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.
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.
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.
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() 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.
boolean	hasMppRecord() An optional TLV record that signals 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 [jstype = JS_STRING];

Returns:

The chanId.

getChanCapacity

@Deprecated
long getChanCapacity()

Deprecated. lnrpc.Hop.chan_capacity is deprecated. See lightning.api.proto;l=3074

int64 chan_capacity = 2 [deprecated = true];

Returns:

The chanCapacity.

getAmtToForward

@Deprecated
long getAmtToForward()

Deprecated. lnrpc.Hop.amt_to_forward is deprecated. See lightning.api.proto;l=3075

int64 amt_to_forward = 3 [deprecated = true];

Returns:

The amtToForward.

getFee

@Deprecated
long getFee()

Deprecated. lnrpc.Hop.fee is deprecated. See lightning.api.proto;l=3076

int64 fee = 4 [deprecated = true];

Returns:

The fee.

getExpiry

int getExpiry()

uint32 expiry = 5;

Returns:

The expiry.

getAmtToForwardMsat

long getAmtToForwardMsat()

int64 amt_to_forward_msat = 6;

Returns:

The amtToForwardMsat.

getFeeMsat

long getFeeMsat()

int64 fee_msat = 7;

Returns:

The feeMsat.

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;

Returns:

The pubKey.

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;

Returns:

The bytes for pubKey.

getTlvPayload

@Deprecated
boolean getTlvPayload()

Deprecated. lnrpc.Hop.tlv_payload is deprecated. See lightning.api.proto;l=3092

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

Returns:

The tlvPayload.

hasMppRecord

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;

Returns:

Whether the mppRecord field is set.

getMppRecord

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;

Returns:

The mppRecord.

getMppRecordOrBuilder

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;

hasAmpRecord

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;

Returns:

Whether the ampRecord field is set.

getAmpRecord

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;

Returns:

The ampRecord.

getAmpRecordOrBuilder

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;

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;

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;

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;

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;

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;

getMetadata

com.google.protobuf.ByteString getMetadata()

 The payment metadata to send along with the payment to the payee.
 

bytes metadata = 13;

Returns:

The metadata.