@wagmi/core 3.2.0 → 3.2.2

package/src/query/getEnsText.ts

@@ -1,5 +1,3 @@
-import type { QueryOptions } from '@tanstack/query-core'
-
 import {
   type GetEnsTextErrorType,
   type GetEnsTextParameters,
@@ -8,30 +6,45 @@ import {
 } from '../actions/getEnsText.js'
 import type { Config } from '../createConfig.js'
 import type { ScopeKeyParameter } from '../types/properties.js'
+import type { QueryOptions, QueryParameter } from '../types/query.js'
 import type { Compute, ExactPartial } from '../types/utils.js'
 import { filterQueryOptions } from './utils.js'
 
-export type GetEnsTextOptions<config extends Config> = Compute<
-  ExactPartial<GetEnsTextParameters<config>> & ScopeKeyParameter
->
+export type GetEnsTextOptions<
+  config extends Config,
+  selectData = GetEnsTextData,
+> = Compute<ExactPartial<GetEnsTextParameters<config>> & ScopeKeyParameter> &
+  QueryParameter<
+    GetEnsTextQueryFnData,
+    GetEnsTextErrorType,
+    selectData,
+    GetEnsTextQueryKey<config>
+  >
 
-export function getEnsTextQueryOptions<config extends Config>(
+export function getEnsTextQueryOptions<
+  config extends Config,
+  selectData = GetEnsTextData,
+>(
   config: config,
-  options: GetEnsTextOptions<config> = {},
-) {
+  options: GetEnsTextOptions<config, selectData> = {},
+): GetEnsTextQueryOptions<config, selectData> {
   return {
-    async queryFn({ queryKey }) {
-      const { key, name, scopeKey: _, ...parameters } = queryKey[1]
-      if (!key || !name) throw new Error('key and name are required')
-      return getEnsText(config, { ...parameters, key, name })
+    ...options.query,
+    enabled: Boolean(
+      options.key && options.name && (options.query?.enabled ?? true),
+    ),
+    queryFn: async (context) => {
+      const [, { scopeKey: _, ...parameters }] = context.queryKey
+      if (!parameters.key || !parameters.name)
+        throw new Error('key and name are required')
+      return getEnsText(config, {
+        ...parameters,
+        key: parameters.key,
+        name: parameters.name,
+      })
     },
     queryKey: getEnsTextQueryKey(options),
-  } as const satisfies QueryOptions<
-    GetEnsTextQueryFnData,
-    GetEnsTextErrorType,
-    GetEnsTextData,
-    GetEnsTextQueryKey<config>
-  >
+  }
 }
 
 export type GetEnsTextQueryFnData = GetEnsTextReturnType
@@ -39,7 +52,9 @@ export type GetEnsTextQueryFnData = GetEnsTextReturnType
 export type GetEnsTextData = GetEnsTextQueryFnData
 
 export function getEnsTextQueryKey<config extends Config>(
-  options: GetEnsTextOptions<config> = {},
+  options: Compute<
+    ExactPartial<GetEnsTextParameters<config>> & ScopeKeyParameter
+  > = {},
 ) {
   return ['ensText', filterQueryOptions(options)] as const
 }
@@ -47,3 +62,13 @@ export function getEnsTextQueryKey<config extends Config>(
 export type GetEnsTextQueryKey<config extends Config> = ReturnType<
   typeof getEnsTextQueryKey<config>
 >
+
+export type GetEnsTextQueryOptions<
+  config extends Config,
+  selectData = GetEnsTextData,
+> = QueryOptions<
+  GetEnsTextQueryFnData,
+  GetEnsTextErrorType,
+  selectData,
+  GetEnsTextQueryKey<config>
+>

package/src/query/getFeeHistory.ts

@@ -1,5 +1,3 @@
-import type { QueryOptions } from '@tanstack/query-core'
-
 import {
   type GetFeeHistoryErrorType,
   type GetFeeHistoryParameters,
@@ -8,48 +6,53 @@ import {
 } from '../actions/getFeeHistory.js'
 import type { Config } from '../createConfig.js'
 import type { ScopeKeyParameter } from '../types/properties.js'
-import type { Compute, PartialBy } from '../types/utils.js'
+import type { QueryOptions, QueryParameter } from '../types/query.js'
+import type { Compute, ExactPartial } from '../types/utils.js'
 import { filterQueryOptions } from './utils.js'
 
 export type GetFeeHistoryOptions<
   config extends Config,
   chainId extends config['chains'][number]['id'],
+  selectData = GetFeeHistoryData,
 > = Compute<
-  PartialBy<
-    GetFeeHistoryParameters<config, chainId>,
-    'blockCount' | 'rewardPercentiles'
-  > &
-    ScopeKeyParameter
->
+  ExactPartial<GetFeeHistoryParameters<config, chainId>> & ScopeKeyParameter
+> &
+  QueryParameter<
+    GetFeeHistoryQueryFnData,
+    GetFeeHistoryErrorType,
+    selectData,
+    GetFeeHistoryQueryKey<config, chainId>
+  >
 
 export function getFeeHistoryQueryOptions<
   config extends Config,
   chainId extends config['chains'][number]['id'],
->(config: config, options: GetFeeHistoryOptions<config, chainId> = {}) {
+  selectData = GetFeeHistoryData,
+>(
+  config: config,
+  options: GetFeeHistoryOptions<config, chainId, selectData> = {},
+): GetFeeHistoryQueryOptions<config, chainId, selectData> {
   return {
-    async queryFn({ queryKey }) {
-      const {
-        blockCount,
-        rewardPercentiles,
-        scopeKey: _,
-        ...parameters
-      } = queryKey[1]
-      if (!blockCount) throw new Error('blockCount is required')
-      if (!rewardPercentiles) throw new Error('rewardPercentiles is required')
+    ...options.query,
+    enabled: Boolean(
+      options.blockCount &&
+        options.rewardPercentiles &&
+        (options.query?.enabled ?? true),
+    ),
+    queryFn: async (context) => {
+      const [, { scopeKey: _, ...parameters }] = context.queryKey
+      if (!parameters.blockCount) throw new Error('blockCount is required')
+      if (!parameters.rewardPercentiles)
+        throw new Error('rewardPercentiles is required')
       const feeHistory = await getFeeHistory(config, {
         ...(parameters as GetFeeHistoryParameters),
-        blockCount,
-        rewardPercentiles,
+        blockCount: parameters.blockCount,
+        rewardPercentiles: parameters.rewardPercentiles,
       })
       return feeHistory ?? null
     },
     queryKey: getFeeHistoryQueryKey(options),
-  } as const satisfies QueryOptions<
-    GetFeeHistoryQueryFnData,
-    GetFeeHistoryErrorType,
-    GetFeeHistoryData,
-    GetFeeHistoryQueryKey<config, chainId>
-  >
+  }
 }
 
 export type GetFeeHistoryQueryFnData = GetFeeHistoryReturnType
@@ -59,7 +62,11 @@ export type GetFeeHistoryData = GetFeeHistoryQueryFnData
 export function getFeeHistoryQueryKey<
   config extends Config,
   chainId extends config['chains'][number]['id'],
->(options: GetFeeHistoryOptions<config, chainId> = {}) {
+>(
+  options: Compute<
+    ExactPartial<GetFeeHistoryParameters<config, chainId>> & ScopeKeyParameter
+  > = {},
+) {
   return ['feeHistory', filterQueryOptions(options)] as const
 }
 
@@ -67,3 +74,14 @@ export type GetFeeHistoryQueryKey<
   config extends Config,
   chainId extends config['chains'][number]['id'],
 > = ReturnType<typeof getFeeHistoryQueryKey<config, chainId>>
+
+export type GetFeeHistoryQueryOptions<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+  selectData = GetFeeHistoryData,
+> = QueryOptions<
+  GetFeeHistoryQueryFnData,
+  GetFeeHistoryErrorType,
+  selectData,
+  GetFeeHistoryQueryKey<config, chainId>
+>

package/src/query/getGasPrice.ts

@@ -1,5 +1,3 @@
-import type { QueryOptions } from '@tanstack/query-core'
-
 import {
   type GetGasPriceErrorType,
   type GetGasPriceParameters,
@@ -8,33 +6,41 @@ import {
 } from '../actions/getGasPrice.js'
 import type { Config } from '../createConfig.js'
 import type { ScopeKeyParameter } from '../types/properties.js'
+import type { QueryOptions, QueryParameter } from '../types/query.js'
 import type { Compute, ExactPartial } from '../types/utils.js'
 import { filterQueryOptions } from './utils.js'
 
 export type GetGasPriceOptions<
   config extends Config,
   chainId extends config['chains'][number]['id'],
+  selectData = GetGasPriceData,
 > = Compute<
   ExactPartial<GetGasPriceParameters<config, chainId>> & ScopeKeyParameter
->
+> &
+  QueryParameter<
+    GetGasPriceQueryFnData,
+    GetGasPriceErrorType,
+    selectData,
+    GetGasPriceQueryKey<config, chainId>
+  >
 
 export function getGasPriceQueryOptions<
   config extends Config,
   chainId extends config['chains'][number]['id'],
->(config: config, options: GetGasPriceOptions<config, chainId> = {}) {
+  selectData = GetGasPriceData,
+>(
+  config: config,
+  options: GetGasPriceOptions<config, chainId, selectData> = {},
+): GetGasPriceQueryOptions<config, chainId, selectData> {
   return {
-    async queryFn({ queryKey }) {
-      const { scopeKey: _, ...parameters } = queryKey[1]
+    ...options.query,
+    queryFn: async (context) => {
+      const [, { scopeKey: _, ...parameters }] = context.queryKey
       const gasPrice = await getGasPrice(config, parameters)
       return gasPrice ?? null
     },
     queryKey: getGasPriceQueryKey(options),
-  } as const satisfies QueryOptions<
-    GetGasPriceQueryFnData,
-    GetGasPriceErrorType,
-    GetGasPriceData,
-    GetGasPriceQueryKey<config, chainId>
-  >
+  }
 }
 
 export type GetGasPriceQueryFnData = GetGasPriceReturnType
@@ -44,7 +50,11 @@ export type GetGasPriceData = GetGasPriceQueryFnData
 export function getGasPriceQueryKey<
   config extends Config,
   chainId extends config['chains'][number]['id'],
->(options: GetGasPriceOptions<config, chainId> = {}) {
+>(
+  options: Compute<
+    ExactPartial<GetGasPriceParameters<config, chainId>> & ScopeKeyParameter
+  > = {},
+) {
   return ['gasPrice', filterQueryOptions(options)] as const
 }
 
@@ -52,3 +62,14 @@ export type GetGasPriceQueryKey<
   config extends Config,
   chainId extends config['chains'][number]['id'],
 > = ReturnType<typeof getGasPriceQueryKey<config, chainId>>
+
+export type GetGasPriceQueryOptions<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+  selectData = GetGasPriceData,
+> = QueryOptions<
+  GetGasPriceQueryFnData,
+  GetGasPriceErrorType,
+  selectData,
+  GetGasPriceQueryKey<config, chainId>
+>

package/src/query/getProof.ts

@@ -1,5 +1,3 @@
-import type { QueryOptions } from '@tanstack/query-core'
-
 import {
   type GetProofErrorType,
   type GetProofParameters,
@@ -8,31 +6,47 @@ import {
 } from '../actions/getProof.js'
 import type { Config } from '../createConfig.js'
 import type { ScopeKeyParameter } from '../types/properties.js'
+import type { QueryOptions, QueryParameter } from '../types/query.js'
 import type { Compute, ExactPartial } from '../types/utils.js'
 import { filterQueryOptions } from './utils.js'
 
-export type GetProofOptions<config extends Config> = Compute<
-  ExactPartial<GetProofParameters<config>> & ScopeKeyParameter
->
+export type GetProofOptions<
+  config extends Config,
+  selectData = GetProofData,
+> = Compute<ExactPartial<GetProofParameters<config>> & ScopeKeyParameter> &
+  QueryParameter<
+    GetProofQueryFnData,
+    GetProofErrorType,
+    selectData,
+    GetProofQueryKey<config>
+  >
 
-export function getProofQueryOptions<config extends Config>(
+export function getProofQueryOptions<
+  config extends Config,
+  selectData = GetProofData,
+>(
   config: config,
-  options: GetProofOptions<config> = {},
-) {
+  options: GetProofOptions<config, selectData> = {},
+): GetProofQueryOptions<config, selectData> {
   return {
-    async queryFn({ queryKey }) {
-      const { address, scopeKey: _, storageKeys, ...parameters } = queryKey[1]
-      if (!address || !storageKeys)
+    ...options.query,
+    enabled: Boolean(
+      options.address &&
+        options.storageKeys &&
+        (options.query?.enabled ?? true),
+    ),
+    queryFn: async (context) => {
+      const [, { scopeKey: _, ...parameters }] = context.queryKey
+      if (!parameters.address || !parameters.storageKeys)
         throw new Error('address and storageKeys are required')
-      return getProof(config, { ...parameters, address, storageKeys })
+      return getProof(config, {
+        ...(parameters as GetProofParameters),
+        address: parameters.address,
+        storageKeys: parameters.storageKeys,
+      })
     },
     queryKey: getProofQueryKey(options),
-  } as const satisfies QueryOptions<
-    GetProofQueryFnData,
-    GetProofErrorType,
-    GetProofData,
-    GetProofQueryKey<config>
-  >
+  }
 }
 
 export type GetProofQueryFnData = GetProofReturnType
@@ -40,7 +54,9 @@ export type GetProofQueryFnData = GetProofReturnType
 export type GetProofData = GetProofQueryFnData
 
 export function getProofQueryKey<config extends Config>(
-  options: GetProofOptions<config>,
+  options: Compute<
+    ExactPartial<GetProofParameters<config>> & ScopeKeyParameter
+  > = {},
 ) {
   return ['getProof', filterQueryOptions(options)] as const
 }
@@ -48,3 +64,13 @@ export function getProofQueryKey<config extends Config>(
 export type GetProofQueryKey<config extends Config> = ReturnType<
   typeof getProofQueryKey<config>
 >
+
+export type GetProofQueryOptions<
+  config extends Config,
+  selectData = GetProofData,
+> = QueryOptions<
+  GetProofQueryFnData,
+  GetProofErrorType,
+  selectData,
+  GetProofQueryKey<config>
+>

package/src/query/getStorageAt.ts

@@ -1,5 +1,3 @@
-import type { QueryOptions } from '@tanstack/query-core'
-
 import {
   type GetStorageAtErrorType,
   type GetStorageAtParameters,
@@ -8,30 +6,45 @@ import {
 } from '../actions/getStorageAt.js'
 import type { Config } from '../createConfig.js'
 import type { ScopeKeyParameter } from '../types/properties.js'
+import type { QueryOptions, QueryParameter } from '../types/query.js'
 import type { Compute, ExactPartial } from '../types/utils.js'
 import { filterQueryOptions } from './utils.js'
 
-export type GetStorageAtOptions<config extends Config> = Compute<
-  ExactPartial<GetStorageAtParameters<config>> & ScopeKeyParameter
->
+export type GetStorageAtOptions<
+  config extends Config,
+  selectData = GetStorageAtData,
+> = Compute<ExactPartial<GetStorageAtParameters<config>> & ScopeKeyParameter> &
+  QueryParameter<
+    GetStorageAtQueryFnData,
+    GetStorageAtErrorType,
+    selectData,
+    GetStorageAtQueryKey<config>
+  >
 
-export function getStorageAtQueryOptions<config extends Config>(
+export function getStorageAtQueryOptions<
+  config extends Config,
+  selectData = GetStorageAtData,
+>(
   config: config,
-  options: GetStorageAtOptions<config> = {},
-) {
+  options: GetStorageAtOptions<config, selectData> = {},
+): GetStorageAtQueryOptions<config, selectData> {
   return {
-    queryFn({ queryKey }) {
-      const { address, slot, scopeKey: _, ...parameters } = queryKey[1]
-      if (!address || !slot) throw new Error('address and slot are required')
-      return getStorageAt(config, { ...parameters, address, slot })
+    ...options.query,
+    enabled: Boolean(
+      options.address && options.slot && (options.query?.enabled ?? true),
+    ),
+    queryFn: async (context) => {
+      const [, { scopeKey: _, ...parameters }] = context.queryKey
+      if (!parameters.address || !parameters.slot)
+        throw new Error('address and slot are required')
+      return getStorageAt(config, {
+        ...(parameters as GetStorageAtParameters),
+        address: parameters.address,
+        slot: parameters.slot,
+      })
     },
     queryKey: getStorageAtQueryKey(options),
-  } as const satisfies QueryOptions<
-    GetStorageAtQueryFnData,
-    GetStorageAtErrorType,
-    GetStorageAtData,
-    GetStorageAtQueryKey<config>
-  >
+  }
 }
 
 export type GetStorageAtQueryFnData = GetStorageAtReturnType
@@ -39,7 +52,9 @@ export type GetStorageAtQueryFnData = GetStorageAtReturnType
 export type GetStorageAtData = GetStorageAtQueryFnData
 
 export function getStorageAtQueryKey<config extends Config>(
-  options: GetStorageAtOptions<config>,
+  options: Compute<
+    ExactPartial<GetStorageAtParameters<config>> & ScopeKeyParameter
+  > = {},
 ) {
   return ['getStorageAt', filterQueryOptions(options)] as const
 }
@@ -47,3 +62,13 @@ export function getStorageAtQueryKey<config extends Config>(
 export type GetStorageAtQueryKey<config extends Config> = ReturnType<
   typeof getStorageAtQueryKey<config>
 >
+
+export type GetStorageAtQueryOptions<
+  config extends Config,
+  selectData = GetStorageAtData,
+> = QueryOptions<
+  GetStorageAtQueryFnData,
+  GetStorageAtErrorType,
+  selectData,
+  GetStorageAtQueryKey<config>
+>

package/src/query/getTransaction.ts

@@ -1,5 +1,3 @@
-import type { QueryOptions } from '@tanstack/query-core'
-
 import {
   type GetTransactionErrorType,
   type GetTransactionParameters,
@@ -8,42 +6,61 @@ import {
 } from '../actions/getTransaction.js'
 import type { Config } from '../createConfig.js'
 import type { ScopeKeyParameter } from '../types/properties.js'
+import type { QueryOptions, QueryParameter } from '../types/query.js'
 import type { Compute, ExactPartial } from '../types/utils.js'
 import { filterQueryOptions } from './utils.js'
 
 export type GetTransactionOptions<
   config extends Config,
   chainId extends config['chains'][number]['id'],
+  selectData = GetTransactionData<config, chainId>,
 > = Compute<
   ExactPartial<GetTransactionParameters<config, chainId>> & ScopeKeyParameter
->
+> &
+  QueryParameter<
+    GetTransactionQueryFnData<config, chainId>,
+    GetTransactionErrorType,
+    selectData,
+    GetTransactionQueryKey<config, chainId>
+  >
 
 export function getTransactionQueryOptions<
   config extends Config,
   chainId extends config['chains'][number]['id'],
->(config: config, options: GetTransactionOptions<config, chainId> = {}) {
+  selectData = GetTransactionData<config, chainId>,
+>(
+  config: config,
+  options: GetTransactionOptions<config, chainId, selectData> = {},
+): GetTransactionQueryOptions<config, chainId, selectData> {
   return {
-    async queryFn({ queryKey }) {
-      const { blockHash, blockNumber, blockTag, hash, index } = queryKey[1]
-      if (!blockHash && !blockNumber && !blockTag && !hash)
-        throw new Error('blockHash, blockNumber, blockTag, or hash is required')
-      if (!hash && !index)
+    ...options.query,
+    enabled: Boolean(
+      (options.hash ||
+        (options.index &&
+          (options.blockHash || options.blockNumber || options.blockTag))) &&
+        (options.query?.enabled ?? true),
+    ),
+    queryFn: async (context) => {
+      const [, { scopeKey: _, ...parameters }] = context.queryKey
+      if (
+        !(
+          parameters.hash ||
+          (parameters.index &&
+            (parameters.blockHash ||
+              parameters.blockNumber ||
+              parameters.blockTag))
+        )
+      )
         throw new Error(
-          'index is required for blockHash, blockNumber, or blockTag',
+          'hash OR index AND blockHash, blockNumber, blockTag is required',
         )
-      const { scopeKey: _, ...rest } = queryKey[1]
       return getTransaction(
         config,
-        rest as GetTransactionParameters,
+        parameters as GetTransactionParameters,
       ) as unknown as Promise<GetTransactionQueryFnData<config, chainId>>
     },
     queryKey: getTransactionQueryKey(options),
-  } as const satisfies QueryOptions<
-    GetTransactionQueryFnData<config, chainId>,
-    GetTransactionErrorType,
-    GetTransactionData<config, chainId>,
-    GetTransactionQueryKey<config, chainId>
-  >
+  }
 }
 
 export type GetTransactionQueryFnData<
@@ -59,7 +76,11 @@ export type GetTransactionData<
 export function getTransactionQueryKey<
   config extends Config,
   chainId extends config['chains'][number]['id'],
->(options: GetTransactionOptions<config, chainId> = {}) {
+>(
+  options: Compute<
+    ExactPartial<GetTransactionParameters<config, chainId>> & ScopeKeyParameter
+  > = {},
+) {
   return ['transaction', filterQueryOptions(options)] as const
 }
 
@@ -67,3 +88,14 @@ export type GetTransactionQueryKey<
   config extends Config,
   chainId extends config['chains'][number]['id'],
 > = ReturnType<typeof getTransactionQueryKey<config, chainId>>
+
+export type GetTransactionQueryOptions<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+  selectData = GetTransactionData<config, chainId>,
+> = QueryOptions<
+  GetTransactionQueryFnData<config, chainId>,
+  GetTransactionErrorType,
+  selectData,
+  GetTransactionQueryKey<config, chainId>
+>