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/Router.html

55 lines
66 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 */
var toRoot = '../';</script></head><body><div id="search"><span id="doc-title"><span id="doc-version"></span></span> <span class="close-results"><span class="left">&lt;</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_" class="anchorToMember"></a><a id="root:_root_" class="anchorToMember"></a> <span class="permalink"><a href="../index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 " name="_root_.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"><a href="index.html" title=""><span class="name">routerrpc</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="current-entities indented1"><a href="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="DefaultRouterClient$.html" title="" class="object"></a> <a href="DefaultRouterClient.html" title="" class="class"></a><a href="DefaultRouterClient.html" title="">DefaultRouterClient</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="ForwardEvent$.html" title="" class="object"></a> <a href="ForwardEvent.html" title="" class="class"></a><a href="ForwardEvent.html" title="">ForwardEvent</a></li><li class="current-entities indented1"><a href="ForwardFailEvent$.html" title="" class="object"></a> <a href="ForwardFailEvent.html" title="" class="class"></a><a href="ForwardFailEvent.html" title="">ForwardFailEvent</a></li><li class="current-entities indented1"><a href="ForwardHtlcInterceptRequest$.html" ti
subsystem of the daemon.
</p></div><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@AkkaGrpcGenerated</span><span class="args">()</span> </dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><a href="../scala/index.html#AnyRef=Object" name="scala.AnyRef" id="scala.AnyRef" class="extmbr">AnyRef</a>, <a href="https://www.scala-lang.org/api/2.13.8/scala/Any.html#scala.Any" name="scala.Any" id="scala.Any" class="extype">Any</a></div></div></div><div class="toggleContainer"><div class="toggle block"><span>Known Subclasses</span><div class="subClasses hiddenContent"><a href="DefaultRouterClient.html" name="routerrpc.DefaultRouterClient" id="routerrpc.DefaultRouterClient" class="extype">DefaultRouterClient</a>, <a href="RouterClient.html" name="routerrpc.RouterClient" id="routerrpc.RouterClient" class="extype">RouterClient</a></div></div></div></div><div id="mbrsel"><div class="toggle"></div><div id="memberfilter"><i class="material-icons arrow"></i><span class="input"><input placeholder="Filter all members" id="mbrsel-input" type="text" accesskey="/"/></span><i class="clear material-icons"></i></div><div id="filterby"><div id="order"><span class="filtertype">Ordering</span><ol><li class="alpha in"><span>Alphabetic</span></li><li class="inherit out"><span>By Inheritance</span></li></ol></div><div class="ancestors"><span class="filtertype">Inherited<br/></span><ol id="linearization"><li class="in" name="routerrpc.Router"><span>Router</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li></ol></div><div class="ancestors"><span class="filtertype"></span><ol><li class="hideall out"><span>Hide All</span></li><li class="showall in"><span>Show All</span></li></ol></div><div id="visbl"><span class="filtertype">Visibility</span><ol><li class="public in"><span>Public</span></li><li class="protected out"><span>Protected</span></li></ol></div></div></div><div id="template"><div id="allMembers"><div class="values members"><h3>Abstract Value Members</h3><ol><li class="indented0 " name="routerrpc.Router#buildRoute" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="buildRoute(in:routerrpc.BuildRouteRequest):scala.concurrent.Future[routerrpc.BuildRouteResponse]" class="anchorToMember"></a><a id="buildRoute(BuildRouteRequest):Future[BuildRouteResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/Router.html#buildRoute(in:routerrpc.BuildRouteRequest):scala.concurrent.Future[routerrpc.BuildRouteResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">buildRoute</span><span class="params">(<span name="in">in: <a href="BuildRouteRequest.html" name="routerrpc.BuildRouteRequest" id="routerrpc.BuildRouteRequest" class="extype">BuildRouteRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="BuildRouteResponse.html" name="routerrpc.BuildRouteResponse" id="routerrpc.BuildRouteResponse" class="extype">BuildRouteResponse</a>]</span></span><p class="shortcomment cmt">BuildRoute builds a fully specified route based on a list of hop public
keys.</p><div class="fullcomment"><div class="comment cmt"><p>BuildRoute builds a fully specified route based on a list of hop public
keys. It retrieves the relevant channel policies from the graph in order to
calculate the correct fees and time locks.
</p></div></div></li><li class="indented0 " name="routerrpc.Router#estimateRouteFee" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="estimateRouteFee(in:routerrpc.RouteFeeRequest):scala.concurrent.Future[routerrpc.RouteFeeResponse]" class="anchorToMember"></a><a id="estimateRouteFee(RouteFeeRequest):Future[RouteFeeResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/Router.html#estimateRouteFee(in:routerrpc.RouteFeeRequest):scala.concurrent.Future[routerrpc.RouteFeeResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">estimateRouteFee</span><span class="params">(<span name="in">in: <a href="RouteFeeRequest.html" name="routerrpc.RouteFeeRequest" id="routerrpc.RouteFeeRequest" class="extype">RouteFeeRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="RouteFeeResponse.html" name="routerrpc.RouteFeeResponse" id="routerrpc.RouteFeeResponse" class="extype">RouteFeeResponse</a>]</span></span><p class="shortcomment cmt">EstimateRouteFee allows callers to obtain a lower bound w.r.t how much it
may cost to send an HTLC to the target end destination.</p></li><li class="indented0 " name="routerrpc.Router#getMissionControlConfig" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="getMissionControlConfig(in:routerrpc.GetMissionControlConfigRequest):scala.concurrent.Future[routerrpc.GetMissionControlConfigResponse]" class="anchorToMember"></a><a id="getMissionControlConfig(GetMissionControlConfigRequest):Future[GetMissionControlConfigResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/Router.html#getMissionControlConfig(in:routerrpc.GetMissionControlConfigRequest):scala.concurrent.Future[routerrpc.GetMissionControlConfigResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getMissionControlConfig</span><span class="params">(<span name="in">in: <a href="GetMissionControlConfigRequest.html" name="routerrpc.GetMissionControlConfigRequest" id="routerrpc.GetMissionControlConfigRequest" class="extype">GetMissionControlConfigRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="GetMissionControlConfigResponse.html" name="routerrpc.GetMissionControlConfigResponse" id="routerrpc.GetMissionControlConfigResponse" class="extype">GetMissionControlConfigResponse</a>]</span></span><p class="shortcomment cmt">GetMissionControlConfig returns mission control's current config.</p></li><li class="indented0 " name="routerrpc.Router#htlcInterceptor" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="htlcInterceptor(in:akka.stream.scaladsl.Source[routerrpc.ForwardHtlcInterceptResponse,akka.NotUsed]):akka.stream.scaladsl.Source[routerrpc.ForwardHtlcInterceptRequest,akka.NotUsed]" class="anchorToMember"></a><a id="htlcInterceptor(Source[ForwardHtlcInterceptResponse,NotUsed]):Source[ForwardHtlcInterceptRequest,NotUsed]" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/Router.html#htlcInterceptor(in:akka.stream.scaladsl.Source[routerrpc.ForwardHtlcInterceptResponse,akka.NotUsed]):akka.stream.scaladsl.Source[routerrpc.ForwardHtlcInterceptRequest,akka.NotUsed]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">htlcInterceptor</span><span class="params">(<span name="in">in: <a href="https://doc.akka.io/api/akka/2.6.19/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="ForwardHtlcInterceptResponse.html" name="routerrpc.ForwardHtlcInterceptResponse" id="routerrpc.ForwardHtlcInterceptResponse" class="extype">ForwardHtlcInterceptResponse</a>, <a href="https://doc.akka.io/api/akka/2.6.19/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span>)</span><span class="result">: <a href="https://doc.akka.io/api/akka/2.6.19/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="ForwardHtlcInterceptRequest.html" name="routerrpc.ForwardHtlcInterceptRequest" id="routerrpc.ForwardHtlcInterceptRequest" class="extype">ForwardHtlcInterceptRequest</a>, <a href="https://doc.akka.io/api/akka/2.6.19/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span></span><p class="shortcomment cmt">*
HtlcInterceptor dispatches a bi-directional streaming RPC in which
Forwarded HTLC requests are sent to the client and the client responds with
a boolean that tells LND if this htlc should be intercepted.</p><div class="fullcomment"><div class="comment cmt"><p>*
HtlcInterceptor dispatches a bi-directional streaming RPC in which
Forwarded HTLC requests are sent to the client and the client responds with
a boolean that tells LND if this htlc should be intercepted.
In case of interception, the htlc can be either settled, cancelled or
resumed later by using the ResolveHoldForward endpoint.
</p></div></div></li><li class="indented0 " name="routerrpc.Router#queryMissionControl" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="queryMissionControl(in:routerrpc.QueryMissionControlRequest):scala.concurrent.Future[routerrpc.QueryMissionControlResponse]" class="anchorToMember"></a><a id="queryMissionControl(QueryMissionControlRequest):Future[QueryMissionControlResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/Router.html#queryMissionControl(in:routerrpc.QueryMissionControlRequest):scala.concurrent.Future[routerrpc.QueryMissionControlResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">queryMissionControl</span><span class="params">(<span name="in">in: <a href="QueryMissionControlRequest.html" name="routerrpc.QueryMissionControlRequest" id="routerrpc.QueryMissionControlRequest" class="extype">QueryMissionControlRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="QueryMissionControlResponse.html" name="routerrpc.QueryMissionControlResponse" id="routerrpc.QueryMissionControlResponse" class="extype">QueryMissionControlResponse</a>]</span></span><p class="shortcomment cmt">QueryMissionControl exposes the internal mission control state to callers.</p><div class="fullcomment"><div class="comment cmt"><p>QueryMissionControl exposes the internal mission control state to callers.
It is a development feature.
</p></div></div></li><li class="indented0 " name="routerrpc.Router#queryProbability" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="queryProbability(in:routerrpc.QueryProbabilityRequest):scala.concurrent.Future[routerrpc.QueryProbabilityResponse]" class="anchorToMember"></a><a id="queryProbability(QueryProbabilityRequest):Future[QueryProbabilityResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/Router.html#queryProbability(in:routerrpc.QueryProbabilityRequest):scala.concurrent.Future[routerrpc.QueryProbabilityResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">queryProbability</span><span class="params">(<span name="in">in: <a href="QueryProbabilityRequest.html" name="routerrpc.QueryProbabilityRequest" id="routerrpc.QueryProbabilityRequest" class="extype">QueryProbabilityRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="QueryProbabilityResponse.html" name="routerrpc.QueryProbabilityResponse" id="routerrpc.QueryProbabilityResponse" class="extype">QueryProbabilityResponse</a>]</span></span><p class="shortcomment cmt">QueryProbability returns the current success probability estimate for a
given node pair and amount.</p></li><li class="indented0 " name="routerrpc.Router#resetMissionControl" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="resetMissionControl(in:routerrpc.ResetMissionControlRequest):scala.concurrent.Future[routerrpc.ResetMissionControlResponse]" class="anchorToMember"></a><a id="resetMissionControl(ResetMissionControlRequest):Future[ResetMissionControlResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/Router.html#resetMissionControl(in:routerrpc.ResetMissionControlRequest):scala.concurrent.Future[routerrpc.ResetMissionControlResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">resetMissionControl</span><span class="params">(<span name="in">in: <a href="ResetMissionControlRequest.html" name="routerrpc.ResetMissionControlRequest" id="routerrpc.ResetMissionControlRequest" class="extype">ResetMissionControlRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ResetMissionControlResponse.html" name="routerrpc.ResetMissionControlResponse" id="routerrpc.ResetMissionControlResponse" class="extype">ResetMissionControlResponse</a>]</span></span><p class="shortcomment cmt">ResetMissionControl clears all mission control state and starts with a clean
slate.</p></li><li class="indented0 " name="routerrpc.Router#sendPayment" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="sendPayment(in:routerrpc.SendPaymentRequest):akka.stream.scaladsl.Source[routerrpc.PaymentStatus,akka.NotUsed]" class="anchorToMember"></a><a id="sendPayment(SendPaymentRequest):Source[PaymentStatus,NotUsed]" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/Router.html#sendPayment(in:routerrpc.SendPaymentRequest):akka.stream.scaladsl.Source[routerrpc.PaymentStatus,akka.NotUsed]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">sendPayment</span><span class="params">(<span name="in">in: <a href="SendPaymentRequest.html" name="routerrpc.SendPaymentRequest" id="routerrpc.SendPaymentRequest" class="extype">SendPaymentRequest</a></span>)</span><span class="result">: <a href="https://doc.akka.io/api/akka/2.6.19/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="PaymentStatus.html" name="routerrpc.PaymentStatus" id="routerrpc.PaymentStatus" class="extype">PaymentStatus</a>, <a href="https://doc.akka.io/api/akka/2.6.19/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span></span><p class="shortcomment cmt">Deprecated, use SendPaymentV2.</p><div class="fullcomment"><div class="comment cmt"><p>Deprecated, use SendPaymentV2. SendPayment attempts to route a payment
described by the passed PaymentRequest to the final destination. The call
returns a stream of payment status updates.
</p></div></div></li><li class="indented0 " name="routerrpc.Router#sendPaymentV2" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="sendPaymentV2(in:routerrpc.SendPaymentRequest):akka.stream.scaladsl.Source[lnrpc.Payment,akka.NotUsed]" class="anchorToMember"></a><a id="sendPaymentV2(SendPaymentRequest):Source[Payment,NotUsed]" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/Router.html#sendPaymentV2(in:routerrpc.SendPaymentRequest):akka.stream.scaladsl.Source[lnrpc.Payment,akka.NotUsed]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">sendPaymentV2</span><span class="params">(<span name="in">in: <a href="SendPaymentRequest.html" name="routerrpc.SendPaymentRequest" id="routerrpc.SendPaymentRequest" class="extype">SendPaymentRequest</a></span>)</span><span class="result">: <a href="https://doc.akka.io/api/akka/2.6.19/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="../lnrpc/Payment.html" name="lnrpc.Payment" id="lnrpc.Payment" class="extype">Payment</a>, <a href="https://doc.akka.io/api/akka/2.6.19/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span></span><p class="shortcomment cmt">SendPaymentV2 attempts to route a payment described by the passed
PaymentRequest to the final destination.</p><div class="fullcomment"><div class="comment cmt"><p>SendPaymentV2 attempts to route a payment described by the passed
PaymentRequest to the final destination. The call returns a stream of
payment updates.
</p></div></div></li><li class="indented0 " name="routerrpc.Router#sendToRoute" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="sendToRoute(in:routerrpc.SendToRouteRequest):scala.concurrent.Future[routerrpc.SendToRouteResponse]" class="anchorToMember"></a><a id="sendToRoute(SendToRouteRequest):Future[SendToRouteResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/Router.html#sendToRoute(in:routerrpc.SendToRouteRequest):scala.concurrent.Future[routerrpc.SendToRouteResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">sendToRoute</span><span class="params">(<span name="in">in: <a href="SendToRouteRequest.html" name="routerrpc.SendToRouteRequest" id="routerrpc.SendToRouteRequest" class="extype">SendToRouteRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="SendToRouteResponse.html" name="routerrpc.SendToRouteResponse" id="routerrpc.SendToRouteResponse" class="extype">SendToRouteResponse</a>]</span></span><p class="shortcomment cmt">Deprecated, use SendToRouteV2.</p><div class="fullcomment"><div class="comment cmt"><p>Deprecated, use SendToRouteV2. SendToRoute attempts to make a payment via
the specified route. This method differs from SendPayment in that it
allows users to specify a full route manually. This can be used for
things like rebalancing, and atomic swaps. It differs from the newer
SendToRouteV2 in that it doesn't return the full HTLC information.
</p></div></div></li><li class="indented0 " name="routerrpc.Router#sendToRouteV2" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="sendToRouteV2(in:routerrpc.SendToRouteRequest):scala.concurrent.Future[lnrpc.HTLCAttempt]" class="anchorToMember"></a><a id="sendToRouteV2(SendToRouteRequest):Future[HTLCAttempt]" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/Router.html#sendToRouteV2(in:routerrpc.SendToRouteRequest):scala.concurrent.Future[lnrpc.HTLCAttempt]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">sendToRouteV2</span><span class="params">(<span name="in">in: <a href="SendToRouteRequest.html" name="routerrpc.SendToRouteRequest" id="routerrpc.SendToRouteRequest" class="extype">SendToRouteRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../lnrpc/HTLCAttempt.html" name="lnrpc.HTLCAttempt" id="lnrpc.HTLCAttempt" class="extype">HTLCAttempt</a>]</span></span><p class="shortcomment cmt">SendToRouteV2 attempts to make a payment via the specified route.</p><div class="fullcomment"><div class="comment cmt"><p>SendToRouteV2 attempts to make a payment via the specified route. This
method differs from SendPayment in that it allows users to specify a full
route manually. This can be used for things like rebalancing, and atomic
swaps.
</p></div></div></li><li class="indented0 " name="routerrpc.Router#setMissionControlConfig" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="setMissionControlConfig(in:routerrpc.SetMissionControlConfigRequest):scala.concurrent.Future[routerrpc.SetMissionControlConfigResponse]" class="anchorToMember"></a><a id="setMissionControlConfig(SetMissionControlConfigRequest):Future[SetMissionControlConfigResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/Router.html#setMissionControlConfig(in:routerrpc.SetMissionControlConfigRequest):scala.concurrent.Future[routerrpc.SetMissionControlConfigResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">setMissionControlConfig</span><span class="params">(<span name="in">in: <a href="SetMissionControlConfigRequest.html" name="routerrpc.SetMissionControlConfigRequest" id="routerrpc.SetMissionControlConfigRequest" class="extype">SetMissionControlConfigRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="SetMissionControlConfigResponse.html" name="routerrpc.SetMissionControlConfigResponse" id="routerrpc.SetMissionControlConfigResponse" class="extype">SetMissionControlConfigResponse</a>]</span></span><p class="shortcomment cmt">SetMissionControlConfig will set mission control's config, if the config
provided is valid.</p></li><li class="indented0 " name="routerrpc.Router#subscribeHtlcEvents" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="subscribeHtlcEvents(in:routerrpc.SubscribeHtlcEventsRequest):akka.stream.scaladsl.Source[routerrpc.HtlcEvent,akka.NotUsed]" class="anchorToMember"></a><a id="subscribeHtlcEvents(SubscribeHtlcEventsRequest):Source[HtlcEvent,NotUsed]" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/Router.html#subscribeHtlcEvents(in:routerrpc.SubscribeHtlcEventsRequest):akka.stream.scaladsl.Source[routerrpc.HtlcEvent,akka.NotUsed]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">subscribeHtlcEvents</span><span class="params">(<span name="in">in: <a href="SubscribeHtlcEventsRequest.html" name="routerrpc.SubscribeHtlcEventsRequest" id="routerrpc.SubscribeHtlcEventsRequest" class="extype">SubscribeHtlcEventsRequest</a></span>)</span><span class="result">: <a href="https://doc.akka.io/api/akka/2.6.19/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="HtlcEvent.html" name="routerrpc.HtlcEvent" id="routerrpc.HtlcEvent" class="extype">HtlcEvent</a>, <a href="https://doc.akka.io/api/akka/2.6.19/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span></span><p class="shortcomment cmt">SubscribeHtlcEvents creates a uni-directional stream from the server to
the client which delivers a stream of htlc events.</p></li><li class="indented0 " name="routerrpc.Router#trackPayment" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="trackPayment(in:routerrpc.TrackPaymentRequest):akka.stream.scaladsl.Source[routerrpc.PaymentStatus,akka.NotUsed]" class="anchorToMember"></a><a id="trackPayment(TrackPaymentRequest):Source[PaymentStatus,NotUsed]" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/Router.html#trackPayment(in:routerrpc.TrackPaymentRequest):akka.stream.scaladsl.Source[routerrpc.PaymentStatus,akka.NotUsed]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">trackPayment</span><span class="params">(<span name="in">in: <a href="TrackPaymentRequest.html" name="routerrpc.TrackPaymentRequest" id="routerrpc.TrackPaymentRequest" class="extype">TrackPaymentRequest</a></span>)</span><span class="result">: <a href="https://doc.akka.io/api/akka/2.6.19/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="PaymentStatus.html" name="routerrpc.PaymentStatus" id="routerrpc.PaymentStatus" class="extype">PaymentStatus</a>, <a href="https://doc.akka.io/api/akka/2.6.19/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span></span><p class="shortcomment cmt">Deprecated, use TrackPaymentV2.</p><div class="fullcomment"><div class="comment cmt"><p>Deprecated, use TrackPaymentV2. TrackPayment returns an update stream for
the payment identified by the payment hash.
</p></div></div></li><li class="indented0 " name="routerrpc.Router#trackPaymentV2" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="trackPaymentV2(in:routerrpc.TrackPaymentRequest):akka.stream.scaladsl.Source[lnrpc.Payment,akka.NotUsed]" class="anchorToMember"></a><a id="trackPaymentV2(TrackPaymentRequest):Source[Payment,NotUsed]" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/Router.html#trackPaymentV2(in:routerrpc.TrackPaymentRequest):akka.stream.scaladsl.Source[lnrpc.Payment,akka.NotUsed]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">trackPaymentV2</span><span class="params">(<span name="in">in: <a href="TrackPaymentRequest.html" name="routerrpc.TrackPaymentRequest" id="routerrpc.TrackPaymentRequest" class="extype">TrackPaymentRequest</a></span>)</span><span class="result">: <a href="https://doc.akka.io/api/akka/2.6.19/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="../lnrpc/Payment.html" name="lnrpc.Payment" id="lnrpc.Payment" class="extype">Payment</a>, <a href="https://doc.akka.io/api/akka/2.6.19/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span></span><p class="shortcomment cmt">TrackPaymentV2 returns an update stream for the payment identified by the
payment hash.</p></li><li class="indented0 " name="routerrpc.Router#updateChanStatus" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="updateChanStatus(in:routerrpc.UpdateChanStatusRequest):scala.concurrent.Future[routerrpc.UpdateChanStatusResponse]" class="anchorToMember"></a><a id="updateChanStatus(UpdateChanStatusRequest):Future[UpdateChanStatusResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/Router.html#updateChanStatus(in:routerrpc.UpdateChanStatusRequest):scala.concurrent.Future[routerrpc.UpdateChanStatusResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">updateChanStatus</span><span class="params">(<span name="in">in: <a href="UpdateChanStatusRequest.html" name="routerrpc.UpdateChanStatusRequest" id="routerrpc.UpdateChanStatusRequest" class="extype">UpdateChanStatusRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="UpdateChanStatusResponse.html" name="routerrpc.UpdateChanStatusResponse" id="routerrpc.UpdateChanStatusResponse" class="extype">UpdateChanStatusResponse</a>]</span></span><p class="shortcomment cmt">UpdateChanStatus attempts to manually set the state of a channel
(enabled, disabled, or auto).</p><div class="fullcomment"><div class="comment cmt"><p>UpdateChanStatus attempts to manually set the state of a channel
(enabled, disabled, or auto). A manual "disable" request will cause the
channel to stay disabled until a subsequent manual request of either
"enable" or "auto".
</p></div></div></li><li class="indented0 " name="routerrpc.Router#xImportMissionControl" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="xImportMissionControl(in:routerrpc.XImportMissionControlRequest):scala.concurrent.Future[routerrpc.XImportMissionControlResponse]" class="anchorToMember"></a><a id="xImportMissionControl(XImportMissionControlRequest):Future[XImportMissionControlResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/Router.html#xImportMissionControl(in:routerrpc.XImportMissionControlRequest):scala.concurrent.Future[routerrpc.XImportMissionControlResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">xImportMissionControl</span><span class="params">(<span name="in">in: <a href="XImportMissionControlRequest.html" name="routerrpc.XImportMissionControlRequest" id="routerrpc.XImportMissionControlRequest" class="extype">XImportMissionControlRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="XImportMissionControlResponse.html" name="routerrpc.XImportMissionControlResponse" id="routerrpc.XImportMissionControlResponse" class="extype">XImportMissionControlResponse</a>]</span></span><p class="shortcomment cmt">XImportMissionControl is an experimental API that imports the state provided
to the internal mission control's state, using all results which are more
recent than our existing values.</p><div class="fullcomment"><div class="comment cmt"><p>XImportMissionControl is an experimental API that imports the state provided
to the internal mission control's state, using all results which are more
recent than our existing values. These values will only be imported
in-memory, and will not be persisted across restarts.
</p></div></div></li></ol></div><div class="values members"><h3>Concrete Value Members</h3><ol><li class="indented0 " name="scala.AnyRef#!=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="!=(x$1:Any):Boolean" class="anchorToMember"></a><a id="!=(Any):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/Router.html#!=(x$1:Any):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $bang$eq">!=</span><span class="params">(<span name="arg0">arg0: <a href="https://www.scala-lang.org/api/2.13.8/scala/Any.html#scala.Any" name="scala.Any" id="scala.Any" class="extype">Any</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef###" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="##:Int" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/Router.html###:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $hash$hash">##</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#==" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="==(x$1:Any):Boolean" class="anchorToMember"></a><a id="==(Any):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/Router.html#==(x$1:Any):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $eq$eq">==</span><span class="params">(<span name="arg0">arg0: <a href="https://www.scala-lang.org/api/2.13.8/scala/Any.html#scala.Any" name="scala.Any" id="scala.Any" class="extype">Any</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.Any#asInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="asInstanceOf[T0]:T0" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/Router.html#asInstanceOf[T0]:T0" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span name="scala.Any.asInstanceOf.T0" class="extype">T0</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#clone" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="clone():Object" class="anchorToMember"></a><a id="clone():AnyRef" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/Router.html#clone():Object" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span c
Reference in a new issue Copy permalink