Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Position

Helper class to interact with a Position account and build complex transactions.

Hierarchy

  • Position

Index

Methods

Methods

collectFees

  • collectFees(updateFeesAndRewards?: boolean, ownerTokenAccountMap?: Partial<Record<string, Address>>, destinationWallet?: Address, positionWallet?: Address, ataPayer?: Address, opts?: SimpleAccountFetchOptions): Promise<TransactionBuilder>

  • Collect fees from this position

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

    Parameters

    • Optional updateFeesAndRewards: boolean

      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)

    • Optional ownerTokenAccountMap: 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)

    • Optional destinationWallet: Address

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

    • Optional positionWallet: Address

      the wallet to that houses the position token. If null, the WhirlpoolContext wallet is used.

    • Optional ataPayer: Address

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

    • Optional opts: SimpleAccountFetchOptions

      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?: Address[], updateFeesAndRewards?: boolean, ownerTokenAccountMap?: Partial<Record<string, Address>>, destinationWallet?: Address, positionWallet?: Address, ataPayer?: Address, opts?: SimpleAccountFetchOptions): Promise<TransactionBuilder>

  • Collect rewards from this position

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

    Parameters

    • Optional rewardsToCollect: Address[]

      reward mints to collect (omitting this parameter means all rewards will be collected)

    • Optional updateFeesAndRewards: boolean

      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)

    • Optional ownerTokenAccountMap: 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)

    • Optional destinationWallet: Address

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

    • Optional positionWallet: Address

      the wallet to that houses the position token. If null, the WhirlpoolContext wallet is used.

    • Optional ataPayer: Address

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

    • Optional opts: SimpleAccountFetchOptions

      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

decreaseLiquidity

  • decreaseLiquidity(liquidityInput: DecreaseLiquidityInput, resolveATA?: boolean, destinationWallet?: Address, positionWallet?: Address, ataPayer?: Address): 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.

    • Optional resolveATA: boolean

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

    • Optional destinationWallet: Address

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

    • Optional positionWallet: Address

      the wallet to that houses the position token. If null, the WhirlpoolContext wallet is used.

    • Optional ataPayer: 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

getLowerTickData

  • 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.

getUpperTickData

  • 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

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

    Returns WhirlpoolData

    most recently fetched WhirlpoolData for this position.

increaseLiquidity

  • increaseLiquidity(liquidityInput: IncreaseLiquidityInput, resolveATA?: boolean, wallet?: Address, positionWallet?: Address, ataPayer?: Address): 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.

    • Optional resolveATA: boolean

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

    • Optional wallet: Address

      to withdraw tokens to deposit into the position. If null, the WhirlpoolContext wallet is used.

    • Optional positionWallet: Address

      the wallet to that houses the position token. If null, the WhirlpoolContext wallet is used.

    • Optional ataPayer: 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

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

    Returns Promise<PositionData>

    the most up to date PositionData for this address.

Generated using TypeDoc