From: Matt Corallo Date: Fri, 23 Jul 2021 15:49:24 +0000 (+0000) Subject: Define public getters for all feature flags X-Git-Tag: v0.0.104~12^2~1 X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=aa5e5f967375eb31d8b0d0ed7f20ef31242693f7;p=rust-lightning Define public getters for all feature flags There's not a ton of reason not to do this, and moving it to the macro removes some code. --- diff --git a/lightning/src/ln/features.rs b/lightning/src/ln/features.rs index 32ba9de75..07e1a3229 100644 --- a/lightning/src/ln/features.rs +++ b/lightning/src/ln/features.rs @@ -223,7 +223,7 @@ mod sealed { /// useful for manipulating feature flags. macro_rules! define_feature { ($odd_bit: expr, $feature: ident, [$($context: ty),+], $doc: expr, $optional_setter: ident, - $required_setter: ident) => { + $required_setter: ident, $supported_getter: ident) => { #[doc = $doc] /// /// See [BOLT #9] for details. @@ -320,6 +320,11 @@ mod sealed { ::set_required_bit(&mut self.flags); self } + + /// Checks if this feature is supported. + pub fn $supported_getter(&self) -> bool { + ::supports_feature(&self.flags) + } } $( @@ -331,41 +336,57 @@ mod sealed { const ASSERT_ODD_BIT_PARITY: usize = (::ODD_BIT % 2) - 1; } )* - + }; + ($odd_bit: expr, $feature: ident, [$($context: ty),+], $doc: expr, $optional_setter: ident, + $required_setter: ident, $supported_getter: ident, $required_getter: ident) => { + define_feature!($odd_bit, $feature, [$($context),+], $doc, $optional_setter, $required_setter, $supported_getter); + impl Features { + /// Checks if this feature is required. + pub fn $required_getter(&self) -> bool { + ::requires_feature(&self.flags) + } + } } } define_feature!(1, DataLossProtect, [InitContext, NodeContext], "Feature flags for `option_data_loss_protect`.", set_data_loss_protect_optional, - set_data_loss_protect_required); + set_data_loss_protect_required, supports_data_loss_protect, requires_data_loss_protect); // NOTE: Per Bolt #9, initial_routing_sync has no even bit. define_feature!(3, InitialRoutingSync, [InitContext], "Feature flags for `initial_routing_sync`.", - set_initial_routing_sync_optional, set_initial_routing_sync_required); + set_initial_routing_sync_optional, set_initial_routing_sync_required, + initial_routing_sync); define_feature!(5, UpfrontShutdownScript, [InitContext, NodeContext], "Feature flags for `option_upfront_shutdown_script`.", set_upfront_shutdown_script_optional, - set_upfront_shutdown_script_required); + set_upfront_shutdown_script_required, supports_upfront_shutdown_script, + requires_upfront_shutdown_script); define_feature!(7, GossipQueries, [InitContext, NodeContext], - "Feature flags for `gossip_queries`.", set_gossip_queries_optional, set_gossip_queries_required); + "Feature flags for `gossip_queries`.", set_gossip_queries_optional, set_gossip_queries_required, + supports_gossip_queries, requires_gossip_queries); define_feature!(9, VariableLengthOnion, [InitContext, NodeContext, InvoiceContext], "Feature flags for `var_onion_optin`.", set_variable_length_onion_optional, - set_variable_length_onion_required); + set_variable_length_onion_required, supports_variable_length_onion, + requires_variable_length_onion); define_feature!(13, StaticRemoteKey, [InitContext, NodeContext, ChannelTypeContext], "Feature flags for `option_static_remotekey`.", set_static_remote_key_optional, - set_static_remote_key_required); + set_static_remote_key_required, supports_static_remote_key, requires_static_remote_key); define_feature!(15, PaymentSecret, [InitContext, NodeContext, InvoiceContext], - "Feature flags for `payment_secret`.", set_payment_secret_optional, set_payment_secret_required); + "Feature flags for `payment_secret`.", set_payment_secret_optional, set_payment_secret_required, + supports_payment_secret, requires_payment_secret); define_feature!(17, BasicMPP, [InitContext, NodeContext, InvoiceContext], - "Feature flags for `basic_mpp`.", set_basic_mpp_optional, set_basic_mpp_required); + "Feature flags for `basic_mpp`.", set_basic_mpp_optional, set_basic_mpp_required, + supports_basic_mpp, requires_basic_mpp); define_feature!(27, ShutdownAnySegwit, [InitContext, NodeContext], "Feature flags for `opt_shutdown_anysegwit`.", set_shutdown_any_segwit_optional, - set_shutdown_any_segwit_required); + set_shutdown_any_segwit_required, supports_shutdown_anysegwit, requires_shutdown_anysegwit); define_feature!(55, Keysend, [NodeContext], - "Feature flags for keysend payments.", set_keysend_optional, set_keysend_required); + "Feature flags for keysend payments.", set_keysend_optional, set_keysend_required, + supports_keysend, requires_keysend); #[cfg(test)] define_feature!(123456789, UnknownFeature, [NodeContext, ChannelContext, InvoiceContext], "Feature flags for an unknown feature used in testing.", set_unknown_feature_optional, - set_unknown_feature_required); + set_unknown_feature_required, supports_unknown_test_feature, requires_unknown_test_feature); } /// Tracks the set of features which a node implements, templated by the context in which it @@ -662,25 +683,7 @@ impl Features { } } -impl Features { - #[cfg(test)] - pub(crate) fn requires_data_loss_protect(&self) -> bool { - ::requires_feature(&self.flags) - } - #[cfg(test)] - 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) - } #[cfg(test)] pub(crate) fn clear_upfront_shutdown_script(mut self) -> Self { ::clear_bits(&mut self.flags); @@ -690,13 +693,6 @@ 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); @@ -704,30 +700,7 @@ 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) - } -} - -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. @@ -737,32 +710,7 @@ impl Features { } } -impl Features { - #[cfg(test)] - pub(crate) fn requires_payment_secret(&self) -> bool { - ::requires_feature(&self.flags) - } - /// Returns whether the `payment_secret` feature is supported. - pub 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. - pub(crate) fn supports_basic_mpp(&self) -> bool { - ::supports_feature(&self.flags) - } -} - 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);