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 */
|
2022-05-11 10:31:34 +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"><</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
|
2022-04-24 17:58:01 +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">maximumPaymentResults</dt><dd class="cmt"><p>
|
|
|
|
|
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
|
2022-05-11 10:31:34 +00:00
|
|
|
before we raise the failure amount.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.10/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="" name="routerrpc.MissionControlConfig" id="routerrpc.MissionControlConfig" class="extype">MissionControlConfig</a>], <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.10/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java/io/Serializable.html#java.io.Serializable" name="java.io.Serializable" id="java.io.Serializable" class="extype">Serializable</a>, <a href="https://www.scala-lang.org/api/2.13.8/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a>, <a href="https://www.scala-lang.org/api/2.13.8/scala/Equals.html#scala.Equals" name="scala.Equals" id="scala.Equals" class="extype">Equals</a>, <a href="../scala/index.html#AnyRef=Object" name="scala.AnyRef" id="scala.AnyRef" class="extmbr">AnyRef</a>, <a href="https://www.scala-lang.org/api/2.13.8/scala/Any.html#scala.Any" name="scala.Any" id="scala.Any" class="extype">Any</a></div></div></div></div><div id="mbrsel"><div class="toggle"></div><div id="memberfilter"><i class="material-icons arrow"></i><span class="input"><input placeholder="Filter all members" id="mbrsel-input" type="text" accesskey="/"/></span><i class="clear material-icons"></i></div><div id="filterby"><div id="order"><span class="filtertype">Ordering</span><ol><li class="alpha in"><span>Alphabetic</span></li><li class="inherit out"><span>By Inheritance</span></li></ol></div><div class="ancestors"><span class="filtertype">Inherited<br/></span><ol id="linearization"><li class="in" name="routerrpc.MissionControlConfig"><span>MissionControlConfig</span></li><li class="in" name="scalapb.lenses.Updatable"><span>Updatable</span></li><li class="in" name="scalapb.GeneratedMessage"><span>GeneratedMessage</span></li><li class="in" name="java.io.Serializable"><span>Serializable</span></li><li class="in" name="scala.Product"><span>Product</span></li><li class="in" name="scala.Equals"><span>Equals</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li></ol></div><div class="ancestors"><span class="filtertype"></span><ol><li class="hideall out"><span>Hide All</span></li><li class="showall in"><span>Show All</span></li></ol></div><div id="visbl"><span class="filtertype">Visibility</span><ol><li class="public in"><span>Public</span></li><li class="protected out"><span>Protected</span></li></ol></div></div></div><div id="template"><div id="allMembers"><div id="constructors" class="members"><h3>Instance Constructors</h3><ol><li class="indented0 " name="routerrpc.MissionControlConfig#<init>" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="<init>(halfLifeSeconds:org.bitcoins.core.number.UInt64,hopProbability:Float,weight:Float,maximumPaymentResults:org.bitcoins.core.number.UInt32,minimumFailureRelaxInterval:org.bitcoins.core.number.UInt64,unknownFields:scalapb.UnknownFieldSet):routerrpc.MissionControlConfig" class="anchorToMember"></a><a id="<init>:MissionControlConfig" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/MissionControlConfig.html#<init>(halfLifeSeconds:org.bitcoins.core.number.UInt64,hopProbability:Float,weight:Float,maximumPaymentResults:org.bitcoins.core.number.UInt32,minimumFailureRelaxInterval:org.bitcoins.core.number.UInt64,unknownFields:scalapb.UnknownFieldSet):routerrpc.MissionControlConfig"
|
2022-04-24 17:58:01 +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">maximumPaymentResults</dt><dd class="cmt"><p>
|
|
|
|
|
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
|
2022-05-11 10:31:34 +00:00
|
|
|
before we raise the failure amount.</p></dd></dl></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="scala.AnyRef#!=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="!=(x$1:Any):Boolean" class="anchorToMember"></a><a id="!=(Any):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/MissionControlConfig.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/MissionControlConfig.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/MissionControlConfig.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/MissionControlConfig.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/MissionControlConfig.html#clone():Object" title="Permalink"><i class="material-icons"></i></a></span> <s
|
