Remove protocol.Params.ProtocolVersion field

access/api.go

@@ -314,9 +314,10 @@ type CompatibleRange struct {
 
 // NodeVersionInfo contains information about node, such as semver, commit, sporkID, protocolVersion, etc
 type NodeVersionInfo struct {
-	Semver               string
-	Commit               string
-	SporkId              flow.Identifier
+	Semver  string
+	Commit  string
+	SporkId flow.Identifier
+	// TODO: should we replicate protocol state version here, or just remove this field?
 	ProtocolVersion      uint64
 	SporkRootBlockHeight uint64
 	NodeRootBlockHeight  uint64

cmd/bootstrap/cmd/finalize.go

@@ -189,7 +189,6 @@ func finalize(cmd *cobra.Command, args []string) {
 		result,
 		seal,
 		rootQC,
-		intermediaryData.ProtocolVersion,
 		func(epochStateID flow.Identifier) (protocol_state.KVStoreAPI, error) {
 			return kvstore.NewDefaultKVStore(
 				intermediaryData.FinalizationSafetyThreshold,

cmd/bootstrap/cmd/intermediary.go

@@ -18,7 +18,6 @@ type IntermediaryBootstrappingData struct {
 // like the root block).
 // This is used to pass data between the rootblock command and the finalize command.
 type IntermediaryParamsData struct {
-	ProtocolVersion             uint
 	FinalizationSafetyThreshold uint64
 	EpochExtensionViewCount     uint64
 }

cmd/bootstrap/cmd/rootblock.go

@@ -23,11 +23,14 @@ import (
 )
 
 var (
-	flagRootChain                   string
-	flagRootParent                  string
-	flagRootHeight                  uint64
-	flagRootTimestamp               string
-	flagProtocolVersion             uint
+	flagRootChain     string
+	flagRootParent    string
+	flagRootHeight    uint64
+	flagRootTimestamp string
+	// Deprecated: Replaced by ProtocolState KVStore version
+	// Historically, this flag set a spork-scoped version number, by convention equal to the major software version.
+	// Now that we have HCUs which change the major software version mid-spork, this is no longer useful.
+	deprecatedFlagProtocolVersion   uint
 	flagFinalizationSafetyThreshold uint64
 	flagEpochExtensionViewCount     uint64
 	flagCollectionClusters          uint
@@ -92,14 +95,13 @@ func addRootBlockCmdFlags() {
 	rootBlockCmd.Flags().StringVar(&flagRootParent, "root-parent", "0000000000000000000000000000000000000000000000000000000000000000", "ID for the parent of the root block")
 	rootBlockCmd.Flags().Uint64Var(&flagRootHeight, "root-height", 0, "height of the root block")
 	rootBlockCmd.Flags().StringVar(&flagRootTimestamp, "root-timestamp", time.Now().UTC().Format(time.RFC3339), "timestamp of the root block (RFC3339)")
-	rootBlockCmd.Flags().UintVar(&flagProtocolVersion, "protocol-version", flow.DefaultProtocolVersion, "major software version used for the duration of this spork")
+	rootBlockCmd.Flags().UintVar(&deprecatedFlagProtocolVersion, "protocol-version", 0, "deprecated: this flag will be ignored and remove in a future release")
 	rootBlockCmd.Flags().Uint64Var(&flagFinalizationSafetyThreshold, "finalization-safety-threshold", 500, "defines finalization safety threshold")
 	rootBlockCmd.Flags().Uint64Var(&flagEpochExtensionViewCount, "epoch-extension-view-count", 100_000, "length of epoch extension in views, default is 100_000 which is approximately 1 day")
 
 	cmd.MarkFlagRequired(rootBlockCmd, "root-chain")
 	cmd.MarkFlagRequired(rootBlockCmd, "root-parent")
 	cmd.MarkFlagRequired(rootBlockCmd, "root-height")
-	cmd.MarkFlagRequired(rootBlockCmd, "protocol-version")
 	cmd.MarkFlagRequired(rootBlockCmd, "finalization-safety-threshold")
 	cmd.MarkFlagRequired(rootBlockCmd, "epoch-extension-view-count")
 
@@ -134,6 +136,9 @@ func rootBlock(cmd *cobra.Command, args []string) {
 			log.Fatal().Msg("cannot use both --partner-stakes and --partner-weights flags (use only --partner-weights)")
 		}
 	}
+	if deprecatedFlagProtocolVersion != 0 {
+		log.Warn().Msg("using deprecated flag --protocol-version; please remove this flag from your workflow, it is ignored and will be removed in a future release")
+	}
 
 	// validate epoch configs
 	err := validateEpochConfig()
@@ -226,7 +231,6 @@ func rootBlock(cmd *cobra.Command, args []string) {
 	intermediaryParamsData := IntermediaryParamsData{
 		FinalizationSafetyThreshold: flagFinalizationSafetyThreshold,
 		EpochExtensionViewCount:     flagEpochExtensionViewCount,
-		ProtocolVersion:             flagProtocolVersion,
 	}
 	intermediaryData := IntermediaryBootstrappingData{
 		IntermediaryEpochData:  intermediaryEpochData,

cmd/bootstrap/cmd/rootblock_test.go

@@ -24,7 +24,6 @@ const rootBlockHappyPathLogs = "collecting partner network and staking keys" +
 	`remove internal partner nodes` +
 	`removed 0 internal partner nodes` +
 	`checking constraints on consensus nodes` +
-
 	`assembling network and staking keys` +
 	`wrote file \S+/node-infos.pub.json` +
 	`running DKG for consensus nodes` +
@@ -68,7 +67,6 @@ func TestRootBlock_HappyPath(t *testing.T) {
 		flagNumViewsInStakingAuction = 50_000
 		flagNumViewsInDKGPhase = 2_000
 		flagFinalizationSafetyThreshold = 1_000
-		flagProtocolVersion = 42
 		flagUseDefaultEpochTargetEndTime = true
 		flagEpochTimingRefCounter = 0
 		flagEpochTimingRefTimestamp = 0

cmd/scaffold.go

@@ -949,8 +949,7 @@ func (fnb *FlowNodeBuilder) initMetrics() error {
 		// metrics enabled, report node info metrics as post init event
 		fnb.PostInit(func(nodeConfig *NodeConfig) error {
 			nodeInfoMetrics := metrics.NewNodeInfoCollector()
-			protocolVersion := fnb.RootSnapshot.Params().ProtocolVersion()
-			nodeInfoMetrics.NodeInfo(build.Version(), build.Commit(), nodeConfig.SporkID.String(), protocolVersion)
+			nodeInfoMetrics.NodeInfo(build.Version(), build.Commit(), nodeConfig.SporkID.String())
 			return nil
 		})
 	}

engine/access/rpc/backend/backend.go

@@ -311,10 +311,12 @@ func (b *Backend) Ping(ctx context.Context) error {
 // GetNodeVersionInfo returns node version information such as semver, commit, sporkID, protocolVersion, etc
 func (b *Backend) GetNodeVersionInfo(_ context.Context) (*access.NodeVersionInfo, error) {
 	sporkID := b.stateParams.SporkID()
-	protocolVersion := b.stateParams.ProtocolVersion()
 	sporkRootBlockHeight := b.stateParams.SporkRootBlockHeight()
-
 	nodeRootBlockHeader := b.stateParams.SealedRoot()
+	protocolSnapshot, err := b.state.Final().ProtocolState()
+	if err != nil {
+		return nil, fmt.Errorf("could not read finalized protocol kvstore: %w", err)
+	}
 
 	var compatibleRange *access.CompatibleRange
 
@@ -330,7 +332,7 @@ func (b *Backend) GetNodeVersionInfo(_ context.Context) (*access.NodeVersionInfo
 		Semver:               build.Version(),
 		Commit:               build.Commit(),
 		SporkId:              sporkID,
-		ProtocolVersion:      uint64(protocolVersion),
+		ProtocolVersion:      protocolSnapshot.GetProtocolStateVersion(),
 		SporkRootBlockHeight: sporkRootBlockHeight,
 		NodeRootBlockHeight:  nodeRootBlockHeader.Height,
 		CompatibleRange:      compatibleRange,

integration/testnet/network.go

@@ -1275,7 +1275,6 @@ func BootstrapNetwork(networkConf NetworkConfig, bootstrapDir string, chainID fl
 		result,
 		seal,
 		qc,
-		flow.DefaultProtocolVersion,
 		networkConf.KVStoreFactory,
 	)
 	if err != nil {

module/metrics/node_info.go

@@ -1,8 +1,6 @@
 package metrics
 
 import (
-	"strconv"
-
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/promauto"
 )
@@ -14,10 +12,9 @@ type NodeInfoCollector struct {
 }
 
 const (
-	sporkIDLabel         = "spork_id"
-	versionLabel         = "version"
-	commitLabel          = "commit"
-	protocolVersionLabel = "protocol_version"
+	sporkIDLabel = "spork_id"
+	versionLabel = "version"
+	commitLabel  = "commit"
 )
 
 func NewNodeInfoCollector() *NodeInfoCollector {
@@ -32,9 +29,8 @@ func NewNodeInfoCollector() *NodeInfoCollector {
 	return collector
 }
 
-func (sc *NodeInfoCollector) NodeInfo(version, commit, sporkID string, protocolVersion uint) {
+func (sc *NodeInfoCollector) NodeInfo(version, commit, sporkID string) {
 	sc.nodeInfo.WithLabelValues(versionLabel, version)
 	sc.nodeInfo.WithLabelValues(commitLabel, commit)
 	sc.nodeInfo.WithLabelValues(sporkIDLabel, sporkID)
-	sc.nodeInfo.WithLabelValues(protocolVersionLabel, strconv.FormatUint(uint64(protocolVersion), 10))
 }

module/metrics/node_info_test.go

@@ -1,7 +1,6 @@
 package metrics
 
 import (
-	"strconv"
 	"testing"
 
 	"github.com/prometheus/client_golang/prometheus"
@@ -19,8 +18,7 @@ func TestNodeInfoCollector_NodeInfo(t *testing.T) {
 	version := "0.29"
 	commit := "63cec231136914941e2358de2054a6ef71ea3c99"
 	sporkID := unittest.IdentifierFixture().String()
-	protocolVersion := uint(10076)
-	collector.NodeInfo(version, commit, sporkID, protocolVersion)
+	collector.NodeInfo(version, commit, sporkID)
 	metricsFamilies, err := reg.Gather()
 	require.NoError(t, err)
 
@@ -35,8 +33,7 @@ func TestNodeInfoCollector_NodeInfo(t *testing.T) {
 		assert.Failf(t, "metric not found", "except to find value %s", value)
 	}
 
-	protocolVersionAsString := strconv.FormatUint(uint64(protocolVersion), 10)
-	for _, value := range []string{version, commit, sporkID, protocolVersionAsString} {
+	for _, value := range []string{version, commit, sporkID} {
 		assertReported(value)
 	}
 }

state/protocol/badger/params.go

@@ -131,12 +131,6 @@ func ReadGlobalParams(db *badger.DB) (*inmem.Params, error) {
 		return nil, fmt.Errorf("could not get spork root block height: %w", err)
 	}
 
-	var version uint
-	err = db.View(operation.RetrieveProtocolVersion(&version))
-	if err != nil {
-		return nil, fmt.Errorf("could not get protocol version: %w", err)
-	}
-
 	root, err := ReadFinalizedRoot(db) // retrieve root header
 	if err != nil {
 		return nil, fmt.Errorf("could not get root: %w", err)
@@ -147,7 +141,6 @@ func ReadGlobalParams(db *badger.DB) (*inmem.Params, error) {
 			ChainID:              root.ChainID,
 			SporkID:              sporkID,
 			SporkRootBlockHeight: sporkRootBlockHeight,
-			ProtocolVersion:      version,
 		},
 	), nil
 }

state/protocol/badger/snapshot_test.go

@@ -111,7 +111,6 @@ func TestSnapshot_Params(t *testing.T) {
 
 	expectedChainID := rootSnapshot.Params().ChainID()
 	expectedSporkID := rootSnapshot.Params().SporkID()
-	expectedProtocolVersion := rootSnapshot.Params().ProtocolVersion()
 
 	rootHeader, err := rootSnapshot.Head()
 	require.NoError(t, err)
@@ -142,10 +141,6 @@ func TestSnapshot_Params(t *testing.T) {
 				sporkID := snapshot.Params().SporkID()
 				assert.Equal(t, expectedSporkID, sporkID)
 			})
-			t.Run("should be able to get protocol version from snapshot", func(t *testing.T) {
-				protocolVersion := snapshot.Params().ProtocolVersion()
-				assert.Equal(t, expectedProtocolVersion, protocolVersion)
-			})
 		}
 	})
 }

state/protocol/badger/state.go

@@ -586,12 +586,6 @@ func bootstrapSporkInfo(root protocol.Snapshot) func(*transaction.Tx) error {
 			return fmt.Errorf("could not insert spork root block height: %w", err)
 		}
 
-		version := params.ProtocolVersion()
-		err = operation.InsertProtocolVersion(version)(bdtx)
-		if err != nil {
-			return fmt.Errorf("could not insert protocol version: %w", err)
-		}
-
 		return nil
 	}
 }

state/protocol/inmem/convert.go

@@ -55,7 +55,6 @@ func FromParams(from protocol.GlobalParams) (*Params, error) {
 		ChainID:              from.ChainID(),
 		SporkID:              from.SporkID(),
 		SporkRootBlockHeight: from.SporkRootBlockHeight(),
-		ProtocolVersion:      from.ProtocolVersion(),
 	}
 	return &Params{params}, nil
 }
@@ -69,12 +68,11 @@ func ClusterFromEncodable(enc EncodableCluster) (*Cluster, error) {
 // root bootstrap state. This is used to bootstrap the protocol state for
 // genesis or post-spork states.
 func SnapshotFromBootstrapState(root *flow.Block, result *flow.ExecutionResult, seal *flow.Seal, qc *flow.QuorumCertificate) (*Snapshot, error) {
-	version := flow.DefaultProtocolVersion
 	safetyParams, err := protocol.DefaultEpochSafetyParams(root.Header.ChainID)
 	if err != nil {
 		return nil, fmt.Errorf("could not get default epoch commit safety threshold: %w", err)
 	}
-	return SnapshotFromBootstrapStateWithParams(root, result, seal, qc, version, func(epochStateID flow.Identifier) (protocol_state.KVStoreAPI, error) {
+	return SnapshotFromBootstrapStateWithParams(root, result, seal, qc, func(epochStateID flow.Identifier) (protocol_state.KVStoreAPI, error) {
 		return kvstore.NewDefaultKVStore(safetyParams.FinalizationSafetyThreshold, safetyParams.EpochExtensionViewCount, epochStateID)
 	})
 }
@@ -86,7 +84,6 @@ func SnapshotFromBootstrapStateWithParams(
 	result *flow.ExecutionResult,
 	seal *flow.Seal,
 	qc *flow.QuorumCertificate,
-	protocolVersion uint,
 	kvStoreFactory func(epochStateID flow.Identifier) (protocol_state.KVStoreAPI, error),
 ) (*Snapshot, error) {
 	setup, ok := result.ServiceEvents[0].Event.(*flow.EpochSetup)
@@ -123,7 +120,6 @@ func SnapshotFromBootstrapStateWithParams(
 		ChainID:              root.Header.ChainID, // chain ID must match the root block
 		SporkID:              root.ID(),           // use root block ID as the unique spork identifier
 		SporkRootBlockHeight: root.Header.Height,  // use root block height as the spork root block height
-		ProtocolVersion:      protocolVersion,     // major software version for this spork
 	}
 
 	rootMinEpochState := EpochProtocolStateFromServiceEvents(setup, commit)

state/protocol/inmem/encodable.go

@@ -119,5 +119,4 @@ type EncodableParams struct {
 	ChainID              flow.ChainID
 	SporkID              flow.Identifier
 	SporkRootBlockHeight uint64
-	ProtocolVersion      uint
 }

state/protocol/inmem/params.go

@@ -28,7 +28,3 @@ func (p Params) SporkID() flow.Identifier {
 func (p Params) SporkRootBlockHeight() uint64 {
 	return p.enc.SporkRootBlockHeight
 }
-
-func (p Params) ProtocolVersion() uint {
-	return p.enc.ProtocolVersion
-}

state/protocol/invalid/params.go

@@ -20,7 +20,3 @@ func (p Params) SporkID() flow.Identifier {
 func (p Params) SporkRootBlockHeight() uint64 {
 	return 0
 }
-
-func (p Params) ProtocolVersion() uint {
-	return 0
-}

state/protocol/params.go

@@ -50,8 +50,4 @@ type GlobalParams interface {
 	// If node uses a sealing segment for bootstrapping then this value will be carried over
 	// as part of snapshot.
 	SporkRootBlockHeight() uint64
-
-	// ProtocolVersion returns the protocol version, the major software version
-	// of the protocol software.
-	ProtocolVersion() uint
 }

storage/badger/operation/spork.go

@@ -29,16 +29,3 @@ func InsertSporkRootBlockHeight(height uint64) func(*badger.Txn) error {
 func RetrieveSporkRootBlockHeight(height *uint64) func(*badger.Txn) error {
 	return retrieve(makePrefix(codeSporkRootBlockHeight), height)
 }
-
-// InsertProtocolVersion inserts the protocol version for the present spork.
-// A single database and protocol state instance spans at most one spork, and
-// a spork has exactly one protocol version for its duration, so this is
-// inserted exactly once, when bootstrapping the state.
-func InsertProtocolVersion(version uint) func(*badger.Txn) error {
-	return insert(makePrefix(codeProtocolVersion), version)
-}
-
-// RetrieveProtocolVersion retrieves the protocol version for the present spork.
-func RetrieveProtocolVersion(version *uint) func(*badger.Txn) error {
-	return retrieve(makePrefix(codeProtocolVersion), version)
-}