Class JsonRpcGroup<Event>

Name

JsonRpcGroup A group of json-rpc methods with a common prefix.

JSON-RPC V2: https://paritytech.github.io/json-rpc-interface-spec/grouping-functions-and-node-capabilities.html#grouping-functions-and-node-capabilities

Type Parameters

  • Event extends string = string

Hierarchy (view full)

Constructors

constructor

Properties

client options

Accessors

prefix

Methods

clearEvents emit off on once send supported version

Constructors

constructor

Properties

client

client: IJsonRpcClient<GenericSubstrateApi<RpcVersion>, ProviderEvent>

options

options: JsonRpcGroupOptions

Accessors

prefix

  • get prefix(): string

  • The prefix of the group

    Returns string

Methods

ProtectedclearEvents

  • clearEvents(): void

  • Returns void

emit

  • emit(event, ...args): boolean

  • Parameters

    • event: Event
    • Rest...args: any[]

    Returns boolean

off

  • off(event, handler?): this

  • Parameters

    • event: Event
    • Optionalhandler: HandlerFn

    Returns this

on

  • on(event, handler): Unsub

  • Parameters

    • event: Event
    • handler: HandlerFn

    Returns Unsub

once

  • once(event, handler): Unsub

  • Parameters

    • event: Event
    • handler: HandlerFn

    Returns Unsub

send

  • send<T>(method, ...params): Promise<T>

  • Send a json-rpc request, note the method should not contain the prefix and version parts.

    Type Parameters

    • T = any

    Parameters

    • method: string
    • Rest...params: any[]

    Returns Promise<T>

    Example

    const client = await JsonRpcClient.new('wss://rpc.polkadot.io');
    const achieve = new JsonRpcGroup(client, { prefix: 'archive', supportedVersions: ['unstable'] });

    const finalizedHeight = await achieve.send<number>('finalizedHeight'); // sending archive_unstable_finalizedHeight
    console.log(finalizedHeight);

supported

  • supported(): Promise<boolean>

  • Check if the group is supported by the connected JSON-RPC server.

    Returns Promise<boolean>

version

  • version(): Promise<JsonRpcGroupVersion>

  • Detect & return the version of the group. This will be used to construct the json-rpc method name.

    Returns Promise<JsonRpcGroupVersion>

On This Page

Constructors
Properties
Accessors
Methods