feat: update metamask sdk and implement connectSign

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",

packages/connectors/src/metaMask.ts

@@ -31,10 +31,17 @@ import {
   withTimeout,
 } from 'viem'
 
-export type MetaMaskParameters = Compute<
+type WagmiMetaMaskSDKOptions = Compute<
   ExactPartial<Omit<MetaMaskSDKOptions, '_source' | 'readonlyRPCMap'>>
 >
 
+export type MetaMaskParameters = WagmiMetaMaskSDKOptions & {
+  // Shortcut to connect and sign a message
+  connectAndSign?: string | undefined
+  // Allow connectWith any rpc method
+  connectWith?: { method: string; params: unknown[] } | undefined
+}
+
 metaMask.type = 'metaMask' as const
 export function metaMask(parameters: MetaMaskParameters = {}) {
   type Provider = SDKProvider
@@ -76,11 +83,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))
+          let requestedAccounts: Address[]
+          if (parameters.connectAndSign) {
+            signResponse = await sdk.connectAndSign({
+              msg: parameters.connectAndSign,
+            })
+            accounts = await this.getAccounts()
+          } else if (parameters.connectWith) {
+            connectWithResponse = await sdk.connectWith({
+              method: parameters.connectWith.method,
+              params: parameters.connectWith.params,
+            })
+            accounts = await this.getAccounts()
+          } else {
+            requestedAccounts = await sdk.connect()
+            accounts = requestedAccounts.map((x) => getAddress(x))
+          }
         }
-
         // Switch to chain if provided
         let currentChainId = (await this.getChainId()) as number
         if (chainId && currentChainId !== chainId) {
@@ -96,6 +118,20 @@ export function metaMask(parameters: MetaMaskParameters = {}) {
           displayUri = undefined
         }
 
+        if (signResponse) {
+          provider.emit('connectAndSign', {
+            accounts,
+            signResponse,
+            chainId: currentChainId,
+          })
+        } else if (connectWithResponse) {
+          provider.emit('connectWith', {
+            accounts,
+            connectWithResponse,
+            chainId: currentChainId,
+          })
+        }
+
         // Manage EIP-1193 event listeners
         // https://eips.ethereum.org/EIPS/eip-1193#events
         if (connect) {
@@ -168,11 +204,19 @@ export function metaMask(parameters: MetaMaskParameters = {}) {
         // See: https://github.com/vitejs/vite/issues/9703
         const MetaMaskSDK = await (async () => {
           const { default: SDK } = await import('@metamask/sdk')
+          // @ts-ignore
           if (typeof SDK !== 'function' && typeof SDK.default === 'function')
+            // @ts-ignore
             return SDK.default
+          // @ts-ignore
           return SDK as unknown as typeof SDK.default
         })()
 
+        const defaultUrl =
+          typeof window !== 'undefined'
+            ? `${window.location.protocol}//${window.location.host}`
+            : ''
+
         sdk = new MetaMaskSDK({
           _source: 'wagmi',
           // Workaround cast since MetaMask SDK does not support `'exactOptionalPropertyTypes'`
@@ -186,8 +230,14 @@ export function metaMask(parameters: MetaMaskParameters = {}) {
               return [chain.id, url]
             }),
           ),
-          dappMetadata: parameters.dappMetadata ?? { name: 'wagmi' },
-          useDeeplink: parameters.useDeeplink ?? true,
+          dappMetadata: parameters.dappMetadata ?? {
+            url: defaultUrl,
+            name: defaultUrl !== '' ? undefined : 'wagmi',
+          },
+          useDeeplink: true,
+          injectProvider: false,
+          forceInjectProvider: false,
+          forceDeleteProvider: false,
         })
         await sdk.init()
         return sdk.getProvider()!