@polkadot/api-jsonrpc

v0.11.3
Method definitions for the Polkadot RPC layer
Polkadot JsonRPC

polkadotjs isc style npm travis maintainability coverage dependency devDependency

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

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

Usage

Installation -

npm install --save @polkadot/api-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)
npm i @polkadot/api-jsonrpc

Metadata

  • ISC
  • >=6.4
  • Jaco Greeff
  • released 5/17/2018

Downloads

Maintainers