feat: implement new gov msg & query servers #10868

cmwaters · 2022-01-04T14:14:05Z

Description

This PR performs the major work of swapping out the v1beta1 msg server and query server for the new one which can process a proposal as an array of messages. This PR still retains the legacy servers which simply wrap around the new ones, providing the same interface as before.

In order to keep backwards compatibility, a new msg, MsgExecLegacyContent has been created which allows Content to become a Msg type and still be used as part of the new implementation.

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)

x/gov/abci.go

proto/cosmos/gov/v1beta2/gov.proto

x/gov/keeper/msg_server.go

amaury1093 · 2022-01-11T17:12:24Z

x/gov/module.go

+	v1beta2.RegisterMsgServer(cfg.MsgServer(), keeper.NewMsgServerImpl(am.keeper))
+	v1beta2.RegisterQueryServer(cfg.QueryServer(), am.keeper)


Should we add v1beta1 too, for backwards-compatibility?

Yes sorry, we want both.

TO not overload this PR, I created a spearate issue for query: #10951

…um/gov-msg-server

codecov · 2022-01-18T17:48:25Z

Codecov Report

Merging #10868 (69b2e66) into master (fd5b97b) will decrease coverage by 0.07%.
The diff coverage is 51.47%.

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

@@            Coverage Diff             @@
##           master   #10868      +/-   ##
==========================================
- Coverage   65.86%   65.78%   -0.08%     
==========================================
  Files         638      644       +6     
  Lines       64303    64802     +499     
==========================================
+ Hits        42352    42630     +278     
- Misses      19577    19781     +204     
- Partials     2374     2391      +17

Impacted Files	Coverage Δ
x/gov/client/cli/query.go	`0.00% <0.00%> (ø)`
x/gov/client/cli/tx.go	`18.61% <0.00%> (-0.10%)`	⬇️
x/gov/types/v1beta1/params.go	`0.00% <ø> (ø)`
x/gov/types/v1beta2/content.go	`0.00% <0.00%> (ø)`
x/gov/types/v1beta2/deposit.go	`0.00% <ø> (ø)`
x/gov/types/v1beta2/genesis.go	`47.50% <0.00%> (ø)`
x/gov/types/v1beta2/params.go	`22.42% <0.00%> (+0.20%)`	⬆️
x/gov/types/v1beta2/proposal.go	`15.87% <0.00%> (-0.26%)`	⬇️
x/gov/types/v1beta2/tally.go	`0.00% <0.00%> (ø)`
x/gov/types/v1beta2/vote.go	`27.27% <0.00%> (-2.00%)`	⬇️
... and 35 more

blushi

looks good overall, but still a few comments

x/gov/keeper/msg_server.go

x/gov/keeper/querier_test.go

x/gov/simulation/operations.go

x/gov/types/v1beta2/msgs.go

x/gov/types/v1beta2/proposal.go

Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>

…um/gov-msg-server

x/gov/keeper/querier_test.go

cmwaters

Added a few comments.

Do we want to keep the legacy querier tests around so that we are testing both the v1beta1 and the v1beta2 query server?

Also why do we have this codecov/patch thing? It's quite disruptive to the review process and if we're not actually using it then I'd advocate to remove it.

x/gov/keeper/msg_server.go

cmwaters · 2022-01-20T15:22:16Z

x/gov/keeper/msg_server.go

+	// Execute the proposal content in a new context branch (with branched store)
+	// to validate the actual parameter changes before the proposal proceeds
+	// through the governance process. State is not persisted.
+	cacheCtx, _ := ctx.CacheContext()


Don't we eventually want to run writeCache. Currently this looks like it never actually persists state. Is this intentional?

Ah you're right.

So the way it currently works is:

in EndBlocker, we create a CacheContext

if all Msgs pass then we write

Which means that in the msg server implementation of ExecLegacyContent, we don't need a CacheContext at all. I removed it.

x/gov/keeper/proposal.go

cmwaters · 2022-01-20T15:26:47Z

x/gov/keeper/proposal.go

+		// Only if it's a MsgExecLegacyContent do we try to execute the
+		// proposal in a cached context.
+		// For other Msgs, we do not verify the proposal messages any further.
+		// They may fail upon execution.
+		// ref: https://github.com/cosmos/cosmos-sdk/pull/10868#discussion_r784872842
+		if msg, ok := msg.(*v1beta2.MsgExecLegacyContent); ok {
+			cacheCtx, _ := ctx.CacheContext()
+			if _, err := handler(cacheCtx, msg); err != nil {
+				return v1beta2.Proposal{}, sdkerrors.Wrap(types.ErrNoProposalHandlerExists, err.Error())
+			}
+		}


