_ Git - rust-lightning/blob - lightning/src/util/ser.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   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
   8 // licenses.
   9
  10 //! A very simple serialization framework which is used to serialize/deserialize messages as well
  11 //! as ChannelsManagers and ChannelMonitors.
  12
  13 use prelude::*;
  14 use std::io::{Read, Write};
  15 use core::hash::Hash;
  16 use std::sync::Mutex;
  17 use core::cmp;
  18
  19 use bitcoin::secp256k1::Signature;
  20 use bitcoin::secp256k1::key::{PublicKey, SecretKey};
  21 use bitcoin::secp256k1::constants::{PUBLIC_KEY_SIZE, SECRET_KEY_SIZE, COMPACT_SIGNATURE_SIZE};
  22 use bitcoin::blockdata::script::Script;
  23 use bitcoin::blockdata::transaction::{OutPoint, Transaction, TxOut};
  24 use bitcoin::consensus;
  25 use bitcoin::consensus::Encodable;
  26 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
  27 use bitcoin::hash_types::{Txid, BlockHash};
  28 use core::marker::Sized;
  29 use ln::msgs::DecodeError;
  30 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
  31
  32 use util::byte_utils::{be48_to_array, slice_to_be48};
  33
  34 /// serialization buffer size
  35 pub const MAX_BUF_SIZE: usize = 64 * 1024;
  36
  37 /// A trait that is similar to std::io::Write but has one extra function which can be used to size
  38 /// buffers being written into.
  39 /// An impl is provided for any type that also impls std::io::Write which simply ignores size
  40 /// hints.
  41 ///
  42 /// (C-not exported) as we only export serialization to/from byte arrays instead
  43 pub trait Writer {
  44         /// Writes the given buf out. See std::io::Write::write_all for more
  45         fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error>;
  46         /// Hints that data of the given size is about the be written. This may not always be called
  47         /// prior to data being written and may be safely ignored.
  48         fn size_hint(&mut self, size: usize);
  49 }
  50
  51 impl<W: Write> Writer for W {
  52         #[inline]
  53         fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
  54                 <Self as ::std::io::Write>::write_all(self, buf)
  55         }
  56         #[inline]
  57         fn size_hint(&mut self, _size: usize) { }
  58 }
  59
  60 pub(crate) struct WriterWriteAdaptor<'a, W: Writer + 'a>(pub &'a mut W);
  61 impl<'a, W: Writer + 'a> Write for WriterWriteAdaptor<'a, W> {
  62         #[inline]
  63         fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
  64                 self.0.write_all(buf)
  65         }
  66         #[inline]
  67         fn write(&mut self, buf: &[u8]) -> Result<usize, ::std::io::Error> {
  68                 self.0.write_all(buf)?;
  69                 Ok(buf.len())
  70         }
  71         #[inline]
  72         fn flush(&mut self) -> Result<(), ::std::io::Error> {
  73                 Ok(())
  74         }
  75 }
  76
  77 pub(crate) struct VecWriter(pub Vec<u8>);
  78 impl Writer for VecWriter {
  79         #[inline]
  80         fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
  81                 self.0.extend_from_slice(buf);
  82                 Ok(())
  83         }
  84         #[inline]
  85         fn size_hint(&mut self, size: usize) {
  86                 self.0.reserve_exact(size);
  87         }
  88 }
  89
  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(crate) struct LengthCalculatingWriter(pub usize);
  93 impl Writer for LengthCalculatingWriter {
  94         #[inline]
  95         fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
  96                 self.0 += buf.len();
  97                 Ok(())
  98         }
  99         #[inline]
 100         fn size_hint(&mut self, _size: usize) {}
 101 }
 102
 103 /// Essentially std::io::Take but a bit simpler and with a method to walk the underlying stream
 104 /// forward to ensure we always consume exactly the fixed length specified.
 105 pub(crate) struct FixedLengthReader<R: Read> {
 106         read: R,
 107         bytes_read: u64,
 108         total_bytes: u64,
 109 }
 110 impl<R: Read> FixedLengthReader<R> {
 111         pub fn new(read: R, total_bytes: u64) -> Self {
 112                 Self { read, bytes_read: 0, total_bytes }
 113         }
 114
 115         #[inline]
 116         pub fn bytes_remain(&mut self) -> bool {
 117                 self.bytes_read != self.total_bytes
 118         }
 119
 120         #[inline]
 121         pub fn eat_remaining(&mut self) -> Result<(), DecodeError> {
 122                 ::std::io::copy(self, &mut ::std::io::sink()).unwrap();
 123                 if self.bytes_read != self.total_bytes {
 124                         Err(DecodeError::ShortRead)
 125                 } else {
 126                         Ok(())
 127                 }
 128         }
 129 }
 130 impl<R: Read> Read for FixedLengthReader<R> {
 131         #[inline]
 132         fn read(&mut self, dest: &mut [u8]) -> Result<usize, ::std::io::Error> {
 133                 if self.total_bytes == self.bytes_read {
 134                         Ok(0)
 135                 } else {
 136                         let read_len = cmp::min(dest.len() as u64, self.total_bytes - self.bytes_read);
 137                         match self.read.read(&mut dest[0..(read_len as usize)]) {
 138                                 Ok(v) => {
 139                                         self.bytes_read += v as u64;
 140                                         Ok(v)
 141                                 },
 142                                 Err(e) => Err(e),
 143                         }
 144                 }
 145         }
 146 }
 147
 148 /// A Read which tracks whether any bytes have been read at all. This allows us to distinguish
 149 /// between "EOF reached before we started" and "EOF reached mid-read".
 150 pub(crate) struct ReadTrackingReader<R: Read> {
 151         read: R,
 152         pub have_read: bool,
 153 }
 154 impl<R: Read> ReadTrackingReader<R> {
 155         pub fn new(read: R) -> Self {
 156                 Self { read, have_read: false }
 157         }
 158 }
 159 impl<R: Read> Read for ReadTrackingReader<R> {
 160         #[inline]
 161         fn read(&mut self, dest: &mut [u8]) -> Result<usize, ::std::io::Error> {
 162                 match self.read.read(dest) {
 163                         Ok(0) => Ok(0),
 164                         Ok(len) => {
 165                                 self.have_read = true;
 166                                 Ok(len)
 167                         },
 168                         Err(e) => Err(e),
 169                 }
 170         }
 171 }
 172
 173 /// A trait that various rust-lightning types implement allowing them to be written out to a Writer
 174 ///
 175 /// (C-not exported) as we only export serialization to/from byte arrays instead
 176 pub trait Writeable {
 177         /// Writes self out to the given Writer
 178         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error>;
 179
 180         /// Writes self out to a Vec<u8>
 181         fn encode(&self) -> Vec<u8> {
 182                 let mut msg = VecWriter(Vec::new());
 183                 self.write(&mut msg).unwrap();
 184                 msg.0
 185         }
 186
 187         /// Writes self out to a Vec<u8>
 188         fn encode_with_len(&self) -> Vec<u8> {
 189                 let mut msg = VecWriter(Vec::new());
 190                 0u16.write(&mut msg).unwrap();
 191                 self.write(&mut msg).unwrap();
 192                 let len = msg.0.len();
 193                 msg.0[..2].copy_from_slice(&(len as u16 - 2).to_be_bytes());
 194                 msg.0
 195         }
 196
 197         /// Gets the length of this object after it has been serialized. This can be overridden to
 198         /// optimize cases where we prepend an object with its length.
 199         // Note that LLVM optimizes this away in most cases! Check that it isn't before you override!
 200         #[inline]
 201         fn serialized_length(&self) -> usize {
 202                 let mut len_calc = LengthCalculatingWriter(0);
 203                 self.write(&mut len_calc).expect("No in-memory data may fail to serialize");
 204                 len_calc.0
 205         }
 206 }
 207
 208 impl<'a, T: Writeable> Writeable for &'a T {
 209         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> { (*self).write(writer) }
 210 }
 211
 212 /// A trait that various rust-lightning types implement allowing them to be read in from a Read
 213 ///
 214 /// (C-not exported) as we only export serialization to/from byte arrays instead
 215 pub trait Readable
 216         where Self: Sized
 217 {
 218         /// Reads a Self in from the given Read
 219         fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError>;
 220 }
 221
 222 /// A trait that various higher-level rust-lightning types implement allowing them to be read in
 223 /// from a Read given some additional set of arguments which is required to deserialize.
 224 ///
 225 /// (C-not exported) as we only export serialization to/from byte arrays instead
 226 pub trait ReadableArgs<P>
 227         where Self: Sized
 228 {
 229         /// Reads a Self in from the given Read
 230         fn read<R: Read>(reader: &mut R, params: P) -> Result<Self, DecodeError>;
 231 }
 232
 233 /// A trait that various rust-lightning types implement allowing them to (maybe) be read in from a Read
 234 ///
 235 /// (C-not exported) as we only export serialization to/from byte arrays instead
 236 pub trait MaybeReadable
 237         where Self: Sized
 238 {
 239         /// Reads a Self in from the given Read
 240         fn read<R: Read>(reader: &mut R) -> Result<Option<Self>, DecodeError>;
 241 }
 242
 243 pub(crate) struct OptionDeserWrapper<T: Readable>(pub Option<T>);
 244 impl<T: Readable> Readable for OptionDeserWrapper<T> {
 245         #[inline]
 246         fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
 247                 Ok(Self(Some(Readable::read(reader)?)))
 248         }
 249 }
 250
 251 /// Wrapper to write each element of a Vec with no length prefix
 252 pub(crate) struct VecWriteWrapper<'a, T: Writeable>(pub &'a Vec<T>);
 253 impl<'a, T: Writeable> Writeable for VecWriteWrapper<'a, T> {
 254         #[inline]
 255         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
 256                 for ref v in self.0.iter() {
 257                         v.write(writer)?;
 258                 }
 259                 Ok(())
 260         }
 261 }
 262
 263 /// Wrapper to read elements from a given stream until it reaches the end of the stream.
 264 pub(crate) struct VecReadWrapper<T: Readable>(pub Vec<T>);
 265 impl<T: Readable> Readable for VecReadWrapper<T> {
 266         #[inline]
 267         fn read<R: Read>(mut reader: &mut R) -> Result<Self, DecodeError> {
 268                 let mut values = Vec::new();
 269                 loop {
 270                         let mut track_read = ReadTrackingReader::new(&mut reader);
 271                         match Readable::read(&mut track_read) {
 272                                 Ok(v) => { values.push(v); },
 273                                 // If we failed to read any bytes at all, we reached the end of our TLV
 274                                 // stream and have simply exhausted all entries.
 275                                 Err(ref e) if e == &DecodeError::ShortRead && !track_read.have_read => break,
 276                                 Err(e) => return Err(e),
 277                         }
 278                 }
 279                 Ok(Self(values))
 280         }
 281 }
 282
 283 pub(crate) struct U48(pub u64);
 284 impl Writeable for U48 {
 285         #[inline]
 286         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
 287                 writer.write_all(&be48_to_array(self.0))
 288         }
 289 }
 290 impl Readable for U48 {
 291         #[inline]
 292         fn read<R: Read>(reader: &mut R) -> Result<U48, DecodeError> {
 293                 let mut buf = [0; 6];
 294                 reader.read_exact(&mut buf)?;
 295                 Ok(U48(slice_to_be48(&buf)))
 296         }
 297 }
 298
 299 /// Lightning TLV uses a custom variable-length integer called BigSize. It is similar to Bitcoin's
 300 /// variable-length integers except that it is serialized in big-endian instead of little-endian.
 301 ///
 302 /// Like Bitcoin's variable-length integer, it exhibits ambiguity in that certain values can be
 303 /// encoded in several different ways, which we must check for at deserialization-time. Thus, if
 304 /// you're looking for an example of a variable-length integer to use for your own project, move
 305 /// along, this is a rather poor design.
 306 pub struct BigSize(pub u64);
 307 impl Writeable for BigSize {
 308         #[inline]
 309         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
 310                 match self.0 {
 311                         0...0xFC => {
 312                                 (self.0 as u8).write(writer)
 313                         },
 314                         0xFD...0xFFFF => {
 315                                 0xFDu8.write(writer)?;
 316                                 (self.0 as u16).write(writer)
 317                         },
 318                         0x10000...0xFFFFFFFF => {
 319                                 0xFEu8.write(writer)?;
 320                                 (self.0 as u32).write(writer)
 321                         },
 322                         _ => {
 323                                 0xFFu8.write(writer)?;
 324                                 (self.0 as u64).write(writer)
 325                         },
 326                 }
 327         }
 328 }
 329 impl Readable for BigSize {
 330         #[inline]
 331         fn read<R: Read>(reader: &mut R) -> Result<BigSize, DecodeError> {
 332                 let n: u8 = Readable::read(reader)?;
 333                 match n {
 334                         0xFF => {
 335                                 let x: u64 = Readable::read(reader)?;
 336                                 if x < 0x100000000 {
 337                                         Err(DecodeError::InvalidValue)
 338                                 } else {
 339                                         Ok(BigSize(x))
 340                                 }
 341                         }
 342                         0xFE => {
 343                                 let x: u32 = Readable::read(reader)?;
 344                                 if x < 0x10000 {
 345                                         Err(DecodeError::InvalidValue)
 346                                 } else {
 347                                         Ok(BigSize(x as u64))
 348                                 }
 349                         }
 350                         0xFD => {
 351                                 let x: u16 = Readable::read(reader)?;
 352                                 if x < 0xFD {
 353                                         Err(DecodeError::InvalidValue)
 354                                 } else {
 355                                         Ok(BigSize(x as u64))
 356                                 }
 357                         }
 358                         n => Ok(BigSize(n as u64))
 359                 }
 360         }
 361 }
 362
 363 /// In TLV we occasionally send fields which only consist of, or potentially end with, a
 364 /// variable-length integer which is simply truncated by skipping high zero bytes. This type
 365 /// encapsulates such integers implementing Readable/Writeable for them.
 366 #[cfg_attr(test, derive(PartialEq, Debug))]
 367 pub(crate) struct HighZeroBytesDroppedVarInt<T>(pub T);
 368
 369 macro_rules! impl_writeable_primitive {
 370         ($val_type:ty, $len: expr) => {
 371                 impl Writeable for $val_type {
 372                         #[inline]
 373                         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
 374                                 writer.write_all(&self.to_be_bytes())
 375                         }
 376                 }
 377                 impl Writeable for HighZeroBytesDroppedVarInt<$val_type> {
 378                         #[inline]
 379                         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
 380                                 // Skip any full leading 0 bytes when writing (in BE):
 381                                 writer.write_all(&self.0.to_be_bytes()[(self.0.leading_zeros()/8) as usize..$len])
 382                         }
 383                 }
 384                 impl Readable for $val_type {
 385                         #[inline]
 386                         fn read<R: Read>(reader: &mut R) -> Result<$val_type, DecodeError> {
 387                                 let mut buf = [0; $len];
 388                                 reader.read_exact(&mut buf)?;
 389                                 Ok(<$val_type>::from_be_bytes(buf))
 390                         }
 391                 }
 392                 impl Readable for HighZeroBytesDroppedVarInt<$val_type> {
 393                         #[inline]
 394                         fn read<R: Read>(reader: &mut R) -> Result<HighZeroBytesDroppedVarInt<$val_type>, DecodeError> {
 395                                 // We need to accept short reads (read_len == 0) as "EOF" and handle them as simply
 396                                 // the high bytes being dropped. To do so, we start reading into the middle of buf
 397                                 // and then convert the appropriate number of bytes with extra high bytes out of
 398                                 // buf.
 399                                 let mut buf = [0; $len*2];
 400                                 let mut read_len = reader.read(&mut buf[$len..])?;
 401                                 let mut total_read_len = read_len;
 402                                 while read_len != 0 && total_read_len != $len {
 403                                         read_len = reader.read(&mut buf[($len + total_read_len)..])?;
 404                                         total_read_len += read_len;
 405                                 }
 406                                 if total_read_len == 0 || buf[$len] != 0 {
 407                                         let first_byte = $len - ($len - total_read_len);
 408                                         let mut bytes = [0; $len];
 409                                         bytes.copy_from_slice(&buf[first_byte..first_byte + $len]);
 410                                         Ok(HighZeroBytesDroppedVarInt(<$val_type>::from_be_bytes(bytes)))
 411                                 } else {
 412                                         // If the encoding had extra zero bytes, return a failure even though we know
 413                                         // what they meant (as the TLV test vectors require this)
 414                                         Err(DecodeError::InvalidValue)
 415                                 }
 416                         }
 417                 }
 418         }
 419 }
 420
 421 impl_writeable_primitive!(u64, 8);
 422 impl_writeable_primitive!(u32, 4);
 423 impl_writeable_primitive!(u16, 2);
 424
 425 impl Writeable for u8 {
 426         #[inline]
 427         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
 428                 writer.write_all(&[*self])
 429         }
 430 }
 431 impl Readable for u8 {
 432         #[inline]
 433         fn read<R: Read>(reader: &mut R) -> Result<u8, DecodeError> {
 434                 let mut buf = [0; 1];
 435                 reader.read_exact(&mut buf)?;
 436                 Ok(buf[0])
 437         }
 438 }
 439
 440 impl Writeable for bool {
 441         #[inline]
 442         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
 443                 writer.write_all(&[if *self {1} else {0}])
 444         }
 445 }
 446 impl Readable for bool {
 447         #[inline]
 448         fn read<R: Read>(reader: &mut R) -> Result<bool, DecodeError> {
 449                 let mut buf = [0; 1];
 450                 reader.read_exact(&mut buf)?;
 451                 if buf[0] != 0 && buf[0] != 1 {
 452                         return Err(DecodeError::InvalidValue);
 453                 }
 454                 Ok(buf[0] == 1)
 455         }
 456 }
 457
 458 // u8 arrays
 459 macro_rules! impl_array {
 460         ( $size:expr ) => (
 461                 impl Writeable for [u8; $size]
 462                 {
 463                         #[inline]
 464                         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 465                                 w.write_all(self)
 466                         }
 467                 }
 468
 469                 impl Readable for [u8; $size]
 470                 {
 471                         #[inline]
 472                         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 473                                 let mut buf = [0u8; $size];
 474                                 r.read_exact(&mut buf)?;
 475                                 Ok(buf)
 476                         }
 477                 }
 478         );
 479 }
 480
 481 //TODO: performance issue with [u8; size] with impl_array!()
 482 impl_array!(3); // for rgb
 483 impl_array!(4); // for IPv4
 484 impl_array!(10); // for OnionV2
 485 impl_array!(16); // for IPv6
 486 impl_array!(32); // for channel id & hmac
 487 impl_array!(PUBLIC_KEY_SIZE); // for PublicKey
 488 impl_array!(COMPACT_SIGNATURE_SIZE); // for Signature
 489 impl_array!(162); // for ECDSA adaptor signatures
 490 impl_array!(1300); // for OnionPacket.hop_data
 491
 492 // HashMap
 493 impl<K, V> Writeable for HashMap<K, V>
 494         where K: Writeable + Eq + Hash,
 495               V: Writeable
 496 {
 497         #[inline]
 498         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 499         (self.len() as u16).write(w)?;
 500                 for (key, value) in self.iter() {
 501                         key.write(w)?;
 502                         value.write(w)?;
 503                 }
 504                 Ok(())
 505         }
 506 }
 507
 508 impl<K, V> Readable for HashMap<K, V>
 509         where K: Readable + Eq + Hash,
 510               V: Readable
 511 {
 512         #[inline]
 513         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 514                 let len: u16 = Readable::read(r)?;
 515                 let mut ret = HashMap::with_capacity(len as usize);
 516                 for _ in 0..len {
 517                         ret.insert(K::read(r)?, V::read(r)?);
 518                 }
 519                 Ok(ret)
 520         }
 521 }
 522
 523 // Vectors
 524 impl Writeable for Vec<u8> {
 525         #[inline]
 526         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 527                 (self.len() as u16).write(w)?;
 528                 w.write_all(&self)
 529         }
 530 }
 531
 532 impl Readable for Vec<u8> {
 533         #[inline]
 534         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 535                 let len: u16 = Readable::read(r)?;
 536                 let mut ret = Vec::with_capacity(len as usize);
 537                 ret.resize(len as usize, 0);
 538                 r.read_exact(&mut ret)?;
 539                 Ok(ret)
 540         }
 541 }
 542 impl Writeable for Vec<Signature> {
 543         #[inline]
 544         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 545                 (self.len() as u16).write(w)?;
 546                 for e in self.iter() {
 547                         e.write(w)?;
 548                 }
 549                 Ok(())
 550         }
 551 }
 552
 553 impl Readable for Vec<Signature> {
 554         #[inline]
 555         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 556                 let len: u16 = Readable::read(r)?;
 557                 let byte_size = (len as usize)
 558                                 .checked_mul(COMPACT_SIGNATURE_SIZE)
 559                                 .ok_or(DecodeError::BadLengthDescriptor)?;
 560                 if byte_size > MAX_BUF_SIZE {
 561                         return Err(DecodeError::BadLengthDescriptor);
 562                 }
 563                 let mut ret = Vec::with_capacity(len as usize);
 564                 for _ in 0..len { ret.push(Signature::read(r)?); }
 565                 Ok(ret)
 566         }
 567 }
 568
 569 impl Writeable for Script {
 570         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 571                 (self.len() as u16).write(w)?;
 572                 w.write_all(self.as_bytes())
 573         }
 574 }
 575
 576 impl Readable for Script {
 577         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 578                 let len = <u16 as Readable>::read(r)? as usize;
 579                 let mut buf = vec![0; len];
 580                 r.read_exact(&mut buf)?;
 581                 Ok(Script::from(buf))
 582         }
 583 }
 584
 585 impl Writeable for PublicKey {
 586         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 587                 self.serialize().write(w)
 588         }
 589         #[inline]
 590         fn serialized_length(&self) -> usize {
 591                 PUBLIC_KEY_SIZE
 592         }
 593 }
 594
 595 impl Readable for PublicKey {
 596         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 597                 let buf: [u8; PUBLIC_KEY_SIZE] = Readable::read(r)?;
 598                 match PublicKey::from_slice(&buf) {
 599                         Ok(key) => Ok(key),
 600                         Err(_) => return Err(DecodeError::InvalidValue),
 601                 }
 602         }
 603 }
 604
 605 impl Writeable for SecretKey {
 606         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 607                 let mut ser = [0; SECRET_KEY_SIZE];
 608                 ser.copy_from_slice(&self[..]);
 609                 ser.write(w)
 610         }
 611         #[inline]
 612         fn serialized_length(&self) -> usize {
 613                 SECRET_KEY_SIZE
 614         }
 615 }
 616
 617 impl Readable for SecretKey {
 618         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 619                 let buf: [u8; SECRET_KEY_SIZE] = Readable::read(r)?;
 620                 match SecretKey::from_slice(&buf) {
 621                         Ok(key) => Ok(key),
 622                         Err(_) => return Err(DecodeError::InvalidValue),
 623                 }
 624         }
 625 }
 626
 627 impl Writeable for Sha256dHash {
 628         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 629                 w.write_all(&self[..])
 630         }
 631 }
 632
 633 impl Readable for Sha256dHash {
 634         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 635                 use bitcoin::hashes::Hash;
 636
 637                 let buf: [u8; 32] = Readable::read(r)?;
 638                 Ok(Sha256dHash::from_slice(&buf[..]).unwrap())
 639         }
 640 }
 641
 642 impl Writeable for Signature {
 643         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 644                 self.serialize_compact().write(w)
 645         }
 646         #[inline]
 647         fn serialized_length(&self) -> usize {
 648                 COMPACT_SIGNATURE_SIZE
 649         }
 650 }
 651
 652 impl Readable for Signature {
 653         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 654                 let buf: [u8; COMPACT_SIGNATURE_SIZE] = Readable::read(r)?;
 655                 match Signature::from_compact(&buf) {
 656                         Ok(sig) => Ok(sig),
 657                         Err(_) => return Err(DecodeError::InvalidValue),
 658                 }
 659         }
 660 }
 661
 662 impl Writeable for PaymentPreimage {
 663         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 664                 self.0.write(w)
 665         }
 666 }
 667
 668 impl Readable for PaymentPreimage {
 669         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 670                 let buf: [u8; 32] = Readable::read(r)?;
 671                 Ok(PaymentPreimage(buf))
 672         }
 673 }
 674
 675 impl Writeable for PaymentHash {
 676         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 677                 self.0.write(w)
 678         }
 679 }
 680
 681 impl Readable for PaymentHash {
 682         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 683                 let buf: [u8; 32] = Readable::read(r)?;
 684                 Ok(PaymentHash(buf))
 685         }
 686 }
 687
 688 impl Writeable for PaymentSecret {
 689         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 690                 self.0.write(w)
 691         }
 692 }
 693
 694 impl Readable for PaymentSecret {
 695         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 696                 let buf: [u8; 32] = Readable::read(r)?;
 697                 Ok(PaymentSecret(buf))
 698         }
 699 }
 700
 701 impl<T: Writeable> Writeable for Box<T> {
 702         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 703                 T::write(&**self, w)
 704         }
 705 }
 706
 707 impl<T: Readable> Readable for Box<T> {
 708         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 709                 Ok(Box::new(Readable::read(r)?))
 710         }
 711 }
 712
 713 impl<T: Writeable> Writeable for Option<T> {
 714         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 715                 match *self {
 716                         None => 0u8.write(w)?,
 717                         Some(ref data) => {
 718                                 BigSize(data.serialized_length() as u64 + 1).write(w)?;
 719                                 data.write(w)?;
 720                         }
 721                 }
 722                 Ok(())
 723         }
 724 }
 725
 726 impl<T: Readable> Readable for Option<T>
 727 {
 728         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 729                 match BigSize::read(r)?.0 {
 730                         0 => Ok(None),
 731                         len => {
 732                                 let mut reader = FixedLengthReader::new(r, len - 1);
 733                                 Ok(Some(Readable::read(&mut reader)?))
 734                         }
 735                 }
 736         }
 737 }
 738
 739 impl Writeable for Txid {
 740         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 741                 w.write_all(&self[..])
 742         }
 743 }
 744
 745 impl Readable for Txid {
 746         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 747                 use bitcoin::hashes::Hash;
 748
 749                 let buf: [u8; 32] = Readable::read(r)?;
 750                 Ok(Txid::from_slice(&buf[..]).unwrap())
 751         }
 752 }
 753
 754 impl Writeable for BlockHash {
 755         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 756                 w.write_all(&self[..])
 757         }
 758 }
 759
 760 impl Readable for BlockHash {
 761         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 762                 use bitcoin::hashes::Hash;
 763
 764                 let buf: [u8; 32] = Readable::read(r)?;
 765                 Ok(BlockHash::from_slice(&buf[..]).unwrap())
 766         }
 767 }
 768
 769 impl Writeable for OutPoint {
 770         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 771                 self.txid.write(w)?;
 772                 self.vout.write(w)?;
 773                 Ok(())
 774         }
 775 }
 776
 777 impl Readable for OutPoint {
 778         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 779                 let txid = Readable::read(r)?;
 780                 let vout = Readable::read(r)?;
 781                 Ok(OutPoint {
 782                         txid,
 783                         vout,
 784                 })
 785         }
 786 }
 787
 788 macro_rules! impl_consensus_ser {
 789         ($bitcoin_type: ty) => {
 790                 impl Writeable for $bitcoin_type {
 791                         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
 792                                 match self.consensus_encode(WriterWriteAdaptor(writer)) {
 793                                         Ok(_) => Ok(()),
 794                                         Err(e) => Err(e),
 795                                 }
 796                         }
 797                 }
 798
 799                 impl Readable for $bitcoin_type {
 800                         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 801                                 match consensus::encode::Decodable::consensus_decode(r) {
 802                                         Ok(t) => Ok(t),
 803                                         Err(consensus::encode::Error::Io(ref e)) if e.kind() == ::std::io::ErrorKind::UnexpectedEof => Err(DecodeError::ShortRead),
 804                                         Err(consensus::encode::Error::Io(e)) => Err(DecodeError::Io(e.kind())),
 805                                         Err(_) => Err(DecodeError::InvalidValue),
 806                                 }
 807                         }
 808                 }
 809         }
 810 }
 811 impl_consensus_ser!(Transaction);
 812 impl_consensus_ser!(TxOut);
 813
 814 impl<T: Readable> Readable for Mutex<T> {
 815         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 816                 let t: T = Readable::read(r)?;
 817                 Ok(Mutex::new(t))
 818         }
 819 }
 820 impl<T: Writeable> Writeable for Mutex<T> {
 821         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 822                 self.lock().unwrap().write(w)
 823         }
 824 }
 825
 826 impl<A: Readable, B: Readable> Readable for (A, B) {
 827         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 828                 let a: A = Readable::read(r)?;
 829                 let b: B = Readable::read(r)?;
 830                 Ok((a, b))
 831         }
 832 }
 833 impl<A: Writeable, B: Writeable> Writeable for (A, B) {
 834         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 835                 self.0.write(w)?;
 836                 self.1.write(w)
 837         }
 838 }
 839
 840 impl<A: Readable, B: Readable, C: Readable> Readable for (A, B, C) {
 841         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 842                 let a: A = Readable::read(r)?;
 843                 let b: B = Readable::read(r)?;
 844                 let c: C = Readable::read(r)?;
 845                 Ok((a, b, c))
 846         }
 847 }
 848 impl<A: Writeable, B: Writeable, C: Writeable> Writeable for (A, B, C) {
 849         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 850                 self.0.write(w)?;
 851                 self.1.write(w)?;
 852                 self.2.write(w)
 853         }
 854 }