viem 2.7.5 → 2.7.6

package/_types/clients/transports/fallback.d.ts

@@ -0,0 +1,77 @@
+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

package/_types/clients/transports/fallback.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fallback.d.ts","sourceRoot":"","sources":["../../../clients/transports/fallback.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AACtD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAA;AAGjD,OAAO,EACL,KAAK,wBAAwB,EAC7B,KAAK,SAAS,EACd,KAAK,eAAe,EAErB,MAAM,sBAAsB,CAAA;AAE7B,MAAM,MAAM,YAAY,GAAG,CACzB,IAAI,EAAE;IACJ,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,OAAO,EAAE,CAAA;IACjB,SAAS,EAAE,UAAU,CAAC,SAAS,CAAC,CAAA;CACjC,GAAG,CACA;IACE,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,QAAQ,EAAE,OAAO,CAAA;IACjB,MAAM,EAAE,SAAS,CAAA;CAClB,GACD;IACE,KAAK,EAAE,KAAK,CAAA;IACZ,QAAQ,CAAC,EAAE,KAAK,CAAA;IAChB,MAAM,EAAE,OAAO,CAAA;CAChB,CACJ,KACE,IAAI,CAAA;AAET,KAAK,WAAW,GAAG;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE;QACR;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,yCAAyC;IACzC,GAAG,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAA;IAC5B,0CAA0C;IAC1C,IAAI,CAAC,EAAE,eAAe,CAAC,MAAM,CAAC,CAAA;IAC9B,iDAAiD;IACjD,IAAI,CAAC,EAAE,OAAO,GAAG,WAAW,CAAA;IAC5B,wCAAwC;IACxC,UAAU,CAAC,EAAE,eAAe,CAAC,YAAY,CAAC,CAAA;IAC1C,8CAA8C;IAC9C,UAAU,CAAC,EAAE,eAAe,CAAC,YAAY,CAAC,CAAA;CAC3C,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,SAAS,CACvC,UAAU,EACV;IACE,UAAU,EAAE,CAAC,EAAE,EAAE,YAAY,KAAK,IAAI,CAAA;IACtC,UAAU,EAAE,UAAU,CAAC,SAAS,CAAC,EAAE,CAAA;CACpC,CACF,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG,wBAAwB,GAAG,SAAS,CAAA;AAE7E,wBAAgB,QAAQ,CACtB,WAAW,EAAE,SAAS,EAAE,EACxB,MAAM,GAAE,uBAA4B,GACnC,iBAAiB,CAoFnB;AAcD,wBAAgB,cAAc,CAAC,EAC7B,KAAK,EACL,QAAgB,EAChB,YAAY,EACZ,WAAgB,EAChB,OAAe,EACf,UAAU,EACV,OAAY,GACb,EAAE;IACD,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC,CAAA;IACjC,YAAY,EAAE,CAAC,UAAU,EAAE,SAAS,EAAE,KAAK,IAAI,CAAA;IAC/C,WAAW,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAA;IACxC,OAAO,CAAC,EAAE,WAAW,CAAC,SAAS,CAAC,CAAA;IAChC,UAAU,EAAE,SAAS,EAAE,CAAA;IACvB,OAAO,CAAC,EAAE,WAAW,CAAC,SAAS,CAAC,CAAA;CACjC,QAwEA"}

package/_types/clients/transports/http.d.ts

