@wagmi/core 2.0.0 → 2.0.2

package/src/query/signTypedData.ts

@@ -2,13 +2,13 @@ import type { MutateOptions, MutationOptions } from '@tanstack/query-core'
 
 import type { TypedData } from 'viem'
 import {
-  type SignTypedDataError,
+  type SignTypedDataErrorType,
   type SignTypedDataParameters,
   type SignTypedDataReturnType,
   signTypedData,
 } from '../actions/signTypedData.js'
 import { type Config } from '../createConfig.js'
-import type { Evaluate } from '../types/utils.js'
+import { type Evaluate } from '../types/utils.js'
 
 export function signTypedDataMutationOptions<config extends Config>(
   config: config,
@@ -20,7 +20,7 @@ export function signTypedDataMutationOptions<config extends Config>(
     mutationKey: ['signTypedData'],
   } as const satisfies MutationOptions<
     SignTypedDataData,
-    SignTypedDataError,
+    SignTypedDataErrorType,
     SignTypedDataVariables
   >
 }
@@ -30,7 +30,9 @@ export type SignTypedDataData = Evaluate<SignTypedDataReturnType>
 export type SignTypedDataVariables<
   typedData extends TypedData | Record<string, unknown> = TypedData,
   primaryType extends keyof typedData | 'EIP712Domain' = keyof typedData,
-> = SignTypedDataParameters<typedData, primaryType>
+  ///
+  primaryTypes = typedData extends TypedData ? keyof typedData : string,
+> = SignTypedDataParameters<typedData, primaryType, primaryTypes>
 
 export type SignTypedDataMutate<context = unknown> = <
   const typedData extends TypedData | Record<string, unknown>,
@@ -40,8 +42,13 @@ export type SignTypedDataMutate<context = unknown> = <
   options?:
     | MutateOptions<
         SignTypedDataData,
-        SignTypedDataError,
-        SignTypedDataVariables<typedData, primaryType>,
+        SignTypedDataErrorType,
+        SignTypedDataVariables<
+          typedData,
+          primaryType,
+          // use `primaryType` to make sure it's not union of all possible primary types
+          primaryType
+        >,
         context
       >
     | undefined,
@@ -55,8 +62,13 @@ export type SignTypedDataMutateAsync<context = unknown> = <
   options?:
     | MutateOptions<
         SignTypedDataData,
-        SignTypedDataError,
-        SignTypedDataVariables<typedData, primaryType>,
+        SignTypedDataErrorType,
+        SignTypedDataVariables<
+          typedData,
+          primaryType,
+          // use `primaryType` to make sure it's not union of all possible primary types
+          primaryType
+        >,
         context
       >
     | undefined,

package/src/query/simulateContract.ts

@@ -2,14 +2,14 @@ import { type QueryOptions } from '@tanstack/query-core'
 import type { Abi, ContractFunctionArgs, ContractFunctionName } from 'viem'
 
 import {
-  type SimulateContractError,
+  type SimulateContractErrorType,
   type SimulateContractParameters,
   type SimulateContractReturnType,
   simulateContract,
 } from '../actions/simulateContract.js'
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
+import type { ScopeKeyParameter } from '../types/properties.js'
 import type { UnionPartial } from '../types/utils.js'
-import type { ScopeKeyParameter } from './types.js'
 import { filterQueryOptions } from './utils.js'
 
 export type SimulateContractOptions<
@@ -28,6 +28,7 @@ export type SimulateContractOptions<
   ScopeKeyParameter
 
 export function simulateContractQueryOptions<
+  config extends Config,
   const abi extends Abi | readonly unknown[],
   functionName extends ContractFunctionName<abi, 'nonpayable' | 'payable'>,
   args extends ContractFunctionArgs<
@@ -35,7 +36,6 @@ export function simulateContractQueryOptions<
     'nonpayable' | 'payable',
     functionName
   >,
