osmo-support-lab / assetlists

Assetlists for the Interchain. Maintained by the Osmosis Support Lab.

Interchain Asset Lists

Asset lists are inspired by the Token Lists project on Ethereum, which helps discoverability of ERC20 tokens by mapping ERC20 contracts to their associated metadata.

Asset Lists offer a similar mechanism to allow frontends and other UIs to fetch metadata associated with Cosmos SDK denominations, especially for assets sent over IBC, although, this standard is a work in progress. You'll notice that the format of assets in the <chain_id>.assetlist.json structure is a strict superset json representation of the banktypes.DenomMetadata from the Cosmos SDK. This is purposefully done so that this standard may eventually be migrated into a Cosmos SDK module in the future and so it can be easily maintained on chain instead of on GitHub.

The assetlist JSON Schema can be found at the Chain Registry here.

Steps to add assets

The <chain_id>.assetlist.json files herein are automatically generated, which will be triggered by additions to the corresponding <chain_name>.zone.json file in the future. For now, the generation is manually done in order to properly select a chain to generate assets for. The metadata is fetched from the Cosmos Chain Registry.

Step 1: Cosmos Chain Registry Additions

1. Ensure asset is added to the chains assetlist.json and image added to the images folder on Cosmos Chain Registry.
2. Ensure an IBC connection between chains are established and the proper IBC information is added to the _IBC folder on Cosmos Chain Registry.

Step 2: How to Add Assets to this repository

To add an asset:

1. Create a new entry at the very bottom of the <chain_id>/<chain_name>.zone.json file, containing the asset's base denom and chain name.

...
{
  "chain_name": "fooChain",
  "base_denom": "ubar"
}

• chain_name must be the exact value defined as chain_name for the chain in the Chain Registry -- it is also the name of the chain's directory in the Chain Registry.
• base_denom is the indivisible, minimal (exponent 0) denomination unit for the asset, which is also the value defined as base for the asset in the Chain Registry.
  • Import note for CW20 assets: All CW20 assets must begin with cw20: and then be followed by their contract address.

Modifications to standard metadata

This repository allows for overrides for certain metadata. Those overrides are:

• symbol
• logo_URIs
• coingecko_id

For example:

    {
      "frontend_properties": {
        "symbol": "wMATIC.axl",
        "logo_URIs": {
          "png": "https://raw.githubusercontent.com/osmo-support-lab/assetlists/main/images/wmatic.png",
          "svg": "https://raw.githubusercontent.com/osmo-support-lab/assetlists/main/images/wmatic.svg"
        },
        "coingecko_id": "wmatic"
      }
    },

<chain_name>.zone.json Example

An example asset object in osmosis.zone.json:

...
{
  "chain_name": "osmosis",
  "base_denom": "uosmo"
},
{
  "chain_name": "axelar",
  "base_denom": "wmatic-wei",
  "frontend_properties": {
    "symbol": "wMATIC.axl",
      "logo_URIs": {
        "png": "https://raw.githubusercontent.com/osmo-support-lab/assetlists/main/images/wmatic.png",
        "svg": "https://raw.githubusercontent.com/osmo-support-lab/assetlists/main/images/wmatic.svg"
    }
  }
}

<chain_id>.assetlist.json Example

An example generated assetlist JSON file:

{
  "chain_name": "osmosis",
  "assets": [
    {
      "description": "The native token of Osmosis",
      "denom_units": [
        {
          "denom": "uosmo",
          "exponent": 0
        },
        {
          "denom": "osmo",
          "exponent": 6
        }
      ],
      "base": "uosmo",
      "name": "Osmosis",
      "display": "osmo",
      "symbol": "OSMO",
      "logo_URIs": {
        "png": "https://raw.githubusercontent.com/cosmos/chain-registry/master/osmosis/images/osmo.png",
        "svg": "https://raw.githubusercontent.com/cosmos/chain-registry/master/osmosis/images/osmo.svg"
      },
      "coingecko_id": "osmosis",
      "keywords": [
        "dex",
        "staking"
      ]
    },
    {
      "description": "Wrapped Matic on Axelar",
      "denom_units": [
        {
          "denom": "ibc/AB589511ED0DD5FA56171A39978AFBF1371DB986EC1C3526CE138A16377E39BB",
          "exponent": 0,
          "aliases": [
            "wmatic-wei"
          ]
        },
        {
          "denom": "wmatic",
          "exponent": 18
        }
      ],
      "base": "ibc/AB589511ED0DD5FA56171A39978AFBF1371DB986EC1C3526CE138A16377E39BB",
      "name": "Wrapped Matic",
      "display": "wmatic",
      "symbol": "wMATIC.axl",
      "traces": [
        {
          "type": "bridge",
          "counterparty": {
            "chain_name": "polygon",
            "base_denom": "0x0d500b1d8e8ef31e21c99d1db9a6444d3adf1270"
          },
          "provider": "Axelar"
        },
        {
          "type": "ibc",
          "counterparty": {
            "chain_name": "axelar",
            "base_denom": "wmatic-wei",
            "channel_id": "channel-3"
          },
          "chain": {
            "channel_id": "channel-208",
            "path": "transfer/channel-208/wmatic-wei"
          }
        }
      ],
      "logo_URIs": {
        "png": "https://raw.githubusercontent.com/osmo-support-lab/assetlists/main/images/wmatic.png",
        "svg": "https://raw.githubusercontent.com/osmo-support-lab/assetlists/main/images/wmatic.svg"
      }
    },
  ]
}

Add a chain for automatic processing

We encourage anyone to utilize this repository to utilize an easy to maintain assetlist for a chain. We will be working to add as many chains as possible as well.

The steps to add a new chain are:

1. Create a new folder named the chain id from the Cosmos Chain Registry (e.g. evmos_9001-2 for Evmos)
2. Create a file within that folder called: <chain_name>.zone.json (e.g. evmos.zone.json for Evmos.)
3. Copy the following template into that folder:

{
  "$schema": "../zone.schema.json",
  "chain_name": "fooChain",
  "assets": [
    {
      "chain_name": "fooChain",
      "base_denom": "uFoo"
    }
  ]
}

4. Replace the placeholders with the real information.
5. Navigate to .github/workflows/generate_assetlist.yml
6. Edit under the inputs: section the chain name and id appropriately. For example:

    inputs:
      chain_id_selection:
        description: 'Chain ID Selection'
        required: true
        default: 'osmosis-1'
        type: choice
        options:
          - osmosis-1
          - juno-1
          - fooChain-1 # Always put the new chain underneath the last available option.
      chain_name_selection:
        description: 'Chain NAME Selection'
        default: 'osmosis'
        type: choice
        options:
          - osmosis
          - juno
          - fooChain # Always put the new chain underneath the last available option.

Credits

• Originally built from osmosis-labs/assetlists with original scripts built by Jeremy Parish