Trait BaseMarket

pub trait BaseMarket<const DECIMALS: u8> {
    type Num: MulDiv<Signed = Self::Signed> + FixedPointOps<DECIMALS>;
    type Signed: UnsignedAbs<Unsigned = Self::Num> + TryFrom<Self::Num> + Num;
    type Pool: Pool<Num = Self::Num, Signed = Self::Signed>;

    // Required methods
    fn liquidity_pool(&self) -> Result<&Self::Pool>;
    fn claimable_fee_pool(&self) -> Result<&Self::Pool>;
    fn swap_impact_pool(&self) -> Result<&Self::Pool>;
    fn open_interest_pool(&self, is_long: bool) -> Result<&Self::Pool>;
    fn open_interest_in_tokens_pool(&self, is_long: bool) -> Result<&Self::Pool>;
    fn collateral_sum_pool(&self, is_long: bool) -> Result<&Self::Pool>;
    fn usd_to_amount_divisor(&self) -> Self::Num;
    fn max_pool_amount(&self, is_long_token: bool) -> Result<Self::Num>;
    fn pnl_factor_config(
        &self,
        kind: PnlFactorKind,
        is_long: bool,
    ) -> Result<Self::Num>;
    fn reserve_factor(&self) -> Result<Self::Num>;
    fn open_interest_reserve_factor(&self) -> Result<Self::Num>;
    fn max_open_interest(&self, is_long: bool) -> Result<Self::Num>;
    fn ignore_open_interest_for_usage_factor(&self) -> Result<bool>;
}

Base Market trait.

Required Associated Types

type Num: MulDiv<Signed = Self::Signed> + FixedPointOps<DECIMALS>

Unsigned number type used in the market.

type Signed: UnsignedAbs<Unsigned = Self::Num> + TryFrom<Self::Num> + Num

Signed number type used in the market.

type Pool: Pool<Num = Self::Num, Signed = Self::Signed>

Pool type.

Required Methods

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 usd_to_amount_divisor(&self) -> Self::Num

USD value to market token amount divisor.

One should make sure it is non-zero.

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.

Implementations on Foreign Types

impl<M: BaseMarket<DECIMALS>, const DECIMALS: u8> BaseMarket<DECIMALS> for &mut M

type Num = <M as BaseMarket<DECIMALS>>::Num

type Signed = <M as BaseMarket<DECIMALS>>::Signed

type Pool = <M as BaseMarket<DECIMALS>>::Pool

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

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

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

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

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

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

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

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

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

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

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

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

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

Implementors