Interface ApiOptions

interface ApiOptions {
    cacheMetadata?: boolean;
    cacheStorage?: IStorage;
    hasher?: HashFn;
    metadata?: Record<`RAW_META/${string}`, `0x${string}`>;
    provider: JsonRpcProvider;
    runtimeApis?: Record<string, RuntimeApiSpec[]>;
    scaledResponses?: Record<string, $.AnyShape>;
    signedExtensions?: Record<string, AnySignedExtension>;
    signer?: Signer;
    subscriptions?: SubscriptionsInfo;
    throwOnUnknownApi?: boolean;
}

Hierarchy (view full)

Properties

cacheMetadata? cacheStorage? hasher? metadata? provider runtimeApis? scaledResponses? signedExtensions? signer? subscriptions? throwOnUnknownApi?

Properties

OptionalcacheMetadata

cacheMetadata?: boolean

OptionalcacheStorage

cacheStorage?: IStorage

Optionalhasher

hasher?: HashFn

Customize hashing algorithm used

Default

blake2_256

Optionalmetadata

metadata?: Record<`RAW_META/${string}`, `0x${string}`>

Description

Metadata is usually downloaded from chain via RPC upon API initialization, We can supply the metadata directly via this option to skip the download metadata step.

Metadata Key format: RAW_META/{genesisHash}/{runtimeSpecVersion}

If the genesisHash & runtimeSpecVersion of the supplied metadata key match with connected chain, then use the provided metadata, else we fetch it anew from chain.

provider

provider: JsonRpcProvider

Description

A JSON-RPC provider instance, it could be a WsProvider or SmoldotProvider

OptionalruntimeApis

runtimeApis?: Record<string, RuntimeApiSpec[]>

Description

Custom runtime api definitions/specs

You probably don't need to use this with the latest Metadata V15, unless you're connecting to a chain supports only Metadata V14

OptionalscaledResponses

scaledResponses?: Record<string, $.AnyShape>

OptionalsignedExtensions

signedExtensions?: Record<string, AnySignedExtension>

Description

User-defined chain-specific signed extensions

Optionalsigner

signer?: Signer

A signer instance to use for signing transactions

Optionalsubscriptions

subscriptions?: SubscriptionsInfo

OptionalthrowOnUnknownApi

throwOnUnknownApi?: boolean

By default, an UnknownApiError error will be thrown out if an api is known (e.g: api.query.pallet.unknown) upon evaluation. When set this to false, the api evaluation will simply return undefined

Default

true

On This Page

Properties