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