connect

Action for connecting accounts with connectors.

Import

import { connect } from '@wagmi/core'

Usage

index.ts

import { connect } from '@wagmi/core'
import { injected } from '@wagmi/connectors'
import { config } from './config'

const result = await connect(config, { connector: injected() })

config.ts

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

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

Parameters

import { type ConnectParameters } from '@wagmi/core'

chainId

number | undefined

Chain ID to connect to.

Not all connectors support connecting directly to a chainId (e.g. they don't support programmatic chain switching). In those cases, the connector will connect to whatever chain the connector's provider is connected to.

index.ts

import { connect } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { injected } from '@wagmi/connectors'
import { config } from './config'

const result = await connect(config, {
  chainId: mainnet.id, 
  connector: injected(),
})

config.ts

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

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

connector

CreateConnectorFn | Connector

Connector to connect with.

index.ts

import { connect } from '@wagmi/core'
import { injected } from '@wagmi/connectors'
import { config } from './config'

const result = await connect(config, {
  connector: injected(), 
})

config.ts

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

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

withCapabilities

boolean | undefined

• Exposes capabilities on return type.
• Defaults to false.

index.ts

import { connect } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { injected } from '@wagmi/connectors'
import { config } from './config'

const result = await connect(config, {
  connector: injected(),
  withCapabilities: true, 
})

config.ts

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

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

Return Type

import { type ConnectReturnType } from '@wagmi/core'

TIP

When withCapabilities: false | undefined:

type ConnectReturnType = {
  accounts: readonly Address[]
  // ...
}

When withCapabilities: true:

type ConnectReturnType = {
  accounts: readonly { address: Address; capabilities: Record<string, unknown> }[]
  // ...
}

accounts

readonly [Address, ...Address[]]

Connected accounts from connector.

chainId

number

Connected chain ID from connector.

Error

import { type ConnectErrorType } from '@wagmi/core'

TanStack Query

import {
  type ConnectData,
  type ConnectVariables,
  type ConnectMutate,
  type ConnectMutateAsync,
  connectMutationOptions,
} from '@wagmi/core/query'