_ 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 //! Some macros that implement [`Readable`]/[`Writeable`] traits for lightning messages.
  11 //! They also handle serialization and deserialization of TLVs.
  12 //!
  13 //! [`Readable`]: crate::util::ser::Readable
  14 //! [`Writeable`]: crate::util::ser::Writeable
  15
  16 /// Implements serialization for a single TLV record.
  17 /// This is exported for use by other exported macros, do not use directly.
  18 #[doc(hidden)]
  19 #[macro_export]
  20 macro_rules! _encode_tlv {
  21         ($stream: expr, $type: expr, $field: expr, (default_value, $default: expr)) => {
  22                 $crate::_encode_tlv!($stream, $type, $field, required)
  23         };
  24         ($stream: expr, $type: expr, $field: expr, (static_value, $value: expr)) => {
  25                 let _ = &$field; // Ensure we "use" the $field
  26         };
  27         ($stream: expr, $type: expr, $field: expr, required) => {
  28                 BigSize($type).write($stream)?;
  29                 BigSize($field.serialized_length() as u64).write($stream)?;
  30                 $field.write($stream)?;
  31         };
  32         ($stream: expr, $type: expr, $field: expr, vec_type) => {
  33                 $crate::_encode_tlv!($stream, $type, $crate::util::ser::WithoutLength(&$field), required);
  34         };
  35         ($stream: expr, $optional_type: expr, $optional_field: expr, option) => {
  36                 if let Some(ref field) = $optional_field {
  37                         BigSize($optional_type).write($stream)?;
  38                         BigSize(field.serialized_length() as u64).write($stream)?;
  39                         field.write($stream)?;
  40                 }
  41         };
  42         ($stream: expr, $type: expr, $field: expr, ignorable) => {
  43                 $crate::_encode_tlv!($stream, $type, $field, required);
  44         };
  45         ($stream: expr, $type: expr, $field: expr, (option, encoding: ($fieldty: ty, $encoding: ident))) => {
  46                 $crate::_encode_tlv!($stream, $type, $field.map(|f| $encoding(f)), option);
  47         };
  48         ($stream: expr, $type: expr, $field: expr, (option, encoding: $fieldty: ty)) => {
  49                 $crate::_encode_tlv!($stream, $type, $field, option);
  50         };
  51 }
  52
  53 /// Panics if the last seen TLV type is not numerically less than the TLV type currently being checked.
  54 /// This is exported for use by other exported macros, do not use directly.
  55 #[doc(hidden)]
  56 #[macro_export]
  57 macro_rules! _check_encoded_tlv_order {
  58         ($last_type: expr, $type: expr, (static_value, $value: expr)) => { };
  59         ($last_type: expr, $type: expr, $fieldty: tt) => {
  60                 if let Some(t) = $last_type {
  61                         #[allow(unused_comparisons)] // Note that $type may be 0 making the following comparison always false
  62                         (debug_assert!(t < $type))
  63                 }
  64                 $last_type = Some($type);
  65         };
  66 }
  67
  68 /// Implements the TLVs serialization part in a [`Writeable`] implementation of a struct.
  69 ///
  70 /// This should be called inside a method which returns `Result<_, `[`io::Error`]`>`, such as
  71 /// [`Writeable::write`]. It will only return an `Err` if the stream `Err`s or [`Writeable::write`]
  72 /// on one of the fields `Err`s.
  73 ///
  74 /// `$stream` must be a `&mut `[`Writer`] which will receive the bytes for each TLV in the stream.
  75 ///
  76 /// Fields MUST be sorted in `$type`-order.
  77 ///
  78 /// Note that the lightning TLV requirements require that a single type not appear more than once,
  79 /// that TLVs are sorted in type-ascending order, and that any even types be understood by the
  80 /// decoder.
  81 ///
  82 /// Any `option` fields which have a value of `None` will not be serialized at all.
  83 ///
  84 /// For example,
  85 /// ```
  86 /// # use lightning::encode_tlv_stream;
  87 /// # fn write<W: lightning::util::ser::Writer> (stream: &mut W) -> Result<(), lightning::io::Error> {
  88 /// let mut required_value = 0u64;
  89 /// let mut optional_value: Option<u64> = None;
  90 /// encode_tlv_stream!(stream, {
  91 ///     (0, required_value, required),
  92 ///     (1, Some(42u64), option),
  93 ///     (2, optional_value, option),
  94 /// });
  95 /// // At this point `required_value` has been written as a TLV of type 0, `42u64` has been written
  96 /// // as a TLV of type 1 (indicating the reader may ignore it if it is not understood), and *no*
  97 /// // TLV is written with type 2.
  98 /// # Ok(())
  99 /// # }
 100 /// ```
 101 ///
 102 /// [`Writeable`]: crate::util::ser::Writeable
 103 /// [`io::Error`]: crate::io::Error
 104 /// [`Writeable::write`]: crate::util::ser::Writeable::write
 105 /// [`Writer`]: crate::util::ser::Writer
 106 #[macro_export]
 107 macro_rules! encode_tlv_stream {
 108         ($stream: expr, {$(($type: expr, $field: expr, $fieldty: tt)),* $(,)*}) => { {
 109                 #[allow(unused_imports)]
 110                 use $crate::{
 111                         ln::msgs::DecodeError,
 112                         util::ser,
 113                         util::ser::BigSize,
 114                         util::ser::Writeable,
 115                 };
 116
 117                 $(
 118                         $crate::_encode_tlv!($stream, $type, $field, $fieldty);
 119                 )*
 120
 121                 #[allow(unused_mut, unused_variables, unused_assignments)]
 122                 #[cfg(debug_assertions)]
 123                 {
 124                         let mut last_seen: Option<u64> = None;
 125                         $(
 126                                 $crate::_check_encoded_tlv_order!(last_seen, $type, $fieldty);
 127                         )*
 128                 }
 129         } }
 130 }
 131
 132 /// Adds the length of the serialized field to a [`LengthCalculatingWriter`].
 133 /// This is exported for use by other exported macros, do not use directly.
 134 ///
 135 /// [`LengthCalculatingWriter`]: crate::util::ser::LengthCalculatingWriter
 136 #[doc(hidden)]
 137 #[macro_export]
 138 macro_rules! _get_varint_length_prefixed_tlv_length {
 139         ($len: expr, $type: expr, $field: expr, (default_value, $default: expr)) => {
 140                 $crate::_get_varint_length_prefixed_tlv_length!($len, $type, $field, required)
 141         };
 142         ($len: expr, $type: expr, $field: expr, (static_value, $value: expr)) => {
 143         };
 144         ($len: expr, $type: expr, $field: expr, required) => {
 145                 BigSize($type).write(&mut $len).expect("No in-memory data may fail to serialize");
 146                 let field_len = $field.serialized_length();
 147                 BigSize(field_len as u64).write(&mut $len).expect("No in-memory data may fail to serialize");
 148                 $len.0 += field_len;
 149         };
 150         ($len: expr, $type: expr, $field: expr, vec_type) => {
 151                 $crate::_get_varint_length_prefixed_tlv_length!($len, $type, $crate::util::ser::WithoutLength(&$field), required);
 152         };
 153         ($len: expr, $optional_type: expr, $optional_field: expr, option) => {
 154                 if let Some(ref field) = $optional_field {
 155                         BigSize($optional_type).write(&mut $len).expect("No in-memory data may fail to serialize");
 156                         let field_len = field.serialized_length();
 157                         BigSize(field_len as u64).write(&mut $len).expect("No in-memory data may fail to serialize");
 158                         $len.0 += field_len;
 159                 }
 160         };
 161         ($len: expr, $type: expr, $field: expr, ignorable) => {
 162                 $crate::_get_varint_length_prefixed_tlv_length!($len, $type, $field, required);
 163         };
 164 }
 165
 166 /// See the documentation of [`write_tlv_fields`].
 167 /// This is exported for use by other exported macros, do not use directly.
 168 #[doc(hidden)]
 169 #[macro_export]
 170 macro_rules! _encode_varint_length_prefixed_tlv {
 171         ($stream: expr, {$(($type: expr, $field: expr, $fieldty: tt)),*}) => { {
 172                 use $crate::util::ser::BigSize;
 173                 let len = {
 174                         #[allow(unused_mut)]
 175                         let mut len = $crate::util::ser::LengthCalculatingWriter(0);
 176                         $(
 177                                 $crate::_get_varint_length_prefixed_tlv_length!(len, $type, $field, $fieldty);
 178                         )*
 179                         len.0
 180                 };
 181                 BigSize(len as u64).write($stream)?;
 182                 $crate::encode_tlv_stream!($stream, { $(($type, $field, $fieldty)),* });
 183         } }
 184 }
 185
 186 /// Errors if there are missing required TLV types between the last seen type and the type currently being processed.
 187 /// This is exported for use by other exported macros, do not use directly.
 188 #[doc(hidden)]
 189 #[macro_export]
 190 macro_rules! _check_decoded_tlv_order {
 191         ($last_seen_type: expr, $typ: expr, $type: expr, $field: ident, (default_value, $default: expr)) => {{
 192                 #[allow(unused_comparisons)] // Note that $type may be 0 making the second comparison always false
 193                 let invalid_order = ($last_seen_type.is_none() || $last_seen_type.unwrap() < $type) && $typ.0 > $type;
 194                 if invalid_order {
 195                         $field = $default.into();
 196                 }
 197         }};
 198         ($last_seen_type: expr, $typ: expr, $type: expr, $field: ident, (static_value, $value: expr)) => {
 199         };
 200         ($last_seen_type: expr, $typ: expr, $type: expr, $field: ident, required) => {{
 201                 #[allow(unused_comparisons)] // Note that $type may be 0 making the second comparison always false
 202                 let invalid_order = ($last_seen_type.is_none() || $last_seen_type.unwrap() < $type) && $typ.0 > $type;
 203                 if invalid_order {
 204                         return Err(DecodeError::InvalidValue);
 205                 }
 206         }};
 207         ($last_seen_type: expr, $typ: expr, $type: expr, $field: ident, option) => {{
 208                 // no-op
 209         }};
 210         ($last_seen_type: expr, $typ: expr, $type: expr, $field: ident, vec_type) => {{
 211                 // no-op
 212         }};
 213         ($last_seen_type: expr, $typ: expr, $type: expr, $field: ident, ignorable) => {{
 214                 // no-op
 215         }};
 216         ($last_seen_type: expr, $typ: expr, $type: expr, $field: ident, (option: $trait: ident $(, $read_arg: expr)?)) => {{
 217                 // no-op
 218         }};
 219         ($last_seen_type: expr, $typ: expr, $type: expr, $field: ident, (option, encoding: $encoding: tt)) => {{
 220                 // no-op
 221         }};
 222 }
 223
 224 /// Errors if there are missing required TLV types after the last seen type.
 225 /// This is exported for use by other exported macros, do not use directly.
 226 #[doc(hidden)]
 227 #[macro_export]
 228 macro_rules! _check_missing_tlv {
 229         ($last_seen_type: expr, $type: expr, $field: ident, (default_value, $default: expr)) => {{
 230                 #[allow(unused_comparisons)] // Note that $type may be 0 making the second comparison always false
 231                 let missing_req_type = $last_seen_type.is_none() || $last_seen_type.unwrap() < $type;
 232                 if missing_req_type {
 233                         $field = $default.into();
 234                 }
 235         }};
 236         ($last_seen_type: expr, $type: expr, $field: expr, (static_value, $value: expr)) => {
 237                 $field = $value;
 238         };
 239         ($last_seen_type: expr, $type: expr, $field: ident, required) => {{
 240                 #[allow(unused_comparisons)] // Note that $type may be 0 making the second comparison always false
 241                 let missing_req_type = $last_seen_type.is_none() || $last_seen_type.unwrap() < $type;
 242                 if missing_req_type {
 243                         return Err(DecodeError::InvalidValue);
 244                 }
 245         }};
 246         ($last_seen_type: expr, $type: expr, $field: ident, vec_type) => {{
 247                 // no-op
 248         }};
 249         ($last_seen_type: expr, $type: expr, $field: ident, option) => {{
 250                 // no-op
 251         }};
 252         ($last_seen_type: expr, $type: expr, $field: ident, ignorable) => {{
 253                 // no-op
 254         }};
 255         ($last_seen_type: expr, $type: expr, $field: ident, (option: $trait: ident $(, $read_arg: expr)?)) => {{
 256                 // no-op
 257         }};
 258         ($last_seen_type: expr, $type: expr, $field: ident, (option, encoding: $encoding: tt)) => {{
 259                 // no-op
 260         }};
 261 }
 262
 263 /// Implements deserialization for a single TLV record.
 264 /// This is exported for use by other exported macros, do not use directly.
 265 #[doc(hidden)]
 266 #[macro_export]
 267 macro_rules! _decode_tlv {
 268         ($reader: expr, $field: ident, (default_value, $default: expr)) => {{
 269                 $crate::_decode_tlv!($reader, $field, required)
 270         }};
 271         ($reader: expr, $field: ident, (static_value, $value: expr)) => {{
 272         }};
 273         ($reader: expr, $field: ident, required) => {{
 274                 $field = $crate::util::ser::Readable::read(&mut $reader)?;
 275         }};
 276         ($reader: expr, $field: ident, vec_type) => {{
 277                 let f: $crate::util::ser::WithoutLength<Vec<_>> = $crate::util::ser::Readable::read(&mut $reader)?;
 278                 $field = Some(f.0);
 279         }};
 280         ($reader: expr, $field: ident, option) => {{
 281                 $field = Some($crate::util::ser::Readable::read(&mut $reader)?);
 282         }};
 283         ($reader: expr, $field: ident, ignorable) => {{
 284                 $field = $crate::util::ser::MaybeReadable::read(&mut $reader)?;
 285         }};
 286         ($reader: expr, $field: ident, (option: $trait: ident $(, $read_arg: expr)?)) => {{
 287                 $field = Some($trait::read(&mut $reader $(, $read_arg)*)?);
 288         }};
 289         ($reader: expr, $field: ident, (option, encoding: ($fieldty: ty, $encoding: ident, $encoder:ty))) => {{
 290                 $crate::_decode_tlv!($reader, $field, (option, encoding: ($fieldty, $encoding)));
 291         }};
 292         ($reader: expr, $field: ident, (option, encoding: ($fieldty: ty, $encoding: ident))) => {{
 293                 $field = {
 294                         let field: $encoding<$fieldty> = ser::Readable::read(&mut $reader)?;
 295                         Some(field.0)
 296                 };
 297         }};
 298         ($reader: expr, $field: ident, (option, encoding: $fieldty: ty)) => {{
 299                 $crate::_decode_tlv!($reader, $field, option);
 300         }};
 301 }
 302
 303 /// Checks if `$val` matches `$type`.
 304 /// This is exported for use by other exported macros, do not use directly.
 305 #[doc(hidden)]
 306 #[macro_export]
 307 macro_rules! _decode_tlv_stream_match_check {
 308         ($val: ident, $type: expr, (static_value, $value: expr)) => { false };
 309         ($val: ident, $type: expr, $fieldty: tt) => { $val == $type }
 310 }
 311
 312 /// Implements the TLVs deserialization part in a [`Readable`] implementation of a struct.
 313 ///
 314 /// This should be called inside a method which returns `Result<_, `[`DecodeError`]`>`, such as
 315 /// [`Readable::read`]. It will either return an `Err` or ensure all `required` fields have been
 316 /// read and optionally read `optional` fields.
 317 ///
 318 /// `$stream` must be a [`Read`] and will be fully consumed, reading until no more bytes remain
 319 /// (i.e. it returns [`DecodeError::ShortRead`]).
 320 ///
 321 /// Fields MUST be sorted in `$type`-order.
 322 ///
 323 /// Note that the lightning TLV requirements require that a single type not appear more than once,
 324 /// that TLVs are sorted in type-ascending order, and that any even types be understood by the
 325 /// decoder.
 326 ///
 327 /// For example,
 328 /// ```
 329 /// # use lightning::decode_tlv_stream;
 330 /// # fn read<R: lightning::io::Read> (stream: R) -> Result<(), lightning::ln::msgs::DecodeError> {
 331 /// let mut required_value = 0u64;
 332 /// let mut optional_value: Option<u64> = None;
 333 /// decode_tlv_stream!(stream, {
 334 ///     (0, required_value, required),
 335 ///     (2, optional_value, option),
 336 /// });
 337 /// // At this point, `required_value` has been overwritten with the TLV with type 0.
 338 /// // `optional_value` may have been overwritten, setting it to `Some` if a TLV with type 2 was
 339 /// // present.
 340 /// # Ok(())
 341 /// # }
 342 /// ```
 343 ///
 344 /// [`Readable`]: crate::util::ser::Readable
 345 /// [`DecodeError`]: crate::ln::msgs::DecodeError
 346 /// [`Readable::read`]: crate::util::ser::Readable::read
 347 /// [`Read`]: crate::io::Read
 348 /// [`DecodeError::ShortRead`]: crate::ln::msgs::DecodeError::ShortRead
 349 #[macro_export]
 350 macro_rules! decode_tlv_stream {
 351         ($stream: expr, {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}) => {
 352                 let rewind = |_, _| { unreachable!() };
 353                 $crate::_decode_tlv_stream_range!($stream, .., rewind, {$(($type, $field, $fieldty)),*});
 354         }
 355 }
 356
 357 /// Similar to [`decode_tlv_stream`] with a custom TLV decoding capabilities.
 358 ///
 359 /// `$decode_custom_tlv` is a closure that may be optionally provided to handle custom message types.
 360 /// If it is provided, it will be called with the custom type and the [`FixedLengthReader`] containing
 361 /// the message contents. It should return `Ok(true)` if the custom message is successfully parsed,
 362 /// `Ok(false)` if the message type is unknown, and `Err(`[`DecodeError`]`)` if parsing fails.
 363 ///
 364 /// [`FixedLengthReader`]: crate::util::ser::FixedLengthReader
 365 /// [`DecodeError`]: crate::ln::msgs::DecodeError
 366 macro_rules! decode_tlv_stream_with_custom_tlv_decode {
 367         ($stream: expr, {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}
 368          $(, $decode_custom_tlv: expr)?) => { {
 369                 let rewind = |_, _| { unreachable!() };
 370                 _decode_tlv_stream_range!(
 371                         $stream, .., rewind, {$(($type, $field, $fieldty)),*} $(, $decode_custom_tlv)?
 372                 );
 373         } }
 374 }
 375
 376 #[doc(hidden)]
 377 #[macro_export]
 378 macro_rules! _decode_tlv_stream_range {
 379         ($stream: expr, $range: expr, $rewind: ident, {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}
 380          $(, $decode_custom_tlv: expr)?) => { {
 381                 use core::ops::RangeBounds;
 382                 use $crate::ln::msgs::DecodeError;
 383                 let mut last_seen_type: Option<u64> = None;
 384                 let mut stream_ref = $stream;
 385                 'tlv_read: loop {
 386                         use $crate::util::ser;
 387
 388                         // First decode the type of this TLV:
 389                         let typ: ser::BigSize = {
 390                                 // We track whether any bytes were read during the consensus_decode call to
 391                                 // determine whether we should break or return ShortRead if we get an
 392                                 // UnexpectedEof. This should in every case be largely cosmetic, but its nice to
 393                                 // pass the TLV test vectors exactly, which require this distinction.
 394                                 let mut tracking_reader = ser::ReadTrackingReader::new(&mut stream_ref);
 395                                 match <$crate::util::ser::BigSize as $crate::util::ser::Readable>::read(&mut tracking_reader) {
 396                                         Err(DecodeError::ShortRead) => {
 397                                                 if !tracking_reader.have_read {
 398                                                         break 'tlv_read;
 399                                                 } else {
 400                                                         return Err(DecodeError::ShortRead);
 401                                                 }
 402                                         },
 403                                         Err(e) => return Err(e),
 404                                         Ok(t) => if $range.contains(&t.0) { t } else {
 405                                                 drop(tracking_reader);
 406
 407                                                 // Assumes the type id is minimally encoded, which is enforced on read.
 408                                                 use $crate::util::ser::Writeable;
 409                                                 let bytes_read = t.serialized_length();
 410                                                 $rewind(stream_ref, bytes_read);
 411                                                 break 'tlv_read;
 412                                         },
 413                                 }
 414                         };
 415
 416                         // Types must be unique and monotonically increasing:
 417                         match last_seen_type {
 418                                 Some(t) if typ.0 <= t => {
 419                                         return Err(DecodeError::InvalidValue);
 420                                 },
 421                                 _ => {},
 422                         }
 423                         // As we read types, make sure we hit every required type between `last_seen_type` and `typ`:
 424                         $({
 425                                 $crate::_check_decoded_tlv_order!(last_seen_type, typ, $type, $field, $fieldty);
 426                         })*
 427                         last_seen_type = Some(typ.0);
 428
 429                         // Finally, read the length and value itself:
 430                         let length: ser::BigSize = $crate::util::ser::Readable::read(&mut stream_ref)?;
 431                         let mut s = ser::FixedLengthReader::new(&mut stream_ref, length.0);
 432                         match typ.0 {
 433                                 $(_t if $crate::_decode_tlv_stream_match_check!(_t, $type, $fieldty) => {
 434                                         $crate::_decode_tlv!(s, $field, $fieldty);
 435                                         if s.bytes_remain() {
 436                                                 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
 437                                                 return Err(DecodeError::InvalidValue);
 438                                         }
 439                                 },)*
 440                                 t => {
 441                                         $(
 442                                                 if $decode_custom_tlv(t, &mut s)? {
 443                                                         // If a custom TLV was successfully read (i.e. decode_custom_tlv returns true),
 444                                                         // continue to the next TLV read.
 445                                                         s.eat_remaining()?;
 446                                                         continue 'tlv_read;
 447                                                 }
 448                                         )?
 449                                         if t % 2 == 0 {
 450                                                 return Err(DecodeError::UnknownRequiredFeature);
 451                                         }
 452                                 }
 453                         }
 454                         s.eat_remaining()?;
 455                 }
 456                 // Make sure we got to each required type after we've read every TLV:
 457                 $({
 458                         $crate::_check_missing_tlv!(last_seen_type, $type, $field, $fieldty);
 459                 })*
 460         } }
 461 }
 462
 463 /// Implements [`Readable`]/[`Writeable`] for a message struct that may include non-TLV and
 464 /// TLV-encoded parts.
 465 ///
 466 /// This is useful to implement a [`CustomMessageReader`].
 467 ///
 468 /// Currently `$fieldty` may only be `option`, i.e., `$tlvfield` is optional field.
 469 ///
 470 /// For example,
 471 /// ```
 472 /// # use lightning::impl_writeable_msg;
 473 /// struct MyCustomMessage {
 474 ///     pub field_1: u32,
 475 ///     pub field_2: bool,
 476 ///     pub field_3: String,
 477 ///     pub tlv_optional_integer: Option<u32>,
 478 /// }
 479 ///
 480 /// impl_writeable_msg!(MyCustomMessage, {
 481 ///     field_1,
 482 ///     field_2,
 483 ///     field_3
 484 /// }, {
 485 ///     (1, tlv_optional_integer, option),
 486 /// });
 487 /// ```
 488 ///
 489 /// [`Readable`]: crate::util::ser::Readable
 490 /// [`Writeable`]: crate::util::ser::Writeable
 491 /// [`CustomMessageReader`]: crate::ln::wire::CustomMessageReader
 492 #[macro_export]
 493 macro_rules! impl_writeable_msg {
 494         ($st:ident, {$($field:ident),* $(,)*}, {$(($type: expr, $tlvfield: ident, $fieldty: tt)),* $(,)*}) => {
 495                 impl $crate::util::ser::Writeable for $st {
 496                         fn write<W: $crate::util::ser::Writer>(&self, w: &mut W) -> Result<(), $crate::io::Error> {
 497                                 $( self.$field.write(w)?; )*
 498                                 $crate::encode_tlv_stream!(w, {$(($type, self.$tlvfield, $fieldty)),*});
 499                                 Ok(())
 500                         }
 501                 }
 502                 impl $crate::util::ser::Readable for $st {
 503                         fn read<R: $crate::io::Read>(r: &mut R) -> Result<Self, $crate::ln::msgs::DecodeError> {
 504                                 $(let $field = $crate::util::ser::Readable::read(r)?;)*
 505                                 $($crate::_init_tlv_field_var!($tlvfield, $fieldty);)*
 506                                 $crate::decode_tlv_stream!(r, {$(($type, $tlvfield, $fieldty)),*});
 507                                 Ok(Self {
 508                                         $($field),*,
 509                                         $($tlvfield),*
 510                                 })
 511                         }
 512                 }
 513         }
 514 }
 515
 516 macro_rules! impl_writeable {
 517         ($st:ident, {$($field:ident),*}) => {
 518                 impl $crate::util::ser::Writeable for $st {
 519                         fn write<W: $crate::util::ser::Writer>(&self, w: &mut W) -> Result<(), $crate::io::Error> {
 520                                 $( self.$field.write(w)?; )*
 521                                 Ok(())
 522                         }
 523
 524                         #[inline]
 525                         fn serialized_length(&self) -> usize {
 526                                 let mut len_calc = 0;
 527                                 $( len_calc += self.$field.serialized_length(); )*
 528                                 return len_calc;
 529                         }
 530                 }
 531
 532                 impl $crate::util::ser::Readable for $st {
 533                         fn read<R: $crate::io::Read>(r: &mut R) -> Result<Self, $crate::ln::msgs::DecodeError> {
 534                                 Ok(Self {
 535                                         $($field: $crate::util::ser::Readable::read(r)?),*
 536                                 })
 537                         }
 538                 }
 539         }
 540 }
 541
 542 /// Write out two bytes to indicate the version of an object.
 543 ///
 544 /// $this_version represents a unique version of a type. Incremented whenever the type's
 545 /// serialization format has changed or has a new interpretation. Used by a type's reader to
 546 /// determine how to interpret fields or if it can understand a serialized object.
 547 ///
 548 /// $min_version_that_can_read_this is the minimum reader version which can understand this
 549 /// serialized object. Previous versions will simply err with a [`DecodeError::UnknownVersion`].
 550 ///
 551 /// Updates to either `$this_version` or `$min_version_that_can_read_this` should be included in
 552 /// release notes.
 553 ///
 554 /// Both version fields can be specific to this type of object.
 555 ///
 556 /// [`DecodeError::UnknownVersion`]: crate::ln::msgs::DecodeError::UnknownVersion
 557 macro_rules! write_ver_prefix {
 558         ($stream: expr, $this_version: expr, $min_version_that_can_read_this: expr) => {
 559                 $stream.write_all(&[$this_version; 1])?;
 560                 $stream.write_all(&[$min_version_that_can_read_this; 1])?;
 561         }
 562 }
 563
 564 /// Writes out a suffix to an object as a length-prefixed TLV stream which contains potentially
 565 /// backwards-compatible, optional fields which old nodes can happily ignore.
 566 ///
 567 /// It is written out in TLV format and, as with all TLV fields, unknown even fields cause a
 568 /// [`DecodeError::UnknownRequiredFeature`] error, with unknown odd fields ignored.
 569 ///
 570 /// This is the preferred method of adding new fields that old nodes can ignore and still function
 571 /// correctly.
 572 ///
 573 /// [`DecodeError::UnknownRequiredFeature`]: crate::ln::msgs::DecodeError::UnknownRequiredFeature
 574 #[macro_export]
 575 macro_rules! write_tlv_fields {
 576         ($stream: expr, {$(($type: expr, $field: expr, $fieldty: tt)),* $(,)*}) => {
 577                 $crate::_encode_varint_length_prefixed_tlv!($stream, {$(($type, $field, $fieldty)),*})
 578         }
 579 }
 580
 581 /// Reads a prefix added by [`write_ver_prefix`], above. Takes the current version of the
 582 /// serialization logic for this object. This is compared against the
 583 /// `$min_version_that_can_read_this` added by [`write_ver_prefix`].
 584 macro_rules! read_ver_prefix {
 585         ($stream: expr, $this_version: expr) => { {
 586                 let ver: u8 = Readable::read($stream)?;
 587                 let min_ver: u8 = Readable::read($stream)?;
 588                 if min_ver > $this_version {
 589                         return Err(DecodeError::UnknownVersion);
 590                 }
 591                 ver
 592         } }
 593 }
 594
 595 /// Reads a suffix added by [`write_tlv_fields`].
 596 ///
 597 /// [`write_tlv_fields`]: crate::write_tlv_fields
 598 #[macro_export]
 599 macro_rules! read_tlv_fields {
 600         ($stream: expr, {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}) => { {
 601                 let tlv_len: $crate::util::ser::BigSize = $crate::util::ser::Readable::read($stream)?;
 602                 let mut rd = $crate::util::ser::FixedLengthReader::new($stream, tlv_len.0);
 603                 $crate::decode_tlv_stream!(&mut rd, {$(($type, $field, $fieldty)),*});
 604                 rd.eat_remaining().map_err(|_| $crate::ln::msgs::DecodeError::ShortRead)?;
 605         } }
 606 }
 607
 608 /// Initializes the struct fields.
 609 ///
 610 /// This is exported for use by other exported macros, do not use directly.
 611 #[doc(hidden)]
 612 #[macro_export]
 613 macro_rules! _init_tlv_based_struct_field {
 614         ($field: ident, (default_value, $default: expr)) => {
 615                 $field.0.unwrap()
 616         };
 617         ($field: ident, (static_value, $value: expr)) => {
 618                 $field
 619         };
 620         ($field: ident, option) => {
 621                 $field
 622         };
 623         ($field: ident, ignorable) => {
 624                 if $field.is_none() { return Ok(None); } else { $field.unwrap() }
 625         };
 626         ($field: ident, required) => {
 627                 $field.0.unwrap()
 628         };
 629         ($field: ident, vec_type) => {
 630                 $field.unwrap()
 631         };
 632 }
 633
 634 /// Initializes the variable we are going to read the TLV into.
 635 ///
 636 /// This is exported for use by other exported macros, do not use directly.
 637 #[doc(hidden)]
 638 #[macro_export]
 639 macro_rules! _init_tlv_field_var {
 640         ($field: ident, (default_value, $default: expr)) => {
 641                 let mut $field = $crate::util::ser::OptionDeserWrapper(None);
 642         };
 643         ($field: ident, (static_value, $value: expr)) => {
 644                 let $field;
 645         };
 646         ($field: ident, required) => {
 647                 let mut $field = $crate::util::ser::OptionDeserWrapper(None);
 648         };
 649         ($field: ident, vec_type) => {
 650                 let mut $field = Some(Vec::new());
 651         };
 652         ($field: ident, option) => {
 653                 let mut $field = None;
 654         };
 655         ($field: ident, ignorable) => {
 656                 let mut $field = None;
 657         };
 658 }
 659
 660 /// Equivalent to running [`_init_tlv_field_var`] then [`read_tlv_fields`].
 661 ///
 662 /// This is exported for use by other exported macros, do not use directly.
 663 #[doc(hidden)]
 664 #[macro_export]
 665 macro_rules! _init_and_read_tlv_fields {
 666         ($reader: ident, {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}) => {
 667                 $(
 668                         $crate::_init_tlv_field_var!($field, $fieldty);
 669                 )*
 670
 671                 $crate::read_tlv_fields!($reader, {
 672                         $(($type, $field, $fieldty)),*
 673                 });
 674         }
 675 }
 676
 677 /// Implements [`Readable`]/[`Writeable`] for a struct storing it as a set of TLVs
 678 /// If `$fieldty` is `required`, then `$field` is a required field that is not an [`Option`] nor a [`Vec`].
 679 /// If `$fieldty` is `(default_value, $default)`, then `$field` will be set to `$default` if not present.
 680 /// If `$fieldty` is `option`, then `$field` is optional field.
 681 /// If `$fieldty` is `vec_type`, then `$field` is a [`Vec`], which needs to have its individual elements serialized.
 682 ///
 683 /// For example,
 684 /// ```
 685 /// # use lightning::impl_writeable_tlv_based;
 686 /// struct LightningMessage {
 687 ///     tlv_integer: u32,
 688 ///     tlv_default_integer: u32,
 689 ///     tlv_optional_integer: Option<u32>,
 690 ///     tlv_vec_type_integer: Vec<u32>,
 691 /// }
 692 ///
 693 /// impl_writeable_tlv_based!(LightningMessage, {
 694 ///     (0, tlv_integer, required),
 695 ///     (1, tlv_default_integer, (default_value, 7)),
 696 ///     (2, tlv_optional_integer, option),
 697 ///     (3, tlv_vec_type_integer, vec_type),
 698 /// });
 699 /// ```
 700 ///
 701 /// [`Readable`]: crate::util::ser::Readable
 702 /// [`Writeable`]: crate::util::ser::Writeable
 703 #[macro_export]
 704 macro_rules! impl_writeable_tlv_based {
 705         ($st: ident, {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}) => {
 706                 impl $crate::util::ser::Writeable for $st {
 707                         fn write<W: $crate::util::ser::Writer>(&self, writer: &mut W) -> Result<(), $crate::io::Error> {
 708                                 $crate::write_tlv_fields!(writer, {
 709                                         $(($type, self.$field, $fieldty)),*
 710                                 });
 711                                 Ok(())
 712                         }
 713
 714                         #[inline]
 715                         fn serialized_length(&self) -> usize {
 716                                 use $crate::util::ser::BigSize;
 717                                 let len = {
 718                                         #[allow(unused_mut)]
 719                                         let mut len = $crate::util::ser::LengthCalculatingWriter(0);
 720                                         $(
 721                                                 $crate::_get_varint_length_prefixed_tlv_length!(len, $type, self.$field, $fieldty);
 722                                         )*
 723                                         len.0
 724                                 };
 725                                 let mut len_calc = $crate::util::ser::LengthCalculatingWriter(0);
 726                                 BigSize(len as u64).write(&mut len_calc).expect("No in-memory data may fail to serialize");
 727                                 len + len_calc.0
 728                         }
 729                 }
 730
 731                 impl $crate::util::ser::Readable for $st {
 732                         fn read<R: $crate::io::Read>(reader: &mut R) -> Result<Self, $crate::ln::msgs::DecodeError> {
 733                                 $crate::_init_and_read_tlv_fields!(reader, {
 734                                         $(($type, $field, $fieldty)),*
 735                                 });
 736                                 Ok(Self {
 737                                         $(
 738                                                 $field: $crate::_init_tlv_based_struct_field!($field, $fieldty)
 739                                         ),*
 740                                 })
 741                         }
 742                 }
 743         }
 744 }
 745
 746 /// Defines a struct for a TLV stream and a similar struct using references for non-primitive types,
 747 /// implementing [`Readable`] for the former and [`Writeable`] for the latter. Useful as an
 748 /// intermediary format when reading or writing a type encoded as a TLV stream. Note that each field
 749 /// representing a TLV record has its type wrapped with an [`Option`]. A tuple consisting of a type
 750 /// and a serialization wrapper may be given in place of a type when custom serialization is
 751 /// required.
 752 ///
 753 /// [`Readable`]: crate::util::ser::Readable
 754 /// [`Writeable`]: crate::util::ser::Writeable
 755 macro_rules! tlv_stream {
 756         ($name:ident, $nameref:ident, $range:expr, {
 757                 $(($type:expr, $field:ident : $fieldty:tt)),* $(,)*
 758         }) => {
 759                 #[derive(Debug)]
 760                 pub(super) struct $name {
 761                         $(
 762                                 pub(super) $field: Option<tlv_record_type!($fieldty)>,
 763                         )*
 764                 }
 765
 766                 #[cfg_attr(test, derive(PartialEq))]
 767                 #[derive(Debug)]
 768                 pub(super) struct $nameref<'a> {
 769                         $(
 770                                 pub(super) $field: Option<tlv_record_ref_type!($fieldty)>,
 771                         )*
 772                 }
 773
 774                 impl<'a> $crate::util::ser::Writeable for $nameref<'a> {
 775                         fn write<W: $crate::util::ser::Writer>(&self, writer: &mut W) -> Result<(), $crate::io::Error> {
 776                                 encode_tlv_stream!(writer, {
 777                                         $(($type, self.$field, (option, encoding: $fieldty))),*
 778                                 });
 779                                 Ok(())
 780                         }
 781                 }
 782
 783                 impl $crate::util::ser::SeekReadable for $name {
 784                         fn read<R: $crate::io::Read + $crate::io::Seek>(reader: &mut R) -> Result<Self, $crate::ln::msgs::DecodeError> {
 785                                 $(
 786                                         _init_tlv_field_var!($field, option);
 787                                 )*
 788                                 let rewind = |cursor: &mut R, offset: usize| {
 789                                         cursor.seek($crate::io::SeekFrom::Current(-(offset as i64))).expect("");
 790                                 };
 791                                 _decode_tlv_stream_range!(reader, $range, rewind, {
 792                                         $(($type, $field, (option, encoding: $fieldty))),*
 793                                 });
 794
 795                                 Ok(Self {
 796                                         $(
 797                                                 $field: $field
 798                                         ),*
 799                                 })
 800                         }
 801                 }
 802         }
 803 }
 804
 805 macro_rules! tlv_record_type {
 806         (($type:ty, $wrapper:ident)) => { $type };
 807         (($type:ty, $wrapper:ident, $encoder:ty)) => { $type };
 808         ($type:ty) => { $type };
 809 }
 810
 811 macro_rules! tlv_record_ref_type {
 812         (char) => { char };
 813         (u8) => { u8 };
 814         ((u16, $wrapper: ident)) => { u16 };
 815         ((u32, $wrapper: ident)) => { u32 };
 816         ((u64, $wrapper: ident)) => { u64 };
 817         (($type:ty, $wrapper:ident)) => { &'a $type };
 818         (($type:ty, $wrapper:ident, $encoder:ty)) => { $encoder };
 819         ($type:ty) => { &'a $type };
 820 }
 821
 822 macro_rules! _impl_writeable_tlv_based_enum_common {
 823         ($st: ident, $(($variant_id: expr, $variant_name: ident) =>
 824                 {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}
 825         ),* $(,)*;
 826         $(($tuple_variant_id: expr, $tuple_variant_name: ident)),*  $(,)*) => {
 827                 impl $crate::util::ser::Writeable for $st {
 828                         fn write<W: $crate::util::ser::Writer>(&self, writer: &mut W) -> Result<(), $crate::io::Error> {
 829                                 match self {
 830                                         $($st::$variant_name { $(ref $field),* } => {
 831                                                 let id: u8 = $variant_id;
 832                                                 id.write(writer)?;
 833                                                 write_tlv_fields!(writer, {
 834                                                         $(($type, *$field, $fieldty)),*
 835                                                 });
 836                                         }),*
 837                                         $($st::$tuple_variant_name (ref field) => {
 838                                                 let id: u8 = $tuple_variant_id;
 839                                                 id.write(writer)?;
 840                                                 field.write(writer)?;
 841                                         }),*
 842                                 }
 843                                 Ok(())
 844                         }
 845                 }
 846         }
 847 }
 848
 849 /// Implement [`Readable`] and [`Writeable`] for an enum, with struct variants stored as TLVs and tuple
 850 /// variants stored directly.
 851 /// The format is, for example
 852 /// ```ignore
 853 /// impl_writeable_tlv_based_enum!(EnumName,
 854 ///   (0, StructVariantA) => {(0, required_variant_field, required), (1, optional_variant_field, option)},
 855 ///   (1, StructVariantB) => {(0, variant_field_a, required), (1, variant_field_b, required), (2, variant_vec_field, vec_type)};
 856 ///   (2, TupleVariantA), (3, TupleVariantB),
 857 /// );
 858 /// ```
 859 /// The type is written as a single byte, followed by any variant data.
 860 /// Attempts to read an unknown type byte result in [`DecodeError::UnknownRequiredFeature`].
 861 ///
 862 /// [`Readable`]: crate::util::ser::Readable
 863 /// [`Writeable`]: crate::util::ser::Writeable
 864 /// [`DecodeError::UnknownRequiredFeature`]: crate::ln::msgs::DecodeError::UnknownRequiredFeature
 865 #[macro_export]
 866 macro_rules! impl_writeable_tlv_based_enum {
 867         ($st: ident, $(($variant_id: expr, $variant_name: ident) =>
 868                 {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}
 869         ),* $(,)*;
 870         $(($tuple_variant_id: expr, $tuple_variant_name: ident)),*  $(,)*) => {
 871                 _impl_writeable_tlv_based_enum_common!($st,
 872                         $(($variant_id, $variant_name) => {$(($type, $field, $fieldty)),*}),*;
 873                         $(($tuple_variant_id, $tuple_variant_name)),*);
 874
 875                 impl $crate::util::ser::Readable for $st {
 876                         fn read<R: $crate::io::Read>(reader: &mut R) -> Result<Self, $crate::ln::msgs::DecodeError> {
 877                                 let id: u8 = $crate::util::ser::Readable::read(reader)?;
 878                                 match id {
 879                                         $($variant_id => {
 880                                                 // Because read_tlv_fields creates a labeled loop, we cannot call it twice
 881                                                 // in the same function body. Instead, we define a closure and call it.
 882                                                 let f = || {
 883                                                         _init_and_read_tlv_fields!(reader, {
 884                                                                 $(($type, $field, $fieldty)),*
 885                                                         });
 886                                                         Ok($st::$variant_name {
 887                                                                 $(
 888                                                                         $field: _init_tlv_based_struct_field!($field, $fieldty)
 889                                                                 ),*
 890                                                         })
 891                                                 };
 892                                                 f()
 893                                         }),*
 894                                         $($tuple_variant_id => {
 895                                                 Ok($st::$tuple_variant_name(Readable::read(reader)?))
 896                                         }),*
 897                                         _ => {
 898                                                 Err($crate::ln::msgs::DecodeError::UnknownRequiredFeature)
 899                                         },
 900                                 }
 901                         }
 902                 }
 903         }
 904 }
 905
 906 /// Implement [`MaybeReadable`] and [`Writeable`] for an enum, with struct variants stored as TLVs and
 907 /// tuple variants stored directly.
 908 ///
 909 /// This is largely identical to [`impl_writeable_tlv_based_enum`], except that odd variants will
 910 /// return `Ok(None)` instead of `Err(`[`DecodeError::UnknownRequiredFeature`]`)`. It should generally be preferred
 911 /// when [`MaybeReadable`] is practical instead of just [`Readable`] as it provides an upgrade path for
 912 /// new variants to be added which are simply ignored by existing clients.
 913 ///
 914 /// [`MaybeReadable`]: crate::util::ser::MaybeReadable
 915 /// [`Writeable`]: crate::util::ser::Writeable
 916 /// [`DecodeError::UnknownRequiredFeature`]: crate::ln::msgs::DecodeError::UnknownRequiredFeature
 917 /// [`Readable`]: crate::util::ser::Readable
 918 #[macro_export]
 919 macro_rules! impl_writeable_tlv_based_enum_upgradable {
 920         ($st: ident, $(($variant_id: expr, $variant_name: ident) =>
 921                 {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}
 922         ),* $(,)*
 923         $(;
 924         $(($tuple_variant_id: expr, $tuple_variant_name: ident)),*  $(,)*)*) => {
 925                 _impl_writeable_tlv_based_enum_common!($st,
 926                         $(($variant_id, $variant_name) => {$(($type, $field, $fieldty)),*}),*;
 927                         $($(($tuple_variant_id, $tuple_variant_name)),*)*);
 928
 929                 impl $crate::util::ser::MaybeReadable for $st {
 930                         fn read<R: $crate::io::Read>(reader: &mut R) -> Result<Option<Self>, $crate::ln::msgs::DecodeError> {
 931                                 let id: u8 = $crate::util::ser::Readable::read(reader)?;
 932                                 match id {
 933                                         $($variant_id => {
 934                                                 // Because read_tlv_fields creates a labeled loop, we cannot call it twice
 935                                                 // in the same function body. Instead, we define a closure and call it.
 936                                                 let f = || {
 937                                                         _init_and_read_tlv_fields!(reader, {
 938                                                                 $(($type, $field, $fieldty)),*
 939                                                         });
 940                                                         Ok(Some($st::$variant_name {
 941                                                                 $(
 942                                                                         $field: _init_tlv_based_struct_field!($field, $fieldty)
 943                                                                 ),*
 944                                                         }))
 945                                                 };
 946                                                 f()
 947                                         }),*
 948                                         $($($tuple_variant_id => {
 949                                                 Ok(Some($st::$tuple_variant_name(Readable::read(reader)?)))
 950                                         }),*)*
 951                                         _ if id % 2 == 1 => Ok(None),
 952                                         _ => Err(DecodeError::UnknownRequiredFeature),
 953                                 }
 954                         }
 955                 }
 956         }
 957 }
 958
 959 #[cfg(test)]
 960 mod tests {
 961         use crate::io::{self, Cursor};
 962         use crate::prelude::*;
 963         use crate::ln::msgs::DecodeError;
 964         use crate::util::ser::{Writeable, HighZeroBytesDroppedBigSize, VecWriter};
 965         use bitcoin::secp256k1::PublicKey;
 966
 967         // The BOLT TLV test cases don't include any tests which use our "required-value" logic since
 968         // the encoding layer in the BOLTs has no such concept, though it makes our macros easier to
 969         // work with so they're baked into the decoder. Thus, we have a few additional tests below
 970         fn tlv_reader(s: &[u8]) -> Result<(u64, u32, Option<u32>), DecodeError> {
 971                 let mut s = Cursor::new(s);
 972                 let mut a: u64 = 0;
 973                 let mut b: u32 = 0;
 974                 let mut c: Option<u32> = None;
 975                 decode_tlv_stream!(&mut s, {(2, a, required), (3, b, required), (4, c, option)});
 976                 Ok((a, b, c))
 977         }
 978
 979         #[test]
 980         fn tlv_v_short_read() {
 981                 // We only expect a u32 for type 3 (which we are given), but the L says its 8 bytes.
 982                 if let Err(DecodeError::ShortRead) = tlv_reader(&::hex::decode(
 983                                 concat!("0100", "0208deadbeef1badbeef", "0308deadbeef")
 984                                 ).unwrap()[..]) {
 985                 } else { panic!(); }
 986         }
 987
 988         #[test]
 989         fn tlv_types_out_of_order() {
 990                 if let Err(DecodeError::InvalidValue) = tlv_reader(&::hex::decode(
 991                                 concat!("0100", "0304deadbeef", "0208deadbeef1badbeef")
 992                                 ).unwrap()[..]) {
 993                 } else { panic!(); }
 994                 // ...even if its some field we don't understand
 995                 if let Err(DecodeError::InvalidValue) = tlv_reader(&::hex::decode(
 996                                 concat!("0208deadbeef1badbeef", "0100", "0304deadbeef")
 997                                 ).unwrap()[..]) {
 998                 } else { panic!(); }
 999         }
1000
1001         #[test]
1002         fn tlv_req_type_missing_or_extra() {
1003                 // It's also bad if they included even fields we don't understand
1004                 if let Err(DecodeError::UnknownRequiredFeature) = tlv_reader(&::hex::decode(
1005                                 concat!("0100", "0208deadbeef1badbeef", "0304deadbeef", "0600")
1006                                 ).unwrap()[..]) {
1007                 } else { panic!(); }
1008                 // ... or if they're missing fields we need
1009                 if let Err(DecodeError::InvalidValue) = tlv_reader(&::hex::decode(
1010                                 concat!("0100", "0208deadbeef1badbeef")
1011                                 ).unwrap()[..]) {
1012                 } else { panic!(); }
1013                 // ... even if that field is even
1014                 if let Err(DecodeError::InvalidValue) = tlv_reader(&::hex::decode(
1015                                 concat!("0304deadbeef", "0500")
1016                                 ).unwrap()[..]) {
1017                 } else { panic!(); }
1018         }
1019
1020         #[test]
1021         fn tlv_simple_good_cases() {
1022                 assert_eq!(tlv_reader(&::hex::decode(
1023                                 concat!("0208deadbeef1badbeef", "03041bad1dea")
1024                                 ).unwrap()[..]).unwrap(),
1025                         (0xdeadbeef1badbeef, 0x1bad1dea, None));
1026                 assert_eq!(tlv_reader(&::hex::decode(
1027                                 concat!("0208deadbeef1badbeef", "03041bad1dea", "040401020304")
1028                                 ).unwrap()[..]).unwrap(),
1029                         (0xdeadbeef1badbeef, 0x1bad1dea, Some(0x01020304)));
1030         }
1031
1032         // BOLT TLV test cases
1033         fn tlv_reader_n1(s: &[u8]) -> Result<(Option<HighZeroBytesDroppedBigSize<u64>>, Option<u64>, Option<(PublicKey, u64, u64)>, Option<u16>), DecodeError> {
1034                 let mut s = Cursor::new(s);
1035                 let mut tlv1: Option<HighZeroBytesDroppedBigSize<u64>> = None;
1036                 let mut tlv2: Option<u64> = None;
1037                 let mut tlv3: Option<(PublicKey, u64, u64)> = None;
1038                 let mut tlv4: Option<u16> = None;
1039                 decode_tlv_stream!(&mut s, {(1, tlv1, option), (2, tlv2, option), (3, tlv3, option), (254, tlv4, option)});
1040                 Ok((tlv1, tlv2, tlv3, tlv4))
1041         }
1042
1043         #[test]
1044         fn bolt_tlv_bogus_stream() {
1045                 macro_rules! do_test {
1046                         ($stream: expr, $reason: ident) => {
1047                                 if let Err(DecodeError::$reason) = tlv_reader_n1(&::hex::decode($stream).unwrap()[..]) {
1048                                 } else { panic!(); }
1049                         }
1050                 }
1051
1052                 // TLVs from the BOLT test cases which should not decode as either n1 or n2
1053                 do_test!(concat!("fd01"), ShortRead);
1054                 do_test!(concat!("fd0001", "00"), InvalidValue);
1055                 do_test!(concat!("fd0101"), ShortRead);
1056                 do_test!(concat!("0f", "fd"), ShortRead);
1057                 do_test!(concat!("0f", "fd26"), ShortRead);
1058                 do_test!(concat!("0f", "fd2602"), ShortRead);
1059                 do_test!(concat!("0f", "fd0001", "00"), InvalidValue);
1060                 do_test!(concat!("0f", "fd0201", "000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"), ShortRead);
1061
1062                 do_test!(concat!("12", "00"), UnknownRequiredFeature);
1063                 do_test!(concat!("fd0102", "00"), UnknownRequiredFeature);
1064                 do_test!(concat!("fe01000002", "00"), UnknownRequiredFeature);
1065                 do_test!(concat!("ff0100000000000002", "00"), UnknownRequiredFeature);
1066         }
1067
1068         #[test]
1069         fn bolt_tlv_bogus_n1_stream() {
1070                 macro_rules! do_test {
1071                         ($stream: expr, $reason: ident) => {
1072                                 if let Err(DecodeError::$reason) = tlv_reader_n1(&::hex::decode($stream).unwrap()[..]) {
1073                                 } else { panic!(); }
1074                         }
1075                 }
1076
1077                 // TLVs from the BOLT test cases which should not decode as n1
1078                 do_test!(concat!("01", "09", "ffffffffffffffffff"), InvalidValue);
1079                 do_test!(concat!("01", "01", "00"), InvalidValue);
1080                 do_test!(concat!("01", "02", "0001"), InvalidValue);
1081                 do_test!(concat!("01", "03", "000100"), InvalidValue);
1082                 do_test!(concat!("01", "04", "00010000"), InvalidValue);
1083                 do_test!(concat!("01", "05", "0001000000"), InvalidValue);
1084                 do_test!(concat!("01", "06", "000100000000"), InvalidValue);
1085                 do_test!(concat!("01", "07", "00010000000000"), InvalidValue);
1086                 do_test!(concat!("01", "08", "0001000000000000"), InvalidValue);
1087                 do_test!(concat!("02", "07", "01010101010101"), ShortRead);
1088                 do_test!(concat!("02", "09", "010101010101010101"), InvalidValue);
1089                 do_test!(concat!("03", "21", "023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb"), ShortRead);
1090                 do_test!(concat!("03", "29", "023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb0000000000000001"), ShortRead);
1091                 do_test!(concat!("03", "30", "023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb000000000000000100000000000001"), ShortRead);
1092                 do_test!(concat!("03", "31", "043da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb00000000000000010000000000000002"), InvalidValue);
1093                 do_test!(concat!("03", "32", "023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb0000000000000001000000000000000001"), InvalidValue);
1094                 do_test!(concat!("fd00fe", "00"), ShortRead);
1095                 do_test!(concat!("fd00fe", "01", "01"), ShortRead);
1096                 do_test!(concat!("fd00fe", "03", "010101"), InvalidValue);
1097                 do_test!(concat!("00", "00"), UnknownRequiredFeature);
1098
1099                 do_test!(concat!("02", "08", "0000000000000226", "01", "01", "2a"), InvalidValue);
1100                 do_test!(concat!("02", "08", "0000000000000231", "02", "08", "0000000000000451"), InvalidValue);
1101                 do_test!(concat!("1f", "00", "0f", "01", "2a"), InvalidValue);
1102                 do_test!(concat!("1f", "00", "1f", "01", "2a"), InvalidValue);
1103
1104                 // The last BOLT test modified to not require creating a new decoder for one trivial test.
1105                 do_test!(concat!("ffffffffffffffffff", "00", "01", "00"), InvalidValue);
1106         }
1107
1108         #[test]
1109         fn bolt_tlv_valid_n1_stream() {
1110                 macro_rules! do_test {
1111                         ($stream: expr, $tlv1: expr, $tlv2: expr, $tlv3: expr, $tlv4: expr) => {
1112                                 if let Ok((tlv1, tlv2, tlv3, tlv4)) = tlv_reader_n1(&::hex::decode($stream).unwrap()[..]) {
1113                                         assert_eq!(tlv1.map(|v| v.0), $tlv1);
1114                                         assert_eq!(tlv2, $tlv2);
1115                                         assert_eq!(tlv3, $tlv3);
1116                                         assert_eq!(tlv4, $tlv4);
1117                                 } else { panic!(); }
1118                         }
1119                 }
1120
1121                 do_test!(concat!(""), None, None, None, None);
1122                 do_test!(concat!("21", "00"), None, None, None, None);
1123                 do_test!(concat!("fd0201", "00"), None, None, None, None);
1124                 do_test!(concat!("fd00fd", "00"), None, None, None, None);
1125                 do_test!(concat!("fd00ff", "00"), None, None, None, None);
1126                 do_test!(concat!("fe02000001", "00"), None, None, None, None);
1127                 do_test!(concat!("ff0200000000000001", "00"), None, None, None, None);
1128
1129                 do_test!(concat!("01", "00"), Some(0), None, None, None);
1130                 do_test!(concat!("01", "01", "01"), Some(1), None, None, None);
1131                 do_test!(concat!("01", "02", "0100"), Some(256), None, None, None);
1132                 do_test!(concat!("01", "03", "010000"), Some(65536), None, None, None);
1133                 do_test!(concat!("01", "04", "01000000"), Some(16777216), None, None, None);
1134                 do_test!(concat!("01", "05", "0100000000"), Some(4294967296), None, None, None);
1135                 do_test!(concat!("01", "06", "010000000000"), Some(1099511627776), None, None, None);
1136                 do_test!(concat!("01", "07", "01000000000000"), Some(281474976710656), None, None, None);
1137                 do_test!(concat!("01", "08", "0100000000000000"), Some(72057594037927936), None, None, None);
1138                 do_test!(concat!("02", "08", "0000000000000226"), None, Some((0 << 30) | (0 << 5) | (550 << 0)), None, None);
1139                 do_test!(concat!("03", "31", "023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb00000000000000010000000000000002"),
1140                         None, None, Some((
1141                                 PublicKey::from_slice(&::hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]).unwrap(), 1, 2)),
1142                         None);
1143                 do_test!(concat!("fd00fe", "02", "0226"), None, None, None, Some(550));
1144         }
1145
1146         fn do_simple_test_tlv_write() -> Result<(), io::Error> {
1147                 let mut stream = VecWriter(Vec::new());
1148
1149                 stream.0.clear();
1150                 _encode_varint_length_prefixed_tlv!(&mut stream, {(1, 1u8, required), (42, None::<u64>, option)});
1151                 assert_eq!(stream.0, ::hex::decode("03010101").unwrap());
1152
1153                 stream.0.clear();
1154                 _encode_varint_length_prefixed_tlv!(&mut stream, {(1, Some(1u8), option)});
1155                 assert_eq!(stream.0, ::hex::decode("03010101").unwrap());
1156
1157                 stream.0.clear();
1158                 _encode_varint_length_prefixed_tlv!(&mut stream, {(4, 0xabcdu16, required), (42, None::<u64>, option)});
1159                 assert_eq!(stream.0, ::hex::decode("040402abcd").unwrap());
1160
1161                 stream.0.clear();
1162                 _encode_varint_length_prefixed_tlv!(&mut stream, {(42, None::<u64>, option), (0xff, 0xabcdu16, required)});
1163                 assert_eq!(stream.0, ::hex::decode("06fd00ff02abcd").unwrap());
1164
1165                 stream.0.clear();
1166                 _encode_varint_length_prefixed_tlv!(&mut stream, {(0, 1u64, required), (42, None::<u64>, option), (0xff, HighZeroBytesDroppedBigSize(0u64), required)});
1167                 assert_eq!(stream.0, ::hex::decode("0e00080000000000000001fd00ff00").unwrap());
1168
1169                 stream.0.clear();
1170                 _encode_varint_length_prefixed_tlv!(&mut stream, {(0, Some(1u64), option), (0xff, HighZeroBytesDroppedBigSize(0u64), required)});
1171                 assert_eq!(stream.0, ::hex::decode("0e00080000000000000001fd00ff00").unwrap());
1172
1173                 Ok(())
1174         }
1175
1176         #[test]
1177         fn simple_test_tlv_write() {
1178                 do_simple_test_tlv_write().unwrap();
1179         }
1180 }