org.lightningj.lnd.proto

Class LightningApi.Route

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.lightningj.lnd.proto.LightningApi.Route

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, LightningApi.RouteOrBuilder

Enclosing class:

LightningApi

public static final class LightningApi.Route
extends com.google.protobuf.GeneratedMessageV3
implements LightningApi.RouteOrBuilder

A path through the channel graph which runs over one or more channels in
succession. This struct carries all the information required to craft the
Sphinx onion packet, and send the payment along the first hop in the path. A
route is only selected as valid if all the channels have sufficient capacity to
carry the initial payment amount after fees are accounted for.
 

Protobuf type lnrpc.Route

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LightningApi.Route.Builder A path through the channel graph which runs over one or more channels in succession.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

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

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	HOPS_FIELD_NUMBER
static int	TOTAL_AMT_FIELD_NUMBER
static int	TOTAL_AMT_MSAT_FIELD_NUMBER
static int	TOTAL_FEES_FIELD_NUMBER
static int	TOTAL_FEES_MSAT_FIELD_NUMBER
static int	TOTAL_TIME_LOCK_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static LightningApi.Route	getDefaultInstance()
LightningApi.Route	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
LightningApi.Hop	getHops(int index) Contains details concerning the specific forwarding details at each hop.
int	getHopsCount() Contains details concerning the specific forwarding details at each hop.
java.util.List<LightningApi.Hop>	getHopsList() Contains details concerning the specific forwarding details at each hop.
LightningApi.HopOrBuilder	getHopsOrBuilder(int index) Contains details concerning the specific forwarding details at each hop.
java.util.List<? extends LightningApi.HopOrBuilder>	getHopsOrBuilderList() Contains details concerning the specific forwarding details at each hop.
com.google.protobuf.Parser<LightningApi.Route>	getParserForType()
int	getSerializedSize()
long	getTotalAmt() Deprecated. lnrpc.Route.total_amt is deprecated. See lightning.api.proto;l=3179
long	getTotalAmtMsat() The total amount in millisatoshis.
long	getTotalFees() Deprecated. lnrpc.Route.total_fees is deprecated. See lightning.api.proto;l=3170
long	getTotalFeesMsat() The total fees in millisatoshis.
int	getTotalTimeLock() The cumulative (final) time lock across the entire route.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static LightningApi.Route.Builder	newBuilder()
static LightningApi.Route.Builder	newBuilder(LightningApi.Route prototype)
LightningApi.Route.Builder	newBuilderForType()
protected LightningApi.Route.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static LightningApi.Route	parseDelimitedFrom(java.io.InputStream input)
static LightningApi.Route	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.Route	parseFrom(byte[] data)
static LightningApi.Route	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.Route	parseFrom(java.nio.ByteBuffer data)
static LightningApi.Route	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.Route	parseFrom(com.google.protobuf.ByteString data)
static LightningApi.Route	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.Route	parseFrom(com.google.protobuf.CodedInputStream input)
static LightningApi.Route	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.Route	parseFrom(java.io.InputStream input)
static LightningApi.Route	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<LightningApi.Route>	parser()
LightningApi.Route.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

TOTAL_TIME_LOCK_FIELD_NUMBER

public static final int TOTAL_TIME_LOCK_FIELD_NUMBER

See Also:

Constant Field Values

TOTAL_FEES_FIELD_NUMBER

public static final int TOTAL_FEES_FIELD_NUMBER

See Also:

Constant Field Values

TOTAL_AMT_FIELD_NUMBER

public static final int TOTAL_AMT_FIELD_NUMBER

See Also:

Constant Field Values

HOPS_FIELD_NUMBER

public static final int HOPS_FIELD_NUMBER

See Also:

Constant Field Values

TOTAL_FEES_MSAT_FIELD_NUMBER

public static final int TOTAL_FEES_MSAT_FIELD_NUMBER

See Also:

Constant Field Values

TOTAL_AMT_MSAT_FIELD_NUMBER

public static final int TOTAL_AMT_MSAT_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getTotalTimeLock

public int getTotalTimeLock()

The cumulative (final) time lock across the entire route. This is the CLTV
value that should be extended to the first hop in the route. All other hops
will decrement the time-lock as advertised, leaving enough time for all
hops to wait for or present the payment preimage to complete the payment.
 

uint32 total_time_lock = 1;

Specified by:

getTotalTimeLock in interface LightningApi.RouteOrBuilder

Returns:

The totalTimeLock.

getTotalFees

@Deprecated
public long getTotalFees()

Deprecated. lnrpc.Route.total_fees is deprecated. See lightning.api.proto;l=3170

The sum of the fees paid at each hop within the final route. In the case
of a one-hop payment, this value will be zero as we don't need to pay a fee
to ourselves.
 

int64 total_fees = 2 [deprecated = true];

Specified by:

getTotalFees in interface LightningApi.RouteOrBuilder

Returns:

The totalFees.

getTotalAmt

@Deprecated
public long getTotalAmt()

Deprecated. lnrpc.Route.total_amt is deprecated. See lightning.api.proto;l=3179

The total amount of funds required to complete a payment over this route.
This value includes the cumulative fees at each hop. As a result, the HTLC
extended to the first-hop in the route will need to have at least this many
satoshis, otherwise the route will fail at an intermediate node due to an
insufficient amount of fees.
 

int64 total_amt = 3 [deprecated = true];

Specified by:

getTotalAmt in interface LightningApi.RouteOrBuilder

Returns:

The totalAmt.

getHopsList

public java.util.List<LightningApi.Hop> getHopsList()

Contains details concerning the specific forwarding details at each hop.
 

repeated .lnrpc.Hop hops = 4;

Specified by:

getHopsList in interface LightningApi.RouteOrBuilder

getHopsOrBuilderList

public java.util.List<? extends LightningApi.HopOrBuilder> getHopsOrBuilderList()

Contains details concerning the specific forwarding details at each hop.
 

repeated .lnrpc.Hop hops = 4;

Specified by:

getHopsOrBuilderList in interface LightningApi.RouteOrBuilder

getHopsCount

public int getHopsCount()

Contains details concerning the specific forwarding details at each hop.
 

repeated .lnrpc.Hop hops = 4;

Specified by:

getHopsCount in interface LightningApi.RouteOrBuilder

getHops

public LightningApi.Hop getHops(int index)

Contains details concerning the specific forwarding details at each hop.
 

repeated .lnrpc.Hop hops = 4;

Specified by:

getHops in interface LightningApi.RouteOrBuilder

getHopsOrBuilder

public LightningApi.HopOrBuilder getHopsOrBuilder(int index)

Contains details concerning the specific forwarding details at each hop.
 

repeated .lnrpc.Hop hops = 4;

Specified by:

getHopsOrBuilder in interface LightningApi.RouteOrBuilder

getTotalFeesMsat

public long getTotalFeesMsat()

The total fees in millisatoshis.
 

int64 total_fees_msat = 5;

Specified by:

getTotalFeesMsat in interface LightningApi.RouteOrBuilder

Returns:

The totalFeesMsat.

getTotalAmtMsat

public long getTotalAmtMsat()

The total amount in millisatoshis.
 

int64 total_amt_msat = 6;

Specified by:

getTotalAmtMsat in interface LightningApi.RouteOrBuilder

Returns:

The totalAmtMsat.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static LightningApi.Route parseFrom(java.nio.ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.Route parseFrom(java.nio.ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.Route parseFrom(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.Route parseFrom(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.Route parseFrom(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.Route parseFrom(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.Route parseFrom(java.io.InputStream input)
                                    throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static LightningApi.Route parseFrom(java.io.InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static LightningApi.Route parseDelimitedFrom(java.io.InputStream input)
                                             throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static LightningApi.Route parseDelimitedFrom(java.io.InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static LightningApi.Route parseFrom(com.google.protobuf.CodedInputStream input)
                                    throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static LightningApi.Route parseFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public LightningApi.Route.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static LightningApi.Route.Builder newBuilder()

newBuilder

public static LightningApi.Route.Builder newBuilder(LightningApi.Route prototype)

toBuilder

public LightningApi.Route.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected LightningApi.Route.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static LightningApi.Route getDefaultInstance()

parser

public static com.google.protobuf.Parser<LightningApi.Route> parser()

getParserForType

public com.google.protobuf.Parser<LightningApi.Route> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public LightningApi.Route getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder