Package Exports
- @polkadot/api-jsonrpc
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@polkadot/api-jsonrpc) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@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-jsonrpcFor 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)