Orca Whirlpools decoder

carbon-orca-whirlpool-decoder decodes the instructions, accounts and events of the Orca Whirlpools program (whirLbMiicVdio4qvUfM5KAg6Ct8VwpYzGff3uctyCc): 66 instructions, 12 account types, 6 events. It is generated with Codama from the program's IDL; see decoders for how decoders plug into a pipeline.

Other DEX and AMM decoders: BonkSwap, FluxBeam, Gavel, Heaven, Jupiter Limit Order, Jupiter Limit Order v2, Kamino Limit Order, Lifinity AMM v2, Meteora DAMM v2, Meteora DLMM, Meteora Pools, OpenBook v2, PancakeSwap, Phoenix v1, PumpSwap, Raydium AMM v4, Raydium CLMM, Raydium CPMM, Raydium Stable Swap, Stabble Stable Swap, Stabble Weighted Swap. To decode several in one pipeline, see dEX and AMM decoders.

The serde feature derives Serialize/Deserialize on every type, postgres adds tables and processors for Postgres, and graphql adds a schema for the GraphQL server.

Usage#

This program crawls recent Orca Whirlpools transactions from the public RPC and prints every decoded Swap instruction. Add the dependencies:

cargo add carbon-core@2.0.0 carbon-orca-whirlpool-decoder@2.0.0 carbon-rpc-transaction-crawler-datasource@2.0.0 carbon-log-metrics@2.0.0 env_logger tokio --features tokio/full

use {
    carbon_core::{
        error::CarbonResult, instruction::InstructionProcessorInputType, pipeline::Pipeline,
        processor::Processor,
    },
    carbon_log_metrics::LogMetrics,
    carbon_orca_whirlpool_decoder::{
        instructions::OrcaWhirlpoolInstruction, OrcaWhirlpoolDecoder, PROGRAM_ID,
    },
    carbon_rpc_transaction_crawler_datasource::{ConnectionConfig, Filters, RpcTransactionCrawler},
    std::sync::Arc,
};

#[tokio::main]
async fn main() -> CarbonResult<()> {
    env_logger::init();

    // Fetches the program's recent transactions over JSON-RPC, newest first.
    let datasource = RpcTransactionCrawler::new(
        "https://api.mainnet-beta.solana.com".to_string(),
        PROGRAM_ID,
        ConnectionConfig::default(),
        Filters::new(None, None, None),
        None,
    );

    Pipeline::builder()
        .datasource(datasource)
        .metrics(Arc::new(LogMetrics::new()))
        .instruction(OrcaWhirlpoolDecoder, InstructionLogger)
        .build()?
        .run()
        .await
}

struct InstructionLogger;

impl Processor<InstructionProcessorInputType<'_, OrcaWhirlpoolInstruction>> for InstructionLogger {
    async fn process(
        &mut self,
        input: &InstructionProcessorInputType<'_, OrcaWhirlpoolInstruction>,
    ) -> CarbonResult<()> {
        let signature = input.metadata.transaction_metadata.signature;
        if let OrcaWhirlpoolInstruction::Swap { data, accounts, .. } = input.decoded_instruction {
            println!("swap {signature}: {data:?} token_program={}", accounts.token_program);
        }
        Ok(())
    }
}

RUST_LOG=info cargo run

Each Swap instruction prints one line with the transaction signature and the decoded Swap data. The public endpoint rate-limits requests, so the first lines can take a while; use your own RPC URL for anything beyond a test. See stream with RPC for the crawler options.

Events published with Anchor's emit_cpi! arrive as the CpiEvent instruction. Match them with OrcaWhirlpoolInstruction::CpiEvent { data: CpiEvent::LiquidityDecreased(event), .. } (import instructions::CpiEvent); see Events. If CpiEvent never arrives, the program logs its events with emit! instead: decode them with decode_log_events.

Decode accounts#

The transaction crawler emits transactions only. To decode accounts, use a datasource that emits account updates. This program subscribes to the program's accounts with programSubscribe on the public WebSocket endpoint and prints every decoded Whirlpool account as it changes. Add the datasource and the Solana RPC types it takes:

cargo add carbon-rpc-program-subscribe-datasource@2.0.0 solana-client@4.2.2

use {
    carbon_core::{
        account::AccountProcessorInputType, error::CarbonResult, pipeline::Pipeline,
        processor::Processor,
    },
    carbon_log_metrics::LogMetrics,
    carbon_orca_whirlpool_decoder::{
        accounts::OrcaWhirlpoolAccount, OrcaWhirlpoolDecoder, PROGRAM_ID,
    },
    carbon_rpc_program_subscribe_datasource::{Filters, RpcProgramSubscribe},
    solana_client::rpc_config::{RpcAccountInfoConfig, RpcProgramAccountsConfig, UiAccountEncoding},
    std::sync::Arc,
};

#[tokio::main]
async fn main() -> CarbonResult<()> {
    env_logger::init();

    // Streams every change to an account owned by the program (programSubscribe).
    let config = RpcProgramAccountsConfig {
        account_config: RpcAccountInfoConfig {
            encoding: Some(UiAccountEncoding::Base64),
            ..Default::default()
        },
        ..Default::default()
    };
    let datasource = RpcProgramSubscribe::new(
        "wss://api.mainnet-beta.solana.com".to_string(),
        Filters::new(PROGRAM_ID, Some(config)),
    );

    Pipeline::builder()
        .datasource(datasource)
        .metrics(Arc::new(LogMetrics::new()))
        .account(OrcaWhirlpoolDecoder, AccountLogger)
        .build()?
        .run()
        .await
}

struct AccountLogger;

impl Processor<AccountProcessorInputType<'_, OrcaWhirlpoolAccount>> for AccountLogger {
    async fn process(
        &mut self,
        input: &AccountProcessorInputType<'_, OrcaWhirlpoolAccount>,
    ) -> CarbonResult<()> {
        if let OrcaWhirlpoolAccount::Whirlpool(whirlpool) = &input.decoded_account.data {
            println!("whirlpool {}: {whirlpool:?}", input.metadata.pubkey);
        }
        Ok(())
    }
}

RUST_LOG=info cargo run

Each update to a Whirlpool account prints its address and decoded fields; the program runs until you stop it. Cargo resolves solana-client to 4.2.2, the exact version the datasource pins, so both use the same RpcProgramAccountsConfig type. To load every existing account once instead of streaming changes, see load account state.

Instructions#

Variants of OrcaWhirlpoolInstruction. Each is OrcaWhirlpoolInstruction::<Variant> { program_id, data, accounts }, where data and accounts are the types listed under the variant, exported from carbon_orca_whirlpool_decoder::instructions. Discriminators are the leading bytes of the instruction data, in hex.

How an instruction decodes. The decoder returns a variant only when all of these hold; otherwise the instruction is skipped and no processor is called:

