docs: RFC 003: Cross Language Account, Module, Message Model

[aaronc]

Description

This RFC conceptually specifies a framework for cross-language, cross-VM accounts and modules.

---

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.

I have...

• [ ] included the correct type prefix in the PR title, you can find examples of the prefixes below:
• [ ] confirmed ! in the type prefix if API or client breaking change
• [ ] targeted the correct branch (see PR Targeting)
• [ ] provided a link to the relevant issue or specification
• [ ] reviewed "Files changed" and left comments if necessary
• [ ] included the necessary unit and integration tests
• [ ] added a changelog entry to CHANGELOG.md
• [ ] updated the relevant documentation or specification, including comments for documenting Go code
• [ ] confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

• [ ] confirmed the correct type prefix in the PR title
• [ ] confirmed all author checklist items have been addressed
• [ ] reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

• New Features

  • Introduced "RFC 003: Account/Module Execution Model," outlining a framework for interoperability among accounts and modules in a multi-language environment within the Cosmos SDK.
  • Detailed the lifecycle of accounts, message transmission specifications, and the role of account handlers.

• Documentation

  • Added comprehensive guidelines on the execution model, including definitions, message types, and metadata requirements.

[coderabbitai[bot]]

[!WARNING]

Rate limit exceeded

@aaronc has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 49 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between a6bf7fc21e0e3a0d77c324bc21c722f40fc69bed and 39ae91825c6178487d87c649e366adc500df1fa1.

Walkthrough

Walkthrough

RFC 003 establishes a formal framework within the Cosmos SDK aimed at enhancing interoperability among accounts and modules in a cross-language and cross-virtual machine (VM) environment. It defines essential components such as accounts, addresses, messages, and account handlers, while detailing processes for account lifecycle management and metadata usage to cater to both single-language users and those working with multiple languages.

Changes

Files	Change Summary
docs/rfc/rfc-003-crosslang.md	Introduced RFC 003 outlining a new execution model for cross-language support, defining accounts, messages, and handlers, and detailing account lifecycle and metadata requirements.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AccountHandler
    participant Hypervisor
    participant VM

    User->>AccountHandler: Send Message
    AccountHandler->>Hypervisor: Process Message
    Hypervisor->>VM: Invoke Message
    VM-->>Hypervisor: Return Response
    Hypervisor-->>AccountHandler: Send Response
    AccountHandler-->>User: Return Result

---

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.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

[aaronc]

Looking forward to hear how will that Message data will be defined however. Could we mention x/account somewhere as well and how this replicates some of its features?

I added references to x/accounts and other previous design documents.

I also added consequences and a decision section, which basically says we intend to move forward with this approach (which is my read on the discussion).

Planning to work on an update to this RFC with message data specs after this first draft is merged.

[aaronc]

Anybody know what's up with the markdown link checker? The report is long and any errors are non obvious

[julienrbrt]

Anybody know what's up with the markdown link checker? The report is long and any errors are non obvious

It hasn't been introduced here for sure. I think it was broken for a while. Just broken links basically.

[julienrbrt]

"ERROR: 4 dead links found!"

Something to fix in the doc focus week for sure.