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
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.
|
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 |
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 |
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) |
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
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 TOTAL_TIME_LOCK_FIELD_NUMBER
public static final int TOTAL_FEES_FIELD_NUMBER
public static final int TOTAL_AMT_FIELD_NUMBER
public static final int HOPS_FIELD_NUMBER
public static final int TOTAL_FEES_MSAT_FIELD_NUMBER
public static final int TOTAL_AMT_MSAT_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.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
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;
getTotalTimeLock
in interface LightningApi.RouteOrBuilder
@Deprecated public long getTotalFees()
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];
getTotalFees
in interface LightningApi.RouteOrBuilder
@Deprecated public long getTotalAmt()
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];
getTotalAmt
in interface LightningApi.RouteOrBuilder
public java.util.List<LightningApi.Hop> getHopsList()
Contains details concerning the specific forwarding details at each hop.
repeated .lnrpc.Hop hops = 4;
getHopsList
in interface LightningApi.RouteOrBuilder
public java.util.List<? extends LightningApi.HopOrBuilder> getHopsOrBuilderList()
Contains details concerning the specific forwarding details at each hop.
repeated .lnrpc.Hop hops = 4;
getHopsOrBuilderList
in interface LightningApi.RouteOrBuilder
public int getHopsCount()
Contains details concerning the specific forwarding details at each hop.
repeated .lnrpc.Hop hops = 4;
getHopsCount
in interface LightningApi.RouteOrBuilder
public LightningApi.Hop getHops(int index)
Contains details concerning the specific forwarding details at each hop.
repeated .lnrpc.Hop hops = 4;
getHops
in interface LightningApi.RouteOrBuilder
public LightningApi.HopOrBuilder getHopsOrBuilder(int index)
Contains details concerning the specific forwarding details at each hop.
repeated .lnrpc.Hop hops = 4;
getHopsOrBuilder
in interface LightningApi.RouteOrBuilder
public long getTotalFeesMsat()
The total fees in millisatoshis.
int64 total_fees_msat = 5;
getTotalFeesMsat
in interface LightningApi.RouteOrBuilder
public long getTotalAmtMsat()
The total amount in millisatoshis.
int64 total_amt_msat = 6;
getTotalAmtMsat
in interface LightningApi.RouteOrBuilder
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.Route parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.Route parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.Route parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.Route parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.Route parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.Route parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.Route parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static LightningApi.Route parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static LightningApi.Route parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static LightningApi.Route parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static LightningApi.Route parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
java.io.IOException
public static LightningApi.Route parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public LightningApi.Route.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static LightningApi.Route.Builder newBuilder()
public static LightningApi.Route.Builder newBuilder(LightningApi.Route prototype)
public LightningApi.Route.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected LightningApi.Route.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static LightningApi.Route getDefaultInstance()
public static com.google.protobuf.Parser<LightningApi.Route> parser()
public com.google.protobuf.Parser<LightningApi.Route> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public LightningApi.Route getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder