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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
use alloc::format;
use core::fmt::{self, Debug, Formatter};
use core::marker::PhantomData;
use serde::ser::SerializeTuple;
use serde::{de, ser, Serializer};
use serde_bolt::Octets;
use serde_derive::{Deserialize, Serialize};
macro_rules! unprefixed_array_impl {
($ty:ident, $len:tt) => {
#[derive(Clone, Serialize, Deserialize)]
pub struct $ty(pub [u8; $len]);
impl Debug for $ty {
fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
write!(f, "{}", hex::encode(&self.0))
}
}
};
}
macro_rules! unprefixed_secret_array_impl {
($ty:ident, $len:tt) => {
#[derive(Clone, Serialize, Deserialize)]
pub struct $ty(pub [u8; $len]);
impl Debug for $ty {
#[cfg(feature = "log-secrets")]
fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
write!(f, "{}", hex::encode(&self.0))
}
#[cfg(not(feature = "log-secrets"))]
fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
write!(f, "******")
}
}
};
}
macro_rules! array_impl {
($ty:ident, $len:tt) => {
#[derive(Clone)]
pub struct $ty(pub [u8; $len]);
impl Debug for $ty {
fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
write!(f, "{}", hex::encode(&self.0))
}
}
impl<'de> de::Deserialize<'de> for $ty {
fn deserialize<D>(d: D) -> core::result::Result<Self, D::Error>
where
D: de::Deserializer<'de>,
{
struct Visitor {
marker: PhantomData<$ty>,
}
impl<'de> de::Visitor<'de> for Visitor {
type Value = $ty;
fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
formatter.write_str(concat!("an array of length {}", $len))
}
#[inline]
fn visit_seq<A>(self, mut seq: A) -> core::result::Result<Self::Value, A::Error>
where
A: de::SeqAccess<'de>,
{
let mut buf = [0u8; $len];
for i in 0..buf.len() {
let next = seq.next_element()?;
buf[i] = match next {
None => return Err(de::Error::invalid_length($len, &self)),
Some(val) => val,
};
}
Ok($ty(buf))
}
}
impl Visitor {
fn new() -> Self {
Self { marker: PhantomData }
}
}
d.deserialize_tuple($len, Visitor::new())
}
}
impl ser::Serialize for $ty {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
let mut tuple = serializer.serialize_tuple(self.0.len())?;
for i in 0..self.0.len() {
tuple.serialize_element(&self.0[i])?;
}
tuple.end()
}
}
};
}
#[derive(Serialize, Deserialize)]
pub struct Bip32KeyVersion {
pub pubkey_version: u32,
pub privkey_version: u32,
}
impl Debug for Bip32KeyVersion {
fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
f.debug_struct("Bip32KeyVersion")
.field("pubkey_version", &format!("0x{:x?}", self.pubkey_version))
.field("privkey_version", &format!("0x{:x?}", self.privkey_version))
.finish()
}
}
unprefixed_array_impl!(BlockId, 32);
unprefixed_secret_array_impl!(Secret, 32);
unprefixed_array_impl!(DisclosedSecret, 32);
unprefixed_array_impl!(DevSecret, 32);
unprefixed_array_impl!(DevPrivKey, 32);
unprefixed_array_impl!(PubKey32, 32);
array_impl!(PubKey, 33);
array_impl!(ExtKey, 78);
unprefixed_array_impl!(Sha256, 32);
unprefixed_array_impl!(BlockHash, 32);
#[derive(Debug, Serialize, Deserialize)]
pub struct OutPoint {
pub txid: TxId,
pub vout: u32,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct Basepoints {
pub revocation: PubKey,
pub payment: PubKey,
pub htlc: PubKey,
pub delayed_payment: PubKey,
}
array_impl!(Signature, 64);
array_impl!(RecoverableSignature, 65);
array_impl!(TxId, 32);
array_impl!(OnionRoutingPacket, 1366);
#[derive(Debug, Serialize, Deserialize)]
pub struct FailedHtlc {
pub id: u64,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BitcoinSignature {
pub signature: Signature,
pub sighash: u8,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct Htlc {
pub side: u8, pub amount: u64,
pub payment_hash: Sha256,
pub ctlv_expiry: u32,
}
impl Htlc {
pub const LOCAL: u8 = 0;
pub const REMOTE: u8 = 1;
}
#[derive(Debug, Serialize, Deserialize)]
pub struct CloseInfo {
pub channel_id: u64,
pub peer_id: PubKey,
pub commitment_point: Option<PubKey>,
pub is_anchors: bool,
pub csv: u32,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct Utxo {
pub txid: TxId,
pub outnum: u32,
pub amount: u64,
pub keyindex: u32,
pub is_p2sh: bool,
pub script: Octets,
pub close_info: Option<CloseInfo>,
pub is_in_coinbase: bool,
}
#[cfg(test)]
mod tests {
#[test]
fn debug_secret_test() {
let secret = super::Secret([0; 32]);
let debug = format!("{:?}", secret);
assert_eq!(debug, "******");
}
}