Onchain Transaction

1.rollIn

Usage

Roll your ETH to cycle

Parameters

ethersSigner: standard signer of ethers.js

fromChainId: the chain id where you initiate rollin transaction

receiveAddress: the address you will receive token on cycle

amount: its name explained itself

Return

Standard ethers.TransactionResponse

sdk.rollIn(ethersSigner: ethers.Signer, fromChainId: number, receiveAddress: string, amount: string): Promise<ethers.TransactionResponse>;

2.rollOut

Usage

Roll your ETH from cycle to other chains

Parameters

ethersSigner: standard signer of ethers.js

toChainId: the chain id where you want to bridge your token

receiveAddress: the address you will receive token on cycle

amount: its name explained itself

Return

Standard ethers.TransactionResponse

sdk.rollOut(ethersSigner: ethers.Signer, toChainId: number, receiveAddress: string, amount: string): Promise<ethers.TransactionResponse>;

3.rollInMessage

Usage

Roll your message to cycle

Parameters

ethersSigner: standard signer of ethers.js

fromChainId: the chain id where you initiate rollin transaction

receiveAddress: the address you will receive token on cycle

amount: its name explained itself

Return

Standard ethers.TransactionResponse

sdk.rollInMessage(ethersSigner: ethers.Signer, fromChainId: number, receiveAddress: string, message: string): Promise<ethers.TransactionResponse>;

4.rollOutMessage

Usage

Roll your message from cycle to other chains

Parameters

ethersSigner: standard signer of ethers.js

toChainId: the chain id where you want to bridge your token

receiveAddress: the address you will receive token on cycle

message: its name explained itself

Return

Standard ethers.TransactionResponse

sdk.rollOutMessage(ethersSigner: ethers.Signer, toChainId: number, receiveAddress: string, message: string): Promise<ethers.TransactionResponse>;

5.claimAssets

Usage

Claim your assets after being rolled out. The assets rolled in will be claimed automatically.

Parameters

ethersSigner: standard signer of ethers.js

claimInfo: the proxy object including everthing needed to claim

Return

Standard ethers.TransactionResponse

sdk.claimAsset(ethersSigner: ethers.Signer, claimInfo: IClaimInfo): Promise<ethers.TransactionResponse>;

6.claimMessage

Usage

Claim your message after being rolled out. The assets rolled in will be claimed automatically.

Parameters

ethersSigner: standard signer of ethers.js

claimInfo: the proxy object including everthing needed to claim

Return

Standard ethers.TransactionResponse

sdk.claimMessage(ethersSigner: ethers.Signer, claimInfo: IClaimInfo): Promise<ethers.TransactionResponse>;