Struct PumpSdk 

pub struct PumpSdk;

Instruction builders (no RPC).

Implementations

impl PumpSdk

pub fn buy_amm_instruction( &self, pool: Pubkey, amm_global: &GlobalConfig, pool_state: &Pool, base_token_program: Pubkey, quote_token_program: Pubkey, user: Pubkey, base_amount_out: u64, max_quote_amount_in: u64, ) -> Option<Instruction>

pump_amm buy. Fees from GlobalConfig, pool layout from Pool. Use default coin_creator to omit pool_v2.

pub fn buy_amm_instructions( &self, pool: Pubkey, amm_global: &GlobalConfig, pool_state: &Pool, base_token_program: Pubkey, quote_token_program: Pubkey, user: Pubkey, base_amount_out: u64, max_quote_amount_in: u64, ) -> Option<Vec<Instruction>>

Self::buy_amm_instruction plus idempotent user base ATA create.

pub fn sell_amm_instruction( &self, pool: Pubkey, amm_global: &GlobalConfig, pool_state: &Pool, base_token_program: Pubkey, quote_token_program: Pubkey, user: Pubkey, base_amount_in: u64, min_quote_amount_out: u64, ) -> Option<Instruction>

pump_amm sell (remaining accounts differ from buy for cashback / buyback).

pub fn sell_amm_instructions( &self, pool: Pubkey, amm_global: &GlobalConfig, pool_state: &Pool, base_token_program: Pubkey, quote_token_program: Pubkey, user: Pubkey, base_amount_in: u64, min_quote_amount_out: u64, ) -> Option<Vec<Instruction>>

Self::sell_amm_instruction plus idempotent user quote ATA create.

pub fn collect_coin_creator_fee_instruction( &self, coin_creator: Pubkey, quote_mint: Pubkey, quote_token_program: Pubkey, ) -> Instruction

collect_coin_creator_fee. Sweeps the AMM coin-creator vault’s quote_mint balance into the coin creator’s own quote ATA. Works for any supported quote mint (wSOL or non-SOL).

pub fn collect_coin_creator_fee_instructions( &self, payer: Pubkey, coin_creator: Pubkey, quote_mint: Pubkey, quote_token_program: Pubkey, create_coin_creator_ata: bool, ) -> Vec<Instruction>

Self::collect_coin_creator_fee_instruction with an optional idempotent ATA create for the coin creator’s quote ATA prepended. payer only matters when the ATA create runs.

pub fn transfer_creator_fees_to_pump_v2_instruction( &self, payer: Pubkey, coin_creator: Pubkey, quote_mint: Pubkey, token_program: Pubkey, ) -> Instruction

impl PumpSdk

pub fn create_instruction( &self, mint: Pubkey, user: Pubkey, name: impl Into<String>, symbol: impl Into<String>, uri: impl Into<String>, creator: Pubkey, ) -> Instruction

👎Deprecated:

Use create_v2_instruction instead

Legacy create (SPL Token + Metaplex); prefer Self::create_v2_instruction.

pub fn buy_instruction( &self, mint: Pubkey, user: Pubkey, creator: Pubkey, fee_recipient: Pubkey, buyback_fee_recipient: Pubkey, amount: u64, max_sol_cost: u64, token_program: Pubkey, ) -> Instruction

👎Deprecated:

Use buy_v2_instruction instead

Legacy bonding-curve buy; prefer Self::buy_v2_instruction. Appends bonding_curve_v2, buyback_fee_recipient.

pub fn sell_instruction( &self, mint: Pubkey, user: Pubkey, creator: Pubkey, fee_recipient: Pubkey, buyback_fee_recipient: Pubkey, amount: u64, min_sol_output: u64, token_program: Pubkey, is_cashback_coin: bool, ) -> Instruction

👎Deprecated:

Use sell_v2_instruction instead

Legacy sell; prefer Self::sell_v2_instruction. Appends UVA, bonding_curve_v2.

impl PumpSdk

pub fn create_v2_instruction( &self, mint: Pubkey, user: Pubkey, name: impl Into<String>, symbol: impl Into<String>, uri: impl Into<String>, creator: Pubkey, quote_mint: Pubkey, mayhem_mode: bool, cashback: bool, ) -> Instruction

create_v2 (Token-2022, Mayhem PDAs).

quote_mint selects the curve’s quote asset. Pass Pubkey::default() or constants::NATIVE_MINT for the standard wSOL curve. Any other mint (e.g. USDC) is treated as a non-SOL quote and three remaining accounts are appended (quote mint, the legacy-SPL ATA owned by the bonding curve, and the legacy SPL Token program).