@@ -0,0 +1,44 @@
+import { type UrlRequiredErrorType } from '../../errors/transport.js';
+import type { ErrorType } from '../../errors/utils.js';
+import { type HttpRpcClientOptions } from '../../utils/rpc/http.js';
+import { type CreateTransportErrorType, type Transport, type TransportConfig } from './createTransport.js';
+export type BatchOptions = {
+    /** The maximum number of JSON-RPC requests to send in a batch. @default 1_000 */
+    batchSize?: number;
+    /** The maximum number of milliseconds to wait before sending a batch. @default 0 */
+    wait?: number;
+};
+export type HttpTransportConfig = {
+    /**
+     * Whether to enable Batch JSON-RPC.
+     * @link https://www.jsonrpc.org/specification#batch
+     */
+    batch?: boolean | BatchOptions;
+    /**
+     * Request configuration to pass to `fetch`.
+     * @link https://developer.mozilla.org/en-US/docs/Web/API/fetch
+     */
+    fetchOptions?: HttpRpcClientOptions['fetchOptions'];
+    /** The key of the HTTP transport. */
+    key?: TransportConfig['key'];
+    /** The name of the HTTP transport. */
+    name?: TransportConfig['name'];
+    /** The max number of times to retry. */
+    retryCount?: TransportConfig['retryCount'];
+    /** The base delay (in ms) between retries. */
+    retryDelay?: TransportConfig['retryDelay'];
+    /** The timeout (in ms) for the HTTP request. Default: 10_000 */
+    timeout?: TransportConfig['timeout'];
+};
+export type HttpTransport = Transport<'http', {
+    fetchOptions?: HttpTransportConfig['fetchOptions'];
+    url?: string;
+}>;
+export type HttpTransportErrorType = CreateTransportErrorType | UrlRequiredErrorType | ErrorType;
+/**
+ * @description Creates a HTTP transport that connects to a JSON-RPC API.
+ */
+export declare function http(
+/** URL of the JSON-RPC API. Defaults to the chain's public RPC URL. */
+url?: string, config?: HttpTransportConfig): HttpTransport;
+//# sourceMappingURL=http.d.ts.map

package/_types/clients/transports/http.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../../../clients/transports/http.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,KAAK,oBAAoB,EAC1B,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AAGtD,OAAO,EACL,KAAK,oBAAoB,EAE1B,MAAM,yBAAyB,CAAA;AAEhC,OAAO,EACL,KAAK,wBAAwB,EAC7B,KAAK,SAAS,EACd,KAAK,eAAe,EAErB,MAAM,sBAAsB,CAAA;AAE7B,MAAM,MAAM,YAAY,GAAG;IACzB,iFAAiF;IACjF,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,oFAAoF;IACpF,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,YAAY,CAAA;IAC9B;;;OAGG;IACH,YAAY,CAAC,EAAE,oBAAoB,CAAC,cAAc,CAAC,CAAA;IACnD,qCAAqC;IACrC,GAAG,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAA;IAC5B,sCAAsC;IACtC,IAAI,CAAC,EAAE,eAAe,CAAC,MAAM,CAAC,CAAA;IAC9B,wCAAwC;IACxC,UAAU,CAAC,EAAE,eAAe,CAAC,YAAY,CAAC,CAAA;IAC1C,8CAA8C;IAC9C,UAAU,CAAC,EAAE,eAAe,CAAC,YAAY,CAAC,CAAA;IAC1C,gEAAgE;IAChE,OAAO,CAAC,EAAE,eAAe,CAAC,SAAS,CAAC,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,aAAa,GAAG,SAAS,CACnC,MAAM,EACN;IACE,YAAY,CAAC,EAAE,mBAAmB,CAAC,cAAc,CAAC,CAAA;IAClD,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,CACF,CAAA;AAED,MAAM,MAAM,sBAAsB,GAC9B,wBAAwB,GACxB,oBAAoB,GACpB,SAAS,CAAA;AAEb;;GAEG;AACH,wBAAgB,IAAI;AAClB,uEAAuE;AACvE,GAAG,CAAC,EAAE,MAAM,EACZ,MAAM,GAAE,mBAAwB,GAC/B,aAAa,CAmEf"}

package/_types/clients/transports/ipc.d.ts

