Drop Pending Stakers 3 - persist stakers' StartTime (#2306)

Co-authored-by: Stephen Buttolph <stephen@avalabs.org>
Co-authored-by: dhrubabasu <7675102+dhrubabasu@users.noreply.github.com>

Author: 3 people

vms/platformvm/block/builder/helpers_test.go

@@ -135,7 +135,7 @@ func newEnvironment(t *testing.T) *environment {
 	res.fx = defaultFx(t, res.clk, res.ctx.Log, res.isBootstrapped.Get())
 
 	rewardsCalc := reward.NewCalculator(res.config.RewardConfig)
-	res.state = defaultState(t, res.config.Validators, res.ctx, res.baseDB, rewardsCalc)
+	res.state = defaultState(t, res.config, res.ctx, res.baseDB, rewardsCalc)
 
 	res.atomicUTXOs = avax.NewAtomicUTXOManager(res.ctx.SharedMemory, txs.Codec)
 	res.uptimes = uptime.NewManager(res.state, res.clk)
@@ -237,7 +237,7 @@ func addSubnet(t *testing.T, env *environment) {
 
 func defaultState(
 	t *testing.T,
-	validators validators.Manager,
+	cfg *config.Config,
 	ctx *snow.Context,
 	db database.Database,
 	rewards reward.Calculator,
@@ -250,7 +250,7 @@ func defaultState(
 		db,
 		genesisBytes,
 		prometheus.NewRegistry(),
-		validators,
+		cfg,
 		execCfg,
 		ctx,
 		metrics.Noop,

vms/platformvm/block/executor/helpers_test.go

@@ -145,7 +145,7 @@ func newEnvironment(t *testing.T, ctrl *gomock.Controller) *environment {
 	res.atomicUTXOs = avax.NewAtomicUTXOManager(res.ctx.SharedMemory, txs.Codec)
 
 	if ctrl == nil {
-		res.state = defaultState(res.config.Validators, res.ctx, res.baseDB, rewardsCalc)
+		res.state = defaultState(res.config, res.ctx, res.baseDB, rewardsCalc)
 		res.uptimes = uptime.NewManager(res.state, res.clk)
 		res.utxosHandler = utxo.NewHandler(res.ctx, res.clk, res.fx)
 		res.txBuilder = p_tx_builder.New(
@@ -263,7 +263,7 @@ func addSubnet(env *environment) {
 }
 
 func defaultState(
-	validators validators.Manager,
+	cfg *config.Config,
 	ctx *snow.Context,
 	db database.Database,
 	rewards reward.Calculator,
@@ -274,7 +274,7 @@ func defaultState(
 		db,
 		genesisBytes,
 		prometheus.NewRegistry(),
-		validators,
+		cfg,
 		execCfg,
 		ctx,
 		metrics.Noop,

vms/platformvm/state/metadata_codec.go

@@ -8,20 +8,28 @@ import (
 
 	"github.com/ava-labs/avalanchego/codec"
 	"github.com/ava-labs/avalanchego/codec/linearcodec"
+	"github.com/ava-labs/avalanchego/utils"
 )
 
 const (
 	v0tag = "v0"
 	v0    = uint16(0)
+
+	v1tag = "v1"
+	v1    = uint16(1)
 )
 
 var metadataCodec codec.Manager
 
 func init() {
-	c := linearcodec.New([]string{v0tag}, math.MaxInt32)
+	c0 := linearcodec.New([]string{v0tag}, math.MaxInt32)
+	c1 := linearcodec.New([]string{v0tag, v1tag}, math.MaxInt32)
 	metadataCodec = codec.NewManager(math.MaxInt32)
 
-	err := metadataCodec.RegisterCodec(v0, c)
+	err := utils.Err(
+		metadataCodec.RegisterCodec(v0, c0),
+		metadataCodec.RegisterCodec(v1, c1),
+	)
 	if err != nil {
 		panic(err)
 	}

vms/platformvm/state/metadata_delegator.go

@@ -9,17 +9,36 @@ import (
 )
 
 type delegatorMetadata struct {
-	PotentialReward uint64
+	PotentialReward uint64 `v1:"true"`
+	StakerStartTime uint64 `v1:"true"`
 
 	txID ids.ID
 }
 
 func parseDelegatorMetadata(bytes []byte, metadata *delegatorMetadata) error {
 	var err error
-	metadata.PotentialReward, err = database.ParseUInt64(bytes)
+	switch len(bytes) {
+	case database.Uint64Size:
+		// only potential reward was stored
+		metadata.PotentialReward, err = database.ParseUInt64(bytes)
+	default:
+		_, err = metadataCodec.Unmarshal(bytes, metadata)
+	}
 	return err
 }
 
-func writeDelegatorMetadata(db database.KeyValueWriter, metadata *delegatorMetadata) error {
-	return database.PutUInt64(db, metadata.txID[:], metadata.PotentialReward)
+func writeDelegatorMetadata(db database.KeyValueWriter, metadata *delegatorMetadata, codecVersion uint16) error {
+	// The "0" codec is skipped for [delegatorMetadata]. This is to ensure the
+	// [validatorMetadata] codec version is the same as the [delegatorMetadata]
+	// codec version.
+	//
+	// TODO: Cleanup post-Durango activation.
+	if codecVersion == 0 {
+		return database.PutUInt64(db, metadata.txID[:], metadata.PotentialReward)
+	}
+	metadataBytes, err := metadataCodec.Marshal(codecVersion, metadata)
+	if err != nil {
+		return err
+	}
+	return db.Put(metadata.txID[:], metadataBytes)
 }

vms/platformvm/state/metadata_delegator_test.go

@@ -0,0 +1,141 @@
+// Copyright (C) 2019-2023, Ava Labs, Inc. All rights reserved.
+// See the file LICENSE for licensing terms.
+
+package state
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/ava-labs/avalanchego/codec"
+	"github.com/ava-labs/avalanchego/database/memdb"
+	"github.com/ava-labs/avalanchego/ids"
+	"github.com/ava-labs/avalanchego/utils/wrappers"
+)
+
+func TestParseDelegatorMetadata(t *testing.T) {
+	type test struct {
+		name        string
+		bytes       []byte
+		expected    *delegatorMetadata
+		expectedErr error
+	}
+	tests := []test{
+		{
+			name: "potential reward only no codec",
+			bytes: []byte{
+				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x7b,
+			},
+			expected: &delegatorMetadata{
+				PotentialReward: 123,
+				StakerStartTime: 0,
+			},
+			expectedErr: nil,
+		},
+		{
+			name: "potential reward + staker start time with codec v1",
+			bytes: []byte{
+				// codec version
+				0x00, 0x01,
+				// potential reward
+				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x7b,
+				// staker start time
+				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0xc8,
+			},
+			expected: &delegatorMetadata{
+				PotentialReward: 123,
+				StakerStartTime: 456,
+			},
+			expectedErr: nil,
+		},
+		{
+			name: "invalid codec version",
+			bytes: []byte{
+				// codec version
+				0x00, 0x02,
+				// potential reward
+				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x7b,
+				// staker start time
+				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0xc8,
+			},
+			expected:    nil,
+			expectedErr: codec.ErrUnknownVersion,
+		},
+		{
+			name: "short byte len",
+			bytes: []byte{
+				// codec version
+				0x00, 0x01,
+				// potential reward
+				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x7b,
+				// staker start time
+				0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+			},
+			expected:    nil,
+			expectedErr: wrappers.ErrInsufficientLength,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			require := require.New(t)
+			var metadata delegatorMetadata
+			err := parseDelegatorMetadata(tt.bytes, &metadata)
+			require.ErrorIs(err, tt.expectedErr)
+			if tt.expectedErr != nil {
+				return
+			}
+			require.Equal(tt.expected, &metadata)
+		})
+	}
+}
+
+func TestWriteDelegatorMetadata(t *testing.T) {
+	type test struct {
+		name     string
+		version  uint16
+		metadata *delegatorMetadata
+		expected []byte
+	}
+	tests := []test{
+		{
+			name:    "v0",
+			version: v0,
+			metadata: &delegatorMetadata{
+				PotentialReward: 123,
+				StakerStartTime: 456,
+			},
+			expected: []byte{
+				// potential reward
+				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x7b,
+			},
+		},
+		{
+			name:    "v1",
+			version: v1,
+			metadata: &delegatorMetadata{
+				PotentialReward: 123,
+				StakerStartTime: 456,
+			},
+			expected: []byte{
+				// codec version
+				0x00, 0x01,
+				// potential reward
+				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x7b,
+				// staker start time
+				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0xc8,
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			require := require.New(t)
+			db := memdb.New()
+			tt.metadata.txID = ids.GenerateTestID()
+			require.NoError(writeDelegatorMetadata(db, tt.metadata, tt.version))
+			bytes, err := db.Get(tt.metadata.txID[:])
+			require.NoError(err)
+			require.Equal(tt.expected, bytes)
+		})
+	}
+}

vms/platformvm/state/metadata_validator.go

@@ -32,6 +32,7 @@ type validatorMetadata struct {
 	LastUpdated              uint64        `v0:"true"` // Unix time in seconds
 	PotentialReward          uint64        `v0:"true"`
 	PotentialDelegateeReward uint64        `v0:"true"`
+	StakerStartTime          uint64        `          v1:"true"`
 
 	txID        ids.ID
 	lastUpdated time.Time
@@ -130,6 +131,7 @@ type validatorState interface {
 	WriteValidatorMetadata(
 		dbPrimary database.KeyValueWriter,
 		dbSubnet database.KeyValueWriter,
+		codecVersion uint16,
 	) error
 }
 
@@ -230,13 +232,14 @@ func (m *metadata) DeleteValidatorMetadata(vdrID ids.NodeID, subnetID ids.ID) {
 func (m *metadata) WriteValidatorMetadata(
 	dbPrimary database.KeyValueWriter,
 	dbSubnet database.KeyValueWriter,
+	codecVersion uint16,
 ) error {
 	for vdrID, updatedSubnets := range m.updatedMetadata {
 		for subnetID := range updatedSubnets {
 			metadata := m.metadata[vdrID][subnetID]
 			metadata.LastUpdated = uint64(metadata.lastUpdated.Unix())
 
-			metadataBytes, err := metadataCodec.Marshal(v0, metadata)
+			metadataBytes, err := metadataCodec.Marshal(codecVersion, metadata)
 			if err != nil {
 				return err
 			}

vms/platformvm/state/metadata_validator_test.go

@@ -81,8 +81,10 @@ func TestWriteValidatorMetadata(t *testing.T) {
 
 	primaryDB := memdb.New()
 	subnetDB := memdb.New()
+
+	codecVersion := v1
 	// write empty uptimes
-	require.NoError(state.WriteValidatorMetadata(primaryDB, subnetDB))
+	require.NoError(state.WriteValidatorMetadata(primaryDB, subnetDB, codecVersion))
 
 	// load uptime
 	nodeID := ids.GenerateTestNodeID()
@@ -96,7 +98,7 @@ func TestWriteValidatorMetadata(t *testing.T) {
 	state.LoadValidatorMetadata(nodeID, subnetID, testUptimeReward)
 
 	// write state, should not reflect to DB yet
-	require.NoError(state.WriteValidatorMetadata(primaryDB, subnetDB))
+	require.NoError(state.WriteValidatorMetadata(primaryDB, subnetDB, codecVersion))
 	require.False(primaryDB.Has(testUptimeReward.txID[:]))
 	require.False(subnetDB.Has(testUptimeReward.txID[:]))
 
@@ -112,7 +114,7 @@ func TestWriteValidatorMetadata(t *testing.T) {
 	require.NoError(state.SetUptime(nodeID, subnetID, newUpDuration, newLastUpdated))
 
 	// write uptimes, should reflect to subnet DB
-	require.NoError(state.WriteValidatorMetadata(primaryDB, subnetDB))
+	require.NoError(state.WriteValidatorMetadata(primaryDB, subnetDB, codecVersion))
 	require.False(primaryDB.Has(testUptimeReward.txID[:]))
 	require.True(subnetDB.Has(testUptimeReward.txID[:]))
 }
@@ -252,7 +254,7 @@ func TestParseValidatorMetadata(t *testing.T) {
 			name: "invalid codec version",
 			bytes: []byte{
 				// codec version
-				0x00, 0x01,
+				0x00, 0x02,
 				// up duration
 				0x00, 0x00, 0x00, 0x00, 0x00, 0x5B, 0x8D, 0x80,
 				// last updated