Struct Features 

pub struct Features<T: Context + ?Sized> { /* private fields */ }

Tracks the set of features which a node implements, templated by the context in which it appears.

This is not exported to bindings users as we map the concrete feature types below directly instead

Implementations

impl<T: DataLossProtect> Features<T>

pub fn set_data_loss_protect_optional(&mut self)

Set this feature as optional.

pub fn set_data_loss_protect_required(&mut self)

Set this feature as required.

pub fn clear_data_loss_protect(&mut self)

Unsets this feature.

pub fn supports_data_loss_protect(&self) -> bool

Checks if this feature is supported.

impl<T: DataLossProtect> Features<T>

pub fn requires_data_loss_protect(&self) -> bool

Checks if this feature is required.

impl<T: InitialRoutingSync> Features<T>

pub fn set_initial_routing_sync_optional(&mut self)

Set this feature as optional.

pub fn set_initial_routing_sync_required(&mut self)

Set this feature as required.

pub fn clear_initial_routing_sync(&mut self)

Unsets this feature.

pub fn initial_routing_sync(&self) -> bool

Checks if this feature is supported.

impl<T: UpfrontShutdownScript> Features<T>

pub fn set_upfront_shutdown_script_optional(&mut self)

Set this feature as optional.

pub fn set_upfront_shutdown_script_required(&mut self)

Set this feature as required.

pub fn clear_upfront_shutdown_script(&mut self)

Unsets this feature.

pub fn supports_upfront_shutdown_script(&self) -> bool

Checks if this feature is supported.

impl<T: UpfrontShutdownScript> Features<T>

pub fn requires_upfront_shutdown_script(&self) -> bool

Checks if this feature is required.

impl<T: GossipQueries> Features<T>

pub fn set_gossip_queries_optional(&mut self)

Set this feature as optional.

pub fn set_gossip_queries_required(&mut self)

Set this feature as required.

pub fn clear_gossip_queries(&mut self)

Unsets this feature.

pub fn supports_gossip_queries(&self) -> bool

Checks if this feature is supported.

impl<T: GossipQueries> Features<T>

pub fn requires_gossip_queries(&self) -> bool

Checks if this feature is required.

impl<T: VariableLengthOnion> Features<T>

pub fn set_variable_length_onion_optional(&mut self)

Set this feature as optional.

pub fn set_variable_length_onion_required(&mut self)

Set this feature as required.

pub fn clear_variable_length_onion(&mut self)

Unsets this feature.

pub fn supports_variable_length_onion(&self) -> bool

Checks if this feature is supported.

impl<T: VariableLengthOnion> Features<T>

pub fn requires_variable_length_onion(&self) -> bool

Checks if this feature is required.

impl<T: StaticRemoteKey> Features<T>

pub fn set_static_remote_key_optional(&mut self)

Set this feature as optional.

pub fn set_static_remote_key_required(&mut self)

Set this feature as required.

pub fn clear_static_remote_key(&mut self)

Unsets this feature.

pub fn supports_static_remote_key(&self) -> bool

Checks if this feature is supported.

impl<T: StaticRemoteKey> Features<T>

pub fn requires_static_remote_key(&self) -> bool

Checks if this feature is required.

impl<T: PaymentSecret> Features<T>

pub fn set_payment_secret_optional(&mut self)

Set this feature as optional.

pub fn set_payment_secret_required(&mut self)

Set this feature as required.

pub fn clear_payment_secret(&mut self)

Unsets this feature.

pub fn supports_payment_secret(&self) -> bool

Checks if this feature is supported.

impl<T: PaymentSecret> Features<T>

pub fn requires_payment_secret(&self) -> bool

Checks if this feature is required.

impl<T: BasicMPP> Features<T>

pub fn set_basic_mpp_optional(&mut self)

Set this feature as optional.

pub fn set_basic_mpp_required(&mut self)

Set this feature as required.

pub fn clear_basic_mpp(&mut self)

Unsets this feature.

