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

chore: use deployer address in deployment scripts #419

Closed lumtis closed 1 month ago

lumtis commented 1 month ago

Closes: https://github.com/zeta-chain/protocol-contracts/issues/411

Use deployer address for all contract with a deterministic address

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago
📝 Walkthrough ## Walkthrough The pull request introduces enhancements to the deployment scripts for the `DeployERC20Custody`, `DeployGatewayEVM`, and `DeployGatewayZEVM` contracts. Key modifications include ensuring that the admin addresses are not zero, using `msg.sender` as the admin during initialization, and adding a `transferAdmin` function to manage admin role transitions. These changes improve the robustness of the contracts by enforcing checks and clarifying the role management process during deployment. ## Changes | File Path | Change Summary | |---------------------------------------------|----------------------------------------------------------------------------------------------------| | v2/scripts/deploy/deterministic/DeployERC20Custody.s.sol | - Added `transferAdmin` method for admin role management.
- Ensured `admin` address is not zero.
- Used `msg.sender` for proxy initialization. | | v2/scripts/deploy/deterministic/DeployGatewayEVM.s.sol | - Added `transferAdmin` method for admin role management.
- Ensured `GATEWAY_ADMIN_ADDRESS_EVM` is set.
- Used `msg.sender` for proxy initialization. | | v2/scripts/deploy/deterministic/DeployGatewayZEVM.s.sol | - Added `transferAdmin` method for admin role management.
- Ensured `GATEWAY_ADMIN_ADDRESS_ZEVM` is set.
- Used `msg.sender` for proxy initialization. | ## Assessment against linked issues | Objective | Addressed | Explanation | |---------------------------------------------------------------------------|-----------|-----------------------------------------------| | Use a deployer address that is transferred to an admin address in deployment script (#411) | ✅ | | ## Possibly related PRs - **#363**: Modifies the `ERC20Custody` contract, introducing a TSS update function related to role management. - **#383**: Focuses on the `updateTSSAddress` function in the `ERC20Custody` contract, relevant to role management enhancements. - **#386**: Enhances role management in the `ERC20Custody` contract, specifically regarding the TSS address. - **#395**: Modifies the `GatewayEVM` contract, sharing similar role management and security enhancements. - **#408**: Introduces a deployment script for the `GatewayZEVM`, related to the deployment logic changes. - **#413**: Improves deployment instructions, relevant to the changes in deployment logic. - **#418**: Adds deployment instructions for ZRC20, relevant to the overall deployment context. ## Suggested reviewers - fadeev - CharlieMc0 - andresaiello - brewmaster012 - skosito - 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.27%. Comparing base (18d5c12) to head (2c27ce8).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #419 +/- ## ======================================= Coverage 84.27% 84.27% ======================================= Files 8 8 Lines 388 388 Branches 123 123 ======================================= Hits 327 327 Misses 61 61 ```

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

skosito commented 1 month ago

@lumtis will this be backported to v20?

lumtis commented 1 month ago

@lumtis will this be backported to v20?

Yes, I originally made the branch there but there is no conflict between both version so changes are the same