Struct BoltChannel

pub struct BoltChannel { /* private fields */ }

The core of the lightning channel operating according to the Bolt3 standard. This is “channel constructor” used by Channel structure and managing part of the state which is not HTLC-related.

The type should not be constructed directly or used from outside of the library, but it’s made public for allowing channel state access.

Implementations

impl BoltChannel

pub fn stage(&self) -> Lifecycle

Method returning copy of BoltChannel::stage field. Current channel lifecycle stage

pub fn chain_hash(&self) -> Slice32

Method returning copy of BoltChannel::chain_hash field. The chain_hash value denotes the exact blockchain that the opened

pub fn active_channel_id(&self) -> ActiveChannelId

Method returning copy of BoltChannel::active_channel_id field. Channel id used by the channel; first temporary and later final.

pub fn local_amount_msat(&self) -> u64

Method returning copy of BoltChannel::local_amount_msat field. Amount in millisatoshis

pub fn remote_amount_msat(&self) -> u64

Method returning copy of BoltChannel::remote_amount_msat field. Amount in millisatoshis

pub fn commitment_number(&self) -> u64

Method returning copy of BoltChannel::commitment_number field.

pub fn commitment_sigs(&self) -> &Vec<Signature>

Method borrowing BoltChannel::commitment_sigs field.

pub fn policy(&self) -> &Policy

Method borrowing BoltChannel::policy field. The policy for accepting remote node params

pub fn common_params(&self) -> CommonParams

Method returning copy of BoltChannel::common_params field. Common parameters applying for both nodes

pub fn local_params(&self) -> PeerParams

Method returning copy of BoltChannel::local_params field. Channel parameters required to be met by the remote node when operating

pub fn remote_params(&self) -> PeerParams

Method returning copy of BoltChannel::remote_params field. Channel parameters to be used towards the remote node

pub fn local_keys(&self) -> &LocalKeyset

Method borrowing BoltChannel::local_keys field. Set of locally-derived keys for creating channel transactions

pub fn remote_keys(&self) -> &RemoteKeyset

Method borrowing BoltChannel::remote_keys field. Set of remote-derived keys for creating channel transactions

pub fn remote_per_commitment_point(&self) -> &PublicKey

Method borrowing BoltChannel::remote_per_commitment_point field.

pub fn local_per_commitment_point(&self) -> &PublicKey

Method borrowing BoltChannel::local_per_commitment_point field.

pub fn direction(&self) -> Direction

Method returning copy of BoltChannel::direction field. Keeps information about node directionality

impl BoltChannel

pub fn channel_id(&self) -> Option<ChannelId>

Returns ChannelId, if the channel already assigned it

pub fn temp_channel_id(&self) -> Option<TempChannelId>

Before the channel is assigned a final ChannelId returns TempChannelId, and None after

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

Returns ChannelId, if the channel already assigned it – or errors otherwise.

pub fn set_temp_channel_id(&mut self, temp_channel_id: TempChannelId)

Assigns channel a temporary id

pub fn set_inbound(&mut self)

Marks the channel as an inbound

pub fn set_outbound(&mut self)

Marks the channel as an outbound

pub fn set_chain_hash(&mut self, chain_hash: Slice32)

Sets the channel chain hash

pub fn set_policy(&mut self, policy: Policy)

Sets channel policy

pub fn set_common_params(&mut self, params: CommonParams)

Sets common parameters for the chanel

pub fn set_local_params(&mut self, params: PeerParams)

Sets local parameters for the channel

pub fn set_local_keys(&mut self, keys: LocalKeyset)

Sets local keys for the channel

pub fn set_static_remotekey(&mut self, static_remotekey: bool)

Sets static_remotekey flag for the channel

impl BoltChannel

pub fn compose_add_update_htlc( &mut self, amount_msat: u64, payment_hash: HashLock, cltv_expiry: u32, route: Vec<Hop<PaymentOnion>>, ) -> Result<Messages, Error>

Trait Implementations

impl ChannelConstructor<BoltExt> for BoltChannel

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

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 Clone for BoltChannel

fn clone(&self) -> BoltChannel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BoltChannel

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

Formats the value using the given formatter.

impl Default for BoltChannel

fn default() -> Self

Returns the “default value” for a type.

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 PartialEq for BoltChannel

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

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

const 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 StrictDecode for BoltChannel

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 BoltChannel

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>, 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 Eq for BoltChannel

impl StructuralPartialEq for BoltChannel