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: use nonReentrant only on functions interacting with arbitrary contracts #395

Closed skosito closed 1 month ago

skosito commented 1 month ago

Use case:

Call from zetachain to evm chain reaches gatewayEVM.execute function which is calling arbitrary function on provided contract. That arbitrary function can call back gateway, eg: gatewayEVM.call gatewayEVM.depositAndCall. Because both execute and call/depositAndCall have nonReentrant modifier, this is not possible currently.

Solution can be to remove nonReentrant from either of those - it is better to remove from entrypoint functions since they do not interact with arbitrary contract, just interact with system contracts or addresses (eg. tss, custody, zrc20), and just emit events. On the other side, execute functions interact with arbitrary contracts so leaving it there makes more sense.

Summary by CodeRabbit

These updates improve overall contract security and ensure safer handling of transactions.

coderabbitai[bot] commented 1 month ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough The changes in the `GatewayEVM` and `GatewayZEVM` contracts focus on enhancing security through the introduction of the `nonReentrant` modifier to various functions, protecting against reentrancy attacks. In `GatewayEVM`, this modifier has been added to functions such as `executeRevert`, `execute`, and several deposit functions, alongside maximum payload size checks for deposits. In `GatewayZEVM`, the `nonReentrant` modifier is similarly applied to functions like `withdraw`, `call`, and `depositAndCall`, with some functions also incorporating a `whenNotPaused` modifier for state management during withdrawals. ## Changes | File Path | Change Summary | |---------------------------------|-------------------------------------------------------------------------------------------------| | v2/contracts/evm/GatewayEVM.sol | - Added `nonReentrant` modifier to `executeRevert`, `execute`, `executeWithERC20`, `revertWithERC20`, `deposit`, `depositAndCall`, and `call` functions. | | | - Added maximum payload size checks in deposit functions. | | v2/contracts/zevm/GatewayZEVM.sol | - Introduced `nonReentrant` modifier to `withdraw`, `withdrawAndCall`, `call`, `executeRevert`, `depositAndRevert`, and the new `depositAndCall` function. | | | - Added `whenNotPaused` modifier to several functions for state management. | ## Possibly related PRs - **#361**: The changes in this PR involve the addition of the `nonReentrant` modifier to several functions in the `GatewayEVM` contract, which is directly related to the main PR's focus on enhancing security through similar modifications. - **#376**: This PR introduces checks for payload sizes in the `GatewayEVM` contract, which aligns with the main PR's updates to deposit functions that also enforce maximum payload size checks. - **#403**: The modifications in this PR to rename emitted events in the `GatewayEVM` contract for deposit and call functions are related to the main PR's changes that also involve updates to these functions and their event emissions. ## Suggested reviewers - fadeev - CharlieMc0 - andresaiello - brewmaster012 - 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 (d40d2e2) to head (36c6a2e). Report is 1 commits behind head on main.

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

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

skosito commented 1 month ago

in this PR for illustration its removed from execute and executeWithERC20 since same applies for this one as well.

You mean this is the opposite here? It is removed from the entrypoint functions, not the endpoint?

yes this was initial PR description, will update