Skip to content

cowprotocol/token-lists

Repository files navigation

Token Lists

CoW Swap default token lists and token image repository

Managing the tokens

The process has been automated, and it's now much simpler. The forms are self-explanatory and should contain all the info you need to proceed.

Notes:

  • Images will be optimized in the background
  • If you want to add a token/image to multiple networks, create one issue per network

Head to the issues section and pick your action:

Add or update token

For adding tokens to CoW Swap's default token list, or to update an existing one, use the Add Token form.

Remove token from the list

Use the Remove Token form.

Even though the token is removed from the default list, its image will be kept.

Add or update image only

Not all tokens should be in the default token list, but the more token images we have the better UX.

For this, use the Add Image form.

Flow overview

flowchart TD
    Start(User: Picks form) --> UserFillsForm(User: Fills in form and creates issue)
    UserFillsForm --> |Form ok| ImageProcessed("Automated: [Optional] Optimize image")
    ImageProcessed --> PRCreated(Automated: Creates Pull Request)
    ImageProcessed --> |Failed to process image| AutomatedIssueClosure
    PRCreated --> TeamReview(Team: Reviews Pull Request)
    UserFillsForm --> |Form invalid| AutomatedIssueClosure(Automated: Closes issue)
    TeamReview --> |Request approved| TeamMergesPR(Team: Merges Pull Request)
    TeamReview --> |Request rejected| TeamClosesPR(Team: Closes Pull Request and Issue)

Loading

Development

Instructions for setting up and running the various scripts locally

Setup

# Install dependencies
yarn

# Generate Coingecko list
yarn coingecko

Download images

There's a script that will fetch all images form the CowSwap list and store them in src/public/images/<chainId>/<address>.png

yarn downloadImages

Generating Auxiliary Token Lists

To generate updated token lists from Coingecko and Uniswap:

yarn generateAuxLists

This script fetches and processes token data from both Coingecko and Uniswap APIs to create auxiliary token lists. These lists are used to enhance token metadata and support across different networks.

  • Coingecko lists contain up to the top 500 tokens per chain, sorted by volume
  • Uniswap lists are a combination of:
    • Token for given chain already existing in the default Uniswap list
    • Mainnet tokens, mapped to the target chain, via Coingecko api

The version and timestamp are bumped according to token list standard.

Required Environment Variables

  • COINGECKO_API_KEY: Your Coingecko API key (required for API access)

Generated Files

The script generates token list files in src/public/ for the following networks:

  • Ethereum (CoinGecko.1.json)
  • Arbitrum (CoinGecko.42161.json, Uniswap.42161.json)
  • Base (CoinGecko.8453.json, Uniswap.8453.json)
  • Gnosis Chain (CoinGecko.100.json, Uniswap.100.json)