bullet-exchange-interface 0.1.1

Type definitions and message formats for the Bullet exchange protocol.
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

use super::{PositiveDecimal, RoundingMode};

pub const FIXED_DECIMALS: u32 = 12;

#[derive(
    Default,
    Debug,
    Clone,
    Copy,
    PartialEq,
    Eq,
    PartialOrd,
    Ord,
    serde::Serialize,
    serde::Deserialize,
    borsh::BorshSerialize,
    borsh::BorshDeserialize,
)]
#[cfg_attr(feature = "schema", derive(sov_universal_wallet::UniversalWallet))]
#[serde(transparent)]
pub struct FixedPositiveDecimal(PositiveDecimal);

impl std::fmt::Display for FixedPositiveDecimal {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.0)
    }
}

impl From<PositiveDecimal> for FixedPositiveDecimal {
    fn from(value: PositiveDecimal) -> Self {
        Self::new(value, RoundingMode::Down)
    }
}

impl From<FixedPositiveDecimal> for PositiveDecimal {
    fn from(value: FixedPositiveDecimal) -> PositiveDecimal {
        value.0
    }
}

impl FixedPositiveDecimal {
    pub const ZERO: FixedPositiveDecimal = FixedPositiveDecimal(PositiveDecimal::ZERO);

    #[inline]
    pub fn new(value: PositiveDecimal, mode: RoundingMode) -> Self {
        let rounded = match mode {
            RoundingMode::Up => value.as_dec().round_dp_with_strategy(
                FIXED_DECIMALS,
                rust_decimal::RoundingStrategy::AwayFromZero,
            ),
            RoundingMode::Down => value
                .as_dec()
                .round_dp_with_strategy(FIXED_DECIMALS, rust_decimal::RoundingStrategy::ToZero),
        };

        // SAFETY: Rounding down a PositiveDecimal (non-negative) with RoundingMode::Down
        // always produces a valid FixedPositiveDecimal. The only way FixedPositiveDecimal::new
        // can fail is if PositiveDecimal::new returns None, which only happens for negative
        // values. Since we're rounding down a non-negative value, the result is always non-negative.
        #[allow(
            clippy::expect_used,
            reason = "Rounding down a PositiveDecimal is infallible - result is always non-negative"
        )]
        Self(
            PositiveDecimal::new(rounded).expect(
                "rounding down a PositiveDecimal always produces valid FixedPositiveDecimal",
            ),
        )
    }

    #[inline(always)]
    pub fn is_zero(&self) -> bool {
        self.0.is_zero()
    }

    #[inline(always)]
    pub fn as_pos_dec(&self) -> PositiveDecimal {
        self.0
    }
}