chore: up

Author: tmm

.changeset/walletconnect-switchchain-listener-leak.md

@@ -2,4 +2,4 @@
 "@wagmi/connectors": patch
 ---
 
-Fixed a listener leak in the WalletConnect connector's `switchChain` implementation. When a chain switch failed (user rejection, network error, or any other RPC error), the `change` event listener registered on the connector's emitter was not removed, causing it to accumulate across repeated failed attempts.
+Fixed listener leak in WalletConnect connector `switchChain` when chain switch fails.

packages/connectors/src/walletConnect.test.ts

@@ -13,12 +13,6 @@ import {
 
 import { walletConnect } from './walletConnect.js'
 
-vi.mock('@walletconnect/ethereum-provider', () => ({
-  EthereumProvider: {
-    init: vi.fn(),
-  },
-}))
-
 const handlers = [
   http.get('https://relay.walletconnect.com', async () =>
     HttpResponse.json(
@@ -71,36 +65,3 @@ test('setup', () => {
     string | undefined
   >()
 })
-
-test('behavior: removes change listener from emitter after switchChain fails', async () => {
-  const { EthereumProvider } = await import('@walletconnect/ethereum-provider')
-
-  const mockProvider = {
-    events: { setMaxListeners: vi.fn() },
-    on: vi.fn(),
-    off: vi.fn(),
-    once: vi.fn(),
-    removeListener: vi.fn(),
-    request: vi
-      .fn()
-      .mockRejectedValue(
-        Object.assign(new Error('User rejected the request.'), { code: 4001 }),
-      ),
-  }
-  vi.mocked(EthereumProvider.init).mockResolvedValue(mockProvider as any)
-
-  const connectorFn = walletConnect({ projectId: walletConnectProjectId })
-  const connector = config._internal.connectors.setup(connectorFn)
-
-  // Force provider initialization
-  await connector.getProvider()
-
-  const listenersBefore = connector.emitter.listenerCount('change')
-
-  await expect(
-    connector.switchChain!({ chainId: 1 }),
-  ).rejects.toThrow()
-
-  // The listener registered inside switchChain must be cleaned up on failure
-  expect(connector.emitter.listenerCount('change')).toBe(listenersBefore)
-})

packages/connectors/src/walletConnect.ts

@@ -338,21 +338,16 @@ export function walletConnect(parameters: WalletConnectParameters) {
       const chain = config.chains.find((x) => x.id === chainId)
       if (!chain) throw new SwitchChainError(new ChainNotConfiguredError())
 
-      let removeChangeListener: (() => void) | undefined
+      let listener: (opts: { chainId?: number | undefined }) => void = () => {}
       try {
         await Promise.all([
           new Promise<void>((resolve) => {
-            const listener = ({
-              chainId: currentChainId,
-            }: {
-              chainId?: number | undefined
-            }) => {
-              if (currentChainId === chainId) {
+            listener = (opts) => {
+              if (opts.chainId === chainId) {
                 config.emitter.off('change', listener)
                 resolve()
               }
             }
-            removeChangeListener = () => config.emitter.off('change', listener)
             config.emitter.on('change', listener)
           }),
           provider.request({
@@ -366,7 +361,7 @@ export function walletConnect(parameters: WalletConnectParameters) {
 
         return chain
       } catch (err) {
-        removeChangeListener?.()
+        config.emitter.off('change', listener)
         const error = err as RpcError
 
         if (/(user rejected)/i.test(error.message))