wagmi 2.0.0 → 2.0.2

package/src/hooks/useEnsAvatar.ts

@@ -1,6 +1,10 @@
 'use client'
 
-import type { Config, GetEnsAvatarError, ResolvedRegister } from '@wagmi/core'
+import type {
+  Config,
+  GetEnsAvatarErrorType,
+  ResolvedRegister,
+} from '@wagmi/core'
 import { type Evaluate } from '@wagmi/core/internal'
 import {
   type GetEnsAvatarData,
@@ -10,12 +14,8 @@ import {
   getEnsAvatarQueryOptions,
 } 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,20 +24,19 @@ export type UseEnsAvatarParameters<
   selectData = GetEnsAvatarData,
 > = Evaluate<
   GetEnsAvatarOptions<config> &
-    ConfigParameter<config> & {
-      query?: UseQueryParameters<
-        GetEnsAvatarQueryFnData,
-        GetEnsAvatarError,
-        selectData,
-        GetEnsAvatarQueryKey<config>
-      >
-    }
+    ConfigParameter<config> &
+    QueryParameter<
+      GetEnsAvatarQueryFnData,
+      GetEnsAvatarErrorType,
+      selectData,
+      GetEnsAvatarQueryKey<config>
+    >
 >
 
 export type UseEnsAvatarReturnType<selectData = GetEnsAvatarData> =
-  UseQueryReturnType<selectData, GetEnsAvatarError>
+  UseQueryReturnType<selectData, GetEnsAvatarErrorType>
 
-/** https://alpha.wagmi.sh/react/api/hooks/useEnsAvatar */
+/** https://wagmi.sh/react/api/hooks/useEnsAvatar */
 export function useEnsAvatar<
   config extends Config = ResolvedRegister['config'],
   selectData = GetEnsAvatarData,
@@ -49,11 +48,11 @@ export function useEnsAvatar<
   const config = useConfig(parameters)
   const chainId = useChainId()
 
-  const queryOptions = getEnsAvatarQueryOptions(config, {
+  const options = getEnsAvatarQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
   })
   const enabled = Boolean(name && (query.enabled ?? true))
 
-  return useQuery({ ...queryOptions, ...query, enabled })
+  return useQuery({ ...query, ...options, enabled })
 }

package/src/hooks/useEnsName.ts

@@ -1,6 +1,6 @@
 'use client'
 
-import type { Config, GetEnsNameError, ResolvedRegister } from '@wagmi/core'
+import type { Config, GetEnsNameErrorType, ResolvedRegister } from '@wagmi/core'
 import { type Evaluate } from '@wagmi/core/internal'
 import {
   type GetEnsNameData,
@@ -10,12 +10,8 @@ import {
   getEnsNameQueryOptions,
 } 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,22 +20,19 @@ export type UseEnsNameParameters<
   selectData = GetEnsNameData,
 > = Evaluate<
   GetEnsNameOptions<config> &
-    ConfigParameter<config> & {
-      query?:
-        | UseQueryParameters<
-            GetEnsNameQueryFnData,
-            GetEnsNameError,
-            selectData,
-            GetEnsNameQueryKey<config>
-          >
-        | undefined
-    }
+    ConfigParameter<config> &
+    QueryParameter<
+      GetEnsNameQueryFnData,
+      GetEnsNameErrorType,
+      selectData,
+      GetEnsNameQueryKey<config>
+    >
 >
 
 export type UseEnsNameReturnType<selectData = GetEnsNameData> =
-  UseQueryReturnType<selectData, GetEnsNameError>
+  UseQueryReturnType<selectData, GetEnsNameErrorType>
 
-/** https://alpha.wagmi.sh/react/api/hooks/useEnsName */
+/** https://wagmi.sh/react/api/hooks/useEnsName */
 export function useEnsName<
   config extends Config = ResolvedRegister['config'],
   selectData = GetEnsNameData,
@@ -51,11 +44,11 @@ export function useEnsName<
   const config = useConfig(parameters)
   const chainId = useChainId()
 
-  const queryOptions = getEnsNameQueryOptions(config, {
+  const options = getEnsNameQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
   })
   const enabled = Boolean(address && (query.enabled ?? true))
 
-  return useQuery({ ...queryOptions, ...query, enabled })
+  return useQuery({ ...query, ...options, enabled })
 }

