Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: remove nonReentrant from execute #395

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

skosito
Copy link
Contributor

@skosito skosito commented Oct 16, 2024

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 - in this PR for illustration its removed from execute and executeWithERC20 since same applies for this one as well.

Qs:

  • is it ok, or better to remove from call/depositAndCall since these don't call any other contract? seems like effect is the same
  • can arbitrary call use delegatecall for gatewayEVM.call/depositAndCall with some edge cases? idea is that gateway dont hold assets so that part should be fine, but might be something else
  • what about executeRevert and revertWithERC20? these also have nonReentrant but theoretically onRevert might want to call back gatewayEVM - should we allow these type of interactions or be more restrictive in these cases?

Note:
Same issue would apply the other way around when going from connected chain to zetachain, but currently execute functions on GatewayZEVM don't have this modifier, don't remember if it was intentional or just by mistake

Summary by CodeRabbit

  • New Features
    • Introduced overloaded execute function for enhanced call execution options.
    • Added new deposit methods with improved payload size checks.
  • Bug Fixes
    • Removed nonReentrant modifier from executeWithERC20 function to improve functionality.
  • Security Enhancements
    • Updated deposit functions to ensure robust checks against overflow issues.

Copy link
Contributor

coderabbitai bot commented Oct 16, 2024

📝 Walkthrough

Walkthrough

The changes in the GatewayEVM contract focus on enhancing the functionality of call execution and deposit handling. The execute function has been overloaded to provide two variants: one requiring a MessageContext and one without. Modifications also include the removal of the nonReentrant modifier from the executeWithERC20 function, affecting reentrancy protection. Additionally, deposit functions now include checks for maximum payload size to prevent overflow issues. The contract maintains role-based access control for critical functions, ensuring that only authorized roles can make changes.

Changes

File Path Change Summary
v2/contracts/evm/GatewayEVM.sol - Overloaded execute function to include a variant with MessageContext.
- Removed nonReentrant modifier from executeWithERC20.
- Updated deposit functions to check maximum payload size when handling revert options.
- Added new method signatures for deposit and depositAndCall.

Possibly related PRs

  • fix: cleanup tss updater changes #368: This PR involves the removal of the _execute function and the introduction of new execute functions in the GatewayEVM contract, which aligns with the changes made in the main PR regarding the overload of the execute function and the removal of the _execute function.

Suggested reviewers

  • fadeev
  • CharlieMc0
  • andresaiello
  • brewmaster012
  • lumtis
  • fbac

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between f29829e and 17d9590.

📒 Files selected for processing (1)
  • v2/contracts/evm/GatewayEVM.sol (0 hunks)
💤 Files with no reviewable changes (1)
  • v2/contracts/evm/GatewayEVM.sol

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.95%. Comparing base (f29829e) to head (17d9590).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #395   +/-   ##
=======================================
  Coverage   84.95%   84.95%           
=======================================
  Files           8        8           
  Lines         412      412           
  Branches      138      138           
=======================================
  Hits          350      350           
  Misses         62       62           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants