Type alias CollectRewardV2Params

CollectRewardV2Params: {
    position: PublicKey;
    positionAuthority: PublicKey;
    positionTokenAccount: PublicKey;
    rewardIndex: number;
    rewardMint: PublicKey;
    rewardOwnerAccount: PublicKey;
    rewardTokenProgram: PublicKey;
    rewardTransferHookAccounts?: AccountMeta[];
    rewardVault: PublicKey;
    whirlpool: PublicKey;
}

Parameters to collect rewards from a reward index in a position.

Type declaration

  • position: PublicKey
  • positionAuthority: PublicKey
  • positionTokenAccount: PublicKey
  • rewardIndex: number
  • rewardMint: PublicKey
  • rewardOwnerAccount: PublicKey
  • rewardTokenProgram: PublicKey
  • Optional rewardTransferHookAccounts?: AccountMeta[]
  • rewardVault: PublicKey
  • whirlpool: PublicKey

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: positionAuthority

authority that owns the token corresponding to this desired position.

Param: rewardIndex

The reward index that we'd like to initialize. (0 <= index <= NUM_REWARDS).

Param: rewardMint

PublicKey for the reward token mint.

Param: rewardOwnerAccount

PublicKey for the reward token account that the reward will deposit into.

Param: rewardVault

PublicKey of the vault account that reward will be withdrawn from.

Param: rewardTransferHookAccounts

Optional array of token transfer hook accounts for the reward token.

Param: rewardTokenProgram

PublicKey for the token program.

Generated using TypeDoc