Skip to main content

Intent

intentIdIntentIdrequired

<sender bech32>:<nonce> - the natural intent key (sender, nonce).

Possible values: Value must match regular expression ^erd1[02-9ac-hj-np-z]{58}:[0-9]{1,20}$

senderAddressrequired

MultiversX bech32 address.

Possible values: Value must match regular expression ^erd1[02-9ac-hj-np-z]{58}$

Example: erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e
nonceinteger<int64>required
txHashTxHash

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

relayerAddress

MultiversX bech32 address.

Possible values: Value must match regular expression ^erd1[02-9ac-hj-np-z]{58}$

Example: erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e
shardShard

Possible values: [0, 1, 2]

receiverAddress

MultiversX bech32 address.

Possible values: Value must match regular expression ^erd1[02-9ac-hj-np-z]{58}$

Example: erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e
functionstring | nullnullable

First data segment when printable ASCII, else null. Rendered as text, never as HTML.

stateIntentStaterequired

Possible values: [ASSIGNED, RECEIVED, REJECTED, ACCEPTED, COSIGNED, BROADCAST, EXECUTED_OK, EXECUTED_FAIL, DEAD, EXPIRED_LOCALLY_STILL_VALID]

finalbooleanrequired

True when the executing block is final - the billing trigger.

rejectCodeErrorCode

Stable machine-readable error code. The enum is open: treat an unknown code by its HTTP status and retryable. CONTRACT_PAUSED (503, resign: SAME_BYTES, retryable) means the CoRelayer contract itself is paused (paused / deposits_paused; contract errors ERR_PAUSED / ERR_DEPOSITS_PAUSED). The relay path, the prepare routes, the purchase pre-check and x402 can all return it. SWAP_VENUE_PAUSED means only the exchange venue is paused.

Possible values: [MALFORMED_REQUEST, VARIANTS_NOT_SUPPORTED, RELAYER_SIGNATURE_PRESENT, CHAIN_ID_MISMATCH, TX_VERSION_UNSUPPORTED, TX_OPTIONS_UNSUPPORTED, LEASE_MISSING, LEASE_INVALID, LEASE_MISMATCH, LEASE_EXPIRED, NONCE_PIN_MISMATCH, RESIGN_REQUIRED, RESIGN_SAME_NONCE, REPLACEMENT_UNDERPRICED, INTENT_ALREADY_EXECUTED, NOTHING_TO_CANCEL, NONCE_TOO_LOW, NONCE_IN_FLIGHT, NONCE_GAP, TOO_MANY_IN_FLIGHT, RELAYER_UNKNOWN, RELAYER_SHARD_MISMATCH, RELAYER_RETIRED, GAS_PRICE_OUT_OF_RANGE, GAS_LIMIT_TOO_LOW, GAS_LIMIT_TOO_HIGH, GAS_OVERPROVISIONED, DATA_TOO_LARGE, RECEIVER_NOT_ALLOWED, SENDER_SIGNATURE_INVALID, GUARDIAN_SIGNATURE_INVALID, GUARDIAN_REQUIRED, GUARDIAN_MISMATCH, GUARDIAN_IS_RELAYER, INSUFFICIENT_SENDER_BALANCE, SIMULATION_FAILED, SWAP_VENUE_PAUSED, CONTRACT_PAUSED, ASSIGN_PROOF_REQUIRED, ASSIGN_PROOF_INVALID, FREE_FLOW_BUSY, FREE_FLOW_BARRED, FREE_FLOW_UNAVAILABLE, INTENT_ALREADY_SUBMITTED, HOURLY_BURN_EXCEEDED, SIGNER_TIMEOUT, NO_ENTITLEMENT, SENDER_NOT_AUTHORIZED, QUOTA_EXHAUSTED, RATE_LIMITED, GAS_BUDGET_EXCEEDED, NO_RELAYER_AVAILABLE, UPSTREAM_UNAVAILABLE, SIGNER_UNAVAILABLE, SIGNER_FENCED, INTERNAL, PRICE_ABOVE_MAX, TIER_NOT_PURCHASABLE, QUEUED_BLOCK_EXISTS, DOWNGRADE_NOT_IMMEDIATE, INSUFFICIENT_CREDITS, DEPOSIT_BELOW_MIN, DEPOSIT_ABOVE_MAX, SWAP_BUDGET_EXHAUSTED, PAYG_PRICE_ABOVE_MAX, DEPLOY_NOT_ALLOWED, UNSUPPORTED_TX_FIELD, QUOTE_EXPIRED, RENEW_NOT_APPLICABLE, UNAUTHENTICATED, TOKEN_INVALID, TOKEN_EXPIRED, ORIGIN_NOT_ALLOWED, CHALLENGE_INVALID, API_KEY_INVALID, API_KEY_SCOPE, STREAM_TICKET_INVALID, FORBIDDEN, ACCOUNT_SUSPENDED, NOT_FOUND, PAYLOAD_TOO_LARGE, CURSOR_INVALID, IDEMPOTENCY_KEY_REUSED, IDEMPOTENCY_IN_PROGRESS, LIMIT_REACHED, WEBHOOK_URL_NOT_ALLOWED, PAYMENT_REQUIRED, PAYMENT_INVALID, PAYMENT_FAILED]

