1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! A very simple serialization framework which is used to serialize/deserialize messages as well
11 //! as [`ChannelManager`]s and [`ChannelMonitor`]s.
13 //! [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
14 //! [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
16 use crate::prelude::*;
17 use crate::io::{self, Read, Seek, Write};
18 use crate::io_extras::{copy, sink};
20 use crate::sync::Mutex;
22 use core::convert::TryFrom;
25 use alloc::collections::BTreeMap;
27 use bitcoin::secp256k1::{PublicKey, SecretKey};
28 use bitcoin::secp256k1::constants::{PUBLIC_KEY_SIZE, SECRET_KEY_SIZE, COMPACT_SIGNATURE_SIZE, SCHNORR_SIGNATURE_SIZE};
29 use bitcoin::secp256k1::ecdsa;
30 use bitcoin::secp256k1::schnorr;
31 use bitcoin::blockdata::constants::ChainHash;
32 use bitcoin::blockdata::script::Script;
33 use bitcoin::blockdata::transaction::{OutPoint, Transaction, TxOut};
34 use bitcoin::consensus;
35 use bitcoin::consensus::Encodable;
36 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
37 use bitcoin::hash_types::{Txid, BlockHash};
38 use core::marker::Sized;
39 use core::time::Duration;
40 use crate::ln::msgs::DecodeError;
41 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
43 use crate::util::byte_utils::{be48_to_array, slice_to_be48};
45 /// serialization buffer size
46 pub const MAX_BUF_SIZE: usize = 64 * 1024;
48 /// A simplified version of [`std::io::Write`] that exists largely for backwards compatibility.
49 /// An impl is provided for any type that also impls [`std::io::Write`].
51 /// (C-not exported) as we only export serialization to/from byte arrays instead
53 /// Writes the given buf out. See std::io::Write::write_all for more
54 fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error>;
57 impl<W: Write> Writer for W {
59 fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error> {
60 <Self as io::Write>::write_all(self, buf)
64 pub(crate) struct WriterWriteAdaptor<'a, W: Writer + 'a>(pub &'a mut W);
65 impl<'a, W: Writer + 'a> Write for WriterWriteAdaptor<'a, W> {
67 fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error> {
71 fn write(&mut self, buf: &[u8]) -> Result<usize, io::Error> {
72 self.0.write_all(buf)?;
76 fn flush(&mut self) -> Result<(), io::Error> {
81 pub(crate) struct VecWriter(pub Vec<u8>);
82 impl Writer for VecWriter {
84 fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error> {
85 self.0.extend_from_slice(buf);
90 /// Writer that only tracks the amount of data written - useful if you need to calculate the length
91 /// of some data when serialized but don't yet need the full data.
92 pub struct LengthCalculatingWriter(pub usize);
93 impl Writer for LengthCalculatingWriter {
95 fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error> {
101 /// Essentially [`std::io::Take`] but a bit simpler and with a method to walk the underlying stream
102 /// forward to ensure we always consume exactly the fixed length specified.
103 pub struct FixedLengthReader<R: Read> {
108 impl<R: Read> FixedLengthReader<R> {
109 /// Returns a new [`FixedLengthReader`].
110 pub fn new(read: R, total_bytes: u64) -> Self {
111 Self { read, bytes_read: 0, total_bytes }
114 /// Returns whether some bytes are remaining or not.
116 pub fn bytes_remain(&mut self) -> bool {
117 self.bytes_read != self.total_bytes
120 /// Consumes the remaining bytes.
122 pub fn eat_remaining(&mut self) -> Result<(), DecodeError> {
123 copy(self, &mut sink()).unwrap();
124 if self.bytes_read != self.total_bytes {
125 Err(DecodeError::ShortRead)
131 impl<R: Read> Read for FixedLengthReader<R> {
133 fn read(&mut self, dest: &mut [u8]) -> Result<usize, io::Error> {
134 if self.total_bytes == self.bytes_read {
137 let read_len = cmp::min(dest.len() as u64, self.total_bytes - self.bytes_read);
138 match self.read.read(&mut dest[0..(read_len as usize)]) {
140 self.bytes_read += v as u64;
149 impl<R: Read> LengthRead for FixedLengthReader<R> {
151 fn total_bytes(&self) -> u64 {
156 /// A [`Read`] implementation which tracks whether any bytes have been read at all. This allows us to distinguish
157 /// between "EOF reached before we started" and "EOF reached mid-read".
158 pub struct ReadTrackingReader<R: Read> {
160 /// Returns whether we have read from this reader or not yet.
163 impl<R: Read> ReadTrackingReader<R> {
164 /// Returns a new [`ReadTrackingReader`].
165 pub fn new(read: R) -> Self {
166 Self { read, have_read: false }
169 impl<R: Read> Read for ReadTrackingReader<R> {
171 fn read(&mut self, dest: &mut [u8]) -> Result<usize, io::Error> {
172 match self.read.read(dest) {
175 self.have_read = true;
183 /// A trait that various LDK types implement allowing them to be written out to a [`Writer`].
185 /// (C-not exported) as we only export serialization to/from byte arrays instead
186 pub trait Writeable {
187 /// Writes `self` out to the given [`Writer`].
188 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error>;
190 /// Writes `self` out to a `Vec<u8>`.
191 fn encode(&self) -> Vec<u8> {
192 let mut msg = VecWriter(Vec::new());
193 self.write(&mut msg).unwrap();
197 /// Writes `self` out to a `Vec<u8>`.
199 fn encode_with_len(&self) -> Vec<u8> {
200 let mut msg = VecWriter(Vec::new());
201 0u16.write(&mut msg).unwrap();
202 self.write(&mut msg).unwrap();
203 let len = msg.0.len();
204 msg.0[..2].copy_from_slice(&(len as u16 - 2).to_be_bytes());
208 /// Gets the length of this object after it has been serialized. This can be overridden to
209 /// optimize cases where we prepend an object with its length.
210 // Note that LLVM optimizes this away in most cases! Check that it isn't before you override!
212 fn serialized_length(&self) -> usize {
213 let mut len_calc = LengthCalculatingWriter(0);
214 self.write(&mut len_calc).expect("No in-memory data may fail to serialize");
219 impl<'a, T: Writeable> Writeable for &'a T {
220 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> { (*self).write(writer) }
223 /// A trait that various LDK types implement allowing them to be read in from a [`Read`].
225 /// (C-not exported) as we only export serialization to/from byte arrays instead
229 /// Reads a `Self` in from the given [`Read`].
230 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError>;
233 /// A trait that various LDK types implement allowing them to be read in from a
234 /// [`Read`]` + `[`Seek`].
235 pub(crate) trait SeekReadable where Self: Sized {
236 /// Reads a `Self` in from the given [`Read`].
237 fn read<R: Read + Seek>(reader: &mut R) -> Result<Self, DecodeError>;
240 /// A trait that various higher-level LDK types implement allowing them to be read in
241 /// from a [`Read`] given some additional set of arguments which is required to deserialize.
243 /// (C-not exported) as we only export serialization to/from byte arrays instead
244 pub trait ReadableArgs<P>
247 /// Reads a `Self` in from the given [`Read`].
248 fn read<R: Read>(reader: &mut R, params: P) -> Result<Self, DecodeError>;
251 /// A [`std::io::Read`] that also provides the total bytes available to be read.
252 pub(crate) trait LengthRead: Read {
253 /// The total number of bytes available to be read.
254 fn total_bytes(&self) -> u64;
257 /// A trait that various higher-level LDK types implement allowing them to be read in
258 /// from a Read given some additional set of arguments which is required to deserialize, requiring
259 /// the implementer to provide the total length of the read.
260 pub(crate) trait LengthReadableArgs<P> where Self: Sized
262 /// Reads a `Self` in from the given [`LengthRead`].
263 fn read<R: LengthRead>(reader: &mut R, params: P) -> Result<Self, DecodeError>;
266 /// A trait that various higher-level LDK types implement allowing them to be read in
267 /// from a [`Read`], requiring the implementer to provide the total length of the read.
268 pub(crate) trait LengthReadable where Self: Sized
270 /// Reads a `Self` in from the given [`LengthRead`].
271 fn read<R: LengthRead>(reader: &mut R) -> Result<Self, DecodeError>;
274 /// A trait that various LDK types implement allowing them to (maybe) be read in from a [`Read`].
276 /// (C-not exported) as we only export serialization to/from byte arrays instead
277 pub trait MaybeReadable
280 /// Reads a `Self` in from the given [`Read`].
281 fn read<R: Read>(reader: &mut R) -> Result<Option<Self>, DecodeError>;
284 impl<T: Readable> MaybeReadable for T {
286 fn read<R: Read>(reader: &mut R) -> Result<Option<T>, DecodeError> {
287 Ok(Some(Readable::read(reader)?))
291 /// Wrapper to read a required (non-optional) TLV record.
292 pub struct RequiredWrapper<T: Readable>(pub Option<T>);
293 impl<T: Readable> Readable for RequiredWrapper<T> {
295 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
296 Ok(Self(Some(Readable::read(reader)?)))
299 /// When handling `default_values`, we want to map the default-value T directly
300 /// to a `RequiredWrapper<T>` in a way that works for `field: T = t;` as
301 /// well. Thus, we assume `Into<T> for T` does nothing and use that.
302 impl<T: Readable> From<T> for RequiredWrapper<T> {
303 fn from(t: T) -> RequiredWrapper<T> { RequiredWrapper(Some(t)) }
306 /// Wrapper to read a required (non-optional) TLV record that may have been upgraded without
307 /// backwards compat.
308 pub struct UpgradableRequired<T: MaybeReadable>(pub Option<T>);
309 impl<T: MaybeReadable> MaybeReadable for UpgradableRequired<T> {
311 fn read<R: Read>(reader: &mut R) -> Result<Option<Self>, DecodeError> {
312 let tlv = MaybeReadable::read(reader)?;
313 if let Some(tlv) = tlv { return Ok(Some(Self(Some(tlv)))) }
318 pub(crate) struct U48(pub u64);
319 impl Writeable for U48 {
321 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
322 writer.write_all(&be48_to_array(self.0))
325 impl Readable for U48 {
327 fn read<R: Read>(reader: &mut R) -> Result<U48, DecodeError> {
328 let mut buf = [0; 6];
329 reader.read_exact(&mut buf)?;
330 Ok(U48(slice_to_be48(&buf)))
334 /// Lightning TLV uses a custom variable-length integer called `BigSize`. It is similar to Bitcoin's
335 /// variable-length integers except that it is serialized in big-endian instead of little-endian.
337 /// Like Bitcoin's variable-length integer, it exhibits ambiguity in that certain values can be
338 /// encoded in several different ways, which we must check for at deserialization-time. Thus, if
339 /// you're looking for an example of a variable-length integer to use for your own project, move
340 /// along, this is a rather poor design.
341 pub struct BigSize(pub u64);
342 impl Writeable for BigSize {
344 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
347 (self.0 as u8).write(writer)
350 0xFDu8.write(writer)?;
351 (self.0 as u16).write(writer)
353 0x10000...0xFFFFFFFF => {
354 0xFEu8.write(writer)?;
355 (self.0 as u32).write(writer)
358 0xFFu8.write(writer)?;
359 (self.0 as u64).write(writer)
364 impl Readable for BigSize {
366 fn read<R: Read>(reader: &mut R) -> Result<BigSize, DecodeError> {
367 let n: u8 = Readable::read(reader)?;
370 let x: u64 = Readable::read(reader)?;
372 Err(DecodeError::InvalidValue)
378 let x: u32 = Readable::read(reader)?;
380 Err(DecodeError::InvalidValue)
382 Ok(BigSize(x as u64))
386 let x: u16 = Readable::read(reader)?;
388 Err(DecodeError::InvalidValue)
390 Ok(BigSize(x as u64))
393 n => Ok(BigSize(n as u64))
398 /// The lightning protocol uses u16s for lengths in most cases. As our serialization framework
399 /// primarily targets that, we must as well. However, because we may serialize objects that have
400 /// more than 65K entries, we need to be able to store larger values. Thus, we define a variable
401 /// length integer here that is backwards-compatible for values < 0xffff. We treat 0xffff as
402 /// "read eight more bytes".
404 /// To ensure we only have one valid encoding per value, we add 0xffff to values written as eight
405 /// bytes. Thus, 0xfffe is serialized as 0xfffe, whereas 0xffff is serialized as
406 /// 0xffff0000000000000000 (i.e. read-eight-bytes then zero).
407 struct CollectionLength(pub u64);
408 impl Writeable for CollectionLength {
410 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
412 (self.0 as u16).write(writer)
414 0xffffu16.write(writer)?;
415 (self.0 - 0xffff).write(writer)
420 impl Readable for CollectionLength {
422 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
423 let mut val: u64 = <u16 as Readable>::read(r)? as u64;
425 val = <u64 as Readable>::read(r)?
426 .checked_add(0xffff).ok_or(DecodeError::InvalidValue)?;
428 Ok(CollectionLength(val))
432 /// In TLV we occasionally send fields which only consist of, or potentially end with, a
433 /// variable-length integer which is simply truncated by skipping high zero bytes. This type
434 /// encapsulates such integers implementing [`Readable`]/[`Writeable`] for them.
435 #[cfg_attr(test, derive(PartialEq, Eq, Debug))]
436 pub(crate) struct HighZeroBytesDroppedBigSize<T>(pub T);
438 macro_rules! impl_writeable_primitive {
439 ($val_type:ty, $len: expr) => {
440 impl Writeable for $val_type {
442 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
443 writer.write_all(&self.to_be_bytes())
446 impl Writeable for HighZeroBytesDroppedBigSize<$val_type> {
448 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
449 // Skip any full leading 0 bytes when writing (in BE):
450 writer.write_all(&self.0.to_be_bytes()[(self.0.leading_zeros()/8) as usize..$len])
453 impl Readable for $val_type {
455 fn read<R: Read>(reader: &mut R) -> Result<$val_type, DecodeError> {
456 let mut buf = [0; $len];
457 reader.read_exact(&mut buf)?;
458 Ok(<$val_type>::from_be_bytes(buf))
461 impl Readable for HighZeroBytesDroppedBigSize<$val_type> {
463 fn read<R: Read>(reader: &mut R) -> Result<HighZeroBytesDroppedBigSize<$val_type>, DecodeError> {
464 // We need to accept short reads (read_len == 0) as "EOF" and handle them as simply
465 // the high bytes being dropped. To do so, we start reading into the middle of buf
466 // and then convert the appropriate number of bytes with extra high bytes out of
468 let mut buf = [0; $len*2];
469 let mut read_len = reader.read(&mut buf[$len..])?;
470 let mut total_read_len = read_len;
471 while read_len != 0 && total_read_len != $len {
472 read_len = reader.read(&mut buf[($len + total_read_len)..])?;
473 total_read_len += read_len;
475 if total_read_len == 0 || buf[$len] != 0 {
476 let first_byte = $len - ($len - total_read_len);
477 let mut bytes = [0; $len];
478 bytes.copy_from_slice(&buf[first_byte..first_byte + $len]);
479 Ok(HighZeroBytesDroppedBigSize(<$val_type>::from_be_bytes(bytes)))
481 // If the encoding had extra zero bytes, return a failure even though we know
482 // what they meant (as the TLV test vectors require this)
483 Err(DecodeError::InvalidValue)
487 impl From<$val_type> for HighZeroBytesDroppedBigSize<$val_type> {
488 fn from(val: $val_type) -> Self { Self(val) }
493 impl_writeable_primitive!(u128, 16);
494 impl_writeable_primitive!(u64, 8);
495 impl_writeable_primitive!(u32, 4);
496 impl_writeable_primitive!(u16, 2);
498 impl Writeable for u8 {
500 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
501 writer.write_all(&[*self])
504 impl Readable for u8 {
506 fn read<R: Read>(reader: &mut R) -> Result<u8, DecodeError> {
507 let mut buf = [0; 1];
508 reader.read_exact(&mut buf)?;
513 impl Writeable for bool {
515 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
516 writer.write_all(&[if *self {1} else {0}])
519 impl Readable for bool {
521 fn read<R: Read>(reader: &mut R) -> Result<bool, DecodeError> {
522 let mut buf = [0; 1];
523 reader.read_exact(&mut buf)?;
524 if buf[0] != 0 && buf[0] != 1 {
525 return Err(DecodeError::InvalidValue);
532 macro_rules! impl_array {
534 impl Writeable for [u8; $size]
537 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
542 impl Readable for [u8; $size]
545 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
546 let mut buf = [0u8; $size];
547 r.read_exact(&mut buf)?;
554 impl_array!(3); // for rgb, ISO 4712 code
555 impl_array!(4); // for IPv4
556 impl_array!(12); // for OnionV2
557 impl_array!(16); // for IPv6
558 impl_array!(32); // for channel id & hmac
559 impl_array!(PUBLIC_KEY_SIZE); // for PublicKey
560 impl_array!(64); // for ecdsa::Signature and schnorr::Signature
561 impl_array!(1300); // for OnionPacket.hop_data
563 impl Writeable for [u16; 8] {
565 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
566 for v in self.iter() {
567 w.write_all(&v.to_be_bytes())?
573 impl Readable for [u16; 8] {
575 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
576 let mut buf = [0u8; 16];
577 r.read_exact(&mut buf)?;
578 let mut res = [0u16; 8];
579 for (idx, v) in res.iter_mut().enumerate() {
580 *v = (buf[idx] as u16) << 8 | (buf[idx + 1] as u16)
586 /// A type for variable-length values within TLV record where the length is encoded as part of the record.
587 /// Used to prevent encoding the length twice.
588 pub struct WithoutLength<T>(pub T);
590 impl Writeable for WithoutLength<&String> {
592 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
593 w.write_all(self.0.as_bytes())
596 impl Readable for WithoutLength<String> {
598 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
599 let v: WithoutLength<Vec<u8>> = Readable::read(r)?;
600 Ok(Self(String::from_utf8(v.0).map_err(|_| DecodeError::InvalidValue)?))
603 impl<'a> From<&'a String> for WithoutLength<&'a String> {
604 fn from(s: &'a String) -> Self { Self(s) }
607 impl<'a, T: Writeable> Writeable for WithoutLength<&'a Vec<T>> {
609 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
610 for ref v in self.0.iter() {
617 impl<T: MaybeReadable> Readable for WithoutLength<Vec<T>> {
619 fn read<R: Read>(mut reader: &mut R) -> Result<Self, DecodeError> {
620 let mut values = Vec::new();
622 let mut track_read = ReadTrackingReader::new(&mut reader);
623 match MaybeReadable::read(&mut track_read) {
624 Ok(Some(v)) => { values.push(v); },
626 // If we failed to read any bytes at all, we reached the end of our TLV
627 // stream and have simply exhausted all entries.
628 Err(ref e) if e == &DecodeError::ShortRead && !track_read.have_read => break,
629 Err(e) => return Err(e),
635 impl<'a, T> From<&'a Vec<T>> for WithoutLength<&'a Vec<T>> {
636 fn from(v: &'a Vec<T>) -> Self { Self(v) }
640 pub(crate) struct Iterable<'a, I: Iterator<Item = &'a T> + Clone, T: 'a>(pub I);
642 impl<'a, I: Iterator<Item = &'a T> + Clone, T: 'a + Writeable> Writeable for Iterable<'a, I, T> {
644 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
645 for ref v in self.0.clone() {
653 impl<'a, I: Iterator<Item = &'a T> + Clone, T: 'a + PartialEq> PartialEq for Iterable<'a, I, T> {
654 fn eq(&self, other: &Self) -> bool {
655 self.0.clone().collect::<Vec<_>>() == other.0.clone().collect::<Vec<_>>()
659 macro_rules! impl_for_map {
660 ($ty: ident, $keybound: ident, $constr: expr) => {
661 impl<K, V> Writeable for $ty<K, V>
662 where K: Writeable + Eq + $keybound, V: Writeable
665 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
666 CollectionLength(self.len() as u64).write(w)?;
667 for (key, value) in self.iter() {
675 impl<K, V> Readable for $ty<K, V>
676 where K: Readable + Eq + $keybound, V: MaybeReadable
679 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
680 let len: CollectionLength = Readable::read(r)?;
681 let mut ret = $constr(len.0 as usize);
684 let v_opt = V::read(r)?;
685 if let Some(v) = v_opt {
686 if ret.insert(k, v).is_some() {
687 return Err(DecodeError::InvalidValue);
697 impl_for_map!(BTreeMap, Ord, |_| BTreeMap::new());
698 impl_for_map!(HashMap, Hash, |len| HashMap::with_capacity(len));
701 impl<T> Writeable for HashSet<T>
702 where T: Writeable + Eq + Hash
705 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
706 CollectionLength(self.len() as u64).write(w)?;
707 for item in self.iter() {
714 impl<T> Readable for HashSet<T>
715 where T: Readable + Eq + Hash
718 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
719 let len: CollectionLength = Readable::read(r)?;
720 let mut ret = HashSet::with_capacity(cmp::min(len.0 as usize, MAX_BUF_SIZE / core::mem::size_of::<T>()));
722 if !ret.insert(T::read(r)?) {
723 return Err(DecodeError::InvalidValue)
731 macro_rules! impl_for_vec {
732 ($ty: ty $(, $name: ident)*) => {
733 impl<$($name : Writeable),*> Writeable for Vec<$ty> {
735 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
736 CollectionLength(self.len() as u64).write(w)?;
737 for elem in self.iter() {
744 impl<$($name : Readable),*> Readable for Vec<$ty> {
746 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
747 let len: CollectionLength = Readable::read(r)?;
748 let mut ret = Vec::with_capacity(cmp::min(len.0 as usize, MAX_BUF_SIZE / core::mem::size_of::<$ty>()));
750 if let Some(val) = MaybeReadable::read(r)? {
760 impl Writeable for Vec<u8> {
762 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
763 CollectionLength(self.len() as u64).write(w)?;
768 impl Readable for Vec<u8> {
770 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
771 let mut len: CollectionLength = Readable::read(r)?;
772 let mut ret = Vec::new();
774 let readamt = cmp::min(len.0 as usize, MAX_BUF_SIZE);
775 let readstart = ret.len();
776 ret.resize(readstart + readamt, 0);
777 r.read_exact(&mut ret[readstart..])?;
778 len.0 -= readamt as u64;
784 impl_for_vec!(ecdsa::Signature);
785 impl_for_vec!(crate::ln::channelmanager::MonitorUpdateCompletionAction);
786 impl_for_vec!((A, B), A, B);
788 impl Writeable for Script {
789 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
790 (self.len() as u16).write(w)?;
791 w.write_all(self.as_bytes())
795 impl Readable for Script {
796 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
797 let len = <u16 as Readable>::read(r)? as usize;
798 let mut buf = vec![0; len];
799 r.read_exact(&mut buf)?;
800 Ok(Script::from(buf))
804 impl Writeable for PublicKey {
805 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
806 self.serialize().write(w)
809 fn serialized_length(&self) -> usize {
814 impl Readable for PublicKey {
815 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
816 let buf: [u8; PUBLIC_KEY_SIZE] = Readable::read(r)?;
817 match PublicKey::from_slice(&buf) {
819 Err(_) => return Err(DecodeError::InvalidValue),
824 impl Writeable for SecretKey {
825 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
826 let mut ser = [0; SECRET_KEY_SIZE];
827 ser.copy_from_slice(&self[..]);
831 fn serialized_length(&self) -> usize {
836 impl Readable for SecretKey {
837 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
838 let buf: [u8; SECRET_KEY_SIZE] = Readable::read(r)?;
839 match SecretKey::from_slice(&buf) {
841 Err(_) => return Err(DecodeError::InvalidValue),
846 impl Writeable for Sha256dHash {
847 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
848 w.write_all(&self[..])
852 impl Readable for Sha256dHash {
853 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
854 use bitcoin::hashes::Hash;
856 let buf: [u8; 32] = Readable::read(r)?;
857 Ok(Sha256dHash::from_slice(&buf[..]).unwrap())
861 impl Writeable for ecdsa::Signature {
862 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
863 self.serialize_compact().write(w)
867 impl Readable for ecdsa::Signature {
868 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
869 let buf: [u8; COMPACT_SIGNATURE_SIZE] = Readable::read(r)?;
870 match ecdsa::Signature::from_compact(&buf) {
872 Err(_) => return Err(DecodeError::InvalidValue),
877 impl Writeable for schnorr::Signature {
878 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
879 self.as_ref().write(w)
883 impl Readable for schnorr::Signature {
884 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
885 let buf: [u8; SCHNORR_SIGNATURE_SIZE] = Readable::read(r)?;
886 match schnorr::Signature::from_slice(&buf) {
888 Err(_) => return Err(DecodeError::InvalidValue),
893 impl Writeable for PaymentPreimage {
894 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
899 impl Readable for PaymentPreimage {
900 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
901 let buf: [u8; 32] = Readable::read(r)?;
902 Ok(PaymentPreimage(buf))
906 impl Writeable for PaymentHash {
907 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
912 impl Readable for PaymentHash {
913 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
914 let buf: [u8; 32] = Readable::read(r)?;
919 impl Writeable for PaymentSecret {
920 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
925 impl Readable for PaymentSecret {
926 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
927 let buf: [u8; 32] = Readable::read(r)?;
928 Ok(PaymentSecret(buf))
932 impl<T: Writeable> Writeable for Box<T> {
933 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
938 impl<T: Readable> Readable for Box<T> {
939 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
940 Ok(Box::new(Readable::read(r)?))
944 impl<T: Writeable> Writeable for Option<T> {
945 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
947 None => 0u8.write(w)?,
949 BigSize(data.serialized_length() as u64 + 1).write(w)?;
957 impl<T: Readable> Readable for Option<T>
959 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
960 let len: BigSize = Readable::read(r)?;
964 let mut reader = FixedLengthReader::new(r, len - 1);
965 Ok(Some(Readable::read(&mut reader)?))
971 impl Writeable for Txid {
972 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
973 w.write_all(&self[..])
977 impl Readable for Txid {
978 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
979 use bitcoin::hashes::Hash;
981 let buf: [u8; 32] = Readable::read(r)?;
982 Ok(Txid::from_slice(&buf[..]).unwrap())
986 impl Writeable for BlockHash {
987 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
988 w.write_all(&self[..])
992 impl Readable for BlockHash {
993 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
994 use bitcoin::hashes::Hash;
996 let buf: [u8; 32] = Readable::read(r)?;
997 Ok(BlockHash::from_slice(&buf[..]).unwrap())
1001 impl Writeable for ChainHash {
1002 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1003 w.write_all(self.as_bytes())
1007 impl Readable for ChainHash {
1008 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1009 let buf: [u8; 32] = Readable::read(r)?;
1010 Ok(ChainHash::from(&buf[..]))
1014 impl Writeable for OutPoint {
1015 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1016 self.txid.write(w)?;
1017 self.vout.write(w)?;
1022 impl Readable for OutPoint {
1023 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1024 let txid = Readable::read(r)?;
1025 let vout = Readable::read(r)?;
1033 macro_rules! impl_consensus_ser {
1034 ($bitcoin_type: ty) => {
1035 impl Writeable for $bitcoin_type {
1036 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1037 match self.consensus_encode(&mut WriterWriteAdaptor(writer)) {
1044 impl Readable for $bitcoin_type {
1045 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1046 match consensus::encode::Decodable::consensus_decode(r) {
1048 Err(consensus::encode::Error::Io(ref e)) if e.kind() == io::ErrorKind::UnexpectedEof => Err(DecodeError::ShortRead),
1049 Err(consensus::encode::Error::Io(e)) => Err(DecodeError::Io(e.kind())),
1050 Err(_) => Err(DecodeError::InvalidValue),
1056 impl_consensus_ser!(Transaction);
1057 impl_consensus_ser!(TxOut);
1059 impl<T: Readable> Readable for Mutex<T> {
1060 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1061 let t: T = Readable::read(r)?;
1065 impl<T: Writeable> Writeable for Mutex<T> {
1066 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1067 self.lock().unwrap().write(w)
1071 impl<A: Readable, B: Readable> Readable for (A, B) {
1072 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1073 let a: A = Readable::read(r)?;
1074 let b: B = Readable::read(r)?;
1078 impl<A: Writeable, B: Writeable> Writeable for (A, B) {
1079 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1085 impl<A: Readable, B: Readable, C: Readable> Readable for (A, B, C) {
1086 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1087 let a: A = Readable::read(r)?;
1088 let b: B = Readable::read(r)?;
1089 let c: C = Readable::read(r)?;
1093 impl<A: Writeable, B: Writeable, C: Writeable> Writeable for (A, B, C) {
1094 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1101 impl<A: Readable, B: Readable, C: Readable, D: Readable> Readable for (A, B, C, D) {
1102 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1103 let a: A = Readable::read(r)?;
1104 let b: B = Readable::read(r)?;
1105 let c: C = Readable::read(r)?;
1106 let d: D = Readable::read(r)?;
1110 impl<A: Writeable, B: Writeable, C: Writeable, D: Writeable> Writeable for (A, B, C, D) {
1111 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1119 impl Writeable for () {
1120 fn write<W: Writer>(&self, _: &mut W) -> Result<(), io::Error> {
1124 impl Readable for () {
1125 fn read<R: Read>(_r: &mut R) -> Result<Self, DecodeError> {
1130 impl Writeable for String {
1132 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1133 CollectionLength(self.len() as u64).write(w)?;
1134 w.write_all(self.as_bytes())
1137 impl Readable for String {
1139 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1140 let v: Vec<u8> = Readable::read(r)?;
1141 let ret = String::from_utf8(v).map_err(|_| DecodeError::InvalidValue)?;
1146 /// Represents a hostname for serialization purposes.
1147 /// Only the character set and length will be validated.
1148 /// The character set consists of ASCII alphanumeric characters, hyphens, and periods.
1149 /// Its length is guaranteed to be representable by a single byte.
1150 /// This serialization is used by [`BOLT 7`] hostnames.
1152 /// [`BOLT 7`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md
1153 #[derive(Clone, Debug, PartialEq, Eq)]
1154 pub struct Hostname(String);
1156 /// Returns the length of the hostname.
1157 pub fn len(&self) -> u8 {
1158 (&self.0).len() as u8
1161 impl Deref for Hostname {
1162 type Target = String;
1164 fn deref(&self) -> &Self::Target {
1168 impl From<Hostname> for String {
1169 fn from(hostname: Hostname) -> Self {
1173 impl TryFrom<Vec<u8>> for Hostname {
1176 fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
1177 if let Ok(s) = String::from_utf8(bytes) {
1178 Hostname::try_from(s)
1184 impl TryFrom<String> for Hostname {
1187 fn try_from(s: String) -> Result<Self, Self::Error> {
1188 if s.len() <= 255 && s.chars().all(|c|
1189 c.is_ascii_alphanumeric() ||
1199 impl Writeable for Hostname {
1201 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1202 self.len().write(w)?;
1203 w.write_all(self.as_bytes())
1206 impl Readable for Hostname {
1208 fn read<R: Read>(r: &mut R) -> Result<Hostname, DecodeError> {
1209 let len: u8 = Readable::read(r)?;
1210 let mut vec = Vec::with_capacity(len.into());
1211 vec.resize(len.into(), 0);
1212 r.read_exact(&mut vec)?;
1213 Hostname::try_from(vec).map_err(|_| DecodeError::InvalidValue)
1217 impl Writeable for Duration {
1219 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1220 self.as_secs().write(w)?;
1221 self.subsec_nanos().write(w)
1224 impl Readable for Duration {
1226 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1227 let secs = Readable::read(r)?;
1228 let nanos = Readable::read(r)?;
1229 Ok(Duration::new(secs, nanos))
1235 use core::convert::TryFrom;
1236 use crate::util::ser::{Readable, Hostname, Writeable};
1239 fn hostname_conversion() {
1240 assert_eq!(Hostname::try_from(String::from("a-test.com")).unwrap().as_str(), "a-test.com");
1242 assert!(Hostname::try_from(String::from("\"")).is_err());
1243 assert!(Hostname::try_from(String::from("$")).is_err());
1244 assert!(Hostname::try_from(String::from("⚡")).is_err());
1245 let mut large_vec = Vec::with_capacity(256);
1246 large_vec.resize(256, b'A');
1247 assert!(Hostname::try_from(String::from_utf8(large_vec).unwrap()).is_err());
1251 fn hostname_serialization() {
1252 let hostname = Hostname::try_from(String::from("test")).unwrap();
1253 let mut buf: Vec<u8> = Vec::new();
1254 hostname.write(&mut buf).unwrap();
1255 assert_eq!(Hostname::read(&mut buf.as_slice()).unwrap().as_str(), "test");