-  config extends Config,
   chainId extends config['chains'][number]['id'] | undefined,
 >(
   config: config,
@@ -55,12 +55,16 @@ export function simulateContractQueryOptions<
       const { address, functionName } = parameters
       if (!address) throw new Error('address is required')
       if (!functionName) throw new Error('functionName is required')
-      return simulateContract(config, { abi, connector, ...parameters } as any)
+      return simulateContract(config, {
+        abi,
+        connector,
+        ...(parameters as any),
+      })
     },
     queryKey: simulateContractQueryKey(options),
   } as const satisfies QueryOptions<
     SimulateContractQueryFnData<abi, functionName, args, config, chainId>,
-    SimulateContractError,
+    SimulateContractErrorType,
     SimulateContractData<abi, functionName, args, config, chainId>,
     SimulateContractQueryKey<abi, functionName, args, config, chainId>
   >
@@ -91,6 +95,7 @@ export type SimulateContractData<
 > = SimulateContractQueryFnData<abi, functionName, args, config, chainId>
 
 export function simulateContractQueryKey<
+  config extends Config,
   abi extends Abi | readonly unknown[],
   functionName extends ContractFunctionName<abi, 'nonpayable' | 'payable'>,
   args extends ContractFunctionArgs<
@@ -98,7 +103,6 @@ export function simulateContractQueryKey<
     'nonpayable' | 'payable',
     functionName
   >,
