X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fln%2Ffeatures.rs;h=35c9410bc0b2b70ce4f7b5bd342b74134e950040;hb=93a75726a128c5f03e822eb70e65192074eb07b8;hp=381297703e882a08cce4577e01d5bd3f7a9a87af;hpb=4bd2c974a2c96a2ce98a4055a72b2b3c687e78bc;p=rust-lightning diff --git a/lightning/src/ln/features.rs b/lightning/src/ln/features.rs index 38129770..35c9410b 100644 --- a/lightning/src/ln/features.rs +++ b/lightning/src/ln/features.rs @@ -1,3 +1,12 @@ +// This file is Copyright its original authors, visible in version control +// history. +// +// This file is licensed under the Apache License, Version 2.0 or the MIT license +// , at your option. +// You may not use this file except in accordance with one or both of these +// licenses. + //! Feature flag definitions for the Lightning protocol according to [BOLT #9]. //! //! Lightning nodes advertise a supported set of operation through feature flags. Features are @@ -17,7 +26,6 @@ //! [`Context`]: sealed/trait.Context.html use std::{cmp, fmt}; -use std::result::Result; use std::marker::PhantomData; use ln::msgs::DecodeError; @@ -89,17 +97,21 @@ mod sealed { // Byte 0 , // Byte 1 - , + StaticRemoteKey, // Byte 2 , + // Byte 3 + , ], optional_features: [ // Byte 0 - DataLossProtect | InitialRoutingSync | UpfrontShutdownScript, + DataLossProtect | InitialRoutingSync | UpfrontShutdownScript | GossipQueries, // Byte 1 VariableLengthOnion | PaymentSecret, // Byte 2 BasicMPP, + // Byte 3 + ShutdownAnySegwit, ], }); define_context!(NodeContext { @@ -107,17 +119,21 @@ mod sealed { // Byte 0 , // Byte 1 - , + StaticRemoteKey, // Byte 2 , + // Byte 3 + , ], optional_features: [ // Byte 0 - DataLossProtect | UpfrontShutdownScript, + DataLossProtect | UpfrontShutdownScript | GossipQueries, // Byte 1 VariableLengthOnion | PaymentSecret, // Byte 2 BasicMPP, + // Byte 3 + ShutdownAnySegwit, ], }); define_context!(ChannelContext { @@ -166,6 +182,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 +196,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 +224,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); } } @@ -213,16 +250,48 @@ mod sealed { "Feature flags for `initial_routing_sync`."); define_feature!(5, UpfrontShutdownScript, [InitContext, NodeContext], "Feature flags for `option_upfront_shutdown_script`."); + define_feature!(7, GossipQueries, [InitContext, NodeContext], + "Feature flags for `gossip_queries`."); define_feature!(9, VariableLengthOnion, [InitContext, NodeContext], "Feature flags for `var_onion_optin`."); + define_feature!(13, StaticRemoteKey, [InitContext, NodeContext], + "Feature flags for `option_static_remotekey`."); define_feature!(15, PaymentSecret, [InitContext, NodeContext], "Feature flags for `payment_secret`."); define_feature!(17, BasicMPP, [InitContext, NodeContext], "Feature flags for `basic_mpp`."); + define_feature!(27, ShutdownAnySegwit, [InitContext, NodeContext], + "Feature flags for `opt_shutdown_anysegwit`."); + + #[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 /// appears. +/// +/// (C-not exported) as we map the concrete feature types below directly instead pub struct Features { /// Note that, for convenience, flags is LITTLE endian (despite being big-endian on the wire) flags: Vec, @@ -292,7 +361,7 @@ impl InitFeatures { impl Features { /// Create a blank Features with no features set - pub fn empty() -> Features { + pub fn empty() -> Self { Features { flags: Vec::new(), mark: PhantomData, @@ -302,7 +371,7 @@ impl Features { /// Creates features known by the implementation as defined by [`T::KNOWN_FEATURE_FLAGS`]. /// /// [`T::KNOWN_FEATURE_FLAGS`]: sealed/trait.Context.html#associatedconstant.KNOWN_FEATURE_FLAGS - pub fn known() -> Features { + pub fn known() -> Self { Self { flags: T::KNOWN_FEATURE_FLAGS.to_vec(), mark: PhantomData, @@ -375,33 +444,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) } @@ -412,32 +484,74 @@ impl Features { } } + +impl Features { + #[cfg(test)] + pub(crate) fn requires_gossip_queries(&self) -> bool { + ::requires_feature(&self.flags) + } + pub(crate) fn supports_gossip_queries(&self) -> bool { + ::supports_feature(&self.flags) + } + #[cfg(test)] + pub(crate) fn clear_gossip_queries(mut self) -> Self { + ::clear_bits(&mut self.flags); + self + } +} + 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) } } +impl Features { + pub(crate) fn supports_static_remote_key(&self) -> bool { + ::supports_feature(&self.flags) + } + #[cfg(test)] + pub(crate) fn requires_static_remote_key(&self) -> bool { + ::requires_feature(&self.flags) + } +} + impl Features { pub(crate) fn initial_routing_sync(&self) -> bool { ::supports_feature(&self.flags) } + // We are no longer setting initial_routing_sync now that gossip_queries + // is enabled. This feature is ignored by a peer when gossip_queries has + // been negotiated. + #[cfg(test)] pub(crate) fn clear_initial_routing_sync(&mut self) { ::clear_bits(&mut self.flags) } } 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 { @@ -445,6 +559,17 @@ impl Features { } } +impl Features { + pub(crate) fn supports_shutdown_anysegwit(&self) -> bool { + ::supports_feature(&self.flags) + } + #[cfg(test)] + pub(crate) fn clear_shutdown_anysegwit(mut self) -> Self { + ::clear_bits(&mut self.flags); + self + } +} + impl Writeable for Features { fn write(&self, w: &mut W) -> Result<(), ::std::io::Error> { w.size_hint(self.flags.len() + 2); @@ -472,7 +597,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 +607,41 @@ 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_gossip_queries()); + assert!(NodeFeatures::known().supports_gossip_queries()); + assert!(!InitFeatures::known().requires_gossip_queries()); + assert!(!NodeFeatures::known().requires_gossip_queries()); 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_static_remote_key()); + assert!(NodeFeatures::known().supports_static_remote_key()); + assert!(InitFeatures::known().requires_static_remote_key()); + assert!(NodeFeatures::known().requires_static_remote_key()); 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()); + + assert!(InitFeatures::known().supports_shutdown_anysegwit()); + assert!(NodeFeatures::known().supports_shutdown_anysegwit()); let mut init_features = InitFeatures::known(); assert!(init_features.initial_routing_sync()); @@ -502,37 +650,52 @@ 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] fn convert_to_context_with_relevant_flags() { - let init_features = InitFeatures::known().clear_upfront_shutdown_script(); + let init_features = InitFeatures::known().clear_upfront_shutdown_script().clear_gossip_queries(); assert!(init_features.initial_routing_sync()); assert!(!init_features.supports_upfront_shutdown_script()); + assert!(!init_features.supports_gossip_queries()); let node_features: NodeFeatures = init_features.to_context(); { // Check that the flags are as expected: // - option_data_loss_protect - // - var_onion_optin | payment_secret + // - var_onion_optin | static_remote_key (req) | payment_secret // - basic_mpp - assert_eq!(node_features.flags.len(), 3); + // - opt_shutdown_anysegwit + assert_eq!(node_features.flags.len(), 4); assert_eq!(node_features.flags[0], 0b00000010); - assert_eq!(node_features.flags[1], 0b10000010); + assert_eq!(node_features.flags[1], 0b10010010); assert_eq!(node_features.flags[2], 0b00000010); + assert_eq!(node_features.flags[3], 0b00001000); } // Check that cleared flags are kept blank when converting back: // - initial_routing_sync was not applicable to NodeContext // - upfront_shutdown_script was cleared before converting + // - gossip_queries was cleared before converting let features: InitFeatures = node_features.to_context_internal(); assert!(!features.initial_routing_sync()); assert!(!features.supports_upfront_shutdown_script()); + assert!(!init_features.supports_gossip_queries()); } }