Defer delegatee rewards to the end of the validator staking period (a…

…va-labs#1262)

Co-authored-by: Stephen <[email protected]>

node/node.go

@@ -809,6 +809,7 @@ func (n *Node) initVMs() error {
 				ApricotPhase3Time:               version.GetApricotPhase3Time(n.Config.NetworkID),
 				ApricotPhase5Time:               version.GetApricotPhase5Time(n.Config.NetworkID),
 				BanffTime:                       version.GetBanffTime(n.Config.NetworkID),
+				CortinaTime:                     version.GetCortinaTime(n.Config.NetworkID),
 				MinPercentConnectedStakeHealthy: n.Config.MinPercentConnectedStakeHealthy,
 				UseCurrentHeight:                n.Config.UseCurrentHeight,
 			},

vms/platformvm/blocks/builder/helpers_test.go

@@ -231,7 +231,9 @@ func addSubnet(env *environment) {
 	}
 
 	stateDiff.AddTx(testSubnet1, status.Committed)
-	stateDiff.Apply(env.state)
+	if err := stateDiff.Apply(env.state); err != nil {
+		panic(err)
+	}
 }
 
 func defaultState(

vms/platformvm/blocks/executor/acceptor.go

@@ -149,7 +149,9 @@ func (a *acceptor) ApricotAtomicBlock(b *blocks.ApricotAtomicBlock) error {
 	}
 
 	// Update the state to reflect the changes made in [onAcceptState].
-	blkState.onAcceptState.Apply(a.state)
+	if err := blkState.onAcceptState.Apply(a.state); err != nil {
+		return err
+	}
 
 	defer a.state.Abort()
 	batch, err := a.state.CommitBatch()
@@ -233,7 +235,9 @@ func (a *acceptor) optionBlock(b, parent blocks.Block) error {
 	if !ok {
 		return fmt.Errorf("couldn't find state of block %s", blkID)
 	}
-	blkState.onAcceptState.Apply(a.state)
+	if err := blkState.onAcceptState.Apply(a.state); err != nil {
+		return err
+	}
 	return a.state.Commit()
 }
 
@@ -271,7 +275,9 @@ func (a *acceptor) standardBlock(b blocks.Block) error {
 	}
 
 	// Update the state to reflect the changes made in [onAcceptState].
-	blkState.onAcceptState.Apply(a.state)
+	if err := blkState.onAcceptState.Apply(a.state); err != nil {
+		return err
+	}
 
 	defer a.state.Abort()
 	batch, err := a.state.CommitBatch()

vms/platformvm/blocks/executor/helpers_test.go

@@ -266,7 +266,9 @@ func addSubnet(env *environment) {
 	}
 
 	stateDiff.AddTx(testSubnet1, status.Committed)
-	stateDiff.Apply(env.state)
+	if err := stateDiff.Apply(env.state); err != nil {
+		panic(err)
+	}
 }
 
 func defaultState(

vms/platformvm/blocks/executor/proposal_block_test.go

@@ -110,6 +110,7 @@ func TestApricotProposalBlockTimeVerification(t *testing.T) {
 	}, nil)
 	onParentAccept.EXPECT().GetTx(addValTx.ID()).Return(addValTx, status.Committed, nil)
 	onParentAccept.EXPECT().GetCurrentSupply(constants.PrimaryNetworkID).Return(uint64(1000), nil).AnyTimes()
+	onParentAccept.EXPECT().GetDelegateeReward(constants.PrimaryNetworkID, utx.NodeID()).Return(uint64(0), nil).AnyTimes()
 
 	env.mockedState.EXPECT().GetUptime(gomock.Any(), constants.PrimaryNetworkID).Return(
 		time.Duration(1000), /*upDuration*/
@@ -229,6 +230,8 @@ func TestBanffProposalBlockTimeVerification(t *testing.T) {
 	currentStakersIt.EXPECT().Release().AnyTimes()
 	onParentAccept.EXPECT().GetCurrentStakerIterator().Return(currentStakersIt, nil).AnyTimes()
 
+	onParentAccept.EXPECT().GetDelegateeReward(constants.PrimaryNetworkID, unsignedNextStakerTx.NodeID()).Return(uint64(0), nil).AnyTimes()
+
 	pendingStakersIt := state.NewMockStakerIterator(ctrl)
 	pendingStakersIt.EXPECT().Next().Return(false).AnyTimes() // no pending stakers
 	pendingStakersIt.EXPECT().Release().AnyTimes()

vms/platformvm/config/config.go

@@ -98,6 +98,9 @@ type Config struct {
 	// Time of the Banff network upgrade
 	BanffTime time.Time
 
+	// Time of the Cortina network upgrade
+	CortinaTime time.Time
+
 	// Subnet ID --> Minimum portion of the subnet's stake this node must be
 	// connected to in order to report healthy.
 	// [constants.PrimaryNetworkID] is always a key in this map.

vms/platformvm/state/diff.go

@@ -24,7 +24,7 @@ var (
 type Diff interface {
 	Chain
 
-	Apply(State)
+	Apply(State) error
 }
 
 type diff struct {
@@ -37,7 +37,9 @@ type diff struct {
 	currentSupply map[ids.ID]uint64
 
 	currentStakerDiffs diffStakers
-	pendingStakerDiffs diffStakers
+	// map of subnetID -> nodeID -> total accrued delegatee rewards
+	modifiedDelegateeRewards map[ids.ID]map[ids.NodeID]uint64
+	pendingStakerDiffs       diffStakers
 
 	addedSubnets []*txs.Tx
 	// Subnet ID --> Tx that transforms the subnet
@@ -121,6 +123,31 @@ func (d *diff) GetCurrentValidator(subnetID ids.ID, nodeID ids.NodeID) (*Staker,
 	}
 }
 
+func (d *diff) SetDelegateeReward(subnetID ids.ID, nodeID ids.NodeID, amount uint64) error {
+	if d.modifiedDelegateeRewards == nil {
+		d.modifiedDelegateeRewards = make(map[ids.ID]map[ids.NodeID]uint64)
+	}
+	nodes, ok := d.modifiedDelegateeRewards[subnetID]
+	if !ok {
+		nodes = make(map[ids.NodeID]uint64)
+		d.modifiedDelegateeRewards[subnetID] = nodes
+	}
+	nodes[nodeID] = amount
+	return nil
+}
+
+func (d *diff) GetDelegateeReward(subnetID ids.ID, nodeID ids.NodeID) (uint64, error) {
+	amount, modified := d.modifiedDelegateeRewards[subnetID][nodeID]
+	if modified {
+		return amount, nil
+	}
+	parentState, ok := d.stateVersions.GetState(d.parentID)
+	if !ok {
+		return 0, fmt.Errorf("%w: %s", ErrMissingParentState, d.parentID)
+	}
+	return parentState.GetDelegateeReward(subnetID, nodeID)
+}
+
 func (d *diff) PutCurrentValidator(staker *Staker) {
 	d.currentStakerDiffs.PutValidator(staker)
 }
@@ -430,7 +457,7 @@ func (d *diff) DeleteUTXO(utxoID ids.ID) {
 	}
 }
 
-func (d *diff) Apply(baseState State) {
+func (d *diff) Apply(baseState State) error {
 	baseState.SetTimestamp(d.timestamp)
 	for subnetID, supply := range d.currentSupply {
 		baseState.SetCurrentSupply(subnetID, supply)
@@ -455,6 +482,13 @@ func (d *diff) Apply(baseState State) {
 			}
 		}
 	}
+	for subnetID, nodes := range d.modifiedDelegateeRewards {
+		for nodeID, amount := range nodes {
+			if err := baseState.SetDelegateeReward(subnetID, nodeID, amount); err != nil {
+				return err
+			}
+		}
+	}
 	for _, subnetValidatorDiffs := range d.pendingStakerDiffs.validatorDiffs {
 		for _, validatorDiff := range subnetValidatorDiffs {
 			switch validatorDiff.validatorStatus {
@@ -501,4 +535,5 @@ func (d *diff) Apply(baseState State) {
 			baseState.DeleteUTXO(utxoID)
 		}
 	}
+	return nil
 }

vms/platformvm/state/stakers.go

@@ -33,6 +33,14 @@ type CurrentStakers interface {
 	// Invariant: [staker] is currently a CurrentValidator
 	DeleteCurrentValidator(staker *Staker)
 
+	// SetDelegateeReward sets the accrued delegation rewards for [nodeID] on
+	// [subnetID] to [amount].
+	SetDelegateeReward(subnetID ids.ID, nodeID ids.NodeID, amount uint64) error
+
+	// GetDelegateeReward returns the accrued delegation rewards for [nodeID] on
+	// [subnetID].
+	GetDelegateeReward(subnetID ids.ID, nodeID ids.NodeID) (uint64, error)
+
 	// GetCurrentDelegatorIterator returns the delegators associated with the
 	// validator on [subnetID] with [nodeID]. Delegators are sorted by their
 	// removal from current staker set.

vms/platformvm/state/state.go

@@ -1609,13 +1609,7 @@ func (s *state) writeCurrentStakers(updateValidators bool, height uint64) error
 					PotentialDelegateeReward: 0,
 				}
 
-				// TODO: Remove once we want to write the new disk format
-				prevMetadata := preDelegateeRewardMetadata{
-					UpDuration:      metadata.UpDuration,
-					LastUpdated:     metadata.LastUpdated,
-					PotentialReward: metadata.PotentialReward,
-				}
-				metadataBytes, err := blocks.GenesisCodec.Marshal(blocks.Version, prevMetadata)
+				metadataBytes, err := blocks.GenesisCodec.Marshal(blocks.Version, metadata)
 				if err != nil {
 					return fmt.Errorf("failed to serialize current validator: %w", err)
 				}