2 use std::fmt::{Display, Formatter};
3 use bech32::{ToBase32, u5, WriteBase32, Base32Len};
7 /// Converts a stream of bytes written to it to base32. On finalization the according padding will
8 /// be applied. That means the results of writing two data blocks with one or two `BytesToBase32`
9 /// converters will differ.
10 struct BytesToBase32<'a, W: WriteBase32 + 'a> {
11 /// Target for writing the resulting `u5`s resulting from the written bytes
13 /// Holds all unwritten bits left over from last round. The bits are stored beginning from
14 /// the most significant bit. E.g. if buffer_bits=3, then the byte with bits a, b and c will
15 /// look as follows: [a, b, c, 0, 0, 0, 0, 0]
17 /// Amount of bits left over from last round, stored in buffer.
21 impl<'a, W: WriteBase32> BytesToBase32<'a, W> {
22 /// Create a new bytes-to-base32 converter with `writer` as a sink for the resulting base32
24 pub fn new(writer: &'a mut W) -> BytesToBase32<'a, W> {
32 /// Add more bytes to the current conversion unit
33 pub fn append(&mut self, bytes: &[u8]) -> Result<(), W::Err> {
40 pub fn append_u8(&mut self, byte: u8) -> Result<(), W::Err> {
41 // Write first u5 if we have to write two u5s this round. That only happens if the
42 // buffer holds too many bits, so we don't have to combine buffer bits with new bits
43 // from this rounds byte.
44 if self.buffer_bits >= 5 {
46 u5::try_from_u8((self.buffer & 0b11111000) >> 3 ).expect("<32")
48 self.buffer = self.buffer << 5;
49 self.buffer_bits -= 5;
52 // Combine all bits from buffer with enough bits from this rounds byte so that they fill
53 // a u5. Save reamining bits from byte to buffer.
54 let from_buffer = self.buffer >> 3;
55 let from_byte = byte >> (3 + self.buffer_bits); // buffer_bits <= 4
57 self.writer.write_u5(u5::try_from_u8(from_buffer | from_byte).expect("<32"))?;
58 self.buffer = byte << (5 - self.buffer_bits);
59 self.buffer_bits = 3 + self.buffer_bits;
64 pub fn finalize(mut self) -> Result<(), W::Err> {
65 self.inner_finalize()?;
66 std::mem::forget(self);
70 fn inner_finalize(&mut self) -> Result<(), W::Err>{
71 // There can be at most two u5s left in the buffer after processing all bytes, write them.
72 if self.buffer_bits >= 5 {
74 u5::try_from_u8((self.buffer & 0b11111000) >> 3).expect("<32")
76 self.buffer = self.buffer << 5;
77 self.buffer_bits -= 5;
80 if self.buffer_bits != 0 {
81 self.writer.write_u5(u5::try_from_u8(self.buffer >> 3).expect("<32"))?;
88 impl<'a, W: WriteBase32> Drop for BytesToBase32<'a, W> {
91 .expect("Unhandled error when finalizing conversion on drop. User finalize to handle.")
95 /// Calculates the base32 encoded size of a byte slice
96 fn bytes_size_to_base32_size(byte_size: usize) -> usize {
97 let bits = byte_size * 8;
99 // without padding bits
107 impl Display for Invoice {
108 fn fmt(&self, f: &mut Formatter) -> Result<(), fmt::Error> {
109 self.signed_invoice.fmt(f)
113 impl Display for SignedRawInvoice {
114 fn fmt(&self, f: &mut Formatter) -> Result<(), fmt::Error> {
115 let hrp = self.raw_invoice.hrp.to_string();
116 let mut data = self.raw_invoice.data.to_base32();
117 data.extend_from_slice(&self.signature.to_base32());
119 bech32::encode_to_fmt(f, &hrp, data).expect("HRP is valid")?;
125 impl Display for RawHrp {
126 fn fmt(&self, f: &mut Formatter) -> Result<(), fmt::Error> {
127 let amount = match self.raw_amount {
128 Some(ref amt) => amt.to_string(),
129 None => String::new(),
132 let si_prefix = match self.si_prefix {
133 Some(ref si) => si.to_string(),
134 None => String::new(),
147 impl Display for Currency {
148 fn fmt(&self, f: &mut Formatter) -> Result<(), fmt::Error> {
149 let currency_code = match *self {
150 Currency::Bitcoin => "bc",
151 Currency::BitcoinTestnet => "tb",
152 Currency::Regtest => "bcrt",
153 Currency::Simnet => "sb",
155 write!(f, "{}", currency_code)
159 impl Display for SiPrefix {
160 fn fmt(&self, f: &mut Formatter) -> Result<(), fmt::Error> {
163 SiPrefix::Milli => "m",
164 SiPrefix::Micro => "u",
165 SiPrefix::Nano => "n",
166 SiPrefix::Pico => "p",
172 fn encode_int_be_base32(int: u64) -> Vec<u5> {
175 let mut out_vec = Vec::<u5>::new();
177 let mut rem_int = int;
179 out_vec.push(u5::try_from_u8((rem_int % base) as u8).expect("always <32"));
187 fn encoded_int_be_base32_size(int: u64) -> usize {
188 for pos in (0..13).rev() {
189 if int & (0x1f << (5 * pos)) != 0 {
190 return (pos + 1) as usize;
196 fn encode_int_be_base256<T: Into<u64>>(int: T) -> Vec<u8> {
199 let mut out_vec = Vec::<u8>::new();
201 let mut rem_int: u64 = int.into();
203 out_vec.push((rem_int % base) as u8);
211 /// Appends the default value of `T` to the front of the `in_vec` till it reaches the length
212 /// `target_length`. If `in_vec` already is too lang `None` is returned.
213 fn try_stretch<T>(mut in_vec: Vec<T>, target_len: usize) -> Option<Vec<T>>
214 where T: Default + Copy
216 if in_vec.len() > target_len {
218 } else if in_vec.len() == target_len {
221 let mut out_vec = Vec::<T>::with_capacity(target_len);
222 out_vec.append(&mut vec![T::default(); target_len - in_vec.len()]);
223 out_vec.append(&mut in_vec);
228 impl ToBase32 for RawDataPart {
229 fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
231 self.timestamp.write_base32(writer)?;
233 // encode tagged fields
234 for tagged_field in self.tagged_fields.iter() {
235 tagged_field.write_base32(writer)?;
242 impl ToBase32 for PositiveTimestamp {
243 fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
244 // FIXME: use writer for int encoding
246 &try_stretch(encode_int_be_base32(self.as_unix_timestamp()), 7)
247 .expect("Can't be longer due than 7 u5s due to timestamp bounds")
252 impl ToBase32 for RawTaggedField {
253 fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
255 RawTaggedField::UnknownSemantics(ref content) => {
256 writer.write(content)
258 RawTaggedField::KnownSemantics(ref tagged_field) => {
259 tagged_field.write_base32(writer)
265 impl ToBase32 for Sha256 {
266 fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
267 (&self.0[..]).write_base32(writer)
270 impl Base32Len for Sha256 {
271 fn base32_len(&self) -> usize {
272 (&self.0[..]).base32_len()
276 impl ToBase32 for Description {
277 fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
278 self.as_bytes().write_base32(writer)
282 impl Base32Len for Description {
283 fn base32_len(&self) -> usize {
284 self.0.as_bytes().base32_len()
288 impl ToBase32 for PayeePubKey {
289 fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
290 (&self.serialize()[..]).write_base32(writer)
294 impl Base32Len for PayeePubKey {
295 fn base32_len(&self) -> usize {
296 bytes_size_to_base32_size(secp256k1::constants::PUBLIC_KEY_SIZE)
300 impl ToBase32 for PaymentSecret {
301 fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
302 (&self.0[..]).write_base32(writer)
306 impl Base32Len for PaymentSecret {
307 fn base32_len(&self) -> usize {
308 bytes_size_to_base32_size(32)
312 impl ToBase32 for ExpiryTime {
313 fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
314 writer.write(&encode_int_be_base32(self.as_seconds()))
318 impl Base32Len for ExpiryTime {
319 fn base32_len(&self) -> usize {
320 encoded_int_be_base32_size(self.0.as_secs())
324 impl ToBase32 for MinFinalCltvExpiry {
325 fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
326 writer.write(&encode_int_be_base32(self.0))
330 impl Base32Len for MinFinalCltvExpiry {
331 fn base32_len(&self) -> usize {
332 encoded_int_be_base32_size(self.0)
336 impl ToBase32 for Fallback {
337 fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
339 Fallback::SegWitProgram {version: v, program: ref p} => {
341 p.write_base32(writer)
343 Fallback::PubKeyHash(ref hash) => {
344 writer.write_u5(u5::try_from_u8(17).expect("17 < 32"))?;
345 (&hash[..]).write_base32(writer)
347 Fallback::ScriptHash(ref hash) => {
348 writer.write_u5(u5::try_from_u8(18).expect("18 < 32"))?;
349 (&hash[..]).write_base32(writer)
355 impl Base32Len for Fallback {
356 fn base32_len(&self) -> usize {
358 Fallback::SegWitProgram {program: ref p, ..} => {
359 bytes_size_to_base32_size(p.len()) + 1
361 Fallback::PubKeyHash(_) | Fallback::ScriptHash(_) => {
368 impl ToBase32 for RouteHint {
369 fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
370 let mut converter = BytesToBase32::new(writer);
372 for hop in self.iter() {
373 converter.append(&hop.src_node_id.serialize()[..])?;
374 let short_channel_id = try_stretch(
375 encode_int_be_base256(hop.short_channel_id),
377 ).expect("sizeof(u64) == 8");
378 converter.append(&short_channel_id)?;
380 let fee_base_msat = try_stretch(
381 encode_int_be_base256(hop.fees.base_msat),
383 ).expect("sizeof(u32) == 4");
384 converter.append(&fee_base_msat)?;
386 let fee_proportional_millionths = try_stretch(
387 encode_int_be_base256(hop.fees.proportional_millionths),
389 ).expect("sizeof(u32) == 4");
390 converter.append(&fee_proportional_millionths)?;
392 let cltv_expiry_delta = try_stretch(
393 encode_int_be_base256(hop.cltv_expiry_delta),
395 ).expect("sizeof(u16) == 2");
396 converter.append(&cltv_expiry_delta)?;
399 converter.finalize()?;
404 impl Base32Len for RouteHint {
405 fn base32_len(&self) -> usize {
406 bytes_size_to_base32_size(self.0.len() * 51)
410 impl ToBase32 for TaggedField {
411 fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
412 /// Writes a tagged field: tag, length and data. `tag` should be in `0..32` otherwise the
413 /// function will panic.
414 fn write_tagged_field<W, P>(writer: &mut W, tag: u8, payload: &P) -> Result<(), W::Err>
415 where W: WriteBase32,
416 P: ToBase32 + Base32Len,
418 let len = payload.base32_len();
419 assert!(len < 1024, "Every tagged field data can be at most 1023 bytes long.");
421 writer.write_u5(u5::try_from_u8(tag).expect("invalid tag, not in 0..32"))?;
422 writer.write(&try_stretch(
423 encode_int_be_base32(len as u64),
425 ).expect("Can't be longer than 2, see assert above."))?;
426 payload.write_base32(writer)
430 TaggedField::PaymentHash(ref hash) => {
431 write_tagged_field(writer, constants::TAG_PAYMENT_HASH, hash)
433 TaggedField::Description(ref description) => {
434 write_tagged_field(writer, constants::TAG_DESCRIPTION, description)
436 TaggedField::PayeePubKey(ref pub_key) => {
437 write_tagged_field(writer, constants::TAG_PAYEE_PUB_KEY, pub_key)
439 TaggedField::DescriptionHash(ref hash) => {
440 write_tagged_field(writer, constants::TAG_DESCRIPTION_HASH, hash)
442 TaggedField::ExpiryTime(ref duration) => {
443 write_tagged_field(writer, constants::TAG_EXPIRY_TIME, duration)
445 TaggedField::MinFinalCltvExpiry(ref expiry) => {
446 write_tagged_field(writer, constants::TAG_MIN_FINAL_CLTV_EXPIRY, expiry)
448 TaggedField::Fallback(ref fallback_address) => {
449 write_tagged_field(writer, constants::TAG_FALLBACK, fallback_address)
451 TaggedField::Route(ref route_hops) => {
452 write_tagged_field(writer, constants::TAG_ROUTE, route_hops)
454 TaggedField::PaymentSecret(ref payment_secret) => {
455 write_tagged_field(writer, constants::TAG_PAYMENT_SECRET, payment_secret)
457 TaggedField::Features(ref features) => {
458 write_tagged_field(writer, constants::TAG_FEATURES, features)
464 impl ToBase32 for Signature {
465 fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
466 let mut converter = BytesToBase32::new(writer);
467 let (recovery_id, signature) = self.0.serialize_compact();
468 converter.append(&signature[..])?;
469 converter.append_u8(recovery_id.to_i32() as u8)?;
476 use bech32::CheckBase32;
479 fn test_currency_code() {
482 assert_eq!("bc", Currency::Bitcoin.to_string());
483 assert_eq!("tb", Currency::BitcoinTestnet.to_string());
484 assert_eq!("bcrt", Currency::Regtest.to_string());
485 assert_eq!("sb", Currency::Simnet.to_string());
490 use ::{Currency, RawHrp, SiPrefix};
493 currency: Currency::Bitcoin,
494 raw_amount: Some(100),
495 si_prefix: Some(SiPrefix::Micro),
498 assert_eq!(hrp.to_string(), "lnbc100u");
502 fn test_encode_int_be_base32() {
503 use ser::encode_int_be_base32;
505 let input: u64 = 33764;
506 let expected_out = CheckBase32::check_base32(&[1, 0, 31, 4]).unwrap();
508 assert_eq!(expected_out, encode_int_be_base32(input));
512 fn test_encode_int_be_base256() {
513 use ser::encode_int_be_base256;
515 let input: u64 = 16842530;
516 let expected_out = vec![1, 0, 255, 34];
518 assert_eq!(expected_out, encode_int_be_base256(input));