Skip to content

coinbaseWallet

Connector for the Coinbase Wallet SDK.

Import

ts
import { coinbaseWallet } from '@wagmi/connectors'

Usage

ts
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'
import { coinbaseWallet } from '@wagmi/connectors'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [
    coinbaseWallet({
      appName: 'My Wagmi App',
    }),
  ],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

Parameters

ts
import { type CoinbaseWalletParameters } from '@wagmi/connectors'

Check out the Coinbase Wallet SDK docs for more info.

appName

string

Application name.

ts
import { coinbaseWallet } from '@wagmi/connectors'

const connector = coinbaseWallet({
  appName: 'My Wagmi App', 
})

appLogoUrl

string | null | undefined

Application logo image URL; favicon is used if unspecified.

ts
import { coinbaseWallet } from '@wagmi/connectors'

const connector = coinbaseWallet({
  appName: 'My Wagmi App',
  appLogoUrl: 'https://example.com/myLogoUrl.png', 
})

chainId

number | undefined

Fallback Ethereum Chain ID. Defaults to 1 (Mainnet).

ts
import { mainnet } from '@wagmi/core/chains'
import { coinbaseWallet } from '@wagmi/connectors'

const connector = coinbaseWallet({
  appName: 'My Wagmi App',
  chainId: mainnet.id, 
})

darkMode

boolean | undefined

Use dark theme.

ts
import { coinbaseWallet } from '@wagmi/connectors'

const connector = coinbaseWallet({
  appName: 'My Wagmi App',
  darkMode: true, 
})

diagnosticLogger

DiagnosticLogger | undefined

A diagnostic tool for debugging; for most, leave it unspecified.

boolean | undefined

Whether to connect mobile web app via WalletLink, defaults to false.

ts
import { coinbaseWallet } from '@wagmi/connectors'

const connector = coinbaseWallet({
  appName: 'My Wagmi App',
  enableMobileWalletLink: true, 
})

headlessMode

boolean | undefined

Whether or not onboarding overlay popup should be displayed.

ts
import { coinbaseWallet } from '@wagmi/connectors'

const connector = coinbaseWallet({
  appName: 'My Wagmi App',
  headlessMode: false, 
})

jsonRpcUrl

string | undefined

Fallback Ethereum JSON RPC URL.

ts
import { coinbaseWallet } from '@wagmi/connectors'

const connector = coinbaseWallet({
  appName: 'My Wagmi App',
  jsonRpcUrl: 'https://cloudflare-eth.com', 
})

linkApiUrl

string | undefined

Coinbase Wallet link server URL; for most, leave it unspecified.

overrideIsCoinbaseBrowser / overrideIsCoinbaseWallet / overrideIsMetaMask

boolean | undefined

Whether wallet link provider should override the isCoinbaseBrowser, isCoinbaseWallet, and/or isMetaMask property.

ts
import { coinbaseWallet } from '@wagmi/connectors'

const connector = coinbaseWallet({
  appName: 'My Wagmi App',
  isCoinbaseBrowser: true, 
  isCoinbaseWallet: true, 
  isMetaMask: true, 
})

reloadOnDisconnect

boolean | undefined

Whether or not to reload dapp automatically after disconnect, defaults to false.

ts
import { coinbaseWallet } from '@wagmi/connectors'

const connector = coinbaseWallet({
  appName: 'My Wagmi App',
  reloadOnDisconnect: true, 
})

uiConstructor

((options: Readonly<WalletUIOptions>) => WalletUI) | undefined

An implementation of WalletUI; for most, leave it unspecified.

Released under the MIT License.