_ Git - rust-lightning/blob - lightning/src/util/ser_macros.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 macro_rules! encode_tlv {
  11         ($stream: expr, $type: expr, $field: expr, (default_value, $default: expr)) => {
  12                 encode_tlv!($stream, $type, $field, required)
  13         };
  14         ($stream: expr, $type: expr, $field: expr, required) => {
  15                 BigSize($type).write($stream)?;
  16                 BigSize($field.serialized_length() as u64).write($stream)?;
  17                 $field.write($stream)?;
  18         };
  19         ($stream: expr, $type: expr, $field: expr, vec_type) => {
  20                 encode_tlv!($stream, $type, ::util::ser::VecWriteWrapper(&$field), required);
  21         };
  22         ($stream: expr, $optional_type: expr, $optional_field: expr, option) => {
  23                 if let Some(ref field) = $optional_field {
  24                         BigSize($optional_type).write($stream)?;
  25                         BigSize(field.serialized_length() as u64).write($stream)?;
  26                         field.write($stream)?;
  27                 }
  28         };
  29 }
  30
  31 macro_rules! encode_tlv_stream {
  32         ($stream: expr, {$(($type: expr, $field: expr, $fieldty: tt)),* $(,)*}) => { {
  33                 #[allow(unused_imports)]
  34                 use {
  35                         ln::msgs::DecodeError,
  36                         util::ser,
  37                         util::ser::BigSize,
  38                 };
  39
  40                 $(
  41                         encode_tlv!($stream, $type, $field, $fieldty);
  42                 )*
  43
  44                 #[allow(unused_mut, unused_variables, unused_assignments)]
  45                 #[cfg(debug_assertions)]
  46                 {
  47                         let mut last_seen: Option<u64> = None;
  48                         $(
  49                                 if let Some(t) = last_seen {
  50                                         debug_assert!(t <= $type);
  51                                 }
  52                                 last_seen = Some($type);
  53                         )*
  54                 }
  55         } }
  56 }
  57
  58 macro_rules! get_varint_length_prefixed_tlv_length {
  59         ($len: expr, $type: expr, $field: expr, (default_value, $default: expr)) => {
  60                 get_varint_length_prefixed_tlv_length!($len, $type, $field, required)
  61         };
  62         ($len: expr, $type: expr, $field: expr, required) => {
  63                 BigSize($type).write(&mut $len).expect("No in-memory data may fail to serialize");
  64                 let field_len = $field.serialized_length();
  65                 BigSize(field_len as u64).write(&mut $len).expect("No in-memory data may fail to serialize");
  66                 $len.0 += field_len;
  67         };
  68         ($len: expr, $type: expr, $field: expr, vec_type) => {
  69                 get_varint_length_prefixed_tlv_length!($len, $type, ::util::ser::VecWriteWrapper(&$field), required);
  70         };
  71         ($len: expr, $optional_type: expr, $optional_field: expr, option) => {
  72                 if let Some(ref field) = $optional_field {
  73                         BigSize($optional_type).write(&mut $len).expect("No in-memory data may fail to serialize");
  74                         let field_len = field.serialized_length();
  75                         BigSize(field_len as u64).write(&mut $len).expect("No in-memory data may fail to serialize");
  76                         $len.0 += field_len;
  77                 }
  78         };
  79 }
  80
  81 macro_rules! encode_varint_length_prefixed_tlv {
  82         ($stream: expr, {$(($type: expr, $field: expr, $fieldty: tt)),*}) => { {
  83                 use util::ser::BigSize;
  84                 let len = {
  85                         #[allow(unused_mut)]
  86                         let mut len = ::util::ser::LengthCalculatingWriter(0);
  87                         $(
  88                                 get_varint_length_prefixed_tlv_length!(len, $type, $field, $fieldty);
  89                         )*
  90                         len.0
  91                 };
  92                 BigSize(len as u64).write($stream)?;
  93                 encode_tlv_stream!($stream, { $(($type, $field, $fieldty)),* });
  94         } }
  95 }
  96
  97 macro_rules! check_tlv_order {
  98         ($last_seen_type: expr, $typ: expr, $type: expr, $field: ident, (default_value, $default: expr)) => {{
  99                 #[allow(unused_comparisons)] // Note that $type may be 0 making the second comparison always true
 100                 let invalid_order = ($last_seen_type.is_none() || $last_seen_type.unwrap() < $type) && $typ.0 > $type;
 101                 if invalid_order {
 102                         $field = $default;
 103                 }
 104         }};
 105         ($last_seen_type: expr, $typ: expr, $type: expr, $field: ident, required) => {{
 106                 #[allow(unused_comparisons)] // Note that $type may be 0 making the second comparison always true
 107                 let invalid_order = ($last_seen_type.is_none() || $last_seen_type.unwrap() < $type) && $typ.0 > $type;
 108                 if invalid_order {
 109                         return Err(DecodeError::InvalidValue);
 110                 }
 111         }};
 112         ($last_seen_type: expr, $typ: expr, $type: expr, $field: ident, option) => {{
 113                 // no-op
 114         }};
 115         ($last_seen_type: expr, $typ: expr, $type: expr, $field: ident, vec_type) => {{
 116                 // no-op
 117         }};
 118 }
 119
 120 macro_rules! check_missing_tlv {
 121         ($last_seen_type: expr, $type: expr, $field: ident, (default_value, $default: expr)) => {{
 122                 #[allow(unused_comparisons)] // Note that $type may be 0 making the second comparison always true
 123                 let missing_req_type = $last_seen_type.is_none() || $last_seen_type.unwrap() < $type;
 124                 if missing_req_type {
 125                         $field = $default;
 126                 }
 127         }};
 128         ($last_seen_type: expr, $type: expr, $field: ident, required) => {{
 129                 #[allow(unused_comparisons)] // Note that $type may be 0 making the second comparison always true
 130                 let missing_req_type = $last_seen_type.is_none() || $last_seen_type.unwrap() < $type;
 131                 if missing_req_type {
 132                         return Err(DecodeError::InvalidValue);
 133                 }
 134         }};
 135         ($last_seen_type: expr, $type: expr, $field: ident, vec_type) => {{
 136                 // no-op
 137         }};
 138         ($last_seen_type: expr, $type: expr, $field: ident, option) => {{
 139                 // no-op
 140         }};
 141 }
 142
 143 macro_rules! decode_tlv {
 144         ($reader: expr, $field: ident, (default_value, $default: expr)) => {{
 145                 decode_tlv!($reader, $field, required)
 146         }};
 147         ($reader: expr, $field: ident, required) => {{
 148                 $field = ser::Readable::read(&mut $reader)?;
 149         }};
 150         ($reader: expr, $field: ident, vec_type) => {{
 151                 $field = Some(ser::Readable::read(&mut $reader)?);
 152         }};
 153         ($reader: expr, $field: ident, option) => {{
 154                 $field = Some(ser::Readable::read(&mut $reader)?);
 155         }};
 156 }
 157
 158 macro_rules! decode_tlv_stream {
 159         ($stream: expr, {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}) => { {
 160                 use ln::msgs::DecodeError;
 161                 let mut last_seen_type: Option<u64> = None;
 162                 'tlv_read: loop {
 163                         use util::ser;
 164
 165                         // First decode the type of this TLV:
 166                         let typ: ser::BigSize = {
 167                                 // We track whether any bytes were read during the consensus_decode call to
 168                                 // determine whether we should break or return ShortRead if we get an
 169                                 // UnexpectedEof. This should in every case be largely cosmetic, but its nice to
 170                                 // pass the TLV test vectors exactly, which requre this distinction.
 171                                 let mut tracking_reader = ser::ReadTrackingReader::new($stream);
 172                                 match ser::Readable::read(&mut tracking_reader) {
 173                                         Err(DecodeError::ShortRead) => {
 174                                                 if !tracking_reader.have_read {
 175                                                         break 'tlv_read;
 176                                                 } else {
 177                                                         return Err(DecodeError::ShortRead);
 178                                                 }
 179                                         },
 180                                         Err(e) => return Err(e),
 181                                         Ok(t) => t,
 182                                 }
 183                         };
 184
 185                         // Types must be unique and monotonically increasing:
 186                         match last_seen_type {
 187                                 Some(t) if typ.0 <= t => {
 188                                         return Err(DecodeError::InvalidValue);
 189                                 },
 190                                 _ => {},
 191                         }
 192                         // As we read types, make sure we hit every required type:
 193                         $({
 194                                 check_tlv_order!(last_seen_type, typ, $type, $field, $fieldty);
 195                         })*
 196                         last_seen_type = Some(typ.0);
 197
 198                         // Finally, read the length and value itself:
 199                         let length: ser::BigSize = ser::Readable::read($stream)?;
 200                         let mut s = ser::FixedLengthReader::new($stream, length.0);
 201                         match typ.0 {
 202                                 $($type => {
 203                                         decode_tlv!(s, $field, $fieldty);
 204                                         if s.bytes_remain() {
 205                                                 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
 206                                                 return Err(DecodeError::InvalidValue);
 207                                         }
 208                                 },)*
 209                                 x if x % 2 == 0 => {
 210                                         return Err(DecodeError::UnknownRequiredFeature);
 211                                 },
 212                                 _ => {},
 213                         }
 214                         s.eat_remaining()?;
 215                 }
 216                 // Make sure we got to each required type after we've read every TLV:
 217                 $({
 218                         check_missing_tlv!(last_seen_type, $type, $field, $fieldty);
 219                 })*
 220         } }
 221 }
 222
 223 macro_rules! impl_writeable {
 224         ($st:ident, $len: expr, {$($field:ident),*}) => {
 225                 impl ::util::ser::Writeable for $st {
 226                         fn write<W: ::util::ser::Writer>(&self, w: &mut W) -> Result<(), $crate::io::Error> {
 227                                 if $len != 0 {
 228                                         w.size_hint($len);
 229                                 }
 230                                 #[cfg(any(test, feature = "fuzztarget"))]
 231                                 {
 232                                         // In tests, assert that the hard-coded length matches the actual one
 233                                         if $len != 0 {
 234                                                 let mut len_calc = ::util::ser::LengthCalculatingWriter(0);
 235                                                 $( self.$field.write(&mut len_calc).expect("No in-memory data may fail to serialize"); )*
 236                                                 assert_eq!(len_calc.0, $len);
 237                                                 assert_eq!(self.serialized_length(), $len);
 238                                         }
 239                                 }
 240                                 $( self.$field.write(w)?; )*
 241                                 Ok(())
 242                         }
 243
 244                         #[inline]
 245                         fn serialized_length(&self) -> usize {
 246                                 if $len == 0 || cfg!(any(test, feature = "fuzztarget")) {
 247                                         let mut len_calc = 0;
 248                                         $( len_calc += self.$field.serialized_length(); )*
 249                                         if $len != 0 {
 250                                                 // In tests, assert that the hard-coded length matches the actual one
 251                                                 assert_eq!(len_calc, $len);
 252                                         } else {
 253                                                 return len_calc;
 254                                         }
 255                                 }
 256                                 $len
 257                         }
 258                 }
 259
 260                 impl ::util::ser::Readable for $st {
 261                         fn read<R: $crate::io::Read>(r: &mut R) -> Result<Self, ::ln::msgs::DecodeError> {
 262                                 Ok(Self {
 263                                         $($field: ::util::ser::Readable::read(r)?),*
 264                                 })
 265                         }
 266                 }
 267         }
 268 }
 269 macro_rules! impl_writeable_len_match {
 270         ($struct: ident, $cmp: tt, ($calc_len: expr), {$({$match: pat, $length: expr}),*}, {$($field:ident),*}) => {
 271                 impl Writeable for $struct {
 272                         fn write<W: Writer>(&self, w: &mut W) -> Result<(), $crate::io::Error> {
 273                                 let len = match *self {
 274                                         $($match => $length,)*
 275                                 };
 276                                 w.size_hint(len);
 277                                 #[cfg(any(test, feature = "fuzztarget"))]
 278                                 {
 279                                         // In tests, assert that the hard-coded length matches the actual one
 280                                         let mut len_calc = ::util::ser::LengthCalculatingWriter(0);
 281                                         $( self.$field.write(&mut len_calc).expect("No in-memory data may fail to serialize"); )*
 282                                         assert!(len_calc.0 $cmp len);
 283                                         assert_eq!(len_calc.0, self.serialized_length());
 284                                 }
 285                                 $( self.$field.write(w)?; )*
 286                                 Ok(())
 287                         }
 288
 289                         #[inline]
 290                         fn serialized_length(&self) -> usize {
 291                                 if $calc_len || cfg!(any(test, feature = "fuzztarget")) {
 292                                         let mut len_calc = 0;
 293                                         $( len_calc += self.$field.serialized_length(); )*
 294                                         if !$calc_len {
 295                                                 assert_eq!(len_calc, match *self {
 296                                                         $($match => $length,)*
 297                                                 });
 298                                         }
 299                                         return len_calc
 300                                 }
 301                                 match *self {
 302                                         $($match => $length,)*
 303                                 }
 304                         }
 305                 }
 306
 307                 impl ::util::ser::Readable for $struct {
 308                         fn read<R: $crate::io::Read>(r: &mut R) -> Result<Self, DecodeError> {
 309                                 Ok(Self {
 310                                         $($field: Readable::read(r)?),*
 311                                 })
 312                         }
 313                 }
 314         };
 315         ($struct: ident, $cmp: tt, {$({$match: pat, $length: expr}),*}, {$($field:ident),*}) => {
 316                 impl_writeable_len_match!($struct, $cmp, (true), { $({ $match, $length }),* }, { $($field),* });
 317         };
 318         ($struct: ident, {$({$match: pat, $length: expr}),*}, {$($field:ident),*}) => {
 319                 impl_writeable_len_match!($struct, ==, (false), { $({ $match, $length }),* }, { $($field),* });
 320         }
 321 }
 322
 323 /// Write out two bytes to indicate the version of an object.
 324 /// $this_version represents a unique version of a type. Incremented whenever the type's
 325 ///               serialization format has changed or has a new interpretation. Used by a type's
 326 ///               reader to determine how to interpret fields or if it can understand a serialized
 327 ///               object.
 328 /// $min_version_that_can_read_this is the minimum reader version which can understand this
 329 ///                                 serialized object. Previous versions will simply err with a
 330 ///                                 DecodeError::UnknownVersion.
 331 ///
 332 /// Updates to either $this_version or $min_version_that_can_read_this should be included in
 333 /// release notes.
 334 ///
 335 /// Both version fields can be specific to this type of object.
 336 macro_rules! write_ver_prefix {
 337         ($stream: expr, $this_version: expr, $min_version_that_can_read_this: expr) => {
 338                 $stream.write_all(&[$this_version; 1])?;
 339                 $stream.write_all(&[$min_version_that_can_read_this; 1])?;
 340         }
 341 }
 342
 343 /// Writes out a suffix to an object which contains potentially backwards-compatible, optional
 344 /// fields which old nodes can happily ignore.
 345 ///
 346 /// It is written out in TLV format and, as with all TLV fields, unknown even fields cause a
 347 /// DecodeError::UnknownRequiredFeature error, with unknown odd fields ignored.
 348 ///
 349 /// This is the preferred method of adding new fields that old nodes can ignore and still function
 350 /// correctly.
 351 macro_rules! write_tlv_fields {
 352         ($stream: expr, {$(($type: expr, $field: expr, $fieldty: tt)),* $(,)*}) => {
 353                 encode_varint_length_prefixed_tlv!($stream, {$(($type, $field, $fieldty)),*});
 354         }
 355 }
 356
 357 /// Reads a prefix added by write_ver_prefix!(), above. Takes the current version of the
 358 /// serialization logic for this object. This is compared against the
 359 /// $min_version_that_can_read_this added by write_ver_prefix!().
 360 macro_rules! read_ver_prefix {
 361         ($stream: expr, $this_version: expr) => { {
 362                 let ver: u8 = Readable::read($stream)?;
 363                 let min_ver: u8 = Readable::read($stream)?;
 364                 if min_ver > $this_version {
 365                         return Err(DecodeError::UnknownVersion);
 366                 }
 367                 ver
 368         } }
 369 }
 370
 371 /// Reads a suffix added by write_tlv_fields.
 372 macro_rules! read_tlv_fields {
 373         ($stream: expr, {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}) => { {
 374                 let tlv_len: ::util::ser::BigSize = ::util::ser::Readable::read($stream)?;
 375                 let mut rd = ::util::ser::FixedLengthReader::new($stream, tlv_len.0);
 376                 decode_tlv_stream!(&mut rd, {$(($type, $field, $fieldty)),*});
 377                 rd.eat_remaining().map_err(|_| ::ln::msgs::DecodeError::ShortRead)?;
 378         } }
 379 }
 380
 381 macro_rules! init_tlv_based_struct_field {
 382         ($field: ident, (default_value, $default: expr)) => {
 383                 $field
 384         };
 385         ($field: ident, option) => {
 386                 $field
 387         };
 388         ($field: ident, required) => {
 389                 $field.0.unwrap()
 390         };
 391         ($field: ident, vec_type) => {
 392                 $field.unwrap().0
 393         };
 394 }
 395
 396 macro_rules! init_tlv_field_var {
 397         ($field: ident, (default_value, $default: expr)) => {
 398                 let mut $field = $default;
 399         };
 400         ($field: ident, required) => {
 401                 let mut $field = ::util::ser::OptionDeserWrapper(None);
 402         };
 403         ($field: ident, vec_type) => {
 404                 let mut $field = Some(::util::ser::VecReadWrapper(Vec::new()));
 405         };
 406         ($field: ident, option) => {
 407                 let mut $field = None;
 408         }
 409 }
 410
 411 /// Implements Readable/Writeable for a struct storing it as a set of TLVs
 412 /// If $fieldty is `required`, then $field is a required field that is not an Option nor a Vec.
 413 /// If $fieldty is `option`, then $field is optional field.
 414 /// if $fieldty is `vec_type`, then $field is a Vec, which needs to have its individual elements
 415 /// serialized.
 416 macro_rules! impl_writeable_tlv_based {
 417         ($st: ident, {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}) => {
 418                 impl ::util::ser::Writeable for $st {
 419                         fn write<W: ::util::ser::Writer>(&self, writer: &mut W) -> Result<(), $crate::io::Error> {
 420                                 write_tlv_fields!(writer, {
 421                                         $(($type, self.$field, $fieldty)),*
 422                                 });
 423                                 Ok(())
 424                         }
 425
 426                         #[inline]
 427                         fn serialized_length(&self) -> usize {
 428                                 use util::ser::BigSize;
 429                                 let len = {
 430                                         #[allow(unused_mut)]
 431                                         let mut len = ::util::ser::LengthCalculatingWriter(0);
 432                                         $(
 433                                                 get_varint_length_prefixed_tlv_length!(len, $type, self.$field, $fieldty);
 434                                         )*
 435                                         len.0
 436                                 };
 437                                 let mut len_calc = ::util::ser::LengthCalculatingWriter(0);
 438                                 BigSize(len as u64).write(&mut len_calc).expect("No in-memory data may fail to serialize");
 439                                 len + len_calc.0
 440                         }
 441                 }
 442
 443                 impl ::util::ser::Readable for $st {
 444                         fn read<R: $crate::io::Read>(reader: &mut R) -> Result<Self, ::ln::msgs::DecodeError> {
 445                                 $(
 446                                         init_tlv_field_var!($field, $fieldty);
 447                                 )*
 448                                 read_tlv_fields!(reader, {
 449                                         $(($type, $field, $fieldty)),*
 450                                 });
 451                                 Ok(Self {
 452                                         $(
 453                                                 $field: init_tlv_based_struct_field!($field, $fieldty)
 454                                         ),*
 455                                 })
 456                         }
 457                 }
 458         }
 459 }
 460
 461 /// Implement Readable and Writeable for an enum, with struct variants stored as TLVs and tuple
 462 /// variants stored directly.
 463 /// The format is, for example
 464 /// impl_writeable_tlv_based_enum!(EnumName,
 465 ///   (0, StructVariantA) => {(0, required_variant_field, required), (1, optional_variant_field, option)},
 466 ///   (1, StructVariantB) => {(0, variant_field_a, required), (1, variant_field_b, required), (2, variant_vec_field, vec_type)};
 467 ///   (2, TupleVariantA), (3, TupleVariantB),
 468 /// );
 469 /// The type is written as a single byte, followed by any variant data.
 470 /// Attempts to read an unknown type byte result in DecodeError::UnknownRequiredFeature.
 471 macro_rules! impl_writeable_tlv_based_enum {
 472         ($st: ident, $(($variant_id: expr, $variant_name: ident) =>
 473                 {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}
 474         ),* $(,)*;
 475         $(($tuple_variant_id: expr, $tuple_variant_name: ident)),*  $(,)*) => {
 476                 impl ::util::ser::Writeable for $st {
 477                         fn write<W: ::util::ser::Writer>(&self, writer: &mut W) -> Result<(), $crate::io::Error> {
 478                                 match self {
 479                                         $($st::$variant_name { $(ref $field),* } => {
 480                                                 let id: u8 = $variant_id;
 481                                                 id.write(writer)?;
 482                                                 write_tlv_fields!(writer, {
 483                                                         $(($type, $field, $fieldty)),*
 484                                                 });
 485                                         }),*
 486                                         $($st::$tuple_variant_name (ref field) => {
 487                                                 let id: u8 = $tuple_variant_id;
 488                                                 id.write(writer)?;
 489                                                 field.write(writer)?;
 490                                         }),*
 491                                 }
 492                                 Ok(())
 493                         }
 494                 }
 495
 496                 impl ::util::ser::Readable for $st {
 497                         fn read<R: $crate::io::Read>(reader: &mut R) -> Result<Self, ::ln::msgs::DecodeError> {
 498                                 let id: u8 = ::util::ser::Readable::read(reader)?;
 499                                 match id {
 500                                         $($variant_id => {
 501                                                 // Because read_tlv_fields creates a labeled loop, we cannot call it twice
 502                                                 // in the same function body. Instead, we define a closure and call it.
 503                                                 let f = || {
 504                                                         $(
 505                                                                 init_tlv_field_var!($field, $fieldty);
 506                                                         )*
 507                                                         read_tlv_fields!(reader, {
 508                                                                 $(($type, $field, $fieldty)),*
 509                                                         });
 510                                                         Ok($st::$variant_name {
 511                                                                 $(
 512                                                                         $field: init_tlv_based_struct_field!($field, $fieldty)
 513                                                                 ),*
 514                                                         })
 515                                                 };
 516                                                 f()
 517                                         }),*
 518                                         $($tuple_variant_id => {
 519                                                 Ok($st::$tuple_variant_name(Readable::read(reader)?))
 520                                         }),*
 521                                         _ => {
 522                                                 Err(DecodeError::UnknownRequiredFeature)
 523                                         },
 524                                 }
 525                         }
 526                 }
 527         }
 528 }
 529
 530 #[cfg(test)]
 531 mod tests {
 532         use io::{self, Cursor};
 533         use prelude::*;
 534         use ln::msgs::DecodeError;
 535         use util::ser::{Writeable, HighZeroBytesDroppedVarInt, VecWriter};
 536         use bitcoin::secp256k1::PublicKey;
 537
 538         // The BOLT TLV test cases don't include any tests which use our "required-value" logic since
 539         // the encoding layer in the BOLTs has no such concept, though it makes our macros easier to
 540         // work with so they're baked into the decoder. Thus, we have a few additional tests below
 541         fn tlv_reader(s: &[u8]) -> Result<(u64, u32, Option<u32>), DecodeError> {
 542                 let mut s = Cursor::new(s);
 543                 let mut a: u64 = 0;
 544                 let mut b: u32 = 0;
 545                 let mut c: Option<u32> = None;
 546                 decode_tlv_stream!(&mut s, {(2, a, required), (3, b, required), (4, c, option)});
 547                 Ok((a, b, c))
 548         }
 549
 550         #[test]
 551         fn tlv_v_short_read() {
 552                 // We only expect a u32 for type 3 (which we are given), but the L says its 8 bytes.
 553                 if let Err(DecodeError::ShortRead) = tlv_reader(&::hex::decode(
 554                                 concat!("0100", "0208deadbeef1badbeef", "0308deadbeef")
 555                                 ).unwrap()[..]) {
 556                 } else { panic!(); }
 557         }
 558
 559         #[test]
 560         fn tlv_types_out_of_order() {
 561                 if let Err(DecodeError::InvalidValue) = tlv_reader(&::hex::decode(
 562                                 concat!("0100", "0304deadbeef", "0208deadbeef1badbeef")
 563                                 ).unwrap()[..]) {
 564                 } else { panic!(); }
 565                 // ...even if its some field we don't understand
 566                 if let Err(DecodeError::InvalidValue) = tlv_reader(&::hex::decode(
 567                                 concat!("0208deadbeef1badbeef", "0100", "0304deadbeef")
 568                                 ).unwrap()[..]) {
 569                 } else { panic!(); }
 570         }
 571
 572         #[test]
 573         fn tlv_req_type_missing_or_extra() {
 574                 // It's also bad if they included even fields we don't understand
 575                 if let Err(DecodeError::UnknownRequiredFeature) = tlv_reader(&::hex::decode(
 576                                 concat!("0100", "0208deadbeef1badbeef", "0304deadbeef", "0600")
 577                                 ).unwrap()[..]) {
 578                 } else { panic!(); }
 579                 // ... or if they're missing fields we need
 580                 if let Err(DecodeError::InvalidValue) = tlv_reader(&::hex::decode(
 581                                 concat!("0100", "0208deadbeef1badbeef")
 582                                 ).unwrap()[..]) {
 583                 } else { panic!(); }
 584                 // ... even if that field is even
 585                 if let Err(DecodeError::InvalidValue) = tlv_reader(&::hex::decode(
 586                                 concat!("0304deadbeef", "0500")
 587                                 ).unwrap()[..]) {
 588                 } else { panic!(); }
 589         }
 590
 591         #[test]
 592         fn tlv_simple_good_cases() {
 593                 assert_eq!(tlv_reader(&::hex::decode(
 594                                 concat!("0208deadbeef1badbeef", "03041bad1dea")
 595                                 ).unwrap()[..]).unwrap(),
 596                         (0xdeadbeef1badbeef, 0x1bad1dea, None));
 597                 assert_eq!(tlv_reader(&::hex::decode(
 598                                 concat!("0208deadbeef1badbeef", "03041bad1dea", "040401020304")
 599                                 ).unwrap()[..]).unwrap(),
 600                         (0xdeadbeef1badbeef, 0x1bad1dea, Some(0x01020304)));
 601         }
 602
 603         // BOLT TLV test cases
 604         fn tlv_reader_n1(s: &[u8]) -> Result<(Option<HighZeroBytesDroppedVarInt<u64>>, Option<u64>, Option<(PublicKey, u64, u64)>, Option<u16>), DecodeError> {
 605                 let mut s = Cursor::new(s);
 606                 let mut tlv1: Option<HighZeroBytesDroppedVarInt<u64>> = None;
 607                 let mut tlv2: Option<u64> = None;
 608                 let mut tlv3: Option<(PublicKey, u64, u64)> = None;
 609                 let mut tlv4: Option<u16> = None;
 610                 decode_tlv_stream!(&mut s, {(1, tlv1, option), (2, tlv2, option), (3, tlv3, option), (254, tlv4, option)});
 611                 Ok((tlv1, tlv2, tlv3, tlv4))
 612         }
 613
 614         #[test]
 615         fn bolt_tlv_bogus_stream() {
 616                 macro_rules! do_test {
 617                         ($stream: expr, $reason: ident) => {
 618                                 if let Err(DecodeError::$reason) = tlv_reader_n1(&::hex::decode($stream).unwrap()[..]) {
 619                                 } else { panic!(); }
 620                         }
 621                 }
 622
 623                 // TLVs from the BOLT test cases which should not decode as either n1 or n2
 624                 do_test!(concat!("fd01"), ShortRead);
 625                 do_test!(concat!("fd0001", "00"), InvalidValue);
 626                 do_test!(concat!("fd0101"), ShortRead);
 627                 do_test!(concat!("0f", "fd"), ShortRead);
 628                 do_test!(concat!("0f", "fd26"), ShortRead);
 629                 do_test!(concat!("0f", "fd2602"), ShortRead);
 630                 do_test!(concat!("0f", "fd0001", "00"), InvalidValue);
 631                 do_test!(concat!("0f", "fd0201", "000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"), ShortRead);
 632
 633                 do_test!(concat!("12", "00"), UnknownRequiredFeature);
 634                 do_test!(concat!("fd0102", "00"), UnknownRequiredFeature);
 635                 do_test!(concat!("fe01000002", "00"), UnknownRequiredFeature);
 636                 do_test!(concat!("ff0100000000000002", "00"), UnknownRequiredFeature);
 637         }
 638
 639         #[test]
 640         fn bolt_tlv_bogus_n1_stream() {
 641                 macro_rules! do_test {
 642                         ($stream: expr, $reason: ident) => {
 643                                 if let Err(DecodeError::$reason) = tlv_reader_n1(&::hex::decode($stream).unwrap()[..]) {
 644                                 } else { panic!(); }
 645                         }
 646                 }
 647
 648                 // TLVs from the BOLT test cases which should not decode as n1
 649                 do_test!(concat!("01", "09", "ffffffffffffffffff"), InvalidValue);
 650                 do_test!(concat!("01", "01", "00"), InvalidValue);
 651                 do_test!(concat!("01", "02", "0001"), InvalidValue);
 652                 do_test!(concat!("01", "03", "000100"), InvalidValue);
 653                 do_test!(concat!("01", "04", "00010000"), InvalidValue);
 654                 do_test!(concat!("01", "05", "0001000000"), InvalidValue);
 655                 do_test!(concat!("01", "06", "000100000000"), InvalidValue);
 656                 do_test!(concat!("01", "07", "00010000000000"), InvalidValue);
 657                 do_test!(concat!("01", "08", "0001000000000000"), InvalidValue);
 658                 do_test!(concat!("02", "07", "01010101010101"), ShortRead);
 659                 do_test!(concat!("02", "09", "010101010101010101"), InvalidValue);
 660                 do_test!(concat!("03", "21", "023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb"), ShortRead);
 661                 do_test!(concat!("03", "29", "023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb0000000000000001"), ShortRead);
 662                 do_test!(concat!("03", "30", "023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb000000000000000100000000000001"), ShortRead);
 663                 do_test!(concat!("03", "31", "043da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb00000000000000010000000000000002"), InvalidValue);
 664                 do_test!(concat!("03", "32", "023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb0000000000000001000000000000000001"), InvalidValue);
 665                 do_test!(concat!("fd00fe", "00"), ShortRead);
 666                 do_test!(concat!("fd00fe", "01", "01"), ShortRead);
 667                 do_test!(concat!("fd00fe", "03", "010101"), InvalidValue);
 668                 do_test!(concat!("00", "00"), UnknownRequiredFeature);
 669
 670                 do_test!(concat!("02", "08", "0000000000000226", "01", "01", "2a"), InvalidValue);
 671                 do_test!(concat!("02", "08", "0000000000000231", "02", "08", "0000000000000451"), InvalidValue);
 672                 do_test!(concat!("1f", "00", "0f", "01", "2a"), InvalidValue);
 673                 do_test!(concat!("1f", "00", "1f", "01", "2a"), InvalidValue);
 674
 675                 // The last BOLT test modified to not require creating a new decoder for one trivial test.
 676                 do_test!(concat!("ffffffffffffffffff", "00", "01", "00"), InvalidValue);
 677         }
 678
 679         #[test]
 680         fn bolt_tlv_valid_n1_stream() {
 681                 macro_rules! do_test {
 682                         ($stream: expr, $tlv1: expr, $tlv2: expr, $tlv3: expr, $tlv4: expr) => {
 683                                 if let Ok((tlv1, tlv2, tlv3, tlv4)) = tlv_reader_n1(&::hex::decode($stream).unwrap()[..]) {
 684                                         assert_eq!(tlv1.map(|v| v.0), $tlv1);
 685                                         assert_eq!(tlv2, $tlv2);
 686                                         assert_eq!(tlv3, $tlv3);
 687                                         assert_eq!(tlv4, $tlv4);
 688                                 } else { panic!(); }
 689                         }
 690                 }
 691
 692                 do_test!(concat!(""), None, None, None, None);
 693                 do_test!(concat!("21", "00"), None, None, None, None);
 694                 do_test!(concat!("fd0201", "00"), None, None, None, None);
 695                 do_test!(concat!("fd00fd", "00"), None, None, None, None);
 696                 do_test!(concat!("fd00ff", "00"), None, None, None, None);
 697                 do_test!(concat!("fe02000001", "00"), None, None, None, None);
 698                 do_test!(concat!("ff0200000000000001", "00"), None, None, None, None);
 699
 700                 do_test!(concat!("01", "00"), Some(0), None, None, None);
 701                 do_test!(concat!("01", "01", "01"), Some(1), None, None, None);
 702                 do_test!(concat!("01", "02", "0100"), Some(256), None, None, None);
 703                 do_test!(concat!("01", "03", "010000"), Some(65536), None, None, None);
 704                 do_test!(concat!("01", "04", "01000000"), Some(16777216), None, None, None);
 705                 do_test!(concat!("01", "05", "0100000000"), Some(4294967296), None, None, None);
 706                 do_test!(concat!("01", "06", "010000000000"), Some(1099511627776), None, None, None);
 707                 do_test!(concat!("01", "07", "01000000000000"), Some(281474976710656), None, None, None);
 708                 do_test!(concat!("01", "08", "0100000000000000"), Some(72057594037927936), None, None, None);
 709                 do_test!(concat!("02", "08", "0000000000000226"), None, Some((0 << 30) | (0 << 5) | (550 << 0)), None, None);
 710                 do_test!(concat!("03", "31", "023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb00000000000000010000000000000002"),
 711                         None, None, Some((
 712                                 PublicKey::from_slice(&::hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]).unwrap(), 1, 2)),
 713                         None);
 714                 do_test!(concat!("fd00fe", "02", "0226"), None, None, None, Some(550));
 715         }
 716
 717         fn do_simple_test_tlv_write() -> Result<(), io::Error> {
 718                 let mut stream = VecWriter(Vec::new());
 719
 720                 stream.0.clear();
 721                 encode_varint_length_prefixed_tlv!(&mut stream, {(1, 1u8, required), (42, None::<u64>, option)});
 722                 assert_eq!(stream.0, ::hex::decode("03010101").unwrap());
 723
 724                 stream.0.clear();
 725                 encode_varint_length_prefixed_tlv!(&mut stream, {(1, Some(1u8), option)});
 726                 assert_eq!(stream.0, ::hex::decode("03010101").unwrap());
 727
 728                 stream.0.clear();
 729                 encode_varint_length_prefixed_tlv!(&mut stream, {(4, 0xabcdu16, required), (42, None::<u64>, option)});
 730                 assert_eq!(stream.0, ::hex::decode("040402abcd").unwrap());
 731
 732                 stream.0.clear();
 733                 encode_varint_length_prefixed_tlv!(&mut stream, {(42, None::<u64>, option), (0xff, 0xabcdu16, required)});
 734                 assert_eq!(stream.0, ::hex::decode("06fd00ff02abcd").unwrap());
 735
 736                 stream.0.clear();
 737                 encode_varint_length_prefixed_tlv!(&mut stream, {(0, 1u64, required), (42, None::<u64>, option), (0xff, HighZeroBytesDroppedVarInt(0u64), required)});
 738                 assert_eq!(stream.0, ::hex::decode("0e00080000000000000001fd00ff00").unwrap());
 739
 740                 stream.0.clear();
 741                 encode_varint_length_prefixed_tlv!(&mut stream, {(0, Some(1u64), option), (0xff, HighZeroBytesDroppedVarInt(0u64), required)});
 742                 assert_eq!(stream.0, ::hex::decode("0e00080000000000000001fd00ff00").unwrap());
 743
 744                 Ok(())
 745         }
 746
 747         #[test]
 748         fn simple_test_tlv_write() {
 749                 do_simple_test_tlv_write().unwrap();
 750         }
 751 }