JS SDK Bridging

The Symbiosis protocol uses minting/burning mechanics to implement cross-chain swaps. 
Bridging is a process of 
Minting sTokens on one blockchain from stablecoins from another blockchain  or
Burning sTokens on one blockchain to obtain stablecoins on another blockchain.
What happens during bridging can be found in the document Mint/Burn processes.
JS SDK implements one method for bridging: exactIn that takes the following parameters for input:
Property
Description
amountIn 
An object of TokenAmount type. An amount of tokens (stablecoins or sTokens) the user gives away.
tokenOut 
The token the user expects to receive
address 
The recipient's address. Usually, it is identical to the sender's address but can differ.
revertableAddress 
The address that can revert this operation if this operation gets stuck. Usually, it is identical to the sender's address but can differ. Please refer to this document for more information on stuck operations. 
1
const bridging = symbiosis.newBridging()
2
​
3
const { execute, fee, tokenAmountOut } = await bridging.exactIn(
4
    amountIn,
5
    tokenOut,
6
    address,
7
    revertableAddress
8
)
9
​
10
const { response, waitForMined } = await execute(signer)
11
​
12
const { receipt, waitForComplete } = await waitForMined()
13
​
14
const log = await waitForComplete()
Copied!
The method exactIn returns:
Property
Description
execute
A function to execute the bridging operation. Calling this function triggers the bridging transaction signing and sends the signed transaction to the origin blockchain. Accepts an object of Signer type. 
fee
An object of TokenAmount type. The amount of tokens to pay the fee for bridging: the fee for relayers network work. Please refer to the document for more information on relayers. 
tokenAmountOut
An object of TokenAmount type.  An amount of tokens the user gets on the destination's blockchain. 
transactionRequest
Instance of TransactionRequest type, used in the stateless mode.

Calling the execute function returns: 
An object response of TransactionResponse type​
A function waitForMined is a function of waiting for the transaction to be mined.
Calling the waitForMined function returns: 
An object receipt of TransactionReceipt type​
A function waitForComplete is a function of waiting for getting tokens on the destination blockchain.
The stateless mode (since JS SDK v2.3)
1
const bridging = symbiosis.newBridging()
2
​
3
// transactionRequest contains everything you need to send a transaction by yourself
4
const { transactionRequest } = await bridging.exactIn(...)
5
​
6
// Send the transaction and get a receipt
7
const receipt = ...
8
​
9
// Wait for the transaction to be completed on the destination chain
10
const log = await bridging.waitForComplete(receipt)
Copied!

Symbiosis JS SDK - Previous

JS SDK Token Representation

Next - Symbiosis JS SDK

JS SDK Cross-chain Swap

Last modified 7d ago

Copy link