feat: Add just task runner to ensure reproducibility of CI

.github/check-license-headers.yaml

@@ -53,6 +53,8 @@
       "cliff.toml",
       "clippy.toml",
       "**/tests/compile_*/**",
+      "justfile",
+      "scripts/run-just.sh",
     ],
   }
 ]

.github/workflows/ci.yaml

@@ -251,18 +251,10 @@ jobs:
       - uses: actions/checkout@v4
       - uses: DeterminateSystems/nix-installer-action@786fff0690178f1234e4e1fe9b536e94f5433196 #v20
       - uses: DeterminateSystems/magic-nix-cache-action@565684385bcd71bad329742eefe8d12f2e765b39 #v13
-      - name: Test build equivalency between Nix and Cargo
-        run: bash -x ./ffi/test-build-equivalency.sh
-      - name: Test Go FFI bindings
-        working-directory: ffi
-        # - cgocheck2 is expensive but provides complete pointer checks
-        # - use hash mode ethhash since the flake builds with `--features ethhash,logger`
-        # - run golang outside a nix shell to validate viability without the env setup performed by a nix shell
-        run: |
-          GOLANG="nix run $PWD#go"
-          cd result/ffi
-          GOEXPERIMENT=cgocheck2 TEST_FIREWOOD_HASH_MODE=ethhash ${GOLANG} test ./...
-        shell: bash
+      - name: Check that FFI flake is up-to-date
+        run: ./scripts/run-just.sh check-ffi-flake
+      - name: Test nix build of Golang FFI bindings
+        run: ./scripts/run-just.sh test-ffi-nix
 
   firewood-ethhash-differential-fuzz:
     needs: build

ffi/flake.nix

@@ -116,13 +116,25 @@
         program = "${go}/bin/go";
       };
 
