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

Add Block Height to EpochInfo #562

Merged
merged 3 commits into from
Nov 5, 2021

Conversation

jeebster
Copy link
Contributor

@jeebster jeebster commented Oct 29, 2021

Closes: #452

Description

NOTES:

  • start_height and current_epoch_start_height fields have been added following the timing scheme. If some of this information is unnecessary, please advise and I will deprecate accordingly
  • protobuf compilation via make proto-all appears to have bumped the cosmos-sdk version dependency
  • Please review logic refactoring in epoch module abci and genesis implementation and test files; I'm not too familiar with the protocol yet so I made some assumptions relative to the issue description

For contributor use:

  • Targeted PR against correct branch (see CONTRIBUTING.md)
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer

Comment on lines 31 to 32
int64 start_height = 8;
int64 current_epoch_start_height = 9;
Copy link
Member

Choose a reason for hiding this comment

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

Should just be one field correct? (I think just current_epoch_start_height

Copy link
Contributor Author

Choose a reason for hiding this comment

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

addressed in 535e15c

@codecov-commenter
Copy link

codecov-commenter commented Oct 29, 2021

Codecov Report

Merging #562 (a821daa) into main (0a105c9) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #562   +/-   ##
=======================================
  Coverage   20.31%   20.32%           
=======================================
  Files         164      164           
  Lines       23262    23264    +2     
=======================================
+ Hits         4726     4728    +2     
  Misses      17762    17762           
  Partials      774      774           
Impacted Files Coverage Δ
x/gamm/types/balancerPool.pb.go 0.57% <ø> (ø)
x/epochs/abci.go 100.00% <100.00%> (ø)
x/epochs/genesis.go 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0a105c9...a821daa. Read the comment docs.

Copy link
Member

@ValarDragon ValarDragon left a comment

Choose a reason for hiding this comment

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

Perfect, the change LGTM!

It just occurred to me, would it be easy to make a test where you manually protobuf serialized an epoch info prior to this change, and ensured that it can still be decoded in the new logic?

We basically need to double check that in order to not need any state migrations before it gets on mainnet. Sorry for not giving that feedback earlier.

@jeebster
Copy link
Contributor Author

Perfect, the change LGTM!

It just occurred to me, would it be easy to make a test where you manually protobuf serialized an epoch info prior to this change, and ensured that it can still be decoded in the new logic?

We basically need to double check that in order to not need any state migrations before it gets on mainnet. Sorry for not giving that feedback earlier.

@ValarDragon I'll take a look into what this may entail - assuming mocking generated protobuf definitions and running backwards-compatible tests. I don't think this would be ideal but a temporary solution could be to check for the existence of the new proto property definition and removing the check after migration. Also, let me know if the base branch should be changed to a different branch if this shouldn't be targeting main

@jeebster jeebster force-pushed the 452-epochs-start_height branch from 535e15c to a821daa Compare October 31, 2021 09:27
@ValarDragon
Copy link
Member

The test shouldn't be too complex, protobuf should still allow parsing old serialized data with the new proto format, as long as no new required fields were added. (As is the case in this PR)

So it would protobuf serializing in old code, copying those bytes out, and then making a new test in this branch that tried proto deserializing those bytes and got no error

@jeebster
Copy link
Contributor Author

jeebster commented Nov 2, 2021

@ValarDragon fbc9a1d should address legacy EpochInfo message compatibility

@ValarDragon
Copy link
Member

Perfect, thanks!

@ValarDragon ValarDragon merged commit 44460ef into osmosis-labs:main Nov 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

x/epochs: Make the epochs module store the start height
3 participants