org.lightningj.lnd.proto

Class LightningApi.CloseChannelRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.lightningj.lnd.proto.LightningApi.CloseChannelRequest

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, LightningApi.CloseChannelRequestOrBuilder

Enclosing class:

LightningApi

public static final class LightningApi.CloseChannelRequest
extends com.google.protobuf.GeneratedMessageV3
implements LightningApi.CloseChannelRequestOrBuilder

Protobuf type lnrpc.CloseChannelRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LightningApi.CloseChannelRequest.Builder Protobuf type lnrpc.CloseChannelRequest

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHANNEL_POINT_FIELD_NUMBER
static int	DELIVERY_ADDRESS_FIELD_NUMBER
static int	FORCE_FIELD_NUMBER
static int	MAX_FEE_PER_VBYTE_FIELD_NUMBER
static int	SAT_PER_BYTE_FIELD_NUMBER
static int	SAT_PER_VBYTE_FIELD_NUMBER
static int	TARGET_CONF_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
LightningApi.ChannelPoint	getChannelPoint() The outpoint (txid:index) of the funding transaction.
LightningApi.ChannelPointOrBuilder	getChannelPointOrBuilder() The outpoint (txid:index) of the funding transaction.
static LightningApi.CloseChannelRequest	getDefaultInstance()
LightningApi.CloseChannelRequest	getDefaultInstanceForType()
java.lang.String	getDeliveryAddress() An optional address to send funds to in the case of a cooperative close.
com.google.protobuf.ByteString	getDeliveryAddressBytes() An optional address to send funds to in the case of a cooperative close.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getForce() If true, then the channel will be closed forcibly.
long	getMaxFeePerVbyte() The maximum fee rate the closer is willing to pay.
com.google.protobuf.Parser<LightningApi.CloseChannelRequest>	getParserForType()
long	getSatPerByte() Deprecated. lnrpc.CloseChannelRequest.sat_per_byte is deprecated. See lightning.api.proto;l=2018
long	getSatPerVbyte() A manual fee rate set in sat/vbyte that should be used when crafting the closure transaction.
int	getSerializedSize()
int	getTargetConf() The target number of blocks that the closure transaction should be confirmed by.
boolean	hasChannelPoint() The outpoint (txid:index) of the funding transaction.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static LightningApi.CloseChannelRequest.Builder	newBuilder()
static LightningApi.CloseChannelRequest.Builder	newBuilder(LightningApi.CloseChannelRequest prototype)
LightningApi.CloseChannelRequest.Builder	newBuilderForType()
protected LightningApi.CloseChannelRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static LightningApi.CloseChannelRequest	parseDelimitedFrom(java.io.InputStream input)
static LightningApi.CloseChannelRequest	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.CloseChannelRequest	parseFrom(byte[] data)
static LightningApi.CloseChannelRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.CloseChannelRequest	parseFrom(java.nio.ByteBuffer data)
static LightningApi.CloseChannelRequest	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.CloseChannelRequest	parseFrom(com.google.protobuf.ByteString data)
static LightningApi.CloseChannelRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.CloseChannelRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static LightningApi.CloseChannelRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.CloseChannelRequest	parseFrom(java.io.InputStream input)
static LightningApi.CloseChannelRequest	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<LightningApi.CloseChannelRequest>	parser()
LightningApi.CloseChannelRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

CHANNEL_POINT_FIELD_NUMBER

public static final int CHANNEL_POINT_FIELD_NUMBER

See Also:

Constant Field Values

FORCE_FIELD_NUMBER

public static final int FORCE_FIELD_NUMBER

See Also:

Constant Field Values

TARGET_CONF_FIELD_NUMBER

public static final int TARGET_CONF_FIELD_NUMBER

See Also:

Constant Field Values

SAT_PER_BYTE_FIELD_NUMBER

public static final int SAT_PER_BYTE_FIELD_NUMBER

See Also:

Constant Field Values

DELIVERY_ADDRESS_FIELD_NUMBER

public static final int DELIVERY_ADDRESS_FIELD_NUMBER

See Also:

Constant Field Values

SAT_PER_VBYTE_FIELD_NUMBER

public static final int SAT_PER_VBYTE_FIELD_NUMBER

See Also:

Constant Field Values

MAX_FEE_PER_VBYTE_FIELD_NUMBER

public static final int MAX_FEE_PER_VBYTE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasChannelPoint

public boolean hasChannelPoint()

The outpoint (txid:index) of the funding transaction. With this value, Bob
will be able to generate a signature for Alice's version of the commitment
transaction.
 

.lnrpc.ChannelPoint channel_point = 1;

Specified by:

hasChannelPoint in interface LightningApi.CloseChannelRequestOrBuilder

Returns:

Whether the channelPoint field is set.

getChannelPoint

public LightningApi.ChannelPoint getChannelPoint()

