Documentation

multinode-demo/client.sh

@@ -2,6 +2,8 @@
 #
 USAGE=" usage: $0 [leader_url] [num_nodes] [--loop] [extra args]
 
+ Run bench-tps against the specified network
+
  leader_url       URL to the leader (defaults to ..)
  num_nodes        Minimum number of nodes to look for while converging
  --loop           Add this flag to cause the program to loop infinitely

multinode-demo/common.sh

@@ -1,7 +1,11 @@
 # |source| this file
 #
-# Disable complaints about unused variables in this file:
+# Common utilities shared by other scripts in this directory
+#
+# The following directive disable complaints about unused variables in this
+# file:
 # shellcheck disable=2034
+#
 
 rsync=rsync
 leader_logger="cat"

multinode-demo/drone.sh

@@ -1,5 +1,7 @@
 #!/bin/bash
 #
+# Starts an instance of solana-drone
+#
 # usage: $0 <rsync network path to solana repo on leader machine>
 #
 

multinode-demo/leader.sh

@@ -1,4 +1,7 @@
 #!/bin/bash
+#
+# Starts a leader node
+#
 
 here=$(dirname "$0")
 # shellcheck source=multinode-demo/common.sh

multinode-demo/metrics_write_datapoint.sh

@@ -1,4 +1,7 @@
 #!/bin/bash -e
+#
+# Send a metrics datapoint
+#
 
 point=$1
 if [[ -z $point ]]; then

multinode-demo/setup.sh

@@ -1,4 +1,7 @@
 #!/bin/bash
+#
+# Creates a fullnode configuration
+#
 
 here=$(dirname "$0")
 # shellcheck source=multinode-demo/common.sh

multinode-demo/validator-x.sh

@@ -1,4 +1,8 @@
 #!/bin/bash
+#
+# Start a dynamically-configured validator node
+#
+
 here=$(dirname "$0")
 
 exec "$here"/validator.sh -x "$@"

multinode-demo/validator.sh

@@ -1,4 +1,7 @@
 #!/bin/bash
+#
+# Start a validator node
+#
 here=$(dirname "$0")
 # shellcheck source=multinode-demo/common.sh
 source "$here"/common.sh

multinode-demo/wallet.sh

@@ -1,5 +1,7 @@
 #!/bin/bash
 #
+# Runs solana-wallet against the specified network
+#
 # usage: $0 <rsync network path to solana repo on leader machine>"
 #