feat: support multiple rdns to filter 6963 providers (#4406)

* feat: support multiple rdns values to prevent duplicate connectors * chore: tweaks --------- Co-authored-by: Saurabh Chauhan <[email protected]>
wevm · Nov 13, 2024 · a13aa8d · a13aa8d
1 parent e9ca469
commit a13aa8d
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 9 deletions.
diff --git a/.changeset/quick-pans-grow.md b/.changeset/quick-pans-grow.md
@@ -0,0 +1,5 @@
+---
+"@wagmi/core": patch
+---
+
+Added support for multiple connector `rdns` entries.
diff --git a/.changeset/wild-guests-tell.md b/.changeset/wild-guests-tell.md
@@ -0,0 +1,5 @@
+---
+"@wagmi/connectors": patch
+---
+
+Added additional RDNS to MetaMask Connector.
diff --git a/packages/connectors/src/metaMask.ts b/packages/connectors/src/metaMask.ts
@@ -95,7 +95,7 @@ export function metaMask(parameters: MetaMaskParameters = {}) {
   return createConnector<Provider, Properties>((config) => ({
     id: 'metaMaskSDK',
     name: 'MetaMask',
-    rdns: 'io.metamask',
+    rdns: ['io.metamask', 'io.metamask.mobile'],
     type: metaMask.type,
     async setup() {
       const provider = await this.getProvider()

diff --git a/packages/core/src/connectors/createConnector.ts b/packages/core/src/connectors/createConnector.ts
@@ -37,7 +37,7 @@ export type CreateConnectorFn<
     readonly icon?: string | undefined
     readonly id: string
     readonly name: string
-    readonly rdns?: string | undefined
+    readonly rdns?: string | readonly string[] | undefined
     readonly supportsSimulation?: boolean | undefined
     readonly type: string
 

diff --git a/packages/core/src/createConfig.test.ts b/packages/core/src/createConfig.test.ts
@@ -394,7 +394,7 @@ test('behavior: eip 6963 providers', async () => {
       createConnector((c) => {
         return {
           ...mock({ accounts })(c),
-          rdns: 'com.mock',
+          rdns: ['com.mock', 'com.baz'],
         }
       }),
     ],
@@ -413,9 +413,12 @@ test('behavior: eip 6963 providers', async () => {
   announceProvider(detail_3)()
   await wait(100)
 
-  expect(config.connectors.map((x) => x.rdns ?? x.id)).toMatchInlineSnapshot(`
+  expect(
+    config.connectors.flatMap((x) => x.rdns ?? x.id),
+  ).toMatchInlineSnapshot(`
     [
       "com.mock",
+      "com.baz",
       "com.example",
       "com.foo",
       "com.bar",

diff --git a/packages/core/src/createConfig.ts b/packages/core/src/createConfig.ts
@@ -98,7 +98,13 @@ export function createConfig<
     for (const connectorFns of rest.connectors ?? []) {
       const connector = setup(connectorFns)
       collection.push(connector)
-      if (!ssr && connector.rdns) rdnsSet.add(connector.rdns)
+      if (!ssr && connector.rdns) {
+        const rdnsValues =
+          typeof connector.rdns === 'string' ? [connector.rdns] : connector.rdns
+        for (const rdns of rdnsValues) {
+          rdnsSet.add(rdns)
+        }
+      }
     }
     if (!ssr && mipd) {
       const providers = mipd.getProviders()
@@ -323,11 +329,17 @@ export function createConfig<
 
   // EIP-6963 subscribe for new wallet providers
   mipd?.subscribe((providerDetails) => {
-    const connectorIdSet = new Set()
-    const connectorRdnsSet = new Set()
+    const connectorIdSet = new Set<string>()
+    const connectorRdnsSet = new Set<string>()
     for (const connector of connectors.getState()) {
       connectorIdSet.add(connector.id)
-      if (connector.rdns) connectorRdnsSet.add(connector.rdns)
+      if (connector.rdns) {
+        const rdnsValues =
+          typeof connector.rdns === 'string' ? [connector.rdns] : connector.rdns
+        for (const rdns of rdnsValues) {
+          connectorRdnsSet.add(rdns)
+        }
+      }
     }
 
     const newConnectors: Connector[] = []

diff --git a/packages/core/src/hydrate.ts b/packages/core/src/hydrate.ts
@@ -27,7 +27,14 @@ export function hydrate(config: Config, parameters: HydrateParameters) {
           config._internal.connectors.setState((connectors) => {
             const rdnsSet = new Set<string>()
             for (const connector of connectors ?? []) {
-              if (connector.rdns) rdnsSet.add(connector.rdns)
+              if (connector.rdns) {
+                const rdnsValues = Array.isArray(connector.rdns)
+                  ? connector.rdns
+                  : [connector.rdns]
+                for (const rdns of rdnsValues) {
+                  rdnsSet.add(rdns)
+                }
+              }
             }
             const mipdConnectors = []
             const providers = config._internal.mipd?.getProviders() ?? []