paritytech/js-jsonrpc

Name: js-jsonrpc

Owner: Parity Technologies

Description: Moved to https://github.com/parity-js/jsonrpc

Created: 2017-07-27 10:42:36.0

Updated: 2018-01-22 09:50:53.0

Pushed: 2017-11-30 23:58:40.0

Homepage: https://github.com/parity-js/jsonrpc

Size: 183

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

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.