feat: add binary to benchmark TPS

.github/workflows/ci.yml

@@ -251,6 +251,50 @@ jobs:
             --data-directory ${{ env.DATA_DIR }} \
             --iterations 10 --concurrency 1 sync-nullifiers --prefixes 10
 
+  # Smoke-tests `miden-benchmark` end-to-end against a locally bootstrapped node.
+  benchmark:
+    name: benchmark smoke
+    runs-on: warp-ubuntu-latest-x64-8x
+    timeout-minutes: 20
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          persist-credentials: false
+      - name: Rustup
+        run: rustup toolchain install --no-self-update
+      - uses: WarpBuilds/rust-cache@9d0cc3090d9c87de74ea67617b246e978735b1a1 # v2.9.1
+        with:
+          shared-key: ${{ github.job }}
+          prefix-key: ${{ env.CACHE_PREFIX }}
+          save-if: ${{ env.SAVE_CACHE }}
+      - name: Build benchmark stack
+        run: |
+          cargo build --release --locked \
+            --bin miden-node \
+            --bin miden-validator \
+            --bin miden-ntx-builder \
+            --bin miden-remote-prover \
+            --bin miden-benchmark
+      - name: Run benchmark with N=1
+        env:
+          N_TXS: "1"
+          USE_REMOTE_PROVER: "0"
+          WAIT_BLOCKS: "30"
+          RUN_DIR: ${{ runner.temp }}/bench-local-run
+        run: |
+          export PATH="$PWD/target/release:$PATH"
+          ./scripts/bench-local.sh
+      - name: Dump component logs on failure
+        if: failure()
+        run: |
+          set +e
+          for f in ${{ runner.temp }}/bench-local-run/logs/*.log; do
+            [ -f "$f" ] || continue
+            echo "::group::$(basename "$f")"
+            tail -n 200 "$f"
+            echo "::endgroup::"
+          done
+
   # ===============================================================================================
   # WASM related jobs
   # ===============================================================================================

.gitignore

@@ -26,6 +26,12 @@ miden-node-stress-test-*
 /accounts
 /data
 
+# Native benchmark runtime artifacts (data dir, logs, snapshots, proofs).
+/node-data*
+/logs
+/snapshots
+/benchmark-proofs
+
 # Sqlite db files
 *.sqlite3
 *.sqlite3-shm

Cargo.toml

@@ -1,5 +1,6 @@
 [workspace]
 members = [
+  "bin/benchmark",
   "bin/network-monitor",
   "bin/node",
   "bin/ntx-builder",
@@ -156,6 +157,10 @@ should_panic_without_expect  = "allow" # We don't care about the specific panic
 # Configure `cargo-typos`
 [workspace.metadata.typos]
 files.extend-exclude = [
-  "*.min.js", # Minified JS bundles (vendored htmx etc.).
-  "*.svg",    # SVG files.
+  "*.min.js",          # Minified JS bundles (vendored htmx etc.).
+  "*.svg",             # SVG files.
+  "benchmark-proofs/", # miden-benchmark output.
+  "logs/",             # Native benchmark process logs.
+  "node-data*/",       # Native benchmark runtime data dir + any sibling clones (RocksDB LOGs etc.).
+  "snapshots/",        # Snapshot tarballs used by the bench replay workflow.
 ]

Makefile

@@ -172,6 +172,10 @@ install-stress-test: ## Installs stress-test binary
 install-network-monitor: ## Installs network monitor binary
 	cargo install --path bin/network-monitor --locked
 
+.PHONY: install-benchmark
+install-benchmark: ## Installs the benchmark binary
+	cargo install --path bin/benchmark --locked
+
 # --- docker --------------------------------------------------------------------------------------
 
 .PHONY: local-network-build

bin/benchmark/Cargo.toml

@@ -0,0 +1,32 @@
+[package]
+authors.workspace      = true
+description            = "A binary to run benchmarks of the Miden network"
+edition.workspace      = true
+exclude.workspace      = true
+homepage.workspace     = true
+keywords               = ["benchmark", "miden", "node"]
+license.workspace      = true
+name                   = "miden-benchmark"
+publish                = true
+readme.workspace       = true
+repository.workspace   = true
+rust-version.workspace = true
+version.workspace      = true
+
+[lints]
+workspace = true
+
+[dependencies]
+anyhow                     = { workspace = true }
+clap                       = { features = ["env", "string"], workspace = true }
+fs-err                     = { workspace = true }
+miden-node-proto           = { workspace = true }
+miden-protocol             = { features = ["std", "testing"], workspace = true }
+miden-remote-prover-client = { features = ["tx-prover"], workspace = true }
+miden-standards            = { workspace = true }
+miden-tx                   = { features = ["concurrent", "std"], workspace = true }
+rand                       = { workspace = true }
+rayon                      = { workspace = true }
+tokio                      = { features = ["full"], workspace = true }
+tonic                      = { workspace = true }
+url                        = { features = ["serde"], workspace = true }