wagmi 1.4.1 → 2.0.0

package/src/hooks/useBalance.ts

@@ -0,0 +1,65 @@
+'use client'
+
+import {
+  type Config,
+  type GetBalanceError,
+  type ResolvedRegister,
+} from '@wagmi/core'
+import type { Evaluate } from '@wagmi/core/internal'
+import {
+  type GetBalanceData,
+  type GetBalanceOptions,
+  type GetBalanceQueryKey,
+  getBalanceQueryOptions,
+} from '@wagmi/core/query'
+import type { GetBalanceQueryFnData } from '@wagmi/core/query'
+
+import type { ConfigParameter } from '../types/properties.js'
+import {
+  type UseQueryParameters,
+  type UseQueryReturnType,
+  useQuery,
+} from '../utils/query.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+
+export type UseBalanceParameters<
+  config extends Config = Config,
+  selectData = GetBalanceData,
+> = Evaluate<
+  GetBalanceOptions<config> &
+    ConfigParameter<config> & {
+      query?:
+        | UseQueryParameters<
+            GetBalanceQueryFnData,
+            GetBalanceError,
+            selectData,
+            GetBalanceQueryKey<config>
+          >
+        | undefined
+    }
+>
+
+export type UseBalanceReturnType<selectData = GetBalanceData> =
+  UseQueryReturnType<selectData, GetBalanceError>
+
+/** https://alpha.wagmi.sh/react/api/hooks/useBalance */
+export function useBalance<
+  config extends Config = ResolvedRegister['config'],
+  selectData = GetBalanceData,
+>(
+  parameters: UseBalanceParameters<config, selectData> = {},
+): UseBalanceReturnType<selectData> {
+  const { address, query = {} } = parameters
+
+  const config = useConfig(parameters)
+  const chainId = useChainId()
+
+  const queryOptions = getBalanceQueryOptions(config, {
+    ...parameters,
+    chainId: parameters.chainId ?? chainId,
+  })
+  const enabled = Boolean(address && (query.enabled ?? true))
+
+  return useQuery({ ...queryOptions, ...query, enabled })
+}

package/src/hooks/useBlockNumber.ts

@@ -0,0 +1,97 @@
+'use client'
+
+import { useQueryClient } from '@tanstack/react-query'
+import {
+  type Config,
+  type GetBlockNumberError,
+  type ResolvedRegister,
+} from '@wagmi/core'
+import { type Evaluate } from '@wagmi/core/internal'
+import {
+  type GetBlockNumberData,
+  type GetBlockNumberOptions,
+  type GetBlockNumberQueryFnData,
+  type GetBlockNumberQueryKey,
+  getBlockNumberQueryOptions,
+} from '@wagmi/core/query'
+
+import type { ConfigParameter } from '../types/properties.js'
+import {
+  type UseQueryParameters,
+  type UseQueryReturnType,
+  useQuery,
+} from '../utils/query.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+import {
+  type UseWatchBlockNumberParameters,
+  useWatchBlockNumber,
+} from './useWatchBlockNumber.js'
+
+export type UseBlockNumberParameters<
+  config extends Config = Config,
+  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
+      watch?:
+        | boolean
+        | Omit<
+            UseWatchBlockNumberParameters<config, chainId>,
+            'chainId' | 'config' | 'onBlockNumber' | 'onError'
+          >
+        | undefined
+    }
+>
+
+export type UseBlockNumberReturnType<selectData = GetBlockNumberData> =
+  UseQueryReturnType<selectData, GetBlockNumberError>
+
+/** https://alpha.wagmi.sh/react/api/hooks/useBlockNumber */
+export function useBlockNumber<
+  config extends Config = ResolvedRegister['config'],
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = GetBlockNumberData,
+>(
+  parameters: UseBlockNumberParameters<config, chainId, selectData> = {},
+): UseBlockNumberReturnType<selectData> {
+  const { query = {}, watch } = parameters
+
+  const config = useConfig(parameters)
+  const queryClient = useQueryClient()
+  const configChainId = useChainId()
+  const chainId = parameters.chainId ?? configChainId
+
+  const queryOptions = getBlockNumberQueryOptions(config, {
+    ...parameters,
+    chainId,
+  })
+
+  useWatchBlockNumber({
+    ...{
+      config: parameters.config,
+      chainId: parameters.chainId as number,
+    },
+    ...(typeof watch === 'object'
+      ? (watch as UseWatchBlockNumberParameters)
+      : {}),
+    enabled: Boolean(
+      (query.enabled ?? true) &&
+        (typeof watch === 'object' ? watch.enabled : watch),
+    ),
+    onBlockNumber(blockNumber) {
+      queryClient.setQueryData(queryOptions.queryKey, blockNumber)
+    },
+  })
+
+  return useQuery({ ...queryOptions, ...query })
+}

