@wagmi/core 1.4.1 → 2.0.0

package/src/exports/query.ts

@@ -0,0 +1,220 @@
+////////////////////////////////////////////////////////////////////////////////
+// Tanstack Query
+
+export {
+  type ConnectData,
+  type ConnectVariables,
+  type ConnectMutate,
+  type ConnectMutateAsync,
+  connectMutationOptions,
+} from '../query/connect.js'
+
+export {
+  type DisconnectData,
+  type DisconnectVariables,
+  type DisconnectMutate,
+  type DisconnectMutateAsync,
+  disconnectMutationOptions,
+} from '../query/disconnect.js'
+
+export {
+  type EstimateFeesPerGasData,
+  type EstimateFeesPerGasOptions,
+  type EstimateFeesPerGasQueryFnData,
+  type EstimateFeesPerGasQueryKey,
+  estimateFeesPerGasQueryKey,
+  estimateFeesPerGasQueryOptions,
+} from '../query/estimateFeesPerGas.js'
+
+export {
+  type EstimateGasData,
+  type EstimateGasOptions,
+  type EstimateGasQueryFnData,
+  type EstimateGasQueryKey,
+  estimateGasQueryKey,
+  estimateGasQueryOptions,
+} from '../query/estimateGas.js'
+
+export {
+  type GetBalanceData,
+  type GetBalanceOptions,
+  type GetBalanceQueryFnData,
+  type GetBalanceQueryKey,
+  getBalanceQueryKey,
+  getBalanceQueryOptions,
+} from '../query/getBalance.js'
+
+export {
+  type GetBlockNumberData,
+  type GetBlockNumberOptions,
+  type GetBlockNumberQueryFnData,
+  type GetBlockNumberQueryKey,
+  getBlockNumberQueryKey,
+  getBlockNumberQueryOptions,
+} from '../query/getBlockNumber.js'
+
+export {
+  type GetConnectorClientData,
+  type GetConnectorClientOptions,
+  type GetConnectorClientQueryFnData,
+  type GetConnectorClientQueryKey,
+  getConnectorClientQueryKey,
+  getConnectorClientQueryOptions,
+} from '../query/getConnectorClient.js'
+
+export {
+  type GetEnsAddressData,
+  type GetEnsAddressOptions,
+  type GetEnsAddressQueryFnData,
+  type GetEnsAddressQueryKey,
+  getEnsAddressQueryKey,
+  getEnsAddressQueryOptions,
+} from '../query/getEnsAddress.js'
+
+export {
+  type GetEnsAvatarData,
+  type GetEnsAvatarOptions,
+  type GetEnsAvatarQueryFnData,
+  type GetEnsAvatarQueryKey,
+  getEnsAvatarQueryKey,
+  getEnsAvatarQueryOptions,
+} from '../query/getEnsAvatar.js'
+
+export {
+  type GetEnsNameData,
+  type GetEnsNameOptions,
+  type GetEnsNameQueryFnData,
+  type GetEnsNameQueryKey,
+  getEnsNameQueryKey,
+  getEnsNameQueryOptions,
+} from '../query/getEnsName.js'
+
+export {
+  type GetEnsResolverData,
+  type GetEnsResolverOptions,
+  type GetEnsResolverQueryFnData,
+  type GetEnsResolverQueryKey,
+  getEnsResolverQueryKey,
+  getEnsResolverQueryOptions,
+} from '../query/getEnsResolver.js'
+
+export {
+  type GetTokenData,
+  type GetTokenOptions,
+  type GetTokenQueryFnData,
+  type GetTokenQueryKey,
+  getTokenQueryKey,
+  getTokenQueryOptions,
+} from '../query/getToken.js'
+
+export {
+  type GetTransactionData,
+  type GetTransactionOptions,
+  type GetTransactionQueryFnData,
+  type GetTransactionQueryKey,
+  getTransactionQueryKey,
+  getTransactionQueryOptions,
+} from '../query/getTransaction.js'
+
+export {
+  type GetWalletClientData,
+  type GetWalletClientOptions,
+  type GetWalletClientQueryFnData,
+  type GetWalletClientQueryKey,
+  getWalletClientQueryKey,
+  getWalletClientQueryOptions,
+} from '../query/getWalletClient.js'
+
+export {
+  type ReadContractData,
+  type ReadContractOptions,
+  type ReadContractQueryFnData,
+  type ReadContractQueryKey,
+  readContractQueryKey,
+  readContractQueryOptions,
+} from '../query/readContract.js'
+
+export {
+  type ReadContractsData,
+  type ReadContractsOptions,
+  type ReadContractsQueryFnData,
+  type ReadContractsQueryKey,
+  readContractsQueryKey,
+  readContractsQueryOptions,
+} from '../query/readContracts.js'
+
+export {
+  type ReconnectData,
+  type ReconnectVariables,
+  type ReconnectMutate,
+  type ReconnectMutateAsync,
+  reconnectMutationOptions,
+} from '../query/reconnect.js'
+
+export {
+  type SendTransactionData,
+  type SendTransactionVariables,
+  type SendTransactionMutate,
+  type SendTransactionMutateAsync,
+  sendTransactionMutationOptions,
+} from '../query/sendTransaction.js'
+
+export {
+  type SignMessageData,
+  type SignMessageVariables,
+  type SignMessageMutate,
+  type SignMessageMutateAsync,
+  signMessageMutationOptions,
+} from '../query/signMessage.js'
+
+export {
+  type SignTypedDataData,
+  type SignTypedDataVariables,
+  type SignTypedDataMutate,
+  type SignTypedDataMutateAsync,
+  signTypedDataMutationOptions,
+} from '../query/signTypedData.js'
+
+export {
+  type SwitchAccountData,
+  type SwitchAccountVariables,
+  type SwitchAccountMutate,
+  type SwitchAccountMutateAsync,
+  switchAccountMutationOptions,
+} from '../query/switchAccount.js'
+
+export {
+  type SimulateContractData,
+  type SimulateContractOptions,
+  type SimulateContractQueryFnData,
+  type SimulateContractQueryKey,
+  simulateContractQueryKey,
+  simulateContractQueryOptions,
+} from '../query/simulateContract.js'
+
+export {
+  type SwitchChainData,
+  type SwitchChainVariables,
+  type SwitchChainMutate,
+  type SwitchChainMutateAsync,
+  switchChainMutationOptions,
+} from '../query/switchChain.js'
+
+export {
+  type WaitForTransactionReceiptData,
+  type WaitForTransactionReceiptOptions,
+  type WaitForTransactionReceiptQueryFnData,
+  type WaitForTransactionReceiptQueryKey,
+  waitForTransactionReceiptQueryKey,
+  waitForTransactionReceiptQueryOptions,
+} from '../query/waitForTransactionReceipt.js'
+
+export {
+  type WriteContractData,
+  type WriteContractVariables,
+  type WriteContractMutate,
+  type WriteContractMutateAsync,
+  writeContractMutationOptions,
+} from '../query/writeContract.js'
+
+export { hashFn } from '../query/utils.js'