pub fn supports_basic_mpp(&self) -> bool

Checks if this feature is supported.

impl<T: BasicMPP> Features<T>

pub fn requires_basic_mpp(&self) -> bool

Checks if this feature is required.

impl<T: Wumbo> Features<T>

pub fn set_wumbo_optional(&mut self)

Set this feature as optional.

pub fn set_wumbo_required(&mut self)

Set this feature as required.

pub fn clear_wumbo(&mut self)

Unsets this feature.

pub fn supports_wumbo(&self) -> bool

Checks if this feature is supported.

impl<T: Wumbo> Features<T>

pub fn requires_wumbo(&self) -> bool

Checks if this feature is required.

impl<T: AnchorsNonzeroFeeHtlcTx> Features<T>

pub fn set_anchors_nonzero_fee_htlc_tx_optional(&mut self)

Set this feature as optional.

pub fn set_anchors_nonzero_fee_htlc_tx_required(&mut self)

Set this feature as required.

pub fn clear_anchors_nonzero_fee_htlc_tx(&mut self)

Unsets this feature.

pub fn supports_anchors_nonzero_fee_htlc_tx(&self) -> bool

Checks if this feature is supported.

impl<T: AnchorsNonzeroFeeHtlcTx> Features<T>

pub fn requires_anchors_nonzero_fee_htlc_tx(&self) -> bool

Checks if this feature is required.

impl<T: AnchorsZeroFeeHtlcTx> Features<T>

pub fn set_anchors_zero_fee_htlc_tx_optional(&mut self)

Set this feature as optional.

pub fn set_anchors_zero_fee_htlc_tx_required(&mut self)

Set this feature as required.

pub fn clear_anchors_zero_fee_htlc_tx(&mut self)

Unsets this feature.

pub fn supports_anchors_zero_fee_htlc_tx(&self) -> bool

Checks if this feature is supported.

impl<T: AnchorsZeroFeeHtlcTx> Features<T>

pub fn requires_anchors_zero_fee_htlc_tx(&self) -> bool

Checks if this feature is required.

impl<T: RouteBlinding> Features<T>

pub fn set_route_blinding_optional(&mut self)

Set this feature as optional.

pub fn set_route_blinding_required(&mut self)

Set this feature as required.

pub fn clear_route_blinding(&mut self)

Unsets this feature.

pub fn supports_route_blinding(&self) -> bool

Checks if this feature is supported.

impl<T: RouteBlinding> Features<T>

pub fn requires_route_blinding(&self) -> bool

Checks if this feature is required.

impl<T: ShutdownAnySegwit> Features<T>

pub fn set_shutdown_any_segwit_optional(&mut self)

Set this feature as optional.

pub fn set_shutdown_any_segwit_required(&mut self)

Set this feature as required.

pub fn clear_shutdown_anysegwit(&mut self)

Unsets this feature.

pub fn supports_shutdown_anysegwit(&self) -> bool

Checks if this feature is supported.

impl<T: ShutdownAnySegwit> Features<T>

pub fn requires_shutdown_anysegwit(&self) -> bool

Checks if this feature is required.

impl<T: DualFund> Features<T>

pub fn set_dual_fund_optional(&mut self)

Set this feature as optional.

pub fn set_dual_fund_required(&mut self)

Set this feature as required.

pub fn clear_dual_fund(&mut self)

Unsets this feature.

pub fn supports_dual_fund(&self) -> bool

Checks if this feature is supported.

impl<T: DualFund> Features<T>

pub fn requires_dual_fund(&self) -> bool

Checks if this feature is required.

impl<T: Taproot> Features<T>

pub fn set_taproot_optional(&mut self)

Set this feature as optional.

pub fn set_taproot_required(&mut self)

Set this feature as required.

pub fn clear_taproot(&mut self)

Unsets this feature.

pub fn supports_taproot(&self) -> bool

Checks if this feature is supported.

impl<T: Taproot> Features<T>

pub fn requires_taproot(&self) -> bool

Checks if this feature is required.

impl<T: Quiescence> Features<T>

pub fn set_quiescence_optional(&mut self)

Set this feature as optional.

pub fn set_quiescence_required(&mut self)

Set this feature as required.

pub fn clear_quiescence(&mut self)

Unsets this feature.

pub fn supports_quiescence(&self) -> bool

Checks if this feature is supported.

impl<T: Quiescence> Features<T>

pub fn requires_quiescence(&self) -> bool

Checks if this feature is required.

impl<T: OnionMessages> Features<T>

pub fn set_onion_messages_optional(&mut self)

Set this feature as optional.

pub fn set_onion_messages_required(&mut self)

Set this feature as required.

pub fn clear_onion_messages(&mut self)

Unsets this feature.

pub fn supports_onion_messages(&self) -> bool

Checks if this feature is supported.

impl<T: OnionMessages> Features<T>

pub fn requires_onion_messages(&self) -> bool

Checks if this feature is required.

impl<T: ProvideStorage> Features<T>

pub fn set_provide_storage_optional(&mut self)

Set this feature as optional.

pub fn set_provide_storage_required(&mut self)

Set this feature as required.

pub fn clear_provide_storage(&mut self)

Unsets this feature.

pub fn supports_provide_storage(&self) -> bool

Checks if this feature is supported.

impl<T: ProvideStorage> Features<T>

pub fn requires_provide_storage(&self) -> bool

Checks if this feature is required.

impl<T: ChannelType> Features<T>

pub fn set_channel_type_optional(&mut self)

Set this feature as optional.

pub fn set_channel_type_required(&mut self)

Set this feature as required.

pub fn clear_channel_type(&mut self)

Unsets this feature.

pub fn supports_channel_type(&self) -> bool

Checks if this feature is supported.

impl<T: ChannelType> Features<T>

pub fn requires_channel_type(&self) -> bool

Checks if this feature is required.

impl<T: SCIDPrivacy> Features<T>

pub fn set_scid_privacy_optional(&mut self)

Set this feature as optional.

pub fn set_scid_privacy_required(&mut self)

Set this feature as required.

pub fn clear_scid_privacy(&mut self)

Unsets this feature.

pub fn supports_scid_privacy(&self) -> bool

Checks if this feature is supported.

impl<T: SCIDPrivacy> Features<T>

pub fn requires_scid_privacy(&self) -> bool

Checks if this feature is required.

impl<T: PaymentMetadata> Features<T>

pub fn set_payment_metadata_optional(&mut self)

Set this feature as optional.

pub fn set_payment_metadata_required(&mut self)

Set this feature as required.

pub fn clear_payment_metadata(&mut self)

Unsets this feature.

pub fn supports_payment_metadata(&self) -> bool

Checks if this feature is supported.

impl<T: PaymentMetadata> Features<T>

pub fn requires_payment_metadata(&self) -> bool

Checks if this feature is required.

impl<T: ZeroConf> Features<T>

pub fn set_zero_conf_optional(&mut self)

Set this feature as optional.

pub fn set_zero_conf_required(&mut self)

Set this feature as required.

pub fn supports_zero_conf(&mut self)

Unsets this feature.

pub fn requires_zero_conf(&self) -> bool

Checks if this feature is supported.

impl<T: Keysend> Features<T>

pub fn set_keysend_optional(&mut self)

Set this feature as optional.

pub fn set_keysend_required(&mut self)

Set this feature as required.

pub fn clear_keysend(&mut self)

Unsets this feature.

pub fn supports_keysend(&self) -> bool

Checks if this feature is supported.

impl<T: Keysend> Features<T>

pub fn requires_keysend(&self) -> bool

Checks if this feature is required.

impl<T: Trampoline> Features<T>

pub fn set_trampoline_routing_optional(&mut self)

Set this feature as optional.

pub fn set_trampoline_routing_required(&mut self)

Set this feature as required.

