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 macro_rules! encode_tlv {
11 ($stream: expr, {$(($type: expr, $field: expr)),*}, {$(($optional_type: expr, $optional_field: expr)),*}) => { {
12 #[allow(unused_imports)]
13 use util::ser::BigSize;
14 // Fields must be serialized in order, so we have to potentially switch between optional
15 // fields and normal fields while serializing. Thus, we end up having to loop over the type
17 // Sadly, while LLVM does appear smart enough to make `max_field` a constant, it appears to
18 // refuse to unroll the loop. If we have enough entries that this is slow we can revisit
19 // this design in the future.
21 let mut max_field: u64 = 0;
23 if $type >= max_field { max_field = $type + 1; }
26 if $optional_type >= max_field { max_field = $optional_type + 1; }
28 #[allow(unused_variables)]
29 for i in 0..max_field {
32 BigSize($type).write($stream)?;
33 BigSize($field.serialized_length() as u64).write($stream)?;
34 $field.write($stream)?;
38 if i == $optional_type {
39 if let Some(ref field) = $optional_field {
40 BigSize($optional_type).write($stream)?;
41 BigSize(field.serialized_length() as u64).write($stream)?;
42 field.write($stream)?;
50 macro_rules! get_varint_length_prefixed_tlv_length {
51 ({$(($type: expr, $field: expr)),*}, {$(($optional_type: expr, $optional_field: expr)),* $(,)*}) => { {
52 use util::ser::LengthCalculatingWriter;
54 let mut len = LengthCalculatingWriter(0);
57 BigSize($type).write(&mut len).expect("No in-memory data may fail to serialize");
58 let field_len = $field.serialized_length();
59 BigSize(field_len as u64).write(&mut len).expect("No in-memory data may fail to serialize");
63 if let Some(ref field) = $optional_field {
64 BigSize($optional_type).write(&mut len).expect("No in-memory data may fail to serialize");
65 let field_len = field.serialized_length();
66 BigSize(field_len as u64).write(&mut len).expect("No in-memory data may fail to serialize");
75 macro_rules! encode_varint_length_prefixed_tlv {
76 ($stream: expr, {$(($type: expr, $field: expr)),*}, {$(($optional_type: expr, $optional_field: expr)),*}) => { {
77 use util::ser::BigSize;
78 let len = get_varint_length_prefixed_tlv_length!({ $(($type, $field)),* }, { $(($optional_type, $optional_field)),* });
79 BigSize(len as u64).write($stream)?;
80 encode_tlv!($stream, { $(($type, $field)),* }, { $(($optional_type, $optional_field)),* });
84 macro_rules! decode_tlv {
85 ($stream: expr, {$(($reqtype: expr, $reqfield: ident)),*}, {$(($type: expr, $field: ident)),*}) => { {
86 use ln::msgs::DecodeError;
87 let mut last_seen_type: Option<u64> = None;
91 // First decode the type of this TLV:
92 let typ: ser::BigSize = {
93 // We track whether any bytes were read during the consensus_decode call to
94 // determine whether we should break or return ShortRead if we get an
95 // UnexpectedEof. This should in every case be largely cosmetic, but its nice to
96 // pass the TLV test vectors exactly, which requre this distinction.
97 let mut tracking_reader = ser::ReadTrackingReader::new($stream);
98 match ser::Readable::read(&mut tracking_reader) {
99 Err(DecodeError::ShortRead) => {
100 if !tracking_reader.have_read {
103 Err(DecodeError::ShortRead)?
111 // Types must be unique and monotonically increasing:
112 match last_seen_type {
113 Some(t) if typ.0 <= t => {
114 Err(DecodeError::InvalidValue)?
118 // As we read types, make sure we hit every required type:
120 #[allow(unused_comparisons)] // Note that $reqtype may be 0 making the second comparison always true
121 let invalid_order = (last_seen_type.is_none() || last_seen_type.unwrap() < $reqtype) && typ.0 > $reqtype;
123 Err(DecodeError::InvalidValue)?
126 last_seen_type = Some(typ.0);
128 // Finally, read the length and value itself:
129 let length: ser::BigSize = Readable::read($stream)?;
130 let mut s = ser::FixedLengthReader::new($stream, length.0);
133 $reqfield = ser::Readable::read(&mut s)?;
134 if s.bytes_remain() {
135 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
136 Err(DecodeError::InvalidValue)?
140 $field = Some(ser::Readable::read(&mut s)?);
141 if s.bytes_remain() {
142 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
143 Err(DecodeError::InvalidValue)?
147 Err(DecodeError::UnknownRequiredFeature)?
153 // Make sure we got to each required type after we've read every TLV:
155 #[allow(unused_comparisons)] // Note that $reqtype may be 0 making the second comparison always true
156 let missing_req_type = last_seen_type.is_none() || last_seen_type.unwrap() < $reqtype;
157 if missing_req_type {
158 Err(DecodeError::InvalidValue)?
164 macro_rules! impl_writeable {
165 ($st:ident, $len: expr, {$($field:ident),*}) => {
166 impl ::util::ser::Writeable for $st {
167 fn write<W: ::util::ser::Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
171 #[cfg(any(test, feature = "fuzztarget"))]
173 // In tests, assert that the hard-coded length matches the actual one
175 use util::ser::LengthCalculatingWriter;
176 let mut len_calc = LengthCalculatingWriter(0);
177 $( self.$field.write(&mut len_calc).expect("No in-memory data may fail to serialize"); )*
178 assert_eq!(len_calc.0, $len);
179 assert_eq!(self.serialized_length(), $len);
182 $( self.$field.write(w)?; )*
187 fn serialized_length(&self) -> usize {
188 if $len == 0 || cfg!(any(test, feature = "fuzztarget")) {
189 let mut len_calc = 0;
190 $( len_calc += self.$field.serialized_length(); )*
192 // In tests, assert that the hard-coded length matches the actual one
193 assert_eq!(len_calc, $len);
202 impl ::util::ser::Readable for $st {
203 fn read<R: ::std::io::Read>(r: &mut R) -> Result<Self, ::ln::msgs::DecodeError> {
205 $($field: ::util::ser::Readable::read(r)?),*
211 macro_rules! impl_writeable_len_match {
212 ($struct: ident, $cmp: tt, ($calc_len: expr), {$({$match: pat, $length: expr}),*}, {$($field:ident),*}) => {
213 impl Writeable for $struct {
214 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
215 let len = match *self {
216 $($match => $length,)*
219 #[cfg(any(test, feature = "fuzztarget"))]
221 // In tests, assert that the hard-coded length matches the actual one
222 use util::ser::LengthCalculatingWriter;
223 let mut len_calc = LengthCalculatingWriter(0);
224 $( self.$field.write(&mut len_calc).expect("No in-memory data may fail to serialize"); )*
225 assert!(len_calc.0 $cmp len);
226 assert_eq!(len_calc.0, self.serialized_length());
228 $( self.$field.write(w)?; )*
233 fn serialized_length(&self) -> usize {
234 if $calc_len || cfg!(any(test, feature = "fuzztarget")) {
235 let mut len_calc = 0;
236 $( len_calc += self.$field.serialized_length(); )*
238 assert_eq!(len_calc, match *self {
239 $($match => $length,)*
245 $($match => $length,)*
250 impl ::util::ser::Readable for $struct {
251 fn read<R: ::std::io::Read>(r: &mut R) -> Result<Self, DecodeError> {
253 $($field: Readable::read(r)?),*
258 ($struct: ident, $cmp: tt, {$({$match: pat, $length: expr}),*}, {$($field:ident),*}) => {
259 impl_writeable_len_match!($struct, $cmp, (true), { $({ $match, $length }),* }, { $($field),* });
261 ($struct: ident, {$({$match: pat, $length: expr}),*}, {$($field:ident),*}) => {
262 impl_writeable_len_match!($struct, ==, (false), { $({ $match, $length }),* }, { $($field),* });
266 /// Write out two bytes to indicate the version of an object.
267 /// $this_version represents a unique version of a type. Incremented whenever the type's
268 /// serialization format has changed or has a new interpretation. Used by a type's
269 /// reader to determine how to interpret fields or if it can understand a serialized
271 /// $min_version_that_can_read_this is the minimum reader version which can understand this
272 /// serialized object. Previous versions will simply err with a
273 /// DecodeError::UnknownVersion.
275 /// Updates to either $this_version or $min_version_that_can_read_this should be included in
278 /// Both version fields can be specific to this type of object.
279 macro_rules! write_ver_prefix {
280 ($stream: expr, $this_version: expr, $min_version_that_can_read_this: expr) => {
281 $stream.write_all(&[$this_version; 1])?;
282 $stream.write_all(&[$min_version_that_can_read_this; 1])?;
286 /// Writes out a suffix to an object which contains potentially backwards-compatible, optional
287 /// fields which old nodes can happily ignore.
289 /// It is written out in TLV format and, as with all TLV fields, unknown even fields cause a
290 /// DecodeError::UnknownRequiredFeature error, with unknown odd fields ignored.
292 /// This is the preferred method of adding new fields that old nodes can ignore and still function
294 macro_rules! write_tlv_fields {
295 ($stream: expr, {$(($type: expr, $field: expr)),* $(,)*}, {$(($optional_type: expr, $optional_field: expr)),* $(,)*}) => {
296 encode_varint_length_prefixed_tlv!($stream, {$(($type, $field)),*} , {$(($optional_type, $optional_field)),*});
300 /// Reads a prefix added by write_ver_prefix!(), above. Takes the current version of the
301 /// serialization logic for this object. This is compared against the
302 /// $min_version_that_can_read_this added by write_ver_prefix!().
303 macro_rules! read_ver_prefix {
304 ($stream: expr, $this_version: expr) => { {
305 let ver: u8 = Readable::read($stream)?;
306 let min_ver: u8 = Readable::read($stream)?;
307 if min_ver > $this_version {
308 return Err(DecodeError::UnknownVersion);
314 /// Reads a suffix added by write_tlv_fields.
315 macro_rules! read_tlv_fields {
316 ($stream: expr, {$(($reqtype: expr, $reqfield: ident)),* $(,)*}, {$(($type: expr, $field: ident)),* $(,)*}) => { {
317 let tlv_len = ::util::ser::BigSize::read($stream)?;
318 let mut rd = ::util::ser::FixedLengthReader::new($stream, tlv_len.0);
319 decode_tlv!(&mut rd, {$(($reqtype, $reqfield)),*}, {$(($type, $field)),*});
320 rd.eat_remaining().map_err(|_| DecodeError::ShortRead)?;
324 // If we naively create a struct in impl_writeable_tlv_based below, we may end up returning
325 // `Self { ,,vecfield: vecfield }` which is obviously incorrect. Instead, we have to match here to
326 // detect at least one empty field set and skip the potentially-extra comma.
327 macro_rules! _init_tlv_based_struct {
328 ($($type: ident)::*, {}, {$($field: ident),*}, {$($vecfield: ident),*}) => {
331 $($vecfield: $vecfield.unwrap().0),*
334 ($($type: ident)::*, {$($reqfield: ident),*}, {}, {$($vecfield: ident),*}) => {
336 $($reqfield: $reqfield.0.unwrap()),*,
337 $($vecfield: $vecfield.unwrap().0),*
340 ($($type: ident)::*, {$($reqfield: ident),*}, {$($field: ident),*}, {}) => {
342 $($reqfield: $reqfield.0.unwrap()),*,
346 ($($type: ident)::*, {$($reqfield: ident),*}, {$($field: ident),*}, {$($vecfield: ident),*}) => {
348 $($reqfield: $reqfield.0.unwrap()),*,
350 $($vecfield: $vecfield.unwrap().0),*
355 // If we don't have any optional types below, but do have some vec types, we end up calling
356 // `write_tlv_field!($stream, {..}, {, (vec_ty, vec_val)})`, which is obviously broken.
357 // Instead, for write and read we match the missing values and skip the extra comma.
358 macro_rules! _write_tlv_fields {
359 ($stream: expr, {$(($type: expr, $field: expr)),* $(,)*}, {}, {$(($optional_type: expr, $optional_field: expr)),* $(,)*}) => {
360 write_tlv_fields!($stream, {$(($type, $field)),*} , {$(($optional_type, $optional_field)),*});
362 ($stream: expr, {$(($type: expr, $field: expr)),* $(,)*}, {$(($optional_type: expr, $optional_field: expr)),* $(,)*}, {$(($optional_type_2: expr, $optional_field_2: expr)),* $(,)*}) => {
363 write_tlv_fields!($stream, {$(($type, $field)),*} , {$(($optional_type, $optional_field)),*, $(($optional_type_2, $optional_field_2)),*});
366 macro_rules! _get_tlv_len {
367 ({$(($type: expr, $field: expr)),* $(,)*}, {}, {$(($optional_type: expr, $optional_field: expr)),* $(,)*}) => {
368 get_varint_length_prefixed_tlv_length!({$(($type, $field)),*} , {$(($optional_type, $optional_field)),*})
370 ({$(($type: expr, $field: expr)),* $(,)*}, {$(($optional_type: expr, $optional_field: expr)),* $(,)*}, {$(($optional_type_2: expr, $optional_field_2: expr)),* $(,)*}) => {
371 get_varint_length_prefixed_tlv_length!({$(($type, $field)),*} , {$(($optional_type, $optional_field)),*, $(($optional_type_2, $optional_field_2)),*})
374 macro_rules! _read_tlv_fields {
375 ($stream: expr, {$(($reqtype: expr, $reqfield: ident)),* $(,)*}, {}, {$(($type: expr, $field: ident)),* $(,)*}) => {
376 read_tlv_fields!($stream, {$(($reqtype, $reqfield)),*}, {$(($type, $field)),*});
378 ($stream: expr, {$(($reqtype: expr, $reqfield: ident)),* $(,)*}, {$(($type: expr, $field: ident)),* $(,)*}, {$(($type_2: expr, $field_2: ident)),* $(,)*}) => {
379 read_tlv_fields!($stream, {$(($reqtype, $reqfield)),*}, {$(($type, $field)),*, $(($type_2, $field_2)),*});
383 /// Implements Readable/Writeable for a struct storing it as a set of TLVs
384 /// First block includes all the required fields including a dummy value which is used during
385 /// deserialization but which will never be exposed to other code.
386 /// The second block includes optional fields.
387 /// The third block includes any Vecs which need to have their individual elements serialized.
388 macro_rules! impl_writeable_tlv_based {
389 ($st: ident, {$(($reqtype: expr, $reqfield: ident)),* $(,)*}, {$(($type: expr, $field: ident)),* $(,)*}, {$(($vectype: expr, $vecfield: ident)),* $(,)*}) => {
390 impl ::util::ser::Writeable for $st {
391 fn write<W: ::util::ser::Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
392 _write_tlv_fields!(writer, {
393 $(($reqtype, self.$reqfield)),*
395 $(($type, self.$field)),*
397 $(($vectype, Some(::util::ser::VecWriteWrapper(&self.$vecfield)))),*
403 fn serialized_length(&self) -> usize {
404 let len = _get_tlv_len!({
405 $(($reqtype, self.$reqfield)),*
407 $(($type, self.$field)),*
409 $(($vectype, Some(::util::ser::VecWriteWrapper(&self.$vecfield)))),*
411 use util::ser::{BigSize, LengthCalculatingWriter};
412 let mut len_calc = LengthCalculatingWriter(0);
413 BigSize(len as u64).write(&mut len_calc).expect("No in-memory data may fail to serialize");
418 impl ::util::ser::Readable for $st {
419 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, ::ln::msgs::DecodeError> {
421 let mut $reqfield = ::util::ser::OptionDeserWrapper(None);
424 let mut $field = None;
427 let mut $vecfield = Some(::util::ser::VecReadWrapper(Vec::new()));
429 _read_tlv_fields!(reader, {
430 $(($reqtype, $reqfield)),*
434 $(($vectype, $vecfield)),*
436 _init_tlv_based_struct!($st, {$($reqfield),*}, {$($field),*}, {$($vecfield),*})
442 /// Implement Readable and Writeable for an enum, with struct variants stored as TLVs and tuple
443 /// variants stored directly.
444 /// The format is, for example
445 /// impl_writeable_tlv_based_enum!(EnumName,
446 /// (0, StructVariantA) => {(0, variant_field)}, {(1, variant_optional_field)}, {},
447 /// (1, StructVariantB) => {(0, variant_field_a), (1, variant_field_b)}, {}, {(2, variant_vec_field)};
448 /// (2, TupleVariantA), (3, TupleVariantB),
450 /// The type is written as a single byte, followed by any variant data.
451 /// Attempts to read an unknown type byte result in DecodeError::UnknownRequiredFeature.
452 macro_rules! impl_writeable_tlv_based_enum {
453 ($st: ident, $(($variant_id: expr, $variant_name: ident) =>
454 {$(($reqtype: expr, $reqfield: ident)),* $(,)*},
455 {$(($type: expr, $field: ident)),* $(,)*},
456 {$(($vectype: expr, $vecfield: ident)),* $(,)*}
458 $(($tuple_variant_id: expr, $tuple_variant_name: ident)),* $(,)*) => {
459 impl ::util::ser::Writeable for $st {
460 fn write<W: ::util::ser::Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
462 $($st::$variant_name { $(ref $reqfield),* $(ref $field),*, $(ref $vecfield),* } => {
463 let id: u8 = $variant_id;
465 _write_tlv_fields!(writer, {
466 $(($reqtype, $reqfield)),*
470 $(($vectype, Some(::util::ser::VecWriteWrapper(&$vecfield)))),*
473 $($st::$tuple_variant_name (ref field) => {
474 let id: u8 = $tuple_variant_id;
476 field.write(writer)?;
483 impl ::util::ser::Readable for $st {
484 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, ::ln::msgs::DecodeError> {
485 let id: u8 = ::util::ser::Readable::read(reader)?;
488 // Because read_tlv_fields creates a labeled loop, we cannot call it twice
489 // in the same function body. Instead, we define a closure and call it.
492 let mut $reqfield = ::util::ser::OptionDeserWrapper(None);
495 let mut $field = None;
498 let mut $vecfield = Some(::util::ser::VecReadWrapper(Vec::new()));
500 _read_tlv_fields!(reader, {
501 $(($reqtype, $reqfield)),*
505 $(($vectype, $vecfield)),*
507 _init_tlv_based_struct!($st::$variant_name, {$($reqfield),*}, {$($field),*}, {$($vecfield),*})
511 $($tuple_variant_id => {
512 Ok($st::$tuple_variant_name(Readable::read(reader)?))
515 Err(DecodeError::UnknownRequiredFeature)?
526 use std::io::{Cursor, Read};
527 use ln::msgs::DecodeError;
528 use util::ser::{Readable, Writeable, HighZeroBytesDroppedVarInt, VecWriter};
529 use bitcoin::secp256k1::PublicKey;
531 // The BOLT TLV test cases don't include any tests which use our "required-value" logic since
532 // the encoding layer in the BOLTs has no such concept, though it makes our macros easier to
533 // work with so they're baked into the decoder. Thus, we have a few additional tests below
534 fn tlv_reader(s: &[u8]) -> Result<(u64, u32, Option<u32>), DecodeError> {
535 let mut s = Cursor::new(s);
538 let mut c: Option<u32> = None;
539 decode_tlv!(&mut s, {(2, a), (3, b)}, {(4, c)});
544 fn tlv_v_short_read() {
545 // We only expect a u32 for type 3 (which we are given), but the L says its 8 bytes.
546 if let Err(DecodeError::ShortRead) = tlv_reader(&::hex::decode(
547 concat!("0100", "0208deadbeef1badbeef", "0308deadbeef")
553 fn tlv_types_out_of_order() {
554 if let Err(DecodeError::InvalidValue) = tlv_reader(&::hex::decode(
555 concat!("0100", "0304deadbeef", "0208deadbeef1badbeef")
558 // ...even if its some field we don't understand
559 if let Err(DecodeError::InvalidValue) = tlv_reader(&::hex::decode(
560 concat!("0208deadbeef1badbeef", "0100", "0304deadbeef")
566 fn tlv_req_type_missing_or_extra() {
567 // It's also bad if they included even fields we don't understand
568 if let Err(DecodeError::UnknownRequiredFeature) = tlv_reader(&::hex::decode(
569 concat!("0100", "0208deadbeef1badbeef", "0304deadbeef", "0600")
572 // ... or if they're missing fields we need
573 if let Err(DecodeError::InvalidValue) = tlv_reader(&::hex::decode(
574 concat!("0100", "0208deadbeef1badbeef")
577 // ... even if that field is even
578 if let Err(DecodeError::InvalidValue) = tlv_reader(&::hex::decode(
579 concat!("0304deadbeef", "0500")
585 fn tlv_simple_good_cases() {
586 assert_eq!(tlv_reader(&::hex::decode(
587 concat!("0208deadbeef1badbeef", "03041bad1dea")
588 ).unwrap()[..]).unwrap(),
589 (0xdeadbeef1badbeef, 0x1bad1dea, None));
590 assert_eq!(tlv_reader(&::hex::decode(
591 concat!("0208deadbeef1badbeef", "03041bad1dea", "040401020304")
592 ).unwrap()[..]).unwrap(),
593 (0xdeadbeef1badbeef, 0x1bad1dea, Some(0x01020304)));
596 impl Readable for (PublicKey, u64, u64) {
598 fn read<R: Read>(reader: &mut R) -> Result<(PublicKey, u64, u64), DecodeError> {
599 Ok((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?))
603 // BOLT TLV test cases
604 fn tlv_reader_n1(s: &[u8]) -> Result<(Option<HighZeroBytesDroppedVarInt<u64>>, Option<u64>, Option<(PublicKey, u64, u64)>, Option<u16>), DecodeError> {
605 let mut s = Cursor::new(s);
606 let mut tlv1: Option<HighZeroBytesDroppedVarInt<u64>> = None;
607 let mut tlv2: Option<u64> = None;
608 let mut tlv3: Option<(PublicKey, u64, u64)> = None;
609 let mut tlv4: Option<u16> = None;
610 decode_tlv!(&mut s, {}, {(1, tlv1), (2, tlv2), (3, tlv3), (254, tlv4)});
611 Ok((tlv1, tlv2, tlv3, tlv4))
615 fn bolt_tlv_bogus_stream() {
616 macro_rules! do_test {
617 ($stream: expr, $reason: ident) => {
618 if let Err(DecodeError::$reason) = tlv_reader_n1(&::hex::decode($stream).unwrap()[..]) {
623 // TLVs from the BOLT test cases which should not decode as either n1 or n2
624 do_test!(concat!("fd01"), ShortRead);
625 do_test!(concat!("fd0001", "00"), InvalidValue);
626 do_test!(concat!("fd0101"), ShortRead);
627 do_test!(concat!("0f", "fd"), ShortRead);
628 do_test!(concat!("0f", "fd26"), ShortRead);
629 do_test!(concat!("0f", "fd2602"), ShortRead);
630 do_test!(concat!("0f", "fd0001", "00"), InvalidValue);
631 do_test!(concat!("0f", "fd0201", "000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"), ShortRead);
633 do_test!(concat!("12", "00"), UnknownRequiredFeature);
634 do_test!(concat!("fd0102", "00"), UnknownRequiredFeature);
635 do_test!(concat!("fe01000002", "00"), UnknownRequiredFeature);
636 do_test!(concat!("ff0100000000000002", "00"), UnknownRequiredFeature);
640 fn bolt_tlv_bogus_n1_stream() {
641 macro_rules! do_test {
642 ($stream: expr, $reason: ident) => {
643 if let Err(DecodeError::$reason) = tlv_reader_n1(&::hex::decode($stream).unwrap()[..]) {
648 // TLVs from the BOLT test cases which should not decode as n1
649 do_test!(concat!("01", "09", "ffffffffffffffffff"), InvalidValue);
650 do_test!(concat!("01", "01", "00"), InvalidValue);
651 do_test!(concat!("01", "02", "0001"), InvalidValue);
652 do_test!(concat!("01", "03", "000100"), InvalidValue);
653 do_test!(concat!("01", "04", "00010000"), InvalidValue);
654 do_test!(concat!("01", "05", "0001000000"), InvalidValue);
655 do_test!(concat!("01", "06", "000100000000"), InvalidValue);
656 do_test!(concat!("01", "07", "00010000000000"), InvalidValue);
657 do_test!(concat!("01", "08", "0001000000000000"), InvalidValue);
658 do_test!(concat!("02", "07", "01010101010101"), ShortRead);
659 do_test!(concat!("02", "09", "010101010101010101"), InvalidValue);
660 do_test!(concat!("03", "21", "023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb"), ShortRead);
661 do_test!(concat!("03", "29", "023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb0000000000000001"), ShortRead);
662 do_test!(concat!("03", "30", "023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb000000000000000100000000000001"), ShortRead);
663 do_test!(concat!("03", "31", "043da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb00000000000000010000000000000002"), InvalidValue);
664 do_test!(concat!("03", "32", "023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb0000000000000001000000000000000001"), InvalidValue);
665 do_test!(concat!("fd00fe", "00"), ShortRead);
666 do_test!(concat!("fd00fe", "01", "01"), ShortRead);
667 do_test!(concat!("fd00fe", "03", "010101"), InvalidValue);
668 do_test!(concat!("00", "00"), UnknownRequiredFeature);
670 do_test!(concat!("02", "08", "0000000000000226", "01", "01", "2a"), InvalidValue);
671 do_test!(concat!("02", "08", "0000000000000231", "02", "08", "0000000000000451"), InvalidValue);
672 do_test!(concat!("1f", "00", "0f", "01", "2a"), InvalidValue);
673 do_test!(concat!("1f", "00", "1f", "01", "2a"), InvalidValue);
675 // The last BOLT test modified to not require creating a new decoder for one trivial test.
676 do_test!(concat!("ffffffffffffffffff", "00", "01", "00"), InvalidValue);
680 fn bolt_tlv_valid_n1_stream() {
681 macro_rules! do_test {
682 ($stream: expr, $tlv1: expr, $tlv2: expr, $tlv3: expr, $tlv4: expr) => {
683 if let Ok((tlv1, tlv2, tlv3, tlv4)) = tlv_reader_n1(&::hex::decode($stream).unwrap()[..]) {
684 assert_eq!(tlv1.map(|v| v.0), $tlv1);
685 assert_eq!(tlv2, $tlv2);
686 assert_eq!(tlv3, $tlv3);
687 assert_eq!(tlv4, $tlv4);
692 do_test!(concat!(""), None, None, None, None);
693 do_test!(concat!("21", "00"), None, None, None, None);
694 do_test!(concat!("fd0201", "00"), None, None, None, None);
695 do_test!(concat!("fd00fd", "00"), None, None, None, None);
696 do_test!(concat!("fd00ff", "00"), None, None, None, None);
697 do_test!(concat!("fe02000001", "00"), None, None, None, None);
698 do_test!(concat!("ff0200000000000001", "00"), None, None, None, None);
700 do_test!(concat!("01", "00"), Some(0), None, None, None);
701 do_test!(concat!("01", "01", "01"), Some(1), None, None, None);
702 do_test!(concat!("01", "02", "0100"), Some(256), None, None, None);
703 do_test!(concat!("01", "03", "010000"), Some(65536), None, None, None);
704 do_test!(concat!("01", "04", "01000000"), Some(16777216), None, None, None);
705 do_test!(concat!("01", "05", "0100000000"), Some(4294967296), None, None, None);
706 do_test!(concat!("01", "06", "010000000000"), Some(1099511627776), None, None, None);
707 do_test!(concat!("01", "07", "01000000000000"), Some(281474976710656), None, None, None);
708 do_test!(concat!("01", "08", "0100000000000000"), Some(72057594037927936), None, None, None);
709 do_test!(concat!("02", "08", "0000000000000226"), None, Some((0 << 30) | (0 << 5) | (550 << 0)), None, None);
710 do_test!(concat!("03", "31", "023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb00000000000000010000000000000002"),
712 PublicKey::from_slice(&::hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]).unwrap(), 1, 2)),
714 do_test!(concat!("fd00fe", "02", "0226"), None, None, None, Some(550));
717 fn do_simple_test_tlv_write() -> Result<(), ::std::io::Error> {
718 let mut stream = VecWriter(Vec::new());
721 encode_varint_length_prefixed_tlv!(&mut stream, { (1, 1u8) }, { (42, None::<u64>) });
722 assert_eq!(stream.0, ::hex::decode("03010101").unwrap());
725 encode_varint_length_prefixed_tlv!(&mut stream, { }, { (1, Some(1u8)) });
726 assert_eq!(stream.0, ::hex::decode("03010101").unwrap());
729 encode_varint_length_prefixed_tlv!(&mut stream, { (4, 0xabcdu16) }, { (42, None::<u64>) });
730 assert_eq!(stream.0, ::hex::decode("040402abcd").unwrap());
733 encode_varint_length_prefixed_tlv!(&mut stream, { (0xff, 0xabcdu16) }, { (42, None::<u64>) });
734 assert_eq!(stream.0, ::hex::decode("06fd00ff02abcd").unwrap());
737 encode_varint_length_prefixed_tlv!(&mut stream, { (0, 1u64), (0xff, HighZeroBytesDroppedVarInt(0u64)) }, { (42, None::<u64>) });
738 assert_eq!(stream.0, ::hex::decode("0e00080000000000000001fd00ff00").unwrap());
741 encode_varint_length_prefixed_tlv!(&mut stream, { (0xff, HighZeroBytesDroppedVarInt(0u64)) }, { (0, Some(1u64)) });
742 assert_eq!(stream.0, ::hex::decode("0e00080000000000000001fd00ff00").unwrap());
748 fn simple_test_tlv_write() {
749 do_simple_test_tlv_write().unwrap();