hylo-fix 0.6.0

Fixed-point number types with Solana Anchor support
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

use crate::typenum::{Integer, U10};
use crate::Fix;

use anchor_lang::error::ErrorCode::InvalidNumericConversion;
use anchor_lang::prelude::{borsh, AnchorDeserialize, AnchorSerialize, InitSpace, Result};
use paste::paste;
use serde::{Deserialize, Serialize};

macro_rules! impl_fix_value {
    ($sign:ident, $bits:expr) => {
        paste! {
           /// A value-space `Fix` where base is always 10 and bits are a concrete type.
           /// Intended for serialized storage in Solana accounts where generics won't work.
            #[derive(PartialEq, Eq, Copy, Clone, Debug, Serialize, Deserialize, AnchorSerialize, AnchorDeserialize, InitSpace)]
            pub struct [<$sign FixValue $bits>] {
                pub bits: [<$sign:lower $bits>],
                pub exp: i8,
            }

            impl [<$sign FixValue $bits>] {
                #[must_use] pub fn new(bits: [<$sign:lower $bits>], exp: i8) -> Self {
                    Self { bits, exp }
                }
            }

            impl<Bits, Exp> From<Fix<Bits, U10, Exp>> for [<$sign FixValue $bits>]
            where
                Bits: Into<[<$sign:lower $bits>]>,
                Exp: Integer,
            {
                fn from(fix: Fix<Bits, U10, Exp>) -> Self {
                    Self {
                        bits: fix.bits.into(),
                        exp: Exp::to_i8(),
                    }
                }
            }

            impl<Bits, Exp> TryFrom<[<$sign FixValue $bits>]> for Fix<Bits, U10, Exp>
            where
                Bits: From<[<$sign:lower $bits>]>,
                Exp: Integer,
            {
              type Error = anchor_lang::error::Error;
              fn try_from(value: [<$sign FixValue $bits>]) -> Result<Fix<Bits, U10, Exp>> {
                if value.exp == Exp::to_i8() {
                  Ok(Fix::new(value.bits.into()))
                } else {
                  Err(InvalidNumericConversion.into())
                }
              }
            }
        }
    };
}

impl_fix_value!(U, 8);
impl_fix_value!(U, 16);
impl_fix_value!(U, 32);
impl_fix_value!(U, 64);
impl_fix_value!(U, 128);
impl_fix_value!(I, 8);
impl_fix_value!(I, 16);
impl_fix_value!(I, 32);
impl_fix_value!(I, 64);
impl_fix_value!(I, 128);

#[cfg(test)]
mod tests {
    use super::*;
    use crate::aliases::si::Kilo;
    use anyhow::Result;
    use borsh::to_vec;

    macro_rules! fix_value_tests {
        ($sign:ident, $bits:expr) => {
            paste! {
                #[test]
                fn [<roundtrip_into_ $sign:lower $bits>]() -> Result<()> {
                    let start = Kilo::new([<69 $sign:lower $bits>]);
                    let there: [<$sign FixValue $bits>] = start.into();
                    let back: Kilo<[<$sign:lower $bits>]> = there.try_into()?;
                    assert_eq!(there, [<$sign FixValue $bits>]::new(69, 3));
                    Ok(assert_eq!(start, back))
                }

                #[test]
                fn [<roundtrip_serialize_ $sign:lower $bits>]() -> Result<()> {
                    let start = [<$sign FixValue $bits>]::new(20, -2);
                    let bytes = to_vec(&start)?;
                    let back = AnchorDeserialize::deserialize(&mut bytes.as_slice())?;
                    Ok(assert_eq!(start, back))
                }

                #[test]
                fn [<wrong_exp_should_fail_ $sign:lower $bits>]() -> Result<()> {
                    let pow11 = [<$sign FixValue $bits>]::new(42, -11);
                    let wrong = TryInto::<Kilo<[<$sign:lower $bits>]>>::try_into(pow11);
                    Ok(assert_eq!(Err(InvalidNumericConversion.into()), wrong))
                }
            }
        };
    }

    fix_value_tests!(U, 8);
    fix_value_tests!(U, 16);
    fix_value_tests!(U, 32);
    fix_value_tests!(U, 64);
    fix_value_tests!(U, 128);
    fix_value_tests!(I, 8);
    fix_value_tests!(I, 16);
    fix_value_tests!(I, 32);
    fix_value_tests!(I, 64);
    fix_value_tests!(I, 128);
}