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: disable callOnRevert in GatewayEVM call #407

Merged
merged 5 commits into from
Oct 23, 2024

Conversation

skosito
Copy link
Contributor

@skosito skosito commented Oct 21, 2024

currently not supported on protocol side, so disabling here as well

Summary by CodeRabbit

  • New Features

    • Introduced a new call function in the GatewayEVM contract for calling omnichain smart contracts without asset transfer.
    • Added a new error CallOnRevertNotSupported() to enhance error handling for unsupported method calls.
  • Bug Fixes

    • Improved checks in deposit, depositAndCall, setCustody, and setConnector functions to prevent initialization errors.
  • Tests

    • Updated test suite to include new error handling scenarios and validate contract behavior under various conditions.

Copy link
Contributor

coderabbitai bot commented Oct 21, 2024

Warning

Rate limit exceeded

@skosito has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 0 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Files that changed from the base of the PR and between 48de3a7 and 4d4c115.

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes in this pull request include the addition of a new error declaration CallOnRevertNotSupported() in the INotSupportedMethods interface, enhancing error handling capabilities. Additionally, a new call function is introduced in the GatewayEVM contract, which allows interaction with omnichain smart contracts without asset transfer and incorporates checks for revert options. Various existing functions have been updated to include checks for payload size and initialization status, improving the robustness of the contract. The test suite has also been updated to reflect these changes, including new test cases and modifications to existing ones.

Changes

File Change Summary
v2/contracts/Errors.sol - Added error: error CallOnRevertNotSupported() in interface INotSupportedMethods.
v2/contracts/evm/GatewayEVM.sol - Added method: function call(address receiver, bytes calldata payload, RevertOptions calldata revertOptions).
- Updated methods: deposit, depositAndCall, setCustody, setConnector to include new checks for revert options and initialization status.
v2/test/GatewayEVM.t.sol - Updated contract declaration to include INotSupportedMethods.
- Removed ZETANotSupported error.
- Modified setUp function for revert options.
- Added new test case: testCallWithPayloadFailsIfCallOnRevertIsTrue.

Possibly related PRs

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
🪧 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-commenter commented Oct 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.27%. Comparing base (25a6e0b) to head (4d4c115).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #407      +/-   ##
==========================================
+ Coverage   84.23%   84.27%   +0.04%     
==========================================
  Files           8        8              
  Lines         387      388       +1     
  Branches      122      123       +1     
==========================================
+ Hits          326      327       +1     
  Misses         61       61              

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
v2/contracts/Errors.sol (1)

8-8: LGTM! Consider adding a brief comment for the new error.

The addition of the CallOnRevertNotSupported() error aligns well with the PR objective to disable the callOnRevert feature. It follows the existing naming convention and structure within the interface.

Consider adding a brief comment above the new error to explain its purpose, similar to how the interface itself is documented. This would improve code readability and maintainability. For example:

/// @notice Error thrown when callOnRevert is not supported
error CallOnRevertNotSupported();
v2/contracts/evm/GatewayEVM.sol (1)

344-344: Consider adding unit tests for the new error condition

Adding unit tests to verify that the function correctly reverts when revertOptions.callOnRevert is true would enhance test coverage and ensure the new logic functions as expected.

Would you like assistance in creating these unit tests or opening a GitHub issue to track this task?

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between d40d2e2 and 48de3a7.

📒 Files selected for processing (3)
  • v2/contracts/Errors.sol (1 hunks)
  • v2/contracts/evm/GatewayEVM.sol (1 hunks)
  • v2/test/GatewayEVM.t.sol (3 hunks)
🧰 Additional context used
🔇 Additional comments (4)
v2/contracts/evm/GatewayEVM.sol (1)

344-344: Properly handling unsupported callOnRevert option

The added check correctly ensures that the function reverts with CallOnRevertNotSupported() when revertOptions.callOnRevert is true, effectively disabling the unsupported feature as intended.

v2/test/GatewayEVM.t.sol (3)

401-401: Addition of INotSupportedMethods interface is appropriate

The inclusion of INotSupportedMethods interface provides access to necessary error declarations used in the tests.


457-457: Setting callOnRevert to false in revertOptions

Properly initializing callOnRevert to false ensures that tests behave as expected when this feature is disabled.


681-687: Test correctly verifies rejection when callOnRevert is true

The test accurately ensures that calling with callOnRevert set to true reverts with the expected error, enforcing that callOnRevert is not supported.

@skosito skosito merged commit cc56841 into main Oct 23, 2024
11 checks passed
@skosito skosito deleted the disable-call-on-revert-call branch October 23, 2024 20:30
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.

4 participants