Package org.ldk.structs

Class Event.ChannelClosed

java.lang.Object

org.ldk.structs.Event

org.ldk.structs.Event.ChannelClosed

Enclosing class:

Event

public static final class Event.ChannelClosed
extends Event

Used to indicate that a previously opened channel with the given `channel_id` is in the process of closure. Note that this event is only triggered for accepted channels: if the [`UserConfig::manually_accept_inbound_channels`] config flag is set to true and the channel is rejected, no `ChannelClosed` event will be sent. [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels

Nested Class Summary

Nested classes/interfaces inherited from class org.ldk.structs.Event

Event.BumpTransaction, Event.ChannelClosed, Event.ChannelPending, Event.ChannelReady, Event.DiscardFunding, Event.FundingGenerationReady, Event.HTLCHandlingFailed, Event.HTLCIntercepted, Event.OpenChannelRequest, Event.PaymentClaimable, Event.PaymentClaimed, Event.PaymentFailed, Event.PaymentForwarded, Event.PaymentPathFailed, Event.PaymentPathSuccessful, Event.PaymentSent, Event.PendingHTLCsForwardable, Event.ProbeFailed, Event.ProbeSuccessful, Event.SpendableOutputs

Field Summary

Fields

Modifier and Type	Field	Description
Option_u64Z	channel_capacity_sats	Channel capacity of the closing channel (sats).
byte[]	channel_id	The `channel_id` of the channel which has been closed.
byte[]	counterparty_node_id	Counterparty in the closed channel.
ClosureReason	reason	The reason the channel was closed.
UInt128	user_channel_id	The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if [`UserConfig::manually_accept_inbound_channels`] config flag is set to true.

Method Summary

Methods inherited from class org.ldk.structs.Event

bump_transaction, channel_closed, channel_pending, channel_ready, clone, discard_funding, eq, equals, finalize, funding_generation_ready, htlchandling_failed, htlcintercepted, open_channel_request, payment_claimable, payment_claimed, payment_failed, payment_forwarded, payment_path_failed, payment_path_successful, payment_sent, pending_htlcs_forwardable, probe_failed, probe_successful, spendable_outputs, write

Methods inherited from class java.lang.Object

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

Field Detail

channel_id

public final byte[] channel_id

The `channel_id` of the channel which has been closed. Note that on-chain transactions resolving the channel are likely still awaiting confirmation.

user_channel_id

public final UInt128 user_channel_id

The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise `user_channel_id` will be randomized for inbound channels. This may be zero for inbound channels serialized prior to 0.0.113 and will always be zero for objects serialized with LDK versions prior to 0.0.102. [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels

reason

public final ClosureReason reason

The reason the channel was closed.

counterparty_node_id

@Nullable
public final byte[] counterparty_node_id

Counterparty in the closed channel. This field will be `None` for objects serialized prior to LDK 0.0.117. Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None

channel_capacity_sats

public final Option_u64Z channel_capacity_sats

Channel capacity of the closing channel (sats). This field will be `None` for objects serialized prior to LDK 0.0.117.