package/src/hooks/useEnsResolver.ts

@@ -1,6 +1,10 @@
 'use client'
 
-import type { Config, GetEnsResolverError, ResolvedRegister } from '@wagmi/core'
+import type {
+  Config,
+  GetEnsResolverErrorType,
+  ResolvedRegister,
+} from '@wagmi/core'
 import { type Evaluate } from '@wagmi/core/internal'
 import {
   type GetEnsResolverData,
@@ -10,12 +14,8 @@ import {
   getEnsResolverQueryOptions,
 } 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,22 +24,19 @@ export type UseEnsResolverParameters<
   selectData = GetEnsResolverData,
 > = Evaluate<
   GetEnsResolverOptions<config> &
-    ConfigParameter<config> & {
-      query?:
-        | UseQueryParameters<
-            GetEnsResolverQueryFnData,
-            GetEnsResolverError,
-            selectData,
-            GetEnsResolverQueryKey<config>
-          >
-        | undefined
-    }
+    ConfigParameter<config> &
+    QueryParameter<
+      GetEnsResolverQueryFnData,
+      GetEnsResolverErrorType,
+      selectData,
+      GetEnsResolverQueryKey<config>
+    >
 >
 
 export type UseEnsResolverReturnType<selectData = GetEnsResolverData> =
-  UseQueryReturnType<selectData, GetEnsResolverError>
+  UseQueryReturnType<selectData, GetEnsResolverErrorType>
 
-/** https://alpha.wagmi.sh/react/api/hooks/useEnsResolver */
+/** https://wagmi.sh/react/api/hooks/useEnsResolver */
 export function useEnsResolver<
   config extends Config = ResolvedRegister['config'],
   selectData = GetEnsResolverData,
@@ -51,11 +48,11 @@ export function useEnsResolver<
   const config = useConfig(parameters)
   const chainId = useChainId()
 
-  const queryOptions = getEnsResolverQueryOptions(config, {
+  const options = getEnsResolverQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
   })
   const enabled = Boolean(name && (query.enabled ?? true))
 
-  return useQuery({ ...queryOptions, ...query, enabled })
+  return useQuery({ ...query, ...options, enabled })
 }

package/src/hooks/useEstimateFeesPerGas.ts

@@ -2,7 +2,7 @@
 
 import {
   type Config,
-  type EstimateFeesPerGasError,
+  type EstimateFeesPerGasErrorType,
   type ResolvedRegister,
 } from '@wagmi/core'
 import { type Evaluate } from '@wagmi/core/internal'
@@ -15,12 +15,8 @@ import {
 } 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 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'
 
@@ -30,24 +26,21 @@ export type UseEstimateFeesPerGasParameters<
   selectData = EstimateFeesPerGasData<type>,
 > = Evaluate<
   EstimateFeesPerGasOptions<type, config> &
-    ConfigParameter<config> & {
-      query?:
-        | UseQueryParameters<
-            EstimateFeesPerGasQueryFnData<type>,
-            EstimateFeesPerGasError,
-            selectData,
-            EstimateFeesPerGasQueryKey<config, type>
-          >
-        | undefined
-    }
+    ConfigParameter<config> &
+    QueryParameter<
+      EstimateFeesPerGasQueryFnData<type>,
+      EstimateFeesPerGasErrorType,
+      selectData,
+      EstimateFeesPerGasQueryKey<config, type>
+    >
 >
 
 export type UseEstimateFeesPerGasReturnType<
   type extends FeeValuesType = FeeValuesType,
   selectData = EstimateFeesPerGasData<type>,
-> = UseQueryReturnType<selectData, EstimateFeesPerGasError>
+> = UseQueryReturnType<selectData, EstimateFeesPerGasErrorType>
 
-/** https://alpha.wagmi.sh/react/api/hooks/useEstimateFeesPerGas */
+/** https://wagmi.sh/react/api/hooks/useEstimateFeesPerGas */
 export function useEstimateFeesPerGas<
   config extends Config = ResolvedRegister['config'],
   type extends FeeValuesType = 'eip1559',
@@ -60,10 +53,10 @@ export function useEstimateFeesPerGas<
   const config = useConfig(parameters)
   const chainId = useChainId()
 
-  const queryOptions = estimateFeesPerGasQueryOptions(config, {
+  const options = estimateFeesPerGasQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
   })
 
-  return useQuery({ ...queryOptions, ...query })
+  return useQuery({ ...query, ...options })
 }

package/src/hooks/useEstimateGas.ts

@@ -1,6 +1,10 @@
 'use client'
 
-import type { Config, EstimateGasError, ResolvedRegister } from '@wagmi/core'
+import type {
+  Config,
+  EstimateGasErrorType,
+  ResolvedRegister,
+} from '@wagmi/core'
 import {
   type EstimateGasData,
   type EstimateGasOptions,
@@ -9,12 +13,8 @@ import {
   estimateGasQueryOptions,
 } 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'
 import { useConnectorClient } from './useConnectorClient.js'
@@ -24,21 +24,18 @@ export type UseEstimateGasParameters<
   chainId extends config['chains'][number]['id'] | undefined = undefined,
   selectData = EstimateGasData,
 > = EstimateGasOptions<config, chainId> &
-  ConfigParameter<config> & {
-    query?:
-      | UseQueryParameters<
-          EstimateGasQueryFnData,
-          EstimateGasError,
-          selectData,
-          EstimateGasQueryKey<config, chainId>
-        >
-      | undefined
-  }
+  ConfigParameter<config> &
+  QueryParameter<
+    EstimateGasQueryFnData,
+    EstimateGasErrorType,
+    selectData,
+    EstimateGasQueryKey<config, chainId>
+  >
 
 export type UseEstimateGasReturnType<selectData = EstimateGasData> =
-  UseQueryReturnType<selectData, EstimateGasError>
+  UseQueryReturnType<selectData, EstimateGasErrorType>
 
-/** https://alpha.wagmi.sh/react/api/hooks/useEstimateGas */
+/** https://wagmi.sh/react/api/hooks/useEstimateGas */
 export function useEstimateGas<
   config extends Config = ResolvedRegister['config'],
   chainId extends config['chains'][number]['id'] | undefined = undefined,
@@ -60,13 +57,13 @@ export function useEstimateGas(
   const account = parameters.account ?? connectorClient?.account
   const chainId = useChainId()
 
-  const queryOptions = estimateGasQueryOptions(config, {
-    ...(parameters as any),
+  const options = estimateGasQueryOptions(config, {
+    ...parameters,
     account,
     chainId: parameters.chainId ?? chainId,
     connector,
   })
   const enabled = Boolean((account || connector) && (query.enabled ?? true))
 
-  return useQuery({ ...queryOptions, ...query, enabled })
+  return useQuery({ ...query, ...options, enabled })
 }

package/src/hooks/useEstimateMaxPriorityFeePerGas.ts

@@ -0,0 +1,61 @@
+'use client'
+
+import {
+  type Config,
+  type EstimateMaxPriorityFeePerGasErrorType,
+  type ResolvedRegister,
+} from '@wagmi/core'
+import { type Evaluate } from '@wagmi/core/internal'
+import {
+  type EstimateMaxPriorityFeePerGasData,
+  type EstimateMaxPriorityFeePerGasOptions,
+  type EstimateMaxPriorityFeePerGasQueryFnData,
+  type EstimateMaxPriorityFeePerGasQueryKey,
+  estimateMaxPriorityFeePerGasQueryOptions,
+} from '@wagmi/core/query'
+
+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'
+
+export type UseEstimateMaxPriorityFeePerGasParameters<
+  config extends Config = Config,
+  selectData = EstimateMaxPriorityFeePerGasData,
+> = Evaluate<
+  EstimateMaxPriorityFeePerGasOptions<config> &
+    ConfigParameter<config> &
+    QueryParameter<
+      EstimateMaxPriorityFeePerGasQueryFnData,
+      EstimateMaxPriorityFeePerGasErrorType,
+      selectData,
+      EstimateMaxPriorityFeePerGasQueryKey<config>
+    >
+>
+
+export type UseEstimateMaxPriorityFeePerGasReturnType<
+  selectData = EstimateMaxPriorityFeePerGasData,
+> = UseQueryReturnType<selectData, EstimateMaxPriorityFeePerGasErrorType>
+
+/** https://wagmi.sh/react/api/hooks/useEstimateMaxPriorityFeePerGas */
+export function useEstimateMaxPriorityFeePerGas<
+  config extends Config = ResolvedRegister['config'],
+  selectData = EstimateMaxPriorityFeePerGasData,
+>(
+  parameters: UseEstimateMaxPriorityFeePerGasParameters<
+    config,
+    selectData
+  > = {},
+): UseEstimateMaxPriorityFeePerGasReturnType<selectData> {
+  const { query = {} } = parameters
+
+  const config = useConfig(parameters)
+  const chainId = useChainId()
+
+  const options = estimateMaxPriorityFeePerGasQueryOptions(config, {
+    ...parameters,
+    chainId: parameters.chainId ?? chainId,
+  })
+
+  return useQuery({ ...query, ...options })
+}

package/src/hooks/useFeeHistory.ts

@@ -0,0 +1,62 @@
+'use client'
+
+import {
+  type Config,
+  type GetFeeHistoryErrorType,
+  type ResolvedRegister,
+} from '@wagmi/core'
+import { type Evaluate } from '@wagmi/core/internal'
+import {
+  type GetFeeHistoryData,
+  type GetFeeHistoryOptions,
+  type GetFeeHistoryQueryFnData,
+  type GetFeeHistoryQueryKey,
+  getFeeHistoryQueryOptions,
+} from '@wagmi/core/query'
+
+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'
+
+export type UseFeeHistoryParameters<
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = GetFeeHistoryData,
+> = Evaluate<
+  GetFeeHistoryOptions<config, chainId> &
+    ConfigParameter<config> &
+    QueryParameter<
+      GetFeeHistoryQueryFnData,
+      GetFeeHistoryErrorType,
+      selectData,
+      GetFeeHistoryQueryKey<config, chainId>
+    >
+>
+
+export type UseFeeHistoryReturnType<selectData = GetFeeHistoryData> =
+  UseQueryReturnType<selectData, GetFeeHistoryErrorType>
+
+/** https://wagmi.sh/react/api/hooks/useFeeHistory */
+export function useFeeHistory<
+  config extends Config = ResolvedRegister['config'],
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = GetFeeHistoryData,
+>(
+  parameters: UseFeeHistoryParameters<config, chainId, selectData> = {},
+): UseFeeHistoryReturnType<selectData> {
+  const { blockCount, rewardPercentiles, query = {} } = parameters
+
+  const config = useConfig(parameters)
+  const chainId = useChainId()
+
+  const options = getFeeHistoryQueryOptions(config, {
+    ...parameters,
+    chainId: parameters.chainId ?? chainId,
+  })
+  const enabled = Boolean(
+    blockCount && rewardPercentiles && (query.enabled ?? true),
+  )
+
+  return useQuery({ ...query, ...options, enabled })
+}

package/src/hooks/useGasPrice.ts

@@ -0,0 +1,60 @@
+'use client'
+
+import {
+  type Config,
+  type GetGasPriceErrorType,
+  type ResolvedRegister,
+} from '@wagmi/core'
+import { type Evaluate } from '@wagmi/core/internal'
+import {
+  type GetGasPriceData,
+  type GetGasPriceOptions,
+  type GetGasPriceQueryFnData,
+  type GetGasPriceQueryKey,
+  getGasPriceQueryOptions,
+} from '@wagmi/core/query'
+
+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'
+
+export type UseGasPriceParameters<
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = GetGasPriceData,
+> = Evaluate<
+  GetGasPriceOptions<config, chainId> &
+    ConfigParameter<config> &
+    QueryParameter<
+      GetGasPriceQueryFnData,
+      GetGasPriceErrorType,
+      selectData,
+      GetGasPriceQueryKey<config, chainId>
+    >
+>
+
+export type UseGasPriceReturnType<selectData = GetGasPriceData> =
+  UseQueryReturnType<selectData, GetGasPriceErrorType>
+
+/** https://wagmi.sh/react/api/hooks/useGasPrice */
+export function useGasPrice<
+  config extends Config = ResolvedRegister['config'],
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = GetGasPriceData,
+>(
+  parameters: UseGasPriceParameters<config, chainId, selectData> = {},
+): UseGasPriceReturnType<selectData> {
+  const { query = {} } = parameters
+
+  const config = useConfig(parameters)
+  const configChainId = useChainId()
+  const chainId = parameters.chainId ?? configChainId
+
+  const options = getGasPriceQueryOptions(config, {
+    ...parameters,
+    chainId,
+  })
+
+  return useQuery({ ...query, ...options })
+}

package/src/hooks/useInfiniteReadContracts.ts

@@ -0,0 +1,89 @@
+'use client'
+
+import type {
+  Config,
+  ReadContractsErrorType,
+  ResolvedRegister,
+} from '@wagmi/core'
+import {
+  type InfiniteReadContractsQueryFnData,
+  type InfiniteReadContractsQueryKey,
+  infiniteReadContractsQueryOptions,
+} from '@wagmi/core/query'
+import type { ContractFunctionParameters } from 'viem'
+
+import type {
+  InfiniteReadContractsData,
+  InfiniteReadContractsOptions,
+} from '../exports/query.js'
+import type {
+  ConfigParameter,
+  InfiniteQueryParameter,
+} from '../types/properties.js'
+import {
+  type UseInfiniteQueryParameters,
+  type UseInfiniteQueryReturnType,
+  structuralSharing,
+  useInfiniteQuery,
+} from '../utils/query.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+
+export type UseInfiniteContractReadsParameters<
+  contracts extends readonly unknown[] = readonly ContractFunctionParameters[],
+  allowFailure extends boolean = true,
+  config extends Config = Config,
+  pageParam = unknown,
+  selectData = InfiniteReadContractsData<contracts, allowFailure>,
+> = InfiniteReadContractsOptions<contracts, allowFailure, pageParam, config> &
+  ConfigParameter<config> &
+  InfiniteQueryParameter<
+    InfiniteReadContractsQueryFnData<contracts, allowFailure>,
+    ReadContractsErrorType,
+    selectData,
+    InfiniteReadContractsData<contracts, allowFailure>,
+    InfiniteReadContractsQueryKey<contracts, allowFailure, pageParam, config>,
+    pageParam
+  >
+
+export type UseInfiniteContractReadsReturnType<
+  contracts extends readonly unknown[] = readonly ContractFunctionParameters[],
+  allowFailure extends boolean = true,
+  selectData = InfiniteReadContractsData<contracts, allowFailure>,
+> = UseInfiniteQueryReturnType<selectData, ReadContractsErrorType>
+
+/** https://wagmi.sh/react/api/hooks/useInfiniteReadContracts */
+export function useInfiniteReadContracts<
+  const contracts extends readonly unknown[],
+  allowFailure extends boolean = true,
+  config extends Config = ResolvedRegister['config'],
+  pageParam = unknown,
+  selectData = InfiniteReadContractsData<contracts, allowFailure>,
+>(
+  parameters: UseInfiniteContractReadsParameters<
+    contracts,
+    allowFailure,
+    config,
+    pageParam,
+    selectData
+  >,
+): UseInfiniteContractReadsReturnType<contracts, allowFailure, selectData> {
+  const { contracts = [], query } = parameters
+
+  const config = useConfig(parameters)
+  const chainId = useChainId()
+
+  const options = infiniteReadContractsQueryOptions(config, {
+    ...parameters,
+    chainId,
+    contracts: contracts as UseInfiniteContractReadsParameters['contracts'],
+    query: query as UseInfiniteQueryParameters,
+  })
+
+  return useInfiniteQuery({
+    ...(query as any),
+    ...options,
+    initialPageParam: options.initialPageParam,
+    structuralSharing: query.structuralSharing ?? structuralSharing,
+  })
+}

package/src/hooks/usePublicClient.ts

@@ -26,7 +26,7 @@ export type UsePublicClientReturnType<
   chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
 > = GetPublicClientReturnType<config, chainId>
 
-/** https://alpha.wagmi.sh/react/api/hooks/usePublicClient */
+/** https://wagmi.sh/react/api/hooks/usePublicClient */
 export function usePublicClient<
   config extends Config = ResolvedRegister['config'],
   chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],