1. The instruction's program ID is whirLbMiicVdio4qvUfM5KAg6Ct8VwpYzGff3uctyCc.
2. The data starts with the variant's discriminator, and the rest deserializes into its data type.
3. The instruction has at least as many accounts as the variant requires (the "Required accounts" count under each variant).

Accounts. They are matched by position, in the order listed. An account marked optional is None only when the instruction ends before it; Anchor programs pass the program ID as a placeholder for an omitted optional account, so check for Some(PROGRAM_ID) too. Accounts after the listed ones are in accounts.remaining as AccountMetas. The decoder doesn't record whether an account signed or was writable: read that from input.raw_instruction.accounts[i].is_signer and .is_writable, which follow the same order. It doesn't check signer, writable, owner or PDA constraints either; the program enforced those when the transaction executed, so a decoded instruction from a successful transaction already satisfied them.

CloseBundledPosition#

From the program's IDL:

Close a bundled position in a Whirlpool.

Authority

• position_bundle_authority - authority that owns the token corresponding to this desired position bundle.

Parameters

• bundle_index - The bundle index that we'd like to close.

Special Errors

• InvalidBundleIndex - If the provided bundle index is out of bounds.
• ClosePositionNotEmpty - The provided position account is not empty.

Discriminator 2924d8f51b556743 · data CloseBundledPosition · accounts CloseBundledPositionInstructionAccounts.

Required accounts: 5; extras go to remaining.

Fields of CloseBundledPositionInstructionAccounts, in account order:

ClosePosition#

From the program's IDL:

Close a position in a Whirlpool. Burns the position token in the owner's wallet. ### Authority

• "position_authority" - The authority that owns the position token.

Special Errors

• ClosePositionNotEmpty - The provided position account is not empty.

Discriminator 7b86510031446262 · data ClosePosition · accounts ClosePositionInstructionAccounts.

No data fields.

Required accounts: 6; extras go to remaining.

Fields of ClosePositionInstructionAccounts, in account order:

ClosePositionWithTokenExtensions#

From the program's IDL:

Close a position in a Whirlpool. Burns the position token in the owner's wallet. Mint and TokenAccount are based on Token-2022. And Mint accout will be also closed. ### Authority

• "position_authority" - The authority that owns the position token.

Special Errors

• ClosePositionNotEmpty - The provided position account is not empty.

Discriminator 01b6873b9b1963df · data ClosePositionWithTokenExtensions · accounts ClosePositionWithTokenExtensionsInstructionAccounts.

No data fields.

Required accounts: 6; extras go to remaining.

Fields of ClosePositionWithTokenExtensionsInstructionAccounts, in account order:

CollectFees#

From the program's IDL:

Collect fees accrued for this position.

Authority

• position_authority - authority that owns the token corresponding to this desired position.

Discriminator a498cf631eba13b6 · data CollectFees · accounts CollectFeesInstructionAccounts.

No data fields.

Required accounts: 9; extras go to remaining.

Fields of CollectFeesInstructionAccounts, in account order:

CollectFeesV2#

From the program's IDL:

Collect fees accrued for this position.
This instruction works with both Token and Token-2022.

Authority

• position_authority - authority that owns the token corresponding to this desired position.

Discriminator cf755fbfe5b4e20f · data CollectFeesV2 · accounts CollectFeesV2InstructionAccounts.

Required accounts: 13; extras go to remaining.

Fields of CollectFeesV2InstructionAccounts, in account order:

CollectProtocolFees#

From the program's IDL:

Collect the protocol fees accrued in this Whirlpool

Authority

• collect_protocol_fees_authority - assigned authority in the WhirlpoolConfig that can collect protocol fees

Discriminator 1643176296b246dc · data CollectProtocolFees · accounts CollectProtocolFeesInstructionAccounts.

No data fields.

Required accounts: 8; extras go to remaining.

Fields of CollectProtocolFeesInstructionAccounts, in account order:

CollectProtocolFeesV2#

From the program's IDL:

Collect the protocol fees accrued in this Whirlpool
This instruction works with both Token and Token-2022.

Authority

• collect_protocol_fees_authority - assigned authority in the WhirlpoolConfig that can collect protocol fees

Discriminator 6780de8672c816c8 · data CollectProtocolFeesV2 · accounts CollectProtocolFeesV2InstructionAccounts.

Required accounts: 12; extras go to remaining.

Fields of CollectProtocolFeesV2InstructionAccounts, in account order:

CollectReward#

From the program's IDL:

Collect rewards accrued for this position.

Authority

• position_authority - authority that owns the token corresponding to this desired position.

Discriminator 4605845756ebb122 · data CollectReward · accounts CollectRewardInstructionAccounts.

Required accounts: 7; extras go to remaining.

Fields of CollectRewardInstructionAccounts, in account order:

CollectRewardV2#

From the program's IDL:

Collect rewards accrued for this position.
This instruction works with both Token and Token-2022.

Authority

• position_authority - authority that owns the token corresponding to this desired position.

Discriminator b16b25b4a01331d1 · data CollectRewardV2 · accounts CollectRewardV2InstructionAccounts.

Required accounts: 9; extras go to remaining.

Fields of CollectRewardV2InstructionAccounts, in account order:

DecreaseLiquidity#

From the program's IDL:

Withdraw liquidity from a position in the Whirlpool. This call also updates the position's accrued fees and rewards. ### Authority

• position_authority - authority that owns the token corresponding to this desired position.

Parameters

• liquidity_amount - The total amount of Liquidity the user desires to withdraw.
• token_min_a - The minimum amount of tokenA the user is willing to withdraw.
• token_min_b - The minimum amount of tokenB the user is willing to withdraw.

Special Errors

• LiquidityZero - Provided liquidity amount is zero.
• LiquidityTooHigh - Provided liquidity exceeds u128::max.
• TokenMinSubceeded - The required token to perform this operation subceeds the user defined amount.

Discriminator a026d06f685b2c01 · data DecreaseLiquidity · accounts DecreaseLiquidityInstructionAccounts.

Required accounts: 11; extras go to remaining.

Fields of DecreaseLiquidityInstructionAccounts, in account order:

DecreaseLiquidityV2#

From the program's IDL:

Withdraw liquidity from a position in the Whirlpool. This call also updates the position's accrued fees and rewards. This instruction works with both
Token and Token-2022. ### Authority

• position_authority - authority that owns the token corresponding to this desired position.

Parameters

• liquidity_amount - The total amount of Liquidity the user desires to withdraw.
• token_min_a - The minimum amount of tokenA the user is willing to withdraw.
• token_min_b - The minimum amount of tokenB the user is willing to withdraw.

Special Errors

• LiquidityZero - Provided liquidity amount is zero.
• LiquidityTooHigh - Provided liquidity exceeds u128::max.
• TokenMinSubceeded - The required token to perform this operation subceeds the user defined amount.

Discriminator 3a7fbc3e4f52c460 · data DecreaseLiquidityV2 · accounts DecreaseLiquidityV2InstructionAccounts.

Required accounts: 15; extras go to remaining.

Fields of DecreaseLiquidityV2InstructionAccounts, in account order:

DeletePositionBundle#

From the program's IDL:

Delete a PositionBundle account. Burns the position bundle token in the owner's wallet. ### Authority

• position_bundle_owner - The owner that owns the position bundle token.

Special Errors

• PositionBundleNotDeletable - The provided position bundle has open positions.

Discriminator 64196302d9ef7cad · data DeletePositionBundle · accounts DeletePositionBundleInstructionAccounts.

No data fields.

Required accounts: 6; extras go to remaining.

Fields of DeletePositionBundleInstructionAccounts, in account order:

DeleteTokenBadge#

From the program's IDL:

Delete a TokenBadge account.

Authority

• "token_badge_authority" - Set authority in the WhirlpoolConfigExtension

Special Errors

• FeatureIsNotEnabled - If the feature flag for token badges is not enabled.

Discriminator 35924408127511b9 · data DeleteTokenBadge · accounts DeleteTokenBadgeInstructionAccounts.

No data fields.

Required accounts: 6; extras go to remaining.

Fields of DeleteTokenBadgeInstructionAccounts, in account order:

IdlInclude#

Discriminator dffd79793cc1811f · data IdlInclude · accounts IdlIncludeInstructionAccounts.

No data fields.

Required accounts: 2; extras go to remaining.

Fields of IdlIncludeInstructionAccounts, in account order:

IncreaseLiquidity#

From the program's IDL:

Add liquidity to a position in the Whirlpool. This call also updates the position's accrued fees and rewards. ### Authority

• position_authority - authority that owns the token corresponding to this desired position.

Parameters

• liquidity_amount - The total amount of Liquidity the user is willing to deposit.
• token_max_a - The maximum amount of tokenA the user is willing to deposit.
• token_max_b - The maximum amount of tokenB the user is willing to deposit.

Special Errors

• LiquidityZero - Provided liquidity amount is zero.
• LiquidityTooHigh - Provided liquidity exceeds u128::max.
• TokenMaxExceeded - The required token to perform this operation exceeds the user defined amount.

Discriminator 2e9cf3760dcdfbb2 · data IncreaseLiquidity · accounts IncreaseLiquidityInstructionAccounts.

Required accounts: 11; extras go to remaining.

Fields of IncreaseLiquidityInstructionAccounts, in account order:

IncreaseLiquidityByTokenAmountsV2#

From the program's IDL:

Add liquidity to a position by specifying token maxima, not liquidity.
This instruction works with both Token and Token-2022.
NOTE: This instruction is only implemented in Pinocchio, not Anchor.

Authority

• position_authority - authority that owns the token corresponding to this desired position.

Parameters

• token_max_a - The maximum amount of tokenA the user is willing to deposit.
• token_max_b - The maximum amount of tokenB the user is willing to deposit.
• min_sqrt_price - The minimum sqrt price allowed.
• max_sqrt_price - The maximum sqrt price allowed.

Special Errors

• LiquidityZero - Computed liquidity amount is zero.
• LiquidityTooHigh - Computed liquidity exceeds u128::max.
• TokenMaxExceeded - The required token to perform this operation exceeds the user defined amount.

Discriminator effb097cd2c6352b · data IncreaseLiquidityByTokenAmountsV2 · accounts IncreaseLiquidityByTokenAmountsV2InstructionAccounts.

Required accounts: 15; extras go to remaining.

Fields of IncreaseLiquidityByTokenAmountsV2InstructionAccounts, in account order:

IncreaseLiquidityV2#

From the program's IDL:

Add liquidity to a position in the Whirlpool. This call also updates the position's accrued fees and rewards. This instruction works with both Token and Token-2022. ### Authority

• position_authority - authority that owns the token corresponding to this desired position.

Parameters

• liquidity_amount - The total amount of Liquidity the user is willing to deposit.
• token_max_a - The maximum amount of tokenA the user is willing to deposit.
• token_max_b - The maximum amount of tokenB the user is willing to deposit.

Special Errors

• LiquidityZero - Provided liquidity amount is zero.
• LiquidityTooHigh - Provided liquidity exceeds u128::max.
• TokenMaxExceeded - The required token to perform this operation exceeds the user defined amount.

Discriminator 851d59df45eeb00a · data IncreaseLiquidityV2 · accounts IncreaseLiquidityV2InstructionAccounts.

Required accounts: 15; extras go to remaining.

Fields of IncreaseLiquidityV2InstructionAccounts, in account order:

InitializeAdaptiveFeeTier#

From the program's IDL:

Initializes an adaptive_fee_tier account usable by Whirlpools in a
WhirlpoolConfig space. ### Authority

• "fee_authority" - Set authority in the WhirlpoolConfig

Parameters

• fee_tier_index - The index of the fee-tier that this adaptive fee tier will be initialized.
• tick_spacing - The tick-spacing that this fee-tier suggests the default_fee_rate for.
• initialize_pool_authority - The authority that can initialize pools with this adaptive fee-tier.
• delegated_fee_authority - The authority that can set the base fee rate for pools using this adaptive fee-tier.
• default_fee_rate - The default fee rate that a pool will use if the pool uses this

fee tier during initialization.

• filter_period - Period determine high frequency trading time window.
  (seconds)
• decay_period - Period determine when the adaptive fee start decrease.
  (seconds)
• reduction_factor - Adaptive fee rate decrement rate.
• adaptive_fee_control_factor - Adaptive fee control factor.
• max_volatility_accumulator - Max volatility accumulator.
• tick_group_size - Tick group size to define tick group index.
• major_swap_threshold_ticks - Major swap threshold ticks to define major swap.

Special Errors

• InvalidTickSpacing - If the provided tick_spacing is 0.
• InvalidFeeTierIndex - If the provided fee_tier_index is same to tick_spacing.
• FeeRateMaxExceeded - If the provided default_fee_rate exceeds
  MAX_FEE_RATE.
• InvalidAdaptiveFeeConstants - If the provided adaptive fee constants are invalid.

Discriminator 4d63d0c88d7b7530 · data InitializeAdaptiveFeeTier · accounts InitializeAdaptiveFeeTierInstructionAccounts.

Required accounts: 5; extras go to remaining.

Fields of InitializeAdaptiveFeeTierInstructionAccounts, in account order:

InitializeConfig#

From the program's IDL:

Initializes a WhirlpoolsConfig account that hosts info & authorities required to govern a set of Whirlpools.

Authority

• "authority" - Set authority that is one of ADMINS.

Parameters

• fee_authority - Authority authorized to initialize fee-tiers and set customs fees.
• collect_protocol_fees_authority - Authority authorized to collect protocol fees.
• reward_emissions_super_authority - Authority authorized to set reward authorities in pools.

Discriminator d07f1501c2bec446 · data InitializeConfig · accounts InitializeConfigInstructionAccounts.

Required accounts: 3; extras go to remaining.

Fields of InitializeConfigInstructionAccounts, in account order:

InitializeConfigExtension#

From the program's IDL:

Initializes a WhirlpoolConfigExtension account that hosts info & authorities. ### Authority

• "fee_authority" - Set authority in the WhirlpoolConfig

Discriminator 370935097239d134 · data InitializeConfigExtension · accounts InitializeConfigExtensionInstructionAccounts.

No data fields.

Required accounts: 5; extras go to remaining.

Fields of InitializeConfigExtensionInstructionAccounts, in account order:

InitializeDynamicTickArray#

From the program's IDL:

Initialize a variable-length tick array for a Whirlpool.

Parameters

• start_tick_index - The starting tick index for this tick-array.

Has to be a multiple of TickArray size & the tick spacing of this pool.

• idempotent - If true, the instruction will not fail if the tick array already exists.

Note: The idempotent option exits successfully if a FixedTickArray is present as well as a DynamicTickArray. #### Special Errors

• InvalidStartTick - if the provided start tick is out of bounds or is not a multiple of

TICK_ARRAY_SIZE * tick spacing.

Discriminator 2921a5c878e78e32 · data InitializeDynamicTickArray · accounts InitializeDynamicTickArrayInstructionAccounts.

Required accounts: 4; extras go to remaining.

Fields of InitializeDynamicTickArrayInstructionAccounts, in account order:

InitializeFeeTier#

From the program's IDL:

Initializes a fee_tier account usable by Whirlpools in a WhirlpoolConfig space. ### Authority

• "fee_authority" - Set authority in the WhirlpoolConfig

Parameters

• tick_spacing - The tick-spacing that this fee-tier suggests the default_fee_rate for.
• default_fee_rate - The default fee rate that a pool will use if the pool uses this

fee tier during initialization.

Special Errors

• InvalidTickSpacing - If the provided tick_spacing is 0.
• FeeRateMaxExceeded - If the provided default_fee_rate exceeds MAX_FEE_RATE.

Discriminator b74a9ca070022a1e · data InitializeFeeTier · accounts InitializeFeeTierInstructionAccounts.

Required accounts: 5; extras go to remaining.

Fields of InitializeFeeTierInstructionAccounts, in account order:

InitializePool#

From the program's IDL:

Initializes a Whirlpool account.
Fee rate is set to the default values on the config and supplied fee_tier.

Parameters

• bumps - The bump value when deriving the PDA of the Whirlpool address.
• tick_spacing - The desired tick spacing for this pool.
• initial_sqrt_price - The desired initial sqrt-price for this pool

Special Errors

InvalidTokenMintOrder - The order of mints have to be ordered by SqrtPriceOutOfBounds - provided initial_sqrt_price is not between 2^-64 to 2^64

Discriminator 5fb40aac54aee828 · data InitializePool · accounts InitializePoolInstructionAccounts.

Required accounts: 11; extras go to remaining.

Fields of InitializePoolInstructionAccounts, in account order:

InitializePoolV2#

From the program's IDL:

Initializes a Whirlpool account.
This instruction works with both Token and Token-2022.
Fee rate is set to the default values on the config and supplied fee_tier.

Parameters

• bumps - The bump value when deriving the PDA of the Whirlpool address.
• tick_spacing - The desired tick spacing for this pool.
• initial_sqrt_price - The desired initial sqrt-price for this pool

Special Errors

InvalidTokenMintOrder - The order of mints have to be ordered by SqrtPriceOutOfBounds - provided initial_sqrt_price is not between 2^-64 to 2^64

Discriminator cf2d57f21b3fcc43 · data InitializePoolV2 · accounts InitializePoolV2InstructionAccounts.

Required accounts: 14; extras go to remaining.

Fields of InitializePoolV2InstructionAccounts, in account order:

InitializePoolWithAdaptiveFee#

From the program's IDL:

Initializes a Whirlpool account and Oracle account with adaptive fee.

Parameters

• initial_sqrt_price - The desired initial sqrt-price for this pool
• trade_enable_timestamp - The timestamp when trading is enabled for this pool (within 72 hours)

Special Errors

InvalidTokenMintOrder - The order of mints have to be ordered by SqrtPriceOutOfBounds - provided initial_sqrt_price is not between 2^-64 to 2^64 InvalidTradeEnableTimestamp - provided trade_enable_timestamp is not within 72 hours or the adaptive fee-tier is permission-less UnsupportedTokenMint - The provided token mint is not supported by the program (e.g. it has risky token extensions)

Discriminator 8f5e604cac7c77c7 · data InitializePoolWithAdaptiveFee · accounts InitializePoolWithAdaptiveFeeInstructionAccounts.

Required accounts: 16; extras go to remaining.

Fields of InitializePoolWithAdaptiveFeeInstructionAccounts, in account order:

InitializePositionBundle#

From the program's IDL:

Initializes a PositionBundle account that bundles several positions.
A unique token will be minted to represent the position bundle in the users wallet.

Discriminator 752df1951812c241 · data InitializePositionBundle · accounts InitializePositionBundleInstructionAccounts.

No data fields.

Required accounts: 9; extras go to remaining.

Fields of InitializePositionBundleInstructionAccounts, in account order:

InitializePositionBundleWithMetadata#

From the program's IDL:

Initializes a PositionBundle account that bundles several positions.
A unique token will be minted to represent the position bundle in the users wallet. Additional Metaplex metadata is appended to identify the token.

Discriminator 5d7c10b3f98373f5 · data InitializePositionBundleWithMetadata · accounts InitializePositionBundleWithMetadataInstructionAccounts.

No data fields.

Required accounts: 12; extras go to remaining.

Fields of InitializePositionBundleWithMetadataInstructionAccounts, in account order:

InitializeReward#

From the program's IDL:

Initialize reward for a Whirlpool. A pool can only support up to a set number of rewards. ### Authority

• "reward_authority" - assigned authority by the reward_super_authority for the specified

reward-index in this Whirlpool

Parameters

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

Special Errors

• InvalidRewardIndex - If the provided reward index doesn't match the lowest uninitialized

index in this pool, or exceeds NUM_REWARDS, or all reward slots for this pool has been initialized.

Discriminator 5f87c0c4f281e644 · data InitializeReward · accounts InitializeRewardInstructionAccounts.

Required accounts: 8; extras go to remaining.

Fields of InitializeRewardInstructionAccounts, in account order:

InitializeRewardV2#

From the program's IDL:

Initialize reward for a Whirlpool. A pool can only support up to a set number of rewards. This instruction works with both Token and Token-2022.

Authority

• "reward_authority" - assigned authority by the reward_super_authority for the specified

reward-index in this Whirlpool

Parameters

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

Special Errors

• InvalidRewardIndex - If the provided reward index doesn't match the lowest uninitialized

index in this pool, or exceeds NUM_REWARDS, or all reward slots for this pool has been initialized.

Discriminator 5b014d32ebe58531 · data InitializeRewardV2 · accounts InitializeRewardV2InstructionAccounts.

Required accounts: 9; extras go to remaining.

Fields of InitializeRewardV2InstructionAccounts, in account order:

InitializeTickArray#

From the program's IDL:

Initializes a fixed-length tick_array account to represent a tick-range in a
Whirlpool. ### Parameters

• start_tick_index - The starting tick index for this tick-array.

Has to be a multiple of TickArray size & the tick spacing of this pool.

Special Errors

• InvalidStartTick - if the provided start tick is out of bounds or is not a multiple of

TICK_ARRAY_SIZE * tick spacing.

Discriminator 0bbcc1d68d5b95b8 · data InitializeTickArray · accounts InitializeTickArrayInstructionAccounts.

Required accounts: 4; extras go to remaining.

Fields of InitializeTickArrayInstructionAccounts, in account order:

InitializeTokenBadge#

From the program's IDL:

Initialize a TokenBadge account.

Authority

• "token_badge_authority" - Set authority in the WhirlpoolConfigExtension

Special Errors

• FeatureIsNotEnabled - If the feature flag for token badges is not enabled.

Discriminator fd4dcd5f1be059df · data InitializeTokenBadge · accounts InitializeTokenBadgeInstructionAccounts.

No data fields.

Required accounts: 7; extras go to remaining.

Fields of InitializeTokenBadgeInstructionAccounts, in account order:

LockPosition#

From the program's IDL:

Lock the position to prevent any liquidity changes.

Authority

• position_authority - The authority that owns the position token.

Special Errors

• PositionAlreadyLocked - The provided position is already locked.
• PositionNotLockable - The provided position is not lockable (e.g. An empty position).

Discriminator e33e02fcf70aabb9 · data LockPosition · accounts LockPositionInstructionAccounts.

Required accounts: 9; extras go to remaining.

Fields of LockPositionInstructionAccounts, in account order:

MigrateRepurposeRewardAuthoritySpace#

From the program's IDL:

Migration instruction to repurpose the reward authority space in the
Whirlpool. TODO: This instruction should be removed once all pools have been migrated.

Discriminator d6a1f84f9862ace7 · data MigrateRepurposeRewardAuthoritySpace · accounts MigrateRepurposeRewardAuthoritySpaceInstructionAccounts.

No data fields.

Required accounts: 1; extras go to remaining.

Fields of MigrateRepurposeRewardAuthoritySpaceInstructionAccounts, in account order:

OpenBundledPosition#

From the program's IDL:

Open a bundled position in a Whirlpool. No new tokens are issued because the owner of the position bundle becomes the owner of the position.
The position will start off with 0 liquidity.

Authority

• position_bundle_authority - authority that owns the token corresponding to this desired position bundle.

Parameters

• bundle_index - The bundle index that we'd like to open.
• tick_lower_index - The tick specifying the lower end of the position range.
• tick_upper_index - The tick specifying the upper end of the position range.

Special Errors

• InvalidBundleIndex - If the provided bundle index is out of bounds.
• InvalidTickIndex - If a provided tick is out of bounds, out of order or not a multiple of

the tick-spacing in this pool.

Discriminator a9717eabd5acd431 · data OpenBundledPosition · accounts OpenBundledPositionInstructionAccounts.

Required accounts: 8; extras go to remaining.

Fields of OpenBundledPositionInstructionAccounts, in account order:

OpenPosition#

From the program's IDL:

Open a position in a Whirlpool. A unique token will be minted to represent the position in the users wallet. The position will start off with 0 liquidity. ### Parameters

• tick_lower_index - The tick specifying the lower end of the position range.
• tick_upper_index - The tick specifying the upper end of the position range.

Special Errors

• InvalidTickIndex - If a provided tick is out of bounds, out of order or not a multiple of

the tick-spacing in this pool.

Discriminator 87802f4d0f98f031 · data OpenPosition · accounts OpenPositionInstructionAccounts.

Required accounts: 10; extras go to remaining.

Fields of OpenPositionInstructionAccounts, in account order:

OpenPositionWithMetadata#

From the program's IDL:

Open a position in a Whirlpool. A unique token will be minted to represent the position in the users wallet. Additional Metaplex metadata is appended to identify the token. The position will start off with 0 liquidity.

Parameters

• tick_lower_index - The tick specifying the lower end of the position range.
• tick_upper_index - The tick specifying the upper end of the position range.

Special Errors

• InvalidTickIndex - If a provided tick is out of bounds, out of order or not a multiple of

the tick-spacing in this pool.

Discriminator f21d86303a6e0e3c · data OpenPositionWithMetadata · accounts OpenPositionWithMetadataInstructionAccounts.

Required accounts: 13; extras go to remaining.

Fields of OpenPositionWithMetadataInstructionAccounts, in account order:

OpenPositionWithTokenExtensions#

From the program's IDL:

Open a position in a Whirlpool. A unique token will be minted to represent the position in the users wallet. Additional TokenMetadata extension is initialized to identify the token. Mint and TokenAccount are based on
Token-2022. The position will start off with 0 liquidity.

Parameters

• tick_lower_index - The tick specifying the lower end of the position range.
• tick_upper_index - The tick specifying the upper end of the position range.
• with_token_metadata_extension - If true, the token metadata extension will be initialized.

Special Errors

• InvalidTickIndex - If a provided tick is out of bounds, out of order or not a multiple of

the tick-spacing in this pool.

Discriminator d42f5f5c726683fa · data OpenPositionWithTokenExtensions · accounts OpenPositionWithTokenExtensionsInstructionAccounts.

Required accounts: 10; extras go to remaining.

Fields of OpenPositionWithTokenExtensionsInstructionAccounts, in account order:

RepositionLiquidityV2#

From the program's IDL:

An atomic instruction that repositions liquidity for a position through the following steps:

• Withdraws liquidity from the current position range
• Resets the position to a new tick range
• Adds liquidity to the new position range
• Restores fees and rewards

This instruction works with both Token and Token-2022.

Authority

• position_authority - authority that owns the token corresponding to this desired position.

Parameters

• new_tick_lower_index - The new tick index for the lower end of the position range.
• new_tick_upper_index - The new tick index for the upper end of the position range.
• new_liquidity_amount - The total amount of Liquidity the user is willing to deposit.
• existing_range_token_min_a - The minimum amount of tokenA the user is willing to withdraw from the existing range.
• existing_range_token_min_b - The minimum amount of tokenB the user is willing to withdraw from the existing range.
• new_range_token_max_a - The maximum amount of tokenA the user is willing to deposit into the new range.
• new_range_token_max_b - The maximum amount of tokenB the user is willing to deposit into the new range.

Special Errors

• LiquidityZero - Provided liquidity amount is zero.
• LiquidityTooHigh - Provided liquidity exceeds u128::max.
• TokenMaxExceeded - The required token to perform this operation exceeds the user defined amount.
• TokenMinSubceeded - The required token to perform this operation subceeds the user defined amount.
• InvalidTickIndex - If a provided tick is out of bounds, out of order or not a multiple of

the tick-spacing in this pool.

• SameTickRangeNotAllowed - The provided tick range is the same as the current tick range.

Discriminator bfa9e00b83139efd · data RepositionLiquidityV2 · accounts RepositionLiquidityV2InstructionAccounts.

Required accounts: 19; extras go to remaining.

Fields of RepositionLiquidityV2InstructionAccounts, in account order:

ResetPositionRange#

From the program's IDL:

Reset the position range to a new range.

Authority

• position_authority - The authority that owns the position token.

Parameters

• new_tick_lower_index - The new tick specifying the lower end of the position range.
• new_tick_upper_index - The new tick specifying the upper end of the position range.

Special Errors

• InvalidTickIndex - If a provided tick is out of bounds, out of order or not a multiple of

the tick-spacing in this pool.

• ClosePositionNotEmpty - The provided position account is not empty.
• SameTickRangeNotAllowed - The provided tick range is the same as the current tick range.

Discriminator a47bb48dc264a0af · data ResetPositionRange · accounts ResetPositionRangeInstructionAccounts.

Required accounts: 6; extras go to remaining.

Fields of ResetPositionRangeInstructionAccounts, in account order:

SetAdaptiveFeeConstants#

From the program's IDL:

Sets specific adaptive fee constants for a pool. Only the provided constants will be updated, others remain unchanged. Caller should avoid invoking this instruction when a pool's adaptive fee is high to prevent LP revenue loss

Authority

• fee_authority - Set authority in the WhirlpoolsConfig

Parameters

All parameters are optional. Only provided values will be updated.

• filter_period - Period determine high frequency trading time window.
  (seconds)
• decay_period - Period determine when the adaptive fee start decrease.
  (seconds)
• reduction_factor - Adaptive fee rate decrement rate.
• adaptive_fee_control_factor - Adaptive fee control factor.
• max_volatility_accumulator - Max volatility accumulator.
• tick_group_size - Tick group size to define tick group index.
• major_swap_threshold_ticks - Major swap threshold ticks to define major swap.

Special Errors

• InvalidAdaptiveFeeConstants - If the resulting constants are invalid for the pool's tick_spacing.
• AdaptiveFeeConstantsUnchanged - If the provided adaptive fee constants are unchanged from the existing constants.

Discriminator 859ed4bded0c4927 · data SetAdaptiveFeeConstants · accounts SetAdaptiveFeeConstantsInstructionAccounts.

Required accounts: 4; extras go to remaining.

Fields of SetAdaptiveFeeConstantsInstructionAccounts, in account order:

SetCollectProtocolFeesAuthority#

From the program's IDL:

Sets the fee authority to collect protocol fees for a WhirlpoolConfig.
Only the current collect protocol fee authority has permission to invoke this instruction. ### Authority

• "fee_authority" - Set authority that can collect protocol fees in the
  WhirlpoolConfig

Discriminator 22965df48be1e943 · data SetCollectProtocolFeesAuthority · accounts SetCollectProtocolFeesAuthorityInstructionAccounts.

No data fields.

Required accounts: 3; extras go to remaining.

Fields of SetCollectProtocolFeesAuthorityInstructionAccounts, in account order:

SetConfigExtensionAuthority#

From the program's IDL:

Sets the config extension authority for a WhirlpoolsConfigExtension.
Only the current config extension authority has permission to invoke this instruction. ### Authority

• "config_extension_authority" - Set authority in the
  WhirlpoolConfigExtension

Discriminator 2c5ef17418bc3c8f · data SetConfigExtensionAuthority · accounts SetConfigExtensionAuthorityInstructionAccounts.

No data fields.

Required accounts: 4; extras go to remaining.

Fields of SetConfigExtensionAuthorityInstructionAccounts, in account order:

SetConfigFeatureFlag#

From the program's IDL:

Sets the feature flag for a WhirlpoolConfig.

Authority

• "authority" - Set authority that is one of ADMINS.

Parameters

• feature_flag - The feature flag that the WhirlpoolConfig will use.

Discriminator 47ade41243f7d239 · data SetConfigFeatureFlag · accounts SetConfigFeatureFlagInstructionAccounts.

Required accounts: 2; extras go to remaining.

Fields of SetConfigFeatureFlagInstructionAccounts, in account order:

SetDefaultBaseFeeRate#

From the program's IDL:

Set the default_base_fee_rate for an AdaptiveFeeTier
Only the current fee authority in WhirlpoolsConfig has permission to invoke this instruction. ### Authority

• "fee_authority" - Set authority in the WhirlpoolConfig

Parameters

• default_base_fee_rate - The default base fee rate that a pool will use if the pool uses this

adaptive fee-tier during initialization.

Special Errors

• FeeRateMaxExceeded - If the provided default_fee_rate exceeds MAX_FEE_RATE.

Discriminator e54254fba486b707 · data SetDefaultBaseFeeRate · accounts SetDefaultBaseFeeRateInstructionAccounts.

Required accounts: 3; extras go to remaining.

Fields of SetDefaultBaseFeeRateInstructionAccounts, in account order:

SetDefaultFeeRate#

From the program's IDL:

Set the default_fee_rate for a FeeTier
Only the current fee authority has permission to invoke this instruction.

Authority

• "fee_authority" - Set authority in the WhirlpoolConfig

Parameters

• default_fee_rate - The default fee rate that a pool will use if the pool uses this

fee tier during initialization.

Special Errors

• FeeRateMaxExceeded - If the provided default_fee_rate exceeds MAX_FEE_RATE.

Discriminator 76d7d69db6e5d0e4 · data SetDefaultFeeRate · accounts SetDefaultFeeRateInstructionAccounts.

Required accounts: 3; extras go to remaining.

Fields of SetDefaultFeeRateInstructionAccounts, in account order:

SetDefaultProtocolFeeRate#

From the program's IDL:

Sets the default protocol fee rate for a WhirlpoolConfig
Protocol fee rate is represented as a basis point.
Only the current fee authority has permission to invoke this instruction.

Authority

• "fee_authority" - Set authority that can modify pool fees in the WhirlpoolConfig

Parameters

• default_protocol_fee_rate - Rate that is referenced during the initialization of a Whirlpool using this config.

Special Errors

• ProtocolFeeRateMaxExceeded - If the provided default_protocol_fee_rate exceeds MAX_PROTOCOL_FEE_RATE.

Discriminator 6bcdf9e297235600 · data SetDefaultProtocolFeeRate · accounts SetDefaultProtocolFeeRateInstructionAccounts.

Required accounts: 2; extras go to remaining.

Fields of SetDefaultProtocolFeeRateInstructionAccounts, in account order:

SetDelegatedFeeAuthority#

From the program's IDL:

Sets the delegated fee authority for an AdaptiveFeeTier.
The delegated fee authority can set the fee rate for individual pools initialized with the adaptive fee-tier. Only the current fee authority in
WhirlpoolsConfig has permission to invoke this instruction. ### Authority

• "fee_authority" - Set authority in the WhirlpoolConfig