pub fn clear_trampoline_routing(&mut self)

Unsets this feature.

pub fn supports_trampoline_routing(&self) -> bool

Checks if this feature is supported.

impl<T: Trampoline> Features<T>

pub fn requires_trampoline_routing(&self) -> bool

Checks if this feature is required.

impl<T: SimpleClose> Features<T>

pub fn set_simple_close_optional(&mut self)

Set this feature as optional.

pub fn set_simple_close_required(&mut self)

Set this feature as required.

pub fn clear_simple_close(&mut self)

Unsets this feature.

pub fn supports_simple_close(&self) -> bool

Checks if this feature is supported.

impl<T: SimpleClose> Features<T>

pub fn requires_simple_close(&self) -> bool

Checks if this feature is required.

impl<T: SpliceProduction> Features<T>

pub fn set_splicing_production_optional(&mut self)

Set this feature as optional.

pub fn set_splicing_production_required(&mut self)

Set this feature as required.

pub fn clear_splicing_production(&mut self)

Unsets this feature.

pub fn supports_splicing_production(&self) -> bool

Checks if this feature is supported.

impl<T: SpliceProduction> Features<T>

pub fn requires_splicing_production(&self) -> bool

Checks if this feature is required.

impl<T: AnchorZeroFeeCommitmentsStaging> Features<T>

pub fn set_anchor_zero_fee_commitments_optional(&mut self)

Set this feature as optional.

pub fn set_anchor_zero_fee_commitments_required(&mut self)

Set this feature as required.

pub fn clear_anchor_zero_fee_commitments(&mut self)

Unsets this feature.

pub fn supports_anchor_zero_fee_commitments(&self) -> bool

Checks if this feature is supported.

impl<T: AnchorZeroFeeCommitmentsStaging> Features<T>

pub fn requires_anchor_zero_fee_commitments(&self) -> bool

Checks if this feature is required.

impl<T: HtlcHold> Features<T>

pub fn set_htlc_hold_optional(&mut self)

Set this feature as optional.

pub fn set_htlc_hold_required(&mut self)

Set this feature as required.

pub fn clear_htlc_hold(&mut self)

Unsets this feature.

pub fn supports_htlc_hold(&self) -> bool

Checks if this feature is supported.

impl<T: HtlcHold> Features<T>

pub fn requires_htlc_hold(&self) -> bool

Checks if this feature is required.

impl<T: SplicePrototype> Features<T>

pub fn set_splicing_optional(&mut self)

Set this feature as optional.

pub fn set_splicing_required(&mut self)

Set this feature as required.

pub fn clear_splicing(&mut self)

Unsets this feature.

pub fn supports_splicing(&self) -> bool

Checks if this feature is supported.

impl<T: SplicePrototype> Features<T>

pub fn requires_splicing(&self) -> bool

Checks if this feature is required.

impl<T: DnsResolver> Features<T>

pub fn set_dns_resolution_optional(&mut self)

Set this feature as optional.

pub fn set_dns_resolution_required(&mut self)

Set this feature as required.

pub fn clear_dns_resolution(&mut self)

Unsets this feature.

pub fn supports_dns_resolution(&self) -> bool

Checks if this feature is supported.

impl<T: DnsResolver> Features<T>

pub fn requires_dns_resolution(&self) -> bool

Checks if this feature is required.

impl Features<Bolt11InvoiceContext>

pub fn for_keysend(allow_mpp: bool) -> Bolt11InvoiceFeatures

Getting a route for a keysend payment to a private node requires providing the payee’s features (since they were not announced in a node announcement). However, keysend payments don’t have an invoice to pull the payee’s features from, so this method is provided for use when a Bolt11InvoiceFeatures is required in a route.

MPP keysend is not widely supported yet, so we parameterize support to allow the user to choose whether their router should find multi-part routes.

impl Features<ChannelTypeContext>

pub fn only_static_remote_key() -> Self

Constructs a ChannelTypeFeatures with only static_remotekey set

