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

fix: add pauser role to tss #386

Closed skosito closed 1 month ago

skosito commented 1 month ago

add pauser role to tss in all evm contracts

Related to https://github.com/zeta-chain/node/issues/3000

Summary by CodeRabbit

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 1 month ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough The pull request introduces significant modifications across several contracts, focusing on role management and the handling of the TSS (Threshold Signature Scheme) address. Key updates include granting the `PAUSER_ROLE` to the TSS address in multiple contracts, enhancing the `updateTSSAddress` function to manage role revocations and assignments, and marking the `deposit` function as deprecated. New functionalities for depositing assets and managing custody and connector addresses have also been added, along with updates to the testing contracts to reflect these changes. ## Changes | File | Change Summary | |----------------------------------------|-----------------------------------------------------------------------------------------------------| | `v2/contracts/evm/ERC20Custody.sol` | Updated constructor and `updateTSSAddress` for role management; deprecated `deposit` function. | | `v2/contracts/evm/GatewayEVM.sol` | Modified `initialize` for role assignments; added `depositAndCall`, `setCustody`, and `setConnector` functions. | | `v2/contracts/evm/ZetaConnectorBase.sol` | Constructor updated for role assignment; `updateTSSAddress` remains unchanged. | | `v2/test/ERC20Custody.t.sol` | Introduced `foo` variable for testing; updated access control tests. | | `v2/test/GatewayEVM.t.sol` | Added `foo` variable; modified tests for pause/unpause functionalities. | | `v2/test/ZetaConnectorNative.t.sol` | Added `foo` variable; updated tests for pause/unpause functionalities. | | `v2/test/ZetaConnectorNonNative.t.sol`| Introduced `foo` variable; modified tests for pause/unpause functionalities. | | `v2/test/utils/GatewayEVMUpgradeTest.sol` | Updated `initialize` for role assignment; modified event emissions in `execute` function. | ## Possibly related PRs - **#363**: The changes in this PR directly relate to the `updateTSSAddress` function in the `ERC20Custody` and `GatewayEVM` contracts, which are also modified in the main PR to manage TSS address updates and role assignments. - **#368**: This PR addresses the removal of an unnecessary `_execute` function in `GatewayEVM`, which is relevant as it relates to the overall functionality and management of the TSS address updates in the contract. - **#376**: The modifications in this PR regarding payload size limits in the `GatewayEVM` contract are relevant as they enhance the overall robustness of the contract, which is consistent with the main PR's focus on improving contract functionality and security. - **#385**: This PR focuses on making the `ERC20Custody` and `ZetaConnector` contracts upgradeable, which is directly related to the main PR's changes that enhance role management for the TSS address, ensuring that these functionalities remain intact during upgrades. ## 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 1 month ago

Codecov Report

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

Project coverage is 84.80%. Comparing base (282fdaa) to head (f23d061).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #386 +/- ## ========================================== + Coverage 84.69% 84.80% +0.11% ========================================== Files 8 8 Lines 405 408 +3 Branches 134 134 ========================================== + Hits 343 346 +3 Misses 62 62 ```

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