Type alias DecreaseLiquidityParams

DecreaseLiquidityParams: {
    position: PublicKey;
    positionAuthority: PublicKey;
    positionTokenAccount: PublicKey;
    tickArrayLower: PublicKey;
    tickArrayUpper: PublicKey;
    tokenOwnerAccountA: PublicKey;
    tokenOwnerAccountB: PublicKey;
    tokenVaultA: PublicKey;
    tokenVaultB: PublicKey;
    whirlpool: PublicKey;
} & DecreaseLiquidityInput

Parameters to remove liquidity from a position.

Type declaration

  • position: PublicKey
  • positionAuthority: PublicKey
  • positionTokenAccount: PublicKey
  • tickArrayLower: PublicKey
  • tickArrayUpper: PublicKey
  • tokenOwnerAccountA: PublicKey
  • tokenOwnerAccountB: PublicKey
  • tokenVaultA: PublicKey
  • tokenVaultB: PublicKey
  • whirlpool: PublicKey

Param: liquidityAmount

The total amount of Liquidity the user is withdrawing

Param: tokenMinA

The minimum amount of token A to remove from the position.

Param: tokenMinB

The minimum amount of token B to remove from the position.

Param: whirlpool

PublicKey for the whirlpool that the position will be opened for.

Param: position

PublicKey for the position will be opened for.

Param: positionTokenAccount

PublicKey for the position token's associated token address.

Param: tokenOwnerAccountA

PublicKey for the token A account that will be withdrawed from.

Param: tokenOwnerAccountB

PublicKey for the token B account that will be withdrawed from.

Param: tokenVaultA

PublicKey for the tokenA vault for this whirlpool.

Param: tokenVaultB

PublicKey for the tokenB vault for this whirlpool.

Param: tickArrayLower

PublicKey for the tick-array account that hosts the tick at the lower tick index.

Param: tickArrayUpper

PublicKey for the tick-array account that hosts the tick at the upper tick index.

Param: positionAuthority

authority that owns the token corresponding to this desired position.

Generated using TypeDoc