Skip to content

docs: add last GatewayZEVM deployment files #552

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

Merged
merged 1 commit into from
Jul 22, 2025
Merged

Conversation

lumtis
Copy link
Member

@lumtis lumtis commented Jul 21, 2025

Summary by CodeRabbit

  • Chores
    • Added and updated deployment records for the GatewayZEVM contract on chains 7000 and 7001, including new deployment artifacts and refreshed deployment metadata. No changes to application functionality or user-facing features.

@lumtis lumtis requested review from a team as code owners July 21, 2025 14:14
Copy link
Contributor

coderabbitai bot commented Jul 21, 2025

📝 Walkthrough

Walkthrough

This change adds and updates deployment artifact JSON files for the GatewayZEVM contract on chain IDs 7000 and 7001. The new and updated files capture full on-chain deployment details, including transaction, receipt, logs, and metadata such as block hashes, timestamps, and commit hashes. No contract code or logic changes are included.

Changes

File(s) Change Summary
broadcast/DeployGatewayZEVMImplementation.s.sol/7000/run-1751468762.json New deployment artifact JSON for GatewayZEVM on chain 7000, including transaction and receipt data.
broadcast/DeployGatewayZEVMImplementation.s.sol/7000/run-latest.json Updated deployment artifact for GatewayZEVM on chain 7000 with new transaction and receipt details.
broadcast/DeployGatewayZEVMImplementation.s.sol/7001/run-1751469443.json New deployment artifact JSON for GatewayZEVM on chain 7001, including transaction and receipt data.
broadcast/DeployGatewayZEVMImplementation.s.sol/7001/run-latest.json Updated deployment artifact for GatewayZEVM on chain 7001 with new transaction and receipt details.

Estimated code review effort

1 (<30 minutes)

Possibly related PRs

Suggested reviewers

  • s2imonovic
  • fadeev

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@github-actions github-actions bot added the docs Improvements or additions to documentation label Jul 21, 2025
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.10%. Comparing base (2aa2029) to head (8068898).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #552   +/-   ##
=======================================
  Coverage   88.10%   88.10%           
=======================================
  Files          14       14           
  Lines         925      925           
  Branches      166      166           
=======================================
  Hits          815      815           
  Misses        110      110           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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

🧹 Nitpick comments (5)
broadcast/DeployGatewayZEVMImplementation.s.sol/7000/run-latest.json (2)

4-8: Identical deployed address across chains can confuse integrators

contractAddress is identical to the 7001 deployment.
While technically harmless, wallet UIs or block-explorer links that key off address alone may display mixed-chain data. Consider adding a short note to README / docs clarifying that the address is chain-specific despite the bytes being identical.


26-30: Gas usage head-room

gas: 0x4929d6 (≈4.8 M) vs. gasUsed: 0x34f810 (≈3.4 M) leaves >30 % margin.
If you plan to automate main-net deploys, shaving this buffer saves upfront ETH and keeps txns under some chains’ per-block limits. Not urgent for artefacts but worth tightening in the deployment script.

Also applies to: 34-40

broadcast/DeployGatewayZEVMImplementation.s.sol/7001/run-1751469443.json (1)

1-22: Artefact duplication – consider pruning

This file is byte-for-byte the same deployment captured in run-latest.json. Keeping both quickly balloons the repository; most teams keep only run-<timestamp>.json or symlink run-latest.json to the latest timestamped file.

If CI relies on run-latest.json, add a .gitattributes filter or a clean-up step to avoid redundant history.

broadcast/DeployGatewayZEVMImplementation.s.sol/7000/run-1751468762.json (2)

10-15: Consider keeping heavy bytecode blobs out of Git history

The transaction.input field embeds the full creation byte-code (~280 KB). Repeatedly committing these broadcast artifacts quickly balloons the repository and slows down clones & CI.

Options:

  1. Drop the input/bytecode fields before committing (keep only the tx-hash and metadata).
  2. Track broadcast/**/*.json in Git LFS.
  3. Store deployments in an artifact bucket (e.g. S3, IPFS) and reference them from docs.

Evaluate whether full bytecode is required in-repo; if not, pruning/LFS will pay off long-term.


17-18: Minor: redundant chain identifier representation

Both "chainId": "0x1b58" (hex) and top-level "chain": 7000 (decimal) represent the same value. One field is usually enough and avoids accidental divergence on future edits.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2aa2029 and 8068898.

