Query Service

Bridge Service

The BridgeService class provides methods to interact with the Cycle network's bridge functionality, allowing users to manage deposits, claims, and cross-chain transactions.

1.getBridge

Usage

Gets a specific bridge deposit.

Parameters

netId: network_id where the rollup initiated

depositCnt: the nonce of deposit on a certain chain

Return

Standard AxiosResponse

sdk.bridgeService.getBridge(netId: number, depositCnt: string): Promise<AxiosResponse>;

2.getMerkleProof

Usage

Retrieves the Merkle proof for a specific deposit.

Parameters

netId: network_id where the rollup initiated

depositCnt: the nonce of deposit on a certain chain

destNetwork: network_id where corresponding to the rollup destination chain

Return

Standard AxiosResponse

sdk.bridgeService.getMerkleProof(netId: number, depositCnt: string, destNetwork: number): Promise<AxiosResponse>;

3.getBridgeByTransaction

Usage

Gets a bridge deposit by its transaction hash.

Parameters

netId: network_id where the rollup initiated

txHash: the rollup txHash

Return

Standard AxiosResponse

sdk.bridgeService.getBridgeByTransaction(netId: number, txHash: string): Promise<AxiosResponse>;

4.getBridges

Usage

Retrieves bridge deposits for a specific user address.

Parameters

userAddr: the direct caller address of the bridge contract

offset: the start position of rollup list

limit: the return count of rollup

Return

Standard AxiosResponse

sdk.bridgeService.getBridges(userAddr: string, offset: number = 0, limit: number = 10): Promise<AxiosResponse>;

5.getSenderBridges

Usage

Retrieves all bridge deposits for a specific sender address.

Parameters

senderAddr: the sender of the rollup tx

offset: the start position of rollup list

limit: the return count of rollup

Return

Standard AxiosResponse

sdk.bridgeService.getSenderBridges(senderAddr: string, offset: number = 0, limit: number = 10): Promise<AxiosResponse>;

6.getSenderBridgesNotClaimed

Usage

Retrieves all bridge deposits to be claimed for a specific sender address.

Parameters

senderAddr: the sender of the rollup tx

offset: the start position of rollup list

limit: the return count of rollup

Return

Standard AxiosResponse

sdk.bridgeService.getSenderBridgesNotClaimed(senderAddr: string, offset: number = 0, limit: number = 10): Promise<AxiosResponse>;

7.getCrossChainBridges

Usage

Gets cross-chain bridge transactions for a specific user address.

Parameters

rollinTx: the rollin tx on the initiate chain

networkId: the initiate chain network_id

Return

Standard AxiosResponse

sdk.bridgeService.getCrossChainBridges(senderAddr: string, offset: number = 0, limit: number = 10): Promise<AxiosResponse>;

8.getCrossChainBridgeByRollIn

Usage

Retrieves a cross-chain bridge transaction by its roll-in transaction hash.

Parameters

rollinTx: the rollin tx on the initiate chain

networkId: the initiate chain network_id

Return

Standard AxiosResponse

sdk.bridgeService.getCrossChainBridgeByRollIn(rollinTx: string, networkId: number): Promise<AxiosResponse>;

9.batchGetCrossChainBridges

Usage

Gets multiple cross-chain bridge transactions in a single batch request.

Parameters

rollinRequests: the array of the rollin request params you want to query

Return

Standard AxiosResponse

sdk.bridgeService.batchGetCrossChainBridges(rollInRequests: Array<{ rollin_tx: string; network_id: number }>): Promise<AxiosResponse>;