feat: Add `MsgSoftwareUpgrade` and `MsgCancelUpgrade` (for new msgs-based gov proposals) #11116

blushi · 2022-02-04T13:20:58Z

Description

Adds MsgSoftwareUpgrade to x/upgrade to be used in v1beta2 msgs-based gov proposals.
TODO:

add MsgCancelUpgrade
spec
CLI and CLI tests

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

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)

codecov · 2022-02-04T13:41:29Z

Codecov Report

Merging #11116 (f13b5b5) into master (918330b) will decrease coverage by 0.02%.
The diff coverage is 66.66%.

❗ Current head f13b5b5 differs from pull request most recent head 0007831. Consider uploading reports for the commit 0007831 to get more accurate results

@@            Coverage Diff             @@
##           master   #11116      +/-   ##
==========================================
- Coverage   65.93%   65.90%   -0.03%     
==========================================
  Files         662      664       +2     
  Lines       68527    68548      +21     
==========================================
- Hits        45180    45174       -6     
- Misses      20702    20731      +29     
+ Partials     2645     2643       -2

Impacted Files	Coverage Δ
x/gov/client/cli/tx.go	`14.76% <0.00%> (+0.48%)`	⬆️
x/upgrade/types/msgs.go	`55.55% <55.55%> (ø)`
x/upgrade/keeper/msg_server.go	`63.63% <63.63%> (ø)`
simapp/app.go	`83.04% <100.00%> (+0.09%)`	⬆️
x/upgrade/keeper/grpc_query.go	`76.74% <100.00%> (+1.13%)`	⬆️
x/upgrade/keeper/keeper.go	`84.67% <100.00%> (+0.06%)`	⬆️
x/upgrade/module.go	`67.44% <100.00%> (+0.77%)`	⬆️
x/upgrade/types/codec.go	`100.00% <100.00%> (ø)`
x/distribution/simulation/operations.go	`80.54% <0.00%> (-9.73%)`	⬇️
x/gov/keeper/keeper.go	`75.64% <0.00%> (-1.47%)`	⬇️
... and 4 more

proto/cosmos/upgrade/v1beta1/tx.proto

amaury1093 · 2022-02-08T14:03:06Z

x/gov/module.go

+	legacyProposalHandlers []govclient.ProposalHandler // legacy proposal handlers which live in governance cli and rest
+	proposalHandlers       []govclient.ProposalHandler // proposal handlers which live in governance cli and rest


Can you explain why we need both?

legacyProposalHandlers CLI handlers will get added as subcommands of NewCmdSubmitLegacyProposal (so we can have simd tx gov submit-legacy-proposal software-upgrade for instance)
same for proposalHandlers and NewCmdSubmitProposal (eg for having simd tx gov submit-proposal software-upgrade)
see NewTxCmd

I think the cli would be better if it were simply simd tx upgrade propose and simd tx upgrade cancel

so you're suggesting to have the new commands available directly from tx upgrade command (instead of tx gov submit-proposal) for the new upgrade proposal msgs
but keep the legacy ones using simd tx gov submit-legacy-proposal software-upgrade / cancel-software-upgrade?
I kind of like this new approach, although I'm a bit concerned it might be confusing for users, any thoughts? @cmwaters @AmauryM

I'm also in favor of the new approach!

that sounds good to me, as long as the docs/changelog are very clear about this

Cool! Although gov is the default module in control of upgrades, I wouldn't want to have them so closely coupled. In the future, one application may want a group in control of proposing upgrades

Hmm on second thought this is a bit more difficult than I thought because the upgrade module doesn't really know who the authority is and whether to submit a proposal or simply execute it

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

amaury1093 · 2022-02-15T14:09:19Z

I pushed a commit for MsgCancelUpgrade msg service implementation and proto files. The last thing needed is CLI for MsgCancelUpgrade and CLI tests.

cmwaters · 2022-02-16T14:44:28Z

We agreed at the call yesterday that I would pick this up

cmwaters · 2022-02-16T15:21:50Z

We shouldn't have it built-in that the governance module account is the authority rather application developers should probably specify an initial address in the constructor as the authority. Some chains may want to create a sub account that is the authority.

amaury1093 · 2022-02-16T16:18:27Z

Yeah, this was a question I asked on Discord, wasn't 100% sure.

I think we can put authority in the keeper config object, which can be overwritten by app developers. It can default to the gov module address.

cmwaters · 2022-02-22T08:35:26Z

So I'm not entirely convinced by the cli commands. My current thinking is that if you want to submit an upgrade msg you just use simd tx gov submit-proposal my-upgrade.json or if the authority is a group then simd tx group submit-proposal my-upgrade.json. We could have the cli for the upgrade module generate the msg in json if we want (i.e. simd tx gov submit-proposal $(simd tx upgrade [insert some argumenst])` but I'm not sure if that's necessary.

blushi · 2022-02-22T08:59:04Z

