public static enum LightningApi.CommitmentType extends java.lang.Enum<LightningApi.CommitmentType> implements com.google.protobuf.ProtocolMessageEnum
lnrpc.CommitmentType
Enum Constant and Description |
---|
ANCHORS
A channel that uses a commitment format that has anchor outputs on the
commitments, allowing fee bumping after a force close transaction has
been broadcast.
|
LEGACY
A channel using the legacy commitment format having tweaked to_remote
keys.
|
SCRIPT_ENFORCED_LEASE
A channel that uses a commitment type that builds upon the anchors
commitment format, but in addition requires a CLTV clause to spend outputs
paying to the channel initiator.
|
SIMPLE_TAPROOT
TODO(roasbeef): need script enforce mirror type for the above as well?
|
STATIC_REMOTE_KEY
A channel that uses the modern commitment format where the key in the
output of the remote party does not change each state.
|
UNKNOWN_COMMITMENT_TYPE
Returned when the commitment type isn't known or unavailable.
|
UNRECOGNIZED |
Modifier and Type | Field and Description |
---|---|
static int |
ANCHORS_VALUE
A channel that uses a commitment format that has anchor outputs on the
commitments, allowing fee bumping after a force close transaction has
been broadcast.
|
static int |
LEGACY_VALUE
A channel using the legacy commitment format having tweaked to_remote
keys.
|
static int |
SCRIPT_ENFORCED_LEASE_VALUE
A channel that uses a commitment type that builds upon the anchors
commitment format, but in addition requires a CLTV clause to spend outputs
paying to the channel initiator.
|
static int |
SIMPLE_TAPROOT_VALUE
TODO(roasbeef): need script enforce mirror type for the above as well?
|
static int |
STATIC_REMOTE_KEY_VALUE
A channel that uses the modern commitment format where the key in the
output of the remote party does not change each state.
|
static int |
UNKNOWN_COMMITMENT_TYPE_VALUE
Returned when the commitment type isn't known or unavailable.
|
Modifier and Type | Method and Description |
---|---|
static LightningApi.CommitmentType |
forNumber(int value) |
static com.google.protobuf.Descriptors.EnumDescriptor |
getDescriptor() |
com.google.protobuf.Descriptors.EnumDescriptor |
getDescriptorForType() |
int |
getNumber() |
com.google.protobuf.Descriptors.EnumValueDescriptor |
getValueDescriptor() |
static com.google.protobuf.Internal.EnumLiteMap<LightningApi.CommitmentType> |
internalGetValueMap() |
static LightningApi.CommitmentType |
valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) |
static LightningApi.CommitmentType |
valueOf(int value)
Deprecated.
Use
forNumber(int) instead. |
static LightningApi.CommitmentType |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static LightningApi.CommitmentType[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final LightningApi.CommitmentType UNKNOWN_COMMITMENT_TYPE
Returned when the commitment type isn't known or unavailable.
UNKNOWN_COMMITMENT_TYPE = 0;
public static final LightningApi.CommitmentType LEGACY
A channel using the legacy commitment format having tweaked to_remote keys.
LEGACY = 1;
public static final LightningApi.CommitmentType STATIC_REMOTE_KEY
A channel that uses the modern commitment format where the key in the output of the remote party does not change each state. This makes back up and recovery easier as when the channel is closed, the funds go directly to that key.
STATIC_REMOTE_KEY = 2;
public static final LightningApi.CommitmentType ANCHORS
A channel that uses a commitment format that has anchor outputs on the commitments, allowing fee bumping after a force close transaction has been broadcast.
ANCHORS = 3;
public static final LightningApi.CommitmentType SCRIPT_ENFORCED_LEASE
A channel that uses a commitment type that builds upon the anchors commitment format, but in addition requires a CLTV clause to spend outputs paying to the channel initiator. This is intended for use on leased channels to guarantee that the channel initiator has no incentives to close a leased channel before its maturity date.
SCRIPT_ENFORCED_LEASE = 4;
public static final LightningApi.CommitmentType SIMPLE_TAPROOT
TODO(roasbeef): need script enforce mirror type for the above as well?
SIMPLE_TAPROOT = 5;
public static final LightningApi.CommitmentType UNRECOGNIZED
public static final int UNKNOWN_COMMITMENT_TYPE_VALUE
Returned when the commitment type isn't known or unavailable.
UNKNOWN_COMMITMENT_TYPE = 0;
public static final int LEGACY_VALUE
A channel using the legacy commitment format having tweaked to_remote keys.
LEGACY = 1;
public static final int STATIC_REMOTE_KEY_VALUE
A channel that uses the modern commitment format where the key in the output of the remote party does not change each state. This makes back up and recovery easier as when the channel is closed, the funds go directly to that key.
STATIC_REMOTE_KEY = 2;
public static final int ANCHORS_VALUE
A channel that uses a commitment format that has anchor outputs on the commitments, allowing fee bumping after a force close transaction has been broadcast.
ANCHORS = 3;
public static final int SCRIPT_ENFORCED_LEASE_VALUE
A channel that uses a commitment type that builds upon the anchors commitment format, but in addition requires a CLTV clause to spend outputs paying to the channel initiator. This is intended for use on leased channels to guarantee that the channel initiator has no incentives to close a leased channel before its maturity date.
SCRIPT_ENFORCED_LEASE = 4;
public static final int SIMPLE_TAPROOT_VALUE
TODO(roasbeef): need script enforce mirror type for the above as well?
SIMPLE_TAPROOT = 5;
public static LightningApi.CommitmentType[] values()
for (LightningApi.CommitmentType c : LightningApi.CommitmentType.values()) System.out.println(c);
public static LightningApi.CommitmentType valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic final int getNumber()
getNumber
in interface com.google.protobuf.Internal.EnumLite
getNumber
in interface com.google.protobuf.ProtocolMessageEnum
@Deprecated public static LightningApi.CommitmentType valueOf(int value)
forNumber(int)
instead.value
- The numeric wire value of the corresponding enum entry.public static LightningApi.CommitmentType forNumber(int value)
value
- The numeric wire value of the corresponding enum entry.public static com.google.protobuf.Internal.EnumLiteMap<LightningApi.CommitmentType> internalGetValueMap()
public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
getValueDescriptor
in interface com.google.protobuf.ProtocolMessageEnum
public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
getDescriptorForType
in interface com.google.protobuf.ProtocolMessageEnum
public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()
public static LightningApi.CommitmentType valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)