Files
api/packages/type-jsonrpc
Jaco Greeff b3a95b58ed Cleanup jsonrpc, refer to api-codec (#174)
* Cleanup jsonrpc, refer to api-codec

* Move storagekey legacy into type-params (legacy)

* Remove misplaced debug log

* Remove header encoding, use api-codec/Header

* Remove legacy types

* Add metadat array (hack around json import)

* Move json metadata to ts
2018-09-28 18:35:39 +02:00
..
2018-09-19 16:14:37 +02:00
2018-08-11 11:14:20 +02:00

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)