Interface JsonRpcProvider

interface JsonRpcProvider {
    status: ConnectionStatus;
    connect(): Promise<JsonRpcProvider>;
    disconnect(): Promise<void>;
    off(event: ProviderEvent, handler?: HandlerFn): this;
    on(event: ProviderEvent, handler: HandlerFn): Unsub;
    once(event: ProviderEvent, handler: HandlerFn): Unsub;
    send<T>(method: string, params: any[]): Promise<T>;
    subscribe<T>(input: JsonRpcSubscriptionInput, callback: JsonRpcSubscriptionCallback<T>): Promise<JsonRpcSubscription>;
}

Hierarchy (view full)

Properties

status

Methods

connect disconnect off on once send subscribe

Properties

status

status: ConnectionStatus

The current connection status

Methods

connect

disconnect

off

  • off(event, handler?): this

  • Parameters

    Returns this

on

  • on(event, handler): Unsub

  • Parameters

    Returns Unsub

once

  • once(event, handler): Unsub

  • Parameters

    Returns Unsub

send

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

  • Send a JSON-RPC request, make sure to connect to the provider first before sending requests

    Type Parameters

    • T = any

    Parameters

    • method: string
    • params: any[]

    Returns Promise<T>

subscribe

On This Page

Properties
Methods