Module orca_whirlpools

Orca Whirlpools Rust SDK

For on-chain uses, see the client crate.

Structs

• ClosePositionInstruction
  Represents the instructions and quotes for closing a liquidity position.
• CreatePoolInstructions
  Represents the instructions and metadata for creating a pool.
• DecreaseLiquidityInstruction
  Represents the instructions and quote for decreasing liquidity in a position.
• HarvestPositionInstruction
  Represents the instructions and quotes for harvesting a position.
• HydratedBundledPosition
  Represents a single bundled position within a PositionBundle account.
• HydratedPosition
  Represents a single Position account.
• HydratedPositionBundle
  Represents a Position Bundle account, which includes multiple bundled positions.
• IncreaseLiquidityInstruction
  Represents the instructions and quote for increasing liquidity in a position.
• InitializedPool
  Represents an initialized pool.
• OpenPositionInstruction
  Represents the instructions and quote for opening a liquidity position.
• ParsedTokenAccount
• SwapInstructions
  Represents the instructions and quote for executing a token swap.
• UninitializedPool
  Represents an uninitialized pool.

Enums

• DecreaseLiquidityParam
  Represents the parameters for decreasing liquidity in a pool.
• IncreaseLiquidityParam
  Represents the parameters for increasing liquidity in a position.
• NativeMintWrappingStrategy
  Defines the strategy for handling SOL wrapping in a transaction.
• PoolInfo
  Represents information about a pool, either initialized or uninitialized.
• PositionOrBundle
  Represents either a standalone Position account or a Position Bundle account.
• SwapQuote
  Represents the quote for a swap operation.
• SwapType
  Represents the type of a swap operation.
• WhirlpoolsConfigInput
  Input type for setting the Whirlpools configuration.

Constants

• DEFAULT_ENFORCE_TOKEN_BALANCE_CHECK
  The default setting for enforcing balance checks during token account preparation.
• DEFAULT_FUNDER
  The default funder for the Whirlpools program.
• DEFAULT_NATIVE_MINT_WRAPPING_STRATEGY
  The default SOL wrapping strategy.
• DEFAULT_SLIPPAGE_TOLERANCE_BPS
  The default slippage tolerance, expressed in basis points. Value of 100 is equivalent to 1%.
• SPLASH_POOL_TICK_SPACING
  The tick spacing for the SPLASH pool.

Statics

• ENFORCE_TOKEN_BALANCE_CHECK
  The currently selected setting for enforcing balance checks during token account preparation. When true, the system will assert that token accounts have sufficient balance before proceeding. When false, balance checks are skipped, allowing users to get quotes and instructions even with insufficient balance.
• FUNDER
  The currently selected funder for the Whirlpools program.
• NATIVE_MINT_WRAPPING_STRATEGY
  The currently selected SOL wrapping strategy.
• SLIPPAGE_TOLERANCE_BPS
  The currently selected slippage tolerance, expressed in basis points.
• WHIRLPOOLS_CONFIG_ADDRESS
  The currently selected address for the Whirlpools program’s config account.
• WHIRLPOOLS_CONFIG_EXTENSION_ADDRESS
  The currently selected address for the Whirlpools program’s config extension account.

Functions

• close_position_instructions
  Generates instructions to close a liquidity position.
• create_concentrated_liquidity_pool_instructions
  Creates the necessary instructions to initialize a Concentrated Liquidity Pool (CLMM).
• create_splash_pool_instructions
  Creates the necessary instructions to initialize a Splash Pool.
• decrease_liquidity_instructions
  Generates instructions to decrease liquidity from an existing position.
• fetch_concentrated_liquidity_pool
  Fetches the details of a specific Concentrated Liquidity Pool.
• fetch_positions_for_owner
  Fetches all positions owned by a given wallet in the Orca Whirlpools.
• fetch_positions_in_whirlpool
  Fetches all positions associated with a specific Whirlpool.
• fetch_splash_pool
  Fetches the details of a specific Splash Pool.
• fetch_whirlpools_by_token_pair
  Fetches all possible liquidity pools between two token mints in Orca Whirlpools.
• get_account_data_size
  Get the size of the account data for a token account
• harvest_position_instructions
  Generates instructions to harvest a position.
• increase_liquidity_instructions
  Generates instructions to increase liquidity for an existing position.
• open_full_range_position_instructions
  Opens a full-range position in a liquidity pool.
• open_position_instructions
  Opens a position in a liquidity pool within a specific price range.
• order_mints
  Orders two mint addresses by their canonical byte order.
• reset_configuration
  Resets the configuration to its default values.
• set_enforce_token_balance_check
  Sets whether to enforce balance checks during token account preparation.
• set_funder
  Sets the currently selected funder for the Whirlpools program.
• set_native_mint_wrapping_strategy
  Sets the currently selected SOL wrapping strategy.
• set_slippage_tolerance_bps
  Sets the currently selected slippage tolerance, expressed in basis points.
• set_whirlpools_config_address
  Sets the currently selected address for the Whirlpools program’s config account.
• swap_instructions
  Generates the instructions necessary to execute a token swap.