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

Use enum instead of int32 for BondStatus #7499

Merged
merged 34 commits into from
Oct 12, 2020
Merged

Conversation

amaury1093
Copy link
Contributor

@amaury1093 amaury1093 commented Oct 9, 2020

Description

BondStatus can take a small amount of variants, so an enum makes more sense.

Breaking changes:

  • We use protobuf's generated stringer for the enum, so expect name changes BondedBOND_STATUS_BONDED

Depends on:

This PR is not a blocker for RC0, though it's a nice-to-have.

Note: BondStatus was in types/staking before. Now it's proto-generated, so it's in x/staking/types. This creates an import cycle:

  • x/staking/exported needs x/staking/types for BondStatus
  • x/staking/types needs x/staking/exported for interface implementation assertion.

In this PR, I removed x/staking/exported and put the interfaces in x/staking/types. lmk if you can think of other ways to solve the import cycle.


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against correct branch (see CONTRIBUTING.md)
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer
  • Review Codecov Report in the comment section below once CI passes

Base automatically changed from am-migrate-followup to master October 9, 2020 19:09
@codecov
Copy link

codecov bot commented Oct 12, 2020

Codecov Report

Merging #7499 into master will decrease coverage by 0.01%.
The diff coverage is 48.71%.

@@            Coverage Diff             @@
##           master    #7499      +/-   ##
==========================================
- Coverage   56.03%   56.01%   -0.02%     
==========================================
  Files         592      592              
  Lines       37254    37244      -10     
==========================================
- Hits        20874    20864      -10     
  Misses      14262    14262              
  Partials     2118     2118              

@amaury1093 amaury1093 marked this pull request as ready for review October 12, 2020 10:05
Copy link
Collaborator

@robert-zaremba robert-zaremba left a comment

Choose a reason for hiding this comment

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

LGTM

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.

ACK. Great work.

@amaury1093 amaury1093 added the A:automerge Automatically merge PR once all prerequisites pass. label Oct 12, 2020
@mergify mergify bot merged commit 33e7297 into master Oct 12, 2020
@mergify mergify bot deleted the am-migrate-followup-staking branch October 12, 2020 13:56
amaury1093 added a commit that referenced this pull request Oct 12, 2020
* Migrate staking module

* Add gov legacy

* Add comments

* Add x/distrib

* x/crisis

* x/mint

* Fix test

* migrate x/genutil

* Fix lint

* Fix staking constants

* Fix test

* Update x/genutil/legacy/v040/migrate.go

Co-authored-by: Marie Gauthier <[email protected]>

* Add migrate script instead of change BondStatus constants

* Change staking bondStatus to enum

* Fix test

* Fix another test

* Remove staking exported

* fix references

* Better constants

* Fix build

* Fix lint

* Remove buf version

* Fix tests

* Fix test

Co-authored-by: Marie Gauthier <[email protected]>
Co-authored-by: Aleksandr Bezobchuk <[email protected]>
@clevinson clevinson mentioned this pull request Oct 19, 2020
31 tasks
clevinson pushed a commit that referenced this pull request Oct 19, 2020
* Use enum instead of int32 for BondStatus (#7499)

* Migrate staking module

* Add gov legacy

* Add comments

* Add x/distrib

* x/crisis

* x/mint

* Fix test

* migrate x/genutil

* Fix lint

* Fix staking constants

* Fix test

* Update x/genutil/legacy/v040/migrate.go

Co-authored-by: Marie Gauthier <[email protected]>

* Add migrate script instead of change BondStatus constants

* Change staking bondStatus to enum

* Fix test

* Fix another test

* Remove staking exported

* fix references

* Better constants

* Fix build

* Fix lint

* Remove buf version

* Fix tests

* Fix test

Co-authored-by: Marie Gauthier <[email protected]>
Co-authored-by: Aleksandr Bezobchuk <[email protected]>

* Update CHANGELOG

Co-authored-by: Marie Gauthier <[email protected]>
Co-authored-by: Aleksandr Bezobchuk <[email protected]>
larry0x pushed a commit to larry0x/cosmos-sdk that referenced this pull request May 22, 2023
* Migrate staking module

* Add gov legacy

* Add comments

* Add x/distrib

* x/crisis

* x/mint

* Fix test

* migrate x/genutil

* Fix lint

* Fix staking constants

* Fix test

* Update x/genutil/legacy/v040/migrate.go

Co-authored-by: Marie Gauthier <[email protected]>

* Add migrate script instead of change BondStatus constants

* Change staking bondStatus to enum

* Fix test

* Fix another test

* Remove staking exported

* fix references

* Better constants

* Fix build

* Fix lint

* Remove buf version

* Fix tests

* Fix test

Co-authored-by: Marie Gauthier <[email protected]>
Co-authored-by: Aleksandr Bezobchuk <[email protected]>
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants