WaitIntentReceipt

cURL

curl --request POST \
  --url https://trails-api.sequence.app/rpc/Trails/WaitIntentReceipt \
  --header 'Content-Type: application/json' \
  --data '
{
  "intentId": "<string>",
  "lastReceiptStates": []
}
'

import requests

url = "https://trails-api.sequence.app/rpc/Trails/WaitIntentReceipt"

payload = {
    "intentId": "<string>",
    "lastReceiptStates": []
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({intentId: '<string>', lastReceiptStates: []})
};

fetch('https://trails-api.sequence.app/rpc/Trails/WaitIntentReceipt', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://trails-api.sequence.app/rpc/Trails/WaitIntentReceipt",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'intentId' => '<string>',
    'lastReceiptStates' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://trails-api.sequence.app/rpc/Trails/WaitIntentReceipt"

	payload := strings.NewReader("{\n  \"intentId\": \"<string>\",\n  \"lastReceiptStates\": []\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://trails-api.sequence.app/rpc/Trails/WaitIntentReceipt")
  .header("Content-Type", "application/json")
  .body("{\n  \"intentId\": \"<string>\",\n  \"lastReceiptStates\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://trails-api.sequence.app/rpc/Trails/WaitIntentReceipt")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"intentId\": \"<string>\",\n  \"lastReceiptStates\": []\n}"

response = http.request(request)
puts response.read_body

{
  "intentReceipt": {
    "id": 123,
    "projectId": 123,
    "intentId": "<string>",
    "ownerAddress": "<string>",
    "originChainId": 123,
    "destinationChainId": 123,
    "depositTransactionId": 123,
    "depositTransaction": {
      "id": 123,
      "intentId": "<string>",
      "chainId": 123,
      "fromAddress": "<string>",
      "toAddress": "<string>",
      "tokenAddress": "<string>",
      "tokenAmount": 123,
      "statusReason": "<string>",
      "bridgeGas": 123,
      "calldata": "<string>",
      "metaTxnId": "<string>",
      "metaTxnFeeQuote": "<string>",
      "precondition": {
        "type": "<string>",
        "chainId": 123,
        "ownerAddress": "<string>",
        "tokenAddress": "<string>",
        "minAmount": 123
      },
      "depositIntentEntry": {
        "feeAmount": "<string>",
        "feeToken": "<string>",
        "feeCollector": "<string>",
        "deadline": 123,
        "intentSignature": "<string>",
        "permitSignature": "<string>",
        "permitDeadline": 123,
        "permitAmount": 123,
        "userNonce": 123
      },
      "txnHash": "<string>",
      "txnMinedAt": "<string>",
      "updatedAt": "<string>",
      "createdAt": "<string>",
      "statusUpdatedAt": "<string>",
      "eligibleAt": "<string>"
    },
    "originTransactionId": 123,
    "originTransaction": {
      "id": 123,
      "intentId": "<string>",
      "chainId": 123,
      "fromAddress": "<string>",
      "toAddress": "<string>",
      "tokenAddress": "<string>",
      "tokenAmount": 123,
      "statusReason": "<string>",
      "bridgeGas": 123,
      "calldata": "<string>",
      "metaTxnId": "<string>",
      "metaTxnFeeQuote": "<string>",
      "precondition": {
        "type": "<string>",
        "chainId": 123,
        "ownerAddress": "<string>",
        "tokenAddress": "<string>",
        "minAmount": 123
      },
      "depositIntentEntry": {
        "feeAmount": "<string>",
        "feeToken": "<string>",
        "feeCollector": "<string>",
        "deadline": 123,
        "intentSignature": "<string>",
        "permitSignature": "<string>",
        "permitDeadline": 123,
        "permitAmount": 123,
        "userNonce": 123
      },
      "txnHash": "<string>",
      "txnMinedAt": "<string>",
      "updatedAt": "<string>",
      "createdAt": "<string>",
      "statusUpdatedAt": "<string>",
      "eligibleAt": "<string>"
    },
    "summary": {
      "intentId": "<string>",
      "ownerAddress": "<string>",
      "originChainId": 123,
      "destinationChainId": 123,
      "routeProviders": [],
      "originIntentAddress": "<string>",
      "originTokenAddress": "<string>",
      "originTokenAmount": 123,
      "quotedOriginTokenAmount": 123,
      "originTokenMetadata": {
        "chainId": 123,
        "tokenAddress": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "logoUri": "<string>"
      },
      "destinationIntentAddress": "<string>",
      "destinationTokenMetadata": {
        "chainId": 123,
        "tokenAddress": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "logoUri": "<string>"
      },
      "destinationHasCallData": true,
      "destinationHasCallValue": true,
      "createdAt": "<string>",
      "expiresAt": "<string>",
      "destinationTokenAddress": "<string>",
      "destinationTokenAmount": 123,
      "quotedDestinationTokenAmount": 123,
      "destinationToAddress": "<string>",
      "edge": {
        "edgeId": "<string>",
        "originChainId": 123,
        "relayRequestId": "<string>",
        "edgeTokenAmount": 123,
        "edgeTokenAddress": "<string>",
        "edgeUserAddress": "<string>",
        "initTransactionHash": "<string>",
        "fillTransactionHash": "<string>",
        "refundTransactionHash": "<string>",
        "edgeTokenMetadata": {
          "chainId": 123,
          "tokenAddress": "<string>",
          "name": "<string>",
          "symbol": "<string>",
          "decimals": 123,
          "logoUri": "<string>"
        },
        "createdAt": "<string>"
      },
      "memo": "<string>",
      "startedAt": "<string>",
      "finishedAt": "<string>"
    },
    "destinationTransactionId": 123,
    "destinationTransaction": {
      "id": 123,
      "intentId": "<string>",
      "chainId": 123,
      "fromAddress": "<string>",
      "toAddress": "<string>",
      "tokenAddress": "<string>",
      "tokenAmount": 123,
      "statusReason": "<string>",
      "bridgeGas": 123,
      "calldata": "<string>",
      "metaTxnId": "<string>",
      "metaTxnFeeQuote": "<string>",
      "precondition": {
        "type": "<string>",
        "chainId": 123,
        "ownerAddress": "<string>",
        "tokenAddress": "<string>",
        "minAmount": 123
      },
      "depositIntentEntry": {
        "feeAmount": "<string>",
        "feeToken": "<string>",
        "feeCollector": "<string>",
        "deadline": 123,
        "intentSignature": "<string>",
        "permitSignature": "<string>",
        "permitDeadline": 123,
        "permitAmount": 123,
        "userNonce": 123
      },
      "txnHash": "<string>",
      "txnMinedAt": "<string>",
      "updatedAt": "<string>",
      "createdAt": "<string>",
      "statusUpdatedAt": "<string>",
      "eligibleAt": "<string>"
    },
    "refundTransactionId": 123,
    "refundTransaction": {
      "id": 123,
      "intentId": "<string>",
      "chainId": 123,
      "fromAddress": "<string>",
      "toAddress": "<string>",
      "tokenAddress": "<string>",
      "tokenAmount": 123,
      "statusReason": "<string>",
      "bridgeGas": 123,
      "calldata": "<string>",
      "metaTxnId": "<string>",
      "metaTxnFeeQuote": "<string>",
      "precondition": {
        "type": "<string>",
        "chainId": 123,
        "ownerAddress": "<string>",
        "tokenAddress": "<string>",
        "minAmount": 123
      },
      "depositIntentEntry": {
        "feeAmount": "<string>",
        "feeToken": "<string>",
        "feeCollector": "<string>",
        "deadline": 123,
        "intentSignature": "<string>",
        "permitSignature": "<string>",
        "permitDeadline": 123,
        "permitAmount": 123,
        "userNonce": 123
      },
      "txnHash": "<string>",
      "txnMinedAt": "<string>",
      "updatedAt": "<string>",
      "createdAt": "<string>",
      "statusUpdatedAt": "<string>",
      "eligibleAt": "<string>"
    },
    "edge": {
      "edgeId": "<string>",
      "originChainId": 123,
      "relayRequestId": "<string>",
      "edgeTokenAmount": 123,
      "edgeTokenAddress": "<string>",
      "edgeUserAddress": "<string>",
      "initTransactionHash": "<string>",
      "fillTransactionHash": "<string>",
      "refundTransactionHash": "<string>",
      "edgeTokenMetadata": {
        "chainId": 123,
        "tokenAddress": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "logoUri": "<string>"
      },
      "createdAt": "<string>"
    },
    "updatedAt": "<string>",
    "createdAt": "<string>"
  },
  "receiptStates": [],
  "done": true
}

{
  "error": "WebrpcEndpoint",
  "code": 0,
  "msg": "endpoint error",
  "status": 400,
  "cause": "<string>"
}

{
  "error": "WebrpcBadResponse",
  "code": -5,
  "msg": "bad response",
  "status": 500,
  "cause": "<string>"
}

POST

rpc

Trails

WaitIntentReceipt

cURL

curl --request POST \
  --url https://trails-api.sequence.app/rpc/Trails/WaitIntentReceipt \
  --header 'Content-Type: application/json' \
  --data '
{
  "intentId": "<string>",
  "lastReceiptStates": []
}
'

import requests

url = "https://trails-api.sequence.app/rpc/Trails/WaitIntentReceipt"

payload = {
    "intentId": "<string>",
    "lastReceiptStates": []
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({intentId: '<string>', lastReceiptStates: []})
};

fetch('https://trails-api.sequence.app/rpc/Trails/WaitIntentReceipt', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://trails-api.sequence.app/rpc/Trails/WaitIntentReceipt",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'intentId' => '<string>',
    'lastReceiptStates' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://trails-api.sequence.app/rpc/Trails/WaitIntentReceipt"

	payload := strings.NewReader("{\n  \"intentId\": \"<string>\",\n  \"lastReceiptStates\": []\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://trails-api.sequence.app/rpc/Trails/WaitIntentReceipt")
  .header("Content-Type", "application/json")
  .body("{\n  \"intentId\": \"<string>\",\n  \"lastReceiptStates\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://trails-api.sequence.app/rpc/Trails/WaitIntentReceipt")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"intentId\": \"<string>\",\n  \"lastReceiptStates\": []\n}"

response = http.request(request)
puts response.read_body

{
  "intentReceipt": {
    "id": 123,
    "projectId": 123,
    "intentId": "<string>",
    "ownerAddress": "<string>",
    "originChainId": 123,
    "destinationChainId": 123,
    "depositTransactionId": 123,
    "depositTransaction": {
      "id": 123,
      "intentId": "<string>",
      "chainId": 123,
      "fromAddress": "<string>",
      "toAddress": "<string>",
      "tokenAddress": "<string>",
      "tokenAmount": 123,
      "statusReason": "<string>",
      "bridgeGas": 123,
      "calldata": "<string>",
      "metaTxnId": "<string>",
      "metaTxnFeeQuote": "<string>",
      "precondition": {
        "type": "<string>",
        "chainId": 123,
        "ownerAddress": "<string>",
        "tokenAddress": "<string>",
        "minAmount": 123
      },
      "depositIntentEntry": {
        "feeAmount": "<string>",
        "feeToken": "<string>",
        "feeCollector": "<string>",
        "deadline": 123,
        "intentSignature": "<string>",
        "permitSignature": "<string>",
        "permitDeadline": 123,
        "permitAmount": 123,
        "userNonce": 123
      },
      "txnHash": "<string>",
      "txnMinedAt": "<string>",
      "updatedAt": "<string>",
      "createdAt": "<string>",
      "statusUpdatedAt": "<string>",
      "eligibleAt": "<string>"
    },
    "originTransactionId": 123,
    "originTransaction": {
      "id": 123,
      "intentId": "<string>",
      "chainId": 123,
      "fromAddress": "<string>",
      "toAddress": "<string>",
      "tokenAddress": "<string>",
      "tokenAmount": 123,
      "statusReason": "<string>",
      "bridgeGas": 123,
      "calldata": "<string>",
      "metaTxnId": "<string>",
      "metaTxnFeeQuote": "<string>",
      "precondition": {
        "type": "<string>",
        "chainId": 123,
        "ownerAddress": "<string>",
        "tokenAddress": "<string>",
        "minAmount": 123
      },
      "depositIntentEntry": {
        "feeAmount": "<string>",
        "feeToken": "<string>",
        "feeCollector": "<string>",
        "deadline": 123,
        "intentSignature": "<string>",
        "permitSignature": "<string>",
        "permitDeadline": 123,
        "permitAmount": 123,
        "userNonce": 123
      },
      "txnHash": "<string>",
      "txnMinedAt": "<string>",
      "updatedAt": "<string>",
      "createdAt": "<string>",
      "statusUpdatedAt": "<string>",
      "eligibleAt": "<string>"
    },
    "summary": {
      "intentId": "<string>",
      "ownerAddress": "<string>",
      "originChainId": 123,
      "destinationChainId": 123,
      "routeProviders": [],
      "originIntentAddress": "<string>",
      "originTokenAddress": "<string>",
      "originTokenAmount": 123,
      "quotedOriginTokenAmount": 123,
      "originTokenMetadata": {
        "chainId": 123,
        "tokenAddress": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "logoUri": "<string>"
      },
      "destinationIntentAddress": "<string>",
      "destinationTokenMetadata": {
        "chainId": 123,
        "tokenAddress": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "logoUri": "<string>"
      },
      "destinationHasCallData": true,
      "destinationHasCallValue": true,
      "createdAt": "<string>",
      "expiresAt": "<string>",
      "destinationTokenAddress": "<string>",
      "destinationTokenAmount": 123,
      "quotedDestinationTokenAmount": 123,
      "destinationToAddress": "<string>",
      "edge": {
        "edgeId": "<string>",
        "originChainId": 123,
        "relayRequestId": "<string>",
        "edgeTokenAmount": 123,
        "edgeTokenAddress": "<string>",
        "edgeUserAddress": "<string>",
        "initTransactionHash": "<string>",
        "fillTransactionHash": "<string>",
        "refundTransactionHash": "<string>",
        "edgeTokenMetadata": {
          "chainId": 123,
          "tokenAddress": "<string>",
          "name": "<string>",
          "symbol": "<string>",
          "decimals": 123,
          "logoUri": "<string>"
        },
        "createdAt": "<string>"
      },
      "memo": "<string>",
      "startedAt": "<string>",
      "finishedAt": "<string>"
    },
    "destinationTransactionId": 123,
    "destinationTransaction": {
      "id": 123,
      "intentId": "<string>",
      "chainId": 123,
      "fromAddress": "<string>",
      "toAddress": "<string>",
      "tokenAddress": "<string>",
      "tokenAmount": 123,
      "statusReason": "<string>",
      "bridgeGas": 123,
      "calldata": "<string>",
      "metaTxnId": "<string>",
      "metaTxnFeeQuote": "<string>",
      "precondition": {
        "type": "<string>",
        "chainId": 123,
        "ownerAddress": "<string>",
        "tokenAddress": "<string>",
        "minAmount": 123
      },
      "depositIntentEntry": {
        "feeAmount": "<string>",
        "feeToken": "<string>",
        "feeCollector": "<string>",
        "deadline": 123,
        "intentSignature": "<string>",
        "permitSignature": "<string>",
        "permitDeadline": 123,
        "permitAmount": 123,
        "userNonce": 123
      },
      "txnHash": "<string>",
      "txnMinedAt": "<string>",
      "updatedAt": "<string>",
      "createdAt": "<string>",
      "statusUpdatedAt": "<string>",
      "eligibleAt": "<string>"
    },
    "refundTransactionId": 123,
    "refundTransaction": {
      "id": 123,
      "intentId": "<string>",
      "chainId": 123,
      "fromAddress": "<string>",
      "toAddress": "<string>",
      "tokenAddress": "<string>",
      "tokenAmount": 123,
      "statusReason": "<string>",
      "bridgeGas": 123,
      "calldata": "<string>",
      "metaTxnId": "<string>",
      "metaTxnFeeQuote": "<string>",
      "precondition": {
        "type": "<string>",
        "chainId": 123,
        "ownerAddress": "<string>",
        "tokenAddress": "<string>",
        "minAmount": 123
      },
      "depositIntentEntry": {
        "feeAmount": "<string>",
        "feeToken": "<string>",
        "feeCollector": "<string>",
        "deadline": 123,
        "intentSignature": "<string>",
        "permitSignature": "<string>",
        "permitDeadline": 123,
        "permitAmount": 123,
        "userNonce": 123
      },
      "txnHash": "<string>",
      "txnMinedAt": "<string>",
      "updatedAt": "<string>",
      "createdAt": "<string>",
      "statusUpdatedAt": "<string>",
      "eligibleAt": "<string>"
    },
    "edge": {
      "edgeId": "<string>",
      "originChainId": 123,
      "relayRequestId": "<string>",
      "edgeTokenAmount": 123,
      "edgeTokenAddress": "<string>",
      "edgeUserAddress": "<string>",
      "initTransactionHash": "<string>",
      "fillTransactionHash": "<string>",
      "refundTransactionHash": "<string>",
      "edgeTokenMetadata": {
        "chainId": 123,
        "tokenAddress": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "logoUri": "<string>"
      },
      "createdAt": "<string>"
    },
    "updatedAt": "<string>",
    "createdAt": "<string>"
  },
  "receiptStates": [],
  "done": true
}

{
  "error": "WebrpcEndpoint",
  "code": 0,
  "msg": "endpoint error",
  "status": 400,
  "cause": "<string>"
}

{
  "error": "WebrpcBadResponse",
  "code": -5,
  "msg": "bad response",
  "status": 500,
  "cause": "<string>"
}

Overview

The WaitIntentReceipt endpoint provides a streaming or long-polling mechanism to wait for an intent to complete. Unlike GetIntentReceipt, which requires manual polling, this endpoint holds the connection until the intent reaches a terminal state or times out.

Use Cases

Wait for transaction completion without polling
Implement real-time transaction monitoring
Reduce API calls by using long-polling
Get notified immediately when transaction completes
Simplify client-side code for waiting

Request Parameters

Required Fields

intentId (string): The unique identifier of the intent to monitor

Response

The response includes:

intentReceipt (IntentReceipt): Complete receipt with transaction details
done (boolean): Indicates if the intent has reached a terminal state
- true: Intent is complete (SUCCEEDED or FAILED)
- false: Intent is still processing (may require another call)

Behavior

This endpoint will:

Check the current status of the intent
If complete (SUCCEEDED or FAILED), return immediately with done: true
If still processing, wait for state changes
Return updates as they occur
Timeout after a reasonable period if no completion

Example

async function waitForCompletion(intentId: string) {
  const response = await fetch('https://trails-api.sequence.app/rpc/Trails/WaitIntentReceipt', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-Access-Key': 'YOUR_ACCESS_KEY'
    },
    body: JSON.stringify({ intentId })
  });

  const { intentReceipt, done } = await response.json();
  
  if (done) {
    if (intentReceipt.status === 'SUCCEEDED') {
      console.log('Transaction succeeded!');
      return intentReceipt;
    } else {
      throw new Error(`Transaction failed: ${intentReceipt.originTransaction.statusReason}`);
    }
  } else {
    // Not done yet, call again
    return waitForCompletion(intentId);
  }
}

// Usage
try {
  const receipt = await waitForCompletion('intent_123abc');
  console.log('Completed:', receipt);
} catch (error) {
  console.error('Failed:', error);
}

Comparison: WaitIntentReceipt vs GetIntentReceipt

GetIntentReceipt (Manual Polling)

// Requires manual polling loop
async function pollReceipt(intentId: string) {
  while (true) {
    const { intentReceipt } = await getIntentReceipt(intentId);
    
    if (intentReceipt.status === 'SUCCEEDED' || intentReceipt.status === 'FAILED') {
      return intentReceipt;
    }
    
    await new Promise(resolve => setTimeout(resolve, 2000)); // 2s delay
  }
}

WaitIntentReceipt (Long Polling)

// Automatic waiting, no manual delay needed
async function waitReceipt(intentId: string) {
  const { intentReceipt, done } = await waitIntentReceipt(intentId);
  
  if (!done) {
    return waitReceipt(intentId); // Recursively wait if needed
  }
  
  return intentReceipt;
}

WaitIntentReceipt is more efficient as it reduces the number of API calls and provides near-instant updates.

With Progress Updates

async function waitWithProgress(intentId: string, onProgress?: (status: string) => void) {
  let lastStatus = '';
  
  const wait = async (): Promise<IntentReceipt> => {
    const { intentReceipt, done } = await fetch(
      'https://trails-api.sequence.app/rpc/Trails/WaitIntentReceipt',
      {
        method: 'POST',
        headers: {
          'Content-Type': 'application/json',
          'X-Access-Key': 'YOUR_ACCESS_KEY'
        },
        body: JSON.stringify({ intentId })
      }
    ).then(r => r.json());
    
    // Report progress if status changed
    if (intentReceipt.status !== lastStatus) {
      lastStatus = intentReceipt.status;
      onProgress?.(intentReceipt.status);
    }
    
    if (done) {
      return intentReceipt;
    }
    
    return wait(); // Continue waiting
  };
  
  return wait();
}

// Usage with progress callback
const receipt = await waitWithProgress('intent_123abc', (status) => {
  console.log('Status update:', status);
  // Update UI, show loading state, etc.
});

Timeout Handling

async function waitWithTimeout(intentId: string, timeoutMs = 300000) {
  const timeoutPromise = new Promise<never>((_, reject) => {
    setTimeout(() => reject(new Error('Timeout waiting for intent')), timeoutMs);
  });
  
  const waitPromise = (async () => {
    let done = false;
    let receipt;
    
    while (!done) {
      const response = await fetch(
        'https://trails-api.sequence.app/rpc/Trails/WaitIntentReceipt',
        {
          method: 'POST',
          headers: {
            'Content-Type': 'application/json',
            'X-Access-Key': 'YOUR_ACCESS_KEY'
          },
          body: JSON.stringify({ intentId })
        }
      );
      
      const data = await response.json();
      receipt = data.intentReceipt;
      done = data.done;
    }
    
    return receipt;
  })();
  
  return Promise.race([waitPromise, timeoutPromise]);
}

try {
  const receipt = await waitWithTimeout('intent_123abc', 60000); // 1 minute timeout
  console.log('Completed:', receipt);
} catch (error) {
  console.error('Timed out or failed:', error);
}

Best Practices

Always implement timeout handling to prevent indefinite waiting in case of network issues or unexpected states.

For UI applications, combine this endpoint with progress callbacks to provide real-time feedback to users.

Next Steps

After receiving the completed receipt:

Verify transaction hashes on block explorers
Update UI to show completion status
Trigger any post-transaction logic
Store receipt for record-keeping

Body

application/json

intentId

string

required

lastReceiptStates

enum<string>[]

[]TransactionStatus

Represented as uint8 on the server side

Available options:

UNKNOWN,

ON_HOLD,

PENDING,

RELAYING,

SENT,

ERRORED,

MINING,

SUCCEEDED,

FAILED,

ABORTED,

REVERTED

Response

intentReceipt

object

required

Show child attributes

receiptStates

enum<string>[]

required

[]TransactionStatus

Represented as uint8 on the server side

Available options:

UNKNOWN,

ON_HOLD,

PENDING,

RELAYING,

SENT,

ERRORED,

MINING,

SUCCEEDED,

FAILED,

ABORTED,

REVERTED

done

boolean

required

GetIntentReceipt GetEdgeStatus

Overview

Intents

Routes & Tokens

Chains & Discovery

Earn

Intents (Advanced)

WaitIntentReceipt

Overview

Use Cases

Request Parameters

Required Fields

Response

Behavior

Example

Comparison: WaitIntentReceipt vs GetIntentReceipt

GetIntentReceipt (Manual Polling)

WaitIntentReceipt (Long Polling)

With Progress Updates

Timeout Handling

Best Practices

Next Steps

Body

Response

​Overview

​Use Cases

​Request Parameters

​Required Fields

​Response

​Behavior

​Example

​Comparison: WaitIntentReceipt vs GetIntentReceipt

​GetIntentReceipt (Manual Polling)

​WaitIntentReceipt (Long Polling)

​With Progress Updates

​Timeout Handling

​Best Practices

​Next Steps

Body

Response

Overview

Use Cases

Request Parameters

Required Fields

Response

Behavior

Example

Comparison: WaitIntentReceipt vs GetIntentReceipt

GetIntentReceipt (Manual Polling)

WaitIntentReceipt (Long Polling)

With Progress Updates

Timeout Handling

Best Practices

Next Steps