viem 2.9.9 → 2.9.12

package/utils/rpc/ipc.ts

@@ -1,11 +1,17 @@
 import { type Socket as NetSocket, connect } from 'node:net'
 import { WebSocketRequestError } from '../../index.js'
 import {
+  type GetSocketRpcClientParameters,
   type Socket,
   type SocketRpcClient,
   getSocketRpcClient,
 } from './socket.js'
 
+export type GetIpcRpcClientOptions = Pick<
+  GetSocketRpcClientParameters,
+  'reconnect'
+>
+
 const openingBrace = '{'.charCodeAt(0)
 const closingBrace = '}'.charCodeAt(0)
 
@@ -33,14 +39,21 @@ export function extractMessages(buffer: Buffer): [Buffer[], Buffer] {
 
 export type IpcRpcClient = SocketRpcClient<NetSocket>
 
-export async function getIpcRpcClient(path: string): Promise<IpcRpcClient> {
+export async function getIpcRpcClient(
+  path: string,
+  options: GetIpcRpcClientOptions = {},
+): Promise<IpcRpcClient> {
+  const { reconnect } = options
+
   return getSocketRpcClient({
-    async getSocket({ onResponse }) {
+    async getSocket({ onError, onOpen, onResponse }) {
       const socket = connect(path)
 
       function onClose() {
         socket.off('close', onClose)
         socket.off('message', onData)
+        socket.off('error', onError)
+        socket.off('connect', onOpen)
       }
 
       let lastRemaining = Buffer.alloc(0)
@@ -57,6 +70,8 @@ export async function getIpcRpcClient(path: string): Promise<IpcRpcClient> {
 
       socket.on('close', onClose)
       socket.on('data', onData)
+      socket.on('error', onError)
+      socket.on('connect', onOpen)
 
       // Wait for the socket to open.
       await new Promise<void>((resolve, reject) => {
@@ -84,6 +99,7 @@ export async function getIpcRpcClient(path: string): Promise<IpcRpcClient> {
         },
       } as Socket<{}>)
     },
+    reconnect,
     url: path,
   })
 }

package/utils/rpc/socket.ts

@@ -9,10 +9,15 @@ import { withTimeout } from '../promise/withTimeout.js'
 import { idCache } from './id.js'
 
 type Id = string | number
-type CallbackFn = (message: any) => void
+type CallbackFn = {
+  onResponse: (message: any) => void
+  onError?: ((error?: Error | Event | undefined) => void) | undefined
+}
 type CallbackMap = Map<Id, CallbackFn>
 
 export type GetSocketParameters = {
+  onError: (error?: Error | Event | undefined) => void
+  onOpen: () => void
   onResponse: (data: RpcResponse) => void
 }
 
@@ -28,7 +33,7 @@ export type SocketRpcClient<socket extends {}> = {
   socket: Socket<socket>
   request(params: {
     body: RpcRequest
-    onError?: ((error: Error) => void) | undefined
+    onError?: ((error?: Error | Event | undefined) => void) | undefined
     onResponse: (message: RpcResponse) => void
   }): void
   requestAsync(params: {
@@ -40,9 +45,28 @@ export type SocketRpcClient<socket extends {}> = {
   url: string
 }
 
-export type GetSocketRpcClientParameters<socket extends {}> = {
-  url: string
+export type GetSocketRpcClientParameters<socket extends {} = {}> = {
   getSocket(params: GetSocketParameters): Promise<Socket<socket>>
+  /**
+   * Whether or not to attempt to reconnect on socket failure.
+   * @default true
+   */
+  reconnect?:
+    | boolean
+    | {
+        /**
+         * The maximum number of reconnection attempts.
+         * @default 5
+         */
+        attempts?: number | undefined
+        /**
+         * The delay (in ms) between reconnection attempts.
+         * @default 2_000
+         */
+        delay?: number | undefined
+      }
+    | undefined
+  url: string
 }
 
 export type GetSocketRpcClientErrorType =
@@ -57,13 +81,16 @@ export const socketClientCache = /*#__PURE__*/ new Map<
 export async function getSocketRpcClient<socket extends {}>(
   params: GetSocketRpcClientParameters<socket>,
 ): Promise<SocketRpcClient<socket>> {
-  const { getSocket, url } = params
+  const { getSocket, reconnect = true, url } = params
+  const { attempts = 5, delay = 2_000 } =
+    typeof reconnect === 'object' ? reconnect : {}
 
   let socketClient = socketClientCache.get(url)
 
   // If the socket already exists, return it.
   if (socketClient) return socketClient as {} as SocketRpcClient<socket>
 
+  let reconnectCount = 0
   const { schedule } = createBatchScheduler<
     undefined,
     [SocketRpcClient<socket>]
@@ -76,17 +103,46 @@ export async function getSocketRpcClient<socket extends {}>(
       // Set up a cache for subscriptions (eth_subscribe).
       const subscriptions = new Map<Id, CallbackFn>()
 
+      let error: Error | Event | undefined
+      let socket: Socket<any>
       // Set up socket implementation.
-      const socket = await getSocket({
-        onResponse(data) {
-          const isSubscription = data.method === 'eth_subscription'
-          const id = isSubscription ? data.params.subscription : data.id
-          const cache = isSubscription ? subscriptions : requests
-          const callback = cache.get(id)
-          if (callback) callback(data)
-          if (!isSubscription) cache.delete(id)
-        },
-      })
+      async function setup() {
+        return getSocket({
+          onError(error_) {
+            error = error_
+
+            // Notify all requests and subscriptions of the error.
+            for (const request of requests.values()) request.onError?.(error)
+            for (const subscription of subscriptions.values())
+              subscription.onError?.(error)
+
+            // Clear all requests and subscriptions.
+            requests.clear()
+            subscriptions.clear()
+
+            // Attempt to reconnect.
+            if (reconnect && reconnectCount < attempts)
+              setTimeout(async () => {
+                reconnectCount++
+                socket = await setup().catch(console.error)
+              }, delay)
+          },
+          onOpen() {
+            error = undefined
+            reconnectCount = 0
+          },
+          onResponse(data) {
+            const isSubscription = data.method === 'eth_subscription'
+            const id = isSubscription ? data.params.subscription : data.id
+            const cache = isSubscription ? subscriptions : requests
+            const callback = cache.get(id)
+            if (callback) callback.onResponse(data)
+            if (!isSubscription) cache.delete(id)
+          },
+        })
+      }
+      socket = await setup()
+      error = undefined
 
       // Create a new socket instance.
       socketClient = {
@@ -96,6 +152,8 @@ export async function getSocketRpcClient<socket extends {}>(
         },
         socket,
         request({ body, onError, onResponse }) {
+          if (error && onError) onError(error)
+
           const id = body.id ?? idCache.take()
 
           const callback = (response: RpcResponse) => {
@@ -107,18 +165,19 @@ export async function getSocketRpcClient<socket extends {}>(
               body.method === 'eth_subscribe' &&
               typeof response.result === 'string'
             )
-              subscriptions.set(response.result, callback)
+              subscriptions.set(response.result, {
+                onResponse: callback,
+                onError,
+              })
 
             // If we are unsubscribing from a topic, we want to remove the listener.
             if (body.method === 'eth_unsubscribe')
               subscriptions.delete(body.params?.[0])
 
             onResponse(response)
-
-            // TODO: delete request?
           }
 
-          requests.set(id, callback)
+          requests.set(id, { onResponse: callback, onError })
           try {
             socket.request({
               body: {

package/utils/rpc/webSocket.ts

@@ -2,22 +2,33 @@ import type { MessageEvent } from 'isows'
 
 import { WebSocketRequestError } from '../../errors/request.js'
 import {
+  type GetSocketRpcClientParameters,
   type Socket,
   type SocketRpcClient,
   getSocketRpcClient,
 } from './socket.js'
 
+export type GetWebSocketRpcClientOptions = Pick<
+  GetSocketRpcClientParameters,
+  'reconnect'
+>
+
 export async function getWebSocketRpcClient(
   url: string,
+  options: GetWebSocketRpcClientOptions | undefined = {},
 ): Promise<SocketRpcClient<WebSocket>> {
+  const { reconnect } = options
+
   return getSocketRpcClient({
-    async getSocket({ onResponse }) {
+    async getSocket({ onError, onOpen, onResponse }) {
       const WebSocket = await import('isows').then((module) => module.WebSocket)
       const socket = new WebSocket(url)
 
       function onClose() {
         socket.removeEventListener('close', onClose)
         socket.removeEventListener('message', onMessage)
+        socket.removeEventListener('error', onError)
+        socket.removeEventListener('open', onOpen)
       }
       function onMessage({ data }: MessageEvent) {
         onResponse(JSON.parse(data))
@@ -26,6 +37,8 @@ export async function getWebSocketRpcClient(
       // Setup event listeners for RPC & subscription responses.
       socket.addEventListener('close', onClose)
       socket.addEventListener('message', onMessage)
+      socket.addEventListener('error', onError)
+      socket.addEventListener('open', onOpen)
 
       // Wait for the socket to open.
       if (socket.readyState === WebSocket.CONNECTING) {
@@ -58,6 +71,7 @@ export async function getWebSocketRpcClient(
         },
       } as Socket<WebSocket>)
     },
+    reconnect,
     url,
   })
 }

package/_cjs/experimental/actions/getCallsReceipt.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getCallsReceipt.js","sourceRoot":"","sources":["../../../experimental/actions/getCallsReceipt.ts"],"names":[],"mappings":";;;AAQA,gEAA6D;AAC7D,wFAA8E;AA8BvE,KAAK,UAAU,eAAe,CAInC,MAAyC,EACzC,UAAqC;IAErC,MAAM,EAAE,EAAE,EAAE,GAAG,UAAU,CAAA;IACzB,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAChD,MAAM,EAAE,wBAAwB;QAChC,MAAM,EAAE,EAAE;KACX,CAAC,CAAA;IACF,OAAO;QACL,MAAM;QACN,QAAQ,EACN,QAAQ,EAAE,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YAC1B,GAAG,OAAO;YACV,WAAW,EAAE,IAAA,wBAAW,EAAC,OAAO,CAAC,WAAW,CAAC;YAC7C,OAAO,EAAE,IAAA,wBAAW,EAAC,OAAO,CAAC,OAAO,CAAC;YACrC,MAAM,EAAE,uCAAe,CAAC,OAAO,CAAC,MAAuB,CAAC;SACzD,CAAC,CAAC,IAAI,EAAE;KACZ,CAAA;AACH,CAAC;AAtBD,0CAsBC"}

package/_esm/experimental/actions/getCallsReceipt.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getCallsReceipt.js","sourceRoot":"","sources":["../../../experimental/actions/getCallsReceipt.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAA;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,8CAA8C,CAAA;AAU9E;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAInC,MAAyC,EACzC,UAAqC;IAErC,MAAM,EAAE,EAAE,EAAE,GAAG,UAAU,CAAA;IACzB,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAChD,MAAM,EAAE,wBAAwB;QAChC,MAAM,EAAE,EAAE;KACX,CAAC,CAAA;IACF,OAAO;QACL,MAAM;QACN,QAAQ,EACN,QAAQ,EAAE,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YAC1B,GAAG,OAAO;YACV,WAAW,EAAE,WAAW,CAAC,OAAO,CAAC,WAAW,CAAC;YAC7C,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC;YACrC,MAAM,EAAE,eAAe,CAAC,OAAO,CAAC,MAAuB,CAAC;SACzD,CAAC,CAAC,IAAI,EAAE;KACZ,CAAA;AACH,CAAC"}

package/_types/experimental/actions/getCallsReceipt.d.ts

@@ -1,35 +0,0 @@
-import type { Client } from '../../clients/createClient.js';
-import type { Transport } from '../../clients/transports/createTransport.js';
-import type { ErrorType } from '../../errors/utils.js';
-import type { Account } from '../../types/account.js';
-import type { Chain } from '../../types/chain.js';
-import type { WalletGetCallsReceiptReturnType } from '../../types/eip1193.js';
-import type { Prettify } from '../../types/utils.js';
-import type { RequestErrorType } from '../../utils/buildRequest.js';
-export type GetCallsReceiptParameters = {
-    id: string;
-};
-export type GetCallsReceiptReturnType = Prettify<WalletGetCallsReceiptReturnType<bigint, 'success' | 'reverted'>>;
-export type GetCallsReceiptErrorType = RequestErrorType | ErrorType;
-/**
- * Returns the status of a call batch that was sent via `sendCalls`.
- *
- * - Docs: https://viem.sh/experimental/actions/getCallsReceipt
- * - JSON-RPC Methods: [`wallet_getCallsReceipt`](https://eips.ethereum.org/EIPS/eip-5792)
- *
- * @param client - Client to use
- * @returns Status of the calls. {@link GetCallsReceiptReturnType}
- *
- * @example
- * import { createWalletClient, custom } from 'viem'
- * import { mainnet } from 'viem/chains'
- * import { getCallsReceipt } from 'viem/wallet'
- *
- * const client = createWalletClient({
- *   chain: mainnet,
- *   transport: custom(window.ethereum),
- * })
- * const { receipts, status } = await getCallsReceipt(client, { id: '0xdeadbeef' })
- */
-export declare function getCallsReceipt<chain extends Chain | undefined, account extends Account | undefined = undefined>(client: Client<Transport, chain, account>, parameters: GetCallsReceiptParameters): Promise<GetCallsReceiptReturnType>;
-//# sourceMappingURL=getCallsReceipt.d.ts.map

package/_types/experimental/actions/getCallsReceipt.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getCallsReceipt.d.ts","sourceRoot":"","sources":["../../../experimental/actions/getCallsReceipt.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,6CAA6C,CAAA;AAC5E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AACrD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,wBAAwB,CAAA;AAC7E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AACpD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AAInE,MAAM,MAAM,yBAAyB,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAA;AAEtD,MAAM,MAAM,yBAAyB,GAAG,QAAQ,CAC9C,+BAA+B,CAAC,MAAM,EAAE,SAAS,GAAG,UAAU,CAAC,CAChE,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG,gBAAgB,GAAG,SAAS,CAAA;AAEnE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,eAAe,CACnC,KAAK,SAAS,KAAK,GAAG,SAAS,EAC/B,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,SAAS,EAE/C,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,EACzC,UAAU,EAAE,yBAAyB,GACpC,OAAO,CAAC,yBAAyB,CAAC,CAgBpC"}