viem 2.4.1 → 2.6.0

package/_types/utils/rpc.d.ts

@@ -1,80 +0,0 @@
-import { type HttpRequestErrorType, type TimeoutErrorType, WebSocketRequestError } from '../errors/request.js';
-import type { ErrorType } from '../errors/utils.js';
-import { type CreateBatchSchedulerErrorType } from './promise/createBatchScheduler.js';
-import { type WithTimeoutErrorType } from './promise/withTimeout.js';
-type SuccessResult<T> = {
-    method?: never;
-    result: T;
-    error?: never;
-};
-type ErrorResult<T> = {
-    method?: never;
-    result?: never;
-    error: T;
-};
-type Subscription<TResult, TError> = {
-    method: 'eth_subscription';
-    error?: never;
-    result?: never;
-    params: {
-        subscription: string;
-    } & ({
-        result: TResult;
-        error?: never;
-    } | {
-        result?: never;
-        error: TError;
-    });
-};
-export type RpcRequest = {
-    method: string;
-    params?: any;
-    id?: number;
-};
-export type RpcResponse<TResult = any, TError = any> = {
-    jsonrpc: `${number}`;
-    id: number;
-} & (SuccessResult<TResult> | ErrorResult<TError> | Subscription<TResult, TError>);
-export type HttpOptions<TBody extends RpcRequest | RpcRequest[] = RpcRequest> = {
-    body: TBody;
-    fetchOptions?: Omit<RequestInit, 'body'>;
-    timeout?: number;
-};
-export type HttpReturnType<TBody extends RpcRequest | RpcRequest[] = RpcRequest> = TBody extends RpcRequest[] ? RpcResponse[] : RpcResponse;
-export type HttpErrorType = HttpRequestErrorType | TimeoutErrorType | WithTimeoutErrorType | ErrorType;
-declare function http<TBody extends RpcRequest | RpcRequest[]>(url: string, { body, fetchOptions, timeout }: HttpOptions<TBody>): Promise<HttpReturnType<TBody>>;
-type Id = string | number;
-type CallbackFn = (message: any) => void;
-type CallbackMap = Map<Id, CallbackFn>;
-export type Socket = WebSocket & {
-    requests: CallbackMap;
-    subscriptions: CallbackMap;
-};
-export type GetSocketErrorType = CreateBatchSchedulerErrorType | ErrorType;
-export declare const socketsCache: Map<string, Socket>;
-export declare function getSocket(url: string): Promise<Socket>;
-export type WebSocketOptions = {
-    /** The RPC request body. */
-    body: RpcRequest;
-    /** The callback to invoke on response. */
-    onResponse?: (message: RpcResponse) => void;
-};
-export type WebSocketReturnType = Socket;
-export type WebSocketErrorType = WebSocketRequestError | ErrorType;
-declare function webSocket(socket: Socket, { body, onResponse }: WebSocketOptions): WebSocketReturnType;
-export type WebSocketAsyncOptions = {
-    /** The RPC request body. */
-    body: RpcRequest;
-    /** The timeout (in ms) for the request. */
-    timeout?: number;
-};
-export type WebSocketAsyncReturnType = RpcResponse;
-export type WebSocketAsyncErrorType = WebSocketErrorType | TimeoutErrorType | WithTimeoutErrorType | ErrorType;
-declare function webSocketAsync(socket: Socket, { body, timeout }: WebSocketAsyncOptions): Promise<WebSocketAsyncReturnType>;
-export declare const rpc: {
-    http: typeof http;
-    webSocket: typeof webSocket;
-    webSocketAsync: typeof webSocketAsync;
-};
-export {};
-//# sourceMappingURL=rpc.d.ts.map

