org.lightningj.lnd.proto

Interface LightningApi.OpenChannelRequestOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

LightningApi.OpenChannelRequest, LightningApi.OpenChannelRequest.Builder

Enclosing class:

LightningApi

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCloseAddress() Close address is an optional address which specifies the address to which funds should be paid out to upon cooperative close.
com.google.protobuf.ByteString	getCloseAddressBytes() Close address is an optional address which specifies the address to which funds should be paid out to upon cooperative close.
LightningApi.FundingShim	getFundingShim() Funding shims are an optional argument that allow the caller to intercept certain funding functionality.
LightningApi.FundingShimOrBuilder	getFundingShimOrBuilder() Funding shims are an optional argument that allow the caller to intercept certain funding functionality.
long	getLocalFundingAmount() The number of satoshis the wallet should commit to the channel
int	getMaxLocalCsv() Max local csv is the maximum csv delay we will allow for our own commitment transaction.
int	getMinConfs() The minimum number of confirmations each one of your outputs used for the funding transaction must satisfy.
long	getMinHtlcMsat() The minimum value in millisatoshi we will require for incoming HTLCs on the channel.
com.google.protobuf.ByteString	getNodePubkey() The pubkey of the node to open a channel with.
java.lang.String	getNodePubkeyString() Deprecated.
com.google.protobuf.ByteString	getNodePubkeyStringBytes() Deprecated.
boolean	getPrivate() Whether this channel should be private, not announced to the greater network.
long	getPushSat() The number of satoshis to push to the remote side as part of the initial commitment state
int	getRemoteCsvDelay() The delay we require on the remote's commitment transaction.
int	getRemoteMaxHtlcs() The maximum number of concurrent HTLCs we will allow the remote party to add to the commitment transaction.
long	getRemoteMaxValueInFlightMsat() The maximum amount of coins in millisatoshi that can be pending within the channel.
long	getSatPerByte() A manual fee rate set in sat/byte that should be used when crafting the funding transaction.
boolean	getSpendUnconfirmed() Whether unconfirmed outputs should be used as inputs for the funding transaction.
int	getTargetConf() The target number of blocks that the funding transaction should be confirmed by.
boolean	hasFundingShim() Funding shims are an optional argument that allow the caller to intercept certain funding functionality.

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

getNodePubkey

com.google.protobuf.ByteString getNodePubkey()

The pubkey of the node to open a channel with. When using REST, this field
must be encoded as base64.
 

bytes node_pubkey = 2;

getNodePubkeyString

@Deprecated
java.lang.String getNodePubkeyString()

Deprecated.

The hex encoded pubkey of the node to open a channel with. Deprecated now
that the REST gateway supports base64 encoding of bytes fields.
 

string node_pubkey_string = 3 [deprecated = true];

getNodePubkeyStringBytes

@Deprecated
com.google.protobuf.ByteString getNodePubkeyStringBytes()

Deprecated.

The hex encoded pubkey of the node to open a channel with. Deprecated now
that the REST gateway supports base64 encoding of bytes fields.
 

string node_pubkey_string = 3 [deprecated = true];

getLocalFundingAmount

long getLocalFundingAmount()

 The number of satoshis the wallet should commit to the channel
 

int64 local_funding_amount = 4;

getPushSat

long getPushSat()

 The number of satoshis to push to the remote side as part of the initial
 commitment state
 

int64 push_sat = 5;

getTargetConf

int getTargetConf()

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

int32 target_conf = 6;

getSatPerByte

long getSatPerByte()

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

int64 sat_per_byte = 7;

getPrivate

boolean getPrivate()

 Whether this channel should be private, not announced to the greater
 network.
 

bool private = 8;

getMinHtlcMsat

long getMinHtlcMsat()

 The minimum value in millisatoshi we will require for incoming HTLCs on
 the channel.
 

int64 min_htlc_msat = 9;

getRemoteCsvDelay

int getRemoteCsvDelay()

 The delay we require on the remote's commitment transaction. If this is
 not set, it will be scaled automatically with the channel size.
 

uint32 remote_csv_delay = 10;

getMinConfs

int getMinConfs()

 The minimum number of confirmations each one of your outputs used for
 the funding transaction must satisfy.
 

int32 min_confs = 11;

getSpendUnconfirmed

boolean getSpendUnconfirmed()

 Whether unconfirmed outputs should be used as inputs for the funding
 transaction.
 

bool spend_unconfirmed = 12;

getCloseAddress

java.lang.String getCloseAddress()

Close address is an optional address which specifies the address to which
funds should be paid out to upon cooperative close. This field may only be
set if the peer supports the option upfront feature bit (call listpeers
to check). The remote peer will only accept cooperative closes to this
address if it is set.
Note: If this value is set on channel creation, you will *not* be able to
cooperatively close out to a different address.
 

string close_address = 13;

getCloseAddressBytes

com.google.protobuf.ByteString getCloseAddressBytes()

Close address is an optional address which specifies the address to which
funds should be paid out to upon cooperative close. This field may only be
set if the peer supports the option upfront feature bit (call listpeers
to check). The remote peer will only accept cooperative closes to this
address if it is set.
Note: If this value is set on channel creation, you will *not* be able to
cooperatively close out to a different address.
 

string close_address = 13;

hasFundingShim

boolean hasFundingShim()

Funding shims are an optional argument that allow the caller to intercept
certain funding functionality. For example, a shim can be provided to use a
particular key for the commitment key (ideally cold) rather than use one
that is generated by the wallet as normal, or signal that signing will be
carried out in an interactive manner (PSBT based).
 

.lnrpc.FundingShim funding_shim = 14;

getFundingShim

LightningApi.FundingShim getFundingShim()

Funding shims are an optional argument that allow the caller to intercept
certain funding functionality. For example, a shim can be provided to use a
particular key for the commitment key (ideally cold) rather than use one
that is generated by the wallet as normal, or signal that signing will be
carried out in an interactive manner (PSBT based).
 

.lnrpc.FundingShim funding_shim = 14;

getFundingShimOrBuilder

LightningApi.FundingShimOrBuilder getFundingShimOrBuilder()

Funding shims are an optional argument that allow the caller to intercept
certain funding functionality. For example, a shim can be provided to use a
particular key for the commitment key (ideally cold) rather than use one
that is generated by the wallet as normal, or signal that signing will be
carried out in an interactive manner (PSBT based).
 

.lnrpc.FundingShim funding_shim = 14;

getRemoteMaxValueInFlightMsat

long getRemoteMaxValueInFlightMsat()

The maximum amount of coins in millisatoshi that can be pending within
the channel. It only applies to the remote party.
 

uint64 remote_max_value_in_flight_msat = 15;

getRemoteMaxHtlcs

int getRemoteMaxHtlcs()

The maximum number of concurrent HTLCs we will allow the remote party to add
to the commitment transaction.
 

uint32 remote_max_htlcs = 16;

getMaxLocalCsv

int getMaxLocalCsv()

Max local csv is the maximum csv delay we will allow for our own commitment
transaction.
 

uint32 max_local_csv = 17;