Struct phoenix_sdk::sdk_client::SDKClient

pub struct SDKClient {
    pub client: EllipsisClient,
    pub core: SDKClientCore,
}

Fields

client: EllipsisClient

core: SDKClientCore

Implementations

impl SDKClient

pub async fn new_from_ellipsis_client( market_key: &Pubkey, client: EllipsisClient ) -> Self

pub fn new_from_ellipsis_client_sync( market_key: &Pubkey, client: EllipsisClient ) -> Self

pub async fn new(market_key: &Pubkey, payer: &Keypair, url: &str) -> Self

pub fn new_sync(market_key: &Pubkey, payer: &Keypair, url: &str) -> Self

pub fn set_payer(&mut self, payer: Keypair)

pub fn get_trader(&self) -> Pubkey

pub fn change_active_market(&mut self, market: &Pubkey) -> Result<()>

pub async fn add_market(&mut self, market_key: &Pubkey) -> Result<()>

pub async fn add_and_change_active_market( &mut self, market: &Pubkey ) -> Result<()>

pub async fn get_market_ladder(&self, levels: u64) -> Ladder

pub fn get_market_ladder_sync(&self, levels: u64) -> Ladder

pub async fn get_market_orderbook(&self) -> Orderbook<FIFOOrderId, PhoenixOrder>

pub fn get_market_orderbook_sync(&self) -> Orderbook<FIFOOrderId, PhoenixOrder>

pub async fn get_traders(&self) -> BTreeMap<Pubkey, TraderState>

pub fn get_traders_sync(&self) -> BTreeMap<Pubkey, TraderState>

pub async fn get_market_state(&self) -> MarketState

pub async fn parse_events_from_transaction( &self, sig: &Signature ) -> Option<Vec<PhoenixEvent>>

pub async fn parse_places(&self, signature: &Signature) -> Vec<PhoenixEvent>

pub async fn parse_cancels(&self, signature: &Signature) -> Vec<PhoenixEvent>

pub async fn parse_fills(&self, signature: &Signature) -> Vec<PhoenixEvent>

pub async fn parse_fills_and_places( &self, signature: &Signature ) -> (Vec<PhoenixEvent>, Vec<PhoenixEvent>)

pub async fn send_ioc( &self, price: u64, side: Side, size: u64 ) -> Option<(Signature, Vec<PhoenixEvent>)>

pub async fn send_fok_buy( &self, price: u64, size_in_quote_lots: u64 ) -> Option<(Signature, Vec<PhoenixEvent>)>

pub async fn send_fok_sell( &self, price: u64, size_in_base_lots: u64 ) -> Option<(Signature, Vec<PhoenixEvent>)>

pub fn get_fok_buy_ix(&self, price: u64, size_in_quote_lots: u64) -> Instruction

pub fn get_fok_sell_ix(&self, price: u64, size_in_base_lots: u64) -> Instruction

pub async fn send_ioc_with_slippage( &self, lots_in: u64, min_lots_out: u64, side: Side ) -> Option<(Signature, Vec<PhoenixEvent>)>

pub async fn send_post_only( &self, price: u64, side: Side, size: u64 ) -> Option<(Signature, Vec<PhoenixEvent>)>

pub async fn send_limit_order( &self, price: u64, side: Side, size: u64 ) -> Option<(Signature, Vec<PhoenixEvent>, Vec<PhoenixEvent>)>

pub async fn send_cancel_ids( &self, ids: Vec<FIFOOrderId> ) -> Option<(Signature, Vec<PhoenixEvent>)>

pub async fn send_cancel_up_to( &self, tick_limit: Option<u64>, side: Side ) -> Option<(Signature, Vec<PhoenixEvent>)>

pub async fn send_cancel_all(&self) -> Option<(Signature, Vec<PhoenixEvent>)>

Methods from Deref<Target = SDKClientCore>

pub fn raw_base_units_to_base_lots(&self, raw_base_units: f64) -> u64

RECOMMENDED: Converts raw base units (whole tokens) to base lots. For example if the base currency was a Widget and you wanted to convert 3 Widget tokens to base lots you would call sdk.raw_base_units_to_base_lots(3.0). This would return the number of base lots that would be equivalent to 3 Widget tokens.

pub fn raw_base_units_to_base_lots_rounded_up(&self, raw_base_units: f64) -> u64

The same function as raw_base_units_to_base_lots, but rounds up instead of down.

pub fn base_atoms_to_base_lots(&self, base_atoms: u64) -> u64

RECOMMENDED: Converts base atoms to base lots. For example if the base currency was a Widget with 9 decimals, where 1 atom is 1e-9 of one Widget and you wanted to convert 3 Widgets to base lots you would call sdk.base_amount_to_base_lots(3_000_000_000). This would return the number of base lots that would be equivalent to 3 Widgets or 3 * 1e9 Widget atoms.

pub fn base_lots_to_base_atoms(&self, base_lots: u64) -> u64

RECOMMENDED: Converts base lots to base atoms. For example if the base currency was a Widget where there are 1_000 base atoms per base lot of Widget, you would call sdk.base_lots_to_base_atoms(300) to convert 300 base lots to 300_000 Widget atoms.

pub fn quote_units_to_quote_lots(&self, quote_units: f64) -> u64

RECOMMENDED: Converts quote units to quote lots. For example if the quote currency was USDC you wanted to convert 3 USDC to quote lots you would call sdk.quote_unit_to_quote_lots(3.0). This would return the number of quote lots that would be equivalent to 3 USDC.

pub fn quote_atoms_to_quote_lots(&self, quote_atoms: u64) -> u64

RECOMMENDED: Converts quote atoms to quote lots. For example if the quote currency was USDC with 6 decimals and you wanted to convert 3 USDC, or 3_000_000 USDC atoms, to quote lots you would call sdk.quote_atoms_to_quote_lots(3_000_000). This would return the number of quote lots that would be equivalent to 3_000_000 USDC atoms.

pub fn quote_lots_to_quote_atoms(&self, quote_lots: u64) -> u64

RECOMMENDED: Converts quote lots to quote atoms. For example if the quote currency was USDC and there are 100 quote atoms per quote lot of USDC, you would call sdk.quote_lots_to_quote_atoms(300) to convert 300 quote lots to 30_000 USDC atoms.

pub fn base_atoms_to_base_unit_as_float(&self, base_atoms: u64) -> f64

Converts a number of base atoms to a floating point number of base units. For example if the base currency is a Widget where the token has 9 decimals and you wanted to convert 1_000_000_000 base atoms to a floating point number of whole Widget tokens you would call sdk.base_amount_to_float(1_000_000_000). This would return 1.0. This is useful for displaying the base amount in a human readable format.

pub fn quote_atoms_to_quote_unit_as_float(&self, quote_atoms: u64) -> f64

Converts a number of quote atoms to a floating point number of quote units. For example if the quote currency is USDC the token has 6 decimals and you wanted to convert 1_000_000 USDC atoms to a floating point number of whole USDC tokens you would call sdk.quote_amount_to_float(1_000_000). This would return 1.0. This is useful for displaying the quote amount in a human readable format.

pub fn print_quote_amount(&self, quote_amount: u64)

Takes in a number of quote atoms, converts to floating point number of whole tokens, and prints it as a human readable string to the console

pub fn print_base_amount(&self, base_amount: u64)

Takes in a number of base atoms, converts to floating point number of whole tokens, and prints it as a human readable string to the console

pub fn fill_event_to_quote_amount(&self, fill: &Fill) -> u64

Takes in information from a fill event and converts it into the equivalent quote amount

pub fn order_to_quote_amount(&self, base_lots: u64, price_in_ticks: u64) -> u64

Takes in tick price and base lots of an order converts it into the equivalent quote amount

pub fn float_price_to_ticks(&self, price: f64) -> u64

Takes in a price as a floating point number and converts it to a number of ticks (rounded down)

pub fn float_price_to_ticks_rounded_up(&self, price: f64) -> u64

Takes in a price as a floating point number and converts it to a number of ticks (rounded up)

pub fn ticks_to_float_price(&self, ticks: u64) -> f64

Takes in a number of ticks and converts it to a floating point number price

pub fn base_lots_to_base_units_multiplier(&self) -> f64

pub fn ticks_to_float_price_multiplier(&self) -> f64

pub fn get_next_client_order_id(&self) -> u128

pub fn change_active_market(&mut self, market: &Pubkey) -> Result<(), Error>

pub fn get_active_market_metadata(&self) -> &MarketMetadata

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

pub fn get_ioc_ix( &self, price: u64, side: Side, num_base_lots: u64 ) -> Instruction

pub fn get_ioc_generic_ix( &self, 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> ) -> Instruction

pub fn get_fok_sell_ix(&self, price: u64, size_in_base_lots: u64) -> Instruction

pub fn get_fok_buy_generic_ix( &self, 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> ) -> Instruction

pub fn get_fok_sell_generic_ix( &self, 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> ) -> Instruction

pub fn get_fok_generic_ix( &self, 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> ) -> Instruction

pub fn get_ioc_with_slippage_ix( &self, lots_in: u64, min_lots_out: u64, side: Side ) -> Instruction

pub fn get_ioc_from_tick_price_ix( &self, tick_price: u64, side: Side, size: u64 ) -> Instruction

pub fn get_post_only_ix(&self, price: u64, side: Side, size: u64) -> Instruction

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

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

pub fn get_limit_order_ix( &self, price: u64, side: Side, size: u64 ) -> Instruction

pub fn get_limit_order_generic_ix( &self, 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> ) -> Instruction

pub fn get_limit_order_ix_from_tick_price( &self, tick_price: u64, side: Side, size: u64, client_order_id: u128 ) -> Instruction

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

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

pub fn get_cancel_all_ix(&self) -> Instruction

Trait Implementations

impl Deref for SDKClient

type Target = SDKClientCore

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for SDKClient

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.