Struct levana_perpswap_cosmos::contracts::market::liquidity::LiquidityStats

pub struct LiquidityStats {
    pub locked: Collateral,
    pub unlocked: Collateral,
    pub total_lp: LpToken,
    pub total_xlp: LpToken,
}

Protocol wide stats on liquidity

Fields

locked: Collateral

Collateral locked as counter collateral in the protocol

unlocked: Collateral

Total amount of collateral available to be used as liquidity

total_lp: LpToken

Total number of LP tokens

total_xlp: LpToken

Total number of xLP tokens

Implementations

impl LiquidityStats

pub fn total_collateral(&self) -> Result<Collateral, OverflowError>

Total amount of locked and unlocked collateral.

pub fn total_tokens(&self) -> Result<LpToken, OverflowError>

Total number of LP and xLP tokens

pub fn lp_to_collateral(&self, lp: LpToken) -> Result<Collateral>

Calculate the amount of collateral for a given number of LP tokens

This method can fail due to arithmetic overflow. It can also fail if invariants are violated, specifically if there is 0 collateral in the pool when this is called with a non-zero amount of LP.

Note that even with a non-zero input value for lp, due to rounding errors this function may return 0 collateral.

pub fn lp_to_collateral_non_zero( &self, lp: NonZero<LpToken>, ) -> Result<NonZero<Collateral>>

Same as Self::lp_to_collateral, but treats round-to-zero as an error.

pub fn collateral_to_lp( &self, amount: NonZero<Collateral>, ) -> Result<NonZero<LpToken>>

Calculate how many LP tokens would be produced from the given collateral.

If there is currently no liquidity in the pool, this will use a 1:1 ratio.

pub fn approx_eq(&self, other: &Self) -> bool

approximate equality comparison, helpful for tests

Trait Implementations

impl Clone for LiquidityStats

fn clone(&self) -> LiquidityStats

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LiquidityStats

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

Formats the value using the given formatter.

impl Default for LiquidityStats

fn default() -> LiquidityStats

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LiquidityStats

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for LiquidityStats

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for LiquidityStats

fn eq(&self, other: &LiquidityStats) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for LiquidityStats

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LiquidityStats