Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: migration doc updates for 08-wasm v8 to v9 #6845

Conversation

gjermundgaraba
Copy link
Contributor

Description

closes: #6139


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 the 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/).
  • Added relevant godoc comments.
  • Provide a conventional commit message to follow the repository standards.
  • Include a descriptive changelog entry when appropriate. This may be left to the discretion of the PR reviewers. (e.g. chores should be omitted from changelog)
  • Re-reviewed Files changed in the GitHub PR explorer.
  • Review SonarCloud Report in the comment section below once CI passes.

Copy link
Contributor

@crodriguezvega crodriguezvega left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good; thank you, @gjermundgaraba! We should move the whole 08-wasm section to the specific migration docs file for 08-wasm. We can have a heading like From ibc-go v8.3.x to ibc-go v9.0.x

@@ -210,9 +210,20 @@ The `IterateConsensusMetadata` function has been removed.

### 08-wasm

- The `Initialize`, `Status`, `GetTimestampAtHeight`, `GetLatestHeight`, `VerifyMembership`, `VerifyNonMembership`, `VerifyClientMessage`, `UpdateState` and `UpdateStateOnMisbehaviour` functions in `ClientState` have been removed and all their logic has been moved to functions of the `LightClientModule`.
- The `MigrateContract()` function has been removed from `ClientState`.
Copy link
Contributor

@crodriguezvega crodriguezvega Jul 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: I don't feel strongly about using () when we refer to functions, but for consistency with the rest of the document we should either remove them or add them to all. If you want, I can take care of this.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fine with removing the parentheses 👍🏻

@@ -210,9 +210,20 @@ The `IterateConsensusMetadata` function has been removed.

### 08-wasm

- The `Initialize`, `Status`, `GetTimestampAtHeight`, `GetLatestHeight`, `VerifyMembership`, `VerifyNonMembership`, `VerifyClientMessage`, `UpdateState` and `UpdateStateOnMisbehaviour` functions in `ClientState` have been removed and all their logic has been moved to functions of the `LightClientModule`.
- The `MigrateContract()` function has been removed from `ClientState`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fine with removing the parentheses 👍🏻

Copy link
Contributor

@DimitrisJim DimitrisJim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm! thanks for taking care of these!

docs/docs/03-light-clients/04-wasm/09-migrations.md Outdated Show resolved Hide resolved
Copy link
Contributor

@crodriguezvega crodriguezvega left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can merge this one, right?

@gjermundgaraba gjermundgaraba added this pull request to the merge queue Jul 19, 2024
Merged via the queue into main with commit 811807f Jul 19, 2024
26 checks passed
@gjermundgaraba gjermundgaraba deleted the gjermund/6139-update-08-wasm-documentation-and-migration-docs-for-v04x branch July 19, 2024 12:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update 08-wasm documentation and migration docs for v0.4.x
4 participants