Interface IJsonRpcClient<ChainApi, Events>

A generic interface for JSON-RPC clients

interface IJsonRpcClient<ChainApi, Events> {
    options: JsonRpcClientOptions;
    provider: JsonRpcProvider;
    rpc: ChainApi["rpc"];
    status: ConnectionStatus;
    connect(): Promise<IJsonRpcClient<ChainApi, Events>>;
    disconnect(): Promise<void>;
    off(event: Events, handler?: HandlerFn): this;
    on(event: Events, handler: HandlerFn): Unsub;
    once(event: Events, handler: HandlerFn): Unsub;
}

Type Parameters

Hierarchy (view full)

Implemented by

Properties

options provider rpc status

Methods

connect disconnect off on once

Properties

options

options: JsonRpcClientOptions

provider

provider: JsonRpcProvider

rpc

rpc: ChainApi["rpc"]

status

status: ConnectionStatus

Methods

connect

disconnect

off

  • off(event, handler?): this

  • Parameters

    • event: Events
    • Optionalhandler: HandlerFn

    Returns this

on

  • on(event, handler): Unsub

  • Parameters

    • event: Events
    • handler: HandlerFn

    Returns Unsub

once

  • once(event, handler): Unsub

  • Parameters

    • event: Events
    • handler: HandlerFn

    Returns Unsub

On This Page

Properties
Methods