The outpoint (txid:index) of the funding transaction. With this value, Bob
will be able to generate a signature for Alice's version of the commitment
transaction.
 

.lnrpc.ChannelPoint channel_point = 1;

Specified by:

getChannelPoint in interface LightningApi.CloseChannelRequestOrBuilder

Returns:

The channelPoint.

getChannelPointOrBuilder

public LightningApi.ChannelPointOrBuilder getChannelPointOrBuilder()

The outpoint (txid:index) of the funding transaction. With this value, Bob
will be able to generate a signature for Alice's version of the commitment
transaction.
 

.lnrpc.ChannelPoint channel_point = 1;

Specified by:

getChannelPointOrBuilder in interface LightningApi.CloseChannelRequestOrBuilder

getForce

public boolean getForce()

 If true, then the channel will be closed forcibly. This means the
 current commitment transaction will be signed and broadcast.
 

bool force = 2;

Specified by:

getForce in interface LightningApi.CloseChannelRequestOrBuilder

Returns:

The force.

getTargetConf

public int getTargetConf()

 The target number of blocks that the closure transaction should be
 confirmed by.
 

int32 target_conf = 3;

Specified by:

getTargetConf in interface LightningApi.CloseChannelRequestOrBuilder

Returns:

The targetConf.

getSatPerByte

@Deprecated
public long getSatPerByte()

Deprecated. lnrpc.CloseChannelRequest.sat_per_byte is deprecated. See lightning.api.proto;l=2018

 Deprecated, use sat_per_vbyte.
 A manual fee rate set in sat/vbyte that should be used when crafting the
 closure transaction.
 

int64 sat_per_byte = 4 [deprecated = true];

Specified by:

getSatPerByte in interface LightningApi.CloseChannelRequestOrBuilder

Returns:

The satPerByte.

getDeliveryAddress

public java.lang.String getDeliveryAddress()

An optional address to send funds to in the case of a cooperative close.
If the channel was opened with an upfront shutdown script and this field
is set, the request to close will fail because the channel must pay out
to the upfront shutdown addresss.
 

string delivery_address = 5;

Specified by:

getDeliveryAddress in interface LightningApi.CloseChannelRequestOrBuilder

Returns:

The deliveryAddress.

getDeliveryAddressBytes

public com.google.protobuf.ByteString getDeliveryAddressBytes()

An optional address to send funds to in the case of a cooperative close.
If the channel was opened with an upfront shutdown script and this field
is set, the request to close will fail because the channel must pay out
to the upfront shutdown addresss.
 

string delivery_address = 5;

Specified by:

getDeliveryAddressBytes in interface LightningApi.CloseChannelRequestOrBuilder

Returns:

The bytes for deliveryAddress.

getSatPerVbyte

public long getSatPerVbyte()

 A manual fee rate set in sat/vbyte that should be used when crafting the
 closure transaction.
 

uint64 sat_per_vbyte = 6;

Specified by:

getSatPerVbyte in interface LightningApi.CloseChannelRequestOrBuilder

Returns:

The satPerVbyte.

getMaxFeePerVbyte

public long getMaxFeePerVbyte()

 The maximum fee rate the closer is willing to pay.

 NOTE: This field is only respected if we're the initiator of the channel.
 

uint64 max_fee_per_vbyte = 7;

Specified by:

getMaxFeePerVbyte in interface LightningApi.CloseChannelRequestOrBuilder

Returns:

The maxFeePerVbyte.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static LightningApi.CloseChannelRequest parseFrom(java.nio.ByteBuffer data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.CloseChannelRequest parseFrom(java.nio.ByteBuffer data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.CloseChannelRequest parseFrom(com.google.protobuf.ByteString data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.CloseChannelRequest parseFrom(com.google.protobuf.ByteString data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.CloseChannelRequest parseFrom(byte[] data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.CloseChannelRequest parseFrom(byte[] data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.CloseChannelRequest parseFrom(java.io.InputStream input)
                                                  throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static LightningApi.CloseChannelRequest parseFrom(java.io.InputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static LightningApi.CloseChannelRequest parseDelimitedFrom(java.io.InputStream input)
                                                           throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static LightningApi.CloseChannelRequest parseDelimitedFrom(java.io.InputStream input,
                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static LightningApi.CloseChannelRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                                  throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static LightningApi.CloseChannelRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public LightningApi.CloseChannelRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static LightningApi.CloseChannelRequest.Builder newBuilder()

newBuilder

public static LightningApi.CloseChannelRequest.Builder newBuilder(LightningApi.CloseChannelRequest prototype)

toBuilder

public LightningApi.CloseChannelRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected LightningApi.CloseChannelRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static LightningApi.CloseChannelRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<LightningApi.CloseChannelRequest> parser()

getParserForType

public com.google.protobuf.Parser<LightningApi.CloseChannelRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public LightningApi.CloseChannelRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder