Merge #112: Decouple version numbers for maintainability

51d29ee Decouple version numbers for maintainability (GideonBature)

Pull request description:

  **Problem:**

  The script previously hardcoded version numbers and assumed specific directory structures in `/opt/`, making updates difficult and breaking user environments when new versions were introduced. Developers had to modify the script manually whenever a new version was released or when `bitcoind` was installed in a different location.

  **Solution:**

  This PR removes the hardcoded version numbers and introduces a configuration-based approach. The script now loads version numbers and `bitcoind` paths from either:
  1. A **custom environment variable** (`BITCOIND_VERSIONS_CONFIG`), allowing users to specify their own config file location.
  2. A **configuration file** (`bitcoind_versions.conf`), which developers can set up based on their local environment.

  If no custom environment variable is provided (BITCOIND_VERSIONS_CONFIG), the script falls back to a default config file in the home directory (`~/.bitcoind_versions.conf`) or the script directory (`./bitcoind_versions.conf`).

  Closes #28

ACKs for top commit:
  tcharding:
    ACK 51d29ee

Tree-SHA512: 87552320ae0af1139256e2bf0bd762a05539ad6ea927ba9c1d9842ae857bc16b6c2239ec1720e9f3d60aff5abf357fe5368106aba2631fa3eec351520b33000b

Author: tcharding

contrib/run-bitcoind.sh

@@ -1,8 +1,8 @@
 #!/usr/bin/env bash
 #
-# Run local regtest `bitcoind` nodes.
-#
-# shell: alias bt18='bitcoin-cli -rpcconnect=localhost:18149 -rpcuser=user -rpcpassword=password'
+# Run local regtest `bitcoind` nodes using versions specified in the config file.
+# Config file default: ~/.run-bitcoind.conf
+# Config file optional: ./run-bitcoind.conf
 
 set -euo pipefail
 
@@ -12,189 +12,185 @@ RPC_USER="user"
 RPC_PASSWORD="password"
 
 usage() {
-    cat <<EOF
+    cat <<'EOF'
 Usage:
 
     ./run-bitcoind.sh [COMMAND]
 
 COMMAND
-   - all                      Start all known bitcoind versions.
-   - start [KNOWN_VERSION]    Start bitcoind nodes, defaults to v22.
-   - stop                     Kill all bitcoind nodes using 'pkill bitcoind'.
-
-KNOWN_VERSION
-   - v28                Bitcoin Core v28.0
-   - v27                Bitcoin Core v27.1
-   - v26                Bitcoin Core v26.2
-   - v25                Bitcoin Core v25.2
-   - v24                Bitcoin Core v24.2
-   - v23                Bitcoin Core v23.2
-   - v22                Bitcoin Core v22.1
-   - v21                Bitcoin Core v0.21.2
-   - v20                Bitcoin Core v0.20.2
-   - v19                Bitcoin Core v0.19.1
-   - v18                Bitcoin Core v0.18.1
-   - v17                Bitcoin Core v0.17.1
+
+   - all                      Start all bitcoind versions defined in the config file.
+   - start [VERSION_ALIAS]    Start bitcoind nodes for the specified version alias (default: v22).
+   - stop                     Kill all bitcoind nodes and clean up test directories.
+
+CONFIGURATION
+
+- Priority
+
+    1. RUN_BITCOIND_CONF environment variable
+    2. ./run-bitcoind.conf (script directory)
+    3. ~/.run-bitcoind.conf (home directory)
+
+- Config format
+
+    <VERSION_ALIAS> <VERSION_NUMBER> <VERSION_ID> <BITCOIND_PATH>
+
+    VERSION_ALIAS       Passed as command line argument to $(start).
+    VERISON_NUMBER      The Bitocin Core version number.
+    VERSION_ID          Used as part of port numbers.
+    BITCOIND_PATH       Path to $(bitcoind) binary.
+
+- Examples
+
+    v28 28.1 281 /opt/bitcoin-28.0/bin/bitcoind
+    v24 24.2 242 /opt/bitcoin-24.2/bin/bitcoind
+    v21 0.21.2 212 /opt/bitcoin-0.21.2/bin/bitcoind
+
 EOF
 }
 
 main() {
     local cmd="${1:-usage}"
-    local version="${2:-v22}"
+    local version="${2:-}"
 
     # FIXME: This is a hackish way to get the help flag.
     if [ "$cmd" = "usage" ] || [ "$cmd" = "-h" ] || [ "$cmd" = "--help" ] || [ "$cmd" = "help" ]; then
         usage
         exit 0
     fi
 
+    case $cmd in
+        all|start)
+            # Config loading logic
+            local config_file=${RUN_BITCOIND_CONF:-}
+
+            if [ -z "$config_file" ]; then
+                local script_dir
+
+                script_dir=$(dirname "$0")
+                local local_config="${script_dir}/run-bitcoind.conf"
+
+                if [ -f "$local_config" ]; then
+                    config_file="$local_config"
+                else
+                    config_file="$HOME/.run-bitcoind.conf"
+                fi
+            fi
+
+            if [ ! -f "$config_file" ]; then
+                err "Config file $config_file not found. Please create it."
+            fi
+
+            # Load config into parallel arrays
+            VERSION_ALIASES=()
+            VERSION_NUMBERS=()
+            VERSION_IDS=()
+            BITCOIND_PATHS=()
+
+            while IFS= read -r line; do
+                line=$(echo "$line" | sed -e 's/#.*//' -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//')
+                [ -z "$line" ] && continue
+                read -r alias version_number version_id path <<<"$line"
+                VERSION_ALIASES+=("$alias")
+                VERSION_NUMBERS+=("$version_number")
+                VERSION_IDS+=("$version_id")
+                BITCOIND_PATHS+=("$path")
+            done < "$config_file"
+            ;;
+    esac
+
     case $cmd in
         all)
-            start "v28"         # 28.0
-            start "v27"         # 27.1
-            start "v26"         # 26.2
-            start "v25"         # 25.2
-            start "v24"         # 24.2
-            start "v23"         # 23.2
-            start "v22"         # 22.1
-            start "v21"         # 0.21.2
-            start "v20"         # 0.20.2
-            start "v19"         # 0.19.1
-            start "v18"         # 0.18.1
-            start "v17"         # 0.17.1
+            for index in "${!VERSION_ALIASES[@]}"; do
+                start "${VERSION_ALIASES[$index]}" \
+                      "${VERSION_NUMBERS[$index]}" \
+                      "${VERSION_IDS[$index]}" \
+                      "${BITCOIND_PATHS[$index]}"
+            done
             ;;
 
         start)
-            start "$version"
+            if [ -z "$version" ]; then
+                version="v22"  # Default version
+            fi
+
+            found=false
+            for index in "${!VERSION_ALIASES[@]}"; do
+                if [ "${VERSION_ALIASES[$index]}" = "$version" ]; then
+                    start "$version" \
+                          "${VERSION_NUMBERS[$index]}" \
+                          "${VERSION_IDS[$index]}" \
+                          "${BITCOIND_PATHS[$index]}"
+                    found=true
+                    break
+                fi
+            done
+
+            if [ "$found" = false ]; then
+                err "Version '$version' not found in config file."
+            fi
             ;;
 
         stop)
-            pkill bitcoind
-            rm -rf "/tmp/corepc-0.17.1/2/regtest/wallets" > /dev/null
-            rm -rf "/tmp/corepc-0.18.1/2/regtest/wallets" > /dev/null
-            rm -rf "/tmp/corepc-22.1/2/regtest/wallets" > /dev/null
+            pkill bitcoind || true
+            rm -rf /tmp/corepc-*/2/regtest/wallets > /dev/null 2>&1
+            echo "Stopped all bitcoind instances and cleaned wallets."
             ;;
         *)
             usage
-            say "Error: unknown command $cmd"
+            say "Error: unknown command '$cmd'"
             ;;
-
     esac
 }
 
 start() {
     local version="$1"
+    local version_number="$2"
+    local version_id="$3"
+    local bitcoind_path="$4"
 
-    case $version in
-        v28)
-            local version_number="28.0"
-            local version_id="280"
-            ;;
-
-        v27)
-            local version_number="27.1"
-            local version_id="271"
-            ;;
-
-        v26)
-            local version_number="26.2"
-            local version_id="262"
-            ;;
-
-        v25)
-            local version_number="25.2"
-            local version_id="252"
-            ;;
-
-        v24)
-            local version_number="24.2"
-            local version_id="242"
-            ;;
-
-        v23)
-            local version_number="23.2"
-            local version_id="232"
-            ;;
-
-        v22)
-            local version_number="22.1"
-            local version_id="221"
-            ;;
-
-        v21)
-            local version_number="0.21.2"
-            local version_id="212"
-            ;;
-
-        v20)
-            local version_number="0.20.2"
-            local version_id="202"
-            ;;
-
-        v19)
-            local version_number="0.19.1"
-            local version_id="191"
-            ;;
-
-        v18)
-            local version_number="0.18.1"
-            local version_id="181"
-            ;;
-
-        v17)
-            local version_number="0.17.1"
-            local version_id="172"
-            ;;
-
-        *)
-            usage
-            err "Error: unknown version $version"
-            ;;
-    esac
+    if [ ! -x "$bitcoind_path" ]; then
+        err "bitcoind binary not found or not executable at '$bitcoind_path'"
+    fi
 
-    run_bitcoind "$version" "$version_number" "$version_id"
+    run_bitcoind "$version" "$version_number" "$version_id" "$bitcoind_path"
 }
 
 run_bitcoind() {
-    local version="$1"          # eg, v22
-    local version_number="$2"   # eg, 22.1
-    local version_id="$3"       # eg, 221
+    local version="$1"              # e.g., v28
+    local version_number="$2"       # e.g., 28.1.0
+    local version_id="$3"           # e.g., 281
+    local bitcoind="$4"
 
     local test_dir="/tmp/corepc-${version_number}"
-    local bitcoind="/opt/bitcoin-${version_number}/bin/bitcoind"
-    # RPC port number of the node we hit when testing (xyz49 where xyz is the bitcoind version identifier).
     local rpc_port="${version_id}49"
 
-    if "$bitcoind" -version | grep -q "${version_number}"; then
-        echo "Starting two bitcoind v${version_number} instances"
-    else
-        echo "Wrong bitcoind version, expected ${version_number}"
-        "$bitcoind" -version
+    if ! "$bitcoind" -version | grep -q "$version_number"; then
+        echo "Version mismatch: Expected $version_number, got $("$bitcoind" -version | head -n1)"
         exit 1
     fi
 
     rm -rf "${test_dir}"
     mkdir -p "${test_dir}/1" "${test_dir}/2"
 
-
     local block_filter_arg=""
-    if echo "${version_number}" | grep -q "0\.\(19\|2\)"; then
+    if [[ "$version_number" =~ ^0\.(19|2) ]]; then
         block_filter_arg="-blockfilterindex=1"
     fi
 
     local fallback_fee_arg=""
-    if echo "${version_number}" | grep -q "2.\."; then
+    if [[ "$version_number" =~ ^[0-9]+\. ]]; then
         fallback_fee_arg="-fallbackfee=0.00001000"
     fi
 
+    echo "Starting bitcoind v${version_number} (alias: ${version})..."
     "$bitcoind" -regtest $fallback_fee_arg $block_filter_arg \
                 -datadir="${test_dir}/1" \
                 -port="${version_id}48" \
                 -server=0 \
                 -printtoconsole=0 &
 
-    # Make sure it's listening on its p2p port.
-    sleep 1
+    sleep 1  # Allow first node to start
 
     "$bitcoind" -regtest $fallback_fee_arg $block_filter_arg \
                 -datadir="${test_dir}/2" \
@@ -208,21 +204,13 @@ run_bitcoind() {
                 -zmqpubrawblock=tcp://0.0.0.0:"${version_id}32" \
                 -zmqpubrawtx=tcp://0.0.0.0:"${version_id}33" &
 
-    # Let it connect to the other node.
-    sleep 1
-
+    sleep 1  # Let nodes connect
     echo "Two connected bitcoind v${version_number} instances running, one node has JSON-RPC listening on port ${rpc_port}"
 }
 
 say() {
     echo "run-bitcoind: $1"
 }
-
-err() {
-    echo "$1" >&2
-    exit 1
-}
-
 #
 # Main script
 #