Interface IPumpAmmTask

Properties of a PumpAmmTask.

interface IPumpAmmTask {
    inAmount?: null | number;
    isXForY?: null | boolean;
    maxSlippage?: null | number;
    poolAddress?: null | string;
}

Implemented by

Properties

inAmount? isXForY? maxSlippage? poolAddress?

Properties

OptionalinAmount

inAmount?: null | number

Optional. The input token amount for the swap.

  • This value should in full units of the input token.
  • Default value: 1 (Swap 1 full token).

OptionalisXForY

isXForY?: null | boolean

Optional. Indicates the swap direction:

  • true: Swapping token X for token Y.
  • false: Swapping token Y for token X.
  • Default value: true.

OptionalmaxSlippage

maxSlippage?: null | number

Optional. The maximum allowed slippage for the swap, expressed as a percentage.

  • Example: 0.5 represents 0.5% slippage tolerance.
  • Default value: 3 (3% slippage tolerance).

OptionalpoolAddress

poolAddress?: null | string

Required. The address of the liquidity pool in the Pump AMM.

Settings

Member Visibility

On This Page

Properties