e8ccc9aa79
* Pull api-* packages into lerna repo * Bootstrap with hoist * Update jest alias config * Add api-jsonrpc * Pull in jsonrpc * Update badges * Don't hoist, use workspaces * .eslintrc to root * Cleanups, build from root * Shorthand commands * Update to @polkadot/dev 0.9.1 * Update description
1.2 KiB
1.2 KiB
@polkadot/api-jsonrpc
A defintion of all the methods exposed in a general Polkadot client application. These are used not only to provide a comprehensive code-generated document of the available methods, but are also used in the API to auto-generate endpoints with the required type-checking.
Usage
Installation -
npm install --save @polkadot/api-jsonrpc
For a list of currently exposed methods, see the method documentation.
Adding methods
As methods are added, simply adding the name, inputs & output will prepare it for use.
- Add the method to the correct file in src/rpc/ (Input/Output types as cross-referenced from the canonical implementation and match one-to-one)
- Should a new type be required, add it to the type list, src/types.js (Required for flow type checking)