Refresh depository contract addresses from live Chains API#298
Open
warengonzaga wants to merge 4 commits into
Open
Refresh depository contract addresses from live Chains API#298warengonzaga wants to merge 4 commits into
warengonzaga wants to merge 4 commits into
Conversation
Regenerates the per-chain depository table in references/protocol/addresses.mdx against the current api.relay.link/chains response: - Adds 13 chains newly supported by the API: monad, stable, hyperliquid, tempo, megaeth, plasma, mythos, doma, gensyn, lighter, ethereal, tron, plus the hyperliquid-vm/tron-vm/lighter-vm VM types. - Removes 12 chains no longer returned by the API: mint, appchain (466), polygon_zkevm, gravity, sanko, hychain, powerloom, arena_z, onchain_points, funki, xai, forma. - Renames 8 chains to match current API slugs: bnb->bsc, manta->manta-pacific, worldchain->world-chain, flow->flow-evm, b3->B3, arbitrum_nova->arbitrum-nova, anime->animechain, zero->zero-network. - Updates bitcoin depository address to 1KT3zCYUrmQxjcveUNs1Rs7WcXDcPQZ4av. - Fixes the generator jq snippet in the leading comment (was referencing .protocol.v2.chainId; now matches the actual column output: .name). - Widens VM Type column to fit hyperliquid-vm (14 chars). Prompted by SafePal (Pylon #4519) flagging that newly supported chains were missing from the docs. The Chains API remains the authoritative source; this refresh brings the static page back in sync. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the protocol documentation’s Depository Contracts table to reflect the current api.relay.link/chains response, aligning chain slugs and addresses with live API data.
Changes:
- Refreshes the per-chain Depository Contracts table (adds new chains, removes deprecated ones, renames slugs).
- Updates the bitcoin depository address.
- Fixes the inline
jqgenerator comment to use the correct field for the chain slug.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Rename "EVM Chain Id" column to "Chain ID" since the column now includes non-EVM chains (bitcoin, solana, tron, etc.) whose values are Relay chain IDs, not EVM chain IDs. - Fill in the Relay chain ID for all non-EVM rows (bitcoin, eclipse, soon, tron, solana, lighter) so the column is consistently populated. - Lowercase the b3 slug to match the convention used for other chain slugs in the table and in references/protocol/depository/addresses.mdx. - Add the trailing pipe to the jq format string in the generator comment so regenerated output matches the table format exactly. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Replace the static depository table in references/protocol/addresses.mdx with a live-fetched table rendered by a new /snippets/Depositories.mdx, mirroring the pattern used by /snippets/Chains.mdx and /snippets/Contracts.mdx. New chains added to api.relay.link/chains will now appear automatically without a docs update. Per Pedro's review feedback on PR relayprotocol#298. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The /chains response returns short codes (evm, bvm, svm, tvm, hypevm, lvm). Mapping them to the ethereum-vm / bitcoin-vm / solana-vm / tron-vm / hyperliquid-vm / lighter-vm labels preserves the phrasing the static table used, so integrators scanning the page see consistent wording. Unknown codes fall through unchanged. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
api.relay.link/chainsresponse.jqsnippet in the leading comment (was.protocol.v2.chainId; now correctly.name).Prompted by Pylon #4519 from SafePal (Tier 2 integrator) flagging that newly supported chains were missing from the docs.
Changes in detail
Added (13 rows):
monad,stable,hyperliquid,tempo,megaeth,plasma,mythos,doma,gensyn,lighter,ethereal,tron— plus new VM typeshyperliquid-vm,tron-vm,lighter-vm.Removed (12 rows — please double-check these are truly deprecated):
mint(185),appchain(466),polygon_zkevm(1101),gravity(1625),sanko(1996),hychain(2911),powerloom(7869),arena_z(7897),onchain_points(17071),funki(33979),xai(660279),forma(984122). None of these appear in the default API response or under?includeDisabled=true.Renamed to match API slugs:
bnb→bscmanta→manta-pacificworldchain→world-chainflow→flow-evmb3→B3arbitrum_nova→arbitrum-novaanime→animechainzero→zero-networkAddress update:
bitcoindepository is now1KT3zCYUrmQxjcveUNs1Rs7WcXDcPQZ4av(wasbc1qdqqsq6y7csd0cr3ye45h9lv8ydh777j2wehgl6).Cosmetic: VM Type column widened from 11 to 14 chars to fit
hyperliquid-vm. This is why the diff shows 78 insertions / 78 deletions — most lines are repadding, not content changes.Out of scope
This PR only refreshes the existing depository table. It does not add per-chain columns for
relayReceiver,erc20Router,approvalProxy, or the v3 equivalents. Integrators asking for the "complete contract list" can get those fromapi.relay.link/chainstoday; expanding the docs page to surface them can be a follow-up if desired.Test plan
🤖 Generated with Claude Code