Skip to main content
Version: 3.0.0

RemoveLiquidityOptions

Options for producing the calldata to exit a position.

Properties#

burnToken#

Optional burnToken: boolean

Whether the NFT should be burned if the entire position is being exited, by default false.

Defined in: nonfungiblePositionManager.ts:139


collectOptions#

collectOptions: Pick<CollectOptions, "expectedCurrencyOwed0" | "expectedCurrencyOwed1" | "recipient">

Parameters to be passed on to collect

Defined in: nonfungiblePositionManager.ts:149


deadline#

deadline: BigintIsh

When the transaction expires, in epoch seconds.

Defined in: nonfungiblePositionManager.ts:134


liquidityPercentage#

liquidityPercentage: Percent

The percentage of position liquidity to exit.

Defined in: nonfungiblePositionManager.ts:124


permit#

Optional permit: NFTPermitOptions

The optional permit of the token ID being exited, in case the exit transaction is being sent by an account that does not own the NFT

Defined in: nonfungiblePositionManager.ts:144


slippageTolerance#

slippageTolerance: Percent

How much the pool price is allowed to move.

Defined in: nonfungiblePositionManager.ts:129


tokenId#

tokenId: BigintIsh

The ID of the token to exit

Defined in: nonfungiblePositionManager.ts:119