nit

vms/platformvm/state/models/helpers_test.go → vms/platformvm/state/stakers_helpers_test.go

@@ -1,7 +1,7 @@
 // Copyright (C) 2019-2023, Ava Labs, Inc. All rights reserved.
 // See the file LICENSE for licensing terms.
 
-package models
+package state
 
 import (
 	"errors"
@@ -25,12 +25,11 @@ import (
 	"github.com/ava-labs/avalanchego/vms/platformvm/config"
 	"github.com/ava-labs/avalanchego/vms/platformvm/metrics"
 	"github.com/ava-labs/avalanchego/vms/platformvm/reward"
-	"github.com/ava-labs/avalanchego/vms/platformvm/state"
 	"github.com/prometheus/client_golang/prometheus"
 )
 
 var (
-	_ state.Versions = (*versionsHolder)(nil)
+	_ Versions = (*versionsHolder)(nil)
 
 	testNetworkID = uint32(10) // To be used in tests
 	xChainID      = ids.Empty.Prefix(0)
@@ -48,14 +47,14 @@ var (
 )
 
 type versionsHolder struct {
-	baseState state.State
+	baseState State
 }
 
-func (h *versionsHolder) GetState(blkID ids.ID) (state.Chain, bool) {
+func (h *versionsHolder) GetState(blkID ids.ID) (Chain, bool) {
 	return h.baseState, blkID == h.baseState.GetLastAccepted()
 }
 
-func buildChainState() (state.State, error) {
+func buildChainState() (State, error) {
 	baseDBManager := manager.NewMemDB(version.Semantic1_0_0)
 	baseDB := versiondb.New(baseDBManager.Current().Database)
 
@@ -73,7 +72,7 @@ func buildChainState() (state.State, error) {
 	}
 
 	rewardsCalc := reward.NewCalculator(cfg.RewardConfig)
-	return state.New(
+	return New(
 		baseDB,
 		genesisBytes,
 		prometheus.NewRegistry(),

vms/platformvm/state/models/stakers_generator_test.go → vms/platformvm/state/stakers_model_generator.go

@@ -1,30 +1,36 @@
 // Copyright (C) 2019-2023, Ava Labs, Inc. All rights reserved.
 // See the file LICENSE for licensing terms.
 
-package models
+package state
 
 import (
-	"fmt"
 	"reflect"
-	"testing"
 	"time"
 
 	blst "github.com/supranational/blst/bindings/go"
 
 	"github.com/ava-labs/avalanchego/ids"
 	"github.com/ava-labs/avalanchego/utils/crypto/bls"
-	"github.com/ava-labs/avalanchego/vms/platformvm/state"
 	"github.com/ava-labs/avalanchego/vms/platformvm/txs"
 	"github.com/leanovate/gopter"
 	"github.com/leanovate/gopter/gen"
-	"github.com/leanovate/gopter/prop"
 )
 
-// stakerGenerator helps creating random yet reproducible  state.Staker objects, which
-// can be used in our property tests.
-// stakerGenerator takes care of enforcing some state.Staker invariants on each and every random sample.
+type generatorPriorityType uint8
+
+const (
+	anyPriority generatorPriorityType = iota
+	currentValidator
+	currentDelegator
+	pendingValidator
+	pendingDelegator
+)
+
+// stakerGenerator helps creating random yet reproducible Staker objects,
+// which can be used in our property tests. stakerGenerator takes care of
+// enforcing some Staker invariants on each and every random sample.
 // TestGeneratedStakersValidity documents and verifies the enforced invariants.
-func stakerGenerator(prio priorityType, subnet *ids.ID, nodeID *ids.NodeID) gopter.Gen {
+func stakerGenerator(prio generatorPriorityType, subnet *ids.ID, nodeID *ids.NodeID) gopter.Gen {
 	return genStakerTimeData(prio).FlatMap(
 		func(v interface{}) gopter.Gen {
 			macro := v.(stakerTimeData)
@@ -38,7 +44,7 @@ func stakerGenerator(prio priorityType, subnet *ids.ID, nodeID *ids.NodeID) gopt
 				genStakerNodeID = gen.Const(*nodeID)
 			}
 
-			return gen.Struct(reflect.TypeOf(state.Staker{}), map[string]gopter.Gen{
+			return gen.Struct(reflect.TypeOf(Staker{}), map[string]gopter.Gen{
 				"TxID":            genID,
 				"NodeID":          genStakerNodeID,
 				"PublicKey":       genBlsKey,
@@ -55,73 +61,6 @@ func stakerGenerator(prio priorityType, subnet *ids.ID, nodeID *ids.NodeID) gopt
 	)
 }
 
-func TestGeneratedStakersValidity(t *testing.T) {
-	properties := gopter.NewProperties(nil)
-
-	properties.Property("EndTime never before StartTime", prop.ForAll(
-		func(s state.Staker) string {
-			if s.EndTime.Before(s.StartTime) {
-				return fmt.Sprintf("startTime %v not before endTime %v, staker %v",
-					s.StartTime, s.EndTime, s)
-			}
-			return ""
-		},
-		stakerGenerator(anyPriority, nil, nil),
-	))
-
-	properties.Property("NextTime coherent with priority", prop.ForAll(
-		func(s state.Staker) string {
-			switch p := s.Priority; p {
-			case txs.PrimaryNetworkDelegatorApricotPendingPriority,
-				txs.PrimaryNetworkDelegatorBanffPendingPriority,
-				txs.SubnetPermissionlessDelegatorPendingPriority,
-				txs.PrimaryNetworkValidatorPendingPriority,
-				txs.SubnetPermissionlessValidatorPendingPriority,
-				txs.SubnetPermissionedValidatorPendingPriority:
-				if !s.NextTime.Equal(s.StartTime) {
-					return fmt.Sprintf("pending staker has nextTime %v different from startTime %v, staker %v",
-						s.NextTime, s.StartTime, s)
-				}
-				return ""
-
-			case txs.PrimaryNetworkDelegatorCurrentPriority,
-				txs.SubnetPermissionlessDelegatorCurrentPriority,
-				txs.PrimaryNetworkValidatorCurrentPriority,
-				txs.SubnetPermissionlessValidatorCurrentPriority,
-				txs.SubnetPermissionedValidatorCurrentPriority:
-				if !s.NextTime.Equal(s.EndTime) {
-					return fmt.Sprintf("current staker has nextTime %v different from endTime %v, staker %v",
-						s.NextTime, s.EndTime, s)
-				}
-				return ""
-
-			default:
-				return fmt.Sprintf("priority %v unhandled in test", p)
-			}
-		},
-		stakerGenerator(anyPriority, nil, nil),
-	))
-
-	subnetID := ids.GenerateTestID()
-	nodeID := ids.GenerateTestNodeID()
-	properties.Property("subnetID and nodeID set as specified", prop.ForAll(
-		func(s state.Staker) string {
-			if s.SubnetID != subnetID {
-				return fmt.Sprintf("unexpected subnetID, expected %v, got %v",
-					subnetID, s.SubnetID)
-			}
-			if s.NodeID != nodeID {
-				return fmt.Sprintf("unexpected nodeID, expected %v, got %v",
-					nodeID, s.NodeID)
-			}
-			return ""
-		},
-		stakerGenerator(anyPriority, &subnetID, &nodeID),
-	))
-
-	properties.TestingRun(t)
-}
-
 // stakerTimeData holds Staker's time related data in order to generate them
 // while fullfilling the following constrains:
 // 1. EndTime >= StartTime
@@ -134,7 +73,7 @@ type stakerTimeData struct {
 	NextTime  time.Time
 }
 
-func genStakerTimeData(prio priorityType) gopter.Gen {
+func genStakerTimeData(prio generatorPriorityType) gopter.Gen {
 	return genStakerMicroData(prio).FlatMap(
 		func(v interface{}) gopter.Gen {
 			micro := v.(stakerMicroData)
@@ -178,25 +117,15 @@ type stakerMicroData struct {
 }
 
 // genStakerMicroData is the helper to generate stakerMicroData
-func genStakerMicroData(prio priorityType) gopter.Gen {
+func genStakerMicroData(prio generatorPriorityType) gopter.Gen {
 	return gen.Struct(reflect.TypeOf(&stakerMicroData{}), map[string]gopter.Gen{
 		"StartTime": gen.Time(),
 		"Duration":  gen.Int64Range(1, 365*24),
 		"Priority":  genPriority(prio),
 	})
 }
 
-type priorityType uint8
-
-const (
-	anyPriority priorityType = iota
-	currentValidator
-	currentDelegator
-	pendingValidator
-	pendingDelegator
-)
-
-func genPriority(p priorityType) gopter.Gen {
+func genPriority(p generatorPriorityType) gopter.Gen {
 	switch p {
 	case anyPriority:
 		return gen.OneConstOf(

vms/platformvm/state/stakers_model_generator_test.go

@@ -0,0 +1,83 @@
+// Copyright (C) 2019-2023, Ava Labs, Inc. All rights reserved.
+// See the file LICENSE for licensing terms.
+
+package state
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/ava-labs/avalanchego/ids"
+	"github.com/ava-labs/avalanchego/vms/platformvm/txs"
+	"github.com/leanovate/gopter"
+	"github.com/leanovate/gopter/prop"
+)
+
+// TestGeneratedStakersValidity documents and verifies the
+// invariants enforced by the staker generator
+func TestGeneratedStakersValidity(t *testing.T) {
+	properties := gopter.NewProperties(nil)
+
+	properties.Property("EndTime never before StartTime", prop.ForAll(
+		func(s Staker) string {
+			if s.EndTime.Before(s.StartTime) {
+				return fmt.Sprintf("startTime %v not before endTime %v, staker %v",
+					s.StartTime, s.EndTime, s)
+			}
+			return ""
+		},
+		stakerGenerator(anyPriority, nil, nil),
+	))
+
+	properties.Property("NextTime coherent with priority", prop.ForAll(
+		func(s Staker) string {
+			switch p := s.Priority; p {
+			case txs.PrimaryNetworkDelegatorApricotPendingPriority,
+				txs.PrimaryNetworkDelegatorBanffPendingPriority,
+				txs.SubnetPermissionlessDelegatorPendingPriority,
+				txs.PrimaryNetworkValidatorPendingPriority,
+				txs.SubnetPermissionlessValidatorPendingPriority,
+				txs.SubnetPermissionedValidatorPendingPriority:
+				if !s.NextTime.Equal(s.StartTime) {
+					return fmt.Sprintf("pending staker has nextTime %v different from startTime %v, staker %v",
+						s.NextTime, s.StartTime, s)
+				}
+				return ""
+
+			case txs.PrimaryNetworkDelegatorCurrentPriority,
+				txs.SubnetPermissionlessDelegatorCurrentPriority,
+				txs.PrimaryNetworkValidatorCurrentPriority,
+				txs.SubnetPermissionlessValidatorCurrentPriority,
+				txs.SubnetPermissionedValidatorCurrentPriority:
+				if !s.NextTime.Equal(s.EndTime) {
+					return fmt.Sprintf("current staker has nextTime %v different from endTime %v, staker %v",
+						s.NextTime, s.EndTime, s)
+				}
+				return ""
+
+			default:
+				return fmt.Sprintf("priority %v unhandled in test", p)
+			}
+		},
+		stakerGenerator(anyPriority, nil, nil),
+	))
+
+	subnetID := ids.GenerateTestID()
+	nodeID := ids.GenerateTestNodeID()
+	properties.Property("subnetID and nodeID set as specified", prop.ForAll(
+		func(s Staker) string {
+			if s.SubnetID != subnetID {
+				return fmt.Sprintf("unexpected subnetID, expected %v, got %v",
+					subnetID, s.SubnetID)
+			}
+			if s.NodeID != nodeID {
+				return fmt.Sprintf("unexpected nodeID, expected %v, got %v",
+					nodeID, s.NodeID)
+			}
+			return ""
+		},
+		stakerGenerator(anyPriority, &subnetID, &nodeID),
+	))
+
+	properties.TestingRun(t)
+}