Package org.ldk.structs

Class Balance

java.lang.Object

org.ldk.structs.Balance

Direct Known Subclasses:

Balance.ClaimableAwaitingConfirmations, Balance.ClaimableOnChannelClose, Balance.ContentiousClaimable, Balance.MaybeClaimableHTLCAwaitingTimeout

public class Balance
extends Object

Details about the balance(s) available for spending once the channel appears on chain. See [`ChannelMonitor::get_claimable_balances`] for more details on when these will or will not be provided.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Balance.ClaimableAwaitingConfirmations	The channel has been closed, and the given balance is ours but awaiting confirmations until we consider it spendable.
static class	Balance.ClaimableOnChannelClose	The channel is not yet closed (or the commitment or closing transaction has not yet appeared in a block).
static class	Balance.ContentiousClaimable	The channel has been closed, and the given balance should be ours but awaiting spending transaction confirmation.
static class	Balance.MaybeClaimableHTLCAwaitingTimeout	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.

Method Summary

Modifier and Type	Method	Description
static Balance	claimable_awaiting_confirmations(long claimable_amount_satoshis, int confirmation_height)	Utility method to constructs a new ClaimableAwaitingConfirmations-variant Balance
static Balance	claimable_on_channel_close(long claimable_amount_satoshis)	Utility method to constructs a new ClaimableOnChannelClose-variant Balance
Balance	clone()	Creates a copy of the Balance
static Balance	contentious_claimable(long claimable_amount_satoshis, int timeout_height)	Utility method to constructs a new ContentiousClaimable-variant Balance
boolean	eq(Balance b)	Checks if two Balances contain equal inner contents.
boolean	equals(Object o)
protected void	finalize()
static Balance	maybe_claimable_htlcawaiting_timeout(long claimable_amount_satoshis, int claimable_height)	Utility method to constructs a new MaybeClaimableHTLCAwaitingTimeout-variant Balance

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

clone

public Balance clone()

Creates a copy of the Balance

Overrides:

clone in class Object

claimable_on_channel_close

public static Balance claimable_on_channel_close(long claimable_amount_satoshis)

Utility method to constructs a new ClaimableOnChannelClose-variant Balance

claimable_awaiting_confirmations

public static Balance claimable_awaiting_confirmations(long claimable_amount_satoshis,
                                                       int confirmation_height)

Utility method to constructs a new ClaimableAwaitingConfirmations-variant Balance

contentious_claimable

public static Balance contentious_claimable(long claimable_amount_satoshis,
                                            int timeout_height)

Utility method to constructs a new ContentiousClaimable-variant Balance

maybe_claimable_htlcawaiting_timeout

public static Balance maybe_claimable_htlcawaiting_timeout(long claimable_amount_satoshis,
                                                           int claimable_height)

Utility method to constructs a new MaybeClaimableHTLCAwaitingTimeout-variant Balance

eq

public boolean eq(Balance b)

Checks if two Balances contain equal inner contents. This ignores pointers and is_owned flags and looks at the values in fields.

equals

public boolean equals(Object o)

Overrides:

equals in class Object