Interface ISubstrateClient<ChainApi, Events>

A generic interface for Substrate clients

interface ISubstrateClient<ChainApi, Events> {
    atBlockHash?: `0x${string}`;
    call: ChainApi["call"];
    consts: ChainApi["consts"];
    errors: ChainApi["errors"];
    events: ChainApi["events"];
    genesisHash: `0x${string}`;
    metadata: Metadata;
    options: ApiOptions;
    provider: JsonRpcProvider;
    query: ChainApi["query"];
    registry: PortableRegistry;
    rpc: ChainApi["rpc"];
    rpcVersion: RpcVersion;
    runtimeVersion: SubstrateRuntimeVersion;
    status: ConnectionStatus;
    tx: ChainApi["tx"];
    at<ChainApiAt>(hash: `0x${string}`): Promise<ISubstrateClientAt<ChainApiAt>>;
    connect(): Promise<ISubstrateClient<ChainApi, Events>>;
    disconnect(): Promise<void>;
    getRuntimeVersion(): Promise<SubstrateRuntimeVersion>;
    off(event: Events, handler?: HandlerFn): this;
    on(event: Events, handler: HandlerFn): Unsub;
    once(event: Events, handler: HandlerFn): Unsub;
    setSigner(signer?: Signer): void;
}

Type Parameters

Hierarchy (view full)

Properties

atBlockHash? call consts errors events genesisHash metadata options provider query registry rpc rpcVersion runtimeVersion status tx

Methods

at connect disconnect getRuntimeVersion off on once setSigner

Properties

OptionalatBlockHash

atBlockHash?: `0x${string}`

call

call: ChainApi["call"]

consts

consts: ChainApi["consts"]

errors

errors: ChainApi["errors"]

events

events: ChainApi["events"]

genesisHash

genesisHash: `0x${string}`

metadata

metadata: Metadata

options

options: ApiOptions

provider

provider: JsonRpcProvider

query

query: ChainApi["query"]

registry

registry: PortableRegistry

rpc

rpc: ChainApi["rpc"]

rpcVersion

rpcVersion: RpcVersion

runtimeVersion

runtimeVersion: SubstrateRuntimeVersion

status

status: ConnectionStatus

tx

tx: ChainApi["tx"]

Methods

at

connect

disconnect

  • disconnect(): Promise<void>

  • Returns Promise<void>

getRuntimeVersion

  • getRuntimeVersion(): Promise<SubstrateRuntimeVersion>

  • Get current version of the runtime This is similar to .runtimeVersion but also ensure the corresponding metadata of this runtime version is downloaded & setup.

    This is helpful when you want to check runtime version to prepare for runtime upgrade

    Returns Promise<SubstrateRuntimeVersion>

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

setSigner

  • setSigner(signer?): void

  • Update the signer instance for signing transactions

    Parameters

    • Optionalsigner: Signer

    Returns void

On This Page

Properties
Methods