msg server function and tests for MsgScheduleIBCClientUpgrade #4442

charleenfei · 2023-08-23T16:27:40Z

Please first review #4436

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.

…e-clients-using-v1-governance-proposals' into charly/issue#3673-msg-server

damiannolan

Looks super clean! Just left two suggestions on testing 👍

damiannolan · 2023-08-24T16:07:50Z

modules/core/keeper/msg_server_test.go

+	testCases := []struct {
+		name     string
+		malleate func()
+		expPass  bool


same as other PR, we can refactor this to be expError and use expPass := expError == nil in the test body! 👍

damiannolan · 2023-08-24T16:08:55Z

modules/core/keeper/msg_server_test.go

+
+			_, err = keeper.Keeper.IBCSoftwareUpgrade(*suite.chainA.App.GetIBCKeeper(), suite.chainA.GetContext(), msg)
+			if tc.expPass {
+				suite.Require().NoError(err)


Inside expPass we can also check that there exists an upgrade plan in the x/upgrade store and upgraded client state in the upgradePath

…e-clients-using-v1-governance-proposals' into charly/issue#3673-msg-server

crodriguezvega

Looks good to me. I agree also with @damiannolan's suggestions.

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

…e-clients-using-v1-governance-proposals' into charly/issue#3673-msg-server

charleenfei · 2023-08-29T14:24:35Z

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

@@ -849,3 +851,74 @@ func (suite *TypesTestSuite) TestMsgIBCSoftwareUpgrade_GetSigners() {
 		}
 	}
 }
