[ENG-87] Implement price library #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

alnoki merged 47 commits into main from ENG-87

Dec 13, 2025

Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Cargo.toml

-Original file line number
+Diff line change
@@ Expand Up / @@ -7,6 +7,7 @@ members = [ @@
       "instruction-macros/crates/test-fixtures",
       "interface",
       "grpc-stream",
+      "price",
       "program",
       "transaction-parser",
     ]
@@ Expand Down @@

instruction-macros/crates/instruction-macros-impl/src/render/try_from_tag_macro.rs

-Original file line number
+Diff line change
@@ Expand Up / @@ -59,7 +59,7 @@ use crate::parse::{ @@
     /// // Use it to implement `TryFrom<u8>`:
     /// impl TryFrom<u8> for MyInstruction {
     ///     type Error = ProgramError;
-    ///
+    ///
     ///     #[inline(always)]
     ///     fn try_from(tag: u8) -> Result<Self, Self::Error> {
     ///         MyInstruction_try_from_tag!(tag, ProgramError::InvalidInstructionData)
@@ Expand Down @@

instruction-macros/crates/test-fixtures/src/client.rs

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -19,7 +19,7 @@ mod test {
  
            #[account(9,           name = "quote_token_program", desc = "The quote mint's token program.")]

            #[args(sector_index_hint: u32, "A hint indicating which sector the user's seat resides in.")]

            CloseSeat,

            #[account(0, signer,   name = "user",           desc = "The user depositing or registering their seat.")]

            #[account(1, writable, name = "market_account", desc = "The market account PDA.")]

            #[account(2, writable, name = "user_ata",       desc = "The user's associated token account.")]

    @@ -29,10 +29,10 @@ mod test {
  
            #[args(amount: u64, "The amount to deposit.")]

            #[args(sector_index_hint: u32, "A hint indicating which sector the user's seat resides in (pass `NIL` when registering a new seat).")]

            Deposit,

            #[account(0, signer, name = "event_authority", desc = "Flush events.")]

            FlushEvents,

            Batch,

        }

    }

interface/src/events/mod.rs

-Original file line number
+Diff line change
@@ Expand Up / @@ -39,7 +39,7 @@ pub enum DropsetEventTag { @@
         #[args(seat_sector_index: u32, "The user's (possibly newly registered) market seat sector index.")]
         DepositEvent,
         #[args(amount: u64, "The amount withdrawn.")]
-        #[args(is_base: bool, "Which token, i.e., `true` => base token, `false` => quote token.")]
+        #[args(is_base: bool, "Which token, i.e., `true` => base token, `false` => quote token.")]
         WithdrawEvent,
         #[args(market: [u8; 32], "The newly registered market.")]
         RegisterMarketEvent,
@@ Expand Down @@

price/Cargo.toml

-Original file line number
+Diff line change
@@ -0,0 +1,15 @@
+    [package]
+    name = "price"
+    version.workspace = true
+    edition.workspace = true
+    [dependencies]
+    static_assertions.workspace = true
+    pinocchio.workspace = true
+    [dev-dependencies]
+    strum.workspace = true
+    strum_macros.workspace = true
+    [lints]
+    workspace = true

price/src/decoded_price.rs

-Original file line number
+Diff line change
@@ -0,0 +1,79 @@
+    use crate::{
+        EncodedPrice,
+        OrderInfoError,
+        ValidatedPriceMantissa,
+        BIAS,
+        ENCODED_PRICE_INFINITY,
+        ENCODED_PRICE_ZERO,
+        PRICE_MANTISSA_BITS,
+        PRICE_MANTISSA_MASK,
+    };
+    /// An enum representing a decoded `EncodedPrice`.
+    #[derive(Clone)]
+    #[cfg_attr(test, derive(Debug))]
+    pub enum DecodedPrice {
+        Zero,
+        Infinity,
+        ExponentAndMantissa {
+            price_exponent_biased: u8,
+            price_mantissa: ValidatedPriceMantissa,
+        },
+    }
+    impl DecodedPrice {
+        /// Return the optional tuple of exponent and mantissa from a decoded price.
+        /// If the decoded price is not a [`DecodedPrice::ExponentAndMantissa`], this returns `None`.
+        pub fn as_exponent_and_mantissa(&self) -> Option<(&u8, &ValidatedPriceMantissa)> {
+            if let DecodedPrice::ExponentAndMantissa {
+                price_exponent_biased,
+                price_mantissa,
+            } = self
+            {
+                Some((price_exponent_biased, price_mantissa))
+            } else {
+                None
+            }
+        }
+    }
+    impl TryFrom<EncodedPrice> for DecodedPrice {
+        type Error = OrderInfoError;
+        fn try_from(encoded: EncodedPrice) -> Result<Self, Self::Error> {
+            let res = match encoded.get() {
+                ENCODED_PRICE_ZERO => Self::Zero,
+                ENCODED_PRICE_INFINITY => Self::Infinity,
+                value => {
+                    let price_exponent_biased = (value >> PRICE_MANTISSA_BITS) as u8;
+                    let validated_mantissa = value & PRICE_MANTISSA_MASK;
+                    Self::ExponentAndMantissa {
+                        price_exponent_biased,
+                        price_mantissa: ValidatedPriceMantissa::try_from(validated_mantissa)?,
+                    }
+                }
+            };
+            Ok(res)
+        }
+    }
+    impl TryFrom<DecodedPrice> for f64 {
+        type Error = OrderInfoError;
+        fn try_from(decoded: DecodedPrice) -> Result<Self, Self::Error> {
+            match decoded {
+                DecodedPrice::Zero => Ok(0f64),
+                DecodedPrice::Infinity => Err(OrderInfoError::InfinityIsNotAFloat),
+                DecodedPrice::ExponentAndMantissa {
+                    price_exponent_biased,
+                    price_mantissa,
+                } => {
+                    let res = (price_mantissa.get() as f64)
+                        * 10f64.powi(price_exponent_biased as i32 - BIAS as i32);
+                    Ok(res)
+                }
+            }
+        }
+    }

price/src/encoded_price.rs

-Original file line number
+Diff line change
@@ -0,0 +1,102 @@
+    use crate::{
+        ValidatedPriceMantissa,
+        PRICE_MANTISSA_BITS,
+    };
+    /// The encoded price as a u32.
+    ///
+    /// If `N` = the number of exponent bits and `M` = the number of price mantissa bits, the u32 bit
+    /// layout is:
+    ///
+    /// ```text
+    ///          N                M
+    /// |-------------------|-------------------|
+    ///   [ exponent_bits ] | [ mantissa_bits ]
+    /// |---------------------------------------|
+    ///                    32
+    /// ```
+    #[repr(transparent)]
+    #[derive(Copy, Clone, Debug)]
+    pub struct EncodedPrice(u32);
+    pub const ENCODED_PRICE_INFINITY: u32 = u32::MAX;
+    pub const ENCODED_PRICE_ZERO: u32 = 0;
+    impl EncodedPrice {
+        /// Creates a new [`EncodedPrice`] from a biased price exponent and a validated price mantissa.
+        #[inline(always)]
+        pub fn new(price_exponent_biased: u8, price_mantissa: ValidatedPriceMantissa) -> Self {
+            // The biased price exponent doesn't need to be checked because a leftwards bitshift will
+            // always discard irrelevant bits.
+            let exponent_bits = (price_exponent_biased as u32) << PRICE_MANTISSA_BITS;
+            // No need to mask the price mantissa since it has already been range checked/validated.
+            // Thus it's guaranteed it will only occupy the lower M bits where M = PRICE_MANTISSA_BITS.
+            Self(exponent_bits | price_mantissa.get())
+        }
+        /// Returns the inner encoded price as a u32.
+        #[inline(always)]
+        pub fn get(&self) -> u32 {
+            self.0
+        }
+        /// The encoded price representation of a market buy/taker order with no constraints on the
+        /// maximum filled ask price.
+        #[inline(always)]
+        pub const fn infinity() -> Self {
+            Self(ENCODED_PRICE_INFINITY)
+        }
+        #[inline(always)]
+        pub fn is_infinity(&self) -> bool {
+            self.0 == ENCODED_PRICE_INFINITY
+        }
+        /// The encoded price representation of a market sell/taker order with no constraints on the
+        /// minimum filled bid price.
+        #[inline(always)]
+        pub const fn zero() -> Self {
+            Self(ENCODED_PRICE_ZERO)
+        }
+        #[inline(always)]
+        pub fn is_zero(&self) -> bool {
+            self.0 == ENCODED_PRICE_ZERO
+        }
+    }
+    #[cfg(test)]
+    mod tests {
+        use crate::{
+            to_biased_exponent,
+            EncodedPrice,
+            ValidatedPriceMantissa,
+            BIAS,
+            PRICE_MANTISSA_BITS,
+            PRICE_MANTISSA_MASK,
+        };
+        #[test]
+        fn encoded_price_mantissa_bits() {
+            let exponent = 0b0_1111;
+            let price_mantissa = 0b000_1111_0000_1111_0000_1111_0000;
+            let encoded_price = EncodedPrice::new(
+                to_biased_exponent!(exponent),
+                ValidatedPriceMantissa::try_from(price_mantissa).unwrap(),
+            );
+            assert_eq!(
+                encoded_price.0 >> PRICE_MANTISSA_BITS,
+                (exponent + BIAS) as u32
+            );
+            assert_eq!(encoded_price.0 & PRICE_MANTISSA_MASK, price_mantissa);
+        }
+        #[test]
+        fn test_infinity() {
+            assert_eq!(EncodedPrice::infinity().0, u32::MAX);
+            assert_eq!(EncodedPrice::zero().0, 0);
+            assert!(EncodedPrice::infinity().is_infinity());
+            assert!(EncodedPrice::zero().is_zero());
+        }
+    }

price/src/error.rs

-Original file line number
+Diff line change
@@ -0,0 +1,10 @@
+    #[repr(u8)]
+    #[derive(Debug)]
+    #[cfg_attr(test, derive(strum_macros::Display))]
+    pub enum OrderInfoError {
+        ExponentUnderflow,
+        ArithmeticOverflow,
+        InvalidPriceMantissa,
+        InvalidBiasedExponent,
+        InfinityIsNotAFloat,
+    }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ENG-87] Implement price library #49

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!