export type Whirlpool = { "version": "0.3.5"; "name": "whirlpool"; "instructions": [ { "name": "initializeConfig"; "docs": [ "Initializes a WhirlpoolsConfig account that hosts info & authorities", "required to govern a set of Whirlpools.", "", "### 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." ]; "accounts": [ { "name": "config"; "isMut": true; "isSigner": true; }, { "name": "funder"; "isMut": true; "isSigner": true; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "feeAuthority"; "type": "publicKey"; }, { "name": "collectProtocolFeesAuthority"; "type": "publicKey"; }, { "name": "rewardEmissionsSuperAuthority"; "type": "publicKey"; }, { "name": "defaultProtocolFeeRate"; "type": "u16"; } ]; }, { "name": "initializePool"; "docs": [ "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", "" ]; "accounts": [ { "name": "whirlpoolsConfig"; "isMut": false; "isSigner": false; }, { "name": "tokenMintA"; "isMut": false; "isSigner": false; }, { "name": "tokenMintB"; "isMut": false; "isSigner": false; }, { "name": "funder"; "isMut": true; "isSigner": true; }, { "name": "whirlpool"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultA"; "isMut": true; "isSigner": true; }, { "name": "tokenVaultB"; "isMut": true; "isSigner": true; }, { "name": "feeTier"; "isMut": false; "isSigner": false; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; }, { "name": "rent"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "bumps"; "type": { "defined": "WhirlpoolBumps"; }; }, { "name": "tickSpacing"; "type": "u16"; }, { "name": "initialSqrtPrice"; "type": "u128"; } ]; }, { "name": "initializeTickArray"; "docs": [ "Initializes a 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." ]; "accounts": [ { "name": "whirlpool"; "isMut": false; "isSigner": false; }, { "name": "funder"; "isMut": true; "isSigner": true; }, { "name": "tickArray"; "isMut": true; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "startTickIndex"; "type": "i32"; } ]; }, { "name": "initializeFeeTier"; "docs": [ "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", "- `FeeRateMaxExceeded` - If the provided default_fee_rate exceeds MAX_FEE_RATE." ]; "accounts": [ { "name": "config"; "isMut": false; "isSigner": false; }, { "name": "feeTier"; "isMut": true; "isSigner": false; }, { "name": "funder"; "isMut": true; "isSigner": true; }, { "name": "feeAuthority"; "isMut": false; "isSigner": true; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "tickSpacing"; "type": "u16"; }, { "name": "defaultFeeRate"; "type": "u16"; } ]; }, { "name": "initializeReward"; "docs": [ "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." ]; "accounts": [ { "name": "rewardAuthority"; "isMut": false; "isSigner": true; }, { "name": "funder"; "isMut": true; "isSigner": true; }, { "name": "whirlpool"; "isMut": true; "isSigner": false; }, { "name": "rewardMint"; "isMut": false; "isSigner": false; }, { "name": "rewardVault"; "isMut": true; "isSigner": true; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; }, { "name": "rent"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "rewardIndex"; "type": "u8"; } ]; }, { "name": "setRewardEmissions"; "docs": [ "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." ]; "accounts": [ { "name": "whirlpool"; "isMut": true; "isSigner": false; }, { "name": "rewardAuthority"; "isMut": false; "isSigner": true; }, { "name": "rewardVault"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "rewardIndex"; "type": "u8"; }, { "name": "emissionsPerSecondX64"; "type": "u128"; } ]; }, { "name": "openPosition"; "docs": [ "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." ]; "accounts": [ { "name": "funder"; "isMut": true; "isSigner": true; }, { "name": "owner"; "isMut": false; "isSigner": false; }, { "name": "position"; "isMut": true; "isSigner": false; }, { "name": "positionMint"; "isMut": true; "isSigner": true; }, { "name": "positionTokenAccount"; "isMut": true; "isSigner": false; }, { "name": "whirlpool"; "isMut": false; "isSigner": false; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; }, { "name": "rent"; "isMut": false; "isSigner": false; }, { "name": "associatedTokenProgram"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "bumps"; "type": { "defined": "OpenPositionBumps"; }; }, { "name": "tickLowerIndex"; "type": "i32"; }, { "name": "tickUpperIndex"; "type": "i32"; } ]; }, { "name": "openPositionWithMetadata"; "docs": [ "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." ]; "accounts": [ { "name": "funder"; "isMut": true; "isSigner": true; }, { "name": "owner"; "isMut": false; "isSigner": false; }, { "name": "position"; "isMut": true; "isSigner": false; }, { "name": "positionMint"; "isMut": true; "isSigner": true; }, { "name": "positionMetadataAccount"; "isMut": true; "isSigner": false; "docs": [ "https://github.com/metaplex-foundation/mpl-token-metadata/blob/master/programs/token-metadata/program/src/utils/metadata.rs#L78" ]; }, { "name": "positionTokenAccount"; "isMut": true; "isSigner": false; }, { "name": "whirlpool"; "isMut": false; "isSigner": false; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; }, { "name": "rent"; "isMut": false; "isSigner": false; }, { "name": "associatedTokenProgram"; "isMut": false; "isSigner": false; }, { "name": "metadataProgram"; "isMut": false; "isSigner": false; }, { "name": "metadataUpdateAuth"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "bumps"; "type": { "defined": "OpenPositionWithMetadataBumps"; }; }, { "name": "tickLowerIndex"; "type": "i32"; }, { "name": "tickUpperIndex"; "type": "i32"; } ]; }, { "name": "increaseLiquidity"; "docs": [ "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." ]; "accounts": [ { "name": "whirlpool"; "isMut": true; "isSigner": false; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; }, { "name": "positionAuthority"; "isMut": false; "isSigner": true; }, { "name": "position"; "isMut": true; "isSigner": false; }, { "name": "positionTokenAccount"; "isMut": false; "isSigner": false; }, { "name": "tokenOwnerAccountA"; "isMut": true; "isSigner": false; }, { "name": "tokenOwnerAccountB"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultA"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultB"; "isMut": true; "isSigner": false; }, { "name": "tickArrayLower"; "isMut": true; "isSigner": false; }, { "name": "tickArrayUpper"; "isMut": true; "isSigner": false; } ]; "args": [ { "name": "liquidityAmount"; "type": "u128"; }, { "name": "tokenMaxA"; "type": "u64"; }, { "name": "tokenMaxB"; "type": "u64"; } ]; }, { "name": "decreaseLiquidity"; "docs": [ "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." ]; "accounts": [ { "name": "whirlpool"; "isMut": true; "isSigner": false; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; }, { "name": "positionAuthority"; "isMut": false; "isSigner": true; }, { "name": "position"; "isMut": true; "isSigner": false; }, { "name": "positionTokenAccount"; "isMut": false; "isSigner": false; }, { "name": "tokenOwnerAccountA"; "isMut": true; "isSigner": false; }, { "name": "tokenOwnerAccountB"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultA"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultB"; "isMut": true; "isSigner": false; }, { "name": "tickArrayLower"; "isMut": true; "isSigner": false; }, { "name": "tickArrayUpper"; "isMut": true; "isSigner": false; } ]; "args": [ { "name": "liquidityAmount"; "type": "u128"; }, { "name": "tokenMinA"; "type": "u64"; }, { "name": "tokenMinB"; "type": "u64"; } ]; }, { "name": "updateFeesAndRewards"; "docs": [ "Update the accrued fees and rewards for a position.", "", "#### Special Errors", "- `TickNotFound` - Provided tick array account does not contain the tick for this position.", "- `LiquidityZero` - Position has zero liquidity and therefore already has the most updated fees and reward values." ]; "accounts": [ { "name": "whirlpool"; "isMut": true; "isSigner": false; }, { "name": "position"; "isMut": true; "isSigner": false; }, { "name": "tickArrayLower"; "isMut": false; "isSigner": false; }, { "name": "tickArrayUpper"; "isMut": false; "isSigner": false; } ]; "args": []; }, { "name": "collectFees"; "docs": [ "Collect fees accrued for this position.", "", "### Authority", "- `position_authority` - authority that owns the token corresponding to this desired position." ]; "accounts": [ { "name": "whirlpool"; "isMut": false; "isSigner": false; }, { "name": "positionAuthority"; "isMut": false; "isSigner": true; }, { "name": "position"; "isMut": true; "isSigner": false; }, { "name": "positionTokenAccount"; "isMut": false; "isSigner": false; }, { "name": "tokenOwnerAccountA"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultA"; "isMut": true; "isSigner": false; }, { "name": "tokenOwnerAccountB"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultB"; "isMut": true; "isSigner": false; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; } ]; "args": []; }, { "name": "collectReward"; "docs": [ "Collect rewards accrued for this position.", "", "### Authority", "- `position_authority` - authority that owns the token corresponding to this desired position." ]; "accounts": [ { "name": "whirlpool"; "isMut": false; "isSigner": false; }, { "name": "positionAuthority"; "isMut": false; "isSigner": true; }, { "name": "position"; "isMut": true; "isSigner": false; }, { "name": "positionTokenAccount"; "isMut": false; "isSigner": false; }, { "name": "rewardOwnerAccount"; "isMut": true; "isSigner": false; }, { "name": "rewardVault"; "isMut": true; "isSigner": false; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "rewardIndex"; "type": "u8"; } ]; }, { "name": "collectProtocolFees"; "docs": [ "Collect the protocol fees accrued in this Whirlpool", "", "### Authority", "- `collect_protocol_fees_authority` - assigned authority in the WhirlpoolConfig that can collect protocol fees" ]; "accounts": [ { "name": "whirlpoolsConfig"; "isMut": false; "isSigner": false; }, { "name": "whirlpool"; "isMut": true; "isSigner": false; }, { "name": "collectProtocolFeesAuthority"; "isMut": false; "isSigner": true; }, { "name": "tokenVaultA"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultB"; "isMut": true; "isSigner": false; }, { "name": "tokenDestinationA"; "isMut": true; "isSigner": false; }, { "name": "tokenDestinationB"; "isMut": true; "isSigner": false; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; } ]; "args": []; }, { "name": "swap"; "docs": [ "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 `amount`represents. 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." ]; "accounts": [ { "name": "tokenProgram"; "isMut": false; "isSigner": false; }, { "name": "tokenAuthority"; "isMut": false; "isSigner": true; }, { "name": "whirlpool"; "isMut": true; "isSigner": false; }, { "name": "tokenOwnerAccountA"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultA"; "isMut": true; "isSigner": false; }, { "name": "tokenOwnerAccountB"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultB"; "isMut": true; "isSigner": false; }, { "name": "tickArray0"; "isMut": true; "isSigner": false; }, { "name": "tickArray1"; "isMut": true; "isSigner": false; }, { "name": "tickArray2"; "isMut": true; "isSigner": false; }, { "name": "oracle"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "amount"; "type": "u64"; }, { "name": "otherAmountThreshold"; "type": "u64"; }, { "name": "sqrtPriceLimit"; "type": "u128"; }, { "name": "amountSpecifiedIsInput"; "type": "bool"; }, { "name": "aToB"; "type": "bool"; } ]; }, { "name": "closePosition"; "docs": [ "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." ]; "accounts": [ { "name": "positionAuthority"; "isMut": false; "isSigner": true; }, { "name": "receiver"; "isMut": true; "isSigner": false; }, { "name": "position"; "isMut": true; "isSigner": false; }, { "name": "positionMint"; "isMut": true; "isSigner": false; }, { "name": "positionTokenAccount"; "isMut": true; "isSigner": false; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; } ]; "args": []; }, { "name": "setDefaultFeeRate"; "docs": [ "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." ]; "accounts": [ { "name": "whirlpoolsConfig"; "isMut": false; "isSigner": false; }, { "name": "feeTier"; "isMut": true; "isSigner": false; }, { "name": "feeAuthority"; "isMut": false; "isSigner": true; } ]; "args": [ { "name": "defaultFeeRate"; "type": "u16"; } ]; }, { "name": "setDefaultProtocolFeeRate"; "docs": [ "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." ]; "accounts": [ { "name": "whirlpoolsConfig"; "isMut": true; "isSigner": false; }, { "name": "feeAuthority"; "isMut": false; "isSigner": true; } ]; "args": [ { "name": "defaultProtocolFeeRate"; "type": "u16"; } ]; }, { "name": "setFeeRate"; "docs": [ "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." ]; "accounts": [ { "name": "whirlpoolsConfig"; "isMut": false; "isSigner": false; }, { "name": "whirlpool"; "isMut": true; "isSigner": false; }, { "name": "feeAuthority"; "isMut": false; "isSigner": true; } ]; "args": [ { "name": "feeRate"; "type": "u16"; } ]; }, { "name": "setProtocolFeeRate"; "docs": [ "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." ]; "accounts": [ { "name": "whirlpoolsConfig"; "isMut": false; "isSigner": false; }, { "name": "whirlpool"; "isMut": true; "isSigner": false; }, { "name": "feeAuthority"; "isMut": false; "isSigner": true; } ]; "args": [ { "name": "protocolFeeRate"; "type": "u16"; } ]; }, { "name": "setFeeAuthority"; "docs": [ "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" ]; "accounts": [ { "name": "whirlpoolsConfig"; "isMut": true; "isSigner": false; }, { "name": "feeAuthority"; "isMut": false; "isSigner": true; }, { "name": "newFeeAuthority"; "isMut": false; "isSigner": false; } ]; "args": []; }, { "name": "setCollectProtocolFeesAuthority"; "docs": [ "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" ]; "accounts": [ { "name": "whirlpoolsConfig"; "isMut": true; "isSigner": false; }, { "name": "collectProtocolFeesAuthority"; "isMut": false; "isSigner": true; }, { "name": "newCollectProtocolFeesAuthority"; "isMut": false; "isSigner": false; } ]; "args": []; }, { "name": "setRewardAuthority"; "docs": [ "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." ]; "accounts": [ { "name": "whirlpool"; "isMut": true; "isSigner": false; }, { "name": "rewardAuthority"; "isMut": false; "isSigner": true; }, { "name": "newRewardAuthority"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "rewardIndex"; "type": "u8"; } ]; }, { "name": "setRewardAuthorityBySuperAuthority"; "docs": [ "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." ]; "accounts": [ { "name": "whirlpoolsConfig"; "isMut": false; "isSigner": false; }, { "name": "whirlpool"; "isMut": true; "isSigner": false; }, { "name": "rewardEmissionsSuperAuthority"; "isMut": false; "isSigner": true; }, { "name": "newRewardAuthority"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "rewardIndex"; "type": "u8"; } ]; }, { "name": "setRewardEmissionsSuperAuthority"; "docs": [ "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." ]; "accounts": [ { "name": "whirlpoolsConfig"; "isMut": true; "isSigner": false; }, { "name": "rewardEmissionsSuperAuthority"; "isMut": false; "isSigner": true; }, { "name": "newRewardEmissionsSuperAuthority"; "isMut": false; "isSigner": false; } ]; "args": []; }, { "name": "twoHopSwap"; "docs": [ "Perform a two-hop 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).", "- `amount_specified_is_input` - Specifies the token the parameter `amount`represents. If true, the amount represents the input token of the swap.", "- `a_to_b_one` - The direction of the swap of hop one. True if swapping from A to B. False if swapping from B to A.", "- `a_to_b_two` - The direction of the swap of hop two. True if swapping from A to B. False if swapping from B to A.", "- `sqrt_price_limit_one` - The maximum/minimum price the swap will swap to in the first hop.", "- `sqrt_price_limit_two` - The maximum/minimum price the swap will swap to in the second hop.", "", "#### 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.", "- `InvalidIntermediaryMint` - Error if the intermediary mint between hop one and two do not equal.", "- `DuplicateTwoHopPool` - Error if whirlpool one & two are the same pool." ]; "accounts": [ { "name": "tokenProgram"; "isMut": false; "isSigner": false; }, { "name": "tokenAuthority"; "isMut": false; "isSigner": true; }, { "name": "whirlpoolOne"; "isMut": true; "isSigner": false; }, { "name": "whirlpoolTwo"; "isMut": true; "isSigner": false; }, { "name": "tokenOwnerAccountOneA"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultOneA"; "isMut": true; "isSigner": false; }, { "name": "tokenOwnerAccountOneB"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultOneB"; "isMut": true; "isSigner": false; }, { "name": "tokenOwnerAccountTwoA"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultTwoA"; "isMut": true; "isSigner": false; }, { "name": "tokenOwnerAccountTwoB"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultTwoB"; "isMut": true; "isSigner": false; }, { "name": "tickArrayOne0"; "isMut": true; "isSigner": false; }, { "name": "tickArrayOne1"; "isMut": true; "isSigner": false; }, { "name": "tickArrayOne2"; "isMut": true; "isSigner": false; }, { "name": "tickArrayTwo0"; "isMut": true; "isSigner": false; }, { "name": "tickArrayTwo1"; "isMut": true; "isSigner": false; }, { "name": "tickArrayTwo2"; "isMut": true; "isSigner": false; }, { "name": "oracleOne"; "isMut": false; "isSigner": false; }, { "name": "oracleTwo"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "amount"; "type": "u64"; }, { "name": "otherAmountThreshold"; "type": "u64"; }, { "name": "amountSpecifiedIsInput"; "type": "bool"; }, { "name": "aToBOne"; "type": "bool"; }, { "name": "aToBTwo"; "type": "bool"; }, { "name": "sqrtPriceLimitOne"; "type": "u128"; }, { "name": "sqrtPriceLimitTwo"; "type": "u128"; } ]; }, { "name": "initializePositionBundle"; "docs": [ "Initializes a PositionBundle account that bundles several positions.", "A unique token will be minted to represent the position bundle in the users wallet." ]; "accounts": [ { "name": "positionBundle"; "isMut": true; "isSigner": false; }, { "name": "positionBundleMint"; "isMut": true; "isSigner": true; }, { "name": "positionBundleTokenAccount"; "isMut": true; "isSigner": false; }, { "name": "positionBundleOwner"; "isMut": false; "isSigner": false; }, { "name": "funder"; "isMut": true; "isSigner": true; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; }, { "name": "rent"; "isMut": false; "isSigner": false; }, { "name": "associatedTokenProgram"; "isMut": false; "isSigner": false; } ]; "args": []; }, { "name": "initializePositionBundleWithMetadata"; "docs": [ "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." ]; "accounts": [ { "name": "positionBundle"; "isMut": true; "isSigner": false; }, { "name": "positionBundleMint"; "isMut": true; "isSigner": true; }, { "name": "positionBundleMetadata"; "isMut": true; "isSigner": false; "docs": [ "https://github.com/metaplex-foundation/metaplex-program-library/blob/773a574c4b34e5b9f248a81306ec24db064e255f/token-metadata/program/src/utils/metadata.rs#L100" ]; }, { "name": "positionBundleTokenAccount"; "isMut": true; "isSigner": false; }, { "name": "positionBundleOwner"; "isMut": false; "isSigner": false; }, { "name": "funder"; "isMut": true; "isSigner": true; }, { "name": "metadataUpdateAuth"; "isMut": false; "isSigner": false; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; }, { "name": "rent"; "isMut": false; "isSigner": false; }, { "name": "associatedTokenProgram"; "isMut": false; "isSigner": false; }, { "name": "metadataProgram"; "isMut": false; "isSigner": false; } ]; "args": []; }, { "name": "deletePositionBundle"; "docs": [ "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." ]; "accounts": [ { "name": "positionBundle"; "isMut": true; "isSigner": false; }, { "name": "positionBundleMint"; "isMut": true; "isSigner": false; }, { "name": "positionBundleTokenAccount"; "isMut": true; "isSigner": false; }, { "name": "positionBundleOwner"; "isMut": false; "isSigner": true; }, { "name": "receiver"; "isMut": true; "isSigner": false; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; } ]; "args": []; }, { "name": "openBundledPosition"; "docs": [ "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." ]; "accounts": [ { "name": "bundledPosition"; "isMut": true; "isSigner": false; }, { "name": "positionBundle"; "isMut": true; "isSigner": false; }, { "name": "positionBundleTokenAccount"; "isMut": false; "isSigner": false; }, { "name": "positionBundleAuthority"; "isMut": false; "isSigner": true; }, { "name": "whirlpool"; "isMut": false; "isSigner": false; }, { "name": "funder"; "isMut": true; "isSigner": true; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; }, { "name": "rent"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "bundleIndex"; "type": "u16"; }, { "name": "tickLowerIndex"; "type": "i32"; }, { "name": "tickUpperIndex"; "type": "i32"; } ]; }, { "name": "closeBundledPosition"; "docs": [ "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." ]; "accounts": [ { "name": "bundledPosition"; "isMut": true; "isSigner": false; }, { "name": "positionBundle"; "isMut": true; "isSigner": false; }, { "name": "positionBundleTokenAccount"; "isMut": false; "isSigner": false; }, { "name": "positionBundleAuthority"; "isMut": false; "isSigner": true; }, { "name": "receiver"; "isMut": true; "isSigner": false; } ]; "args": [ { "name": "bundleIndex"; "type": "u16"; } ]; }, { "name": "openPositionWithTokenExtensions"; "docs": [ "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." ]; "accounts": [ { "name": "funder"; "isMut": true; "isSigner": true; }, { "name": "owner"; "isMut": false; "isSigner": false; }, { "name": "position"; "isMut": true; "isSigner": false; }, { "name": "positionMint"; "isMut": true; "isSigner": true; }, { "name": "positionTokenAccount"; "isMut": true; "isSigner": false; }, { "name": "whirlpool"; "isMut": false; "isSigner": false; }, { "name": "token2022Program"; "isMut": false; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; }, { "name": "associatedTokenProgram"; "isMut": false; "isSigner": false; }, { "name": "metadataUpdateAuth"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "tickLowerIndex"; "type": "i32"; }, { "name": "tickUpperIndex"; "type": "i32"; }, { "name": "withTokenMetadataExtension"; "type": "bool"; } ]; }, { "name": "closePositionWithTokenExtensions"; "docs": [ "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." ]; "accounts": [ { "name": "positionAuthority"; "isMut": false; "isSigner": true; }, { "name": "receiver"; "isMut": true; "isSigner": false; }, { "name": "position"; "isMut": true; "isSigner": false; }, { "name": "positionMint"; "isMut": true; "isSigner": false; }, { "name": "positionTokenAccount"; "isMut": true; "isSigner": false; }, { "name": "token2022Program"; "isMut": false; "isSigner": false; } ]; "args": []; }, { "name": "lockPosition"; "docs": [ "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)." ]; "accounts": [ { "name": "funder"; "isMut": true; "isSigner": true; }, { "name": "positionAuthority"; "isMut": false; "isSigner": true; }, { "name": "position"; "isMut": false; "isSigner": false; }, { "name": "positionMint"; "isMut": false; "isSigner": false; }, { "name": "positionTokenAccount"; "isMut": true; "isSigner": false; }, { "name": "lockConfig"; "isMut": true; "isSigner": false; }, { "name": "whirlpool"; "isMut": false; "isSigner": false; }, { "name": "token2022Program"; "isMut": false; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "lockType"; "type": { "defined": "LockType"; }; } ]; }, { "name": "collectFeesV2"; "docs": [ "Collect fees accrued for this position.", "", "### Authority", "- `position_authority` - authority that owns the token corresponding to this desired position." ]; "accounts": [ { "name": "whirlpool"; "isMut": false; "isSigner": false; }, { "name": "positionAuthority"; "isMut": false; "isSigner": true; }, { "name": "position"; "isMut": true; "isSigner": false; }, { "name": "positionTokenAccount"; "isMut": false; "isSigner": false; }, { "name": "tokenMintA"; "isMut": false; "isSigner": false; }, { "name": "tokenMintB"; "isMut": false; "isSigner": false; }, { "name": "tokenOwnerAccountA"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultA"; "isMut": true; "isSigner": false; }, { "name": "tokenOwnerAccountB"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultB"; "isMut": true; "isSigner": false; }, { "name": "tokenProgramA"; "isMut": false; "isSigner": false; }, { "name": "tokenProgramB"; "isMut": false; "isSigner": false; }, { "name": "memoProgram"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "remainingAccountsInfo"; "type": { "option": { "defined": "RemainingAccountsInfo"; }; }; } ]; }, { "name": "collectProtocolFeesV2"; "docs": [ "Collect the protocol fees accrued in this Whirlpool", "", "### Authority", "- `collect_protocol_fees_authority` - assigned authority in the WhirlpoolConfig that can collect protocol fees" ]; "accounts": [ { "name": "whirlpoolsConfig"; "isMut": false; "isSigner": false; }, { "name": "whirlpool"; "isMut": true; "isSigner": false; }, { "name": "collectProtocolFeesAuthority"; "isMut": false; "isSigner": true; }, { "name": "tokenMintA"; "isMut": false; "isSigner": false; }, { "name": "tokenMintB"; "isMut": false; "isSigner": false; }, { "name": "tokenVaultA"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultB"; "isMut": true; "isSigner": false; }, { "name": "tokenDestinationA"; "isMut": true; "isSigner": false; }, { "name": "tokenDestinationB"; "isMut": true; "isSigner": false; }, { "name": "tokenProgramA"; "isMut": false; "isSigner": false; }, { "name": "tokenProgramB"; "isMut": false; "isSigner": false; }, { "name": "memoProgram"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "remainingAccountsInfo"; "type": { "option": { "defined": "RemainingAccountsInfo"; }; }; } ]; }, { "name": "collectRewardV2"; "docs": [ "Collect rewards accrued for this position.", "", "### Authority", "- `position_authority` - authority that owns the token corresponding to this desired position." ]; "accounts": [ { "name": "whirlpool"; "isMut": false; "isSigner": false; }, { "name": "positionAuthority"; "isMut": false; "isSigner": true; }, { "name": "position"; "isMut": true; "isSigner": false; }, { "name": "positionTokenAccount"; "isMut": false; "isSigner": false; }, { "name": "rewardOwnerAccount"; "isMut": true; "isSigner": false; }, { "name": "rewardMint"; "isMut": false; "isSigner": false; }, { "name": "rewardVault"; "isMut": true; "isSigner": false; }, { "name": "rewardTokenProgram"; "isMut": false; "isSigner": false; }, { "name": "memoProgram"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "rewardIndex"; "type": "u8"; }, { "name": "remainingAccountsInfo"; "type": { "option": { "defined": "RemainingAccountsInfo"; }; }; } ]; }, { "name": "decreaseLiquidityV2"; "docs": [ "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." ]; "accounts": [ { "name": "whirlpool"; "isMut": true; "isSigner": false; }, { "name": "tokenProgramA"; "isMut": false; "isSigner": false; }, { "name": "tokenProgramB"; "isMut": false; "isSigner": false; }, { "name": "memoProgram"; "isMut": false; "isSigner": false; }, { "name": "positionAuthority"; "isMut": false; "isSigner": true; }, { "name": "position"; "isMut": true; "isSigner": false; }, { "name": "positionTokenAccount"; "isMut": false; "isSigner": false; }, { "name": "tokenMintA"; "isMut": false; "isSigner": false; }, { "name": "tokenMintB"; "isMut": false; "isSigner": false; }, { "name": "tokenOwnerAccountA"; "isMut": true; "isSigner": false; }, { "name": "tokenOwnerAccountB"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultA"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultB"; "isMut": true; "isSigner": false; }, { "name": "tickArrayLower"; "isMut": true; "isSigner": false; }, { "name": "tickArrayUpper"; "isMut": true; "isSigner": false; } ]; "args": [ { "name": "liquidityAmount"; "type": "u128"; }, { "name": "tokenMinA"; "type": "u64"; }, { "name": "tokenMinB"; "type": "u64"; }, { "name": "remainingAccountsInfo"; "type": { "option": { "defined": "RemainingAccountsInfo"; }; }; } ]; }, { "name": "increaseLiquidityV2"; "docs": [ "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." ]; "accounts": [ { "name": "whirlpool"; "isMut": true; "isSigner": false; }, { "name": "tokenProgramA"; "isMut": false; "isSigner": false; }, { "name": "tokenProgramB"; "isMut": false; "isSigner": false; }, { "name": "memoProgram"; "isMut": false; "isSigner": false; }, { "name": "positionAuthority"; "isMut": false; "isSigner": true; }, { "name": "position"; "isMut": true; "isSigner": false; }, { "name": "positionTokenAccount"; "isMut": false; "isSigner": false; }, { "name": "tokenMintA"; "isMut": false; "isSigner": false; }, { "name": "tokenMintB"; "isMut": false; "isSigner": false; }, { "name": "tokenOwnerAccountA"; "isMut": true; "isSigner": false; }, { "name": "tokenOwnerAccountB"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultA"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultB"; "isMut": true; "isSigner": false; }, { "name": "tickArrayLower"; "isMut": true; "isSigner": false; }, { "name": "tickArrayUpper"; "isMut": true; "isSigner": false; } ]; "args": [ { "name": "liquidityAmount"; "type": "u128"; }, { "name": "tokenMaxA"; "type": "u64"; }, { "name": "tokenMaxB"; "type": "u64"; }, { "name": "remainingAccountsInfo"; "type": { "option": { "defined": "RemainingAccountsInfo"; }; }; } ]; }, { "name": "initializePoolV2"; "docs": [ "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", "" ]; "accounts": [ { "name": "whirlpoolsConfig"; "isMut": false; "isSigner": false; }, { "name": "tokenMintA"; "isMut": false; "isSigner": false; }, { "name": "tokenMintB"; "isMut": false; "isSigner": false; }, { "name": "tokenBadgeA"; "isMut": false; "isSigner": false; }, { "name": "tokenBadgeB"; "isMut": false; "isSigner": false; }, { "name": "funder"; "isMut": true; "isSigner": true; }, { "name": "whirlpool"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultA"; "isMut": true; "isSigner": true; }, { "name": "tokenVaultB"; "isMut": true; "isSigner": true; }, { "name": "feeTier"; "isMut": false; "isSigner": false; }, { "name": "tokenProgramA"; "isMut": false; "isSigner": false; }, { "name": "tokenProgramB"; "isMut": false; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; }, { "name": "rent"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "tickSpacing"; "type": "u16"; }, { "name": "initialSqrtPrice"; "type": "u128"; } ]; }, { "name": "initializeRewardV2"; "docs": [ "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." ]; "accounts": [ { "name": "rewardAuthority"; "isMut": false; "isSigner": true; }, { "name": "funder"; "isMut": true; "isSigner": true; }, { "name": "whirlpool"; "isMut": true; "isSigner": false; }, { "name": "rewardMint"; "isMut": false; "isSigner": false; }, { "name": "rewardTokenBadge"; "isMut": false; "isSigner": false; }, { "name": "rewardVault"; "isMut": true; "isSigner": true; }, { "name": "rewardTokenProgram"; "isMut": false; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; }, { "name": "rent"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "rewardIndex"; "type": "u8"; } ]; }, { "name": "setRewardEmissionsV2"; "docs": [ "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." ]; "accounts": [ { "name": "whirlpool"; "isMut": true; "isSigner": false; }, { "name": "rewardAuthority"; "isMut": false; "isSigner": true; }, { "name": "rewardVault"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "rewardIndex"; "type": "u8"; }, { "name": "emissionsPerSecondX64"; "type": "u128"; } ]; }, { "name": "swapV2"; "docs": [ "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 `amount`represents. 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." ]; "accounts": [ { "name": "tokenProgramA"; "isMut": false; "isSigner": false; }, { "name": "tokenProgramB"; "isMut": false; "isSigner": false; }, { "name": "memoProgram"; "isMut": false; "isSigner": false; }, { "name": "tokenAuthority"; "isMut": false; "isSigner": true; }, { "name": "whirlpool"; "isMut": true; "isSigner": false; }, { "name": "tokenMintA"; "isMut": false; "isSigner": false; }, { "name": "tokenMintB"; "isMut": false; "isSigner": false; }, { "name": "tokenOwnerAccountA"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultA"; "isMut": true; "isSigner": false; }, { "name": "tokenOwnerAccountB"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultB"; "isMut": true; "isSigner": false; }, { "name": "tickArray0"; "isMut": true; "isSigner": false; }, { "name": "tickArray1"; "isMut": true; "isSigner": false; }, { "name": "tickArray2"; "isMut": true; "isSigner": false; }, { "name": "oracle"; "isMut": true; "isSigner": false; } ]; "args": [ { "name": "amount"; "type": "u64"; }, { "name": "otherAmountThreshold"; "type": "u64"; }, { "name": "sqrtPriceLimit"; "type": "u128"; }, { "name": "amountSpecifiedIsInput"; "type": "bool"; }, { "name": "aToB"; "type": "bool"; }, { "name": "remainingAccountsInfo"; "type": { "option": { "defined": "RemainingAccountsInfo"; }; }; } ]; }, { "name": "twoHopSwapV2"; "docs": [ "Perform a two-hop 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).", "- `amount_specified_is_input` - Specifies the token the parameter `amount`represents. If true, the amount represents the input token of the swap.", "- `a_to_b_one` - The direction of the swap of hop one. True if swapping from A to B. False if swapping from B to A.", "- `a_to_b_two` - The direction of the swap of hop two. True if swapping from A to B. False if swapping from B to A.", "- `sqrt_price_limit_one` - The maximum/minimum price the swap will swap to in the first hop.", "- `sqrt_price_limit_two` - The maximum/minimum price the swap will swap to in the second hop.", "", "#### 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.", "- `InvalidIntermediaryMint` - Error if the intermediary mint between hop one and two do not equal.", "- `DuplicateTwoHopPool` - Error if whirlpool one & two are the same pool." ]; "accounts": [ { "name": "whirlpoolOne"; "isMut": true; "isSigner": false; }, { "name": "whirlpoolTwo"; "isMut": true; "isSigner": false; }, { "name": "tokenMintInput"; "isMut": false; "isSigner": false; }, { "name": "tokenMintIntermediate"; "isMut": false; "isSigner": false; }, { "name": "tokenMintOutput"; "isMut": false; "isSigner": false; }, { "name": "tokenProgramInput"; "isMut": false; "isSigner": false; }, { "name": "tokenProgramIntermediate"; "isMut": false; "isSigner": false; }, { "name": "tokenProgramOutput"; "isMut": false; "isSigner": false; }, { "name": "tokenOwnerAccountInput"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultOneInput"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultOneIntermediate"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultTwoIntermediate"; "isMut": true; "isSigner": false; }, { "name": "tokenVaultTwoOutput"; "isMut": true; "isSigner": false; }, { "name": "tokenOwnerAccountOutput"; "isMut": true; "isSigner": false; }, { "name": "tokenAuthority"; "isMut": false; "isSigner": true; }, { "name": "tickArrayOne0"; "isMut": true; "isSigner": false; }, { "name": "tickArrayOne1"; "isMut": true; "isSigner": false; }, { "name": "tickArrayOne2"; "isMut": true; "isSigner": false; }, { "name": "tickArrayTwo0"; "isMut": true; "isSigner": false; }, { "name": "tickArrayTwo1"; "isMut": true; "isSigner": false; }, { "name": "tickArrayTwo2"; "isMut": true; "isSigner": false; }, { "name": "oracleOne"; "isMut": true; "isSigner": false; }, { "name": "oracleTwo"; "isMut": true; "isSigner": false; }, { "name": "memoProgram"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "amount"; "type": "u64"; }, { "name": "otherAmountThreshold"; "type": "u64"; }, { "name": "amountSpecifiedIsInput"; "type": "bool"; }, { "name": "aToBOne"; "type": "bool"; }, { "name": "aToBTwo"; "type": "bool"; }, { "name": "sqrtPriceLimitOne"; "type": "u128"; }, { "name": "sqrtPriceLimitTwo"; "type": "u128"; }, { "name": "remainingAccountsInfo"; "type": { "option": { "defined": "RemainingAccountsInfo"; }; }; } ]; }, { "name": "initializeConfigExtension"; "accounts": [ { "name": "config"; "isMut": false; "isSigner": false; }, { "name": "configExtension"; "isMut": true; "isSigner": false; }, { "name": "funder"; "isMut": true; "isSigner": true; }, { "name": "feeAuthority"; "isMut": false; "isSigner": true; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; } ]; "args": []; }, { "name": "setConfigExtensionAuthority"; "accounts": [ { "name": "whirlpoolsConfig"; "isMut": false; "isSigner": false; }, { "name": "whirlpoolsConfigExtension"; "isMut": true; "isSigner": false; }, { "name": "configExtensionAuthority"; "isMut": false; "isSigner": true; }, { "name": "newConfigExtensionAuthority"; "isMut": false; "isSigner": false; } ]; "args": []; }, { "name": "setTokenBadgeAuthority"; "accounts": [ { "name": "whirlpoolsConfig"; "isMut": false; "isSigner": false; }, { "name": "whirlpoolsConfigExtension"; "isMut": true; "isSigner": false; }, { "name": "configExtensionAuthority"; "isMut": false; "isSigner": true; }, { "name": "newTokenBadgeAuthority"; "isMut": false; "isSigner": false; } ]; "args": []; }, { "name": "initializeTokenBadge"; "accounts": [ { "name": "whirlpoolsConfig"; "isMut": false; "isSigner": false; }, { "name": "whirlpoolsConfigExtension"; "isMut": false; "isSigner": false; }, { "name": "tokenBadgeAuthority"; "isMut": false; "isSigner": true; }, { "name": "tokenMint"; "isMut": false; "isSigner": false; }, { "name": "tokenBadge"; "isMut": true; "isSigner": false; }, { "name": "funder"; "isMut": true; "isSigner": true; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; } ]; "args": []; }, { "name": "deleteTokenBadge"; "accounts": [ { "name": "whirlpoolsConfig"; "isMut": false; "isSigner": false; }, { "name": "whirlpoolsConfigExtension"; "isMut": false; "isSigner": false; }, { "name": "tokenBadgeAuthority"; "isMut": false; "isSigner": true; }, { "name": "tokenMint"; "isMut": false; "isSigner": false; }, { "name": "tokenBadge"; "isMut": true; "isSigner": false; }, { "name": "receiver"; "isMut": true; "isSigner": false; } ]; "args": []; } ]; "accounts": [ { "name": "whirlpoolsConfig"; "type": { "kind": "struct"; "fields": [ { "name": "feeAuthority"; "type": "publicKey"; }, { "name": "collectProtocolFeesAuthority"; "type": "publicKey"; }, { "name": "rewardEmissionsSuperAuthority"; "type": "publicKey"; }, { "name": "defaultProtocolFeeRate"; "type": "u16"; } ]; }; }, { "name": "whirlpoolsConfigExtension"; "type": { "kind": "struct"; "fields": [ { "name": "whirlpoolsConfig"; "type": "publicKey"; }, { "name": "configExtensionAuthority"; "type": "publicKey"; }, { "name": "tokenBadgeAuthority"; "type": "publicKey"; } ]; }; }, { "name": "feeTier"; "type": { "kind": "struct"; "fields": [ { "name": "whirlpoolsConfig"; "type": "publicKey"; }, { "name": "tickSpacing"; "type": "u16"; }, { "name": "defaultFeeRate"; "type": "u16"; } ]; }; }, { "name": "lockConfig"; "type": { "kind": "struct"; "fields": [ { "name": "position"; "type": "publicKey"; }, { "name": "positionOwner"; "type": "publicKey"; }, { "name": "whirlpool"; "type": "publicKey"; }, { "name": "lockedTimestamp"; "type": "u64"; }, { "name": "lockType"; "type": { "defined": "LockTypeLabel"; }; } ]; }; }, { "name": "position"; "type": { "kind": "struct"; "fields": [ { "name": "whirlpool"; "type": "publicKey"; }, { "name": "positionMint"; "type": "publicKey"; }, { "name": "liquidity"; "type": "u128"; }, { "name": "tickLowerIndex"; "type": "i32"; }, { "name": "tickUpperIndex"; "type": "i32"; }, { "name": "feeGrowthCheckpointA"; "type": "u128"; }, { "name": "feeOwedA"; "type": "u64"; }, { "name": "feeGrowthCheckpointB"; "type": "u128"; }, { "name": "feeOwedB"; "type": "u64"; }, { "name": "rewardInfos"; "type": { "array": [ { "defined": "PositionRewardInfo"; }, 3 ]; }; } ]; }; }, { "name": "positionBundle"; "type": { "kind": "struct"; "fields": [ { "name": "positionBundleMint"; "type": "publicKey"; }, { "name": "positionBitmap"; "type": { "array": [ "u8", 32 ]; }; } ]; }; }, { "name": "tickArray"; "type": { "kind": "struct"; "fields": [ { "name": "startTickIndex"; "type": "i32"; }, { "name": "ticks"; "type": { "array": [ { "defined": "Tick"; }, 88 ]; }; }, { "name": "whirlpool"; "type": "publicKey"; } ]; }; }, { "name": "tokenBadge"; "type": { "kind": "struct"; "fields": [ { "name": "whirlpoolsConfig"; "type": "publicKey"; }, { "name": "tokenMint"; "type": "publicKey"; } ]; }; }, { "name": "whirlpool"; "type": { "kind": "struct"; "fields": [ { "name": "whirlpoolsConfig"; "type": "publicKey"; }, { "name": "whirlpoolBump"; "type": { "array": [ "u8", 1 ]; }; }, { "name": "tickSpacing"; "type": "u16"; }, { "name": "tickSpacingSeed"; "type": { "array": [ "u8", 2 ]; }; }, { "name": "feeRate"; "type": "u16"; }, { "name": "protocolFeeRate"; "type": "u16"; }, { "name": "liquidity"; "type": "u128"; }, { "name": "sqrtPrice"; "type": "u128"; }, { "name": "tickCurrentIndex"; "type": "i32"; }, { "name": "protocolFeeOwedA"; "type": "u64"; }, { "name": "protocolFeeOwedB"; "type": "u64"; }, { "name": "tokenMintA"; "type": "publicKey"; }, { "name": "tokenVaultA"; "type": "publicKey"; }, { "name": "feeGrowthGlobalA"; "type": "u128"; }, { "name": "tokenMintB"; "type": "publicKey"; }, { "name": "tokenVaultB"; "type": "publicKey"; }, { "name": "feeGrowthGlobalB"; "type": "u128"; }, { "name": "rewardLastUpdatedTimestamp"; "type": "u64"; }, { "name": "rewardInfos"; "type": { "array": [ { "defined": "WhirlpoolRewardInfo"; }, 3 ]; }; } ]; }; } ]; "types": [ { "name": "LockType"; "type": { "kind": "enum"; "variants": [ { "name": "Permanent"; } ]; }; }, { "name": "LockTypeLabel"; "type": { "kind": "enum"; "variants": [ { "name": "Permanent"; } ]; }; }, { "name": "OpenPositionBumps"; "type": { "kind": "struct"; "fields": [ { "name": "positionBump"; "type": "u8"; } ]; }; }, { "name": "OpenPositionWithMetadataBumps"; "type": { "kind": "struct"; "fields": [ { "name": "positionBump"; "type": "u8"; }, { "name": "metadataBump"; "type": "u8"; } ]; }; }, { "name": "PositionRewardInfo"; "type": { "kind": "struct"; "fields": [ { "name": "growthInsideCheckpoint"; "type": "u128"; }, { "name": "amountOwed"; "type": "u64"; } ]; }; }, { "name": "Tick"; "type": { "kind": "struct"; "fields": [ { "name": "initialized"; "type": "bool"; }, { "name": "liquidityNet"; "type": "i128"; }, { "name": "liquidityGross"; "type": "u128"; }, { "name": "feeGrowthOutsideA"; "type": "u128"; }, { "name": "feeGrowthOutsideB"; "type": "u128"; }, { "name": "rewardGrowthsOutside"; "type": { "array": [ "u128", 3 ]; }; } ]; }; }, { "name": "WhirlpoolBumps"; "type": { "kind": "struct"; "fields": [ { "name": "whirlpoolBump"; "type": "u8"; } ]; }; }, { "name": "WhirlpoolRewardInfo"; "docs": [ "Stores the state relevant for tracking liquidity mining rewards at the `Whirlpool` level.", "These values are used in conjunction with `PositionRewardInfo`, `Tick.reward_growths_outside`,", "and `Whirlpool.reward_last_updated_timestamp` to determine how many rewards are earned by open", "positions." ]; "type": { "kind": "struct"; "fields": [ { "name": "mint"; "docs": [ "Reward token mint." ]; "type": "publicKey"; }, { "name": "vault"; "docs": [ "Reward vault token account." ]; "type": "publicKey"; }, { "name": "authority"; "docs": [ "Authority account that has permission to initialize the reward and set emissions." ]; "type": "publicKey"; }, { "name": "emissionsPerSecondX64"; "docs": [ "Q64.64 number that indicates how many tokens per second are earned per unit of liquidity." ]; "type": "u128"; }, { "name": "growthGlobalX64"; "docs": [ "Q64.64 number that tracks the total tokens earned per unit of liquidity since the reward", "emissions were turned on." ]; "type": "u128"; } ]; }; }, { "name": "AccountsType"; "type": { "kind": "enum"; "variants": [ { "name": "TransferHookA"; }, { "name": "TransferHookB"; }, { "name": "TransferHookReward"; }, { "name": "TransferHookInput"; }, { "name": "TransferHookIntermediate"; }, { "name": "TransferHookOutput"; }, { "name": "SupplementalTickArrays"; }, { "name": "SupplementalTickArraysOne"; }, { "name": "SupplementalTickArraysTwo"; } ]; }; }, { "name": "RemainingAccountsInfo"; "type": { "kind": "struct"; "fields": [ { "name": "slices"; "type": { "vec": { "defined": "RemainingAccountsSlice"; }; }; } ]; }; }, { "name": "RemainingAccountsSlice"; "type": { "kind": "struct"; "fields": [ { "name": "accountsType"; "type": { "defined": "AccountsType"; }; }, { "name": "length"; "type": "u8"; } ]; }; } ]; "events": [ { "name": "LiquidityDecreased"; "fields": [ { "name": "whirlpool"; "type": "publicKey"; "index": false; }, { "name": "position"; "type": "publicKey"; "index": false; }, { "name": "tickLowerIndex"; "type": "i32"; "index": false; }, { "name": "tickUpperIndex"; "type": "i32"; "index": false; }, { "name": "liquidity"; "type": "u128"; "index": false; }, { "name": "tokenAAmount"; "type": "u64"; "index": false; }, { "name": "tokenBAmount"; "type": "u64"; "index": false; }, { "name": "tokenATransferFee"; "type": "u64"; "index": false; }, { "name": "tokenBTransferFee"; "type": "u64"; "index": false; } ]; }, { "name": "LiquidityIncreased"; "fields": [ { "name": "whirlpool"; "type": "publicKey"; "index": false; }, { "name": "position"; "type": "publicKey"; "index": false; }, { "name": "tickLowerIndex"; "type": "i32"; "index": false; }, { "name": "tickUpperIndex"; "type": "i32"; "index": false; }, { "name": "liquidity"; "type": "u128"; "index": false; }, { "name": "tokenAAmount"; "type": "u64"; "index": false; }, { "name": "tokenBAmount"; "type": "u64"; "index": false; }, { "name": "tokenATransferFee"; "type": "u64"; "index": false; }, { "name": "tokenBTransferFee"; "type": "u64"; "index": false; } ]; }, { "name": "PoolInitialized"; "fields": [ { "name": "whirlpool"; "type": "publicKey"; "index": false; }, { "name": "whirlpoolsConfig"; "type": "publicKey"; "index": false; }, { "name": "tokenMintA"; "type": "publicKey"; "index": false; }, { "name": "tokenMintB"; "type": "publicKey"; "index": false; }, { "name": "tickSpacing"; "type": "u16"; "index": false; }, { "name": "tokenProgramA"; "type": "publicKey"; "index": false; }, { "name": "tokenProgramB"; "type": "publicKey"; "index": false; }, { "name": "decimalsA"; "type": "u8"; "index": false; }, { "name": "decimalsB"; "type": "u8"; "index": false; }, { "name": "initialSqrtPrice"; "type": "u128"; "index": false; } ]; }, { "name": "Traded"; "fields": [ { "name": "whirlpool"; "type": "publicKey"; "index": false; }, { "name": "aToB"; "type": "bool"; "index": false; }, { "name": "preSqrtPrice"; "type": "u128"; "index": false; }, { "name": "postSqrtPrice"; "type": "u128"; "index": false; }, { "name": "inputAmount"; "type": "u64"; "index": false; }, { "name": "outputAmount"; "type": "u64"; "index": false; }, { "name": "inputTransferFee"; "type": "u64"; "index": false; }, { "name": "outputTransferFee"; "type": "u64"; "index": false; }, { "name": "lpFee"; "type": "u64"; "index": false; }, { "name": "protocolFee"; "type": "u64"; "index": false; } ]; } ]; "errors": [ { "code": 6000; "name": "InvalidEnum"; "msg": "Enum value could not be converted"; }, { "code": 6001; "name": "InvalidStartTick"; "msg": "Invalid start tick index provided."; }, { "code": 6002; "name": "TickArrayExistInPool"; "msg": "Tick-array already exists in this whirlpool"; }, { "code": 6003; "name": "TickArrayIndexOutofBounds"; "msg": "Attempt to search for a tick-array failed"; }, { "code": 6004; "name": "InvalidTickSpacing"; "msg": "Tick-spacing is not supported"; }, { "code": 6005; "name": "ClosePositionNotEmpty"; "msg": "Position is not empty It cannot be closed"; }, { "code": 6006; "name": "DivideByZero"; "msg": "Unable to divide by zero"; }, { "code": 6007; "name": "NumberCastError"; "msg": "Unable to cast number into BigInt"; }, { "code": 6008; "name": "NumberDownCastError"; "msg": "Unable to down cast number"; }, { "code": 6009; "name": "TickNotFound"; "msg": "Tick not found within tick array"; }, { "code": 6010; "name": "InvalidTickIndex"; "msg": "Provided tick index is either out of bounds or uninitializable"; }, { "code": 6011; "name": "SqrtPriceOutOfBounds"; "msg": "Provided sqrt price out of bounds"; }, { "code": 6012; "name": "LiquidityZero"; "msg": "Liquidity amount must be greater than zero"; }, { "code": 6013; "name": "LiquidityTooHigh"; "msg": "Liquidity amount must be less than i64::MAX"; }, { "code": 6014; "name": "LiquidityOverflow"; "msg": "Liquidity overflow"; }, { "code": 6015; "name": "LiquidityUnderflow"; "msg": "Liquidity underflow"; }, { "code": 6016; "name": "LiquidityNetError"; "msg": "Tick liquidity net underflowed or overflowed"; }, { "code": 6017; "name": "TokenMaxExceeded"; "msg": "Exceeded token max"; }, { "code": 6018; "name": "TokenMinSubceeded"; "msg": "Did not meet token min"; }, { "code": 6019; "name": "MissingOrInvalidDelegate"; "msg": "Position token account has a missing or invalid delegate"; }, { "code": 6020; "name": "InvalidPositionTokenAmount"; "msg": "Position token amount must be 1"; }, { "code": 6021; "name": "InvalidTimestampConversion"; "msg": "Timestamp should be convertible from i64 to u64"; }, { "code": 6022; "name": "InvalidTimestamp"; "msg": "Timestamp should be greater than the last updated timestamp"; }, { "code": 6023; "name": "InvalidTickArraySequence"; "msg": "Invalid tick array sequence provided for instruction."; }, { "code": 6024; "name": "InvalidTokenMintOrder"; "msg": "Token Mint in wrong order"; }, { "code": 6025; "name": "RewardNotInitialized"; "msg": "Reward not initialized"; }, { "code": 6026; "name": "InvalidRewardIndex"; "msg": "Invalid reward index"; }, { "code": 6027; "name": "RewardVaultAmountInsufficient"; "msg": "Reward vault requires amount to support emissions for at least one day"; }, { "code": 6028; "name": "FeeRateMaxExceeded"; "msg": "Exceeded max fee rate"; }, { "code": 6029; "name": "ProtocolFeeRateMaxExceeded"; "msg": "Exceeded max protocol fee rate"; }, { "code": 6030; "name": "MultiplicationShiftRightOverflow"; "msg": "Multiplication with shift right overflow"; }, { "code": 6031; "name": "MulDivOverflow"; "msg": "Muldiv overflow"; }, { "code": 6032; "name": "MulDivInvalidInput"; "msg": "Invalid div_u256 input"; }, { "code": 6033; "name": "MultiplicationOverflow"; "msg": "Multiplication overflow"; }, { "code": 6034; "name": "InvalidSqrtPriceLimitDirection"; "msg": "Provided SqrtPriceLimit not in the same direction as the swap."; }, { "code": 6035; "name": "ZeroTradableAmount"; "msg": "There are no tradable amount to swap."; }, { "code": 6036; "name": "AmountOutBelowMinimum"; "msg": "Amount out below minimum threshold"; }, { "code": 6037; "name": "AmountInAboveMaximum"; "msg": "Amount in above maximum threshold"; }, { "code": 6038; "name": "TickArraySequenceInvalidIndex"; "msg": "Invalid index for tick array sequence"; }, { "code": 6039; "name": "AmountCalcOverflow"; "msg": "Amount calculated overflows"; }, { "code": 6040; "name": "AmountRemainingOverflow"; "msg": "Amount remaining overflows"; }, { "code": 6041; "name": "InvalidIntermediaryMint"; "msg": "Invalid intermediary mint"; }, { "code": 6042; "name": "DuplicateTwoHopPool"; "msg": "Duplicate two hop pool"; }, { "code": 6043; "name": "InvalidBundleIndex"; "msg": "Bundle index is out of bounds"; }, { "code": 6044; "name": "BundledPositionAlreadyOpened"; "msg": "Position has already been opened"; }, { "code": 6045; "name": "BundledPositionAlreadyClosed"; "msg": "Position has already been closed"; }, { "code": 6046; "name": "PositionBundleNotDeletable"; "msg": "Unable to delete PositionBundle with open positions"; }, { "code": 6047; "name": "UnsupportedTokenMint"; "msg": "Token mint has unsupported attributes"; }, { "code": 6048; "name": "RemainingAccountsInvalidSlice"; "msg": "Invalid remaining accounts"; }, { "code": 6049; "name": "RemainingAccountsInsufficient"; "msg": "Insufficient remaining accounts"; }, { "code": 6050; "name": "NoExtraAccountsForTransferHook"; "msg": "Unable to call transfer hook without extra accounts"; }, { "code": 6051; "name": "IntermediateTokenAmountMismatch"; "msg": "Output and input amount mismatch"; }, { "code": 6052; "name": "TransferFeeCalculationError"; "msg": "Transfer fee calculation failed"; }, { "code": 6053; "name": "RemainingAccountsDuplicatedAccountsType"; "msg": "Same accounts type is provided more than once"; }, { "code": 6054; "name": "FullRangeOnlyPool"; "msg": "This whirlpool only supports full-range positions"; }, { "code": 6055; "name": "TooManySupplementalTickArrays"; "msg": "Too many supplemental tick arrays provided"; }, { "code": 6056; "name": "DifferentWhirlpoolTickArrayAccount"; "msg": "TickArray account for different whirlpool provided"; }, { "code": 6057; "name": "PartialFillError"; "msg": "Trade resulted in partial fill"; }, { "code": 6058; "name": "PositionNotLockable"; "msg": "Position is not lockable"; }, { "code": 6059; "name": "OperationNotAllowedOnLockedPosition"; "msg": "Operation not allowed on locked position"; } ]; }; export declare const IDL: Whirlpool;