Discriminator c1eae7938a39037a · data SetDelegatedFeeAuthority · accounts SetDelegatedFeeAuthorityInstructionAccounts.

No data fields.

Required accounts: 4; extras go to remaining.

Fields of SetDelegatedFeeAuthorityInstructionAccounts, in account order:

SetFeeAuthority#

From the program's IDL:

Sets the fee authority for a WhirlpoolConfig.
The fee authority can set the fee & protocol fee rate for individual pools or set the default fee rate for newly minted pools.
Only the current fee authority has permission to invoke this instruction.

Authority

• "fee_authority" - Set authority that can modify pool fees in the WhirlpoolConfig

Discriminator 1f013257ed656184 · data SetFeeAuthority · accounts SetFeeAuthorityInstructionAccounts.

No data fields.

Required accounts: 3; extras go to remaining.

Fields of SetFeeAuthorityInstructionAccounts, in account order:

SetFeeRate#

From the program's IDL:

Sets the fee rate for a Whirlpool.
Fee rate is represented as hundredths of a basis point.
Only the current fee authority has permission to invoke this instruction.

Authority

• "fee_authority" - Set authority that can modify pool fees in the WhirlpoolConfig

Parameters

• fee_rate - The rate that the pool will use to calculate fees going onwards.

Special Errors

• FeeRateMaxExceeded - If the provided fee_rate exceeds MAX_FEE_RATE.

Discriminator 35f38941088c9e06 · data SetFeeRate · accounts SetFeeRateInstructionAccounts.

Required accounts: 3; extras go to remaining.

Fields of SetFeeRateInstructionAccounts, in account order:

SetFeeRateByDelegatedFeeAuthority#

From the program's IDL:

Sets the fee rate for a Whirlpool by the delegated fee authority in
AdaptiveFeeTier. Fee rate is represented as hundredths of a basis point.

Authority

• "delegated_fee_authority" - Set authority that can modify pool fees in the AdaptiveFeeTier

Parameters

• fee_rate - The rate that the pool will use to calculate fees going onwards.

Special Errors

• FeeRateMaxExceeded - If the provided fee_rate exceeds MAX_FEE_RATE.

Discriminator 7979367283e6a268 · data SetFeeRateByDelegatedFeeAuthority · accounts SetFeeRateByDelegatedFeeAuthorityInstructionAccounts.

Required accounts: 3; extras go to remaining.

Fields of SetFeeRateByDelegatedFeeAuthorityInstructionAccounts, in account order:

SetInitializePoolAuthority#

From the program's IDL:

Sets the initialize pool authority for an AdaptiveFeeTier.
Only the initialize pool authority can initialize pools with the adaptive fee-tier. Only the current fee authority in WhirlpoolsConfig has permission to invoke this instruction. ### Authority

• "fee_authority" - Set authority in the WhirlpoolConfig

Discriminator 7d2b7feb951a6aec · data SetInitializePoolAuthority · accounts SetInitializePoolAuthorityInstructionAccounts.

No data fields.

Required accounts: 4; extras go to remaining.

Fields of SetInitializePoolAuthorityInstructionAccounts, in account order:

SetPresetAdaptiveFeeConstants#

From the program's IDL:

Sets the adaptive fee constants for an AdaptiveFeeTier.
Only the current fee authority in WhirlpoolsConfig has permission to invoke this instruction. ### Authority

• "fee_authority" - Set authority in the WhirlpoolConfig

Parameters

• filter_period - Period determine high frequency trading time window. (seconds)
• decay_period - Period determine when the adaptive fee start decrease.
  (seconds)
• reduction_factor - Adaptive fee rate decrement rate.
• adaptive_fee_control_factor - Adaptive fee control factor.
• max_volatility_accumulator - Max volatility accumulator.
• tick_group_size - Tick group size to define tick group index.
• major_swap_threshold_ticks - Major swap threshold ticks to define major swap.

Discriminator 84b94294535886c6 · data SetPresetAdaptiveFeeConstants · accounts SetPresetAdaptiveFeeConstantsInstructionAccounts.

Required accounts: 3; extras go to remaining.

Fields of SetPresetAdaptiveFeeConstantsInstructionAccounts, in account order:

SetProtocolFeeRate#

From the program's IDL:

Sets the protocol fee rate for a Whirlpool.
Protocol fee rate is represented as a basis point.
Only the current fee authority has permission to invoke this instruction.

Authority

• "fee_authority" - Set authority that can modify pool fees in the WhirlpoolConfig

Parameters

• protocol_fee_rate - The rate that the pool will use to calculate protocol fees going onwards.

Special Errors

• ProtocolFeeRateMaxExceeded - If the provided default_protocol_fee_rate exceeds MAX_PROTOCOL_FEE_RATE.

Discriminator 5f0704329a4f9c83 · data SetProtocolFeeRate · accounts SetProtocolFeeRateInstructionAccounts.

Required accounts: 3; extras go to remaining.

Fields of SetProtocolFeeRateInstructionAccounts, in account order:

SetRewardAuthority#

From the program's IDL:

Set the whirlpool reward authority at the provided reward_index.
Only the current reward authority for this reward index has permission to invoke this instruction. ### Authority

• "reward_authority" - Set authority that can control reward emission for this particular reward.

Special Errors

• InvalidRewardIndex - If the provided reward index doesn't match the lowest uninitialized

index in this pool, or exceeds NUM_REWARDS, or all reward slots for this pool has been initialized.

Discriminator 2227b7fc531c557f · data SetRewardAuthority · accounts SetRewardAuthorityInstructionAccounts.

Required accounts: 3; extras go to remaining.

Fields of SetRewardAuthorityInstructionAccounts, in account order:

SetRewardAuthorityBySuperAuthority#

From the program's IDL:

Set the whirlpool reward authority at the provided reward_index.
Only the current reward super authority has permission to invoke this instruction. ### Authority

• "reward_authority" - Set authority that can control reward emission for this particular reward.

Special Errors

• InvalidRewardIndex - If the provided reward index doesn't match the lowest uninitialized

index in this pool, or exceeds NUM_REWARDS, or all reward slots for this pool has been initialized.

Discriminator f09ac9c6945d3819 · data SetRewardAuthorityBySuperAuthority · accounts SetRewardAuthorityBySuperAuthorityInstructionAccounts.

Required accounts: 4; extras go to remaining.

Fields of SetRewardAuthorityBySuperAuthorityInstructionAccounts, in account order:

SetRewardEmissions#

From the program's IDL:

Set the reward emissions for a reward in a Whirlpool.

Authority

• "reward_authority" - assigned authority by the reward_super_authority for the specified

reward-index in this Whirlpool

Parameters

• reward_index - The reward index (0 <= index <= NUM_REWARDS) that we'd like to modify.
• emissions_per_second_x64 - The amount of rewards emitted in this pool.

Special Errors

• RewardVaultAmountInsufficient - The amount of rewards in the reward vault cannot emit

more than a day of desired emissions.

• InvalidTimestamp - Provided timestamp is not in order with the previous timestamp.
• InvalidRewardIndex - If the provided reward index doesn't match the lowest uninitialized

index in this pool, or exceeds NUM_REWARDS, or all reward slots for this pool has been initialized.

Discriminator 0dc556a86db01bf4 · data SetRewardEmissions · accounts SetRewardEmissionsInstructionAccounts.

Required accounts: 3; extras go to remaining.

Fields of SetRewardEmissionsInstructionAccounts, in account order:

SetRewardEmissionsSuperAuthority#

From the program's IDL:

Set the whirlpool reward super authority for a WhirlpoolConfig
Only the current reward super authority has permission to invoke this instruction. This instruction will not change the authority on any WhirlpoolRewardInfo whirlpool rewards. ### Authority

• "reward_emissions_super_authority" - Set authority that can control reward authorities for all pools in this config space.

Discriminator cf05c8d17a3852b7 · data SetRewardEmissionsSuperAuthority · accounts SetRewardEmissionsSuperAuthorityInstructionAccounts.

No data fields.

Required accounts: 3; extras go to remaining.

Fields of SetRewardEmissionsSuperAuthorityInstructionAccounts, in account order:

SetRewardEmissionsV2#

From the program's IDL:

Set the reward emissions for a reward in a Whirlpool.
This instruction works with both Token and Token-2022.

Authority

• "reward_authority" - assigned authority by the reward_super_authority for the specified

reward-index in this Whirlpool

Parameters

• reward_index - The reward index (0 <= index <= NUM_REWARDS) that we'd like to modify.
• emissions_per_second_x64 - The amount of rewards emitted in this pool.

Special Errors

• RewardVaultAmountInsufficient - The amount of rewards in the reward vault cannot emit

more than a day of desired emissions.

• InvalidTimestamp - Provided timestamp is not in order with the previous timestamp.
• InvalidRewardIndex - If the provided reward index doesn't match the lowest uninitialized

index in this pool, or exceeds NUM_REWARDS, or all reward slots for this pool has been initialized.

Discriminator 72e44820c130a066 · data SetRewardEmissionsV2 · accounts SetRewardEmissionsV2InstructionAccounts.

Required accounts: 3; extras go to remaining.

Fields of SetRewardEmissionsV2InstructionAccounts, in account order:

SetTokenBadgeAttribute#

From the program's IDL:

Set an attribute on a TokenBadge account.

Authority

• "token_badge_authority" - Set authority in the WhirlpoolConfigExtension

Parameters

• attribute - The attribute to set on the TokenBadge account.

Special Errors

• FeatureIsNotEnabled - If the feature flag for token badges is not enabled.

Discriminator e05841218a93f689 · data SetTokenBadgeAttribute · accounts SetTokenBadgeAttributeInstructionAccounts.

Required accounts: 5; extras go to remaining.

Fields of SetTokenBadgeAttributeInstructionAccounts, in account order:

SetTokenBadgeAuthority#

From the program's IDL:

Sets the token badge authority for a WhirlpoolsConfigExtension.
Only the config extension authority has permission to invoke this instruction. ### Authority

• "config_extension_authority" - Set authority in the
  WhirlpoolConfigExtension

Discriminator cfca0420cd4f0db2 · data SetTokenBadgeAuthority · accounts SetTokenBadgeAuthorityInstructionAccounts.

No data fields.

Required accounts: 4; extras go to remaining.

Fields of SetTokenBadgeAuthorityInstructionAccounts, in account order:

Swap#

From the program's IDL:

Perform a swap in this Whirlpool

Authority

• "token_authority" - The authority to withdraw tokens from the input token account.

Parameters

• amount - The amount of input or output token to swap from (depending on amount_specified_is_input).
• other_amount_threshold - The maximum/minimum of input/output token to swap into (depending on amount_specified_is_input).
• sqrt_price_limit - The maximum/minimum price the swap will swap to.
• amount_specified_is_input - Specifies the token the parameter amountrepresents. If true, the amount represents the input token of the swap.
• a_to_b - The direction of the swap. True if swapping from A to B. False if swapping from B to A.

Special Errors

• ZeroTradableAmount - User provided parameter amount is 0.
• InvalidSqrtPriceLimitDirection - User provided parameter sqrt_price_limit does not match the direction of the trade.
• SqrtPriceOutOfBounds - User provided parameter sqrt_price_limit is over Whirlppool's max/min bounds for sqrt-price.
• InvalidTickArraySequence - User provided tick-arrays are not in sequential order required to proceed in this trade direction.
• TickArraySequenceInvalidIndex - The swap loop attempted to access an invalid array index during the query of the next initialized tick.
• TickArrayIndexOutofBounds - The swap loop attempted to access an invalid array index during tick crossing.
• LiquidityOverflow - Liquidity value overflowed 128bits during tick crossing.
• InvalidTickSpacing - The swap pool was initialized with tick-spacing of 0.

Discriminator f8c69e91e17587c8 · data Swap · accounts SwapInstructionAccounts.

Required accounts: 11; extras go to remaining.

Fields of SwapInstructionAccounts, in account order:

SwapV2#

From the program's IDL:

Perform a swap in this Whirlpool
This instruction works with both Token and Token-2022.

Authority

• "token_authority" - The authority to withdraw tokens from the input token account.

Parameters

• amount - The amount of input or output token to swap from (depending on amount_specified_is_input).
• other_amount_threshold - The maximum/minimum of input/output token to swap into (depending on amount_specified_is_input).
• sqrt_price_limit - The maximum/minimum price the swap will swap to.
• amount_specified_is_input - Specifies the token the parameter amountrepresents. If true, the amount represents the input token of the swap.
• a_to_b - The direction of the swap. True if swapping from A to B. False if swapping from B to A.

Special Errors

• ZeroTradableAmount - User provided parameter amount is 0.
• InvalidSqrtPriceLimitDirection - User provided parameter sqrt_price_limit does not match the direction of the trade.
• SqrtPriceOutOfBounds - User provided parameter sqrt_price_limit is over Whirlppool's max/min bounds for sqrt-price.
• InvalidTickArraySequence - User provided tick-arrays are not in sequential order required to proceed in this trade direction.
• TickArraySequenceInvalidIndex - The swap loop attempted to access an invalid array index during the query of the next initialized tick.
• TickArrayIndexOutofBounds - The swap loop attempted to access an invalid array index during tick crossing.
• LiquidityOverflow - Liquidity value overflowed 128bits during tick crossing.
• InvalidTickSpacing - The swap pool was initialized with tick-spacing of 0.

Discriminator 2b04ed0b1ac91e62 · data SwapV2 · accounts SwapV2InstructionAccounts.

Required accounts: 15; extras go to remaining.

Fields of SwapV2InstructionAccounts, in account order:

TransferLockedPosition#

From the program's IDL:

Transfer a locked position to a different token account.

Authority

• position_authority - The authority that owns the position token.