fix(wagmi): respect coinbasePreference when selecting Coinbase connector

.changeset/cute-otters-stay.md

@@ -0,0 +1,31 @@
+---
+'@reown/appkit-adapter-wagmi': patch
+'pay-test-exchange': patch
+'@reown/appkit-adapter-bitcoin': patch
+'@reown/appkit-adapter-ethers': patch
+'@reown/appkit-adapter-ethers5': patch
+'@reown/appkit-adapter-solana': patch
+'@reown/appkit-adapter-ton': patch
+'@reown/appkit-adapter-tron': patch
+'@reown/appkit': patch
+'@reown/appkit-utils': patch
+'@reown/appkit-cdn': patch
+'@reown/appkit-cli': patch
+'@reown/appkit-codemod': patch
+'@reown/appkit-common': patch
+'@reown/appkit-controllers': patch
+'@reown/appkit-core': patch
+'@reown/appkit-experimental': patch
+'@reown/appkit-pay': patch
+'@reown/appkit-polyfills': patch
+'@reown/appkit-scaffold-ui': patch
+'@reown/appkit-siwe': patch
+'@reown/appkit-siwx': patch
+'@reown/appkit-testing': patch
+'@reown/appkit-ui': patch
+'@reown/appkit-universal-connector': patch
+'@reown/appkit-wallet': patch
+'@reown/appkit-wallet-button': patch
+---
+
+Fix `coinbasePreference` option being ignored — `'all'` and `'eoaOnly'` now correctly use the `coinbaseWallet` connector (with QR code support) instead of always using `baseAccount`. `'smartWalletOnly'` uses `baseAccount`. Regression introduced in PR #5269.

packages/adapters/wagmi/src/client.ts

@@ -298,8 +298,11 @@ export class WagmiAdapter extends AdapterBlueprint {
 
   private async addThirdPartyConnectors() {
     const thirdPartyConnectors: CreateConnectorFn[] = []
-    const { enableCoinbase: isCoinbaseEnabled, enableBaseAccount: isBaseAccountEnabled } =
-      OptionsController.state || {}
+    const {
+      enableCoinbase: isCoinbaseEnabled,
+      enableBaseAccount: isBaseAccountEnabled,
+      coinbasePreference
+    } = OptionsController.state || {}
 
     if (isBaseAccountEnabled !== false) {
       const baseAccountConnector = await getBaseAccountConnector(this.wagmiConfig.connectors)
@@ -309,7 +312,10 @@ export class WagmiAdapter extends AdapterBlueprint {
     }
 
     if (isCoinbaseEnabled !== false) {
-      const coinbaseConnector = await getCoinbaseConnector(this.wagmiConfig.connectors)
+      const coinbaseConnector = await getCoinbaseConnector(
+        this.wagmiConfig.connectors,
+        coinbasePreference
+      )
       if (coinbaseConnector) {
         thirdPartyConnectors.push(coinbaseConnector)
       }

packages/adapters/wagmi/src/tests/client.test.ts

@@ -1631,25 +1631,27 @@ describe('WagmiAdapter - addThirdPartyConnectors', () => {
     vi.restoreAllMocks()
   })
 
-  it('should add Base Account connector if enableBaseAccount is not false', async () => {
+  it('should add Base Account connector when enableBaseAccount is not false', async () => {
     const getBaseAccountConnectorSpy = vi
       .spyOn(helpers, 'getBaseAccountConnector')
       .mockResolvedValue(mockBaseAccountConnector() as any)
     vi.spyOn(helpers, 'getCoinbaseConnector').mockResolvedValue(null)
     await adapter['addThirdPartyConnectors']()
     expect(getBaseAccountConnectorSpy).toHaveBeenCalled()
-    expect(adapter.wagmiConfig.connectors.length).toBe(1)
+    expect(adapter.wagmiConfig.connectors.some(c => c.id === 'baseAccount')).toBe(true)
   })
 
   it('should not add Base Account connector if enableBaseAccount is false', async () => {
     vi.spyOn(OptionsController, 'state', 'get').mockReturnValue({
       ...(OptionsController.state || {}),
       enableBaseAccount: false
     })
-    vi.spyOn(helpers, 'getBaseAccountConnector').mockResolvedValue(null)
-    vi.spyOn(helpers, 'getCoinbaseConnector').mockResolvedValue(null)
+    const getBaseAccountConnectorSpy = vi
+      .spyOn(helpers, 'getBaseAccountConnector')
+      .mockResolvedValue(null)
+    vi.spyOn(helpers, 'getCoinbaseConnector').mockResolvedValue(mockCoinbaseConnector() as any)
     await adapter['addThirdPartyConnectors']()
-    expect(adapter.wagmiConfig.connectors.length).toBe(0)
+    expect(getBaseAccountConnectorSpy).not.toHaveBeenCalled()
   })
 
   it('should add Coinbase connector if enableCoinbase is not false', async () => {
@@ -1673,14 +1675,48 @@ describe('WagmiAdapter - addThirdPartyConnectors', () => {
     expect(adapter.wagmiConfig.connectors.length).toBe(0)
   })
 
-  it('should add both Base Account and Coinbase connectors when both are enabled', async () => {
-    vi.spyOn(helpers, 'getBaseAccountConnector').mockResolvedValue(
-      mockBaseAccountConnector() as any
-    )
-    vi.spyOn(helpers, 'getCoinbaseConnector').mockResolvedValue(mockCoinbaseConnector() as any)
+  it('should use coinbaseWallet with preference "all" by default', async () => {
+    vi.spyOn(OptionsController, 'state', 'get').mockReturnValue({
+      ...(OptionsController.state || {}),
+      coinbasePreference: 'all'
+    })
+    vi.spyOn(helpers, 'getBaseAccountConnector').mockResolvedValue(null)
+    const getCoinbaseConnectorSpy = vi
+      .spyOn(helpers, 'getCoinbaseConnector')
+      .mockResolvedValue(mockCoinbaseConnector() as any)
     await adapter['addThirdPartyConnectors']()
-    expect(adapter.wagmiConfig.connectors.length).toBe(2)
-    expect(adapter.wagmiConfig.connectors.some(c => c.id === 'baseAccount')).toBe(true)
+    expect(getCoinbaseConnectorSpy).toHaveBeenCalledWith(adapter.wagmiConfig.connectors, 'all')
+    expect(adapter.wagmiConfig.connectors.some(c => c.id === 'coinbaseWallet')).toBe(true)
+  })
+
+  it('should use coinbaseWallet with preference "eoaOnly" when coinbasePreference is eoaOnly', async () => {
+    vi.spyOn(OptionsController, 'state', 'get').mockReturnValue({
+      ...(OptionsController.state || {}),
+      coinbasePreference: 'eoaOnly'
+    })
+    vi.spyOn(helpers, 'getBaseAccountConnector').mockResolvedValue(null)
+    const getCoinbaseConnectorSpy = vi
+      .spyOn(helpers, 'getCoinbaseConnector')
+      .mockResolvedValue(mockCoinbaseConnector() as any)
+    await adapter['addThirdPartyConnectors']()
+    expect(getCoinbaseConnectorSpy).toHaveBeenCalledWith(adapter.wagmiConfig.connectors, 'eoaOnly')
+    expect(adapter.wagmiConfig.connectors.some(c => c.id === 'coinbaseWallet')).toBe(true)
+  })
+
+  it('should use coinbaseWallet with preference "smartWalletOnly" when coinbasePreference is smartWalletOnly', async () => {
+    vi.spyOn(OptionsController, 'state', 'get').mockReturnValue({
+      ...(OptionsController.state || {}),
+      coinbasePreference: 'smartWalletOnly'
+    })
+    vi.spyOn(helpers, 'getBaseAccountConnector').mockResolvedValue(null)
+    const getCoinbaseConnectorSpy = vi
+      .spyOn(helpers, 'getCoinbaseConnector')
+      .mockResolvedValue(mockCoinbaseConnector() as any)
+    await adapter['addThirdPartyConnectors']()
+    expect(getCoinbaseConnectorSpy).toHaveBeenCalledWith(
+      adapter.wagmiConfig.connectors,
+      'smartWalletOnly'
+    )
     expect(adapter.wagmiConfig.connectors.some(c => c.id === 'coinbaseWallet')).toBe(true)
   })
 

packages/adapters/wagmi/src/utils/helpers.ts

@@ -86,13 +86,14 @@ export async function getBaseAccountConnector(
 }
 
 export async function getCoinbaseConnector(
-  connectors: readonly Connector[]
+  connectors: readonly Connector[],
+  preference?: 'all' | 'smartWalletOnly' | 'eoaOnly'
 ): Promise<CreateConnectorFn | null> {
   try {
     const { coinbaseWallet } = await import('@wagmi/connectors')
 
     if (coinbaseWallet && !connectors.some(c => c.id === 'coinbaseWallet')) {
-      return coinbaseWallet()
+      return coinbaseWallet({ preference })
     }
   } catch (error) {
     // eslint-disable-next-line no-console