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(staking)!: binary format for HistoricalInfoKey #15701

Merged
merged 14 commits into from
Apr 13, 2023

Conversation

babadro
Copy link
Contributor

@babadro babadro commented Apr 5, 2023

Description

Closes: #11463


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
  • 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)

@babadro babadro changed the title refactor: binary format for HistoricalInfoKey !refactor: binary format for HistoricalInfoKey Apr 5, 2023
@babadro babadro changed the title !refactor: binary format for HistoricalInfoKey refactor!: binary format for HistoricalInfoKey Apr 5, 2023
@babadro
Copy link
Contributor Author

babadro commented Apr 5, 2023

Early feedback is appreciated.

@alexanderbez @tac0turtle

Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

migration should be handled in this pr. you can checkout the migation folder to see how it is done

Copy link
Contributor

@alexanderbez alexanderbez left a comment

Choose a reason for hiding this comment

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

Looking good so far! Lets be sure to have exhaustive test coverage

@babadro babadro force-pushed the 11463-binary-historical-info-key branch from df71bc9 to c0e556c Compare April 8, 2023 06:09
@babadro babadro force-pushed the 11463-binary-historical-info-key branch from c0e556c to c313538 Compare April 8, 2023 19:19
@babadro babadro marked this pull request as ready for review April 9, 2023 06:08
@babadro babadro requested a review from a team as a code owner April 9, 2023 06:08
@github-prbot github-prbot requested review from a team, alexanderbez and atheeshp and removed request for a team April 9, 2023 06:08
CHANGELOG.md Outdated
@@ -314,6 +315,7 @@ Ref: https://keepachangelog.com/en/1.0.0/

### State Machine Breaking

* (x/staking) [#15701](https://github.com/cosmos/cosmos-sdk/pull/15701) The `HistoricalInfoKey` has been updated to use a binary format.
Copy link
Contributor

Choose a reason for hiding this comment

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

This is in the wrong section. Move it up to the unreleased section above.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, fixed

x/staking/migrations/v5/store.go Outdated Show resolved Hide resolved
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

utACK.

@julienrbrt julienrbrt added the A:automerge Automatically merge PR once all prerequisites pass. label Apr 12, 2023
@julienrbrt julienrbrt changed the title refactor!: binary format for HistoricalInfoKey refactor(staking)!: binary format for HistoricalInfoKey Apr 12, 2023
@julienrbrt
Copy link
Member

@babadro could you run make lint-fix in your PR?

@mergify mergify bot merged commit 491cf3b into cosmos:main Apr 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass. C:x/staking
Projects
None yet
Development

Successfully merging this pull request may close these issues.

GetAllHistoricalInfo returns wrong order when height goes through 10^n (i.e. number of digits change)
5 participants