Enum lnp::channel::bolt::BoltExt

pub enum BoltExt {
    Channel,
    Bolt3,
    Htlc,
    ShutdownScript,
    AnchorOutputs,
    Policy,
    Bip96,
}

Variants

Channel

The channel itself

Bolt3

Main channel constructor

Htlc

HTLC payments

ShutdownScript

BOLT-9 feature: shutdown script

AnchorOutputs

BOLT-9 feature: anchor

Policy

The role of policy extension is to make sure that aggregate properties of the transaction (no of HTLCs, fees etc) does not violate channel policies – and adjust to these policies if needed

NB: Policy must always be applied after other extenders

Bip96

Deterministic transaction ordering

Trait Implementations

impl ChannelConstructor<BoltExt> for BoltChannel

fn enrich_funding( &self, psbt: &mut Psbt, funding: &Funding ) -> Result<(), Error>

impl ChannelExtension<BoltExt> for AnchorOutputs

fn new() -> Box<dyn ChannelExtension<BoltExt>>where Self: Sized,

Constructs boxed extension objects which can be inserted into channel extension pipeline

fn build_graph( &self, _tx_graph: &mut TxGraph<'_>, _as_remote_node: bool ) -> Result<(), Error>

Applies state to the channel transaction graph

impl ChannelExtension<BoltExt> for BoltChannel

fn new() -> Box<dyn ChannelExtension<BoltExt>>

Constructs boxed extension objects which can be inserted into channel extension pipeline

fn build_graph( &self, tx_graph: &mut TxGraph<'_>, as_remote_node: bool ) -> Result<(), Error>

Applies state to the channel transaction graph

impl ChannelExtension<BoltExt> for Htlc

fn new() -> Box<dyn ChannelExtension<BoltExt>>where Self: Sized,

Constructs boxed extension objects which can be inserted into channel extension pipeline

fn build_graph( &self, tx_graph: &mut TxGraph<'_>, _as_remote_node: bool ) -> Result<(), Error>

Applies state to the channel transaction graph

impl Clone for BoltExt

fn clone(&self) -> BoltExt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BoltExt

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

Formats the value using the given formatter.

impl Default for BoltExt

fn default() -> Self

Returns the “default value” for a type.

impl Display for BoltExt

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

Formats the value using the given formatter.

impl Extension<BoltExt> for AnchorOutputs

fn identity(&self) -> BoltExt

fn update_from_local(&mut self, _message: &()) -> Result<(), Error>

Updates extension state from some local data

fn update_from_peer(&mut self, _: &Messages) -> Result<(), Error>

Updates extension state from the data taken from the message received from the remote peer

fn load_state(&mut self, _state: &ChannelState)

fn store_state(&self, _state: &mut ChannelState)

fn state_change( &mut self, request: &<N as Nomenclature>::UpdateRequest, message: &mut <N as Nomenclature>::PeerMessage ) -> Result<(), <N as Nomenclature>::Error>

Perform a sate change and produce a message which should be communicated to peers notifying them about the state change

impl Extension<BoltExt> for Bip96

fn identity(&self) -> BoltExt

fn update_from_local(&mut self, _message: &()) -> Result<(), Error>

Updates extension state from some local data

fn update_from_peer(&mut self, _: &Messages) -> Result<(), Error>

Updates extension state from the data taken from the message received from the remote peer

fn load_state(&mut self, _state: &ChannelState)

fn store_state(&self, _state: &mut ChannelState)

fn state_change( &mut self, request: &<N as Nomenclature>::UpdateRequest, message: &mut <N as Nomenclature>::PeerMessage ) -> Result<(), <N as Nomenclature>::Error>

Perform a sate change and produce a message which should be communicated to peers notifying them about the state change

impl Extension<BoltExt> for BoltChannel

fn identity(&self) -> BoltExt

fn update_from_local(&mut self, _message: &()) -> Result<(), Error>

Updates extension state from some local data

fn update_from_peer(&mut self, message: &Messages) -> Result<(), Error>

Updates extension state from the data taken from the message received from the remote peer

fn load_state(&mut self, state: &ChannelState)

fn store_state(&self, state: &mut ChannelState)

fn state_change( &mut self, request: &<N as Nomenclature>::UpdateRequest, message: &mut <N as Nomenclature>::PeerMessage ) -> Result<(), <N as Nomenclature>::Error>

Perform a sate change and produce a message which should be communicated to peers notifying them about the state change

impl Extension<BoltExt> for Htlc

fn identity(&self) -> BoltExt

fn update_from_local(&mut self, _message: &()) -> Result<(), Error>

Updates extension state from some local data

fn state_change( &mut self, request: &UpdateReq, message: &mut Messages ) -> Result<(), Error>

Perform a sate change and produce a message which should be communicated to peers notifying them about the state change

fn update_from_peer(&mut self, message: &Messages) -> Result<(), Error>

Updates extension state from the data taken from the message received from the remote peer

fn load_state(&mut self, state: &ChannelState)

fn store_state(&self, state: &mut ChannelState)

impl From<BoltExt> for u16

fn from(id: BoltExt) -> Self

Converts to this type from the input type.

impl Hash for BoltExt

fn hash<__H: Hasher>(&self, state: &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 Nomenclature for BoltExt

type State = ChannelState

type Error = Error

type PeerMessage = Messages

type UpdateMessage = ()

type UpdateRequest = UpdateReq

impl Nomenclature for BoltExt

type Constructor = BoltChannel

fn default_extenders() -> Vec<Box<dyn ChannelExtension<Self>>>

Returns set of default channel extenders

fn default_modifiers() -> Vec<Box<dyn ChannelExtension<Self>>>

Returns set of default channel modifiers

fn update_from_peer( channel: &mut Channel<Self>, message: &Messages ) -> Result<(), Error>

Updates channel extension structure from peer message. Processed before each of the registered extensions gets Extension::update_from_peer

impl Ord for BoltExt

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<BoltExt> for BoltExt

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

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

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

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

impl PartialOrd<BoltExt> for BoltExt

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

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

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

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

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

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

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

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

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 BoltExt

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

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

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

Tries to deserialize byte array into the current type using StrictDecode::strict_decode. If there are some data remains in the buffer once deserialization is completed, fails with Error::DataNotEntirelyConsumed. Use io::Cursor over the buffer and StrictDecode::strict_decode to avoid such failures.

fn strict_file_load(path: impl AsRef<Path>) -> Result<Self, Error>

Reads data from file at path and reconstructs object from it. Fails with Error::DataNotEntirelyConsumed if file contains remaining data after the object reconstruction.

impl StrictEncode for BoltExt

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

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

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

Serializes data as a byte array using StrictEncode::strict_encode function

fn strict_file_save(&self, path: impl AsRef<Path>) -> Result<usize, Error>

Saves data to a file at a given path. If the file does not exists, attempts to create the file. If the file already exists, it gets truncated.

impl TryFrom<u16> for BoltExt

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: u16) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for BoltExt

impl Eq for BoltExt

impl StructuralEq for BoltExt

impl StructuralPartialEq for BoltExt