polymerdao / monomer

Build Cosmos SDK applications on the OP Stack.
http://monomer.nethermind.io/
Apache License 2.0
23 stars 16 forks source link

Support ERC-20 deposits in x/rollup #223

Closed natebeauregard closed 1 month ago

natebeauregard commented 1 month ago

Adds support for ERC-20 deposits by parsing the deposit tx data. ERC-20 tokens are minted on L2 in the erc20/{L1 ERC-20 address} format.

Safeguards are in place to ensure that the deposit tx originated from the L1CrossDomainMessenger so that users can't forge tx data to mint unlimited ERC-20 tokens.

x/rollup integration tests and e2e tests with ERC-20 deposits were added to verify the deposit was successful.

This is an initial increment to get a functional implementation for ERC-20 deposits. Future work to either add a genesis state to x/rollup to contain the L1CrossDomainMessenger address or to extract the ERC-20 deposit logic to a new cosmos module will be done in a future increment.

Closes https://github.com/polymerdao/monomer/issues/210

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

This pull request introduces significant enhancements to the handling of ERC20 token deposits and cross-domain messaging within the Ethereum ecosystem. Key changes include the addition of new data structures for managing token transfers, modifications to the stack configuration for improved modularity, and updates to testing frameworks to ensure comprehensive coverage of both ETH and ERC20 transactions. The integration of new functions for parsing cross-domain messages and minting tokens further strengthens the interoperability between Ethereum and Cosmos.

Changes

File Path Change Summary
bindings/erc20_deposit_args.go Added RelayMessageArgs and FinalizeBridgeERC20Args structures for managing Ethereum transactions and ERC20 token deposits.
e2e/stack.go Modified StackConfig to include L1Deployments, OptimismPortal, and L1StandardBridge. Updated run method to instantiate L1StandardBridge.
e2e/stack_test.go Renamed rollupFlow to ethRollupFlow and added erc20RollupFlow for ERC20 token deposits. Enhanced ETH deposit handling and logging.
testutils/utils.go Introduced GenerateERC20DepositTx function for creating ERC20 deposit transactions.
x/rollup/keeper/deposits.go Added parseAndExecuteCrossDomainMessage for handling cross-domain messages and mintERC20 for minting tokens. Improved error handling in mintETH.
x/rollup/tests/integration/rollup_test.go Enhanced tests to cover ERC20 deposits, refactored balance querying functions, and verified user balances after deposits.
x/rollup/types/events.go Added constants AttributeKeyERC20Address and EventTypeMintERC20 for ERC20 event handling.

Assessment against linked issues

Objective Addressed Explanation
Support depositing ERC-20 tokens to monomer based L2s (#210) βœ…

Possibly related PRs

Poem

In the meadow where tokens play,
A rabbit hops, brightening the day.
With ERC20s now in tow,
Cross-domain magic starts to flow.
Hops and jumps, oh what a sight,
In the world of DeFi, all feels right! πŸ‡βœ¨


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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
natebeauregard commented 1 month ago

Force-pushed to rebase on main to get the docusaurus CI job passing

natebeauregard commented 1 month ago

Force-pushed to rebase on main and resolve merge conflicts

natebeauregard commented 1 month ago

Force-pushed to format commits for merge