@parity/jsonrpc
v2.1.6
Published
JSON and JS interface defintions for RPC
Downloads
181
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
- Clone the repo
- Branch
- Add the missing interfaces only into
src/interfaces/*.js
- 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'
- Run the lint & tests,
npm run lint && npm run test
- Generate via
npm run build
which outputsindex.js
&index.json
. - (optional) Generate docs via
npm run build:markdown
which outputsmd
files to./docs
. - Check-in and make a PR.