add protos, msgs, keeper handler to upgrade clients using v1 governance proposals #4436

charleenfei · 2023-08-23T12:52:48Z

Description

closes a portion of #3673.

This PR contains just the protos, msgs, keeper function and correlating tests.

the msg_server impl will come in a following pr

Commit Message / Changelog Entry

feat: add protos, msgs, keeper handler to upgrade clients using v1 governance proposals

see the guidelines for commit messages. (view raw markdown for examples)

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 and Go style guide.
Wrote unit and integration tests.
Updated relevant documentation (docs/) or specification (x/<module>/spec/).
Added relevant godoc comments.
Provide a commit message to be used for the changelog entry in the PR description for review.
Re-reviewed Files changed in the Github PR explorer.
Review Codecov Report in the comment section below once CI passes.

damiannolan

should fix linter errors I think, I haven't reviewed anything else properly yet! Looks good tho!

modules/core/keeper/msg_server.go

modules/core/keeper/msg_server_test.go

proto/ibc/core/client/v1/tx.proto

damiannolan

Looks great! Left a couple of suggestions, mostly minor stuff!

Main concern is around sdkerrors and ibcerrors being used together

damiannolan · 2023-08-24T09:07:40Z

modules/core/02-client/keeper/keeper_test.go

+	var (
+		upgradedClientState *ibctm.ClientState
+		oldPlan, plan       upgradetypes.Plan
+		expError            error


is it possible to expError on the testcase struct instead?

modules/core/02-client/keeper/keeper_test.go

damiannolan · 2023-08-24T09:09:31Z

modules/core/02-client/keeper/keeper_test.go

+				bz, err := types.MarshalClientState(suite.chainA.App.AppCodec(), upgradedClientState)
+				suite.Require().NoError(err)
+
+				suite.chainA.GetSimApp().UpgradeKeeper.SetUpgradedClient(suite.chainA.GetContext(), oldPlan.Height, bz) //nolint:errcheck


may as well check the error instead of having the nolint directive, if you always expect it to succeed just use suite.Require().NoError(err) on it directly underneath

damiannolan · 2023-08-24T09:10:25Z

modules/core/02-client/keeper/keeper_test.go

+				}
+
+				// check that client state was not set
+				_, found = suite.chainA.GetSimApp().UpgradeKeeper.GetUpgradedClient(suite.chainA.GetContext(), plan.Height)


nit: I have a preference for not discarding args as much as possible. We can do an assert empty or assert default struct of this value I think, right?

modules/core/02-client/types/msgs_test.go

damiannolan · 2023-08-24T09:12:10Z

modules/core/02-client/types/msgs_test.go

+			Name:   "upgrade IBC clients",
+			Height: 1000,
+		}
+		_, err := types.NewMsgScheduleIBCClientUpgrade(


I think we could not discard this and make some assertions on expected value in expPass conditional

proto/ibc/core/client/v1/tx.proto

colin-axner

LGTM, see comments

modules/core/02-client/types/msgs_test.go

modules/core/02-client/keeper/keeper.go

modules/core/02-client/keeper/keeper_test.go

colin-axner · 2023-08-24T12:57:40Z

modules/core/02-client/keeper/keeper_test.go

+			// set the old plan if it is not empty
+			if oldPlan.Height != 0 {
+				// set upgrade plan in the upgrade store
+				store := suite.chainA.GetContext().KVStore(suite.chainA.GetSimApp().GetKey(upgradetypes.StoreKey))
+				bz := suite.chainA.App.AppCodec().MustMarshal(&oldPlan)
+				store.Set(upgradetypes.PlanKey(), bz)
+
+				bz, err := types.MarshalClientState(suite.chainA.App.AppCodec(), upgradedClientState)
+				suite.Require().NoError(err)
+
+				suite.Require().NoError(suite.chainA.GetSimApp().UpgradeKeeper.SetUpgradedClient(suite.chainA.GetContext(), oldPlan.Height, bz))
+			}


There's probably some code magic we could do here by adding the logic to setting an old plan and checking the expected result only in the test cases that use it. Maybe we can open as a followup issue (I know this comes from the existing code). I'd expect only the test cases needing an existing plan to execute that logic (maybe by calling ibcSoftwareUpgrade with an older plan height and then having some assertion to check that the old plan exists. Happy as is though

damiannolan · 2023-08-24T16:12:54Z

modules/core/02-client/types/msgs.go

+}
+
+// ValidateBasic performs basic checks on a MsgIBCSoftwareUpgrade.
+func (msg *MsgIBCSoftwareUpgrade) ValidateBasic() error {


Considering that for the time being we're implicitly on a tendermint chain when using ibc-go should we add a check on the provided client state that ClientType() returns exported.Tendermint

cc. @colin-axner

crodriguezvega

Great work, @charleenfei! Just left one comment based on what we decided yesterday to rename authority to signer in the MsgUpdateParams.

proto/ibc/core/client/v1/tx.proto

modules/core/02-client/types/msgs.go

…handler-to-upgrade-clients-using-v1-governance-proposals

DimitrisJim · 2023-08-29T14:06:53Z

modules/core/02-client/keeper/keeper.go

+	}
+
+	// emitting an event for handling client upgrade proposal
+	emitUpgradeClientProposalEvent(ctx, plan.Name, plan.Height)


do we want a separate event for this?

i would lean towards not for this function, as this function calls the upgradeKeeper to schedule a client upgrade so i think the event should remain the same.

potentially could be different for recover client tho

Yes we should, opened #4507

…and `MsgIBCSoftwareUpgrade`. The legacy proposal types `ClientUpdateProposal` and `UpgradeClientProposal` have been removed. (#4620) * Add proto message, implement sdk.Msg for Recover Client. (#4494) * Add proto message for Recover client, implement sdk.Message interface. * Update modules/core/02-client/types/msgs.go Co-authored-by: Damian Nolan <[email protected]> * Apply suggestions from code review Co-authored-by: Charly <[email protected]> * Remove gogoproto false for cmp, lint, move ibctesting address inline. --------- Co-authored-by: Damian Nolan <[email protected]> Co-authored-by: Charly <[email protected]> * add protos, msgs, keeper handler to upgrade clients using v1 governance proposals (#4436) * add protos and keeper function placeholder * add keeper functions/tests, msgs and tests * update to 0.47.5 release branch * Move signer as last proto field. (#4510) * msg server function and tests for MsgScheduleIBCClientUpgrade (#4442) * Add 02-client implementation for Recover client. (#4499) * Add 02-client implementation for Recover client. * Partially address feedback. * Docu RecoverClient, add label, re-use error. * Add implementation for recover client on message server. (#4503) * Add message server handler for recovering a client * Don't assign to deprecated attrs, clean up unused fields. * Further clean-up, remove declaration of unmutated vars. * Add cmd for submitting a recover client prop. (#4522) * Add cmd for submitting a recover client prop. * Bump cosmossdk in e2e. * Use govtypes.ModuleName, rename old govtypes to govv1beta1 * Update modules/core/02-client/client/cli/tx.go Co-authored-by: Damian Nolan <[email protected]> * Add auth flag. --------- Co-authored-by: Damian Nolan <[email protected]> * rename command * docs: fixed broken links (#4571) * Add e2e test for recovering a client. (#4543) Co-authored-by: Colin Axnér <[email protected]> * feat: add unpacket inerfaces message assertion (#4588) * add cli for MsgIBCSoftwareUpgrade (#4558) * docs: use MsgRecoverClient in docs (#4580) * docs: recover client update * Update docs/ibc/proposals.md * Apply suggestions from code review Co-authored-by: Carlos Rodriguez <[email protected]> --------- Co-authored-by: Carlos Rodriguez <[email protected]> * refactor: remove legacy client update proposal (#4581) * refactor: remove legacy client update proposal * e2e: swap from ClientUpdateProposal e2e to RecoverClient * refactor: remove unused events * feat: add proposal simulator interface function and tests (#4466) Co-authored-by: colin axner <[email protected]> * refactor!: remove UpgradeProposal type (#4602) * create separate event emission for ibc software upgrades vs an upgraded client (#4594) * add new event type * update event name * fix build * remove: legacy event emissions * remove: unnecessary assignments, apply suggestion from code review * e2e: schedule IBC software upgrade (#4585) * wip e2e test * query proposal * update upgrade height in plan * rm unnecessary wait/authority * rm test artifact from merge * add checks for scheduled plan * hook up upgrade query client * plan height * pr fixes * update test * import space * update newchainID value * update clientID upgrade * linter * gci * rm unnecessary event --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Damian Nolan <[email protected]> Co-authored-by: colin axnér <[email protected]> Co-authored-by: Sishir Giri <[email protected]> Co-authored-by: srdtrk <[email protected]> Co-authored-by: Cian Hatton <[email protected]> Co-authored-by: Julien Robert <[email protected]> Co-authored-by: Carlos Rodriguez <[email protected]> Co-authored-by: Jim Fasarakis-Hilliard <[email protected]> Co-authored-by: sontrinh16 <[email protected]> Co-authored-by: catShaark <[email protected]> Co-authored-by: khanh-notional <[email protected]> * chore: docs for MsgIBCSoftwareUpgrade (#4601) * chore: update docs for UpgradeProposal -> MsgIBCSoftwareUpgrade * chore: anticipate link change * fix event docs * refactor: s.Assert -> s.Require * Apply suggestions from code review Co-authored-by: Damian Nolan <[email protected]> * make proto-all * chore: update compiler assertion * refactor: ordering, order as follows: create, update, upgrade, misbheaviour, recover, ibcsoftwareupgrade, update params * refactor: simplify ibc software upgrade emitted event * lint lint lint * Apply suggestions from code review Co-authored-by: Charly <[email protected]> * review of feat/govv1 * pr nits * fix tests for error wrapping --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Jim Fasarakis-Hilliard <[email protected]> Co-authored-by: Damian Nolan <[email protected]> Co-authored-by: Charly <[email protected]> Co-authored-by: Charly <[email protected]> Co-authored-by: Carlos Rodriguez <[email protected]> Co-authored-by: srdtrk <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Sishir Giri <[email protected]> Co-authored-by: Cian Hatton <[email protected]> Co-authored-by: Julien Robert <[email protected]> Co-authored-by: sontrinh16 <[email protected]> Co-authored-by: catShaark <[email protected]> Co-authored-by: khanh-notional <[email protected]>

charleenfei added 2 commits August 22, 2023 16:35

add protos and keeper function placeholder

f9ce4fd

add keeper functions/tests, msgs and tests

5242278

charleenfei requested review from colin-axner, AdityaSripal and damiannolan as code owners August 23, 2023 12:52

charleenfei added 2 commits August 23, 2023 15:50

fix linter

f499db4

bring back msg_server placeholders

59514fe

This comment was marked as outdated.

Sign in to view

damiannolan reviewed Aug 23, 2023

View reviewed changes

modules/core/keeper/msg_server.go Outdated Show resolved Hide resolved

modules/core/keeper/msg_server_test.go Outdated Show resolved Hide resolved

fix linter

a4922e7

charleenfei mentioned this pull request Aug 23, 2023

msg server function and tests for MsgScheduleIBCClientUpgrade #4442

Merged

9 tasks

colin-axner reviewed Aug 24, 2023

View reviewed changes

proto/ibc/core/client/v1/tx.proto Outdated Show resolved Hide resolved

damiannolan reviewed Aug 24, 2023

View reviewed changes

update msg name, make changes in testing

70a431f

colin-axner approved these changes Aug 24, 2023

View reviewed changes

damiannolan reviewed Aug 24, 2023

View reviewed changes

charleenfei added the v8 label Aug 25, 2023

update test bool, method name

b2eee55

charleenfei mentioned this pull request Aug 28, 2023

create util function for upgrade plan testing #4481

Open

charleenfei added 2 commits August 28, 2023 16:04

capitalisation

2c94f5f

update testcase

5462ba6

crodriguezvega approved these changes Aug 29, 2023

View reviewed changes

proto/ibc/core/client/v1/tx.proto Outdated Show resolved Hide resolved

DimitrisJim reviewed Aug 29, 2023

View reviewed changes

modules/core/02-client/types/msgs.go Outdated Show resolved Hide resolved

Carlos Rodriguez and others added 2 commits August 29, 2023 10:36

added check that message implements sdk.Msg interface

776a7ce

update authority -> signers

efa5e43

charleenfei requested review from srdtrk and chatton as code owners August 29, 2023 12:29

Merge branch 'feat/govv1' into charly/issue#3673-add-message-and-rpc-…

dbbf6b9

…handler-to-upgrade-clients-using-v1-governance-proposals

charleenfei force-pushed the charly/issue#3673-add-message-and-rpc-handler-to-upgrade-clients-using-v1-governance-proposals branch from 3d627a9 to dbbf6b9 Compare August 29, 2023 12:35

merge

eb99d94

charleenfei added 3 commits August 29, 2023 14:53

fix merge conflicts

77a2720

fix merge shenanigans

c418302

add check for tm client type

4cad828

DimitrisJim reviewed Aug 29, 2023

View reviewed changes

charleenfei merged commit 35909f6 into feat/govv1 Aug 29, 2023

charleenfei deleted the charly/issue#3673-add-message-and-rpc-handler-to-upgrade-clients-using-v1-governance-proposals branch August 29, 2023 14:07

DimitrisJim mentioned this pull request Aug 29, 2023

Add 02-client implementation for Recover client. #4499

Merged

9 tasks

colin-axner mentioned this pull request Aug 31, 2023

Add message and rpc handler to upgrade clients using v1 governance proposals #3673

Closed

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add protos, msgs, keeper handler to upgrade clients using v1 governance proposals #4436

add protos, msgs, keeper handler to upgrade clients using v1 governance proposals #4436

charleenfei commented Aug 23, 2023

This comment was marked as outdated.

damiannolan left a comment

damiannolan left a comment

damiannolan Aug 24, 2023

damiannolan Aug 24, 2023

damiannolan Aug 24, 2023

damiannolan Aug 24, 2023

colin-axner left a comment

colin-axner Aug 24, 2023

damiannolan Aug 24, 2023

colin-axner Aug 24, 2023

crodriguezvega left a comment

DimitrisJim Aug 29, 2023

charleenfei Aug 29, 2023

charleenfei Aug 29, 2023

colin-axner Aug 30, 2023

add protos, msgs, keeper handler to upgrade clients using v1 governance proposals #4436

add protos, msgs, keeper handler to upgrade clients using v1 governance proposals #4436

Conversation

charleenfei commented Aug 23, 2023

Description

Commit Message / Changelog Entry

This comment was marked as outdated.

damiannolan left a comment

Choose a reason for hiding this comment

damiannolan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

colin-axner left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

crodriguezvega left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment