Files
api/packages/type-jsonrpc/README.md
T
Jaco Greeff ad968ec794 Import type-* from common repo (#125)
* Import type-* from common repo

* Update links

* Fix lint links (package index)
2018-08-11 11:14:20 +02:00

2.1 KiB

polkadotjs isc style npm travis maintainability coverage dependency devDependency

@polkadot/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.

For a list of currently exposed methods, see the method documentation.

Usage

Installation -

npm install --save @polkadot/jsonrpc

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)