README.md

rainbow-token-list

Available at https://metadata.p.rainbow.me/token-list/rainbow-token-list.json published twice a day, or manually.

Usage

curl https://metadata.p.rainbow.me/token-list/rainbow-token-list.json

Returns a JSON file containing a list of supported tokens in Rainbow.

The CDN delivering the file supports:

• Content-Encoding: gzip/Accept-Encoding: gzip, deflate
• ETag/If-None-Match

How

rainbow-token-list.json can be generated by the following steps:

git clone https://github.com/rainbow-me/rainbow-token-list.git
cd rainbow-token-list
yarn
yarn build

The output will be generated in the output directory.

Publishing schedule

The token list published to https://metadata.p.rainbow.me/token-list/rainbow-token-list.json is generated on a CRON schedule in a github action.

It is published every 12 hours.

What

Rainbow token list contains data similar to the following example:

{
  "keywords": [
    "rainbow"
  ],
  "logoURI": "https://avatars0.githubusercontent.com/u/48327834?s=200&v=4",
  "name": "Rainbow Token List",
  "timestamp": "2021-10-06T16:33:31.459Z",
  "tokens": [
    {
      "address": "0x68A118Ef45063051Eac49c7e647CE5Ace48a68a5",
      "chainId": 1,
      "decimals": 18,
      "name": "Based Money",
      "symbol": "$BASED",
      "extensions": {
        "color": "#00ADD5",
        "isRainbowCurated": true,
        "isVerified": true
      }
    },
    {
      "address": "0x4E84E9e5fb0A972628Cf4568c403167EF1D40431",
      "chainId": 1,
      "decimals": 18,
      "name": "$Fluzcoin",
      "symbol": "$FFC"
    }
  ],
  "version": {
    "major": 1,
    "minor": 2,
    "patch": 1
  }
}

Note that some of the tokens include extensions which can be customize in the rainbow-overrides.json file. These are used to customize how tokens are display in Rainbow.

TODO...