X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fln%2Ffeatures.rs;h=c97e18100fc769fd906a201f4868f3e662d21852;hb=1d0645f7e603317fad65065fb0573facb45d4fd4;hp=b65b9b1b245e0a8922a4b69a8dbebfe2f76a500e;hpb=ee27e8432ac13cdff5bc2d2db3245691facc2083;p=rust-lightning diff --git a/lightning/src/ln/features.rs b/lightning/src/ln/features.rs index b65b9b1b..c97e1810 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,13 +97,13 @@ mod sealed { // Byte 0 , // Byte 1 - , + StaticRemoteKey, // Byte 2 , ], optional_features: [ // Byte 0 - DataLossProtect | InitialRoutingSync | UpfrontShutdownScript, + DataLossProtect | InitialRoutingSync | UpfrontShutdownScript | GossipQueries, // Byte 1 VariableLengthOnion | PaymentSecret, // Byte 2 @@ -107,13 +115,13 @@ mod sealed { // Byte 0 , // Byte 1 - , + StaticRemoteKey, // Byte 2 , ], optional_features: [ // Byte 0 - DataLossProtect | UpfrontShutdownScript, + DataLossProtect | UpfrontShutdownScript | GossipQueries, // Byte 1 VariableLengthOnion | PaymentSecret, // Byte 2 @@ -234,8 +242,12 @@ 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], @@ -268,6 +280,8 @@ mod sealed { /// 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, @@ -337,7 +351,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, @@ -347,7 +361,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, @@ -460,6 +474,22 @@ 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 { @@ -470,10 +500,24 @@ impl Features { } } +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) } @@ -545,6 +589,11 @@ mod tests { 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()); @@ -555,6 +604,11 @@ mod tests { 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()); @@ -592,27 +646,30 @@ mod tests { #[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); 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); } // 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()); } }