Enum LightningBalance

pub enum LightningBalance {
    ClaimableOnChannelClose {
        channel_id: ChannelId,
        counterparty_node_id: PublicKey,
        amount_satoshis: u64,
        transaction_fee_satoshis: u64,
        outbound_payment_htlc_rounded_msat: u64,
        outbound_forwarded_htlc_rounded_msat: u64,
        inbound_claiming_htlc_rounded_msat: u64,
        inbound_htlc_rounded_msat: u64,
    },
    ClaimableAwaitingConfirmations {
        channel_id: ChannelId,
        counterparty_node_id: PublicKey,
        amount_satoshis: u64,
        confirmation_height: u32,
        source: BalanceSource,
    },
    ContentiousClaimable {
        channel_id: ChannelId,
        counterparty_node_id: PublicKey,
        amount_satoshis: u64,
        timeout_height: u32,
        payment_hash: PaymentHash,
        payment_preimage: PaymentPreimage,
    },
    MaybeTimeoutClaimableHTLC {
        channel_id: ChannelId,
        counterparty_node_id: PublicKey,
        amount_satoshis: u64,
        claimable_height: u32,
        payment_hash: PaymentHash,
        outbound_payment: bool,
    },
    MaybePreimageClaimableHTLC {
        channel_id: ChannelId,
        counterparty_node_id: PublicKey,
        amount_satoshis: u64,
        expiry_height: u32,
        payment_hash: PaymentHash,
    },
    CounterpartyRevokedOutputClaimable {
        channel_id: ChannelId,
        counterparty_node_id: PublicKey,
        amount_satoshis: u64,
    },
}

Details about the status of a known Lightning balance.

Variants

ClaimableOnChannelClose

The channel is not yet closed (or the commitment or closing transaction has not yet appeared in a block). The given balance is claimable (less on-chain fees) if the channel is force-closed now.

Fields

channel_id: ChannelId

The identifier of the channel this balance belongs to.

counterparty_node_id: PublicKey

The identifier of our channel counterparty.

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 amount_satoshis value.

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

outbound_payment_htlc_rounded_msat: u64

The amount of millisatoshis which has been burned to fees from HTLCs which are outbound from us and are related to a payment which was sent by us. This is the sum of the millisatoshis part of all HTLCs which are otherwise represented by LightningBalance::MaybeTimeoutClaimableHTLC with their LightningBalance::MaybeTimeoutClaimableHTLC::outbound_payment flag set, as well as any dust HTLCs which would otherwise be represented the same.

This amount (rounded up to a whole satoshi value) will not be included in amount_satoshis.

outbound_forwarded_htlc_rounded_msat: u64

The amount of millisatoshis which has been burned to fees from HTLCs which are outbound from us and are related to a forwarded HTLC. This is the sum of the millisatoshis part of all HTLCs which are otherwise represented by LightningBalance::MaybeTimeoutClaimableHTLC with their LightningBalance::MaybeTimeoutClaimableHTLC::outbound_payment flag not set, as well as any dust HTLCs which would otherwise be represented the same.

This amount (rounded up to a whole satoshi value) will not be included in amount_satoshis.

inbound_claiming_htlc_rounded_msat: u64

The amount of millisatoshis which has been burned to fees from HTLCs which are inbound to us and for which we know the preimage. This is the sum of the millisatoshis part of all HTLCs which would be represented by LightningBalance::ContentiousClaimable on channel close, but whose current value is included in amount_satoshis, as well as any dust HTLCs which would otherwise be represented the same.

This amount (rounded up to a whole satoshi value) will not be included in the counterparty’s amount_satoshis.

inbound_htlc_rounded_msat: u64

The amount of millisatoshis which has been burned to fees from HTLCs which are inbound to us and for which we do not know the preimage. This is the sum of the millisatoshis part of all HTLCs which would be represented by LightningBalance::MaybePreimageClaimableHTLC on channel close, as well as any dust HTLCs which would otherwise be represented the same.

This amount (rounded up to a whole satoshi value) will not be included in the counterparty’s amount_satoshis.

ClaimableAwaitingConfirmations

The channel has been closed, and the given balance is ours but awaiting confirmations until we consider it spendable.

Fields

channel_id: ChannelId

The identifier of the channel this balance belongs to.

counterparty_node_id: PublicKey

The identifier of our channel counterparty.

amount_satoshis: u64

The amount available to claim, in satoshis, possibly excluding the on-chain fees which were spent in broadcasting the transaction.

confirmation_height: u32

The height at which an Event::SpendableOutputs event will be generated for this amount.

source: BalanceSource

Whether this balance is a result of cooperative close, a force-close, or an HTLC.

ContentiousClaimable

The channel has been closed, and the given balance should be ours but awaiting spending transaction confirmation. If the spending transaction does not confirm in time, it is possible our counterparty can take the funds by broadcasting an HTLC timeout on-chain.

Once the spending transaction confirms, before it has reached enough confirmations to be considered safe from chain reorganizations, the balance will instead be provided via LightningBalance::ClaimableAwaitingConfirmations.

Fields

channel_id: ChannelId

The identifier of the channel this balance belongs to.

counterparty_node_id: PublicKey

The identifier of our channel counterparty.

amount_satoshis: u64

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

timeout_height: u32

The height at which the counterparty may be able to claim the balance if we have not done so.

payment_hash: PaymentHash

The payment hash that locks this HTLC.

payment_preimage: PaymentPreimage

The preimage that can be used to claim this HTLC.

MaybeTimeoutClaimableHTLC

HTLCs which we sent to our counterparty which are claimable after a timeout (less on-chain fees) if the counterparty does not know the preimage for the HTLCs. These are somewhat likely to be claimed by our counterparty before we do.

Fields

channel_id: ChannelId

The identifier of the channel this balance belongs to.

counterparty_node_id: PublicKey

The identifier of our channel counterparty.

amount_satoshis: u64

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

claimable_height: u32

The height at which we will be able to claim the balance if our counterparty has not done so.

payment_hash: PaymentHash

The payment hash whose preimage our counterparty needs to claim this HTLC.

outbound_payment: bool

Indicates whether this HTLC represents a payment which was sent outbound from us.

MaybePreimageClaimableHTLC

HTLCs which we received from our counterparty which are claimable with a preimage which we do not currently have. This will only be claimable if we receive the preimage from the node to which we forwarded this HTLC before the timeout.

Fields

channel_id: ChannelId

The identifier of the channel this balance belongs to.

counterparty_node_id: PublicKey

The identifier of our channel counterparty.

amount_satoshis: u64

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

expiry_height: u32

The height at which our counterparty will be able to claim the balance if we have not yet received the preimage and claimed it ourselves.

payment_hash: PaymentHash

The payment hash whose preimage we need to claim this HTLC.

CounterpartyRevokedOutputClaimable

The channel has been closed, and our counterparty broadcasted a revoked commitment transaction.

Thus, we’re able to claim all outputs in the commitment transaction, one of which has the following amount.

Fields

channel_id: ChannelId

The identifier of the channel this balance belongs to.

counterparty_node_id: PublicKey

The identifier of our channel counterparty.

amount_satoshis: u64

The amount, in satoshis, of the output which we can claim.

Trait Implementations

impl Clone for LightningBalance

fn clone(&self) -> LightningBalance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LightningBalance

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

Formats the value using the given formatter.