wagmi 3.3.4 → 3.4.0

package/src/hooks/useSwitchConnection.ts

@@ -1,5 +1,4 @@
 'use client'
-
 import { useMutation } from '@tanstack/react-query'
 import type {
   Config,
@@ -12,33 +11,19 @@ import {
   type SwitchConnectionData,
   type SwitchConnectionMutate,
   type SwitchConnectionMutateAsync,
+  type SwitchConnectionOptions,
   type SwitchConnectionVariables,
   switchConnectionMutationOptions,
 } 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 UseSwitchConnectionParameters<
   config extends Config = Config,
   context = unknown,
-> = Compute<
-  ConfigParameter<config> & {
-    mutation?:
-      | UseMutationParameters<
-          SwitchConnectionData<config>,
-          SwitchConnectionErrorType,
-          SwitchConnectionVariables,
-          context
-        >
-      | undefined
-  }
->
+> = Compute<ConfigParameter<config> & SwitchConnectionOptions<config, context>>
 
 export type UseSwitchConnectionReturnType<
   config extends Config = Config,
@@ -48,12 +33,12 @@ export type UseSwitchConnectionReturnType<
     SwitchConnectionData<config>,
     SwitchConnectionErrorType,
     SwitchConnectionVariables,
-    context
+    context,
+    SwitchConnectionMutate<config, context>,
+    SwitchConnectionMutateAsync<config, context>
   > & {
     /** @deprecated use `useConnections` instead */
     connectors: readonly Connector[]
-    mutate: SwitchConnectionMutate<config, context>
-    mutateAsync: SwitchConnectionMutateAsync<config, context>
     /** @deprecated use `mutate` instead */
     switchAccount: SwitchConnectionMutate<config, context>
     /** @deprecated use `mutateAsync` instead */
@@ -73,16 +58,14 @@ export function useSwitchConnection<
   parameters: UseSwitchConnectionParameters<config, context> = {},
 ): UseSwitchConnectionReturnType<config, context> {
   const config = useConfig(parameters)
-  const mutationOptions = switchConnectionMutationOptions(config)
-  const mutation = useMutation({ ...parameters.mutation, ...mutationOptions })
+  const options = switchConnectionMutationOptions(config, parameters)
+  const mutation = useMutation(options)
   type Return = UseSwitchConnectionReturnType<config, context>
   return {
-    ...mutation,
+    ...(mutation as Return),
     connectors: useConnections({ config }).map(
       (connection) => connection.connector,
     ),
-    mutate: mutation.mutate as Return['mutate'],
-    mutateAsync: mutation.mutateAsync as Return['mutateAsync'],
     switchAccount: mutation.mutate as Return['mutate'],
     switchAccountAsync: mutation.mutateAsync as Return['mutateAsync'],
     switchConnection: mutation.mutate as Return['mutate'],

package/src/hooks/useTransaction.ts

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

package/src/hooks/useTransactionConfirmations.ts

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

package/src/hooks/useTransactionCount.ts

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

package/src/hooks/useTransactionReceipt.ts

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

package/src/hooks/useVerifyMessage.ts

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

package/src/hooks/useVerifyTypedData.ts

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

package/src/hooks/useWaitForCallsStatus.ts

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

package/src/hooks/useWaitForTransactionReceipt.ts

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

package/src/hooks/useWatchAsset.ts

@@ -1,5 +1,4 @@
 'use client'
-
 import { useMutation } from '@tanstack/react-query'
 import type { WatchAssetErrorType } from '@wagmi/core'
 import type { Compute } from '@wagmi/core/internal'
@@ -7,28 +6,16 @@ import {
   type WatchAssetData,
   type WatchAssetMutate,
   type WatchAssetMutateAsync,
+  type WatchAssetOptions,
   type WatchAssetVariables,
   watchAssetMutationOptions,
 } 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'
 
 export type UseWatchAssetParameters<context = unknown> = Compute<
-  ConfigParameter & {
-    mutation?:
-      | UseMutationParameters<
-          WatchAssetData,
-          WatchAssetErrorType,
-          WatchAssetVariables,
-          context
-        >
-      | undefined
-  }
+  ConfigParameter & WatchAssetOptions<context>
 >
 
 export type UseWatchAssetReturnType<context = unknown> = Compute<
@@ -36,10 +23,10 @@ export type UseWatchAssetReturnType<context = unknown> = Compute<
     WatchAssetData,
     WatchAssetErrorType,
     WatchAssetVariables,
-    context
+    context,
+    WatchAssetMutate<context>,
+    WatchAssetMutateAsync<context>
   > & {
-    mutate: WatchAssetMutate<context>
-    mutateAsync: WatchAssetMutateAsync<context>
     /** @deprecated use `mutate` instead */
     watchAsset: WatchAssetMutate<context>
     /** @deprecated use `mutateAsync` instead */
@@ -52,11 +39,12 @@ export function useWatchAsset<context = unknown>(
   parameters: UseWatchAssetParameters<context> = {},
 ): UseWatchAssetReturnType<context> {
   const config = useConfig(parameters)
-  const mutationOptions = watchAssetMutationOptions(config)
-  const mutation = useMutation({ ...parameters.mutation, ...mutationOptions })
+  const options = watchAssetMutationOptions(config, parameters)
+  const mutation = useMutation(options)
+  type Return = UseWatchAssetReturnType<context>
   return {
-    ...mutation,
-    watchAsset: mutation.mutate,
-    watchAssetAsync: mutation.mutateAsync,
+    ...(mutation as Return),
+    watchAsset: mutation.mutate as Return['mutate'],
+    watchAssetAsync: mutation.mutateAsync as Return['mutateAsync'],
   }
 }

package/src/hooks/useWatchBlockNumber.ts

@@ -1,5 +1,4 @@
 'use client'
-
 import {
   type Config,
   type ResolvedRegister,
@@ -7,8 +6,7 @@ import {
   watchBlockNumber,
 } from '@wagmi/core'
 import type { UnionCompute, UnionExactPartial } from '@wagmi/core/internal'
-import { useEffect } from 'react'
-
+import { useEffect, useRef } from 'react'
 import type { ConfigParameter, EnabledParameter } from '../types/properties.js'
 import { useChainId } from './useChainId.js'
 import { useConfig } from './useConfig.js'
@@ -39,23 +37,28 @@ export function useWatchBlockNumber<
   const configChainId = useChainId({ config })
   const chainId = parameters.chainId ?? configChainId
 
+  const onBlockNumberRef = useRef(onBlockNumber)
+  const onErrorRef = useRef(rest.onError)
+  onBlockNumberRef.current = onBlockNumber
+  onErrorRef.current = rest.onError
+
   // TODO(react@19): cleanup
   // biome-ignore lint/correctness/useExhaustiveDependencies: `rest` changes every render so only including properties in dependency array
   useEffect(() => {
     if (!enabled) return
-    if (!onBlockNumber) return
+    if (!onBlockNumberRef.current) return
     return watchBlockNumber(config, {
       ...(rest as any),
       chainId,
-      onBlockNumber,
+      onBlockNumber: (blockNumber, prevBlockNumber) =>
+        onBlockNumberRef.current?.(blockNumber, prevBlockNumber),
+      onError: (error) => onErrorRef.current?.(error),
     })
   }, [
     chainId,
     config,
     enabled,
-    onBlockNumber,
     ///
-    rest.onError,
     rest.emitMissed,
     rest.emitOnBegin,
     rest.poll,

package/src/hooks/useWatchBlocks.ts

@@ -1,5 +1,4 @@
 'use client'
-
 import {
   type Config,
   type ResolvedRegister,
@@ -7,9 +6,8 @@ import {
   watchBlocks,
 } from '@wagmi/core'
 import type { UnionCompute, UnionExactPartial } from '@wagmi/core/internal'
-import { useEffect } from 'react'
+import { useEffect, useRef } from 'react'
 import type { BlockTag } from 'viem'
-
 import type { ConfigParameter, EnabledParameter } from '../types/properties.js'
 import { useChainId } from './useChainId.js'
 import { useConfig } from './useConfig.js'
@@ -51,27 +49,32 @@ export function useWatchBlocks<
   const configChainId = useChainId({ config })
   const chainId = parameters.chainId ?? configChainId
 
+  const onBlockRef = useRef(onBlock)
+  const onErrorRef = useRef(rest.onError)
+  onBlockRef.current = onBlock
+  onErrorRef.current = rest.onError
+
   // TODO(react@19): cleanup
   // biome-ignore lint/correctness/useExhaustiveDependencies: `rest` changes every render so only including properties in dependency array
   useEffect(() => {
     if (!enabled) return
-    if (!onBlock) return
+    if (!onBlockRef.current) return
     return watchBlocks(config, {
       ...(rest as any),
       chainId,
-      onBlock,
+      onBlock: (block, prevBlock) =>
+        onBlockRef.current?.(block as any, prevBlock as any),
+      onError: (error) => onErrorRef.current?.(error),
     })
   }, [
     chainId,
     config,
     enabled,
-    onBlock,
     ///
     rest.blockTag,
     rest.emitMissed,
     rest.emitOnBegin,
     rest.includeTransactions,
-    rest.onError,
     rest.poll,
     rest.pollingInterval,
     rest.syncConnectedChain,

package/src/hooks/useWatchContractEvent.ts

@@ -1,15 +1,14 @@
 'use client'
-
 import {
   type Config,
+  deepEqual,
   type ResolvedRegister,
   type WatchContractEventParameters,
   watchContractEvent,
 } from '@wagmi/core'
 import type { UnionCompute, UnionExactPartial } from '@wagmi/core/internal'
-import { useEffect } from 'react'
+import { useEffect, useRef } from 'react'
 import type { Abi, ContractEventName } from 'viem'
-
 import type { ConfigParameter, EnabledParameter } from '../types/properties.js'
 import { useChainId } from './useChainId.js'
 import { useConfig } from './useConfig.js'
@@ -54,29 +53,43 @@ export function useWatchContractEvent<
   const configChainId = useChainId({ config })
   const chainId = parameters.chainId ?? configChainId
 
+  const onLogsRef = useRef(onLogs)
+  const onErrorRef = useRef(rest.onError)
+  onLogsRef.current = onLogs
+  onErrorRef.current = rest.onError
+
+  const abiRef = useRef(rest.abi)
+  const addressRef = useRef(rest.address)
+  const argsRef = useRef(rest.args)
+  if (!abiRef.current || !deepEqual(abiRef.current, rest.abi))
+    abiRef.current = rest.abi
+  if (!addressRef.current || !deepEqual(addressRef.current, rest.address))
+    addressRef.current = rest.address
+  if (!argsRef.current || !deepEqual(argsRef.current, rest.args))
+    argsRef.current = rest.args
+
   // TODO(react@19): cleanup
   // biome-ignore lint/correctness/useExhaustiveDependencies: `rest` changes every render so only including properties in dependency array
   useEffect(() => {
     if (!enabled) return
-    if (!onLogs) return
+    if (!onLogsRef.current) return
     return watchContractEvent(config, {
       ...(rest as any),
       chainId,
-      onLogs,
+      onLogs: (logs) => onLogsRef.current?.(logs as any),
+      onError: (error) => onErrorRef.current?.(error),
     })
   }, [
     chainId,
     config,
     enabled,
-    onLogs,
     ///
-    rest.abi,
-    rest.address,
-    rest.args,
+    abiRef.current,
+    addressRef.current,
+    argsRef.current,
     rest.batch,
     rest.eventName,
     rest.fromBlock,
-    rest.onError,
     rest.poll,
     rest.pollingInterval,
     rest.strict,

package/src/hooks/useWatchPendingTransactions.ts

@@ -1,5 +1,4 @@
 'use client'
-
 import {
   type Config,
   type ResolvedRegister,
@@ -7,8 +6,7 @@ import {
   watchPendingTransactions,
 } from '@wagmi/core'
 import type { UnionCompute, UnionExactPartial } from '@wagmi/core/internal'
-import { useEffect } from 'react'
-
+import { useEffect, useRef } from 'react'
 import type { ConfigParameter, EnabledParameter } from '../types/properties.js'
 import { useChainId } from './useChainId.js'
 import { useConfig } from './useConfig.js'
@@ -42,24 +40,29 @@ export function useWatchPendingTransactions<
   const configChainId = useChainId({ config })
   const chainId = parameters.chainId ?? configChainId
 
+  const onTransactionsRef = useRef(onTransactions)
+  const onErrorRef = useRef(rest.onError)
+  onTransactionsRef.current = onTransactions
+  onErrorRef.current = rest.onError
+
   // TODO(react@19): cleanup
   // biome-ignore lint/correctness/useExhaustiveDependencies: `rest` changes every render so only including properties in dependency array
   useEffect(() => {
     if (!enabled) return
-    if (!onTransactions) return
+    if (!onTransactionsRef.current) return
     return watchPendingTransactions(config, {
       ...(rest as any),
       chainId,
-      onTransactions,
+      onTransactions: (transactions) =>
+        onTransactionsRef.current?.(transactions),
+      onError: (error) => onErrorRef.current?.(error),
     })
   }, [
     chainId,
     config,
     enabled,
-    onTransactions,
     ///
     rest.batch,
-    rest.onError,
     rest.poll,
     rest.pollingInterval,
     rest.syncConnectedChain,

package/src/hooks/useWriteContract.ts

@@ -1,5 +1,4 @@
 'use client'
-
 import { useMutation } from '@tanstack/react-query'
 import type {
   Config,
@@ -10,37 +9,19 @@ import {
   type WriteContractData,
   type WriteContractMutate,
   type WriteContractMutateAsync,
+  type WriteContractOptions,
   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 type { UseMutationReturnType } from '../utils/query.js'
 import { useConfig } from './useConfig.js'
 
 export type UseWriteContractParameters<
   config extends Config = Config,
   context = unknown,
-> = ConfigParameter<config> & {
-  mutation?:
-    | UseMutationParameters<
-        WriteContractData,
-        WriteContractErrorType,
-        WriteContractVariables<
-          Abi,
-          string,
-          readonly unknown[],
-          config,
-          config['chains'][number]['id']
-        >,
-        context
-      >
-    | undefined
-}
+> = ConfigParameter<config> & WriteContractOptions<config, context>
 
 export type UseWriteContractReturnType<
   config extends Config = Config,
@@ -55,10 +36,10 @@ export type UseWriteContractReturnType<
     config,
     config['chains'][number]['id']
   >,
-  context
+  context,
+  WriteContractMutate<config, context>,
+  WriteContractMutateAsync<config, context>
 > & {
-  mutate: WriteContractMutate<config, context>
-  mutateAsync: WriteContractMutateAsync<config, context>
   /** @deprecated use `mutate` instead */
   writeContract: WriteContractMutate<config, context>
   /** @deprecated use `mutateAsync` instead */
@@ -73,13 +54,11 @@ export function useWriteContract<
   parameters: UseWriteContractParameters<config, context> = {},
 ): UseWriteContractReturnType<config, context> {
   const config = useConfig(parameters)
-  const mutationOptions = writeContractMutationOptions(config)
-  const mutation = useMutation({ ...parameters.mutation, ...mutationOptions })
+  const options = writeContractMutationOptions(config, parameters)
+  const mutation = useMutation(options)
   type Return = UseWriteContractReturnType<config, context>
   return {
-    ...mutation,
-    mutate: mutation.mutate as Return['mutate'],
-    mutateAsync: mutation.mutateAsync as Return['mutateAsync'],
+    ...(mutation as Return),
     writeContract: mutation.mutate as Return['mutate'],
     writeContractAsync: mutation.mutateAsync as Return['mutateAsync'],
   }

package/src/hooks/useWriteContractSync.ts

@@ -0,0 +1,65 @@
+'use client'
+import { useMutation } from '@tanstack/react-query'
+import type {
+  Config,
+  ResolvedRegister,
+  WriteContractSyncErrorType,
+} from '@wagmi/core'
+import {
+  type WriteContractSyncData,
+  type WriteContractSyncMutate,
+  type WriteContractSyncMutateAsync,
+  type WriteContractSyncOptions,
+  type WriteContractSyncVariables,
+  writeContractSyncMutationOptions,
+} from '@wagmi/core/query'
+import type { Abi } from 'viem'
+import type { ConfigParameter } from '../types/properties.js'
+import type { UseMutationReturnType } from '../utils/query.js'
+import { useConfig } from './useConfig.js'
+
+export type UseWriteContractSyncParameters<
+  config extends Config = Config,
+  context = unknown,
+> = ConfigParameter<config> & WriteContractSyncOptions<config, context>
+
+export type UseWriteContractSyncReturnType<
+  config extends Config = Config,
+  context = unknown,
+> = UseMutationReturnType<
+  WriteContractSyncData,
+  WriteContractSyncErrorType,
+  WriteContractSyncVariables<
+    Abi,
+    string,
+    readonly unknown[],
+    config,
+    config['chains'][number]['id']
+  >,
+  context,
+  WriteContractSyncMutate<config, context>,
+  WriteContractSyncMutateAsync<config, context>
+> & {
+  /** @deprecated use `mutate` instead */
+  writeContractSync: WriteContractSyncMutate<config, context>
+  /** @deprecated use `mutateAsync` instead */
+  writeContractSyncAsync: WriteContractSyncMutateAsync<config, context>
+}
+
+/** https://wagmi.sh/react/api/hooks/useWriteContractSync */
+export function useWriteContractSync<
+  config extends Config = ResolvedRegister['config'],
+  context = unknown,
+>(
+  parameters: UseWriteContractSyncParameters<config, context> = {},
+): UseWriteContractSyncReturnType<config, context> {
+  const config = useConfig(parameters)
+  const options = writeContractSyncMutationOptions(config, parameters)
+  const mutation = useMutation(options)
+  type Return = UseWriteContractSyncReturnType<config, context>
+  return {
+    ...(mutation as Return),
+    writeContractSync: mutation.mutate as Return['mutate'],
+    writeContractSyncAsync: mutation.mutateAsync as Return['mutateAsync'],
+  }
+}