Struct HolderCommitmentTransactionBalance

pub struct HolderCommitmentTransactionBalance {
    pub amount_satoshis: u64,
    pub transaction_fee_satoshis: u64,
}

The claimable balance of a holder commitment transaction that has yet to be broadcast.

Fields

amount_satoshis: u64

The amount available to claim, in satoshis, excluding the on-chain fees which will be required to do so.

transaction_fee_satoshis: u64

The transaction fee we pay for the closing commitment transaction. This amount is not included in the HolderCommitmentTransactionBalance::amount_satoshis value. This amount includes the sum of dust HTLCs on the commitment transaction, any elided anchors, as well as the sum of msat amounts rounded down from non-dust HTLCs.

Note that if this channel is inbound (and thus our counterparty pays the commitment transaction fee) this value will be zero. For ChannelMonitors created prior to LDK 0.0.124, the channel is always treated as outbound (and thus this value is never zero).

Trait Implementations

impl Clone for HolderCommitmentTransactionBalance

fn clone(&self) -> HolderCommitmentTransactionBalance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HolderCommitmentTransactionBalance

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

Formats the value using the given formatter.

impl PartialEq for HolderCommitmentTransactionBalance

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

impl StructuralPartialEq for HolderCommitmentTransactionBalance