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

refactor: rename onCrosschainCall and zContext #349

Closed skosito closed 1 month ago

skosito commented 2 months ago

closes: #345

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 2 months ago

[!CAUTION]

Review failed

The pull request is closed.

📝 Walkthrough
📝 Walkthrough ## Walkthrough The changes primarily involve the renaming of the `zContext` type to `MessageContext` across various contracts and interfaces, particularly in the `GatewayZEVM` and `UniversalContract`. The method `onCrossChainCall` has been renamed to `onCall`, reflecting a shift in handling cross-chain interactions. The updates enhance the clarity of function signatures and improve the structure of message-related data utilized in cross-chain communications. ## Changes | File(s) | Change Summary | |-------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------| | `v2/contracts/zevm/GatewayZEVM.sol`, `v2/contracts/zevm/interfaces/IGatewayZEVM.sol` | Renamed `zContext` to `MessageContext` in function signatures for `execute` and `depositAndCall`. | | `v2/contracts/zevm/interfaces/UniversalContract.sol` | Renamed `onCrossChainCall` to `onCall` and updated parameter type from `zContext` to `MessageContext`. | | `v2/test/GatewayZEVM.t.sol`, `v2/test/utils/TestUniversalContract.sol` | Refactored tests to use `MessageContext` instead of `zContext` in relevant test functions. | | `v2/test/utils/upgrades/GatewayZEVMUpgradeTest.sol` | Updated parameter types from `zContext` to `MessageContext` and modified event names and visibility. | ## Assessment against linked issues | Objective | Addressed | Explanation | |----------------------------------------------------------------|-----------|--------------------------------------------------| | Rename `onCrossChainCall` to `onCall` and `zContext` to `messageContext` (#345) | ✅ | | ## Possibly related issues - **zeta-chain/protocol-contracts#298**: The changes include renaming `zContext` to `MessageContext`, which aligns with the objective to standardize naming conventions in the codebase. ## 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.
codecov-commenter commented 2 months ago

Codecov Report

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

Project coverage is 84.95%. Comparing base (f7f6d9f) to head (9eb0897).

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

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

skosito commented 2 months ago

Who prefer to have some discussion around backward compatibility before moving forward with this one

yea that makes sense, but dont see a way to keep compatibility and rename, adding overloads seems like an overkill for this

can we just rename on protocol side as well, it should be simple change?

lumtis commented 1 month ago

Who prefer to have some discussion around backward compatibility before moving forward with this one

yea that makes sense, but dont see a way to keep compatibility and rename, adding overloads seems like an overkill for this

can we just rename on protocol side as well, it should be simple change?

Would the following be an overkill?

If we consider ZETA is not supported for now, there are two entrypoint now where onCrossChainCall is used.