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/routerrpc/index.html

246 lines
221 KiB
HTML
Raw Normal View History

Deploy website Deploy website version based on 587bca87c4c298b31341f30deff84cc21e154b2e
2022-04-24 17:58:01 +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 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +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 current" name="_root_.routerrpc" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="routerrpc" class="anchorToMember"></a><a id="routerrpc:routerrpc" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/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"><span class="name">routerrpc</span></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="AprioriParameters$.html" title="" class="object"></a> <a href="AprioriParameters.html" title="" class="class"></a><a href="AprioriParameters.html" title="">AprioriParameters</a></li><li class="current-entities indented1"><a href="BimodalParameters$.html" title="" class="object"></a> <a href="BimodalParameters.html" title="" class="class"></a><a href="BimodalParameters.html" title="">BimodalParameters</a></li><li class="current-entities indented1"><a href="BuildRouteRequest$.html" title="" class="object"></a> <a href="BuildRouteRequest.html" title="" class="class"></a><a href="BuildRouteRequest.html" title="">BuildRouteRequest</a></li><li class="current-entities indented1"><a href="BuildRouteResponse$.html" title="" class="object"></a> <a href="BuildRouteResponse.html" title="" class="class"></a><a href="BuildRouteResponse.html" title="">BuildRouteResponse</a></li><li class="current-entities indented1"><a href="ChanStatusAction$.html" title="" class="object"></a> <a href="ChanStatusAction.html" title="" class="class"></a><a href="ChanStatusAction.html" title="">ChanStatusAction</a></li><li class="current-entities indented1"><a href="CircuitKey$.html" title="" class="object"></a> <a href="CircuitKey.html" title="" class="class"></a><a href="CircuitKey.html" title="">CircuitKey</a></li><li class="current-entities indented1"><a href="FailureDetail$.html" title="" class="object"></a> <a href="FailureDetail.html" title="" class="class"></a><a href="FailureDetail.html" title="">FailureDetail</a></li><li class="current-entities indented1"><a href="FinalHtlcEvent$.html" title="" class="object"></a> <a href="FinalHtlcEvent.html" title="" class="class"></a><a href="FinalHtlcEvent.html" title="">FinalHtlcEvent</a></li><li class="current-entities indented1"><a href="ForwardEvent$.html" title="" class="object"></a> <a href="Fo
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
The amount of time mission control will take to restore a penalized node
or channel back to 50% success probability, expressed in seconds. Setting
this value to a higher value will penalize failures for longer, making
mission control less likely to route through nodes and channels that we
have previously recorded failures for.</p></dd><dt class="param">hopProbability</dt><dd class="cmt"><p>
The probability of success mission control should assign to hop in a route
where it has no other information available. Higher values will make mission
control more willing to try hops that we have no information about, lower
values will discourage trying these hops.</p></dd><dt class="param">weight</dt><dd class="cmt"><p>
The importance that mission control should place on historical results,
expressed as a value in [0;1]. Setting this value to 1 will ignore all
historical payments and just use the hop probability to assess the
probability of success for each hop. A zero value ignores hop probability
completely and relies entirely on historical results, unless none are
available.</p></dd><dt class="param">capacityFraction</dt><dd class="cmt"><p>
The fraction of a channel's capacity that we consider to have liquidity. For
amounts that come close to or exceed the fraction, an additional penalty is
applied. A value of 1.0 disables the capacity factor. Allowed values are in
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
[0.75, 1.0].</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.BimodalParameters" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="BimodalParametersextendsGeneratedMessagewithUpdatable[routerrpc.BimodalParameters]withProductwithSerializable" class="anchorToMember"></a><a id="BimodalParameters:BimodalParameters" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/BimodalParameters.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="BimodalParameters.html" title=""><span class="name">BimodalParameters</span></a><span class="params">(<span name="nodeWeight">nodeWeight: <a href="https://www.scala-lang.org/api/2.13.14/scala/Double.html#scala.Double" name="scala.Double" id="scala.Double" class="extype">Double</a> = <span class="symbol">0.0</span></span>, <span name="scaleMsat">scaleMsat: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="decayTime">decayTime: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="BimodalParameters.html" name="routerrpc.BimodalParameters" id="routerrpc.BimodalParameters" class="extype">BimodalParameters</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">nodeWeight</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
NodeWeight defines how strongly other previous forwardings on channels of a
router should be taken into account when computing a channel's probability
to route. The allowed values are in the range [0, 1], where a value of 0
means that only direct information about a channel is taken into account.</p></dd><dt class="param">scaleMsat</dt><dd class="cmt"><p>
ScaleMsat describes the scale over which channels statistically have some
liquidity left. The value determines how quickly the bimodal distribution
drops off from the edges of a channel. A larger value (compared to typical
channel capacities) means that the drop off is slow and that channel
balances are distributed more uniformly. A small value leads to the
assumption of very unbalanced channels.</p></dd><dt class="param">decayTime</dt><dd class="cmt"><p>
DecayTime describes the information decay of knowledge about previous
successes and failures in channels. The smaller the decay time, the quicker
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
we forget about past forwardings.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.BuildRouteRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="BuildRouteRequestextendsGeneratedMessagewithUpdatable[routerrpc.BuildRouteRequest]withProductwithSerializable" class="anchorToMember"></a><a id="BuildRouteRequest:BuildRouteRequest" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/BuildRouteRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="BuildRouteRequest.html" title=""><span class="name">BuildRouteRequest</span></a><span class="params">(<span name="amtMsat">amtMsat: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="finalCltvDelta">finalCltvDelta: <a href="https://www.scala-lang.org/api/2.13.14/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="outgoingChanId">outgoingChanId: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="hopPubkeys">hopPubkeys: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.25.3/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="paymentAddr">paymentAddr: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.25.3/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="BuildRouteRequest.html" name="routerrpc.BuildRouteRequest" id="routerrpc.BuildRouteRequest" class="extype">BuildRouteRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">amtMsat</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 587bca87c4c298b31341f30deff84cc21e154b2e
2022-04-24 17:58:01 +00:00
The amount to send expressed in msat. If set to zero, the minimum routable
amount is used.</p></dd><dt class="param">finalCltvDelta</dt><dd class="cmt"><p>
CLTV delta from the current height that should be used for the timelock
of the final hop</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">hopPubkeys</dt><dd class="cmt"><p>
A list of hops that defines the route. This does not include the source hop
pubkey.</p></dd><dt class="param">paymentAddr</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
An optional payment addr to be included within the last hop of the route.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.BuildRouteResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="BuildRouteResponseextendsGeneratedMessagewithUpdatable[routerrpc.BuildRouteResponse]withProductwithSerializable" class="anchorToMember"></a><a id="BuildRouteResponse:BuildRouteResponse" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/BuildRouteResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="BuildRouteResponse.html" title=""><span class="name">BuildRouteResponse</span></a><span class="params">(<span name="route">route: <a href="https://www.scala-lang.org/api/2.13.14/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="../lnrpc/Route.html" name="lnrpc.Route" id="lnrpc.Route" class="extype">Route</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="BuildRouteResponse.html" name="routerrpc.BuildRouteResponse" id="routerrpc.BuildRouteResponse" class="extype">BuildRouteResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">route</dt><dd class="cmt"><p>
Fully specified route that can be used to execute the payment.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.ChanStatusAction" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="ChanStatusActionextendsGeneratedEnum" class="anchorToMember"></a><a id="ChanStatusAction:ChanStatusAction" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/ChanStatusAction.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="ChanStatusAction.html" title=""><span class="name">ChanStatusAction</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedEnum.html#scalapb.GeneratedEnum" name="scalapb.GeneratedEnum" id="scalapb.GeneratedEnum" class="extype">GeneratedEnum</a></span></span></li><li class="indented0 " name="routerrpc.CircuitKey" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CircuitKeyextendsGeneratedMessagewithUpdatable[routerrpc.CircuitKey]withProductwithSerializable" class="anchorToMember"></a><a id="CircuitKey:CircuitKey" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/CircuitKey.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="CircuitKey.html" title=""><span class="name">CircuitKey</span></a><span class="params">(<span name="chanId">chanId: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="htlcId">htlcId: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="CircuitKey.html" name="routerrpc.CircuitKey" id="routerrpc.CircuitKey" class="extype">CircuitKey</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">chanId</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 587bca87c4c298b31341f30deff84cc21e154b2e
2022-04-24 17:58:01 +00:00
/ The id of the channel that the is part of this circuit.</p></dd><dt class="param">htlcId</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
/ The index of the incoming htlc in the incoming channel.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.FailureDetail" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="FailureDetailextendsGeneratedEnum" class="anchorToMember"></a><a id="FailureDetail:FailureDetail" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/FailureDetail.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="FailureDetail.html" title=""><span class="name">FailureDetail</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedEnum.html#scalapb.GeneratedEnum" name="scalapb.GeneratedEnum" id="scalapb.GeneratedEnum" class="extype">GeneratedEnum</a></span></span></li><li class="indented0 " name="routerrpc.FinalHtlcEvent" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FinalHtlcEventextendsGeneratedMessagewithUpdatable[routerrpc.FinalHtlcEvent]withProductwithSerializable" class="anchorToMember"></a><a id="FinalHtlcEvent:FinalHtlcEvent" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/FinalHtlcEvent.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="FinalHtlcEvent.html" title=""><span class="name">FinalHtlcEvent</span></a><span class="params">(<span name="settled">settled: <a href="https://www.scala-lang.org/api/2.13.14/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="offchain">offchain: <a href="https://www.scala-lang.org/api/2.13.14/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="FinalHtlcEvent.html" name="routerrpc.FinalHtlcEvent" id="routerrpc.FinalHtlcEvent" class="extype">FinalHtlcEvent</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.ForwardEvent" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ForwardEventextendsGeneratedMessagewithUpdatable[routerrpc.ForwardEvent]withProductwithSerializable" class="anchorToMember"></a><a id="ForwardEvent:ForwardEvent" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/ForwardEvent.html" title="Permalink"><i cla
Info contains details about the htlc that was forwarded.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.ForwardFailEvent" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ForwardFailEventextendsGeneratedMessagewithUpdatable[routerrpc.ForwardFailEvent]withProductwithSerializable" class="anchorToMember"></a><a id="ForwardFailEvent:ForwardFailEvent" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/ForwardFailEvent.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ForwardFailEvent.html" title=""><span class="name">ForwardFailEvent</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ForwardFailEvent.html" name="routerrpc.ForwardFailEvent" id="routerrpc.ForwardFailEvent" class="extype">ForwardFailEvent</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.ForwardHtlcInterceptRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ForwardHtlcInterceptRequestextendsGeneratedMessagewithUpdatable[routerrpc.ForwardHtlcInterceptRequest]withProductwithSerializable" class="anchorToMember"></a><a id="ForwardHtlcInterceptRequest:ForwardHtlcInterceptRequest" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/ForwardHtlcInterceptRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ForwardHtlcInterceptRequest.html" title=""><span class="name">ForwardHtlcInterceptRequest</span></a><span class="params">(<span name="incomingCircuitKey">incomingCircuitKey: <a href="https://www.scala-lang.org/api/2.13.14/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="CircuitKey.html" name="routerrpc.CircuitKey" id="routerrpc.CircuitKey" class="extype">CircuitKey</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="incomingAmountMsat">incomingAmountMsat: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="incomingExpiry">incomingExpiry: <a href="https://www.scala-lang.org/api/2.13.14/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="paymentHash">paymentHash:
Deploy website Deploy website version based on 587bca87c4c298b31341f30deff84cc21e154b2e
2022-04-24 17:58:01 +00:00
The key of this forwarded htlc. It defines the incoming channel id and
the index in this channel.</p></dd><dt class="param">incomingAmountMsat</dt><dd class="cmt"><p>
The incoming htlc amount.</p></dd><dt class="param">incomingExpiry</dt><dd class="cmt"><p>
The incoming htlc expiry.</p></dd><dt class="param">paymentHash</dt><dd class="cmt"><p>
The htlc payment hash. This value is not guaranteed to be unique per
request.</p></dd><dt class="param">outgoingRequestedChanId</dt><dd class="cmt"><p>
The requested outgoing channel id for this forwarded htlc. Because of
non-strict forwarding, this isn't necessarily the channel over which the
packet will be forwarded eventually. A different channel to the same peer
may be selected as well.</p></dd><dt class="param">outgoingAmountMsat</dt><dd class="cmt"><p>
The outgoing htlc amount.</p></dd><dt class="param">outgoingExpiry</dt><dd class="cmt"><p>
The outgoing htlc expiry.</p></dd><dt class="param">customRecords</dt><dd class="cmt"><p>
Any custom records that were present in the payload.</p></dd><dt class="param">onionBlob</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
The onion blob for the next hop</p></dd><dt class="param">autoFailHeight</dt><dd class="cmt"><p>
The block height at which this htlc will be auto-failed to prevent the
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
channel from force-closing.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.ForwardHtlcInterceptResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ForwardHtlcInterceptResponseextendsGeneratedMessagewithUpdatable[routerrpc.ForwardHtlcInterceptResponse]withProductwithSerializable" class="anchorToMember"></a><a id="ForwardHtlcInterceptResponse:ForwardHtlcInterceptResponse" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/ForwardHtlcInterceptResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ForwardHtlcInterceptResponse.html" title="* ForwardHtlcInterceptResponse enables the caller to resolve a previously hold forward."><span class="name">ForwardHtlcInterceptResponse</span></a><span class="params">(<span name="incomingCircuitKey">incomingCircuitKey: <a href="https://www.scala-lang.org/api/2.13.14/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="CircuitKey.html" name="routerrpc.CircuitKey" id="routerrpc.CircuitKey" class="extype">CircuitKey</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="action">action: <a href="ResolveHoldForwardAction.html" name="routerrpc.ResolveHoldForwardAction" id="routerrpc.ResolveHoldForwardAction" class="extype">ResolveHoldForwardAction</a> = <span class="defval"><span class="name"><a href="">routerrpc.ResolveHoldForwardAction.SETTLE</a></span></span></span>, <span name="preimage">preimage: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.25.3/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="failureMessage">failureMessage: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.25.3/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="failureCode">failureCode: <a href="../lnrpc/Failure$$FailureCode.html" name="lnrpc.Failure.FailureCode" id="lnrpc.Failure.FailureCode" class="extype">FailureCode</a> = <span class="symbol"><span class="name"><a href="../lnrpc/index.html">lnrpc.Failure.FailureCode.RESERVED</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ForwardHtlcInterceptResponse.html" name="routerrpc.ForwardHtlcInterceptResponse" id="routerrpc.ForwardHtlcInterceptResponse" class="extype">ForwardHtlcInterceptResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product"
Deploy website Deploy website version based on 587bca87c4c298b31341f30deff84cc21e154b2e
2022-04-24 17:58:01 +00:00
ForwardHtlcInterceptResponse enables the caller to resolve a previously hold
forward.</p><div class="fullcomment"><div class="comment cmt"><p>*
ForwardHtlcInterceptResponse enables the caller to resolve a previously hold
forward. The caller can choose either to:
- <code>Resume</code>: Execute the default behavior (usually forward).
- <code>Reject</code>: Fail the htlc backwards.
- <code>Settle</code>: Settle this htlc with a given preimage.
</p></div><dl class="paramcmts block"><dt class="param">incomingCircuitKey</dt><dd class="cmt"><p>
*
The key of this forwarded htlc. It defines the incoming channel id and
the index in this channel.</p></dd><dt class="param">action</dt><dd class="cmt"><p>
The resolve action for this intercepted htlc.</p></dd><dt class="param">preimage</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
The preimage in case the resolve action is Settle.</p></dd><dt class="param">failureMessage</dt><dd class="cmt"><p>
Encrypted failure message in case the resolve action is Fail.
If failure_message is specified, the failure_code field must be set
to zero.</p></dd><dt class="param">failureCode</dt><dd class="cmt"><p>
Return the specified failure code in case the resolve action is Fail. The
message data fields are populated automatically.
If a non-zero failure_code is specified, failure_message must not be set.
For backwards-compatibility reasons, TEMPORARY_CHANNEL_FAILURE is the
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
default value for this field.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.GetMissionControlConfigRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GetMissionControlConfigRequestextendsGeneratedMessagewithUpdatable[routerrpc.GetMissionControlConfigRequest]withProductwithSerializable" class="anchorToMember"></a><a id="GetMissionControlConfigRequest:GetMissionControlConfigRequest" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/GetMissionControlConfigRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="GetMissionControlConfigRequest.html" title=""><span class="name">GetMissionControlConfigRequest</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="GetMissionControlConfigRequest.html" name="routerrpc.GetMissionControlConfigRequest" id="routerrpc.GetMissionControlConfigRequest" class="extype">GetMissionControlConfigRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.GetMissionControlConfigResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GetMissionControlConfigResponseextendsGeneratedMessagewithUpdatable[routerrpc.GetMissionControlConfigResponse]withProductwithSerializable" class="anchorToMember"></a><a id="GetMissionControlConfigResponse:GetMissionControlConfigResponse" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/GetMissionControlConfigResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="GetMissionControlConfigResponse.html" title=""><span class="name">GetMissionControlConfigResponse</span></a><span class="params">(<span name="config">config: <a href="https://www.scala-lang.org/api/2.13.14/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="MissionControlConfig.html" name="routerrpc.MissionControlConfig" id="routerrpc.MissionControlConfig" class="extype">MissionControlConfig</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="
Mission control's currently active config.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.HtlcEvent" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HtlcEventextendsGeneratedMessagewithUpdatable[routerrpc.HtlcEvent]withProductwithSerializable" class="anchorToMember"></a><a id="HtlcEvent:HtlcEvent" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/HtlcEvent.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="HtlcEvent.html" title="HtlcEvent contains the htlc event that was processed."><span class="name">HtlcEvent</span></a><span class="params">(<span name="incomingChannelId">incomingChannelId: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="outgoingChannelId">outgoingChannelId: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="incomingHtlcId">incomingHtlcId: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="outgoingHtlcId">outgoingHtlcId: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="timestampNs">timestampNs: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="eventType">eventType: <a href="HtlcEvent$$EventType.html" name="routerrpc.HtlcEvent.EventType" id="routerrpc.HtlcEvent.EventType" class="extype">EventType</a> = <span class="defval"><span class="name"><a href="">routerrpc.HtlcEvent.EventType.UNKNOWN</a></span></span></span>, <span name="event">event: <a href="HtlcEvent$$Event.html" name="routerrpc.HtlcEvent.Event" id="routerrpc.HtlcEvent.Event" class="extype">Event</a> = <span class="symbol"><span class="name"><a href="">routerrpc.HtlcEvent.Event.Empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="HtlcEvent.html" name="routerrpc.HtlcEvent" id="routerrpc.HtlcEvent" class="extype">HtlcEvent</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt">HtlcEvent contains the htlc event that was processed.</p><div class="fullcomment"><div class="comment cmt"><p>HtlcEvent contains the htlc event that was processed. These are served on a
Deploy website Deploy website version based on 587bca87c4c298b31341f30deff84cc21e154b2e
2022-04-24 17:58:01 +00:00
best-effort basis; events are not persisted, delivery is not guaranteed
(in the event of a crash in the switch, forward events may be lost) and
some events may be replayed upon restart. Events consumed from this package
should be de-duplicated by the htlc's unique combination of incoming and
outgoing channel id and htlc id. [EXPERIMENTAL]
</p></div><dl class="paramcmts block"><dt class="param">incomingChannelId</dt><dd class="cmt"><p>
The short channel id that the incoming htlc arrived at our node on. This
value is zero for sends.</p></dd><dt class="param">outgoingChannelId</dt><dd class="cmt"><p>
The short channel id that the outgoing htlc left our node on. This value
is zero for receives.</p></dd><dt class="param">incomingHtlcId</dt><dd class="cmt"><p>
Incoming id is the index of the incoming htlc in the incoming channel.
This value is zero for sends.</p></dd><dt class="param">outgoingHtlcId</dt><dd class="cmt"><p>
Outgoing id is the index of the outgoing htlc in the outgoing channel.
This value is zero for receives.</p></dd><dt class="param">timestampNs</dt><dd class="cmt"><p>
The time in unix nanoseconds that the event occurred.</p></dd><dt class="param">eventType</dt><dd class="cmt"><p>
The event type indicates whether the htlc was part of a send, receive or
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
forward.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.HtlcInfo" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HtlcInfoextendsGeneratedMessagewithUpdatable[routerrpc.HtlcInfo]withProductwithSerializable" class="anchorToMember"></a><a id="HtlcInfo:HtlcInfo" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/HtlcInfo.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="HtlcInfo.html" title=""><span class="name">HtlcInfo</span></a><span class="params">(<span name="incomingTimelock">incomingTimelock: <a href="https://www.scala-lang.org/api/2.13.14/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="outgoingTimelock">outgoingTimelock: <a href="https://www.scala-lang.org/api/2.13.14/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="incomingAmtMsat">incomingAmtMsat: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="outgoingAmtMsat">outgoingAmtMsat: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="HtlcInfo.html" name="routerrpc.HtlcInfo" id="routerrpc.HtlcInfo" class="extype">HtlcInfo</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">incomingTimelock</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 587bca87c4c298b31341f30deff84cc21e154b2e
2022-04-24 17:58:01 +00:00
The timelock on the incoming htlc.</p></dd><dt class="param">outgoingTimelock</dt><dd class="cmt"><p>
The timelock on the outgoing htlc.</p></dd><dt class="param">incomingAmtMsat</dt><dd class="cmt"><p>
The amount of the incoming htlc.</p></dd><dt class="param">outgoingAmtMsat</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
The amount of the outgoing htlc.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.LinkFailEvent" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LinkFailEventextendsGeneratedMessagewithUpdatable[routerrpc.LinkFailEvent]withProductwithSerializable" class="anchorToMember"></a><a id="LinkFailEvent:LinkFailEvent" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/LinkFailEvent.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="LinkFailEvent.html" title=""><span class="name">LinkFailEvent</span></a><span class="params">(<span name="info">info: <a href="https://www.scala-lang.org/api/2.13.14/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="HtlcInfo.html" name="routerrpc.HtlcInfo" id="routerrpc.HtlcInfo" class="extype">HtlcInfo</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="wireFailure">wireFailure: <a href="../lnrpc/Failure$$FailureCode.html" name="lnrpc.Failure.FailureCode" id="lnrpc.Failure.FailureCode" class="extype">FailureCode</a> = <span class="symbol"><span class="name"><a href="../lnrpc/index.html">lnrpc.Failure.FailureCode.RESERVED</a></span></span></span>, <span name="failureDetail">failureDetail: <a href="FailureDetail.html" name="routerrpc.FailureDetail" id="routerrpc.FailureDetail" class="extype">FailureDetail</a> = <span class="symbol"><span class="name"><a href="">routerrpc.FailureDetail.UNKNOWN</a></span></span></span>, <span name="failureString">failureString: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="LinkFailEvent.html" name="routerrpc.LinkFailEvent" id="routerrpc.LinkFailEvent" class="extype">LinkFailEvent</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">info</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 587bca87c4c298b31341f30deff84cc21e154b2e
2022-04-24 17:58:01 +00:00
Info contains details about the htlc that we failed.</p></dd><dt class="param">wireFailure</dt><dd class="cmt"><p>
FailureCode is the BOLT error code for the failure.</p></dd><dt class="param">failureDetail</dt><dd class="cmt"><p>
FailureDetail provides additional information about the reason for the
failure. This detail enriches the information provided by the wire message
and may be 'no detail' if the wire message requires no additional metadata.</p></dd><dt class="param">failureString</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
A string representation of the link failure.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.MissionControlConfig" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="MissionControlConfigextendsGeneratedMessagewithUpdatable[routerrpc.MissionControlConfig]withProductwithSerializable" class="anchorToMember"></a><a id="MissionControlConfig:MissionControlConfig" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/MissionControlConfig.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="MissionControlConfig.html" title=""><span class="name">MissionControlConfig</span></a><span class="params">(<span name="halfLifeSeconds">halfLifeSeconds: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="hopProbability">hopProbability: <a href="https://www.scala-lang.org/api/2.13.14/scala/Float.html#scala.Float" name="scala.Float" id="scala.Float" class="extype">Float</a> = <span class="symbol">0.0f</span></span>, <span name="weight">weight: <a href="https://www.scala-lang.org/api/2.13.14/scala/Float.html#scala.Float" name="scala.Float" id="scala.Float" class="extype">Float</a> = <span class="symbol">0.0f</span></span>, <span name="maximumPaymentResults">maximumPaymentResults: <a href="https://www.scala-lang.org/api/2.13.14/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="minimumFailureRelaxInterval">minimumFailureRelaxInterval: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="model">model: <a href="MissionControlConfig$$ProbabilityModel.html" name="routerrpc.MissionControlConfig.ProbabilityModel" id="routerrpc.MissionControlConfig.ProbabilityModel" class="extype">ProbabilityModel</a> = <span class="defval"><span class="name"><a href="">routerrpc.MissionControlConfig.ProbabilityModel.APRIORI</a></span></span></span>, <span name="estimatorConfig">estimatorConfig: <a href="MissionControlConfig$$EstimatorConfig.html" name="routerrpc.MissionControlConfig.EstimatorConfig" id="routerrpc.MissionControlConfig.EstimatorConfig" class="extype">EstimatorConfig</a> = <span class="defval"><span class="name"><a href="">routerrpc.MissionControlConfig.EstimatorConfig.Empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="MissionControlConfig.html" name="routerrpc.MissionControlConfig" id="routerrpc.MissionControlConfig" class="extype">MissionControlConfig</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Se
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
Deprecated, use AprioriParameters. The amount of time mission control will
take to restore a penalized node or channel back to 50% success probability,
expressed in seconds. Setting this value to a higher value will penalize
failures for longer, making mission control less likely to route through
nodes and channels that we have previously recorded failures for.</p></dd><dt class="param">hopProbability</dt><dd class="cmt"><p>
Deprecated, use AprioriParameters. The probability of success mission
control should assign to hop in a route where it has no other information
available. Higher values will make mission control more willing to try hops
that we have no information about, lower values will discourage trying these
hops.</p></dd><dt class="param">weight</dt><dd class="cmt"><p>
Deprecated, use AprioriParameters. The importance that mission control
should place on historical results, expressed as a value in [0;1]. Setting
this value to 1 will ignore all historical payments and just use the hop
probability to assess the probability of success for each hop. A zero value
ignores hop probability completely and relies entirely on historical
results, unless none are available.</p></dd><dt class="param">maximumPaymentResults</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 587bca87c4c298b31341f30deff84cc21e154b2e
2022-04-24 17:58:01 +00:00
The maximum number of payment results that mission control will store.</p></dd><dt class="param">minimumFailureRelaxInterval</dt><dd class="cmt"><p>
The minimum time that must have passed since the previously recorded failure
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
before we raise the failure amount.</p></dd><dt class="param">model</dt><dd class="cmt"><p>
ProbabilityModel defines which probability estimator should be used in
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
pathfinding. Note that the bimodal estimator is experimental.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.PairData" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PairDataextendsGeneratedMessagewithUpdatable[routerrpc.PairData]withProductwithSerializable" class="anchorToMember"></a><a id="PairData:PairData" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/PairData.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="PairData.html" title=""><span class="name">PairData</span></a><span class="params">(<span name="failTime">failTime: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="failAmtSat">failAmtSat: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="failAmtMsat">failAmtMsat: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="successTime">successTime: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="successAmtSat">successAmtSat: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="successAmtMsat">successAmtMsat: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="PairData.html" name="routerrpc.PairData" id="routerrpc.PairData" class="extype">PairData</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">failTime</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 587bca87c4c298b31341f30deff84cc21e154b2e
2022-04-24 17:58:01 +00:00
Time of last failure.</p></dd><dt class="param">failAmtSat</dt><dd class="cmt"><p>
Lowest amount that failed to forward rounded to whole sats. This may be
set to zero if the failure is independent of amount.</p></dd><dt class="param">failAmtMsat</dt><dd class="cmt"><p>
Lowest amount that failed to forward in millisats. This may be
set to zero if the failure is independent of amount.</p></dd><dt class="param">successTime</dt><dd class="cmt"><p>
Time of last success.</p></dd><dt class="param">successAmtSat</dt><dd class="cmt"><p>
Highest amount that we could successfully forward rounded to whole sats.</p></dd><dt class="param">successAmtMsat</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
Highest amount that we could successfully forward in millisats.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.PairHistory" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PairHistoryextendsGeneratedMessagewithUpdatable[routerrpc.PairHistory]withProductwithSerializable" class="anchorToMember"></a><a id="PairHistory:PairHistory" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/PairHistory.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="PairHistory.html" title="PairHistory contains the mission control state for a particular node pair."><span class="name">PairHistory</span></a><span class="params">(<span name="nodeFrom">nodeFrom: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.25.3/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="nodeTo">nodeTo: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.25.3/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="history">history: <a href="https://www.scala-lang.org/api/2.13.14/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="PairData.html" name="routerrpc.PairData" id="routerrpc.PairData" class="extype">PairData</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="PairHistory.html" name="routerrpc.PairHistory" id="routerrpc.PairHistory" class="extype">PairHistory</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt">PairHistory contains the mission control state for a particular node pair.</p><div class="fullcomment"><div class="comment cmt"><p>PairHistory contains the mission control state for a particular node pair.
Deploy website Deploy website version based on 587bca87c4c298b31341f30deff84cc21e154b2e
2022-04-24 17:58:01 +00:00
</p></div><dl class="paramcmts block"><dt class="param">nodeFrom</dt><dd class="cmt"><p>
The source node pubkey of the pair.</p></dd><dt class="param">nodeTo</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
The destination node pubkey of the pair.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.PaymentState" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="PaymentStateextendsGeneratedEnum" class="anchorToMember"></a><a id="PaymentState:PaymentState" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/PaymentState.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="PaymentState.html" title=""><span class="name">PaymentState</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedEnum.html#scalapb.GeneratedEnum" name="scalapb.GeneratedEnum" id="scalapb.GeneratedEnum" class="extype">GeneratedEnum</a></span></span></li><li class="indented0 " name="routerrpc.PaymentStatus" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PaymentStatusextendsGeneratedMessagewithUpdatable[routerrpc.PaymentStatus]withProductwithSerializable" class="anchorToMember"></a><a id="PaymentStatus:PaymentStatus" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/PaymentStatus.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="PaymentStatus.html" title=""><span class="name">PaymentStatus</span></a><span class="params">(<span name="state">state: <a href="PaymentState.html" name="routerrpc.PaymentState" id="routerrpc.PaymentState" class="extype">PaymentState</a> = <span class="symbol"><span class="name"><a href="">routerrpc.PaymentState.IN_FLIGHT</a></span></span></span>, <span name="preimage">preimage: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.25.3/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="htlcs">htlcs: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="../lnrpc/HTLCAttempt.html" name="lnrpc.HTLCAttempt" id="lnrpc.HTLCAttempt" class="extype">HTLCAttempt</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="PaymentStatus.html" name="routerrpc.PaymentStatus" id="routerrpc.PaymentStatus" class="extype">PaymentStatus</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment
Deploy website Deploy website version based on 587bca87c4c298b31341f30deff84cc21e154b2e
2022-04-24 17:58:01 +00:00
Current state the payment is in.</p></dd><dt class="param">preimage</dt><dd class="cmt"><p>
The pre-image of the payment when state is SUCCEEDED.</p></dd><dt class="param">htlcs</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
The HTLCs made in attempt to settle the payment [EXPERIMENTAL].</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.QueryMissionControlRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="QueryMissionControlRequestextendsGeneratedMessagewithUpdatable[routerrpc.QueryMissionControlRequest]withProductwithSerializable" class="anchorToMember"></a><a id="QueryMissionControlRequest:QueryMissionControlRequest" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/QueryMissionControlRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="QueryMissionControlRequest.html" title=""><span class="name">QueryMissionControlRequest</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="QueryMissionControlRequest.html" name="routerrpc.QueryMissionControlRequest" id="routerrpc.QueryMissionControlRequest" class="extype">QueryMissionControlRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.QueryMissionControlResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="QueryMissionControlResponseextendsGeneratedMessagewithUpdatable[routerrpc.QueryMissionControlResponse]withProductwithSerializable" class="anchorToMember"></a><a id="QueryMissionControlResponse:QueryMissionControlResponse" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/QueryMissionControlResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="QueryMissionControlResponse.html" title="QueryMissionControlResponse contains mission control state."><span class="name">QueryMissionControlResponse</span></a><span class="params">(<span name="pairs">pairs: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="PairHistory.html" name="routerrpc.PairHistory" id="routerrpc.PairHistory" class="extype">PairHistory</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span
Deploy website Deploy website version based on 587bca87c4c298b31341f30deff84cc21e154b2e
2022-04-24 17:58:01 +00:00
</p></div><dl class="paramcmts block"><dt class="param">pairs</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
Node pair-level mission control state.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.QueryProbabilityRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="QueryProbabilityRequestextendsGeneratedMessagewithUpdatable[routerrpc.QueryProbabilityRequest]withProductwithSerializable" class="anchorToMember"></a><a id="QueryProbabilityRequest:QueryProbabilityRequest" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/QueryProbabilityRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="QueryProbabilityRequest.html" title=""><span class="name">QueryProbabilityRequest</span></a><span class="params">(<span name="fromNode">fromNode: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.25.3/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="toNode">toNode: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.25.3/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="amtMsat">amtMsat: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="QueryProbabilityRequest.html" name="routerrpc.QueryProbabilityRequest" id="routerrpc.QueryProbabilityRequest" class="extype">QueryProbabilityRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">fromNode</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 587bca87c4c298b31341f30deff84cc21e154b2e
2022-04-24 17:58:01 +00:00
The source node pubkey of the pair.</p></dd><dt class="param">toNode</dt><dd class="cmt"><p>
The destination node pubkey of the pair.</p></dd><dt class="param">amtMsat</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
The amount for which to calculate a probability.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.QueryProbabilityResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="QueryProbabilityResponseextendsGeneratedMessagewithUpdatable[routerrpc.QueryProbabilityResponse]withProductwithSerializable" class="anchorToMember"></a><a id="QueryProbabilityResponse:QueryProbabilityResponse" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/QueryProbabilityResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="QueryProbabilityResponse.html" title=""><span class="name">QueryProbabilityResponse</span></a><span class="params">(<span name="probability">probability: <a href="https://www.scala-lang.org/api/2.13.14/scala/Double.html#scala.Double" name="scala.Double" id="scala.Double" class="extype">Double</a> = <span class="symbol">0.0</span></span>, <span name="history">history: <a href="https://www.scala-lang.org/api/2.13.14/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="PairData.html" name="routerrpc.PairData" id="routerrpc.PairData" class="extype">PairData</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="QueryProbabilityResponse.html" name="routerrpc.QueryProbabilityResponse" id="routerrpc.QueryProbabilityResponse" class="extype">QueryProbabilityResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">probability</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 587bca87c4c298b31341f30deff84cc21e154b2e
2022-04-24 17:58:01 +00:00
The success probability for the requested pair.</p></dd><dt class="param">history</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
The historical data for the requested pair.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.ResetMissionControlRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ResetMissionControlRequestextendsGeneratedMessagewithUpdatable[routerrpc.ResetMissionControlRequest]withProductwithSerializable" class="anchorToMember"></a><a id="ResetMissionControlRequest:ResetMissionControlRequest" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/ResetMissionControlRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ResetMissionControlRequest.html" title=""><span class="name">ResetMissionControlRequest</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ResetMissionControlRequest.html" name="routerrpc.ResetMissionControlRequest" id="routerrpc.ResetMissionControlRequest" class="extype">ResetMissionControlRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.ResetMissionControlResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ResetMissionControlResponseextendsGeneratedMessagewithUpdatable[routerrpc.ResetMissionControlResponse]withProductwithSerializable" class="anchorToMember"></a><a id="ResetMissionControlResponse:ResetMissionControlResponse" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/ResetMissionControlResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ResetMissionControlResponse.html" title=""><span class="name">ResetMissionControlResponse</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="s
Deploy website Deploy website version based on 587bca87c4c298b31341f30deff84cc21e154b2e
2022-04-24 17:58:01 +00:00
The destination once wishes to obtain a routing fee quote to.</p></dd><dt class="param">amtSat</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
The amount one wishes to send to the target destination.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.RouteFeeResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RouteFeeResponseextendsGeneratedMessagewithUpdatable[routerrpc.RouteFeeResponse]withProductwithSerializable" class="anchorToMember"></a><a id="RouteFeeResponse:RouteFeeResponse" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/RouteFeeResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="RouteFeeResponse.html" title=""><span class="name">RouteFeeResponse</span></a><span class="params">(<span name="routingFeeMsat">routingFeeMsat: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="timeLockDelay">timeLockDelay: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="RouteFeeResponse.html" name="routerrpc.RouteFeeResponse" id="routerrpc.RouteFeeResponse" class="extype">RouteFeeResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">routingFeeMsat</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 587bca87c4c298b31341f30deff84cc21e154b2e
2022-04-24 17:58:01 +00:00
A lower bound of the estimated fee to the target destination within the
network, expressed in milli-satoshis.</p></dd><dt class="param">timeLockDelay</dt><dd class="cmt"><p>
An estimate of the worst case time delay that can occur. Note that callers
will still need to factor in the final CLTV delta of the last hop into this
value.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.Router" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="RouterextendsAnyRef" class="anchorToMember"></a><a id="Router:Router" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/Router.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="Router.html" title="Router is a service that offers advanced interaction with the router subsystem of the daemon."><span class="name">Router</span></a><span class="result"> extends <a href="../scala/index.html#AnyRef=Object" name="scala.AnyRef" id="scala.AnyRef" class="extmbr">AnyRef</a></span></span><p class="shortcomment cmt">Router is a service that offers advanced interaction with the router
subsystem of the daemon.</p><div class="fullcomment"><div class="comment cmt"><p>Router is a service that offers advanced interaction with the router
subsystem of the daemon.
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
</p></div><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@PekkoGrpcGenerated</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.RouterClient" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="RouterClientextendsRouterwithRouterClientPowerApiwithPekkoGrpcClient" class="anchorToMember"></a><a id="RouterClient:RouterClient" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/RouterClient.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="RouterClient.html" title=""><span class="name">RouterClient</span></a><span class="result"> extends <a href="Router.html" name="routerrpc.Router" id="routerrpc.Router" class="extype">Router</a> with <a href="RouterClientPowerApi.html" name="routerrpc.RouterClientPowerApi" id="routerrpc.RouterClientPowerApi" class="extype">RouterClientPowerApi</a> with <a href="https://pekko.apache.org/api/pekko-grpc/1.1.0-M1/org/apache/pekko/grpc/org/apache/pekko/grpc/scaladsl/PekkoGrpcClient.html#org.apache.pekko.grpc.scaladsl.PekkoGrpcClient" name="org.apache.pekko.grpc.scaladsl.PekkoGrpcClient" id="org.apache.pekko.grpc.scaladsl.PekkoGrpcClient" class="extype">PekkoGrpcClient</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@PekkoGrpcGenerated</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.RouterClientPowerApi" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="RouterClientPowerApiextendsAnyRef" class="anchorToMember"></a><a id="RouterClientPowerApi:RouterClientPowerApi" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/RouterClientPowerApi.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="RouterClientPowerApi.html" title=""><span class="name">RouterClientPowerApi</span></a><span class="result"> extends <a href="../scala/index.html#AnyRef=Object" name="scala.AnyRef" id="scala.AnyRef" class="extmbr">AnyRef</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@PekkoGrpcGenerated</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.SendPaymentRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SendPaymentRequestextendsGeneratedMessagewithUpdatable[routerrpc.SendPaymentRequest]withProductwithSerializable" class="anchorToMember"></a><a id="SendPaymentRequest:SendPaymentRequest" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/SendPaymentRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SendPaymentRequest.html" title=""><span class="name">SendPaymentRequest</span></a><span class="params">(<span name="dest">dest: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.25.3/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="amt">amt: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="amtMsat">amtMsat: <a href="https://www.scala-lang.org/api/2.13.14/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="paymentHash">paymentHash: <a href="http
Deploy website Deploy website version based on 587bca87c4c298b31341f30deff84cc21e154b2e
2022-04-24 17:58:01 +00:00
The identity pubkey of the payment recipient</p></dd><dt class="param">amt</dt><dd class="cmt"><p>
Number of satoshis to send.
The fields amt and amt_msat are mutually exclusive.</p></dd><dt class="param">amtMsat</dt><dd class="cmt"><p>
Number of millisatoshis to send.
The fields amt and amt_msat are mutually exclusive.</p></dd><dt class="param">paymentHash</dt><dd class="cmt"><p>
The hash to use within the payment's HTLC</p></dd><dt class="param">finalCltvDelta</dt><dd class="cmt"><p>
The CLTV delta from the current height that should be used to set the
timelock for the final hop.</p></dd><dt class="param">paymentAddr</dt><dd class="cmt"><p>
An optional payment addr to be included within the last hop of the route.</p></dd><dt class="param">paymentRequest</dt><dd class="cmt"><p>
A bare-bones invoice for a payment within the Lightning Network. With the
details of the invoice, the sender has all the data necessary to send a
payment to the recipient. The amount in the payment request may be zero. In
that case it is required to set the amt field as well. If no payment request
is specified, the following fields are required: dest, amt and payment_hash.</p></dd><dt class="param">timeoutSeconds</dt><dd class="cmt"><p>
An upper limit on the amount of time we should spend when attempting to
fulfill the payment. This is expressed in seconds. If we cannot make a
successful payment within this time frame, an error will be returned.
This field must be non-zero.</p></dd><dt class="param">feeLimitSat</dt><dd class="cmt"><p>
The maximum number of satoshis that will be paid as a fee of the payment.
If this field is left to the default value of 0, only zero-fee routes will
be considered. This usually means single hop routes connecting directly to
the destination. To send the payment without a fee limit, use max int here.
The fields fee_limit_sat and fee_limit_msat are mutually exclusive.</p></dd><dt class="param">feeLimitMsat</dt><dd class="cmt"><p>
The maximum number of millisatoshis that will be paid as a fee of the
payment. If this field is left to the default value of 0, only zero-fee
routes will be considered. This usually means single hop routes connecting
directly to the destination. To send the payment without a fee limit, use
max int here.
The fields fee_limit_sat and fee_limit_msat are mutually exclusive.</p></dd><dt class="param">outgoingChanId</dt><dd class="cmt"><p>
Deprecated, use outgoing_chan_ids. The channel id of the channel that must
be taken to the first hop. If zero, any channel may be used (unless
outgoing_chan_ids are set).</p></dd><dt class="param">outgoingChanIds</dt><dd class="cmt"><p>
The channel ids of the channels are allowed for the first hop. If empty,
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">cltvLimit</dt><dd class="cmt"><p>
An optional maximum total time lock for the route. This should not exceed
lnd's <code>--max-cltv-expiry</code> setting. If zero, then the value of
<code>--max-cltv-expiry</code> is enforced.</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">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. 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">allowSelfPayment</dt><dd class="cmt"><p>
If set, circular payments to self are permitted.</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
fallback.</p></dd><dt class="param">maxParts</dt><dd class="cmt"><p>
The maximum number of partial payments that may be use to complete the full
amount.</p></dd><dt class="param">noInflightUpdates</dt><dd class="cmt"><p>
If set, only the final payment update is streamed back. Intermediate updates
that show which htlcs are still in flight are suppressed.</p></dd><dt class="param">maxShardSizeMsat</dt><dd class="cmt"><p>
The largest payment split that should be attempted when making a payment if
splitting is necessary. Setting this value will effectively cause lnd to
split more aggressively, vs only when it thinks it needs to. Note that this
value is in milli-satoshis.</p></dd><dt class="param">amp</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
If set, an AMP-payment will be attempted.</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 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +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></li><li class="indented0 " name="routerrpc.SendToRouteRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SendToRouteRequestextendsGeneratedMessagewithUpdatable[routerrpc.SendToRouteRequest]withProductwithSerializable" class="anchorToMember"></a><a id="SendToRouteRequest:SendToRouteRequest" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/SendToRouteRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SendToRouteRequest.html" title=""><span class="name">SendToRouteRequest</span></a><span class="params">(<span name="paymentHash">paymentHash: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.25.3/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="route">route: <a href="https://www.scala-lang.org/api/2.13.14/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="../lnrpc/Route.html" name="lnrpc.Route" id="lnrpc.Route" class="extype">Route</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="skipTempErr">skipTempErr: <a href="https://www.scala-lang.org/api/2.13.14/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="SendToRouteRequest.html" name="routerrpc.SendToRouteRequest" id="routerrpc.SendToRouteRequest" class="extype">SendToRouteRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">paymentHash</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 587bca87c4c298b31341f30deff84cc21e154b2e
2022-04-24 17:58:01 +00:00
The payment hash to use for the HTLC.</p></dd><dt class="param">route</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 2a30232181538e19fe10927b2345534617def9d4
2022-10-18 15:12:45 +00:00
Route that should be used to attempt to complete the payment.</p></dd><dt class="param">skipTempErr</dt><dd class="cmt"><p>
Whether the payment should be marked as failed when a temporary error is
returned from the given route. Set it to true so the payment won't be
failed unless a terminal error is occurred, such as payment timeout, no
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
routes, incorrect payment details, or insufficient funds.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.SendToRouteResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SendToRouteResponseextendsGeneratedMessagewithUpdatable[routerrpc.SendToRouteResponse]withProductwithSerializable" class="anchorToMember"></a><a id="SendToRouteResponse:SendToRouteResponse" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/SendToRouteResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SendToRouteResponse.html" title=""><span class="name">SendToRouteResponse</span></a><span class="params">(<span name="preimage">preimage: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.25.3/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="failure">failure: <a href="https://www.scala-lang.org/api/2.13.14/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="../lnrpc/Failure.html" name="lnrpc.Failure" id="lnrpc.Failure" class="extype">Failure</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="SendToRouteResponse.html" name="routerrpc.SendToRouteResponse" id="routerrpc.SendToRouteResponse" class="extype">SendToRouteResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">preimage</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 587bca87c4c298b31341f30deff84cc21e154b2e
2022-04-24 17:58:01 +00:00
The preimage obtained by making the payment.</p></dd><dt class="param">failure</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
The failure message in case the payment failed.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.SetMissionControlConfigRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SetMissionControlConfigRequestextendsGeneratedMessagewithUpdatable[routerrpc.SetMissionControlConfigRequest]withProductwithSerializable" class="anchorToMember"></a><a id="SetMissionControlConfigRequest:SetMissionControlConfigRequest" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/SetMissionControlConfigRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SetMissionControlConfigRequest.html" title=""><span class="name">SetMissionControlConfigRequest</span></a><span class="params">(<span name="config">config: <a href="https://www.scala-lang.org/api/2.13.14/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="MissionControlConfig.html" name="routerrpc.MissionControlConfig" id="routerrpc.MissionControlConfig" class="extype">MissionControlConfig</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="SetMissionControlConfigRequest.html" name="routerrpc.SetMissionControlConfigRequest" id="routerrpc.SetMissionControlConfigRequest" class="extype">SetMissionControlConfigRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">config</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 587bca87c4c298b31341f30deff84cc21e154b2e
2022-04-24 17:58:01 +00:00
The config to set for mission control. Note that all values *must* be set,
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
because the full config will be applied.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.SetMissionControlConfigResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SetMissionControlConfigResponseextendsGeneratedMessagewithUpdatable[routerrpc.SetMissionControlConfigResponse]withProductwithSerializable" class="anchorToMember"></a><a id="SetMissionControlConfigResponse:SetMissionControlConfigResponse" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/SetMissionControlConfigResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SetMissionControlConfigResponse.html" title=""><span class="name">SetMissionControlConfigResponse</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="SetMissionControlConfigResponse.html" name="routerrpc.SetMissionControlConfigResponse" id="routerrpc.SetMissionControlConfigResponse" class="extype">SetMissionControlConfigResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.SettleEvent" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SettleEventextendsGeneratedMessagewithUpdatable[routerrpc.SettleEvent]withProductwithSerializable" class="anchorToMember"></a><a id="SettleEvent:SettleEvent" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/SettleEvent.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SettleEvent.html" title=""><span class="name">SettleEvent</span></a><span class="params">(<span name="preimage">preimage: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.25.3/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-r
The revealed preimage.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.SubscribeHtlcEventsRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SubscribeHtlcEventsRequestextendsGeneratedMessagewithUpdatable[routerrpc.SubscribeHtlcEventsRequest]withProductwithSerializable" class="anchorToMember"></a><a id="SubscribeHtlcEventsRequest:SubscribeHtlcEventsRequest" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/SubscribeHtlcEventsRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SubscribeHtlcEventsRequest.html" title=""><span class="name">SubscribeHtlcEventsRequest</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="SubscribeHtlcEventsRequest.html" name="routerrpc.SubscribeHtlcEventsRequest" id="routerrpc.SubscribeHtlcEventsRequest" class="extype">SubscribeHtlcEventsRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.SubscribedEvent" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SubscribedEventextendsGeneratedMessagewithUpdatable[routerrpc.SubscribedEvent]withProductwithSerializable" class="anchorToMember"></a><a id="SubscribedEvent:SubscribedEvent" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/SubscribedEvent.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SubscribedEvent.html" title=""><span class="name">SubscribedEvent</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="SubscribedEvent.html" name="routerrpc.SubscribedEvent"
Deploy website Deploy website version based on 587bca87c4c298b31341f30deff84cc21e154b2e
2022-04-24 17:58:01 +00:00
The hash of the payment to look up.</p></dd><dt class="param">noInflightUpdates</dt><dd class="cmt"><p>
If set, only the final payment update is streamed back. Intermediate updates
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
that show which htlcs are still in flight are suppressed.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.TrackPaymentsRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TrackPaymentsRequestextendsGeneratedMessagewithUpdatable[routerrpc.TrackPaymentsRequest]withProductwithSerializable" class="anchorToMember"></a><a id="TrackPaymentsRequest:TrackPaymentsRequest" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/TrackPaymentsRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="TrackPaymentsRequest.html" title=""><span class="name">TrackPaymentsRequest</span></a><span class="params">(<span name="noInflightUpdates">noInflightUpdates: <a href="https://www.scala-lang.org/api/2.13.14/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="TrackPaymentsRequest.html" name="routerrpc.TrackPaymentsRequest" id="routerrpc.TrackPaymentsRequest" class="extype">TrackPaymentsRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">noInflightUpdates</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
If set, only the final payment updates are streamed back. Intermediate
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
updates that show which htlcs are still in flight are suppressed.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.UpdateChanStatusRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UpdateChanStatusRequestextendsGeneratedMessagewithUpdatable[routerrpc.UpdateChanStatusRequest]withProductwithSerializable" class="anchorToMember"></a><a id="UpdateChanStatusRequest:UpdateChanStatusRequest" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/UpdateChanStatusRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="UpdateChanStatusRequest.html" title=""><span class="name">UpdateChanStatusRequest</span></a><span class="params">(<span name="chanPoint">chanPoint: <a href="https://www.scala-lang.org/api/2.13.14/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="../lnrpc/ChannelPoint.html" name="lnrpc.ChannelPoint" id="lnrpc.ChannelPoint" class="extype">ChannelPoint</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="action">action: <a href="ChanStatusAction.html" name="routerrpc.ChanStatusAction" id="routerrpc.ChanStatusAction" class="extype">ChanStatusAction</a> = <span class="symbol"><span class="name"><a href="">routerrpc.ChanStatusAction.ENABLE</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="UpdateChanStatusRequest.html" name="routerrpc.UpdateChanStatusRequest" id="routerrpc.UpdateChanStatusRequest" class="extype">UpdateChanStatusRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.UpdateChanStatusResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UpdateChanStatusResponseextendsGeneratedMessagewithUpdatable[routerrpc.UpdateChanStatusResponse]withProductwithSerializable" class="anchorToMember"></a><a id="UpdateChanStatusResponse:UpdateChanStatusResponse" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/UpdateChanStatusResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="UpdateChanStatusResponse.html" title=""><span class="name">UpdateChanStatusResponse</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFiel
Deploy website Deploy website version based on 587bca87c4c298b31341f30deff84cc21e154b2e
2022-04-24 17:58:01 +00:00
Node pair-level mission control state to be imported.</p></dd><dt class="param">force</dt><dd class="cmt"><p>
Whether to force override MC pair history. Note that even with force
override the failure pair is imported before the success pair and both
Deploy website Deploy website version based on 4885bdb07dddf4c170d2eec068918a90abd1350a
2024-07-16 15:30:06 +00:00
still clamp existing failure/success amounts.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="routerrpc.XImportMissionControlResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="XImportMissionControlResponseextendsGeneratedMessagewithUpdatable[routerrpc.XImportMissionControlResponse]withProductwithSerializable" class="anchorToMember"></a><a id="XImportMissionControlResponse:XImportMissionControlResponse" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/XImportMissionControlResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="XImportMissionControlResponse.html" title=""><span class="name">XImportMissionControlResponse</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.15/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="XImportMissionControlResponse.html" name="routerrpc.XImportMissionControlResponse" id="routerrpc.XImportMissionControlResponse" class="extype">XImportMissionControlResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.14/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="routerrpc.AprioriParameters" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AprioriParameters" class="anchorToMember"></a><a id="AprioriParameters:AprioriParameters" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/AprioriParameters$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="AprioriParameters$.html" title=""><span class="name">AprioriParameters</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.15/scalapb/GeneratedMessageCompanion.html#scalapb.GeneratedMessageCompanion" name="scalapb.GeneratedMessageCompanion" id="scalapb.GeneratedMessageCompanion" class="extype">GeneratedMessageCompanion</a>[<a href="AprioriParameters.html" name="routerrpc.AprioriParameters" id="routerrpc.AprioriParameters" class="extype">AprioriParameters</a>]</span></span></li><li class="indented0 " name="routerrpc.BimodalParameters" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="BimodalParameters" class="anchorToMember"></a><a id="BimodalParameters:BimodalParameters" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/BimodalParameters$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="m
Reference in a new issue Copy permalink