package/src/hooks/useChainId.ts

@@ -0,0 +1,31 @@
+'use client'
+
+import {
+  type Config,
+  type GetChainIdReturnType,
+  type ResolvedRegister,
+  getChainId,
+  watchChainId,
+} from '@wagmi/core'
+import { useSyncExternalStore } from 'react'
+
+import type { ConfigParameter } from '../types/properties.js'
+import { useConfig } from './useConfig.js'
+
+export type UseChainIdParameters<config extends Config = Config> =
+  ConfigParameter<config>
+
+export type UseChainIdReturnType<config extends Config = Config> =
+  GetChainIdReturnType<config>
+
+/** https://alpha.wagmi.sh/react/api/hooks/useChainId */
+export function useChainId<config extends Config = ResolvedRegister['config']>(
+  parameters: UseChainIdParameters<config> = {},
+): UseChainIdReturnType<config> {
+  const config = useConfig(parameters)
+
+  return useSyncExternalStore(
+    (onChange) => watchChainId(config, { onChange }),
+    () => getChainId(config),
+  )
+}

package/src/hooks/useClient.ts

@@ -0,0 +1,43 @@
+'use client'
+
+import {
+  type Config,
+  type GetClientParameters,
+  type GetClientReturnType,
+  type ResolvedRegister,
+  getClient,
+  watchClient,
+} from '@wagmi/core'
+import type { Evaluate } from '@wagmi/core/internal'
+import { useSyncExternalStoreWithSelector } from 'use-sync-external-store/shim/with-selector.js'
+
+import type { ConfigParameter } from '../types/properties.js'
+import { useConfig } from './useConfig.js'
+
+export type UseClientParameters<
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+> = Evaluate<GetClientParameters<config, chainId> & ConfigParameter<config>>
+
+export type UseClientReturnType<
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+> = GetClientReturnType<config, chainId>
+
+/** https://alpha.wagmi.sh/react/api/hooks/useClient */
+export function useClient<
+  config extends Config = ResolvedRegister['config'],
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+>(
+  parameters: UseClientParameters<config, chainId> = {},
+): UseClientReturnType<config, chainId> {
+  const config = useConfig(parameters)
+
+  return useSyncExternalStoreWithSelector(
+    (onChange) => watchClient(config, { onChange }),
+    () => getClient(config, parameters),
+    () => getClient(config, parameters),
+    (x) => x,
+    (a, b) => a.uid === b.uid,
+  ) as any
+}

package/src/hooks/useConfig.ts

@@ -0,0 +1,22 @@
+'use client'
+
+import { type Config, type ResolvedRegister } from '@wagmi/core'
+import { useContext } from 'react'
+
+import { WagmiContext } from '../context.js'
+import { WagmiProviderNotFoundError } from '../errors/context.js'
+import type { ConfigParameter } from '../types/properties.js'
+
+export type UseConfigParameters<config extends Config = Config> =
+  ConfigParameter<config>
+
+export type UseConfigReturnType<config extends Config = Config> = config
+
+/** https://alpha.wagmi.sh/react/api/hooks/useConfig */
+export function useConfig<config extends Config = ResolvedRegister['config']>(
+  parameters: UseConfigParameters<config> = {},
+): UseConfigReturnType<config> {
+  const config = parameters.config ?? useContext(WagmiContext)
+  if (!config) throw new WagmiProviderNotFoundError()
+  return config as UseConfigReturnType<config>
+}

package/src/hooks/useConnect.ts

@@ -0,0 +1,80 @@
+'use client'
+
+import { useMutation } from '@tanstack/react-query'
+import {
+  type Config,
+  type ConnectError,
+  type ResolvedRegister,
+} from '@wagmi/core'
+import type { Evaluate } from '@wagmi/core/internal'
+import {
+  type ConnectData,
+  type ConnectMutate,
+  type ConnectMutateAsync,
+  type ConnectVariables,
+  connectMutationOptions,
+} from '@wagmi/core/query'
+
+import type { ConfigParameter } from '../types/properties.js'
+import type {
+  UseMutationParameters,
+  UseMutationReturnType,
+} from '../utils/query.js'
+import { useConfig } from './useConfig.js'
+
+export type UseConnectParameters<
+  config extends Config = Config,
+  context = unknown,
+> = Evaluate<
+  ConfigParameter<config> & {
+    mutation?:
+      | UseMutationParameters<
+          ConnectData<config>,
+          ConnectError,
+          ConnectVariables<config>,
+          context
+        >
+      | undefined
+  }
+>
+
+export type UseConnectReturnType<
+  config extends Config = Config,
+  context = unknown,
+> = Evaluate<
+  UseMutationReturnType<
+    ConnectData<config>,
+    ConnectError,
+    ConnectVariables<config>,
+    context
+  > & {
+    connect: ConnectMutate<config, context>
+    connectAsync: ConnectMutateAsync<config, context>
+    connectors: config['connectors']
+  }
+>
+
+/** https://alpha.wagmi.sh/react/api/hooks/useConnect */
+export function useConnect<
+  config extends Config = ResolvedRegister['config'],
+  context = unknown,
+>(
+  parameters: UseConnectParameters<config, context> = {},
+): UseConnectReturnType<config, context> {
+  const { mutation } = parameters
+
+  const config = useConfig(parameters)
+
+  const mutationOptions = connectMutationOptions(config)
+  const { mutate, mutateAsync, ...result } = useMutation({
+    ...mutation,
+    ...mutationOptions,
+  })
+
+  return {
+    ...result,
+    connect: mutate,
+    connectAsync: mutateAsync,
+    connectors: config.connectors,
+  }
+}

package/src/hooks/useConnections.ts

@@ -0,0 +1,27 @@
+'use client'
+
+import {
+  type GetConnectionsReturnType,
+  getConnections,
+  watchConnections,
+} from '@wagmi/core'
+import { useSyncExternalStore } from 'react'
+
+import type { ConfigParameter } from '../types/properties.js'
+import { useConfig } from './useConfig.js'
+
+export type UseConnectionsParameters = ConfigParameter
+
+export type UseConnectionsReturnType = GetConnectionsReturnType
+
+/** https://alpha.wagmi.sh/react/api/hooks/useConnections */
+export function useConnections(
+  parameters: UseConnectionsParameters = {},
+): UseConnectionsReturnType {
+  const config = useConfig(parameters)
+
+  return useSyncExternalStore(
+    (onChange) => watchConnections(config, { onChange }),
+    () => getConnections(config),
+  )
+}

package/src/hooks/useConnectorClient.ts

