Struct MarketMetadata

pub struct MarketMetadata {
    pub base_mint: Pubkey,
    pub quote_mint: Pubkey,
    pub base_decimals: u32,
    pub quote_decimals: u32,
    pub base_atoms_per_raw_base_unit: u64,
    pub quote_atoms_per_quote_unit: u64,
    pub quote_atoms_per_quote_lot: u64,
    pub base_atoms_per_base_lot: u64,
    pub tick_size_in_quote_atoms_per_base_unit: u64,
    pub num_base_lots_per_base_unit: u64,
    pub raw_base_units_per_base_unit: u32,
    pub market_size_params: MarketSizeParams,
}

Fields

base_mint: Pubkey

quote_mint: Pubkey

base_decimals: u32

quote_decimals: u32

base_atoms_per_raw_base_unit: u64

10^base_decimals

quote_atoms_per_quote_unit: u64

10^quote_decimals

quote_atoms_per_quote_lot: u64

base_atoms_per_base_lot: u64

tick_size_in_quote_atoms_per_base_unit: u64

num_base_lots_per_base_unit: u64

raw_base_units_per_base_unit: u32

The adjustment factor to convert from the raw base unit (i.e. 1 BONK token) to the Phoenix BaseUnit (which may be a multiple of whole tokens). The adjustment factor is almost always 1, unless one base token is worth less than one quote atom (i.e. 1e-6 USDC)

market_size_params: MarketSizeParams

Implementations

impl MarketMetadata

pub fn from_header(header: &MarketHeader) -> Result<MarketMetadata, Error>

impl MarketMetadata

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

Given a number of raw base units, returns the equivalent number of base lots (rounded down).

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

Given a number of raw base units, returns the equivalent number of base lots (rounded up).

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

Given a number of base atoms, returns the equivalent number of base lots (rounded down).

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

Given a number of base atoms, returns the equivalent number of base lots (rounded up).

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

Given a number of base lots, returns the equivalent number of base atoms.

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

Given a number of quote units, returns the equivalent number of quote lots.

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

Given a number of quote atoms, returns the equivalent number of quote lots (rounded down).

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

Given a number of quote atoms, returns the equivalent number of quote lots (rounded up).

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

Given a number of quote lots, returns the equivalent number of quote atoms.

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

Given a number of base atoms, returns the equivalent number of raw base units.

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

Given a number of quote atoms, returns the equivalent number of quote units.

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

Given a number of base lots and price in ticks, returns the equivalent number of quote atoms for that price and number of base lots.

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

Given a price in quote units per raw base unit (represented as a float), returns the corresponding number of ticks (rounded down)

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

Given a price in quote units per raw base unit (represented as a float), returns the corresponding number of ticks (rounded up)

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

Given a number of ticks, returns the corresponding price in quote units per raw base unit (as a float)

pub fn raw_base_units_per_base_lot(&self) -> f64

Returns the base lot size in raw base units (as a float)

pub fn quote_units_per_raw_base_unit_per_tick(&self) -> f64

Returns the tick size in quote units per raw base unit

Trait Implementations

impl Clone for MarketMetadata

fn clone(&self) -> MarketMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MarketMetadata

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

Formats the value using the given formatter.

impl Default for MarketMetadata

fn default() -> MarketMetadata

Returns the “default value” for a type.

impl Copy for MarketMetadata