search

zeta-chain / protocol-contracts

Protocol contracts implementing the core logic of the protocol, deployed on ZetaChain and on connected chains
MIT License
71 stars 58 forks source link

feat: add `DepositedAndCalled` and `WithdrawnAndCalled` events #403

Closed lumtis closed 1 month ago

lumtis commented 1 month ago

Change the event emitted in WithdrawAndCall and DepositAndCall to allow parsing these action with an empty message

Protocol integration associated PR: https://github.com/zeta-chain/node/pull/3018

Summary by CodeRabbit

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 (2095aa6) to head (e74f50a).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #403 +/- ## ======================================= 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.

coderabbitai[bot] commented 1 month ago

[!CAUTION]

Review failed

The pull request is closed.

📝 Walkthrough
📝 Walkthrough ## Walkthrough The pull request introduces significant updates to the `GatewayEVM` and `GatewayZEVM` contracts, particularly focusing on the `depositAndCall` and `withdrawAndCall` functions. Key changes include renaming emitted events for clarity, adding new functions for calling contracts without asset transfers, and enhancing validation checks. The associated interfaces have also been updated to reflect these changes, ensuring compatibility and improved event logging. Additionally, test contracts have been modified to align with the new event emissions and functionality. ## Changes | File Path | Change Summary | |-----------------------------------------|----------------------------------------------------------------------------------------------------| | v2/contracts/evm/GatewayEVM.sol | Updated `depositAndCall` function signatures; added `call` function; renamed events to `DepositedAndCalled`. | | v2/contracts/evm/interfaces/IGatewayEVM.sol | Added `DepositedAndCalled` event; updated `Deposited` event comment; added new `depositAndCall` signatures. | | v2/contracts/zevm/GatewayZEVM.sol | Updated `withdrawAndCall` function to emit `WithdrawnAndCalled`; added new commented-out `withdraw` functions. | | v2/contracts/zevm/interfaces/IGatewayZEVM.sol | Added `WithdrawnAndCalled` event; updated `Withdrawn` event comment. | | v2/test/GatewayEVM.t.sol | Updated tests for `GatewayEVM` to reflect new event names for deposits with payloads. | | v2/test/GatewayEVMZEVM.t.sol | Updated tests for `GatewayEVMZEVM` to reflect new event name for withdrawals. | | v2/test/GatewayZEVM.t.sol | Updated tests for `GatewayZEVM` to reflect new event names for withdrawals and added checks for `ZETANotSupported`. | ## Possibly related PRs - **#376**: This PR introduces a constant for maximum payload size and enforces checks in the `depositAndCall` and `call` functions, which are directly related to the changes in the main PR that also modifies these functions to include payload size validation. - **#403**: This PR modifies the `depositAndCall` and `withdrawAndCall` functions to emit `DepositedAndCalled` and `WithdrawnAndCalled` events, which aligns with the main PR's changes that rename the emitted events for these functions. ## 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.
skosito commented 1 month ago

@lumtis i merged main here since conflicts were just in bindings and will merge PR when CI is green