Skip to content

useClient

Primitive for getting Viem Client instance.

Import

ts
import { useClient } from '@wagmi/solid'

Usage

tsx
import { useClient } from '@wagmi/solid'

function App() {
  const client = useClient()
}
ts
import { createConfig, http } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

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

Parameters

ts
import { useClient } from '@wagmi/solid'

useClient.Parameters
useClient.SolidParameters

Parameters are passed as a getter function to maintain Solid reactivity.

ts
useClient(() => ({
  chainId: 1,
}))

chainId

config['chains'][number]['id'] | undefined

ID of chain to use when getting the client.

config

Config | undefined

Config to use instead of retrieving from the nearest WagmiProvider.

Return Type

ts
import { useClient } from '@wagmi/solid'

useClient.ReturnType

Accessor<Client | undefined>

Returns an accessor containing the Viem Client instance, or undefined if not available.

Action

Released under the MIT License.