gate unreleased forks

Author: terencechain

beacon-chain/blockchain/process_block_test.go

@@ -2804,7 +2804,7 @@ func TestProcessLightClientUpdate(t *testing.T) {
 	require.NoError(t, s.cfg.BeaconDB.SaveState(ctx, headState, [32]byte{1, 2}))
 	require.NoError(t, s.cfg.BeaconDB.SaveHeadBlockRoot(ctx, [32]byte{1, 2}))
 
-	for _, testVersion := range version.All()[1:] {
+	for _, testVersion := range version.Released()[1:] {
 		t.Run(version.String(testVersion), func(t *testing.T) {
 			l := util.NewTestLightClient(t, testVersion)
 

beacon-chain/core/validators/slashing_test.go

@@ -8,7 +8,7 @@ import (
 )
 
 func TestSlashingParamsPerVersion_NoErrors(t *testing.T) {
-	for _, v := range version.All() {
+	for _, v := range version.Released() {
 		_, _, _, err := validators.SlashingParamsPerVersion(v)
 		if err != nil {
 			// If this test is failing, you need to add a case for the version in slashingParamsPerVersion.

beacon-chain/db/kv/lightclient_test.go

@@ -215,7 +215,7 @@ func TestStore_LightClientUpdate_CanSaveRetrieve(t *testing.T) {
 
 	db := setupDB(t)
 	ctx := t.Context()
-	for _, testVersion := range version.All()[1:] {
+	for _, testVersion := range version.Released()[1:] {
 		t.Run(version.String(testVersion), func(t *testing.T) {
 			update, err := createUpdate(t, testVersion)
 			require.NoError(t, err)
@@ -571,7 +571,7 @@ func TestStore_LightClientBootstrap_CanSaveRetrieve(t *testing.T) {
 		require.NoError(t, err)
 		require.IsNil(t, retrievedBootstrap)
 	})
-	for _, testVersion := range version.All()[1:] {
+	for _, testVersion := range version.Released()[1:] {
 		t.Run(version.String(testVersion), func(t *testing.T) {
 			bootstrap, err := createDefaultLightClientBootstrap(primitives.Slot(uint64(params.BeaconConfig().VersionToForkEpochMap()[testVersion]) * uint64(params.BeaconConfig().SlotsPerEpoch)))
 			require.NoError(t, err)

beacon-chain/light-client/lightclient_test.go

@@ -32,7 +32,7 @@ func TestLightClient_NewLightClientOptimisticUpdateFromBeaconState(t *testing.T)
 	cfg.FuluForkEpoch = 6
 	params.OverrideBeaconConfig(cfg)
 
-	for _, testVersion := range version.All()[1:] {
+	for _, testVersion := range version.Released()[1:] {
 		t.Run(version.String(testVersion), func(t *testing.T) {
 			l := util.NewTestLightClient(t, testVersion)
 

beacon-chain/rpc/eth/light-client/handlers_test.go

@@ -46,7 +46,7 @@ func TestLightClientHandler_GetLightClientBootstrap(t *testing.T) {
 	cfg.FuluForkEpoch = 5
 	params.OverrideBeaconConfig(cfg)
 
-	for _, testVersion := range version.All()[1:] {
+	for _, testVersion := range version.Released()[1:] {
 		t.Run(version.String(testVersion), func(t *testing.T) {
 			l := util.NewTestLightClient(t, testVersion)
 
@@ -177,7 +177,7 @@ func TestLightClientHandler_GetLightClientByRange(t *testing.T) {
 	params.OverrideBeaconConfig(config)
 
 	t.Run("can save retrieve", func(t *testing.T) {
-		for _, testVersion := range version.All()[1:] {
+		for _, testVersion := range version.Released()[1:] {
 			t.Run(version.String(testVersion), func(t *testing.T) {
 
 				slot := primitives.Slot(params.BeaconConfig().VersionToForkEpochMap()[testVersion] * primitives.Epoch(config.SlotsPerEpoch)).Add(1)
@@ -731,7 +731,7 @@ func TestLightClientHandler_GetLightClientFinalityUpdate(t *testing.T) {
 		require.Equal(t, http.StatusNotFound, writer.Code)
 	})
 
-	for _, testVersion := range version.All()[1:] {
+	for _, testVersion := range version.Released()[1:] {
 		t.Run(version.String(testVersion), func(t *testing.T) {
 			ctx := t.Context()
 
@@ -826,7 +826,7 @@ func TestLightClientHandler_GetLightClientOptimisticUpdate(t *testing.T) {
 		require.Equal(t, http.StatusNotFound, writer.Code)
 	})
 
-	for _, testVersion := range version.All()[1:] {
+	for _, testVersion := range version.Released()[1:] {
 		t.Run(version.String(testVersion), func(t *testing.T) {
 			ctx := t.Context()
 			l := util.NewTestLightClient(t, testVersion)

runtime/version/fork.go

@@ -25,11 +25,19 @@ var versionToString = map[int]string{
 	Deneb:     "deneb",
 	Electra:   "electra",
 	Fulu:      "fulu",
+	Gloas:     "gloas",
 }
 
 // stringToVersion and allVersions are populated in init()
 var stringToVersion = map[string]int{}
 var allVersions []int
+var releasedVersions []int
+
+// featureGatedVersions contains fork versions that exist in the enums but are not yet
+// enabled on any supported network. These versions are removed from Released().
+var featureGatedVersions = []int{Gloas}
+
+var featureGatedVersionSet = map[int]struct{}{}
 
 // ErrUnrecognizedVersionName means a string does not match the list of canonical version names.
 var ErrUnrecognizedVersionName = errors.New("version name doesn't map to a known value in the enum")
@@ -58,6 +66,22 @@ func All() []int {
 	return allVersions
 }
 
+// Released returns the list of fork versions that are not feature gated.
+func Released() []int {
+	return releasedVersions
+}
+
+// FeatureGated returns fork versions that exist in the enum but are not yet enabled.
+func FeatureGated() []int {
+	return featureGatedVersions
+}
+
+// IsFeatureGated reports whether the provided version is currently gate-kept.
+func IsFeatureGated(version int) bool {
+	_, ok := featureGatedVersionSet[version]
+	return ok
+}
+
 func init() {
 	allVersions = make([]int, len(versionToString))
 	i := 0
@@ -67,4 +91,18 @@ func init() {
 		i++
 	}
 	sort.Ints(allVersions)
+
+	featureGatedVersionSet = make(map[int]struct{}, len(featureGatedVersions))
+	for _, v := range featureGatedVersions {
+		featureGatedVersionSet[v] = struct{}{}
+	}
+	sort.Ints(featureGatedVersions)
+
+	releasedVersions = make([]int, 0, len(allVersions))
+	for _, v := range allVersions {
+		if _, skip := featureGatedVersionSet[v]; skip {
+			continue
+		}
+		releasedVersions = append(releasedVersions, v)
+	}
 }

runtime/version/fork_test.go

@@ -1,11 +1,15 @@
-package version
+package version_test
 
 import (
 	"slices"
 	"sort"
 	"testing"
 
+	"github.com/OffchainLabs/prysm/v7/config/params"
+	"github.com/OffchainLabs/prysm/v7/consensus-types/primitives"
+	"github.com/OffchainLabs/prysm/v7/runtime/version"
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 func TestVersionString(t *testing.T) {
@@ -16,26 +20,26 @@ func TestVersionString(t *testing.T) {
 	}{
 		{
 			name:    "phase0",
-			version: Phase0,
+			version: version.Phase0,
 			want:    "phase0",
 		},
 		{
 			name:    "altair",
-			version: Altair,
+			version: version.Altair,
 			want:    "altair",
 		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			if got := String(tt.version); got != tt.want {
+			if got := version.String(tt.version); got != tt.want {
 				t.Errorf("String() = %v, want %v", got, tt.want)
 			}
 		})
 	}
 }
 
 func TestVersionSorting(t *testing.T) {
-	versions := All()
+	versions := version.All()
 	expected := slices.Clone(versions)
 	sort.Ints(expected)
 	tests := []struct {
@@ -54,3 +58,82 @@ func TestVersionSorting(t *testing.T) {
 		})
 	}
 }
+
+func TestReleasedExcludesFeatureGated(t *testing.T) {
+	released := version.Released()
+	gated := version.FeatureGated()
+
+	for _, v := range gated {
+		assert.NotContains(t, released, v, "released versions should exclude feature gated fork %s", version.String(v))
+	}
+
+	releasedSet := make(map[int]struct{}, len(released))
+	for _, v := range released {
+		releasedSet[v] = struct{}{}
+	}
+
+	gatedSet := make(map[int]struct{}, len(gated))
+	for _, v := range gated {
+		gatedSet[v] = struct{}{}
+	}
+
+	for _, v := range version.All() {
+		if _, skip := gatedSet[v]; skip {
+			continue
+		}
+		if _, ok := releasedSet[v]; !ok {
+			t.Fatalf("version %s missing from released versions", version.String(v))
+		}
+	}
+}
+
+func TestFeatureGatedVersionsAreNotScheduledOnTestnets(t *testing.T) {
+	if len(version.FeatureGated()) == 0 {
+		t.Skip("no feature gated versions defined")
+	}
+
+	testnetConfigs := []*params.BeaconChainConfig{
+		params.HoleskyConfig(),
+		params.SepoliaConfig(),
+		params.HoodiConfig(),
+	}
+
+	for _, v := range version.FeatureGated() {
+		for _, cfg := range testnetConfigs {
+			epoch := forkEpochForVersion(cfg, v)
+			require.Equalf(
+				t,
+				cfg.FarFutureEpoch,
+				epoch,
+				"feature gated version %s should not be scheduled on %s (epoch=%d)",
+				version.String(v),
+				cfg.ConfigName,
+				epoch,
+			)
+		}
+	}
+}
+
+func forkEpochForVersion(cfg *params.BeaconChainConfig, v int) primitives.Epoch {
+	switch v {
+	case version.Phase0:
+		return cfg.GenesisEpoch
+	case version.Altair:
+		return cfg.AltairForkEpoch
+	case version.Bellatrix:
+		return cfg.BellatrixForkEpoch
+	case version.Capella:
+		return cfg.CapellaForkEpoch
+	case version.Deneb:
+		return cfg.DenebForkEpoch
+	case version.Electra:
+		return cfg.ElectraForkEpoch
+	case version.Fulu:
+		return cfg.FuluForkEpoch
+	default:
+		if version.IsFeatureGated(v) {
+			return cfg.FarFutureEpoch
+		}
+		panic("forkEpochForVersion missing version " + version.String(v))
+	}
+}