org.lightningj.lnd.proto

Interface LightningApi.CloseChannelRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

LightningApi.CloseChannelRequest, LightningApi.CloseChannelRequest.Builder

Enclosing class:

LightningApi

public static interface LightningApi.CloseChannelRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
LightningApi.ChannelPoint	getChannelPoint() The outpoint (txid:index) of the funding transaction.
LightningApi.ChannelPointOrBuilder	getChannelPointOrBuilder() The outpoint (txid:index) of the funding transaction.
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.
boolean	getForce() If true, then the channel will be closed forcibly.
long	getMaxFeePerVbyte() The maximum fee rate the closer is willing to pay.
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	getTargetConf() The target number of blocks that the closure transaction should be confirmed by.
boolean	hasChannelPoint() The outpoint (txid:index) of the funding transaction.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasChannelPoint

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;

Returns:

Whether the channelPoint field is set.

getChannelPoint

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;

Returns:

The channelPoint.

getChannelPointOrBuilder

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;

getForce

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;

Returns:

The force.

getTargetConf

int getTargetConf()

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

int32 target_conf = 3;

Returns:

The targetConf.

getSatPerByte

@Deprecated
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];

Returns:

The satPerByte.

getDeliveryAddress

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;

Returns:

The deliveryAddress.

getDeliveryAddressBytes

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;

Returns:

The bytes for deliveryAddress.

getSatPerVbyte

long getSatPerVbyte()

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

uint64 sat_per_vbyte = 6;

Returns:

The satPerVbyte.

getMaxFeePerVbyte

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;

Returns:

The maxFeePerVbyte.