API Reference

Note: 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.

Link gateway-gettransferconfigsforall.md

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.

Link gateway-estimateamt.md

Link contract-pool-based-transfer.md

Link gateway-gettransferstatus.md

Transfer Refund Flow

When the transfer status is TRANSFER_TO_BE_REFUNDED, cBridge gateway will prepare on-chain refund transaction info automatically within several minutes. Polling getTransferStatus and submit on-chain transaction based on failed transfer type.

Link gateway-gettransferstatus.md

Link contract-pool-based-transfer-refund.md

Link contract-mint-canonical-token-transfer-refund.md

Link contract-burn-canonical-token-transfer-refund.md

Transfer History Query

Link gateway-transferhistory.md