So I'm not entirely convinced by the cli commands. My current thinking is that if you want to submit an upgrade msg you just use simd tx gov submit-proposal my-upgrade.json or if the authority is a group then simd tx group submit-proposal my-upgrade.json. We could have the cli for the upgrade module generate the msg in json if we want (i.e. simd tx gov submit-proposal $(simd tx upgrade [insert some argumenst])` but I'm not sure if that's necessary.

But then that means you would basically need to execute 2 commands, which might not be considered as a UX improvement... Although from a dev standpoint, that seems more consistent with the new gov json-based CLI approach for submitting proposal with arbitrary msgs. Let's maybe discuss during our sync later today?

cmwaters · 2022-02-25T18:37:02Z

FYI: I've made the authority configurable by the application (simd uses the gov module account and I'd expect most other apps to do the same). You can now also query what the authority for the upgrade module is.

In our call, we also agreed to not include any new cli commands as people could no construct the message in json and submit it via <app> tx gov submit-proposals [path/to/proposal.json]

amaury1093

LGTM, except the fact that the Msg server should check against the keeper authority (not hardcode the gov address)

x/upgrade/types/codec.go

x/upgrade/keeper/keeper.go

x/upgrade/keeper/msg_server.go

x/upgrade/types/expected_keepers.go

x/gov/client/cli/tx.go

x/upgrade/keeper/keeper.go

x/upgrade/keeper/msg_server.go

amaury1093

LGTM!

x/gov/client/cli/tx.go

x/upgrade/types/codec.go

x/upgrade/client/cli/parse.go

x/upgrade/client/cli/tx.go

…s-sdk into marie/10489-gov-upgrade-msg

CHANGELOG.md

amaury1093 · 2022-03-03T15:04:44Z

@cmwaters We need 2 approvals for automerge. Since Marie authored, you can just approve I guess

