zone.schema.json

{
  "$defs": {
    "asset": {
      "additionalProperties": true,
      "properties": {
        "base_denom": {
          "description": "Base denomination as used for the asset in the Cosmos Chain Registry",
          "type": "string"
        },
        "chain_name": {
          "description": "Chain name as used in the Cosmos Chain Registry",
          "type": "string"
        },
        "chain_name_pretty": {
          "description": "[OPTIONAL] Overriding the 'pretty_name' of an asset's chain. For example Osmosis instead of osmosis or Terra 2.0 instead of terra2.",
          "type": "string"
        },
        "frontend_properties": {
          "description": "Properties that should not follow the Chain Registry, and behave or appear differently on different front ends.",
          "properties": {
            "additional_information": {
              "description": "[OPTIONAL] A list of up to 10 objects that have key:value pairs. Example {'chain_website': 'link'}, this will generally be utilized for front-ends.",
              "items": {
                "type": "object"
              },
              "maxItems": 10,
              "type": "array"
            },
            "coingecko_id": {
              "description": "[OPTIONAL] The coingecko id to fetch asset data from coingecko v3 api. See https://api.coingecko.com/api/v3/coins/list",
              "type": "string"
            },
            "description": {
              "description": "[OPTIONAL] An override string for the asset. ",
              "type": "string"
            },
            "keywords": {
              "description": "[OPTIONAL] An array of up to 20 keywords to describe the asset. Examples are: Native, Derivative, Liquid-Staked, Wrapped/Bridged, Fiat-Collateralized, Anchored, Utility, Reflexive",
              "items": {
                "type": "string"
              },
              "maxItems": 20,
              "type": "array"
            },
            "logo_URIs": {
              "description": "[OPTIONAL] Overrides for logo images. These should be uploaded under /images/<chain_name>/<symbol>.png or .svg",
              "properties": {
                "png": {
                  "type": "string"
                },
                "svg": {
                  "type": "string"
                }
              },
              "type": "object"
            },
            "pretty_path": {
              "description": "[OPTIONAL] A single string representing a bridged token. For example: Ethereum to Axelar",
              "type": "string"
            },
            "symbol": {
              "description": "Overriding symbol of an asset. For example WBTC.axl instead of WBTC",
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "required": [
        "chain_name",
        "base_denom"
      ],
      "type": "object"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema",
  "additionalProperties": false,
  "description": "A basic list of assets, in order as shown on front-ends with optional overrides.",
  "properties": {
    "$schema": {
      "type": "string"
    },
    "assets": {
      "items": {
        "$ref": "#/$defs/asset"
      },
      "type": "array"
    },
    "chain_name": {
      "type": "string"
    }
  },
  "required": [
    "$schema",
    "chain_name",
    "assets"
  ],
  "title": "Zone List",
  "type": "object"
}