We no longer need to do this right because we have the new MsgServer method for executing legacy content messages.

this is related to #10868 (comment).

The current code runs the Msg in SubmitProposal iif it's a MsgExecLegacyContent (to match old behavior). We could also remove this code, in which case the legacy content will be run for the 1st time once the proposal passes

I feel that mock running legacy content in SubmitProposal is safe, those old gov handlers are well-known and don't do any side-effects such as sending IBC messages or writing to disk

Ok yeah that's fine with me

x/gov/types/errors.go

Co-authored-by: Callum Waters <cmwaters19@gmail.com>

…s-sdk into callum/gov-msg-server

amaury1093 · 2022-01-20T16:08:00Z

thanks for the review @cmwaters

Also why do we have this codecov/patch thing? It's quite disruptive to the review process and if we're not actually using it then I'd advocate to remove it.

You mean this comment #10868 (comment) ? I feel it's one comment per PR, so it doesn't bother me too much, but happy to hear other opinions

Do we want to keep the legacy querier tests around so that we are testing both the v1beta1 and the v1beta2 query server?

Yeah, in this PR I switched querier_test.go to use v1beta2, but once we have #10951 I think we should add both grpc_query and legacy_querier tests to test both

cmwaters · 2022-01-20T20:14:45Z

You mean this comment #10868 (comment) ? I feel it's one comment per PR, so it doesn't bother me too much, but happy to hear other opinions

No I meant the inline comments for every line which doesn't have a test which hits it

cmwaters

🚀 LGTM. I can't actually approve this because I am the author but in any case this seems to ready to merge from my side

blushi

LGTM, pending merge conflicts

…um/gov-msg-server

amaury1093

🚀 LGTM. I can't actually approve this because I am the author but in any case this seems to ready to merge from my side

I'll give you mine!

## Description Ref: cosmos#9438 This PR performs the major work of swapping out the v1beta1 msg server and query server for the new one which can process a proposal as an array of messages. This PR still retains the legacy servers which simply wrap around the new ones, providing the same interface as before. In order to keep backwards compatibility, a new msg, `MsgExecLegacyContent` has been created which allows `Content` to become a `Msg` type and still be used as part of the new implementation. --- ### 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) 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)

cmwaters added 4 commits December 22, 2021 16:09

checkpoint

50bdd18

add logic for executing and submitting a proposal

f9d43a7

go fmt

b3b859a

add proposal test and nil check

79c7a64

github-actions bot added C:orm C:Simulations C:x/auth C:x/gov C:x/params C:x/staking labels Jan 4, 2022

Merge branch 'master' into callum/gov-msg-server

be5bcc9

cmwaters changed the title ~~gov: implement new msg server~~ feat: implement new gov msg & query servers Jan 4, 2022

amaury1093 reviewed Jan 5, 2022

View reviewed changes

x/gov/abci.go Show resolved Hide resolved

proto/cosmos/gov/v1beta2/gov.proto Outdated Show resolved Hide resolved

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

amaury1093 mentioned this pull request Jan 7, 2022

Merge master and fix conflicts on Callum's gov PR #10868 #10906

Closed

cmwaters added 4 commits January 7, 2022 13:12

Merge branch 'master' into callum/gov-msg-server

46d984c

resolve merge conflicts

099a3c2

fix auth

7871f98

fix missed compile errors

dbbb0c9

atheeshp mentioned this pull request Jan 7, 2022

refactor: remove deprecated vote option #10854

Merged

19 tasks

cmwaters added 2 commits January 7, 2022 17:25

fix a few tests

673e972

fix more tests

3af7d07

cmwaters assigned amaury1093 Jan 11, 2022

Fix some tests

833db47

github-actions bot added C:CLI C:x/authz C:x/distribution distribution module related C:x/feegrant labels Jan 11, 2022

amaury1093 reviewed Jan 11, 2022

View reviewed changes

amaury1093 added 2 commits January 11, 2022 18:56

Fix some more tests

1f46581

Merge branch 'master' of ssh://github.com/cosmos/cosmos-sdk into call…

0b8eeb3

…um/gov-msg-server

blushi reviewed Jan 20, 2022

View reviewed changes

Update x/gov/keeper/msg_server.go

be045bd

Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>

amaury1093 mentioned this pull request Jan 20, 2022

Update gov simulations to use v1beta2.Proposal #10986

Closed

4 tasks

amaury1093 added 3 commits January 20, 2022 13:11

Address reviews

43e18e5

Fix querier test

175ffad

Merge branch 'master' of ssh://github.com/cosmos/cosmos-sdk into call…

c760b1e

…um/gov-msg-server

amaury1093 reviewed Jan 20, 2022

View reviewed changes