…ased gov proposals) (cosmos#11116)

blushi added 4 commits February 3, 2022 14:38

Add Msg/SoftwareUpgrade wip

a6a1463

Add msg server impl and tests

2705931

Add CLI

ff85950

Add parse tests

ad36272

github-actions bot added C:CLI C:x/gov C:x/upgrade labels Feb 4, 2022

blushi added 2 commits February 4, 2022 14:21

Merge branch 'master' into marie/10489-gov-upgrade-msg

3eb75c5

Add changelog

8216437

blushi changed the title ~~feat: Add MsgSoftwareUpgrade (new msgs-based gov proposals)~~ feat: Add MsgSoftwareUpgrade (for new msgs-based gov proposals) Feb 4, 2022

blushi changed the title ~~feat: Add MsgSoftwareUpgrade (for new msgs-based gov proposals)~~ feat: Add MsgSoftwareUpgrade (for new msgs-based gov proposals) Feb 4, 2022

blushi assigned amaury1093 Feb 7, 2022

amaury1093 reviewed Feb 8, 2022

View reviewed changes

blushi and others added 4 commits February 9, 2022 15:23

Update proto/cosmos/upgrade/v1beta1/tx.proto

3e606b2

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

Update proto/cosmos/upgrade/v1beta1/tx.proto

3845818

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

make proto-gen

be03a49

Merge branch 'master' into marie/10489-gov-upgrade-msg

08ddb21

blushi changed the title ~~feat: Add MsgSoftwareUpgrade (for new msgs-based gov proposals)~~ feat: Add MsgSoftwareUpgrade and MsgCancelUpgrade (for new msgs-based gov proposals) Feb 10, 2022

amaury1093 added 2 commits February 15, 2022 11:23

merge master

43e56a3

Add CancelUpgrade message

30dccb0

add cancel upgrade cli

756c95c

add authority grpc method

192528a

github-actions bot added the C:orm label Feb 21, 2022

Merge branch 'master' into marie/10489-gov-upgrade-msg

3101849

cmwaters added 3 commits February 25, 2022 19:14

remove the new upgrade cli

5da8064

fix cli build problems

3df9278

Merge branch 'master' into marie/10489-gov-upgrade-msg

7ec2a25

cmwaters marked this pull request as ready for review February 25, 2022 18:34

cmwaters requested review from aaronc and alexanderbez as code owners February 25, 2022 18:34

amaury1093 assigned likhita-809 Feb 28, 2022

amaury1093 reviewed Mar 1, 2022

View reviewed changes

cmwaters added 2 commits March 1, 2022 15:45

add a check for the authority

650cc34

implement code suggestions

689789a

amaury1093 reviewed Mar 1, 2022

View reviewed changes

x/upgrade/keeper/keeper.go Outdated Show resolved Hide resolved

x/upgrade/keeper/msg_server.go Outdated Show resolved Hide resolved

cmwaters added 2 commits March 3, 2022 12:10

implement suggestions

d3c83e8

Merge branch 'master' into marie/10489-gov-upgrade-msg

28f1d8d

cmwaters requested a review from amaury1093 March 3, 2022 11:13

amaury1093 approved these changes Mar 3, 2022

View reviewed changes

x/gov/client/cli/tx.go Outdated Show resolved Hide resolved

x/upgrade/types/codec.go Show resolved Hide resolved

x/upgrade/client/cli/parse.go Outdated Show resolved Hide resolved

x/upgrade/client/cli/tx.go Show resolved Hide resolved

cmwaters added 3 commits March 3, 2022 12:31

implement suggestions

7a3a715

Merge branch 'marie/10489-gov-upgrade-msg' of github.com:cosmos/cosmo…

7a95a45

…s-sdk into marie/10489-gov-upgrade-msg

remove redundant parse command

d2d3ee2

cmwaters reviewed Mar 3, 2022

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

cmwaters added 2 commits March 3, 2022 12:39

clean up changelog

f13b5b5

Merge branch 'master' into marie/10489-gov-upgrade-msg

0007831

cmwaters added the A:automerge Automatically merge PR once all prerequisites pass. label Mar 3, 2022

cmwaters merged commit 75d9d0d into master Mar 3, 2022

cmwaters deleted the marie/10489-gov-upgrade-msg branch March 3, 2022 15:45

amaury1093 mentioned this pull request May 20, 2022

Manual Testing for v0.46 #11880

Closed

72 tasks

larry0x pushed a commit to larry0x/cosmos-sdk that referenced this pull request May 22, 2023

feat: Add MsgSoftwareUpgrade and MsgCancelUpgrade (for new msgs-b…

b9a3027

…ased gov proposals) (cosmos#11116)

LampardNguyen234 mentioned this pull request Aug 15, 2023

deps: bump cosmos-sdk v0.46 and evmos v12 AstraProtocol/astra#209

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add `MsgSoftwareUpgrade` and `MsgCancelUpgrade` (for new msgs-based gov proposals) #11116

feat: Add `MsgSoftwareUpgrade` and `MsgCancelUpgrade` (for new msgs-based gov proposals) #11116

blushi commented Feb 4, 2022 •

edited by amaury1093

codecov bot commented Feb 4, 2022 •

edited

amaury1093 Feb 8, 2022

blushi Feb 9, 2022 •

edited

cmwaters Feb 16, 2022

blushi Feb 18, 2022 •

edited

amaury1093 Feb 18, 2022

blushi Feb 18, 2022

cmwaters Feb 21, 2022

cmwaters Feb 21, 2022

amaury1093 commented Feb 15, 2022

cmwaters commented Feb 16, 2022

cmwaters commented Feb 16, 2022 •

edited

amaury1093 commented Feb 16, 2022

cmwaters commented Feb 22, 2022

blushi commented Feb 22, 2022

cmwaters commented Feb 25, 2022

amaury1093 left a comment

amaury1093 left a comment

amaury1093 commented Mar 3, 2022

		legacyProposalHandlers []govclient.ProposalHandler // legacy proposal handlers which live in governance cli and rest
		proposalHandlers []govclient.ProposalHandler // proposal handlers which live in governance cli and rest

feat: Add MsgSoftwareUpgrade and MsgCancelUpgrade (for new msgs-based gov proposals) #11116

feat: Add MsgSoftwareUpgrade and MsgCancelUpgrade (for new msgs-based gov proposals) #11116

Conversation

blushi commented Feb 4, 2022 • edited by amaury1093

Description

Author Checklist

Reviewers Checklist

codecov bot commented Feb 4, 2022 • edited

Codecov Report

amaury1093 Feb 8, 2022

Choose a reason for hiding this comment

blushi Feb 9, 2022 • edited

Choose a reason for hiding this comment

cmwaters Feb 16, 2022

Choose a reason for hiding this comment

blushi Feb 18, 2022 • edited

Choose a reason for hiding this comment

amaury1093 Feb 18, 2022

Choose a reason for hiding this comment

blushi Feb 18, 2022

Choose a reason for hiding this comment

cmwaters Feb 21, 2022

Choose a reason for hiding this comment

cmwaters Feb 21, 2022

Choose a reason for hiding this comment

amaury1093 commented Feb 15, 2022

cmwaters commented Feb 16, 2022

cmwaters commented Feb 16, 2022 • edited

amaury1093 commented Feb 16, 2022

cmwaters commented Feb 22, 2022

blushi commented Feb 22, 2022

cmwaters commented Feb 25, 2022

amaury1093 left a comment

Choose a reason for hiding this comment

amaury1093 left a comment

Choose a reason for hiding this comment

amaury1093 commented Mar 3, 2022

feat: Add `MsgSoftwareUpgrade` and `MsgCancelUpgrade` (for new msgs-based gov proposals) #11116

feat: Add `MsgSoftwareUpgrade` and `MsgCancelUpgrade` (for new msgs-based gov proposals) #11116

blushi commented Feb 4, 2022 •

edited by amaury1093

codecov bot commented Feb 4, 2022 •

edited

blushi Feb 9, 2022 •

edited

blushi Feb 18, 2022 •

edited

cmwaters commented Feb 16, 2022 •

edited