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

Index

Type aliases

Interface$Sections

Ƭ Interface$Sections: keyof Interfaces

Defined in types.d.ts:18

Interfaces

Ƭ Interfaces: object

Defined in types.d.ts:11

Type declaration

PrivateMethods

Ƭ PrivateMethods: object

Defined in chain.ts:50 Defined in state.ts:99 Defined in system.ts:34 Defined in author.ts:32

Type declaration

PublicMethods

Ƭ PublicMethods: object

Defined in chain.ts:49 Defined in state.ts:100 Defined in system.ts:35 Defined in author.ts:33