+
+// TestMsgIBCSoftwareUpgrade_ValidateBasic tests ValidateBasic for MsgIBCSoftwareUpgrade
+func (suite *TypesTestSuite) TestMsgIBCSoftwareUpgrade_ValidateBasic() {


this test got removed in the last pr merge process.

colin-axner

LGTM! Left a tiny nit and a suggestion (implement if you wish!)

colin-axner · 2023-08-30T09:32:01Z

modules/core/keeper/msg_server_test.go

-func (*KeeperTestSuite) TestIBCSoftwareUpgrade() {
+func (suite *KeeperTestSuite) TestIBCSoftwareUpgrade() {
+	var (
+		expError error


super nit: I like defining the expError on the testCases, it makes it more explicit what we expect to occur and avoids potential mishaps of not setting an expected error

colin-axner · 2023-08-30T09:33:17Z

modules/core/keeper/msg_server_test.go

+			// update trusting period
+			clientState := ibctm.NewClientState(suite.chainA.ChainID, ibctesting.DefaultTrustLevel, ibctesting.TrustingPeriod+100, ibctesting.UnbondingPeriod, ibctesting.MaxClockDrift, clienttypes.NewHeight(1, 10), commitmenttypes.GetSDKSpecs(), ibctesting.UpgradePath)
+


could also likely do:

clientState := path.EndpointB.GetClientState() clientState.TrustingPeriod+=100

…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 <damiannolan@gmail.com> * Apply suggestions from code review Co-authored-by: Charly <charly@interchain.io> * Remove gogoproto false for cmp, lint, move ibctesting address inline. --------- Co-authored-by: Damian Nolan <damiannolan@gmail.com> Co-authored-by: Charly <charly@interchain.io> * 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 <damiannolan@gmail.com> * Add auth flag. --------- Co-authored-by: Damian Nolan <damiannolan@gmail.com> * rename command * docs: fixed broken links (#4571) * Add e2e test for recovering a client. (#4543) Co-authored-by: Colin Axnér <25233464+colin-axner@users.noreply.github.com> * 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 <carlos@interchain.io> --------- Co-authored-by: Carlos Rodriguez <carlos@interchain.io> * 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 <25233464+colin-axner@users.noreply.github.com> * 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] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Damian Nolan <damiannolan@gmail.com> Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com> Co-authored-by: Sishir Giri <sis1001@berkeley.edu> Co-authored-by: srdtrk <59252793+srdtrk@users.noreply.github.com> Co-authored-by: Cian Hatton <cian@interchain.io> Co-authored-by: Julien Robert <julien@rbrt.fr> Co-authored-by: Carlos Rodriguez <carlos@interchain.io> Co-authored-by: Jim Fasarakis-Hilliard <d.f.hilliard@gmail.com> Co-authored-by: sontrinh16 <trinhleson2000@gmail.com> Co-authored-by: catShaark <gundamaster5@gmail.com> Co-authored-by: khanh-notional <50263489+catShaark@users.noreply.github.com> * 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 <damiannolan@gmail.com> * 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 <charly@interchain.io> * review of feat/govv1 * pr nits * fix tests for error wrapping --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Jim Fasarakis-Hilliard <d.f.hilliard@gmail.com> Co-authored-by: Damian Nolan <damiannolan@gmail.com> Co-authored-by: Charly <charly@interchain.io> Co-authored-by: Charly <charly@interchain.berlin> Co-authored-by: Carlos Rodriguez <carlos@interchain.io> Co-authored-by: srdtrk <59252793+srdtrk@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Sishir Giri <sis1001@berkeley.edu> Co-authored-by: Cian Hatton <cian@interchain.io> Co-authored-by: Julien Robert <julien@rbrt.fr> Co-authored-by: sontrinh16 <trinhleson2000@gmail.com> Co-authored-by: catShaark <gundamaster5@gmail.com> Co-authored-by: khanh-notional <50263489+catShaark@users.noreply.github.com>

charleenfei added 6 commits August 22, 2023 16:35

add protos and keeper function placeholder

f9ce4fd

add keeper functions/tests, msgs and tests

5242278

fix linter

f499db4

bring back msg_server placeholders

59514fe

add msg_server function and tests

55eb017

fix linter

a4922e7

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

charleenfei added 4 commits August 23, 2023 18:29

Merge branch 'charly/issue#3673-add-message-and-rpc-handler-to-upgrad…

8c4ca90

…e-clients-using-v1-governance-proposals' into charly/issue#3673-msg-server

update msg name, make changes in testing

70a431f

Merge branch 'charly/issue#3673-add-message-and-rpc-handler-to-upgrad…

22125d3

…e-clients-using-v1-governance-proposals' into charly/issue#3673-msg-server

fix linter, update to new msg name

314c81d

damiannolan approved these changes Aug 24, 2023

View reviewed changes

charleenfei added the v8 label Aug 25, 2023

charleenfei added 6 commits August 28, 2023 15:48

update test bool, method name

b2eee55

capitalisation

2c94f5f

Merge branch 'charly/issue#3673-add-message-and-rpc-handler-to-upgrad…

6d7407b

…e-clients-using-v1-governance-proposals' into charly/issue#3673-msg-server

update test bool

5b4aa3c

update testcase

5462ba6

Merge branch 'charly/issue#3673-add-message-and-rpc-handler-to-upgrad…

f23b9b4

…e-clients-using-v1-governance-proposals' into charly/issue#3673-msg-server

crodriguezvega approved these changes Aug 29, 2023

View reviewed changes

crodriguezvega and others added 8 commits August 29, 2023 10:36

added check that message implements sdk.Msg interface

776a7ce

update authority -> signers

efa5e43

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

dbbf6b9

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

merge

eb99d94

fix merge conflicts

77a2720

Merge branch 'charly/issue#3673-add-message-and-rpc-handler-to-upgrad…

9744005

…e-clients-using-v1-governance-proposals' into charly/issue#3673-msg-server

update authority -> signer

7868ed2

add tests back in

d5d5dcb

charleenfei added 3 commits August 29, 2023 15:16

fix merge shenanigans

c418302

add check for tm client type

4cad828

msgs

89da39e

Base automatically changed from charly/issue#3673-add-message-and-rpc-handler-to-upgrade-clients-using-v1-governance-proposals to feat/govv1 August 29, 2023 14:07

charleenfei added 3 commits August 29, 2023 16:12

Merge branch 'feat/govv1' into charly/issue#3673-msg-server

3de8fd5

move params tests back to reduce diffs

c92a408

merge shenanigans

f4cd006

charleenfei commented Aug 29, 2023

View reviewed changes

charleenfei added 3 commits August 29, 2023 17:43

update tests per comments

49655cc

linter fix

0505634

Merge branch 'feat/govv1' into charly/issue#3673-msg-server

c4c033d

colin-axner approved these changes Aug 30, 2023

View reviewed changes

charleenfei added 2 commits August 30, 2023 14:46

go mod tidy

0125cdc

pr comments

d7ff43a

charleenfei requested review from chatton and DimitrisJim as code owners August 30, 2023 12:51

charleenfei merged commit d9f6200 into feat/govv1 Aug 30, 2023
49 checks passed

charleenfei deleted the charly/issue#3673-msg-server branch August 30, 2023 13:43

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

msg server function and tests for MsgScheduleIBCClientUpgrade #4442

msg server function and tests for MsgScheduleIBCClientUpgrade #4442

charleenfei commented Aug 23, 2023 •

edited

Loading

damiannolan left a comment

damiannolan Aug 24, 2023

damiannolan Aug 24, 2023

crodriguezvega left a comment

charleenfei Aug 29, 2023

colin-axner left a comment

colin-axner Aug 30, 2023

colin-axner Aug 30, 2023

		// update trusting period
		clientState := ibctm.NewClientState(suite.chainA.ChainID, ibctesting.DefaultTrustLevel, ibctesting.TrustingPeriod+100, ibctesting.UnbondingPeriod, ibctesting.MaxClockDrift, clienttypes.NewHeight(1, 10), commitmenttypes.GetSDKSpecs(), ibctesting.UpgradePath)

msg server function and tests for MsgScheduleIBCClientUpgrade #4442

msg server function and tests for MsgScheduleIBCClientUpgrade #4442

Conversation

charleenfei commented Aug 23, 2023 • edited Loading

damiannolan left a comment

Choose a reason for hiding this comment

damiannolan Aug 24, 2023

Choose a reason for hiding this comment

damiannolan Aug 24, 2023

Choose a reason for hiding this comment

crodriguezvega left a comment

Choose a reason for hiding this comment

charleenfei Aug 29, 2023

Choose a reason for hiding this comment

colin-axner left a comment

Choose a reason for hiding this comment

colin-axner Aug 30, 2023

Choose a reason for hiding this comment

colin-axner Aug 30, 2023

Choose a reason for hiding this comment

charleenfei commented Aug 23, 2023 •

edited

Loading