mirrors/bitcoin-s
1
0
Fork 0
mirror of https://github.com/bitcoin-s/bitcoin-s.git synced 2025-03-19 13:35:17 +01:00
Code Issues Projects Releases Packages Wiki Activity
bitcoin-s/api/lnrpc/QueryRoutesRequest.html

89 lines
167 KiB
HTML
Raw Normal View History

Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
<!DOCTYPE html ><html><head><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport"/><title></title><meta content="" name="description"/><meta content="" name="keywords"/><meta http-equiv="content-type" content="text/html; charset=UTF-8"/><link href="../lib/index.css" media="screen" type="text/css" rel="stylesheet"/><link href="../lib/template.css" media="screen" type="text/css" rel="stylesheet"/><link href="../lib/print.css" media="print" type="text/css" rel="stylesheet"/><link href="../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css"/><script type="text/javascript" src="../lib/jquery.min.js"></script><script type="text/javascript" src="../lib/index.js"></script><script type="text/javascript" src="../index.js"></script><script type="text/javascript" src="../lib/scheduler.js"></script><script type="text/javascript" src="../lib/template.js"></script><script type="text/javascript">/* this variable can be used by the JS to determine the path to the root document */
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
var toRoot = '../';</script></head><body><div id="search"><span id="doc-title"><span id="doc-version"></span></span> <span class="close-results"><span class="left">&lt;</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_" class="anchorToMember"></a><a id="root:_root_" class="anchorToMember"></a> <span class="permalink"><a href="../index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 " name="_root_.lnrpc" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="lnrpc" class="anchorToMember"></a><a id="lnrpc:lnrpc" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="index.html" title=""><span class="name">lnrpc</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="current-entities indented1"><a href="AMP$.html" title="" class="object"></a> <a href="AMP.html" title="Details specific to AMP HTLCs." class="class"></a><a href="AMP.html" title="Details specific to AMP HTLCs.">AMP</a></li><li class="current-entities indented1"><a href="AMPInvoiceState$.html" title="" class="object"></a> <a href="AMPInvoiceState.html" title="" class="class"></a><a href="AMPInvoiceState.html" title="">AMPInvoiceState</a></li><li class="current-entities indented1"><a href="AMPRecord$.html" title="" class="object"></a> <a href="AMPRecord.html" title="" class="class"></a><a href="AMPRecord.html" title="">AMPRecord</a></li><li class="current-entities indented1"><a href="AbandonChannelRequest$.html" title="" class="object"></a> <a href="AbandonChannelRequest.html" title="" class="class"></a><a href="AbandonChannelRequest.html" title="">AbandonChannelRequest</a></li><li class="current-entities indented1"><a href="AbandonChannelResponse$.html" title="" class="object"></a> <a href="AbandonChannelResponse.html" title="" class="class"></a><a href="AbandonChannelResponse.html" title="">AbandonChannelResponse</a></li><li class="current-entities indented1"><a href="AddInvoiceResponse$.html" title="" class="object"></a> <a href="AddInvoiceResponse.html" title="" class="class"></a><a href="AddInvoiceResponse.html" title="">AddInvoiceResponse</a></li><li class="current-entities indented1"><a href="AddressType$.html" title="" class="object"></a> <a href="AddressType.html" title="AddressType has to be one of:" class="class"></a><a href="AddressType.html" title="AddressType has to be one of:">AddressType</a></li><li class="current-entities indented1"><a href="AliasMap$.html" title="" class="object"></a> <a href="AliasMap.html" title="" class="class"></a><a href="AliasMap.html" title="">AliasMap</a></li><li class="current-entities indented1"><a href=
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The 33-byte hex-encoded public key for the payment destination</p></dd><dt class="param">amt</dt><dd class="cmt"><p>
The amount to send expressed in satoshis.
The fields amt and amt_msat are mutually exclusive.</p></dd><dt class="param">amtMsat</dt><dd class="cmt"><p>
The amount to send expressed in millisatoshis.
The fields amt and amt_msat are mutually exclusive.</p></dd><dt class="param">finalCltvDelta</dt><dd class="cmt"><p>
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.</p></dd><dt class="param">feeLimit</dt><dd class="cmt"><p>
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
Deploy website Deploy website version based on 142612f0342f3bd1fc9021b72c384bae9b9475ba
2022-02-04 12:38:32 +00:00
send the payment. If not specified, lnd will use a default value of 100%
fees for small amounts (&lt;=1k sat) or 5% fees for larger amounts.</p></dd><dt class="param">ignoredNodes</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
A list of nodes to ignore during path finding. When using REST, these fields
must be encoded as base64.</p></dd><dt class="param">ignoredEdges</dt><dd class="cmt"><p>
Deprecated. A list of edges to ignore during path finding.</p></dd><dt class="param">sourcePubKey</dt><dd class="cmt"><p>
The source node where the request route should originated from. If empty,
self is assumed.</p></dd><dt class="param">useMissionControl</dt><dd class="cmt"><p>
If set to true, edge probabilities from mission control will be used to get
the optimal route.</p></dd><dt class="param">ignoredPairs</dt><dd class="cmt"><p>
A list of directed node pairs that will be ignored during path finding.</p></dd><dt class="param">cltvLimit</dt><dd class="cmt"><p>
An optional maximum total time lock for the route. If the source is empty or
ourselves, this should not exceed lnd's <code>--max-cltv-expiry</code> setting. If
zero, then the value of <code>--max-cltv-expiry</code> is used as the limit.</p></dd><dt class="param">destCustomRecords</dt><dd class="cmt"><p>
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
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
does not support the specified records, an error will be returned.
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Record types are required to be in the custom range &gt;= 65536. When using
REST, the values must be encoded as base64.</p></dd><dt class="param">outgoingChanId</dt><dd class="cmt"><p>
The channel id of the channel that must be taken to the first hop. If zero,
any channel may be used.</p></dd><dt class="param">lastHopPubkey</dt><dd class="cmt"><p>
The pubkey of the last hop of the route. If empty, any hop may be used.</p></dd><dt class="param">routeHints</dt><dd class="cmt"><p>
Optional route hints to reach the destination through private channels.</p></dd><dt class="param">destFeatures</dt><dd class="cmt"><p>
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
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
fallback.</p></dd><dt class="param">timePref</dt><dd class="cmt"><p>
The time preference for this payment. Set to -1 to optimize for fees
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
only, to 1 to optimize for reliability only or a value inbetween for a mix.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="" name="lnrpc.QueryRoutesRequest" id="lnrpc.QueryRoutesRequest" class="extype">QueryRoutesRequest</a>], <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java/io/Serializable.html#java.io.Serializable" name="java.io.Serializable" id="java.io.Serializable" class="extype">Serializable</a>, <a href="https://www.scala-lang.org/api/2.13.10/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a>, <a href="https://www.scala-lang.org/api/2.13.10/scala/Equals.html#scala.Equals" name="scala.Equals" id="scala.Equals" class="extype">Equals</a>, <a href="../scala/index.html#AnyRef=Object" name="scala.AnyRef" id="scala.AnyRef" class="extmbr">AnyRef</a>, <a href="https://www.scala-lang.org/api/2.13.10/scala/Any.html#scala.Any" name="scala.Any" id="scala.Any" class="extype">Any</a></div></div></div></div><div id="mbrsel"><div class="toggle"></div><div id="memberfilter"><i class="material-icons arrow"></i><span class="input"><input placeholder="Filter all members" id="mbrsel-input" type="text" accesskey="/"/></span><i class="clear material-icons"></i></div><div id="filterby"><div id="order"><span class="filtertype">Ordering</span><ol><li class="alpha in"><span>Alphabetic</span></li><li class="inherit out"><span>By Inheritance</span></li></ol></div><div class="ancestors"><span class="filtertype">Inherited<br/></span><ol id="linearization"><li class="in" name="lnrpc.QueryRoutesRequest"><span>QueryRoutesRequest</span></li><li class="in" name="scalapb.lenses.Updatable"><span>Updatable</span></li><li class="in" name="scalapb.GeneratedMessage"><span>GeneratedMessage</span></li><li class="in" name="java.io.Serializable"><span>Serializable</span></li><li class="in" name="scala.Product"><span>Product</span></li><li class="in" name="scala.Equals"><span>Equals</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li></ol></div><div class="ancestors"><span class="filtertype"></span><ol><li class="hideall out"><span>Hide All</span></li><li class="showall in"><span>Show All</span></li></ol></div><div id="visbl"><span class="filtertype">Visibility</span><ol><li class="public in"><span>Public</span></li><li class="protected out"><span>Protected</span></li></ol></div></div></div><div id="template"><div id="allMembers"><div id="constructors" class="members"><h3>Instance Constructors</h3><ol><li class="indented0 " name="lnrpc.QueryRoutesRequest#&lt;init&gt;" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="&lt;init&gt;(pubKey:String,amt:Long,amtMsat:Long,finalCltvDelta:Int,feeLimit:Option[lnrpc.FeeLimit],ignoredNodes:Seq[com.google.protobuf.ByteString],ignoredEdges:Seq[lnrpc.EdgeLocator],sourcePubKey:String,useMissionControl:Boolean,ignoredPairs:Seq[lnrpc.NodePair],cltvLimit:org.bitcoins.core.number.UInt32,destCustomRecords:scala.collection.immutable.Map[org.bitcoins.core.number.UInt64,com.google.protobuf.ByteString],outgoingChanId:org.bitcoins.core.number.UInt64,lastHopPubkey:com.google.protobuf.ByteString,routeHints:Seq[lnrpc.RouteHint],destFeatures:Seq[lnrpc.FeatureBit],timePref:Double,unknownFields:scalapb.UnknownFieldSet):lnrpc.QueryRoutesRequest" class="anchorToMember"></a><a id="&lt;init&gt;:QueryRo
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The 33-byte hex-encoded public key for the payment destination</p></dd><dt class="param">amt</dt><dd class="cmt"><p>
The amount to send expressed in satoshis.
The fields amt and amt_msat are mutually exclusive.</p></dd><dt class="param">amtMsat</dt><dd class="cmt"><p>
The amount to send expressed in millisatoshis.
The fields amt and amt_msat are mutually exclusive.</p></dd><dt class="param">finalCltvDelta</dt><dd class="cmt"><p>
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.</p></dd><dt class="param">feeLimit</dt><dd class="cmt"><p>
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
Deploy website Deploy website version based on 142612f0342f3bd1fc9021b72c384bae9b9475ba
2022-02-04 12:38:32 +00:00
send the payment. If not specified, lnd will use a default value of 100%
fees for small amounts (&lt;=1k sat) or 5% fees for larger amounts.</p></dd><dt class="param">ignoredNodes</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
A list of nodes to ignore during path finding. When using REST, these fields
must be encoded as base64.</p></dd><dt class="param">ignoredEdges</dt><dd class="cmt"><p>
Deprecated. A list of edges to ignore during path finding.</p></dd><dt class="param">sourcePubKey</dt><dd class="cmt"><p>
The source node where the request route should originated from. If empty,
self is assumed.</p></dd><dt class="param">useMissionControl</dt><dd class="cmt"><p>
If set to true, edge probabilities from mission control will be used to get
the optimal route.</p></dd><dt class="param">ignoredPairs</dt><dd class="cmt"><p>
A list of directed node pairs that will be ignored during path finding.</p></dd><dt class="param">cltvLimit</dt><dd class="cmt"><p>
An optional maximum total time lock for the route. If the source is empty or
ourselves, this should not exceed lnd's <code>--max-cltv-expiry</code> setting. If
zero, then the value of <code>--max-cltv-expiry</code> is used as the limit.</p></dd><dt class="param">destCustomRecords</dt><dd class="cmt"><p>
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
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
does not support the specified records, an error will be returned.
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Record types are required to be in the custom range &gt;= 65536. When using
REST, the values must be encoded as base64.</p></dd><dt class="param">outgoingChanId</dt><dd class="cmt"><p>
The channel id of the channel that must be taken to the first hop. If zero,
any channel may be used.</p></dd><dt class="param">lastHopPubkey</dt><dd class="cmt"><p>
The pubkey of the last hop of the route. If empty, any hop may be used.</p></dd><dt class="param">routeHints</dt><dd class="cmt"><p>
Optional route hints to reach the destination through private channels.</p></dd><dt class="param">destFeatures</dt><dd class="cmt"><p>
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
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
fallback.</p></dd><dt class="param">timePref</dt><dd class="cmt"><p>
The time preference for this payment. Set to -1 to optimize for fees
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
only, to 1 to optimize for reliability only or a value inbetween for a mix.</p></dd></dl></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="scala.AnyRef#!=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="!=(x$1:Any):Boolean" class="anchorToMember"></a><a id="!=(Any):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/QueryRoutesRequest.html#!=(x$1:Any):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $bang$eq">!=</span><span class="params">(<span name="arg0">arg0: <a href="https://www.scala-lang.org/api/2.13.10/scala/Any.html#scala.Any" name="scala.Any" id="scala.Any" class="extype">Any</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef###" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="##:Int" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/QueryRoutesRequest.html###:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $hash$hash">##</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#==" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="==(x$1:Any):Boolean" class="anchorToMember"></a><a id="==(Any):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/QueryRoutesRequest.html#==(x$1:Any):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $eq$eq">==</span><span class="params">(<span name="arg0">arg0: <a href="https://www.scala-lang.org/api/2.13.10/scala/Any.html#scala.Any" name="scala.Any" id="scala.Any" class="extype">Any</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.10/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="lnrpc.QueryRoutesRequest#addAllDestCustomRecords" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="addAllDestCustomRecords(__vs:Iterable[(org.bitcoins.core.number.UInt64,com.google.protobuf.ByteString)]):lnrpc.QueryRoutesRequest" class="anchorToMember"></a><a id="addAllDestCustomRecords(Iterable[(UInt64,ByteString)]):QueryRoutesRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/QueryRoutesRequest.html#addAllDestCustomRecords(__vs:Iterable[(org.bitcoins.core.number.UInt64,com.google.protobuf.ByteString)]):lnrpc.QueryRoutesRequest" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">addAllDestCustomRecords</span><span class="params">(<span name="__vs">__vs: <a href="../scala/index.html#Iterable[+A]=Iterable[A]" name="scala.Iterable" id="scala.Iterable" class="extmbr">Iterable</a>[(<a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UI
Reference in a new issue Copy permalink