wagmi 2.0.0 → 2.0.2

package/src/hooks/useTransaction.ts

@@ -1,6 +1,10 @@
 'use client'
 
-import type { Config, GetTransactionError, ResolvedRegister } from '@wagmi/core'
+import type {
+  Config,
+  GetTransactionErrorType,
+  ResolvedRegister,
+} from '@wagmi/core'
 import { type Evaluate } from '@wagmi/core/internal'
 import {
   type GetTransactionData,
@@ -10,12 +14,8 @@ import {
   getTransactionQueryOptions,
 } 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'
 
@@ -25,25 +25,22 @@ export type UseTransactionParameters<
   selectData = GetTransactionData<config, chainId>,
 > = Evaluate<
   GetTransactionOptions<config, chainId> &
-    ConfigParameter<config> & {
-      query?:
-        | UseQueryParameters<
-            GetTransactionQueryFnData<config, chainId>,
-            GetTransactionError,
-            selectData,
-            GetTransactionQueryKey<config, chainId>
-          >
-        | undefined
-    }
+    ConfigParameter<config> &
+    QueryParameter<
+      GetTransactionQueryFnData<config, chainId>,
+      GetTransactionErrorType,
+      selectData,
+      GetTransactionQueryKey<config, chainId>
+    >
 >
 
 export type UseTransactionReturnType<
   config extends Config = Config,
   chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
   selectData = GetTransactionData<config, chainId>,
-> = UseQueryReturnType<selectData, GetTransactionError>
+> = UseQueryReturnType<selectData, GetTransactionErrorType>
 
-/** https://alpha.wagmi.sh/react/api/hooks/useTransaction */
+/** https://wagmi.sh/react/api/hooks/useTransaction */
 export function useTransaction<
   config extends Config = ResolvedRegister['config'],
   chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
@@ -56,7 +53,7 @@ export function useTransaction<
   const config = useConfig(parameters)
   const chainId = useChainId()
 
-  const queryOptions = getTransactionQueryOptions(config, {
+  const options = getTransactionQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
   })
@@ -64,5 +61,9 @@ export function useTransaction<
     !(blockHash && blockNumber && blockTag && hash) && (query.enabled ?? true),
   )
 
-  return useQuery({ ...queryOptions, ...query, enabled })
+  return useQuery({
+    ...(query as any),
+    ...options,
+    enabled,
+  }) as UseTransactionReturnType<config, chainId, selectData>
 }

package/src/hooks/useTransactionCount.ts

@@ -0,0 +1,59 @@
+'use client'
+
+import {
+  type Config,
+  type GetTransactionCountErrorType,
+  type ResolvedRegister,
+} from '@wagmi/core'
+import type { Evaluate } from '@wagmi/core/internal'
+import type { GetTransactionCountQueryFnData } from '@wagmi/core/query'
+import {
+  type GetTransactionCountData,
+  type GetTransactionCountOptions,
+  type GetTransactionCountQueryKey,
+  getTransactionCountQueryOptions,
+} 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 UseTransactionCountParameters<
+  config extends Config = Config,
+  selectData = GetTransactionCountData,
+> = Evaluate<
+  GetTransactionCountOptions<config> &
+    ConfigParameter<config> &
+    QueryParameter<
+      GetTransactionCountQueryFnData,
+      GetTransactionCountErrorType,
+      selectData,
+      GetTransactionCountQueryKey<config>
+    >
+>
+
+export type UseTransactionCountReturnType<
+  selectData = GetTransactionCountData,
+> = UseQueryReturnType<selectData, GetTransactionCountErrorType>
+
+/** https://wagmi.sh/react/api/hooks/useTransactionCount */
+export function useTransactionCount<
+  config extends Config = ResolvedRegister['config'],
+  selectData = GetTransactionCountData,
+>(
+  parameters: UseTransactionCountParameters<config, selectData> = {},
+): UseTransactionCountReturnType<selectData> {
+  const { address, query = {} } = parameters
+
+  const config = useConfig(parameters)
+  const chainId = useChainId()
+
+  const options = getTransactionCountQueryOptions(config, {
+    ...parameters,
+    chainId: parameters.chainId ?? chainId,
+  })
+  const enabled = Boolean(address && (query.enabled ?? true))
+
+  return useQuery({ ...query, ...options, enabled })
+}

package/src/hooks/useVerifyMessage.ts

@@ -0,0 +1,59 @@
+'use client'
+
+import {
+  type Config,
+  type ResolvedRegister,
+  type VerifyMessageErrorType,
+} from '@wagmi/core'
+import type { Evaluate } from '@wagmi/core/internal'
+import {
+  type VerifyMessageData,
+  type VerifyMessageOptions,
+  type VerifyMessageQueryKey,
+  verifyMessageQueryOptions,
+} from '@wagmi/core/query'
+import type { VerifyMessageQueryFnData } 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 UseVerifyMessageParameters<
+  config extends Config = Config,
+  selectData = VerifyMessageData,
+> = Evaluate<
+  VerifyMessageOptions<config> &
+    ConfigParameter<config> &
+    QueryParameter<
+      VerifyMessageQueryFnData,
+      VerifyMessageErrorType,
+      selectData,
+      VerifyMessageQueryKey
+    >
+>
+
+export type UseVerifyMessageReturnType<selectData = VerifyMessageData> =
+  UseQueryReturnType<selectData, VerifyMessageErrorType>
+
+/** https://wagmi.sh/react/api/hooks/useVerifyMessage */
+export function useVerifyMessage<
+  config extends Config = ResolvedRegister['config'],
+  selectData = VerifyMessageData,
+>(
+  parameters: UseVerifyMessageParameters<config, selectData> = {},
+): UseVerifyMessageReturnType<selectData> {
+  const { address, message, signature, query = {} } = parameters
+
+  const config = useConfig(parameters)
+  const chainId = useChainId()
+
+  const options = verifyMessageQueryOptions(config, {
+    ...parameters,
+    chainId: parameters.chainId ?? chainId,
+  })
+  const enabled = Boolean(
+    address && message && signature && (query.enabled ?? true),
+  )
+
+  return useQuery({ ...query, ...options, enabled })
+}

package/src/hooks/useVerifyTypedData.ts

@@ -0,0 +1,81 @@
+'use client'
+
+import {
+  type Config,
+  type ResolvedRegister,
+  type VerifyTypedDataErrorType,
+} from '@wagmi/core'
+import {
+  type VerifyTypedDataData,
+  type VerifyTypedDataOptions,
+  type VerifyTypedDataQueryKey,
+  verifyTypedDataQueryOptions,
+} from '@wagmi/core/query'
+import type { VerifyTypedDataQueryFnData } from '@wagmi/core/query'
+import { type TypedData } from 'viem'
+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 UseVerifyTypedDataParameters<
+  typedData extends TypedData | Record<string, unknown> = TypedData,
+  primaryType extends keyof typedData | 'EIP712Domain' = keyof typedData,
+  config extends Config = Config,
+  selectData = VerifyTypedDataData,
+> = VerifyTypedDataOptions<typedData, primaryType, config> &
+  ConfigParameter<config> &
+  QueryParameter<
+    VerifyTypedDataQueryFnData,
+    VerifyTypedDataErrorType,
+    selectData,
+    VerifyTypedDataQueryKey<typedData, primaryType, config>
+  >
+
+export type UseVerifyTypedDataReturnType<selectData = VerifyTypedDataData> =
+  UseQueryReturnType<selectData, VerifyTypedDataErrorType>
+
+/** https://wagmi.sh/react/api/hooks/useVerifyTypedData */
+export function useVerifyTypedData<
+  const typedData extends TypedData | Record<string, unknown>,
+  primaryType extends keyof typedData | 'EIP712Domain',
+  config extends Config = ResolvedRegister['config'],
+  selectData = VerifyTypedDataData,
+>(
+  parameters: UseVerifyTypedDataParameters<
+    typedData,
+    primaryType,
+    config,
+    selectData
+  > = {} as any,
+): UseVerifyTypedDataReturnType<selectData> {
+  const {
+    address,
+    message,
+    primaryType,
+    signature,
+    types,
+    query = {},
+  } = parameters
+
+  const config = useConfig(parameters)
+  const chainId = useChainId()
+
+  const options = verifyTypedDataQueryOptions<config, typedData, primaryType>(
+    config,
+    {
+      ...parameters,
+      chainId: parameters.chainId ?? chainId,
+    },
+  )
+  const enabled = Boolean(
+    address &&
+      message &&
+      primaryType &&
+      signature &&
+      types &&
+      (query.enabled ?? true),
+  )
+
+  return useQuery({ ...query, ...options, enabled })
+}

