provides metadata for chains
Go to file
2022-01-05 15:25:33 +01:00
_data Backfill more title fields and shorten corresponding names 2022-01-05 15:25:33 +01:00
.ci Add test stage 2020-11-13 04:19:30 +01:00
.github Create dependabot.yml 2021-10-10 16:55:57 +02:00
gradle/wrapper Use gradle 7.3.3 2021-12-30 07:06:43 +01:00
model Bump version to 1.1 2021-12-31 09:50:12 +01:00
processor Deprecate the 'network' field 2021-12-31 09:48:32 +01:00
.gitignore add Gather chains (#598) 2021-11-29 10:43:31 +01:00
build.gradle Bump gradle-versions-plugin from 0.39.0 to 0.40.0 (#720) 2021-12-30 23:21:18 +01:00
gradlew Use gradle 7.2 2021-09-14 13:38:05 +02:00
gradlew.bat
LICENSE
README.md Add projects 2022-01-04 11:52:15 +01:00
settings.gradle.kts Split out the model to extra module 2021-12-30 07:38:32 +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",
  "network": "mainnet",
  "rpc": [
    "https://mainnet.infura.io/v3/${INFURA_API_KEY}",
    "https://api.mycryptoapi.com/eth"
  ],
  "faucets": [],
  "nativeCurrency": {
    "name": "Ether",
    "symbol": "ETH",
    "decimals": 18
  },
  "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 optional - but when one is there then the other must be there also
  • 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.

Aggregation

There are also aggregated json files with all chains automatically assembled:

Collision management

If different chains have the same chainID we list the one with the oldest genesis.

Usages