fix: skip admin transfer in deployment scripts when admin is deployer

[lumtis]

If the admin is the deployer (which could be the case for testnet or some other testing), we have an issue in the scripts where renounceRole would be called with the actual admin address, meaning the contract end up with no admin at all

        gateway.renounceRole(gateway.PAUSER_ROLE(), deployer);
        gateway.renounceRole(gateway.DEFAULT_ADMIN_ROLE(), deployer);

This change skips this logic if the deployer is the admin

Summary by CodeRabbit

• Security Improvements
  • Enhanced admin role transfer logic across multiple deployment scripts
  • Added conditional checks to prevent unnecessary or redundant admin role transfers
  • Improved control flow for role assignment during contract deployment

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces a consistent modification across multiple deployment scripts for ERC20 Custody, Gateway EVM, and Gateway ZEVM contracts. The primary change involves adding a conditional check before transferring the admin role during deployment. This ensures that the admin role is only transferred if the current deployer (msg.sender) is different from the target admin address, preventing unnecessary or redundant role transfers.

Changes

File	Change Summary
scripts/deploy/deterministic/DeployERC20Custody.s.sol	Added conditional check before transferAdmin to prevent transfer if deployer is already the admin
scripts/deploy/deterministic/DeployGatewayEVM.s.sol	Added conditional check before transferAdmin to prevent transfer if deployer is already the admin
scripts/deploy/deterministic/DeployGatewayZEVM.s.sol	Added conditional check before transferAdmin to prevent transfer if deployer is already the admin

Possibly related issues

• zeta-chain/protocol-contracts#411: This issue directly aligns with the changes made in the pull request. The modification ensures that the deployment script handles admin role transfer consistently and deterministically across different chains, addressing the concern about varying admin addresses during deployment.

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4b8c89f and 9294473.

📒 Files selected for processing (3)

• scripts/deploy/deterministic/DeployERC20Custody.s.sol (1 hunks)
• scripts/deploy/deterministic/DeployGatewayEVM.s.sol (1 hunks)
• scripts/deploy/deterministic/DeployGatewayZEVM.s.sol (1 hunks)

🧰 Additional context used

📓 Path-based instructions (3)

scripts/deploy/deterministic/DeployGatewayEVM.s.sol (1)

Pattern scripts/**: Review the Hardhat scripts for best practices.

scripts/deploy/deterministic/DeployGatewayZEVM.s.sol (1)

Pattern scripts/**: Review the Hardhat scripts for best practices.

scripts/deploy/deterministic/DeployERC20Custody.s.sol (1)

Pattern scripts/**: Review the Hardhat scripts for best practices.

📓 Learnings (2)

📓 Common learnings

Learnt from: lumtis
PR: zeta-chain/protocol-contracts#419
File: v2/scripts/deploy/deterministic/DeployERC20Custody.s.sol:68-86
Timestamp: 2024-11-12T13:20:12.658Z
Learning: In the `ERC20Custody` contract, the `WITHDRAWER_ROLE` is intentionally not granted to the admin during the admin transition in the `DeployERC20Custody` deployment script.

scripts/deploy/deterministic/DeployERC20Custody.s.sol (1)

Learnt from: lumtis
PR: zeta-chain/protocol-contracts#419
File: v2/scripts/deploy/deterministic/DeployERC20Custody.s.sol:68-86
Timestamp: 2024-11-12T13:20:12.658Z
Learning: In the `ERC20Custody` contract, the `WITHDRAWER_ROLE` is intentionally not granted to the admin during the admin transition in the `DeployERC20Custody` deployment script.

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: slither
• GitHub Check: generate
• GitHub Check: test
• GitHub Check: Analyze (javascript)

🔇 Additional comments (3)

scripts/deploy/deterministic/DeployGatewayZEVM.s.sol (1)

61-63: LGTM! The fix correctly prevents unnecessary admin role transfers.

The added condition ensures that the admin role transfer is skipped when the deployer is already the admin, preventing the contract from losing its admin role.

scripts/deploy/deterministic/DeployGatewayEVM.s.sol (1)

63-66: LGTM! The fix correctly prevents unnecessary admin role transfers.

The added condition and explanatory comment clearly indicate that the admin role transfer is skipped when the deployer is already the admin.

scripts/deploy/deterministic/DeployERC20Custody.s.sol (1)

63-65: LGTM! The fix correctly prevents unnecessary admin role transfers.

The added condition ensures that the admin role transfer is skipped when the deployer is already the admin, preventing the contract from losing its admin role.

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.07%. Comparing base (4b8c89f) to head (9294473).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #457   +/-   ##
=======================================
  Coverage   87.07%   87.07%           
=======================================
  Files           9        9           
  Lines         526      526           
  Branches      128      128           
=======================================
  Hits          458      458           
  Misses         68       68           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.