package/src/hooks/useWaitForTransactionReceipt.ts

@@ -3,7 +3,7 @@
 import type {
   Config,
   ResolvedRegister,
-  WaitForTransactionReceiptError,
+  WaitForTransactionReceiptErrorType,
 } from '@wagmi/core'
 import { type Evaluate } from '@wagmi/core/internal'
 import {
@@ -14,12 +14,8 @@ import {
   waitForTransactionReceiptQueryOptions,
 } 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'
 
@@ -29,25 +25,22 @@ export type UseWaitForTransactionReceiptParameters<
   selectData = WaitForTransactionReceiptData<config, chainId>,
 > = Evaluate<
   WaitForTransactionReceiptOptions<config, chainId> &
-    ConfigParameter<config> & {
-      query?:
-        | UseQueryParameters<
-            WaitForTransactionReceiptQueryFnData<config, chainId>,
-            WaitForTransactionReceiptError,
-            selectData,
-            WaitForTransactionReceiptQueryKey<config, chainId>
-          >
-        | undefined
-    }
+    ConfigParameter<config> &
+    QueryParameter<
+      WaitForTransactionReceiptQueryFnData<config, chainId>,
+      WaitForTransactionReceiptErrorType,
+      selectData,
+      WaitForTransactionReceiptQueryKey<config, chainId>
+    >
 >
 
 export type UseWaitForTransactionReceiptReturnType<
   config extends Config = Config,
   chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
   selectData = WaitForTransactionReceiptData<config, chainId>,
-> = UseQueryReturnType<selectData, WaitForTransactionReceiptError>
+> = UseQueryReturnType<selectData, WaitForTransactionReceiptErrorType>
 
-/** https://alpha.wagmi.sh/react/api/hooks/useWaitForTransactionReceipt */
+/** https://wagmi.sh/react/api/hooks/useWaitForTransactionReceipt */
 export function useWaitForTransactionReceipt<
   config extends Config = ResolvedRegister['config'],
   chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
@@ -64,11 +57,15 @@ export function useWaitForTransactionReceipt<
   const config = useConfig(parameters)
   const chainId = useChainId()
 
-  const queryOptions = waitForTransactionReceiptQueryOptions(config, {
+  const options = waitForTransactionReceiptQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
   })
-  const enabled = Boolean(!hash && (query.enabled ?? true))
+  const enabled = Boolean(hash && (query.enabled ?? true))
 
-  return useQuery({ ...queryOptions, ...query, enabled })
+  return useQuery({
+    ...(query as any),
+    ...options,
+    enabled,
+  }) as UseWaitForTransactionReceiptReturnType<config, chainId, selectData>
 }

package/src/hooks/useWalletClient.ts

@@ -6,7 +6,7 @@
 import { useQueryClient } from '@tanstack/react-query'
 import type {
   Config,
-  GetWalletClientError,
+  GetWalletClientErrorType,
   ResolvedRegister,
 } from '@wagmi/core'
 import { type Evaluate, type Omit } from '@wagmi/core/internal'
@@ -36,17 +36,19 @@ export type UseWalletClientParameters<
 > = Evaluate<
   GetWalletClientOptions<config, chainId> &
     ConfigParameter<config> & {
-      query?: Evaluate<
-        Omit<
-          UseQueryParameters<
-            GetWalletClientQueryFnData<config, chainId>,
-            GetWalletClientError,
-            selectData,
-            GetWalletClientQueryKey<config, chainId>
-          >,
-          'gcTime' | 'staleTime'
-        >
-      >
+      query?:
+        | Evaluate<
+            Omit<
+              UseQueryParameters<
+                GetWalletClientQueryFnData<config, chainId>,
+                GetWalletClientErrorType,
+                selectData,
+                GetWalletClientQueryKey<config, chainId>
+              >,
+              'gcTime' | 'staleTime'
+            >
+          >
+        | undefined
     }
 >
 
@@ -54,9 +56,9 @@ export type UseWalletClientReturnType<
   config extends Config = Config,
   chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
   selectData = GetWalletClientData<config, chainId>,
-> = UseQueryReturnType<selectData, GetWalletClientError>
+> = UseQueryReturnType<selectData, GetWalletClientErrorType>
 
-/** https://alpha.wagmi.sh/react/api/hooks/useWalletClient */
+/** https://wagmi.sh/react/api/hooks/useWalletClient */
 export function useWalletClient<
   config extends Config = ResolvedRegister['config'],
   chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
@@ -71,11 +73,14 @@ export function useWalletClient<
   const { address, connector, status } = useAccount()
   const chainId = useChainId()
 
-  const { queryKey, ...options } = getWalletClientQueryOptions(config, {
-    ...parameters,
-    chainId: parameters.chainId ?? chainId,
-    connector: parameters.connector ?? connector,
-  })
+  const { queryKey, ...options } = getWalletClientQueryOptions<config, chainId>(
+    config,
+    {
+      ...parameters,
+      chainId: parameters.chainId ?? chainId,
+      connector: parameters.connector ?? connector,
+    },
+  )
   const enabled = Boolean(status !== 'disconnected' && (query.enabled ?? true))
 
   // biome-ignore lint/nursery/useExhaustiveDependencies: `queryKey` not required
@@ -86,11 +91,10 @@ export function useWalletClient<
   }, [address, queryClient])
 
   return useQuery({
-    ...options,
     ...query,
+    ...options,
     queryKey,
     enabled,
-    gcTime: 0,
     staleTime: Infinity,
   })
 }

package/src/hooks/useWatchBlockNumber.ts

@@ -24,7 +24,7 @@ export type UseWatchBlockNumberParameters<
 
 export type UseWatchBlockNumberReturnType = void
 
-/** https://alpha.wagmi.sh/react/api/hooks/useWatchBlockNumber */
+/** https://wagmi.sh/react/api/hooks/useWatchBlockNumber */
 export function useWatchBlockNumber<
   config extends Config = ResolvedRegister['config'],
   chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],

package/src/hooks/useWatchBlocks.ts

@@ -0,0 +1,61 @@
+'use client'
+
+import {
+  type Config,
+  type ResolvedRegister,
+  type WatchBlocksParameters,
+  watchBlocks,
+} from '@wagmi/core'
+import { type UnionEvaluate, type UnionPartial } from '@wagmi/core/internal'
+import { useEffect } 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'
+
+export type UseWatchBlocksParameters<
+  includeTransactions extends boolean = false,
+  blockTag extends BlockTag = 'latest',
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+> = UnionEvaluate<
+  UnionPartial<
+    WatchBlocksParameters<includeTransactions, blockTag, config, chainId>
+  > &
+    ConfigParameter<config> &
+    EnabledParameter
+>
+
+export type UseWatchBlocksReturnType = void
+
+/** https://wagmi.sh/react/hooks/useWatchBlocks */
+export function useWatchBlocks<
+  config extends Config = ResolvedRegister['config'],
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  includeTransactions extends boolean = false,
+  blockTag extends BlockTag = 'latest',
+>(
+  parameters: UseWatchBlocksParameters<
+    includeTransactions,
+    blockTag,
+    config,
+    chainId
+  > = {} as any,
+): UseWatchBlocksReturnType {
+  const { enabled = true, onBlock, config: _, ...rest } = parameters
+
+  const config = useConfig(parameters)
+  const configChainId = useChainId()
+  const chainId = parameters.chainId ?? configChainId
+
+  useEffect(() => {
+    if (!enabled) return
+    if (!onBlock) return
+    return watchBlocks(config, {
+      ...(rest as any),
+      chainId,
+      onBlock,
+    })
+  }, [chainId, config, enabled, onBlock, rest])
+}

package/src/hooks/useWatchContractEvent.ts

@@ -30,7 +30,7 @@ export type UseWatchContractEventParameters<
 
 export type UseWatchContractEventReturnType = void
 
-/** https://alpha.wagmi.sh/react/api/hooks/useWatchContractEvent */
+/** https://wagmi.sh/react/api/hooks/useWatchContractEvent */
 export function useWatchContractEvent<
   const abi extends Abi | readonly unknown[],
   eventName extends ContractEventName<abi>,

package/src/hooks/useWatchPendingTransactions.ts

