search

zeta-chain / protocol-contracts

Protocol contracts implementing the core logic of the protocol, deployed on ZetaChain and on connected chains
MIT License
71 stars 58 forks source link

feat: erc20 auth calls #401

Closed skosito closed 1 month ago

skosito commented 1 month ago

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 1 month ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough The pull request introduces significant updates across multiple contracts and their corresponding tests, primarily focusing on the addition of a `MessageContext` parameter to various function signatures. This parameter enhances the context for operations such as withdrawals and executions. The changes affect the `ERC20Custody`, `GatewayEVM`, and `ZetaConnector` contracts, along with their interfaces and test suites, ensuring that the tests align with the new method signatures and functionality. ## Changes | File Path | Change Summary | |---------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------| | `v2/contracts/evm/ERC20Custody.sol` | Updated `withdrawAndCall` and `withdrawAndRevert` method signatures to include `MessageContext` and `RevertContext`. | | `v2/contracts/evm/interfaces/IERC20Custody.sol` | Updated `withdrawAndCall` method signature to include `MessageContext`. | | `v2/test/ERC20Custody.t.sol` | Added `arbitraryCallMessageContext` variable and updated tests to reflect new method signatures. | | `v2/test/utils/upgrades/ERC20CustodyUpgradeTest.sol` | Updated `withdrawAndCall` and `withdrawAndRevert` method signatures to include `MessageContext` and `RevertContext`. | | `v2/contracts/evm/GatewayEVM.sol` | Updated `execute` and `executeWithERC20` method signatures to include `MessageContext`. | | `v2/contracts/evm/interfaces/IGatewayEVM.sol` | Updated `execute` and `executeWithERC20` method signatures to include `MessageContext`. Added `MessageContext` struct. | | `v2/test/GatewayEVM.t.sol` | Added `arbitraryCallMessageContext` variable and updated tests to reflect new method signatures. | | `v2/test/GatewayEVMZEVM.t.sol` | Added `arbitraryCallMessageContext` variable and updated tests to reflect new method signatures. | | `v2/test/utils/upgrades/GatewayEVMUpgradeTest.sol` | Updated `execute` and `executeWithERC20` method signatures to include `MessageContext`. | | `v2/contracts/evm/ZetaConnectorBase.sol` | Updated `withdrawAndCall` method signature to include `MessageContext`. | | `v2/contracts/evm/ZetaConnectorNative.sol` | Updated `withdrawAndCall` method signature to include `MessageContext`. | | `v2/contracts/evm/ZetaConnectorNonNative.sol` | Updated `withdrawAndCall` method signature to include `MessageContext`. | | `v2/test/ZetaConnectorNative.t.sol` | Added `arbitraryCallMessageContext` variable and updated tests to reflect new method signatures. | | `v2/test/ZetaConnectorNonNative.t.sol` | Added `arbitraryCallMessageContext` variable and updated tests to reflect new method signatures. | | `v2/test/utils/upgrades/ZetaConnectorNativeUpgradeTest.sol` | Updated `withdrawAndCall` method signature to include `MessageContext`. | | `v2/test/utils/upgrades/ZetaConnectorNonNativeUpgradeTest.sol` | Updated `withdrawAndCall` method signature to include `MessageContext`. | | `v2/test/utils/IReceiverEVM.sol` | Updated `ReceivedOnCall` event signature to include `sender` and `message` parameters. | | `v2/test/utils/ReceiverEVM.sol` | Updated `onCall` method signature to include `MessageContext`. | ## Possibly related PRs - **#361**: The changes in this PR involve adding a `sender` field to the `RevertContext` struct, which aligns with the main PR's updates to include the `MessageContext` parameter in various contracts, enhancing context management during function calls. - **#363**: This PR introduces an `updateTSSAddress` function in the `ERC20Custody` and `GatewayEVM` contracts, which relates to the main PR's modifications in the same contracts, particularly regarding role management and function updates. - **#368**: This PR focuses on refining the `GatewayEVM` contract, including the removal of the `_execute` function and the introduction of new `execute` functions, which directly relates to the changes made in the main PR regarding the `GatewayEVM` contract's execution logic. - **#385**: This PR transitions the `ERC20Custody` and `ZetaConnector` contracts to be upgradeable, which is relevant to the main PR's updates that also involve significant changes to these contracts. - **#386**: The introduction of the `PAUSER_ROLE` for the TSS in this PR enhances the role management system, which is a key aspect of the changes made in the main PR regarding the `ERC20Custody` and `GatewayEVM` contracts. ## Suggested reviewers - fadeev - CharlieMc0 - andresaiello - brewmaster012 - lumtis - fbac

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. ### 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.
codecov-commenter commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 84.23%. Comparing base (ff64066) to head (f98eb2c).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #401 +/- ## ======================================= Coverage 84.23% 84.23% ======================================= Files 8 8 Lines 387 387 Branches 121 122 +1 ======================================= Hits 326 326 Misses 61 61 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.