docs(rfc): non-evm chain memo design standard

[ws4charlie]

Description

upload the doc Standard-non-EVM-Inbound-Memo

How Has This Been Tested?

• [ ] Tested CCTX in localnet
• [ ] Tested in development environment
• [ ] Go unit tests
• [ ] Go integration tests
• [ ] Tested via GitHub Actions

Summary by CodeRabbit

• New Features

  • Introduced support for stateful precompiled contracts and staking precompiled contracts.
  • Added common importable RPC package and enhancements for multiple Bitcoin chains.
  • Integrated authenticated calls smart contract functionality and new documentation for non-EVM chain memo format.

• Bug Fixes

  • Improved functionality for operators voting on ballots and resolved issues with outbound tracker on EVM chains.

• Documentation

  • Updated changelog and added a new section detailing the design of the non-EVM chain inbound memo format.

• Refactor

  • Cleaned up lint errors and modified contract handling for better organization.

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

📝 Walkthrough

📝 Walkthrough

📝 Walkthrough

📝 Walkthrough

Walkthrough

The changes encompass a comprehensive update to the changelog and the introduction of a proposed standard memo format for non-EVM chains. Key features include support for stateful precompiled contracts, enhancements to staking and bank precompiled contracts, and the integration of multiple Bitcoin chains. Additionally, the documentation outlines a structured memo format aimed at improving cross-chain transaction interoperability, detailing its structure, operation codes, and encoding specifications.

Changes

File Path	Change Summary
changelog.md	Updated to include new features such as stateful precompiled contracts, RPC package, staking enhancements, and support for multiple Bitcoin chains. Refactored MsgUpdateChainInfo and added MsgRemoveChainInfo. Expanded testing and fixed various functionality issues.
docs/design-proposals/non_evm_inbound_memo/...	Introduced a proposed standard memo format for non-EVM chains, detailing its structure, operation codes, and encoding specifications for improved interoperability.

Possibly related PRs

• #2735: The changes in this PR address issues with the outbound tracker, which is also mentioned in the main PR's summary regarding fixes to the outbound tracker on EVM chains.
• #2872: This PR updates the changelog to reflect significant changes in functionality, including enhancements related to the protocol, which aligns with the main PR's focus on updating the changelog for various new features and fixes.

Suggested labels

no-changelog

---

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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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.

[lumtis]

Converting to draft as we should not merge it for now

[lumtis]

Added a few commit to make it same organization as the other docs

[swift1337]

Why does this doc have an index of 002? 😅

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 64.91%. Comparing base (7b2bbe7) to head (205113f). Report is 8 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #2963      +/-   ##
===========================================
- Coverage    65.77%   64.91%   -0.86%     
===========================================
  Files          398      408      +10     
  Lines        22421    28407    +5986     
===========================================
+ Hits         14747    18441    +3694     
- Misses        6900     9170    +2270     
- Partials       774      796      +22     

see 392 files with indirect coverage changes