@@ -24,7 +24,7 @@ export type UseWatchPendingTransactionsParameters<
 
 export type UseWatchPendingTransactionsReturnType = void
 
-/** https://alpha.wagmi.sh/react/api/hooks/useWatchPendingTransactions */
+/** https://wagmi.sh/react/api/hooks/useWatchPendingTransactions */
 export function useWatchPendingTransactions<
   config extends Config = ResolvedRegister['config'],
   chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],

package/src/hooks/{useContractWrite.ts → useWriteContract.ts}

@@ -1,7 +1,11 @@
 'use client'
 
 import { useMutation } from '@tanstack/react-query'
-import type { Config, ResolvedRegister, WriteContractError } from '@wagmi/core'
+import type {
+  Config,
+  ResolvedRegister,
+  WriteContractErrorType,
+} from '@wagmi/core'
 import {
   type WriteContractData,
   type WriteContractMutate,
@@ -18,14 +22,14 @@ import type {
 } from '../utils/query.js'
 import { useConfig } from './useConfig.js'
 
-export type UseContractWriteParameters<
+export type UseWriteContractParameters<
   config extends Config = Config,
   context = unknown,
 > = ConfigParameter<config> & {
   mutation?:
     | UseMutationParameters<
         WriteContractData,
-        WriteContractError,
+        WriteContractErrorType,
         WriteContractVariables<
           Abi,
           string,
@@ -38,12 +42,12 @@ export type UseContractWriteParameters<
     | undefined
 }
 
-export type UseContractWriteReturnType<
+export type UseWriteContractReturnType<
   config extends Config = Config,
   context = unknown,
 > = UseMutationReturnType<
   WriteContractData,
-  WriteContractError,
+  WriteContractErrorType,
   WriteContractVariables<
     Abi,
     string,
@@ -53,17 +57,17 @@ export type UseContractWriteReturnType<
   >,
   context
 > & {
-  write: WriteContractMutate<config, context>
-  writeAsync: WriteContractMutateAsync<config, context>
+  writeContract: WriteContractMutate<config, context>
+  writeContractAsync: WriteContractMutateAsync<config, context>
 }
 
-/** https://alpha.wagmi.sh/react/api/hooks/useContractWrite */
-export function useContractWrite<
+/** https://wagmi.sh/react/api/hooks/useWriteContract */
+export function useWriteContract<
   config extends Config = ResolvedRegister['config'],
   context = unknown,
 >(
-  parameters: UseContractWriteParameters<config, context> = {},
-): UseContractWriteReturnType<config, context> {
+  parameters: UseWriteContractParameters<config, context> = {},
+): UseWriteContractReturnType<config, context> {
   const { mutation } = parameters
 
   const config = useConfig(parameters)
@@ -74,10 +78,10 @@ export function useContractWrite<
     ...mutationOptions,
   })
 
-  type Return = UseContractWriteReturnType<config, context>
+  type Return = UseWriteContractReturnType<config, context>
   return {
     ...result,
-    write: mutate as Return['write'],
-    writeAsync: mutateAsync as Return['writeAsync'],
+    writeContract: mutate as Return['writeContract'],
+    writeContractAsync: mutateAsync as Return['writeContractAsync'],
   }
 }

package/src/hydrate.ts

@@ -0,0 +1,36 @@
+'use client'
+
+import { type ResolvedRegister, type State, hydrate } from '@wagmi/core'
+import { type ReactElement, useEffect, useRef } from 'react'
+
+export type HydrateProps = {
+  config: ResolvedRegister['config']
+  initialState?: State | undefined
+  reconnectOnMount?: boolean | undefined
+}
+
+export function Hydrate(parameters: React.PropsWithChildren<HydrateProps>) {
+  const { children, config, initialState, reconnectOnMount = true } = parameters
+
+  const { onMount } = hydrate(config, {
+    initialState,
+    reconnectOnMount,
+  })
+
+  // Hydrate for non-SSR
+  if (!config._internal.ssr) onMount()
+
+  // Hydrate for SSR
+  const active = useRef(true)
+  // biome-ignore lint/nursery/useExhaustiveDependencies:
+  useEffect(() => {
+    if (!active.current) return
+    if (!config._internal.ssr) return
+    onMount()
+    return () => {
+      active.current = false
+    }
+  }, [])
+
+  return children as ReactElement
+}