Struct kujira_std::NormalizedPrice

pub struct NormalizedPrice(/* private fields */);

NormalizedPrice should be used in all operations involving calculating the value of coins given the oracle price. When comparing values of non-standard denominations, failing to normalize the price can cause unexpected and incorrect results.

Standard denominations have 6 decimal places, so we use that as the reference point.

Implementations

impl NormalizedPrice

pub fn unsafe_unchecked(price: Decimal) -> Self

This is unsafe because it does not check that the price is normalized to the reference decimal places. Most likely during testing.

pub fn from_raw(price: Decimal, decimals: u8) -> Self

pub fn from_delta(price: Decimal, delta: i16) -> Self

pub fn from_oracle<T: Into<String>>( querier: &KujiraQuerier<'_>, denom: T, decimals: u8 ) -> StdResult<Self>

pub fn inner(&self) -> Decimal

Methods from Deref<Target = Decimal>

pub const DECIMAL_PLACES: u32 = 18u32

pub const MAX: Decimal = _

pub const MIN: Decimal = _

pub fn is_zero(&self) -> bool

pub fn atomics(&self) -> Uint128

A decimal is an integer of atomic units plus a number that specifies the position of the decimal dot. So any decimal can be expressed as two numbers.

Examples

// Value with whole and fractional part
let a = Decimal::from_str("1.234").unwrap();
assert_eq!(a.decimal_places(), 18);
assert_eq!(a.atomics(), Uint128::new(1234000000000000000));

// Smallest possible value
let b = Decimal::from_str("0.000000000000000001").unwrap();
assert_eq!(b.decimal_places(), 18);
assert_eq!(b.atomics(), Uint128::new(1));

pub fn decimal_places(&self) -> u32

The number of decimal places. This is a constant value for now but this could potentially change as the type evolves.

See also Decimal::atomics().

pub fn floor(&self) -> Decimal

Rounds value down after decimal places.

pub fn ceil(&self) -> Decimal

Rounds value up after decimal places. Panics on overflow.

pub fn checked_ceil(&self) -> Result<Decimal, RoundUpOverflowError>

Rounds value up after decimal places. Returns OverflowError on overflow.

pub fn sqrt(&self) -> Decimal

Returns the approximate square root as a Decimal.

This should not overflow or panic.

Trait Implementations

impl Clone for NormalizedPrice

fn clone(&self) -> NormalizedPrice

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NormalizedPrice

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

Formats the value using the given formatter.

impl Deref for NormalizedPrice

type Target = Decimal

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for NormalizedPrice

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Div<NormalizedPrice> for Uint128

type Output = Option<Uint128>

The resulting type after applying the / operator.

fn div(self, rhs: NormalizedPrice) -> Self::Output

Performs the / operation.

impl Div<Uint128> for NormalizedPrice

type Output = Option<Uint128>

The resulting type after applying the / operator.

fn div(self, rhs: Uint128) -> Self::Output

Performs the / operation.

impl Div for NormalizedPrice

type Output = NormalizedPrice

The resulting type after applying the / operator.

fn div(self, rhs: NormalizedPrice) -> Self::Output

Performs the / operation.

impl DivAssign for NormalizedPrice

fn div_assign(&mut self, rhs: NormalizedPrice)

Performs the /= operation.

impl From<NormalizedPrice> for Decimal

fn from(price: NormalizedPrice) -> Self

Converts to this type from the input type.

impl JsonSchema for NormalizedPrice

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 Mul<NormalizedPrice> for Uint128

type Output = Uint128

The resulting type after applying the * operator.

fn mul(self, rhs: NormalizedPrice) -> Self::Output

Performs the * operation.

impl Mul<Uint128> for NormalizedPrice

type Output = Uint128

The resulting type after applying the * operator.

fn mul(self, rhs: Uint128) -> Self::Output

Performs the * operation.

impl Mul for NormalizedPrice

type Output = NormalizedPrice

The resulting type after applying the * operator.

fn mul(self, rhs: NormalizedPrice) -> Self::Output

Performs the * operation.

impl MulAssign<NormalizedPrice> for Uint128

fn mul_assign(&mut self, rhs: NormalizedPrice)

Performs the *= operation.

impl MulAssign for NormalizedPrice

fn mul_assign(&mut self, rhs: NormalizedPrice)

Performs the *= operation.

impl Ord for NormalizedPrice

fn cmp(&self, other: &NormalizedPrice) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for NormalizedPrice

fn eq(&self, other: &NormalizedPrice) -> 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 PartialOrd for NormalizedPrice

fn partial_cmp(&self, other: &NormalizedPrice) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for NormalizedPrice

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for NormalizedPrice

impl Eq for NormalizedPrice

impl StructuralPartialEq for NormalizedPrice