search

weweswap / contracts

smart contracts
MIT License
1 stars 4 forks source link

Feature/merge names #63

Closed bitcoinbrisbane closed 2 weeks ago

bitcoinbrisbane commented 3 weeks ago

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 3 weeks ago

[!IMPORTANT]

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request introduces several updates primarily to the README.md file and smart contracts related to the BroMerge functionality. Key changes include adjustments to script examples, updates to the contract address for Bro Merge, and enhancements to the BroMerge and Eater contracts, including new functions and event renaming. Additionally, several artifacts related to removed contracts have been deleted. The deployment addresses have also been updated, reflecting these changes.

Changes

File Change Summary
README.md - Updated script examples by removing --asset parameter from simple-swap and mint-nft-position commands.
- Emphasized the need for FORKING_URL in the blockchain state section.
- Updated Bro Merge contract address from 0xe58C... to 0x5031....
contracts/core/merge/BroMerge.sol - Added _pause() call in the constructor.
- Renamed event Eaten to Merged.
- Added event RateChanged(uint256 newRate).
- Updated depositAll() to deposit(uint256 amount) and added merge(uint256 amount) and mergeAll().
contracts/core/merge/Eater.sol - Inherited from Pausable.
- Added name(), sweep(), and togglePause() functions.
- Updated _merge and receiveApproval functions with whenNotPaused modifier.
ignition/deployments/chain-8453/artifacts/BroMergeModule#BroMerge.json - Updated ABI with renamed event Eaten to Merged and added RateChanged.
- Updated deposit function signature.
ignition/deployments/chain-8453/artifacts/BroMergeModule#BroMerge.dbg.json - Updated buildInfo reference.
ignition/deployments/chain-8453/artifacts/ChaosModule#CHAOS.json - Removed contract artifact for CHAOS.
ignition/deployments/chain-8453/artifacts/FarmModule#Farm.json - Removed contract artifact for Farm.
ignition/deployments/chain-8453/artifacts/MigrationModule#Migration.json - Removed contract artifact for Migration.
ignition/deployments/chain-8453/deployed_addresses.json - Updated BroMergeModule#BroMerge address and removed entries for Farm, Migration, and Chaos.
ignition/deployments/chain-8453/journal.jsonl - Updated entries for MigrationModule, ChaosModule, and BroMergeModule with new transaction details.
ignition/modules/BroMerge.ts - Added constant rate and a call to setRate in BroMergeModule.
test/GenericMerge.test.ts - Added tests for ownership and pause functionality, including tests for sweep and toggling pause state.

Possibly related PRs

Suggested labels

SC

🐰 In the meadow, changes bloom,
Scripts and contracts find new room.
With pauses set and rates defined,
The BroMerge hops, well-aligned.
So let’s cheer for code so bright,
A joyful leap into the night! 🌙

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.