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

fix: prevent using 0 gas limit for call and withdrawAndCall #370

Closed skosito closed 1 month ago

skosito commented 1 month ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago
📝 Walkthrough ## Walkthrough The changes introduced in the `GatewayZEVM` contract focus on enhancing error handling and functionality related to gas limits. New checks ensure that the `gasLimit` parameter is not zero in critical functions such as `withdrawAndCall` and `call`, with specific revert conditions implemented to trigger the `InsufficientGasLimit` error. Additionally, overloads for these functions have been added to accommodate a `CallOptions` struct, allowing for more flexible gas limit specifications. Corresponding updates have been made to the interface and test files to support these changes. ## Changes | File Path | Change Summary | |------------------------------------------------|---------------------------------------------------------------------------------------------------------------------| | v2/contracts/zevm/GatewayZEVM.sol | Updated `withdrawAndCall` and `call` methods with new overloads; added checks for zero gas limits; introduced `InsufficientGasLimit` error. | | v2/contracts/zevm/interfaces/IGatewayZEVM.sol | Added new error type `InsufficientGasLimit` to the `IGatewayZEVMErrors` interface. | | v2/test/GatewayZEVM.t.sol | Added new test cases for gas limit checks; expanded existing tests for error handling related to zero amounts and addresses. | ## Possibly related PRs - **#352**: Modifications in the `GatewayZEVM` contract regarding access control and function logic. - **#355**: Introduction of the `CallOptions` structure in the `GatewayZEVM` contract, relevant to gas limit handling. - **#361**: Enhancements to revert handling with the addition of the `sender` field in the `RevertContext` struct. - **#363**: Updates to the `GatewayEVM` contract involving function additions for TSS address updates, relevant to overall functionality improvements. ## 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 83.29%. Comparing base (eda1e99) to head (01820b8).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #370 +/- ## ========================================== + Coverage 83.07% 83.29% +0.21% ========================================== Files 8 8 Lines 384 389 +5 Branches 122 127 +5 ========================================== + Hits 319 324 +5 Misses 65 65 ```

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