wagmi 3.3.4 → 3.4.1

package/src/exports/index.ts

@@ -30,6 +30,12 @@ export {
   useBalance,
 } from '../hooks/useBalance.js'
 
+export {
+  type UseBlobBaseFeeParameters,
+  type UseBlobBaseFeeReturnType,
+  useBlobBaseFee,
+} from '../hooks/useBlobBaseFee.js'
+
 export {
   type UseBlockParameters,
   type UseBlockReturnType,
@@ -141,6 +147,12 @@ export {
   useConnectors,
 } from '../hooks/useConnectors.js'
 
+export {
+  type UseContractEventsParameters,
+  type UseContractEventsReturnType,
+  useContractEvents,
+} from '../hooks/useContractEvents.js'
+
 export {
   type UseDeployContractParameters,
   type UseDeployContractReturnType,
@@ -412,6 +424,12 @@ export {
   useWriteContract,
 } from '../hooks/useWriteContract.js'
 
+export {
+  type UseWriteContractSyncParameters,
+  type UseWriteContractSyncReturnType,
+  useWriteContractSync,
+} from '../hooks/useWriteContractSync.js'
+
 ////////////////////////////////////////////////////////////////////////////////
 // Hydrate
 ////////////////////////////////////////////////////////////////////////////////

package/src/hooks/codegen/createUseWriteContract.ts

@@ -304,6 +304,8 @@ export function createUseWriteContract<
     )
     return {
       ...(result as any),
+      mutate,
+      mutateAsync,
       writeContract: mutate,
       writeContractAsync: mutateAsync,
     }

package/src/hooks/useBalance.ts

@@ -31,7 +31,6 @@ export function useBalance<
   const options = getBalanceQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
-    query: parameters.query,
   })
   return useQuery(options)
 }

package/src/hooks/useBlobBaseFee.ts

@@ -0,0 +1,46 @@
+'use client'
+import type {
+  Config,
+  GetBlobBaseFeeErrorType,
+  ResolvedRegister,
+} from '@wagmi/core'
+import type { Compute } from '@wagmi/core/internal'
+import {
+  type GetBlobBaseFeeData,
+  type GetBlobBaseFeeOptions,
+  getBlobBaseFeeQueryOptions,
+} from '@wagmi/core/query'
+import type { ConfigParameter } from '../types/properties.js'
+import { type UseQueryReturnType, useQuery } from '../utils/query.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+
+export type UseBlobBaseFeeParameters<
+  config extends Config = Config,
+  chainId extends
+    config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = GetBlobBaseFeeData,
+> = Compute<
+  GetBlobBaseFeeOptions<config, chainId, selectData> & ConfigParameter<config>
+>
+
+export type UseBlobBaseFeeReturnType<selectData = GetBlobBaseFeeData> =
+  UseQueryReturnType<selectData, GetBlobBaseFeeErrorType>
+
+/** https://wagmi.sh/react/api/hooks/useBlobBaseFee */
+export function useBlobBaseFee<
+  config extends Config = ResolvedRegister['config'],
+  chainId extends
+    config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = GetBlobBaseFeeData,
+>(
+  parameters: UseBlobBaseFeeParameters<config, chainId, selectData> = {},
+): UseBlobBaseFeeReturnType<selectData> {
+  const config = useConfig(parameters)
+  const chainId = useChainId({ config })
+  const options = getBlobBaseFeeQueryOptions(config, {
+    ...parameters,
+    chainId: parameters.chainId ?? chainId,
+  })
+  return useQuery(options)
+}

package/src/hooks/useBlock.ts

@@ -85,7 +85,6 @@ export function useBlock<
   const options = getBlockQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
-    query: parameters.query,
   })
   const queryClient = useQueryClient()
   useWatchBlocks({

package/src/hooks/useBlockNumber.ts

@@ -61,7 +61,6 @@ export function useBlockNumber<
   const options = getBlockNumberQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
-    query: parameters.query,
   })
   const queryClient = useQueryClient()
   useWatchBlockNumber({

package/src/hooks/useBlockTransactionCount.ts

@@ -47,7 +47,6 @@ export function useBlockTransactionCount<
   const options = getBlockTransactionCountQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
-    query: parameters.query,
   })
   return useQuery(options)
 }

