openethereum/js/packages/jsonrpc/README.md
Jaco Greeff 49fdd23d58 Ui 2 move to packages/* (#6113)
* Move secureApi to shell

* Extract isTestnet test

* Use mobx + subscriptions for status

* Re-add status indicator

* Add lerna

* Move intial packages to js/packages

* Move 3rdparty/{email,sms}-verification to correct location

* Move package.json & README to library src

* Move tests for library packages

* Move views & dapps to packages

* Move i18n to root

* Move shell to actual src (main app)

* Remove ~ references

* Change ~ to root (explicit imports)

* Finalise convert of ~

* Move views into dapps as well

* Move dapps to packages/

* Fix references

* Update css

* Update test spec locations

* Update tests

* Case fix

* Skip flakey tests

* Update enzyme

* Skip previously ignored tests

* Allow empty api for hw

* Re-add theme for embed
2017-07-21 15:46:53 +02:00

917 B

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.