Network

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

Network

{
  "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": {}
}