Struct ldk_node::ChannelDetails

pub struct ChannelDetails {

    pub channel_id: ChannelId,
    pub counterparty_node_id: PublicKey,
    pub funding_txo: Option<OutPoint>,
    pub channel_value_satoshis: u64,
    pub unspendable_punishment_reserve: Option<u64>,
    pub user_channel_id: UserChannelId,
    pub feerate_sat_per_1000_weight: u32,
    pub balance_msat: u64,
    pub outbound_capacity_msat: u64,
    pub inbound_capacity_msat: u64,
    pub confirmations_required: Option<u32>,
    pub confirmations: Option<u32>,
    pub is_outbound: bool,
    pub is_channel_ready: bool,
    pub is_usable: bool,
    pub is_public: bool,
    pub cltv_expiry_delta: Option<u16>,
}

Details of a channel as returned by Node::list_channels.

Fields

channel_id: ChannelId

The channel’s ID (prior to funding transaction generation, this is a random 32 bytes, thereafter this is the transaction ID of the funding transaction XOR the funding transaction output).

Note that this means this value is not persistent - it can change once during the lifetime of the channel.

counterparty_node_id: PublicKey

The node_id of our channel’s counterparty.

funding_txo: Option<OutPoint>

The channel’s funding transaction output, if we’ve negotiated the funding transaction with our counterparty already.

channel_value_satoshis: u64

The value, in satoshis, of this channel as appears in the funding output.

unspendable_punishment_reserve: Option<u64>

The value, in satoshis, that must always be held in the channel for us. This value ensures that if we broadcast a revoked state, our counterparty can punish us by claiming at least this value on chain.

This value is not included in outbound_capacity_msat as it can never be spent.

This value will be None for outbound channels until the counterparty accepts the channel.

user_channel_id: UserChannelId

The local user_channel_id of this channel.

feerate_sat_per_1000_weight: u32

The currently negotiated fee rate denominated in satoshi per 1000 weight units, which is applied to commitment and HTLC transactions.

balance_msat: u64

Total balance of the channel. This is the amount that will be returned to the user if the channel is closed.

The value is not exact, due to potential in-flight and fee-rate changes. Therefore, exactly this amount is likely irrecoverable on close.

outbound_capacity_msat: u64

Available outbound capacity for sending HTLCs to the remote peer.

The amount does not include any pending HTLCs which are not yet resolved (and, thus, whose balance is not available for inclusion in new outbound HTLCs). This further does not include any pending outgoing HTLCs which are awaiting some other resolution to be sent.

inbound_capacity_msat: u64

Available outbound capacity for sending HTLCs to the remote peer.

The amount does not include any pending HTLCs which are not yet resolved (and, thus, whose balance is not available for inclusion in new inbound HTLCs). This further does not include any pending outgoing HTLCs which are awaiting some other resolution to be sent.

confirmations_required: Option<u32>

The number of required confirmations on the funding transactions before the funding is considered “locked”. The amount is selected by the channel fundee.

The value will be None for outbound channels until the counterparty accepts the channel.

confirmations: Option<u32>

The current number of confirmations on the funding transaction.

is_outbound: bool

Returns true if the channel was initiated (and therefore funded) by us.

is_channel_ready: bool

Returns true if the channel is confirmed, both parties have exchanged channel_ready messages, and the channel is not currently being shut down. Both parties exchange channel_ready messages upon independently verifying that the required confirmations count provided by confirmations_required has been reached.

is_usable: bool

Returns true if the channel is (a) confirmed and channel_ready has been exchanged, (b) the peer is connected, and (c) the channel is not currently negotiating shutdown.

This is a strict superset of is_channel_ready.

is_public: bool

Returns true if this channel is (or will be) publicly-announced

cltv_expiry_delta: Option<u16>

The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over the channel.

Trait Implementations

impl Clone for ChannelDetails

fn clone(&self) -> ChannelDetails

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelDetails

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

Formats the value using the given formatter.

impl From<ChannelDetails> for ChannelDetails

fn from(value: LdkChannelDetails) -> Self

Converts to this type from the input type.

impl PartialEq<ChannelDetails> for ChannelDetails

fn eq(&self, other: &ChannelDetails) -> 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 Eq for ChannelDetails

impl StructuralEq for ChannelDetails

impl StructuralPartialEq for ChannelDetails