docs: use MsgRecoverClient in docs #4580

colin-axner · 2023-09-05T15:28:48Z

Description

Commit Message / Changelog Entry

type: commit message

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.

colin-axner · 2023-09-05T15:29:38Z

docs/ibc/proposals.md

@@ -76,11 +75,10 @@ The client is attached to the expected Akash `chain-id`. Note that although the

 ### Step 2

-If the chain has been updated to ibc-go >= v1.1.0, anyone can submit the governance proposal to recover the client by executing this via CLI.
+Anyone can submit the governance proposal to recover the client by executing the following via CLI.
+If the chain is on an ibc-go version older than v8, please see the [relevant documentation](https://ibc.cosmos.network/v6.1.0/ibc/proposals.html).


for some reason linking v7.3.0 wasn't working for me

hmmm, that's not good... Looks like the docs for the latest releases are not properly deployed...

docs/ibc/proposals.md

colin-axner · 2023-09-05T15:34:38Z

docs/ibc/proposals.md

        "subject_client_id": "expired_client_id_string",
-        "substitute_client_id": "active_client_id_string"
+        "substitute_client_id": "active_client_id_string",


I haven't verified manually. If someone thinks that is important, I'll let you take the lead 🙂

I did use the gov cli cmd to format this:

Example: $ simd tx gov submit-proposal path/to/proposal.json Where proposal.json contains: { // array of proto-JSON-encoded sdk.Msgs "messages": [ { "@type": "/cosmos.bank.v1beta1.MsgSend", "from_address": "cosmos1...", "to_address": "cosmos1...", "amount":[{"denom": "stake","amount": "10"}] } ], // metadata can be any of base64 encoded, raw text, stringified json, IPFS link to json // see below for example metadata "metadata": "4pIMOgIGx1vZGU=", "deposit": "10stake", "title": "My proposal", "summary": "A short summary of my proposal", "expedited": false }

wouldn't this just be simd tx ibc client "subject-client" "substitute-client" --title="..."

this suggestion comes after looking at sdk's docs for x/upgrade which uses gov v1.

There's 2 cli's that support submission of recovering a client. Using gov's submit-proposal cli and the one we implemented. I actually ended up testing recovery via the gov cli using the e2e targetting cli's. Personally I prefer the json file approach, otherwise you input all the args as flags

colin-axner · 2023-09-05T15:35:19Z

docs/ibc/proposals.md

@@ -124,6 +112,4 @@ After this, all that remains is deciding who funds the governance deposit and en

 ## Important considerations

-Please note that from v1.0.0 of ibc-go it will not be allowed for transactions to go to expired clients anymore, so please update to at least this version to prevent similar issues in the future.


removed as no chains are on a pre ibc-go v1 version

crodriguezvega

Thank you, @colin-axner. Left just a couple of comments.

docs/architecture/adr-026-ibc-client-recovery-mechanisms.md

crodriguezvega · 2023-09-06T07:55:29Z

docs/ibc/proposals.md

@@ -76,11 +75,10 @@ The client is attached to the expected Akash `chain-id`. Note that although the

 ### Step 2

-If the chain has been updated to ibc-go >= v1.1.0, anyone can submit the governance proposal to recover the client by executing this via CLI.
+Anyone can submit the governance proposal to recover the client by executing the following via CLI.
+If the chain is on an ibc-go version older than v8, please see the [relevant documentation](https://ibc.cosmos.network/v6.1.0/ibc/proposals.html).


hmmm, that's not good... Looks like the docs for the latest releases are not properly deployed...

crodriguezvega · 2023-09-06T07:58:42Z

docs/ibc/proposals.md

      }
    ],
    "metadata": "<metadata>",
    "deposit": "10stake"
+    "title": "My proposal",
+    "summary": "A short summary of my proposal",
+    "expedited": false
  }
  ```



Should we also add an example using the recover-client CLI that we are adding now?

Personally, I find the submit-proposal to be easier UI then submitting all these extra fields with flags. I'll leave it up to y'all to push the extra example if you'd like

Co-authored-by: Carlos Rodriguez <[email protected]>

damiannolan

Nice one!

colin-axner · 2023-09-06T13:49:49Z

Merging, if anyone wants to push other changes, please feel free to open another pr

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

docs: recover client update

720a30d

colin-axner requested review from AdityaSripal, crodriguezvega, charleenfei, damiannolan, chatton, DimitrisJim and srdtrk as code owners September 5, 2023 15:28

colin-axner commented Sep 5, 2023

View reviewed changes

docs/ibc/proposals.md Outdated Show resolved Hide resolved

Update docs/ibc/proposals.md

9efba33

colin-axner commented Sep 5, 2023

View reviewed changes

colin-axner added the v8 label Sep 5, 2023

crodriguezvega approved these changes Sep 6, 2023

View reviewed changes

Apply suggestions from code review

59be787

Co-authored-by: Carlos Rodriguez <[email protected]>

damiannolan approved these changes Sep 6, 2023

View reviewed changes

colin-axner merged commit ffcb06d into feat/govv1 Sep 6, 2023
14 checks passed

colin-axner deleted the colin/3672-recover-client-docs branch September 6, 2023 13:49

colin-axner mentioned this pull request Sep 6, 2023

Update docs for recovering a client using v1 gov proposals #4584

Closed

crodriguezvega mentioned this pull request Sep 6, 2023

No type registered for ibc.core.client.v1.ClientUpdateProposal #3539

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: use MsgRecoverClient in docs #4580

docs: use MsgRecoverClient in docs #4580

colin-axner commented Sep 5, 2023 •

edited by DimitrisJim

Loading

colin-axner Sep 5, 2023

crodriguezvega Sep 6, 2023

colin-axner Sep 5, 2023

DimitrisJim Sep 6, 2023 •

edited

Loading

colin-axner Sep 6, 2023

colin-axner Sep 5, 2023

crodriguezvega left a comment

crodriguezvega Sep 6, 2023

crodriguezvega Sep 6, 2023

colin-axner Sep 6, 2023

damiannolan left a comment

colin-axner commented Sep 6, 2023

		@@ -124,6 +112,4 @@ After this, all that remains is deciding who funds the governance deposit and en

		## Important considerations

		Please note that from v1.0.0 of ibc-go it will not be allowed for transactions to go to expired clients anymore, so please update to at least this version to prevent similar issues in the future.

docs: use MsgRecoverClient in docs #4580

docs: use MsgRecoverClient in docs #4580

Conversation

colin-axner commented Sep 5, 2023 • edited by DimitrisJim Loading

Description

Commit Message / Changelog Entry

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DimitrisJim Sep 6, 2023 • edited Loading

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

damiannolan left a comment

Choose a reason for hiding this comment

colin-axner commented Sep 6, 2023

colin-axner commented Sep 5, 2023 •

edited by DimitrisJim

Loading

DimitrisJim Sep 6, 2023 •

edited

Loading