@metamask/api-specs
TypeScript icon, indicating that this package has built-in type declarations

0.9.3 • Public • Published

MetaMask API Specs

API Playground: https://metamask.github.io/api-playground/api-documentation API Reference Docs: https://docs.metamask.io/wallet/reference/json-rpc-api/

Latest build: https://metamask.github.io/api-specs/latest/openrpc.json

JSON-RPC API provided by MetaMask.

MetaMask dapp developers lack a formal RPC specification. This attempts to document which methods MetaMask supports in a way that's versionable, human-readable and machine-readable. It will improve the accuracy of documentation, API, and clients.

MetaMasks effectiveness as an enterprise-grade application platform depends on its ability to provide a reliable and predictable developer experience.

Contributing

Edit the openrpc.yaml file.

You can then run yarn run build to generate the output file again.

To test the result, you can paste the resulting file from dist/build/openrpc.json into the OpenRPC playground and view the result.

Build Process

  • filter out methods that are not supported/implemented by metamask
  • merge wallet methods with execution api methods
  • output to build

Deploy

  • On release uploads to npm at @metamask/api-specs
  • On release uploads to github pages at https://metamask.github.io/api-specs/latest/metamask-openrpc.json

/@metamask/api-specs/

    Package Sidebar

    Install

    npm i @metamask/api-specs

    Weekly Downloads

    3

    Version

    0.9.3

    License

    Apache-2.0

    Unpacked Size

    193 kB

    Total Files

    6

    Last publish

    Collaborators

    • mcmire
    • nicholasellul
    • lgbot
    • naugtur
    • ritave
    • danfinlay
    • kumavis
    • rekmarks
    • metamaskbot
    • gudahtt
    • brad.decker
    • sethkfman