latestOpenAPI 3.0.02026-08-2232150173.9 KB

b70d36b7002b

relay

Check Relay bridge transaction status

Returns comprehensive information about a cross-chain Relay bridge transaction, including Relay message parameters, on-chain events, and transaction data from Enso.

get/api/v1/relay/bridge/check

Query parameters

chainIdnumber required

Example:1

Chain ID of the source transaction

txHashstring required

Example:0x94e5ea92d395fc8969b3253395ce58d51b27781c7305376d494f0804b109a8b5

Transaction hash of the Relay bridge transaction on source chain

Response

Bridge transaction status and details

sourceChainIdnumber required

Source chain ID where the Relay message was sent from

sourceTxHashstring required

Source chain transaction hash

destinationChainIdnumber

Destination chain ID where the Relay message was delivered

destinationTxHashstring

Destination chain transaction hash (if message was delivered)

refundChainIdnumber

Chain the funds were refunded on — the origin chain — present when the request was refunded instead of delivered. destinationChainId then names the intended destination and destinationTxHash is absent (nothing arrived there).

refundTxHashstring

The refund payout transaction, present when the request was refunded instead of delivered

status'pending' | 'inflight' | 'delivered' | 'failed' | 'unknown' required

Overall bridge status

errorstring

Error message if the API request failed (e.g., transaction not found, API errors)

Example response

{
  "sourceChainId": 1,
  "sourceTxHash": "0x80f1faf0652a5618ea1de0fc5142418e380676b3c6c74d482cfac1237638d6d4",
  "destinationChainId": 8453,
  "destinationTxHash": "0x9a3e6a8a52b82a1f4b523b0d50be133df0ad9407814b32e42d67119e1ae1947d",
  "refundChainId": 42161,
  "relayRequest": {
    "status": "success",
    "user": "0x1234567890123456789012345678901234567890",
    "recipient": "0x1234567890123456789012345678901234567890",
    "inTxs": [
      {
        "hash": "0x80f1faf0652a5618ea1de0fc5142418e380676b3c6c74d482cfac1237638d6d4",
        "chainId": 8453,
        "block": 12345678,
        "timestamp": 1700000000,
        "status": "success"
      }
    ],
    "outTxs": [
      {
        "hash": "0x80f1faf0652a5618ea1de0fc5142418e380676b3c6c74d482cfac1237638d6d4",
        "chainId": 8453,
        "block": 12345678,
        "timestamp": 1700000000,
        "status": "success"
      }
    ],
    "currency": {
      "chainId": 1,
      "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
      "symbol": "USDC",
      "name": "USD Coin",
      "decimals": 6
    },
    "fees": {
      "gas": "50000000000000",
      "fixed": "0",
      "price": "100000",
      "gateway": "0"
    },
    "feesUsd": {
      "gas": "50000000000000",
      "fixed": "0",
      "price": "100000",
      "gateway": "0"
    },
    "failReason": "EXECUTION_REVERTED",
    "createdAt": "2024-01-15T12:00:00Z",
    "updatedAt": "2024-01-15T12:05:00Z"
  },
  "error": "Transaction receipt not found for 0x..."
}