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

fix(x/staking): Refactor GetLastValidators #19226

Merged
merged 4 commits into from
Jan 25, 2024
Merged

fix(x/staking): Refactor GetLastValidators #19226

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
8cf0de1
init commit
alexanderbez Jan 24, 2024
72bf602
init commit
alexanderbez Jan 24, 2024
fb2c442
cl++
alexanderbez Jan 24, 2024
361c052
cl++
alexanderbez Jan 25, 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
5 changes: 3 additions & 2 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ Every module contains its own CHANGELOG.md. Please refer to the module you are i

### Bug Fixes

* (x/staking) [#19226](https://github.com/cosmos/cosmos-sdk/pull/19226) Ensure `GetLastValidators` in `x/staking` does not return an error when `MaxValidators` exceeds total number of bonded validators.
* (baseapp) [#19198](https://github.com/cosmos/cosmos-sdk/pull/19198) Remove usage of pointers in logs in all OE goroutines.
* (baseapp) [#18727](https://github.com/cosmos/cosmos-sdk/pull/18727) Ensure that `BaseApp.Init` firstly returns any errors from a nil commit multistore instead of panicking on nil dereferencing and before sealing the app.
* (client) [#18622](https://github.com/cosmos/cosmos-sdk/pull/18622) Fixed a potential under/overflow from `uint64->int64` when computing gas fees as a LegacyDec.
Expand Down Expand Up @@ -542,14 +543,14 @@ Every module contains its own CHANGELOG.md. Please refer to the module you are i

### Bug Fixes

* [#19106](https://github.com/cosmos/cosmos-sdk/pull/19106) Allow empty public keys when setting signatures. Public keys aren't needed for every transaction.
* [#19106](https://github.com/cosmos/cosmos-sdk/pull/19106) Allow empty public keys when setting signatures. Public keys aren't needed for every transaction.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The entry for the server module fix mentions a consensus failure but does not specify the nature of the fix. It would be beneficial to include a brief description of how the issue was resolved.

Consider adding a short description of the fix applied to address the consensus failure issue.

* (server) [#18920](https://github.com/cosmos/cosmos-sdk/pull/18920) Fixes consensus failure while restart node with wrong `chainId` in genesis.

## [v0.47.7](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.47.7) - 2023-12-20

### Improvements

* (x/gov) [#18707](https://github.com/cosmos/cosmos-sdk/pull/18707) Improve genesis validation.
* (x/gov) [#18707](https://github.com/cosmos/cosmos-sdk/pull/18707) Improve genesis validation.
* (server) [#18478](https://github.com/cosmos/cosmos-sdk/pull/18478) Add command flag to disable colored logs.

### Bug Fixes
Expand Down
13 changes: 10 additions & 3 deletions x/staking/keeper/validator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,13 +383,19 @@ func (k Keeper) GetLastValidators(ctx context.Context) (validators []types.Valid
if err != nil {
return nil, err
}
validators = make([]types.Validator, maxValidators)

i := 0
validators = make([]types.Validator, maxValidators)

err = k.LastValidatorPower.Walk(ctx, nil, func(key []byte, _ gogotypes.Int64Value) (bool, error) {
// sanity check
// Note, we do NOT error here as the MaxValidators param may change via on-chain
// governance. In cases where the param is increased, this case should never
// be hit. In cases where the param is decreased, we will simply not return
// the remainder of the validator set, as the ApplyAndReturnValidatorSetUpdates
// call should ensure the validators past the cliff will be moved to the
// unbonding set.
if i >= int(maxValidators) {
return true, fmt.Errorf("more validators than maxValidators found")
return true, nil
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i dont think this is correct, we should add a test case to make sure the validators have entered the unbond queue. We could leave the state machine in a weird limbo if they are still in the bonded queue

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yup -- on it

}

validator, err := k.GetValidator(ctx, key)
Comment on lines 383 to 401
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [388-408]

The refactored GetLastValidators function now initializes the validators slice after retrieving the maxValidators value from storage, which is a logical change to handle dynamic validator set sizes. However, the function does not handle the case where maxValidators could be zero, which would lead to an unnecessary allocation of a slice. It would be more efficient to check if maxValidators is zero and return an empty slice immediately.

- validators = make([]types.Validator, maxValidators)
+ if maxValidators == 0 {
+     return []types.Validator{}, nil
+ }
+ validators = make([]types.Validator, maxValidators)

Expand All @@ -399,6 +405,7 @@ func (k Keeper) GetLastValidators(ctx context.Context) (validators []types.Valid

validators[i] = validator
i++

return false, nil
})
if err != nil {
Expand Down
44 changes: 44 additions & 0 deletions x/staking/keeper/validator_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,50 @@ func (s *KeeperTestSuite) TestValidator() {
require.Equal(int64(0), resPower)
}

func (s *KeeperTestSuite) TestGetLastValidators() {
ctx, keeper := s.ctx, s.stakingKeeper
require := s.Require()

params, err := keeper.Params.Get(ctx)
require.NoError(err)

params.MaxValidators = 50
require.NoError(keeper.Params.Set(ctx, params))

// construct 50 validators all with equal power of 100
var validators [50]stakingtypes.Validator
for i := 0; i < 50; i++ {
validators[i] = testutil.NewValidator(s.T(), sdk.ValAddress(PKs[i].Address().Bytes()), PKs[i])
validators[i].Status = stakingtypes.Unbonded
validators[i].Tokens = math.ZeroInt()
tokens := keeper.TokensFromConsensusPower(ctx, 100)

validators[i], _ = validators[i].AddTokensFromDel(tokens)
require.Equal(keeper.TokensFromConsensusPower(ctx, 100), validators[i].Tokens)

s.bankKeeper.EXPECT().SendCoinsFromModuleToModule(gomock.Any(), stakingtypes.NotBondedPoolName, stakingtypes.BondedPoolName, gomock.Any())

validators[i] = stakingkeeper.TestingUpdateValidator(keeper, ctx, validators[i], true)
require.NoError(keeper.SetValidatorByConsAddr(ctx, validators[i]))

resVal, err := keeper.GetValidator(ctx, sdk.ValAddress(PKs[i].Address().Bytes()))
require.NoError(err)
require.True(validators[i].MinEqual(&resVal))
}

res, err := keeper.GetLastValidators(ctx)
require.NoError(err)
require.Len(res, 50)

// reduce max validators to 30 and ensure we only get 30 back
params.MaxValidators = 30
require.NoError(keeper.Params.Set(ctx, params))

res, err = keeper.GetLastValidators(ctx)
require.NoError(err)
require.Len(res, 30)
}

// This function tests UpdateValidator, GetValidator, GetLastValidators, RemoveValidator
func (s *KeeperTestSuite) TestValidatorBasics() {
ctx, keeper := s.ctx, s.stakingKeeper
Expand Down