Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: script to deploy GatewayZEVM #408

Merged
merged 3 commits into from
Oct 23, 2024
Merged

chore: script to deploy GatewayZEVM #408

merged 3 commits into from
Oct 23, 2024

Conversation

skosito
Copy link
Contributor

@skosito skosito commented Oct 21, 2024

Summary by CodeRabbit

  • New Features

    • Introduced a new smart contract for deploying a Gateway on the Zeta Ethereum Virtual Machine (ZEVM).
    • Added functionality to initialize the Gateway with specific admin and token addresses.
    • Expanded configuration options with new environment variables for ZEVM deployments.
  • Bug Fixes

    • Improved validation checks during deployment to ensure addresses are correctly set and non-zero.

Copy link
Contributor

coderabbitai bot commented Oct 21, 2024

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes introduce a new Solidity smart contract file, DeployGatewayZEVM.s.sol, which is responsible for deploying a Gateway contract on the Zeta Ethereum Virtual Machine (ZEVM). The contract includes a public function, run, that retrieves necessary addresses from environment variables, computes expected contract addresses, and deploys both the implementation contract (GatewayZEVM) and an ERC1967Proxy. The deployment process includes validations to ensure that the addresses are correct and that the proxy is initialized with the appropriate parameters.

Changes

File Path Change Summary
v2/scripts/deploy/deterministic/DeployGatewayZEVM.s.sol Added contract DeployGatewayZEVM with public function run() for deploying a Gateway contract on ZEVM.
v2/.env.sample Added environment variables GATEWAY_ADMIN_ADDRESS_ZEVM and WZETA for ZEVM configuration.

Sequence Diagram(s)

sequenceDiagram
    participant Env as Environment Variables
    participant Deploy as DeployGatewayZEVM
    participant Impl as GatewayZEVM Implementation
    participant Proxy as ERC1967Proxy

    Env->>Deploy: Retrieve admin and token addresses
    Deploy->>Deploy: Compute expected addresses
    Deploy->>Impl: Deploy GatewayZEVM
    Impl-->>Deploy: Return implementation address
    Deploy->>Proxy: Deploy ERC1967Proxy
    Proxy-->>Deploy: Return proxy address
    Deploy->>Impl: Initialize with Zeta token and admin
    Deploy->>Deploy: Verify token and address
    Deploy->>Deploy: Stop transaction broadcast
Loading

Possibly related PRs

  • feat: deploy zrc 20 script #338: This PR adds new environment variables for ZEVM configuration, which are relevant to the deployment process described in the main PR for the DeployGatewayZEVM contract.
  • feat: add DepositedAndCalled and WithdrawnAndCalled events #403: This PR modifies the GatewayZEVM contract to enhance event emissions related to deposits and withdrawals, which is directly related to the functionality of the DeployGatewayZEVM contract that manages the deployment of the GatewayZEVM.

Suggested reviewers

  • fadeev
  • CharlieMc0
  • andresaiello
  • brewmaster012
  • 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
🪧 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 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
Copy link

codecov-commenter commented Oct 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.27%. Comparing base (cc56841) to head (ccaacfa).
Report is 1 commits behind head on main.

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

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

🧹 Outside diff range and nitpick comments (1)
v2/scripts/deploy/deterministic/DeployGatewayZEVM.s.sol (1)

50-50: Ensure proper casting of proxy to implementation contract

When casting the gatewayProxy to GatewayZEVM, ensure that the proxy correctly forwards calls to the implementation contract. This casting relies on the assumption that the proxy is set up properly.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between d40d2e2 and f5a7285.

📒 Files selected for processing (1)
  • v2/scripts/deploy/deterministic/DeployGatewayZEVM.s.sol (1 hunks)
🧰 Additional context used

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
v2/.env.sample (1)

13-14: LGTM! Consider adding explanatory comments.

The new environment variables GATEWAY_ADMIN_ADDRESS_ZEVM and WZETA are correctly placed under the "zevm" section and follow the existing naming conventions. This change is consistent with the introduction of the new DeployGatewayZEVM contract.

Consider adding brief comments to explain the purpose of these new variables, similar to the existing comments in the file. For example:

 # zevm
 GATEWAY_PROXY_ZEVM=
 SYSTEM_CONTRACT=
-GATEWAY_ADMIN_ADDRESS_ZEVM=
-WZETA=
+# Address of the gateway admin for ZEVM
+GATEWAY_ADMIN_ADDRESS_ZEVM=
+# Address of the wrapped ZETA token on ZEVM
+WZETA=
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between f5a7285 and 03f388b.

📒 Files selected for processing (2)
  • v2/.env.sample (1 hunks)
  • v2/scripts/deploy/deterministic/DeployGatewayZEVM.s.sol (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • v2/scripts/deploy/deterministic/DeployGatewayZEVM.s.sol
🧰 Additional context used

@skosito skosito merged commit abbfeea into main Oct 23, 2024
11 checks passed
@skosito skosito deleted the deploy-gateway-zevm branch October 23, 2024 20:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants