feat: bump mm sdk (#4337)

* feat: update metamask sdk and implement connectSign * feat: cleanup * feat: cleanup * sdk 0.29.1 * feat: cleanup * feat: url default * feat: prevent breaking changes * feat: cleanup * chore: tweaks * chore: tweaks * chore: format * chore: changeset --------- Co-authored-by: abretonc7s <[email protected]> Co-authored-by: tmm <[email protected]>
wevm · Oct 15, 2024 · 34a0c3b · 34a0c3b
1 parent 7282143
commit 34a0c3b
Show file tree

Hide file tree

Showing 6 changed files with 263 additions and 187 deletions.
diff --git a/.changeset/purple-hotels-smell.md b/.changeset/purple-hotels-smell.md
@@ -0,0 +1,5 @@
+---
+"@wagmi/connectors": minor
+---
+
+Added "Connect and Sign" behavior to MetaMask Connector.
diff --git a/package.json b/package.json
@@ -57,7 +57,7 @@
     "publint": "^0.2.11",
     "sherif": "^1.0.0",
     "simple-git-hooks": "^2.11.1",
-    "typescript": "5.5.2",
+    "typescript": "5.5.4",
     "viem": "2.17.0",
     "vitest": "^2.1.1"
   },

diff --git a/packages/connectors/package.json b/packages/connectors/package.json
@@ -46,7 +46,7 @@
   },
   "dependencies": {
     "@coinbase/wallet-sdk": "4.0.4",
-    "@metamask/sdk": "0.28.4",
+    "@metamask/sdk": "0.29.2",
     "@safe-global/safe-apps-provider": "0.18.3",
     "@safe-global/safe-apps-sdk": "9.1.0",
     "@walletconnect/ethereum-provider": "2.17.0",

diff --git a/packages/connectors/src/metaMask.ts b/packages/connectors/src/metaMask.ts
@@ -12,7 +12,9 @@ import {
 import type {
   Compute,
   ExactPartial,
+  OneOf,
   RemoveUndefined,
+  UnionCompute,
 } from '@wagmi/core/internal'
 import {
   type AddEthereumChainParameter,
@@ -31,8 +33,42 @@ import {
   withTimeout,
 } from 'viem'
 
-export type MetaMaskParameters = Compute<
-  ExactPartial<Omit<MetaMaskSDKOptions, '_source' | 'readonlyRPCMap'>>
+export type MetaMaskParameters = UnionCompute<
+  WagmiMetaMaskSDKOptions &
+    OneOf<
+      | {
+          /* Shortcut to connect and sign a message */
+          connectAndSign?: string | undefined
+        }
+      | {
+          // TODO: Strongly type `method` and `params`
+          /* Allow `connectWith` any rpc method */
+          connectWith?: { method: string; params: unknown[] } | undefined
+        }
+    >
+>
+
+type WagmiMetaMaskSDKOptions = Compute<
+  ExactPartial<
+    Omit<
+      MetaMaskSDKOptions,
+      | '_source'
+      | 'forceDeleteProvider'
+      | 'forceInjectProvider'
+      | 'injectProvider'
+      | 'useDeeplink'
+      | 'readonlyRPCMap'
+    >
+  > & {
+    /** @deprecated */
+    forceDeleteProvider?: MetaMaskSDKOptions['forceDeleteProvider']
+    /** @deprecated */
+    forceInjectProvider?: MetaMaskSDKOptions['forceInjectProvider']
+    /** @deprecated */
+    injectProvider?: MetaMaskSDKOptions['injectProvider']
+    /** @deprecated */
+    useDeeplink?: MetaMaskSDKOptions['useDeeplink']
+  }
 >
 
 metaMask.type = 'metaMask' as const
@@ -76,11 +112,26 @@ export function metaMask(parameters: MetaMaskParameters = {}) {
       if (isReconnecting) accounts = await this.getAccounts().catch(() => [])
 
       try {
+        let signResponse: string | undefined
+        let connectWithResponse: unknown | undefined
         if (!accounts?.length) {
-          const requestedAccounts = (await sdk.connect()) as string[]
-          accounts = requestedAccounts.map((x) => getAddress(x))
-        }
+          if (parameters.connectAndSign || parameters.connectWith) {
+            if (parameters.connectAndSign)
+              signResponse = await sdk.connectAndSign({
+                msg: parameters.connectAndSign,
+              })
+            else if (parameters.connectWith)
+              connectWithResponse = await sdk.connectWith({
+                method: parameters.connectWith.method,
+                params: parameters.connectWith.params,
+              })
 
+            accounts = await this.getAccounts()
+          } else {
+            const requestedAccounts = (await sdk.connect()) as string[]
+            accounts = requestedAccounts.map((x) => getAddress(x))
+          }
+        }
         // Switch to chain if provided
         let currentChainId = (await this.getChainId()) as number
         if (chainId && currentChainId !== chainId) {
@@ -96,6 +147,19 @@ export function metaMask(parameters: MetaMaskParameters = {}) {
           displayUri = undefined
         }
 
+        if (signResponse)
+          provider.emit('connectAndSign', {
+            accounts,
+            chainId: currentChainId,
+            signResponse,
+          })
+        else if (connectWithResponse)
+          provider.emit('connectWith', {
+            accounts,
+            chainId: currentChainId,
+            connectWithResponse,
+          })
+
         // Manage EIP-1193 event listeners
         // https://eips.ethereum.org/EIPS/eip-1193#events
         if (connect) {
@@ -175,6 +239,9 @@ export function metaMask(parameters: MetaMaskParameters = {}) {
 
         sdk = new MetaMaskSDK({
           _source: 'wagmi',
+          forceDeleteProvider: false,
+          forceInjectProvider: false,
+          injectProvider: false,
           // Workaround cast since MetaMask SDK does not support `'exactOptionalPropertyTypes'`
           ...(parameters as RemoveUndefined<typeof parameters>),
           readonlyRPCMap: Object.fromEntries(
@@ -186,7 +253,11 @@ export function metaMask(parameters: MetaMaskParameters = {}) {
               return [chain.id, url]
             }),
           ),
-          dappMetadata: parameters.dappMetadata ?? { name: 'wagmi' },
+          dappMetadata:
+            parameters.dappMetadata ??
+            (typeof window !== 'undefined'
+              ? { url: window.location.origin }
+              : { name: 'wagmi' }),
           useDeeplink: parameters.useDeeplink ?? true,
         })
         await sdk.init()