viem
Version:
77 lines • 2.52 kB
TypeScript
import type { ErrorType } from '../../errors/utils.js';
import type { Chain } from '../../types/chain.js';
import { type CreateTransportErrorType, type Transport, type TransportConfig } from './createTransport.js';
export type OnResponseFn = (args: {
method: string;
params: unknown[];
transport: ReturnType<Transport>;
} & ({
error?: never;
response: unknown;
status: 'success';
} | {
error: Error;
response?: never;
status: 'error';
})) => void;
type RankOptions = {
/**
* The polling interval (in ms) at which the ranker should ping the RPC URL.
* @default client.pollingInterval
*/
interval?: number;
/**
* The number of previous samples to perform ranking on.
* @default 10
*/
sampleCount?: number;
/**
* Timeout when sampling transports.
* @default 1_000
*/
timeout?: number;
/**
* Weights to apply to the scores. Weight values are proportional.
*/
weights?: {
/**
* The weight to apply to the latency score.
* @default 0.3
*/
latency?: number;
/**
* The weight to apply to the stability score.
* @default 0.7
*/
stability?: number;
};
};
export type FallbackTransportConfig = {
/** The key of the Fallback transport. */
key?: TransportConfig['key'];
/** The name of the Fallback transport. */
name?: TransportConfig['name'];
/** Toggle to enable ranking, or rank options. */
rank?: boolean | RankOptions;
/** The max number of times to retry. */
retryCount?: TransportConfig['retryCount'];
/** The base delay (in ms) between retries. */
retryDelay?: TransportConfig['retryDelay'];
};
export type FallbackTransport = Transport<'fallback', {
onResponse: (fn: OnResponseFn) => void;
transports: ReturnType<Transport>[];
}>;
export type FallbackTransportErrorType = CreateTransportErrorType | ErrorType;
export declare function fallback(transports_: Transport[], config?: FallbackTransportConfig): FallbackTransport;
export declare function rankTransports({ chain, interval, onTransports, sampleCount, timeout, transports, weights, }: {
chain?: Chain;
interval: RankOptions['interval'];
onTransports: (transports: Transport[]) => void;
sampleCount?: RankOptions['sampleCount'];
timeout?: RankOptions['timeout'];
transports: Transport[];
weights?: RankOptions['weights'];
}): void;
export {};
//# sourceMappingURL=fallback.d.ts.map