x/gov/keeper/querier_test.go Outdated Show resolved Hide resolved

Update x/gov/keeper/querier_test.go

d16e290

amaury1093 mentioned this pull request Jan 20, 2022

feat: Add metadata field to proposal #10989

Merged

19 tasks

cmwaters commented Jan 20, 2022

View reviewed changes

amaury1093 and others added 4 commits January 20, 2022 16:40

Update x/gov/keeper/proposal.go

9ef5dad

Co-authored-by: Callum Waters <cmwaters19@gmail.com>

Address reviews

4bad077

Merge branch 'callum/gov-msg-server' of ssh://github.com/cosmos/cosmo…

0a6e01a

…s-sdk into callum/gov-msg-server

Move all errors to types/errors.go

69b2e66

cmwaters commented Jan 20, 2022

View reviewed changes

blushi approved these changes Jan 21, 2022

View reviewed changes

amaury1093 added 2 commits January 21, 2022 11:23

Merge branch 'master' of ssh://github.com/cosmos/cosmos-sdk into call…

a0a2289

…um/gov-msg-server

make proto-gen

d9e4067

amaury1093 approved these changes Jan 21, 2022

View reviewed changes

amaury1093 added the A:automerge Automatically merge PR once all prerequisites pass. label Jan 21, 2022

Merge branch 'master' into callum/gov-msg-server

e1d59ef

mergify bot merged commit eb5b11b into master Jan 21, 2022

mergify bot deleted the callum/gov-msg-server branch January 21, 2022 11:14

amaury1093 mentioned this pull request Feb 8, 2022

Update group module to tally at the end of voting #11092

Closed

4 tasks

NeverHappened mentioned this pull request Aug 30, 2023

Feat/admin module sdk47 NTRN-70 neutron-org/admin-module#2

Merged

JulianToledano mentioned this pull request Apr 29, 2024

[Feature]: simulate nested messages #15809

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: implement new gov msg & query servers #10868

feat: implement new gov msg & query servers #10868

cmwaters commented Jan 4, 2022 •

edited by amaury1093

Loading

amaury1093 Jan 11, 2022

cmwaters Jan 12, 2022

amaury1093 Jan 14, 2022

codecov bot commented Jan 18, 2022 •

edited

Loading

blushi left a comment

cmwaters left a comment

cmwaters Jan 20, 2022

amaury1093 Jan 20, 2022 •

edited

Loading

cmwaters Jan 20, 2022

amaury1093 Jan 20, 2022 •

edited

Loading

cmwaters Jan 20, 2022

amaury1093 commented Jan 20, 2022 •

edited

Loading

cmwaters commented Jan 20, 2022

cmwaters left a comment

blushi left a comment •

edited

Loading

amaury1093 left a comment

		v1beta2.RegisterMsgServer(cfg.MsgServer(), keeper.NewMsgServerImpl(am.keeper))
		v1beta2.RegisterQueryServer(cfg.QueryServer(), am.keeper)

feat: implement new gov msg & query servers #10868

feat: implement new gov msg & query servers #10868

Conversation

cmwaters commented Jan 4, 2022 • edited by amaury1093 Loading

Description

Author Checklist

Reviewers Checklist

amaury1093 Jan 11, 2022

Choose a reason for hiding this comment

cmwaters Jan 12, 2022

Choose a reason for hiding this comment

amaury1093 Jan 14, 2022

Choose a reason for hiding this comment

codecov bot commented Jan 18, 2022 • edited Loading

Codecov Report

blushi left a comment

Choose a reason for hiding this comment

cmwaters left a comment

Choose a reason for hiding this comment

cmwaters Jan 20, 2022

Choose a reason for hiding this comment

amaury1093 Jan 20, 2022 • edited Loading

Choose a reason for hiding this comment

cmwaters Jan 20, 2022

Choose a reason for hiding this comment

amaury1093 Jan 20, 2022 • edited Loading

Choose a reason for hiding this comment

cmwaters Jan 20, 2022

Choose a reason for hiding this comment

amaury1093 commented Jan 20, 2022 • edited Loading

cmwaters commented Jan 20, 2022

cmwaters left a comment

Choose a reason for hiding this comment

blushi left a comment • edited Loading

Choose a reason for hiding this comment

amaury1093 left a comment

Choose a reason for hiding this comment

cmwaters commented Jan 4, 2022 •

edited by amaury1093

Loading

codecov bot commented Jan 18, 2022 •

edited

Loading

amaury1093 Jan 20, 2022 •

edited

Loading

amaury1093 Jan 20, 2022 •

edited

Loading

amaury1093 commented Jan 20, 2022 •

edited

Loading

blushi left a comment •

edited

Loading