public static interface LightningApi.QueryRoutesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsDestCustomRecords(long key)
An optional field that can be used to pass an arbitrary set of TLV records
to a peer which understands the new records.
|
long |
getAmt()
The amount to send expressed in satoshis.
|
long |
getAmtMsat()
The amount to send expressed in millisatoshis.
|
int |
getCltvLimit()
An optional maximum total time lock for the route.
|
java.util.Map<java.lang.Long,com.google.protobuf.ByteString> |
getDestCustomRecords()
Deprecated.
|
int |
getDestCustomRecordsCount()
An optional field that can be used to pass an arbitrary set of TLV records
to a peer which understands the new records.
|
java.util.Map<java.lang.Long,com.google.protobuf.ByteString> |
getDestCustomRecordsMap()
An optional field that can be used to pass an arbitrary set of TLV records
to a peer which understands the new records.
|
com.google.protobuf.ByteString |
getDestCustomRecordsOrDefault(long key,
com.google.protobuf.ByteString defaultValue)
An optional field that can be used to pass an arbitrary set of TLV records
to a peer which understands the new records.
|
com.google.protobuf.ByteString |
getDestCustomRecordsOrThrow(long key)
An optional field that can be used to pass an arbitrary set of TLV records
to a peer which understands the new records.
|
LightningApi.FeatureBit |
getDestFeatures(int index)
Features assumed to be supported by the final node.
|
int |
getDestFeaturesCount()
Features assumed to be supported by the final node.
|
java.util.List<LightningApi.FeatureBit> |
getDestFeaturesList()
Features assumed to be supported by the final node.
|
int |
getDestFeaturesValue(int index)
Features assumed to be supported by the final node.
|
java.util.List<java.lang.Integer> |
getDestFeaturesValueList()
Features assumed to be supported by the final node.
|
LightningApi.FeeLimit |
getFeeLimit()
The maximum number of satoshis that will be paid as a fee of the payment.
|
LightningApi.FeeLimitOrBuilder |
getFeeLimitOrBuilder()
The maximum number of satoshis that will be paid as a fee of the payment.
|
int |
getFinalCltvDelta()
An optional CLTV delta from the current height that should be used for the
timelock of the final hop.
|
LightningApi.EdgeLocator |
getIgnoredEdges(int index)
Deprecated.
|
int |
getIgnoredEdgesCount()
Deprecated.
|
java.util.List<LightningApi.EdgeLocator> |
getIgnoredEdgesList()
Deprecated.
|
LightningApi.EdgeLocatorOrBuilder |
getIgnoredEdgesOrBuilder(int index)
Deprecated.
|
java.util.List<? extends LightningApi.EdgeLocatorOrBuilder> |
getIgnoredEdgesOrBuilderList()
Deprecated.
|
com.google.protobuf.ByteString |
getIgnoredNodes(int index)
A list of nodes to ignore during path finding.
|
int |
getIgnoredNodesCount()
A list of nodes to ignore during path finding.
|
java.util.List<com.google.protobuf.ByteString> |
getIgnoredNodesList()
A list of nodes to ignore during path finding.
|
LightningApi.NodePair |
getIgnoredPairs(int index)
A list of directed node pairs that will be ignored during path finding.
|
int |
getIgnoredPairsCount()
A list of directed node pairs that will be ignored during path finding.
|
java.util.List<LightningApi.NodePair> |
getIgnoredPairsList()
A list of directed node pairs that will be ignored during path finding.
|
LightningApi.NodePairOrBuilder |
getIgnoredPairsOrBuilder(int index)
A list of directed node pairs that will be ignored during path finding.
|
java.util.List<? extends LightningApi.NodePairOrBuilder> |
getIgnoredPairsOrBuilderList()
A list of directed node pairs that will be ignored during path finding.
|
com.google.protobuf.ByteString |
getLastHopPubkey()
The pubkey of the last hop of the route.
|
long |
getOutgoingChanId()
The channel id of the channel that must be taken to the first hop.
|
java.lang.String |
getPubKey()
The 33-byte hex-encoded public key for the payment destination
|
com.google.protobuf.ByteString |
getPubKeyBytes()
The 33-byte hex-encoded public key for the payment destination
|
LightningApi.RouteHint |
getRouteHints(int index)
Optional route hints to reach the destination through private channels.
|
int |
getRouteHintsCount()
Optional route hints to reach the destination through private channels.
|
java.util.List<LightningApi.RouteHint> |
getRouteHintsList()
Optional route hints to reach the destination through private channels.
|
LightningApi.RouteHintOrBuilder |
getRouteHintsOrBuilder(int index)
Optional route hints to reach the destination through private channels.
|
java.util.List<? extends LightningApi.RouteHintOrBuilder> |
getRouteHintsOrBuilderList()
Optional route hints to reach the destination through private channels.
|
java.lang.String |
getSourcePubKey()
The source node where the request route should originated from.
|
com.google.protobuf.ByteString |
getSourcePubKeyBytes()
The source node where the request route should originated from.
|
double |
getTimePref()
The time preference for this payment.
|
boolean |
getUseMissionControl()
If set to true, edge probabilities from mission control will be used to get
the optimal route.
|
boolean |
hasFeeLimit()
The maximum number of satoshis that will be paid as a fee of the payment.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofjava.lang.String getPubKey()
The 33-byte hex-encoded public key for the payment destination
string pub_key = 1;com.google.protobuf.ByteString getPubKeyBytes()
The 33-byte hex-encoded public key for the payment destination
string pub_key = 1;long getAmt()
The amount to send expressed in satoshis. The fields amt and amt_msat are mutually exclusive.
int64 amt = 2;long getAmtMsat()
The amount to send expressed in millisatoshis. The fields amt and amt_msat are mutually exclusive.
int64 amt_msat = 12;int getFinalCltvDelta()
An optional CLTV delta from the current height that should be used for the timelock of the final hop. Note that unlike SendPayment, QueryRoutes does not add any additional block padding on top of final_ctlv_delta. This padding of a few blocks needs to be added manually or otherwise failures may happen when a block comes in while the payment is in flight.
int32 final_cltv_delta = 4;boolean hasFeeLimit()
The maximum number of satoshis that will be paid as a fee of the payment. This value can be represented either as a percentage of the amount being sent, or as a fixed amount of the maximum fee the user is willing the pay to send the payment. If not specified, lnd will use a default value of 100% fees for small amounts (<=1k sat) or 5% fees for larger amounts.
.lnrpc.FeeLimit fee_limit = 5;LightningApi.FeeLimit getFeeLimit()
The maximum number of satoshis that will be paid as a fee of the payment. This value can be represented either as a percentage of the amount being sent, or as a fixed amount of the maximum fee the user is willing the pay to send the payment. If not specified, lnd will use a default value of 100% fees for small amounts (<=1k sat) or 5% fees for larger amounts.
.lnrpc.FeeLimit fee_limit = 5;LightningApi.FeeLimitOrBuilder getFeeLimitOrBuilder()
The maximum number of satoshis that will be paid as a fee of the payment. This value can be represented either as a percentage of the amount being sent, or as a fixed amount of the maximum fee the user is willing the pay to send the payment. If not specified, lnd will use a default value of 100% fees for small amounts (<=1k sat) or 5% fees for larger amounts.
.lnrpc.FeeLimit fee_limit = 5;java.util.List<com.google.protobuf.ByteString> getIgnoredNodesList()
A list of nodes to ignore during path finding. When using REST, these fields must be encoded as base64.
repeated bytes ignored_nodes = 6;int getIgnoredNodesCount()
A list of nodes to ignore during path finding. When using REST, these fields must be encoded as base64.
repeated bytes ignored_nodes = 6;com.google.protobuf.ByteString getIgnoredNodes(int index)
A list of nodes to ignore during path finding. When using REST, these fields must be encoded as base64.
repeated bytes ignored_nodes = 6;index - The index of the element to return.@Deprecated java.util.List<LightningApi.EdgeLocator> getIgnoredEdgesList()
Deprecated. A list of edges to ignore during path finding.
repeated .lnrpc.EdgeLocator ignored_edges = 7 [deprecated = true];@Deprecated LightningApi.EdgeLocator getIgnoredEdges(int index)
Deprecated. A list of edges to ignore during path finding.
repeated .lnrpc.EdgeLocator ignored_edges = 7 [deprecated = true];@Deprecated int getIgnoredEdgesCount()
Deprecated. A list of edges to ignore during path finding.
repeated .lnrpc.EdgeLocator ignored_edges = 7 [deprecated = true];@Deprecated java.util.List<? extends LightningApi.EdgeLocatorOrBuilder> getIgnoredEdgesOrBuilderList()
Deprecated. A list of edges to ignore during path finding.
repeated .lnrpc.EdgeLocator ignored_edges = 7 [deprecated = true];@Deprecated LightningApi.EdgeLocatorOrBuilder getIgnoredEdgesOrBuilder(int index)
Deprecated. A list of edges to ignore during path finding.
repeated .lnrpc.EdgeLocator ignored_edges = 7 [deprecated = true];java.lang.String getSourcePubKey()
The source node where the request route should originated from. If empty, self is assumed.
string source_pub_key = 8;com.google.protobuf.ByteString getSourcePubKeyBytes()
The source node where the request route should originated from. If empty, self is assumed.
string source_pub_key = 8;boolean getUseMissionControl()
If set to true, edge probabilities from mission control will be used to get the optimal route.
bool use_mission_control = 9;java.util.List<LightningApi.NodePair> getIgnoredPairsList()
A list of directed node pairs that will be ignored during path finding.
repeated .lnrpc.NodePair ignored_pairs = 10;LightningApi.NodePair getIgnoredPairs(int index)
A list of directed node pairs that will be ignored during path finding.
repeated .lnrpc.NodePair ignored_pairs = 10;int getIgnoredPairsCount()
A list of directed node pairs that will be ignored during path finding.
repeated .lnrpc.NodePair ignored_pairs = 10;java.util.List<? extends LightningApi.NodePairOrBuilder> getIgnoredPairsOrBuilderList()
A list of directed node pairs that will be ignored during path finding.
repeated .lnrpc.NodePair ignored_pairs = 10;LightningApi.NodePairOrBuilder getIgnoredPairsOrBuilder(int index)
A list of directed node pairs that will be ignored during path finding.
repeated .lnrpc.NodePair ignored_pairs = 10;int getCltvLimit()
An optional maximum total time lock for the route. If the source is empty or ourselves, this should not exceed lnd's `--max-cltv-expiry` setting. If zero, then the value of `--max-cltv-expiry` is used as the limit.
uint32 cltv_limit = 11;int getDestCustomRecordsCount()
An optional field that can be used to pass an arbitrary set of TLV records to a peer which understands the new records. This can be used to pass application specific data during the payment attempt. If the destination does not support the specified records, an error will be returned. Record types are required to be in the custom range >= 65536. When using REST, the values must be encoded as base64.
map<uint64, bytes> dest_custom_records = 13;boolean containsDestCustomRecords(long key)
An optional field that can be used to pass an arbitrary set of TLV records to a peer which understands the new records. This can be used to pass application specific data during the payment attempt. If the destination does not support the specified records, an error will be returned. Record types are required to be in the custom range >= 65536. When using REST, the values must be encoded as base64.
map<uint64, bytes> dest_custom_records = 13;@Deprecated java.util.Map<java.lang.Long,com.google.protobuf.ByteString> getDestCustomRecords()
getDestCustomRecordsMap() instead.java.util.Map<java.lang.Long,com.google.protobuf.ByteString> getDestCustomRecordsMap()
An optional field that can be used to pass an arbitrary set of TLV records to a peer which understands the new records. This can be used to pass application specific data during the payment attempt. If the destination does not support the specified records, an error will be returned. Record types are required to be in the custom range >= 65536. When using REST, the values must be encoded as base64.
map<uint64, bytes> dest_custom_records = 13;com.google.protobuf.ByteString getDestCustomRecordsOrDefault(long key,
com.google.protobuf.ByteString defaultValue)
An optional field that can be used to pass an arbitrary set of TLV records to a peer which understands the new records. This can be used to pass application specific data during the payment attempt. If the destination does not support the specified records, an error will be returned. Record types are required to be in the custom range >= 65536. When using REST, the values must be encoded as base64.
map<uint64, bytes> dest_custom_records = 13;com.google.protobuf.ByteString getDestCustomRecordsOrThrow(long key)
An optional field that can be used to pass an arbitrary set of TLV records to a peer which understands the new records. This can be used to pass application specific data during the payment attempt. If the destination does not support the specified records, an error will be returned. Record types are required to be in the custom range >= 65536. When using REST, the values must be encoded as base64.
map<uint64, bytes> dest_custom_records = 13;long getOutgoingChanId()
The channel id of the channel that must be taken to the first hop. If zero, any channel may be used.
uint64 outgoing_chan_id = 14 [jstype = JS_STRING];com.google.protobuf.ByteString getLastHopPubkey()
The pubkey of the last hop of the route. If empty, any hop may be used.
bytes last_hop_pubkey = 15;java.util.List<LightningApi.RouteHint> getRouteHintsList()
Optional route hints to reach the destination through private channels.
repeated .lnrpc.RouteHint route_hints = 16;LightningApi.RouteHint getRouteHints(int index)
Optional route hints to reach the destination through private channels.
repeated .lnrpc.RouteHint route_hints = 16;int getRouteHintsCount()
Optional route hints to reach the destination through private channels.
repeated .lnrpc.RouteHint route_hints = 16;java.util.List<? extends LightningApi.RouteHintOrBuilder> getRouteHintsOrBuilderList()
Optional route hints to reach the destination through private channels.
repeated .lnrpc.RouteHint route_hints = 16;LightningApi.RouteHintOrBuilder getRouteHintsOrBuilder(int index)
Optional route hints to reach the destination through private channels.
repeated .lnrpc.RouteHint route_hints = 16;java.util.List<LightningApi.FeatureBit> getDestFeaturesList()
Features assumed to be supported by the final node. All transitive feature dependencies must also be set properly. For a given feature bit pair, either optional or remote may be set, but not both. If this field is nil or empty, the router will try to load destination features from the graph as a fallback.
repeated .lnrpc.FeatureBit dest_features = 17;int getDestFeaturesCount()
Features assumed to be supported by the final node. All transitive feature dependencies must also be set properly. For a given feature bit pair, either optional or remote may be set, but not both. If this field is nil or empty, the router will try to load destination features from the graph as a fallback.
repeated .lnrpc.FeatureBit dest_features = 17;LightningApi.FeatureBit getDestFeatures(int index)
Features assumed to be supported by the final node. All transitive feature dependencies must also be set properly. For a given feature bit pair, either optional or remote may be set, but not both. If this field is nil or empty, the router will try to load destination features from the graph as a fallback.
repeated .lnrpc.FeatureBit dest_features = 17;index - The index of the element to return.java.util.List<java.lang.Integer> getDestFeaturesValueList()
Features assumed to be supported by the final node. All transitive feature dependencies must also be set properly. For a given feature bit pair, either optional or remote may be set, but not both. If this field is nil or empty, the router will try to load destination features from the graph as a fallback.
repeated .lnrpc.FeatureBit dest_features = 17;int getDestFeaturesValue(int index)
Features assumed to be supported by the final node. All transitive feature dependencies must also be set properly. For a given feature bit pair, either optional or remote may be set, but not both. If this field is nil or empty, the router will try to load destination features from the graph as a fallback.
repeated .lnrpc.FeatureBit dest_features = 17;index - The index of the value to return.double getTimePref()
The time preference for this payment. Set to -1 to optimize for fees only, to 1 to optimize for reliability only or a value inbetween for a mix.
double time_pref = 18;