wagmi 1.4.1 → 2.0.0

package/src/hooks/useContractSimulate.ts

@@ -0,0 +1,117 @@
+'use client'
+
+import type {
+  Config,
+  ResolvedRegister,
+  SimulateContractError,
+} from '@wagmi/core'
+import {
+  type SimulateContractData,
+  type SimulateContractOptions,
+  type SimulateContractQueryFnData,
+  type SimulateContractQueryKey,
+  simulateContractQueryOptions,
+} from '@wagmi/core/query'
+import type { Abi, ContractFunctionArgs, ContractFunctionName } from 'viem'
+
+import type { ConfigParameter } from '../types/properties.js'
+import {
+  type UseQueryParameters,
+  type UseQueryReturnType,
+  useQuery,
+} from '../utils/query.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+import { useConnectorClient } from './useConnectorClient.js'
+
+export type UseContractSimulateParameters<
+  abi extends Abi | readonly unknown[] = Abi,
+  functionName extends ContractFunctionName<
+    abi,
+    'nonpayable' | 'payable'
+  > = ContractFunctionName<abi, 'nonpayable' | 'payable'>,
+  args extends ContractFunctionArgs<
+    abi,
+    'nonpayable' | 'payable',
+    functionName
+  > = ContractFunctionArgs<abi, 'nonpayable' | 'payable', functionName>,
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] | undefined = undefined,
+  selectData = SimulateContractData<abi, functionName, args, config, chainId>,
+> = SimulateContractOptions<abi, functionName, args, config, chainId> &
+  ConfigParameter<config> & {
+    query?:
+      | UseQueryParameters<
+          SimulateContractQueryFnData<abi, functionName, args, config, chainId>,
+          SimulateContractError,
+          selectData,
+          SimulateContractQueryKey<abi, functionName, args, config, chainId>
+        >
+      | undefined
+  }
+
+export type UseContractSimulateReturnType<
+  abi extends Abi | readonly unknown[] = Abi,
+  functionName extends ContractFunctionName<
+    abi,
+    'nonpayable' | 'payable'
+  > = ContractFunctionName<abi, 'nonpayable' | 'payable'>,
+  args extends ContractFunctionArgs<
+    abi,
+    'nonpayable' | 'payable',
+    functionName
+  > = ContractFunctionArgs<abi, 'nonpayable' | 'payable', functionName>,
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] | undefined = undefined,
+  selectData = SimulateContractData<abi, functionName, args, config, chainId>,
+> = UseQueryReturnType<selectData, SimulateContractError>
+
+/** https://alpha.wagmi.sh/react/api/hooks/useContractSimulate */
+export function useContractSimulate<
+  const abi extends Abi | readonly unknown[],
+  functionName extends ContractFunctionName<abi, 'nonpayable' | 'payable'>,
+  args extends ContractFunctionArgs<
+    abi,
+    'nonpayable' | 'payable',
+    functionName
+  >,
+  config extends Config = ResolvedRegister['config'],
+  chainId extends config['chains'][number]['id'] | undefined = undefined,
+  selectData = SimulateContractData<abi, functionName, args, config, chainId>,
+>(
+  parameters: UseContractSimulateParameters<
+    abi,
+    functionName,
+    args,
+    config,
+    chainId,
+    selectData
+  > = {} as any,
+): UseContractSimulateReturnType<
+  abi,
+  functionName,
+  args,
+  config,
+  chainId,
+  selectData
+> {
+  const { abi, address, connector, functionName, query = {} } = parameters
+
+  const config = useConfig(parameters)
+  const { data: connectorClient } = useConnectorClient({
+    connector,
+    query: { enabled: parameters.account === undefined },
+  })
+  const chainId = useChainId()
+
+  const queryOptions = simulateContractQueryOptions(config, {
+    ...(parameters as any),
+    account: parameters.account ?? connectorClient?.account,
+    chainId: parameters.chainId ?? chainId,
+  })
+  const enabled = Boolean(
+    abi && address && functionName && (query.enabled ?? true),
+  )
+
+  return useQuery({ ...queryOptions, ...query, enabled })
+}

package/src/hooks/useContractWrite.ts

