assetlist.schema.json

{
    "$schema": "https://json-schema.org/draft/2019-09/schema",
    "title": "AssetList",
    "type": "object",
    "required": [
        "chain_name",
        "assets"
    ],
    "properties": {
        "$schema": {
            "type": "string",
            "minLength": 1,
            "pattern": "^(\\.\\./)+assetlist\\.schema\\.json$"
        },
        "chain_name": {
            "type": "string",
            "minLength": 1,
            "pattern": "[a-z0-9]+",
            "examples": [
                "polygon"
            ]
        },
        "assets": {
            "type": "array",
            "default": [],
            "items": {
                "type": "object",
                "description": "An asset on this chain.",
                "required": [
                    "name",
                    "decimals",
                    "symbol",
                    "logo_uri",
                    "coingecko_id"
                ],
                "properties": {
                    "id": {
                        "type": "string",
                        "description": "Only required for native assets. A unique identifier for this asset. A native asset's ID should have the suffix -native. e.g. ethereum-native for ethereum."
                    },
                    "name": {
                        "type": "string",
                        "minLength": 1,
                        "description": "The name of the asset."
                    },
                    "decimals": {
                        "type": "integer",
                        "description": "The decimals value of the asset."
                    },
                    "erc20_contract_address": {
                        "type": "string",
                        "minLength": 1,
                        "pattern": "0x[a-zA-Z0-9]*$",
                        "description": "[OPTIONAL] The ERC20 contract address of the asset."
                    },
                    "denom": {
                        "type": "string",
                        "minLength": 1,
                        "description": "[OPTIONAL] The denomination of the token. Either erc20_contract_address or denom should be defined."
                    },
                    "symbol": {
                        "type": "string",
                        "minLength": 1,
                        "description": "The symbol of the asset."
                    },
                    "logo_uri": {
                        "type": "string",
                        "format": "uri-reference",
                        "minLength": 1,
                        "description": "The logo URI of the asset."
                    },
                    "coingecko_id": {
                        "type": "string",
                        "minLength": 1,
                        "description": "The coingecko ID of the asset."
                    },
                    "axelar_symbol": {
                        "type": "string",
                        "description": "[OPTIONAL] The axelar symbol of the asset."
                    },
                    "axelar_denom": {
                        "type": "string",
                        "description": "[OPTIONAL] The axelar denom of the asset."
                    },
                    "axelar_name": {
                        "type": "string",
                        "description": "[OPTIONAL] The axelar name of the asset."
                    },
                    "go_fast_enabled": {
                        "type": "boolean",
                        "default": false,
                        "description": "[OPTIONAL] If this asset is fast transferable via Skip Go Fast."
                    }
                }
            }
        }
    }
}