_ Git - rust-lightning/blob - lightning/src/ln/features.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 //! Feature flag definitions for the Lightning protocol according to [BOLT #9].
  11 //!
  12 //! Lightning nodes advertise a supported set of operation through feature flags. Features are
  13 //! applicable for a specific context as indicated in some [messages]. [`Features`] encapsulates
  14 //! behavior for specifying and checking feature flags for a particular context. Each feature is
  15 //! defined internally by a trait specifying the corresponding flags (i.e., even and odd bits).
  16 //!
  17 //! Whether a feature is considered "known" or "unknown" is relative to the implementation, whereas
  18 //! the term "supports" is used in reference to a particular set of [`Features`]. That is, a node
  19 //! supports a feature if it advertises the feature (as either required or optional) to its peers.
  20 //! And the implementation can interpret a feature if the feature is known to it.
  21 //!
  22 //! The following features are currently required in the LDK:
  23 //! - `VariableLengthOnion` - requires/supports variable-length routing onion payloads
  24 //!     (see [BOLT-4](https://github.com/lightning/bolts/blob/master/04-onion-routing.md) for more information).
  25 //! - `StaticRemoteKey` - requires/supports static key for remote output
  26 //!     (see [BOLT-3](https://github.com/lightning/bolts/blob/master/03-transactions.md) for more information).
  27 //!
  28 //! The following features are currently supported in the LDK:
  29 //! - `DataLossProtect` - requires/supports that a node which has somehow fallen behind, e.g., has been restored from an old backup,
  30 //!     can detect that it has fallen behind
  31 //!     (see [BOLT-2](https://github.com/lightning/bolts/blob/master/02-peer-protocol.md) for more information).
  32 //! - `InitialRoutingSync` - requires/supports that the sending node needs a complete routing information dump
  33 //!     (see [BOLT-7](https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#initial-sync) for more information).
  34 //! - `UpfrontShutdownScript` - commits to a shutdown scriptpubkey when opening a channel
  35 //!     (see [BOLT-2](https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-open_channel-message) for more information).
  36 //! - `GossipQueries` - requires/supports more sophisticated gossip control
  37 //!     (see [BOLT-7](https://github.com/lightning/bolts/blob/master/07-routing-gossip.md) for more information).
  38 //! - `PaymentSecret` - requires/supports that a node supports payment_secret field
  39 //!     (see [BOLT-4](https://github.com/lightning/bolts/blob/master/04-onion-routing.md) for more information).
  40 //! - `BasicMPP` - requires/supports that a node can receive basic multi-part payments
  41 //!     (see [BOLT-4](https://github.com/lightning/bolts/blob/master/04-onion-routing.md#basic-multi-part-payments) for more information).
  42 //! - `Wumbo` - requires/supports that a node create large channels. Called `option_support_large_channel` in the spec.
  43 //!     (see [BOLT-2](https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-open_channel-message) for more information).
  44 //! - `ShutdownAnySegwit` - requires/supports that future segwit versions are allowed in `shutdown`
  45 //!     (see [BOLT-2](https://github.com/lightning/bolts/blob/master/02-peer-protocol.md) for more information).
  46 //! - `OnionMessages` - requires/supports forwarding onion messages
  47 //!     (see [BOLT-7](https://github.com/lightning/bolts/pull/759/files) for more information).
  48 //!     TODO: update link
  49 //! - `ChannelType` - node supports the channel_type field in open/accept
  50 //!     (see [BOLT-2](https://github.com/lightning/bolts/blob/master/02-peer-protocol.md) for more information).
  51 //! - `SCIDPrivacy` - supply channel aliases for routing
  52 //!     (see [BOLT-2](https://github.com/lightning/bolts/blob/master/02-peer-protocol.md) for more information).
  53 //! - `Keysend` - send funds to a node without an invoice
  54 //!     (see the [`Keysend` feature assignment proposal](https://github.com/lightning/bolts/issues/605#issuecomment-606679798) for more information).
  55 //!
  56 //! [BOLT #9]: https://github.com/lightning/bolts/blob/master/09-features.md
  57 //! [messages]: crate::ln::msgs
  58
  59 use crate::{io, io_extras};
  60 use crate::prelude::*;
  61 use core::{cmp, fmt};
  62 use core::hash::{Hash, Hasher};
  63 use core::marker::PhantomData;
  64
  65 use bitcoin::bech32;
  66 use bitcoin::bech32::{Base32Len, FromBase32, ToBase32, u5, WriteBase32};
  67 use crate::ln::msgs::DecodeError;
  68 use crate::util::ser::{Readable, Writeable, Writer};
  69
  70 mod sealed {
  71         use crate::prelude::*;
  72         use crate::ln::features::Features;
  73
  74         /// The context in which [`Features`] are applicable. Defines which features are known to the
  75         /// implementation, though specification of them as required or optional is up to the code
  76         /// constructing a features object.
  77         pub trait Context {
  78                 /// Bitmask for selecting features that are known to the implementation.
  79                 const KNOWN_FEATURE_MASK: &'static [u8];
  80         }
  81
  82         /// Defines a [`Context`] by stating which features it requires and which are optional. Features
  83         /// are specified as a comma-separated list of bytes where each byte is a pipe-delimited list of
  84         /// feature identifiers.
  85         macro_rules! define_context {
  86                 ($context: ident, [$( $( $known_feature: ident )|*, )*]) => {
  87                         #[derive(Eq, PartialEq)]
  88                         pub struct $context {}
  89
  90                         impl Context for $context {
  91                                 const KNOWN_FEATURE_MASK: &'static [u8] = &[
  92                                         $(
  93                                                 0b00_00_00_00 $(|
  94                                                         <Self as $known_feature>::REQUIRED_MASK |
  95                                                         <Self as $known_feature>::OPTIONAL_MASK)*,
  96                                         )*
  97                                 ];
  98                         }
  99
 100                         impl alloc::fmt::Display for Features<$context> {
 101                                 fn fmt(&self, fmt: &mut alloc::fmt::Formatter) -> Result<(), alloc::fmt::Error> {
 102                                         $(
 103                                                 $(
 104                                                         fmt.write_fmt(format_args!("{}: {}, ", stringify!($known_feature),
 105                                                                 if <$context as $known_feature>::requires_feature(&self.flags) { "required" }
 106                                                                 else if <$context as $known_feature>::supports_feature(&self.flags) { "supported" }
 107                                                                 else { "not supported" }))?;
 108                                                 )*
 109                                                 {} // Rust gets mad if we only have a $()* block here, so add a dummy {}
 110                                         )*
 111                                         fmt.write_fmt(format_args!("unknown flags: {}",
 112                                                 if self.requires_unknown_bits() { "required" }
 113                                                 else if self.supports_unknown_bits() { "supported" } else { "none" }))
 114                                 }
 115                         }
 116                 };
 117         }
 118
 119         define_context!(InitContext, [
 120                 // Byte 0
 121                 DataLossProtect | InitialRoutingSync | UpfrontShutdownScript | GossipQueries,
 122                 // Byte 1
 123                 VariableLengthOnion | StaticRemoteKey | PaymentSecret,
 124                 // Byte 2
 125                 BasicMPP | Wumbo,
 126                 // Byte 3
 127                 ShutdownAnySegwit,
 128                 // Byte 4
 129                 OnionMessages,
 130                 // Byte 5
 131                 ChannelType | SCIDPrivacy,
 132                 // Byte 6
 133                 ZeroConf,
 134         ]);
 135         define_context!(NodeContext, [
 136                 // Byte 0
 137                 DataLossProtect | UpfrontShutdownScript | GossipQueries,
 138                 // Byte 1
 139                 VariableLengthOnion | StaticRemoteKey | PaymentSecret,
 140                 // Byte 2
 141                 BasicMPP | Wumbo,
 142                 // Byte 3
 143                 ShutdownAnySegwit,
 144                 // Byte 4
 145                 OnionMessages,
 146                 // Byte 5
 147                 ChannelType | SCIDPrivacy,
 148                 // Byte 6
 149                 ZeroConf | Keysend,
 150         ]);
 151         define_context!(ChannelContext, []);
 152         define_context!(InvoiceContext, [
 153                 // Byte 0
 154                 ,
 155                 // Byte 1
 156                 VariableLengthOnion | PaymentSecret,
 157                 // Byte 2
 158                 BasicMPP,
 159         ]);
 160         // This isn't a "real" feature context, and is only used in the channel_type field in an
 161         // `OpenChannel` message.
 162         define_context!(ChannelTypeContext, [
 163                 // Byte 0
 164                 ,
 165                 // Byte 1
 166                 StaticRemoteKey,
 167                 // Byte 2
 168                 ,
 169                 // Byte 3
 170                 ,
 171                 // Byte 4
 172                 ,
 173                 // Byte 5
 174                 SCIDPrivacy,
 175                 // Byte 6
 176                 ZeroConf,
 177         ]);
 178
 179         /// Defines a feature with the given bits for the specified [`Context`]s. The generated trait is
 180         /// useful for manipulating feature flags.
 181         macro_rules! define_feature {
 182                 ($odd_bit: expr, $feature: ident, [$($context: ty),+], $doc: expr, $optional_setter: ident,
 183                  $required_setter: ident, $supported_getter: ident) => {
 184                         #[doc = $doc]
 185                         ///
 186                         /// See [BOLT #9] for details.
 187                         ///
 188                         /// [BOLT #9]: https://github.com/lightning/bolts/blob/master/09-features.md
 189                         pub trait $feature: Context {
 190                                 /// The bit used to signify that the feature is required.
 191                                 const EVEN_BIT: usize = $odd_bit - 1;
 192
 193                                 /// The bit used to signify that the feature is optional.
 194                                 const ODD_BIT: usize = $odd_bit;
 195
 196                                 /// Assertion that [`EVEN_BIT`] is actually even.
 197                                 ///
 198                                 /// [`EVEN_BIT`]: #associatedconstant.EVEN_BIT
 199                                 const ASSERT_EVEN_BIT_PARITY: usize;
 200
 201                                 /// Assertion that [`ODD_BIT`] is actually odd.
 202                                 ///
 203                                 /// [`ODD_BIT`]: #associatedconstant.ODD_BIT
 204                                 const ASSERT_ODD_BIT_PARITY: usize;
 205
 206                                 /// Assertion that the bits are set in the context's [`KNOWN_FEATURE_MASK`].
 207                                 ///
 208                                 /// [`KNOWN_FEATURE_MASK`]: Context::KNOWN_FEATURE_MASK
 209                                 #[cfg(not(test))] // We violate this constraint with `UnknownFeature`
 210                                 const ASSERT_BITS_IN_MASK: u8;
 211
 212                                 /// The byte where the feature is set.
 213                                 const BYTE_OFFSET: usize = Self::EVEN_BIT / 8;
 214
 215                                 /// The bitmask for the feature's required flag relative to the [`BYTE_OFFSET`].
 216                                 ///
 217                                 /// [`BYTE_OFFSET`]: #associatedconstant.BYTE_OFFSET
 218                                 const REQUIRED_MASK: u8 = 1 << (Self::EVEN_BIT - 8 * Self::BYTE_OFFSET);
 219
 220                                 /// The bitmask for the feature's optional flag relative to the [`BYTE_OFFSET`].
 221                                 ///
 222                                 /// [`BYTE_OFFSET`]: #associatedconstant.BYTE_OFFSET
 223                                 const OPTIONAL_MASK: u8 = 1 << (Self::ODD_BIT - 8 * Self::BYTE_OFFSET);
 224
 225                                 /// Returns whether the feature is required by the given flags.
 226                                 #[inline]
 227                                 fn requires_feature(flags: &Vec<u8>) -> bool {
 228                                         flags.len() > Self::BYTE_OFFSET &&
 229                                                 (flags[Self::BYTE_OFFSET] & Self::REQUIRED_MASK) != 0
 230                                 }
 231
 232                                 /// Returns whether the feature is supported by the given flags.
 233                                 #[inline]
 234                                 fn supports_feature(flags: &Vec<u8>) -> bool {
 235                                         flags.len() > Self::BYTE_OFFSET &&
 236                                                 (flags[Self::BYTE_OFFSET] & (Self::REQUIRED_MASK | Self::OPTIONAL_MASK)) != 0
 237                                 }
 238
 239                                 /// Sets the feature's required (even) bit in the given flags.
 240                                 #[inline]
 241                                 fn set_required_bit(flags: &mut Vec<u8>) {
 242                                         if flags.len() <= Self::BYTE_OFFSET {
 243                                                 flags.resize(Self::BYTE_OFFSET + 1, 0u8);
 244                                         }
 245
 246                                         flags[Self::BYTE_OFFSET] |= Self::REQUIRED_MASK;
 247                                 }
 248
 249                                 /// Sets the feature's optional (odd) bit in the given flags.
 250                                 #[inline]
 251                                 fn set_optional_bit(flags: &mut Vec<u8>) {
 252                                         if flags.len() <= Self::BYTE_OFFSET {
 253                                                 flags.resize(Self::BYTE_OFFSET + 1, 0u8);
 254                                         }
 255
 256                                         flags[Self::BYTE_OFFSET] |= Self::OPTIONAL_MASK;
 257                                 }
 258
 259                                 /// Clears the feature's required (even) and optional (odd) bits from the given
 260                                 /// flags.
 261                                 #[inline]
 262                                 fn clear_bits(flags: &mut Vec<u8>) {
 263                                         if flags.len() > Self::BYTE_OFFSET {
 264                                                 flags[Self::BYTE_OFFSET] &= !Self::REQUIRED_MASK;
 265                                                 flags[Self::BYTE_OFFSET] &= !Self::OPTIONAL_MASK;
 266                                         }
 267
 268                                         let last_non_zero_byte = flags.iter().rposition(|&byte| byte != 0);
 269                                         let size = if let Some(offset) = last_non_zero_byte { offset + 1 } else { 0 };
 270                                         flags.resize(size, 0u8);
 271                                 }
 272                         }
 273
 274                         impl <T: $feature> Features<T> {
 275                                 /// Set this feature as optional.
 276                                 pub fn $optional_setter(&mut self) {
 277                                         <T as $feature>::set_optional_bit(&mut self.flags);
 278                                 }
 279
 280                                 /// Set this feature as required.
 281                                 pub fn $required_setter(&mut self) {
 282                                         <T as $feature>::set_required_bit(&mut self.flags);
 283                                 }
 284
 285                                 /// Checks if this feature is supported.
 286                                 pub fn $supported_getter(&self) -> bool {
 287                                         <T as $feature>::supports_feature(&self.flags)
 288                                 }
 289                         }
 290
 291                         $(
 292                                 impl $feature for $context {
 293                                         // EVEN_BIT % 2 == 0
 294                                         const ASSERT_EVEN_BIT_PARITY: usize = 0 - (<Self as $feature>::EVEN_BIT % 2);
 295
 296                                         // ODD_BIT % 2 == 1
 297                                         const ASSERT_ODD_BIT_PARITY: usize = (<Self as $feature>::ODD_BIT % 2) - 1;
 298
 299                                         // (byte & (REQUIRED_MASK | OPTIONAL_MASK)) >> (EVEN_BIT % 8) == 3
 300                                         #[cfg(not(test))] // We violate this constraint with `UnknownFeature`
 301                                         const ASSERT_BITS_IN_MASK: u8 =
 302                                                 ((<$context>::KNOWN_FEATURE_MASK[<Self as $feature>::BYTE_OFFSET] & (<Self as $feature>::REQUIRED_MASK | <Self as $feature>::OPTIONAL_MASK))
 303                                                  >> (<Self as $feature>::EVEN_BIT % 8)) - 3;
 304                                 }
 305                         )*
 306                 };
 307                 ($odd_bit: expr, $feature: ident, [$($context: ty),+], $doc: expr, $optional_setter: ident,
 308                  $required_setter: ident, $supported_getter: ident, $required_getter: ident) => {
 309                         define_feature!($odd_bit, $feature, [$($context),+], $doc, $optional_setter, $required_setter, $supported_getter);
 310                         impl <T: $feature> Features<T> {
 311                                 /// Checks if this feature is required.
 312                                 pub fn $required_getter(&self) -> bool {
 313                                         <T as $feature>::requires_feature(&self.flags)
 314                                 }
 315                         }
 316                 }
 317         }
 318
 319         define_feature!(1, DataLossProtect, [InitContext, NodeContext],
 320                 "Feature flags for `option_data_loss_protect`.", set_data_loss_protect_optional,
 321                 set_data_loss_protect_required, supports_data_loss_protect, requires_data_loss_protect);
 322         // NOTE: Per Bolt #9, initial_routing_sync has no even bit.
 323         define_feature!(3, InitialRoutingSync, [InitContext], "Feature flags for `initial_routing_sync`.",
 324                 set_initial_routing_sync_optional, set_initial_routing_sync_required,
 325                 initial_routing_sync);
 326         define_feature!(5, UpfrontShutdownScript, [InitContext, NodeContext],
 327                 "Feature flags for `option_upfront_shutdown_script`.", set_upfront_shutdown_script_optional,
 328                 set_upfront_shutdown_script_required, supports_upfront_shutdown_script,
 329                 requires_upfront_shutdown_script);
 330         define_feature!(7, GossipQueries, [InitContext, NodeContext],
 331                 "Feature flags for `gossip_queries`.", set_gossip_queries_optional, set_gossip_queries_required,
 332                 supports_gossip_queries, requires_gossip_queries);
 333         define_feature!(9, VariableLengthOnion, [InitContext, NodeContext, InvoiceContext],
 334                 "Feature flags for `var_onion_optin`.", set_variable_length_onion_optional,
 335                 set_variable_length_onion_required, supports_variable_length_onion,
 336                 requires_variable_length_onion);
 337         define_feature!(13, StaticRemoteKey, [InitContext, NodeContext, ChannelTypeContext],
 338                 "Feature flags for `option_static_remotekey`.", set_static_remote_key_optional,
 339                 set_static_remote_key_required, supports_static_remote_key, requires_static_remote_key);
 340         define_feature!(15, PaymentSecret, [InitContext, NodeContext, InvoiceContext],
 341                 "Feature flags for `payment_secret`.", set_payment_secret_optional, set_payment_secret_required,
 342                 supports_payment_secret, requires_payment_secret);
 343         define_feature!(17, BasicMPP, [InitContext, NodeContext, InvoiceContext],
 344                 "Feature flags for `basic_mpp`.", set_basic_mpp_optional, set_basic_mpp_required,
 345                 supports_basic_mpp, requires_basic_mpp);
 346         define_feature!(19, Wumbo, [InitContext, NodeContext],
 347                 "Feature flags for `option_support_large_channel` (aka wumbo channels).", set_wumbo_optional, set_wumbo_required,
 348                 supports_wumbo, requires_wumbo);
 349         define_feature!(27, ShutdownAnySegwit, [InitContext, NodeContext],
 350                 "Feature flags for `opt_shutdown_anysegwit`.", set_shutdown_any_segwit_optional,
 351                 set_shutdown_any_segwit_required, supports_shutdown_anysegwit, requires_shutdown_anysegwit);
 352         define_feature!(39, OnionMessages, [InitContext, NodeContext],
 353                 "Feature flags for `option_onion_messages`.", set_onion_messages_optional,
 354                 set_onion_messages_required, supports_onion_messages, requires_onion_messages);
 355         define_feature!(45, ChannelType, [InitContext, NodeContext],
 356                 "Feature flags for `option_channel_type`.", set_channel_type_optional,
 357                 set_channel_type_required, supports_channel_type, requires_channel_type);
 358         define_feature!(47, SCIDPrivacy, [InitContext, NodeContext, ChannelTypeContext],
 359                 "Feature flags for only forwarding with SCID aliasing. Called `option_scid_alias` in the BOLTs",
 360                 set_scid_privacy_optional, set_scid_privacy_required, supports_scid_privacy, requires_scid_privacy);
 361         define_feature!(51, ZeroConf, [InitContext, NodeContext, ChannelTypeContext],
 362                 "Feature flags for accepting channels with zero confirmations. Called `option_zeroconf` in the BOLTs",
 363                 set_zero_conf_optional, set_zero_conf_required, supports_zero_conf, requires_zero_conf);
 364         define_feature!(55, Keysend, [NodeContext],
 365                 "Feature flags for keysend payments.", set_keysend_optional, set_keysend_required,
 366                 supports_keysend, requires_keysend);
 367
 368         #[cfg(test)]
 369         define_feature!(123456789, UnknownFeature, [NodeContext, ChannelContext, InvoiceContext],
 370                 "Feature flags for an unknown feature used in testing.", set_unknown_feature_optional,
 371                 set_unknown_feature_required, supports_unknown_test_feature, requires_unknown_test_feature);
 372 }
 373
 374 /// Tracks the set of features which a node implements, templated by the context in which it
 375 /// appears.
 376 ///
 377 /// (C-not exported) as we map the concrete feature types below directly instead
 378 #[derive(Eq)]
 379 pub struct Features<T: sealed::Context> {
 380         /// Note that, for convenience, flags is LITTLE endian (despite being big-endian on the wire)
 381         flags: Vec<u8>,
 382         mark: PhantomData<T>,
 383 }
 384
 385 impl <T: sealed::Context> Features<T> {
 386         pub(crate) fn or(mut self, o: Self) -> Self {
 387                 let total_feature_len = cmp::max(self.flags.len(), o.flags.len());
 388                 self.flags.resize(total_feature_len, 0u8);
 389                 for (byte, o_byte) in self.flags.iter_mut().zip(o.flags.iter()) {
 390                         *byte |= *o_byte;
 391                 }
 392                 self
 393         }
 394 }
 395
 396 impl<T: sealed::Context> Clone for Features<T> {
 397         fn clone(&self) -> Self {
 398                 Self {
 399                         flags: self.flags.clone(),
 400                         mark: PhantomData,
 401                 }
 402         }
 403 }
 404 impl<T: sealed::Context> Hash for Features<T> {
 405         fn hash<H: Hasher>(&self, hasher: &mut H) {
 406                 self.flags.hash(hasher);
 407         }
 408 }
 409 impl<T: sealed::Context> PartialEq for Features<T> {
 410         fn eq(&self, o: &Self) -> bool {
 411                 self.flags.eq(&o.flags)
 412         }
 413 }
 414 impl<T: sealed::Context> fmt::Debug for Features<T> {
 415         fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
 416                 self.flags.fmt(fmt)
 417         }
 418 }
 419
 420 /// Features used within an `init` message.
 421 pub type InitFeatures = Features<sealed::InitContext>;
 422 /// Features used within a `node_announcement` message.
 423 pub type NodeFeatures = Features<sealed::NodeContext>;
 424 /// Features used within a `channel_announcement` message.
 425 pub type ChannelFeatures = Features<sealed::ChannelContext>;
 426 /// Features used within an invoice.
 427 pub type InvoiceFeatures = Features<sealed::InvoiceContext>;
 428
 429 /// Features used within the channel_type field in an OpenChannel message.
 430 ///
 431 /// A channel is always of some known "type", describing the transaction formats used and the exact
 432 /// semantics of our interaction with our peer.
 433 ///
 434 /// Note that because a channel is a specific type which is proposed by the opener and accepted by
 435 /// the counterparty, only required features are allowed here.
 436 ///
 437 /// This is serialized differently from other feature types - it is not prefixed by a length, and
 438 /// thus must only appear inside a TLV where its length is known in advance.
 439 pub type ChannelTypeFeatures = Features<sealed::ChannelTypeContext>;
 440
 441 impl InitFeatures {
 442         /// Writes all features present up to, and including, 13.
 443         pub(crate) fn write_up_to_13<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 444                 let len = cmp::min(2, self.flags.len());
 445                 (len as u16).write(w)?;
 446                 for i in (0..len).rev() {
 447                         if i == 0 {
 448                                 self.flags[i].write(w)?;
 449                         } else {
 450                                 // On byte 1, we want up-to-and-including-bit-13, 0-indexed, which is
 451                                 // up-to-and-including-bit-5, 0-indexed, on this byte:
 452                                 (self.flags[i] & 0b00_11_11_11).write(w)?;
 453                         }
 454                 }
 455                 Ok(())
 456         }
 457
 458         /// Converts `InitFeatures` to `Features<C>`. Only known `InitFeatures` relevant to context `C`
 459         /// are included in the result.
 460         pub(crate) fn to_context<C: sealed::Context>(&self) -> Features<C> {
 461                 self.to_context_internal()
 462         }
 463 }
 464
 465 impl InvoiceFeatures {
 466         /// Converts `InvoiceFeatures` to `Features<C>`. Only known `InvoiceFeatures` relevant to
 467         /// context `C` are included in the result.
 468         pub(crate) fn to_context<C: sealed::Context>(&self) -> Features<C> {
 469                 self.to_context_internal()
 470         }
 471
 472         /// Getting a route for a keysend payment to a private node requires providing the payee's
 473         /// features (since they were not announced in a node announcement). However, keysend payments
 474         /// don't have an invoice to pull the payee's features from, so this method is provided for use in
 475         /// [`PaymentParameters::for_keysend`], thus omitting the need for payers to manually construct an
 476         /// `InvoiceFeatures` for [`find_route`].
 477         ///
 478         /// [`PaymentParameters::for_keysend`]: crate::routing::router::PaymentParameters::for_keysend
 479         /// [`find_route`]: crate::routing::router::find_route
 480         pub(crate) fn for_keysend() -> InvoiceFeatures {
 481                 let mut res = InvoiceFeatures::empty();
 482                 res.set_variable_length_onion_optional();
 483                 res
 484         }
 485 }
 486
 487 impl ChannelTypeFeatures {
 488         /// Constructs the implicit channel type based on the common supported types between us and our
 489         /// counterparty
 490         pub(crate) fn from_counterparty_init(counterparty_init: &InitFeatures) -> Self {
 491                 let mut ret = counterparty_init.to_context_internal();
 492                 // ChannelTypeFeatures must only contain required bits, so we OR the required forms of all
 493                 // optional bits and then AND out the optional ones.
 494                 for byte in ret.flags.iter_mut() {
 495                         *byte |= (*byte & 0b10_10_10_10) >> 1;
 496                         *byte &= 0b01_01_01_01;
 497                 }
 498                 ret
 499         }
 500
 501         /// Constructs a ChannelTypeFeatures with only static_remotekey set
 502         pub(crate) fn only_static_remote_key() -> Self {
 503                 let mut ret = Self::empty();
 504                 <sealed::ChannelTypeContext as sealed::StaticRemoteKey>::set_required_bit(&mut ret.flags);
 505                 ret
 506         }
 507 }
 508
 509 impl ToBase32 for InvoiceFeatures {
 510         fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
 511                 // Explanation for the "4": the normal way to round up when dividing is to add the divisor
 512                 // minus one before dividing
 513                 let length_u5s = (self.flags.len() * 8 + 4) / 5 as usize;
 514                 let mut res_u5s: Vec<u5> = vec![u5::try_from_u8(0).unwrap(); length_u5s];
 515                 for (byte_idx, byte) in self.flags.iter().enumerate() {
 516                         let bit_pos_from_left_0_indexed = byte_idx * 8;
 517                         let new_u5_idx = length_u5s - (bit_pos_from_left_0_indexed / 5) as usize - 1;
 518                         let new_bit_pos = bit_pos_from_left_0_indexed % 5;
 519                         let shifted_chunk_u16 = (*byte as u16) << new_bit_pos;
 520                         let curr_u5_as_u8 = res_u5s[new_u5_idx].to_u8();
 521                         res_u5s[new_u5_idx] = u5::try_from_u8(curr_u5_as_u8 | ((shifted_chunk_u16 & 0x001f) as u8)).unwrap();
 522                         if new_u5_idx > 0 {
 523                                 let curr_u5_as_u8 = res_u5s[new_u5_idx - 1].to_u8();
 524                                 res_u5s[new_u5_idx - 1] = u5::try_from_u8(curr_u5_as_u8 | (((shifted_chunk_u16 >> 5) & 0x001f) as u8)).unwrap();
 525                         }
 526                         if new_u5_idx > 1 {
 527                                 let curr_u5_as_u8 = res_u5s[new_u5_idx - 2].to_u8();
 528                                 res_u5s[new_u5_idx - 2] = u5::try_from_u8(curr_u5_as_u8 | (((shifted_chunk_u16 >> 10) & 0x001f) as u8)).unwrap();
 529                         }
 530                 }
 531                 // Trim the highest feature bits.
 532                 while !res_u5s.is_empty() && res_u5s[0] == u5::try_from_u8(0).unwrap() {
 533                         res_u5s.remove(0);
 534                 }
 535                 writer.write(&res_u5s)
 536         }
 537 }
 538
 539 impl Base32Len for InvoiceFeatures {
 540         fn base32_len(&self) -> usize {
 541                 self.to_base32().len()
 542         }
 543 }
 544
 545 impl FromBase32 for InvoiceFeatures {
 546         type Err = bech32::Error;
 547
 548         fn from_base32(field_data: &[u5]) -> Result<InvoiceFeatures, bech32::Error> {
 549                 // Explanation for the "7": the normal way to round up when dividing is to add the divisor
 550                 // minus one before dividing
 551                 let length_bytes = (field_data.len() * 5 + 7) / 8 as usize;
 552                 let mut res_bytes: Vec<u8> = vec![0; length_bytes];
 553                 for (u5_idx, chunk) in field_data.iter().enumerate() {
 554                         let bit_pos_from_right_0_indexed = (field_data.len() - u5_idx - 1) * 5;
 555                         let new_byte_idx = (bit_pos_from_right_0_indexed / 8) as usize;
 556                         let new_bit_pos = bit_pos_from_right_0_indexed % 8;
 557                         let chunk_u16 = chunk.to_u8() as u16;
 558                         res_bytes[new_byte_idx] |= ((chunk_u16 << new_bit_pos) & 0xff) as u8;
 559                         if new_byte_idx != length_bytes - 1 {
 560                                 res_bytes[new_byte_idx + 1] |= ((chunk_u16 >> (8-new_bit_pos)) & 0xff) as u8;
 561                         }
 562                 }
 563                 // Trim the highest feature bits.
 564                 while !res_bytes.is_empty() && res_bytes[res_bytes.len() - 1] == 0 {
 565                         res_bytes.pop();
 566                 }
 567                 Ok(InvoiceFeatures::from_le_bytes(res_bytes))
 568         }
 569 }
 570
 571 impl<T: sealed::Context> Features<T> {
 572         /// Create a blank Features with no features set
 573         pub fn empty() -> Self {
 574                 Features {
 575                         flags: Vec::new(),
 576                         mark: PhantomData,
 577                 }
 578         }
 579
 580         /// Converts `Features<T>` to `Features<C>`. Only known `T` features relevant to context `C` are
 581         /// included in the result.
 582         fn to_context_internal<C: sealed::Context>(&self) -> Features<C> {
 583                 let from_byte_count = T::KNOWN_FEATURE_MASK.len();
 584                 let to_byte_count = C::KNOWN_FEATURE_MASK.len();
 585                 let mut flags = Vec::new();
 586                 for (i, byte) in self.flags.iter().enumerate() {
 587                         if i < from_byte_count && i < to_byte_count {
 588                                 let from_known_features = T::KNOWN_FEATURE_MASK[i];
 589                                 let to_known_features = C::KNOWN_FEATURE_MASK[i];
 590                                 flags.push(byte & from_known_features & to_known_features);
 591                         }
 592                 }
 593                 Features::<C> { flags, mark: PhantomData, }
 594         }
 595
 596         /// Create a Features given a set of flags, in little-endian. This is in reverse byte order from
 597         /// most on-the-wire encodings.
 598         /// (C-not exported) as we don't support export across multiple T
 599         pub fn from_le_bytes(flags: Vec<u8>) -> Features<T> {
 600                 Features {
 601                         flags,
 602                         mark: PhantomData,
 603                 }
 604         }
 605
 606         #[cfg(test)]
 607         /// Gets the underlying flags set, in LE.
 608         pub fn le_flags(&self) -> &Vec<u8> {
 609                 &self.flags
 610         }
 611
 612         fn write_be<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 613                 for f in self.flags.iter().rev() { // Swap back to big-endian
 614                         f.write(w)?;
 615                 }
 616                 Ok(())
 617         }
 618
 619         fn from_be_bytes(mut flags: Vec<u8>) -> Features<T> {
 620                 flags.reverse(); // Swap to little-endian
 621                 Self {
 622                         flags,
 623                         mark: PhantomData,
 624                 }
 625         }
 626
 627         pub(crate) fn supports_any_optional_bits(&self) -> bool {
 628                 self.flags.iter().any(|&byte| (byte & 0b10_10_10_10) != 0)
 629         }
 630
 631         /// Returns true if this `Features` object contains unknown feature flags which are set as
 632         /// "required".
 633         pub fn requires_unknown_bits(&self) -> bool {
 634                 // Bitwise AND-ing with all even bits set except for known features will select required
 635                 // unknown features.
 636                 let byte_count = T::KNOWN_FEATURE_MASK.len();
 637                 self.flags.iter().enumerate().any(|(i, &byte)| {
 638                         let required_features = 0b01_01_01_01;
 639                         let unknown_features = if i < byte_count {
 640                                 !T::KNOWN_FEATURE_MASK[i]
 641                         } else {
 642                                 0b11_11_11_11
 643                         };
 644                         (byte & (required_features & unknown_features)) != 0
 645                 })
 646         }
 647
 648         pub(crate) fn supports_unknown_bits(&self) -> bool {
 649                 // Bitwise AND-ing with all even and odd bits set except for known features will select
 650                 // both required and optional unknown features.
 651                 let byte_count = T::KNOWN_FEATURE_MASK.len();
 652                 self.flags.iter().enumerate().any(|(i, &byte)| {
 653                         let unknown_features = if i < byte_count {
 654                                 !T::KNOWN_FEATURE_MASK[i]
 655                         } else {
 656                                 0b11_11_11_11
 657                         };
 658                         (byte & unknown_features) != 0
 659                 })
 660         }
 661 }
 662
 663 impl<T: sealed::UpfrontShutdownScript> Features<T> {
 664         #[cfg(test)]
 665         pub(crate) fn clear_upfront_shutdown_script(mut self) -> Self {
 666                 <T as sealed::UpfrontShutdownScript>::clear_bits(&mut self.flags);
 667                 self
 668         }
 669 }
 670
 671 impl<T: sealed::ShutdownAnySegwit> Features<T> {
 672         #[cfg(test)]
 673         pub(crate) fn clear_shutdown_anysegwit(mut self) -> Self {
 674                 <T as sealed::ShutdownAnySegwit>::clear_bits(&mut self.flags);
 675                 self
 676         }
 677 }
 678
 679 impl<T: sealed::Wumbo> Features<T> {
 680         #[cfg(test)]
 681         pub(crate) fn clear_wumbo(mut self) -> Self {
 682                 <T as sealed::Wumbo>::clear_bits(&mut self.flags);
 683                 self
 684         }
 685 }
 686
 687 macro_rules! impl_feature_len_prefixed_write {
 688         ($features: ident) => {
 689                 impl Writeable for $features {
 690                         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 691                                 (self.flags.len() as u16).write(w)?;
 692                                 self.write_be(w)
 693                         }
 694                 }
 695                 impl Readable for $features {
 696                         fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
 697                                 Ok(Self::from_be_bytes(Vec::<u8>::read(r)?))
 698                         }
 699                 }
 700         }
 701 }
 702 impl_feature_len_prefixed_write!(InitFeatures);
 703 impl_feature_len_prefixed_write!(ChannelFeatures);
 704 impl_feature_len_prefixed_write!(NodeFeatures);
 705 impl_feature_len_prefixed_write!(InvoiceFeatures);
 706
 707 // Because ChannelTypeFeatures only appears inside of TLVs, it doesn't have a length prefix when
 708 // serialized. Thus, we can't use `impl_feature_len_prefixed_write`, above, and have to write our
 709 // own serialization.
 710 impl Writeable for ChannelTypeFeatures {
 711         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 712                 self.write_be(w)
 713         }
 714 }
 715 impl Readable for ChannelTypeFeatures {
 716         fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
 717                 let v = io_extras::read_to_end(r)?;
 718                 Ok(Self::from_be_bytes(v))
 719         }
 720 }
 721
 722 #[cfg(test)]
 723 mod tests {
 724         use super::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, InvoiceFeatures, NodeFeatures, sealed};
 725         use bitcoin::bech32::{Base32Len, FromBase32, ToBase32, u5};
 726
 727         #[test]
 728         fn sanity_test_unknown_bits() {
 729                 let features = ChannelFeatures::empty();
 730                 assert!(!features.requires_unknown_bits());
 731                 assert!(!features.supports_unknown_bits());
 732
 733                 let mut features = ChannelFeatures::empty();
 734                 features.set_unknown_feature_required();
 735                 assert!(features.requires_unknown_bits());
 736                 assert!(features.supports_unknown_bits());
 737
 738                 let mut features = ChannelFeatures::empty();
 739                 features.set_unknown_feature_optional();
 740                 assert!(!features.requires_unknown_bits());
 741                 assert!(features.supports_unknown_bits());
 742         }
 743
 744         #[test]
 745         fn convert_to_context_with_relevant_flags() {
 746                 let mut init_features = InitFeatures::empty();
 747                 // Set a bunch of features we use, plus initial_routing_sync_required (which shouldn't get
 748                 // converted as it's only relevant in an init context).
 749                 init_features.set_initial_routing_sync_required();
 750                 init_features.set_data_loss_protect_optional();
 751                 init_features.set_variable_length_onion_required();
 752                 init_features.set_static_remote_key_required();
 753                 init_features.set_payment_secret_required();
 754                 init_features.set_basic_mpp_optional();
 755                 init_features.set_wumbo_optional();
 756                 init_features.set_shutdown_any_segwit_optional();
 757                 init_features.set_onion_messages_optional();
 758                 init_features.set_channel_type_optional();
 759                 init_features.set_scid_privacy_optional();
 760                 init_features.set_zero_conf_optional();
 761
 762                 assert!(init_features.initial_routing_sync());
 763                 assert!(!init_features.supports_upfront_shutdown_script());
 764                 assert!(!init_features.supports_gossip_queries());
 765
 766                 let node_features: NodeFeatures = init_features.to_context();
 767                 {
 768                         // Check that the flags are as expected:
 769                         // - option_data_loss_protect
 770                         // - var_onion_optin (req) | static_remote_key (req) | payment_secret(req)
 771                         // - basic_mpp | wumbo
 772                         // - opt_shutdown_anysegwit
 773                         // - onion_messages
 774                         // - option_channel_type | option_scid_alias
 775                         // - option_zeroconf
 776                         assert_eq!(node_features.flags.len(), 7);
 777                         assert_eq!(node_features.flags[0], 0b00000010);
 778                         assert_eq!(node_features.flags[1], 0b01010001);
 779                         assert_eq!(node_features.flags[2], 0b00001010);
 780                         assert_eq!(node_features.flags[3], 0b00001000);
 781                         assert_eq!(node_features.flags[4], 0b10000000);
 782                         assert_eq!(node_features.flags[5], 0b10100000);
 783                         assert_eq!(node_features.flags[6], 0b00001000);
 784                 }
 785
 786                 // Check that cleared flags are kept blank when converting back:
 787                 // - initial_routing_sync was not applicable to NodeContext
 788                 // - upfront_shutdown_script was cleared before converting
 789                 // - gossip_queries was cleared before converting
 790                 let features: InitFeatures = node_features.to_context_internal();
 791                 assert!(!features.initial_routing_sync());
 792                 assert!(!features.supports_upfront_shutdown_script());
 793                 assert!(!init_features.supports_gossip_queries());
 794         }
 795
 796         #[test]
 797         fn convert_to_context_with_unknown_flags() {
 798                 // Ensure the `from` context has fewer known feature bytes than the `to` context.
 799                 assert!(<sealed::InvoiceContext as sealed::Context>::KNOWN_FEATURE_MASK.len() <
 800                         <sealed::NodeContext as sealed::Context>::KNOWN_FEATURE_MASK.len());
 801                 let mut invoice_features = InvoiceFeatures::empty();
 802                 invoice_features.set_unknown_feature_optional();
 803                 assert!(invoice_features.supports_unknown_bits());
 804                 let node_features: NodeFeatures = invoice_features.to_context();
 805                 assert!(!node_features.supports_unknown_bits());
 806         }
 807
 808         #[test]
 809         fn set_feature_bits() {
 810                 let mut features = InvoiceFeatures::empty();
 811                 features.set_basic_mpp_optional();
 812                 features.set_payment_secret_required();
 813                 assert!(features.supports_basic_mpp());
 814                 assert!(!features.requires_basic_mpp());
 815                 assert!(features.requires_payment_secret());
 816                 assert!(features.supports_payment_secret());
 817         }
 818
 819         #[test]
 820         fn invoice_features_encoding() {
 821                 let features_as_u5s = vec![
 822                         u5::try_from_u8(6).unwrap(),
 823                         u5::try_from_u8(10).unwrap(),
 824                         u5::try_from_u8(25).unwrap(),
 825                         u5::try_from_u8(1).unwrap(),
 826                         u5::try_from_u8(10).unwrap(),
 827                         u5::try_from_u8(0).unwrap(),
 828                         u5::try_from_u8(20).unwrap(),
 829                         u5::try_from_u8(2).unwrap(),
 830                         u5::try_from_u8(0).unwrap(),
 831                         u5::try_from_u8(6).unwrap(),
 832                         u5::try_from_u8(0).unwrap(),
 833                         u5::try_from_u8(16).unwrap(),
 834                         u5::try_from_u8(1).unwrap(),
 835                 ];
 836                 let features = InvoiceFeatures::from_le_bytes(vec![1, 2, 3, 4, 5, 42, 100, 101]);
 837
 838                 // Test length calculation.
 839                 assert_eq!(features.base32_len(), 13);
 840
 841                 // Test serialization.
 842                 let features_serialized = features.to_base32();
 843                 assert_eq!(features_as_u5s, features_serialized);
 844
 845                 // Test deserialization.
 846                 let features_deserialized = InvoiceFeatures::from_base32(&features_as_u5s).unwrap();
 847                 assert_eq!(features, features_deserialized);
 848         }
 849
 850         #[test]
 851         fn test_channel_type_mapping() {
 852                 // If we map an InvoiceFeatures with StaticRemoteKey optional, it should map into a
 853                 // required-StaticRemoteKey ChannelTypeFeatures.
 854                 let mut init_features = InitFeatures::empty();
 855                 init_features.set_static_remote_key_optional();
 856                 let converted_features = ChannelTypeFeatures::from_counterparty_init(&init_features);
 857                 assert_eq!(converted_features, ChannelTypeFeatures::only_static_remote_key());
 858                 assert!(!converted_features.supports_any_optional_bits());
 859                 assert!(converted_features.requires_static_remote_key());
 860         }
 861 }