Struct ChannelBalance

pub struct ChannelBalance {
    pub claimable: u64,
    pub received_htlc: u64,
    pub offered_htlc: u64,
    pub sweeping: u64,
    pub stub_count: u32,
    pub unconfirmed_count: u32,
    pub channel_count: u32,
    pub closing_count: u32,
    pub received_htlc_count: u32,
    pub offered_htlc_count: u32,
}

Balances associated with a channel See: https://gitlab.com/lightning-signer/docs/-/wikis/Proposed-L1-and-Channel-Balance-Reconciliation

All channels that VLS knows about are in one of the four categories:

1. channel stubs: assigned channelid and can generate points, keys, …
2. unconfirmed channels: negotiated channels prior to channel_ready
3. channels: active channels in their normal operating mode
4. closing channels: closed channels being swept or aged prior to pruning

Fields

claimable: u64

Claimable balance on open channel

received_htlc: u64

Sum of htlcs offered to us

offered_htlc: u64

Sum of htlcs we offered

sweeping: u64

Sweeping to wallet

stub_count: u32

Current number of channel stubs

unconfirmed_count: u32

Current number of unconfirmed channels

channel_count: u32

Current number of active channels

closing_count: u32

Current number of closing channels

received_htlc_count: u32

Current number of received htlcs

offered_htlc_count: u32

Current number of offered htlcs

Implementations

impl ChannelBalance

pub fn new( claimable: u64, received_htlc: u64, offered_htlc: u64, sweeping: u64, stub_count: u32, unconfirmed_count: u32, channel_count: u32, closing_count: u32, received_htlc_count: u32, offered_htlc_count: u32, ) -> ChannelBalance

Create a ChannelBalance with specific values

pub fn zero() -> ChannelBalance

Create a ChannelBalance with zero values

pub fn stub() -> ChannelBalance

Create a ChannelBalance for a stub

pub fn accumulate(&mut self, other: &ChannelBalance)

Sum channel balances

Trait Implementations

impl Debug for ChannelBalance

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

Formats the value using the given formatter.

impl PartialEq for ChannelBalance

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