docs: update project structure

[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 Codecov Report in the comment section below once CI passes.

Summary by CodeRabbit

• New Features
  • Introduced a new capability module for dynamic capability store.
  • Added callbacks module for secondary applications to interact with IBC apps.
  • Implemented ICS 08 and ICS 09 in light-clients.

[coderabbitai]

Walkthrough

This update introduces a significant enhancement to the Cosmos SDK, focusing on dynamic capability storage and improved interaction mechanisms for IBC apps. By implementing ADR 003 and ADR 008, it adds a capability module for dynamic storage and a callbacks module for secondary application interactions, alongside updating light-clients with ICS 08 and ICS 09 implementations.

Changes

File	Change Summary
docs/dev/.../capability.md	Added documentation for the new capability module implementing Cosmos SDK's ADR 003.
docs/dev/.../callbacks.md	Introduced callbacks module documentation following ADR 008 for IBC app interactions.
docs/dev/.../light-clients.md	Updated with ICS 08 and ICS 09 implementations for light-clients.

Related issues

• ICS20 V2 Support for Multi Denom  #5793: The implementation of ICS20 V2 for Multi Denom might benefit from the new capability and callbacks modules for enhanced interactions and dynamic capabilities.
• [EPIC] IBC-Go Documentation Revamp #3488: Revamping ibc-go documentation could leverage the newly added module documentations to improve structure and content comprehensiveness.
• Add docs for revision formats #1795: The addition of light-clients implementations for ICS 08 and ICS 09 may provide necessary context or references for the documentation on revision formats and misbehavior detection.

Poem

In the realm of Cosmos, so vast and wide,
A rabbit hopped in, with eyes open wide.
"Look at these modules, so shiny, so new,
ADRs in action, dreams coming true."
🌌🐇💻
"With capabilities dynamic, callbacks so fine,
This update's a leap through blockchain's design."
In code we trust, in progress, we delight,
A hop forward in blockchain's endless flight.

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-tests 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 tests 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 tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 600de3b and 6dd28e6.

Files selected for processing (1)

• docs/dev/project-structure.md (2 hunks)

Additional comments: 3

docs/dev/project-structure.md (3)

• 11-13: The description of the capability module is clear and effectively communicates its purpose and implementation basis on Cosmos SDK's ADR 003. Good job on providing the direct link to the ADR for further reading.
• 29-29: The introduction of the callbacks module and its purpose, as outlined here, aligns well with the objectives of ADR 008. Including the module's documentation link provides a helpful resource for further exploration.
• 35-36: The updates to the light-clients section, including the descriptions for 08-wasm and 09-localhost, are well-documented and align with the implementations for ICS 08 and ICS 09. These additions enhance the documentation's comprehensiveness regarding light client support.

[DimitrisJim]

lgtm, thanks for remembering these often forgotten additions! 💯

[damiannolan]

🙏🏻