[ci] Switch from local flake to avalanchego flake (#1990)

maru-ava · web-flow · commit 0fb6cc743147 · 2025-03-25T19:20:39.000Z
Signed-off-by: maru &lt;maru.newby@avalabs.org&gt;
diff --git a/.envrc b/.envrc
@@ -0,0 +1,10 @@
+# - Will execute on entry to the containing directory only if authorized with `direnv allow`
+# - Requires a recent version of direnv (https://direnv.net/)
+# - For quieter direnv output, set `export DIRENV_LOG_FORMAT=`
+
+# Determine AVALANCHE_VERSION
+source ./scripts/constants.sh
+
+# - Starts an avalanchego dev shell
+# - Requires nix (https://github.com/DeterminateSystems/nix-installer?tab=readme-ov-file#install-nix)
+use flake "github:ava-labs/avalanchego?ref=${AVALANCHE_VERSION}"
diff --git a/.github/workflows/hypersdk-ci.yml b/.github/workflows/hypersdk-ci.yml
@@ -55,11 +55,10 @@ jobs:
       - name: Run actionlint
         shell: bash
         run: scripts/tests.actionlint.sh
-      - uses: ava-labs/avalanchego/.github/actions/install-nix@6626b41b013f2365b96bd66dfc8499ee4861d25b
       - name: Ensure consistent avalanchego version
         shell: bash
         run: |
-          nix develop --command bash -x scripts/update_avalanchego_version.sh
+          scripts/update_avalanchego_version.sh
           git diff --exit-code
 
   # This workflow job ensures generated code is up-to-date
@@ -153,7 +152,7 @@ jobs:
             go.sum
             examples/morpheusvm/go.sum
       - name: Run e2e tests
-        uses: ava-labs/avalanchego/.github/actions/run-monitored-tmpnet-cmd@6626b41b013f2365b96bd66dfc8499ee4861d25b
+        uses: ava-labs/avalanchego/.github/actions/run-monitored-tmpnet-cmd@50f1601bf39a106d066012b4ef470c1058f5005a
         with:
           run: ./examples/morpheusvm/scripts/run.sh
           run_env: MODE='test'
diff --git a/.gitignore b/.gitignore
@@ -71,3 +71,5 @@ compose-dev.yaml
 # Do not ignore specific .txt files for license check
 !license-header.txt
 !license-style.txt
+
+.direnv
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -53,6 +53,23 @@ The `hypersdk` project also has a fixer that tries to help. To run the fixer, si
 ./scripts/fix.lint.sh
 ```
 
+## Optional Dev Shell
+
+Some activities, such as collecting metrics and logs from the nodes targeted by an e2e
+test run, require binary dependencies. One way of making these dependencies available is
+to use a nix shell which will give access to the dependencies expected by the test
+tooling:
+
+ - Install [nix](https://nixos.org/). The [determinate systems
+   installer](https://github.com/DeterminateSystems/nix-installer?tab=readme-ov-file#install-nix)
+   is recommended.
+ - Use ./scripts/dev_shell.sh to start a nix shell
+ - Execute the dependency-requiring command (e.g. `ginkgo -v ./tests/e2e -- --start-collectors`)
+
+This repo also defines a `.envrc` file to configure [devenv](https://direnv.net/). With `devenv`
+and `nix` installed, a shell at the root of the hypersdk repo will automatically start a nix dev
+shell.
+
 ## Contributing
 
 We welcome contributions to hypersdk! To contribute, please follow these steps:
diff --git a/examples/morpheusvm/go.mod b/examples/morpheusvm/go.mod
@@ -3,7 +3,7 @@ module github.com/ava-labs/hypersdk/examples/morpheusvm
 go 1.23.7
 
 require (
-	github.com/ava-labs/avalanchego v1.12.3-0.20250317160941-6626b41b013f
+	github.com/ava-labs/avalanchego v1.13.1-0.20250321175346-50f1601bf39a
 	github.com/ava-labs/hypersdk v0.0.0-00010101000000-000000000000
 	github.com/fatih/color v1.13.0
 	github.com/onsi/ginkgo/v2 v2.13.1
@@ -18,7 +18,7 @@ require (
 	github.com/NYTimes/gziphandler v1.1.1 // indirect
 	github.com/StephenButtolph/canoto v0.15.0 // indirect
 	github.com/VictoriaMetrics/fastcache v1.12.1 // indirect
-	github.com/ava-labs/coreth v0.14.1-rc.2.0.20250307191323-71558f89e990 // indirect
+	github.com/ava-labs/coreth v0.15.0-rc.0.0.20250320164322-dac35665f8fd // indirect
 	github.com/beorn7/perks v1.0.1 // indirect
 	github.com/bits-and-blooms/bitset v1.10.0 // indirect
 	github.com/btcsuite/btcd/btcec/v2 v2.3.2 // indirect
diff --git a/examples/morpheusvm/go.sum b/examples/morpheusvm/go.sum
@@ -62,10 +62,10 @@ github.com/allegro/bigcache v1.2.1-0.20190218064605-e24eb225f156/go.mod h1:Cb/ax
 github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8=
 github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio=
 github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs=
-github.com/ava-labs/avalanchego v1.12.3-0.20250317160941-6626b41b013f h1:K4LOeVz3V9fa14Kq3m6j/ZD/JXhO+8sY70IVHCcsqzM=
-github.com/ava-labs/avalanchego v1.12.3-0.20250317160941-6626b41b013f/go.mod h1:8eq+yF40tIMs1KAuSsS8h5VqT+kLMwyqliomV6RGpOo=
-github.com/ava-labs/coreth v0.14.1-rc.2.0.20250307191323-71558f89e990 h1:tMdOyCb0L5mbkesMCIvqeTPvQl3XzD0gEkbSkoMSBzk=
-github.com/ava-labs/coreth v0.14.1-rc.2.0.20250307191323-71558f89e990/go.mod h1:ilQRZoMu4fnSx5i8P+r/AhM+/WHhxm3n3tPQudoECb4=
+github.com/ava-labs/avalanchego v1.13.1-0.20250321175346-50f1601bf39a h1:CjuaPVnONeFUUN6za8+lLlrGd2+PmWC34Lf1jjY+WWA=
+github.com/ava-labs/avalanchego v1.13.1-0.20250321175346-50f1601bf39a/go.mod h1:fpV/GmbfIB3P53gkq6zFpyeQtyAsJIuZCCKnm7TJ4sQ=
+github.com/ava-labs/coreth v0.15.0-rc.0.0.20250320164322-dac35665f8fd h1:pYNXZk+nbyvG+YJBAGeWUGPPuwKqJZVPd1uVwc6SZXs=
+github.com/ava-labs/coreth v0.15.0-rc.0.0.20250320164322-dac35665f8fd/go.mod h1:292OEKMTXPHjWVleBouko2+bRp1oYnmy0npWnmq6pqk=
 github.com/aymerick/raymond v2.0.3-0.20180322193309-b565731e1464+incompatible/go.mod h1:osfaiScAUVup+UC9Nfq76eWqDhXlp+4UYaA8uhTBO6g=
 github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
 github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
diff --git a/flake.lock b/flake.lock
diff --git a/flake.nix b/flake.nix
diff --git a/go.mod b/go.mod
@@ -4,7 +4,7 @@ go 1.23.7
 
 require (
 	github.com/StephenButtolph/canoto v0.15.0
-	github.com/ava-labs/avalanchego v1.12.3-0.20250317160941-6626b41b013f
+	github.com/ava-labs/avalanchego v1.12.3-0.20250321175346-50f1601bf39a
 	github.com/cockroachdb/pebble v0.0.0-20230928194634-aa077af62593
 	github.com/gorilla/rpc v1.2.0
 	github.com/gorilla/websocket v1.5.0
@@ -38,7 +38,7 @@ require (
 	github.com/DataDog/zstd v1.5.2 // indirect
 	github.com/NYTimes/gziphandler v1.1.1 // indirect
 	github.com/VictoriaMetrics/fastcache v1.12.1 // indirect
-	github.com/ava-labs/coreth v0.14.1-rc.2.0.20250307191323-71558f89e990 // indirect
+	github.com/ava-labs/coreth v0.15.0-rc.0.0.20250320164322-dac35665f8fd // indirect
 	github.com/beorn7/perks v1.0.1 // indirect
 	github.com/bits-and-blooms/bitset v1.10.0 // indirect
 	github.com/btcsuite/btcd/btcec/v2 v2.3.2 // indirect
diff --git a/go.sum b/go.sum
@@ -62,10 +62,10 @@ github.com/allegro/bigcache v1.2.1-0.20190218064605-e24eb225f156/go.mod h1:Cb/ax
 github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8=
 github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio=
 github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs=
-github.com/ava-labs/avalanchego v1.12.3-0.20250317160941-6626b41b013f h1:K4LOeVz3V9fa14Kq3m6j/ZD/JXhO+8sY70IVHCcsqzM=
-github.com/ava-labs/avalanchego v1.12.3-0.20250317160941-6626b41b013f/go.mod h1:8eq+yF40tIMs1KAuSsS8h5VqT+kLMwyqliomV6RGpOo=
-github.com/ava-labs/coreth v0.14.1-rc.2.0.20250307191323-71558f89e990 h1:tMdOyCb0L5mbkesMCIvqeTPvQl3XzD0gEkbSkoMSBzk=
-github.com/ava-labs/coreth v0.14.1-rc.2.0.20250307191323-71558f89e990/go.mod h1:ilQRZoMu4fnSx5i8P+r/AhM+/WHhxm3n3tPQudoECb4=
+github.com/ava-labs/avalanchego v1.12.3-0.20250321175346-50f1601bf39a h1:KSpG4lheMcV3oWrJJQyDyzx+JqSzjJPZEpi7UkSvE8I=
+github.com/ava-labs/avalanchego v1.12.3-0.20250321175346-50f1601bf39a/go.mod h1:fpV/GmbfIB3P53gkq6zFpyeQtyAsJIuZCCKnm7TJ4sQ=
+github.com/ava-labs/coreth v0.15.0-rc.0.0.20250320164322-dac35665f8fd h1:pYNXZk+nbyvG+YJBAGeWUGPPuwKqJZVPd1uVwc6SZXs=
+github.com/ava-labs/coreth v0.15.0-rc.0.0.20250320164322-dac35665f8fd/go.mod h1:292OEKMTXPHjWVleBouko2+bRp1oYnmy0npWnmq6pqk=
 github.com/aymerick/raymond v2.0.3-0.20180322193309-b565731e1464+incompatible/go.mod h1:osfaiScAUVup+UC9Nfq76eWqDhXlp+4UYaA8uhTBO6g=
 github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
 github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
diff --git a/scripts/dev_shell.sh b/scripts/dev_shell.sh
@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+# Copyright (C) 2023, Ava Labs, Inc. All rights reserved.
+
+set -euo pipefail
+
+# Requires nix to be installed. The determinate systems installer is recommended:
+#
+#   https://github.com/DeterminateSystems/nix-installer?tab=readme-ov-file#install-nix
+#
+
+# Load AVALANCHE_VERSION
+SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
+# shellcheck source=/scripts/constants.sh
+source "$SCRIPT_DIR"/constants.sh
+
+# Start a dev shell with the avalanchego flake
+FLAKE="github:ava-labs/avalanchego?ref=${AVALANCHE_VERSION}"
+echo "Starting nix shell for ${FLAKE}"
+nix develop "${FLAKE}" "${@}"
diff --git a/scripts/update_avalanchego_version.sh b/scripts/update_avalanchego_version.sh
@@ -2,21 +2,13 @@
 # Copyright (C) 2024, Ava Labs, Inc. All rights reserved.
 # See the file LICENSE for licensing terms.
 
-# This script assumes a linux or nix userland. On macos, invoke `nix develop` before running this script.
-
 set -euo pipefail
 
 if ! [[ "$0" =~ scripts/update_avalanchego_version.sh ]]; then
   echo "must be run from repository root"
   exit 255
 fi
 
-if ! nix --version > /dev/null 2>&1; then
-  echo "This script requires nix to be installed."
-  echo "See flake.nix for recommended installation instructions."
-  exit 255
-fi
-
 # If version is not provided, the existing version in go.mod is assumed
 VERSION="${1:-}"
 
@@ -53,16 +45,6 @@ FULL_AVALANCHE_VERSION="$("${CURL_ARGS[@]}" "${CURL_URL}" | grep '"sha":' | head
 
 # Ensure the custom action version matches the avalanche version
 WORKFLOW_PATH=".github/workflows/hypersdk-ci.yml"
-for custom_action in "run-monitored-tmpnet-cmd" "install-nix"; do
-  echo "Ensuring AvalancheGo version ${FULL_AVALANCHE_VERSION} for ${custom_action} custom action in ${WORKFLOW_PATH} "
-  sed -i.bak "s|\(uses: ava-labs/avalanchego/.github/actions/${custom_action}\)@.*|\1@${FULL_AVALANCHE_VERSION}|g" "${WORKFLOW_PATH}" && rm -f "${WORKFLOW_PATH}.bak"
-done
-
-# Ensure the flake version is the same as the avalanche version
-FLAKE_DEP="github:ava-labs/avalanchego"
-FLAKE_FILE=flake.nix
-echo "Ensuring AvalancheGo version ${FULL_AVALANCHE_VERSION} for ${FLAKE_DEP} input of ${FLAKE_FILE}"
-sed -i.bak "s|\(${FLAKE_DEP}?ref=\).*|\1${FULL_AVALANCHE_VERSION}\";|g" "${FLAKE_FILE}" && rm -f "${FLAKE_FILE}.bak"
-
-# Update the flake.lock file.
-nix flake update --extra-experimental-features nix-command --extra-experimental-features flakes
+CUSTOM_ACTION="ava-labs/avalanchego/.github/actions/run-monitored-tmpnet-cmd"
+echo "Ensuring AvalancheGo version ${FULL_AVALANCHE_VERSION} for ${CUSTOM_ACTION} custom action in ${WORKFLOW_PATH} "
+sed -i.bak "s|\(uses: ${CUSTOM_ACTION}\)@.*|\1@${FULL_AVALANCHE_VERSION}|g" "${WORKFLOW_PATH}" && rm -f "${WORKFLOW_PATH}.bak"
