Change ARCHIVE and MINIMAL to NODE_TYPE (#2401)

Author: yorickdowne

.github/workflows/test-client-combos.yml

@@ -151,7 +151,7 @@ jobs:
           - "CL_MAX_PEER_COUNT=100 CL_MIN_PEER_COUNT=20 EL_MAX_PEER_COUNT=10"
           - IPV6=true
           - IPV6=false
-          - EL_MINIMAL_NODE=false
+          - EL_NODE_TYPE=full
           - CHECKPOINT_SYNC_URL=
     steps:
       - name: Checkout

besu.yml

@@ -25,8 +25,7 @@ services:
       - JAVA_OPTS=${BESU_HEAP:--Xmx5g}
       - JWT_SECRET=${JWT_SECRET:-}
       - EL_EXTRAS=${EL_EXTRAS:-}
-      - ARCHIVE_NODE=${EL_ARCHIVE_NODE:-}
-      - MINIMAL_NODE=${EL_MINIMAL_NODE:-}
+      - NODE_TYPE=${EL_NODE_TYPE:-pre-merge-expiry}
       - NETWORK=${NETWORK}
       - IPV6=${IPV6:-false}
     volumes:

besu/docker-entrypoint.sh

@@ -63,38 +63,47 @@ else
   __network="--network ${NETWORK}"
 fi
 
-if [[ "${ARCHIVE_NODE}" = "true" ]]; then
-  echo "Besu archive node without pruning"
-  __prune="--data-storage-format=FOREST --sync-mode=FULL"
-elif [[ "${MINIMAL_NODE}" = "true" ]]; then
-  case "${NETWORK}" in
-    mainnet | sepolia )
-      echo "Besu minimal node with pre-merge history expiry"
-      __prune="--snapsync-server-enabled"
-      timestamp_file="/var/lib/besu/prune-history-timestamp.txt"
-      if [[ -f "${timestamp_file}" ]]; then
-        saved_ts=$(<"${timestamp_file}")
-        current_ts=$(date +%s)
-        diff=$((current_ts - saved_ts))
+case "${NODE_TYPE}" in
+  archive)
+    echo "Besu archive node without pruning"
+    __prune="--data-storage-format=FOREST --sync-mode=FULL"
+    ;;
+  full)
+    echo "Besu full node without history expiry"
+    __prune="--snapsync-synchronizer-pre-checkpoint-headers-only-enabled=false --snapsync-server-enabled"
+    ;;
+  pre-merge-expiry)
+    case "${NETWORK}" in
+      mainnet|sepolia)
+        echo "Besu minimal node with pre-merge history expiry"
+        __prune="--snapsync-server-enabled"
+        timestamp_file="/var/lib/besu/prune-history-timestamp.txt"
+        if [[ -f "${timestamp_file}" ]]; then
+          saved_ts=$(<"${timestamp_file}")
+          current_ts=$(date +%s)
+          diff=$((current_ts - saved_ts))
 
-        if (( diff >= 172800 )); then  # 48 * 60 * 60 - 48 hours have passed
-          rm -f "${timestamp_file}"
-        else
-          echo "Enabling RocksDB garbage collection after history prune. You should see Besu DB space usage go down."
-          echo "This may take 6-12 hours. Eth Docker will keep RocksDB garbage collection on for 48 hours."
-          __prune+=" --history-expiry-prune"
+          if (( diff >= 172800 )); then  # 48 * 60 * 60 - 48 hours have passed
+            rm -f "${timestamp_file}"
+          else
+            echo "Enabling RocksDB garbage collection after history prune. You should see Besu DB space usage go down."
+            echo "This may take 6-12 hours. Eth Docker will keep RocksDB garbage collection on for 48 hours."
+            __prune+=" --history-expiry-prune"
+          fi
         fi
-      fi
-      ;;
-    * )
-      echo "There is no pre-merge history for ${NETWORK} network, EL_MINIMAL_NODE has no effect."
-      __prune=""
-      ;;
-  esac
-else
-  echo "Besu full node without history expiry"
-  __prune="--snapsync-synchronizer-pre-checkpoint-headers-only-enabled=false --snapsync-server-enabled"
-fi
+        ;;
+      *)
+        echo "There is no pre-merge history for ${NETWORK} network, \"pre-merge-expiry\" has no effect."
+        __prune=""
+        ;;
+    esac
+    ;;
+  *)
+    echo "ERROR: The node type ${NODE_TYPE} is not known to Eth Docker's Besu implementation."
+    sleep 30
+    exit 1
+    ;;
+esac
 
 # New or old datadir
 if [[ -d /var/lib/besu-og/database ]]; then
@@ -116,7 +125,7 @@ set -- "${__args[@]}"
 
 if [[ -f /var/lib/besu/prune-history-marker ]]; then
   rm -f /var/lib/besu/prune-history-marker
-  if [[ "${ARCHIVE_NODE}" = "true" ]]; then
+  if [[ "${NODE_TYPE}" = "archive" ]]; then
     echo "Besu is an archive node. Not attempting to prune history: Aborting."
     exit 1
   fi
@@ -127,7 +136,7 @@ if [[ -f /var/lib/besu/prune-history-marker ]]; then
   exec /opt/besu/bin/besu ${__datadir} ${__network} storage prune-pre-merge-blocks
 elif [[ -f /var/lib/besu/prune-marker ]]; then
   rm -f /var/lib/besu/prune-marker
-  if [[ "${ARCHIVE_NODE}" = "true" ]]; then
+  if [[ "${NODE_TYPE}" = "archive" ]]; then
     echo "Besu is an archive node. Not attempting to prune trie-logs: Aborting."
     exit 1
   fi

default.env

@@ -195,26 +195,22 @@ W3S_HEAP=
 # If left empty, the default in lodestar.yml will be used.
 LODESTAR_HEAP=
 
-# Set this to true to sync an execution layer archive node instead of pruned
-# Caution that this may a) require a fresh sync and b) will
-# use a lot of disk - in the case of Geth >12TB, for example.
-EL_ARCHIVE_NODE=false
-# Set this to true to sync a consensus layer archive node instead of pruned
-# This may also keep all blobs, depending on client
-# For a more granular way to handle it, please use CL_EXTRAS instead
-CL_ARCHIVE_NODE=false
-# Set this to true to sync a minimal CL node - in use with Grandine and Teku, for example
-# CL_ARCHIVE_NODE must be false for this to take effect
-CL_MINIMAL_NODE=true
-# Set this to true to sync a node that does not carry all historical data, see EIP-4444
-# Only meaningful for mainnet and sepolia, may fail on hoodi
-# This expires pre-merge blocks and receipts as of June 2025, see https://hackmd.io/@hBXHLw_9Qq2va4pRtI4bIA/ryzBaf7fJx
+# CL_NODE_TYPE can be "archive", "full", "pruned" or "pruned-with-zkproofs"
+# "archive" may also keep all blobs, depending on client
+# Switching node type typically requires a resync
+# "pruned-with-zkproofs" is experimental and will not work with the standard client builds
+# For a more granular way to handle it, please use CL_EXTRAS in combination with "full"
+CL_NODE_TYPE=pruned
+# EL_NODE_TYPE can be "archive", "full", "pre-merge-expiry", "aggressive-expiry" or "rolling-expiry"
+# "pre-merge-expiry" is only meaningful for mainnet and sepolia, may fail on hoodi
+# Switching node type typically requires a resync
 # Consider using `./ethd prune-history`, which guides you as to whether to prune in-place
 # or resync, depending on client
-# Erigon also has an \"aggressive\" mode that prunes even more
-# EL_ARCHIVE_NODE must be false for this to take effect
-EL_MINIMAL_NODE=true
+# "aggressive-expiry" is supported with Erigon
+# "rolling-expiry" is a Nethermind feature, waiting for PR 2263 to do anything
+EL_NODE_TYPE=pre-merge-expiry
 # Era URLs, see https://eth-clients.github.io/history-endpoints/
+# Note that this will be replaced with EraE sometime 2026, possibly still Q1 2026
 # Era1 is for pre-merge data, Era for post-merge. If these URLs are
 # not empty, an EL that supports Era import will use them when fresh syncing
 # A network with pre-merge history can import Era1 and optionally also Era; one without
@@ -452,4 +448,4 @@ NODE_EXPORTER_IGNORE_MOUNT_REGEX='^/(dev|proc|sys|run|var/snap/.+|var/lib/docker
 DOCKER_ROOT=/var/lib/docker
 
 # Used by ethd update - please do not adjust
-ENV_VERSION=47
+ENV_VERSION=48

erigon.yml

@@ -24,8 +24,8 @@ services:
     environment:
       - JWT_SECRET=${JWT_SECRET}
       - EL_EXTRAS=${EL_EXTRAS:-}
-      - ARCHIVE_NODE=${EL_ARCHIVE_NODE:-}
-      - MINIMAL_NODE=${EL_MINIMAL_NODE:-}
+      - NODE_TYPE=${EL_NODE_TYPE:-pre-merge-expiry}
+      - CL_NODE_TYPE=${CL_NODE_TYPE:-pruned}
       - NETWORK=${NETWORK}
       - IPV6=${IPV6:-false}
       - COMPOSE_FILE=${COMPOSE_FILE}

erigon/docker-entrypoint.sh

@@ -67,27 +67,37 @@ else
   __network="--chain ${NETWORK}"
 fi
 
-if [[ "${ARCHIVE_NODE}" = "true" ]]; then
-  echo "Erigon archive node without pruning"
-  __prune="--prune.mode=archive --prune.distance=0"
-elif [[ "${MINIMAL_NODE}" = "aggressive" ]]; then
-  echo "Erigon minimal node with aggressive expiry"
-  __prune="--prune.mode=minimal --persist.receipts=false"
-elif [[ "${MINIMAL_NODE}" = "true" ]]; then
-  case "${NETWORK}" in
-    mainnet | sepolia )
-      echo "Erigon minimal node with pre-merge history expiry"
-      __prune="--prune.mode=full --persist.receipts=false"
-      ;;
-    * )
-      echo "There is no pre-merge history for ${NETWORK} network, Erigon will use \"full\" pruning."
-      __prune="--prune.mode=full --persist.receipts=false"
-      ;;
-  esac
-else
-  echo "Erigon full node without history expiry"
-  __prune="--prune.mode=blocks"
-fi
+case "${NODE_TYPE}" in
+  archive)
+    echo "Erigon archive node without pruning"
+    __prune="--prune.mode=archive --prune.distance=0"
+    ;;
+  full)
+    echo "Erigon full node without history expiry"
+    __prune="--prune.mode=blocks --prune.include-commitment-history"
+    ;;
+  pre-merge-expiry)
+    case "${NETWORK}" in
+      mainnet|sepolia)
+        echo "Erigon minimal node with pre-merge history expiry"
+        __prune="--prune.mode=full --persist.receipts=false"
+        ;;
+      *)
+        echo "There is no pre-merge history for ${NETWORK} network, Erigon will use \"full\" pruning."
+        __prune="--prune.mode=full --persist.receipts=false"
+        ;;
+    esac
+    ;;
+  aggressive-expiry)
+    echo "Erigon minimal node with aggressive expiry"
+    __prune="--prune.mode=minimal --persist.receipts=false"
+    ;;
+  *)
+    echo "ERROR: The node type ${NODE_TYPE} is not known to Eth Docker's Erigon implementation."
+    sleep 30
+    exit 1
+    ;;
+esac
 
 __caplin=""
 # shellcheck disable=SC2076
@@ -104,7 +114,8 @@ else
     __caplin+=" --caplin.mev-relay-url=${MEV_NODE}"
     echo "MEV Boost enabled"
   fi
-  if [[ "${ARCHIVE_NODE}" = "true" ]]; then
+  if [[ "${CL_NODE_TYPE}" = "archive" ]]; then
+    echo "Running Caplin archive node"
     __caplin+=" --caplin.states-archive=true --caplin.blobs-archive=true --caplin.blobs-no-pruning=true --caplin.blocks-archive=true"
   fi
   if [[ -n "${CHECKPOINT_SYNC_URL}" ]]; then