History

Jaco Greeff 7a627f88cb parity.js interfaces for vaults (#4497 )		2017-02-09 11:07:08 -05:00
..
interfaces	parity.js interfaces for vaults (#4497 )	2017-02-09 11:07:08 -05:00
.gitignore	JSON-RPC interfaces with documentation (#4276 )	2017-01-24 22:02:52 +01:00
helpers.js	Full JSON-RPC docs + sync tests. (#4335 )	2017-02-01 10:58:09 +01:00
index.js	Fix whitespace (#4299 )	2017-01-25 18:51:41 +01:00
index.spec.js	Perform a sync between Rust and JS when generating markdown instead of in spec tests (#4408 )	2017-02-02 17:24:15 +01:00
README.md	Extended JS interface -> Markdown generator (#4275 )	2017-01-24 16:05:21 +01:00
types.js	Full JSON-RPC docs + sync tests. (#4335 )	2017-02-01 10:58:09 +01:00

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

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 outputs index.js & index.json.
(optional) Generate docs via npm run build:markdown which outputs md files to ./docs.
Check-in and make a PR.