NetworkAndTokens

versionstring

Changes whenever the content does.

updatedAtstring<date-time>

networks object[]

Array [

namestring

Example: ethereum

titlestring

Example: Ethereum

statusstring

Possible values: [Active, Inactive]

chainIdintegernullable

The chain's own id. null on the home network.

assignedChainIdintegernullable

The id a Bitcoin request names the network by. null on the home network.

networkGroupstring

Possible values: [EVM, SVM, TVM, TON, BTC]

modestring

home: where BTC lives. intermediary: TeleBTC is minted and swapped there. crossChain: a TeleSwap contract runs there, so a route can swap on the network. crossChainDirect: no TeleSwap contract; a token arrives 1:1, and an unwrap is a deposit into the network's Across SpokePool (contracts.acrossSpokePool).

Possible values: [home, intermediary, crossChain, crossChainDirect]

slugstring

acrossSupportedboolean

nativeCurrency object

namestring

symbolstring

decimalsinteger

explorer object

txstring

URL template with {hash}

addressstring

URL template with {address}

publicRpcUrlsstring[]

iconstring

colors object

textstring

bgstring

layerZeroEndpointIdintegernullable

sortOrderintegernullable

Lower first. The home network and the rest are ordered apart.

contracts object

Protocol contracts by role, such as connector, wrappedNative and acrossSpokePool.

property name*string

]

tokens object[]

Array [

networkstring

addressstring

In the network's own address form.

symbolstring

namestring

decimalsinteger

tokenIdstringnullable

How a Bitcoin request names the token.

iconstringnullable

isNativeboolean

hiddenboolean

sortOrderintegernullable

Lower first, across networks. Tokens on the home network are ordered apart from the rest.

priceCoinSlugstringnullable

statusstring

Possible values: [Active, Inactive]

wrapRoute objectnullable

BTC → this token. A token on an intermediary network carries only status.

statusstring

Inactive closes this direction, whatever intermediaryChains say.

Possible values: [Active, Inactive]

appIdinteger

acrossSupportedboolean

intermediaryChains object

Keyed by intermediary network name.

property name* WrapRouteIntermediaryChain

statusstring

Possible values: [Active, Inactive]

intermediaryTokenOnIntermediaryChainstring

intermediaryTokenOnIntermediaryChainDecimalsinteger

pathFromTeleBTCToIntermediarystring[]

The swap on the intermediary network, TeleBTC first.

pathFromIntermediaryToOutputTokenstring[]

The swap on the token's network; empty when the token arrives 1:1.

isUniversalboolean

true when the token is reached by a swap on its own network.

pathFromTeleBTCToIntermediaryFeeTiersinteger[]

The pool fee of each hop of pathFromTeleBTCToIntermediary, in millionths.

unwrapRoute objectnullable

This token → BTC. A token on an intermediary network carries only status.

statusstring

Inactive closes this direction, whatever intermediaryChains say.

Possible values: [Active, Inactive]

directDepositboolean

true when the unwrap is a deposit into the network's Across SpokePool.

intermediaryChains object

Keyed by intermediary network name.

property name* UnwrapRouteIntermediaryChain

statusstring

Possible values: [Active, Inactive]

intermediaryTokenOnIntermediaryChainstring

intermediaryTokenOnIntermediaryChainDecimalsinteger

]

NetworkAndTokens

{
  "version": "string",
  "updatedAt": "2024-07-29T15:51:28.071Z",
  "networks": [
    {
      "name": "ethereum",
      "title": "Ethereum",
      "status": "Active",
      "chainId": 0,
      "assignedChainId": 0,
      "networkGroup": "EVM",
      "mode": "home",
      "slug": "string",
      "acrossSupported": true,
      "nativeCurrency": {
        "name": "string",
        "symbol": "string",
        "decimals": 0
      },
      "explorer": {
        "tx": "string",
        "address": "string"
      },
      "publicRpcUrls": [
        "string"
      ],
      "icon": "string",
      "colors": {
        "text": "string",
        "bg": "string"
      },
      "layerZeroEndpointId": 0,
      "sortOrder": 0,
      "contracts": {}
    }
  ],
  "tokens": [
    {
      "network": "string",
      "address": "string",
      "symbol": "string",
      "name": "string",
      "decimals": 0,
      "tokenId": "string",
      "icon": "string",
      "isNative": true,
      "hidden": true,
      "sortOrder": 0,
      "priceCoinSlug": "string",
      "status": "Active",
      "wrapRoute": {
        "status": "Active",
        "appId": 0,
        "acrossSupported": true,
        "intermediaryChains": {}
      },
      "unwrapRoute": {
        "status": "Active",
        "directDeposit": true,
        "intermediaryChains": {}
      }
    }
  ]
}