package/src/hooks/useBytecode.ts

@@ -35,7 +35,6 @@ export function useBytecode<
   const options = getBytecodeQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
-    query: parameters.query,
   })
   return useQuery(options)
 }

package/src/hooks/useCall.ts

@@ -33,7 +33,6 @@ export function useCall<
   const options = callQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
-    query: parameters.query,
   })
   return useQuery(options)
 }

package/src/hooks/useCallsStatus.ts

@@ -35,7 +35,6 @@ export function useCallsStatus<
   const options = getCallsStatusQueryOptions(config, {
     ...parameters,
     connector: parameters.connector ?? connector,
-    query: parameters.query,
   })
   return useQuery(options)
 }

package/src/hooks/useCapabilities.ts

@@ -43,7 +43,6 @@ export function useCapabilities<
     ...parameters,
     account: parameters.account ?? address,
     connector: parameters.connector ?? connector,
-    query: parameters.query,
   })
   return useQuery(options as never) as any
 }

package/src/hooks/useConnect.ts

@@ -1,5 +1,4 @@
 'use client'
-
 import { useMutation } from '@tanstack/react-query'
 import type { Config, ConnectErrorType, ResolvedRegister } from '@wagmi/core'
 import type { Compute } from '@wagmi/core/internal'
@@ -7,34 +6,20 @@ import {
   type ConnectData,
   type ConnectMutate,
   type ConnectMutateAsync,
+  type ConnectOptions,
   type ConnectVariables,
   connectMutationOptions,
 } from '@wagmi/core/query'
 import { useEffect } from 'react'
-
 import type { ConfigParameter } from '../types/properties.js'
-import type {
-  UseMutationParameters,
-  UseMutationReturnType,
-} from '../utils/query.js'
+import type { UseMutationReturnType } from '../utils/query.js'
 import { useConfig } from './useConfig.js'
 import { type UseConnectorsReturnType, useConnectors } from './useConnectors.js'
 
 export type UseConnectParameters<
   config extends Config = Config,
   context = unknown,
-> = Compute<
-  ConfigParameter<config> & {
-    mutation?:
-      | UseMutationParameters<
-          ConnectData<config, config['connectors'][number], boolean>,
-          ConnectErrorType,
-          ConnectVariables<config, config['connectors'][number], boolean>,
-          context
-        >
-      | undefined
-  }
->
+> = Compute<ConfigParameter<config> & ConnectOptions<config, context>>
 
 export type UseConnectReturnType<
   config extends Config = Config,
@@ -44,7 +29,9 @@ export type UseConnectReturnType<
     ConnectData<config, config['connectors'][number], boolean>,
     ConnectErrorType,
     ConnectVariables<config, config['connectors'][number], boolean>,
-    context
+    context,
+    ConnectMutate<config, context>,
+    ConnectMutateAsync<config, context>
   > & {
     /** @deprecated use `mutate` instead */
     connect: ConnectMutate<config, context>
@@ -52,8 +39,6 @@ export type UseConnectReturnType<
     connectAsync: ConnectMutateAsync<config, context>
     /** @deprecated use `useConnectors` instead */
     connectors: Compute<UseConnectorsReturnType> | config['connectors']
-    mutate: ConnectMutate<config, context>
-    mutateAsync: ConnectMutateAsync<config, context>
   }
 >
 
