public static interface LightningApi.HopOrBuilder
extends com.google.protobuf.MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsCustomRecords(long key)
An optional set of key-value TLV records.
|
long |
getAmtToForward()
Deprecated.
|
long |
getAmtToForwardMsat()
int64 amt_to_forward_msat = 6; |
long |
getChanCapacity()
int64 chan_capacity = 2; |
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.
|
int |
getExpiry()
uint32 expiry = 5; |
long |
getFee()
Deprecated.
|
long |
getFeeMsat()
int64 fee_msat = 7; |
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.
|
java.lang.String |
getPubKey()
An optional public key of the hop.
|
com.google.protobuf.ByteString |
getPubKeyBytes()
An optional public key of the hop.
|
boolean |
getTlvPayload()
If set to true, then this hop will be encoded using the new variable length
TLV format.
|
boolean |
hasMppRecord()
An optional TLV record that signals the use of an MPP payment.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneoflong 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];long getChanCapacity()
int64 chan_capacity = 2;@Deprecated long getAmtToForward()
int64 amt_to_forward = 3 [deprecated = true];@Deprecated long getFee()
int64 fee = 4 [deprecated = true];int getExpiry()
uint32 expiry = 5;long getAmtToForwardMsat()
int64 amt_to_forward_msat = 6;long getFeeMsat()
int64 fee_msat = 7;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;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;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;boolean hasMppRecord()
An optional TLV record that signals the use of an MPP payment. If present, the receiver will enforce that 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;LightningApi.MPPRecord getMppRecord()
An optional TLV record that signals the use of an MPP payment. If present, the receiver will enforce that 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;LightningApi.MPPRecordOrBuilder getMppRecordOrBuilder()
An optional TLV record that signals the use of an MPP payment. If present, the receiver will enforce that 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;int getCustomRecordsCount()
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;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;@Deprecated java.util.Map<java.lang.Long,com.google.protobuf.ByteString> getCustomRecords()
getCustomRecordsMap() instead.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;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;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;