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

feat: add sender when calling connected chain contracts from zetachain #355

Closed skosito closed 1 month ago

skosito commented 2 months ago

same as: https://github.com/zeta-chain/protocol-contracts/pull/350 just correct base branch and onCall function payable

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 2 months ago
Walkthrough ## Walkthrough This pull request introduces significant modifications to the `GatewayEVM` and `GatewayZEVM` contracts, focusing on the execution of calls with new structures for handling call options, including gas limits. The `go.mod` file reflects updates to various dependencies, including downgrades and the addition of new libraries. The changes enhance the functionality and clarity of the contracts, particularly in managing authenticated and arbitrary calls, while also improving the testing framework to cover new scenarios. ## Changes | File | Change Summary | |-------------------------------------------|----------------------------------------------------------------------------------------------------| | `go.mod` | Updated dependency versions, including downgrades and the addition of a new dependency. | | `v2/contracts/evm/GatewayEVM.sol` | Removed `_execute` function; added `_executeAuthenticatedCall` and `_executeArbitraryCall`. Overloaded `execute` function to support a `MessageContext`. | | `v2/contracts/evm/interfaces/IGatewayEVM.sol` | Added new error and methods; introduced `MessageContext` struct and `Callable` interface. | | `v2/contracts/zevm/GatewayZEVM.sol` | Introduced `CallOptions` struct for call parameters; added `withdrawAndCall` and `call` functions. | | `v2/contracts/zevm/interfaces/IGatewayZEVM.sol` | Updated events to use `CallOptions`; added new functions for withdrawals and calls. | | `v2/test/GatewayEVM.t.sol` | Added new test functions for `gateway.execute` scenarios, enhancing coverage for authorization checks. | | `v2/test/GatewayEVMZEVM.t.sol` | Updated imports and function calls to utilize `CallOptions`. | | `v2/test/GatewayZEVM.t.sol` | Modified tests to incorporate `CallOptions` in various withdrawal and call scenarios. | | `v2/test/utils/GatewayEVMUpgradeTest.sol`| Removed `_execute`; added new functions for authenticated and arbitrary calls. | | `v2/test/utils/IReceiverEVM.sol` | Added `ReceivedOnCall` event to the interface. | | `v2/test/utils/ReceiverEVM.sol` | Introduced `onCall` function to handle calls with `MessageContext`. | ## Possibly related issues - **zeta-chain/protocol-contracts#307**: The changes in this PR address the need for a `GasLimit` option in the `call` and `withdrawAndCall` functions, as outlined in the issue. ## Possibly related PRs - **#352**: This PR involves modifications to the `GatewayZEVM` contract structure and functionality, which may relate to the dependency updates in the main PR. ## Suggested reviewers - fadeev - CharlieMc0 - brewmaster012 - andresaiello - fbac - lumtis

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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov-commenter commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 91.92%. Comparing base (c2ce913) to head (b98b0d9). Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #355 +/- ## ========================================== + Coverage 91.39% 91.92% +0.52% ========================================== Files 8 8 Lines 337 359 +22 Branches 110 117 +7 ========================================== + Hits 308 330 +22 Misses 29 29 ```

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

skosito commented 1 month ago

@lumtis @fadeev could you please check this one?