API Reference

All APIs will have a prefix to indicate whether it is a cBridge gateway function or a cBridge contract on-chain function.

Get Transfer Configs

Get chains and tokens info supported by cBridge.

Transfer Flow

When all needed information is ready, make an estimation for this transfer first. Then, submit an on-chain send transaction. Poll getTransferStatus for this transaction until the transfer is complete or needs a refund.

Transfer Refund Flow

When the transfer status is TRANSFER_TO_BE_REFUNDED, trigger the transfer refund flow. Submit a WithdrawLiquidity request to cBridge gateway. cBridge gateway will provide details for submitting on-chain withdrawal. Finally, send getTransferStatus repeatedly until the refund is complete.

Transfer History Query