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

refactor: disable ZETA related functions and remove call functions not using `callOptions` #393

Closed lumtis closed 1 month ago

lumtis commented 1 month ago

Not running generate now to simplify review.

Opening for review now, there is a test error happening in these lines: https://github.com/zeta-chain/protocol-contracts/pull/393/files#diff-2605cea5bc2def7c46e3d80e4eaef42116a8c377202c5645d231f1bd7daf4726R178 https://github.com/zeta-chain/protocol-contracts/pull/393/files#diff-2605cea5bc2def7c46e3d80e4eaef42116a8c377202c5645d231f1bd7daf4726R255 -> replacing the gasLimit with callOptions for withdraw tests. Gonna investigate further later, maybe you have an idea @skosito or are these tests still needed at all?

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough A new interface `INotSupportedMethods` has been introduced to define an error type `ZETANotSupported`, which is implemented in the `GatewayEVM` and `GatewayZEVM` contracts. These contracts have been modified to handle unsupported method calls by reverting with the new error. Additionally, several functions have been updated to utilize a `CallOptions` structure instead of individual parameters for gas limits. Test contracts have been adjusted to incorporate these changes, ensuring proper error handling and functionality. ## Changes | File | Change Summary | |----------------------------------------|---------------------------------------------------------------------------------------------------| | v2/contracts/Errors.sol | Added interface `INotSupportedMethods` and error `ZETANotSupported()`. | | v2/contracts/evm/GatewayEVM.sol | Implemented `INotSupportedMethods`; modified `_transferFromToAssetHandler` to revert on ZETA deposits. | | v2/contracts/zevm/GatewayZEVM.sol | Inherited `INotSupportedMethods`; updated `withdraw`, `withdrawAndCall`, and `call` functions to revert on unsupported operations and changed parameters to use `CallOptions`. | | v2/contracts/zevm/interfaces/IGatewayZEVM.sol | Updated `withdrawAndCall` and `call` functions to use `CallOptions`. | | v2/test/GatewayEVM.t.sol | Added error `ZETANotSupported()`; updated tests for handling deposits and custody balance checks. | | v2/test/GatewayEVMZEVM.t.sol | Integrated `CallOptions` into test functions; added a new state variable. | | v2/test/GatewayZEVM.t.sol | Added error `ZETANotSupported()`; updated event parameter `sender` to `sfender` and modified function calls to use `CallOptions`. | | v2/test/utils/SenderZEVM.sol | Updated `callReceiver` and `withdrawAndCallReceiver` to include `CallOptions`. | ## Possibly related issues - **zeta-chain/protocol-contracts#390**: The changes in this PR address the objective of disabling ZETA gateway functions as indicated by the introduction of the `ZETANotSupported` error. ## Possibly related PRs - **#370**: Modifications to prevent zero gas limits in `GatewayZEVM` are relevant as they align with the handling of unsupported method calls in this PR. - **#376**: Changes related to payload size limits in `GatewayEVM` connect with the error handling enhancements introduced in this PR. - **#383**: Updates to error handling in `GatewayEVM` during deposit operations relate to the new `ZETANotSupported` error type implemented in this PR. ## Suggested reviewers - fadeev - CharlieMc0 - andresaiello - brewmaster012

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 (a675f8a) to head (cf2ea8c).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #393 +/- ## ========================================== - Coverage 84.95% 84.23% -0.72% ========================================== Files 8 8 Lines 412 387 -25 Branches 138 121 -17 ========================================== - Hits 350 326 -24 + Misses 62 61 -1 ```

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