[ci] Support running re-execution benchmark with arbitrary version of Firewood

.github/workflows/c-chain-reexecution-benchmark-container.yml

@@ -82,8 +82,6 @@ jobs:
       id-token: write
       contents: write
     runs-on: ${{ matrix.runner }}
-    container:
-      image: ghcr.io/actions/actions-runner:2.325.0
     steps:
       - uses: actions/checkout@v4
       - name: Install ARC Dependencies

.github/workflows/c-chain-reexecution-benchmark-firewood.yml

@@ -0,0 +1,139 @@
+# Firewood Reexecution Benchmark
+#
+# This workflow runs C-Chain reexecution benchmarks with custom Firewood builds.
+# It's designed to be triggered by the Firewood repository to track performance.
+#
+# Firewood input modes:
+#   - Versioned (v0.0.15): Uses `go get` to fetch published version (fast)
+#   - Branch/commit (main, abc123): Builds from source using Nix (slower)
+#
+# Results are uploaded as artifacts for Firewood to download and publish
+# to their own GitHub Pages dashboard.
+
+name: Firewood Reexecution Benchmark
+
+on:
+  workflow_dispatch:
+    inputs:
+      firewood:
+        description: 'Firewood commit/branch/tag to build and test'
+        required: true
+      libevm:
+        description: 'libevm commit/branch/tag (optional)'
+        default: ''
+      task:
+        description: 'Taskfile task to execute (e.g., c-chain-reexecution-firewood-101-250k, if present custom inputs below are ignored)'
+        default: 'c-chain-reexecution-firewood-101-250k'
+      config:
+        default: ''
+      start-block:
+        default: ''
+      end-block:
+        default: ''
+      block-dir-src:
+        default: ''
+      current-state-dir-src:
+        default: ''
+      runner:
+        description: 'Runner to execute the benchmark. Input to the runs-on field of the job.'
+        required: true
+      push-post-state:
+        default: ''
+
+jobs:
+  determine-build-type:
+    runs-on: ubuntu-latest
+    outputs:
+      from-source: ${{ steps.check.outputs.from-source }}
+    steps:
+      - name: Check Firewood input
+        id: check
+        run: |
+          # Semantic versions (vX.Y.Z) are published to Go module registry
+          # Branches/commits need to be built from source using Nix
+          if [[ "${{ inputs.firewood }}" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+            echo "from-source=false" >> "$GITHUB_OUTPUT"
+            echo "Firewood version detected: ${{ inputs.firewood }}"
+          else
+            echo "from-source=true" >> "$GITHUB_OUTPUT"
+            echo "Firewood branch/commit detected: ${{ inputs.firewood }}"
+          fi
+  c-chain-reexecution:
+    needs: determine-build-type
+    permissions:
+      id-token: write
+      contents: write
+    runs-on: ${{ inputs.runner }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Go
+        uses: ./.github/actions/setup-go-for-project
+      - name: Install Nix dependencies
+        shell: bash
+        run: |
+          if ! command -v xz &> /dev/null; then
+            sudo apt-get update
+            sudo apt-get install -y xz-utils
+          fi
+      - name: Install Nix
+        if: needs.determine-build-type.outputs.from-source == 'true'
+        uses: cachix/install-nix-action@02a151ada4993995686f9ed4f1be7cfbb229e56f # v31
+        with:
+          github_access_token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Update libevm
+        if: inputs.libevm != ''
+        shell: bash
+        run: |
+          echo "Updating libevm to: ${{ inputs.libevm }}"
+          go get github.com/ava-labs/libevm@${{ inputs.libevm }}
+          cd graft/coreth
+          go get github.com/ava-labs/libevm@${{ inputs.libevm }}
+      - name: Fetch Firewood (versioned)
+        if: needs.determine-build-type.outputs.from-source == 'false'
+        shell: bash
+        run: |
+          cd graft/coreth
+          echo "Fetching published Firewood: ${{ inputs.firewood }}"
+          go get github.com/ava-labs/firewood-go-ethhash/ffi@${{ inputs.firewood }}
+      - name: Build Firewood (from source)
+        if: needs.determine-build-type.outputs.from-source == 'true'
+        shell: bash
+        run: ./scripts/run_task.sh build-firewood FIREWOOD_REF="${{ inputs.firewood }}" DIRTY=true
+        env:
+          TMPDIR: /tmp
+          NIX_BUILD_TOP: /tmp
+      # Commit go.mod changes locally to keep working tree clean
+      # (required for github-action-benchmark branch switching)
+      - name: Commit go.mod changes
+        shell: bash
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add go.mod go.sum graft/coreth/go.mod graft/coreth/go.sum
+          git diff --staged --quiet || git commit -m "temp: Firewood/libevm for benchmark"
+      - name: Run C-Chain Re-Execution Benchmark
+        uses: ./.github/actions/c-chain-reexecution-benchmark
+        with:
+          task: ${{ inputs.task }}
+          config: ${{ inputs.config }}
+          start-block: ${{ inputs.start-block }}
+          end-block: ${{ inputs.end-block }}
+          block-dir-src: ${{ inputs.block-dir-src }}
+          current-state-dir-src: ${{ inputs.current-state-dir-src }}
+          prometheus-url: ${{ secrets.PROMETHEUS_URL || '' }}
+          prometheus-push-url: ${{ secrets.PROMETHEUS_PUSH_URL || '' }}
+          prometheus-username: ${{ secrets.PROMETHEUS_USERNAME || '' }}
+          prometheus-password: ${{ secrets.PROMETHEUS_PASSWORD || '' }}
+          push-github-action-benchmark: false # Firewood downloads artifact and publishes to their gh-pages
+          aws-role: ${{ inputs.push-post-state != '' && secrets.AWS_S3_RW_ROLE || secrets.AWS_S3_READ_ONLY_ROLE }}
+          aws-region: 'us-east-2'
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          push-post-state: ${{ inputs.push-post-state }}
+          runner_name: ${{ inputs.runner }}
+      - name: Upload benchmark results
+        uses: actions/upload-artifact@v4
+        with:
+          name: benchmark-output
+          path: ${{ github.workspace }}/benchmark-output.txt
+          retention-days: 30
+          if-no-files-found: error

Taskfile.yml

@@ -328,6 +328,14 @@ tasks:
           CURRENT_STATE_DIR_SRC: 'cchain-current-state-firewood-100'
           CONFIG: firewood
 
+  build-firewood:
+    desc: Build Firewood FFI from source for testing with Coreth
+    dir: graft/coreth
+    vars:
+      FIREWOOD_REF: '{{.FIREWOOD_REF | default "main"}}'
+      DIRTY_FLAG: '{{if eq .DIRTY "true"}}--dirty{{end}}'
+    cmd: ./scripts/build_firewood.sh {{.FIREWOOD_REF}} {{.DIRTY_FLAG}}
+
   test-bootstrap-monitor-e2e:
     desc: Runs bootstrap monitor e2e tests
     cmd: bash -x ./scripts/tests.e2e.bootstrap_monitor.sh

graft/coreth/scripts/build_firewood.sh

@@ -0,0 +1,97 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+print_usage() {
+  printf "Usage: build_firewood.sh [FIREWOOD_COMMIT] [--dirty]
+
+  Build Firewood FFI from source for testing with Coreth.
+
+  Arguments:
+    FIREWOOD_COMMIT   Git commit or branch to build (default: main)
+
+  Options:
+    --dirty           Update go.mod after building (dirties working tree)
+                      (default: only print path)
+
+  Examples:
+    # Build from commit and capture FFI path
+    FIREWOOD_FFI_PATH=\$(./scripts/build_firewood.sh abc123def)
+
+    # Build from main and update go.mod (dirties tree)
+    ./scripts/build_firewood.sh main --dirty
+
+  Note: To use a published Firewood version (e.g., v0.0.15) run go get -u github.com/ava-labs/firewood-go-ethhash/ffi@{version}
+"
+}
+
+FIREWOOD_COMMIT="main"
+UPDATE_GO_MOD=false
+
+while [[ $# -gt 0 ]]; do
+  case $1 in
+    -h|--help)
+      print_usage
+      exit 0
+      ;;
+    --dirty)
+      UPDATE_GO_MOD=true
+      shift
+      ;;
+    *)
+      FIREWOOD_COMMIT="$1"
+      shift
+      ;;
+  esac
+done
+
+CORETH_PATH=$( cd "$( dirname "${BASH_SOURCE[0]}" )"; cd .. && pwd )
+FIREWOOD_DIR="${CORETH_PATH}/build/firewood"
+
+echo "Building Firewood FFI from source at: ${FIREWOOD_COMMIT}" >&2
+
+if ! command -v nix &> /dev/null; then
+  echo "Error: nix command not found" >&2
+  echo "Nix is required to build Firewood. To install it, run:" >&2
+  echo "  ./scripts/run_task.sh install-nix" >&2
+  exit 1
+fi
+
+if [ -d "${FIREWOOD_DIR}/.git" ]; then
+  cd "${FIREWOOD_DIR}"
+  git fetch origin
+  git checkout "${FIREWOOD_COMMIT}"
+  git pull --ff-only 2>/dev/null || true
+else
+  mkdir -p "${CORETH_PATH}/build"
+  git clone https://github.com/ava-labs/firewood.git "${FIREWOOD_DIR}"
+  cd "${FIREWOOD_DIR}"
+  git checkout "${FIREWOOD_COMMIT}"
+fi
+
+cd "${FIREWOOD_DIR}/ffi"
+nix build 2>&1
+
+FIREWOOD_FFI_PATH="${FIREWOOD_DIR}/ffi/result/ffi"
+export FIREWOOD_FFI_PATH
+
+if [ ! -d "${FIREWOOD_FFI_PATH}" ]; then
+  echo "Error: Build succeeded but result not found at ${FIREWOOD_FFI_PATH}" >&2
+  exit 1
+fi
+
+echo "Firewood built successfully at: ${FIREWOOD_FFI_PATH}" >&2
+
+if [ "${UPDATE_GO_MOD}" = true ]; then
+  echo "Updating go.mod..." >&2
+
+  cd "${CORETH_PATH}"
+  go mod edit -replace "github.com/ava-labs/firewood-go-ethhash/ffi=${FIREWOOD_FFI_PATH}"
+  go mod tidy
+
+  echo "Updated go.mod successfully" >&2
+fi
+
+# Output path to stdout for capture
+echo "${FIREWOOD_FFI_PATH}"
+