RemoveLiquidityOptions
@pegasys-fi/v3-sdk / Exports / RemoveLiquidityOptions
Interface: RemoveLiquidityOptions
Options for producing the calldata to exit a position.
Table of contents
Properties
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:162
collectOptions
• collectOptions: Omit<CollectOptions, "tokenId">
Parameters to be passed on to collect
Defined in
nonfungiblePositionManager.ts:172
deadline
• deadline: BigintIsh
When the transaction expires, in epoch seconds.
Defined in
nonfungiblePositionManager.ts:157
liquidityPercentage
• liquidityPercentage: Percent
The percentage of position liquidity to exit.
Defined in
nonfungiblePositionManager.ts:147
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:167
slippageTolerance
• slippageTolerance: Percent
How much the pool price is allowed to move.
Defined in
nonfungiblePositionManager.ts:152
tokenId
• tokenId: BigintIsh
The ID of the token to exit