scaladoc

bench/src/main/scala/org/bitcoins/bench/eclair/EclairBench.scala

@@ -14,6 +14,15 @@ import scala.concurrent.duration.DurationInt
 import scala.concurrent.{ExecutionContext, Future}
 import scala.util.{Failure, Success}
 
+/**
+  * This test spins up one test node and [[NetworkSize]] sender nodes, which open channels with the test one.
+  * Then each sender node sends [[PaymentCount]] payments to the test node one by one. For each payment the
+  * test node generates an invoice and the send node pays it using `sendtonode` API call.
+  *
+  * 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 [[OutputFileName]]
+  * in CSV format.
+  */
 object EclairBench extends App with EclairRpcTestUtil {
 
   import PaymentLog._