Function orca_whirlpools_docs::orca_whirlpools::open_position_instructions

pub async fn open_position_instructions(
    rpc: &RpcClient,
    pool_address: Pubkey,
    lower_price: f64,
    upper_price: f64,
    param: IncreaseLiquidityParam,
    slippage_tolerance_bps: Option<u16>,
    funder: Option<Pubkey>,
) -> Result<OpenPositionInstruction, Box<dyn Error>>

Opens a position in a liquidity pool within a specific price range.

This function creates a new position in the specified price range for a given pool. It allows for providing liquidity in a targeted range, optimizing capital efficiency.

Arguments

• rpc - A reference to the Solana RPC client.
• pool_address - The public key of the liquidity pool.
• lower_price - The lower bound of the price range for the position.
• upper_price - The upper bound of the price range for the position.
• param - Parameters for increasing liquidity, specified as IncreaseLiquidityParam.
• slippage_tolerance_bps - An optional slippage tolerance in basis points. Defaults to the global slippage tolerance if not provided.
• funder - An optional public key of the funder account. Defaults to the global funder if not provided.

Returns

Returns a Result containing an OpenPositionInstruction on success, which includes:

• position_mint - The mint address of the position NFT.
• quote - The computed liquidity quote, including liquidity delta, token estimates, and maximum tokens.
• instructions - A vector of Instruction objects required for creating the position.
• additional_signers - A vector of Keypair objects for additional transaction signers.
• initialization_cost - The cost of initializing the position, in lamports.

Errors

Returns an error if:

• The funder account is invalid.
• The pool or token mint accounts are not found or invalid.
• Any RPC request fails.
• The pool is a Splash Pool, as they only support full-range positions.

Example

use solana_client::rpc_client::RpcClient;
use solana_sdk::{pubkey::Pubkey, signer::Keypair};
use orca_whirlpools::{open_position_instructions, IncreaseLiquidityParam};
use std::str::FromStr;

set_whirlpools_config_address(WhirlpoolsConfigInput::SolanaDevnet).unwrap();
let rpc = RpcClient::new("https://api.devnet.solana.com");

let whirlpool_pubkey = Pubkey::from_str("WHIRLPOOL_ADDRESS").unwrap();
let lower_price = 0.00005;
let upper_price = 0.00015;
let param = IncreaseLiquidityParam::TokenA(1_000_000);
let slippage_tolerance_bps = Some(100);

let wallet = Keypair::new();
let funder = Some(wallet.pubkey());

let result = open_position_instructions(
    &rpc,
    whirlpool_pubkey,
    lower_price,
    upper_price,
    param,
    slippage_tolerance_bps,
    funder,
).unwrap();

println!("Position Mint: {:?}", result.position_mint);
println!("Initialization Cost: {} lamports", result.initialization_cost);