Package org.ldk.enums

Enum ChannelShutdownState

java.lang.Object

java.lang.Enum<ChannelShutdownState>

org.ldk.enums.ChannelShutdownState

All Implemented Interfaces:

Serializable, Comparable<ChannelShutdownState>

public enum ChannelShutdownState
extends Enum<ChannelShutdownState>

Further information on the details of the channel shutdown. Upon channels being forced closed (i.e. commitment transaction confirmation detected by `ChainMonitor`), ChannelShutdownState will be set to `ShutdownComplete` or the channel will be removed shortly. Also note, that in normal operation, peers could disconnect at any of these states and require peer re-connection before making progress onto other states

Enum Constant Summary

Enum Constants

Enum Constant	Description
LDKChannelShutdownState_NegotiatingClosingFee	All HTLCs have been resolved, nodes are currently negotiating channel close onchain fee rates.
LDKChannelShutdownState_NotShuttingDown	Channel has not sent or received a shutdown message.
LDKChannelShutdownState_ResolvingHTLCs	Shutdown message exchanges have concluded and the channels are in the midst of resolving all existing open HTLCs before closing can continue.
LDKChannelShutdownState_ShutdownComplete	We've successfully negotiated a closing_signed dance.
LDKChannelShutdownState_ShutdownInitiated	Local node has sent a shutdown message for this channel.

Method Summary

Modifier and Type	Method	Description
static ChannelShutdownState	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ChannelShutdownState[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LDKChannelShutdownState_NotShuttingDown

public static final ChannelShutdownState LDKChannelShutdownState_NotShuttingDown

Channel has not sent or received a shutdown message.

LDKChannelShutdownState_ShutdownInitiated

public static final ChannelShutdownState LDKChannelShutdownState_ShutdownInitiated

Local node has sent a shutdown message for this channel.

LDKChannelShutdownState_ResolvingHTLCs

public static final ChannelShutdownState LDKChannelShutdownState_ResolvingHTLCs

Shutdown message exchanges have concluded and the channels are in the midst of resolving all existing open HTLCs before closing can continue.

LDKChannelShutdownState_NegotiatingClosingFee

public static final ChannelShutdownState LDKChannelShutdownState_NegotiatingClosingFee

All HTLCs have been resolved, nodes are currently negotiating channel close onchain fee rates.

LDKChannelShutdownState_ShutdownComplete

public static final ChannelShutdownState LDKChannelShutdownState_ShutdownComplete

We've successfully negotiated a closing_signed dance. At this point `ChannelManager` is about to drop the channel.

Method Detail

values

public static ChannelShutdownState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ChannelShutdownState c : ChannelShutdownState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ChannelShutdownState valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null