x/upgrade: protocol version tracking by technicallyty · Pull Request #8897 · cosmos/cosmos-sdk

technicallyty · 2021-03-16T20:20:39Z

Description

Includes app version and protocol version fields to abci.ResponseInfo
x/upgrade module now tracks a protocol version which increments on upgrade in store with new key 0x3
x/upgrade keeper requires new argument which is an interface that implements functionality to set the protocol version on baseapp

closes: #7487

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

…ng consensus version store in x/upgrade -cleaned up x/upgrade Keeper -handler in apply upgrade now handles errors and setting consensus versions -cleaned up migration map keys -removed init chainer method -simapp now implements GetConsensusVersions to assist with testing

codecov · 2021-03-16T20:30:02Z

Codecov Report

Merging #8897 (d86db6f) into master (410d8ed) will increase coverage by 0.00%.
The diff coverage is 83.33%.

@@           Coverage Diff           @@
##           master    #8897   +/-   ##
=======================================
  Coverage   58.94%   58.95%           
=======================================
  Files         575      575           
  Lines       32171    32191   +20     
=======================================
+ Hits        18962    18977   +15     
- Misses      10995    10999    +4     
- Partials     2214     2215    +1

Impacted Files	Coverage Δ
x/upgrade/types/keys.go	`0.00% <ø> (ø)`
x/upgrade/keeper/keeper.go	`76.51% <75.00%> (-0.21%)`	⬇️
baseapp/abci.go	`57.94% <100.00%> (+0.19%)`	⬆️
baseapp/baseapp.go	`77.38% <100.00%> (+0.09%)`	⬆️
baseapp/options.go	`63.01% <100.00%> (-0.88%)`	⬇️
simapp/app.go	`82.84% <100.00%> (ø)`

orijbot · 2021-03-16T20:34:32Z

Benchmark finished. See the result: https://github.orijtech.com/benchmark/result?id=42eae37a2970445893042777552e4b99

blushi

Looks good to me overall, just a small concern regarding naming.

baseapp/abci.go

orijbot · 2021-03-18T11:52:13Z

Benchmark beginning. Status page: https://github.orijtech.com/benchmark/status?commit=d9c29c4d6a6c672c8c9e40833b9b78401483a5e7

aaronc · 2021-03-19T14:30:20Z

x/upgrade/keeper/keeper.go

 	"github.com/tendermint/tendermint/libs/log"
 	tmos "github.com/tendermint/tendermint/libs/os"

+	"github.com/cosmos/cosmos-sdk/baseapp"


Instead of importing baseapp can we duplicate the ProtocolManager interface here following the expected keepers pattern?

x/upgrade/keeper/keeper.go

aaronc · 2021-03-19T14:33:10Z

x/upgrade/keeper/keeper.go

+	protoManager       baseapp.ProtocolManager
 }

 // NewKeeper constructs an upgrade Keeper


Can we document all of the parameters here? I'd also like this to explicitly allow ProtocolManager to be nil.

It doesn't seem like this has been addressed @technicallyty, although I guess documenting vs ProtocolVersionSetter would be sufficient.

Does documentation on just the versionSetter suffice @aaronc? I can add comments to all of them, or maybe can do that in a separate PR?

I would like comments on all of them. It can be a separate PR if you prefer.

added comments for all the fields @aaronc

Awesome that's great. We also do want docs for all arguments to NewKeeper. That is what users of the SDK will see in godocs when they're using NewKeeper.

added doc comments. let me know if the format/content needs to change @aaronc

…cosmos-sdk into ty-7487-protocol_version

orijbot · 2021-03-26T09:22:16Z

Benchmark beginning. Status page: https://github.orijtech.com/benchmark/status?commit=d20bfc10c1bdf4303db0756c886cda45f9665789

orijbot · 2021-03-26T09:42:07Z

Benchmark finished. See the result: https://github.orijtech.com/benchmark/result?id=b5e2e395007f4c96a5e629dc64451af5

orijbot · 2021-03-26T09:49:38Z

Benchmark beginning. Status page: https://github.orijtech.com/benchmark/status?commit=71a4dfafcfae7ca34dc94ce2feed266dbe6da009

orijbot · 2021-03-26T12:14:24Z

Benchmark finished. See the result: https://github.orijtech.com/benchmark/result?id=f5af0bdbc6d34becb35658ad4b4ce5fa

orijbot · 2021-03-29T23:11:28Z

Benchmark finished. See the result: https://github.orijtech.com/benchmark/result?id=de7b1585ec494be0810f8a9aeb448361

orijbot · 2021-03-29T23:11:31Z

Benchmark beginning. Status page: https://github.orijtech.com/benchmark/status?commit=b0f7765e35f1fe0ea2b34ca9506355ca6453f397

orijbot · 2021-03-29T23:11:32Z

Benchmark finished. See the result: https://github.orijtech.com/benchmark/result?id=ed0c0a5a4b544fddb11dc71db8c9e768

orijbot · 2021-03-29T23:11:33Z

Benchmark finished. See the result: https://github.orijtech.com/benchmark/result?id=8b5d442aa4f246999e4480835e0b2f08

orijbot · 2021-03-29T23:11:34Z

Benchmark finished. See the result: https://github.orijtech.com/benchmark/result?id=c546d701c0004306801d65b769613fbb

orijbot · 2021-03-29T23:12:43Z

