wagmi 2.0.0 → 2.0.1

package/src/hooks/{useContractRead.ts → useReadContract.ts}

@@ -2,7 +2,7 @@
 
 import {
   type Config,
-  type ReadContractError,
+  type ReadContractErrorType,
   type ResolvedRegister,
 } from '@wagmi/core'
 import { type UnionEvaluate } from '@wagmi/core/internal'
@@ -19,9 +19,8 @@ import {
   type ContractFunctionName,
 } from 'viem'
 
-import type { ConfigParameter } from '../types/properties.js'
+import type { ConfigParameter, QueryParameter } from '../types/properties.js'
 import {
-  type UseQueryParameters,
   type UseQueryReturnType,
   structuralSharing,
   useQuery,
@@ -29,7 +28,7 @@ import {
 import { useChainId } from './useChainId.js'
 import { useConfig } from './useConfig.js'
 
-export type UseContractReadParameters<
+export type UseReadContractParameters<
   abi extends Abi | readonly unknown[] = Abi,
   functionName extends ContractFunctionName<
     abi,
@@ -44,19 +43,16 @@ export type UseContractReadParameters<
   selectData = ReadContractData<abi, functionName, args>,
 > = UnionEvaluate<
   ReadContractOptions<abi, functionName, args, config> &
-    ConfigParameter<config> & {
-      query?:
-        | UseQueryParameters<
-            ReadContractQueryFnData<abi, functionName, args>,
-            ReadContractError,
-            selectData,
-            ReadContractQueryKey<config, abi, functionName, args>
-          >
-        | undefined
-    }
+    ConfigParameter<config> &
+    QueryParameter<
+      ReadContractQueryFnData<abi, functionName, args>,
+      ReadContractErrorType,
+      selectData,
+      ReadContractQueryKey<abi, functionName, args, config>
+    >
 >
 
-export type UseContractReadReturnType<
+export type UseReadContractReturnType<
   abi extends Abi | readonly unknown[] = Abi,
   functionName extends ContractFunctionName<
     abi,
@@ -68,39 +64,40 @@ export type UseContractReadReturnType<
     functionName
   > = ContractFunctionArgs<abi, 'pure' | 'view', functionName>,
   selectData = ReadContractData<abi, functionName, args>,
-> = UseQueryReturnType<selectData, ReadContractError>
+> = UseQueryReturnType<selectData, ReadContractErrorType>
 
-/** https://alpha.wagmi.sh/react/api/hooks/useContractRead */
-export function useContractRead<
+/** https://wagmi.sh/react/api/hooks/useReadContract */
+export function useReadContract<
   const abi extends Abi | readonly unknown[],
   functionName extends ContractFunctionName<abi, 'pure' | 'view'>,
   args extends ContractFunctionArgs<abi, 'pure' | 'view', functionName>,
   config extends Config = ResolvedRegister['config'],
   selectData = ReadContractData<abi, functionName, args>,
 >(
-  parameters: UseContractReadParameters<
+  parameters: UseReadContractParameters<
     abi,
     functionName,
     args,
     config,
     selectData
   > = {} as any,
-): UseContractReadReturnType<abi, functionName, args, selectData> {
+): UseReadContractReturnType<abi, functionName, args, selectData> {
   const { abi, address, functionName, query = {} } = parameters
+
   const config = useConfig(parameters)
   const chainId = useChainId()
 
-  const queryOptions = readContractQueryOptions(config, {
-    ...(parameters as any),
-    chainId: parameters.chainId ?? chainId,
-  })
+  const options = readContractQueryOptions<config, abi, functionName, args>(
+    config,
+    { ...(parameters as any), chainId: parameters.chainId ?? chainId },
+  )
   const enabled = Boolean(
     address && abi && functionName && (query.enabled ?? true),
   )
 
   return useQuery({
-    ...queryOptions,
     ...query,
+    ...options,
     enabled,
     structuralSharing: query.structuralSharing ?? structuralSharing,
   })

package/src/hooks/{useContractReads.ts → useReadContracts.ts}

@@ -2,7 +2,7 @@
 
 import {
   type Config,
-  type ReadContractError,
+  type ReadContractsErrorType,
   type ResolvedRegister,
 } from '@wagmi/core'
 import { type Evaluate } from '@wagmi/core/internal'
@@ -14,11 +14,13 @@ import {
   readContractsQueryOptions,
 } from '@wagmi/core/query'
 import { useMemo } from 'react'
-import type { ContractFunctionParameters } from 'viem'
+import { type ContractFunctionParameters } from 'viem'
 
-import type { ConfigParameter } from '../types/properties.js'
 import {
-  type UseQueryParameters,
+  type ConfigParameter,
+  type QueryParameter,
+} from '../types/properties.js'
+import {
   type UseQueryReturnType,
   structuralSharing,
   useQuery,
@@ -26,55 +28,52 @@ import {
 import { useChainId } from './useChainId.js'
 import { useConfig } from './useConfig.js'
 
-export type UseContractReadsParameters<
+export type UseReadContractsParameters<
   contracts extends readonly unknown[] = readonly ContractFunctionParameters[],
   allowFailure extends boolean = true,
   config extends Config = Config,
   selectData = ReadContractsData<contracts, allowFailure>,
 > = Evaluate<
-  ReadContractsOptions<config, contracts, allowFailure> &
-    ConfigParameter<config> & {
-      query?:
-        | UseQueryParameters<
-            ReadContractsQueryFnData<contracts, allowFailure>,
-            ReadContractError,
-            selectData,
-            ReadContractsQueryKey<config, contracts, allowFailure>
-          >
-        | undefined
-    }
+  ReadContractsOptions<contracts, allowFailure, config> &
+    ConfigParameter<config> &
+    QueryParameter<
+      ReadContractsQueryFnData<contracts, allowFailure>,
+      ReadContractsErrorType,
+      selectData,
+      ReadContractsQueryKey<contracts, allowFailure, config>
+    >
 >
 
-export type UseContractReadsReturnType<
+export type UseReadContractsReturnType<
   contracts extends readonly unknown[] = readonly ContractFunctionParameters[],
   allowFailure extends boolean = true,
   selectData = ReadContractsData<contracts, allowFailure>,
-> = UseQueryReturnType<selectData, ReadContractError>
+> = UseQueryReturnType<selectData, ReadContractsErrorType>
 
-/** https://alpha.wagmi.sh/react/api/hooks/useContractReads */
-export function useContractReads<
+/** https://wagmi.sh/react/api/hooks/useReadContracts */
+export function useReadContracts<
   const contracts extends readonly unknown[],
   allowFailure extends boolean = true,
   config extends Config = ResolvedRegister['config'],
   selectData = ReadContractsData<contracts, allowFailure>,
 >(
-  parameters: UseContractReadsParameters<
+  parameters: UseReadContractsParameters<
     contracts,
     allowFailure,
     config,
     selectData
   > = {},
-): UseContractReadsReturnType<contracts, allowFailure, selectData> {
+): UseReadContractsReturnType<contracts, allowFailure, selectData> {
   const { contracts = [], query = {} } = parameters
 
   const config = useConfig(parameters)
   const chainId = useChainId()
 
-  const queryOptions = readContractsQueryOptions(config, {
-    ...parameters,
-    chainId,
-    contracts,
-  })
+  const options = readContractsQueryOptions<config, contracts, allowFailure>(
+    config,
+    { ...parameters, chainId },
+  )
+
   const enabled = useMemo(() => {
     let isContractsValid = false
     for (const contract of contracts) {
@@ -90,7 +89,7 @@ export function useContractReads<
   }, [contracts, query.enabled])
 
   return useQuery({
-    ...queryOptions,
+    ...options,
     ...query,
     enabled,
     structuralSharing: query.structuralSharing ?? structuralSharing,

package/src/hooks/useReconnect.ts

@@ -1,7 +1,7 @@
 'use client'
 
 import { useMutation } from '@tanstack/react-query'
-import { type Connector, type ReconnectError } from '@wagmi/core'
+import { type Connector, type ReconnectErrorType } from '@wagmi/core'
 import type { Evaluate } from '@wagmi/core/internal'
 import {
   type ReconnectData,
@@ -23,7 +23,7 @@ export type UseReconnectParameters<context = unknown> = Evaluate<
     mutation?:
       | UseMutationParameters<
           ReconnectData,
-          ReconnectError,
+          ReconnectErrorType,
           ReconnectVariables,
           context
         >
@@ -34,7 +34,7 @@ export type UseReconnectParameters<context = unknown> = Evaluate<
 export type UseReconnectReturnType<context = unknown> = Evaluate<
   UseMutationReturnType<
     ReconnectData,
-    ReconnectError,
+    ReconnectErrorType,
     ReconnectVariables,
     context
   > & {
@@ -44,7 +44,7 @@ export type UseReconnectReturnType<context = unknown> = Evaluate<
   }
 >
 
-/** https://alpha.wagmi.sh/react/api/hooks/useReconnect */
+/** https://wagmi.sh/react/api/hooks/useReconnect */
 export function useReconnect<context = unknown>(
   parameters: UseReconnectParameters<context> = {},
 ): UseReconnectReturnType<context> {

package/src/hooks/useSendTransaction.ts

@@ -4,7 +4,7 @@ import { useMutation } from '@tanstack/react-query'
 import type {
   Config,
   ResolvedRegister,
-  SendTransactionError,
+  SendTransactionErrorType,
 } from '@wagmi/core'
 import type { Evaluate } from '@wagmi/core/internal'
 import {
@@ -30,7 +30,7 @@ export type UseSendTransactionParameters<
     mutation?:
       | UseMutationParameters<
           SendTransactionData,
-          SendTransactionError,
+          SendTransactionErrorType,
           SendTransactionVariables<config, config['chains'][number]['id']>,
           context
         >
@@ -44,7 +44,7 @@ export type UseSendTransactionReturnType<
 > = Evaluate<
   UseMutationReturnType<
     SendTransactionData,
-    SendTransactionError,
+    SendTransactionErrorType,
     SendTransactionVariables<config, config['chains'][number]['id']>,
     context
   > & {
@@ -53,7 +53,7 @@ export type UseSendTransactionReturnType<
   }
 >
 
-/** https://alpha.wagmi.sh/react/api/hooks/useSendTransaction */
+/** https://wagmi.sh/react/api/hooks/useSendTransaction */
 export function useSendTransaction<
   config extends Config = ResolvedRegister['config'],
   context = unknown,

package/src/hooks/useSignMessage.ts

@@ -1,7 +1,7 @@
 'use client'
 
 import { useMutation } from '@tanstack/react-query'
-import { type SignMessageError } from '@wagmi/core'
+import { type SignMessageErrorType } from '@wagmi/core'
 import type { Evaluate } from '@wagmi/core/internal'
 import {
   type SignMessageData,
@@ -23,7 +23,7 @@ export type UseSignMessageParameters<context = unknown> = Evaluate<
     mutation?:
       | UseMutationParameters<
           SignMessageData,
-          SignMessageError,
+          SignMessageErrorType,
           SignMessageVariables,
           context
         >
@@ -34,7 +34,7 @@ export type UseSignMessageParameters<context = unknown> = Evaluate<
 export type UseSignMessageReturnType<context = unknown> = Evaluate<
   UseMutationReturnType<
     SignMessageData,
-    SignMessageError,
+    SignMessageErrorType,
     SignMessageVariables,
     context
   > & {
@@ -43,7 +43,7 @@ export type UseSignMessageReturnType<context = unknown> = Evaluate<
   }
 >
 
-/** https://alpha.wagmi.sh/react/api/hooks/useSignMessage */
+/** https://wagmi.sh/react/api/hooks/useSignMessage */
 export function useSignMessage<context = unknown>(
   parameters: UseSignMessageParameters<context> = {},
 ): UseSignMessageReturnType<context> {

package/src/hooks/useSignTypedData.ts

@@ -1,7 +1,7 @@
 'use client'
 
 import { useMutation } from '@tanstack/react-query'
-import type { SignTypedDataError } from '@wagmi/core'
+import type { SignTypedDataErrorType } from '@wagmi/core'
 import type { Evaluate } from '@wagmi/core/internal'
 import {
   type SignTypedDataData,
@@ -23,7 +23,7 @@ export type UseSignTypedDataParameters<context = unknown> = Evaluate<
     mutation?:
       | UseMutationParameters<
           SignTypedDataData,
-          SignTypedDataError,
+          SignTypedDataErrorType,
           SignTypedDataVariables,
           context
         >
@@ -34,7 +34,7 @@ export type UseSignTypedDataParameters<context = unknown> = Evaluate<
 export type UseSignTypedDataReturnType<context = unknown> = Evaluate<
   UseMutationReturnType<
     SignTypedDataData,
-    SignTypedDataError,
+    SignTypedDataErrorType,
     SignTypedDataVariables,
     context
   > & {
@@ -43,7 +43,7 @@ export type UseSignTypedDataReturnType<context = unknown> = Evaluate<
   }
 >
 
-/** https://alpha.wagmi.sh/react/api/hooks/useSignTypedData */
+/** https://wagmi.sh/react/api/hooks/useSignTypedData */
 export function useSignTypedData<context = unknown>(
   parameters: UseSignTypedDataParameters<context> = {},
 ): UseSignTypedDataReturnType<context> {

package/src/hooks/{useContractSimulate.ts → useSimulateContract.ts}

@@ -3,7 +3,7 @@
 import type {
   Config,
   ResolvedRegister,
-  SimulateContractError,
+  SimulateContractErrorType,
 } from '@wagmi/core'
 import {
   type SimulateContractData,
@@ -14,17 +14,13 @@ import {
 } 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 type { ConfigParameter, QueryParameter } from '../types/properties.js'
+import { 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<
+export type UseSimulateContractParameters<
   abi extends Abi | readonly unknown[] = Abi,
   functionName extends ContractFunctionName<
     abi,
@@ -39,18 +35,15 @@ export type UseContractSimulateParameters<
   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
-  }
+  ConfigParameter<config> &
+  QueryParameter<
+    SimulateContractQueryFnData<abi, functionName, args, config, chainId>,
+    SimulateContractErrorType,
+    selectData,
+    SimulateContractQueryKey<abi, functionName, args, config, chainId>
+  >
 
-export type UseContractSimulateReturnType<
+export type UseSimulateContractReturnType<
   abi extends Abi | readonly unknown[] = Abi,
   functionName extends ContractFunctionName<
     abi,
@@ -64,10 +57,10 @@ export type UseContractSimulateReturnType<
   config extends Config = Config,
   chainId extends config['chains'][number]['id'] | undefined = undefined,
   selectData = SimulateContractData<abi, functionName, args, config, chainId>,
-> = UseQueryReturnType<selectData, SimulateContractError>
+> = UseQueryReturnType<selectData, SimulateContractErrorType>
 
-/** https://alpha.wagmi.sh/react/api/hooks/useContractSimulate */
-export function useContractSimulate<
+/** https://wagmi.sh/react/api/hooks/useSimulateContract */
+export function useSimulateContract<
   const abi extends Abi | readonly unknown[],
   functionName extends ContractFunctionName<abi, 'nonpayable' | 'payable'>,
   args extends ContractFunctionArgs<
@@ -79,7 +72,7 @@ export function useContractSimulate<
   chainId extends config['chains'][number]['id'] | undefined = undefined,
   selectData = SimulateContractData<abi, functionName, args, config, chainId>,
 >(
-  parameters: UseContractSimulateParameters<
+  parameters: UseSimulateContractParameters<
     abi,
     functionName,
     args,
@@ -87,7 +80,7 @@ export function useContractSimulate<
     chainId,
     selectData
   > = {} as any,
-): UseContractSimulateReturnType<
+): UseSimulateContractReturnType<
   abi,
   functionName,
   args,
@@ -104,8 +97,14 @@ export function useContractSimulate<
   })
   const chainId = useChainId()
 
-  const queryOptions = simulateContractQueryOptions(config, {
-    ...(parameters as any),
+  const options = simulateContractQueryOptions<
+    config,
+    abi,
+    functionName,
+    args,
+    chainId
+  >(config, {
+    ...parameters,
     account: parameters.account ?? connectorClient?.account,
     chainId: parameters.chainId ?? chainId,
   })
@@ -113,5 +112,5 @@ export function useContractSimulate<
     abi && address && functionName && (query.enabled ?? true),
   )
 
-  return useQuery({ ...queryOptions, ...query, enabled })
+  return useQuery({ ...query, ...options, enabled })
 }

package/src/hooks/useSwitchAccount.ts

@@ -5,7 +5,7 @@ import type {
   Config,
   Connector,
   ResolvedRegister,
-  SwitchAccountError,
+  SwitchAccountErrorType,
 } from '@wagmi/core'
 import type { Evaluate } from '@wagmi/core/internal'
 import {
@@ -32,7 +32,7 @@ export type UseSwitchAccountParameters<
     mutation?:
       | UseMutationParameters<
           SwitchAccountData<config>,
-          SwitchAccountError,
+          SwitchAccountErrorType,
           SwitchAccountVariables,
           context
         >
@@ -46,7 +46,7 @@ export type UseSwitchAccountReturnType<
 > = Evaluate<
   UseMutationReturnType<
     SwitchAccountData<config>,
-    SwitchAccountError,
+    SwitchAccountErrorType,
     SwitchAccountVariables,
     context
   > & {
@@ -56,7 +56,7 @@ export type UseSwitchAccountReturnType<
   }
 >
 
-/** https://alpha.wagmi.sh/react/api/hooks/useSwitchAccount */
+/** https://wagmi.sh/react/api/hooks/useSwitchAccount */
 export function useSwitchAccount<
   config extends Config = ResolvedRegister['config'],
   context = unknown,

package/src/hooks/useSwitchChain.ts

@@ -1,7 +1,11 @@
 'use client'
 
 import { useMutation } from '@tanstack/react-query'
-import type { Config, ResolvedRegister, SwitchChainError } from '@wagmi/core'
+import type {
+  Config,
+  ResolvedRegister,
+  SwitchChainErrorType,
+} from '@wagmi/core'
 import type { Evaluate } from '@wagmi/core/internal'
 import {
   type SwitchChainData,
@@ -26,7 +30,7 @@ export type UseSwitchChainParameters<
     mutation?:
       | UseMutationParameters<
           SwitchChainData<config, config['chains'][number]['id']>,
-          SwitchChainError,
+          SwitchChainErrorType,
           SwitchChainVariables<config, config['chains'][number]['id']>,
           context
         >
@@ -40,7 +44,7 @@ export type UseSwitchChainReturnType<
 > = Evaluate<
   UseMutationReturnType<
     SwitchChainData<config, config['chains'][number]['id']>,
-    SwitchChainError,
+    SwitchChainErrorType,
     SwitchChainVariables<config, config['chains'][number]['id']>,
     context
   > & {
@@ -50,7 +54,7 @@ export type UseSwitchChainReturnType<
   }
 >
 
-/** https://alpha.wagmi.sh/react/api/hooks/useSwitchChain */
+/** https://wagmi.sh/react/api/hooks/useSwitchChain */
 export function useSwitchChain<
   config extends Config = ResolvedRegister['config'],
   context = unknown,

package/src/hooks/useToken.ts

@@ -1,6 +1,6 @@
 'use client'
 
-import type { Config, GetTokenError, ResolvedRegister } from '@wagmi/core'
+import type { Config, GetTokenErrorType, ResolvedRegister } from '@wagmi/core'
 import { type Evaluate } from '@wagmi/core/internal'
 import {
   type GetTokenData,
@@ -10,12 +10,8 @@ import {
   getTokenQueryOptions,
 } from '@wagmi/core/query'
 
-import type { ConfigParameter } from '../types/properties.js'
-import {
-  type UseQueryParameters,
-  type UseQueryReturnType,
-  useQuery,
-} from '../utils/query.js'
+import type { ConfigParameter, QueryParameter } from '../types/properties.js'
+import { type UseQueryReturnType, useQuery } from '../utils/query.js'
 import { useChainId } from './useChainId.js'
 import { useConfig } from './useConfig.js'
 
@@ -24,24 +20,25 @@ export type UseTokenParameters<
   selectData = GetTokenData,
 > = Evaluate<
   GetTokenOptions<config> &
-    ConfigParameter<config> & {
-      query?:
-        | UseQueryParameters<
-            GetTokenQueryFnData,
-            GetTokenError,
-            selectData,
-            GetTokenQueryKey<config>
-          >
-        | undefined
-    }
+    ConfigParameter<config> &
+    QueryParameter<
+      GetTokenQueryFnData,
+      GetTokenErrorType,
+      selectData,
+      GetTokenQueryKey<config>
+    >
 >
 
 export type UseTokenReturnType<selectData = GetTokenData> = UseQueryReturnType<
   selectData,
-  GetTokenError
+  GetTokenErrorType
 >
 
-/** https://alpha.wagmi.sh/react/api/hooks/useToken */
+/**
+ * @deprecated
+ *
+ * https://wagmi.sh/react/api/hooks/useToken
+ */
 export function useToken<
   config extends Config = ResolvedRegister['config'],
   selectData = GetTokenData,
@@ -53,11 +50,11 @@ export function useToken<
   const config = useConfig(parameters)
   const chainId = useChainId()
 
-  const queryOptions = getTokenQueryOptions(config, {
+  const options = getTokenQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
   })
   const enabled = Boolean(address && (query.enabled ?? true))
 
-  return useQuery({ ...queryOptions, ...query, enabled })
+  return useQuery({ ...query, ...options, enabled })
 }