@wagmi/connectors 4.0.0-alpha.5 → 4.0.0-alpha.7

package/dist/esm/version.js

@@ -1,2 +1,2 @@
-export const version = '4.0.0-alpha.5';
+export const version = '4.0.0-alpha.7';
 //# sourceMappingURL=version.js.map

package/dist/types/exports/index.d.ts

@@ -1,6 +1,7 @@
 export { type InjectedParameters, injected, type MockParameters, mock, } from '@wagmi/core/internal';
 export { type CoinbaseWalletParameters, coinbaseWallet, } from '../coinbaseWallet.js';
 export { type LedgerParameters, ledger } from '../ledger.js';
+export { type MetaMaskParameters, metaMask } from '../metaMask.js';
 export { type SafeParameters, safe } from '../safe.js';
 export { type WalletConnectParameters, walletConnect, } from '../walletConnect.js';
 export { version } from '../version.js';

package/dist/types/exports/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/exports/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,kBAAkB,EACvB,QAAQ,EACR,KAAK,cAAc,EACnB,IAAI,GACL,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EACL,KAAK,wBAAwB,EAC7B,cAAc,GACf,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAE5D,OAAO,EAAE,KAAK,cAAc,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AAEtD,OAAO,EACL,KAAK,uBAAuB,EAC5B,aAAa,GACd,MAAM,qBAAqB,CAAA;AAE5B,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/exports/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,kBAAkB,EACvB,QAAQ,EACR,KAAK,cAAc,EACnB,IAAI,GACL,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EACL,KAAK,wBAAwB,EAC7B,cAAc,GACf,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAE5D,OAAO,EAAE,KAAK,kBAAkB,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAElE,OAAO,EAAE,KAAK,cAAc,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AAEtD,OAAO,EACL,KAAK,uBAAuB,EAC5B,aAAa,GACd,MAAM,qBAAqB,CAAA;AAE5B,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA"}

package/dist/types/metaMask.d.ts

@@ -0,0 +1,10 @@
+import { type MetaMaskSDKOptions, SDKProvider } from '@metamask/sdk';
+import type { Evaluate, ExactPartial, Omit } from '@wagmi/core/internal';
+import { type ProviderConnectInfo } from 'viem';
+export type MetaMaskParameters = Evaluate<ExactPartial<Omit<MetaMaskSDKOptions, 'checkInstallationImmediately' | 'checkInstallationOnAllCalls' | 'defaultReadOnlyChainId' | 'readonlyRPCMap'>>>;
+export declare function metaMask(parameters?: MetaMaskParameters): import("@wagmi/core").CreateConnectorFn<SDKProvider, {
+    onConnect(connectInfo: ProviderConnectInfo): void;
+}, {
+    'metaMaskSDK.disconnected': true;
+}>;
+//# sourceMappingURL=metaMask.d.ts.map

package/dist/types/metaMask.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metaMask.d.ts","sourceRoot":"","sources":["../../src/metaMask.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,kBAAkB,EACvB,WAAW,EACZ,MAAM,eAAe,CAAA;AAMtB,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAA;AACxE,OAAO,EAEL,KAAK,mBAAmB,EASzB,MAAM,MAAM,CAAA;AAEb,MAAM,MAAM,kBAAkB,GAAG,QAAQ,CACvC,YAAY,CACV,IAAI,CACF,kBAAkB,EAChB,8BAA8B,GAC9B,6BAA6B,GAC7B,wBAAwB,GACxB,gBAAgB,CACnB,CACF,CACF,CAAA;AAED,wBAAgB,QAAQ,CAAC,UAAU,GAAE,kBAAuB;2BAGjC,mBAAmB,GAAG,IAAI;;gCAEF,IAAI;GAiRtD"}

package/dist/types/version.d.ts

@@ -1,2 +1,2 @@
-export declare const version = "4.0.0-alpha.5";
+export declare const version = "4.0.0-alpha.7";
 //# sourceMappingURL=version.d.ts.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@wagmi/connectors",
   "description": "Collection of connectors for Wagmi",
-  "version": "4.0.0-alpha.5",
+  "version": "4.0.0-alpha.7",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -28,9 +28,9 @@
     "./package.json": "./package.json"
   },
   "peerDependencies": {
-    "typescript": ">=5",
-    "viem": "2.0.0-alpha.12",
-    "@wagmi/core": "2.0.0-alpha.5"
+    "typescript": ">=5.0.4",
+    "viem": "2.0.0-alpha.13",
+    "@wagmi/core": "2.0.0-alpha.7"
   },
   "peerDependenciesMeta": {
     "typescript": {
@@ -40,6 +40,7 @@
   "dependencies": {
     "@coinbase/wallet-sdk": "3.9.0-canary.2",
     "@ledgerhq/connect-kit-loader": "^1.1.2",
+    "@metamask/sdk": "^0.7.1",
     "@safe-global/safe-apps-provider": "^0.18.0",
     "@safe-global/safe-apps-sdk": "^8.1.0",
     "@walletconnect/ethereum-provider": "^2.10.1",
@@ -48,18 +49,13 @@
   "devDependencies": {
     "lokijs": "^1.5.12",
     "msw": "^1.3.1",
-    "@wagmi/core": "2.0.0-alpha.5"
+    "@wagmi/core": "2.0.0-alpha.7"
   },
   "contributors": [
     "awkweb.eth <t@wagmi.sh>",
     "jxom.eth <j@wagmi.sh>"
   ],
-  "funding": [
-    {
-      "type": "github",
-      "url": "https://github.com/sponsors/wagmi-dev"
-    }
-  ],
+  "funding": "https://github.com/sponsors/wagmi-dev",
   "keywords": [
     "react",
     "hooks",
@@ -71,9 +67,9 @@
     "abi"
   ],
   "scripts": {
-    "clean": "rm -rf dist tsconfig.tsbuildinfo",
     "build": "pnpm run clean && pnpm run build:esm+types",
     "build:esm+types": "tsc --project tsconfig.build.json --module es2020 --outDir ./dist/esm --declaration --declarationMap --declarationDir ./dist/types",
+    "clean": "rm -rf dist tsconfig.tsbuildinfo",
     "test:build": "publint --strict",
     "typecheck": "tsc --noEmit"
   }

package/src/coinbaseWallet.ts

@@ -78,7 +78,7 @@ export function coinbaseWallet(parameters: CoinbaseWalletParameters) {
         return { accounts, chainId: currentChainId }
       } catch (error) {
         if (
-          /(user closed modal|accounts received is empty)/i.test(
+          /(user closed modal|accounts received is empty|user denied account)/i.test(
             (error as Error).message,
           )
         )

package/src/exports/index.ts

@@ -12,6 +12,8 @@ export {
 
 export { type LedgerParameters, ledger } from '../ledger.js'
 
+export { type MetaMaskParameters, metaMask } from '../metaMask.js'
+
 export { type SafeParameters, safe } from '../safe.js'
 
 export {

package/src/metaMask.ts

@@ -0,0 +1,316 @@
+import {
+  EventType,
+  MetaMaskSDK,
+  type MetaMaskSDKOptions,
+  SDKProvider,
+} from '@metamask/sdk'
+import {
+  ChainNotConfiguredError,
+  createConnector,
+  normalizeChainId,
+} from '@wagmi/core'
+import type { Evaluate, ExactPartial, Omit } from '@wagmi/core/internal'
+import {
+  type Address,
+  type ProviderConnectInfo,
+  type ProviderRpcError,
+  ResourceUnavailableRpcError,
+  RpcError,
+  SwitchChainError,
+  UserRejectedRequestError,
+  type WalletPermission,
+  getAddress,
+  numberToHex,
+} from 'viem'
+
+export type MetaMaskParameters = Evaluate<
+  ExactPartial<
+    Omit<
+      MetaMaskSDKOptions,
+      | 'checkInstallationImmediately'
+      | 'checkInstallationOnAllCalls'
+      | 'defaultReadOnlyChainId'
+      | 'readonlyRPCMap'
+    >
+  >
+>
+
+export function metaMask(parameters: MetaMaskParameters = {}) {
+  type Provider = SDKProvider
+  type Properties = {
+    onConnect(connectInfo: ProviderConnectInfo): void
+  }
+  type StorageItem = { 'metaMaskSDK.disconnected': true }
+  type Listener = Parameters<Provider['on']>[1]
+
+  let sdk: MetaMaskSDK
+  let walletProvider: Provider | undefined
+
+  return createConnector<Provider, Properties, StorageItem>((config) => ({
+    id: 'metaMaskSDK',
+    name: 'MetaMask',
+    async setup() {
+      const provider = await this.getProvider()
+      if (provider)
+        provider.on('connect', this.onConnect.bind(this) as Listener)
+    },
+    async connect({ chainId, isReconnecting } = {}) {
+      const provider = await this.getProvider()
+
+      let accounts: readonly Address[] | null = null
+      if (!isReconnecting) {
+        accounts = await this.getAccounts().catch(() => null)
+        const isAuthorized = !!accounts?.length
+        if (isAuthorized)
+          // Attempt to show another prompt for selecting account if already connected
+          try {
+            const permissions = (await provider.request({
+              method: 'wallet_requestPermissions',
+              params: [{ eth_accounts: {} }],
+            })) as WalletPermission[]
+            accounts = permissions[0]?.caveats?.[0]?.value?.map(getAddress)
+          } catch (err) {
+            const error = err as RpcError
+            // Not all injected providers support `wallet_requestPermissions` (e.g. MetaMask iOS).
+            // Only bubble up error if user rejects request
+            if (error.code === UserRejectedRequestError.code)
+              throw new UserRejectedRequestError(error)
+            // Or prompt is already open
+            if (error.code === ResourceUnavailableRpcError.code) throw error
+          }
+      }
+
+      try {
+        if (!accounts?.length) {
+          const requestedAccounts = (await sdk.connect()) as string[]
+          accounts = requestedAccounts.map(getAddress)
+        }
+
+        provider.removeListener(
+          'connect',
+          this.onConnect.bind(this) as Listener,
+        )
+        provider.on(
+          'accountsChanged',
+          this.onAccountsChanged.bind(this) as Listener,
+        )
+        provider.on('chainChanged', this.onChainChanged as Listener)
+        provider.on('disconnect', this.onDisconnect.bind(this) as Listener)
+
+        // Backward compatibility with older wallet (<7.3) version that return accounts before authorization
+        if (!sdk.isExtensionActive() && !sdk._getConnection()?.isAuthorized()) {
+          function waitForAuthorized() {
+            return new Promise((resolve) => {
+              const connection = sdk._getConnection()
+              const connector = connection?.getConnector()
+              connector?.once(EventType.AUTHORIZED, () => resolve(true))
+            })
+          }
+          await waitForAuthorized()
+        }
+
+        // Switch to chain if provided
+        let currentChainId = await this.getChainId()
+        if (chainId && currentChainId !== chainId) {
+          const chain = await this.switchChain!({ chainId }).catch(() => ({
+            id: currentChainId,
+          }))
+          currentChainId = chain?.id ?? currentChainId
+        }
+
+        await config.storage?.removeItem('metaMaskSDK.disconnected')
+
+        return { accounts, chainId: currentChainId }
+      } catch (err) {
+        const error = err as RpcError
+        if (error.code === UserRejectedRequestError.code)
+          throw new UserRejectedRequestError(error)
+        if (error.code === ResourceUnavailableRpcError.code)
+          throw new ResourceUnavailableRpcError(error)
+        throw error
+      }
+    },
+    async disconnect() {
+      const provider = await this.getProvider()
+
+      provider.removeListener(
+        'accountsChanged',
+        this.onAccountsChanged.bind(this),
+      )
+      provider.removeListener('chainChanged', this.onChainChanged)
+      provider.removeListener('disconnect', this.onDisconnect.bind(this))
+      provider.on('connect', this.onConnect.bind(this) as Listener)
+
+      // Add shim signalling connector is disconnected
+      await config.storage?.setItem('metaMaskSDK.disconnected', true)
+    },
+    async getAccounts() {
+      const provider = await this.getProvider()
+      const accounts = (await provider.request({
+        method: 'eth_accounts',
+      })) as string[]
+      return accounts.map(getAddress)
+    },
+    async getChainId() {
+      const provider = await this.getProvider()
+      const chainId =
+        provider.chainId ?? (await provider?.request({ method: 'eth_chainId' }))
+      return normalizeChainId(chainId)
+    },
+    async getProvider() {
+      if (!walletProvider) {
+        if (!sdk || !sdk?.isInitialized()) {
+          sdk = new MetaMaskSDK({
+            enableDebug: false,
+            dappMetadata: { name: 'wagmi' },
+            extensionOnly: true,
+            useDeeplink: true,
+            _source: 'wagmi',
+            ...parameters,
+            checkInstallationImmediately: false,
+            checkInstallationOnAllCalls: false,
+          })
+          await sdk.init()
+        }
+        walletProvider = sdk.getProvider()
+      }
+      return walletProvider
+    },
+    async isAuthorized() {
+      try {
+        const isDisconnected =
+          // If shim exists in storage, connector is disconnected
+          await config.storage?.getItem('metaMaskSDK.disconnected')
+        if (isDisconnected) return false
+
+        const accounts = await this.getAccounts()
+        return !!accounts.length
+      } catch {
+        return false
+      }
+    },
+    async switchChain({ chainId }) {
+      const provider = await this.getProvider()
+
+      const chain = config.chains.find((x) => x.id === chainId)
+      if (!chain) throw new SwitchChainError(new ChainNotConfiguredError())
+
+      try {
+        await Promise.all([
+          provider.request({
+            method: 'wallet_switchEthereumChain',
+            params: [{ chainId: numberToHex(chainId) }],
+          }),
+          new Promise<void>((resolve) =>
+            config.emitter.once('change', ({ chainId: currentChainId }) => {
+              if (currentChainId === chainId) resolve()
+            }),
+          ),
+        ])
+        return chain
+      } catch (err) {
+        const error = err as RpcError
+
+        // Indicates chain is not added to provider
+        if (
+          error.code === 4902 ||
+          // Unwrapping for MetaMask Mobile
+          // https://github.com/MetaMask/metamask-mobile/issues/2944#issuecomment-976988719
+          (error as ProviderRpcError<{ originalError?: { code: number } }>)
+            ?.data?.originalError?.code === 4902
+        ) {
+          try {
+            const { default: blockExplorer, ...blockExplorers } =
+              chain.blockExplorers ?? {}
+            let blockExplorerUrls: string[] = []
+            if (blockExplorer)
+              blockExplorerUrls = [
+                blockExplorer.url,
+                ...Object.values(blockExplorers).map((x) => x.url),
+              ]
+
+            await provider.request({
+              method: 'wallet_addEthereumChain',
+              params: [
+                {
+                  chainId: numberToHex(chainId),
+                  chainName: chain.name,
+                  nativeCurrency: chain.nativeCurrency,
+                  rpcUrls: [chain.rpcUrls.public?.http[0] ?? ''],
+                  blockExplorerUrls,
+                },
+              ],
+            })
+
+            const currentChainId = await this.getChainId()
+            if (currentChainId !== chainId)
+              throw new UserRejectedRequestError(
+                new Error('User rejected switch after adding network.'),
+              )
+
+            return chain
+          } catch (error) {
+            throw new UserRejectedRequestError(error as Error)
+          }
+        }
+
+        if (error.code === UserRejectedRequestError.code)
+          throw new UserRejectedRequestError(error)
+        throw new SwitchChainError(error)
+      }
+    },
+    async onAccountsChanged(accounts) {
+      // Disconnect if there are no accounts
+      if (accounts.length === 0) this.onDisconnect()
+      // Connect if emitter is listening for connect event (e.g. is disconnected and connects through wallet interface)
+      else if (config.emitter.listenerCount('connect')) {
+        const chainId = (await this.getChainId()).toString()
+        this.onConnect({ chainId })
+        await config.storage?.removeItem('metaMaskSDK.disconnected')
+      }
+      // Regular change event
+      else config.emitter.emit('change', { accounts: accounts.map(getAddress) })
+    },
+    onChainChanged(chain) {
+      const chainId = normalizeChainId(chain)
+      config.emitter.emit('change', { chainId })
+    },
+    async onConnect(connectInfo) {
+      const accounts = await this.getAccounts()
+      if (accounts.length === 0) return
+
+      const chainId = normalizeChainId(connectInfo.chainId)
+      config.emitter.emit('connect', { accounts, chainId })
+
+      const provider = await this.getProvider()
+      if (provider) {
+        provider.removeListener('connect', this.onConnect.bind(this))
+        provider.on('accountsChanged', this.onAccountsChanged.bind(this) as any)
+        provider.on('chainChanged', this.onChainChanged as any)
+        provider.on('disconnect', this.onDisconnect.bind(this) as any)
+      }
+    },
+    async onDisconnect(error) {
+      const provider = await this.getProvider()
+
+      // If MetaMask emits a `code: 1013` error, wait for reconnection before disconnecting
+      // https://github.com/MetaMask/providers/pull/120
+      if (error && (error as RpcError<1013>).code === 1013) {
+        if (provider && !!(await this.getAccounts()).length) return
+      }
+
+      // No need to remove 'metaMaskSDK.disconnected' from storage because `onDisconnect` is typically
+      // only called when the wallet is disconnected through the wallet's interface, meaning the wallet
+      // actually disconnected and we don't need to simulate it.
+      config.emitter.emit('disconnect')
+
+      provider.removeListener(
+        'accountsChanged',
+        this.onAccountsChanged.bind(this),
+      )
+      provider.removeListener('chainChanged', this.onChainChanged)
+      provider.removeListener('disconnect', this.onDisconnect.bind(this))
+      provider.on('connect', this.onConnect.bind(this) as any)
+    },
+  }))
+}

package/src/version.ts

@@ -1 +1 @@
-export const version = '4.0.0-alpha.5'
+export const version = '4.0.0-alpha.7'