Merge pull request #2922 from IntersectMBO/log_testnet_faucet_balance

Log testnet faucet balance

Author: mkoura

cardano_node_tests/cluster_scripts/testnets/start-cluster

@@ -25,6 +25,27 @@ if [ -e "$SCRIPT_DIR/shell_env" ]; then
   source "$SCRIPT_DIR/shell_env"
 fi
 
+get_address_balance() {
+  local txhash txix amount total_amount _
+
+  # Repeat in case `query utxo` fails
+  for _ in {1..3}; do
+    total_amount=0
+    while read -r txhash txix amount _; do
+      if [ -z "$txhash" ] || [ -z "$txix" ]; then
+        continue
+      fi
+      total_amount="$((total_amount + amount))"
+    done <<< "$(cardano-cli latest query utxo "$@" | grep " lovelace")"
+
+    if [ "$total_amount" -gt 0 ]; then
+      break
+    fi
+  done
+
+  echo "$total_amount"
+}
+
 rm -rf "$STATE_CLUSTER"
 mkdir -p "$STATE_CLUSTER"/{byron,shelley,webserver}
 cd "$STATE_CLUSTER/.."
@@ -36,6 +57,12 @@ fi
 
 # copy faucet address and keys
 cp "$TESTNET_DIR"/shelley/faucet.* "$STATE_CLUSTER/shelley"
+[ -e "$STATE_CLUSTER/shelley/faucet.addr" ] || \
+  { echo "The \`$STATE_CLUSTER/shelley/faucet.addr\` not found, line $LINENO" >&2; exit 1; }  # assert
+[ -e "$STATE_CLUSTER/shelley/faucet.vkey" ] || \
+  { echo "The \`$STATE_CLUSTER/shelley/faucet.vkey\` not found, line $LINENO" >&2; exit 1; }  # assert
+[ -e "$STATE_CLUSTER/shelley/faucet.skey" ] || \
+  { echo "The \`$STATE_CLUSTER/shelley/faucet.skey\` not found, line $LINENO" >&2; exit 1; }  # assert
 
 # copy configuration files
 cp "$SCRIPT_DIR"/cardano-node-* "$STATE_CLUSTER"
@@ -48,6 +75,8 @@ ln -rs "$STATE_CLUSTER/genesis-shelley.json" "$STATE_CLUSTER/shelley/genesis.jso
 ln -rs "$STATE_CLUSTER/genesis-alonzo.json" "$STATE_CLUSTER/shelley/genesis.alonzo.json"
 ln -rs "$STATE_CLUSTER/genesis-conway.json" "$STATE_CLUSTER/shelley/genesis.conway.json"
 
+NETWORK_MAGIC="$(jq '.networkMagic' "$STATE_CLUSTER/shelley/genesis.json")"
+
 # edit port numbers in configuration
 RELAY1_EKG="%%EKG_PORT_RELAY1%%"
 RELAY1_PROMETHEUS="%%PROMETHEUS_PORT_RELAY1%%"
@@ -174,7 +203,6 @@ done
 [ -S "$CARDANO_NODE_SOCKET_PATH" ] || { echo "Failed to start the relay node, line $LINENO" >&2; exit 1; }  # assert
 
 echo "Waiting to make sure the chain is synced"
-NETWORK_MAGIC="$(jq '.networkMagic' "$STATE_CLUSTER/shelley/genesis.json")"
 for _ in {1..600}; do
   sync_progress="$(cardano-cli query tip --testnet-magic "$NETWORK_MAGIC" | jq -r '.syncProgress')"
   if [ "$sync_progress" = "100.00" ]; then
@@ -208,4 +236,9 @@ if [ -n "${DBSYNC_REPO:-""}" ]; then
   done
 fi
 
+get_address_balance \
+  --testnet-magic "$NETWORK_MAGIC" \
+  --address "$(<"$STATE_CLUSTER/shelley/faucet.addr")" \
+  > "${STATE_CLUSTER}/start-cluster.log"
+
 echo "Cluster started. Run \`$SCRIPT_DIR/stop-cluster\` to stop"

cardano_node_tests/utils/cluster_nodes.py

@@ -274,10 +274,12 @@ def create_addrs_data(
                 "payment": payment,
             }
 
+        faucet_balance = cluster_obj.g_query.get_address_balance(address=faucet_rec.address)
+        LOGGER.info(f"Initial faucet balance: {faucet_balance}")
+
         # Fund new addresses from faucet address
         LOGGER.debug("Funding created addresses.")
         to_fund = [d["payment"] for d in new_addrs_data.values()]
-        faucet_balance = cluster_obj.g_query.get_address_balance(address=faucet_rec.address)
         amount_per_address = faucet_balance // len(self.test_addr_records)
         faucet.fund_from_faucet(
             *to_fund,

cardano_node_tests/utils/testnet_cleanup.py

@@ -375,3 +375,6 @@ def cleanup(
     defragment_utxos.defragment(
         cluster_obj=cluster_obj, address=faucet_payment.address, skey_file=faucet_payment.skey_file
     )
+
+    faucet_balance = cluster_obj.g_query.get_address_balance(address=faucet_payment.address)
+    LOGGER.info(f"Final faucet balance: {faucet_balance}")