pub fn buy_v2_instruction( &self, global: &Global, bonding_curve: &BondingCurve, base_mint: Pubkey, quote_token_program: Pubkey, user: Pubkey, amount: u64, max_quote_tokens: u64, ) -> Option<Instruction>

buy_v2 with fee recipients from Global and quote layout from BondingCurve.

pub fn buy_v2_instructions( &self, global: &Global, bonding_curve: &BondingCurve, base_mint: Pubkey, quote_token_program: Pubkey, user: Pubkey, amount: u64, max_quote_tokens: u64, ) -> Option<Vec<Instruction>>

buy_v2 with idempotent ATA creates for base/quote user accounts (skipped when quote_mint is the default).

pub fn buy_exact_quote_in_v2_instruction( &self, global: &Global, bonding_curve: &BondingCurve, base_mint: Pubkey, quote_token_program: Pubkey, user: Pubkey, spendable_quote_in: u64, min_tokens_out: u64, ) -> Option<Instruction>

buy_exact_quote_in_v2: spend exactly spendable_quote_in, requiring at least min_tokens_out base tokens out.

pub fn buy_exact_quote_in_v2_instructions( &self, global: &Global, bonding_curve: &BondingCurve, base_mint: Pubkey, quote_token_program: Pubkey, user: Pubkey, spendable_quote_in: u64, min_tokens_out: u64, ) -> Option<Vec<Instruction>>

buy_exact_quote_in_v2 with idempotent ATA creates for base/quote user accounts (skipped when quote_mint is the default).

pub fn sell_v2_instruction( &self, global: &Global, bonding_curve: &BondingCurve, base_mint: Pubkey, quote_token_program: Pubkey, user: Pubkey, amount: u64, min_sol_output: u64, ) -> Option<Instruction>

sell_v2; fee recipients from Global, quote accounts from BondingCurve.

pub fn sell_v2_instructions( &self, global: &Global, bonding_curve: &BondingCurve, base_mint: Pubkey, quote_token_program: Pubkey, user: Pubkey, amount: u64, min_sol_output: u64, ) -> Option<Vec<Instruction>>

sell_v2 with idempotent ATA creates for base/quote user accounts (skipped when quote_mint is the default).

pub fn create_v2_and_buy_instruction( &self, mint: Pubkey, user: Pubkey, name: impl Into<String>, symbol: impl Into<String>, uri: impl Into<String>, creator: Pubkey, quote_mint: Pubkey, mayhem_mode: bool, cashback: bool, tokenized_agent_buyback_bps: Option<u16>, global: &Global, amount: u64, max_quote_tokens: u64, ) -> Option<Vec<Instruction>>

create_v2 then Self::buy_v2_instructions. Pass quote_mint = Pubkey::default() for a wSOL-quoted coin, or a supported quote mint (e.g. USDC) for a non-native quote. Pass tokenized_agent_buyback_bps = Some(bps) to also append Self::agent_initialize_instruction in the same tx (mirrors the frontend’s tokenized-agent flow).

pub fn agent_initialize_instruction( &self, mint: Pubkey, user: Pubkey, creator: Pubkey, buyback_bps: u16, ) -> Instruction

agent_initialize (pump_agent_payments). Initializes the TokenAgentPayments PDA for mint with creator as the agent payment authority. user signs and pays for the new account.

pub fn extend_account_ix(&self, mint: Pubkey, user: Pubkey) -> Instruction

pub fn claim_cashback_v2_instruction( &self, user: Pubkey, quote_mint: Pubkey, quote_token_program: Pubkey, ) -> Instruction

pub fn collect_creator_fee_v2_instructions( &self, payer: Pubkey, creator: Pubkey, quote_mint: Pubkey, quote_token_program: Pubkey, create_creator_ata: bool, ) -> Vec<Instruction>

pub fn collect_creator_fee_v2_instruction( &self, creator: Pubkey, quote_mint: Pubkey, quote_token_program: Pubkey, ) -> Instruction

pub fn distribute_creator_fees_v2_instructions( &self, payer: Pubkey, mint: Pubkey, creator: Pubkey, quote_mint: Pubkey, quote_token_program: Pubkey, initialize_ata: bool, create_creator_vault_ata: bool, shareholders: &[Pubkey], ) -> Vec<Instruction>

pub fn distribute_creator_fees_v2_instruction( &self, payer: Pubkey, mint: Pubkey, creator: Pubkey, quote_mint: Pubkey, quote_token_program: Pubkey, initialize_ata: bool, shareholders: &[Pubkey], ) -> Instruction

pub fn create_coin_instructions( &self, params: CreateCoinParams<'_>, ) -> Option<Vec<Instruction>>

create_v2 then Self::buy_v2_instructions. Set params.quote_mint = Pubkey::default() for a wSOL-quoted coin, or a supported quote mint (e.g. USDC) for a non-native quote. Setting params.tokenized_agent_buyback_bps = Some(bps) also appends Self::agent_initialize_instruction.

impl PumpSdk

pub fn trade_tx_instructions_with_venue( &self, params: TradeTxWithVenueParams<'_>, ) -> Option<Vec<Instruction>>

Full buy or sell: bonding curve via Self::buy_v2_instructions / Self::sell_v2_instructions, or AMM with wSOL wrap/unwrap when the quote is native. None if global fee recipients are missing.

pub fn trade_tx_instructions( &self, params: TradeTxParams<'_>, ) -> Option<Vec<Instruction>>

Self::trade_tx_instructions_with_venue with routing from bonding_curve.complete.

pub fn quote_trade( &self, params: TradeQuoteParams<'_>, ) -> Option<QuoteResult<Quote>>

Auto-routed quote: bonding curve via Self::buy_quote_bonding_curve_token_out / Self::sell_quote_bonding_curve, or AMM via Self::buy_quote_amm_token_out / Self::sell_quote_amm using bonding_curve.complete. None when the curve is complete and pump_pool was not supplied — mirrors Self::trade_tx_instructions.

impl PumpSdk

pub const fn new() -> Self

pub fn fee_recipient_from_pump_global( global: &Global, is_mayhem: bool, ) -> Option<Pubkey>

Random protocol fee recipient from Global (deduped).

pub fn buyback_fee_recipient_from_pump_global(global: &Global) -> Option<Pubkey>

Random buyback fee recipient from Global.

pub fn protocol_fee_recipient_from_amm_global( global_config: &GlobalConfig, ) -> Option<Pubkey>

Random protocol fee recipient from AMM GlobalConfig.

pub fn buyback_fee_recipient_from_amm_global( global_config: &GlobalConfig, ) -> Option<Pubkey>

Random buyback fee recipient from AMM GlobalConfig.

pub fn pump_fee_recipients_pair( global: &Global, is_mayhem: bool, ) -> Option<(Pubkey, Pubkey)>

(fee_recipient, buyback_fee_recipient) from Global. None when either pool is empty.

pub fn amm_fee_recipients_pair( global_config: &GlobalConfig, ) -> Option<(Pubkey, Pubkey)>

(protocol_fee_recipient, buyback_fee_recipient) from AMM GlobalConfig. None when either pool is empty.

pub fn buy_quote_bonding_curve_sol_in( &self, global: &Global, fee_config: Option<&FeeConfig>, bonding_curve: &BondingCurve, mint_supply: u64, sol_amount: u64, slippage_bps: u16, ) -> QuoteResult<Quote>

Bonding curve buy: SOL in → tokens out.

pub fn buy_quote_bonding_curve_token_out( &self, global: &Global, fee_config: Option<&FeeConfig>, bonding_curve: &BondingCurve, mint_supply: u64, token_amount: u64, slippage_bps: u16, ) -> QuoteResult<Quote>

Bonding curve buy: fixed token out → SOL cost.

pub fn sell_quote_bonding_curve( &self, global: &Global, fee_config: Option<&FeeConfig>, bonding_curve: &BondingCurve, mint_supply: u64, token_amount: u64, slippage_bps: u16, ) -> QuoteResult<Quote>

Bonding curve sell.

pub fn buy_quote_amm_sol_in( &self, global_config: &GlobalConfig, fee_config: Option<&FeeConfig>, source: AmmQuoteSource<'_>, sol_amount: u64, slippage_bps: u16, ) -> QuoteResult<Quote>

AMM buy: quote in.

pub fn buy_quote_amm_token_out( &self, global_config: &GlobalConfig, fee_config: Option<&FeeConfig>, source: AmmQuoteSource<'_>, token_amount: u64, slippage_bps: u16, ) -> QuoteResult<Quote>

AMM buy: token amount out.

pub fn sell_quote_amm( &self, global_config: &GlobalConfig, fee_config: Option<&FeeConfig>, source: AmmQuoteSource<'_>, token_amount: u64, slippage_bps: u16, ) -> QuoteResult<Quote>

AMM sell.

Trait Implementations

impl Clone for PumpSdk

fn clone(&self) -> PumpSdk

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PumpSdk

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PumpSdk

fn default() -> PumpSdk

Returns the “default value” for a type.

impl Copy for PumpSdk