@polkadot/jsonrpc
TypeScript icon, indicating that this package has built-in type declarations

1.7.1 • Public • Published

@polkadot/jsonrpc

A definition 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 -

yarn add @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 TSLint type checking)

Classes

Classes

Readme

Keywords

Package Sidebar

Install

npm i @polkadot/jsonrpc

Weekly Downloads

9

Version

1.7.1

License

Apache-2.0

Unpacked Size

40.8 kB

Total Files

31

Last publish

Collaborators

  • polkadotjs
  • jacogr