search

weweswap / contracts

smart contracts
MIT License
2 stars 4 forks source link

Brokker merge addresses #62

Closed bitcoinbrisbane closed 1 month ago

bitcoinbrisbane commented 1 month ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The pull request introduces several changes primarily focused on the README.md file, the BroMerge and Eater smart contracts, and various deployment artifacts. Key modifications include updates to script examples, contract addresses, and the addition of pausable functionality in the Eater contract. The BroMerge contract's constructor now initializes the contract in a paused state. Several deployment artifacts related to the Farm and Chaos modules have been removed, and their corresponding entries in the deployed_addresses.json file have been updated to reflect the new contract address for BroMerge.

Changes

File Change Summary
README.md Updated script examples by removing --asset from certain commands; updated Bro Merge contract address from 0xe58C0537e99299Cd6B1fa8DccF8Ee378c0ec8678 to 0x5031A1c6B31b02605D8D61D115A1eFe436256E4B.
contracts/core/merge/BroMerge.sol Added call to _pause() in the constructor to initialize the contract in a paused state.
contracts/core/merge/Eater.sol Added Pausable functionality, updated _merge and receiveApproval functions with whenNotPaused modifier; added sweep and togglePause functions.
ignition/deployments/chain-8453/artifacts/BroMergeModule#BroMerge.dbg.json Updated buildInfo field to new value.
ignition/deployments/chain-8453/artifacts/BroMergeModule#BroMerge.json Renamed event Eaten to Merged, added RateChanged event, modified deposit function, added merge and mergeAll functions.
ignition/deployments/chain-8453/artifacts/ChaosModule#CHAOS.dbg.json File removed.
ignition/deployments/chain-8453/artifacts/ChaosModule#CHAOS.json File removed.
ignition/deployments/chain-8453/artifacts/FarmModule#Farm.dbg.json File removed.
ignition/deployments/chain-8453/artifacts/FarmModule#Farm.json File removed.
ignition/deployments/chain-8453/artifacts/MigrationModule#Migration.dbg.json File removed.
ignition/deployments/chain-8453/artifacts/MigrationModule#Migration.json File removed.
ignition/deployments/chain-8453/deployed_addresses.json Updated BroMergeModule#BroMerge address and removed entries for FarmModule, MigrationModule, and ChaosModule.
ignition/deployments/chain-8453/journal.jsonl Updated transaction details and network interactions for BroMergeModule, MigrationModule, and ChaosModule.
ignition/modules/BroMerge.ts Added constant rate and call to setRate method of broMerge contract.

Possibly related PRs

Suggested labels

SC

Poem

In the meadow, changes bloom,
The Bro Merge finds its room.
With a pause, the contracts play,
New scripts guide the way.
Hopping through the code so bright,
A rabbit's joy in every byte! 🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
bitcoinbrisbane commented 1 month ago

@coderabbitai write a unit tests for the pause functions

coderabbitai[bot] commented 1 month ago

[!TIP] For best results, initiate chat on the files or code changes.

@bitcoinbrisbane, here are the unit tests for the pause functions in the Eater contract:

const { expect } = require('chai');
const { ethers } = require('hardhat');

describe('Eater Contract Pause Functionality', function () {
  let Eater, eater, owner, addr1;

  beforeEach(async function () {
    [owner, addr1] = await ethers.getSigners();

    // Deploy the Eater contract
    const EaterFactory = await ethers.getContractFactory('Eater');
    eater = await EaterFactory.deploy();
    await eater.deployed();
  });

  it('should allow only the owner to toggle pause', async function () {
    // Owner can toggle pause
    await expect(eater.connect(owner).togglePause()).to.not.be.reverted;

    // Contract should be paused
    expect(await eater.paused()).to.equal(true);

    // Non-owner cannot toggle pause
    await expect(eater.connect(addr1).togglePause()).to.be.revertedWith('Ownable: caller is not the owner');
  });

  it('should prevent functions with whenNotPaused modifier when paused', async function () {
    // Pause the contract
    await eater.connect(owner).togglePause();

    // Attempt to call receiveApproval while paused
    await expect(
      eater.connect(addr1).receiveApproval(
        addr1.address,
        ethers.utils.parseEther('100'),
        ethers.constants.AddressZero,
        '0x'
      )
    ).to.be.revertedWith('Pausable: paused');

    // Unpause the contract
    await eater.connect(owner).togglePause();

    // Should be able to call receiveApproval when unpaused
    await expect(
      eater.connect(addr1).receiveApproval(
        addr1.address,
        ethers.utils.parseEther('100'),
        ethers.constants.AddressZero,
        '0x'
      )
    ).to.not.be.reverted;
  });

  it('should allow only the owner to call sweep', async function () {
    // Non-owner attempts to call sweep
    await expect(eater.connect(addr1).sweep()).to.be.revertedWith('Ownable: caller is not the owner');

    // Owner calls sweep with no balance
    await expect(eater.connect(owner).sweep()).to.be.revertedWith('No balance to sweep');
  });

  it('should transfer WEWE tokens to the owner when sweep is called', async function () {
    // Deploy a mock WEWE token
    const WEWEFactory = await ethers.getContractFactory('MockERC20');
    const wewe = await WEWEFactory.deploy('WEWE Token', 'WEWE', 18);
    await wewe.deployed();

    // Mint tokens to the Eater contract
    await wewe.mint(eater.address, ethers.utils.parseEther('1000'));

    // Verify Eater contract's WEWE balance
    expect(await wewe.balanceOf(eater.address)).to.equal(ethers.utils.parseEther('1000'));

    // Owner calls sweep
    await expect(eater.connect(owner).sweep()).to.not.be.reverted;

    // Eater's WEWE balance should be zero
    expect(await wewe.balanceOf(eater.address)).to.equal(0);

    // Owner's WEWE balance should have increased
    expect(await wewe.balanceOf(owner.address)).to.equal(ethers.utils.parseEther('1000'));
  });
});

These tests cover the togglePause and sweep functions, ensuring that only the owner can pause/unpause the contract and call sweep, and that the whenNotPaused modifier works as expected.

Let me know if you need any further assistance.