deadReasonDeadReason

Possible values: [NONCE_CONSUMED_FOREIGN, REPLACED_BY_CANCEL, REPLACED_BY_RESIGN, REPLACED_BY_PEER, INVALID_BYTES]

stuckReasonStuckReason

Possible values: [RELAYER_UNDERFUNDED, CHAIN_STALLED, NOT_IN_POOL]

correctedboolean

Reconciliation turned DEAD into EXECUTED_*.

modeRelayMode

Possible values: [normal, cancel, replace]

Default value: normal
ruinteger<int64>

Relay Units.

Possible values: >= 0

accountAddress

MultiversX bech32 address.

Possible values: Value must match regular expression ^erd1[02-9ac-hj-np-z]{58}$

Example: erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e
includedInBlock object
shardShard

Possible values: [0, 1, 2]

nonceinteger<int64>
hashHex32

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

receivedAtMs(integer | null)<int64>nullable
cosignedAtMs(integer | null)<int64>nullable
broadcastAtMs(integer | null)<int64>nullable
executedBlockTsMs(integer | null)<int64>nullable
finalizedAtMs(integer | null)<int64>nullable
latency object

All values in milliseconds. A value is null when its timestamp is unknown, for example on a row the service recovered after a restart. acceptToCosignMs = cosignedAtMs - receivedAtMs; cosignToBroadcastMs = broadcastAtMs - cosignedAtMs; addedMs = broadcastAtMs - receivedAtMs; inclusionMs = executedBlockTsMs - receivedAtMs; finalityMs = finalizedAtMs - executedBlockTsMs; totalMs = finalizedAtMs - receivedAtMs; roundsToInclusion = ceil(inclusionMs / roundDurationMs).

acceptToCosignMsinteger | nullnullable
cosignToBroadcastMsinteger | nullnullable
addedMsinteger | nullnullable
inclusionMsinteger | nullnullable
finalityMsinteger | nullnullable
totalMsinteger | nullnullable
roundsToInclusioninteger | nullnullable
crossShardboolean
acks object[]
  • Array [
    • gatewaystringrequired

    The ID of the gateway that acknowledged the transaction, such as G1.

    msintegerrequired

    Milliseconds from cosignedAtMs to the acknowledgement.

    viastring

    Which node sent it.

    Possible values: [owner, peer, witness]

  • ]
    • feePaidAttoAttoEgld

    atto-EGLD as decimal string.

    Possible values: Value must match regular expression ^[0-9]+$

    gasUsedinteger<int64>
    advisorystring
    explorerUrlstring<uri>
    Intent
    {
      "intentId": "string",
      "sender": "erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e",
      "nonce": 0,
      "txHash": "string",
      "relayer": "erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e",
      "shard": 0,
      "receiver": "erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e",
      "function": "string",
      "state": "ASSIGNED",
      "final": true,
      "rejectCode": "MALFORMED_REQUEST",
      "deadReason": "NONCE_CONSUMED_FOREIGN",
      "stuckReason": "RELAYER_UNDERFUNDED",
      "corrected": true,
      "mode": "normal",
      "ru": 0,
      "account": "erd1mf4u0jr6786wtz7s7dj6gmpyfafg8e0exh5wvye5cygvvxyyxhpsmj8q0e",
      "includedInBlock": {
        "shard": 0,
        "nonce": 0,
        "hash": "string"
      },
      "receivedAtMs": 0,
      "cosignedAtMs": 0,
      "broadcastAtMs": 0,
      "executedBlockTsMs": 0,
      "finalizedAtMs": 0,
      "latency": {
        "acceptToCosignMs": 0,
        "cosignToBroadcastMs": 0,
        "addedMs": 0,
        "inclusionMs": 0,
        "finalityMs": 0,
        "totalMs": 0,
        "roundsToInclusion": 0,
        "crossShard": true
      },
      "acks": [
        {
          "gateway": "string",
          "ms": 0,
          "via": "owner"
        }
      ],
      "feePaidAtto": "string",
      "gasUsed": 0,
      "advisory": "string",
      "explorerUrl": "string"
    }