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.

Nested Class Summary

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

Event.ChannelClosed, Event.DiscardFunding, Event.FundingGenerationReady, Event.HTLCHandlingFailed, Event.OpenChannelRequest, Event.PaymentClaimed, Event.PaymentFailed, Event.PaymentForwarded, Event.PaymentPathFailed, Event.PaymentPathSuccessful, Event.PaymentReceived, Event.PaymentSent, Event.PendingHTLCsForwardable, Event.ProbeFailed, Event.ProbeSuccessful, Event.SpendableOutputs

Field Summary

Fields

Modifier and Type	Field	Description
byte[]	channel_id	The channel_id of the channel which has been closed.
ClosureReason	reason	The reason the channel was closed.
long	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

channel_closed, clone, discard_funding, finalize, funding_generation_ready, htlchandling_failed, open_channel_request, payment_claimed, payment_failed, payment_forwarded, payment_path_failed, payment_path_successful, payment_received, payment_sent, pending_htlcs_forwardable, probe_failed, probe_successful, spendable_outputs, write

Methods inherited from class java.lang.Object

equals, 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 long 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 0 for an inbound channel. This 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.