Struct MarketModel 

pub struct MarketModel { /* private fields */ }

Available on crate feature model only.

Market Model.

Implementations

impl MarketModel

pub fn from_parts(market: Arc<Market>, supply: u64) -> Self

Create from parts.

pub fn is_pure(&self) -> bool

Get whether it is a pure market.

pub fn swap_pricing(&self) -> &SwapPricingKind

Get swap pricing kind.

pub fn with_swap_pricing<T>( &mut self, swap_pricing: SwapPricingKind, f: impl FnOnce(&mut Self) -> T, ) -> T

Execute a function with the specified swap pricing kind.

Panic Safety

This method uses RAII to ensure state is restored even if the closure panics.

pub fn with_vi_models<T>( &mut self, vi_map: &mut BTreeMap<Pubkey, VirtualInventoryModel>, f: impl FnOnce(&mut Self) -> T, ) -> T

Execute a function with virtual inventory models from a map.

This method temporarily replaces the virtual inventory models (for swaps and positions) of the MarketModel with models from the provided map, executes the provided function, and then restores the original values.

The virtual inventory models are looked up from the map using the market’s virtual_inventory_for_swaps and virtual_inventory_for_positions addresses.

Arguments

• vi_map - A mutable reference to a map of Pubkey to VirtualInventoryModel
• f - Function to execute with the temporary VI models

Returns

The return value of the function f

Note

The virtual inventory models are passed via a mutable reference to a map, allowing the caller to maintain access to the models and observe any state changes made during the function execution.

Panic Safety

This method uses RAII to ensure state is restored even if the closure panics.

Notes

• If the MarketModel already has virtual inventory models attached (i.e. vi_for_swaps / vi_for_positions are Some), this function will not load VI models from vi_map and will not write any changes back to vi_map. In that case, only the existing in-model VI instances are used and mutated.

pub fn with_vis_if<T>( &mut self, vi_map: Option<&mut BTreeMap<Pubkey, VirtualInventoryModel>>, f: impl FnOnce(&mut Self) -> T, ) -> T

Execute a function with or without virtual inventories depending on the given map.

• If vi_map is Some, this will attach VI models from the map via Self::with_vi_models.
• If vi_map is None, this will temporarily disable VIs via Self::with_vis_disabled.

This is a small utility to unify the entry point of VI enable/disable logic so that callers do not need to duplicate branching between with_vi_models and with_vis_disabled.

pub fn with_vis_disabled<T>(&mut self, f: impl FnOnce(&mut Self) -> T) -> T

Execute a function with virtual inventories disabled.

Panic Safety

This method uses RAII to ensure state is restored even if the closure panics.

pub fn passed_in_seconds_for_funding(&self) -> Result<u64>

Returns the time in seconds since last funding fee state update.

pub fn into_empty_position( self, is_long: bool, collateral_token: Pubkey, ) -> Result<PositionModel>

Convert into an empty position model.

Notes

• All position parameters unrelated to the model, such as owner and bump, use zeroed values.

pub fn into_empty_position_opts( self, is_long: bool, collateral_token: Pubkey, options: PositionOptions, ) -> Result<PositionModel>

Convert into an empty position model with options.

pub fn set_order_fee_discount_factor(&mut self, factor: u128)

Set order fee discount factor.

Methods from Deref<Target = Market>

pub fn name(&self) -> Result<&str>

Available on crate features utils and store and gmsol-utils only.

Get name.

Trait Implementations

impl Bank<Pubkey> for MarketModel

type Num = u64

Number type.

fn record_transferred_in_by_token<Q: ?Sized + Borrow<Pubkey>>( &mut self, token: &Q, amount: &Self::Num, ) -> Result<()>

Record transferred in amount by token.

fn record_transferred_out_by_token<Q: ?Sized + Borrow<Pubkey>>( &mut self, token: &Q, amount: &Self::Num, ) -> Result<()>

Record transferred out amount by token.

fn balance<Q: Borrow<Pubkey> + ?Sized>(&self, token: &Q) -> Result<Self::Num>

Get the balance of the given token.

fn balance_excluding<Q>( &self, token: &Q, excluded: &Self::Num, ) -> Result<Self::Num, Error>

where Q: Borrow<K> + ?Sized, Self::Num: CheckedSub + Zero,

Get the balance of the given token excluding excluded amount.

impl BaseMarket<{ constants::MARKET_DECIMALS }> for MarketModel

type Num = u128

Unsigned number type used in the market.

type Signed = i128

Signed number type used in the market.

type Pool = Pool

Pool type.

fn liquidity_pool(&self) -> Result<&Self::Pool>

Get the liquidity pool.

fn claimable_fee_pool(&self) -> Result<&Self::Pool>

Get the claimable fee pool.

fn swap_impact_pool(&self) -> Result<&Self::Pool>

Get the swap impact pool.

fn open_interest_pool(&self, is_long: bool) -> Result<&Self::Pool>

Get the open interest pool.

fn open_interest_in_tokens_pool(&self, is_long: bool) -> Result<&Self::Pool>

Get the open interest in (index) tokens pool.

fn collateral_sum_pool(&self, is_long: bool) -> Result<&Self::Pool>

Get collateral sum pool.

fn virtual_inventory_for_swaps_pool( &self, ) -> Result<Option<impl Deref<Target = Self::Pool>>>

Get virtual inventory for swaps.

fn virtual_inventory_for_positions_pool( &self, ) -> Result<Option<impl Deref<Target = Self::Pool>>>

Get virtual inventory for positions.

fn usd_to_amount_divisor(&self) -> Self::Num

USD value to market token amount divisor.

fn max_pool_amount(&self, is_long_token: bool) -> Result<Self::Num>

Get max pool amount.

fn pnl_factor_config( &self, kind: PnlFactorKind, is_long: bool, ) -> Result<Self::Num>

Get pnl factor config.

fn reserve_factor(&self) -> Result<Self::Num>

Get reserve factor.

fn open_interest_reserve_factor(&self) -> Result<Self::Num>

Get open interest reserve factor.

fn max_open_interest(&self, is_long: bool) -> Result<Self::Num>

Get max open interest.

fn ignore_open_interest_for_usage_factor(&self) -> Result<bool>

Returns whether ignore open interest for usage factor.

impl BaseMarketMut<{ constants::MARKET_DECIMALS }> for MarketModel

fn liquidity_pool_mut(&mut self) -> Result<&mut Self::Pool>

Get the liquidity pool mutably.

fn claimable_fee_pool_mut(&mut self) -> Result<&mut Self::Pool>

Get the mutable reference of the claimable fee pool.

fn virtual_inventory_for_swaps_pool_mut( &mut self, ) -> Result<Option<impl DerefMut<Target = Self::Pool>>>

Get virtual inventory for swaps mutably.

impl BorrowingFeeMarket<{ constants::MARKET_DECIMALS }> for MarketModel

fn borrowing_factor_pool(&self) -> Result<&Self::Pool>

Get borrowing factor pool.

fn total_borrowing_pool(&self) -> Result<&Self::Pool>

Get total borrowing pool.

fn borrowing_fee_params(&self) -> Result<BorrowingFeeParams<Self::Num>>

Get borrowing fee params.

fn passed_in_seconds_for_borrowing(&self) -> Result<u64>

Get the passed time in seconds for the given kind of clock.

fn borrowing_fee_kink_model_params( &self, ) -> Result<BorrowingFeeKinkModelParams<Self::Num>>

Get borrowing fee kink model params.

impl Clone for MarketModel

fn clone(&self) -> MarketModel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MarketModel

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

Formats the value using the given formatter.

impl Deref for MarketModel

type Target = Market

The resulting type after dereferencing.

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

Dereferences the value.

impl LiquidityMarket<{ constants::MARKET_DECIMALS }> for MarketModel

fn total_supply(&self) -> Self::Num

Get total supply of the market token.

fn max_pool_value_for_deposit(&self, is_long_token: bool) -> Result<Self::Num>

Get max pool value for deposit.

impl LiquidityMarketMut<{ constants::MARKET_DECIMALS }> for MarketModel

fn mint(&mut self, amount: &Self::Num) -> Result<()>

Perform mint.

fn burn(&mut self, amount: &Self::Num) -> Result<()>

Perform burn.

impl PerpMarket<{ constants::MARKET_DECIMALS }> for MarketModel

fn funding_factor_per_second(&self) -> &Self::Signed

Get funding factor per second.

fn funding_amount_per_size_pool(&self, is_long: bool) -> Result<&Self::Pool>

Get funding amount per size pool.

fn claimable_funding_amount_per_size_pool( &self, is_long: bool, ) -> Result<&Self::Pool>

Get claimable funding amount per size pool.

fn funding_amount_per_size_adjustment(&self) -> Self::Num

Adjustment factor for packing funding amount per size.

fn funding_fee_params(&self) -> Result<FundingFeeParams<Self::Num>>

Get funding fee params.

fn position_params(&self) -> Result<PositionParams<Self::Num>>

Get basic position params.

fn order_fee_params(&self) -> Result<FeeParams<Self::Num>>

Get the order fee params.

fn min_collateral_factor_for_open_interest_multiplier( &self, is_long: bool, ) -> Result<Self::Num>

Get min collateral factor for open interest multiplier.

fn liquidation_fee_params(&self) -> Result<LiquidationFeeParams<Self::Num>>

Get liquidation fee params.

impl PerpMarketMut<{ constants::MARKET_DECIMALS }> for MarketModel

fn just_passed_in_seconds_for_funding(&mut self) -> Result<u64>

Get the just passed time in seconds for the given kind of clock.

fn funding_factor_per_second_mut(&mut self) -> &mut Self::Signed

Get funding factor per second mutably.

fn open_interest_pool_mut(&mut self, is_long: bool) -> Result<&mut Self::Pool>

Get mutable reference of open interest pool.

fn open_interest_in_tokens_pool_mut( &mut self, is_long: bool, ) -> Result<&mut Self::Pool>

Get mutable reference of open interest pool.

fn funding_amount_per_size_pool_mut( &mut self, is_long: bool, ) -> Result<&mut Self::Pool>

Get funding amount per size pool mutably.

fn claimable_funding_amount_per_size_pool_mut( &mut self, is_long: bool, ) -> Result<&mut Self::Pool>

Get claimable funding amount per size pool mutably.

fn collateral_sum_pool_mut(&mut self, is_long: bool) -> Result<&mut Self::Pool>

Get collateral sum pool mutably.

fn total_borrowing_pool_mut(&mut self) -> Result<&mut Self::Pool>

Get total borrowing pool mutably.

fn virtual_inventory_for_positions_pool_mut( &mut self, ) -> Result<Option<impl DerefMut<Target = Self::Pool>>>

Get virtual inventory for positions mutably.

fn on_insufficient_funding_fee_payment( &mut self, _cost_amount: &Self::Num, _paid_in_collateral_amount: &Self::Num, _paid_in_secondary_output_amount: &Self::Num, _is_collateral_token_long: bool, ) -> Result<(), Error>

Insufficient funding fee payment callback.

impl PositionImpactMarket<{ constants::MARKET_DECIMALS }> for MarketModel

fn position_impact_pool(&self) -> Result<&Self::Pool>

Get position impact pool.

fn position_impact_params(&self) -> Result<PriceImpactParams<Self::Num>>

Get the position impact params.

fn position_impact_distribution_params( &self, ) -> Result<PositionImpactDistributionParams<Self::Num>>

Get position impact distribution params.

fn passed_in_seconds_for_position_impact_distribution(&self) -> Result<u64>

Get the passed time in seconds for the given kind of clock.

impl PositionImpactMarketMut<{ constants::MARKET_DECIMALS }> for MarketModel

fn position_impact_pool_mut(&mut self) -> Result<&mut Self::Pool>

Get position impact pool mutably.

fn just_passed_in_seconds_for_position_impact_distribution( &mut self, ) -> Result<u64>

Get the just passed time in seconds for the given kind of clock.

impl SwapMarket<{ constants::MARKET_DECIMALS }> for MarketModel

fn swap_impact_params(&self) -> Result<PriceImpactParams<Self::Num>>

Get swap impact params.

fn swap_fee_params(&self) -> Result<FeeParams<Self::Num>>

Get the swap fee params.

impl SwapMarketMut<{ constants::MARKET_DECIMALS }> for MarketModel

fn swap_impact_pool_mut(&mut self) -> Result<&mut Self::Pool>

Get the swap impact pool mutably.