openethereum/js/src/jsonrpc
2016-11-23 10:33:04 +01:00
..
generator Initial new UI source code import (#2607) 2016-10-18 11:52:56 +02:00
interfaces Typo in description 2016-11-23 10:33:04 +01:00
index.js Cleaning up polluted namespaces (#3143) 2016-11-06 12:51:53 +01:00
index.spec.js Initial new UI source code import (#2607) 2016-10-18 11:52:56 +02:00
README.md Initial new UI source code import (#2607) 2016-10-18 11:52:56 +02:00
rollup.config.js Initial new UI source code import (#2607) 2016-10-18 11:52:56 +02:00
types.js Initial new UI source code import (#2607) 2016-10-18 11:52:56 +02: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

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' }
    • 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 testOnce
  6. Generate via npm run build which outputs index.js, index.json & interfaces.md (Only required until Travis is fully in-place)
  7. Check-in and make a PR