Benchmark beginning. Status page: https://github.orijtech.com/benchmark/status?commit=4bf3eaaa7b38800c1901a246057bff70aa34b275

* -added consensus version tracking to x/upgrade * -added interface to module manager -added e2e test for migrations using consensus version store in x/upgrade -cleaned up x/upgrade Keeper -handler in apply upgrade now handles errors and setting consensus versions -cleaned up migration map keys -removed init chainer method -simapp now implements GetConsensusVersions to assist with testing * protocol version p1 * add protocol version to baseapp * rebase against master * add test * added test case * cleanup * docs and change to bigendian * changelog * cleanup keeper * swap appVersion and version * cleanup * change interface id * update keeper field name to versionSetter * reorder keys and docs * -move interface into exported folder * typo * typo2 * docs on keeper fields * docs for upgrade NewKeeper * cleanup * NewKeeper docs Co-authored-by: technicallyty <48813565+tytech3@users.noreply.github.com> Co-authored-by: Alessio Treglia <alessio@tendermint.com>

technicallyty added 12 commits March 1, 2021 19:34

-added consensus version tracking to x/upgrade

e900fb1

Merge branch 'master' into ty-8514-module_tracking

8c7b105

protocol version p1

efe2817

add protocol version to baseapp

32316ef

Merge branch 'master' into ty-7487-protocol_version

1a51e9e

rebase against master

0fe4051

add test

a6eae2a

added test case

fb696bc

Merge branch 'master' into ty-7487-protocol_version

dc8e0d0

cleanup

128926d

docs and change to bigendian

35a424e

technicallyty requested review from aaronc, alessio and alexanderbez as code owners March 16, 2021 20:20

technicallyty added the C:x/upgrade label Mar 16, 2021

changelog

16b92fb

clevinson requested review from amaury1093, blushi and robert-zaremba March 16, 2021 21:12

blushi self-assigned this Mar 17, 2021

blushi reviewed Mar 18, 2021

View reviewed changes

baseapp/abci.go Outdated Show resolved Hide resolved

Merge branch 'master' into ty-7487-protocol_version

d9c29c4

Merge branch 'master' into ty-7487-protocol_version

07ab2cc

aaronc reviewed Mar 19, 2021

View reviewed changes

technicallyty added 2 commits March 19, 2021 08:20

cleanup keeper

4039b34

Merge branch 'ty-7487-protocol_version' of https://github.com/cosmos/…

61576a1

…cosmos-sdk into ty-7487-protocol_version

typo2

d20bfc1

cosmos deleted a comment from orijbot Mar 25, 2021

technicallyty added 5 commits March 27, 2021 12:44

Merge branch 'master' into ty-7487-protocol_version

97ab692

Merge branch 'master' into ty-7487-protocol_version

4bf3eaa

docs on keeper fields

1df5a51

Merge branch 'master' into ty-7487-protocol_version

b61ab5a

Merge branch 'master' into ty-7487-protocol_version

b0f7765

technicallyty added 6 commits March 30, 2021 09:10

Merge branch 'master' into ty-7487-protocol_version

31a6a1a

Merge branch 'master' into ty-7487-protocol_version

a43f7e6

docs for upgrade NewKeeper

7760ab1

cleanup

bebb4fe

Merge branch 'master' into ty-7487-protocol_version

b2003dd

NewKeeper docs

d86db6f

aaronc approved these changes Apr 1, 2021

View reviewed changes

clevinson added the automerge label Apr 2, 2021

clevinson merged commit e3a0148 into master Apr 2, 2021

clevinson deleted the ty-7487-protocol_version branch April 2, 2021 14:11

arijitAD mentioned this pull request Aug 2, 2021

Upgrade cosmos sdk to latest release. akash-network/node#1343

Merged

12 tasks

0xHansLee mentioned this pull request Jun 23, 2022

feat: upgrade cosmos-sdk v0.45.4 medibloc/panacea-core#356

Merged

2 tasks

Conversation

technicallyty commented Mar 16, 2021

Description

Uh oh!

codecov bot commented Mar 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

orijbot commented Mar 16, 2021

Uh oh!

blushi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

orijbot commented Mar 18, 2021

Uh oh!

aaronc Mar 19, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

aaronc Mar 19, 2021

Choose a reason for hiding this comment

Uh oh!

blushi Mar 24, 2021

Choose a reason for hiding this comment

Uh oh!

technicallyty Mar 25, 2021

Choose a reason for hiding this comment

Uh oh!

aaronc Mar 29, 2021

Choose a reason for hiding this comment

Uh oh!

technicallyty Mar 29, 2021

Choose a reason for hiding this comment

Uh oh!

aaronc Mar 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

technicallyty Apr 1, 2021

Choose a reason for hiding this comment

Uh oh!

orijbot commented Mar 26, 2021

Uh oh!

orijbot commented Mar 26, 2021

Uh oh!

orijbot commented Mar 26, 2021

Uh oh!

orijbot commented Mar 26, 2021

Uh oh!

orijbot commented Mar 29, 2021

Uh oh!

orijbot commented Mar 29, 2021

Uh oh!

orijbot commented Mar 29, 2021

Uh oh!

orijbot commented Mar 29, 2021

Uh oh!

orijbot commented Mar 29, 2021

Uh oh!

orijbot commented Mar 29, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

codecov bot commented Mar 16, 2021 •

edited

Loading

aaronc Mar 30, 2021 •

edited

Loading