+      apps.jq = {
+        type = "app";
+        program = "${pkgs.jq}/bin/jq";
+      };
+
+      apps.just = {
+        type = "app";
+        program = "${pkgs.just}/bin/just";
+      };
+
       devShells.default = craneLib.devShell {
         inputsFrom = [ firewood-ffi ];
 
         packages = with pkgs; [
           firewood-ffi
-          rustToolchain
           go
+          jq
+          just
+          rustToolchain
         ];
 
         shellHook = ''

ffi/go.mod

@@ -4,9 +4,10 @@ go 1.24
 
 // Changes to the toolchain version should be replicated in:
 //   - ffi/go.mod (here)
-//   - ffi/flake.nix (update golang.url to a version of avalanchego's nix/go/flake.nix that uses the desired version)
+//   - ffi/flake.nix (update golang.url to a version of avalanchego's nix/go/flake.nix that uses the desired version and run `just update-ffi-flake`)
 //   - ffi/tests/eth/go.mod
 //   - ffi/tests/firewood/go.mod
+// `just check-golang-version` validates that these versions are in sync and will run in CI as part of the ffi-nix job.
 toolchain go1.24.9
 
 require (

justfile

@@ -0,0 +1,131 @@
+# List available recipes
+default:
+    ./scripts/run-just.sh --list
+
+# Build ffi with nix
+build-ffi-nix: check-nix
+    cd ffi && nix build
+
+# Check if the git branch is clean
+check-clean-branch:
+    #!/usr/bin/env bash
+    set -euo pipefail
+
+    git add --all
+    git update-index --really-refresh >> /dev/null
+
+    # Show the status of the working tree.
+    git status --short
+
+    # Exits if any uncommitted changes are found.
+    git diff-index --quiet HEAD
+
+# Check if the FFI flake is up-to-date (requires clean git tree)
+check-ffi-flake: check-nix
+    #!/usr/bin/env bash
+    set -euo pipefail
+    ./scripts/run-just.sh update-ffi-flake
+    ./scripts/run-just.sh check-clean-branch
+
+# Check if the golang version is set consistently (requires clean git tree)
+check-golang-version: check-nix
+    #!/usr/bin/env bash
+    set -euo pipefail
+
+    # Exit only at the end if any of the checks set FAILED=1
+    FAILED=
+
+    cd ffi
+
+    TOOLCHAIN_VERSION=$(nix develop --command bash -c "go mod edit -json | jq -r '.Toolchain'")
+    echo "toolchain version in ffi/go.mod is ${TOOLCHAIN_VERSION}"
+
+    ETH_TESTS_VERSION=$(nix develop --command bash -c "cd tests/eth && go mod edit -json | jq -r '.Toolchain'")
+    echo "toolchain version in ffi/tests/eth/go.mod is ${ETH_TESTS_VERSION}"
+
+    if [[ "${TOOLCHAIN_VERSION}" != "${ETH_TESTS_VERSION}" ]]; then
+        echo "❌ toolchain version in ffi/tests/eth/go.mod should be ${TOOLCHAIN_VERSION}"
+        FAILED=1
+    fi
+
+    FIREWOOD_TESTS_VERSION=$(nix develop --command bash -c "cd tests/firewood && go mod edit -json | jq -r '.Toolchain'")
+    echo "toolchain version in ffi/tests/firewood/go.mod is ${FIREWOOD_TESTS_VERSION}"
+
+    if [[ "${TOOLCHAIN_VERSION}" != "${FIREWOOD_TESTS_VERSION}" ]]; then
+        echo "❌ toolchain version in ffi/tests/firewood/go.mod should be ${TOOLCHAIN_VERSION}"
+        FAILED=1
+    fi
+
+    NIX_VERSION=$(nix run .#go -- version | awk '{print $3}')
+    echo "golang provided by ffi/flake.nix is ${NIX_VERSION}"
+
+    if [[ "${TOOLCHAIN_VERSION}" != "${NIX_VERSION}" ]]; then
+        echo "❌ golang provided by ffi/flake/nix should be ${TOOLCHAIN_VERSION}"
+        echo "It will be necessary to update the golang.url in ffi/flake.nix to point to a SHA of"\
+             "AvalancheGo whose nix/go/flake.nix provides ${TOOLCHAIN_VERSION}."
+    fi
+
+    if [[ -n "${FAILED}" ]]; then
+        exit 1
+    fi
+
+# Check if nix is installed
+check-nix:
+    #!/usr/bin/env bash
+    set -euo pipefail
+    if ! command -v nix &> /dev/null; then
+        echo "Error: 'nix' is not installed." >&2
+        echo "" >&2
+        echo "To install nix:" >&2
+        echo "  - Visit: https://github.com/DeterminateSystems/nix-installer" >&2
+        echo "  - Or run: curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install" >&2
+        exit 1
+    fi
+
+# Run all checks of ffi built with nix
+test-ffi-nix: test-ffi-nix-build-equivalency test-ffi-nix-go-bindings
+
+# Test ffi build equivalency between nix and cargo
+test-ffi-nix-build-equivalency: check-nix
+    #!/usr/bin/env bash
+    set -euo pipefail
+
+    echo "Testing ffi build equivalency between nix and cargo"
+
+    bash -x ./ffi/test-build-equivalency.sh
+
+# Test golang ffi bindings using the nix-built artifacts
+test-ffi-nix-go-bindings: build-ffi-nix
+    #!/usr/bin/env bash
+    set -euo pipefail
+
+    echo "running ffi tests against bindings built by nix..."
+
+    cd ffi
+
+    # Need to capture the flake path before changing directories to
+    # result/ffi because `result` is a nix store symlink so ../../
+    # won't resolve to the ffi path containing the flake.
+    FLAKE_PATH="$PWD"
+
+    # This runs golang outside a nix shell to validate viability
+    # without the env setup performed by a nix shell
+    GO="nix run $FLAKE_PATH#go"
+
+    cd result/ffi
+
+    # - cgocheck2 is expensive but provides complete pointer checks
+    # - use hash mode ethhash since the flake builds with `--features ethhash,logger`
+    GOEXPERIMENT=cgocheck2 TEST_FIREWOOD_HASH_MODE=ethhash ${GO} test ./...
+
+# Ensure the FFI flake is up-to-date
+update-ffi-flake: check-nix
+    #!/usr/bin/env bash
+    set -euo pipefail
+    cd ffi
+
+    echo "ensuring flake lock file is current for golang"
+    nix flake update golang
+
+    echo "checking for a consistent golang verion"
+    ../scripts/run-just.sh check-golang-version

scripts/run-just.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+if command -v just &> /dev/null; then
+    exec just "$@"
+elif command -v nix &> /dev/null; then
+    exec nix run nixpkgs#just -- "$@"
+else
+    echo "Error: Neither 'just' nor 'nix' is installed." >&2
+    echo "" >&2
+    echo "Please install one of the following:" >&2
+    echo "" >&2
+    echo "Option 1 - Install just:" >&2
+    echo "  - Visit: https://github.com/casey/just#installation" >&2
+    echo "  - Or use cargo: cargo install just" >&2
+    echo "" >&2
+    echo "Option 2 - Install nix:" >&2
+    echo "  - Visit: https://github.com/DeterminateSystems/nix-installer" >&2
+    echo "  - Or run: curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install" >&2
+    exit 1
+fi