connect
Action for connecting accounts with connectors.
Import
ts
import { connect } from '@wagmi/core'import { connect } from '@wagmi/core'Usage
ts
import { connect } from '@wagmi/core'
import { injected } from '@wagmi/connectors'
import { config } from './config'
const result = await connect(config, { connector: injected() })import { connect } from '@wagmi/core'
import { injected } from '@wagmi/connectors'
import { config } from './config'
const result = await connect(config, { connector: injected() })ts
import { http, createConfig } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'
export const config = createConfig({
chains: [mainnet, sepolia],
transports: {
[mainnet.id]: http(),
[sepolia.id]: http(),
},
})import { http, createConfig } 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
ts
import { type ConnectParameters } from '@wagmi/core'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.
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(),
})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(),
})ts
import { http, createConfig } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'
export const config = createConfig({
chains: [mainnet, sepolia],
transports: {
[mainnet.id]: http(),
[sepolia.id]: http(),
},
})import { http, createConfig } 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.
ts
import { connect } from '@wagmi/core'
import { injected } from '@wagmi/connectors'
import { config } from './config'
const result = await connect(config, {
connector: injected(),
})import { connect } from '@wagmi/core'
import { injected } from '@wagmi/connectors'
import { config } from './config'
const result = await connect(config, {
connector: injected(),
})ts
import { http, createConfig } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'
export const config = createConfig({
chains: [mainnet, sepolia],
transports: {
[mainnet.id]: http(),
[sepolia.id]: http(),
},
})import { http, createConfig } 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
ts
import { type ConnectReturnType } from '@wagmi/core'import { type ConnectReturnType } from '@wagmi/core'accounts
readonly [Address, ...Address[]]
Connected accounts from connector.
chainId
number
Connected chain ID from connector.
Error
ts
import { type ConnectErrorType } from '@wagmi/core'import { type ConnectErrorType } from '@wagmi/core'TanStack Query
ts
import {
type ConnectData,
type ConnectVariables,
type ConnectMutate,
type ConnectMutateAsync,
connectMutationOptions,
} from '@wagmi/core/query'import {
type ConnectData,
type ConnectVariables,
type ConnectMutate,
type ConnectMutateAsync,
connectMutationOptions,
} from '@wagmi/core/query'