grassrootseconomics/openethereum
5
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
a58fad06a7
openethereum/js/src/jsonrpc
History
Maciej Hirsz a58fad06a7 JSON-RPC interfaces with documentation (#4276) 
* Extended Markdown generator

* Synced and extended all JSON-RPC interfaces

* Fix linter errors

* Format `parity_listAccounts` output in API

* typo
2017-01-24 22:02:52 +01:00
..
interfaces JSON-RPC interfaces with documentation (#4276) 2017-01-24 22:02:52 +01:00
.gitignore JSON-RPC interfaces with documentation (#4276) 2017-01-24 22:02:52 +01:00
helpers.js Extended JS interface -> Markdown generator (#4275) 2017-01-24 16:05:21 +01:00
index.js Crate tidyups. 2016-12-11 19:14:42 +01:00
index.spec.js Crate tidyups. 2016-12-11 19:14:42 +01:00
README.md Extended JS interface -> Markdown generator (#4275) 2017-01-24 16:05:21 +01:00
types.js Crate tidyups. 2016-12-11 19:14:42 +01:00

README.md

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.