chore: 08-wasm branch for conditional clients compatible with v8.3.x

[crodriguezvega]

Description

closes: #XXXX

---

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.

Summary by CodeRabbit

• Chores

  • Updated backport patches target branches for wasm ibc-go versions.

• Documentation

  • Added recommendations for sharing Wasm VM instances in integration guides.
  • Updated migration guide for 08-wasm versions detailing changes in checksum storage and WasmEngine interface updates.

[coderabbitai]

Walkthrough

The updates encompass refining the 08-wasm module and its documentation to enhance integration and migration strategies for wasm light clients within the IBC framework. Changes include backporting patches, advising on Wasm VM instance sharing, and detailing migration steps for improved module functionality and compatibility.

Changes

File Path	Change Summary
.github/mergify.yml	Backport patches target branches updated to v8.3.x; label updated.
docs/.../03-integration.md docs/.../09-migrations.md	Recommended sharing the same Wasm VM instance between modules; advised against shared directories. Detailed migration guide for 08-wasm versions, including checksum storage and WasmEngine interface updates.

Possibly related issues

• Restructure 02-client to a more generalized light client handler #5084: The restructuring goals and enhancements proposed align with the updates in 08-wasm module documentation, focusing on flexibility and efficiency in handling light clients.
• Conditional clients #5112: The challenges in 08-wasm implementation discussed could benefit from the documentation updates, especially regarding integration and migration strategies for wasm clients.
• Human readable client registration for 08-wasm #5844: The introduction of a human-readable sub-type and registry implementation in 08-wasm may relate to the enhancements in module usability and interaction, as outlined in the migration guide.

"In a world of bytes and bits, 🐰
A rabbit hopped, fixing kits. 🛠️
With patches back and guides anew,
Wasm clients shine, in v8.3 hue.
Through docs and codes, it leaps,
Ensuring every module neatly keeps. 🌟"

---

Recent Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 790b314 and c8124d9.

Files selected for processing (1)

• .github/mergify.yml (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• .github/mergify.yml

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between b124129 and 790b314.

Files selected for processing (3)

• .github/mergify.yml (1 hunks)
• docs/docs/03-light-clients/04-wasm/03-integration.md (1 hunks)
• docs/docs/03-light-clients/04-wasm/09-migrations.md (1 hunks)

Additional comments not posted (3)

docs/docs/03-light-clients/04-wasm/09-migrations.md (1)

15-21: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [18-76]

The update to the WasmEngine interface and the WasmConfig structure are clear and well-documented with the use of diff blocks. These changes reflect the necessary adjustments for compatibility from ibc-go v8.0.x to v8.3.x, including the introduction of gas limits and the transition from Response to ContractResult. It's important to ensure that all dependent modules and implementations are updated accordingly to accommodate these interface changes.

.github/mergify.yml (1)

69-76: The addition of the backport rule for the v0.2.x wasm ibc-go v8.3.x & wasmvm 2.0.x branch is correctly implemented and follows the structure of existing backport rules. This change aligns with the PR objectives to ensure compatibility with version 8.3.x for conditional clients using the 08-wasm branch. It's crucial to verify that the specified branches exist and are correctly named to avoid any issues with the backport process.

docs/docs/03-light-clients/04-wasm/03-integration.md (1)

132-132: The recommendation to share the same Wasm VM instance between 08-wasm and x/wasm is a significant change that can impact how chains integrate these modules. This approach can optimize resource usage and simplify configuration. However, it's crucial to highlight the importance of not sharing directories between VM instances to prevent unexpected behavior. This advice is particularly relevant for chains upgrading to or beyond x/wasm v0.51 and 08-wasm v0.2.0+ibc-go-v8.3-wasmvm-v2.0, where sharing the same data folder is explicitly forbidden. Chains should review their current setup to ensure compliance with these guidelines.

[damiannolan]

This needs to be merged before dependabot updates wasmvm to v2.0.1, right?

[crodriguezvega]

This needs to be merged before dependabot updates wasmvm to v2.0.1, right?

Not necessarily. It also works with reapplying the label on the PR.