Drop Pending Stakers 1 - introduced ScheduledStaker txs (#2323)

abi87 · StephenButtolph · web-flow · commit b36416da40fd · 2023-12-06T19:12:11.000Z
Co-authored-by: Stephen Buttolph &lt;stephen@avalabs.org&gt;
diff --git a/vms/platformvm/state/staker.go b/vms/platformvm/state/staker.go
@@ -83,7 +83,7 @@ func (s *Staker) Less(than *Staker) bool {
 	return bytes.Compare(s.TxID[:], than.TxID[:]) == -1
 }
 
-func NewCurrentStaker(txID ids.ID, staker txs.Staker, potentialReward uint64) (*Staker, error) {
+func NewCurrentStaker(txID ids.ID, staker txs.ScheduledStaker, potentialReward uint64) (*Staker, error) {
 	publicKey, _, err := staker.PublicKey()
 	if err != nil {
 		return nil, err
@@ -103,7 +103,7 @@ func NewCurrentStaker(txID ids.ID, staker txs.Staker, potentialReward uint64) (*
 	}, nil
 }
 
-func NewPendingStaker(txID ids.ID, staker txs.Staker) (*Staker, error) {
+func NewPendingStaker(txID ids.ID, staker txs.ScheduledStaker) (*Staker, error) {
 	publicKey, _, err := staker.PublicKey()
 	if err != nil {
 		return nil, err
diff --git a/vms/platformvm/state/staker_test.go b/vms/platformvm/state/staker_test.go
@@ -148,7 +148,7 @@ func TestNewCurrentStaker(t *testing.T) {
 	potentialReward := uint64(54321)
 	currentPriority := txs.SubnetPermissionedValidatorCurrentPriority
 
-	stakerTx := txs.NewMockStaker(ctrl)
+	stakerTx := txs.NewMockScheduledStaker(ctrl)
 	stakerTx.EXPECT().NodeID().Return(nodeID)
 	stakerTx.EXPECT().PublicKey().Return(publicKey, true, nil)
 	stakerTx.EXPECT().SubnetID().Return(subnetID)
@@ -192,7 +192,7 @@ func TestNewPendingStaker(t *testing.T) {
 	endTime := time.Now()
 	pendingPriority := txs.SubnetPermissionedValidatorPendingPriority
 
-	stakerTx := txs.NewMockStaker(ctrl)
+	stakerTx := txs.NewMockScheduledStaker(ctrl)
 	stakerTx.EXPECT().NodeID().Return(nodeID)
 	stakerTx.EXPECT().PublicKey().Return(publicKey, true, nil)
 	stakerTx.EXPECT().SubnetID().Return(subnetID)
diff --git a/vms/platformvm/state/state.go b/vms/platformvm/state/state.go
@@ -1320,9 +1320,13 @@ func (s *state) syncGenesis(genesisBlk block.Block, genesis *genesis.Genesis) er
 
 	// Persist primary network validator set at genesis
 	for _, vdrTx := range genesis.Validators {
-		validatorTx, ok := vdrTx.Unsigned.(txs.ValidatorTx)
+		// We expect genesis validator txs to be either AddValidatorTx or
+		// AddPermissionlessValidatorTx.
+		//
+		// TODO: Enforce stricter type check
+		validatorTx, ok := vdrTx.Unsigned.(txs.ScheduledStaker)
 		if !ok {
-			return fmt.Errorf("expected tx type txs.ValidatorTx but got %T", vdrTx.Unsigned)
+			return fmt.Errorf("expected a scheduled staker but got %T", vdrTx.Unsigned)
 		}
 
 		stakeAmount := validatorTx.Weight()
@@ -1451,7 +1455,7 @@ func (s *state) loadCurrentValidators() error {
 			return fmt.Errorf("failed loading validator transaction txID %s, %w", txID, err)
 		}
 
-		stakerTx, ok := tx.Unsigned.(txs.Staker)
+		stakerTx, ok := tx.Unsigned.(txs.ScheduledStaker)
 		if !ok {
 			return fmt.Errorf("expected tx type txs.Staker but got %T", tx.Unsigned)
 		}
@@ -1492,7 +1496,7 @@ func (s *state) loadCurrentValidators() error {
 			return err
 		}
 
-		stakerTx, ok := tx.Unsigned.(txs.Staker)
+		stakerTx, ok := tx.Unsigned.(txs.ScheduledStaker)
 		if !ok {
 			return fmt.Errorf("expected tx type txs.Staker but got %T", tx.Unsigned)
 		}
@@ -1539,7 +1543,7 @@ func (s *state) loadCurrentValidators() error {
 				return err
 			}
 
-			stakerTx, ok := tx.Unsigned.(txs.Staker)
+			stakerTx, ok := tx.Unsigned.(txs.ScheduledStaker)
 			if !ok {
 				return fmt.Errorf("expected tx type txs.Staker but got %T", tx.Unsigned)
 			}
@@ -1596,7 +1600,7 @@ func (s *state) loadPendingValidators() error {
 				return err
 			}
 
-			stakerTx, ok := tx.Unsigned.(txs.Staker)
+			stakerTx, ok := tx.Unsigned.(txs.ScheduledStaker)
 			if !ok {
 				return fmt.Errorf("expected tx type txs.Staker but got %T", tx.Unsigned)
 			}
@@ -1631,7 +1635,7 @@ func (s *state) loadPendingValidators() error {
 				return err
 			}
 
-			stakerTx, ok := tx.Unsigned.(txs.Staker)
+			stakerTx, ok := tx.Unsigned.(txs.ScheduledStaker)
 			if !ok {
 				return fmt.Errorf("expected tx type txs.Staker but got %T", tx.Unsigned)
 			}
diff --git a/vms/platformvm/txs/add_delegator_tx.go b/vms/platformvm/txs/add_delegator_tx.go
@@ -19,7 +19,8 @@ import (
 )
 
 var (
-	_ DelegatorTx = (*AddDelegatorTx)(nil)
+	_ DelegatorTx     = (*AddDelegatorTx)(nil)
+	_ ScheduledStaker = (*AddDelegatorTx)(nil)
 
 	errDelegatorWeightMismatch = errors.New("delegator weight is not equal to total stake weight")
 	errStakeMustBeAVAX         = errors.New("stake must be AVAX")
diff --git a/vms/platformvm/txs/add_permissionless_delegator_tx.go b/vms/platformvm/txs/add_permissionless_delegator_tx.go
@@ -17,7 +17,10 @@ import (
 	"github.com/ava-labs/avalanchego/vms/secp256k1fx"
 )
 
-var _ DelegatorTx = (*AddPermissionlessDelegatorTx)(nil)
+var (
+	_ DelegatorTx     = (*AddPermissionlessDelegatorTx)(nil)
+	_ ScheduledStaker = (*AddPermissionlessDelegatorTx)(nil)
+)
 
 // AddPermissionlessDelegatorTx is an unsigned addPermissionlessDelegatorTx
 type AddPermissionlessDelegatorTx struct {
diff --git a/vms/platformvm/txs/add_permissionless_validator_tx.go b/vms/platformvm/txs/add_permissionless_validator_tx.go
@@ -21,7 +21,8 @@ import (
 )
 
 var (
-	_ ValidatorTx = (*AddPermissionlessValidatorTx)(nil)
+	_ ValidatorTx     = (*AddPermissionlessValidatorTx)(nil)
+	_ ScheduledStaker = (*AddPermissionlessDelegatorTx)(nil)
 
 	errEmptyNodeID             = errors.New("validator nodeID cannot be empty")
 	errNoStake                 = errors.New("no stake")
diff --git a/vms/platformvm/txs/add_subnet_validator_tx.go b/vms/platformvm/txs/add_subnet_validator_tx.go
@@ -14,7 +14,8 @@ import (
 )
 
 var (
-	_ StakerTx = (*AddSubnetValidatorTx)(nil)
+	_ StakerTx        = (*AddSubnetValidatorTx)(nil)
+	_ ScheduledStaker = (*AddSubnetValidatorTx)(nil)
 
 	errAddPrimaryNetworkValidator = errors.New("can't add primary network validator with AddSubnetValidatorTx")
 )
diff --git a/vms/platformvm/txs/add_validator_tx.go b/vms/platformvm/txs/add_validator_tx.go
@@ -19,7 +19,8 @@ import (
 )
 
 var (
-	_ ValidatorTx = (*AddValidatorTx)(nil)
+	_ ValidatorTx     = (*AddValidatorTx)(nil)
+	_ ScheduledStaker = (*AddValidatorTx)(nil)
 
 	errTooManyShares = fmt.Errorf("a staker can only require at most %d shares from delegators", reward.PercentDenominator)
 )
diff --git a/vms/platformvm/txs/executor/standard_tx_executor.go b/vms/platformvm/txs/executor/standard_tx_executor.go
@@ -534,7 +534,7 @@ func (e *StandardTxExecutor) BaseTx(tx *txs.BaseTx) error {
 }
 
 // Creates the staker as defined in [stakerTx] and adds it to [e.State].
-func (e *StandardTxExecutor) putStaker(stakerTx txs.Staker) error {
+func (e *StandardTxExecutor) putStaker(stakerTx txs.ScheduledStaker) error {
 	txID := e.Tx.ID()
 	staker, err := state.NewPendingStaker(txID, stakerTx)
 	if err != nil {
diff --git a/vms/platformvm/txs/mempool/mempool.go b/vms/platformvm/txs/mempool/mempool.go
@@ -280,7 +280,7 @@ func (m *mempool) DropExpiredStakerTxs(minStartTime time.Time) []ids.ID {
 	txIter := m.unissuedTxs.NewIterator()
 	for txIter.Next() {
 		tx := txIter.Value()
-		stakerTx, ok := tx.Unsigned.(txs.Staker)
+		stakerTx, ok := tx.Unsigned.(txs.ScheduledStaker)
 		if !ok {
 			continue
 		}
diff --git a/vms/platformvm/txs/mock_scheduled_staker.go b/vms/platformvm/txs/mock_scheduled_staker.go
diff --git a/vms/platformvm/txs/mock_staker.go b/vms/platformvm/txs/mock_staker.go
diff --git a/vms/platformvm/txs/staker_tx.go b/vms/platformvm/txs/staker_tx.go
@@ -48,9 +48,13 @@ type Staker interface {
 	// PublicKey returns the BLS public key registered by this transaction. If
 	// there was no key registered by this transaction, it will return false.
 	PublicKey() (*bls.PublicKey, bool, error)
-	StartTime() time.Time
 	EndTime() time.Time
 	Weight() uint64
-	PendingPriority() Priority
 	CurrentPriority() Priority
 }
+
+type ScheduledStaker interface {
+	Staker
+	StartTime() time.Time
+	PendingPriority() Priority
+}
diff --git a/vms/platformvm/validator_set_property_test.go b/vms/platformvm/validator_set_property_test.go
@@ -373,7 +373,6 @@ func addPrimaryValidatorWithoutBLSKey(vm *VM, data *validatorInputData) (*state.
 }
 
 func internalAddValidator(vm *VM, signedTx *txs.Tx) (*state.Staker, error) {
-	stakerTx := signedTx.Unsigned.(txs.StakerTx)
 	if err := vm.Network.IssueTx(context.Background(), signedTx); err != nil {
 		return nil, fmt.Errorf("could not add tx to mempool: %w", err)
 	}
@@ -393,6 +392,7 @@ func internalAddValidator(vm *VM, signedTx *txs.Tx) (*state.Staker, error) {
 	}
 
 	// move time ahead, promoting the validator to current
+	stakerTx := signedTx.Unsigned.(txs.ScheduledStaker)
 	currentTime := stakerTx.StartTime()
 	vm.clock.Set(currentTime)
 	vm.state.SetTimestamp(currentTime)

Original file line number	Diff line number	Diff line change
`@@ -1320,9 +1320,13 @@ func (s state) syncGenesis(genesisBlk block.Block, genesis genesis.Genesis) er`
`1320`	`1320`
`1321`	`1321`	`// Persist primary network validator set at genesis`
`1322`	`1322`	`for _, vdrTx := range genesis.Validators {`
`1323`		`- validatorTx, ok := vdrTx.Unsigned.(txs.ValidatorTx)`
	`1323`	`+ // We expect genesis validator txs to be either AddValidatorTx or`
	`1324`	`+ // AddPermissionlessValidatorTx.`
	`1325`	`+ //`
	`1326`	`+ // TODO: Enforce stricter type check`
	`1327`	`+ validatorTx, ok := vdrTx.Unsigned.(txs.ScheduledStaker)`
`1324`	`1328`	`if !ok {`
`1325`		`- return fmt.Errorf("expected tx type txs.ValidatorTx but got %T", vdrTx.Unsigned)`
	`1329`	`+ return fmt.Errorf("expected a scheduled staker but got %T", vdrTx.Unsigned)`
`1326`	`1330`	`}`
`1327`	`1331`
`1328`	`1332`	`stakeAmount := validatorTx.Weight()`
`@@ -1451,7 +1455,7 @@ func (s *state) loadCurrentValidators() error {`
`1451`	`1455`	`return fmt.Errorf("failed loading validator transaction txID %s, %w", txID, err)`
`1452`	`1456`	`}`
`1453`	`1457`
`1454`		`- stakerTx, ok := tx.Unsigned.(txs.Staker)`
	`1458`	`+ stakerTx, ok := tx.Unsigned.(txs.ScheduledStaker)`
`1455`	`1459`	`if !ok {`
`1456`	`1460`	`return fmt.Errorf("expected tx type txs.Staker but got %T", tx.Unsigned)`
`1457`	`1461`	`}`
`@@ -1492,7 +1496,7 @@ func (s *state) loadCurrentValidators() error {`
`1492`	`1496`	`return err`
`1493`	`1497`	`}`
`1494`	`1498`
`1495`		`- stakerTx, ok := tx.Unsigned.(txs.Staker)`
	`1499`	`+ stakerTx, ok := tx.Unsigned.(txs.ScheduledStaker)`
`1496`	`1500`	`if !ok {`
`1497`	`1501`	`return fmt.Errorf("expected tx type txs.Staker but got %T", tx.Unsigned)`
`1498`	`1502`	`}`
`@@ -1539,7 +1543,7 @@ func (s *state) loadCurrentValidators() error {`
`1539`	`1543`	`return err`
`1540`	`1544`	`}`
`1541`	`1545`
`1542`		`- stakerTx, ok := tx.Unsigned.(txs.Staker)`
	`1546`	`+ stakerTx, ok := tx.Unsigned.(txs.ScheduledStaker)`
`1543`	`1547`	`if !ok {`
`1544`	`1548`	`return fmt.Errorf("expected tx type txs.Staker but got %T", tx.Unsigned)`
`1545`	`1549`	`}`
`@@ -1596,7 +1600,7 @@ func (s *state) loadPendingValidators() error {`
`1596`	`1600`	`return err`
`1597`	`1601`	`}`
`1598`	`1602`
`1599`		`- stakerTx, ok := tx.Unsigned.(txs.Staker)`
	`1603`	`+ stakerTx, ok := tx.Unsigned.(txs.ScheduledStaker)`
`1600`	`1604`	`if !ok {`
`1601`	`1605`	`return fmt.Errorf("expected tx type txs.Staker but got %T", tx.Unsigned)`
`1602`	`1606`	`}`
`@@ -1631,7 +1635,7 @@ func (s *state) loadPendingValidators() error {`
`1631`	`1635`	`return err`
`1632`	`1636`	`}`
`1633`	`1637`
`1634`		`- stakerTx, ok := tx.Unsigned.(txs.Staker)`
	`1638`	`+ stakerTx, ok := tx.Unsigned.(txs.ScheduledStaker)`
`1635`	`1639`	`if !ok {`
`1636`	`1640`	`return fmt.Errorf("expected tx type txs.Staker but got %T", tx.Unsigned)`
`1637`	`1641`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,8 @@ import (`
`19`	`19`	`)`
`20`	`20`
`21`	`21`	`var (`
`22`		`- _ DelegatorTx = (*AddDelegatorTx)(nil)`
	`22`	`+ _ DelegatorTx = (*AddDelegatorTx)(nil)`
	`23`	`+ _ ScheduledStaker = (*AddDelegatorTx)(nil)`
`23`	`24`
`24`	`25`	`errDelegatorWeightMismatch = errors.New("delegator weight is not equal to total stake weight")`
`25`	`26`	`errStakeMustBeAVAX = errors.New("stake must be AVAX")`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,8 @@ import (`
`21`	`21`	`)`
`22`	`22`
`23`	`23`	`var (`
`24`		`- _ ValidatorTx = (*AddPermissionlessValidatorTx)(nil)`
	`24`	`+ _ ValidatorTx = (*AddPermissionlessValidatorTx)(nil)`
	`25`	`+ _ ScheduledStaker = (*AddPermissionlessDelegatorTx)(nil)`
`25`	`26`
`26`	`27`	`errEmptyNodeID = errors.New("validator nodeID cannot be empty")`
`27`	`28`	`errNoStake = errors.New("no stake")`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,8 @@ import (`
`14`	`14`	`)`
`15`	`15`
`16`	`16`	`var (`
`17`		`- _ StakerTx = (*AddSubnetValidatorTx)(nil)`
	`17`	`+ _ StakerTx = (*AddSubnetValidatorTx)(nil)`
	`18`	`+ _ ScheduledStaker = (*AddSubnetValidatorTx)(nil)`
`18`	`19`
`19`	`20`	`errAddPrimaryNetworkValidator = errors.New("can't add primary network validator with AddSubnetValidatorTx")`
`20`	`21`	`)`
Original file line number	Diff line number	Diff line change
`@@ -534,7 +534,7 @@ func (e StandardTxExecutor) BaseTx(tx txs.BaseTx) error {`
`534`	`534`	`}`
`535`	`535`
`536`	`536`	`// Creates the staker as defined in [stakerTx] and adds it to [e.State].`
`537`		`-func (e *StandardTxExecutor) putStaker(stakerTx txs.Staker) error {`
	`537`	`+func (e *StandardTxExecutor) putStaker(stakerTx txs.ScheduledStaker) error {`
`538`	`538`	`txID := e.Tx.ID()`
`539`	`539`	`staker, err := state.NewPendingStaker(txID, stakerTx)`
`540`	`540`	`if err != nil {`
Original file line number	Diff line number	Diff line change
`@@ -280,7 +280,7 @@ func (m *mempool) DropExpiredStakerTxs(minStartTime time.Time) []ids.ID {`
`280`	`280`	`txIter := m.unissuedTxs.NewIterator()`
`281`	`281`	`for txIter.Next() {`
`282`	`282`	`tx := txIter.Value()`
`283`		`- stakerTx, ok := tx.Unsigned.(txs.Staker)`
	`283`	`+ stakerTx, ok := tx.Unsigned.(txs.ScheduledStaker)`
`284`	`284`	`if !ok {`
`285`	`285`	`continue`
`286`	`286`	`}`