Skip to content

API Reference

Complete reference for all BridgeSDK methods available through sdk.bridge, along with their request and response type definitions.


Core methods for cross-chain bridging of TAO and Alpha assets between Bittensor and EVM chains.

MethodDescriptionParametersReturn Type
bridge(payload)Initiate a bridge transaction. Handles EVM burn requests and Bittensor batch transaction preparation.payload: BridgeSwapRequestPromise<BridgeSwapResponse>
getBridgeFeeEstimate(params)Estimate fees and the recipient amount for a bridge operation.params: BridgeFeeEstimateRequestPromise<BridgeFeeEstimateResponse>

Methods for routing transactions (Swap, Bridge, CCIP) through the unified router.

MethodDescriptionParametersReturn Type
routeSwap(payload)Route a token swap (e.g. wTAO → wALPHA).payload: RouteSwapRequestPromise<RouteTransactionResponse>
routeBridge(payload)Route a bridge operation via the router.payload: RouteBridgeRequestPromise<RouteTransactionResponse>
routeCcip(payload)Route a Cross-Chain Interoperability Protocol (CCIP) operation.payload: RouteCcipRequestPromise<RouteTransactionResponse>
getRouterSwapFeeEstimate(params)Estimate fees for router-based operations (Swap, Bridge, or CCIP).params: RouterSwapFeeEstimateRequestPromise<RouterSwapFeeEstimateResponse>

Methods for tracking and managing in-flight transactions.

MethodDescriptionParametersReturn Type
getRecentTransactions(page, limit)Fetch a paginated list of recent transactions for the current tenant.page?: number, limit?: numberPromise<ApiTransactionsResponse>
cancelBridgeSwap(params)Cancel a pending bridge operation.params: CancelBridgeSwapRequestPromise<CancelOperationResponse>
cancelRouterSwap(params)Cancel a pending router swap.params: CancelRouterSwapRequestPromise<CancelOperationResponse>
cancelCcipRoute(params)Cancel a pending CCIP route operation.params: CancelCcipRequestPromise<CancelOperationResponse>

Methods for manually validating or confirming transactions when automatic indexing is insufficient.

MethodDescriptionParametersReturn Type
validateBurnTransaction(params)Manually validate an EVM burn transaction hash if the automatic indexer misses it.params: ValidateBurnRequestPromise<ValidateBurnResponse>
confirmCcipTransaction(params)Manually confirm a CCIP transaction after on-chain finality.params: CcipTxConfirmationRequestPromise<CcipTxConfirmationResponse>

PropertyTypeRequiredDescription
fromWalletstringSender wallet address.
toWalletstringRecipient wallet address on the destination chain.
fromTokenstringSource token symbol — must be lowercase (e.g. wtao).
toTokenstringDestination token symbol — must be lowercase (e.g. tao).
fromChainstringSource chain ID (e.g. ethereum).
toChainstringDestination chain ID (e.g. bittensor).
amountnumberAmount to bridge.
subnetIdnumber⚠️ ConditionalRequired for Bittensor bridging. Use 0 for TAO, or the subnet ID for Alpha.
PropertyTypeDescription
identifierstringUnique transaction identifier.
toAddressstring (optional)Destination address (Bridge Hot Wallet) for the transfer.
encodedDatastring (optional)ABI-encoded data for EVM burn transactions.
signaturestring (optional)Signature for EVM burn transactions.
evmTransactionobject (optional)Prepared EVM transaction object containing to, data, and value.
subnetDestinationHotkeystring (optional)Hotkey for Alpha subnet stake transfers.

PropertyTypeRequiredDescription
fromTokenstringSource token symbol.
toTokenstringDestination token symbol.
amountnumberAmount to bridge.
PropertyTypeDescription
feestringEstimated total fee for the bridge operation.
recipientAmountstringEstimated amount the recipient will receive after fees.
tenantFeestringPortion of the fee collected by the tenant/integrator.

PropertyTypeRequiredDescription
operationType'SWAP'Must be the literal string 'SWAP'.
originAssetIdnumberID of the source asset.
destinationAssetIdnumberID of the destination asset.
fromAddressstringSender address.
toAddressstringRecipient address.
amountnumberAmount to swap.
PropertyTypeRequiredDescription
operationType'BRIDGE'Must be the literal string 'BRIDGE'.
fromChainstringSource chain ID.
toChainstringDestination chain ID.
fromTokenstringSource token symbol.
toTokenstringDestination token symbol.
fromWalletstringSender wallet address.
toWalletstringRecipient wallet address.
amountnumberAmount to bridge.
subnetIdnumber⚠️ ConditionalRequired for Alpha bridging.
PropertyTypeRequiredDescription
operationType'CCIP'Must be the literal string 'CCIP'.
originAssetIdnumberSource asset ID.
destinationAssetIdnumberDestination asset ID.
fromAddressstringSender address.
toAddressstringRecipient address on the destination chain.
amountnumberAmount to transfer.
PropertyTypeDescription
successbooleanWhether the routing request was successful.
identifierstringUnique transaction identifier for tracking.
dataobjectContains to, data, value, and chainId for EVM execution.
ccipFeestring (optional)Estimated CCIP protocol fee, if applicable.

PropertyTypeRequiredDescription
originAssetIdnumberSource asset ID.
destinationAssetIdnumberDestination asset ID.
amountnumberAmount to swap or bridge.
operationTypeRouteOperationTypeOne of 'SWAP', 'BRIDGE', or 'CCIP'.
toAddressstringRecipient address.
PropertyTypeDescription
swapAmountstringEstimated output amount the recipient will receive.
totalFeestringTotal combined fee.
platformFeestringVoidAI platform fee component.
ccipFeestringChainlink CCIP protocol fee component.
tenantFeestringFee collected by the tenant/integrator.

PropertyTypeDescription
itemsApiTransactionItem[]Paginated list of transaction records.
pagenumberCurrent page number.
limitnumberNumber of items per page.
totalItemsnumberTotal number of transactions.
totalPagesnumberTotal number of pages.

PropertyTypeRequiredDescription
fromTokenstringSource token symbol.
toTokenstringDestination token symbol.
uuidstringTransaction UUID to cancel.
PropertyTypeRequiredDescription
uuidstringTransaction UUID to cancel.
PropertyTypeRequiredDescription
operationType'CCIP'Must be the literal string 'CCIP'.
fromTokenstringSource token symbol.
toTokenstringDestination token symbol.
uuidstringTransaction UUID to cancel.
PropertyTypeDescription
successbooleanWhether the cancellation was successful.
messagestringHuman-readable status message.

PropertyTypeRequiredDescription
transactionHashstringOn-chain hash of the EVM burn transaction.
identifierstringTransaction identifier returned by the original bridge call.
PropertyTypeDescription
successbooleanWhether the validation was successful.
messagestringHuman-readable status message.
identifierstringConfirmed transaction identifier.
burnDetailsobjectParsed details of the on-chain burn event.

PropertyTypeRequiredDescription
transactionIdstringVoidAI Transaction ID (from the original routeCcip response).
txnHashstringOn-chain transaction hash from the source chain.
operationTypestringOperation type — use 'ccipBridge' for CCIP transfers.
txnStatusstringCurrent status code (e.g. 'CCIP_SOURCE_INITIATED').
PropertyTypeDescription
successbooleanWhether the confirmation was accepted.
messagestring (optional)Human-readable status message.