public static final class LightningApi.Hop extends com.google.protobuf.GeneratedMessageV3 implements LightningApi.HopOrBuilder
lnrpc.Hop
Modifier and Type | Class and Description |
---|---|
static class |
LightningApi.Hop.Builder
Protobuf type
lnrpc.Hop |
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 |
AMP_RECORD_FIELD_NUMBER |
static int |
AMT_TO_FORWARD_FIELD_NUMBER |
static int |
AMT_TO_FORWARD_MSAT_FIELD_NUMBER |
static int |
CHAN_CAPACITY_FIELD_NUMBER |
static int |
CHAN_ID_FIELD_NUMBER |
static int |
CUSTOM_RECORDS_FIELD_NUMBER |
static int |
EXPIRY_FIELD_NUMBER |
static int |
FEE_FIELD_NUMBER |
static int |
FEE_MSAT_FIELD_NUMBER |
static int |
METADATA_FIELD_NUMBER |
static int |
MPP_RECORD_FIELD_NUMBER |
static int |
PUB_KEY_FIELD_NUMBER |
static int |
TLV_PAYLOAD_FIELD_NUMBER |
Modifier and Type | Method and Description |
---|---|
boolean |
containsCustomRecords(long key)
An optional set of key-value TLV records.
|
boolean |
equals(java.lang.Object obj) |
LightningApi.AMPRecord |
getAmpRecord()
An optional TLV record that signals the use of an AMP payment.
|
LightningApi.AMPRecordOrBuilder |
getAmpRecordOrBuilder()
An optional TLV record that signals the use of an AMP payment.
|
long |
getAmtToForward()
Deprecated.
lnrpc.Hop.amt_to_forward is deprecated.
See lightning.api.proto;l=3075
|
long |
getAmtToForwardMsat()
int64 amt_to_forward_msat = 6; |
long |
getChanCapacity()
Deprecated.
lnrpc.Hop.chan_capacity is deprecated.
See lightning.api.proto;l=3074
|
long |
getChanId()
The unique channel ID for the channel.
|
java.util.Map<java.lang.Long,com.google.protobuf.ByteString> |
getCustomRecords()
Deprecated.
|
int |
getCustomRecordsCount()
An optional set of key-value TLV records.
|
java.util.Map<java.lang.Long,com.google.protobuf.ByteString> |
getCustomRecordsMap()
An optional set of key-value TLV records.
|
com.google.protobuf.ByteString |
getCustomRecordsOrDefault(long key,
com.google.protobuf.ByteString defaultValue)
An optional set of key-value TLV records.
|
com.google.protobuf.ByteString |
getCustomRecordsOrThrow(long key)
An optional set of key-value TLV records.
|
static LightningApi.Hop |
getDefaultInstance() |
LightningApi.Hop |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
int |
getExpiry()
uint32 expiry = 5; |
long |
getFee()
Deprecated.
lnrpc.Hop.fee is deprecated.
See lightning.api.proto;l=3076
|
long |
getFeeMsat()
int64 fee_msat = 7; |
com.google.protobuf.ByteString |
getMetadata()
The payment metadata to send along with the payment to the payee.
|
LightningApi.MPPRecord |
getMppRecord()
An optional TLV record that signals the use of an MPP payment.
|
LightningApi.MPPRecordOrBuilder |
getMppRecordOrBuilder()
An optional TLV record that signals the use of an MPP payment.
|
com.google.protobuf.Parser<LightningApi.Hop> |
getParserForType() |
java.lang.String |
getPubKey()
An optional public key of the hop.
|
com.google.protobuf.ByteString |
getPubKeyBytes()
An optional public key of the hop.
|
int |
getSerializedSize() |
boolean |
getTlvPayload()
Deprecated.
lnrpc.Hop.tlv_payload is deprecated.
See lightning.api.proto;l=3092
|
boolean |
hasAmpRecord()
An optional TLV record that signals the use of an AMP payment.
|
int |
hashCode() |
boolean |
hasMppRecord()
An optional TLV record that signals the use of an MPP payment.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static LightningApi.Hop.Builder |
newBuilder() |
static LightningApi.Hop.Builder |
newBuilder(LightningApi.Hop prototype) |
LightningApi.Hop.Builder |
newBuilderForType() |
protected LightningApi.Hop.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected java.lang.Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static LightningApi.Hop |
parseDelimitedFrom(java.io.InputStream input) |
static LightningApi.Hop |
parseDelimitedFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.Hop |
parseFrom(byte[] data) |
static LightningApi.Hop |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.Hop |
parseFrom(java.nio.ByteBuffer data) |
static LightningApi.Hop |
parseFrom(java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.Hop |
parseFrom(com.google.protobuf.ByteString data) |
static LightningApi.Hop |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.Hop |
parseFrom(com.google.protobuf.CodedInputStream input) |
static LightningApi.Hop |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.Hop |
parseFrom(java.io.InputStream input) |
static LightningApi.Hop |
parseFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<LightningApi.Hop> |
parser() |
LightningApi.Hop.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, 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
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int CHAN_ID_FIELD_NUMBER
public static final int CHAN_CAPACITY_FIELD_NUMBER
public static final int AMT_TO_FORWARD_FIELD_NUMBER
public static final int FEE_FIELD_NUMBER
public static final int EXPIRY_FIELD_NUMBER
public static final int AMT_TO_FORWARD_MSAT_FIELD_NUMBER
public static final int FEE_MSAT_FIELD_NUMBER
public static final int PUB_KEY_FIELD_NUMBER
public static final int TLV_PAYLOAD_FIELD_NUMBER
public static final int MPP_RECORD_FIELD_NUMBER
public static final int AMP_RECORD_FIELD_NUMBER
public static final int CUSTOM_RECORDS_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER
protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField
in class com.google.protobuf.GeneratedMessageV3
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
public long getChanId()
The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel.
uint64 chan_id = 1 [jstype = JS_STRING];
getChanId
in interface LightningApi.HopOrBuilder
@Deprecated public long getChanCapacity()
int64 chan_capacity = 2 [deprecated = true];
getChanCapacity
in interface LightningApi.HopOrBuilder
@Deprecated public long getAmtToForward()
int64 amt_to_forward = 3 [deprecated = true];
getAmtToForward
in interface LightningApi.HopOrBuilder
@Deprecated public long getFee()
int64 fee = 4 [deprecated = true];
getFee
in interface LightningApi.HopOrBuilder
public int getExpiry()
uint32 expiry = 5;
getExpiry
in interface LightningApi.HopOrBuilder
public long getAmtToForwardMsat()
int64 amt_to_forward_msat = 6;
getAmtToForwardMsat
in interface LightningApi.HopOrBuilder
public long getFeeMsat()
int64 fee_msat = 7;
getFeeMsat
in interface LightningApi.HopOrBuilder
public java.lang.String getPubKey()
An optional public key of the hop. If the public key is given, the payment can be executed without relying on a copy of the channel graph.
string pub_key = 8;
getPubKey
in interface LightningApi.HopOrBuilder
public com.google.protobuf.ByteString getPubKeyBytes()
An optional public key of the hop. If the public key is given, the payment can be executed without relying on a copy of the channel graph.
string pub_key = 8;
getPubKeyBytes
in interface LightningApi.HopOrBuilder
@Deprecated public boolean getTlvPayload()
If set to true, then this hop will be encoded using the new variable length TLV format. Note that if any custom tlv_records below are specified, then this field MUST be set to true for them to be encoded properly.
bool tlv_payload = 9 [deprecated = true];
getTlvPayload
in interface LightningApi.HopOrBuilder
public boolean hasMppRecord()
An optional TLV record that signals the use of an MPP payment. If present, the receiver will enforce that the same mpp_record is included in the final hop payload of all non-zero payments in the HTLC set. If empty, a regular single-shot payment is or was attempted.
.lnrpc.MPPRecord mpp_record = 10;
hasMppRecord
in interface LightningApi.HopOrBuilder
public LightningApi.MPPRecord getMppRecord()
An optional TLV record that signals the use of an MPP payment. If present, the receiver will enforce that the same mpp_record is included in the final hop payload of all non-zero payments in the HTLC set. If empty, a regular single-shot payment is or was attempted.
.lnrpc.MPPRecord mpp_record = 10;
getMppRecord
in interface LightningApi.HopOrBuilder
public LightningApi.MPPRecordOrBuilder getMppRecordOrBuilder()
An optional TLV record that signals the use of an MPP payment. If present, the receiver will enforce that the same mpp_record is included in the final hop payload of all non-zero payments in the HTLC set. If empty, a regular single-shot payment is or was attempted.
.lnrpc.MPPRecord mpp_record = 10;
getMppRecordOrBuilder
in interface LightningApi.HopOrBuilder
public boolean hasAmpRecord()
An optional TLV record that signals the use of an AMP payment. If present, the receiver will treat all received payments including the same (payment_addr, set_id) pair as being part of one logical payment. The payment will be settled by XORing the root_share's together and deriving the child hashes and preimages according to BOLT XX. Must be used in conjunction with mpp_record.
.lnrpc.AMPRecord amp_record = 12;
hasAmpRecord
in interface LightningApi.HopOrBuilder
public LightningApi.AMPRecord getAmpRecord()
An optional TLV record that signals the use of an AMP payment. If present, the receiver will treat all received payments including the same (payment_addr, set_id) pair as being part of one logical payment. The payment will be settled by XORing the root_share's together and deriving the child hashes and preimages according to BOLT XX. Must be used in conjunction with mpp_record.
.lnrpc.AMPRecord amp_record = 12;
getAmpRecord
in interface LightningApi.HopOrBuilder
public LightningApi.AMPRecordOrBuilder getAmpRecordOrBuilder()
An optional TLV record that signals the use of an AMP payment. If present, the receiver will treat all received payments including the same (payment_addr, set_id) pair as being part of one logical payment. The payment will be settled by XORing the root_share's together and deriving the child hashes and preimages according to BOLT XX. Must be used in conjunction with mpp_record.
.lnrpc.AMPRecord amp_record = 12;
getAmpRecordOrBuilder
in interface LightningApi.HopOrBuilder
public int getCustomRecordsCount()
LightningApi.HopOrBuilder
An optional set of key-value TLV records. This is useful within the context of the SendToRoute call as it allows callers to specify arbitrary K-V pairs to drop off at each hop within the onion.
map<uint64, bytes> custom_records = 11;
getCustomRecordsCount
in interface LightningApi.HopOrBuilder
public boolean containsCustomRecords(long key)
An optional set of key-value TLV records. This is useful within the context of the SendToRoute call as it allows callers to specify arbitrary K-V pairs to drop off at each hop within the onion.
map<uint64, bytes> custom_records = 11;
containsCustomRecords
in interface LightningApi.HopOrBuilder
@Deprecated public java.util.Map<java.lang.Long,com.google.protobuf.ByteString> getCustomRecords()
getCustomRecordsMap()
instead.getCustomRecords
in interface LightningApi.HopOrBuilder
public java.util.Map<java.lang.Long,com.google.protobuf.ByteString> getCustomRecordsMap()
An optional set of key-value TLV records. This is useful within the context of the SendToRoute call as it allows callers to specify arbitrary K-V pairs to drop off at each hop within the onion.
map<uint64, bytes> custom_records = 11;
getCustomRecordsMap
in interface LightningApi.HopOrBuilder
public com.google.protobuf.ByteString getCustomRecordsOrDefault(long key, com.google.protobuf.ByteString defaultValue)
An optional set of key-value TLV records. This is useful within the context of the SendToRoute call as it allows callers to specify arbitrary K-V pairs to drop off at each hop within the onion.
map<uint64, bytes> custom_records = 11;
getCustomRecordsOrDefault
in interface LightningApi.HopOrBuilder
public com.google.protobuf.ByteString getCustomRecordsOrThrow(long key)
An optional set of key-value TLV records. This is useful within the context of the SendToRoute call as it allows callers to specify arbitrary K-V pairs to drop off at each hop within the onion.
map<uint64, bytes> custom_records = 11;
getCustomRecordsOrThrow
in interface LightningApi.HopOrBuilder
public com.google.protobuf.ByteString getMetadata()
The payment metadata to send along with the payment to the payee.
bytes metadata = 13;
getMetadata
in interface LightningApi.HopOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
java.io.IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(java.lang.Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static LightningApi.Hop parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.Hop parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.Hop parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.Hop parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.Hop parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.Hop parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.Hop parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static LightningApi.Hop parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static LightningApi.Hop parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static LightningApi.Hop parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static LightningApi.Hop parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
java.io.IOException
public static LightningApi.Hop parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public LightningApi.Hop.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static LightningApi.Hop.Builder newBuilder()
public static LightningApi.Hop.Builder newBuilder(LightningApi.Hop prototype)
public LightningApi.Hop.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected LightningApi.Hop.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static LightningApi.Hop getDefaultInstance()
public static com.google.protobuf.Parser<LightningApi.Hop> parser()
public com.google.protobuf.Parser<LightningApi.Hop> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public LightningApi.Hop getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder