public static final class LightningApi.Route.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.Route.Builder> 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 | Method and Description |
---|---|
LightningApi.Route.Builder |
addAllHops(java.lang.Iterable<? extends LightningApi.Hop> values)
Contains details concerning the specific forwarding details at each hop.
|
LightningApi.Route.Builder |
addHops(int index,
LightningApi.Hop.Builder builderForValue)
Contains details concerning the specific forwarding details at each hop.
|
LightningApi.Route.Builder |
addHops(int index,
LightningApi.Hop value)
Contains details concerning the specific forwarding details at each hop.
|
LightningApi.Route.Builder |
addHops(LightningApi.Hop.Builder builderForValue)
Contains details concerning the specific forwarding details at each hop.
|
LightningApi.Route.Builder |
addHops(LightningApi.Hop value)
Contains details concerning the specific forwarding details at each hop.
|
LightningApi.Hop.Builder |
addHopsBuilder()
Contains details concerning the specific forwarding details at each hop.
|
LightningApi.Hop.Builder |
addHopsBuilder(int index)
Contains details concerning the specific forwarding details at each hop.
|
LightningApi.Route |
build() |
LightningApi.Route |
buildPartial() |
LightningApi.Route.Builder |
clear() |
LightningApi.Route.Builder |
clearHops()
Contains details concerning the specific forwarding details at each hop.
|
LightningApi.Route.Builder |
clearTotalAmt()
Deprecated.
lnrpc.Route.total_amt is deprecated.
See lightning.api.proto;l=3179
|
LightningApi.Route.Builder |
clearTotalAmtMsat()
The total amount in millisatoshis.
|
LightningApi.Route.Builder |
clearTotalFees()
Deprecated.
lnrpc.Route.total_fees is deprecated.
See lightning.api.proto;l=3170
|
LightningApi.Route.Builder |
clearTotalFeesMsat()
The total fees in millisatoshis.
|
LightningApi.Route.Builder |
clearTotalTimeLock()
The cumulative (final) time lock across the entire route.
|
LightningApi.Route |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
LightningApi.Hop |
getHops(int index)
Contains details concerning the specific forwarding details at each hop.
|
LightningApi.Hop.Builder |
getHopsBuilder(int index)
Contains details concerning the specific forwarding details at each hop.
|
java.util.List<LightningApi.Hop.Builder> |
getHopsBuilderList()
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.
|
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.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
LightningApi.Route.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
LightningApi.Route.Builder |
mergeFrom(LightningApi.Route other) |
LightningApi.Route.Builder |
mergeFrom(com.google.protobuf.Message other) |
LightningApi.Route.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
LightningApi.Route.Builder |
removeHops(int index)
Contains details concerning the specific forwarding details at each hop.
|
LightningApi.Route.Builder |
setHops(int index,
LightningApi.Hop.Builder builderForValue)
Contains details concerning the specific forwarding details at each hop.
|
LightningApi.Route.Builder |
setHops(int index,
LightningApi.Hop value)
Contains details concerning the specific forwarding details at each hop.
|
LightningApi.Route.Builder |
setTotalAmt(long value)
Deprecated.
lnrpc.Route.total_amt is deprecated.
See lightning.api.proto;l=3179
|
LightningApi.Route.Builder |
setTotalAmtMsat(long value)
The total amount in millisatoshis.
|
LightningApi.Route.Builder |
setTotalFees(long value)
Deprecated.
lnrpc.Route.total_fees is deprecated.
See lightning.api.proto;l=3170
|
LightningApi.Route.Builder |
setTotalFeesMsat(long value)
The total fees in millisatoshis.
|
LightningApi.Route.Builder |
setTotalTimeLock(int value)
The cumulative (final) time lock across the entire route.
|
LightningApi.Route.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.Route.Builder>
public LightningApi.Route.Builder clear()
clear
in interface com.google.protobuf.Message.Builder
clear
in interface com.google.protobuf.MessageLite.Builder
clear
in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.Route.Builder>
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType
in interface com.google.protobuf.Message.Builder
getDescriptorForType
in interface com.google.protobuf.MessageOrBuilder
getDescriptorForType
in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.Route.Builder>
public LightningApi.Route getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
public LightningApi.Route build()
build
in interface com.google.protobuf.Message.Builder
build
in interface com.google.protobuf.MessageLite.Builder
public LightningApi.Route buildPartial()
buildPartial
in interface com.google.protobuf.Message.Builder
buildPartial
in interface com.google.protobuf.MessageLite.Builder
public LightningApi.Route.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom
in interface com.google.protobuf.Message.Builder
mergeFrom
in class com.google.protobuf.AbstractMessage.Builder<LightningApi.Route.Builder>
public LightningApi.Route.Builder mergeFrom(LightningApi.Route other)
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.Route.Builder>
public LightningApi.Route.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
mergeFrom
in interface com.google.protobuf.Message.Builder
mergeFrom
in interface com.google.protobuf.MessageLite.Builder
mergeFrom
in class com.google.protobuf.AbstractMessage.Builder<LightningApi.Route.Builder>
java.io.IOException
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
public LightningApi.Route.Builder setTotalTimeLock(int value)
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;
value
- The totalTimeLock to set.public LightningApi.Route.Builder clearTotalTimeLock()
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;
@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 LightningApi.Route.Builder setTotalFees(long value)
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];
value
- The totalFees to set.@Deprecated public LightningApi.Route.Builder clearTotalFees()
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];
@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
@Deprecated public LightningApi.Route.Builder setTotalAmt(long value)
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];
value
- The totalAmt to set.@Deprecated public LightningApi.Route.Builder clearTotalAmt()
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];
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 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.Route.Builder setHops(int index, LightningApi.Hop value)
Contains details concerning the specific forwarding details at each hop.
repeated .lnrpc.Hop hops = 4;
public LightningApi.Route.Builder setHops(int index, LightningApi.Hop.Builder builderForValue)
Contains details concerning the specific forwarding details at each hop.
repeated .lnrpc.Hop hops = 4;
public LightningApi.Route.Builder addHops(LightningApi.Hop value)
Contains details concerning the specific forwarding details at each hop.
repeated .lnrpc.Hop hops = 4;
public LightningApi.Route.Builder addHops(int index, LightningApi.Hop value)
Contains details concerning the specific forwarding details at each hop.
repeated .lnrpc.Hop hops = 4;
public LightningApi.Route.Builder addHops(LightningApi.Hop.Builder builderForValue)
Contains details concerning the specific forwarding details at each hop.
repeated .lnrpc.Hop hops = 4;
public LightningApi.Route.Builder addHops(int index, LightningApi.Hop.Builder builderForValue)
Contains details concerning the specific forwarding details at each hop.
repeated .lnrpc.Hop hops = 4;
public LightningApi.Route.Builder addAllHops(java.lang.Iterable<? extends LightningApi.Hop> values)
Contains details concerning the specific forwarding details at each hop.
repeated .lnrpc.Hop hops = 4;
public LightningApi.Route.Builder clearHops()
Contains details concerning the specific forwarding details at each hop.
repeated .lnrpc.Hop hops = 4;
public LightningApi.Route.Builder removeHops(int index)
Contains details concerning the specific forwarding details at each hop.
repeated .lnrpc.Hop hops = 4;
public LightningApi.Hop.Builder getHopsBuilder(int index)
Contains details concerning the specific forwarding details at each hop.
repeated .lnrpc.Hop hops = 4;
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 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 LightningApi.Hop.Builder addHopsBuilder()
Contains details concerning the specific forwarding details at each hop.
repeated .lnrpc.Hop hops = 4;
public LightningApi.Hop.Builder addHopsBuilder(int index)
Contains details concerning the specific forwarding details at each hop.
repeated .lnrpc.Hop hops = 4;
public java.util.List<LightningApi.Hop.Builder> getHopsBuilderList()
Contains details concerning the specific forwarding details at each hop.
repeated .lnrpc.Hop hops = 4;
public long getTotalFeesMsat()
The total fees in millisatoshis.
int64 total_fees_msat = 5;
getTotalFeesMsat
in interface LightningApi.RouteOrBuilder
public LightningApi.Route.Builder setTotalFeesMsat(long value)
The total fees in millisatoshis.
int64 total_fees_msat = 5;
value
- The totalFeesMsat to set.public LightningApi.Route.Builder clearTotalFeesMsat()
The total fees in millisatoshis.
int64 total_fees_msat = 5;
public long getTotalAmtMsat()
The total amount in millisatoshis.
int64 total_amt_msat = 6;
getTotalAmtMsat
in interface LightningApi.RouteOrBuilder
public LightningApi.Route.Builder setTotalAmtMsat(long value)
The total amount in millisatoshis.
int64 total_amt_msat = 6;
value
- The totalAmtMsat to set.public LightningApi.Route.Builder clearTotalAmtMsat()
The total amount in millisatoshis.
int64 total_amt_msat = 6;
public final LightningApi.Route.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields
in interface com.google.protobuf.Message.Builder
setUnknownFields
in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.Route.Builder>
public final LightningApi.Route.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields
in interface com.google.protobuf.Message.Builder
mergeUnknownFields
in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.Route.Builder>