Links

Checking the Status of a Transaction

Checking if a cross-chain transfer is completed.
The full API documentation for our /status endpoint can be found here.
If you already looked at our Transferring Tokens Guide, you know how to request and submit a transaction.
To fetch the execution status of a transfer, the /status endpoint can be queried.
In case of a cross-chain transfer, the fromChain, toChain, and bridge parameters need to be set. For simple swaps, fromChain and toChain have to be set to the same value. The bridge parameter can be omitted.
const getStatus = async (bridge, fromChain, toChain, txHash) => {
const result = await axios.get('https://li.quest/v1/status', {
params: {
bridge,
fromChain,
toChain,
txHash,
}
});
return result.data;
}
The result will look similar to the following:
{
"sending": {
"chainId": 1,
"txHash": "0x807e84fcea166e316742f811a47c464c02cc1f2cd176f514308244831cc67182",
"txLink": "https://etherscan.io/tx/0x807e84fcea166e316742f811a47c464c02cc1f2cd176f514308244831cc67182",
"amount": "2000000000000000000",
"token": { ... }, // information about the sent token
"gasPrice": "204953572552",
"gasUsed": "124062"
},
"receiving": {
"chainId": 42161,
"txHash": "0x233114043b0bc383d7d87ab3d8451b24ce17474f26e4c08a9d08ff18f18f639f",
"txLink": "https://arbiscan.io/tx/0x233114043b0bc383d7d87ab3d8451b24ce17474f26e4c08a9d08ff18f18f639f",
"amount": "2004304477512464378",
"token": { ... }, // information about the received token
"gasPrice": "1140752846",
"gasUsed": "0"
​
},
"tool": "hop",
"status": "DONE",
"substatus": "COMPLETE"
}

The different statuses and what they mean

The response from our /status endpoint contains the property status, indicating the current state of the transaction. The possible values are NOT_FOUND, INVALID, PENDING, DONE, or FAILED.
  • NOT_FOUND: This means that the transaction doesn't exist. This can happen if the passed hash refers to a transaction that hasn't been mined yet.
  • INVALID The provided transaction hash does not seem to be tied to the tool you requested the status from. This can happen if the status monitoring is requested for 'connext', but the transaction was processed through 'hop'.
  • PENDING: The initial transaction was mined, but the bridging process is still in progress. You can get this status also if part of the third-party services we rely on is not reachable or the RPC communication isn't working properly. Refer to the sub-status information to know more.
  • DONE: The final transaction was received on the destination chain and the operation has concluded. The sub-status will indicate whether there has been a refund or if the tokens received were only partially delivered.
  • FAILED: The bridging transaction was marked as failed. Look into the transactions to learn what exactly went wrong.

The different sub-statuses and what they mean

When the status is either DONE or PENDING, we also return a sub-status to explain the situation better.
Sub-statuses of PENDING:
  • WAIT_SOURCE_CONFIRMATIONS: The bridge is waiting for additional confirmations.
  • WAIT_DESTINATION_TRANSACTION: The off-chain logic is in progress, waiting for the destination transaction to be mined. Check back later.
  • BRIDGE_NOT_AVAILABLE: The bridge API / subgraph is temporarily unavailable, check back later.
  • CHAIN_NOT_AVAILABLE: The RPC for the source/destination chain is temporarily unavailable
  • NOT_PROCESSABLE_REFUND_NEEDED: The transfer cannot be completed, a refund is required.
  • REFUND_IN_PROGRESS: The refund has been requested and it's being processed (not all bridges will go through this state!)
  • UNKNOWN_ERROR: We cannot determine the status of the transfer.
Sub-statuses of DONE:
  • COMPLETED: The transfer was successful.
  • PARTIAL: The transfer was partially successful. This can happen for specific bridges like across , multichain or connext which may provide alternative tokens in case of low liquidity.
  • REFUNDED: The transfer was not successful and the sent token has been refunded

Handling unexpected receiving token

When using multichain or connext it can happen that receiving.token is not the token requested in the original quote:
  • multichain mints custom anyToken when bridging and swap them automatically to the token representation the user requested. In rare cases, it can happen that while the transfer was executed, the swap liquidity to exchange that token was used up. In this case, the user receives the anyToken instead. This guide explains how to exchange that token later.
  • connext transfers mainly stablecoins. If the user wants to receive another asset instead we can trigger a swap for the user and send the resulting token to the user. This swap has to be defined with the initial quote, but is always executed a few minutes later when transferred to the destination chain. At this time the exchange rates for the token may have changed, if the slippage was set too small it is not possible anymore to fulfill the swap as requested by the user. In this case we send the bridged (stable) coin to the user and he has to do the swap himself. To prevent this, the slippage should be set higher than normal. If the swap still fails, you should request a new rate for the swap from our API and ask the user to submit it to receive the desired token.

Querying the status endpoint

If your dApp wants to wait for the completion of the cross-chain transfer, it can query the /status endpoint until a final state is reached:
const getStatus = async (bridge, fromChain, toChain, txHash) => {
const result = await axios.get('https://li.quest/v1/status', {
params: {
bridge,
fromChain,
toChain,
txHash,
}
});
return result.data;
}
​
let result;
do {
result = await getStatus(quote.tool, fromChain, toChain, tx.hash);
} while (result.status !== 'DONE' && result.status !== 'FAILED')
​
console.log(`Transfer completed with state ${result.status}`);