package/src/query/connect.ts

@@ -0,0 +1,45 @@
+import type { MutationOptions } from '@tanstack/query-core'
+
+import {
+  type ConnectError,
+  type ConnectParameters,
+  type ConnectReturnType,
+  connect,
+} from '../actions/connect.js'
+import { type Config } from '../createConfig.js'
+
+import type { Mutate, MutateAsync } from './types.js'
+
+export function connectMutationOptions<config extends Config>(config: config) {
+  return {
+    mutationFn(variables) {
+      return connect(config, variables)
+    },
+    mutationKey: ['connect'],
+  } as const satisfies MutationOptions<
+    ConnectData<config>,
+    ConnectError,
+    ConnectVariables<config>
+  >
+}
+
+export type ConnectData<config extends Config> = ConnectReturnType<config>
+
+export type ConnectVariables<config extends Config> = ConnectParameters<config>
+
+export type ConnectMutate<config extends Config, context = unknown> = Mutate<
+  ConnectData<config>,
+  ConnectError,
+  ConnectVariables<config>,
+  context
+>
+
+export type ConnectMutateAsync<
+  config extends Config,
+  context = unknown,
+> = MutateAsync<
+  ConnectData<config>,
+  ConnectError,
+  ConnectVariables<config>,
+  context
+>

package/src/query/disconnect.ts

@@ -0,0 +1,43 @@
+import type { MutationOptions } from '@tanstack/query-core'
+
+import {
+  type DisconnectError,
+  type DisconnectParameters,
+  type DisconnectReturnType,
+  disconnect,
+} from '../actions/disconnect.js'
+import type { Config } from '../createConfig.js'
+import type { Mutate, MutateAsync } from './types.js'
+
+export function disconnectMutationOptions<config extends Config>(
+  config: config,
+) {
+  return {
+    mutationFn(variables) {
+      return disconnect(config, variables)
+    },
+    mutationKey: ['disconnect'],
+  } as const satisfies MutationOptions<
+    DisconnectData,
+    DisconnectError,
+    DisconnectVariables
+  >
+}
+
+export type DisconnectData = DisconnectReturnType
+
+export type DisconnectVariables = DisconnectParameters | undefined
+
+export type DisconnectMutate<context = unknown> = Mutate<
+  DisconnectData,
+  DisconnectError,
+  DisconnectVariables,
+  context
+>
+
+export type DisconnectMutateAsync<context = unknown> = MutateAsync<
+  DisconnectData,
+  DisconnectError,
+  DisconnectVariables,
+  context
+>

package/src/query/estimateFeesPerGas.ts

@@ -0,0 +1,56 @@
+import { type QueryOptions } from '@tanstack/query-core'
+import type { FeeValuesType } from 'viem'
+
+import {
+  type EstimateFeesPerGasError,
+  type EstimateFeesPerGasParameters,
+  type EstimateFeesPerGasReturnType,
+  estimateFeesPerGas,
+} from '../actions/estimateFeesPerGas.js'
+import type { Config } from '../createConfig.js'
+import type { Evaluate, ExactPartial } from '../types/utils.js'
+import type { ScopeKeyParameter } from './types.js'
+import { filterQueryOptions } from './utils.js'
+
+export type EstimateFeesPerGasOptions<
+  type extends FeeValuesType,
+  config extends Config,
+> = Evaluate<
+  ExactPartial<EstimateFeesPerGasParameters<type, config>> & ScopeKeyParameter
+>
+
+export function estimateFeesPerGasQueryOptions<
+  config extends Config,
+  type extends FeeValuesType = 'eip1559',
+>(config: config, options: EstimateFeesPerGasOptions<type, config> = {}) {
+  return {
+    async queryFn({ queryKey }) {
+      const { scopeKey: _, ...parameters } = queryKey[1]
+      return estimateFeesPerGas(config, parameters)
+    },
+    queryKey: estimateFeesPerGasQueryKey(options),
+  } as const satisfies QueryOptions<
+    EstimateFeesPerGasQueryFnData<type>,
+    EstimateFeesPerGasError,
+    EstimateFeesPerGasData<type>,
+    EstimateFeesPerGasQueryKey<config, type>
+  >
+}
+
+export type EstimateFeesPerGasQueryFnData<type extends FeeValuesType> =
+  EstimateFeesPerGasReturnType<type>
+
+export type EstimateFeesPerGasData<type extends FeeValuesType,> =
+  EstimateFeesPerGasQueryFnData<type>
+
+export function estimateFeesPerGasQueryKey<
+  config extends Config,
+  type extends FeeValuesType = 'eip1559',
+>(options: EstimateFeesPerGasOptions<type, config> = {}) {
+  return ['estimateFeesPerGas', filterQueryOptions(options)] as const
+}
+
+export type EstimateFeesPerGasQueryKey<
+  config extends Config,
+  type extends FeeValuesType,
+> = ReturnType<typeof estimateFeesPerGasQueryKey<config, type>>

package/src/query/estimateGas.ts

