@polkadot/jsonrpc

@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

Changelog

1.6.1 Mar 12, 2020

• Breaking change api.rpc.state.queryStorage(...) now fully decodes the Vec<StorageChangeSet> and returns a decoded [Hash, Codec[]][] when using this RPC.

Changes:

• StorageKey now has an .args property, decoded from meta where twox64_concat or blake128_concat are used on maps
• Fix api.query.*.*.entries type conversions to return exact types (not Option in some cases)
• Add api.query.*.*.keys to retrieve only the storage keys, similar to .entries
• Full linked map retrievals will now use direct getStorage queries for faster operation
• Underlying rpc-core interfaces now unwraps Error("...") when found in responses
• Added derive.eras* interfaces for queries to new Substrate staking interfaces
• Update derive.account to cater for new indices module storage (detected with fallbacks)
• Adjust derive queries for session without module prefix (DoubleMap -> Map), detected on use
• Add runtime validation for map arguments to api.query.*
• TypeScript interfaces for linked maps now correctly generates as [Type, Linkage<Next>]