move interfaces to separate pkgs (#1379)

* add validator state

* add pausable uptime manager

* remove stuttering name

* rename state listener

* Update plugin/evm/validators/state.go

Co-authored-by: Darioush Jalali <[email protected]>
Signed-off-by: Ceyhun Onur <[email protected]>

* use update enum

* Update plugin/evm/validators/state.go

Co-authored-by: Darioush Jalali <[email protected]>
Signed-off-by: Ceyhun Onur <[email protected]>

* Update plugin/evm/validators/state.go

Co-authored-by: Darioush Jalali <[email protected]>
Signed-off-by: Ceyhun Onur <[email protected]>

* respond to comments

* update avalanchego dep branch

* reviews

* reword errs

* fix test changes

* fix upgrades after deactivating latest in context

* use branch commit for ava version

* reviews

* add listener mock

* remove errs from resume and pause

* check after stopping

* use expectedTime in tests

* reviews

* move interfaces to separate pkgs

* regen mock

---------

Signed-off-by: Ceyhun Onur <[email protected]>
Co-authored-by: Darioush Jalali <[email protected]>

Author: ceyonur

plugin/evm/uptime/interfaces/interface.go

@@ -0,0 +1,16 @@
+// Copyright (C) 2019-2024, Ava Labs, Inc. All rights reserved.
+// See the file LICENSE for licensing terms.
+
+package interfaces
+
+import (
+	"github.com/ava-labs/avalanchego/ids"
+	"github.com/ava-labs/avalanchego/snow/uptime"
+	validatorsinterfaces "github.com/ava-labs/subnet-evm/plugin/evm/validators/interfaces"
+)
+
+type PausableManager interface {
+	uptime.Manager
+	validatorsinterfaces.StateCallbackListener
+	IsPaused(nodeID ids.NodeID) bool
+}

plugin/evm/uptime/pausable_manager.go

@@ -6,24 +6,16 @@ package uptime
 import (
 	"errors"
 
-	"github.com/ava-labs/subnet-evm/plugin/evm/validators"
+	"github.com/ava-labs/subnet-evm/plugin/evm/uptime/interfaces"
 	"github.com/ethereum/go-ethereum/log"
 
 	"github.com/ava-labs/avalanchego/ids"
 	"github.com/ava-labs/avalanchego/snow/uptime"
 	"github.com/ava-labs/avalanchego/utils/set"
 )
 
-var _ validators.StateCallbackListener = &pausableManager{}
-
 var errPausedDisconnect = errors.New("paused node cannot be disconnected")
 
-type PausableManager interface {
-	uptime.Manager
-	validators.StateCallbackListener
-	IsPaused(nodeID ids.NodeID) bool
-}
-
 type pausableManager struct {
 	uptime.Manager
 	pausedVdrs set.Set[ids.NodeID]
@@ -33,7 +25,7 @@ type pausableManager struct {
 }
 
 // NewPausableManager takes an uptime.Manager and returns a PausableManager
-func NewPausableManager(manager uptime.Manager) PausableManager {
+func NewPausableManager(manager uptime.Manager) interfaces.PausableManager {
 	return &pausableManager{
 		pausedVdrs:    make(set.Set[ids.NodeID]),
 		connectedVdrs: make(set.Set[ids.NodeID]),

plugin/evm/uptime/pausable_manager_test.go

@@ -10,6 +10,7 @@ import (
 	"github.com/ava-labs/avalanchego/ids"
 	"github.com/ava-labs/avalanchego/snow/uptime"
 	"github.com/ava-labs/avalanchego/utils/timer/mockable"
+	"github.com/ava-labs/subnet-evm/plugin/evm/uptime/interfaces"
 	"github.com/stretchr/testify/require"
 )
 
@@ -20,11 +21,11 @@ func TestPausableManager(t *testing.T) {
 
 	tests := []struct {
 		name     string
-		testFunc func(t *testing.T, up PausableManager, clk *mockable.Clock, s uptime.State)
+		testFunc func(t *testing.T, up interfaces.PausableManager, clk *mockable.Clock, s uptime.State)
 	}{
 		{
 			name: "Case 1: Connect, pause, start tracking",
-			testFunc: func(t *testing.T, up PausableManager, clk *mockable.Clock, s uptime.State) {
+			testFunc: func(t *testing.T, up interfaces.PausableManager, clk *mockable.Clock, s uptime.State) {
 				require := require.New(t)
 
 				// Connect before tracking
@@ -53,7 +54,7 @@ func TestPausableManager(t *testing.T) {
 		},
 		{
 			name: "Case 2: Start tracking, connect, pause, re-connect, resume",
-			testFunc: func(t *testing.T, up PausableManager, clk *mockable.Clock, s uptime.State) {
+			testFunc: func(t *testing.T, up interfaces.PausableManager, clk *mockable.Clock, s uptime.State) {
 				require := require.New(t)
 
 				// Start tracking
@@ -104,7 +105,7 @@ func TestPausableManager(t *testing.T) {
 		},
 		{
 			name: "Case 3: Pause, start tracking, connect, re-connect, resume",
-			testFunc: func(t *testing.T, up PausableManager, clk *mockable.Clock, s uptime.State) {
+			testFunc: func(t *testing.T, up interfaces.PausableManager, clk *mockable.Clock, s uptime.State) {
 				require := require.New(t)
 
 				// Pause before tracking
@@ -146,7 +147,7 @@ func TestPausableManager(t *testing.T) {
 		},
 		{
 			name: "Case 4: Start tracking, connect, pause, stop tracking, resume tracking",
-			testFunc: func(t *testing.T, up PausableManager, clk *mockable.Clock, s uptime.State) {
+			testFunc: func(t *testing.T, up interfaces.PausableManager, clk *mockable.Clock, s uptime.State) {
 				require := require.New(t)
 
 				// Start tracking and connect
@@ -218,7 +219,7 @@ func TestPausableManager(t *testing.T) {
 	}
 }
 
-func setupTestEnv(nodeID ids.NodeID, startTime time.Time) (PausableManager, *mockable.Clock, uptime.State) {
+func setupTestEnv(nodeID ids.NodeID, startTime time.Time) (interfaces.PausableManager, *mockable.Clock, uptime.State) {
 	clk := mockable.Clock{}
 	clk.Set(startTime)
 	s := uptime.NewTestState()
@@ -232,7 +233,7 @@ func addTime(clk *mockable.Clock, duration time.Duration) time.Time {
 	return clk.Time()
 }
 
-func checkUptime(t *testing.T, up PausableManager, nodeID ids.NodeID, expectedUptime time.Duration, expectedLastUpdate time.Time) {
+func checkUptime(t *testing.T, up interfaces.PausableManager, nodeID ids.NodeID, expectedUptime time.Duration, expectedLastUpdate time.Time) {
 	t.Helper()
 	uptime, lastUpdated, err := up.CalculateUptime(nodeID)
 	require.NoError(t, err)

plugin/evm/validators/interfaces/interface.go

@@ -0,0 +1,43 @@
+// Copyright (C) 2019-2024, Ava Labs, Inc. All rights reserved.
+// See the file LICENSE for licensing terms.
+
+package interfaces
+
+import (
+	"github.com/ava-labs/avalanchego/ids"
+	"github.com/ava-labs/avalanchego/snow/uptime"
+	"github.com/ava-labs/avalanchego/utils/set"
+)
+
+type State interface {
+	uptime.State
+	// AddValidator adds a new validator to the state
+	AddValidator(vID ids.ID, nodeID ids.NodeID, startTimestamp uint64, isActive bool) error
+	// DeleteValidator deletes the validator from the state
+	DeleteValidator(vID ids.ID) error
+	// WriteState writes the validator state to the disk
+	WriteState() error
+
+	// SetStatus sets the active status of the validator with the given vID
+	SetStatus(vID ids.ID, isActive bool) error
+	// GetStatus returns the active status of the validator with the given vID
+	GetStatus(vID ids.ID) (bool, error)
+
+	// GetValidationIDs returns the validation IDs in the state
+	GetValidationIDs() set.Set[ids.ID]
+	// GetValidatorIDs returns the validator node IDs in the state
+	GetValidatorIDs() set.Set[ids.NodeID]
+
+	// RegisterListener registers a listener to the state
+	RegisterListener(StateCallbackListener)
+}
+
+// StateCallbackListener is a listener for the validator state
+type StateCallbackListener interface {
+	// OnValidatorAdded is called when a new validator is added
+	OnValidatorAdded(vID ids.ID, nodeID ids.NodeID, startTime uint64, isActive bool)
+	// OnValidatorRemoved is called when a validator is removed
+	OnValidatorRemoved(vID ids.ID, nodeID ids.NodeID)
+	// OnValidatorStatusUpdated is called when a validator status is updated
+	OnValidatorStatusUpdated(vID ids.ID, nodeID ids.NodeID, isActive bool)
+}

plugin/evm/validators/mock_listener.go renamed to plugin/evm/validators/interfaces/mock_listener.go

@@ -11,6 +11,7 @@ import (
 	"github.com/ava-labs/avalanchego/ids"
 	"github.com/ava-labs/avalanchego/snow/uptime"
 	"github.com/ava-labs/avalanchego/utils/set"
+	"github.com/ava-labs/subnet-evm/plugin/evm/validators/interfaces"
 )
 
 var _ uptime.State = &state{}
@@ -24,39 +25,6 @@ const (
 	deleted dbUpdateStatus = false
 )
 
-type State interface {
-	uptime.State
-	// AddValidator adds a new validator to the state
-	AddValidator(vID ids.ID, nodeID ids.NodeID, startTimestamp uint64, isActive bool) error
-	// DeleteValidator deletes the validator from the state
-	DeleteValidator(vID ids.ID) error
-	// WriteState writes the validator state to the disk
-	WriteState() error
-
-	// SetStatus sets the active status of the validator with the given vID
-	SetStatus(vID ids.ID, isActive bool) error
-	// GetStatus returns the active status of the validator with the given vID
-	GetStatus(vID ids.ID) (bool, error)
-
-	// GetValidationIDs returns the validation IDs in the state
-	GetValidationIDs() set.Set[ids.ID]
-	// GetValidatorIDs returns the validator node IDs in the state
-	GetValidatorIDs() set.Set[ids.NodeID]
-
-	// RegisterListener registers a listener to the state
-	RegisterListener(StateCallbackListener)
-}
-
-// StateCallbackListener is a listener for the validator state
-type StateCallbackListener interface {
-	// OnValidatorAdded is called when a new validator is added
-	OnValidatorAdded(vID ids.ID, nodeID ids.NodeID, startTime uint64, isActive bool)
-	// OnValidatorRemoved is called when a validator is removed
-	OnValidatorRemoved(vID ids.ID, nodeID ids.NodeID)
-	// OnValidatorStatusUpdated is called when a validator status is updated
-	OnValidatorStatusUpdated(vID ids.ID, nodeID ids.NodeID, isActive bool)
-}
-
 type validatorData struct {
 	UpDuration  time.Duration `serialize:"true"`
 	LastUpdated uint64        `serialize:"true"`
@@ -74,11 +42,11 @@ type state struct {
 	updatedData map[ids.ID]dbUpdateStatus // vID -> updated status
 	db          database.Database
 
-	listeners []StateCallbackListener
+	listeners []interfaces.StateCallbackListener
 }
 
 // NewState creates a new State, it also loads the data from the disk
-func NewState(db database.Database) (State, error) {
+func NewState(db database.Database) (interfaces.State, error) {
 	s := &state{
 		index:       make(map[ids.NodeID]ids.ID),
 		data:        make(map[ids.ID]*validatorData),
@@ -243,7 +211,7 @@ func (s *state) GetValidatorIDs() set.Set[ids.NodeID] {
 
 // RegisterListener registers a listener to the state
 // OnValidatorAdded is called for all current validators on the provided listener before this function returns
-func (s *state) RegisterListener(listener StateCallbackListener) {
+func (s *state) RegisterListener(listener interfaces.StateCallbackListener) {
 	s.listeners = append(s.listeners, listener)
 
 	// notify the listener of the current state

plugin/evm/validators/state.go

@@ -15,6 +15,7 @@ import (
 	"github.com/ava-labs/avalanchego/database/memdb"
 	"github.com/ava-labs/avalanchego/ids"
 	"github.com/ava-labs/avalanchego/utils/wrappers"
+	"github.com/ava-labs/subnet-evm/plugin/evm/validators/interfaces"
 )
 
 func TestState(t *testing.T) {
@@ -223,7 +224,7 @@ func TestStateListener(t *testing.T) {
 	expectedvID := ids.GenerateTestID()
 	expectedNodeID := ids.GenerateTestNodeID()
 	expectedStartTime := time.Now()
-	mockListener := NewMockStateCallbackListener(ctrl)
+	mockListener := interfaces.NewMockStateCallbackListener(ctrl)
 	// add initial validator to test RegisterListener
 	initialvID := ids.GenerateTestID()
 	initialNodeID := ids.GenerateTestNodeID()

plugin/evm/validators/state_test.go

@@ -1,3 +1,3 @@
 github.com/ava-labs/subnet-evm/precompile/precompileconfig=Predicater,Config,ChainConfig,Accepter=precompile/precompileconfig/mocks.go
 github.com/ava-labs/subnet-evm/precompile/contract=BlockContext,AccessibleState,StateDB=precompile/contract/mocks.go
-github.com/ava-labs/subnet-evm/plugin/evm/validators=StateCallbackListener=plugin/evm/validators/mock_listener.go
+github.com/ava-labs/subnet-evm/plugin/evm/validators/interfaces=StateCallbackListener=plugin/evm/validators/interfaces/mock_listener.go