📒 Files selected for processing (4)
  • broadcast/DeployGatewayZEVMImplementation.s.sol/7000/run-1751468762.json (1 hunks)
  • broadcast/DeployGatewayZEVMImplementation.s.sol/7000/run-latest.json (2 hunks)
  • broadcast/DeployGatewayZEVMImplementation.s.sol/7001/run-1751469443.json (1 hunks)
  • broadcast/DeployGatewayZEVMImplementation.s.sol/7001/run-latest.json (2 hunks)
🧰 Additional context used
🧠 Learnings (5)
📓 Common learnings
Learnt from: julianrubino
PR: zeta-chain/protocol-contracts#458
File: broadcast/DeployGatewayEVM.s.sol/43114/run-latest.json:38-40
Timestamp: 2025-02-21T16:34:37.206Z
Learning: Run metadata files (like broadcast/*.json) contain the actual chain IDs where contracts were deployed, which may differ from the target test networks mentioned in PR descriptions, as they record historical deployment transactions.
broadcast/DeployGatewayZEVMImplementation.s.sol/7001/run-1751469443.json (1)

Learnt from: julianrubino
PR: #458
File: broadcast/DeployGatewayEVM.s.sol/43114/run-latest.json:38-40
Timestamp: 2025-02-21T16:34:37.206Z
Learning: Run metadata files (like broadcast/*.json) contain the actual chain IDs where contracts were deployed, which may differ from the target test networks mentioned in PR descriptions, as they record historical deployment transactions.

broadcast/DeployGatewayZEVMImplementation.s.sol/7000/run-latest.json (2)

Learnt from: julianrubino
PR: #458
File: broadcast/DeployGatewayEVM.s.sol/43114/run-latest.json:38-40
Timestamp: 2025-02-21T16:34:37.206Z
Learning: Run metadata files (like broadcast/*.json) contain the actual chain IDs where contracts were deployed, which may differ from the target test networks mentioned in PR descriptions, as they record historical deployment transactions.

Learnt from: lumtis
PR: #488
File: contracts/evm/Registry.sol:137-151
Timestamp: 2025-05-08T11:16:07.319Z
Learning: When maintaining lists or arrays of unique identifiers (like chain IDs) in smart contracts, implement duplicate checks before adding new items to prevent array bloat and potential gas wastage.

broadcast/DeployGatewayZEVMImplementation.s.sol/7000/run-1751468762.json (1)

Learnt from: julianrubino
PR: #458
File: broadcast/DeployGatewayEVM.s.sol/43114/run-latest.json:38-40
Timestamp: 2025-02-21T16:34:37.206Z
Learning: Run metadata files (like broadcast/*.json) contain the actual chain IDs where contracts were deployed, which may differ from the target test networks mentioned in PR descriptions, as they record historical deployment transactions.

broadcast/DeployGatewayZEVMImplementation.s.sol/7001/run-latest.json (1)

Learnt from: julianrubino
PR: #458
File: broadcast/DeployGatewayEVM.s.sol/43114/run-latest.json:38-40
Timestamp: 2025-02-21T16:34:37.206Z
Learning: Run metadata files (like broadcast/*.json) contain the actual chain IDs where contracts were deployed, which may differ from the target test networks mentioned in PR descriptions, as they record historical deployment transactions.

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
  • GitHub Check: generate
  • GitHub Check: slither
  • GitHub Check: test
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (3)
broadcast/DeployGatewayZEVMImplementation.s.sol/7001/run-latest.json (2)

4-8: Double-check deterministic address & nonce consistency

The CREATE2 deployment here (hash 0x66e5…ff8) yields the same resulting contractAddress as the 7000 artefact.
That’s expected only if:

  1. The salt, byte-code and deployer are identical, and
  2. The deployer account nonces are identical (nonce 0xb08 vs. 0x23 in 7000).

Because the nonces differ, the identical address relies solely on CREATE2 salt determinism – good, but worth an explicit confirmation in docs/tests so future deploys don’t accidentally diverge.

Also confirm the "commit" (0fcb39f9) matches the Git commit of the byte-code actually deployed; otherwise downstream reproducibility tools will mis-map artefacts to source.

Also applies to: 16-18


58-61: Timestamp & commit look correct – LGTM

No functional concerns. Metadata fields align with the other 7001 artefacts.

broadcast/DeployGatewayZEVMImplementation.s.sol/7001/run-1751469443.json (1)

58-60: Metadata verified

timestamp, chain, and commit align with the update in the other artefacts – no further action.

@lumtis lumtis merged commit 7d1fac1 into main Jul 22, 2025
16 checks passed
@lumtis lumtis deleted the docs/add-last-zevm-deploy branch July 22, 2025 08:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants