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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
use std::fmt;
use std::fmt::{Display, Formatter};
use bech32::{Bech32, ToBase32, u5};
use ::*;
impl Display for Invoice {
fn fmt(&self, f: &mut Formatter) -> Result<(), fmt::Error> {
self.signed_invoice.fmt(f)
}
}
impl Display for SignedRawInvoice {
fn fmt(&self, f: &mut Formatter) -> Result<(), fmt::Error> {
let hrp = self.raw_invoice.hrp.to_string();
let mut data = self.raw_invoice.data.to_base32();
data.extend_from_slice(&self.signature.to_base32());
Bech32::new(hrp, data).expect("hrp len > 0").fmt(f)
}
}
impl Display for RawHrp {
fn fmt(&self, f: &mut Formatter) -> Result<(), fmt::Error> {
let amount = match self.raw_amount {
Some(ref amt) => amt.to_string(),
None => String::new(),
};
let si_prefix = match self.si_prefix {
Some(ref si) => si.to_string(),
None => String::new(),
};
write!(
f,
"ln{}{}{}",
self.currency,
amount,
si_prefix
)
}
}
impl Display for Currency {
fn fmt(&self, f: &mut Formatter) -> Result<(), fmt::Error> {
let currency_code = match *self {
Currency::Bitcoin => "bc",
Currency::BitcoinTestnet => "tb",
};
write!(f, "{}", currency_code)
}
}
impl Display for SiPrefix {
fn fmt(&self, f: &mut Formatter) -> Result<(), fmt::Error> {
write!(f, "{}",
match *self {
SiPrefix::Milli => "m",
SiPrefix::Micro => "u",
SiPrefix::Nano => "n",
SiPrefix::Pico => "p",
}
)
}
}
fn encode_int_be_base32(int: u64) -> Vec<u5> {
let base = 32u64;
let mut out_vec = Vec::<u5>::new();
let mut rem_int = int;
while rem_int != 0 {
out_vec.push(u5::try_from_u8((rem_int % base) as u8).expect("always <32"));
rem_int /= base;
}
out_vec.reverse();
out_vec
}
fn encode_int_be_base256<T: Into<u64>>(int: T) -> Vec<u8> {
let base = 256u64;
let mut out_vec = Vec::<u8>::new();
let mut rem_int: u64 = int.into();
while rem_int != 0 {
out_vec.push((rem_int % base) as u8);
rem_int /= base;
}
out_vec.reverse();
out_vec
}
fn try_stretch<T>(mut in_vec: Vec<T>, target_len: usize) -> Option<Vec<T>>
where T: Default + Copy
{
if in_vec.len() > target_len {
None
} else if in_vec.len() == target_len {
Some(in_vec)
} else {
let mut out_vec = Vec::<T>::with_capacity(target_len);
out_vec.append(&mut vec![T::default(); target_len - in_vec.len()]);
out_vec.append(&mut in_vec);
Some(out_vec)
}
}
impl ToBase32<Vec<u5>> for RawDataPart {
fn to_base32(&self) -> Vec<u5> {
let mut encoded = Vec::<u5>::new();
encoded.extend(self.timestamp.to_base32());
for tagged_field in self.tagged_fields.iter() {
encoded.extend_from_slice(&tagged_field.to_base32());
}
encoded
}
}
impl ToBase32<Vec<u5>> for PositiveTimestamp {
fn to_base32(&self) -> Vec<u5> {
try_stretch(encode_int_be_base32(self.as_unix_timestamp()), 7)
.expect("Can't be longer due than 7 u5s due to timestamp bounds")
}
}
impl ToBase32<Vec<u5>> for RawTaggedField {
fn to_base32(&self) -> Vec<u5> {
match *self {
RawTaggedField::UnknownSemantics(ref content) => {
content.clone()
},
RawTaggedField::KnownSemantics(ref tagged_field) => {
tagged_field.to_base32()
}
}
}
}
impl ToBase32<Vec<u5>> for Sha256 {
fn to_base32(&self) -> Vec<u5> {
(&self.0[..]).to_base32()
}
}
impl ToBase32<Vec<u5>> for Description {
fn to_base32(&self) -> Vec<u5> {
self.as_bytes().to_base32()
}
}
impl ToBase32<Vec<u5>> for PayeePubKey {
fn to_base32(&self) -> Vec<u5> {
(&self.serialize()[..]).to_base32()
}
}
impl ToBase32<Vec<u5>> for ExpiryTime {
fn to_base32(&self) -> Vec<u5> {
encode_int_be_base32(self.as_seconds())
}
}
impl ToBase32<Vec<u5>> for MinFinalCltvExpiry {
fn to_base32(&self) -> Vec<u5> {
encode_int_be_base32(self.0)
}
}
impl ToBase32<Vec<u5>> for Fallback {
fn to_base32(&self) -> Vec<u5> {
match *self {
Fallback::SegWitProgram {version: v, program: ref p} => {
let mut data = Vec::<u5>::with_capacity(1);
data.push(v);
data.extend_from_slice(&p.to_base32());
data
},
Fallback::PubKeyHash(ref hash) => {
let mut data = Vec::<u5>::with_capacity(1 + 32);
data.push(u5::try_from_u8(17).unwrap());
data.extend_from_slice(&hash.to_base32());
data
},
Fallback::ScriptHash(ref hash) => {
let mut data = Vec::<u5>::with_capacity(1 + 32);
data.push(u5::try_from_u8(18).unwrap());
data.extend_from_slice(&hash.to_base32());
data
}
}
}
}
impl ToBase32<Vec<u5>> for Route {
fn to_base32(&self) -> Vec<u5> {
let mut bytes = Vec::<u8>::new();
for hop in self.iter() {
bytes.extend_from_slice(&hop.pubkey.serialize()[..]);
bytes.extend_from_slice(&hop.short_channel_id[..]);
let fee_base_msat = try_stretch(
encode_int_be_base256(hop.fee_base_msat),
4
).expect("sizeof(u32) == 4");
bytes.extend_from_slice(&fee_base_msat);
let fee_proportional_millionths = try_stretch(
encode_int_be_base256(hop.fee_proportional_millionths),
4
).expect("sizeof(u32) == 4");
bytes.extend_from_slice(&fee_proportional_millionths);
let cltv_expiry_delta = try_stretch(
encode_int_be_base256(hop.cltv_expiry_delta),
2
).expect("sizeof(u16) == 2");
bytes.extend_from_slice(&cltv_expiry_delta);
}
assert_eq!(
bytes.len() % 51,
0,
"One hop is 51 bytes long, so all hops should be a multiple of that long."
);
bytes.to_base32()
}
}
impl ToBase32<Vec<u5>> for TaggedField {
fn to_base32(&self) -> Vec<u5> {
let (tag, data) = match *self {
TaggedField::PaymentHash(ref hash) => {
(constants::TAG_PAYMENT_HASH, hash.to_base32())
},
TaggedField::Description(ref description) => {
(constants::TAG_DESCRIPTION, description.to_base32())
},
TaggedField::PayeePubKey(ref pub_key) => {
(constants::TAG_PAYEE_PUB_KEY, pub_key.to_base32())
},
TaggedField::DescriptionHash(ref hash) => {
(constants::TAG_DESCRIPTION_HASH, hash.to_base32())
},
TaggedField::ExpiryTime(ref duration) => {
(constants::TAG_EXPIRY_TIME, duration.to_base32())
},
TaggedField::MinFinalCltvExpiry(ref expiry) => {
(constants::TAG_MIN_FINAL_CLTV_EXPIRY, expiry.to_base32())
},
TaggedField::Fallback(ref fallback_address) => {
(constants::TAG_FALLBACK, fallback_address.to_base32())
},
TaggedField::Route(ref route_hops) => {
(constants::TAG_ROUTE, route_hops.to_base32())
},
};
assert!(data.len() < 1024, "Every tagged field data can be at most 1023 bytes long.");
let mut sized_data = Vec::<u5>::with_capacity(data.len() + 3);
sized_data.push(u5::try_from_u8(tag).expect("Tags should be <32."));
sized_data.extend_from_slice(
&try_stretch(
encode_int_be_base32(data.len() as u64),
2
).expect("Can't be longer than 2, see assert above.")
);
sized_data.extend_from_slice(&data);
sized_data
}
}
impl ToBase32<Vec<u5>> for Signature {
fn to_base32(&self) -> Vec<u5> {
let (recovery_id, signature) = self.serialize_compact();
let mut signature_bytes = Vec::<u8>::with_capacity(65);
signature_bytes.extend_from_slice(&signature[..]);
signature_bytes.push(recovery_id.to_i32() as u8);
signature_bytes.to_base32()
}
}
#[cfg(test)]
mod test {
use bech32::CheckBase32;
#[test]
fn test_currency_code() {
use Currency;
assert_eq!("bc", Currency::Bitcoin.to_string());
assert_eq!("tb", Currency::BitcoinTestnet.to_string());
}
#[test]
fn test_raw_hrp() {
use ::{Currency, RawHrp, SiPrefix};
let hrp = RawHrp {
currency: Currency::Bitcoin,
raw_amount: Some(100),
si_prefix: Some(SiPrefix::Micro),
};
assert_eq!(hrp.to_string(), "lnbc100u");
}
#[test]
fn test_encode_int_be_base32() {
use ser::encode_int_be_base32;
let input: u64 = 33764;
let expected_out = CheckBase32::check_base32(&[1, 0, 31, 4]).unwrap();
assert_eq!(expected_out, encode_int_be_base32(input));
}
#[test]
fn test_encode_int_be_base256() {
use ser::encode_int_be_base256;
let input: u64 = 16842530;
let expected_out = vec![1, 0, 255, 34];
assert_eq!(expected_out, encode_int_be_base256(input));
}
}