org.lightningj.lnd.proto

Interface LightningApi.HopOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

LightningApi.Hop, LightningApi.Hop.Builder

Enclosing class:

LightningApi

public static interface LightningApi.HopOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

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[json_name = "amt_to_forward_msat"];
long	getChanCapacity() int64 chan_capacity = 2[json_name = "chan_capacity"];
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[json_name = "expiry"];
long	getFee() Deprecated.
long	getFeeMsat() int64 fee_msat = 7[json_name = "fee_msat"];
LightningApi.MPPRecord	getMppRecord() An optional TLV record tha singals the use of an MPP payment.
LightningApi.MPPRecordOrBuilder	getMppRecordOrBuilder() An optional TLV record tha singals 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 tha singals the use of an MPP payment.

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

getChanId

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[json_name = "chan_id", jstype = JS_STRING];

getChanCapacity

long getChanCapacity()

int64 chan_capacity = 2[json_name = "chan_capacity"];

getAmtToForward

@Deprecated
long getAmtToForward()

Deprecated.

int64 amt_to_forward = 3[json_name = "amt_to_forward", deprecated = true];

getFee

@Deprecated
long getFee()

Deprecated.

int64 fee = 4[json_name = "fee", deprecated = true];

getExpiry

int getExpiry()

uint32 expiry = 5[json_name = "expiry"];

getAmtToForwardMsat

long getAmtToForwardMsat()

int64 amt_to_forward_msat = 6[json_name = "amt_to_forward_msat"];

getFeeMsat

long getFeeMsat()

int64 fee_msat = 7[json_name = "fee_msat"];

getPubKey

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[json_name = "pub_key"];

getPubKeyBytes

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[json_name = "pub_key"];

getTlvPayload

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[json_name = "tlv_payload"];

hasMppRecord

boolean hasMppRecord()

An optional TLV record tha singals 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[json_name = "mpp_record"];

getMppRecord

LightningApi.MPPRecord getMppRecord()

An optional TLV record tha singals 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[json_name = "mpp_record"];

getMppRecordOrBuilder

LightningApi.MPPRecordOrBuilder getMppRecordOrBuilder()

An optional TLV record tha singals 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[json_name = "mpp_record"];

getCustomRecordsCount

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[json_name = "custom_records"];

containsCustomRecords

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[json_name = "custom_records"];

getCustomRecords

@Deprecated
java.util.Map<java.lang.Long,com.google.protobuf.ByteString> getCustomRecords()

Deprecated.

Use getCustomRecordsMap() instead.

getCustomRecordsMap

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[json_name = "custom_records"];

getCustomRecordsOrDefault

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[json_name = "custom_records"];

getCustomRecordsOrThrow

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[json_name = "custom_records"];