wagmi 2.0.0 → 2.0.2

package/src/hooks/useBlock.ts

@@ -0,0 +1,129 @@
+'use client'
+
+import { useQueryClient } from '@tanstack/react-query'
+import {
+  type Config,
+  type GetBlockErrorType,
+  type ResolvedRegister,
+} from '@wagmi/core'
+import {
+  type Evaluate,
+  type UnionEvaluate,
+  type UnionOmit,
+} from '@wagmi/core/internal'
+import {
+  type GetBlockData,
+  type GetBlockOptions,
+  type GetBlockQueryFnData,
+  type GetBlockQueryKey,
+  getBlockQueryOptions,
+} from '@wagmi/core/query'
+import type { BlockTag } 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'
+import {
+  type UseWatchBlocksParameters,
+  useWatchBlocks,
+} from './useWatchBlocks.js'
+
+export type UseBlockParameters<
+  includeTransactions extends boolean = false,
+  blockTag extends BlockTag = 'latest',
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = GetBlockData<includeTransactions, blockTag, config, chainId>,
+> = Evaluate<
+  GetBlockOptions<includeTransactions, blockTag, config, chainId> &
+    ConfigParameter<config> &
+    QueryParameter<
+      GetBlockQueryFnData<includeTransactions, blockTag, config, chainId>,
+      GetBlockErrorType,
+      selectData,
+      GetBlockQueryKey<includeTransactions, blockTag, config, chainId>
+    > & {
+      watch?:
+        | boolean
+        | UnionEvaluate<
+            UnionOmit<
+              UseWatchBlocksParameters<
+                includeTransactions,
+                blockTag,
+                config,
+                chainId
+              >,
+              'chainId' | 'config' | 'onBlock' | 'onError'
+            >
+          >
+        | undefined
+    }
+>
+
+export type UseBlockReturnType<
+  includeTransactions extends boolean = false,
+  blockTag extends BlockTag = 'latest',
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = GetBlockData<includeTransactions, blockTag, config, chainId>,
+> = UseQueryReturnType<selectData, GetBlockErrorType>
+
+/** https://wagmi.sh/react/hooks/useBlock */
+export function useBlock<
+  includeTransactions extends boolean = false,
+  blockTag extends BlockTag = 'latest',
+  config extends Config = ResolvedRegister['config'],
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = GetBlockData<includeTransactions, blockTag, config, chainId>,
+>(
+  parameters: UseBlockParameters<
+    includeTransactions,
+    blockTag,
+    config,
+    chainId,
+    selectData
+  > = {},
+): UseBlockReturnType<
+  includeTransactions,
+  blockTag,
+  config,
+  chainId,
+  selectData
+> {
+  const { query = {}, watch } = parameters
+
+  const config = useConfig(parameters)
+  const queryClient = useQueryClient()
+  const configChainId = useChainId()
+  const chainId = parameters.chainId ?? configChainId
+
+  const options = getBlockQueryOptions(config, { chainId })
+  const enabled = Boolean(query.enabled ?? true)
+
+  useWatchBlocks({
+    ...({
+      config: parameters.config,
+      chainId: parameters.chainId!,
+      ...(typeof watch === 'object' ? watch : {}),
+    } as UseWatchBlocksParameters),
+    enabled: Boolean(
+      enabled && (typeof watch === 'object' ? watch.enabled : watch),
+    ),
+    onBlock(block) {
+      queryClient.setQueryData(options.queryKey, block)
+    },
+  })
+
+  return useQuery({
+    ...(query as any),
+    ...options,
+    enabled,
+  }) as UseBlockReturnType<
+    includeTransactions,
+    blockTag,
+    config,
+    chainId,
+    selectData
+  >
+}

package/src/hooks/useBlockNumber.ts

@@ -3,10 +3,14 @@
 import { useQueryClient } from '@tanstack/react-query'
 import {
   type Config,
-  type GetBlockNumberError,
+  type GetBlockNumberErrorType,
   type ResolvedRegister,
 } from '@wagmi/core'
