LightningApi.OpenChannelRequestOrBuilder (lightningj 0.17.4-Beta API)

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

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`long`	`getBaseFee()` The base fee charged regardless of the number of milli-satoshis sent.
`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.CommitmentType`	`getCommitmentType()` The explicit commitment type to use.
`int`	`getCommitmentTypeValue()` The explicit commitment type to use.
`long`	`getFeeRate()` The fee rate in ppm (parts per million) that will be charged in proportion of the value of each forwarded HTLC.
`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.
`boolean`	`getFundMax()` If set, then lnd will attempt to commit all the coins under control of the internal wallet to open the channel, and the LocalFundingAmount field must be zero and is ignored.
`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.
`java.lang.String`	`getMemo()` An optional note-to-self to go along with the channel containing some useful information.
`com.google.protobuf.ByteString`	`getMemoBytes()` An optional note-to-self to go along with the channel containing some useful information.
`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. lnrpc.OpenChannelRequest.node_pubkey_string is deprecated. See lightning.api.proto;l=2235
`com.google.protobuf.ByteString`	`getNodePubkeyStringBytes()` Deprecated. lnrpc.OpenChannelRequest.node_pubkey_string is deprecated. See lightning.api.proto;l=2235
`LightningApi.OutPoint`	`getOutpoints(int index)` A list of selected outpoints that are allocated for channel funding.
`int`	`getOutpointsCount()` A list of selected outpoints that are allocated for channel funding.
`java.util.List<LightningApi.OutPoint>`	`getOutpointsList()` A list of selected outpoints that are allocated for channel funding.
`LightningApi.OutPointOrBuilder`	`getOutpointsOrBuilder(int index)` A list of selected outpoints that are allocated for channel funding.
`java.util.List<? extends LightningApi.OutPointOrBuilder>`	`getOutpointsOrBuilderList()` A list of selected outpoints that are allocated for channel funding.
`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
`long`	`getRemoteChanReserveSat()` The number of satoshis we require the remote peer to reserve.
`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()` Deprecated. lnrpc.OpenChannelRequest.sat_per_byte is deprecated. See lightning.api.proto;l=2251
`long`	`getSatPerVbyte()` A manual fee rate set in sat/vbyte that should be used when crafting the funding transaction.
`boolean`	`getScidAlias()` If this is true, then an option-scid-alias channel-type open will be attempted.
`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`	`getUseBaseFee()` If use_base_fee is true the open channel announcement will update the channel base fee with the value specified in base_fee.
`boolean`	`getUseFeeRate()` If use_fee_rate is true the open channel announcement will update the channel fee rate with the value specified in fee_rate.
`boolean`	`getZeroConf()` If this is true, then a zero-conf channel open will be attempted.
`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

getSatPerVbyte

long getSatPerVbyte()

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

uint64 sat_per_vbyte = 1;

Returns:: The satPerVbyte.

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;

Returns:: The nodePubkey.

getNodePubkeyString
```
@Deprecated
java.lang.String getNodePubkeyString()
```
Deprecated. lnrpc.OpenChannelRequest.node_pubkey_string is deprecated. See lightning.api.proto;l=2235
```
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];
Returns:

The nodePubkeyString.

getNodePubkeyStringBytes
```
@Deprecated
com.google.protobuf.ByteString getNodePubkeyStringBytes()
```
Deprecated. lnrpc.OpenChannelRequest.node_pubkey_string is deprecated. See lightning.api.proto;l=2235
```
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];
Returns:

The bytes for nodePubkeyString.

getLocalFundingAmount

long getLocalFundingAmount()

 The number of satoshis the wallet should commit to the channel

int64 local_funding_amount = 4;

Returns:: The localFundingAmount.

getPushSat

long getPushSat()

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

int64 push_sat = 5;

Returns:: The pushSat.

getTargetConf

int getTargetConf()

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

int32 target_conf = 6;

Returns:: The targetConf.

getSatPerByte
```
@Deprecated
long getSatPerByte()
```
Deprecated. lnrpc.OpenChannelRequest.sat_per_byte is deprecated. See lightning.api.proto;l=2251
```
 Deprecated, use sat_per_vbyte.
 A manual fee rate set in sat/vbyte that should be used when crafting the
 funding transaction.
 
