ruint 1.18.0

Unsigned integer type with const-generic bit length
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

//! Support for the [`bn-rs`](https://crates.io/crates/bn-rs) crate.

#![cfg(feature = "bn-rs")]
#![cfg_attr(docsrs, doc(cfg(feature = "bn-rs")))]

use crate::{BaseConvertError, Bits, ParseError, Uint, from::ToUintError};
use bn_rs::{BN, BigNumber};

impl<const BITS: usize, const LIMBS: usize> TryFrom<&BN> for Uint<BITS, LIMBS> {
    type Error = ToUintError<Self>;

    // FIXME: Return wrapped values.
    fn try_from(value: &BN) -> Result<Self, Self::Error> {
        if value.negative() == 1 {
            return Err(ToUintError::ValueNegative(BITS, Self::ZERO));
        }
        if value.byte_length() as usize > Self::BYTES {
            return Err(ToUintError::ValueTooLarge(BITS, Self::ZERO));
        }
        // Binding for `toArray`
        // `a.toArray(endian, length)` - convert to byte array, and optionally zero pad
        // to length, throwing if already exceeding. <https://github.com/indutny/bn.js/blob/5df40f81ea8afb835b909bb7c21e0833cdeb6a30/lib/bn.js#L573>
        value.to_array("le".into(), 0).map_or_else(
            |_| Err(ToUintError::NotANumber(BITS)),
            |bytes| {
                Self::try_from_le_slice(&bytes).ok_or(ToUintError::ValueTooLarge(BITS, Self::ZERO))
            },
        )
    }
}

impl<const BITS: usize, const LIMBS: usize> TryFrom<BN> for Uint<BITS, LIMBS> {
    type Error = ToUintError<Self>;

    fn try_from(value: BN) -> Result<Self, Self::Error> {
        Self::try_from(&value)
    }
}

impl<const BITS: usize, const LIMBS: usize> From<&Uint<BITS, LIMBS>> for BN {
    fn from(value: &Uint<BITS, LIMBS>) -> Self {
        Self::new_from_array(&value.as_le_bytes(), 256)
    }
}

impl<const BITS: usize, const LIMBS: usize> From<Uint<BITS, LIMBS>> for BN {
    fn from(value: Uint<BITS, LIMBS>) -> Self {
        (&value).into()
    }
}

impl<const BITS: usize, const LIMBS: usize> TryFrom<&BigNumber> for Uint<BITS, LIMBS> {
    type Error = ToUintError<Self>;

    // FIXME: Return wrapped values.
    fn try_from(value: &BigNumber) -> Result<Self, Self::Error> {
        let hex = value.hex();
        Self::from_str_radix(&hex, 16).map_err(|e| match e {
            ParseError::BaseConvertError(BaseConvertError::Overflow) => {
                ToUintError::ValueTooLarge(BITS, Self::ZERO)
            }
            _ => ToUintError::NotANumber(BITS),
        })
    }
}

impl<const BITS: usize, const LIMBS: usize> TryFrom<BigNumber> for Uint<BITS, LIMBS> {
    type Error = ToUintError<Self>;

    fn try_from(value: BigNumber) -> Result<Self, Self::Error> {
        Self::try_from(&value)
    }
}

impl<const BITS: usize, const LIMBS: usize> From<&Uint<BITS, LIMBS>> for BigNumber {
    fn from(value: &Uint<BITS, LIMBS>) -> Self {
        Self::new(format!("{value:#x}"))
    }
}

impl<const BITS: usize, const LIMBS: usize> From<Uint<BITS, LIMBS>> for BigNumber {
    fn from(value: Uint<BITS, LIMBS>) -> Self {
        (&value).into()
    }
}

macro_rules! impl_bits {
    ($($ty:ty)*) => {
        $(
            impl<const BITS: usize, const LIMBS: usize> TryFrom<$ty> for Bits<BITS, LIMBS> {
                type Error = <Uint<BITS, LIMBS> as TryFrom<$ty>>::Error;

                fn try_from(value: $ty) -> Result<Self, Self::Error> {
                    Uint::try_from(value).map(Self::from)
                }
            }

            impl<'a, const BITS: usize, const LIMBS: usize> TryFrom<&'a $ty> for Bits<BITS, LIMBS> {
                type Error = <Uint<BITS, LIMBS> as TryFrom<&'a $ty>>::Error;

                fn try_from(value: &'a $ty) -> Result<Self, Self::Error> {
                    Uint::try_from(value).map(Self::from)
                }
            }

            impl<const BITS: usize, const LIMBS: usize> From<Bits<BITS, LIMBS>> for $ty {
                fn from(value: Bits<BITS, LIMBS>) -> Self {
                    Self::from(value.into_inner())
                }
            }

            impl<const BITS: usize, const LIMBS: usize> From<&Bits<BITS, LIMBS>> for $ty {
                fn from(value: &Bits<BITS, LIMBS>) -> Self {
                    Self::from(value.as_uint())
                }
            }
        )*
    }
}

impl_bits!(BN BigNumber);

#[cfg(test)]
#[cfg(any(target_arch = "wasm32", target_arch = "wasm64"))] // Tests require wasm
mod test {
    use super::*;
    use crate::{const_for, nlimbs};
    use proptest::proptest;

    #[test]
    fn test_bn_roundtrip() {
        const_for!(BITS in SIZES {
            const LIMBS: usize = nlimbs(BITS);
            type U = Uint<BITS, LIMBS>;
            proptest!(|(value: U)| {
                let obj: BN = value.into();
                let native = obj.try_into().unwrap();
                assert_eq!(value, native);
            });
        });
    }

    #[test]
    fn test_bignumber_roundtrip() {
        const_for!(BITS in SIZES {
            const LIMBS: usize = nlimbs(BITS);
            type U = Uint<BITS, LIMBS>;
            proptest!(|(value: U)| {
                let obj: BigNumber = value.into();
                let native = obj.try_into().unwrap();
                assert_eq!(value, native);
            });
        });
    }
}