Struct Simulator 

pub struct Simulator { /* private fields */ }

Available on simulation only.

A simulator for actions.

Implementations

impl Simulator

pub fn from_parts( tokens: HashMap<Pubkey, TokenState>, markets: HashMap<Pubkey, MarketModel>, glvs: HashMap<Pubkey, GlvModel>, vis: BTreeMap<Pubkey, VirtualInventoryModel>, ) -> Self

Create from parts.

pub fn get_market(&self, market_token: &Pubkey) -> Option<&MarketModel>

Get market by its market token.

pub fn get_market_mut( &mut self, market_token: &Pubkey, ) -> Option<&mut MarketModel>

Get market mutably by its market token.

pub fn get_price(&self, token: &Pubkey) -> Option<Price<u128>>

Get prices for the given token.

pub fn insert_price( &mut self, token: &Pubkey, price: Arc<Price<u128>>, ) -> Result<&mut Self>

Upsert the prices for the give token.

Errors

Returns error if the token does not exist in the simulator.

pub fn get_prices(&self, meta: &MarketMeta) -> Option<Prices<u128>>

Get prices for the given market meta.

pub fn get_glv(&self, glv_token: &Pubkey) -> Option<&GlvModel>

Get GLV by GLV token address.

pub fn get_glv_mut(&mut self, glv_token: &Pubkey) -> Option<&mut GlvModel>

Get GLV by GLV token address mutably.

pub fn insert_glv(&mut self, glv: GlvModel) -> Option<GlvModel>

Insert GLV model.

pub fn swap_along_path( &mut self, path: &[Pubkey], source_token: &Pubkey, amount: u128, options: Option<SimulationOptions>, ) -> Result<SwapOutput>

Swap along the provided path.

Arguments

• path - The path of market tokens to swap along
• source_token - The source token to swap from
• amount - The amount to swap
• options - Optional simulation options. If None, default options are used.

pub fn tokens(&self) -> impl Iterator<Item = (&Pubkey, &TokenState)>

Get token states.

pub fn markets(&self) -> impl Iterator<Item = (&Pubkey, &MarketModel)>

Get market states.

pub fn glvs(&self) -> impl Iterator<Item = (&Pubkey, &GlvModel)>

Get GLV states.

pub fn insert_vi( &mut self, vi_address: Pubkey, vi: VirtualInventoryModel, ) -> Option<VirtualInventoryModel>

Insert virtual inventory model.

pub fn get_vi(&self, vi_address: &Pubkey) -> Option<&VirtualInventoryModel>

Get virtual inventory model by address.

pub fn vis(&self) -> impl Iterator<Item = (&Pubkey, &VirtualInventoryModel)>

Get all virtual inventory states.

pub fn simulate_order<'a>( &'a mut self, kind: CreateOrderKind, params: &'a CreateOrderParams, collateral_or_swap_out_token: &'a Pubkey, ) -> OrderSimulationBuilderForSimulator<'a>

Create a builder for order simulation.

pub fn simulate_deposit<'a>( &'a mut self, market_token: &'a Pubkey, params: &'a CreateDepositParams, ) -> DepositSimulationBuilderForSimulator<'a>

Create a builder for deposit simulation.

pub fn simulate_withdrawal<'a>( &'a mut self, market_token: &'a Pubkey, params: &'a CreateWithdrawalParams, ) -> WithdrawalSimulationBuilderForSimulator<'a>

Create a builder for withdrawal simulation.

pub fn simulate_glv_deposit<'a>( &'a mut self, glv_token: &'a Pubkey, market_token: &'a Pubkey, params: &'a CreateGlvDepositParams, ) -> GlvDepositSimulationBuilderForSimulator<'a>

Create a builder for GLV deposit simulation.

pub fn simulate_glv_withdrawal<'a>( &'a mut self, glv_token: &'a Pubkey, market_token: &'a Pubkey, params: &'a CreateGlvWithdrawalParams, ) -> GlvWithdrawalSimulationBuilderForSimulator<'a>

Create a builder for GLV withdrawal simulation.

pub fn simulate_shift<'a>( &'a mut self, from_market_token: &'a Pubkey, to_market_token: &'a Pubkey, params: &'a CreateShiftParams, ) -> ShiftSimulationBuilderForSimulator<'a>

Create a builder for shift simulation.

Trait Implementations

impl Clone for Simulator

fn clone(&self) -> Simulator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Simulator

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

Formats the value using the given formatter.

impl From<Simulator> for JsSimulator

Available on crate feature js only.

fn from(simulator: Simulator) -> Self

Converts to this type from the input type.

impl GlvCalculator for Simulator

fn get_glv_model(&self, glv_token: &Pubkey) -> Option<&GlvModel>

Returns GlvModel corresponding to the given GLV token.

fn get_market_token_value_in_glv( &self, glv_token: &Pubkey, market_token: &Pubkey, maximize: bool, ) -> Result<u128>

Calcualtes the market token value in GLV.

fn get_glv_value(&self, glv_token: &Pubkey, maximize: bool) -> Result<u128>

Calculates the total value of the given GLV.

fn get_glv_token_value( &self, glv_token: &Pubkey, amount: u64, maximize: bool, ) -> Result<u128>

Calculates the underlying value represented by the given amount of a GLV token.

fn get_max_sellable_glv_value_for_market_token( &self, glv_token: &Pubkey, market_token: &Pubkey, ) -> Result<u128>

Calculates the maximum sellable value through the given market within the given GLV.

fn get_max_sellable_glv_value(&self, glv_token: &Pubkey) -> Result<u128>

Calculates the maximum sellable value for the given GLV.

fn get_glv_status(&self, glv_token: &Pubkey) -> Result<GlvStatus>

Calculates the status of the given GLV.

impl MarketCalculator for Simulator

fn get_market_model(&self, market_token: &Pubkey) -> Option<&MarketModel>

Returns MarketModel corresponding to the given market token.

fn get_token_price(&self, token: &Pubkey) -> Option<Price<u128>>

Returns Price corresponding to the given token address.

fn get_token_prices_for_market_meta( &self, meta: &MarketMeta, ) -> Option<Prices<u128>>

Returns Prices corresponding to the given MarketMeta.

fn get_market_model_with_prices( &self, market_token: &Pubkey, ) -> Result<(&MarketModel, Prices<u128>)>

Returns MarketModel and Prices corresponding to the given market token.