package/_types/utils/rpc.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"rpc.d.ts","sourceRoot":"","sources":["../../utils/rpc.ts"],"names":[],"mappings":"AAEA,OAAO,EAEL,KAAK,oBAAoB,EAEzB,KAAK,gBAAgB,EACrB,qBAAqB,EACtB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AACnD,OAAO,EACL,KAAK,6BAA6B,EAEnC,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EACL,KAAK,oBAAoB,EAE1B,MAAM,0BAA0B,CAAA;AAKjC,KAAK,aAAa,CAAC,CAAC,IAAI;IACtB,MAAM,CAAC,EAAE,KAAK,CAAA;IACd,MAAM,EAAE,CAAC,CAAA;IACT,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,CAAA;AACD,KAAK,WAAW,CAAC,CAAC,IAAI;IACpB,MAAM,CAAC,EAAE,KAAK,CAAA;IACd,MAAM,CAAC,EAAE,KAAK,CAAA;IACd,KAAK,EAAE,CAAC,CAAA;CACT,CAAA;AACD,KAAK,YAAY,CAAC,OAAO,EAAE,MAAM,IAAI;IACnC,MAAM,EAAE,kBAAkB,CAAA;IAC1B,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,MAAM,CAAC,EAAE,KAAK,CAAA;IACd,MAAM,EAAE;QACN,YAAY,EAAE,MAAM,CAAA;KACrB,GAAG,CACA;QACE,MAAM,EAAE,OAAO,CAAA;QACf,KAAK,CAAC,EAAE,KAAK,CAAA;KACd,GACD;QACE,MAAM,CAAC,EAAE,KAAK,CAAA;QACd,KAAK,EAAE,MAAM,CAAA;KACd,CACJ,CAAA;CACF,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,GAAG,CAAC;IAAC,EAAE,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA;AAEtE,MAAM,MAAM,WAAW,CAAC,OAAO,GAAG,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI;IACrD,OAAO,EAAE,GAAG,MAAM,EAAE,CAAA;IACpB,EAAE,EAAE,MAAM,CAAA;CACX,GAAG,CACA,aAAa,CAAC,OAAO,CAAC,GACtB,WAAW,CAAC,MAAM,CAAC,GACnB,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAChC,CAAA;AAKD,MAAM,MAAM,WAAW,CAAC,KAAK,SAAS,UAAU,GAAG,UAAU,EAAE,GAAG,UAAU,IAC1E;IAEE,IAAI,EAAE,KAAK,CAAA;IAEX,YAAY,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAA;IAExC,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAEH,MAAM,MAAM,cAAc,CACxB,KAAK,SAAS,UAAU,GAAG,UAAU,EAAE,GAAG,UAAU,IAClD,KAAK,SAAS,UAAU,EAAE,GAAG,WAAW,EAAE,GAAG,WAAW,CAAA;AAE5D,MAAM,MAAM,aAAa,GACrB,oBAAoB,GACpB,gBAAgB,GAChB,oBAAoB,GACpB,SAAS,CAAA;AAEb,iBAAe,IAAI,CAAC,KAAK,SAAS,UAAU,GAAG,UAAU,EAAE,EACzD,GAAG,EAAE,MAAM,EACX,EAAE,IAAI,EAAE,YAAiB,EAAE,OAAgB,EAAE,EAAE,WAAW,CAAC,KAAK,CAAC,GAChE,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CA2DhC;AAKD,KAAK,EAAE,GAAG,MAAM,GAAG,MAAM,CAAA;AACzB,KAAK,UAAU,GAAG,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,CAAA;AACxC,KAAK,WAAW,GAAG,GAAG,CAAC,EAAE,EAAE,UAAU,CAAC,CAAA;AAEtC,MAAM,MAAM,MAAM,GAAG,SAAS,GAAG;IAC/B,QAAQ,EAAE,WAAW,CAAA;IACrB,aAAa,EAAE,WAAW,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,6BAA6B,GAAG,SAAS,CAAA;AAE1E,eAAO,MAAM,YAAY,qBAA0C,CAAA;AAEnE,wBAAsB,SAAS,CAAC,GAAG,EAAE,MAAM,mBA2D1C;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,4BAA4B;IAC5B,IAAI,EAAE,UAAU,CAAA;IAChB,0CAA0C;IAC1C,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,IAAI,CAAA;CAC5C,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAA;AAExC,MAAM,MAAM,kBAAkB,GAAG,qBAAqB,GAAG,SAAS,CAAA;AAElE,iBAAS,SAAS,CAChB,MAAM,EAAE,MAAM,EACd,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,gBAAgB,GACrC,mBAAmB,CAoCrB;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,4BAA4B;IAC5B,IAAI,EAAE,UAAU,CAAA;IAChB,2CAA2C;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG,WAAW,CAAA;AAElD,MAAM,MAAM,uBAAuB,GAC/B,kBAAkB,GAClB,gBAAgB,GAChB,oBAAoB,GACpB,SAAS,CAAA;AAEb,iBAAe,cAAc,CAC3B,MAAM,EAAE,MAAM,EACd,EAAE,IAAI,EAAE,OAAgB,EAAE,EAAE,qBAAqB,GAChD,OAAO,CAAC,wBAAwB,CAAC,CAcnC;AAID,eAAO,MAAM,GAAG;;;;CAIf,CAAA"}

package/utils/rpc.ts

@@ -1,318 +0,0 @@
-import type { MessageEvent } from 'isows'
-
-import {
-  HttpRequestError,
-  type HttpRequestErrorType,
-  TimeoutError,
-  type TimeoutErrorType,
-  WebSocketRequestError,
-} from '../errors/request.js'
-import type { ErrorType } from '../errors/utils.js'
-import {
-  type CreateBatchSchedulerErrorType,
-  createBatchScheduler,
-} from './promise/createBatchScheduler.js'
-import {
-  type WithTimeoutErrorType,
-  withTimeout,
-} from './promise/withTimeout.js'
-import { stringify } from './stringify.js'
-
-let id = 0
-
-type SuccessResult<T> = {
-  method?: never
-  result: T
-  error?: never
-}
-type ErrorResult<T> = {
-  method?: never
-  result?: never
-  error: T
-}
-type Subscription<TResult, TError> = {
-  method: 'eth_subscription'
-  error?: never
-  result?: never
-  params: {
-    subscription: string
-  } & (
-    | {
-        result: TResult
-        error?: never
-      }
-    | {
-        result?: never
-        error: TError
-      }
-  )
-}
-
-export type RpcRequest = { method: string; params?: any; id?: number }
-
-export type RpcResponse<TResult = any, TError = any> = {
-  jsonrpc: `${number}`
-  id: number
-} & (
-  | SuccessResult<TResult>
-  | ErrorResult<TError>
-  | Subscription<TResult, TError>
-)
-
-///////////////////////////////////////////////////
-// HTTP
-
-export type HttpOptions<TBody extends RpcRequest | RpcRequest[] = RpcRequest> =
-  {
-    // The RPC request body.
-    body: TBody
-    // Request configuration to pass to `fetch`.
-    fetchOptions?: Omit<RequestInit, 'body'>
-    // The timeout (in ms) for the request.
-    timeout?: number
-  }
-
-export type HttpReturnType<
-  TBody extends RpcRequest | RpcRequest[] = RpcRequest,
-> = TBody extends RpcRequest[] ? RpcResponse[] : RpcResponse
-
-export type HttpErrorType =
-  | HttpRequestErrorType
-  | TimeoutErrorType
-  | WithTimeoutErrorType
-  | ErrorType
-
-async function http<TBody extends RpcRequest | RpcRequest[]>(
-  url: string,
-  { body, fetchOptions = {}, timeout = 10_000 }: HttpOptions<TBody>,
-): Promise<HttpReturnType<TBody>> {
-  const { headers, method, signal: signal_ } = fetchOptions
-  try {
-    const response = await withTimeout(
-      async ({ signal }) => {
-        const response = await fetch(url, {
-          ...fetchOptions,
-          body: Array.isArray(body)
-            ? stringify(
-                body.map((body) => ({
-                  jsonrpc: '2.0',
-                  id: body.id ?? id++,
-                  ...body,
-                })),
-              )
-            : stringify({ jsonrpc: '2.0', id: body.id ?? id++, ...body }),
-          headers: {
-            ...headers,
-            'Content-Type': 'application/json',
-          },
-          method: method || 'POST',
-          signal: signal_ || (timeout > 0 ? signal : undefined),
-        })
-        return response
-      },
-      {
-        errorInstance: new TimeoutError({ body, url }),
-        timeout,
-        signal: true,
-      },
-    )
-
-    let data: any
-    if (response.headers.get('Content-Type')?.startsWith('application/json')) {
-      data = await response.json()
-    } else {
-      data = await response.text()
-    }
-
-    if (!response.ok) {
-      throw new HttpRequestError({
-        body,
-        details: stringify(data.error) || response.statusText,
-        headers: response.headers,
-        status: response.status,
-        url,
-      })
-    }
-
-    return data
-  } catch (err) {
-    if (err instanceof HttpRequestError) throw err
-    if (err instanceof TimeoutError) throw err
-    throw new HttpRequestError({
-      body,
-      details: (err as Error).message,
-      url,
-    })
-  }
-}
-
-///////////////////////////////////////////////////
-// WebSocket
-
-type Id = string | number
-type CallbackFn = (message: any) => void
-type CallbackMap = Map<Id, CallbackFn>
-
-export type Socket = WebSocket & {
-  requests: CallbackMap
-  subscriptions: CallbackMap
-}
-
-export type GetSocketErrorType = CreateBatchSchedulerErrorType | ErrorType
-
-export const socketsCache = /*#__PURE__*/ new Map<string, Socket>()
-
-export async function getSocket(url: string) {
-  let socket = socketsCache.get(url)
-
-  // If the socket already exists, return it.
-  if (socket) return socket
-
-  const { schedule } = createBatchScheduler<undefined, [Socket]>({
-    id: url,
-    fn: async () => {
-      const WebSocket = await import('isows').then((module) => module.WebSocket)
-      const webSocket = new WebSocket(url)
-
-      // Set up a cache for incoming "synchronous" requests.
-      const requests = new Map<Id, CallbackFn>()
-
-      // Set up a cache for subscriptions (eth_subscribe).
-      const subscriptions = new Map<Id, CallbackFn>()
-
-      const onMessage: (event: MessageEvent) => void = ({ data }) => {
-        const message: RpcResponse = JSON.parse(data as string)
-        const isSubscription = message.method === 'eth_subscription'
-        const id = isSubscription ? message.params.subscription : message.id
-        const cache = isSubscription ? subscriptions : requests
-        const callback = cache.get(id)
-        if (callback) callback({ data })
-        if (!isSubscription) cache.delete(id)
-      }
-      const onClose = () => {
-        socketsCache.delete(url)
-        webSocket.removeEventListener('close', onClose)
-        webSocket.removeEventListener('message', onMessage)
-      }
-
-      // Setup event listeners for RPC & subscription responses.
-      webSocket.addEventListener('close', onClose)
-      webSocket.addEventListener('message', onMessage)
-
-      // Wait for the socket to open.
-      if (webSocket.readyState === WebSocket.CONNECTING) {
-        await new Promise((resolve, reject) => {
-          if (!webSocket) return
-          webSocket.onopen = resolve
-          webSocket.onerror = reject
-        })
-      }
-
-      // Create a new socket instance.
-      socket = Object.assign(webSocket, {
-        requests,
-        subscriptions,
-      })
-      socketsCache.set(url, socket)
-
-      return [socket]
-    },
-  })
-
-  const [_, [socket_]] = await schedule()
-  return socket_
-}
-
-export type WebSocketOptions = {
-  /** The RPC request body. */
-  body: RpcRequest
-  /** The callback to invoke on response. */
-  onResponse?: (message: RpcResponse) => void
-}
-
-export type WebSocketReturnType = Socket
-
-export type WebSocketErrorType = WebSocketRequestError | ErrorType
-
-function webSocket(
-  socket: Socket,
-  { body, onResponse }: WebSocketOptions,
-): WebSocketReturnType {
-  if (
-    socket.readyState === socket.CLOSED ||
-    socket.readyState === socket.CLOSING
-  )
-    throw new WebSocketRequestError({
-      body,
-      url: socket.url,
-      details: 'Socket is closed.',
-    })
-
-  const id_ = id++
-
-  const callback = ({ data }: { data: any }) => {
-    const message: RpcResponse = JSON.parse(data)
-
-    if (typeof message.id === 'number' && id_ !== message.id) return
-
-    onResponse?.(message)
-
-    // If we are subscribing to a topic, we want to set up a listener for incoming
-    // messages.
-    if (body.method === 'eth_subscribe' && typeof message.result === 'string') {
-      socket.subscriptions.set(message.result, callback)
-    }
-
-    // If we are unsubscribing from a topic, we want to remove the listener.
-    if (body.method === 'eth_unsubscribe') {
-      socket.subscriptions.delete(body.params?.[0])
-    }
-  }
-  socket.requests.set(id_, callback)
-
-  socket.send(JSON.stringify({ jsonrpc: '2.0', ...body, id: id_ }))
-
-  return socket
-}
-
-export type WebSocketAsyncOptions = {
-  /** The RPC request body. */
-  body: RpcRequest
-  /** The timeout (in ms) for the request. */
-  timeout?: number
-}
-
-export type WebSocketAsyncReturnType = RpcResponse
-
-export type WebSocketAsyncErrorType =
-  | WebSocketErrorType
-  | TimeoutErrorType
-  | WithTimeoutErrorType
-  | ErrorType
-
-async function webSocketAsync(
-  socket: Socket,
-  { body, timeout = 10_000 }: WebSocketAsyncOptions,
-): Promise<WebSocketAsyncReturnType> {
-  return withTimeout(
-    () =>
-      new Promise<RpcResponse>((onResponse) =>
-        rpc.webSocket(socket, {
-          body,
-          onResponse,
-        }),
-      ),
-    {
-      errorInstance: new TimeoutError({ body, url: socket.url }),
-      timeout,
-    },
-  )
-}
-
-///////////////////////////////////////////////////
-
-export const rpc = {
-  http,
-  webSocket,
-  webSocketAsync,
-}