1 // This file is Copyright its original authors, visible in version control
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
10 //! Some macros that implement [`Readable`]/[`Writeable`] traits for lightning messages.
11 //! They also handle serialization and deserialization of TLVs.
13 //! [`Readable`]: crate::util::ser::Readable
14 //! [`Writeable`]: crate::util::ser::Writeable
16 /// Implements serialization for a single TLV record.
17 /// This is exported for use by other exported macros, do not use directly.
20 macro_rules! _encode_tlv {
21 ($stream: expr, $type: expr, $field: expr, (default_value, $default: expr)) => {
22 $crate::_encode_tlv!($stream, $type, $field, required)
24 ($stream: expr, $type: expr, $field: expr, (static_value, $value: expr)) => {
25 let _ = &$field; // Ensure we "use" the $field
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)?;
32 ($stream: expr, $type: expr, $field: expr, vec_type) => {
33 $crate::_encode_tlv!($stream, $type, $crate::util::ser::WithoutLength(&$field), required);
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)?;
42 ($stream: expr, $type: expr, $field: expr, upgradable_required) => {
43 $crate::_encode_tlv!($stream, $type, $field, required);
45 ($stream: expr, $type: expr, $field: expr, upgradable_option) => {
46 $crate::_encode_tlv!($stream, $type, $field, option);
48 ($stream: expr, $type: expr, $field: expr, (option, encoding: ($fieldty: ty, $encoding: ident))) => {
49 $crate::_encode_tlv!($stream, $type, $field.map(|f| $encoding(f)), option);
51 ($stream: expr, $type: expr, $field: expr, (option, encoding: $fieldty: ty)) => {
52 $crate::_encode_tlv!($stream, $type, $field, option);
56 /// Panics if the last seen TLV type is not numerically less than the TLV type currently being checked.
57 /// This is exported for use by other exported macros, do not use directly.
60 macro_rules! _check_encoded_tlv_order {
61 ($last_type: expr, $type: expr, (static_value, $value: expr)) => { };
62 ($last_type: expr, $type: expr, $fieldty: tt) => {
63 if let Some(t) = $last_type {
64 #[allow(unused_comparisons)] // Note that $type may be 0 making the following comparison always false
65 (debug_assert!(t < $type))
67 $last_type = Some($type);
71 /// Implements the TLVs serialization part in a [`Writeable`] implementation of a struct.
73 /// This should be called inside a method which returns `Result<_, `[`io::Error`]`>`, such as
74 /// [`Writeable::write`]. It will only return an `Err` if the stream `Err`s or [`Writeable::write`]
75 /// on one of the fields `Err`s.
77 /// `$stream` must be a `&mut `[`Writer`] which will receive the bytes for each TLV in the stream.
79 /// Fields MUST be sorted in `$type`-order.
81 /// Note that the lightning TLV requirements require that a single type not appear more than once,
82 /// that TLVs are sorted in type-ascending order, and that any even types be understood by the
85 /// Any `option` fields which have a value of `None` will not be serialized at all.
89 /// # use lightning::encode_tlv_stream;
90 /// # fn write<W: lightning::util::ser::Writer> (stream: &mut W) -> Result<(), lightning::io::Error> {
91 /// let mut required_value = 0u64;
92 /// let mut optional_value: Option<u64> = None;
93 /// encode_tlv_stream!(stream, {
94 /// (0, required_value, required),
95 /// (1, Some(42u64), option),
96 /// (2, optional_value, option),
98 /// // At this point `required_value` has been written as a TLV of type 0, `42u64` has been written
99 /// // as a TLV of type 1 (indicating the reader may ignore it if it is not understood), and *no*
100 /// // TLV is written with type 2.
105 /// [`Writeable`]: crate::util::ser::Writeable
106 /// [`io::Error`]: crate::io::Error
107 /// [`Writeable::write`]: crate::util::ser::Writeable::write
108 /// [`Writer`]: crate::util::ser::Writer
110 macro_rules! encode_tlv_stream {
111 ($stream: expr, {$(($type: expr, $field: expr, $fieldty: tt)),* $(,)*}) => { {
112 #[allow(unused_imports)]
114 ln::msgs::DecodeError,
117 util::ser::Writeable,
121 $crate::_encode_tlv!($stream, $type, $field, $fieldty);
124 #[allow(unused_mut, unused_variables, unused_assignments)]
125 #[cfg(debug_assertions)]
127 let mut last_seen: Option<u64> = None;
129 $crate::_check_encoded_tlv_order!(last_seen, $type, $fieldty);
135 /// Adds the length of the serialized field to a [`LengthCalculatingWriter`].
136 /// This is exported for use by other exported macros, do not use directly.
138 /// [`LengthCalculatingWriter`]: crate::util::ser::LengthCalculatingWriter
141 macro_rules! _get_varint_length_prefixed_tlv_length {
142 ($len: expr, $type: expr, $field: expr, (default_value, $default: expr)) => {
143 $crate::_get_varint_length_prefixed_tlv_length!($len, $type, $field, required)
145 ($len: expr, $type: expr, $field: expr, (static_value, $value: expr)) => {
147 ($len: expr, $type: expr, $field: expr, required) => {
148 BigSize($type).write(&mut $len).expect("No in-memory data may fail to serialize");
149 let field_len = $field.serialized_length();
150 BigSize(field_len as u64).write(&mut $len).expect("No in-memory data may fail to serialize");
153 ($len: expr, $type: expr, $field: expr, vec_type) => {
154 $crate::_get_varint_length_prefixed_tlv_length!($len, $type, $crate::util::ser::WithoutLength(&$field), required);
156 ($len: expr, $optional_type: expr, $optional_field: expr, option) => {
157 if let Some(ref field) = $optional_field {
158 BigSize($optional_type).write(&mut $len).expect("No in-memory data may fail to serialize");
159 let field_len = field.serialized_length();
160 BigSize(field_len as u64).write(&mut $len).expect("No in-memory data may fail to serialize");
164 ($len: expr, $type: expr, $field: expr, upgradable_required) => {
165 $crate::_get_varint_length_prefixed_tlv_length!($len, $type, $field, required);
167 ($len: expr, $type: expr, $field: expr, upgradable_option) => {
168 $crate::_get_varint_length_prefixed_tlv_length!($len, $type, $field, option);
172 /// See the documentation of [`write_tlv_fields`].
173 /// This is exported for use by other exported macros, do not use directly.
176 macro_rules! _encode_varint_length_prefixed_tlv {
177 ($stream: expr, {$(($type: expr, $field: expr, $fieldty: tt)),*}) => { {
178 use $crate::util::ser::BigSize;
181 let mut len = $crate::util::ser::LengthCalculatingWriter(0);
183 $crate::_get_varint_length_prefixed_tlv_length!(len, $type, $field, $fieldty);
187 BigSize(len as u64).write($stream)?;
188 $crate::encode_tlv_stream!($stream, { $(($type, $field, $fieldty)),* });
192 /// Errors if there are missing required TLV types between the last seen type and the type currently being processed.
193 /// This is exported for use by other exported macros, do not use directly.
196 macro_rules! _check_decoded_tlv_order {
197 ($last_seen_type: expr, $typ: expr, $type: expr, $field: ident, (default_value, $default: expr)) => {{
198 #[allow(unused_comparisons)] // Note that $type may be 0 making the second comparison always false
199 let invalid_order = ($last_seen_type.is_none() || $last_seen_type.unwrap() < $type) && $typ.0 > $type;
201 $field = $default.into();
204 ($last_seen_type: expr, $typ: expr, $type: expr, $field: ident, (static_value, $value: expr)) => {
206 ($last_seen_type: expr, $typ: expr, $type: expr, $field: ident, required) => {{
207 #[allow(unused_comparisons)] // Note that $type may be 0 making the second comparison always false
208 let invalid_order = ($last_seen_type.is_none() || $last_seen_type.unwrap() < $type) && $typ.0 > $type;
210 return Err(DecodeError::InvalidValue);
213 ($last_seen_type: expr, $typ: expr, $type: expr, $field: ident, option) => {{
216 ($last_seen_type: expr, $typ: expr, $type: expr, $field: ident, vec_type) => {{
219 ($last_seen_type: expr, $typ: expr, $type: expr, $field: ident, upgradable_required) => {{
220 _check_decoded_tlv_order!($last_seen_type, $typ, $type, $field, required)
222 ($last_seen_type: expr, $typ: expr, $type: expr, $field: ident, upgradable_option) => {{
225 ($last_seen_type: expr, $typ: expr, $type: expr, $field: ident, (option: $trait: ident $(, $read_arg: expr)?)) => {{
228 ($last_seen_type: expr, $typ: expr, $type: expr, $field: ident, (option, encoding: $encoding: tt)) => {{
233 /// Errors if there are missing required TLV types after the last seen type.
234 /// This is exported for use by other exported macros, do not use directly.
237 macro_rules! _check_missing_tlv {
238 ($last_seen_type: expr, $type: expr, $field: ident, (default_value, $default: expr)) => {{
239 #[allow(unused_comparisons)] // Note that $type may be 0 making the second comparison always false
240 let missing_req_type = $last_seen_type.is_none() || $last_seen_type.unwrap() < $type;
241 if missing_req_type {
242 $field = $default.into();
245 ($last_seen_type: expr, $type: expr, $field: expr, (static_value, $value: expr)) => {
248 ($last_seen_type: expr, $type: expr, $field: ident, required) => {{
249 #[allow(unused_comparisons)] // Note that $type may be 0 making the second comparison always false
250 let missing_req_type = $last_seen_type.is_none() || $last_seen_type.unwrap() < $type;
251 if missing_req_type {
252 return Err(DecodeError::InvalidValue);
255 ($last_seen_type: expr, $type: expr, $field: ident, vec_type) => {{
258 ($last_seen_type: expr, $type: expr, $field: ident, option) => {{
261 ($last_seen_type: expr, $type: expr, $field: ident, upgradable_required) => {{
262 _check_missing_tlv!($last_seen_type, $type, $field, required)
264 ($last_seen_type: expr, $type: expr, $field: ident, upgradable_option) => {{
267 ($last_seen_type: expr, $type: expr, $field: ident, (option: $trait: ident $(, $read_arg: expr)?)) => {{
270 ($last_seen_type: expr, $type: expr, $field: ident, (option, encoding: $encoding: tt)) => {{
275 /// Implements deserialization for a single TLV record.
276 /// This is exported for use by other exported macros, do not use directly.
279 macro_rules! _decode_tlv {
280 ($reader: expr, $field: ident, (default_value, $default: expr)) => {{
281 $crate::_decode_tlv!($reader, $field, required)
283 ($reader: expr, $field: ident, (static_value, $value: expr)) => {{
285 ($reader: expr, $field: ident, required) => {{
286 $field = $crate::util::ser::Readable::read(&mut $reader)?;
288 ($reader: expr, $field: ident, vec_type) => {{
289 let f: $crate::util::ser::WithoutLength<Vec<_>> = $crate::util::ser::Readable::read(&mut $reader)?;
292 ($reader: expr, $field: ident, option) => {{
293 $field = Some($crate::util::ser::Readable::read(&mut $reader)?);
295 // `upgradable_required` indicates we're reading a required TLV that may have been upgraded
296 // without backwards compat. We'll error if the field is missing, and return `Ok(None)` if the
297 // field is present but we can no longer understand it.
298 // Note that this variant can only be used within a `MaybeReadable` read.
299 ($reader: expr, $field: ident, upgradable_required) => {{
300 $field = match $crate::util::ser::MaybeReadable::read(&mut $reader)? {
305 // `upgradable_option` indicates we're reading an Option-al TLV that may have been upgraded
306 // without backwards compat. $field will be None if the TLV is missing or if the field is present
307 // but we can no longer understand it.
308 ($reader: expr, $field: ident, upgradable_option) => {{
309 $field = $crate::util::ser::MaybeReadable::read(&mut $reader)?;
311 ($reader: expr, $field: ident, (option: $trait: ident $(, $read_arg: expr)?)) => {{
312 $field = Some($trait::read(&mut $reader $(, $read_arg)*)?);
314 ($reader: expr, $field: ident, (option, encoding: ($fieldty: ty, $encoding: ident, $encoder:ty))) => {{
315 $crate::_decode_tlv!($reader, $field, (option, encoding: ($fieldty, $encoding)));
317 ($reader: expr, $field: ident, (option, encoding: ($fieldty: ty, $encoding: ident))) => {{
319 let field: $encoding<$fieldty> = ser::Readable::read(&mut $reader)?;
323 ($reader: expr, $field: ident, (option, encoding: $fieldty: ty)) => {{
324 $crate::_decode_tlv!($reader, $field, option);
328 /// Checks if `$val` matches `$type`.
329 /// This is exported for use by other exported macros, do not use directly.
332 macro_rules! _decode_tlv_stream_match_check {
333 ($val: ident, $type: expr, (static_value, $value: expr)) => { false };
334 ($val: ident, $type: expr, $fieldty: tt) => { $val == $type }
337 /// Implements the TLVs deserialization part in a [`Readable`] implementation of a struct.
339 /// This should be called inside a method which returns `Result<_, `[`DecodeError`]`>`, such as
340 /// [`Readable::read`]. It will either return an `Err` or ensure all `required` fields have been
341 /// read and optionally read `optional` fields.
343 /// `$stream` must be a [`Read`] and will be fully consumed, reading until no more bytes remain
344 /// (i.e. it returns [`DecodeError::ShortRead`]).
346 /// Fields MUST be sorted in `$type`-order.
348 /// Note that the lightning TLV requirements require that a single type not appear more than once,
349 /// that TLVs are sorted in type-ascending order, and that any even types be understood by the
354 /// # use lightning::decode_tlv_stream;
355 /// # fn read<R: lightning::io::Read> (stream: R) -> Result<(), lightning::ln::msgs::DecodeError> {
356 /// let mut required_value = 0u64;
357 /// let mut optional_value: Option<u64> = None;
358 /// decode_tlv_stream!(stream, {
359 /// (0, required_value, required),
360 /// (2, optional_value, option),
362 /// // At this point, `required_value` has been overwritten with the TLV with type 0.
363 /// // `optional_value` may have been overwritten, setting it to `Some` if a TLV with type 2 was
369 /// [`Readable`]: crate::util::ser::Readable
370 /// [`DecodeError`]: crate::ln::msgs::DecodeError
371 /// [`Readable::read`]: crate::util::ser::Readable::read
372 /// [`Read`]: crate::io::Read
373 /// [`DecodeError::ShortRead`]: crate::ln::msgs::DecodeError::ShortRead
375 macro_rules! decode_tlv_stream {
376 ($stream: expr, {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}) => {
377 let rewind = |_, _| { unreachable!() };
378 $crate::_decode_tlv_stream_range!($stream, .., rewind, {$(($type, $field, $fieldty)),*});
382 /// Similar to [`decode_tlv_stream`] with a custom TLV decoding capabilities.
384 /// `$decode_custom_tlv` is a closure that may be optionally provided to handle custom message types.
385 /// If it is provided, it will be called with the custom type and the [`FixedLengthReader`] containing
386 /// the message contents. It should return `Ok(true)` if the custom message is successfully parsed,
387 /// `Ok(false)` if the message type is unknown, and `Err(`[`DecodeError`]`)` if parsing fails.
389 /// [`FixedLengthReader`]: crate::util::ser::FixedLengthReader
390 /// [`DecodeError`]: crate::ln::msgs::DecodeError
391 macro_rules! decode_tlv_stream_with_custom_tlv_decode {
392 ($stream: expr, {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}
393 $(, $decode_custom_tlv: expr)?) => { {
394 let rewind = |_, _| { unreachable!() };
395 _decode_tlv_stream_range!(
396 $stream, .., rewind, {$(($type, $field, $fieldty)),*} $(, $decode_custom_tlv)?
403 macro_rules! _decode_tlv_stream_range {
404 ($stream: expr, $range: expr, $rewind: ident, {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}
405 $(, $decode_custom_tlv: expr)?) => { {
406 use core::ops::RangeBounds;
407 use $crate::ln::msgs::DecodeError;
408 let mut last_seen_type: Option<u64> = None;
409 let mut stream_ref = $stream;
411 use $crate::util::ser;
413 // First decode the type of this TLV:
414 let typ: ser::BigSize = {
415 // We track whether any bytes were read during the consensus_decode call to
416 // determine whether we should break or return ShortRead if we get an
417 // UnexpectedEof. This should in every case be largely cosmetic, but its nice to
418 // pass the TLV test vectors exactly, which require this distinction.
419 let mut tracking_reader = ser::ReadTrackingReader::new(&mut stream_ref);
420 match <$crate::util::ser::BigSize as $crate::util::ser::Readable>::read(&mut tracking_reader) {
421 Err(DecodeError::ShortRead) => {
422 if !tracking_reader.have_read {
425 return Err(DecodeError::ShortRead);
428 Err(e) => return Err(e),
429 Ok(t) => if $range.contains(&t.0) { t } else {
430 drop(tracking_reader);
432 // Assumes the type id is minimally encoded, which is enforced on read.
433 use $crate::util::ser::Writeable;
434 let bytes_read = t.serialized_length();
435 $rewind(stream_ref, bytes_read);
441 // Types must be unique and monotonically increasing:
442 match last_seen_type {
443 Some(t) if typ.0 <= t => {
444 return Err(DecodeError::InvalidValue);
448 // As we read types, make sure we hit every required type between `last_seen_type` and `typ`:
450 $crate::_check_decoded_tlv_order!(last_seen_type, typ, $type, $field, $fieldty);
452 last_seen_type = Some(typ.0);
454 // Finally, read the length and value itself:
455 let length: ser::BigSize = $crate::util::ser::Readable::read(&mut stream_ref)?;
456 let mut s = ser::FixedLengthReader::new(&mut stream_ref, length.0);
458 $(_t if $crate::_decode_tlv_stream_match_check!(_t, $type, $fieldty) => {
459 $crate::_decode_tlv!(s, $field, $fieldty);
460 if s.bytes_remain() {
461 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
462 return Err(DecodeError::InvalidValue);
467 if $decode_custom_tlv(t, &mut s)? {
468 // If a custom TLV was successfully read (i.e. decode_custom_tlv returns true),
469 // continue to the next TLV read.
475 return Err(DecodeError::UnknownRequiredFeature);
481 // Make sure we got to each required type after we've read every TLV:
483 $crate::_check_missing_tlv!(last_seen_type, $type, $field, $fieldty);
488 /// Implements [`Readable`]/[`Writeable`] for a message struct that may include non-TLV and
489 /// TLV-encoded parts.
491 /// This is useful to implement a [`CustomMessageReader`].
493 /// Currently `$fieldty` may only be `option`, i.e., `$tlvfield` is optional field.
497 /// # use lightning::impl_writeable_msg;
498 /// struct MyCustomMessage {
499 /// pub field_1: u32,
500 /// pub field_2: bool,
501 /// pub field_3: String,
502 /// pub tlv_optional_integer: Option<u32>,
505 /// impl_writeable_msg!(MyCustomMessage, {
510 /// (1, tlv_optional_integer, option),
514 /// [`Readable`]: crate::util::ser::Readable
515 /// [`Writeable`]: crate::util::ser::Writeable
516 /// [`CustomMessageReader`]: crate::ln::wire::CustomMessageReader
518 macro_rules! impl_writeable_msg {
519 ($st:ident, {$($field:ident),* $(,)*}, {$(($type: expr, $tlvfield: ident, $fieldty: tt)),* $(,)*}) => {
520 impl $crate::util::ser::Writeable for $st {
521 fn write<W: $crate::util::ser::Writer>(&self, w: &mut W) -> Result<(), $crate::io::Error> {
522 $( self.$field.write(w)?; )*
523 $crate::encode_tlv_stream!(w, {$(($type, self.$tlvfield, $fieldty)),*});
527 impl $crate::util::ser::Readable for $st {
528 fn read<R: $crate::io::Read>(r: &mut R) -> Result<Self, $crate::ln::msgs::DecodeError> {
529 $(let $field = $crate::util::ser::Readable::read(r)?;)*
530 $($crate::_init_tlv_field_var!($tlvfield, $fieldty);)*
531 $crate::decode_tlv_stream!(r, {$(($type, $tlvfield, $fieldty)),*});
541 macro_rules! impl_writeable {
542 ($st:ident, {$($field:ident),*}) => {
543 impl $crate::util::ser::Writeable for $st {
544 fn write<W: $crate::util::ser::Writer>(&self, w: &mut W) -> Result<(), $crate::io::Error> {
545 $( self.$field.write(w)?; )*
550 fn serialized_length(&self) -> usize {
551 let mut len_calc = 0;
552 $( len_calc += self.$field.serialized_length(); )*
557 impl $crate::util::ser::Readable for $st {
558 fn read<R: $crate::io::Read>(r: &mut R) -> Result<Self, $crate::ln::msgs::DecodeError> {
560 $($field: $crate::util::ser::Readable::read(r)?),*
567 /// Write out two bytes to indicate the version of an object.
569 /// $this_version represents a unique version of a type. Incremented whenever the type's
570 /// serialization format has changed or has a new interpretation. Used by a type's reader to
571 /// determine how to interpret fields or if it can understand a serialized object.
573 /// $min_version_that_can_read_this is the minimum reader version which can understand this
574 /// serialized object. Previous versions will simply err with a [`DecodeError::UnknownVersion`].
576 /// Updates to either `$this_version` or `$min_version_that_can_read_this` should be included in
579 /// Both version fields can be specific to this type of object.
581 /// [`DecodeError::UnknownVersion`]: crate::ln::msgs::DecodeError::UnknownVersion
582 macro_rules! write_ver_prefix {
583 ($stream: expr, $this_version: expr, $min_version_that_can_read_this: expr) => {
584 $stream.write_all(&[$this_version; 1])?;
585 $stream.write_all(&[$min_version_that_can_read_this; 1])?;
589 /// Writes out a suffix to an object as a length-prefixed TLV stream which contains potentially
590 /// backwards-compatible, optional fields which old nodes can happily ignore.
592 /// It is written out in TLV format and, as with all TLV fields, unknown even fields cause a
593 /// [`DecodeError::UnknownRequiredFeature`] error, with unknown odd fields ignored.
595 /// This is the preferred method of adding new fields that old nodes can ignore and still function
598 /// [`DecodeError::UnknownRequiredFeature`]: crate::ln::msgs::DecodeError::UnknownRequiredFeature
600 macro_rules! write_tlv_fields {
601 ($stream: expr, {$(($type: expr, $field: expr, $fieldty: tt)),* $(,)*}) => {
602 $crate::_encode_varint_length_prefixed_tlv!($stream, {$(($type, $field, $fieldty)),*})
606 /// Reads a prefix added by [`write_ver_prefix`], above. Takes the current version of the
607 /// serialization logic for this object. This is compared against the
608 /// `$min_version_that_can_read_this` added by [`write_ver_prefix`].
609 macro_rules! read_ver_prefix {
610 ($stream: expr, $this_version: expr) => { {
611 let ver: u8 = Readable::read($stream)?;
612 let min_ver: u8 = Readable::read($stream)?;
613 if min_ver > $this_version {
614 return Err(DecodeError::UnknownVersion);
620 /// Reads a suffix added by [`write_tlv_fields`].
622 /// [`write_tlv_fields`]: crate::write_tlv_fields
624 macro_rules! read_tlv_fields {
625 ($stream: expr, {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}) => { {
626 let tlv_len: $crate::util::ser::BigSize = $crate::util::ser::Readable::read($stream)?;
627 let mut rd = $crate::util::ser::FixedLengthReader::new($stream, tlv_len.0);
628 $crate::decode_tlv_stream!(&mut rd, {$(($type, $field, $fieldty)),*});
629 rd.eat_remaining().map_err(|_| $crate::ln::msgs::DecodeError::ShortRead)?;
633 /// Initializes the struct fields.
635 /// This is exported for use by other exported macros, do not use directly.
638 macro_rules! _init_tlv_based_struct_field {
639 ($field: ident, (default_value, $default: expr)) => {
642 ($field: ident, (static_value, $value: expr)) => {
645 ($field: ident, option) => {
648 ($field: ident, upgradable_required) => {
651 ($field: ident, upgradable_option) => {
654 ($field: ident, required) => {
657 ($field: ident, vec_type) => {
662 /// Initializes the variable we are going to read the TLV into.
664 /// This is exported for use by other exported macros, do not use directly.
667 macro_rules! _init_tlv_field_var {
668 ($field: ident, (default_value, $default: expr)) => {
669 let mut $field = $crate::util::ser::RequiredWrapper(None);
671 ($field: ident, (static_value, $value: expr)) => {
674 ($field: ident, required) => {
675 let mut $field = $crate::util::ser::RequiredWrapper(None);
677 ($field: ident, vec_type) => {
678 let mut $field = Some(Vec::new());
680 ($field: ident, option) => {
681 let mut $field = None;
683 ($field: ident, upgradable_required) => {
684 let mut $field = $crate::util::ser::UpgradableRequired(None);
686 ($field: ident, upgradable_option) => {
687 let mut $field = None;
691 /// Equivalent to running [`_init_tlv_field_var`] then [`read_tlv_fields`].
693 /// This is exported for use by other exported macros, do not use directly.
696 macro_rules! _init_and_read_tlv_fields {
697 ($reader: ident, {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}) => {
699 $crate::_init_tlv_field_var!($field, $fieldty);
702 $crate::read_tlv_fields!($reader, {
703 $(($type, $field, $fieldty)),*
708 /// Implements [`Readable`]/[`Writeable`] for a struct storing it as a set of TLVs
709 /// If `$fieldty` is `required`, then `$field` is a required field that is not an [`Option`] nor a [`Vec`].
710 /// If `$fieldty` is `(default_value, $default)`, then `$field` will be set to `$default` if not present.
711 /// If `$fieldty` is `option`, then `$field` is optional field.
712 /// If `$fieldty` is `vec_type`, then `$field` is a [`Vec`], which needs to have its individual elements serialized.
716 /// # use lightning::impl_writeable_tlv_based;
717 /// struct LightningMessage {
718 /// tlv_integer: u32,
719 /// tlv_default_integer: u32,
720 /// tlv_optional_integer: Option<u32>,
721 /// tlv_vec_type_integer: Vec<u32>,
724 /// impl_writeable_tlv_based!(LightningMessage, {
725 /// (0, tlv_integer, required),
726 /// (1, tlv_default_integer, (default_value, 7)),
727 /// (2, tlv_optional_integer, option),
728 /// (3, tlv_vec_type_integer, vec_type),
732 /// [`Readable`]: crate::util::ser::Readable
733 /// [`Writeable`]: crate::util::ser::Writeable
735 macro_rules! impl_writeable_tlv_based {
736 ($st: ident, {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}) => {
737 impl $crate::util::ser::Writeable for $st {
738 fn write<W: $crate::util::ser::Writer>(&self, writer: &mut W) -> Result<(), $crate::io::Error> {
739 $crate::write_tlv_fields!(writer, {
740 $(($type, self.$field, $fieldty)),*
746 fn serialized_length(&self) -> usize {
747 use $crate::util::ser::BigSize;
750 let mut len = $crate::util::ser::LengthCalculatingWriter(0);
752 $crate::_get_varint_length_prefixed_tlv_length!(len, $type, self.$field, $fieldty);
756 let mut len_calc = $crate::util::ser::LengthCalculatingWriter(0);
757 BigSize(len as u64).write(&mut len_calc).expect("No in-memory data may fail to serialize");
762 impl $crate::util::ser::Readable for $st {
763 fn read<R: $crate::io::Read>(reader: &mut R) -> Result<Self, $crate::ln::msgs::DecodeError> {
764 $crate::_init_and_read_tlv_fields!(reader, {
765 $(($type, $field, $fieldty)),*
769 $field: $crate::_init_tlv_based_struct_field!($field, $fieldty)
777 /// Defines a struct for a TLV stream and a similar struct using references for non-primitive types,
778 /// implementing [`Readable`] for the former and [`Writeable`] for the latter. Useful as an
779 /// intermediary format when reading or writing a type encoded as a TLV stream. Note that each field
780 /// representing a TLV record has its type wrapped with an [`Option`]. A tuple consisting of a type
781 /// and a serialization wrapper may be given in place of a type when custom serialization is
784 /// [`Readable`]: crate::util::ser::Readable
785 /// [`Writeable`]: crate::util::ser::Writeable
786 macro_rules! tlv_stream {
787 ($name:ident, $nameref:ident, $range:expr, {
788 $(($type:expr, $field:ident : $fieldty:tt)),* $(,)*
791 pub(super) struct $name {
793 pub(super) $field: Option<tlv_record_type!($fieldty)>,
797 #[cfg_attr(test, derive(PartialEq))]
799 pub(super) struct $nameref<'a> {
801 pub(super) $field: Option<tlv_record_ref_type!($fieldty)>,
805 impl<'a> $crate::util::ser::Writeable for $nameref<'a> {
806 fn write<W: $crate::util::ser::Writer>(&self, writer: &mut W) -> Result<(), $crate::io::Error> {
807 encode_tlv_stream!(writer, {
808 $(($type, self.$field, (option, encoding: $fieldty))),*
814 impl $crate::util::ser::SeekReadable for $name {
815 fn read<R: $crate::io::Read + $crate::io::Seek>(reader: &mut R) -> Result<Self, $crate::ln::msgs::DecodeError> {
817 _init_tlv_field_var!($field, option);
819 let rewind = |cursor: &mut R, offset: usize| {
820 cursor.seek($crate::io::SeekFrom::Current(-(offset as i64))).expect("");
822 _decode_tlv_stream_range!(reader, $range, rewind, {
823 $(($type, $field, (option, encoding: $fieldty))),*
836 macro_rules! tlv_record_type {
837 (($type:ty, $wrapper:ident)) => { $type };
838 (($type:ty, $wrapper:ident, $encoder:ty)) => { $type };
839 ($type:ty) => { $type };
842 macro_rules! tlv_record_ref_type {
845 ((u16, $wrapper: ident)) => { u16 };
846 ((u32, $wrapper: ident)) => { u32 };
847 ((u64, $wrapper: ident)) => { u64 };
848 (($type:ty, $wrapper:ident)) => { &'a $type };
849 (($type:ty, $wrapper:ident, $encoder:ty)) => { $encoder };
850 ($type:ty) => { &'a $type };
853 macro_rules! _impl_writeable_tlv_based_enum_common {
854 ($st: ident, $(($variant_id: expr, $variant_name: ident) =>
855 {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}
857 $(($tuple_variant_id: expr, $tuple_variant_name: ident)),* $(,)*) => {
858 impl $crate::util::ser::Writeable for $st {
859 fn write<W: $crate::util::ser::Writer>(&self, writer: &mut W) -> Result<(), $crate::io::Error> {
861 $($st::$variant_name { $(ref $field),* } => {
862 let id: u8 = $variant_id;
864 write_tlv_fields!(writer, {
865 $(($type, *$field, $fieldty)),*
868 $($st::$tuple_variant_name (ref field) => {
869 let id: u8 = $tuple_variant_id;
871 field.write(writer)?;
880 /// Implement [`Readable`] and [`Writeable`] for an enum, with struct variants stored as TLVs and tuple
881 /// variants stored directly.
882 /// The format is, for example
884 /// impl_writeable_tlv_based_enum!(EnumName,
885 /// (0, StructVariantA) => {(0, required_variant_field, required), (1, optional_variant_field, option)},
886 /// (1, StructVariantB) => {(0, variant_field_a, required), (1, variant_field_b, required), (2, variant_vec_field, vec_type)};
887 /// (2, TupleVariantA), (3, TupleVariantB),
890 /// The type is written as a single byte, followed by any variant data.
891 /// Attempts to read an unknown type byte result in [`DecodeError::UnknownRequiredFeature`].
893 /// [`Readable`]: crate::util::ser::Readable
894 /// [`Writeable`]: crate::util::ser::Writeable
895 /// [`DecodeError::UnknownRequiredFeature`]: crate::ln::msgs::DecodeError::UnknownRequiredFeature
897 macro_rules! impl_writeable_tlv_based_enum {
898 ($st: ident, $(($variant_id: expr, $variant_name: ident) =>
899 {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}
901 $(($tuple_variant_id: expr, $tuple_variant_name: ident)),* $(,)*) => {
902 _impl_writeable_tlv_based_enum_common!($st,
903 $(($variant_id, $variant_name) => {$(($type, $field, $fieldty)),*}),*;
904 $(($tuple_variant_id, $tuple_variant_name)),*);
906 impl $crate::util::ser::Readable for $st {
907 fn read<R: $crate::io::Read>(reader: &mut R) -> Result<Self, $crate::ln::msgs::DecodeError> {
908 let id: u8 = $crate::util::ser::Readable::read(reader)?;
911 // Because read_tlv_fields creates a labeled loop, we cannot call it twice
912 // in the same function body. Instead, we define a closure and call it.
914 _init_and_read_tlv_fields!(reader, {
915 $(($type, $field, $fieldty)),*
917 Ok($st::$variant_name {
919 $field: _init_tlv_based_struct_field!($field, $fieldty)
925 $($tuple_variant_id => {
926 Ok($st::$tuple_variant_name(Readable::read(reader)?))
929 Err($crate::ln::msgs::DecodeError::UnknownRequiredFeature)
937 /// Implement [`MaybeReadable`] and [`Writeable`] for an enum, with struct variants stored as TLVs and
938 /// tuple variants stored directly.
940 /// This is largely identical to [`impl_writeable_tlv_based_enum`], except that odd variants will
941 /// return `Ok(None)` instead of `Err(`[`DecodeError::UnknownRequiredFeature`]`)`. It should generally be preferred
942 /// when [`MaybeReadable`] is practical instead of just [`Readable`] as it provides an upgrade path for
943 /// new variants to be added which are simply ignored by existing clients.
945 /// [`MaybeReadable`]: crate::util::ser::MaybeReadable
946 /// [`Writeable`]: crate::util::ser::Writeable
947 /// [`DecodeError::UnknownRequiredFeature`]: crate::ln::msgs::DecodeError::UnknownRequiredFeature
948 /// [`Readable`]: crate::util::ser::Readable
950 macro_rules! impl_writeable_tlv_based_enum_upgradable {
951 ($st: ident, $(($variant_id: expr, $variant_name: ident) =>
952 {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}
955 $(($tuple_variant_id: expr, $tuple_variant_name: ident)),* $(,)*)*) => {
956 _impl_writeable_tlv_based_enum_common!($st,
957 $(($variant_id, $variant_name) => {$(($type, $field, $fieldty)),*}),*;
958 $($(($tuple_variant_id, $tuple_variant_name)),*)*);
960 impl $crate::util::ser::MaybeReadable for $st {
961 fn read<R: $crate::io::Read>(reader: &mut R) -> Result<Option<Self>, $crate::ln::msgs::DecodeError> {
962 let id: u8 = $crate::util::ser::Readable::read(reader)?;
965 // Because read_tlv_fields creates a labeled loop, we cannot call it twice
966 // in the same function body. Instead, we define a closure and call it.
968 _init_and_read_tlv_fields!(reader, {
969 $(($type, $field, $fieldty)),*
971 Ok(Some($st::$variant_name {
973 $field: _init_tlv_based_struct_field!($field, $fieldty)
979 $($($tuple_variant_id => {
980 Ok(Some($st::$tuple_variant_name(Readable::read(reader)?)))
982 _ if id % 2 == 1 => Ok(None),
983 _ => Err($crate::ln::msgs::DecodeError::UnknownRequiredFeature),
992 use crate::io::{self, Cursor};
993 use crate::prelude::*;
994 use crate::ln::msgs::DecodeError;
995 use crate::util::ser::{Writeable, HighZeroBytesDroppedBigSize, VecWriter};
996 use bitcoin::secp256k1::PublicKey;
998 // The BOLT TLV test cases don't include any tests which use our "required-value" logic since
999 // the encoding layer in the BOLTs has no such concept, though it makes our macros easier to
1000 // work with so they're baked into the decoder. Thus, we have a few additional tests below
1001 fn tlv_reader(s: &[u8]) -> Result<(u64, u32, Option<u32>), DecodeError> {
1002 let mut s = Cursor::new(s);
1005 let mut c: Option<u32> = None;
1006 decode_tlv_stream!(&mut s, {(2, a, required), (3, b, required), (4, c, option)});
1011 fn tlv_v_short_read() {
1012 // We only expect a u32 for type 3 (which we are given), but the L says its 8 bytes.
1013 if let Err(DecodeError::ShortRead) = tlv_reader(&::hex::decode(
1014 concat!("0100", "0208deadbeef1badbeef", "0308deadbeef")
1016 } else { panic!(); }
1020 fn tlv_types_out_of_order() {
1021 if let Err(DecodeError::InvalidValue) = tlv_reader(&::hex::decode(
1022 concat!("0100", "0304deadbeef", "0208deadbeef1badbeef")
1024 } else { panic!(); }
1025 // ...even if its some field we don't understand
1026 if let Err(DecodeError::InvalidValue) = tlv_reader(&::hex::decode(
1027 concat!("0208deadbeef1badbeef", "0100", "0304deadbeef")
1029 } else { panic!(); }
1033 fn tlv_req_type_missing_or_extra() {
1034 // It's also bad if they included even fields we don't understand
1035 if let Err(DecodeError::UnknownRequiredFeature) = tlv_reader(&::hex::decode(
1036 concat!("0100", "0208deadbeef1badbeef", "0304deadbeef", "0600")
1038 } else { panic!(); }
1039 // ... or if they're missing fields we need
1040 if let Err(DecodeError::InvalidValue) = tlv_reader(&::hex::decode(
1041 concat!("0100", "0208deadbeef1badbeef")
1043 } else { panic!(); }
1044 // ... even if that field is even
1045 if let Err(DecodeError::InvalidValue) = tlv_reader(&::hex::decode(
1046 concat!("0304deadbeef", "0500")
1048 } else { panic!(); }
1052 fn tlv_simple_good_cases() {
1053 assert_eq!(tlv_reader(&::hex::decode(
1054 concat!("0208deadbeef1badbeef", "03041bad1dea")
1055 ).unwrap()[..]).unwrap(),
1056 (0xdeadbeef1badbeef, 0x1bad1dea, None));
1057 assert_eq!(tlv_reader(&::hex::decode(
1058 concat!("0208deadbeef1badbeef", "03041bad1dea", "040401020304")
1059 ).unwrap()[..]).unwrap(),
1060 (0xdeadbeef1badbeef, 0x1bad1dea, Some(0x01020304)));
1063 #[derive(Debug, PartialEq)]
1064 struct TestUpgradable {
1070 fn upgradable_tlv_reader(s: &[u8]) -> Result<Option<TestUpgradable>, DecodeError> {
1071 let mut s = Cursor::new(s);
1074 let mut c: Option<u32> = None;
1075 decode_tlv_stream!(&mut s, {(2, a, upgradable_required), (3, b, upgradable_required), (4, c, upgradable_option)});
1076 Ok(Some(TestUpgradable { a, b, c, }))
1080 fn upgradable_tlv_simple_good_cases() {
1081 assert_eq!(upgradable_tlv_reader(&::hex::decode(
1082 concat!("0204deadbeef", "03041bad1dea", "0404deadbeef")
1083 ).unwrap()[..]).unwrap(),
1084 Some(TestUpgradable { a: 0xdeadbeef, b: 0x1bad1dea, c: Some(0xdeadbeef) }));
1086 assert_eq!(upgradable_tlv_reader(&::hex::decode(
1087 concat!("0204deadbeef", "03041bad1dea")
1088 ).unwrap()[..]).unwrap(),
1089 Some(TestUpgradable { a: 0xdeadbeef, b: 0x1bad1dea, c: None}));
1093 fn missing_required_upgradable() {
1094 if let Err(DecodeError::InvalidValue) = upgradable_tlv_reader(&::hex::decode(
1095 concat!("0100", "0204deadbeef")
1097 } else { panic!(); }
1098 if let Err(DecodeError::InvalidValue) = upgradable_tlv_reader(&::hex::decode(
1099 concat!("0100", "03041bad1dea")
1101 } else { panic!(); }
1104 // BOLT TLV test cases
1105 fn tlv_reader_n1(s: &[u8]) -> Result<(Option<HighZeroBytesDroppedBigSize<u64>>, Option<u64>, Option<(PublicKey, u64, u64)>, Option<u16>), DecodeError> {
1106 let mut s = Cursor::new(s);
1107 let mut tlv1: Option<HighZeroBytesDroppedBigSize<u64>> = None;
1108 let mut tlv2: Option<u64> = None;
1109 let mut tlv3: Option<(PublicKey, u64, u64)> = None;
1110 let mut tlv4: Option<u16> = None;
1111 decode_tlv_stream!(&mut s, {(1, tlv1, option), (2, tlv2, option), (3, tlv3, option), (254, tlv4, option)});
1112 Ok((tlv1, tlv2, tlv3, tlv4))
1116 fn bolt_tlv_bogus_stream() {
1117 macro_rules! do_test {
1118 ($stream: expr, $reason: ident) => {
1119 if let Err(DecodeError::$reason) = tlv_reader_n1(&::hex::decode($stream).unwrap()[..]) {
1120 } else { panic!(); }
1124 // TLVs from the BOLT test cases which should not decode as either n1 or n2
1125 do_test!(concat!("fd01"), ShortRead);
1126 do_test!(concat!("fd0001", "00"), InvalidValue);
1127 do_test!(concat!("fd0101"), ShortRead);
1128 do_test!(concat!("0f", "fd"), ShortRead);
1129 do_test!(concat!("0f", "fd26"), ShortRead);
1130 do_test!(concat!("0f", "fd2602"), ShortRead);
1131 do_test!(concat!("0f", "fd0001", "00"), InvalidValue);
1132 do_test!(concat!("0f", "fd0201", "000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"), ShortRead);
1134 do_test!(concat!("12", "00"), UnknownRequiredFeature);
1135 do_test!(concat!("fd0102", "00"), UnknownRequiredFeature);
1136 do_test!(concat!("fe01000002", "00"), UnknownRequiredFeature);
1137 do_test!(concat!("ff0100000000000002", "00"), UnknownRequiredFeature);
1141 fn bolt_tlv_bogus_n1_stream() {
1142 macro_rules! do_test {
1143 ($stream: expr, $reason: ident) => {
1144 if let Err(DecodeError::$reason) = tlv_reader_n1(&::hex::decode($stream).unwrap()[..]) {
1145 } else { panic!(); }
1149 // TLVs from the BOLT test cases which should not decode as n1
1150 do_test!(concat!("01", "09", "ffffffffffffffffff"), InvalidValue);
1151 do_test!(concat!("01", "01", "00"), InvalidValue);
1152 do_test!(concat!("01", "02", "0001"), InvalidValue);
1153 do_test!(concat!("01", "03", "000100"), InvalidValue);
1154 do_test!(concat!("01", "04", "00010000"), InvalidValue);
1155 do_test!(concat!("01", "05", "0001000000"), InvalidValue);
1156 do_test!(concat!("01", "06", "000100000000"), InvalidValue);
1157 do_test!(concat!("01", "07", "00010000000000"), InvalidValue);
1158 do_test!(concat!("01", "08", "0001000000000000"), InvalidValue);
1159 do_test!(concat!("02", "07", "01010101010101"), ShortRead);
1160 do_test!(concat!("02", "09", "010101010101010101"), InvalidValue);
1161 do_test!(concat!("03", "21", "023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb"), ShortRead);
1162 do_test!(concat!("03", "29", "023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb0000000000000001"), ShortRead);
1163 do_test!(concat!("03", "30", "023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb000000000000000100000000000001"), ShortRead);
1164 do_test!(concat!("03", "31", "043da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb00000000000000010000000000000002"), InvalidValue);
1165 do_test!(concat!("03", "32", "023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb0000000000000001000000000000000001"), InvalidValue);
1166 do_test!(concat!("fd00fe", "00"), ShortRead);
1167 do_test!(concat!("fd00fe", "01", "01"), ShortRead);
1168 do_test!(concat!("fd00fe", "03", "010101"), InvalidValue);
1169 do_test!(concat!("00", "00"), UnknownRequiredFeature);
1171 do_test!(concat!("02", "08", "0000000000000226", "01", "01", "2a"), InvalidValue);
1172 do_test!(concat!("02", "08", "0000000000000231", "02", "08", "0000000000000451"), InvalidValue);
1173 do_test!(concat!("1f", "00", "0f", "01", "2a"), InvalidValue);
1174 do_test!(concat!("1f", "00", "1f", "01", "2a"), InvalidValue);
1176 // The last BOLT test modified to not require creating a new decoder for one trivial test.
1177 do_test!(concat!("ffffffffffffffffff", "00", "01", "00"), InvalidValue);
1181 fn bolt_tlv_valid_n1_stream() {
1182 macro_rules! do_test {
1183 ($stream: expr, $tlv1: expr, $tlv2: expr, $tlv3: expr, $tlv4: expr) => {
1184 if let Ok((tlv1, tlv2, tlv3, tlv4)) = tlv_reader_n1(&::hex::decode($stream).unwrap()[..]) {
1185 assert_eq!(tlv1.map(|v| v.0), $tlv1);
1186 assert_eq!(tlv2, $tlv2);
1187 assert_eq!(tlv3, $tlv3);
1188 assert_eq!(tlv4, $tlv4);
1189 } else { panic!(); }
1193 do_test!(concat!(""), None, None, None, None);
1194 do_test!(concat!("21", "00"), None, None, None, None);
1195 do_test!(concat!("fd0201", "00"), None, None, None, None);
1196 do_test!(concat!("fd00fd", "00"), None, None, None, None);
1197 do_test!(concat!("fd00ff", "00"), None, None, None, None);
1198 do_test!(concat!("fe02000001", "00"), None, None, None, None);
1199 do_test!(concat!("ff0200000000000001", "00"), None, None, None, None);
1201 do_test!(concat!("01", "00"), Some(0), None, None, None);
1202 do_test!(concat!("01", "01", "01"), Some(1), None, None, None);
1203 do_test!(concat!("01", "02", "0100"), Some(256), None, None, None);
1204 do_test!(concat!("01", "03", "010000"), Some(65536), None, None, None);
1205 do_test!(concat!("01", "04", "01000000"), Some(16777216), None, None, None);
1206 do_test!(concat!("01", "05", "0100000000"), Some(4294967296), None, None, None);
1207 do_test!(concat!("01", "06", "010000000000"), Some(1099511627776), None, None, None);
1208 do_test!(concat!("01", "07", "01000000000000"), Some(281474976710656), None, None, None);
1209 do_test!(concat!("01", "08", "0100000000000000"), Some(72057594037927936), None, None, None);
1210 do_test!(concat!("02", "08", "0000000000000226"), None, Some((0 << 30) | (0 << 5) | (550 << 0)), None, None);
1211 do_test!(concat!("03", "31", "023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb00000000000000010000000000000002"),
1213 PublicKey::from_slice(&::hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]).unwrap(), 1, 2)),
1215 do_test!(concat!("fd00fe", "02", "0226"), None, None, None, Some(550));
1218 fn do_simple_test_tlv_write() -> Result<(), io::Error> {
1219 let mut stream = VecWriter(Vec::new());
1222 _encode_varint_length_prefixed_tlv!(&mut stream, {(1, 1u8, required), (42, None::<u64>, option)});
1223 assert_eq!(stream.0, ::hex::decode("03010101").unwrap());
1226 _encode_varint_length_prefixed_tlv!(&mut stream, {(1, Some(1u8), option)});
1227 assert_eq!(stream.0, ::hex::decode("03010101").unwrap());
1230 _encode_varint_length_prefixed_tlv!(&mut stream, {(4, 0xabcdu16, required), (42, None::<u64>, option)});
1231 assert_eq!(stream.0, ::hex::decode("040402abcd").unwrap());
1234 _encode_varint_length_prefixed_tlv!(&mut stream, {(42, None::<u64>, option), (0xff, 0xabcdu16, required)});
1235 assert_eq!(stream.0, ::hex::decode("06fd00ff02abcd").unwrap());
1238 _encode_varint_length_prefixed_tlv!(&mut stream, {(0, 1u64, required), (42, None::<u64>, option), (0xff, HighZeroBytesDroppedBigSize(0u64), required)});
1239 assert_eq!(stream.0, ::hex::decode("0e00080000000000000001fd00ff00").unwrap());
1242 _encode_varint_length_prefixed_tlv!(&mut stream, {(0, Some(1u64), option), (0xff, HighZeroBytesDroppedBigSize(0u64), required)});
1243 assert_eq!(stream.0, ::hex::decode("0e00080000000000000001fd00ff00").unwrap());
1249 fn simple_test_tlv_write() {
1250 do_simple_test_tlv_write().unwrap();