@@ -0,0 +1,55 @@
+import { type QueryOptions } from '@tanstack/query-core'
+
+import {
+  type EstimateGasError,
+  type EstimateGasParameters,
+  type EstimateGasReturnType,
+  estimateGas,
+} from '../actions/estimateGas.js'
+import type { Config } from '../createConfig.js'
+import type { UnionPartial } from '../types/utils.js'
+import type { ScopeKeyParameter } from './types.js'
+import { filterQueryOptions } from './utils.js'
+
+export type EstimateGasOptions<
+  config extends Config,
+  chainId extends config['chains'][number]['id'] | undefined,
+> = UnionPartial<EstimateGasParameters<config, chainId>> & ScopeKeyParameter
+
+export function estimateGasQueryOptions<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+>(config: config, options: EstimateGasOptions<config, chainId> = {} as any) {
+  return {
+    async queryFn({ queryKey }) {
+      const { connector } = options
+      const { account, scopeKey: _, ...parameters } = queryKey[1]
+      if (!account && !connector)
+        throw new Error('account or connector is required')
+      return estimateGas(config, { account, connector, ...parameters } as any)
+    },
+    queryKey: estimateGasQueryKey(options),
+  } as const satisfies QueryOptions<
+    EstimateGasQueryFnData,
+    EstimateGasError,
+    EstimateGasData,
+    EstimateGasQueryKey<config, chainId>
+  >
+}
+
+export type EstimateGasQueryFnData = EstimateGasReturnType
+
+export type EstimateGasData = EstimateGasQueryFnData
+
+export function estimateGasQueryKey<
+  config extends Config,
+  chainId extends config['chains'][number]['id'] | undefined,
+>(options: EstimateGasOptions<config, chainId> = {} as any) {
+  const { connector: _, ...rest } = options
+  return ['estimateGas', filterQueryOptions(rest)] as const
+}
+
+export type EstimateGasQueryKey<
+  config extends Config,
+  chainId extends config['chains'][number]['id'] | undefined,
+> = ReturnType<typeof estimateGasQueryKey<config, chainId>>

package/src/query/getBalance.ts

@@ -0,0 +1,61 @@
+import { type QueryOptions } from '@tanstack/query-core'
+
+import {
+  type GetBalanceError,
+  type GetBalanceParameters,
+  type GetBalanceReturnType,
+  getBalance,
+} from '../actions/getBalance.js'
+import type { Config } from '../createConfig.js'
+import type { Evaluate, PartialBy } from '../types/utils.js'
+import type { ScopeKeyParameter } from './types.js'
+import { filterQueryOptions } from './utils.js'
+
+export type GetBalanceOptions<config extends Config> = Evaluate<
+  PartialBy<GetBalanceParameters<config>, 'address'> & ScopeKeyParameter
+>
+
+export function getBalanceQueryOptions<config extends Config>(
+  config: config,
+  options: GetBalanceOptions<config> = {},
+) {
+  return {
+    async queryFn({ queryKey }) {
+      const {
+        address,
+        blockNumber,
+        blockTag,
+        scopeKey: _,
+        ...parameters
+      } = queryKey[1]
+      if (!address) throw new Error('address is required')
+      const balance = await getBalance(
+        config,
+        blockNumber
+          ? { ...parameters, address, blockNumber }
+          : { ...parameters, address, blockTag },
+      )
+      return balance ?? null
+    },
+    queryKey: getBalanceQueryKey(options),
+  } as const satisfies QueryOptions<
+    GetBalanceQueryFnData,
+    GetBalanceError,
+    GetBalanceData,
+    GetBalanceQueryKey<config>
+  >
+}
+
+export type GetBalanceQueryFnData = Evaluate<GetBalanceReturnType>
+
+export type GetBalanceData = GetBalanceQueryFnData
+
+export function getBalanceQueryKey<config extends Config>(
+  options: GetBalanceOptions<config> = {},
+) {
+  return ['balance', filterQueryOptions(options)] as const
+}
+
+export type GetBalanceQueryKey<config extends Config> = ReturnType<
+  typeof getBalanceQueryKey<config>
+>

package/src/query/getBlockNumber.ts

@@ -0,0 +1,50 @@
+import { type QueryOptions } from '@tanstack/query-core'
+
+import {
+  type GetBlockNumberError,
+  type GetBlockNumberParameters,
+  type GetBlockNumberReturnType,
+  getBlockNumber,
+} from '../actions/getBlockNumber.js'
+import type { Config } from '../createConfig.js'
+import type { Evaluate, ExactPartial } from '../types/utils.js'
+import type { ScopeKeyParameter } from './types.js'
+import { filterQueryOptions } from './utils.js'
+
+export type GetBlockNumberOptions<config extends Config> = Evaluate<
+  ExactPartial<GetBlockNumberParameters<config>> & ScopeKeyParameter
+>
+
+export function getBlockNumberQueryOptions<config extends Config>(
+  config: config,
+  options: GetBlockNumberOptions<config> = {},
+) {
+  return {
+    gcTime: 0,
+    async queryFn({ queryKey }) {
+      const { scopeKey: _, ...parameters } = queryKey[1]
+      const blockNumber = await getBlockNumber(config, parameters)
+      return blockNumber ?? null
+    },
+    queryKey: getBlockNumberQueryKey(options),
+  } as const satisfies QueryOptions<
+    GetBlockNumberQueryFnData,
+    GetBlockNumberError,
+    GetBlockNumberData,
+    GetBlockNumberQueryKey<config>
+  >
+}
+
+export type GetBlockNumberQueryFnData = GetBlockNumberReturnType
+
+export type GetBlockNumberData = GetBlockNumberQueryFnData
+
+export function getBlockNumberQueryKey<config extends Config>(
+  options: GetBlockNumberOptions<config> = {},
+) {
+  return ['blockNumber', filterQueryOptions(options)] as const
+}
+
+export type GetBlockNumberQueryKey<config extends Config> = ReturnType<
+  typeof getBlockNumberQueryKey<config>
+>

package/src/query/getConnectorClient.ts

@@ -0,0 +1,68 @@
+import { type QueryOptions } from '@tanstack/query-core'
+
+import {
+  type GetConnectorClientError,
+  type GetConnectorClientParameters,
+  type GetConnectorClientReturnType,
+  getConnectorClient,
+} from '../actions/getConnectorClient.js'
+import type { Config } from '../createConfig.js'
+import type { Evaluate, ExactPartial } from '../types/utils.js'
+import type { ScopeKeyParameter } from './types.js'
+import { filterQueryOptions } from './utils.js'
+
+export type GetConnectorClientOptions<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+> = Evaluate<
+  ExactPartial<GetConnectorClientParameters<config, chainId>> &
+    ScopeKeyParameter
+>
+
+export function getConnectorClientQueryOptions<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+>(config: config, options: GetConnectorClientOptions<config, chainId> = {}) {
+  return {
+    async queryFn({ queryKey }) {
+      const { connector } = options
+      const { connectorUid: _, scopeKey: _s, ...parameters } = queryKey[1]
+      return getConnectorClient(config, {
+        ...parameters,
+        connector,
+      }) as unknown as Promise<GetConnectorClientReturnType<config, chainId>>
+    },
+    queryKey: getConnectorClientQueryKey(options),
+  } as const satisfies QueryOptions<
+    GetConnectorClientQueryFnData<config, chainId>,
+    GetConnectorClientError,
+    GetConnectorClientData<config, chainId>,
+    GetConnectorClientQueryKey<config, chainId>
+  >
+}
+
+export type GetConnectorClientQueryFnData<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+> = GetConnectorClientReturnType<config, chainId>
+
+export type GetConnectorClientData<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+> = GetConnectorClientQueryFnData<config, chainId>
+
+export function getConnectorClientQueryKey<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+>(options: GetConnectorClientOptions<config, chainId> = {}) {
+  const { connector, ...parameters } = options
+  return [
+    'connectorClient',
+    { ...filterQueryOptions(parameters), connectorUid: connector?.uid },
+  ] as const
+}
+
+export type GetConnectorClientQueryKey<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+> = ReturnType<typeof getConnectorClientQueryKey<config, chainId>>

