From 4a1b369c9213b97c7475798ef1cb3d3262d4b394 Mon Sep 17 00:00:00 2001 From: iamsofonias Date: Fri, 14 Jul 2023 14:48:03 -0400 Subject: [PATCH 1/2] Easy - Rename StakingRewardsMaxNumStakes global param --- lib/block_view.go | 6 +++--- lib/block_view_types.go | 14 +++++++------- lib/constants.go | 14 +++++++------- lib/pos_epoch_complete_hook.go | 2 +- lib/pos_snapshot_entries.go | 4 ++-- 5 files changed, 20 insertions(+), 20 deletions(-) diff --git a/lib/block_view.go b/lib/block_view.go index 363c52c91..33857c167 100644 --- a/lib/block_view.go +++ b/lib/block_view.go @@ -3043,10 +3043,10 @@ func (bav *UtxoView) _connectUpdateGlobalParams( return 0, 0, nil, fmt.Errorf("_connectUpdateGlobalParams: unable to decode ValidatorSetMaxNumValidators as uint64") } } - if len(extraData[StakingRewardDistributionMaxNumStakersKey]) > 0 { - newGlobalParamsEntry.StakingRewardDistributionMaxNumStakers, bytesRead = Uvarint(extraData[StakingRewardDistributionMaxNumStakersKey]) + if len(extraData[StakingRewardsMaxNumStakesKey]) > 0 { + newGlobalParamsEntry.StakingRewardsMaxNumStakes, bytesRead = Uvarint(extraData[StakingRewardsMaxNumStakesKey]) if bytesRead <= 0 { - return 0, 0, nil, fmt.Errorf("_connectUpdateGlobalParams: unable to decode StakingRewardDistributionMaxNumStakers as uint64") + return 0, 0, nil, fmt.Errorf("_connectUpdateGlobalParams: unable to decode StakingRewardsMaxNumStakes as uint64") } } if len(extraData[EpochDurationNumBlocksKey]) > 0 { diff --git a/lib/block_view_types.go b/lib/block_view_types.go index 8c75f6738..b3e45339e 100644 --- a/lib/block_view_types.go +++ b/lib/block_view_types.go @@ -3777,10 +3777,10 @@ type GlobalParamsEntry struct { // consensus. ValidatorSetMaxNumValidators uint64 - // StakingRewardDistributionMaxNumStakers is the maximum number of stake entries - // that are eligible to receive block rewards every epoch in the Proof-of-Stake + // StakingRewardsMaxNumStakes is the maximum number of stake entries that are + // eligible to receive block rewards every epoch in the Proof-of-Stake // consensus. - StakingRewardDistributionMaxNumStakers uint64 + StakingRewardsMaxNumStakes uint64 // EpochDurationNumBlocks is the number of blocks included in one epoch. EpochDurationNumBlocks uint64 @@ -3803,7 +3803,7 @@ func (gp *GlobalParamsEntry) Copy() *GlobalParamsEntry { ValidatorJailEpochDuration: gp.ValidatorJailEpochDuration, LeaderScheduleMaxNumValidators: gp.LeaderScheduleMaxNumValidators, ValidatorSetMaxNumValidators: gp.ValidatorSetMaxNumValidators, - StakingRewardDistributionMaxNumStakers: gp.StakingRewardDistributionMaxNumStakers, + StakingRewardsMaxNumStakes: gp.StakingRewardsMaxNumStakes, EpochDurationNumBlocks: gp.EpochDurationNumBlocks, JailInactiveValidatorGracePeriodEpochs: gp.JailInactiveValidatorGracePeriodEpochs, } @@ -3825,7 +3825,7 @@ func (gp *GlobalParamsEntry) RawEncodeWithoutMetadata(blockHeight uint64, skipMe data = append(data, UintToBuf(gp.ValidatorJailEpochDuration)...) data = append(data, UintToBuf(gp.LeaderScheduleMaxNumValidators)...) data = append(data, UintToBuf(gp.ValidatorSetMaxNumValidators)...) - data = append(data, UintToBuf(gp.StakingRewardDistributionMaxNumStakers)...) + data = append(data, UintToBuf(gp.StakingRewardsMaxNumStakes)...) data = append(data, UintToBuf(gp.EpochDurationNumBlocks)...) data = append(data, UintToBuf(gp.JailInactiveValidatorGracePeriodEpochs)...) } @@ -3878,9 +3878,9 @@ func (gp *GlobalParamsEntry) RawDecodeWithoutMetadata(blockHeight uint64, rr *by if err != nil { return errors.Wrapf(err, "GlobalParamsEntry.Decode: Problem reading ValidatorSetMaxNumValidators: ") } - gp.StakingRewardDistributionMaxNumStakers, err = ReadUvarint(rr) + gp.StakingRewardsMaxNumStakes, err = ReadUvarint(rr) if err != nil { - return errors.Wrapf(err, "GlobalParamsEntry.Decode: Problem reading StakingRewardDistributionMaxNumStakers: ") + return errors.Wrapf(err, "GlobalParamsEntry.Decode: Problem reading StakingRewardsMaxNumStakes: ") } gp.EpochDurationNumBlocks, err = ReadUvarint(rr) if err != nil { diff --git a/lib/constants.go b/lib/constants.go index ac2e97948..971df1b31 100644 --- a/lib/constants.go +++ b/lib/constants.go @@ -670,9 +670,9 @@ type DeSoParams struct { // that are included in the validator set for any given epoch. DefaultValidatorSetMaxNumValidators uint64 - // DefaultStakingRewardDistributionMaxNumStakers is the default number of stake entries + // DefaultStakingRewardsMaxNumStakes is the default number of stake entries // that are included in the staking reward distribution in each epoch. - DefaultStakingRewardDistributionMaxNumStakers uint64 + DefaultStakingRewardsMaxNumStakes uint64 // DefaultEpochDurationNumBlocks is the default number of blocks included in one epoch. DefaultEpochDurationNumBlocks uint64 @@ -1074,8 +1074,8 @@ var DeSoMainnetParams = DeSoParams{ // The max number of validators included in a validator set for any given epoch. DefaultValidatorSetMaxNumValidators: uint64(1000), - // The max number of stakers included in a staking rewards distribution every epoch. - DefaultStakingRewardDistributionMaxNumStakers: uint64(10000), + // The max number of stakes included in a staking rewards distribution every epoch. + DefaultStakingRewardsMaxNumStakes: uint64(10000), // The number of blocks in one epoch DefaultEpochDurationNumBlocks: uint64(3600), @@ -1329,8 +1329,8 @@ var DeSoTestnetParams = DeSoParams{ // The max number of validators included in a validator set for any given epoch. DefaultValidatorSetMaxNumValidators: uint64(1000), - // The max number of stakers included in a staking rewards distribution every epoch. - DefaultStakingRewardDistributionMaxNumStakers: uint64(10000), + // The max number of stakes included in a staking rewards distribution every epoch. + DefaultStakingRewardsMaxNumStakes: uint64(10000), // The number of blocks in one epoch DefaultEpochDurationNumBlocks: uint64(3600), @@ -1386,7 +1386,7 @@ const ( ValidatorJailEpochDurationKey = "ValidatorJailEpochDuration" LeaderScheduleMaxNumValidatorsKey = "LeaderScheduleMaxNumValidators" ValidatorSetMaxNumValidatorsKey = "ValidatorSetMaxNumValidators" - StakingRewardDistributionMaxNumStakersKey = "StakingRewardDistributionMaxNumStakers" + StakingRewardsMaxNumStakesKey = "StakingRewardsMaxNumStakes" EpochDurationNumBlocksKey = "EpochDurationNumBlocks" JailInactiveValidatorGracePeriodEpochsKey = "JailInactiveValidatorGracePeriodEpochs" diff --git a/lib/pos_epoch_complete_hook.go b/lib/pos_epoch_complete_hook.go index 336f0629b..bae8af90d 100644 --- a/lib/pos_epoch_complete_hook.go +++ b/lib/pos_epoch_complete_hook.go @@ -103,7 +103,7 @@ func (bav *UtxoView) RunEpochCompleteHook(blockHeight uint64) error { } // Snapshot the current top n stake entries. - topStakeEntries, err := bav.GetTopStakesByStakeAmount(currentGlobalParamsEntry.StakingRewardDistributionMaxNumStakers) + topStakeEntries, err := bav.GetTopStakesByStakeAmount(currentGlobalParamsEntry.StakingRewardsMaxNumStakes) if err != nil { return errors.Wrapf(err, "RunEpochCompleteHook: error retrieving top StakeEntries: ") } diff --git a/lib/pos_snapshot_entries.go b/lib/pos_snapshot_entries.go index 34d832b54..47d3d6623 100644 --- a/lib/pos_snapshot_entries.go +++ b/lib/pos_snapshot_entries.go @@ -101,8 +101,8 @@ func _mergeGlobalParamEntryDefaults(bav *UtxoView, globalParamsEntry *GlobalPara if globalParamsEntryCopy.ValidatorSetMaxNumValidators == 0 { globalParamsEntryCopy.ValidatorSetMaxNumValidators = bav.Params.DefaultValidatorSetMaxNumValidators } - if globalParamsEntryCopy.StakingRewardDistributionMaxNumStakers == 0 { - globalParamsEntryCopy.StakingRewardDistributionMaxNumStakers = bav.Params.DefaultStakingRewardDistributionMaxNumStakers + if globalParamsEntryCopy.StakingRewardsMaxNumStakes == 0 { + globalParamsEntryCopy.StakingRewardsMaxNumStakes = bav.Params.DefaultStakingRewardsMaxNumStakes } if globalParamsEntryCopy.EpochDurationNumBlocks == 0 { globalParamsEntryCopy.EpochDurationNumBlocks = bav.Params.DefaultEpochDurationNumBlocks From 29b5ff8e0f093ed2aa8bd0f40e390afeb41b1694 Mon Sep 17 00:00:00 2001 From: iamsofonias Date: Mon, 17 Jul 2023 13:34:47 -0400 Subject: [PATCH 2/2] Fix typo --- lib/pos_snapshot_entries.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/pos_snapshot_entries.go b/lib/pos_snapshot_entries.go index 47d3d6623..44d36881a 100644 --- a/lib/pos_snapshot_entries.go +++ b/lib/pos_snapshot_entries.go @@ -686,7 +686,7 @@ type SnapshotStakeMapKey struct { } // This is a bare bones in-memory only construct used to capture the ValidatorPKID, -// StakerPKID, and StakeAmountNanos from a StakeEntry that has been snapshot. We +// StakerPKID, and StakeAmountNanos from a StakeEntry that has been snapshotted. We // define a new type here rather than re-using the StakeEntry type to reduce the risk // of bugs. The StakeEntry type has additional fields (ex: RestakeRewards, ExtraData) // that are not snapshotted.