Class PositionImpl

constructor

• new PositionImpl(ctx, address, data, whirlpoolData, lowerTickArrayData, upperTickArrayData, positionMintTokenProgramId): PositionImpl

• Parameters

  • ctx: WhirlpoolContext
  • address: PublicKey
  • data: PositionData
  • whirlpoolData: WhirlpoolData
  • lowerTickArrayData: TickArrayData
  • upperTickArrayData: TickArrayData
  • positionMintTokenProgramId: PublicKey

  Returns PositionImpl

Readonlyaddress

Readonlyctx

ReadonlypositionMintTokenProgramId

collectFees

• collectFees(updateFeesAndRewards?, ownerTokenAccountMap?, destinationWallet?, positionWallet?, ataPayer?, opts?): Promise<TransactionBuilder>

• Collect fees from this position

  If positionWallet is provided, the wallet owners have to sign this transaction.

  Parameters

  • updateFeesAndRewards: boolean = true

    if true, add instructions to refresh the accumulated fees and rewards data (default to true unless you know that the collect fees quote and on-chain data match for the "feeOwedA" and "feeOwedB" fields in the Position account)
  • OptionalownerTokenAccountMap: Partial<Record<string, Address>>

    A record that maps a given mint to the owner's token account for that mint (if an entry doesn't exist, it will be automatically resolved)
  • OptionaldestinationWallet: Address

    the wallet to deposit tokens into when withdrawing from the position. If null, the WhirlpoolContext wallet is used.
  • OptionalpositionWallet: Address

    the wallet to that houses the position token. If null, the WhirlpoolContext wallet is used.
  • OptionalataPayer: Address

    wallet that will fund the creation of the new associated token accounts
  • opts: SimpleAccountFetchOptions = PREFER_CACHE

    an options object to define fetch and cache options when accessing on-chain accounts

  Returns Promise<TransactionBuilder>

  the transaction that will collect fees from the position

collectRewards

• collectRewards(rewardsToCollect?, updateFeesAndRewards?, ownerTokenAccountMap?, destinationWallet?, positionWallet?, ataPayer?, opts?): Promise<TransactionBuilder[]>

• Collect rewards from this position

  If positionWallet is provided, the wallet owners have to sign this transaction.

  Parameters

  • OptionalrewardsToCollect: Address[]

    reward mints to collect (omitting this parameter means all rewards will be collected)
  • updateFeesAndRewards: boolean = true

    if true, add instructions to refresh the accumulated fees and rewards data (default to true unless you know that the collect fees quote and on-chain data match for the "feeOwedA" and "feeOwedB" fields in the Position account)
  • OptionalownerTokenAccountMap: Partial<Record<string, Address>>

    A record that maps a given mint to the owner's token account for that mint (if an entry doesn't exist, it will be automatically resolved)
  • OptionaldestinationWallet: Address

    the wallet to deposit tokens into when withdrawing from the position. If null, the WhirlpoolContext wallet is used.
  • OptionalpositionWallet: Address

    the wallet to that houses the position token. If null, the WhirlpoolContext wallet is used.
  • OptionalataPayer: Address

    wallet that will fund the creation of the new associated token accounts
  • opts: SimpleAccountFetchOptions = IGNORE_CACHE

    an options object to define fetch and cache options when accessing on-chain accounts

  Returns Promise<TransactionBuilder[]>

  the transactions that will collect rewards from the position. The transactions must be executed serially.

decreaseLiquidity

• decreaseLiquidity(liquidityInput, resolveATA?, sourceWallet?, positionWallet?, ataPayer?): Promise<TransactionBuilder>

• Withdraw liquidity from this position.

  If positionWallet is provided, the wallet owners have to sign this transaction.

  Parameters

  • liquidityInput: DecreaseLiquidityInput

    input that defines the desired liquidity amount and minimum tokens willing to be to withdrawn from the position.
  • resolveATA: boolean = true

    if true, add instructions to create associated token accounts for tokenA,B for the destinationWallet if necessary. (RPC call required)
  • OptionalsourceWallet: Address
  • OptionalpositionWallet: Address

    the wallet to that houses the position token. If null, the WhirlpoolContext wallet is used.
  • OptionalataPayer: Address

    wallet that will fund the creation of the new associated token accounts

  Returns Promise<TransactionBuilder>

  the transaction that will deposit the tokens into the position when executed.

getAddress

• getAddress(): PublicKey

• Return the address for this Whirlpool instance.

  Returns PublicKey

  the PublicKey for this Whirlpool instance.

getData

• getData(): PositionData

• Return the most recently fetched Position account data.

  Returns PositionData

  most recently fetched PositionData for this address.

getLowerTickData

• getLowerTickData(): TickData

• Return the most recently fetched TickData account data for this position's lower tick.

  Returns TickData

  most recently fetched TickData for this position's lower tick.

getPositionMintTokenProgramId

• getPositionMintTokenProgramId(): PublicKey

• Return the program address owning the position token.

  Returns PublicKey

  the PublicKey for the program address owning the position token.

getUpperTickData

• getUpperTickData(): TickData

• Return the most recently fetched TickData account data for this position's upper tick.

  Returns TickData

  most recently fetched TickData for this position's upper tick.

getWhirlpoolData

• getWhirlpoolData(): WhirlpoolData

• Return the most recently fetched Whirlpool account data for this position.

  Returns WhirlpoolData

  most recently fetched WhirlpoolData for this position.

increaseLiquidity

• increaseLiquidity(liquidityInput, resolveATA?, sourceWallet?, positionWallet?, ataPayer?): Promise<TransactionBuilder>

• Deposit additional tokens into this postiion. The wallet must contain the position token and the necessary token A & B to complete the deposit. If positionWallet and wallet is provided, the wallet owners have to sign this transaction.

  Parameters

  • liquidityInput: IncreaseLiquidityInput

    input that defines the desired liquidity amount and maximum tokens willing to be to deposited.
  • resolveATA: boolean = true

    if true, add instructions to create associated token accounts for tokenA,B for the destinationWallet if necessary. (RPC call required)
  • OptionalsourceWallet: Address
  • OptionalpositionWallet: Address

    the wallet to that houses the position token. If null, the WhirlpoolContext wallet is used.
  • OptionalataPayer: Address

    wallet that will fund the creation of the new associated token accounts

  Returns Promise<TransactionBuilder>

  the transaction that will deposit the tokens into the position when executed.

refreshData

• refreshData(): Promise<PositionData>

• Fetch and return the most recently fetched Position account data.

  Returns Promise<PositionData>

  the most up to date PositionData for this address.