public static final class LightningApi.BatchOpenChannel extends com.google.protobuf.GeneratedMessageV3 implements LightningApi.BatchOpenChannelOrBuilder
lnrpc.BatchOpenChannel| Modifier and Type | Class and Description |
|---|---|
static class |
LightningApi.BatchOpenChannel.Builder
Protobuf type
lnrpc.BatchOpenChannel |
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| 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 |
LOCAL_FUNDING_AMOUNT_FIELD_NUMBER |
static int |
MAX_LOCAL_CSV_FIELD_NUMBER |
static int |
MEMO_FIELD_NUMBER |
static int |
MIN_HTLC_MSAT_FIELD_NUMBER |
static int |
NODE_PUBKEY_FIELD_NUMBER |
static int |
PENDING_CHAN_ID_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 |
SCID_ALIAS_FIELD_NUMBER |
static int |
USE_BASE_FEE_FIELD_NUMBER |
static int |
USE_FEE_RATE_FIELD_NUMBER |
static int |
ZERO_CONF_FIELD_NUMBER |
| 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.BatchOpenChannel |
getDefaultInstance() |
LightningApi.BatchOpenChannel |
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.
|
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.
|
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.
|
com.google.protobuf.Parser<LightningApi.BatchOpenChannel> |
getParserForType() |
com.google.protobuf.ByteString |
getPendingChanId()
An optional, unique identifier of 32 random bytes that will be used as the
pending channel ID to identify the channel while it is in the pre-pending
state.
|
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.
|
boolean |
getScidAlias()
If this is true, then an option-scid-alias channel-type open will be
attempted.
|
int |
getSerializedSize() |
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.
|
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static LightningApi.BatchOpenChannel.Builder |
newBuilder() |
static LightningApi.BatchOpenChannel.Builder |
newBuilder(LightningApi.BatchOpenChannel prototype) |
LightningApi.BatchOpenChannel.Builder |
newBuilderForType() |
protected LightningApi.BatchOpenChannel.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected java.lang.Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static LightningApi.BatchOpenChannel |
parseDelimitedFrom(java.io.InputStream input) |
static LightningApi.BatchOpenChannel |
parseDelimitedFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.BatchOpenChannel |
parseFrom(byte[] data) |
static LightningApi.BatchOpenChannel |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.BatchOpenChannel |
parseFrom(java.nio.ByteBuffer data) |
static LightningApi.BatchOpenChannel |
parseFrom(java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.BatchOpenChannel |
parseFrom(com.google.protobuf.ByteString data) |
static LightningApi.BatchOpenChannel |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.BatchOpenChannel |
parseFrom(com.google.protobuf.CodedInputStream input) |
static LightningApi.BatchOpenChannel |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.BatchOpenChannel |
parseFrom(java.io.InputStream input) |
static LightningApi.BatchOpenChannel |
parseFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<LightningApi.BatchOpenChannel> |
parser() |
LightningApi.BatchOpenChannel.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NODE_PUBKEY_FIELD_NUMBER
public static final int LOCAL_FUNDING_AMOUNT_FIELD_NUMBER
public static final int PUSH_SAT_FIELD_NUMBER
public static final int PRIVATE_FIELD_NUMBER
public static final int MIN_HTLC_MSAT_FIELD_NUMBER
public static final int REMOTE_CSV_DELAY_FIELD_NUMBER
public static final int CLOSE_ADDRESS_FIELD_NUMBER
public static final int PENDING_CHAN_ID_FIELD_NUMBER
public static final int COMMITMENT_TYPE_FIELD_NUMBER
public static final int REMOTE_MAX_VALUE_IN_FLIGHT_MSAT_FIELD_NUMBER
public static final int REMOTE_MAX_HTLCS_FIELD_NUMBER
public static final int MAX_LOCAL_CSV_FIELD_NUMBER
public static final int ZERO_CONF_FIELD_NUMBER
public static final int SCID_ALIAS_FIELD_NUMBER
public static final int BASE_FEE_FIELD_NUMBER
public static final int FEE_RATE_FIELD_NUMBER
public static final int USE_BASE_FEE_FIELD_NUMBER
public static final int USE_FEE_RATE_FIELD_NUMBER
public static final int REMOTE_CHAN_RESERVE_SAT_FIELD_NUMBER
public static final int MEMO_FIELD_NUMBER
protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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 = 1;getNodePubkey in interface LightningApi.BatchOpenChannelOrBuilderpublic long getLocalFundingAmount()
The number of satoshis the wallet should commit to the channel.
int64 local_funding_amount = 2;getLocalFundingAmount in interface LightningApi.BatchOpenChannelOrBuilderpublic long getPushSat()
The number of satoshis to push to the remote side as part of the initial commitment state.
int64 push_sat = 3;getPushSat in interface LightningApi.BatchOpenChannelOrBuilderpublic boolean getPrivate()
Whether this channel should be private, not announced to the greater network.
bool private = 4;getPrivate in interface LightningApi.BatchOpenChannelOrBuilderpublic long getMinHtlcMsat()
The minimum value in millisatoshi we will require for incoming HTLCs on the channel.
int64 min_htlc_msat = 5;getMinHtlcMsat in interface LightningApi.BatchOpenChannelOrBuilderpublic 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 = 6;getRemoteCsvDelay in interface LightningApi.BatchOpenChannelOrBuilderpublic 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 = 7;getCloseAddress in interface LightningApi.BatchOpenChannelOrBuilderpublic 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 = 7;getCloseAddressBytes in interface LightningApi.BatchOpenChannelOrBuilderpublic com.google.protobuf.ByteString getPendingChanId()
An optional, unique identifier of 32 random bytes that will be used as the pending channel ID to identify the channel while it is in the pre-pending state.
bytes pending_chan_id = 8;getPendingChanId in interface LightningApi.BatchOpenChannelOrBuilderpublic 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 = 9;getCommitmentTypeValue in interface LightningApi.BatchOpenChannelOrBuilderpublic 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 = 9;getCommitmentType in interface LightningApi.BatchOpenChannelOrBuilderpublic 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 = 10;getRemoteMaxValueInFlightMsat in interface LightningApi.BatchOpenChannelOrBuilderpublic int getRemoteMaxHtlcs()
The maximum number of concurrent HTLCs we will allow the remote party to add to the commitment transaction.
uint32 remote_max_htlcs = 11;getRemoteMaxHtlcs in interface LightningApi.BatchOpenChannelOrBuilderpublic int getMaxLocalCsv()
Max local csv is the maximum csv delay we will allow for our own commitment transaction.
uint32 max_local_csv = 12;getMaxLocalCsv in interface LightningApi.BatchOpenChannelOrBuilderpublic boolean getZeroConf()
If this is true, then a zero-conf channel open will be attempted.
bool zero_conf = 13;getZeroConf in interface LightningApi.BatchOpenChannelOrBuilderpublic boolean getScidAlias()
If this is true, then an option-scid-alias channel-type open will be attempted.
bool scid_alias = 14;getScidAlias in interface LightningApi.BatchOpenChannelOrBuilderpublic long getBaseFee()
The base fee charged regardless of the number of milli-satoshis sent.
uint64 base_fee = 15;getBaseFee in interface LightningApi.BatchOpenChannelOrBuilderpublic 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 = 16;getFeeRate in interface LightningApi.BatchOpenChannelOrBuilderpublic 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 = 17;getUseBaseFee in interface LightningApi.BatchOpenChannelOrBuilderpublic 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 = 18;getUseFeeRate in interface LightningApi.BatchOpenChannelOrBuilderpublic 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 = 19;getRemoteChanReserveSat in interface LightningApi.BatchOpenChannelOrBuilderpublic 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 = 20;getMemo in interface LightningApi.BatchOpenChannelOrBuilderpublic 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 = 20;getMemoBytes in interface LightningApi.BatchOpenChannelOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws java.io.IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3java.io.IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(java.lang.Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static LightningApi.BatchOpenChannel parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static LightningApi.BatchOpenChannel parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static LightningApi.BatchOpenChannel parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static LightningApi.BatchOpenChannel parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static LightningApi.BatchOpenChannel parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static LightningApi.BatchOpenChannel parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static LightningApi.BatchOpenChannel parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static LightningApi.BatchOpenChannel parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static LightningApi.BatchOpenChannel parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static LightningApi.BatchOpenChannel parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static LightningApi.BatchOpenChannel parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
java.io.IOExceptionpublic static LightningApi.BatchOpenChannel parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic LightningApi.BatchOpenChannel.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static LightningApi.BatchOpenChannel.Builder newBuilder()
public static LightningApi.BatchOpenChannel.Builder newBuilder(LightningApi.BatchOpenChannel prototype)
public LightningApi.BatchOpenChannel.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected LightningApi.BatchOpenChannel.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static LightningApi.BatchOpenChannel getDefaultInstance()
public static com.google.protobuf.Parser<LightningApi.BatchOpenChannel> parser()
public com.google.protobuf.Parser<LightningApi.BatchOpenChannel> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public LightningApi.BatchOpenChannel getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder