Struct phoenix_sdk::sdk_client::SDKClientCore

pub struct SDKClientCore {
    pub markets: BTreeMap<Pubkey, MarketMetadata, Global>,
    pub trader: Pubkey,
}

Fields

markets: BTreeMap<Pubkey, MarketMetadata, Global>

trader: Pubkey

Implementations

impl SDKClientCore

Unit conversions

pub fn raw_base_units_to_base_lots_rounded_down( &self, market_key: &Pubkey, raw_base_units: f64 ) -> Result<u64, Error>

Given a market pubkey and a number of raw base units, returns the equivalent number of base lots (rounded down).

pub fn raw_base_units_to_base_lots_rounded_up( &self, market_key: &Pubkey, raw_base_units: f64 ) -> Result<u64, Error>

Given a market pubkey and a number of raw base units, returns the equivalent number of base lots (rounded up).

pub fn base_atoms_to_base_lots_rounded_down( &self, market_key: &Pubkey, base_atoms: u64 ) -> Result<u64, Error>

Given a market pubkey and a number of base atoms, returns the equivalent number of base lots (rounded down).

pub fn base_atoms_to_base_lots_rounded_up( &self, market_key: &Pubkey, base_atoms: u64 ) -> Result<u64, Error>

Given a market pubkey and a number of base atoms, returns the equivalent number of base lots (rounded up).

pub fn base_lots_to_base_atoms( &self, market_key: &Pubkey, base_lots: u64 ) -> Result<u64, Error>

Given a market pubkey and a number of base lots, returns the equivalent number of base atoms.

pub fn quote_units_to_quote_lots( &self, market_key: &Pubkey, quote_units: f64 ) -> Result<u64, Error>

Given a market pubkey and a number of quote units, returns the equivalent number of quote lots.

pub fn quote_atoms_to_quote_lots_rounded_down( &self, market_key: &Pubkey, quote_atoms: u64 ) -> Result<u64, Error>

Given a market pubkey and a number of quote atoms, returns the equivalent number of quote lots (rounded down).

pub fn quote_atoms_to_quote_lots_rounded_up( &self, market_key: &Pubkey, quote_atoms: u64 ) -> Result<u64, Error>

Given a market pubkey and a number of quote atoms, returns the equivalent number of quote lots (rounded up).

pub fn quote_lots_to_quote_atoms( &self, market_key: &Pubkey, quote_lots: u64 ) -> Result<u64, Error>

Given a market pubkey and a number of quote lots, returns the equivalent number of quote atoms.

pub fn base_atoms_to_raw_base_units_as_float( &self, market_key: &Pubkey, base_atoms: u64 ) -> Result<f64, Error>

Given a market pubkey and a number of base atoms, returns the equivalent number of raw base units.

pub fn quote_atoms_to_quote_units_as_float( &self, market_key: &Pubkey, quote_atoms: u64 ) -> Result<f64, Error>

Given a market pubkey and a number of quote atoms, returns the equivalent number of quote units.

pub fn fill_event_to_quote_atoms( &self, market_key: &Pubkey, fill: &Fill ) -> Result<u64, Error>

Given a market pubkey and a fill event, returns the number of quote atoms filled.

pub fn base_lots_and_price_to_quote_atoms( &self, market_key: &Pubkey, base_lots: u64, price_in_ticks: u64 ) -> Result<u64, Error>

Given a market pubkey, number of base lots, and price in ticks, returns the equivalent number of quote atoms for that price and number of base lots.

pub fn float_price_to_ticks_rounded_down( &self, market_key: &Pubkey, price: f64 ) -> Result<u64, Error>

Given a market pubkey and a price in quote units per raw base unit (represented as a float), returns the corresponding number of ticks (rounded down)

pub fn float_price_to_ticks_rounded_up( &self, market_key: &Pubkey, price: f64 ) -> Result<u64, Error>

Given a market pubkey and a price in quote units per raw base unit (represented as a float), returns the corresponding number of ticks (rounded up)

pub fn ticks_to_float_price( &self, market_key: &Pubkey, ticks: u64 ) -> Result<f64, Error>

Given a number of ticks, returns the corresponding price in quote units per raw base unit (as a float)

pub fn raw_base_units_per_base_lot( &self, market_key: &Pubkey ) -> Result<f64, Error>

Given a market, returns the base lot size in raw base units (as a float)

pub fn quote_units_per_raw_base_unit_per_tick( &self, market_key: &Pubkey ) -> Result<f64, Error>

Given a market, returns the tick size in quote units per raw base unit

impl SDKClientCore

pub fn get_next_client_order_id(&self, rng: &mut StdRng) -> u128

Generate a random client order id

