Old swap params

TIP

We have maintained compatibility with the old swap parameters in the new version of the SDK. This means that even if you make no changes to your code, simply upgrading the SDK version will allow it to function properly.

1. Build fast swap transaction.

This method will send swaped coins to user directly.. Here are two type fast swap params:

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

import { AggregatorClient } from "@cetusprotocol/aggregator-sdk"
import { Transaction } from '@mysten/sui/transactions';
import BN from "bn.js"

const client = new AggregatorClient()

const amount = new BN(1000000)
const from = "0x2::sui::SUI"
const target = "0x06864a6f921804860930db6ddbe2e16acdf8504495ea7481637a1c8b9a8fe54b::cetus::CETUS"

const routers = await client.findRouters({
  from,
  target,
  amount,
  byAmountIn: true, // `true` means fix input amount, `false` means fix output amount
})

const txb = new Transaction()

await client.fastRouterSwap({
  routers: routerRes.routes,
  byAmountIn,
  txb,
  slippage: 0.01,
  isMergeTragetCoin: true,
  refreshAllCoins: true,
})

2. 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.

Example

import { AggregatorClient } from "@cetusprotocol/aggregator-sdk"
import { Transaction } from '@mysten/sui/transactions';
​import BN from "bn.js"

const client = new AggregatorClient()
​
const amount = new BN(1000000)
const from = "0x2::sui::SUI"
const target = "0x06864a6f921804860930db6ddbe2e16acdf8504495ea7481637a1c8b9a8fe54b::cetus::CETUS"
​
const routers = await client.findRouters({
  from,
  target,
  amount,
  byAmountIn: true, // `true` means fix input amount, `false` means fix output amount
})
​
const txb = new Transaction()
​
const targetCoin = await client.routerSwap({
  routers: routerRes.routes,
  byAmountIn: true,
  txb,
  inputCoin,
  slippage: 0.01,
})
​
// you can use this target coin object argument to build your ptb.
const client.transferOrDestoryCoin(
    txb,
    targetCoin,
    target
)