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