Use explicit WithoutLength for BOLT 12 features

[rust-lightning] / lightning / src / ln / features.rs

diff --git a/lightning/src/ln/features.rs b/lightning/src/ln/features.rs
index 77d0fa4529fb2ea526682079229b81fa9165ddf6..9d34433161a55e064afcddca798fa6fe7aaacdeb 100644 (file)
--- a/lightning/src/ln/features.rs
+++ b/lightning/src/ln/features.rs
@@ -65,7 +65,7 @@ use core::marker::PhantomData;
 use bitcoin::bech32;
 use bitcoin::bech32::{Base32Len, FromBase32, ToBase32, u5, WriteBase32};
 use crate::ln::msgs::DecodeError;
-use crate::util::ser::{Readable, Writeable, Writer};
+use crate::util::ser::{Readable, WithoutLength, Writeable, Writer};
 
 mod sealed {
        use crate::prelude::*;
@@ -158,6 +158,7 @@ mod sealed {
                BasicMPP,
        ]);
        define_context!(OfferContext, []);
+       define_context!(InvoiceRequestContext, []);
        // This isn't a "real" feature context, and is only used in the channel_type field in an
        // `OpenChannel` message.
        define_context!(ChannelTypeContext, [
@@ -367,7 +368,8 @@ mod sealed {
                supports_keysend, requires_keysend);
 
        #[cfg(test)]
-       define_feature!(123456789, UnknownFeature, [NodeContext, ChannelContext, InvoiceContext, OfferContext],
+       define_feature!(123456789, UnknownFeature,
+               [NodeContext, ChannelContext, InvoiceContext, OfferContext, InvoiceRequestContext],
                "Feature flags for an unknown feature used in testing.", set_unknown_feature_optional,
                set_unknown_feature_required, supports_unknown_test_feature, requires_unknown_test_feature);
 }
@@ -426,8 +428,10 @@ pub type NodeFeatures = Features<sealed::NodeContext>;
 pub type ChannelFeatures = Features<sealed::ChannelContext>;
 /// Features used within an invoice.
 pub type InvoiceFeatures = Features<sealed::InvoiceContext>;
-/// Features used within an offer.
+/// Features used within an `offer`.
 pub type OfferFeatures = Features<sealed::OfferContext>;
+/// Features used within an `invoice_request`.
+pub type InvoiceRequestFeatures = Features<sealed::InvoiceRequestContext>;
 
 /// Features used within the channel_type field in an OpenChannel message.
 ///
@@ -721,25 +725,40 @@ macro_rules! impl_feature_tlv_write {
        ($features: ident) => {
                impl Writeable for $features {
                        fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
-                               self.write_be(w)
+                               WithoutLength(self).write(w)
                        }
                }
                impl Readable for $features {
                        fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
-                               let v = io_extras::read_to_end(r)?;
-                               Ok(Self::from_be_bytes(v))
+                               Ok(WithoutLength::<Self>::read(r)?.0)
                        }
                }
        }
 }
 
 impl_feature_tlv_write!(ChannelTypeFeatures);
-impl_feature_tlv_write!(OfferFeatures);
+
+// Some features may appear both in a TLV record and as part of a TLV subtype sequence. The latter
+// requires a length but the former does not.
+
+impl<T: sealed::Context> Writeable for WithoutLength<&Features<T>> {
+       fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
+               self.0.write_be(w)
+       }
+}
+
+impl<T: sealed::Context> Readable for WithoutLength<Features<T>> {
+       fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
+               let v = io_extras::read_to_end(r)?;
+               Ok(WithoutLength(Features::<T>::from_be_bytes(v)))
+       }
+}
 
 #[cfg(test)]
 mod tests {
-       use super::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, InvoiceFeatures, NodeFeatures, sealed};
+       use super::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, InvoiceFeatures, NodeFeatures, OfferFeatures, sealed};
        use bitcoin::bech32::{Base32Len, FromBase32, ToBase32, u5};
+       use crate::util::ser::{Readable, WithoutLength, Writeable};
 
        #[test]
        fn sanity_test_unknown_bits() {
@@ -833,6 +852,20 @@ mod tests {
                assert!(features.supports_payment_secret());
        }
 
+       #[test]
+       fn encodes_features_without_length() {
+               let features = OfferFeatures::from_le_bytes(vec![1, 2, 3, 4, 5, 42, 100, 101]);
+               assert_eq!(features.flags.len(), 8);
+
+               let mut serialized_features = Vec::new();
+               WithoutLength(&features).write(&mut serialized_features).unwrap();
+               assert_eq!(serialized_features.len(), 8);
+
+               let deserialized_features =
+                       WithoutLength::<OfferFeatures>::read(&mut &serialized_features[..]).unwrap().0;
+               assert_eq!(features, deserialized_features);
+       }
+
        #[test]
        fn invoice_features_encoding() {
                let features_as_u5s = vec![