Skip to content
This repository has been archived by the owner on May 13, 2021. It is now read-only.
/ jsonrpc Public archive

@parity/jsonrpc Ethereum JSONRPC definitions

License

Notifications You must be signed in to change notification settings

parity-js/jsonrpc

Repository files navigation

jsonrpc

JSON file of all ethereum's rpc methods supported by parity

Build Status Coverage Status Dependency Status devDependency Status

interfaces

interfaces.md contains the auto-generated list of interfaces exposed, along with their relevant documentation

contributing

  1. Clone the repo
  2. Branch
  3. Add the missing interfaces only into src/interfaces/*.js
  4. Parameters (array) & Returns take objects of type
    • { type: [Array|Boolean|Object|String|...], desc: 'some description', example: 100|'0xff'|{ ... } }
    • Types are built-in JS types or those defined in src/types.js (e.g. BlockNumber, Quantity, etc.)
    • If a formatter is required, add it as format: 'string-type'
  5. Run the lint & tests, npm run lint && npm run test
  6. Generate via npm run build which outputs index.js & index.json.
  7. (optional) Generate docs via npm run build:markdown which outputs md files to ./docs.
  8. Check-in and make a PR.

About

@parity/jsonrpc Ethereum JSONRPC definitions

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published