bitcoin-s/api/org/bitcoins/bench/eclair/index.html
Docusaurus bot d2bfc0739f Deploy website
Deploy website version based on ebe98959ed
2023-06-08 16:02:22 +00:00

7 lines
12 KiB
HTML

<!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_.org" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="org" class="anchorToMember"></a><a id="org:org" class="anchorToMember"></a> <span class="permalink"><a href="../../../../org/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">org</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="indented2 " name="org.bitcoins" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="bitcoins" class="anchorToMember"></a><a id="bitcoins:bitcoins" class="anchorToMember"></a> <span class="permalink"><a href="../../../../org/bitcoins/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">bitcoins</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="org" id="org" class="extype">org</a></dd></dl></div></li><li class="indented3 " name="org.bitcoins.bench" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="bench" class="anchorToMember"></a><a id="bench:bench" class="anchorToMember"></a> <span class="permalink"><a href="../../../../org/bitcoins/bench/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">bench</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../index.html" name="org.bitcoins" id="org.bitcoins" class="extype">bitcoins</a></dd></dl></div></li><li class="indented4 " name="org.bitcoins.bench.core" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="core" class="anchorToMember"></a><a id="core:core" class="anchorToMember"></a> <span class="permalink"><a href="../../../../org/bitcoins/bench/core/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="../core/index.html" title=""><span class="name">core</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="org.bitcoins.bench" id="org.bitcoins.bench" class="extype">bench</a></dd></dl></div></li><li class="indented4 current" name="org.bitcoins.bench.eclair" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="eclair" class="anchorToMember"></a><a id="eclair:eclair" class="anchorToMember"></a> <span class="permalink"><a href="../../../../org/bitcoins/bench/eclair/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">eclair</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="org.bitcoins.bench" id="org.bitcoins.bench" class="extype">bench</a></dd></dl></div></li><li class="current-entities indented4"><span class="separator"></span> <a href="EclairBench$.html" title="This test spins up one test node and NetworkSize sender nodes, which open channels with the test one." class="object"></a><a href="EclairBench$.html" title="This test spins up one test node and NetworkSize sender nodes, which open channels with the test one.">EclairBench</a></li><li class="current-entities indented4"><span class="separator"></span> <a href="EclairBenchUtil$.html" title="" class="object"></a><a href="EclairBenchUtil$.html" title="">EclairBenchUtil</a></li><li class="current-entities indented4"><span class="separator"></span> <a href="PaymentLog$.html" title="" class="object"></a><a href="PaymentLog$.html" title="">PaymentLog</a></li></ul></div></div><div id="content"><body class="package value"><div id="definition"><div class="big-circle package">p</div><p id="owner"><a href="../../../index.html" name="org" id="org" class="extype">org</a>.<a href="../../index.html" name="org.bitcoins" id="org.bitcoins" class="extype">bitcoins</a>.<a href="../index.html" name="org.bitcoins.bench" id="org.bitcoins.bench" class="extype">bench</a></p><h1>eclair<span class="permalink"><a href="../../../../org/bitcoins/bench/eclair/index.html" title="Permalink"><i class="material-icons"></i></a></span></h1></div><h4 id="signature" class="signature"><span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><span class="name">eclair</span></span></h4><div id="comment" class="fullcommenttop"></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></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>Value Members</h3><ol><li class="indented0 " name="org.bitcoins.bench.eclair.EclairBench" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="EclairBench" class="anchorToMember"></a><a id="EclairBench:EclairBench" class="anchorToMember"></a> <span class="permalink"><a href="../../../../org/bitcoins/bench/eclair/EclairBench$.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="EclairBench$.html" title="This test spins up one test node and NetworkSize sender nodes, which open channels with the test one."><span class="name">EclairBench</span></a><span class="result"> extends <a href="https://www.scala-lang.org/api/2.13.11/scala/App.html#scala.App" name="scala.App" id="scala.App" class="extype">App</a> with <a href="../../testkit/eclair/rpc/EclairRpcTestUtil.html" name="org.bitcoins.testkit.eclair.rpc.EclairRpcTestUtil" id="org.bitcoins.testkit.eclair.rpc.EclairRpcTestUtil" class="extype">EclairRpcTestUtil</a></span></span><p class="shortcomment cmt">This test spins up one test node and <a href="EclairBench$.html#NetworkSize:Int" name="org.bitcoins.bench.eclair.EclairBench#NetworkSize" id="org.bitcoins.bench.eclair.EclairBench#NetworkSize" class="extmbr">NetworkSize</a> sender nodes, which open channels with the test one.</p><div class="fullcomment"><div class="comment cmt"><p>This test spins up one test node and <a href="EclairBench$.html#NetworkSize:Int" name="org.bitcoins.bench.eclair.EclairBench#NetworkSize" id="org.bitcoins.bench.eclair.EclairBench#NetworkSize" class="extmbr">NetworkSize</a> sender nodes, which open channels with the test one.
Then each sender node sends <a href="EclairBench$.html#PaymentCount:Int" name="org.bitcoins.bench.eclair.EclairBench#PaymentCount" id="org.bitcoins.bench.eclair.EclairBench#PaymentCount" class="extmbr">PaymentCount</a> payments to the test node one by one. For each payment the
test node generates an invoice and the send node pays it using <code>sendtonode</code> API call.</p><p>The test keeps track of times when a payment was initiated, when the payment ID was received,
and when the corresponding web socket event was received. It writes all results into <a href="EclairBench$.html#OutputFileName:String" name="org.bitcoins.bench.eclair.EclairBench#OutputFileName" id="org.bitcoins.bench.eclair.EclairBench#OutputFileName" class="extmbr">OutputFileName</a>
in CSV format.
</p></div></div></li><li class="indented0 " name="org.bitcoins.bench.eclair.EclairBenchUtil" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="EclairBenchUtil" class="anchorToMember"></a><a id="EclairBenchUtil:EclairBenchUtil" class="anchorToMember"></a> <span class="permalink"><a href="../../../../org/bitcoins/bench/eclair/EclairBenchUtil$.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="EclairBenchUtil$.html" title=""><span class="name">EclairBenchUtil</span></a></span></li><li class="indented0 " name="org.bitcoins.bench.eclair.PaymentLog" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="PaymentLog" class="anchorToMember"></a><a id="PaymentLog:PaymentLog" class="anchorToMember"></a> <span class="permalink"><a href="../../../../org/bitcoins/bench/eclair/PaymentLog$.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="PaymentLog$.html" title=""><span class="name">PaymentLog</span></a></span></li></ol></div></div><div id="inheritedMembers"></div><div id="groupedMembers"><div name="Ungrouped" class="group"><h3>Ungrouped</h3></div></div></div><div id="tooltip"></div><div id="footer"></div></body></div></div></div></body></html>