@@ -0,0 +1,46 @@
+import { type UrlRequiredErrorType } from '../../errors/transport.js';
+import type { ErrorType } from '../../errors/utils.js';
+import type { Hash } from '../../types/misc.js';
+import type { RpcResponse } from '../../types/rpc.js';
+import { type IpcRpcClient } from '../../utils/rpc/ipc.js';
+import { type CreateTransportErrorType, type Transport, type TransportConfig } from './createTransport.js';
+type IpcTransportSubscribeParameters = {
+    onData: (data: RpcResponse) => void;
+    onError?: (error: any) => void;
+};
+type IpcTransportSubscribeReturnType = {
+    subscriptionId: Hash;
+    unsubscribe: () => Promise<RpcResponse<boolean>>;
+};
+type IpcTransportSubscribe = {
+    subscribe(args: IpcTransportSubscribeParameters & {
+        /**
+         * @description Add information about compiled contracts
+         * @link https://hardhat.org/hardhat-network/docs/reference#hardhat_addcompilationresult
+         */
+        params: ['newHeads'];
+    }): Promise<IpcTransportSubscribeReturnType>;
+};
+export type IpcTransportConfig = {
+    /** The key of the Ipc transport. */
+    key?: TransportConfig['key'];
+    /** The name of the Ipc transport. */
+    name?: TransportConfig['name'];
+    /** The max number of times to retry. */
+    retryCount?: TransportConfig['retryCount'];
+    /** The base delay (in ms) between retries. */
+    retryDelay?: TransportConfig['retryDelay'];
+    /** The timeout (in ms) for async Ipc requests. Default: 10_000 */
+    timeout?: TransportConfig['timeout'];
+};
+export type IpcTransport = Transport<'ipc', {
+    getRpcClient(): Promise<IpcRpcClient>;
+    subscribe: IpcTransportSubscribe['subscribe'];
+}>;
+export type IpcTransportErrorType = CreateTransportErrorType | UrlRequiredErrorType | ErrorType;
+/**
+ * @description Creates an IPC transport that connects to a JSON-RPC API.
+ */
+export declare function ipc(path: string, config?: IpcTransportConfig): IpcTransport;
+export {};
+//# sourceMappingURL=ipc.d.ts.map

package/_types/clients/transports/ipc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipc.d.ts","sourceRoot":"","sources":["../../../clients/transports/ipc.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AACrE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AACtD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAA;AAC/C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,KAAK,YAAY,EAAmB,MAAM,wBAAwB,CAAA;AAC3E,OAAO,EACL,KAAK,wBAAwB,EAC7B,KAAK,SAAS,EACd,KAAK,eAAe,EAErB,MAAM,sBAAsB,CAAA;AAE7B,KAAK,+BAA+B,GAAG;IACrC,MAAM,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,CAAA;IACnC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,CAAA;CAC/B,CAAA;AAED,KAAK,+BAA+B,GAAG;IACrC,cAAc,EAAE,IAAI,CAAA;IACpB,WAAW,EAAE,MAAM,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAA;CACjD,CAAA;AAED,KAAK,qBAAqB,GAAG;IAC3B,SAAS,CACP,IAAI,EAAE,+BAA+B,GAAG;QACtC;;;WAGG;QACH,MAAM,EAAE,CAAC,UAAU,CAAC,CAAA;KACrB,GACA,OAAO,CAAC,+BAA+B,CAAC,CAAA;CAC5C,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,oCAAoC;IACpC,GAAG,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAA;IAC5B,qCAAqC;IACrC,IAAI,CAAC,EAAE,eAAe,CAAC,MAAM,CAAC,CAAA;IAC9B,wCAAwC;IACxC,UAAU,CAAC,EAAE,eAAe,CAAC,YAAY,CAAC,CAAA;IAC1C,8CAA8C;IAC9C,UAAU,CAAC,EAAE,eAAe,CAAC,YAAY,CAAC,CAAA;IAC1C,kEAAkE;IAClE,OAAO,CAAC,EAAE,eAAe,CAAC,SAAS,CAAC,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,SAAS,CAClC,KAAK,EACL;IACE,YAAY,IAAI,OAAO,CAAC,YAAY,CAAC,CAAA;IACrC,SAAS,EAAE,qBAAqB,CAAC,WAAW,CAAC,CAAA;CAC9C,CACF,CAAA;AAED,MAAM,MAAM,qBAAqB,GAC7B,wBAAwB,GACxB,oBAAoB,GACpB,SAAS,CAAA;AAEb;;GAEG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,MAAM,EACZ,MAAM,GAAE,kBAAuB,GAC9B,YAAY,CA4Ed"}

package/_types/clients/transports/webSocket.d.ts

@@ -0,0 +1,52 @@
+import { type UrlRequiredErrorType } from '../../errors/transport.js';
+import type { ErrorType } from '../../errors/utils.js';
+import type { Hash } from '../../types/misc.js';
+import type { RpcResponse } from '../../types/rpc.js';
+import type { SocketRpcClient } from '../../utils/rpc/socket.js';
+import { type CreateTransportErrorType, type Transport, type TransportConfig } from './createTransport.js';
+type WebSocketTransportSubscribeParameters = {
+    onData: (data: RpcResponse) => void;
+    onError?: (error: any) => void;
+};
+type WebSocketTransportSubscribeReturnType = {
+    subscriptionId: Hash;
+    unsubscribe: () => Promise<RpcResponse<boolean>>;
+};
+type WebSocketTransportSubscribe = {
+    subscribe(args: WebSocketTransportSubscribeParameters & {
+        /**
+         * @description Add information about compiled contracts
+         * @link https://hardhat.org/hardhat-network/docs/reference#hardhat_addcompilationresult
+         */
+        params: ['newHeads'];
+    }): Promise<WebSocketTransportSubscribeReturnType>;
+};
+export type WebSocketTransportConfig = {
+    /** The key of the WebSocket transport. */
+    key?: TransportConfig['key'];
+    /** The name of the WebSocket transport. */
+    name?: TransportConfig['name'];
+    /** The max number of times to retry. */
+    retryCount?: TransportConfig['retryCount'];
+    /** The base delay (in ms) between retries. */
+    retryDelay?: TransportConfig['retryDelay'];
+    /** The timeout (in ms) for async WebSocket requests. Default: 10_000 */
+    timeout?: TransportConfig['timeout'];
+};
+export type WebSocketTransport = Transport<'webSocket', {
+    /**
+     * @deprecated use `getRpcClient` instead.
+     */
+    getSocket(): Promise<WebSocket>;
+    getRpcClient(): Promise<SocketRpcClient<WebSocket>>;
+    subscribe: WebSocketTransportSubscribe['subscribe'];
+}>;
+export type WebSocketTransportErrorType = CreateTransportErrorType | UrlRequiredErrorType | ErrorType;
+/**
+ * @description Creates a WebSocket transport that connects to a JSON-RPC API.
+ */
+export declare function webSocket(
+/** URL of the JSON-RPC API. Defaults to the chain's public RPC URL. */
+url?: string, config?: WebSocketTransportConfig): WebSocketTransport;
+export {};
+//# sourceMappingURL=webSocket.d.ts.map

package/_types/clients/transports/webSocket.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webSocket.d.ts","sourceRoot":"","sources":["../../../clients/transports/webSocket.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,KAAK,oBAAoB,EAC1B,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AACtD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAA;AAC/C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAErD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAEhE,OAAO,EACL,KAAK,wBAAwB,EAC7B,KAAK,SAAS,EACd,KAAK,eAAe,EAErB,MAAM,sBAAsB,CAAA;AAE7B,KAAK,qCAAqC,GAAG;IAC3C,MAAM,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,CAAA;IACnC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,CAAA;CAC/B,CAAA;AAED,KAAK,qCAAqC,GAAG;IAC3C,cAAc,EAAE,IAAI,CAAA;IACpB,WAAW,EAAE,MAAM,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAA;CACjD,CAAA;AAED,KAAK,2BAA2B,GAAG;IACjC,SAAS,CACP,IAAI,EAAE,qCAAqC,GAAG;QAC5C;;;WAGG;QACH,MAAM,EAAE,CAAC,UAAU,CAAC,CAAA;KACrB,GACA,OAAO,CAAC,qCAAqC,CAAC,CAAA;CAClD,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,0CAA0C;IAC1C,GAAG,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAA;IAC5B,2CAA2C;IAC3C,IAAI,CAAC,EAAE,eAAe,CAAC,MAAM,CAAC,CAAA;IAC9B,wCAAwC;IACxC,UAAU,CAAC,EAAE,eAAe,CAAC,YAAY,CAAC,CAAA;IAC1C,8CAA8C;IAC9C,UAAU,CAAC,EAAE,eAAe,CAAC,YAAY,CAAC,CAAA;IAC1C,wEAAwE;IACxE,OAAO,CAAC,EAAE,eAAe,CAAC,SAAS,CAAC,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,SAAS,CACxC,WAAW,EACX;IACE;;OAEG;IACH,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,CAAA;IAC/B,YAAY,IAAI,OAAO,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,CAAA;IACnD,SAAS,EAAE,2BAA2B,CAAC,WAAW,CAAC,CAAA;CACpD,CACF,CAAA;AAED,MAAM,MAAM,2BAA2B,GACnC,wBAAwB,GACxB,oBAAoB,GACpB,SAAS,CAAA;AAEb;;GAEG;AACH,wBAAgB,SAAS;AACvB,uEAAuE;AACvE,GAAG,CAAC,EAAE,MAAM,EACZ,MAAM,GAAE,wBAA6B,GACpC,kBAAkB,CAiFpB"}