refactor(distribution)!: use collections for ValidatorCurrentRewards #16459
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 6 commits
June 8, 2023 12:42
github-actions
bot
added
C:Simulations
C:x/distribution
testinginprod
commented
Jun 8, 2023
| @@ -179,50 +179,6 @@ func (k Keeper) GetValidatorHistoricalReferenceCount(ctx context.Context) (count | |||
| return | |||
| } | |||
|
|
|||
| // get current rewards for a validator | |||
| func (k Keeper) GetValidatorCurrentRewards(ctx context.Context, val sdk.ValAddress) (rewards types.ValidatorCurrentRewards, err error) { | |||
There was a problem hiding this comment.
There's a small behavioural change for which:
- Before: if reward did not exist, we do not error but return un-initialised types.ValidatorCurrentRewards
- Now: if reward does not exist we error.
testinginprod
commented
Jun 8, 2023
| if err != nil { | ||
| currentRewards, err := k.ValidatorCurrentRewards.Get(ctx, val.GetOperator()) | ||
| // if the rewards do not exist it's fine, we will just add to zero. | ||
| if err != nil && !errors.Is(err, collections.ErrNotFound) { |
There was a problem hiding this comment.
This is where the behavioural change had impact, so we explictly use zero coins in case the current rewards did not exist.
testinginprod
commented
Jun 8, 2023
| @@ -14,7 +14,7 @@ import ( | |||
| // initialize starting info for a new delegation | |||
| func (k Keeper) initializeDelegation(ctx context.Context, val sdk.ValAddress, del sdk.AccAddress) error { | |||
| // period has already been incremented - we want to store the period ended by this delegation action | |||
| valCurrentRewards, err := k.GetValidatorCurrentRewards(ctx, val) | |||
| valCurrentRewards, err := k.ValidatorCurrentRewards.Get(ctx, val) | |||
There was a problem hiding this comment.
returning a zeroed validator current rewards would have yielded to a uint64 underflow.
testinginprod
commented
Jun 8, 2023
| rewards, err := k.GetValidatorCurrentRewards(ctx, val.GetOperator()) | ||
| if err != nil { | ||
| rewards, err := k.ValidatorCurrentRewards.Get(ctx, val.GetOperator()) | ||
| if err != nil && !errors.Is(err, collections.ErrNotFound) { |
There was a problem hiding this comment.
retaining old behaviour
github-prbot
requested review from
a team,
kocubinski and
julienrbrt
and removed request for
a team
tac0turtle
reviewed
Jun 8, 2023
julienrbrt
reviewed
Jun 8, 2023
added 2 commits
June 9, 2023 01:28
12 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Closes: #16460
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!to the type prefix if API or client breaking changeCHANGELOG.mdReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...
!in the type prefix if API or client breaking change