+2
Daily
9,838
stars
8,238
forks
554
watchers
6,925
prs
1,449
issues
0
releases
README
EVM-based Chains
The source data is in _data/chains. Each chain has its own file with the filename being the CAIP-2 representation as name and .json as extension.
Example:
json
{
"name": "Ethereum Mainnet",
"chain": "ETH",
"rpc": [
"https://mainnet.infura.io/v3/${INFURA_API_KEY}",
"https://api.mycryptoapi.com/eth"
],
"faucets": [],
"nativeCurrency": {
"name": "Ether",
"symbol": "ETH",
"decimals": 18
},
"features": [{ "name": "EIP155" }, { "name": "EIP1559" }],
"infoURL": "https://ethereum.org",
"shortName": "eth",
"chainId": 1,
"networkId": 1,
"icon": "ethereum",
"explorers": [{
"name": "etherscan",
"url": "https://etherscan.io",
"icon": "etherscan",
"standard": "EIP3091"
}]
}
When an icon is used in either the network or an explorer, there must be a JSON in _data/icons with the name used.
(e.g. in the above example there must be a ethereum.json and a etherscan.json in there) - The icon JSON files look like this:
json
[
{
"url": "ipfs://QmdwQDr6vmBtXmK2TmknkEuZNoaDqTasFdZdu3DRw8b2wt",
"width": 1000,
"height": 1628,
"format": "png"
}
]
where:
The URL MUST be publicly resolvable through IPFS
width and height MUST be positive integers
format is either "png", "jpg" or "svg"
size MUST be less than 250kb
If the chain is an L2 or a shard of another chain you can link it to the parent chain like this:
json
{
...
"parent": {
"type" : "L2",
"chain": "eip155-1",
"bridges": [ {"url":"https://bridge.arbitrum.io"} ]
}
}
where you need to specify the type and the reference to an existing parent. The field about bridges is optional.
You can add a status field e.g. to deprecate (via status deprecated) a chain (a chain should never be deleted as this would open the door to replay attacks)
Other options for status are active (default) or incubating
Aggregation
There are also aggregated json files with all chains automatically assembled:
https://chainid.network/chains.json
https://chainid.network/chains_mini.json (miniaturized - fewer fields for smaller filesize)
Constraints
the shortName and name MUST be unique - see e.g. EIP-3770 on why
if referencing a parent chain - the chain MUST exist in the repo
if using an IPFS CID for the icon - the CID MUST be retrievable via ipfs get - not only through some gateway (means please do not use pinata for now)
for more constraints you can look into the CI
Collision management
We cannot allow more than one chain with the same chainID - this would open the door to replay attacks.
The first pull request gets the chainID assigned. When creating a chain we can expect that you read EIP155 which states this repo.
All pull requests trying to replace a chainID because they think their chain is better than the other will be closed.
The only way to get a chain reassigned is when the old chain gets deprecated. This can e.g. be used for testnets that are short-lived. But then youTop issues
#4833Idea: Add L2 Configuration Fields8 comments · 2024-04-12#2373Field "chain" is used twice with different meaning/definition7 comments · 2023-03-07#1889API v2 6 comments · 2022-11-18#49scheduled chain releases 4 comments · 2019-03-29#3Add consensus_type field6 comments · 2018-12-20#1935Backfill features and add EIPs5 comments · 2022-11-24#99Deploy to ENS5 comments · 2020-06-19#97Feature request: sort by id5 comments · 2020-05-25