search

zeta-chain / protocol-contracts

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

fix: missing tss update in erc20custody, zetaConnector and gatewayEVM #363

Closed skosito closed 1 day ago

skosito commented 6 days ago

Summary by CodeRabbit

coderabbitai[bot] commented 6 days ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough The changes introduce a new function, `updateTSSAddress`, in the `ERC20Custody`, `GatewayEVM`, and `ZetaConnectorBase` contracts, allowing the administrator to update the TSS address with appropriate access controls. This function ensures that the new address is not a zero address and revokes the relevant roles from the old address while granting them to the new address. Corresponding events are emitted to signal these updates. Additionally, test cases have been added across various test contracts to validate the functionality and access control of these updates. ## Changes | Files | Change Summary | |-------------------------------------------|-----------------------------------------------------------------------------------------------------------------| | `v2/contracts/evm/ERC20Custody.sol` | Added `TSS_UPDATER_ROLE` constant and `updateTSSAddress` function for updating TSS address with access control. | | `v2/contracts/evm/GatewayEVM.sol` | Added `TSS_UPDATER_ROLE` constant and `updateTSSAddress` function for updating TSS address with access control. | | `v2/contracts/evm/ZetaConnectorBase.sol` | Added `tssAddress` variable and `updateTSSAddress` function for managing TSS address with access control. | | `v2/test/ERC20Custody.t.sol` | Introduced tests for `updateTSSAddress` including success and failure scenarios for updating TSS address. | | `v2/test/GatewayEVM.t.sol` | Introduced tests for `updateTSSAddress` including success and failure scenarios for updating TSS address. | | `v2/test/ZetaConnectorNative.t.sol` | Added tests for `updateTSSAddress`, verifying role management and event emission upon TSS address update. | | `v2/contracts/evm/interfaces/IERC20Custody.sol` | Added `UpdatedCustodyTSSAddress` event declaration. | | `v2/contracts/evm/interfaces/IGatewayEVM.sol` | Added `UpdatedGatewayTSSAddress` event declaration. | | `v2/contracts/evm/interfaces/IZetaConnector.sol` | Added `UpdatedZetaConnectorTSSAddress` event declaration. |
## Possibly related PRs - **#361**: The `GatewayEVM` contract in this PR includes an `updateTSSAddress` function, which is directly related to the `updateTSSAddress` function added in the main PR for the `ERC20Custody` contract, indicating a shared functionality for updating the TSS address. ## 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 6 days ago

Codecov Report

Attention: Patch coverage is 82.60870% with 4 lines in your changes missing coverage. Please review.

Project coverage is 83.07%. Comparing base (514eaac) to head (518753a).

Files with missing lines Patch % Lines
v2/contracts/evm/GatewayEVM.sol 62.50% 3 Missing :warning:
v2/contracts/evm/ZetaConnectorBase.sol 87.50% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #363 +/- ## ========================================== - Coverage 83.10% 83.07% -0.03% ========================================== Files 8 8 Lines 361 384 +23 Branches 118 122 +4 ========================================== + Hits 300 319 +19 - Misses 61 65 +4 ```

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