provides metadata for chains
Go to file
2023-03-13 10:09:23 +01:00
_data Remove unused icons 2023-03-13 10:03:31 +01:00
.ci
.github Now that the file is there we can use the gatsby build 2023-01-23 08:14:14 +01:00
gradle/wrapper Use gradle 8.0.2 (#2367) 2023-03-06 07:29:04 +01:00
httpsloader Add initial httpsloader (#2104) 2023-01-07 11:28:37 +01:00
model Remove a leftover from commit a3cd16b7a7 (#2370) 2023-03-06 17:19:23 +01:00
processor Detect unused icons 2023-03-13 10:09:23 +01:00
tools Updated "standard" attribute description (#2282) 2023-02-15 22:48:52 +01:00
website@e573725226 Use new website version (with icons now) 2023-01-23 16:52:25 +01:00
.gitignore suggest to run gradle before submitting PR; (#2284) 2023-02-16 20:48:31 +01:00
.gitmodules Add chainlist website as submodule 2023-01-23 07:21:57 +01:00
.jitpack.yml Tell jitpack to use openjdk 11 (#2105) 2023-01-07 12:04:41 +01:00
.prettierignore Added Prettier and formatted existing JSON files (#1501) 2022-08-27 19:20:08 +02:00
.prettierrc.json Added Prettier and formatted existing JSON files (#1501) 2022-08-27 19:20:08 +02:00
build.gradle Bump com.github.ben-manes:gradle-versions-plugin from 0.45.0 to 0.46.0 (#2307) 2023-02-21 00:07:48 +01:00
gradlew Use gradle 8.0.1 (#2306) 2023-02-20 03:52:26 +01:00
gradlew.bat Use gradle 7.6 2022-11-27 10:16:17 +01:00
LICENSE
maintainer_checklist.md Update maintainer_checklist.md 2022-11-03 22:41:59 +01:00
README.md Add EvmChain.info app for chainlist (#2366) 2023-03-06 07:29:17 +01:00
settings.gradle.kts Add initial httpsloader (#2104) 2023-01-07 11:28:37 +01:00

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 ans extension.

Example

{
  "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 a 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 jsons look like this:


[
    {
      "url": "ipfs://QmdwQDr6vmBtXmK2TmknkEuZNoaDqTasFdZdu3DRw8b2wt",
      "width": 1000,
      "height": 1628,
      "format": "png"
    }
]

where:

  • the URL must be a IPFS url that is publicly resolveable
  • width and height are positive integers
  • format is either "png", "jpg" or "svg"

If the chain is an L2 or a shard of another chain you can link it to the parent chain like this:

{
  ...
  "parent": {
   "type" : "L2",
   "chain": "eip155-1",
   "bridges": [ {"url":"https://bridge.arbitrum.io"} ]
  }
}

where you need to specify type 2 and the reference to an existing parent. The field about bridges is optional.

You can add a status field e.g. to deprecate 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:

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 a 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 request 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 you will get the redFlag "reusedChaiID" that should be displayed in clients to warn them about the dangers here.

PR verification

Before submitting a PR, please verify that checks pass with:

$ ./gradlew run

BUILD SUCCESSFUL in 7s
9 actionable tasks: 9 executed

Usages

Wallets

Explorers

EIPs

  • EIP-155
  • EIP-3014
  • EIP-3770
  • EIP-4527

Listing sites

Other