org.lightningj.lnd.proto

Class LightningApi.OpenChannelRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.lightningj.lnd.proto.LightningApi.OpenChannelRequest

All Implemented Interfaces:

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

Enclosing class:

LightningApi

public static final class LightningApi.OpenChannelRequest
extends com.google.protobuf.GeneratedMessageV3
implements LightningApi.OpenChannelRequestOrBuilder

Protobuf type lnrpc.OpenChannelRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

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	BASE_FEE_FIELD_NUMBER
static int	CLOSE_ADDRESS_FIELD_NUMBER
static int	COMMITMENT_TYPE_FIELD_NUMBER
static int	FEE_RATE_FIELD_NUMBER
static int	FUND_MAX_FIELD_NUMBER
static int	FUNDING_SHIM_FIELD_NUMBER
static int	LOCAL_FUNDING_AMOUNT_FIELD_NUMBER
static int	MAX_LOCAL_CSV_FIELD_NUMBER
static int	MEMO_FIELD_NUMBER
static int	MIN_CONFS_FIELD_NUMBER
static int	MIN_HTLC_MSAT_FIELD_NUMBER
static int	NODE_PUBKEY_FIELD_NUMBER
static int	NODE_PUBKEY_STRING_FIELD_NUMBER
static int	OUTPOINTS_FIELD_NUMBER
static int	PRIVATE_FIELD_NUMBER
static int	PUSH_SAT_FIELD_NUMBER
static int	REMOTE_CHAN_RESERVE_SAT_FIELD_NUMBER
static int	REMOTE_CSV_DELAY_FIELD_NUMBER
static int	REMOTE_MAX_HTLCS_FIELD_NUMBER
static int	REMOTE_MAX_VALUE_IN_FLIGHT_MSAT_FIELD_NUMBER
static int	SAT_PER_BYTE_FIELD_NUMBER
static int	SAT_PER_VBYTE_FIELD_NUMBER
static int	SCID_ALIAS_FIELD_NUMBER
static int	SPEND_UNCONFIRMED_FIELD_NUMBER
static int	TARGET_CONF_FIELD_NUMBER
static int	USE_BASE_FEE_FIELD_NUMBER
static int	USE_FEE_RATE_FIELD_NUMBER
static int	ZERO_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)
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.
static LightningApi.OpenChannelRequest	getDefaultInstance()
LightningApi.OpenChannelRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<LightningApi.OpenChannelRequest>	getParserForType()
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.
int	getSerializedSize()
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.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static LightningApi.OpenChannelRequest.Builder	newBuilder()
static LightningApi.OpenChannelRequest.Builder	newBuilder(LightningApi.OpenChannelRequest prototype)
LightningApi.OpenChannelRequest.Builder	newBuilderForType()
protected LightningApi.OpenChannelRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static LightningApi.OpenChannelRequest	parseDelimitedFrom(java.io.InputStream input)
static LightningApi.OpenChannelRequest	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.OpenChannelRequest	parseFrom(byte[] data)
static LightningApi.OpenChannelRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.OpenChannelRequest	parseFrom(java.nio.ByteBuffer data)
static LightningApi.OpenChannelRequest	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.OpenChannelRequest	parseFrom(com.google.protobuf.ByteString data)
static LightningApi.OpenChannelRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.OpenChannelRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static LightningApi.OpenChannelRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.OpenChannelRequest	parseFrom(java.io.InputStream input)
static LightningApi.OpenChannelRequest	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<LightningApi.OpenChannelRequest>	parser()
LightningApi.OpenChannelRequest.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

SAT_PER_VBYTE_FIELD_NUMBER

public static final int SAT_PER_VBYTE_FIELD_NUMBER

See Also:

Constant Field Values

NODE_PUBKEY_FIELD_NUMBER

public static final int NODE_PUBKEY_FIELD_NUMBER

See Also:

Constant Field Values

NODE_PUBKEY_STRING_FIELD_NUMBER

public static final int NODE_PUBKEY_STRING_FIELD_NUMBER

See Also:

Constant Field Values

LOCAL_FUNDING_AMOUNT_FIELD_NUMBER

public static final int LOCAL_FUNDING_AMOUNT_FIELD_NUMBER

See Also:

Constant Field Values

PUSH_SAT_FIELD_NUMBER

public static final int PUSH_SAT_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

PRIVATE_FIELD_NUMBER

public static final int PRIVATE_FIELD_NUMBER

See Also:

Constant Field Values

MIN_HTLC_MSAT_FIELD_NUMBER

public static final int MIN_HTLC_MSAT_FIELD_NUMBER

See Also:

