Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 2.68 KB

README.md

File metadata and controls

54 lines (40 loc) · 2.68 KB
Raw

MetaMask Wallet API specification

This repository contains the OpenRPC specification for MetaMask's Wallet JSON-RPC API. You can view the specs in the following formats:

OpenRPC is way to specify JSON-RPC APIs that is versionable, human-readable, and machine-readable. It improves the accuracy of documentation, APIs, and clients.

Contribute

You can contribute to the API specs using the following steps.

Note: These steps are for updating the API specs. To make a significant change to the API itself, please submit a MetaMask Improvement Proposal (MIP).

  1. Edit the API specs in the openrpc.yaml file. See the OpenRPC docs for more information on how to format the specs.
  2. Run yarn install if you haven't previously set up the repository.
  3. Run yarn run build to re-generate the output file: dist/build/openrpc.json.
  4. To view the result, paste that file's contents into the OpenRPC playground.

For information about publishing changes to the interactive API reference in the MetaMask developer docs, see the docs contribution guidelines.

Build process

When you build the project, the following happens:

  1. The MetaMask-specific API specs openrpc.yaml are loaded from the local file system.
  2. The Ethereum Execution API specs are fetched from a remote URL and methods not supported/implemented by MetaMask are filtered out.
  3. The local MetaMask specs are merged with the Ethereum specs.
  4. Each Ethereum method is tagged with the "Ethereum API" tag.
  5. The merged and filtered specs are written out to temporary files:
    • src/build/openrpc.json
    • src/build/multichain-openrpc.json
  6. These files are output to the dist folder and the src/build contents are deleted.

Publishing process

On release, the specs are published to npm at @metamask/api-specs and to GitHub Pages.

For information about publishing to the interactive API reference in the MetaMask developer docs, see the docs contribution guidelines.