@@ -0,0 +1,95 @@
+'use client'
+
+import { useQueryClient } from '@tanstack/react-query'
+import type {
+  Config,
+  GetConnectorClientError,
+  ResolvedRegister,
+} from '@wagmi/core'
+import { type Evaluate, type Omit } from '@wagmi/core/internal'
+import {
+  type GetConnectorClientData,
+  type GetConnectorClientOptions,
+  type GetConnectorClientQueryFnData,
+  type GetConnectorClientQueryKey,
+  getConnectorClientQueryOptions,
+} from '@wagmi/core/query'
+import { useEffect } from 'react'
+
+import type { ConfigParameter } from '../types/properties.js'
+import {
+  type UseQueryParameters,
+  type UseQueryReturnType,
+  useQuery,
+} from '../utils/query.js'
+import { useAccount } from './useAccount.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+
+export type UseConnectorClientParameters<
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = GetConnectorClientData<config, chainId>,
+> = Evaluate<
+  GetConnectorClientOptions<config, chainId> &
+    ConfigParameter<config> & {
+      query?:
+        | Evaluate<
+            Omit<
+              UseQueryParameters<
+                GetConnectorClientQueryFnData<config, chainId>,
+                GetConnectorClientError,
+                selectData,
+                GetConnectorClientQueryKey<config, chainId>
+              >,
+              'gcTime' | 'staleTime'
+            >
+          >
+        | undefined
+    }
+>
+
+export type UseConnectorClientReturnType<
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = GetConnectorClientData<config, chainId>,
+> = UseQueryReturnType<selectData, GetConnectorClientError>
+
+/** https://alpha.wagmi.sh/react/api/hooks/useConnectorClient */
+export function useConnectorClient<
+  config extends Config = ResolvedRegister['config'],
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = GetConnectorClientData<config, chainId>,
+>(
+  parameters: UseConnectorClientParameters<config, chainId, selectData> = {},
+): UseConnectorClientReturnType<config, chainId, selectData> {
+  const { query = {} } = parameters
+
+  const config = useConfig(parameters)
+  const queryClient = useQueryClient()
+  const { address, connector, status } = useAccount()
+  const chainId = useChainId()
+
+  const { queryKey, ...options } = getConnectorClientQueryOptions(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
+  useEffect(() => {
+    // invalidate when address changes
+    if (address) queryClient.invalidateQueries({ queryKey })
+    else queryClient.removeQueries({ queryKey }) // remove when account is disconnected
+  }, [address, queryClient])
+
+  return useQuery({
+    ...options,
+    ...query,
+    queryKey,
+    enabled,
+    gcTime: 0,
+    staleTime: Infinity,
+  })
+}

package/src/hooks/useContractRead.ts

@@ -0,0 +1,107 @@
+'use client'
+
+import {
+  type Config,
+  type ReadContractError,
+  type ResolvedRegister,
+} from '@wagmi/core'
+import { type UnionEvaluate } from '@wagmi/core/internal'
+import {
+  type ReadContractData,
+  type ReadContractOptions,
+  type ReadContractQueryFnData,
+  type ReadContractQueryKey,
+  readContractQueryOptions,
+} from '@wagmi/core/query'
+import {
+  type Abi,
+  type ContractFunctionArgs,
+  type ContractFunctionName,
+} from 'viem'
+
+import type { ConfigParameter } from '../types/properties.js'
+import {
+  type UseQueryParameters,
+  type UseQueryReturnType,
+  structuralSharing,
+  useQuery,
+} from '../utils/query.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+
+export type UseContractReadParameters<
+  abi extends Abi | readonly unknown[] = Abi,
+  functionName extends ContractFunctionName<
+    abi,
+    'pure' | 'view'
+  > = ContractFunctionName<abi, 'pure' | 'view'>,
+  args extends ContractFunctionArgs<
+    abi,
+    'pure' | 'view',
+    functionName
+  > = ContractFunctionArgs<abi, 'pure' | 'view', functionName>,
+  config extends Config = Config,
+  selectData = ReadContractData<abi, functionName, args>,
+> = UnionEvaluate<
+  ReadContractOptions<abi, functionName, args, config> &
+    ConfigParameter<config> & {
+      query?:
+        | UseQueryParameters<
+            ReadContractQueryFnData<abi, functionName, args>,
+            ReadContractError,
+            selectData,
+            ReadContractQueryKey<config, abi, functionName, args>
+          >
+        | undefined
+    }
+>
+
+export type UseContractReadReturnType<
+  abi extends Abi | readonly unknown[] = Abi,
+  functionName extends ContractFunctionName<
+    abi,
+    'pure' | 'view'
+  > = ContractFunctionName<abi, 'pure' | 'view'>,
+  args extends ContractFunctionArgs<
+    abi,
+    'pure' | 'view',
+    functionName
+  > = ContractFunctionArgs<abi, 'pure' | 'view', functionName>,
+  selectData = ReadContractData<abi, functionName, args>,
+> = UseQueryReturnType<selectData, ReadContractError>
+
+/** https://alpha.wagmi.sh/react/api/hooks/useContractRead */
+export function useContractRead<
+  const abi extends Abi | readonly unknown[],
+  functionName extends ContractFunctionName<abi, 'pure' | 'view'>,
+  args extends ContractFunctionArgs<abi, 'pure' | 'view', functionName>,
+  config extends Config = ResolvedRegister['config'],
+  selectData = ReadContractData<abi, functionName, args>,
+>(
+  parameters: UseContractReadParameters<
+    abi,
+    functionName,
+    args,
+    config,
+    selectData
+  > = {} as any,
+): UseContractReadReturnType<abi, functionName, args, selectData> {
+  const { abi, address, functionName, query = {} } = parameters
+  const config = useConfig(parameters)
+  const chainId = useChainId()
+
+  const queryOptions = readContractQueryOptions(config, {
+    ...(parameters as any),
+    chainId: parameters.chainId ?? chainId,
+  })
+  const enabled = Boolean(
+    address && abi && functionName && (query.enabled ?? true),
+  )
+
+  return useQuery({
+    ...queryOptions,
+    ...query,
+    enabled,
+    structuralSharing: query.structuralSharing ?? structuralSharing,
+  })
+}

package/src/hooks/useContractReads.ts

@@ -0,0 +1,98 @@
+'use client'
+
+import {
+  type Config,
+  type ReadContractError,
+  type ResolvedRegister,
+} from '@wagmi/core'
+import { type Evaluate } from '@wagmi/core/internal'
+import {
+  type ReadContractsData,
+  type ReadContractsOptions,
+  type ReadContractsQueryFnData,
+  type ReadContractsQueryKey,
+  readContractsQueryOptions,
+} from '@wagmi/core/query'
+import { useMemo } from 'react'
+import type { ContractFunctionParameters } from 'viem'
+
+import type { ConfigParameter } from '../types/properties.js'
+import {
+  type UseQueryParameters,
+  type UseQueryReturnType,
+  structuralSharing,
+  useQuery,
+} from '../utils/query.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+
+export type UseContractReadsParameters<
+  contracts extends readonly unknown[] = readonly ContractFunctionParameters[],
+  allowFailure extends boolean = true,
+  config extends Config = Config,
+  selectData = ReadContractsData<contracts, allowFailure>,
+> = Evaluate<
+  ReadContractsOptions<config, contracts, allowFailure> &
+    ConfigParameter<config> & {
+      query?:
+        | UseQueryParameters<
+            ReadContractsQueryFnData<contracts, allowFailure>,
+            ReadContractError,
+            selectData,
+            ReadContractsQueryKey<config, contracts, allowFailure>
+          >
+        | undefined
+    }
+>
+
+export type UseContractReadsReturnType<
+  contracts extends readonly unknown[] = readonly ContractFunctionParameters[],
+  allowFailure extends boolean = true,
+  selectData = ReadContractsData<contracts, allowFailure>,
+> = UseQueryReturnType<selectData, ReadContractError>
+
+/** https://alpha.wagmi.sh/react/api/hooks/useContractReads */
+export function useContractReads<
+  const contracts extends readonly unknown[],
+  allowFailure extends boolean = true,
+  config extends Config = ResolvedRegister['config'],
+  selectData = ReadContractsData<contracts, allowFailure>,
+>(
+  parameters: UseContractReadsParameters<
+    contracts,
+    allowFailure,
+    config,
+    selectData
+  > = {},
+): UseContractReadsReturnType<contracts, allowFailure, selectData> {
+  const { contracts = [], query = {} } = parameters
+
+  const config = useConfig(parameters)
+  const chainId = useChainId()
+
+  const queryOptions = readContractsQueryOptions(config, {
+    ...parameters,
+    chainId,
+    contracts,
+  })
+  const enabled = useMemo(() => {
+    let isContractsValid = false
+    for (const contract of contracts) {
+      const { abi, address, functionName } =
+        contract as ContractFunctionParameters
+      if (!abi || !address || !functionName) {
+        isContractsValid = false
+        break
+      }
+      isContractsValid = true
+    }
+    return Boolean(isContractsValid && (query.enabled ?? true))
+  }, [contracts, query.enabled])
+
+  return useQuery({
+    ...queryOptions,
+    ...query,
+    enabled,
+    structuralSharing: query.structuralSharing ?? structuralSharing,
+  })
+}