Interface ClientOptions

RPC Client options

interface ClientOptions {
    addressPrefix?: string;
    backoff?: ((tries: number) => number);
    chainId?: string;
    consoleOnFailover?: boolean;
    coreClient?: any;
    coreModule?: any;
    failoverThreshold?: number;
    nodeSelectionStrategy?: any;
    rpcTransport?: RpcTransportKind;
    timeout?: number;
}

Hierarchy (view full)

Properties

addressPrefix? backoff? chainId? consoleOnFailover? coreClient? coreModule? failoverThreshold? nodeSelectionStrategy? rpcTransport? timeout?

Properties

OptionaladdressPrefix

addressPrefix?: string

Blurt address prefix. Defaults to main network: BLT

Optionalbackoff

backoff?: ((tries: number) => number)

Retry backoff function, returns milliseconds. Defaults to dblurt's built-in capped quadratic backoff.

OptionalchainId

chainId?: string

Blurt chain id. Defaults cd8d90f29ae273abec3eaa7731e25934c63eb654d55080caff2ebb7f5df6381f

OptionalconsoleOnFailover

consoleOnFailover?: boolean

Whether a console.log should be made when RPC failed over to another one

OptionalcoreClient

coreClient?: any

Optional prebuilt blurt-rpc-core compatible client for tests/custom transports.

OptionalcoreModule

coreModule?: any

Optional preloaded blurt-rpc-core module for tests/CommonJS integration.

OptionalfailoverThreshold

failoverThreshold?: number

Specifies the amount of times the urls (RPC nodes) should be iterated and retried in case of timeout errors. (important) Requires url parameter to be an array (string[])! Can be set to 0 to iterate and retry forever. Defaults to 3 rounds.

OptionalnodeSelectionStrategy

nodeSelectionStrategy?: any

Optional blurt-rpc-core node selection strategy, used only with rpcTransport='core'.

OptionalrpcTransport

rpcTransport?: RpcTransportKind

Internal migration switch. Defaults to legacy; core is experimental opt-in and delegates only JSON-RPC transport to blurt-rpc-core.

Optionaltimeout

timeout?: number

how long to wait in milliseconds before giving up on a rpc call. Defaults to 60 * 1000 ms.

Settings

Member Visibility

On This Page

RPC Client options
Properties