X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fln%2Ffeatures.rs;h=b65b9b1b245e0a8922a4b69a8dbebfe2f76a500e;hb=ee27e8432ac13cdff5bc2d2db3245691facc2083;hp=381297703e882a08cce4577e01d5bd3f7a9a87af;hpb=4bd2c974a2c96a2ce98a4055a72b2b3c687e78bc;p=rust-lightning diff --git a/lightning/src/ln/features.rs b/lightning/src/ln/features.rs index 38129770..b65b9b1b 100644 --- a/lightning/src/ln/features.rs +++ b/lightning/src/ln/features.rs @@ -166,6 +166,13 @@ mod sealed { /// [`BYTE_OFFSET`]: #associatedconstant.BYTE_OFFSET const OPTIONAL_MASK: u8 = 1 << (Self::ODD_BIT - 8 * Self::BYTE_OFFSET); + /// Returns whether the feature is required by the given flags. + #[inline] + fn requires_feature(flags: &Vec) -> bool { + flags.len() > Self::BYTE_OFFSET && + (flags[Self::BYTE_OFFSET] & Self::REQUIRED_MASK) != 0 + } + /// Returns whether the feature is supported by the given flags. #[inline] fn supports_feature(flags: &Vec) -> bool { @@ -173,6 +180,16 @@ mod sealed { (flags[Self::BYTE_OFFSET] & (Self::REQUIRED_MASK | Self::OPTIONAL_MASK)) != 0 } + /// Sets the feature's required (even) bit in the given flags. + #[inline] + fn set_required_bit(flags: &mut Vec) { + if flags.len() <= Self::BYTE_OFFSET { + flags.resize(Self::BYTE_OFFSET + 1, 0u8); + } + + flags[Self::BYTE_OFFSET] |= Self::REQUIRED_MASK; + } + /// Sets the feature's optional (odd) bit in the given flags. #[inline] fn set_optional_bit(flags: &mut Vec) { @@ -191,6 +208,10 @@ mod sealed { flags[Self::BYTE_OFFSET] &= !Self::REQUIRED_MASK; flags[Self::BYTE_OFFSET] &= !Self::OPTIONAL_MASK; } + + let last_non_zero_byte = flags.iter().rposition(|&byte| byte != 0); + let size = if let Some(offset) = last_non_zero_byte { offset + 1 } else { 0 }; + flags.resize(size, 0u8); } } @@ -219,6 +240,30 @@ mod sealed { "Feature flags for `payment_secret`."); define_feature!(17, BasicMPP, [InitContext, NodeContext], "Feature flags for `basic_mpp`."); + + #[cfg(test)] + define_context!(TestingContext { + required_features: [ + // Byte 0 + , + // Byte 1 + , + // Byte 2 + UnknownFeature, + ], + optional_features: [ + // Byte 0 + , + // Byte 1 + , + // Byte 2 + , + ], + }); + + #[cfg(test)] + define_feature!(23, UnknownFeature, [TestingContext], + "Feature flags for an unknown feature used in testing."); } /// Tracks the set of features which a node implements, templated by the context in which it @@ -375,33 +420,36 @@ impl Features { } #[cfg(test)] - pub(crate) fn set_require_unknown_bits(&mut self) { - let newlen = cmp::max(3, self.flags.len()); - self.flags.resize(newlen, 0u8); - self.flags[2] |= 0x40; + pub(crate) fn set_required_unknown_bits(&mut self) { + ::set_required_bit(&mut self.flags); } #[cfg(test)] - pub(crate) fn clear_require_unknown_bits(&mut self) { - let newlen = cmp::max(3, self.flags.len()); - self.flags.resize(newlen, 0u8); - self.flags[2] &= !0x40; - if self.flags.len() == 3 && self.flags[2] == 0 { - self.flags.resize(2, 0u8); - } - if self.flags.len() == 2 && self.flags[1] == 0 { - self.flags.resize(1, 0u8); - } + pub(crate) fn set_optional_unknown_bits(&mut self) { + ::set_optional_bit(&mut self.flags); + } + + #[cfg(test)] + pub(crate) fn clear_unknown_bits(&mut self) { + ::clear_bits(&mut self.flags); } } impl Features { + #[cfg(test)] + pub(crate) fn requires_data_loss_protect(&self) -> bool { + ::requires_feature(&self.flags) + } pub(crate) fn supports_data_loss_protect(&self) -> bool { ::supports_feature(&self.flags) } } impl Features { + #[cfg(test)] + pub(crate) fn requires_upfront_shutdown_script(&self) -> bool { + ::requires_feature(&self.flags) + } pub(crate) fn supports_upfront_shutdown_script(&self) -> bool { ::supports_feature(&self.flags) } @@ -413,6 +461,10 @@ impl Features { } impl Features { + #[cfg(test)] + pub(crate) fn requires_variable_length_onion(&self) -> bool { + ::requires_feature(&self.flags) + } pub(crate) fn supports_variable_length_onion(&self) -> bool { ::supports_feature(&self.flags) } @@ -428,16 +480,24 @@ impl Features { } impl Features { - #[allow(dead_code)] + #[cfg(test)] + pub(crate) fn requires_payment_secret(&self) -> bool { + ::requires_feature(&self.flags) + } // Note that we never need to test this since what really matters is the invoice - iff the // invoice provides a payment_secret, we assume that we can use it (ie that the recipient // supports payment_secret). + #[allow(dead_code)] pub(crate) fn supports_payment_secret(&self) -> bool { ::supports_feature(&self.flags) } } impl Features { + #[cfg(test)] + pub(crate) fn requires_basic_mpp(&self) -> bool { + ::requires_feature(&self.flags) + } // We currently never test for this since we don't actually *generate* multipath routes. #[allow(dead_code)] pub(crate) fn supports_basic_mpp(&self) -> bool { @@ -472,7 +532,7 @@ mod tests { use super::{ChannelFeatures, InitFeatures, NodeFeatures}; #[test] - fn sanity_test_our_features() { + fn sanity_test_known_features() { assert!(!ChannelFeatures::known().requires_unknown_bits()); assert!(!ChannelFeatures::known().supports_unknown_bits()); assert!(!InitFeatures::known().requires_unknown_bits()); @@ -482,18 +542,28 @@ mod tests { assert!(InitFeatures::known().supports_upfront_shutdown_script()); assert!(NodeFeatures::known().supports_upfront_shutdown_script()); + assert!(!InitFeatures::known().requires_upfront_shutdown_script()); + assert!(!NodeFeatures::known().requires_upfront_shutdown_script()); assert!(InitFeatures::known().supports_data_loss_protect()); assert!(NodeFeatures::known().supports_data_loss_protect()); + assert!(!InitFeatures::known().requires_data_loss_protect()); + assert!(!NodeFeatures::known().requires_data_loss_protect()); assert!(InitFeatures::known().supports_variable_length_onion()); assert!(NodeFeatures::known().supports_variable_length_onion()); + assert!(!InitFeatures::known().requires_variable_length_onion()); + assert!(!NodeFeatures::known().requires_variable_length_onion()); assert!(InitFeatures::known().supports_payment_secret()); assert!(NodeFeatures::known().supports_payment_secret()); + assert!(!InitFeatures::known().requires_payment_secret()); + assert!(!NodeFeatures::known().requires_payment_secret()); assert!(InitFeatures::known().supports_basic_mpp()); assert!(NodeFeatures::known().supports_basic_mpp()); + assert!(!InitFeatures::known().requires_basic_mpp()); + assert!(!NodeFeatures::known().requires_basic_mpp()); let mut init_features = InitFeatures::known(); assert!(init_features.initial_routing_sync()); @@ -502,12 +572,22 @@ mod tests { } #[test] - fn sanity_test_unkown_bits_testing() { - let mut features = ChannelFeatures::known(); - features.set_require_unknown_bits(); + fn sanity_test_unknown_bits() { + let mut features = ChannelFeatures::empty(); + assert!(!features.requires_unknown_bits()); + assert!(!features.supports_unknown_bits()); + + features.set_required_unknown_bits(); assert!(features.requires_unknown_bits()); - features.clear_require_unknown_bits(); + assert!(features.supports_unknown_bits()); + + features.clear_unknown_bits(); + assert!(!features.requires_unknown_bits()); + assert!(!features.supports_unknown_bits()); + + features.set_optional_unknown_bits(); assert!(!features.requires_unknown_bits()); + assert!(features.supports_unknown_bits()); } #[test]