-import { type Evaluate } from '@wagmi/core/internal'
+import {
+  type Evaluate,
+  type UnionEvaluate,
+  type UnionOmit,
+} from '@wagmi/core/internal'
 import {
   type GetBlockNumberData,
   type GetBlockNumberOptions,
@@ -15,12 +19,8 @@ import {
   getBlockNumberQueryOptions,
 } 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 {
@@ -33,30 +33,30 @@ export type UseBlockNumberParameters<
   chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
   selectData = GetBlockNumberData,
 > = Evaluate<
-  GetBlockNumberOptions<config> &
-    ConfigParameter<config> & {
-      query?:
-        | UseQueryParameters<
-            GetBlockNumberQueryFnData,
-            GetBlockNumberError,
-            selectData,
-            GetBlockNumberQueryKey<config>
-          >
-        | undefined
+  GetBlockNumberOptions<config, chainId> &
+    ConfigParameter<config> &
+    QueryParameter<
+      GetBlockNumberQueryFnData,
+      GetBlockNumberErrorType,
+      selectData,
+      GetBlockNumberQueryKey<config, chainId>
+    > & {
       watch?:
         | boolean
-        | Omit<
-            UseWatchBlockNumberParameters<config, chainId>,
-            'chainId' | 'config' | 'onBlockNumber' | 'onError'
+        | UnionEvaluate<
+            UnionOmit<
+              UseWatchBlockNumberParameters<config, chainId>,
+              'chainId' | 'config' | 'onBlockNumber' | 'onError'
+            >
           >
         | undefined
     }
 >
 
 export type UseBlockNumberReturnType<selectData = GetBlockNumberData> =
-  UseQueryReturnType<selectData, GetBlockNumberError>
+  UseQueryReturnType<selectData, GetBlockNumberErrorType>
 
-/** https://alpha.wagmi.sh/react/api/hooks/useBlockNumber */
+/** https://wagmi.sh/react/api/hooks/useBlockNumber */
 export function useBlockNumber<
   config extends Config = ResolvedRegister['config'],
   chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
@@ -71,27 +71,25 @@ export function useBlockNumber<
   const configChainId = useChainId()
   const chainId = parameters.chainId ?? configChainId
 
-  const queryOptions = getBlockNumberQueryOptions(config, {
+  const options = getBlockNumberQueryOptions(config, {
     ...parameters,
     chainId,
   })
 
   useWatchBlockNumber({
-    ...{
+    ...({
       config: parameters.config,
-      chainId: parameters.chainId as number,
-    },
-    ...(typeof watch === 'object'
-      ? (watch as UseWatchBlockNumberParameters)
-      : {}),
+      chainId: parameters.chainId,
+      ...(typeof watch === 'object' ? watch : {}),
+    } as UseWatchBlockNumberParameters),
     enabled: Boolean(
       (query.enabled ?? true) &&
         (typeof watch === 'object' ? watch.enabled : watch),
     ),
     onBlockNumber(blockNumber) {
-      queryClient.setQueryData(queryOptions.queryKey, blockNumber)
+      queryClient.setQueryData(options.queryKey, blockNumber)
     },
   })
 
-  return useQuery({ ...queryOptions, ...query })
+  return useQuery({ ...query, ...options })
 }

package/src/hooks/useBlockTransactionCount.ts

@@ -0,0 +1,65 @@
+'use client'
+
+import {
+  type Config,
+  type GetBlockTransactionCountErrorType,
+  type ResolvedRegister,
+} from '@wagmi/core'
+import { type UnionEvaluate } from '@wagmi/core/internal'
+import {
+  type GetBlockTransactionCountData,
+  type GetBlockTransactionCountOptions,
+  type GetBlockTransactionCountQueryFnData,
+  type GetBlockTransactionCountQueryKey,
+  getBlockTransactionCountQueryOptions,
+} 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 UseBlockTransactionCountParameters<
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = GetBlockTransactionCountData,
+> = UnionEvaluate<
+  GetBlockTransactionCountOptions<config, chainId> &
+    ConfigParameter<config> &
+    QueryParameter<
+      GetBlockTransactionCountQueryFnData,
+      GetBlockTransactionCountErrorType,
+      selectData,
+      GetBlockTransactionCountQueryKey<config, chainId>
+    >
+>
+
+export type UseBlockTransactionCountReturnType<
+  selectData = GetBlockTransactionCountData,
+> = UseQueryReturnType<selectData, GetBlockTransactionCountErrorType>
+
+/** https://wagmi.sh/react/api/hooks/useBlockTransactionCount */
+export function useBlockTransactionCount<
+  config extends Config = ResolvedRegister['config'],
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = GetBlockTransactionCountData,
+>(
+  parameters: UseBlockTransactionCountParameters<
+    config,
+    chainId,
+    selectData
+  > = {},
+): UseBlockTransactionCountReturnType<selectData> {
+  const { query = {} } = parameters
+
+  const config = useConfig(parameters)
+  const configChainId = useChainId()
+  const chainId = parameters.chainId ?? configChainId
+
+  const options = getBlockTransactionCountQueryOptions(config, {
+    ...parameters,
+    chainId,
+  })
+
+  return useQuery({ ...query, ...options })
+}

package/src/hooks/useChainId.ts

@@ -18,7 +18,7 @@ export type UseChainIdParameters<config extends Config = Config> =
 export type UseChainIdReturnType<config extends Config = Config> =
   GetChainIdReturnType<config>
 
-/** https://alpha.wagmi.sh/react/api/hooks/useChainId */
+/** https://wagmi.sh/react/api/hooks/useChainId */
 export function useChainId<config extends Config = ResolvedRegister['config']>(
   parameters: UseChainIdParameters<config> = {},
 ): UseChainIdReturnType<config> {
@@ -27,5 +27,6 @@ export function useChainId<config extends Config = ResolvedRegister['config']>(
   return useSyncExternalStore(
     (onChange) => watchChainId(config, { onChange }),
     () => getChainId(config),
+    () => getChainId(config),
   )
 }

package/src/hooks/useClient.ts

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

package/src/hooks/useConfig.ts

@@ -12,7 +12,7 @@ export type UseConfigParameters<config extends Config = Config> =
 
 export type UseConfigReturnType<config extends Config = Config> = config
 
-/** https://alpha.wagmi.sh/react/api/hooks/useConfig */
+/** https://wagmi.sh/react/api/hooks/useConfig */
 export function useConfig<config extends Config = ResolvedRegister['config']>(
   parameters: UseConfigParameters<config> = {},
 ): UseConfigReturnType<config> {

package/src/hooks/useConnect.ts

@@ -3,7 +3,8 @@
 import { useMutation } from '@tanstack/react-query'
 import {
   type Config,
-  type ConnectError,
+  type ConnectErrorType,
+  type Connector,
   type ResolvedRegister,
 } from '@wagmi/core'
 import type { Evaluate } from '@wagmi/core/internal'
@@ -14,6 +15,7 @@ import {
   type ConnectVariables,
   connectMutationOptions,
 } from '@wagmi/core/query'
+import { useEffect } from 'react'
 
 import type { ConfigParameter } from '../types/properties.js'
 import type {
@@ -21,6 +23,7 @@ import type {
   UseMutationReturnType,
 } from '../utils/query.js'
 import { useConfig } from './useConfig.js'
+import { useConnectors } from './useConnectors.js'
 
 export type UseConnectParameters<
   config extends Config = Config,
@@ -30,7 +33,7 @@ export type UseConnectParameters<
     mutation?:
       | UseMutationParameters<
           ConnectData<config>,
-          ConnectError,
+          ConnectErrorType,
           ConnectVariables<config>,
           context
         >
@@ -44,17 +47,17 @@ export type UseConnectReturnType<
 > = Evaluate<
   UseMutationReturnType<
     ConnectData<config>,
-    ConnectError,
+    ConnectErrorType,
     ConnectVariables<config>,
     context
   > & {
     connect: ConnectMutate<config, context>
     connectAsync: ConnectMutateAsync<config, context>
-    connectors: config['connectors']
+    connectors: readonly Connector[]
   }
 >
 
-/** https://alpha.wagmi.sh/react/api/hooks/useConnect */
+/** https://wagmi.sh/react/api/hooks/useConnect */
 export function useConnect<
   config extends Config = ResolvedRegister['config'],
   context = unknown,
@@ -64,6 +67,7 @@ export function useConnect<
   const { mutation } = parameters
 
   const config = useConfig(parameters)
+  const connectors = useConnectors({ config })
 
   const mutationOptions = connectMutationOptions(config)
   const { mutate, mutateAsync, ...result } = useMutation({
@@ -71,10 +75,21 @@ export function useConnect<
     ...mutationOptions,
   })
 
+  // Reset mutation back to an idle state when the connector disconnects.
+  useEffect(() => {
+    return config.subscribe(
+      ({ status }) => status,
+      (status, previousStatus) => {
+        if (previousStatus === 'connected' && status === 'disconnected')
+          result.reset()
+      },
+    )
+  }, [config, result])
+
   return {
     ...result,
     connect: mutate,
     connectAsync: mutateAsync,
-    connectors: config.connectors,
+    connectors,
   }
 }

package/src/hooks/useConnections.ts

@@ -14,7 +14,7 @@ export type UseConnectionsParameters = ConfigParameter
 
 export type UseConnectionsReturnType = GetConnectionsReturnType
 
-/** https://alpha.wagmi.sh/react/api/hooks/useConnections */
+/** https://wagmi.sh/react/api/hooks/useConnections */
 export function useConnections(
   parameters: UseConnectionsParameters = {},
 ): UseConnectionsReturnType {
@@ -23,5 +23,6 @@ export function useConnections(
   return useSyncExternalStore(
     (onChange) => watchConnections(config, { onChange }),
     () => getConnections(config),
+    () => getConnections(config),
   )
 }

package/src/hooks/useConnectorClient.ts

@@ -3,7 +3,7 @@
 import { useQueryClient } from '@tanstack/react-query'
 import type {
   Config,
-  GetConnectorClientError,
+  GetConnectorClientErrorType,
   ResolvedRegister,
 } from '@wagmi/core'
 import { type Evaluate, type Omit } from '@wagmi/core/internal'
@@ -38,7 +38,7 @@ export type UseConnectorClientParameters<
             Omit<
               UseQueryParameters<
                 GetConnectorClientQueryFnData<config, chainId>,
-                GetConnectorClientError,
+                GetConnectorClientErrorType,
                 selectData,
                 GetConnectorClientQueryKey<config, chainId>
               >,
@@ -53,9 +53,9 @@ export type UseConnectorClientReturnType<
   config extends Config = Config,
   chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
   selectData = GetConnectorClientData<config, chainId>,
-> = UseQueryReturnType<selectData, GetConnectorClientError>
+> = UseQueryReturnType<selectData, GetConnectorClientErrorType>
 
-/** https://alpha.wagmi.sh/react/api/hooks/useConnectorClient */
+/** https://wagmi.sh/react/api/hooks/useConnectorClient */
 export function useConnectorClient<
   config extends Config = ResolvedRegister['config'],
   chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
@@ -70,7 +70,10 @@ export function useConnectorClient<
   const { address, connector, status } = useAccount()
   const chainId = useChainId()
 
-  const { queryKey, ...options } = getConnectorClientQueryOptions(config, {
+  const { queryKey, ...options } = getConnectorClientQueryOptions<
+    config,
+    chainId
+  >(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
     connector: parameters.connector ?? connector,
@@ -85,11 +88,10 @@ export function useConnectorClient<
   }, [address, queryClient])
 
   return useQuery({
-    ...options,
     ...query,
+    ...options,
     queryKey,
     enabled,
-    gcTime: 0,
     staleTime: Infinity,
   })
 }

package/src/hooks/useConnectors.ts

@@ -0,0 +1,28 @@
+'use client'
+
+import {
+  type GetConnectorsReturnType,
+  getConnectors,
+  watchConnectors,
+} from '@wagmi/core'
+import { useSyncExternalStore } from 'react'
+
+import type { ConfigParameter } from '../types/properties.js'
+import { useConfig } from './useConfig.js'
+
+export type UseConnectorsParameters = ConfigParameter
+
+export type UseConnectorsReturnType = GetConnectorsReturnType
+
+/** https://wagmi.sh/react/api/hooks/useConnectors */
+export function useConnectors(
+  parameters: UseConnectorsParameters = {},
+): UseConnectorsReturnType {
+  const config = useConfig(parameters)
+
+  return useSyncExternalStore(
+    (onChange) => watchConnectors(config, { onChange }),
+    () => getConnectors(config),
+    () => getConnectors(config),
+  )
+}

package/src/hooks/useDisconnect.ts

@@ -1,7 +1,7 @@
 'use client'
 
 import { useMutation } from '@tanstack/react-query'
-import { type Connector, type DisconnectError } from '@wagmi/core'
+import { type Connector, type DisconnectErrorType } from '@wagmi/core'
 import type { Evaluate } from '@wagmi/core/internal'
 import {
   type DisconnectData,
@@ -24,7 +24,7 @@ export type UseDisconnectParameters<context = unknown> = Evaluate<
     mutation?:
       | UseMutationParameters<
           DisconnectData,
-          DisconnectError,
+          DisconnectErrorType,
           DisconnectVariables,
           context
         >
@@ -35,7 +35,7 @@ export type UseDisconnectParameters<context = unknown> = Evaluate<
 export type UseDisconnectReturnType<context = unknown> = Evaluate<
   UseMutationReturnType<
     DisconnectData,
-    DisconnectError,
+    DisconnectErrorType,
     DisconnectVariables,
     context
   > & {
@@ -45,7 +45,7 @@ export type UseDisconnectReturnType<context = unknown> = Evaluate<
   }
 >
 
-/** https://alpha.wagmi.sh/react/api/hooks/useDisconnect */
+/** https://wagmi.sh/react/api/hooks/useDisconnect */
 export function useDisconnect<context = unknown>(
   parameters: UseDisconnectParameters<context> = {},
 ): UseDisconnectReturnType<context> {

package/src/hooks/useEnsAddress.ts

@@ -1,6 +1,10 @@
 'use client'
 
-import type { Config, GetEnsAddressError, ResolvedRegister } from '@wagmi/core'
+import type {
+  Config,
+  GetEnsAddressErrorType,
+  ResolvedRegister,
+} from '@wagmi/core'
 import { type Evaluate } from '@wagmi/core/internal'
 import {
   type GetEnsAddressData,
@@ -10,12 +14,8 @@ import {
   getEnsAddressQueryOptions,
 } 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 UseEnsAddressParameters<
   selectData = GetEnsAddressData,
 > = Evaluate<
   GetEnsAddressOptions<config> &
-    ConfigParameter<config> & {
-      query?:
-        | UseQueryParameters<
-            GetEnsAddressQueryFnData,
-            GetEnsAddressError,
-            selectData,
-            GetEnsAddressQueryKey<config>
-          >
-        | undefined
-    }
+    ConfigParameter<config> &
+    QueryParameter<
+      GetEnsAddressQueryFnData,
+      GetEnsAddressErrorType,
+      selectData,
+      GetEnsAddressQueryKey<config>
+    >
 >
 
 export type UseEnsAddressReturnType<selectData = GetEnsAddressData> =
-  UseQueryReturnType<selectData, GetEnsAddressError>
+  UseQueryReturnType<selectData, GetEnsAddressErrorType>
 
-/** https://alpha.wagmi.sh/react/api/hooks/useEnsAddress */
+/** https://wagmi.sh/react/api/hooks/useEnsAddress */
 export function useEnsAddress<
   config extends Config = ResolvedRegister['config'],
   selectData = GetEnsAddressData,
@@ -51,11 +48,11 @@ export function useEnsAddress<
   const config = useConfig(parameters)
   const chainId = useChainId()
 
-  const queryOptions = getEnsAddressQueryOptions(config, {
+  const options = getEnsAddressQueryOptions(config, {
     ...parameters,
     chainId: parameters.chainId ?? chainId,
   })
   const enabled = Boolean(name && (query.enabled ?? true))
 
-  return useQuery({ ...queryOptions, ...query, enabled })
+  return useQuery({ ...query, ...options, enabled })
 }