Interface ApiPoolWithdrawBody

Request body for withdrawing specific amounts from the pool, specifying which coins to remove, how much LP is burned, slippage, etc.

interface ApiPoolWithdrawBody {
    amountsOutDirection: CoinsToBalance;
    lpCoinAmount: bigint;
    referrer?: string;
    slippage: number;
    walletAddress: string;
}

Properties

amountsOutDirection: CoinsToBalance

Non-zero entries describe the relative output direction for each coin type.

lpCoinAmount: bigint

The LP amount to burn, in the LP coin's smallest unit.

referrer?: string

An optional referrer address used to register the referral in the transaction.

slippage: number

The maximum output shortfall accepted by the transaction. 0.01 is 1%.

walletAddress: string

The wallet that owns the LP coins and receives the withdrawn coins.