-
Notifications
You must be signed in to change notification settings - Fork 67
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
Conversation
📝 WalkthroughWalkthroughThis change adds and updates deployment artifact JSON files for the Changes
Estimated code review effort1 (<30 minutes) Possibly related PRs
Suggested reviewers
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
Documentation and Community
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. 🚀 New features to boost your workflow:
|
There was a problem hiding this 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 pruningThis file is byte-for-byte the same deployment captured in
run-latest.json
. Keeping both quickly balloons the repository; most teams keep onlyrun-<timestamp>.json
or symlinkrun-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 historyThe
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:
- Drop the
input
/bytecode
fields before committing (keep only the tx-hash and metadata).- Track
broadcast/**/*.json
in Git LFS.- 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 representationBoth
"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
📒 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 consistencyThe CREATE2 deployment here (
hash 0x66e5…ff8
) yields the same resultingcontractAddress
as the 7000 artefact.
That’s expected only if:
- The salt, byte-code and deployer are identical, and
- 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 – LGTMNo 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
, andcommit
align with the update in the other artefacts – no further action.
Summary by CodeRabbit