@@ -0,0 +1,83 @@
+'use client'
+
+import { useMutation } from '@tanstack/react-query'
+import type { Config, ResolvedRegister, WriteContractError } from '@wagmi/core'
+import {
+  type WriteContractData,
+  type WriteContractMutate,
+  type WriteContractMutateAsync,
+  type WriteContractVariables,
+  writeContractMutationOptions,
+} from '@wagmi/core/query'
+import type { Abi } from 'viem'
+
+import type { ConfigParameter } from '../types/properties.js'
+import type {
+  UseMutationParameters,
+  UseMutationReturnType,
+} from '../utils/query.js'
+import { useConfig } from './useConfig.js'
+
+export type UseContractWriteParameters<
+  config extends Config = Config,
+  context = unknown,
+> = ConfigParameter<config> & {
+  mutation?:
+    | UseMutationParameters<
+        WriteContractData,
+        WriteContractError,
+        WriteContractVariables<
+          Abi,
+          string,
+          readonly unknown[],
+          config,
+          config['chains'][number]['id']
+        >,
+        context
+      >
+    | undefined
+}
+
+export type UseContractWriteReturnType<
+  config extends Config = Config,
+  context = unknown,
+> = UseMutationReturnType<
+  WriteContractData,
+  WriteContractError,
+  WriteContractVariables<
+    Abi,
+    string,
+    readonly unknown[],
+    config,
+    config['chains'][number]['id']
+  >,
+  context
+> & {
+  write: WriteContractMutate<config, context>
+  writeAsync: WriteContractMutateAsync<config, context>
+}
+
+/** https://alpha.wagmi.sh/react/api/hooks/useContractWrite */
+export function useContractWrite<
+  config extends Config = ResolvedRegister['config'],
+  context = unknown,
+>(
+  parameters: UseContractWriteParameters<config, context> = {},
+): UseContractWriteReturnType<config, context> {
+  const { mutation } = parameters
+
+  const config = useConfig(parameters)
+
+  const mutationOptions = writeContractMutationOptions(config)
+  const { mutate, mutateAsync, ...result } = useMutation({
+    ...mutation,
+    ...mutationOptions,
+  })
+
+  type Return = UseContractWriteReturnType<config, context>
+  return {
+    ...result,
+    write: mutate as Return['write'],
+    writeAsync: mutateAsync as Return['writeAsync'],
+  }
+}

package/src/hooks/useDisconnect.ts

@@ -0,0 +1,68 @@
+'use client'
+
+import { useMutation } from '@tanstack/react-query'
+import { type Connector, type DisconnectError } from '@wagmi/core'
+import type { Evaluate } from '@wagmi/core/internal'
+import {
+  type DisconnectData,
+  type DisconnectMutate,
+  type DisconnectMutateAsync,
+  type DisconnectVariables,
+  disconnectMutationOptions,
+} from '@wagmi/core/query'
+
+import type { ConfigParameter } from '../types/properties.js'
+import type {
+  UseMutationParameters,
+  UseMutationReturnType,
+} from '../utils/query.js'
+import { useConfig } from './useConfig.js'
+import { useConnections } from './useConnections.js'
+
+export type UseDisconnectParameters<context = unknown> = Evaluate<
+  ConfigParameter & {
+    mutation?:
+      | UseMutationParameters<
+          DisconnectData,
+          DisconnectError,
+          DisconnectVariables,
+          context
+        >
+      | undefined
+  }
+>
+
+export type UseDisconnectReturnType<context = unknown> = Evaluate<
+  UseMutationReturnType<
+    DisconnectData,
+    DisconnectError,
+    DisconnectVariables,
+    context
+  > & {
+    connectors: readonly Connector[]
+    disconnect: DisconnectMutate<context>
+    disconnectAsync: DisconnectMutateAsync<context>
+  }
+>
+
+/** https://alpha.wagmi.sh/react/api/hooks/useDisconnect */
+export function useDisconnect<context = unknown>(
+  parameters: UseDisconnectParameters<context> = {},
+): UseDisconnectReturnType<context> {
+  const { mutation } = parameters
+
+  const config = useConfig(parameters)
+
+  const mutationOptions = disconnectMutationOptions(config)
+  const { mutate, mutateAsync, ...result } = useMutation({
+    ...mutation,
+    ...mutationOptions,
+  })
+
+  return {
+    ...result,
+    connectors: useConnections().map((connection) => connection.connector),
+    disconnect: mutate,
+    disconnectAsync: mutateAsync,
+  }
+}

package/src/hooks/useEnsAddress.ts

@@ -0,0 +1,61 @@
+'use client'
+
+import type { Config, GetEnsAddressError, ResolvedRegister } from '@wagmi/core'
+import { type Evaluate } from '@wagmi/core/internal'
+import {
+  type GetEnsAddressData,
+  type GetEnsAddressOptions,
+  type GetEnsAddressQueryFnData,
+  type GetEnsAddressQueryKey,
+  getEnsAddressQueryOptions,
+} from '@wagmi/core/query'
+
+import type { ConfigParameter } from '../types/properties.js'
+import {
+  type UseQueryParameters,
+  type UseQueryReturnType,
+  useQuery,
+} from '../utils/query.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+
+export type UseEnsAddressParameters<
+  config extends Config = Config,
+  selectData = GetEnsAddressData,
+> = Evaluate<
+  GetEnsAddressOptions<config> &
+    ConfigParameter<config> & {
+      query?:
+        | UseQueryParameters<
+            GetEnsAddressQueryFnData,
+            GetEnsAddressError,
+            selectData,
+            GetEnsAddressQueryKey<config>
+          >
+        | undefined
+    }
+>
+
+export type UseEnsAddressReturnType<selectData = GetEnsAddressData> =
+  UseQueryReturnType<selectData, GetEnsAddressError>
+
+/** https://alpha.wagmi.sh/react/api/hooks/useEnsAddress */
+export function useEnsAddress<
+  config extends Config = ResolvedRegister['config'],
+  selectData = GetEnsAddressData,
+>(
+  parameters: UseEnsAddressParameters<config, selectData> = {},
+): UseEnsAddressReturnType<selectData> {
+  const { name, query = {} } = parameters
+
+  const config = useConfig(parameters)
+  const chainId = useChainId()
+
+  const queryOptions = getEnsAddressQueryOptions(config, {
+    ...parameters,
+    chainId: parameters.chainId ?? chainId,
+  })
+  const enabled = Boolean(name && (query.enabled ?? true))
+
+  return useQuery({ ...queryOptions, ...query, enabled })
+}

package/src/hooks/useEnsAvatar.ts

@@ -0,0 +1,59 @@
+'use client'
+
+import type { Config, GetEnsAvatarError, ResolvedRegister } from '@wagmi/core'
+import { type Evaluate } from '@wagmi/core/internal'
+import {
+  type GetEnsAvatarData,
+  type GetEnsAvatarOptions,
+  type GetEnsAvatarQueryFnData,
+  type GetEnsAvatarQueryKey,
+  getEnsAvatarQueryOptions,
+} from '@wagmi/core/query'
+
+import type { ConfigParameter } from '../types/properties.js'
+import {
+  type UseQueryParameters,
+  type UseQueryReturnType,
+  useQuery,
+} from '../utils/query.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+
+export type UseEnsAvatarParameters<
+  config extends Config = Config,
+  selectData = GetEnsAvatarData,
+> = Evaluate<
+  GetEnsAvatarOptions<config> &
+    ConfigParameter<config> & {
+      query?: UseQueryParameters<
+        GetEnsAvatarQueryFnData,
+        GetEnsAvatarError,
+        selectData,
+        GetEnsAvatarQueryKey<config>
+      >
+    }
+>
+
+export type UseEnsAvatarReturnType<selectData = GetEnsAvatarData> =
+  UseQueryReturnType<selectData, GetEnsAvatarError>
+
+/** https://alpha.wagmi.sh/react/api/hooks/useEnsAvatar */
+export function useEnsAvatar<
+  config extends Config = ResolvedRegister['config'],
+  selectData = GetEnsAvatarData,
+>(
+  parameters: UseEnsAvatarParameters<config, selectData> = {},
+): UseEnsAvatarReturnType<selectData> {
+  const { name, query = {} } = parameters
+
+  const config = useConfig(parameters)
+  const chainId = useChainId()
+
+  const queryOptions = getEnsAvatarQueryOptions(config, {
+    ...parameters,
+    chainId: parameters.chainId ?? chainId,
+  })
+  const enabled = Boolean(name && (query.enabled ?? true))
+
+  return useQuery({ ...queryOptions, ...query, enabled })
+}

package/src/hooks/useEnsName.ts

@@ -0,0 +1,61 @@
+'use client'
+
+import type { Config, GetEnsNameError, ResolvedRegister } from '@wagmi/core'
+import { type Evaluate } from '@wagmi/core/internal'
+import {
+  type GetEnsNameData,
+  type GetEnsNameOptions,
+  type GetEnsNameQueryFnData,
+  type GetEnsNameQueryKey,
+  getEnsNameQueryOptions,
+} from '@wagmi/core/query'
+
+import type { ConfigParameter } from '../types/properties.js'
+import {
+  type UseQueryParameters,
+  type UseQueryReturnType,
+  useQuery,
+} from '../utils/query.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+
+export type UseEnsNameParameters<
+  config extends Config = Config,
+  selectData = GetEnsNameData,
+> = Evaluate<
+  GetEnsNameOptions<config> &
+    ConfigParameter<config> & {
+      query?:
+        | UseQueryParameters<
+            GetEnsNameQueryFnData,
+            GetEnsNameError,
+            selectData,
+            GetEnsNameQueryKey<config>
+          >
+        | undefined
+    }
+>
+
+export type UseEnsNameReturnType<selectData = GetEnsNameData> =
+  UseQueryReturnType<selectData, GetEnsNameError>
+
+/** https://alpha.wagmi.sh/react/api/hooks/useEnsName */
+export function useEnsName<
+  config extends Config = ResolvedRegister['config'],
+  selectData = GetEnsNameData,
+>(
+  parameters: UseEnsNameParameters<config, selectData> = {},
+): UseEnsNameReturnType<selectData> {
+  const { address, query = {} } = parameters
+
+  const config = useConfig(parameters)
+  const chainId = useChainId()
+
+  const queryOptions = getEnsNameQueryOptions(config, {
+    ...parameters,
+    chainId: parameters.chainId ?? chainId,
+  })
+  const enabled = Boolean(address && (query.enabled ?? true))
+
+  return useQuery({ ...queryOptions, ...query, enabled })
+}

package/src/hooks/useEnsResolver.ts

@@ -0,0 +1,61 @@
+'use client'
+
+import type { Config, GetEnsResolverError, ResolvedRegister } from '@wagmi/core'
+import { type Evaluate } from '@wagmi/core/internal'
+import {
+  type GetEnsResolverData,
+  type GetEnsResolverOptions,
+  type GetEnsResolverQueryFnData,
+  type GetEnsResolverQueryKey,
+  getEnsResolverQueryOptions,
+} from '@wagmi/core/query'
+
+import type { ConfigParameter } from '../types/properties.js'
+import {
+  type UseQueryParameters,
+  type UseQueryReturnType,
+  useQuery,
+} from '../utils/query.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+
+export type UseEnsResolverParameters<
+  config extends Config = Config,
+  selectData = GetEnsResolverData,
+> = Evaluate<
+  GetEnsResolverOptions<config> &
+    ConfigParameter<config> & {
+      query?:
+        | UseQueryParameters<
+            GetEnsResolverQueryFnData,
+            GetEnsResolverError,
+            selectData,
+            GetEnsResolverQueryKey<config>
+          >
+        | undefined
+    }
+>
+
+export type UseEnsResolverReturnType<selectData = GetEnsResolverData> =
+  UseQueryReturnType<selectData, GetEnsResolverError>
+
+/** https://alpha.wagmi.sh/react/api/hooks/useEnsResolver */
+export function useEnsResolver<
+  config extends Config = ResolvedRegister['config'],
+  selectData = GetEnsResolverData,
+>(
+  parameters: UseEnsResolverParameters<config, selectData> = {},
+): UseEnsResolverReturnType<selectData> {
+  const { name, query = {} } = parameters
+
+  const config = useConfig(parameters)
+  const chainId = useChainId()
+
+  const queryOptions = getEnsResolverQueryOptions(config, {
+    ...parameters,
+    chainId: parameters.chainId ?? chainId,
+  })
+  const enabled = Boolean(name && (query.enabled ?? true))
+
+  return useQuery({ ...queryOptions, ...query, enabled })
+}

package/src/hooks/useEstimateFeesPerGas.ts

@@ -0,0 +1,69 @@
+'use client'
+
+import {
+  type Config,
+  type EstimateFeesPerGasError,
+  type ResolvedRegister,
+} from '@wagmi/core'
+import { type Evaluate } from '@wagmi/core/internal'
+import {
+  type EstimateFeesPerGasData,
+  type EstimateFeesPerGasOptions,
+  type EstimateFeesPerGasQueryFnData,
+  type EstimateFeesPerGasQueryKey,
+  estimateFeesPerGasQueryOptions,
+} from '@wagmi/core/query'
+import type { FeeValuesType } from 'viem'
+
+import type { ConfigParameter } from '../types/properties.js'
+import {
+  type UseQueryParameters,
+  type UseQueryReturnType,
+  useQuery,
+} from '../utils/query.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+
+export type UseEstimateFeesPerGasParameters<
+  type extends FeeValuesType = FeeValuesType,
+  config extends Config = Config,
+  selectData = EstimateFeesPerGasData<type>,
+> = Evaluate<
+  EstimateFeesPerGasOptions<type, config> &
+    ConfigParameter<config> & {
+      query?:
+        | UseQueryParameters<
+            EstimateFeesPerGasQueryFnData<type>,
+            EstimateFeesPerGasError,
+            selectData,
+            EstimateFeesPerGasQueryKey<config, type>
+          >
+        | undefined
+    }
+>
+
+export type UseEstimateFeesPerGasReturnType<
+  type extends FeeValuesType = FeeValuesType,
+  selectData = EstimateFeesPerGasData<type>,
+> = UseQueryReturnType<selectData, EstimateFeesPerGasError>
+
+/** https://alpha.wagmi.sh/react/api/hooks/useEstimateFeesPerGas */
+export function useEstimateFeesPerGas<
+  config extends Config = ResolvedRegister['config'],
+  type extends FeeValuesType = 'eip1559',
+  selectData = EstimateFeesPerGasData<type>,
+>(
+  parameters: UseEstimateFeesPerGasParameters<type, config, selectData> = {},
+): UseEstimateFeesPerGasReturnType<type, selectData> {
+  const { query = {} } = parameters
+
+  const config = useConfig(parameters)
+  const chainId = useChainId()
+
+  const queryOptions = estimateFeesPerGasQueryOptions(config, {
+    ...parameters,
+    chainId: parameters.chainId ?? chainId,
+  })
+
+  return useQuery({ ...queryOptions, ...query })
+}

package/src/hooks/useEstimateGas.ts

@@ -0,0 +1,72 @@
+'use client'
+
+import type { Config, EstimateGasError, ResolvedRegister } from '@wagmi/core'
+import {
+  type EstimateGasData,
+  type EstimateGasOptions,
+  type EstimateGasQueryFnData,
+  type EstimateGasQueryKey,
+  estimateGasQueryOptions,
+} from '@wagmi/core/query'
+
+import type { ConfigParameter } from '../types/properties.js'
+import {
+  type UseQueryParameters,
+  type UseQueryReturnType,
+  useQuery,
+} from '../utils/query.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+import { useConnectorClient } from './useConnectorClient.js'
+
+export type UseEstimateGasParameters<
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] | undefined = undefined,
+  selectData = EstimateGasData,
+> = EstimateGasOptions<config, chainId> &
+  ConfigParameter<config> & {
+    query?:
+      | UseQueryParameters<
+          EstimateGasQueryFnData,
+          EstimateGasError,
+          selectData,
+          EstimateGasQueryKey<config, chainId>
+        >
+      | undefined
+  }
+
+export type UseEstimateGasReturnType<selectData = EstimateGasData> =
+  UseQueryReturnType<selectData, EstimateGasError>
+
+/** https://alpha.wagmi.sh/react/api/hooks/useEstimateGas */
+export function useEstimateGas<
+  config extends Config = ResolvedRegister['config'],
+  chainId extends config['chains'][number]['id'] | undefined = undefined,
+  selectData = EstimateGasData,
+>(
+  parameters?: UseEstimateGasParameters<config, chainId, selectData>,
+): UseEstimateGasReturnType<selectData>
+
+export function useEstimateGas(
+  parameters: UseEstimateGasParameters = {},
+): UseEstimateGasReturnType {
+  const { connector, query = {} } = parameters
+
+  const config = useConfig(parameters)
+  const { data: connectorClient } = useConnectorClient({
+    connector,
+    query: { enabled: parameters.account === undefined },
+  })
+  const account = parameters.account ?? connectorClient?.account
+  const chainId = useChainId()
+
+  const queryOptions = estimateGasQueryOptions(config, {
+    ...(parameters as any),
+    account,
+    chainId: parameters.chainId ?? chainId,
+    connector,
+  })
+  const enabled = Boolean((account || connector) && (query.enabled ?? true))
+
+  return useQuery({ ...queryOptions, ...query, enabled })
+}