pub fn get_market_metadata(&self, market_key: &Pubkey) -> &MarketMetadata

pub fn parse_raw_phoenix_events( &self, sig: &Signature, events: Vec<Vec<u8, Global>, Global> ) -> Option<Vec<RawPhoenixEvent, Global>>

pub fn parse_events_from_transaction( &self, tx: &ParsedTransaction ) -> Option<Vec<RawPhoenixEvent, Global>>

impl SDKClientCore

SDKClientCore instruction builders

pub fn get_ioc_ix( &self, market_key: &Pubkey, price: u64, side: Side, num_base_lots: u64 ) -> Result<Instruction, Error>

pub fn get_ioc_generic_ix( &self, market_key: &Pubkey, price: u64, side: Side, num_base_lots: u64, self_trade_behavior: Option<SelfTradeBehavior>, match_limit: Option<u64>, client_order_id: Option<u128>, use_only_deposited_funds: Option<bool>, last_valid_slot: Option<u64>, last_valid_unix_timestamp_in_seconds: Option<u64> ) -> Result<Instruction, Error>

pub fn get_fok_sell_ix( &self, market_key: &Pubkey, price: u64, size_in_base_lots: u64 ) -> Result<Instruction, Error>

pub fn get_fok_buy_ix( &self, market_key: &Pubkey, price: u64, size_in_base_lots: u64 ) -> Result<Instruction, Error>

pub fn get_fok_buy_generic_ix( &self, market_key: &Pubkey, price: u64, size_in_quote_lots: u64, self_trade_behavior: Option<SelfTradeBehavior>, match_limit: Option<u64>, client_order_id: Option<u128>, use_only_deposited_funds: Option<bool> ) -> Result<Instruction, Error>

pub fn get_fok_sell_generic_ix( &self, market_key: &Pubkey, price: u64, size_in_base_lots: u64, self_trade_behavior: Option<SelfTradeBehavior>, match_limit: Option<u64>, client_order_id: Option<u128>, use_only_deposited_funds: Option<bool> ) -> Result<Instruction, Error>

pub fn get_fok_generic_ix( &self, market_key: &Pubkey, price: u64, side: Side, size: u64, self_trade_behavior: Option<SelfTradeBehavior>, match_limit: Option<u64>, client_order_id: Option<u128>, use_only_deposited_funds: Option<bool> ) -> Result<Instruction, Error>

pub fn get_ioc_with_slippage_ix( &self, market_key: &Pubkey, lots_in: u64, min_lots_out: u64, side: Side ) -> Result<Instruction, Error>

pub fn get_ioc_from_tick_price_ix( &self, market_key: &Pubkey, tick_price: u64, side: Side, size: u64 ) -> Result<Instruction, Error>

pub fn get_post_only_ix( &self, market_key: &Pubkey, price: u64, side: Side, size: u64 ) -> Result<Instruction, Error>

pub fn get_post_only_generic_ix( &self, market_key: &Pubkey, price: u64, side: Side, size: u64, client_order_id: Option<u128>, reject_post_only: Option<bool>, use_only_deposited_funds: Option<bool>, last_valid_slot: Option<u64>, last_valid_unix_timestamp_in_seconds: Option<u64> ) -> Result<Instruction, Error>

pub fn get_post_only_ix_from_tick_price( &self, market_key: &Pubkey, tick_price: u64, side: Side, size: u64, client_order_id: u128, improve_price_on_cross: bool ) -> Result<Instruction, Error>

pub fn get_limit_order_ix( &self, market_key: &Pubkey, price: u64, side: Side, size: u64 ) -> Result<Instruction, Error>

pub fn get_limit_order_generic_ix( &self, market_key: &Pubkey, price: u64, side: Side, size: u64, self_trade_behavior: Option<SelfTradeBehavior>, match_limit: Option<u64>, client_order_id: Option<u128>, use_only_deposited_funds: Option<bool>, last_valid_slot: Option<u64>, last_valid_unix_timestamp_in_seconds: Option<u64> ) -> Result<Instruction, Error>

pub fn get_limit_order_ix_from_tick_price( &self, market_key: &Pubkey, tick_price: u64, side: Side, size: u64, client_order_id: u128 ) -> Result<Instruction, Error>

pub fn get_cancel_ids_ix( &self, market_key: &Pubkey, ids: Vec<FIFOOrderId, Global> ) -> Result<Instruction, Error>

pub fn get_cancel_up_to_ix( &self, market_key: &Pubkey, tick_limit: Option<u64>, side: Side ) -> Result<Instruction, Error>

pub fn get_cancel_all_ix( &self, market_key: &Pubkey ) -> Result<Instruction, Error>