_ 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 io::{self, Read, Write};
  15 use io_extras::{copy, sink};
  16 use core::hash::Hash;
  17 use sync::Mutex;
  18 use core::cmp;
  19
  20 use bitcoin::secp256k1::Signature;
  21 use bitcoin::secp256k1::key::{PublicKey, SecretKey};
  22 use bitcoin::secp256k1::constants::{PUBLIC_KEY_SIZE, SECRET_KEY_SIZE, COMPACT_SIGNATURE_SIZE};
  23 use bitcoin::blockdata::script::Script;
  24 use bitcoin::blockdata::transaction::{OutPoint, Transaction, TxOut};
  25 use bitcoin::consensus;
  26 use bitcoin::consensus::Encodable;
  27 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
  28 use bitcoin::hash_types::{Txid, BlockHash};
  29 use core::marker::Sized;
  30 use ln::msgs::DecodeError;
  31 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
  32
  33 use util::byte_utils::{be48_to_array, slice_to_be48};
  34
  35 /// serialization buffer size
  36 pub const MAX_BUF_SIZE: usize = 64 * 1024;
  37
  38 /// A trait that is similar to std::io::Write but has one extra function which can be used to size
  39 /// buffers being written into.
  40 /// An impl is provided for any type that also impls std::io::Write which simply ignores size
  41 /// hints.
  42 ///
  43 /// (C-not exported) as we only export serialization to/from byte arrays instead
  44 pub trait Writer {
  45         /// Writes the given buf out. See std::io::Write::write_all for more
  46         fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error>;
  47         /// Hints that data of the given size is about the be written. This may not always be called
  48         /// prior to data being written and may be safely ignored.
  49         fn size_hint(&mut self, size: usize);
  50 }
  51
  52 impl<W: Write> Writer for W {
  53         #[inline]
  54         fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error> {
  55                 <Self as io::Write>::write_all(self, buf)
  56         }
  57         #[inline]
  58         fn size_hint(&mut self, _size: usize) { }
  59 }
  60
  61 pub(crate) struct WriterWriteAdaptor<'a, W: Writer + 'a>(pub &'a mut W);
  62 impl<'a, W: Writer + 'a> Write for WriterWriteAdaptor<'a, W> {
  63         #[inline]
  64         fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error> {
  65                 self.0.write_all(buf)
  66         }
  67         #[inline]
  68         fn write(&mut self, buf: &[u8]) -> Result<usize, io::Error> {
  69                 self.0.write_all(buf)?;
  70                 Ok(buf.len())
  71         }
  72         #[inline]
  73         fn flush(&mut self) -> Result<(), io::Error> {
  74                 Ok(())
  75         }
  76 }
  77
  78 pub(crate) struct VecWriter(pub Vec<u8>);
  79 impl Writer for VecWriter {
  80         #[inline]
  81         fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error> {
  82                 self.0.extend_from_slice(buf);
  83                 Ok(())
  84         }
  85         #[inline]
  86         fn size_hint(&mut self, size: usize) {
  87                 self.0.reserve_exact(size);
  88         }
  89 }
  90
  91 /// Writer that only tracks the amount of data written - useful if you need to calculate the length
  92 /// of some data when serialized but don't yet need the full data.
  93 pub(crate) struct LengthCalculatingWriter(pub usize);
  94 impl Writer for LengthCalculatingWriter {
  95         #[inline]
  96         fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error> {
  97                 self.0 += buf.len();
  98                 Ok(())
  99         }
 100         #[inline]
 101         fn size_hint(&mut self, _size: usize) {}
 102 }
 103
 104 /// Essentially std::io::Take but a bit simpler and with a method to walk the underlying stream
 105 /// forward to ensure we always consume exactly the fixed length specified.
 106 pub(crate) struct FixedLengthReader<R: Read> {
 107         read: R,
 108         bytes_read: u64,
 109         total_bytes: u64,
 110 }
 111 impl<R: Read> FixedLengthReader<R> {
 112         pub fn new(read: R, total_bytes: u64) -> Self {
 113                 Self { read, bytes_read: 0, total_bytes }
 114         }
 115
 116         #[inline]
 117         pub fn bytes_remain(&mut self) -> bool {
 118                 self.bytes_read != self.total_bytes
 119         }
 120
 121         #[inline]
 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)
 126                 } else {
 127                         Ok(())
 128                 }
 129         }
 130 }
 131 impl<R: Read> Read for FixedLengthReader<R> {
 132         #[inline]
 133         fn read(&mut self, dest: &mut [u8]) -> Result<usize, io::Error> {
 134                 if self.total_bytes == self.bytes_read {
 135                         Ok(0)
 136                 } else {
 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)]) {
 139                                 Ok(v) => {
 140                                         self.bytes_read += v as u64;
 141                                         Ok(v)
 142                                 },
 143                                 Err(e) => Err(e),
 144                         }
 145                 }
 146         }
 147 }
 148
 149 /// A Read which tracks whether any bytes have been read at all. This allows us to distinguish
 150 /// between "EOF reached before we started" and "EOF reached mid-read".
 151 pub(crate) struct ReadTrackingReader<R: Read> {
 152         read: R,
 153         pub have_read: bool,
 154 }
 155 impl<R: Read> ReadTrackingReader<R> {
 156         pub fn new(read: R) -> Self {
 157                 Self { read, have_read: false }
 158         }
 159 }
 160 impl<R: Read> Read for ReadTrackingReader<R> {
 161         #[inline]
 162         fn read(&mut self, dest: &mut [u8]) -> Result<usize, io::Error> {
 163                 match self.read.read(dest) {
 164                         Ok(0) => Ok(0),
 165                         Ok(len) => {
 166                                 self.have_read = true;
 167                                 Ok(len)
 168                         },
 169                         Err(e) => Err(e),
 170                 }
 171         }
 172 }
 173
 174 /// A trait that various rust-lightning types implement allowing them to be written out to a Writer
 175 ///
 176 /// (C-not exported) as we only export serialization to/from byte arrays instead
 177 pub trait Writeable {
 178         /// Writes self out to the given Writer
 179         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error>;
 180
 181         /// Writes self out to a Vec<u8>
 182         fn encode(&self) -> Vec<u8> {
 183                 let mut msg = VecWriter(Vec::new());
 184                 self.write(&mut msg).unwrap();
 185                 msg.0
 186         }
 187
 188         /// Writes self out to a Vec<u8>
 189         fn encode_with_len(&self) -> Vec<u8> {
 190                 let mut msg = VecWriter(Vec::new());
 191                 0u16.write(&mut msg).unwrap();
 192                 self.write(&mut msg).unwrap();
 193                 let len = msg.0.len();
 194                 msg.0[..2].copy_from_slice(&(len as u16 - 2).to_be_bytes());
 195                 msg.0
 196         }
 197
 198         /// Gets the length of this object after it has been serialized. This can be overridden to
 199         /// optimize cases where we prepend an object with its length.
 200         // Note that LLVM optimizes this away in most cases! Check that it isn't before you override!
 201         #[inline]
 202         fn serialized_length(&self) -> usize {
 203                 let mut len_calc = LengthCalculatingWriter(0);
 204                 self.write(&mut len_calc).expect("No in-memory data may fail to serialize");
 205                 len_calc.0
 206         }
 207 }
 208
 209 impl<'a, T: Writeable> Writeable for &'a T {
 210         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> { (*self).write(writer) }
 211 }
 212
 213 /// A trait that various rust-lightning types implement allowing them to be read in from a Read
 214 ///
 215 /// (C-not exported) as we only export serialization to/from byte arrays instead
 216 pub trait Readable
 217         where Self: Sized
 218 {
 219         /// Reads a Self in from the given Read
 220         fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError>;
 221 }
 222
 223 /// A trait that various higher-level rust-lightning types implement allowing them to be read in
 224 /// from a Read given some additional set of arguments which is required to deserialize.
 225 ///
 226 /// (C-not exported) as we only export serialization to/from byte arrays instead
 227 pub trait ReadableArgs<P>
 228         where Self: Sized
 229 {
 230         /// Reads a Self in from the given Read
 231         fn read<R: Read>(reader: &mut R, params: P) -> Result<Self, DecodeError>;
 232 }
 233
 234 /// A trait that various rust-lightning types implement allowing them to (maybe) be read in from a Read
 235 ///
 236 /// (C-not exported) as we only export serialization to/from byte arrays instead
 237 pub trait MaybeReadable
 238         where Self: Sized
 239 {
 240         /// Reads a Self in from the given Read
 241         fn read<R: Read>(reader: &mut R) -> Result<Option<Self>, DecodeError>;
 242 }
 243
 244 pub(crate) struct OptionDeserWrapper<T: Readable>(pub Option<T>);
 245 impl<T: Readable> Readable for OptionDeserWrapper<T> {
 246         #[inline]
 247         fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
 248                 Ok(Self(Some(Readable::read(reader)?)))
 249         }
 250 }
 251
 252 /// Wrapper to write each element of a Vec with no length prefix
 253 pub(crate) struct VecWriteWrapper<'a, T: Writeable>(pub &'a Vec<T>);
 254 impl<'a, T: Writeable> Writeable for VecWriteWrapper<'a, T> {
 255         #[inline]
 256         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 257                 for ref v in self.0.iter() {
 258                         v.write(writer)?;
 259                 }
 260                 Ok(())
 261         }
 262 }
 263
 264 /// Wrapper to read elements from a given stream until it reaches the end of the stream.
 265 pub(crate) struct VecReadWrapper<T: Readable>(pub Vec<T>);
 266 impl<T: Readable> Readable for VecReadWrapper<T> {
 267         #[inline]
 268         fn read<R: Read>(mut reader: &mut R) -> Result<Self, DecodeError> {
 269                 let mut values = Vec::new();
 270                 loop {
 271                         let mut track_read = ReadTrackingReader::new(&mut reader);
 272                         match Readable::read(&mut track_read) {
 273                                 Ok(v) => { values.push(v); },
 274                                 // If we failed to read any bytes at all, we reached the end of our TLV
 275                                 // stream and have simply exhausted all entries.
 276                                 Err(ref e) if e == &DecodeError::ShortRead && !track_read.have_read => break,
 277                                 Err(e) => return Err(e),
 278                         }
 279                 }
 280                 Ok(Self(values))
 281         }
 282 }
 283
 284 pub(crate) struct U48(pub u64);
 285 impl Writeable for U48 {
 286         #[inline]
 287         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 288                 writer.write_all(&be48_to_array(self.0))
 289         }
 290 }
 291 impl Readable for U48 {
 292         #[inline]
 293         fn read<R: Read>(reader: &mut R) -> Result<U48, DecodeError> {
 294                 let mut buf = [0; 6];
 295                 reader.read_exact(&mut buf)?;
 296                 Ok(U48(slice_to_be48(&buf)))
 297         }
 298 }
 299
 300 /// Lightning TLV uses a custom variable-length integer called BigSize. It is similar to Bitcoin's
 301 /// variable-length integers except that it is serialized in big-endian instead of little-endian.
 302 ///
 303 /// Like Bitcoin's variable-length integer, it exhibits ambiguity in that certain values can be
 304 /// encoded in several different ways, which we must check for at deserialization-time. Thus, if
 305 /// you're looking for an example of a variable-length integer to use for your own project, move
 306 /// along, this is a rather poor design.
 307 pub(crate) struct BigSize(pub u64);
 308 impl Writeable for BigSize {
 309         #[inline]
 310         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 311                 match self.0 {
 312                         0...0xFC => {
 313                                 (self.0 as u8).write(writer)
 314                         },
 315                         0xFD...0xFFFF => {
 316                                 0xFDu8.write(writer)?;
 317                                 (self.0 as u16).write(writer)
 318                         },
 319                         0x10000...0xFFFFFFFF => {
 320                                 0xFEu8.write(writer)?;
 321                                 (self.0 as u32).write(writer)
 322                         },
 323                         _ => {
 324                                 0xFFu8.write(writer)?;
 325                                 (self.0 as u64).write(writer)
 326                         },
 327                 }
 328         }
 329 }
 330 impl Readable for BigSize {
 331         #[inline]
 332         fn read<R: Read>(reader: &mut R) -> Result<BigSize, DecodeError> {
 333                 let n: u8 = Readable::read(reader)?;
 334                 match n {
 335                         0xFF => {
 336                                 let x: u64 = Readable::read(reader)?;
 337                                 if x < 0x100000000 {
 338                                         Err(DecodeError::InvalidValue)
 339                                 } else {
 340                                         Ok(BigSize(x))
 341                                 }
 342                         }
 343                         0xFE => {
 344                                 let x: u32 = Readable::read(reader)?;
 345                                 if x < 0x10000 {
 346                                         Err(DecodeError::InvalidValue)
 347                                 } else {
 348                                         Ok(BigSize(x as u64))
 349                                 }
 350                         }
 351                         0xFD => {
 352                                 let x: u16 = Readable::read(reader)?;
 353                                 if x < 0xFD {
 354                                         Err(DecodeError::InvalidValue)
 355                                 } else {
 356                                         Ok(BigSize(x as u64))
 357                                 }
 358                         }
 359                         n => Ok(BigSize(n as u64))
 360                 }
 361         }
 362 }
 363
 364 /// In TLV we occasionally send fields which only consist of, or potentially end with, a
 365 /// variable-length integer which is simply truncated by skipping high zero bytes. This type
 366 /// encapsulates such integers implementing Readable/Writeable for them.
 367 #[cfg_attr(test, derive(PartialEq, Debug))]
 368 pub(crate) struct HighZeroBytesDroppedVarInt<T>(pub T);
 369
 370 macro_rules! impl_writeable_primitive {
 371         ($val_type:ty, $len: expr) => {
 372                 impl Writeable for $val_type {
 373                         #[inline]
 374                         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 375                                 writer.write_all(&self.to_be_bytes())
 376                         }
 377                 }
 378                 impl Writeable for HighZeroBytesDroppedVarInt<$val_type> {
 379                         #[inline]
 380                         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 381                                 // Skip any full leading 0 bytes when writing (in BE):
 382                                 writer.write_all(&self.0.to_be_bytes()[(self.0.leading_zeros()/8) as usize..$len])
 383                         }
 384                 }
 385                 impl Readable for $val_type {
 386                         #[inline]
 387                         fn read<R: Read>(reader: &mut R) -> Result<$val_type, DecodeError> {
 388                                 let mut buf = [0; $len];
 389                                 reader.read_exact(&mut buf)?;
 390                                 Ok(<$val_type>::from_be_bytes(buf))
 391                         }
 392                 }
 393                 impl Readable for HighZeroBytesDroppedVarInt<$val_type> {
 394                         #[inline]
 395                         fn read<R: Read>(reader: &mut R) -> Result<HighZeroBytesDroppedVarInt<$val_type>, DecodeError> {
 396                                 // We need to accept short reads (read_len == 0) as "EOF" and handle them as simply
 397                                 // the high bytes being dropped. To do so, we start reading into the middle of buf
 398                                 // and then convert the appropriate number of bytes with extra high bytes out of
 399                                 // buf.
 400                                 let mut buf = [0; $len*2];
 401                                 let mut read_len = reader.read(&mut buf[$len..])?;
 402                                 let mut total_read_len = read_len;
 403                                 while read_len != 0 && total_read_len != $len {
 404                                         read_len = reader.read(&mut buf[($len + total_read_len)..])?;
 405                                         total_read_len += read_len;
 406                                 }
 407                                 if total_read_len == 0 || buf[$len] != 0 {
 408                                         let first_byte = $len - ($len - total_read_len);
 409                                         let mut bytes = [0; $len];
 410                                         bytes.copy_from_slice(&buf[first_byte..first_byte + $len]);
 411                                         Ok(HighZeroBytesDroppedVarInt(<$val_type>::from_be_bytes(bytes)))
 412                                 } else {
 413                                         // If the encoding had extra zero bytes, return a failure even though we know
 414                                         // what they meant (as the TLV test vectors require this)
 415                                         Err(DecodeError::InvalidValue)
 416                                 }
 417                         }
 418                 }
 419         }
 420 }
 421
 422 impl_writeable_primitive!(u64, 8);
 423 impl_writeable_primitive!(u32, 4);
 424 impl_writeable_primitive!(u16, 2);
 425
 426 impl Writeable for u8 {
 427         #[inline]
 428         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 429                 writer.write_all(&[*self])
 430         }
 431 }
 432 impl Readable for u8 {
 433         #[inline]
 434         fn read<R: Read>(reader: &mut R) -> Result<u8, DecodeError> {
 435                 let mut buf = [0; 1];
 436                 reader.read_exact(&mut buf)?;
 437                 Ok(buf[0])
 438         }
 439 }
 440
 441 impl Writeable for bool {
 442         #[inline]
 443         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 444                 writer.write_all(&[if *self {1} else {0}])
 445         }
 446 }
 447 impl Readable for bool {
 448         #[inline]
 449         fn read<R: Read>(reader: &mut R) -> Result<bool, DecodeError> {
 450                 let mut buf = [0; 1];
 451                 reader.read_exact(&mut buf)?;
 452                 if buf[0] != 0 && buf[0] != 1 {
 453                         return Err(DecodeError::InvalidValue);
 454                 }
 455                 Ok(buf[0] == 1)
 456         }
 457 }
 458
 459 // u8 arrays
 460 macro_rules! impl_array {
 461         ( $size:expr ) => (
 462                 impl Writeable for [u8; $size]
 463                 {
 464                         #[inline]
 465                         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 466                                 w.write_all(self)
 467                         }
 468                 }
 469
 470                 impl Readable for [u8; $size]
 471                 {
 472                         #[inline]
 473                         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 474                                 let mut buf = [0u8; $size];
 475                                 r.read_exact(&mut buf)?;
 476                                 Ok(buf)
 477                         }
 478                 }
 479         );
 480 }
 481
 482 //TODO: performance issue with [u8; size] with impl_array!()
 483 impl_array!(3); // for rgb
 484 impl_array!(4); // for IPv4
 485 impl_array!(10); // for OnionV2
 486 impl_array!(16); // for IPv6
 487 impl_array!(32); // for channel id & hmac
 488 impl_array!(PUBLIC_KEY_SIZE); // for PublicKey
 489 impl_array!(COMPACT_SIGNATURE_SIZE); // for Signature
 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<(), 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<(), 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<(), 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<(), 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<(), 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<(), 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<(), 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<(), 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<(), 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<(), 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<(), 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<(), 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<(), 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<(), 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<(), 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<(), 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<(), 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() == 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<(), 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<(), 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<(), io::Error> {
 850                 self.0.write(w)?;
 851                 self.1.write(w)?;
 852                 self.2.write(w)
 853         }
 854 }