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.

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

refactor(x/staking): Migrate ValidatorQueue to use Collections #17562

Merged
merged 26 commits into from
Sep 8, 2023

Conversation

likhita-809
Copy link
Contributor

Description

Closes: #16391


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...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • run make lint and make test
  • confirmed all CI checks have passed

Reviewers 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...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@likhita-809 likhita-809 marked this pull request as ready for review September 1, 2023 06:04
@likhita-809 likhita-809 requested a review from a team as a code owner September 1, 2023 06:04
Copy link
Contributor

@atheeshp atheeshp left a comment

Choose a reason for hiding this comment

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

lgtm


bz, err := store.Get(types.GetValidatorQueueKey(endTime, endHeight))
timeBz := sdk.FormatTimeBytes(endTime)
timeBzL := len(timeBz)
Copy link
Contributor

Choose a reason for hiding this comment

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

really unfortunate that we prefix time bytes with their length even when the size is constant and well-known. =(

Copy link
Contributor

Choose a reason for hiding this comment

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

you can use here if you want k.ValidatorsQueue.KeyCodec().Size(endTime), instead of using sdk.FormatTimeBytes... At least this way we don't need to rely on format time bytes and we keep it in between collections. I would even comment this in the Keeper why we use three keys instead of using simply two.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think we can use k.ValidatorQueue.KeyCodec().Size(endTime) because key here should be of format collections.Triple[uint64, time.Time, uint64], not just time(endTime). And it gives size of the combined length of fields in key.

Copy link
Member

Choose a reason for hiding this comment

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

I mean, it's a good workaround, unfortunate that we had to do it but it works lol. Once we finish up with all these migrations we'll most definitely do a lot of refactor so we can do proper migrations then

Copy link
Contributor

Choose a reason for hiding this comment

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

I see, then @likhita-809 maybe we can use sdk.TimeKey.Size directly, sorry for being pedantic about this, but I'd rather we remove every form of bytes conversion in state from production code, testing is fine to have it.

Copy link
Contributor

Choose a reason for hiding this comment

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

Although, time key size is constant so in theory we could use the same number everywhere: https://github.com/cosmos/cosmos-sdk/blob/main/types/collections.go#L210

Copy link
Member

@facundomedica facundomedica left a comment

Choose a reason for hiding this comment

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

utACK

@likhita-809
Copy link
Contributor Author

@testinginprod this one also needs a final review

Co-authored-by: unknown unknown <unknown@unknown>
Copy link
Contributor

@testinginprod testinginprod left a comment

Choose a reason for hiding this comment

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

lgtm, minor nits

x/staking/keeper/validator.go Outdated Show resolved Hide resolved
x/staking/keeper/validator.go Outdated Show resolved Hide resolved
x/staking/keeper/validator.go Outdated Show resolved Hide resolved
x/staking/keeper/validator.go Outdated Show resolved Hide resolved
@tac0turtle tac0turtle added this pull request to the merge queue Sep 8, 2023
Merged via the queue into main with commit e53830d Sep 8, 2023
49 checks passed
@tac0turtle tac0turtle deleted the likhita/valQueue branch September 8, 2023 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

refactor(staking): move Validator Queue to use collections
5 participants