search

zeta-chain / protocol-contracts

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

feat: improve revert handling #361

Closed skosito closed 1 month ago

skosito commented 1 month ago

base is auth call branch, please dont merge until that one is merged

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough The changes in this pull request involve multiple modifications across several Solidity files, primarily focusing on enhancing the `RevertContext` struct by adding a `sender` field to capture the address of the initiating account. Additionally, the `GatewayEVM` contract's function for validating calls has been renamed and its logic altered to improve security. The `UniversalContract` interface has had the `onRevert` function removed, and error handling has been improved with the addition of a new error in the `IGatewayEVMErrors` interface. ## Changes | File Path | Change Summary | |------------------------------------------------|-------------------------------------------------------------------------------------------------| | v2/contracts/Revert.sol | Added `address sender` field to `RevertContext` struct. | | v2/contracts/evm/GatewayEVM.sol | Renamed `revertIfAuthenticatedCall` to `revertIfOnCallOrOnRevert` and updated its logic. | | v2/contracts/evm/interfaces/IGatewayEVM.sol | Added new error `NotAllowedToCallOnRevert` to the interface. | | v2/contracts/zevm/GatewayZEVM.sol | Updated calls from `UniversalContract` to `Revertable` in `executeRevert` and `deposit` functions. | | v2/contracts/zevm/interfaces/UniversalContract.sol | Removed `onRevert` function from the `UniversalContract` interface. | | v2/test/ERC20Custody.t.sol | Updated `revertContext` initialization to include `sender`. | | v2/test/GatewayEVM.t.sol | Updated `revertContext` to include `sender` and added new test for unauthorized `onRevert` calls. | | v2/test/GatewayZEVM.t.sol | Updated `revertContext` initialization to include `sender`. | | v2/test/ZetaConnectorNative.t.sol | Updated `revertContext` initialization to include `sender`. | | v2/test/ZetaConnectorNonNative.t.sol | Updated `revertContext` initialization to include `sender`. | | v2/test/utils/TestUniversalContract.sol | Updated class signature to inherit from `Revertable` in addition to `UniversalContract`. | ## Possibly related issues - **zeta-chain/protocol-contracts#359**: This issue discusses the need to add a `sender` field in `RevertContext`, which has been addressed in this PR. - **zeta-chain/protocol-contracts#356**: This issue proposes the removal of `onRevert` from the `UniversalContract` interface, which aligns with the changes made in this PR. ## Possibly related PRs - **#355**: This PR adds a `sender` field to the `MessageContext` struct, which is directly related to the addition of the `sender` field in the `RevertContext` struct in this PR. ## 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](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.
codecov-commenter commented 1 month ago

Codecov Report

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

Project coverage is 83.10%. Comparing base (7175604) to head (42c1ede). Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #361 +/- ## ========================================== + Coverage 83.00% 83.10% +0.09% ========================================== Files 8 8 Lines 359 361 +2 Branches 117 118 +1 ========================================== + Hits 298 300 +2 Misses 61 61 ```

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