Add proto message, implement sdk.Msg for Recover Client. #4494

DimitrisJim · 2023-08-28T20:38:57Z

Description

closes: #4493

this only takes care of adding proto and then satisfying the compiler, follow ups will implement func for client keeper and on msg_server.

Commit Message / Changelog Entry

feat: add proto message for RecoverClient

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.

crodriguezvega

Looks very good!

damiannolan

Nice work! Just left some nits :)

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

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

charleenfei

a few small comments but otherwise lgtm!

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

charleenfei · 2023-08-29T08:44:47Z

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

+
+  // signer address (it may be the the address that controls the module, which defaults to x/gov unless overwritten).
+  string signer = 1;


nit but usually the signer field is last on our other Msg types

that should be due to it being added later no?

No signer should exist for every msg type since the beginning of sdk

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

charleenfei · 2023-08-29T08:45:51Z

modules/core/keeper/msg_server.go

@@ -100,6 +100,11 @@ func (k Keeper) SubmitMisbehaviour(goCtx context.Context, msg *clienttypes.MsgSu
 	return &clienttypes.MsgSubmitMisbehaviourResponse{}, nil
 }

+// RecoverClient defines a rpc handler method for MsgRecoverClient.
+func (k Keeper) RecoverClient(goCtx context.Context, msg *clienttypes.MsgRecoverClient) (*clienttypes.MsgRecoverClientResponse, error) { //nolint:revive


Suggested change

func (k Keeper) RecoverClient(goCtx context.Context, msg *clienttypes.MsgRecoverClient) (*clienttypes.MsgRecoverClientResponse, error) { //nolint:revive

func (Keeper) RecoverClient(goCtx context.Context, msg *clienttypes.MsgRecoverClient) (*clienttypes.MsgRecoverClientResponse, error) {

yea, I'll remove the nolint directive when adding the implementation for RecoverClient

Co-authored-by: Damian Nolan <[email protected]>

Co-authored-by: Charly <[email protected]>

codecov-commenter · 2023-08-29T09:26:06Z

Codecov Report

Merging #4494 (ae081cc) into feat/govv1 (85821bd) will increase coverage by 0.01%.
The diff coverage is 90.90%.

Additional details and impacted files

@@              Coverage Diff               @@
##           feat/govv1    #4494      +/-   ##
==============================================
+ Coverage       79.50%   79.52%   +0.01%     
==============================================
  Files             188      188              
  Lines           13038    13060      +22     
==============================================
+ Hits            10366    10386      +20     
- Misses           2241     2243       +2     
  Partials          431      431

Files Changed	Coverage Δ
modules/core/keeper/msg_server.go	`55.73% <0.00%> (-0.23%)`	⬇️
modules/core/02-client/types/codec.go	`80.00% <100.00%> (+0.20%)`	⬆️
modules/core/02-client/types/msgs.go	`79.80% <100.00%> (+2.08%)`	⬆️

…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]>

Add proto message for Recover client, implement sdk.Message interface.

79163d2

DimitrisJim marked this pull request as ready for review August 29, 2023 07:51

DimitrisJim requested review from colin-axner, AdityaSripal and damiannolan as code owners August 29, 2023 07:51

DimitrisJim requested a review from charleenfei August 29, 2023 07:57

crodriguezvega approved these changes Aug 29, 2023

View reviewed changes

damiannolan approved these changes Aug 29, 2023

View reviewed changes

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

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

charleenfei approved these changes Aug 29, 2023

View reviewed changes

DimitrisJim and others added 3 commits August 29, 2023 11:50

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

1b1fae1

Co-authored-by: Damian Nolan <[email protected]>

Apply suggestions from code review

2e6b754

Co-authored-by: Charly <[email protected]>

Remove gogoproto false for cmp, lint, move ibctesting address inline.

ae081cc

DimitrisJim merged commit 51417ee into feat/govv1 Aug 29, 2023

DimitrisJim deleted the jim/3672-message-recover-client branch August 29, 2023 09:39

DimitrisJim mentioned this pull request Aug 30, 2023

Move signer as last proto field. #4510

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add proto message, implement sdk.Msg for Recover Client. #4494

Add proto message, implement sdk.Msg for Recover Client. #4494

DimitrisJim commented Aug 28, 2023 •

edited

Loading

crodriguezvega left a comment •

edited

Loading

damiannolan left a comment

charleenfei left a comment

charleenfei Aug 29, 2023

DimitrisJim Aug 29, 2023

colin-axner Aug 30, 2023

DimitrisJim Aug 30, 2023

charleenfei Aug 29, 2023

DimitrisJim Aug 29, 2023

codecov-commenter commented Aug 29, 2023


		// signer address (it may be the the address that controls the module, which defaults to x/gov unless overwritten).
		string signer = 1;

	func (k Keeper) RecoverClient(goCtx context.Context, msg clienttypes.MsgRecoverClient) (clienttypes.MsgRecoverClientResponse, error) { //nolint:revive
	func (Keeper) RecoverClient(goCtx context.Context, msg clienttypes.MsgRecoverClient) (clienttypes.MsgRecoverClientResponse, error) {

Add proto message, implement sdk.Msg for Recover Client. #4494

Add proto message, implement sdk.Msg for Recover Client. #4494

Conversation

DimitrisJim commented Aug 28, 2023 • edited Loading

Description

Commit Message / Changelog Entry

crodriguezvega left a comment • edited Loading

Choose a reason for hiding this comment

damiannolan left a comment

Choose a reason for hiding this comment

charleenfei left a comment

Choose a reason for hiding this comment

charleenfei Aug 29, 2023

Choose a reason for hiding this comment

DimitrisJim Aug 29, 2023

Choose a reason for hiding this comment

colin-axner Aug 30, 2023

Choose a reason for hiding this comment

DimitrisJim Aug 30, 2023

Choose a reason for hiding this comment

charleenfei Aug 29, 2023

Choose a reason for hiding this comment

DimitrisJim Aug 29, 2023

Choose a reason for hiding this comment

codecov-commenter commented Aug 29, 2023

Codecov Report

DimitrisJim commented Aug 28, 2023 •

edited

Loading

crodriguezvega left a comment •

edited

Loading