Constant Field Values

REMOTE_CSV_DELAY_FIELD_NUMBER

public static final int REMOTE_CSV_DELAY_FIELD_NUMBER

See Also:

Constant Field Values

MIN_CONFS_FIELD_NUMBER

public static final int MIN_CONFS_FIELD_NUMBER

See Also:

Constant Field Values

SPEND_UNCONFIRMED_FIELD_NUMBER

public static final int SPEND_UNCONFIRMED_FIELD_NUMBER

See Also:

Constant Field Values

CLOSE_ADDRESS_FIELD_NUMBER

public static final int CLOSE_ADDRESS_FIELD_NUMBER

See Also:

Constant Field Values

FUNDING_SHIM_FIELD_NUMBER

public static final int FUNDING_SHIM_FIELD_NUMBER

See Also:

Constant Field Values

REMOTE_MAX_VALUE_IN_FLIGHT_MSAT_FIELD_NUMBER

public static final int REMOTE_MAX_VALUE_IN_FLIGHT_MSAT_FIELD_NUMBER

See Also:

Constant Field Values

REMOTE_MAX_HTLCS_FIELD_NUMBER

public static final int REMOTE_MAX_HTLCS_FIELD_NUMBER

See Also:

Constant Field Values

MAX_LOCAL_CSV_FIELD_NUMBER

public static final int MAX_LOCAL_CSV_FIELD_NUMBER

See Also:

Constant Field Values

COMMITMENT_TYPE_FIELD_NUMBER

public static final int COMMITMENT_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

ZERO_CONF_FIELD_NUMBER

public static final int ZERO_CONF_FIELD_NUMBER

See Also:

Constant Field Values

SCID_ALIAS_FIELD_NUMBER

public static final int SCID_ALIAS_FIELD_NUMBER

See Also:

Constant Field Values

BASE_FEE_FIELD_NUMBER

public static final int BASE_FEE_FIELD_NUMBER

See Also:

Constant Field Values

FEE_RATE_FIELD_NUMBER

public static final int FEE_RATE_FIELD_NUMBER

See Also:

Constant Field Values

USE_BASE_FEE_FIELD_NUMBER

public static final int USE_BASE_FEE_FIELD_NUMBER

See Also:

Constant Field Values

USE_FEE_RATE_FIELD_NUMBER

public static final int USE_FEE_RATE_FIELD_NUMBER

See Also:

Constant Field Values

REMOTE_CHAN_RESERVE_SAT_FIELD_NUMBER

public static final int REMOTE_CHAN_RESERVE_SAT_FIELD_NUMBER

See Also:

Constant Field Values

FUND_MAX_FIELD_NUMBER

public static final int FUND_MAX_FIELD_NUMBER

See Also:

Constant Field Values

MEMO_FIELD_NUMBER

public static final int MEMO_FIELD_NUMBER

See Also:

Constant Field Values

OUTPOINTS_FIELD_NUMBER

public static final int OUTPOINTS_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

getSatPerVbyte

public long getSatPerVbyte()

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

uint64 sat_per_vbyte = 1;

Specified by:

getSatPerVbyte in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The satPerVbyte.

getNodePubkey

public 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;

Specified by:

getNodePubkey in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The nodePubkey.

getNodePubkeyString

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

Specified by:

getNodePubkeyString in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The nodePubkeyString.

getNodePubkeyStringBytes

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

Specified by:

getNodePubkeyStringBytes in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The bytes for nodePubkeyString.

getLocalFundingAmount

public long getLocalFundingAmount()

 The number of satoshis the wallet should commit to the channel
 

int64 local_funding_amount = 4;

Specified by:

getLocalFundingAmount in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The localFundingAmount.

getPushSat

public long getPushSat()

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

int64 push_sat = 5;

Specified by:

getPushSat in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The pushSat.

getTargetConf

public int getTargetConf()

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

int32 target_conf = 6;

Specified by:

getTargetConf in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The targetConf.

getSatPerByte

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

Specified by:

getSatPerByte in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The satPerByte.

getPrivate

public boolean getPrivate()

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

bool private = 8;

Specified by:

getPrivate in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The private.

getMinHtlcMsat

public long getMinHtlcMsat()

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

int64 min_htlc_msat = 9;

Specified by:

getMinHtlcMsat in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The minHtlcMsat.

getRemoteCsvDelay

public 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;

Specified by:

getRemoteCsvDelay in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The remoteCsvDelay.

getMinConfs

public int getMinConfs()

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

int32 min_confs = 11;

Specified by:

getMinConfs in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The minConfs.

getSpendUnconfirmed

public boolean getSpendUnconfirmed()

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

bool spend_unconfirmed = 12;

Specified by:

getSpendUnconfirmed in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The spendUnconfirmed.

getCloseAddress

public 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;

Specified by:

getCloseAddress in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The closeAddress.

getCloseAddressBytes

public 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;

Specified by:

getCloseAddressBytes in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The bytes for closeAddress.

hasFundingShim

public 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;

Specified by:

hasFundingShim in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

Whether the fundingShim field is set.

getFundingShim

public 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;

Specified by:

getFundingShim in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The fundingShim.

getFundingShimOrBuilder

public 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;

Specified by:

getFundingShimOrBuilder in interface LightningApi.OpenChannelRequestOrBuilder

getRemoteMaxValueInFlightMsat

public 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;

Specified by:

getRemoteMaxValueInFlightMsat in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The remoteMaxValueInFlightMsat.

getRemoteMaxHtlcs

public 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;

Specified by:

getRemoteMaxHtlcs in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The remoteMaxHtlcs.

getMaxLocalCsv

public int getMaxLocalCsv()

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

uint32 max_local_csv = 17;

Specified by:

getMaxLocalCsv in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The maxLocalCsv.

getCommitmentTypeValue

public 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;

Specified by:

getCommitmentTypeValue in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The enum numeric value on the wire for commitmentType.

getCommitmentType

public 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;

Specified by:

getCommitmentType in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The commitmentType.

getZeroConf

public boolean getZeroConf()

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

bool zero_conf = 19;

Specified by:

getZeroConf in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The zeroConf.

getScidAlias

public boolean getScidAlias()

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

bool scid_alias = 20;

Specified by:

getScidAlias in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The scidAlias.

getBaseFee

public long getBaseFee()

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

uint64 base_fee = 21;

Specified by:

getBaseFee in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The baseFee.

getFeeRate

public 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;

Specified by:

getFeeRate in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The feeRate.

getUseBaseFee

public 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;

Specified by:

getUseBaseFee in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The useBaseFee.

getUseFeeRate

public 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;

Specified by:

getUseFeeRate in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The useFeeRate.

getRemoteChanReserveSat

public 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;

Specified by:

getRemoteChanReserveSat in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The remoteChanReserveSat.

getFundMax

public 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;

Specified by:

getFundMax in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The fundMax.

getMemo

public 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;

Specified by:

getMemo in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The memo.

getMemoBytes

public 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;

Specified by:

getMemoBytes in interface LightningApi.OpenChannelRequestOrBuilder

Returns:

The bytes for memo.

getOutpointsList

public java.util.List<LightningApi.OutPoint> getOutpointsList()

A list of selected outpoints that are allocated for channel funding.
 

repeated .lnrpc.OutPoint outpoints = 28;

Specified by:

getOutpointsList in interface LightningApi.OpenChannelRequestOrBuilder

getOutpointsOrBuilderList

public java.util.List<? extends LightningApi.OutPointOrBuilder> getOutpointsOrBuilderList()

A list of selected outpoints that are allocated for channel funding.
 

repeated .lnrpc.OutPoint outpoints = 28;

Specified by:

getOutpointsOrBuilderList in interface LightningApi.OpenChannelRequestOrBuilder

getOutpointsCount

public int getOutpointsCount()

A list of selected outpoints that are allocated for channel funding.
 

repeated .lnrpc.OutPoint outpoints = 28;

Specified by:

getOutpointsCount in interface LightningApi.OpenChannelRequestOrBuilder

getOutpoints

public LightningApi.OutPoint getOutpoints(int index)

A list of selected outpoints that are allocated for channel funding.
 

repeated .lnrpc.OutPoint outpoints = 28;

Specified by:

getOutpoints in interface LightningApi.OpenChannelRequestOrBuilder

getOutpointsOrBuilder

public LightningApi.OutPointOrBuilder getOutpointsOrBuilder(int index)

A list of selected outpoints that are allocated for channel funding.
 

repeated .lnrpc.OutPoint outpoints = 28;

Specified by:

getOutpointsOrBuilder in interface LightningApi.OpenChannelRequestOrBuilder

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.OpenChannelRequest parseFrom(java.nio.ByteBuffer data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.OpenChannelRequest 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.OpenChannelRequest parseFrom(byte[] data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

newBuilderForType

public LightningApi.OpenChannelRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static LightningApi.OpenChannelRequest.Builder newBuilder()

newBuilder

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

toBuilder

public LightningApi.OpenChannelRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static LightningApi.OpenChannelRequest getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<LightningApi.OpenChannelRequest> 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.OpenChannelRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder