feat: propagate transport rpc urls to connectors (#4162)

* feat: propagate transport rpc urls to connectors * tests: update snaps
wevm · Jul 23, 2024 · a73a773 · a73a773
1 parent 361fd58
commit a73a773
Show file tree

Hide file tree

Showing 9 changed files with 127 additions and 9 deletions.
diff --git a/.changeset/real-squids-add.md b/.changeset/real-squids-add.md
@@ -0,0 +1,8 @@
+---
+"@wagmi/connectors": minor
+"@wagmi/core": minor
+"wagmi": minor
+"@wagmi/vue": minor
+---
+
+Added functionality for consumer-defined RPC URLs (`config.transports`) to be propagated to the WalletConnect & MetaMask Connectors.
diff --git a/packages/connectors/src/metaMask.ts b/packages/connectors/src/metaMask.ts
@@ -7,6 +7,7 @@ import {
   ChainNotConfiguredError,
   type Connector,
   createConnector,
+  extractRpcUrls,
 } from '@wagmi/core'
 import type {
   Compute,
@@ -175,10 +176,13 @@ export function metaMask(parameters: MetaMaskParameters = {}) {
           // Workaround cast since MetaMask SDK does not support `'exactOptionalPropertyTypes'`
           ...(parameters as RemoveUndefined<typeof parameters>),
           readonlyRPCMap: Object.fromEntries(
-            config.chains.map((chain) => [
-              chain.id,
-              chain.rpcUrls.default.http[0]!,
-            ]),
+            config.chains.map((chain) => {
+              const [url] = extractRpcUrls({
+                chain,
+                transports: config.transports,
+              })
+              return [chain.id, url]
+            }),
           ),
           dappMetadata: parameters.dappMetadata ?? {},
           useDeeplink: parameters.useDeeplink ?? true,

diff --git a/packages/connectors/src/walletConnect.ts b/packages/connectors/src/walletConnect.ts
@@ -3,6 +3,7 @@ import {
   type Connector,
   ProviderNotFoundError,
   createConnector,
+  extractRpcUrls,
 } from '@wagmi/core'
 import type { Compute, ExactPartial, Omit } from '@wagmi/core/internal'
 import type { EthereumProvider } from '@walletconnect/ethereum-provider'
@@ -249,10 +250,13 @@ export function walletConnect(parameters: WalletConnectParameters) {
           optionalChains,
           projectId: parameters.projectId,
           rpcMap: Object.fromEntries(
-            config.chains.map((chain) => [
-              chain.id,
-              chain.rpcUrls.default.http[0]!,
-            ]),
+            config.chains.map((chain) => {
+              const [url] = extractRpcUrls({
+                chain,
+                transports: config.transports,
+              })
+              return [chain.id, url]
+            }),
           ),
           showQrModal: parameters.showQrModal ?? true,
         })

diff --git a/packages/core/src/connectors/createConnector.ts b/packages/core/src/connectors/createConnector.ts
@@ -7,6 +7,7 @@ import type {
   ProviderMessage,
 } from 'viem'
 
+import type { Transport } from '../createConfig.js'
 import type { Emitter } from '../createEmitter.js'
 import type { Storage } from '../createStorage.js'
 import type { Compute, ExactPartial, StrictOmit } from '../types/utils.js'
@@ -30,6 +31,7 @@ export type CreateConnectorFn<
   chains: readonly [Chain, ...Chain[]]
   emitter: Emitter<ConnectorEventMap>
   storage?: Compute<Storage<storageItem>> | null | undefined
+  transports?: Record<number, Transport> | undefined
 }) => Compute<
   {
     readonly icon?: string | undefined

diff --git a/packages/core/src/createConfig.ts b/packages/core/src/createConfig.ts
@@ -103,7 +103,12 @@ export function createConfig<
     // Set up emitter with uid and add to connector so they are "linked" together.
     const emitter = createEmitter<ConnectorEventMap>(uid())
     const connector = {
-      ...connectorFn({ emitter, chains: chains.getState(), storage }),
+      ...connectorFn({
+        emitter,
+        chains: chains.getState(),
+        storage,
+        transports: rest.transports,
+      }),
       emitter,
       uid: emitter.uid,
     }

diff --git a/packages/core/src/exports/index.test.ts b/packages/core/src/exports/index.test.ts
@@ -102,6 +102,7 @@ test('exports', () => {
       "parseCookie",
       "deepEqual",
       "deserialize",
+      "extractRpcUrls",
       "normalizeChainId",
       "serialize",
       "version",

diff --git a/packages/core/src/exports/index.ts b/packages/core/src/exports/index.ts
@@ -543,6 +543,8 @@ export { deepEqual } from '../utils/deepEqual.js'
 
 export { deserialize } from '../utils/deserialize.js'
 
+export { extractRpcUrls } from '../utils/extractRpcUrls.js'
+
 export { normalizeChainId } from '../utils/normalizeChainId.js'
 
 export { serialize } from '../utils/serialize.js'

diff --git a/packages/core/src/utils/extractRpcUrls.test.ts b/packages/core/src/utils/extractRpcUrls.test.ts
@@ -0,0 +1,73 @@
+import { http } from 'viem'
+import { mainnet, optimism, sepolia } from 'viem/chains'
+import { expect, test } from 'vitest'
+
+import { fallback } from '../transports/fallback.js'
+import { extractRpcUrls } from './extractRpcUrls.js'
+
+test('default', () => {
+  expect(
+    extractRpcUrls({
+      chain: mainnet,
+      transports: {
+        [mainnet.id]: fallback([
+          http('https://wagmi.com'),
+          http('https://lol.com'),
+        ]),
+        [sepolia.id]: http('https://sepoliarocks.com'),
+        [optimism.id]: http(),
+      },
+    }),
+  ).toMatchInlineSnapshot(`
+    [
+      "https://wagmi.com",
+      "https://lol.com",
+    ]
+  `)
+
+  expect(
+    extractRpcUrls({
+      chain: sepolia,
+      transports: {
+        [mainnet.id]: fallback([
+          http('https://wagmi.com'),
+          http('https://lol.com'),
+        ]),
+        [sepolia.id]: http('https://sepoliarocks.com'),
+        [optimism.id]: http(),
+      },
+    }),
+  ).toMatchInlineSnapshot(`
+    [
+      "https://sepoliarocks.com",
+    ]
+  `)
+
+  expect(
+    extractRpcUrls({
+      chain: optimism,
+      transports: {
+        [mainnet.id]: fallback([
+          http('https://wagmi.com'),
+          http('https://lol.com'),
+        ]),
+        [sepolia.id]: http('https://sepoliarocks.com'),
+        [optimism.id]: http(),
+      },
+    }),
+  ).toMatchInlineSnapshot(`
+    [
+      "https://mainnet.optimism.io",
+    ]
+  `)
+
+  expect(
+    extractRpcUrls({
+      chain: mainnet,
+    }),
+  ).toMatchInlineSnapshot(`
+    [
+      "https://cloudflare-eth.com",
+    ]
+  `)
+})
diff --git a/packages/core/src/utils/extractRpcUrls.ts b/packages/core/src/utils/extractRpcUrls.ts
@@ -0,0 +1,19 @@
+import type { Chain, Transport } from 'viem'
+
+type ExtractRpcUrlsParameters = {
+  transports?: Record<string, Transport> | undefined
+  chain: Chain
+}
+
+export function extractRpcUrls(parameters: ExtractRpcUrlsParameters) {
+  const { chain } = parameters
+  const fallbackUrl = chain.rpcUrls.default.http[0]
+
+  if (!parameters.transports) return [fallbackUrl]
+
+  const transport = parameters.transports?.[chain.id]?.({ chain })
+  const transports = transport?.value?.transports || [transport]
+  return transports.map(
+    ({ value }: { value: { url: string } }) => value.url || fallbackUrl,
+  )
+}