Skip to main content

Network

chainIdstringrequired

Chain id of the serving network. Clients build the assign presence proof with it (corelayer/assign/v1|<chainId>|<sender>|<serverTimeMs>), key their contract-address pin and relayer-verification cache by it, and must refuse to sign when it differs from the chainID of the transaction or from network.chainId in pricing.json. The owner, the relayers and possibly the contract address are the same on devnet and mainnet, so an address never tells the networks apart.

Possible values: [1, D]

caip2string
Examples:
Example: mvx:1
roundDurationMsintegerrequired
minGasPriceinteger<int64>required
maxGasPriceinteger<int64>required

2 x minGasPrice. A normal submission may not use a higher gas price.

minGasLimitintegerrequired
gasPerDataByteintegerrequired
extraGasRelayedintegerrequired
extraGasGuardedintegerrequired
gasPriceModifierstringrequired
maxGasPerTransactioninteger<int64>required
readAtEpochinteger
contractstring | nullnullablerequired

CoRelayer contract address, for convenience. Pin the address in your own configuration; your pin wins if the two disagree.

ruScheduleVersioninteger
serverTimeMsinteger<int64>required

Unix time in milliseconds.

Possible values: >= 0

chainTimeMsinteger<int64>

timestampMs of the newest shard-1 block ingested.

Possible values: >= 0

swapVenue objectrequired
pausedbooleanrequired
pairStateinteger
wrapperPausedboolean
tokenPausedboolean
checkedAtMsinteger<int64>required

Unix time in milliseconds.

Possible values: >= 0

contractPause object

The CoRelayer contract's getPauseState(), re-read every 6 000 ms. all or deposits true -> purchase routes answer CONTRACT_PAUSED. The contract is deployed paused.

allbooleanrequired
depositsbooleanrequired
checkedAtMsinteger<int64>required

Unix time in milliseconds.

Possible values: >= 0

paymentTokenstring

ESDT identifier from the contract configuration: USDC-c76f1f on mainnet, USDC-350c4e on devnet staging.

Example: USDC-c76f1f
nativeAuth object

Recent shard-1 block for headless agents that build a native-auth token themselves. Tokens must embed a shard-1 block hash (security scheme nativeAuth). Refreshed with every ingested shard-1 block.

blockHashHex32required

Possible values: Value must match regular expression ^[0-9a-f]{64}$

blockTsMsinteger<int64>required

Unix time in milliseconds.

Possible values: >= 0

shardintegerrequired
Constant value: 1
originstring<uri>

The fixed headless-agent origin string to put into the token (https://agent.co-relayer.com on mainnet).

shards object[]required
  • Array [
    • shardShardrequired

    Possible values: [0, 1, 2]

    statusComponentStatusrequired

    Possible values: [operational, degraded, partial_outage, major_outage, maintenance]

    activeRelayersinteger
    relays24hinteger

    Customer relays of this shard in the last 86 400 000 ms; synthetic probes excluded.

    windowMsinteger<int64>

    Possible values: >= 0

    samplesinteger
    inclusionP50Msinteger | nullnullable
    inclusionP95Msinteger | nullnullable
    inclusionP99Msinteger | nullnullable
    addedP50Msinteger | nullnullable
    addedP99Msinteger | nullnullable
    lastBlockTsMsinteger<int64>

    Unix time in milliseconds.

    Possible values: >= 0

    stalledboolean
  • ]
    • directHostsstring<uri>[]

    Regional API hosts to fail over to when the main host does not answer: https://fsn.api.co-relayer.com and https://hel.api.co-relayer.com (devnet has its own). They send the same CORS headers as the main host, so browsers can use them.

    Network
    {
      "chainId": "1",
      "caip2": "mvx:1",
      "roundDurationMs": 0,
      "minGasPrice": 0,
      "maxGasPrice": 0,
      "minGasLimit": 0,
      "gasPerDataByte": 0,
      "extraGasRelayed": 0,
      "extraGasGuarded": 0,
      "gasPriceModifier": "string",
      "maxGasPerTransaction": 0,
      "readAtEpoch": 0,
      "contract": "string",
      "ruScheduleVersion": 0,
      "serverTimeMs": 0,
      "chainTimeMs": 0,
      "swapVenue": {
        "paused": true,
        "pairState": 0,
        "wrapperPaused": true,
        "tokenPaused": true,
        "checkedAtMs": 0
      },
      "contractPause": {
        "all": true,
        "deposits": true,
        "checkedAtMs": 0
      },
      "paymentToken": "USDC-c76f1f",
      "nativeAuth": {
        "blockHash": "string",
        "blockTsMs": 0,
        "shard": 1,
        "origin": "string"
      },
      "shards": [
        {
          "shard": 0,
          "status": "operational",
          "activeRelayers": 0,
          "relays24h": 0,
          "windowMs": 0,
          "samples": 0,
          "inclusionP50Ms": 0,
          "inclusionP95Ms": 0,
          "inclusionP99Ms": 0,
          "addedP50Ms": 0,
          "addedP99Ms": 0,
          "lastBlockTsMs": 0,
          "stalled": true
        }
      ],
      "directHosts": [
        "string"
      ]
    }