@@ -65,12 +50,8 @@ export function useConnect<
   parameters: UseConnectParameters<config, context> = {},
 ): UseConnectReturnType<config, context> {
   const config = useConfig(parameters)
-
-  const mutationOptions = connectMutationOptions(config)
-  const mutation = useMutation({
-    ...(parameters.mutation as typeof mutationOptions),
-    ...mutationOptions,
-  })
+  const options = connectMutationOptions(config, parameters)
+  const mutation = useMutation(options)
 
   // Reset mutation back to an idle state when the connector disconnects.
   useEffect(() => {

package/src/hooks/useContractEvents.ts

@@ -0,0 +1,111 @@
+'use client'
+import type {
+  Config,
+  GetContractEventsErrorType,
+  ResolvedRegister,
+} from '@wagmi/core'
+import type { UnionCompute } from '@wagmi/core/internal'
+import {
+  type GetContractEventsData,
+  type GetContractEventsOptions,
+  getContractEventsQueryOptions,
+} from '@wagmi/core/query'
+import type { Abi, BlockNumber, BlockTag, ContractEventName } from 'viem'
+import type { ConfigParameter } from '../types/properties.js'
+import { type UseQueryReturnType, useQuery } from '../utils/query.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+
+export type UseContractEventsParameters<
+  abi extends Abi | readonly unknown[] = Abi,
+  eventName extends ContractEventName<abi> | undefined =
+    | ContractEventName<abi>
+    | undefined,
+  strict extends boolean | undefined = undefined,
+  fromBlock extends BlockNumber | BlockTag | undefined = undefined,
+  toBlock extends BlockNumber | BlockTag | undefined = undefined,
+  config extends Config = Config,
+  chainId extends
+    config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = GetContractEventsData<
+    abi,
+    eventName,
+    strict,
+    fromBlock,
+    toBlock
+  >,
+> = UnionCompute<
+  GetContractEventsOptions<
+    abi,
+    eventName,
+    strict,
+    fromBlock,
+    toBlock,
+    config,
+    chainId,
+    selectData
+  > &
+    ConfigParameter<config>
+>
+
+export type UseContractEventsReturnType<
+  abi extends Abi | readonly unknown[] = Abi,
+  eventName extends ContractEventName<abi> | undefined =
+    | ContractEventName<abi>
+    | undefined,
+  strict extends boolean | undefined = undefined,
+  fromBlock extends BlockNumber | BlockTag | undefined = undefined,
+  toBlock extends BlockNumber | BlockTag | undefined = undefined,
+  selectData = GetContractEventsData<
+    abi,
+    eventName,
+    strict,
+    fromBlock,
+    toBlock
+  >,
+> = UseQueryReturnType<selectData, GetContractEventsErrorType>
+
+/** https://wagmi.sh/react/api/hooks/useContractEvents */
+export function useContractEvents<
+  const abi extends Abi | readonly unknown[],
+  eventName extends ContractEventName<abi> | undefined,
+  strict extends boolean | undefined = undefined,
+  fromBlock extends BlockNumber | BlockTag | undefined = undefined,
+  toBlock extends BlockNumber | BlockTag | undefined = undefined,
+  config extends Config = ResolvedRegister['config'],
+  chainId extends
+    config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = GetContractEventsData<
+    abi,
+    eventName,
+    strict,
+    fromBlock,
+    toBlock
+  >,
+>(
+  parameters: UseContractEventsParameters<
+    abi,
+    eventName,
+    strict,
+    fromBlock,
+    toBlock,
+    config,
+    chainId,
+    selectData
+  > = {} as any,
+): UseContractEventsReturnType<
+  abi,
+  eventName,
+  strict,
+  fromBlock,
+  toBlock,
+  selectData
+> {
+  const config = useConfig(parameters)
+  const chainId = useChainId({ config })
+  const options = getContractEventsQueryOptions(config, {
+    ...parameters,
+    chainId: parameters.chainId ?? chainId,
+  })
+  return useQuery(options)
+}

package/src/hooks/useDeployContract.ts

@@ -1,5 +1,4 @@
 'use client'
-
 import { useMutation } from '@tanstack/react-query'
 import type {
   Config,
@@ -11,33 +10,19 @@ import {
   type DeployContractData,
   type DeployContractMutate,
   type DeployContractMutateAsync,
+  type DeployContractOptions,
   type DeployContractVariables,
   deployContractMutationOptions,
 } 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 type { UseMutationReturnType } from '../utils/query.js'
 import { useConfig } from './useConfig.js'
 
 export type UseDeployContractParameters<
   config extends Config = Config,
   context = unknown,
-> = Compute<
-  ConfigParameter<config> & {
-    mutation?:
-      | UseMutationParameters<
-          DeployContractData,
-          DeployContractErrorType,
-          DeployContractVariables<Abi, config, config['chains'][number]['id']>,
-          context
-        >
-      | undefined
-  }
->
+> = Compute<ConfigParameter<config> & DeployContractOptions<config, context>>
 
 export type UseDeployContractReturnType<
   config extends Config = Config,
@@ -46,14 +31,14 @@ export type UseDeployContractReturnType<
   DeployContractData,
   DeployContractErrorType,
   DeployContractVariables<Abi, config, config['chains'][number]['id']>,
-  context
+  context,
+  DeployContractMutate<config, context>,
+  DeployContractMutateAsync<config, context>
 > & {
   /** @deprecated use `mutate` instead */
   deployContract: DeployContractMutate<config, context>
   /** @deprecated use `mutateAsync` instead */
   deployContractAsync: DeployContractMutateAsync<config, context>
-  mutate: DeployContractMutate<config, context>
-  mutateAsync: DeployContractMutateAsync<config, context>
 }
 
 /** https://wagmi.sh/react/api/hooks/useDeployContract */
@@ -64,14 +49,12 @@ export function useDeployContract<
   parameters: UseDeployContractParameters<config, context> = {},
 ): UseDeployContractReturnType<config, context> {
   const config = useConfig(parameters)
-  const mutationOptions = deployContractMutationOptions(config)
-  const mutation = useMutation({ ...parameters.mutation, ...mutationOptions })
+  const options = deployContractMutationOptions(config, parameters)
+  const mutation = useMutation(options)
   type Return = UseDeployContractReturnType<config, context>
   return {
-    ...mutation,
+    ...(mutation as Return),
     deployContract: mutation.mutate as Return['mutate'],
     deployContractAsync: mutation.mutateAsync as Return['mutateAsync'],
-    mutate: mutation.mutate as Return['mutate'],
-    mutateAsync: mutation.mutateAsync as Return['mutateAsync'],
   }
 }

package/src/hooks/useDisconnect.ts

@@ -1,5 +1,4 @@
 'use client'
-
 import { useMutation } from '@tanstack/react-query'
 import type { Connector, DisconnectErrorType } from '@wagmi/core'
 import type { Compute } from '@wagmi/core/internal'
@@ -7,29 +6,17 @@ import {
   type DisconnectData,
   type DisconnectMutate,
   type DisconnectMutateAsync,
+  type DisconnectOptions,
   type DisconnectVariables,
   disconnectMutationOptions,
 } from '@wagmi/core/query'
-
 import type { ConfigParameter } from '../types/properties.js'
-import type {
-  UseMutationParameters,
-  UseMutationReturnType,
-} from '../utils/query.js'
+import type { UseMutationReturnType } from '../utils/query.js'
 import { useConfig } from './useConfig.js'
 import { useConnections } from './useConnections.js'
 
 export type UseDisconnectParameters<context = unknown> = Compute<
-  ConfigParameter & {
-    mutation?:
-      | UseMutationParameters<
-          DisconnectData,
-          DisconnectErrorType,
-          DisconnectVariables,
-          context
-        >
-      | undefined
-  }
+  ConfigParameter & DisconnectOptions<context>
 >
 
 export type UseDisconnectReturnType<context = unknown> = Compute<
@@ -37,7 +24,9 @@ export type UseDisconnectReturnType<context = unknown> = Compute<
     DisconnectData,
     DisconnectErrorType,
     DisconnectVariables,
-    context
+    context,
+    DisconnectMutate<context>,
+    DisconnectMutateAsync<context>
   > & {
     /** @deprecated use `useConnections` instead */
     connectors: readonly Connector[]
@@ -45,8 +34,6 @@ export type UseDisconnectReturnType<context = unknown> = Compute<
     disconnect: DisconnectMutate<context>
     /** @deprecated use `mutateAsync` instead */
     disconnectAsync: DisconnectMutateAsync<context>
-    mutate: DisconnectMutate<context>
-    mutateAsync: DisconnectMutateAsync<context>
   }
 >
 
@@ -55,14 +42,15 @@ export function useDisconnect<context = unknown>(
   parameters: UseDisconnectParameters<context> = {},
 ): UseDisconnectReturnType<context> {
   const config = useConfig(parameters)
-  const mutationOptions = disconnectMutationOptions(config)
-  const mutation = useMutation({ ...parameters.mutation, ...mutationOptions })
+  const options = disconnectMutationOptions(config, parameters)
+  const mutation = useMutation(options)
+  type Return = UseDisconnectReturnType<context>
   return {
-    ...mutation,
+    ...(mutation as Return),
     connectors: useConnections({ config }).map(
       (connection) => connection.connector,
     ),
-    disconnect: mutation.mutate,
-    disconnectAsync: mutation.mutateAsync,
+    disconnect: mutation.mutate as Return['mutate'],
+    disconnectAsync: mutation.mutateAsync as Return['mutateAsync'],
   }
 }

package/src/hooks/useEnsAddress.ts

@@ -35,7 +35,6 @@ export function useEnsAddress<
   const options = getEnsAddressQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
-    query: parameters.query,
   })
   return useQuery(options)
 }

package/src/hooks/useEnsAvatar.ts

@@ -35,7 +35,6 @@ export function useEnsAvatar<
   const options = getEnsAvatarQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
-    query: parameters.query,
   })
   return useQuery(options)
 }

package/src/hooks/useEnsName.ts

@@ -31,7 +31,6 @@ export function useEnsName<
   const options = getEnsNameQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
-    query: parameters.query,
   })
   return useQuery(options)
 }

package/src/hooks/useEnsResolver.ts

@@ -35,7 +35,6 @@ export function useEnsResolver<
   const options = getEnsResolverQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
-    query: parameters.query,
   })
   return useQuery(options)
 }

package/src/hooks/useEnsText.ts

@@ -31,7 +31,6 @@ export function useEnsText<
   const options = getEnsTextQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
-    query: parameters.query,
   })
   return useQuery(options)
 }

package/src/hooks/useEstimateFeesPerGas.ts

@@ -42,7 +42,6 @@ export function useEstimateFeesPerGas<
   const options = estimateFeesPerGasQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
-    query: parameters.query,
   })
   return useQuery(options)
 }

package/src/hooks/useEstimateGas.ts

@@ -44,7 +44,6 @@ export function useEstimateGas(
     account: parameters.account ?? address,
     chainId: parameters.chainId ?? chainId,
     connector: parameters.connector ?? connector,
-    query: parameters.query,
   })
   return useQuery(options)
 }

package/src/hooks/useEstimateMaxPriorityFeePerGas.ts

@@ -42,7 +42,6 @@ export function useEstimateMaxPriorityFeePerGas<
   const options = estimateMaxPriorityFeePerGasQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
-    query: parameters.query,
   })
   return useQuery(options)
 }

package/src/hooks/useFeeHistory.ts

@@ -41,7 +41,6 @@ export function useFeeHistory<
   const options = getFeeHistoryQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
-    query: parameters.query,
   })
   return useQuery(options)
 }

package/src/hooks/useGasPrice.ts

@@ -41,7 +41,6 @@ export function useGasPrice<
   const options = getGasPriceQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
-    query: parameters.query,
   })
   return useQuery(options)
 }

package/src/hooks/usePrepareTransactionRequest.ts

@@ -73,7 +73,6 @@ export function usePrepareTransactionRequest<
   const options = prepareTransactionRequestQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
-    query: parameters.query,
   } as PrepareTransactionRequestOptions<config, chainId, request>)
   return useQuery(options) as any
 }

package/src/hooks/useProof.ts

@@ -33,7 +33,6 @@ export function useProof<
   const options = getProofQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
-    query: parameters.query,
   })
   return useQuery(options)
 }

package/src/hooks/useReadContract.ts

@@ -69,7 +69,6 @@ export function useReadContract<
   const options = readContractQueryOptions(config, {
     ...(parameters as any),
     chainId: parameters.chainId ?? chainId,
-    query: parameters.query,
   })
   return useQuery(options) as any
 }

package/src/hooks/useReadContracts.ts

@@ -64,7 +64,6 @@ export function useReadContracts<
   const options = readContractsQueryOptions(config, {
     ...parameters,
     chainId: contractsChainId ?? chainId,
-    query: parameters.query,
   })
   return useQuery(options) as any
 }