Struct lnp::features::InitFeatures

pub struct InitFeatures {
    pub option_data_loss_protect: Option<bool>,
    pub initial_routing_sync: bool,
    pub option_upfront_shutdown_script: Option<bool>,
    pub gossip_queries: Option<bool>,
    pub var_onion_optin: Option<bool>,
    pub gossip_queries_ex: Option<bool>,
    pub option_static_remotekey: Option<bool>,
    pub payment_secret: Option<bool>,
    pub basic_mpp: Option<bool>,
    pub option_support_large_channel: Option<bool>,
    pub option_anchor_outputs: Option<bool>,
    pub unknown: FlagVec,
}

Flags are numbered from the least-significant bit, at bit 0 (i.e. 0x1, an even bit). They are generally assigned in pairs so that features can be introduced as optional (odd bits) and later upgraded to be compulsory (even bits), which will be refused by outdated nodes: see BOLT #1: The init Message.

Specification

https://github.com/lightningnetwork/lightning-rfc/blob/master/09-features.md

Fields

option_data_loss_protect: Option<bool>

Requires or supports extra channel_reestablish fields

initial_routing_sync: bool

Sending node needs a complete routing information dump

option_upfront_shutdown_script: Option<bool>

Commits to a shutdown scriptpubkey when opening channel

gossip_queries: Option<bool>

More sophisticated gossip control

var_onion_optin: Option<bool>

Requires/supports variable-length routing onion payloads

gossip_queries_ex: Option<bool>

Gossip queries can include additional information

option_static_remotekey: Option<bool>

Static key for remote output

payment_secret: Option<bool>

Node supports payment_secret field

basic_mpp: Option<bool>

Node can receive basic multi-part payments

option_support_large_channel: Option<bool>

Can create large channels

option_anchor_outputs: Option<bool>

Anchor outputs

unknown: FlagVec

Rest of feature flags which are unknown to the current implementation

Implementations

impl InitFeatures

pub fn check(&self) -> Result<(), Error>

pub fn check_consistency(&self) -> Result<(), NoRequiredFeatureError>

pub fn check_unknown_even(&self) -> Result<(), Error>

pub fn known_features(&self) -> BTreeMap<Feature, bool>

Trait Implementations

impl Clone for InitFeatures

fn clone(&self) -> InitFeatures

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InitFeatures

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

Formats the value using the given formatter.

impl Default for InitFeatures

fn default() -> InitFeatures

Returns the “default value” for a type.

impl Display for InitFeatures

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

Formats the value using the given formatter.

impl Eq for InitFeatures

impl Hash for InitFeatures

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl LightningDecode for InitFeatures

fn lightning_decode<D: Read>(d: D) -> Result<Self, Error>

pub fn lightning_deserialize(data: &impl AsRef<[u8]>) -> Result<Self, Error>

impl LightningEncode for InitFeatures

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

pub fn lightning_serialize(&self) -> Vec<u8, Global>

impl Ord for InitFeatures

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<InitFeatures> for InitFeatures

fn eq(&self, other: &InitFeatures) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<InitFeatures> for InitFeatures

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StrictDecode for InitFeatures

fn strict_decode<D: Read>(d: D) -> Result<Self, Error>

Decode with the given [std::io::Reader] instance; must either construct an instance or return implementation-specific error type.

pub fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using [strict_decode()]

impl StrictEncode for InitFeatures

fn strict_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Encode with the given [std::io::Writer] instance; must return result with either amount of bytes encoded – or implementation-specific error type.

pub fn strict_serialize(&self) -> Result<Vec<u8, Global>, Error>

Serializes data as a byte array using [strict_encode()] function

impl StructuralEq for InitFeatures

impl StructuralPartialEq for InitFeatures

impl TryFrom<FlagVec> for InitFeatures

type Error = Error

The type returned in the event of a conversion error.

fn try_from(flags: FlagVec) -> Result<Self, Self::Error>

Performs the conversion.