schema.token.json

{
  "$id": "https://evmos.org/schema.token.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Token Schema Registry via Evmos Governance",
  "type": "object",
  "properties": {
    "coinDenom": {
      "type": "string",
      "description": "Coin denom representation, i.e BTC "
    },
    "minCoinDenom": {
      "type": "string",
      "description": "Minimal coin denom, i.e. satoshi for Bitcoin"
    },
    "img": {
      "type": "object",
      "required": ["png"],
      "properties": {
        "png": {
          "type": "string",
          "description": "Link must be png source. If this image is coming from Github, make sure it has a pattern of 'https://raw.githubusercontent.com/cosmos/chain-registry/master/${chain}/images/${coin}.png' and the link directly opens the image only and not the site of Github with the image.",
          "pattern": "^https://raw\\.githubusercontent\\.com/evmos/chain-token-registry/main/assets/tokens/.+\\.png$"
        },
        "svg": {
          "type": "string",
          "description": "Link must be SVG link only. If this image is coming from Github, make sure it has a pattern of 'https://raw.githubusercontent.com/cosmos/chain-registry/master/${chain}/images/${coin}.svg' and the link directly opens the image only and not the site of Github with the image.",
          "pattern": "^https://raw\\.githubusercontent\\.com/evmos/chain-token-registry/main/assets/tokens/.+\\.svg$"
        }
      }
    },
    "type": {
      "type": "string",
      "enum": ["IBC", "ERC-20", "CW20"]
    },
    "exponent": {
      "type": "string"
    },
    "cosmosDenom": {
      "type": "string",
      "description": "Starting with ibc/..."
    },
    "description": {
      "type": "string",
      "description": "Coin description goes here. This description will be used to describe the coin to the user. Please keep it concise."
    },
    "name": {
      "type": "string",
      "description": "Official name of the coin, i.e. EVMOS"
    },
    "tokenRepresentation": {
      "type": "string",
      "description": "Single token representation,i.e. EVMOS, it's the grouping key for the assets page"
    },
    "channel": {
      "type": "string",
      "description": "Channel must be active. Check https://www.mintscan.io/evmos/relayers and find the right network to see which channel is open on both ends. The value wanted here is the From side of Evmos."
    },
    "isEnabled": {
      "type": "boolean",
      "default": true,
      "description": "Default to true"
    },
    "erc20Address": {
      "type": "string",
      "description": "Hex address only, i.e. 0x. Can be found on the Evmos API TokenPairs endpoint. This field will be populated when the token passes governance."
    },
    "ibc": {
      "type": "object",
      "properties": {
        "sourceDenom": {
          "type": "string",
          "description": "There are two states for sourceDenom. Main chain coins like EVMOS will have their minCoinDenom listed here, however, coins from that ecosystem other than the main coin will require its prefix+hexAddress, i.e. gravity0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48 for Gravity's USDC.grv"
        },
        "source": {
          "type": "string",
          "description": "Chain name, i.e. Cosmos or Osmosis"
        }
      }
    },
    "hideFromTestnet": {
      "type": "boolean",
      "default": false,
      "description": "If network does not have testnet and the coin is not in the testnet via governance or other means, mark this as true, otherwise, leave as is."
    },
    "coingeckoId": {
      "type": "string",
      "description": "Official string coingecko uses to search and load the asset. Please insure the text matches exactly."
    },
    "category": {
      "type": "string",
      "description": "Select a parental category of this asset. If a category does not exist, please feel free to create a PR to update the schema. For example, all wrapped token are part of the parent category, gWBTC is 'bitcoin'.",
      "default": "none",
      "enum": [
        "bitcoin",
        "ethereum",
        "stablecoin",
        "cosmos",
        "polygon",
        "none",
        "solana"
      ]
    },
    "coinSourcePrefix": {
      "type": "string",
      "description": "Use this field to declare if the coin is part of a network's ecosystem, like for example, gWBTC is part of Gravity. If the coin is the main network coin, then the response will be itself still. the string here should match the network prefix."
    },
    "handledByExternalUI": {
      "type": "array",
      "items": {
        "type": "object",
        "required": ["url", "handlingAction"],
        "properties": {
          "url": {
            "type": "string",
            "description": "Link to the external UI site"
          },
          "handlingAction": {
            "type": "string",
            "enum": [
              "Deposit",
              "Withdraw",
              "Convert",
              "Deposit and Withdraw",
              "All"
            ],
            "description": "Specify if the external UI is for Deposit, Withdraw, Convert, or others."
          }
        }
      }
    }
  },
  "required": [
    "coinDenom",
    "minCoinDenom",
    "type",
    "exponent",
    "cosmosDenom",
    "description",
    "name",
    "tokenRepresentation",
    "channel",
    "erc20Address",
    "ibc",
    "coingeckoId",
    "coinSourcePrefix",
    "category",
    "img"
  ]
}