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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192

pub mod any;
pub mod arc;
pub mod binary_heap;
pub mod channel;
pub mod hashmap;
pub mod hex;
pub mod iter;
pub mod networking;
pub mod option;
pub mod refs;

pub mod as_slice;

/// # Examples
/// ## Implement serde::Serialize/serde::Deserialize for the Vec field of the struct
/// ```
/// #[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
/// struct MyStructVec {
///     #[serde(with = "kaspa_utils::serde_bytes")]
///     v: Vec<u8>,
/// }
/// let v = vec![0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19];
/// let len = v.len();
/// let test_struct = MyStructVec { v: v.clone() };
///
/// // Serialize using bincode
/// let encoded = bincode::serialize(&test_struct).unwrap();
/// assert_eq!(encoded, len.to_le_bytes().into_iter().chain(v.into_iter()).collect::<Vec<_>>());
/// // Deserialize using bincode
/// let decoded: MyStructVec = bincode::deserialize(&encoded).unwrap();
/// assert_eq!(test_struct, decoded);
///
/// let expected_str = r#"{"v":"000102030405060708090a0b0c0d0e0f10111213"}"#;
/// // Serialize using serde_json
/// let json = serde_json::to_string(&test_struct).unwrap();
/// assert_eq!(expected_str, json);
/// // Deserialize using serde_json
/// let from_json: MyStructVec = serde_json::from_str(&json).unwrap();
/// assert_eq!(test_struct, from_json);
/// ```
/// ## Implement serde::Serialize/serde::Deserialize for the SmallVec field of the struct
/// ```
/// use smallvec::{smallvec, SmallVec};
/// #[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
/// struct MyStructSmallVec {  
///     #[serde(with = "kaspa_utils::serde_bytes")]
///     v: SmallVec<[u8; 19]>,
/// }
/// let v = smallvec![0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19];
/// let len = v.len();
/// let test_struct = MyStructSmallVec { v: v.clone() };
///
/// // Serialize using bincode
/// let encoded = bincode::serialize(&test_struct).unwrap();
/// assert_eq!(encoded, len.to_le_bytes().into_iter().chain(v.into_iter()).collect::<Vec<_>>());
/// // Deserialize using bincode
/// let decoded: MyStructSmallVec = bincode::deserialize(&encoded).unwrap();
/// assert_eq!(test_struct, decoded);
///
/// let expected_str = r#"{"v":"000102030405060708090a0b0c0d0e0f10111213"}"#;
/// // Serialize using serde_json
/// let json = serde_json::to_string(&test_struct).unwrap();
/// assert_eq!(expected_str, json);
/// // Deserialize using serde_json
/// let from_json: MyStructSmallVec = serde_json::from_str(&json).unwrap();
/// assert_eq!(test_struct, from_json);
/// ```
pub mod serde_bytes;

/// # Examples
///
/// ```
/// #[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
/// struct TestStruct {
///     #[serde(with = "kaspa_utils::serde_bytes_fixed")]
///     v: [u8; 20],
/// }
/// let test_struct = TestStruct { v: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19] };
///
/// // Serialize using bincode
/// let encoded = bincode::serialize(&test_struct).unwrap();
/// assert_eq!(encoded, [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19]);
/// // Deserialize using bincode
/// let decoded: TestStruct = bincode::deserialize(&encoded).unwrap();
/// assert_eq!(test_struct, decoded);
///
/// let expected_str = r#"{"v":"000102030405060708090a0b0c0d0e0f10111213"}"#;
/// // Serialize using serde_json
/// let json = serde_json::to_string(&test_struct).unwrap();
/// assert_eq!(expected_str, json);
/// // Deserialize using serde_json
/// let from_json: TestStruct = serde_json::from_str(&json).unwrap();
/// assert_eq!(test_struct, from_json);
/// ```
pub mod serde_bytes_fixed;
/// # Examples
/// ## Implement serde::Serialize/serde::Deserialize using declarative macro
/// ```
/// #[derive(Debug, Copy, Clone, PartialEq, Eq)]
/// struct MyStruct([u8; 20]);
///
/// impl AsRef<[u8; 20]> for MyStruct {
///     fn as_ref(&self) -> &[u8; 20] {
///         &self.0
///     }
/// }
/// impl kaspa_utils::hex::FromHex for MyStruct {
///     type Error = faster_hex::Error;
///     fn from_hex(hex_str: &str) -> Result<Self, Self::Error> {
///         let mut bytes = [0u8; 20];
///         faster_hex::hex_decode(hex_str.as_bytes(), &mut bytes)?;
///         Ok(MyStruct(bytes))
///     }
/// }
/// impl From<[u8; 20]> for MyStruct {
///     fn from(value: [u8; 20]) -> Self {
///         MyStruct(value)
///     }
/// }
/// kaspa_utils::serde_impl_ser_fixed_bytes_ref!(MyStruct, 20);
/// kaspa_utils::serde_impl_deser_fixed_bytes_ref!(MyStruct, 20);
///
/// let test_struct = MyStruct([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19]);
/// let expected_str = r#""000102030405060708090a0b0c0d0e0f10111213""#;
/// // Serialize using serde_json
/// let json = serde_json::to_string(&test_struct).unwrap();
/// assert_eq!(expected_str, json);
/// // Deserialize using serde_json
/// let from_json: MyStruct = serde_json::from_str(&json).unwrap();
/// assert_eq!(test_struct, from_json);
/// // Serialize using bincode
/// let encoded = bincode::serialize(&test_struct).unwrap();
/// assert_eq!(encoded, [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19]);
/// // Deserialize using bincode
/// let decoded: MyStruct = bincode::deserialize(&encoded).unwrap();
/// assert_eq!(test_struct, decoded);
/// ```
///
/// ## Implement serde::Serialize/serde::Deserialize for the field of the struct
/// ```
/// #[derive(Debug, Copy, Clone, PartialEq, Eq)]
/// struct MyStruct([u8; 20]);
///
/// impl AsRef<[u8; 20]> for MyStruct {
///     fn as_ref(&self) -> &[u8; 20] {
///         &self.0
///     }
/// }
/// impl kaspa_utils::hex::FromHex for MyStruct {
///     type Error = faster_hex::Error;
///     fn from_hex(hex_str: &str) -> Result<Self, Self::Error> {
///         let mut bytes = [0u8; 20];
///         faster_hex::hex_decode(hex_str.as_bytes(), &mut bytes)?;
///         Ok(MyStruct(bytes))
///     }
/// }
/// impl From<[u8; 20]> for MyStruct {
///     fn from(value: [u8; 20]) -> Self {
///         MyStruct(value)
///     }
/// }
///
/// #[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
/// struct TestStruct {
///     #[serde(with = "kaspa_utils::serde_bytes_fixed_ref")]
///     v: MyStruct,
/// }
///
/// let test_struct = TestStruct { v: MyStruct([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19]) };
///
/// // Serialize using bincode
/// let encoded = bincode::serialize(&test_struct).unwrap();
/// assert_eq!(encoded, [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19]);
/// // Deserialize using bincode
/// let decoded: TestStruct = bincode::deserialize(&encoded).unwrap();
/// assert_eq!(test_struct, decoded);
///
/// let expected_str = r#"{"v":"000102030405060708090a0b0c0d0e0f10111213"}"#;
/// // Serialize using serde_json
/// let json = serde_json::to_string(&test_struct).unwrap();
/// assert_eq!(expected_str, json);
/// // Deserialize using serde_json
/// let from_json: TestStruct = serde_json::from_str(&json).unwrap();
/// assert_eq!(test_struct, from_json);
/// ```
pub mod serde_bytes_fixed_ref;
pub mod sim;
pub mod sync;
pub mod triggers;
pub mod vec;

pub mod fd_budget;