pub fn anchors_zero_htlc_fee_and_dependencies() -> Self

Constructs a ChannelTypeFeatures with anchors support

pub fn anchors_zero_fee_commitments() -> Self

Constructs a ChannelTypeFeatures with zero fee commitment anchors support.

impl<T: Context> Features<T>

pub fn empty() -> Self

Create a blank Features with no features set

pub fn from_le_bytes(flags: Vec<u8>) -> Features<T>

Create a Features given a set of flags, in little-endian. This is in reverse byte order from most on-the-wire encodings.

This is not exported to bindings users as we don’t support export across multiple T

pub fn le_flags(&self) -> &[u8]

Returns the feature set as a list of bytes, in little-endian. This is in reverse byte order from most on-the-wire encodings.

pub fn from_be_bytes(flags: Vec<u8>) -> Features<T>

Create a Features given a set of flags, in big-endian. This is in byte order from most on-the-wire encodings.

This is not exported to bindings users as we don’t support export across multiple T

pub fn supports_any_optional_bits(&self) -> bool

Returns true if this Features has any optional flags set

pub fn requires_unknown_bits_from(&self, other: &Self) -> bool

Returns true if this Features object contains required features unknown by other.

pub fn required_unknown_bits_from(&self, other: &Self) -> Vec<u64>

Returns the set of required features unknown by other, as their bit position.

pub fn requires_unknown_bits(&self) -> bool

Returns true if this Features object contains unknown feature flags which are set as “required”.

pub fn supports_unknown_bits(&self) -> bool

Returns true if this Features supports any bits which we do not know of

pub fn set_required_feature_bit(&mut self, bit: usize) -> Result<(), ()>

Sets a required feature bit. Errors if bit is outside the feature range as defined by BOLT 9.

Note: Required bits are even. If an odd bit is given, then the corresponding even bit will be set instead (i.e., bit - 1).

pub fn set_optional_feature_bit(&mut self, bit: usize) -> Result<(), ()>

Sets an optional feature bit. Errors if bit is outside the feature range as defined by BOLT 9.

Note: Optional bits are odd. If an even bit is given, then the corresponding odd bit will be set instead (i.e., bit + 1).

pub fn set_required_custom_bit(&mut self, bit: usize) -> Result<(), ()>

Sets a required custom feature bit. Errors if bit is outside the custom range as defined by bLIP 2 or if it is a known T feature.

Note: Required bits are even. If an odd bit is given, then the corresponding even bit will be set instead (i.e., bit - 1).

pub fn set_optional_custom_bit(&mut self, bit: usize) -> Result<(), ()>

Sets an optional custom feature bit. Errors if bit is outside the custom range as defined by bLIP 2 or if it is a known T feature.

Note: Optional bits are odd. If an even bit is given, then the corresponding odd bit will be set instead (i.e., bit + 1).

Trait Implementations

impl<T: Context> BitOr for Features<T>

type Output = Features<T>

The resulting type after applying the | operator.

fn bitor(self, o: Self) -> Self

Performs the | operation.

impl<T: Context, Rhs: Borrow<Self>> BitOrAssign<Rhs> for Features<T>

fn bitor_assign(&mut self, rhs: Rhs)

Performs the |= operation.

impl<T: Context> Clone for Features<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Context> Debug for Features<T>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for Features<BlindedHopContext>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for Features<Bolt11InvoiceContext>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for Features<Bolt12InvoiceContext>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for Features<ChannelContext>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for Features<ChannelTypeContext>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for Features<InitContext>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for Features<InvoiceRequestContext>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for Features<NodeContext>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for Features<OfferContext>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<T: Context> Hash for Features<T>

fn hash<H: Hasher>(&self, hasher: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Context + Eq> Ord for Features<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: Context + ?Sized> PartialEq for Features<T>

fn eq(&self, o: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Context> PartialOrd for Features<T>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Eq + Context + ?Sized> Eq for Features<T>