JSPM

  • Created
  • Published
  • Downloads 451
  • Score
    100M100P100Q56392F
  • License GPL-3.0

JSON and JS interface defintions for RPC

Package Exports

  • @parity/jsonrpc

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@parity/jsonrpc) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

jsonrpc

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

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.