package/src/query/getEnsAddress.ts

@@ -0,0 +1,49 @@
+import { type QueryOptions } from '@tanstack/query-core'
+
+import {
+  type GetEnsAddressError,
+  type GetEnsAddressParameters,
+  type GetEnsAddressReturnType,
+  getEnsAddress,
+} from '../actions/getEnsAddress.js'
+import type { Config } from '../createConfig.js'
+import type { Evaluate, ExactPartial } from '../types/utils.js'
+import type { ScopeKeyParameter } from './types.js'
+import { filterQueryOptions } from './utils.js'
+
+export type GetEnsAddressOptions<config extends Config> = Evaluate<
+  ExactPartial<GetEnsAddressParameters<config>> & ScopeKeyParameter
+>
+
+export function getEnsAddressQueryOptions<config extends Config>(
+  config: config,
+  options: GetEnsAddressOptions<config> = {},
+) {
+  return {
+    async queryFn({ queryKey }) {
+      const { name, scopeKey: _, ...parameters } = queryKey[1]
+      if (!name) throw new Error('name is required')
+      return getEnsAddress(config, { ...parameters, name })
+    },
+    queryKey: getEnsAddressQueryKey(options),
+  } as const satisfies QueryOptions<
+    GetEnsAddressQueryFnData,
+    GetEnsAddressError,
+    GetEnsAddressData,
+    GetEnsAddressQueryKey<config>
+  >
+}
+
+export type GetEnsAddressQueryFnData = GetEnsAddressReturnType
+
+export type GetEnsAddressData = GetEnsAddressQueryFnData
+
+export function getEnsAddressQueryKey<config extends Config>(
+  options: GetEnsAddressOptions<config> = {},
+) {
+  return ['ensAddress', filterQueryOptions(options)] as const
+}
+
+export type GetEnsAddressQueryKey<config extends Config> = ReturnType<
+  typeof getEnsAddressQueryKey<config>
+>

package/src/query/getEnsAvatar.ts

@@ -0,0 +1,49 @@
+import { type QueryOptions } from '@tanstack/query-core'
+
+import {
+  type GetEnsAvatarError,
+  type GetEnsAvatarParameters,
+  type GetEnsAvatarReturnType,
+  getEnsAvatar,
+} from '../actions/getEnsAvatar.js'
+import type { Config } from '../createConfig.js'
+import type { Evaluate, ExactPartial } from '../types/utils.js'
+import type { ScopeKeyParameter } from './types.js'
+import { filterQueryOptions } from './utils.js'
+
+export type GetEnsAvatarOptions<config extends Config> = Evaluate<
+  ExactPartial<GetEnsAvatarParameters<config>> & ScopeKeyParameter
+>
+
+export function getEnsAvatarQueryOptions<config extends Config>(
+  config: config,
+  options: GetEnsAvatarOptions<config> = {},
+) {
+  return {
+    async queryFn({ queryKey }) {
+      const { name, scopeKey: _, ...parameters } = queryKey[1]
+      if (!name) throw new Error('name is required')
+      return getEnsAvatar(config, { ...parameters, name })
+    },
+    queryKey: getEnsAvatarQueryKey(options),
+  } as const satisfies QueryOptions<
+    GetEnsAvatarQueryFnData,
+    GetEnsAvatarError,
+    GetEnsAvatarData,
+    GetEnsAvatarQueryKey<config>
+  >
+}
+
+export type GetEnsAvatarQueryFnData = GetEnsAvatarReturnType
+
+export type GetEnsAvatarData = GetEnsAvatarQueryFnData
+
+export function getEnsAvatarQueryKey<config extends Config>(
+  options: GetEnsAvatarOptions<config> = {},
+) {
+  return ['ensAvatar', filterQueryOptions(options)] as const
+}
+
+export type GetEnsAvatarQueryKey<config extends Config> = ReturnType<
+  typeof getEnsAvatarQueryKey<config>
+>