[nix] Add package for official golang binaries (#3824)

Author: maru-ava

.github/CODEOWNERS

@@ -22,6 +22,7 @@
 /flake.nix @joshua-kim @maru-ava
 /network/p2p/ @joshua-kim
 /network/p2p/*.md @joshua-kim @meaghanfitzgerald
+/nix/* @joshua-kim @maru-ava
 /scripts/ @joshua-kim @maru-ava
 /scripts/*.md @joshua-kim @maru-ava @meaghanfitzgerald
 /scripts/benchmark_cchain_range.sh @aaronbuchwald

.github/actions/c-chain-reexecution-benchmark/action.yml

@@ -64,7 +64,6 @@ inputs:
 runs:
   using: composite
   steps:
-    - uses: ./.github/actions/setup-go-for-project
     - name: Set task env
       shell: bash
       run: |
@@ -113,8 +112,6 @@ runs:
         github-token: ${{ inputs.github-token }}
         auto-push: ${{ inputs.push-github-action-benchmark }}
 
-    - uses: ./.github/actions/install-nix
-      if: ${{ inputs.push-post-state != '' }}
     - name: Push Post-State to S3 (if not exists)
       if: ${{ inputs.push-post-state != '' }}
       shell: nix develop --command bash -x {0}

.github/actions/install-nix/action.yml

@@ -15,3 +15,23 @@ runs:
         github_access_token: ${{ inputs.github_token }}
     - run: nix develop --command echo "dependencies installed"
       shell: bash
+    # Cache Go modules (architecture-independent)
+    - uses: actions/cache@v4
+      id: go-mod-cache
+      with:
+        path: ~/go/pkg/mod
+        key: ${{ runner.os }}-go-mod-${{ hashFiles('go.sum', 'tools/go.sum') }}
+        restore-keys: ${{ runner.os }}-go-mod-
+    # Cache Go build cache (architecture-specific)
+    - uses: actions/cache@v4
+      with:
+        path: ~/.cache/go-build
+        key: ${{ runner.os }}-${{ runner.arch }}-go-build-${{ hashFiles('go.sum', 'tools/go.sum') }}
+        restore-keys: ${{ runner.os }}-${{ runner.arch }}-go-build-
+    # Download modules only on cache miss
+    - run: nix develop --command go mod download
+      if: steps.go-mod-cache.outputs.cache-hit != 'true'
+      shell: bash
+    - run: nix develop --command go mod download -modfile=tools/go.mod
+      if: steps.go-mod-cache.outputs.cache-hit != 'true'
+      shell: bash

.github/actions/run-monitored-tmpnet-cmd/action.yml

@@ -59,11 +59,33 @@ runs:
     # - Avoid using the install-nix custom action since a relative
     #   path wouldn't be resolveable from other repos and an absolute
     #   path would require setting a version.
+    # - TODO(marun) Switch to a relative reference to the install-nix
+    #   custom action if/when no external repos use this action.
     - uses: cachix/install-nix-action@02a151ada4993995686f9ed4f1be7cfbb229e56f #v31
       with:
         github_access_token: ${{ inputs.github_token }}
     - run: $GITHUB_ACTION_PATH/nix-develop.sh --command echo "dependencies installed"
       shell: bash
+    # Cache Go modules (architecture-independent)
+    - uses: actions/cache@v4
+      id: go-mod-cache
+      with:
+        path: ~/go/pkg/mod
+        key: ${{ runner.os }}-go-mod-${{ hashFiles('go.sum', 'tools/go.sum') }}
+        restore-keys: ${{ runner.os }}-go-mod-
+    # Cache Go build cache (architecture-specific)
+    - uses: actions/cache@v4
+      with:
+        path: ~/.cache/go-build
+        key: ${{ runner.os }}-${{ runner.arch }}-go-build-${{ hashFiles('go.sum', 'tools/go.sum') }}
+        restore-keys: ${{ runner.os }}-${{ runner.arch }}-go-build-
+    # Download modules only on cache miss
+    - run: $GITHUB_ACTION_PATH/nix-develop.sh --command go mod download
+      if: steps.go-mod-cache.outputs.cache-hit != 'true'
+      shell: bash
+    - run: $GITHUB_ACTION_PATH/nix-develop.sh --command go mod download -modfile=tools/go.mod
+      if: steps.go-mod-cache.outputs.cache-hit != 'true'
+      shell: bash
     - name: Notify of metrics availability
       if: (inputs.prometheus_username != '')
       shell: bash

.github/workflows/ci.yml

@@ -46,7 +46,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: ./.github/actions/setup-go-for-project
       - name: Run e2e tests
         uses: ./.github/actions/run-monitored-tmpnet-cmd
         with:
@@ -65,7 +64,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: ./.github/actions/setup-go-for-project
       - name: Run e2e tests
         uses: ./.github/actions/run-monitored-tmpnet-cmd
         with:
@@ -84,7 +82,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: ./.github/actions/setup-go-for-project
       - uses: ./.github/actions/run-monitored-tmpnet-cmd
         with:
           run: ./scripts/run_task.sh test-e2e-kube-ci
@@ -103,7 +100,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: ./.github/actions/setup-go-for-project
       - name: Run e2e tests with existing network
         uses: ./.github/actions/run-monitored-tmpnet-cmd
         with:
@@ -121,7 +117,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: ./.github/actions/setup-go-for-project
       - name: Run e2e tests
         uses: ./.github/actions/run-monitored-tmpnet-cmd
         with:
@@ -139,7 +134,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: ./.github/actions/setup-go-for-project
       - uses: ./.github/actions/install-nix
       - name: Runs all lint checks
         shell: nix develop --command bash -x {0}
@@ -157,7 +151,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: ./.github/actions/setup-go-for-project
       # Use the dev shell instead of bufbuild/buf-action to ensure the dev shell provides the expected versions
       - uses: ./.github/actions/install-nix
       - shell: nix develop --command bash -x {0}
@@ -183,7 +176,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: ./.github/actions/setup-go-for-project
       - uses: ./.github/actions/install-nix
       - shell: nix develop --command bash -x {0}
         run: task check-generate-load-contract-bindings
@@ -230,7 +222,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: ./.github/actions/setup-go-for-project
       - uses: ./.github/actions/install-nix
       - name: Run e2e tests
         shell: bash
@@ -240,7 +231,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: ./.github/actions/setup-go-for-project
       - uses: ./.github/actions/run-monitored-tmpnet-cmd
         with:
           run: ./scripts/run_task.sh test-load -- --load-timeout=30s
@@ -258,7 +248,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: ./.github/actions/setup-go-for-project
       - uses: ./.github/actions/run-monitored-tmpnet-cmd
         with:
           run: ./scripts/run_task.sh test-load-kube-kind -- --load-timeout=30s
@@ -276,7 +265,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: ./.github/actions/setup-go-for-project
       - uses: ./.github/actions/install-nix
         # TODO(marun) Extend testing of robustness beyond deploying a suitable test environment
       - name: Deploy kind with chaos mesh

.github/workflows/firewood-load-test.yml

@@ -20,7 +20,6 @@ jobs:
             sudo apt-get install -y xz-utils
           fi
       - uses: actions/checkout@v4
-      - uses: ./.github/actions/setup-go-for-project
       - uses: ./.github/actions/run-monitored-tmpnet-cmd
         with:
           run: ./scripts/run_task.sh test-load -- --load-timeout=30m --firewood

.github/workflows/self-hosted-load-tests.yaml

@@ -34,7 +34,6 @@ jobs:
             sudo apt-get install -y xz-utils
           fi
       - uses: actions/checkout@v4
-      - uses: ./.github/actions/setup-go-for-project
       - name: Run load test
         uses: ./.github/actions/run-monitored-tmpnet-cmd
         with:

flake.nix

@@ -39,6 +39,9 @@
             # Task runner
             go-task
 
+            # Local Go package
+            (import ./nix/go.nix { inherit pkgs; })
+
             # Monitoring tools
             promtail                                   # Loki log shipper
             prometheus                                 # Metrics collector
@@ -71,6 +74,12 @@
           # Add scripts/ directory to PATH so kind-with-registry.sh is accessible
           shellHook = ''
             export PATH="$PWD/scripts:$PATH"
+
+            # Ensure golang bin is in the path
+            GOBIN="$(go env GOPATH)/bin"
+            if [[ ":$PATH:" != *":$GOBIN:"* ]]; then
+              export PATH="$GOBIN:$PATH"
+            fi
           '';
         };
       });

go.mod

@@ -8,6 +8,7 @@ module github.com/ava-labs/avalanchego
 //   - CONTRIBUTING.md
 //   - README.md
 //   - go.mod (here)
+//   - nix/go.nix (update version and sha256 for supported arches)
 //   - tools/go.mod
 //
 // - If updating between minor versions (e.g. 1.24.x -> 1.25.x):

nix/go.nix

@@ -0,0 +1,56 @@
+{ pkgs }:
+let
+  # Helper functions to derive Go arch from Nix arch
+  nixArchToGoArch = arch: {
+    "x86_64" = "amd64";
+    "aarch64" = "arm64";
+  }.${arch} or arch;
+
+  # Split system into arch and os
+  parseSystem = system:
+    let
+      parts = builtins.split "-" system;
+      arch = builtins.elemAt parts 0;
+      os = builtins.elemAt parts 2;
+    in {
+      goarch = nixArchToGoArch arch;
+      goos = os;
+      goURLPath = "${os}-${nixArchToGoArch arch}";
+    };
+
+  # Update the following to change the version:
+  goVersion = "1.24.7";
+  goSHA256s = {
+    "linux-amd64" = "da18191ddb7db8a9339816f3e2b54bdded8047cdc2a5d67059478f8d1595c43f";
+    "linux-arm64" = "fd2bccce882e29369f56c86487663bb78ba7ea9e02188a5b0269303a0c3d33ab";
+    "darwin-amd64" = "138b6be2138e83d2c90c23d3a2cc94fcb11864d8db0706bb1d1e0dde744dc46a";
+    "darwin-arm64" = "d06bad763f8820d3e29ee11f2c0c71438903c007e772a159c5760a300298302e";
+  };
+
+  targetSystem = parseSystem pkgs.system;
+in
+pkgs.stdenv.mkDerivation {
+  name = "go-${goVersion}";
+  version = goVersion;
+
+  inherit (targetSystem) goos goarch;
+  GOOS = targetSystem.goos;
+  GOARCH = targetSystem.goarch;
+
+  src = pkgs.fetchurl {
+    url = "https://go.dev/dl/go${goVersion}.${targetSystem.goURLPath}.tar.gz";
+    sha256 = goSHA256s.${targetSystem.goURLPath} or (throw "Unsupported system: ${pkgs.system}");
+  };
+
+  # Skip unpacking since we need special handling for the tarball
+  dontUnpack = true;
+
+  installPhase = ''
+    mkdir -p $out
+    # Extract directly to output, stripping the 'go' directory prefix
+    # and ignoring permission/ownership issues in containers
+    tar xzf $src -C $out --strip-components=1 --no-same-owner --no-same-permissions
+    # Ensure go binary is executable
+    chmod +x $out/bin/go
+  '';
+}