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