```
int64 sat_per_byte = 7 [deprecated = true];
Returns:

The satPerByte.

getPrivate

boolean getPrivate()

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

bool private = 8;

Returns:: The private.

getMinHtlcMsat

long getMinHtlcMsat()

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

int64 min_htlc_msat = 9;

Returns:: The minHtlcMsat.

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;

Returns:: The remoteCsvDelay.

getMinConfs

int getMinConfs()

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

int32 min_confs = 11;

Returns:: The minConfs.

getSpendUnconfirmed

boolean getSpendUnconfirmed()

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

bool spend_unconfirmed = 12;

Returns:: The spendUnconfirmed.

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;

Returns:: The closeAddress.

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;

Returns:: The bytes for closeAddress.

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;

Returns:: Whether the fundingShim field is set.

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;

Returns:: The fundingShim.

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;

Returns:: The remoteMaxValueInFlightMsat.

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;

Returns:: The remoteMaxHtlcs.

getMaxLocalCsv

int getMaxLocalCsv()


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

uint32 max_local_csv = 17;

Returns:: The maxLocalCsv.

getCommitmentTypeValue

int getCommitmentTypeValue()


The explicit commitment type to use. Note this field will only be used if
the remote peer supports explicit channel negotiation.

.lnrpc.CommitmentType commitment_type = 18;

Returns:: The enum numeric value on the wire for commitmentType.

getCommitmentType

LightningApi.CommitmentType getCommitmentType()


The explicit commitment type to use. Note this field will only be used if
the remote peer supports explicit channel negotiation.

.lnrpc.CommitmentType commitment_type = 18;

Returns:: The commitmentType.

getZeroConf

boolean getZeroConf()


If this is true, then a zero-conf channel open will be attempted.

bool zero_conf = 19;

Returns:: The zeroConf.

getScidAlias

boolean getScidAlias()


If this is true, then an option-scid-alias channel-type open will be
attempted.

bool scid_alias = 20;

Returns:: The scidAlias.

getBaseFee

long getBaseFee()


The base fee charged regardless of the number of milli-satoshis sent.

uint64 base_fee = 21;

Returns:: The baseFee.

getFeeRate

long getFeeRate()


The fee rate in ppm (parts per million) that will be charged in
proportion of the value of each forwarded HTLC.

uint64 fee_rate = 22;

Returns:: The feeRate.

getUseBaseFee

boolean getUseBaseFee()


If use_base_fee is true the open channel announcement will update the
channel base fee with the value specified in base_fee. In the case of
a base_fee of 0 use_base_fee is needed downstream to distinguish whether
to use the default base fee value specified in the config or 0.

bool use_base_fee = 23;

Returns:: The useBaseFee.

getUseFeeRate

boolean getUseFeeRate()


If use_fee_rate is true the open channel announcement will update the
channel fee rate with the value specified in fee_rate. In the case of
a fee_rate of 0 use_fee_rate is needed downstream to distinguish whether
to use the default fee rate value specified in the config or 0.

bool use_fee_rate = 24;

Returns:: The useFeeRate.

getRemoteChanReserveSat

long getRemoteChanReserveSat()


The number of satoshis we require the remote peer to reserve. This value,
if specified, must be above the dust limit and below 20% of the channel
capacity.

uint64 remote_chan_reserve_sat = 25;

Returns:: The remoteChanReserveSat.

getFundMax

boolean getFundMax()


If set, then lnd will attempt to commit all the coins under control of the
internal wallet to open the channel, and the LocalFundingAmount field must
be zero and is ignored.

bool fund_max = 26;

Returns:: The fundMax.

getMemo

java.lang.String getMemo()


An optional note-to-self to go along with the channel containing some
useful information. This is only ever stored locally and in no way impacts
the channel's operation.

string memo = 27;

Returns:: The memo.

getMemoBytes

com.google.protobuf.ByteString getMemoBytes()


An optional note-to-self to go along with the channel containing some
useful information. This is only ever stored locally and in no way impacts
the channel's operation.

string memo = 27;

Returns:: The bytes for memo.