@wagmi/connectors 4.3.10 → 5.0.1

package/dist/esm/version.js

@@ -1,2 +1,2 @@
-export const version = '4.3.10';
+export const version = '5.0.1';
 //# sourceMappingURL=version.js.map

package/dist/esm/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAA"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAA"}

package/dist/types/coinbaseWallet.d.ts

@@ -1,6 +1,39 @@
-import type { CoinbaseWalletProvider, CoinbaseWalletSDK } from '@coinbase/wallet-sdk';
+import type { CoinbaseWalletSDK, ProviderInterface } from '@coinbase/wallet-sdk';
 import type { Evaluate, Mutable, Omit } from '@wagmi/core/internal';
-export type CoinbaseWalletParameters = Evaluate<Mutable<Omit<ConstructorParameters<typeof CoinbaseWalletSDK>[0], 'reloadOnDisconnect'>> & {
+import type { CoinbaseWalletProvider as CBW_Provider, CoinbaseWalletSDK as CBW_SDK } from 'cbw-sdk';
+type Version = '3' | '4';
+export type CoinbaseWalletParameters<version extends Version = '3'> = version extends '4' ? Evaluate<{
+    headlessMode?: false | undefined;
+    /** Coinbase Wallet SDK version */
+    version?: version | '3' | undefined;
+} & Version4Parameters> : Evaluate<{
+    /**
+     * @deprecated `headlessMode` will be removed in the next major version. Upgrade to `version: '4'`.
+     */
+    headlessMode?: true | undefined;
+    /**
+     * Coinbase Wallet SDK version
+     * @deprecated Version 3 will be removed in the next major version. Upgrade to `version: '4'`.
+     * @default '4'
+     */
+    version?: version | '4' | undefined;
+} & Version3Parameters>;
+export declare function coinbaseWallet<version extends Version>(parameters?: CoinbaseWalletParameters<version>): version extends '4' ? ReturnType<typeof version4> : ReturnType<typeof version3>;
+export declare namespace coinbaseWallet {
+    var type: "coinbaseWallet";
+}
+type Version4Parameters = Mutable<Omit<ConstructorParameters<typeof CoinbaseWalletSDK>[0], 'appChainIds'> & {
+    /**
+     * Preference for the type of wallet to display.
+     * @default 'all'
+     */
+    preference?: 'all' | 'smartWalletOnly' | 'eoaOnly' | undefined;
+    keysUrl?: string | undefined;
+}>;
+declare function version4(parameters: Version4Parameters): import("@wagmi/core").CreateConnectorFn<ProviderInterface & {
+    close?(): void;
+}, {}, {}>;
+type Version3Parameters = Mutable<Omit<ConstructorParameters<typeof CBW_SDK>[0], 'reloadOnDisconnect'>> & {
     /**
      * Fallback Ethereum JSON RPC URL
      * @default ""
@@ -16,9 +49,7 @@ export type CoinbaseWalletParameters = Evaluate<Mutable<Omit<ConstructorParamete
      * @default false
      */
     reloadOnDisconnect?: boolean | undefined;
-}>;
-export declare function coinbaseWallet(parameters: CoinbaseWalletParameters): import("@wagmi/core").CreateConnectorFn<CoinbaseWalletProvider, {}, {}>;
-export declare namespace coinbaseWallet {
-    var type: "coinbaseWallet";
-}
+};
+declare function version3(parameters: Version3Parameters): import("@wagmi/core").CreateConnectorFn<CBW_Provider, {}, {}>;
+export {};
 //# sourceMappingURL=coinbaseWallet.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"coinbaseWallet.d.ts","sourceRoot":"","sources":["../../src/coinbaseWallet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,sBAAsB,EACtB,iBAAiB,EAClB,MAAM,sBAAsB,CAAA;AAM7B,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAA;AAWnE,MAAM,MAAM,wBAAwB,GAAG,QAAQ,CAC7C,OAAO,CACL,IAAI,CACF,qBAAqB,CAAC,OAAO,iBAAiB,CAAC,CAAC,CAAC,CAAC,EAClD,oBAAoB,CACrB,CACF,GAAG;IACF;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CACzC,CACF,CAAA;AAGD,wBAAgB,cAAc,CAAC,UAAU,EAAE,wBAAwB,2EA6NlE;yBA7Ne,cAAc"}
+{"version":3,"file":"coinbaseWallet.d.ts","sourceRoot":"","sources":["../../src/coinbaseWallet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAMhF,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAA;AACnE,OAAO,KAAK,EACV,sBAAsB,IAAI,YAAY,EACtC,iBAAiB,IAAI,OAAO,EAC7B,MAAM,SAAS,CAAA;AAUhB,KAAK,OAAO,GAAG,GAAG,GAAG,GAAG,CAAA;AAExB,MAAM,MAAM,wBAAwB,CAAC,OAAO,SAAS,OAAO,GAAG,GAAG,IAChE,OAAO,SAAS,GAAG,GACf,QAAQ,CACN;IACE,YAAY,CAAC,EAAE,KAAK,GAAG,SAAS,CAAA;IAChC,kCAAkC;IAClC,OAAO,CAAC,EAAE,OAAO,GAAG,GAAG,GAAG,SAAS,CAAA;CACpC,GAAG,kBAAkB,CACvB,GACD,QAAQ,CACN;IACE;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,GAAG,SAAS,CAAA;IAC/B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,GAAG,GAAG,SAAS,CAAA;CACpC,GAAG,kBAAkB,CACvB,CAAA;AAGP,wBAAgB,cAAc,CAAC,OAAO,SAAS,OAAO,EACpD,UAAU,GAAE,wBAAwB,CAAC,OAAO,CAAa,GACxD,OAAO,SAAS,GAAG,GAClB,UAAU,CAAC,OAAO,QAAQ,CAAC,GAC3B,UAAU,CAAC,OAAO,QAAQ,CAAC,CAI9B;yBARe,cAAc;;;AAU9B,KAAK,kBAAkB,GAAG,OAAO,CAC/B,IAAI,CACF,qBAAqB,CAAC,OAAO,iBAAiB,CAAC,CAAC,CAAC,CAAC,EAClD,aAAa,CACd,GAAG;IACF;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,GAAG,iBAAiB,GAAG,SAAS,GAAG,SAAS,CAAA;IAC9D,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC7B,CACF,CAAA;AAED,iBAAS,QAAQ,CAAC,UAAU,EAAE,kBAAkB;cAGlC,IAAI;WA6MjB;AAED,KAAK,kBAAkB,GAAG,OAAO,CAC/B,IAAI,CACF,qBAAqB,CAAC,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC,EACxC,oBAAoB,CACrB,CACF,GAAG;IACF;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CACzC,CAAA;AAED,iBAAS,QAAQ,CAAC,UAAU,EAAE,kBAAkB,iEAuN/C"}

package/dist/types/version.d.ts

@@ -1,2 +1,2 @@
-export declare const version = "4.3.10";
+export declare const version = "5.0.1";
 //# sourceMappingURL=version.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAA"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@wagmi/connectors",
   "description": "Collection of connectors for Wagmi",
-  "version": "4.3.10",
+  "version": "5.0.1",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -30,7 +30,7 @@
   "peerDependencies": {
     "typescript": ">=5.0.4",
     "viem": "2.x",
-    "@wagmi/core": "2.9.8"
+    "@wagmi/core": "2.10.1"
   },
   "peerDependenciesMeta": {
     "typescript": {
@@ -38,12 +38,13 @@
     }
   },
   "dependencies": {
-    "@coinbase/wallet-sdk": "3.9.1",
+    "@coinbase/wallet-sdk": "4.0.0",
     "@metamask/sdk": "0.20.3",
     "@safe-global/safe-apps-provider": "0.18.1",
     "@safe-global/safe-apps-sdk": "8.1.0",
     "@walletconnect/ethereum-provider": "2.13.0",
-    "@walletconnect/modal": "2.6.2"
+    "@walletconnect/modal": "2.6.2",
+    "cbw-sdk": "npm:@coinbase/wallet-sdk@3.9.3"
   },
   "contributors": [
     "awkweb.eth <t@wevm.dev>",

package/src/coinbaseWallet.ts

@@ -1,13 +1,14 @@
-import type {
-  CoinbaseWalletProvider,
-  CoinbaseWalletSDK,
-} from '@coinbase/wallet-sdk'
+import type { CoinbaseWalletSDK, ProviderInterface } from '@coinbase/wallet-sdk'
 import {
   ChainNotConfiguredError,
   type Connector,
   createConnector,
 } from '@wagmi/core'
 import type { Evaluate, Mutable, Omit } from '@wagmi/core/internal'
+import type {
+  CoinbaseWalletProvider as CBW_Provider,
+  CoinbaseWalletSDK as CBW_SDK,
+} from 'cbw-sdk'
 import {
   type AddEthereumChainParameter,
   type ProviderRpcError,
@@ -17,40 +18,297 @@ import {
   numberToHex,
 } from 'viem'
 
-// TODO(@3): Set `enableMobileWalletLink` to `true`
-export type CoinbaseWalletParameters = Evaluate<
-  Mutable<
-    Omit<
-      ConstructorParameters<typeof CoinbaseWalletSDK>[0],
-      'reloadOnDisconnect' // remove property since TSDoc says default is `true`
-    >
+type Version = '3' | '4'
+
+export type CoinbaseWalletParameters<version extends Version = '3'> =
+  version extends '4'
+    ? Evaluate<
+        {
+          headlessMode?: false | undefined
+          /** Coinbase Wallet SDK version */
+          version?: version | '3' | undefined
+        } & Version4Parameters
+      >
+    : Evaluate<
+        {
+          /**
+           * @deprecated `headlessMode` will be removed in the next major version. Upgrade to `version: '4'`.
+           */
+          headlessMode?: true | undefined
+          /**
+           * Coinbase Wallet SDK version
+           * @deprecated Version 3 will be removed in the next major version. Upgrade to `version: '4'`.
+           * @default '4'
+           */
+          version?: version | '4' | undefined
+        } & Version3Parameters
+      >
+
+coinbaseWallet.type = 'coinbaseWallet' as const
+export function coinbaseWallet<version extends Version>(
+  parameters: CoinbaseWalletParameters<version> = {} as any,
+): version extends '4'
+  ? ReturnType<typeof version4>
+  : ReturnType<typeof version3> {
+  if (parameters.version === '3' || parameters.headlessMode)
+    return version3(parameters as Version3Parameters) as any
+  return version4(parameters as Version4Parameters) as any
+}
+
+type Version4Parameters = Mutable<
+  Omit<
+    ConstructorParameters<typeof CoinbaseWalletSDK>[0],
+    'appChainIds' // set via wagmi config
   > & {
     /**
-     * Fallback Ethereum JSON RPC URL
-     * @default ""
+     * Preference for the type of wallet to display.
+     * @default 'all'
      */
-    jsonRpcUrl?: string | undefined
-    /**
-     * Fallback Ethereum Chain ID
-     * @default 1
-     */
-    chainId?: number | undefined
-    /**
-     * Whether or not to reload dapp automatically after disconnect.
-     * @default false
-     */
-    reloadOnDisconnect?: boolean | undefined
+    preference?: 'all' | 'smartWalletOnly' | 'eoaOnly' | undefined
+    keysUrl?: string | undefined
   }
 >
 
-coinbaseWallet.type = 'coinbaseWallet' as const
-export function coinbaseWallet(parameters: CoinbaseWalletParameters) {
+function version4(parameters: Version4Parameters) {
+  type Provider = ProviderInterface & {
+    // for backwards compatibility
+    close?(): void
+  }
+  type Properties = {}
+
+  let sdk: CoinbaseWalletSDK | undefined
+  let walletProvider: Provider | undefined
+
+  let accountsChanged: Connector['onAccountsChanged'] | undefined
+  let chainChanged: Connector['onChainChanged'] | undefined
+  let disconnect: Connector['onDisconnect'] | undefined
+
+  return createConnector<Provider, Properties>((config) => ({
+    id: 'coinbaseWalletSDK',
+    name: 'Coinbase Wallet',
+    supportsSimulation: true,
+    type: coinbaseWallet.type,
+    async connect({ chainId } = {}) {
+      try {
+        const provider = await this.getProvider()
+        const accounts = (
+          (await provider.request({
+            method: 'eth_requestAccounts',
+          })) as string[]
+        ).map((x) => getAddress(x))
+
+        if (!accountsChanged) {
+          accountsChanged = this.onAccountsChanged.bind(this)
+          provider.on('accountsChanged', accountsChanged)
+        }
+        if (!chainChanged) {
+          chainChanged = this.onChainChanged.bind(this)
+          provider.on('chainChanged', chainChanged)
+        }
+        if (!disconnect) {
+          disconnect = this.onDisconnect.bind(this)
+          provider.on('disconnect', disconnect)
+        }
+
+        // Switch to chain if provided
+        let currentChainId = await this.getChainId()
+        if (chainId && currentChainId !== chainId) {
+          const chain = await this.switchChain!({ chainId }).catch((error) => {
+            if (error.code === UserRejectedRequestError.code) throw error
+            return { id: currentChainId }
+          })
+          currentChainId = chain?.id ?? currentChainId
+        }
+
+        return { accounts, chainId: currentChainId }
+      } catch (error) {
+        if (
+          /(user closed modal|accounts received is empty|user denied account)/i.test(
+            (error as Error).message,
+          )
+        )
+          throw new UserRejectedRequestError(error as Error)
+        throw error
+      }
+    },
+    async disconnect() {
+      const provider = await this.getProvider()
+
+      if (accountsChanged) {
+        provider.removeListener('accountsChanged', accountsChanged)
+        accountsChanged = undefined
+      }
+      if (chainChanged) {
+        provider.removeListener('chainChanged', chainChanged)
+        chainChanged = undefined
+      }
+      if (disconnect) {
+        provider.removeListener('disconnect', disconnect)
+        disconnect = undefined
+      }
+
+      provider.disconnect()
+      provider.close?.()
+    },
+    async getAccounts() {
+      const provider = await this.getProvider()
+      return (
+        await provider.request<string[]>({
+          method: 'eth_accounts',
+        })
+      ).map((x) => getAddress(x))
+    },
+    async getChainId() {
+      const provider = await this.getProvider()
+      const chainId = await provider.request<number>({
+        method: 'eth_chainId',
+      })
+      return Number(chainId)
+    },
+    async getProvider() {
+      if (!walletProvider) {
+        // Unwrap import
+        const { default: SDK_ } = await import('@coinbase/wallet-sdk')
+        let SDK: typeof SDK_.default
+        if (typeof SDK_ !== 'function' && typeof SDK_.default === 'function')
+          SDK = SDK_.default
+        else SDK = SDK_ as unknown as typeof SDK_.default
+        sdk = new SDK({
+          ...parameters,
+          appChainIds: config.chains.map((x) => x.id),
+        })
+
+        walletProvider = sdk.makeWeb3Provider({
+          ...parameters,
+          options: parameters.preference ?? 'all',
+        })
+      }
+
+      return walletProvider
+    },
+    async isAuthorized() {
+      try {
+        const accounts = await this.getAccounts()
+        return !!accounts.length
+      } catch {
+        return false
+      }
+    },
+    async switchChain({ addEthereumChainParameter, chainId }) {
+      const chain = config.chains.find((chain) => chain.id === chainId)
+      if (!chain) throw new SwitchChainError(new ChainNotConfiguredError())
+
+      const provider = await this.getProvider()
+
+      try {
+        await provider.request({
+          method: 'wallet_switchEthereumChain',
+          params: [{ chainId: numberToHex(chain.id) }],
+        })
+        return chain
+      } catch (error) {
+        // Indicates chain is not added to provider
+        if ((error as ProviderRpcError).code === 4902) {
+          try {
+            let blockExplorerUrls
+            if (addEthereumChainParameter?.blockExplorerUrls)
+              blockExplorerUrls = addEthereumChainParameter.blockExplorerUrls
+            else
+              blockExplorerUrls = chain.blockExplorers?.default.url
+                ? [chain.blockExplorers?.default.url]
+                : []
+
+            let rpcUrls
+            if (addEthereumChainParameter?.rpcUrls?.length)
+              rpcUrls = addEthereumChainParameter.rpcUrls
+            else rpcUrls = [chain.rpcUrls.default?.http[0] ?? '']
+
+            const addEthereumChain = {
+              blockExplorerUrls,
+              chainId: numberToHex(chainId),
+              chainName: addEthereumChainParameter?.chainName ?? chain.name,
+              iconUrls: addEthereumChainParameter?.iconUrls,
+              nativeCurrency:
+                addEthereumChainParameter?.nativeCurrency ??
+                chain.nativeCurrency,
+              rpcUrls,
+            } satisfies AddEthereumChainParameter
+
+            await provider.request({
+              method: 'wallet_addEthereumChain',
+              params: [addEthereumChain],
+            })
+
+            return chain
+          } catch (error) {
+            throw new UserRejectedRequestError(error as Error)
+          }
+        }
+
+        throw new SwitchChainError(error as Error)
+      }
+    },
+    onAccountsChanged(accounts) {
+      if (accounts.length === 0) this.onDisconnect()
+      else
+        config.emitter.emit('change', {
+          accounts: accounts.map((x) => getAddress(x)),
+        })
+    },
+    onChainChanged(chain) {
+      const chainId = Number(chain)
+      config.emitter.emit('change', { chainId })
+    },
+    async onDisconnect(_error) {
+      config.emitter.emit('disconnect')
+
+      const provider = await this.getProvider()
+      if (accountsChanged) {
+        provider.removeListener('accountsChanged', accountsChanged)
+        accountsChanged = undefined
+      }
+      if (chainChanged) {
+        provider.removeListener('chainChanged', chainChanged)
+        chainChanged = undefined
+      }
+      if (disconnect) {
+        provider.removeListener('disconnect', disconnect)
+        disconnect = undefined
+      }
+    },
+  }))
+}
+
+type Version3Parameters = Mutable<
+  Omit<
+    ConstructorParameters<typeof CBW_SDK>[0],
+    'reloadOnDisconnect' // remove property since TSDoc says default is `true`
+  >
+> & {
+  /**
+   * Fallback Ethereum JSON RPC URL
+   * @default ""
+   */
+  jsonRpcUrl?: string | undefined
+  /**
+   * Fallback Ethereum Chain ID
+   * @default 1
+   */
+  chainId?: number | undefined
+  /**
+   * Whether or not to reload dapp automatically after disconnect.
+   * @default false
+   */
+  reloadOnDisconnect?: boolean | undefined
+}
+
+function version3(parameters: Version3Parameters) {
   const reloadOnDisconnect = false
 
-  type Provider = CoinbaseWalletProvider
+  type Provider = CBW_Provider
   type Properties = {}
 
-  let sdk: CoinbaseWalletSDK | undefined
+  let sdk: CBW_SDK | undefined
   let walletProvider: Provider | undefined
 
   let accountsChanged: Connector['onAccountsChanged'] | undefined
@@ -139,17 +397,11 @@ export function coinbaseWallet(parameters: CoinbaseWalletParameters) {
     },
     async getProvider() {
       if (!walletProvider) {
-        const { default: CoinbaseWalletSDK } = await import(
-          '@coinbase/wallet-sdk'
-        )
-        let SDK: typeof CoinbaseWalletSDK.default
-        if (
-          typeof CoinbaseWalletSDK !== 'function' &&
-          typeof CoinbaseWalletSDK.default === 'function'
-        )
-          SDK = CoinbaseWalletSDK.default
-        else
-          SDK = CoinbaseWalletSDK as unknown as typeof CoinbaseWalletSDK.default
+        const { default: SDK_ } = await import('cbw-sdk')
+        let SDK: typeof SDK_.default
+        if (typeof SDK_ !== 'function' && typeof SDK_.default === 'function')
+          SDK = SDK_.default
+        else SDK = SDK_ as unknown as typeof SDK_.default
         sdk = new SDK({ reloadOnDisconnect, ...parameters })
 
         // Force types to retrieve private `walletExtension` method from the Coinbase Wallet SDK.

package/src/version.ts

@@ -1 +1 @@
-export const version = '4.3.10'
+export const version = '5.0.1'