Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use rewards retention period instead of hardcoded 365 days #948

Merged
merged 4 commits into from
Apr 30, 2024
Merged

Use rewards retention period instead of hardcoded 365 days #948

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
be4309a
Use rewards retention period instead of hardcoded 365 days
alexsporn Apr 30, 2024
0452c15
Fixed typo
alexsporn Apr 30, 2024
f10ab33
Avoid possible overflow
alexsporn Apr 30, 2024
a5be224
Fixed rewards roots always being zero
alexsporn Apr 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions pkg/protocol/sybilprotection/sybilprotectionv1/performance/snapshot.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,6 @@ import (
iotago "github.com/iotaledger/iota.go/v4"
)

const (
// TODO: should be addressed in issue #300.
daysInYear = 365
)

func (t *Tracker) Import(reader io.ReadSeeker) error {
t.mutex.Lock()
defer t.mutex.Unlock()
Expand Down Expand Up @@ -279,18 +274,25 @@ func (t *Tracker) exportPoolRewards(writer io.WriteSeeker, targetEpoch iotago.Ep
// export all stored pools
// in theory we could save the epoch count only once, because stats and rewards should be the same length

protocolParams := t.apiProvider.APIForEpoch(targetEpoch).ProtocolParameters()
retentionPeriod := iotago.EpochIndex(protocolParams.RewardsParameters().RetentionPeriod)
earliestRewardEpoch := iotago.EpochIndex(0)
if targetEpoch > retentionPeriod {
earliestRewardEpoch = targetEpoch - retentionPeriod
}

if err := stream.WriteCollection(writer, serializer.SeriLengthPrefixTypeAsUint32, func() (int, error) {
var epochCount int
// Here underflow will not happen because we will stop iterating for epoch 0, because 0 is not greater than zero.
// Use safemath here anyway to avoid hard to trace problems stemming from an accidental underflow.
for epoch := targetEpoch; epoch > iotago.EpochIndex(lo.Max(0, int(targetEpoch)-daysInYear)); epoch = lo.PanicOnErr(safemath.SafeSub(epoch, 1)) {
for epoch := targetEpoch; epoch > earliestRewardEpoch; epoch = lo.PanicOnErr(safemath.SafeSub(epoch, 1)) {
rewardsMap, err := t.rewardsMap(epoch)
if err != nil {
return 0, ierrors.Wrapf(err, "unable to get rewards tree for epoch %d", epoch)
}
// if the map was not present in storage we can skip this epoch and the previous ones, as we never stored any rewards
// if the map was not present in storage we can skip this epoch
if !rewardsMap.WasRestoredFromStorage() {
break
continue
}

if err := stream.Write(writer, epoch); err != nil {
Expand Down
2 changes: 1 addition & 1 deletion pkg/protocol/sybilprotection/sybilprotectionv1/performance/tracker_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ func TestManager_Rewards(t *testing.T) {
}
ts.ApplyEpochActions(epoch, epochActions)
ts.AssertEpochRewards(epoch, epochActions)
// better performin validator should get more rewards
// better performing validator should get more rewards
ts.AssertValidatorRewardGreaterThan("A", "B", epoch, epochActions)

epoch = iotago.EpochIndex(3)
Expand Down
14 changes: 10 additions & 4 deletions pkg/protocol/sybilprotection/sybilprotectionv1/sybilprotection.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@ import (
"sort"

"github.com/iotaledger/hive.go/ads"
"github.com/iotaledger/hive.go/core/safemath"
"github.com/iotaledger/hive.go/ierrors"
"github.com/iotaledger/hive.go/kvstore/mapdb"
"github.com/iotaledger/hive.go/lo"
"github.com/iotaledger/hive.go/runtime/module"
"github.com/iotaledger/hive.go/runtime/options"
"github.com/iotaledger/hive.go/runtime/syncutils"
Expand Down Expand Up @@ -152,7 +154,9 @@ func (o *SybilProtection) CommitSlot(slot iotago.SlotIndex) (committeeRoot iotag
timeProvider := apiForSlot.TimeProvider()
currentEpoch := timeProvider.EpochFromSlot(slot)
nextEpoch := currentEpoch + 1
prevEpoch := lo.Return1(safemath.SafeSub(currentEpoch, 1))
currentEpochEndSlot := timeProvider.EpochEnd(currentEpoch)
isEpochEndSlot := slot == currentEpochEndSlot
maxCommittableAge := apiForSlot.ProtocolParameters().MaxCommittableAge()

// Determine the committee root.
Expand Down Expand Up @@ -188,7 +192,7 @@ func (o *SybilProtection) CommitSlot(slot iotago.SlotIndex) (committeeRoot iotag

// Handle performance tracking for the current epoch.
{
if slot == currentEpochEndSlot {
if isEpochEndSlot {
committee, exists := o.performanceTracker.LoadCommitteeForEpoch(currentEpoch)
if !exists {
return iotago.Identifier{}, iotago.Identifier{}, ierrors.Wrapf(err, "committee for a finished epoch %d not found", currentEpoch)
Expand All @@ -203,9 +207,11 @@ func (o *SybilProtection) CommitSlot(slot iotago.SlotIndex) (committeeRoot iotag

// Determine the rewards root.
{
targetRewardsEpoch := currentEpoch
if slot == currentEpochEndSlot {
targetRewardsEpoch = nextEpoch
// We only update the rewards root if the slot is the last slot of the epoch.
// Otherwise, we reuse the rewards root from the previous epoch.
targetRewardsEpoch := prevEpoch
if isEpochEndSlot {
targetRewardsEpoch = currentEpoch
}

rewardsRoot, err = o.performanceTracker.RewardsRoot(targetRewardsEpoch)
Expand Down
Loading