-  config extends Config,
   chainId extends config['chains'][number]['id'] | undefined,
 >(
   options: SimulateContractOptions<
@@ -124,5 +128,5 @@ export type SimulateContractQueryKey<
   config extends Config,
   chainId extends config['chains'][number]['id'] | undefined,
 > = ReturnType<
-  typeof simulateContractQueryKey<abi, functionName, args, config, chainId>
+  typeof simulateContractQueryKey<config, abi, functionName, args, chainId>
 >

package/src/query/switchAccount.ts

@@ -1,14 +1,14 @@
-import type { MutationOptions } from '@tanstack/query-core'
+import { type MutationOptions } from '@tanstack/query-core'
 
 import {
-  type SwitchAccountError,
+  type SwitchAccountErrorType,
   type SwitchAccountParameters,
   type SwitchAccountReturnType,
   switchAccount,
 } from '../actions/switchAccount.js'
 import { type Config } from '../createConfig.js'
-import type { Evaluate } from '../types/utils.js'
-import type { Mutate, MutateAsync } from './types.js'
+import { type Evaluate } from '../types/utils.js'
+import { type Mutate, type MutateAsync } from './types.js'
 
 export function switchAccountMutationOptions<config extends Config>(
   config: config,
@@ -20,7 +20,7 @@ export function switchAccountMutationOptions<config extends Config>(
     mutationKey: ['switchAccount'],
   } as const satisfies MutationOptions<
     SwitchAccountData<config>,
-    SwitchAccountError,
+    SwitchAccountErrorType,
     SwitchAccountVariables
   >
 }
@@ -36,7 +36,7 @@ export type SwitchAccountMutate<
   context = unknown,
 > = Mutate<
   SwitchAccountData<config>,
-  SwitchAccountError,
+  SwitchAccountErrorType,
   SwitchAccountVariables,
   context
 >
@@ -46,7 +46,7 @@ export type SwitchAccountMutateAsync<
   context = unknown,
 > = MutateAsync<
   SwitchAccountData<config>,
-  SwitchAccountError,
+  SwitchAccountErrorType,
   SwitchAccountVariables,
   context
 >

package/src/query/switchChain.ts

@@ -1,13 +1,13 @@
-import type { MutateOptions, MutationOptions } from '@tanstack/query-core'
+import { type MutateOptions, type MutationOptions } from '@tanstack/query-core'
 
 import {
-  type SwitchChainError,
+  type SwitchChainErrorType,
   type SwitchChainParameters,
   type SwitchChainReturnType,
   switchChain,
 } from '../actions/switchChain.js'
 import { type Config } from '../createConfig.js'
-import type { Evaluate } from '../types/utils.js'
+import { type Evaluate } from '../types/utils.js'
 
 export function switchChainMutationOptions<config extends Config>(
   config: config,
@@ -19,7 +19,7 @@ export function switchChainMutationOptions<config extends Config>(
     mutationKey: ['switchChain'],
   } as const satisfies MutationOptions<
     SwitchChainData<config, config['chains'][number]['id']>,
-    SwitchChainError,
+    SwitchChainErrorType,
     SwitchChainVariables<config, config['chains'][number]['id']>
   >
 }
@@ -42,7 +42,7 @@ export type SwitchChainMutate<config extends Config, context = unknown> = <
     | Evaluate<
         MutateOptions<
           SwitchChainData<config, chainId>,
-          SwitchChainError,
+          SwitchChainErrorType,
           Evaluate<SwitchChainVariables<config, chainId>>,
           context
         >
@@ -58,7 +58,7 @@ export type SwitchChainMutateAsync<config extends Config, context = unknown> = <
     | Evaluate<
         MutateOptions<
           SwitchChainData<config, chainId>,
-          SwitchChainError,
+          SwitchChainErrorType,
           Evaluate<SwitchChainVariables<config, chainId>>,
           context
         >

package/src/query/types.ts

@@ -1,39 +1,49 @@
-import type { Evaluate } from '../types/utils.js'
+import {
+  type DefaultError,
+  type InfiniteQueryObserverOptions,
+  type MutateOptions,
+  type QueryKey,
+  type QueryMeta,
+} from '@tanstack/query-core'
 
-export type ScopeKeyParameter = { scopeKey?: string | undefined }
+import { type Evaluate, type Omit } from '../types/utils.js'
 
-type MutateFn<
-  data = unknown,
-  error = unknown,
-  variables = void,
-  context = unknown,
-> = undefined extends variables
-  ? (
-      variables?: variables,
-      options?:
-        | Evaluate<
-            import('@tanstack/query-core').MutateOptions<
-              data,
-              error,
-              variables,
-              context
-            >
-          >
-        | undefined,
-    ) => Promise<data>
-  : (
-      variables: variables,
-      options?:
-        | Evaluate<
-            import('@tanstack/query-core').MutateOptions<
-              data,
-              error,
-              variables,
-              context
-            >
-          >
-        | undefined,
-    ) => Promise<data>
+export type InfiniteQueryOptions<
+  queryFnData = unknown,
+  error = DefaultError,
+  data = queryFnData,
+  queryData = queryFnData,
+  queryKey extends QueryKey = QueryKey,
+  pageParam = unknown,
+  ///
+  options extends InfiniteQueryObserverOptions<
+    queryFnData,
+    error,
+    data,
+    queryData,
+    queryKey,
+    pageParam
+  > = InfiniteQueryObserverOptions<
+    queryFnData,
+    error,
+    data,
+    queryData,
+    queryKey,
+    pageParam
+  >,
+> = Evaluate<
+  // `queryFn` doesn't pass through `pageParam` correctly
+  Omit<options, 'queryFn'> & {
+    // TS2742: `QueryFunctionContext` not exported from `@tanstack/query-core`
+    queryFn?(context: {
+      queryKey: queryKey
+      signal: AbortSignal
+      pageParam: pageParam
+      direction: 'forward' | 'backward'
+      meta: QueryMeta | undefined
+    }): ReturnType<NonNullable<options['queryFn']>>
+  }
+>
 
 export type Mutate<
   data = unknown,
@@ -50,3 +60,22 @@ export type MutateAsync<
   variables = void,
   context = unknown,
 > = MutateFn<data, error, Evaluate<variables>, context>
+
+type MutateFn<
+  data = unknown,
+  error = unknown,
+  variables = void,
+  context = unknown,
+> = undefined extends variables
+  ? (
+      variables?: variables,
+      options?:
+        | Evaluate<MutateOptions<data, error, variables, context>>
+        | undefined,
+    ) => Promise<data>
+  : (
+      variables: variables,
+      options?:
+        | Evaluate<MutateOptions<data, error, variables, context>>
+        | undefined,
+    ) => Promise<data>

package/src/query/utils.ts

@@ -1,4 +1,4 @@
-import type { QueryKey } from '@tanstack/query-core'
+import { type QueryKey } from '@tanstack/query-core'
 
 export function hashFn(queryKey: QueryKey): string {
   return JSON.stringify(queryKey, (_, value) => {
@@ -45,6 +45,21 @@ export function filterQueryOptions<type extends Record<string, unknown>>(
   // destructuring is super fast
   // biome-ignore format: no formatting
   const {
+    // import('@tanstack/query-core').QueryOptions
+    // biome-ignore lint/correctness/noUnusedVariables: remove properties
+    _defaulted, behavior, gcTime, initialData, initialDataUpdatedAt, maxPages, meta, networkMode, queryFn, queryHash, queryKey, queryKeyHashFn, retry, retryDelay, structuralSharing,
+
+    // import('@tanstack/query-core').InfiniteQueryObserverOptions
+    // biome-ignore lint/correctness/noUnusedVariables: remove properties
+    getPreviousPageParam, getNextPageParam, initialPageParam,
+    
+    // import('@tanstack/react-query').UseQueryOptions
+    // biome-ignore lint/correctness/noUnusedVariables: remove properties
+    _optimisticResults, enabled, notifyOnChangeProps, placeholderData, refetchInterval, refetchIntervalInBackground, refetchOnMount, refetchOnReconnect, refetchOnWindowFocus, retryOnMount, select, staleTime, suspense, throwOnError,
+
+    ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+    // wagmi
+    ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
     // biome-ignore lint/correctness/noUnusedVariables: remove properties
     config, connector, query,
     ...rest

package/src/query/verifyMessage.ts

@@ -0,0 +1,54 @@
+import { type QueryOptions } from '@tanstack/query-core'
+
+import {
+  type VerifyMessageErrorType,
+  type VerifyMessageParameters,
+  type VerifyMessageReturnType,
+  verifyMessage,
+} from '../actions/verifyMessage.js'
+import { type Config } from '../createConfig.js'
+import type { ScopeKeyParameter } from '../types/properties.js'
+import type { Evaluate, ExactPartial } from '../types/utils.js'
+import { filterQueryOptions } from './utils.js'
+
+export type VerifyMessageOptions<config extends Config> = Evaluate<
+  ExactPartial<VerifyMessageParameters<config>> & ScopeKeyParameter
+>
+
+export function verifyMessageQueryOptions<config extends Config>(
+  config: config,
+  options: VerifyMessageOptions<config> = {},
+) {
+  return {
+    async queryFn({ queryKey }) {
+      const { address, message, signature } = queryKey[1]
+      if (!address || !message || !signature)
+        throw new Error('address, message, and signature are required')
+
+      const { scopeKey: _, ...parameters } = queryKey[1]
+
+      const verified = await verifyMessage(
+        config,
+        parameters as VerifyMessageParameters,
+      )
+      return verified ?? null
+    },
+    queryKey: verifyMessageQueryKey(options),
+  } as const satisfies QueryOptions<
+    VerifyMessageQueryFnData,
+    VerifyMessageErrorType,
+    VerifyMessageData,
+    VerifyMessageQueryKey
+  >
+}
+export type VerifyMessageQueryFnData = VerifyMessageReturnType
+
+export type VerifyMessageData = VerifyMessageQueryFnData
+
+export function verifyMessageQueryKey<config extends Config>(
+  options: VerifyMessageOptions<config>,
+) {
+  return ['verifyMessage', filterQueryOptions(options)] as const
+}
+
+export type VerifyMessageQueryKey = ReturnType<typeof verifyMessageQueryKey>

package/src/query/verifyTypedData.ts

@@ -0,0 +1,81 @@
+import { type QueryOptions } from '@tanstack/query-core'
+import { type TypedData } from 'viem'
+
+import {
+  type VerifyTypedDataErrorType,
+  type VerifyTypedDataParameters,
+  type VerifyTypedDataReturnType,
+  verifyTypedData,
+} from '../actions/verifyTypedData.js'
+import { type Config } from '../createConfig.js'
+import { type ScopeKeyParameter } from '../types/properties.js'
+import { type ExactPartial } from '../types/utils.js'
+import { filterQueryOptions } from './utils.js'
+
+export type VerifyTypedDataOptions<
+  typedData extends TypedData | Record<string, unknown>,
+  primaryType extends keyof typedData | 'EIP712Domain',
+  config extends Config,
+> = ExactPartial<VerifyTypedDataParameters<typedData, primaryType, config>> &
+  ScopeKeyParameter
+
+export function verifyTypedDataQueryOptions<
+  config extends Config,
+  const typedData extends TypedData | Record<string, unknown>,
+  primaryType extends keyof typedData | 'EIP712Domain',
+>(
+  config: config,
+  options: VerifyTypedDataOptions<typedData, primaryType, config> = {} as any,
+) {
+  return {
+    async queryFn({ queryKey }) {
+      const {
+        address,
+        message,
+        primaryType,
+        signature,
+        types,
+        scopeKey: _,
+        ...parameters
+      } = queryKey[1]
+      if (!address) throw new Error('address is required')
+      if (!message) throw new Error('message is required')
+      if (!primaryType) throw new Error('primaryType is required')
+      if (!signature) throw new Error('signature is required')
+      if (!types) throw new Error('types is required')
+
+      const verified = await verifyTypedData(config, {
+        address,
+        message,
+        primaryType,
+        signature,
+        types,
+        ...parameters,
+      })
+      return verified ?? null
+    },
+    queryKey: verifyTypedDataQueryKey(options),
+  } as const satisfies QueryOptions<
+    VerifyTypedDataQueryFnData,
+    VerifyTypedDataErrorType,
+    VerifyTypedDataData,
+    VerifyTypedDataQueryKey<typedData, primaryType, config>
+  >
+}
+export type VerifyTypedDataQueryFnData = VerifyTypedDataReturnType
+
+export type VerifyTypedDataData = VerifyTypedDataQueryFnData
+
+export function verifyTypedDataQueryKey<
+  config extends Config,
+  const typedData extends TypedData | Record<string, unknown>,
+  primaryType extends keyof typedData | 'EIP712Domain',
+>(options: VerifyTypedDataOptions<typedData, primaryType, config>) {
+  return ['verifyTypedData', filterQueryOptions(options)] as const
+}
+
+export type VerifyTypedDataQueryKey<
+  typedData extends TypedData | Record<string, unknown>,
+  primaryType extends keyof typedData | 'EIP712Domain',
+  config extends Config,
+> = ReturnType<typeof verifyTypedDataQueryKey<config, typedData, primaryType>>

package/src/query/waitForTransactionReceipt.ts

@@ -1,14 +1,14 @@
 import { type QueryOptions } from '@tanstack/query-core'
 
 import {
-  type WaitForTransactionReceiptError,
+  type WaitForTransactionReceiptErrorType,
   type WaitForTransactionReceiptParameters,
   type WaitForTransactionReceiptReturnType,
   waitForTransactionReceipt,
 } from '../actions/waitForTransactionReceipt.js'
-import type { Config } from '../createConfig.js'
-import type { Evaluate, ExactPartial } from '../types/utils.js'
-import type { ScopeKeyParameter } from './types.js'
+import { type Config } from '../createConfig.js'
+import { type ScopeKeyParameter } from '../types/properties.js'
+import { type Evaluate, type ExactPartial } from '../types/utils.js'
 import { filterQueryOptions } from './utils.js'
 
 export type WaitForTransactionReceiptOptions<
@@ -23,7 +23,7 @@ export function waitForTransactionReceiptQueryOptions<
   config extends Config,
   chainId extends config['chains'][number]['id'],
 >(
-  config: Config,
+  config: config,
   options: WaitForTransactionReceiptOptions<config, chainId> = {},
 ) {
   return {
@@ -41,7 +41,7 @@ export function waitForTransactionReceiptQueryOptions<
     queryKey: waitForTransactionReceiptQueryKey(options),
   } as const satisfies QueryOptions<
     WaitForTransactionReceiptQueryFnData<config, chainId>,
-    WaitForTransactionReceiptError,
+    WaitForTransactionReceiptErrorType,
     WaitForTransactionReceiptData<config, chainId>,
     WaitForTransactionReceiptQueryKey<config, chainId>
   >

package/src/query/writeContract.ts

@@ -1,14 +1,18 @@
-import type { MutateOptions, MutationOptions } from '@tanstack/query-core'
-import type { Abi, ContractFunctionArgs, ContractFunctionName } from 'viem'
+import { type MutateOptions, type MutationOptions } from '@tanstack/query-core'
+import {
+  type Abi,
+  type ContractFunctionArgs,
+  type ContractFunctionName,
+} from 'viem'
 
 import {
-  type WriteContractError,
+  type WriteContractErrorType,
   type WriteContractParameters,
   type WriteContractReturnType,
   writeContract,
 } from '../actions/writeContract.js'
 import { type Config } from '../createConfig.js'
-import type { Evaluate } from '../types/utils.js'
+import { type Evaluate } from '../types/utils.js'
 
 export function writeContractMutationOptions<config extends Config>(
   config: config,
@@ -20,7 +24,7 @@ export function writeContractMutationOptions<config extends Config>(
     mutationKey: ['writeContract'],
   } as const satisfies MutationOptions<
     WriteContractData,
-    WriteContractError,
+    WriteContractErrorType,
     WriteContractVariables<
       Abi,
       string,
@@ -43,7 +47,16 @@ export type WriteContractVariables<
   >,
   config extends Config,
   chainId extends config['chains'][number]['id'],
-> = WriteContractParameters<abi, functionName, args, config, chainId>
+  ///
+  allFunctionNames = ContractFunctionName<abi, 'nonpayable' | 'payable'>,
+> = WriteContractParameters<
+  abi,
+  functionName,
+  args,
+  config,
+  chainId,
+  allFunctionNames
+>
 
 export type WriteContractMutate<config extends Config, context = unknown> = <
   const abi extends Abi | readonly unknown[],
@@ -59,8 +72,16 @@ export type WriteContractMutate<config extends Config, context = unknown> = <
   options?:
     | MutateOptions<
         WriteContractData,
-        WriteContractError,
-        WriteContractVariables<abi, functionName, args, config, chainId>,
+        WriteContractErrorType,
+        WriteContractVariables<
+          abi,
+          functionName,
+          args,
+          config,
+          chainId,
+          // use `functionName` to make sure it's not union of all possible function names
+          functionName
+        >,
         context
       >
     | undefined,
@@ -83,8 +104,16 @@ export type WriteContractMutateAsync<
   options?:
     | MutateOptions<
         WriteContractData,
-        WriteContractError,
-        WriteContractVariables<abi, functionName, args, config, chainId>,
+        WriteContractErrorType,
+        WriteContractVariables<
+          abi,
+          functionName,
+          args,
+          config,
+          chainId,
+          // use `functionName` to make sure it's not union of all possible function names
+          functionName
+        >,
         context
       >
     | undefined,