docs: link to the Multichain API prose reference#315
Open
adonesky1 wants to merge 1 commit into
Open
Conversation
Points readers from the README to MULTICHAIN_API.md in @metamask/multichain-api-middleware for a readable walkthrough of the Multichain API, and clarifies that multichain/openrpc.yaml is the machine-readable source of truth.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a callout in the README pointing readers to the new wallet-side Multichain API reference in
@metamask/multichain-api-middleware, and clarifies thatmultichain/openrpc.yamlhere is the machine-readable source of truth for that API.The OpenRPC spec is accurate but not easy to read end-to-end; the new doc gives a prose walkthrough (inputs/outputs, supported methods, error codes, and divergences from the current CAIP-25). This just cross-links the two.
Depends on the companion
MetaMask/corePR that addsMULTICHAIN_API.md(link targetsmain).Test plan
coredoc merges tomain.Note
Low Risk
Documentation-only README change with no runtime or spec file edits.
Overview
Adds a Multichain API (CAIP-25 / CAIP-27) callout to the README after the OpenRPC intro. It points readers to the prose
MULTICHAIN_API.mdin@metamask/multichain-api-middlewarefor session setup, methods, errors, and CAIP-25 divergences, and states thatmultichain/openrpc.yamlin this repo remains the machine-readable source of truth.Reviewed by Cursor Bugbot for commit 15a892d. Bugbot is set up for automated code reviews on this repo. Configure here.