secp256kfun 0.12.1

A mid-level secp256k1 library optimized for fun!
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
156
157
158
159
160
161

#[cfg(all(feature = "bincode", feature = "serde"))]
mod test {

    use core::{marker::PhantomData, str::FromStr};
    use secp256kfun::{
        hex::{self, HexError},
        impl_display_debug_serialize, impl_fromstr_deserialize,
    };

    #[derive(PartialEq)]
    struct SixBytes<T>([u8; 6], PhantomData<T>);

    impl<T> SixBytes<T> {
        fn from_six_bytes(from: [u8; 6]) -> Option<Self> {
            if from[0] == 0u8 {
                None
            } else {
                Some(SixBytes(from, PhantomData))
            }
        }

        fn to_six_bytes(&self) -> [u8; 6] {
            self.0
        }

        #[allow(dead_code)]
        fn from_slice(slice: &[u8]) -> Option<Self> {
            if slice.len() != 6 {
                return None;
            }

            let mut bytes = [0u8; 6];

            bytes.copy_from_slice(slice);
            Self::from_six_bytes(bytes)
        }
    }

    impl_fromstr_deserialize! {
        name => "six bytes",
        fn from_bytes<T>(bytes: [u8;6]) -> Option<SixBytes<T>> {
            SixBytes::from_six_bytes(bytes)
        }
    }

    impl_display_debug_serialize! {
        fn to_bytes<T>(six_bytes: &SixBytes<T>) -> &[u8;6] {
            &six_bytes.0
        }
    }

    #[test]
    fn from_str_roundtrip() {
        let parsed = SixBytes::<()>::from_str("deadbeef0123").unwrap();
        assert_eq!(
            parsed.to_six_bytes(),
            hex::decode_array("deadbeef0123").unwrap()
        );
        assert_eq!(format!("{parsed}").as_str(), "deadbeef0123");
    }

    #[test]
    fn from_str_error_cases() {
        assert_eq!(
            SixBytes::<()>::from_str("deadbeef012345"),
            Err(HexError::InvalidLength)
        );

        assert_eq!(
            SixBytes::<()>::from_str("deadbeef012g"),
            Err(HexError::InvalidHex)
        );

        assert_eq!(
            SixBytes::<()>::from_str("deadbeef01234"),
            Err(HexError::InvalidHex)
        );

        assert_eq!(
            SixBytes::<()>::from_str("00deadbeef11"),
            Err(HexError::InvalidEncoding)
        );
    }

    #[test]
    fn serde_serialize_roundtrip() {
        let six_bytes =
            &SixBytes::<()>::from_six_bytes(hex::decode_array("010203040506").unwrap()).unwrap();
        let serialized = bincode::encode_to_vec(
            bincode::serde::Compat(six_bytes),
            bincode::config::standard(),
        )
        .unwrap();
        let six_bytes: bincode::serde::Compat<SixBytes<()>> =
            bincode::decode_from_slice(&serialized, bincode::config::standard())
                .expect("valid bincode")
                .0;
        assert_eq!(
            six_bytes.0.to_six_bytes(),
            hex::decode_array("010203040506").unwrap()
        );
    }

    #[test]
    fn bincode2_serialize_roundtrip() {
        let six_bytes =
            &SixBytes::<()>::from_six_bytes(hex::decode_array("010203040506").unwrap()).unwrap();
        let serialized = bincode::encode_to_vec(six_bytes, bincode::config::standard()).unwrap();
        let six_bytes: SixBytes<()> =
            bincode::decode_from_slice(&serialized, bincode::config::standard())
                .expect("valid bincode")
                .0;
        assert_eq!(
            six_bytes.to_six_bytes(),
            hex::decode_array("010203040506").unwrap()
        );
    }

    #[test]
    #[should_panic(
        expected = "invalid byte encoding, expected a valid 6-byte encoding of a six bytes"
    )]
    fn deserialize_invalid_bytes() {
        let bincode_bytes = hex::decode_array::<6>("000102030405").unwrap(); // starting with 00 is invalid
        bincode::decode_from_slice::<bincode::serde::Compat<SixBytes<()>>, _>(
            &bincode_bytes,
            bincode::config::standard(),
        )
        .unwrap();
    }

    #[test]
    #[cfg(feature = "alloc")]
    fn serialize_hex_roundtrip() {
        let json_string = r#""deadbeef0123""#;
        let six_bytes = serde_json::from_str::<SixBytes<()>>(json_string).expect("valid json");
        assert_eq!(
            six_bytes.to_six_bytes(),
            hex::decode_array("deadbeef0123").unwrap()
        );
        assert_eq!(serde_json::to_string(&six_bytes).unwrap(), json_string)
    }

    #[test]
    #[should_panic(expected = "invalid length 5, expected a valid 6-byte hex encoded six bytes")]
    #[cfg(feature = "alloc")]
    fn deserialize_wrong_length() {
        serde_json::from_str::<SixBytes<()>>(r#""deadbeef01""#).unwrap();
    }

    #[test]
    fn display() {
        struct MyMarker;
        let six_bytes =
            SixBytes::<MyMarker>::from_six_bytes(hex::decode_array("deadbeef0123").unwrap())
                .unwrap();

        assert_eq!(format!("{six_bytes}"), "deadbeef0123");
        assert_eq!(format!("{six_bytes:?}"), "SixBytes<MyMarker>(deadbeef0123)");
    }
}