Features Available
1. Find best router swap result
Func client.findRouters
Params
from(String): the coin type of input coin.
target(String): the coin type of output coin.
amount(BN): the amount of input or output.
byAmountIn(boolean):
true
means fixed the amount of input,false
means fixed the amount of output.providers:(Option, String Array): Now, support cetus, deepbook v2/v3, kriya v2/v3, flowx v2/v3, aftermath, turbos, afsui, volo, haedal, bluemove. If not set, it's will default support all providers.
depth(Option, number): now depths support betweent 1 and 3, default setting is 3, it means you can get 3 hops path.
splitAlgorithm(Option, String): devide_equally or geometric, recommand just use default devide_equally.
splitFactor: (Option, number): used to contral geometric split width.
splitCount(Option, number): this field represents the maximum number of splits for a transaction. If you do not want to split, set it to 1. The default value is 20.
Example
2. Build fast swap transaction.
This method will send swaped coins to user directly.
Params
routers(Router Object): The result from findRouter(), representing the path chosen for the swap.
byAmountIn(boolean): The input params as the same as request in findRouter().
txb(Transaction): The programmable transaction builder.
slippage:(number): A value between 0 and 1, representing the maximum allowed price slippage as a percentage. A value of 0.01 allows up to 1% price slippage. This parameter is crucial for protecting your assets in a rapidly changing market.
isMergeTragetCoin(boolean): If set to true, the output coins are merged into the existing coin object to prevent an indefinite increase in the number of coin types held.
refreshAllCoins(Option(boolean)): If true, retrieves all coin types when setting up the swap; if false, uses the existing coins.
partner(Option(string)): The partner address. Details about partner can be found here.
Example
Build swap transaction and return target coin object.
This method will build transaction and return coin objects, used to build ptb.
Params
routers(Router Object): The result from findRouter(), representing the path chosen for the swap.
byAmountIn(boolean): The input params as the same as request in findRouter().
inputCoin(TransactionObjectArgument): This represents the input coin object. If you only support swaps with a fixed input, simply extract a fixed amount from the coin object. If you support fixed output, you need to extract an amount limited by the specified constraints from the coin object.
txb(Transaction): The programmable transaction builder.
slippage:(number): A value between 0 and 1, representing the maximum allowed price slippage as a percentage. A value of 0.01 allows up to 1% price slippage. This parameter is crucial for protecting your assets in a rapidly changing market.
partner(Option(string)): The partner address. Details about partner can be found here.
Return
targetCoin: TransactionObjectArgument
Example
Last updated