@wagmi/core 3.2.0 → 3.2.2

package/src/query/getCallsStatus.ts

@@ -1,5 +1,3 @@
-import type { QueryOptions } from '@tanstack/query-core'
-
 import {
   type GetCallsStatusErrorType,
   type GetCallsStatusParameters,
@@ -7,44 +5,61 @@ import {
   getCallsStatus,
 } from '../actions/getCallsStatus.js'
 import type { Config } from '../createConfig.js'
-import { ConnectorNotConnectedError } from '../errors/config.js'
 import { filterQueryOptions } from '../query/utils.js'
 import type { ScopeKeyParameter } from '../types/properties.js'
+import type { QueryOptions, QueryParameter } from '../types/query.js'
 import type { Compute } from '../types/utils.js'
 
-export type GetCallsStatusOptions = Compute<
+export type GetCallsStatusOptions<selectData = GetCallsStatusData> = Compute<
   GetCallsStatusParameters & ScopeKeyParameter
->
+> &
+  QueryParameter<
+    GetCallsStatusQueryFnData,
+    GetCallsStatusErrorType,
+    selectData,
+    GetCallsStatusQueryKey
+  >
 
-export function getCallsStatusQueryOptions<config extends Config>(
+export function getCallsStatusQueryOptions<
+  config extends Config,
+  selectData = GetCallsStatusData,
+>(
   config: config,
-  options: GetCallsStatusOptions,
-) {
+  options: GetCallsStatusOptions<selectData>,
+): GetCallsStatusQueryOptions<selectData> {
   return {
-    async queryFn({ queryKey }) {
-      const { scopeKey: _, ...parameters } = queryKey[1]
+    ...options.query,
+    enabled: Boolean(
+      options.connector?.getProvider && (options.query?.enabled ?? true),
+    ),
+    queryFn: async (context) => {
+      if (!options.connector?.getProvider)
+        throw new Error('connector is required')
+      const [, { connectorUid: _, scopeKey: __, ...parameters }] =
+        context.queryKey
       const status = await getCallsStatus(config, parameters)
       return status
     },
     queryKey: getCallsStatusQueryKey(options),
-    retry(failureCount, error) {
-      if (error instanceof ConnectorNotConnectedError) return false
-      return failureCount < 3
-    },
-  } as const satisfies QueryOptions<
-    GetCallsStatusQueryFnData,
-    GetCallsStatusErrorType,
-    GetCallsStatusData,
-    GetCallsStatusQueryKey
-  >
+  }
 }
 
 export type GetCallsStatusQueryFnData = GetCallsStatusReturnType
 
 export type GetCallsStatusData = GetCallsStatusQueryFnData
 
-export function getCallsStatusQueryKey(options: GetCallsStatusOptions) {
+export function getCallsStatusQueryKey(
+  options: Compute<GetCallsStatusParameters & ScopeKeyParameter>,
+) {
   return ['callsStatus', filterQueryOptions(options)] as const
 }
 
 export type GetCallsStatusQueryKey = ReturnType<typeof getCallsStatusQueryKey>
+
+export type GetCallsStatusQueryOptions<selectData = GetCallsStatusData> =
+  QueryOptions<
+    GetCallsStatusQueryFnData,
+    GetCallsStatusErrorType,
+    selectData,
+    GetCallsStatusQueryKey
+  >

package/src/query/getCapabilities.ts

@@ -1,5 +1,3 @@
-import type { QueryOptions } from '@tanstack/query-core'
-
 import {
   type GetCapabilitiesErrorType,
   type GetCapabilitiesParameters,
@@ -7,39 +5,48 @@ import {
   getCapabilities,
 } from '../actions/getCapabilities.js'
 import type { Config } from '../createConfig.js'
-import { ConnectorNotConnectedError } from '../errors/config.js'
 import { filterQueryOptions } from '../query/utils.js'
 import type { ScopeKeyParameter } from '../types/properties.js'
+import type { QueryOptions, QueryParameter } from '../types/query.js'
 import type { Compute, ExactPartial } from '../types/utils.js'
 
 export type GetCapabilitiesOptions<
   config extends Config = Config,
   chainId extends config['chains'][number]['id'] | undefined = undefined,
+  selectData = GetCapabilitiesData<config, chainId>,
 > = Compute<
   ExactPartial<GetCapabilitiesParameters<config, chainId>> & ScopeKeyParameter
->
+> &
+  QueryParameter<
+    GetCapabilitiesQueryFnData<config, chainId>,
+    GetCapabilitiesErrorType,
+    selectData,
+    GetCapabilitiesQueryKey<config, chainId>
+  >
 
 export function getCapabilitiesQueryOptions<
   config extends Config,
   chainId extends config['chains'][number]['id'] | undefined = undefined,
->(config: config, options: GetCapabilitiesOptions<config, chainId> = {}) {
+  selectData = GetCapabilitiesData<config, chainId>,
+>(
+  config: config,
+  options: GetCapabilitiesOptions<config, chainId, selectData> = {},
+): GetCapabilitiesQueryOptions<config, chainId, selectData> {
   return {
-    async queryFn({ queryKey }) {
-      const { scopeKey: _, ...parameters } = queryKey[1]
+    ...options.query,
+    enabled: Boolean(
+      options.connector?.getProvider && (options.query?.enabled ?? true),
+    ),
+    queryFn: async (context) => {
+      if (!options.connector?.getProvider)
+        throw new Error('connector is required')
+      const [, { connectorUid: _, scopeKey: __, ...parameters }] =
+        context.queryKey
       const capabilities = await getCapabilities(config, parameters)
       return capabilities
     },
     queryKey: getCapabilitiesQueryKey(options),
-    retry(failureCount, error) {
-      if (error instanceof ConnectorNotConnectedError) return false
-      return failureCount < 3
-    },
-  } as const satisfies QueryOptions<
-    GetCapabilitiesQueryFnData<config, chainId>,
-    GetCapabilitiesErrorType,
-    GetCapabilitiesData<config, chainId>,
-    GetCapabilitiesQueryKey<config, chainId>
-  >
+  }
 }
 
 export type GetCapabilitiesQueryFnData<
@@ -55,7 +62,11 @@ export type GetCapabilitiesData<
 export function getCapabilitiesQueryKey<
   config extends Config,
   chainId extends config['chains'][number]['id'] | undefined = undefined,
->(options: GetCapabilitiesOptions<config, chainId> = {}) {
+>(
+  options: Compute<
+    ExactPartial<GetCapabilitiesParameters<config, chainId>> & ScopeKeyParameter
+  > = {},
+) {
   return ['capabilities', filterQueryOptions(options)] as const
 }
 
@@ -63,3 +74,14 @@ export type GetCapabilitiesQueryKey<
   config extends Config,
   chainId extends config['chains'][number]['id'] | undefined = undefined,
 > = ReturnType<typeof getCapabilitiesQueryKey<config, chainId>>
+
+export type GetCapabilitiesQueryOptions<
+  config extends Config,
+  chainId extends config['chains'][number]['id'] | undefined = undefined,
+  selectData = GetCapabilitiesData<config, chainId>,
+> = QueryOptions<
+  GetCapabilitiesQueryFnData<config, chainId>,
+  GetCapabilitiesErrorType,
+  selectData,
+  GetCapabilitiesQueryKey<config, chainId>
+>

package/src/query/getConnectorClient.ts

@@ -1,5 +1,3 @@
-import type { QueryOptions } from '@tanstack/query-core'
-
 import {
   type GetConnectorClientErrorType,
   type GetConnectorClientParameters,
@@ -8,38 +6,53 @@ import {
 } from '../actions/getConnectorClient.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 GetConnectorClientOptions<
   config extends Config,
   chainId extends config['chains'][number]['id'],
+  selectData = GetConnectorClientData<config, chainId>,
 > = Compute<
   ExactPartial<GetConnectorClientParameters<config, chainId>> &
     ScopeKeyParameter
->
+> &
+  Omit<
+    QueryParameter<
+      GetConnectorClientQueryFnData<config, chainId>,
+      GetConnectorClientErrorType,
+      selectData,
+      GetConnectorClientQueryKey<config, chainId>
+    >,
+    'gcTime' | 'staleTime'
+  >
 
 export function getConnectorClientQueryOptions<
   config extends Config,
   chainId extends config['chains'][number]['id'],
->(config: config, options: GetConnectorClientOptions<config, chainId> = {}) {
+  selectData = GetConnectorClientData<config, chainId>,
+>(
+  config: config,
+  options: GetConnectorClientOptions<config, chainId, selectData> = {},
+): GetConnectorClientQueryOptions<config, chainId, selectData> {
   return {
+    ...options.query,
+    enabled: Boolean(
+      options.connector?.getProvider && (options.query?.enabled ?? true),
+    ),
     gcTime: 0,
-    async queryFn({ queryKey }) {
-      const { connector } = options
-      const { connectorUid: _, scopeKey: _s, ...parameters } = queryKey[1]
+    queryFn: async (context) => {
+      const [, { connectorUid: _, scopeKey: __, ...parameters }] =
+        context.queryKey
       return getConnectorClient(config, {
         ...parameters,
-        connector,
+        connector: options.connector,
       }) as unknown as Promise<GetConnectorClientReturnType<config, chainId>>
     },
     queryKey: getConnectorClientQueryKey(options),
-  } as const satisfies QueryOptions<
-    GetConnectorClientQueryFnData<config, chainId>,
-    GetConnectorClientErrorType,
-    GetConnectorClientData<config, chainId>,
-    GetConnectorClientQueryKey<config, chainId>
-  >
+    staleTime: Number.POSITIVE_INFINITY,
+  }
 }
 
 export type GetConnectorClientQueryFnData<
@@ -55,15 +68,27 @@ export type GetConnectorClientData<
 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
+>(
+  options: Compute<
+    ExactPartial<GetConnectorClientParameters<config, chainId>> &
+      ScopeKeyParameter
+  > = {},
+) {
+  return ['connectorClient', filterQueryOptions(options)] as const
 }
 
 export type GetConnectorClientQueryKey<
   config extends Config,
   chainId extends config['chains'][number]['id'],
 > = ReturnType<typeof getConnectorClientQueryKey<config, chainId>>
+
+export type GetConnectorClientQueryOptions<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+  selectData = GetConnectorClientData<config, chainId>,
+> = QueryOptions<
+  GetConnectorClientQueryFnData<config, chainId>,
+  GetConnectorClientErrorType,
+  selectData,
+  GetConnectorClientQueryKey<config, chainId>
+>

package/src/query/getEnsAddress.ts

@@ -1,5 +1,3 @@
-import type { QueryOptions } from '@tanstack/query-core'
-
 import {
   type GetEnsAddressErrorType,
   type GetEnsAddressParameters,
@@ -8,30 +6,38 @@ import {
 } from '../actions/getEnsAddress.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 GetEnsAddressOptions<config extends Config> = Compute<
-  ExactPartial<GetEnsAddressParameters<config>> & ScopeKeyParameter
->
+export type GetEnsAddressOptions<
+  config extends Config,
+  selectData = GetEnsAddressData,
+> = Compute<ExactPartial<GetEnsAddressParameters<config>> & ScopeKeyParameter> &
+  QueryParameter<
+    GetEnsAddressQueryFnData,
+    GetEnsAddressErrorType,
+    selectData,
+    GetEnsAddressQueryKey<config>
+  >
 
-export function getEnsAddressQueryOptions<config extends Config>(
+export function getEnsAddressQueryOptions<
+  config extends Config,
+  selectData = GetEnsAddressData,
+>(
   config: config,
-  options: GetEnsAddressOptions<config> = {},
-) {
+  options: GetEnsAddressOptions<config, selectData> = {},
+): GetEnsAddressQueryOptions<config, selectData> {
   return {
-    async queryFn({ queryKey }) {
-      const { name, scopeKey: _, ...parameters } = queryKey[1]
-      if (!name) throw new Error('name is required')
-      return getEnsAddress(config, { ...parameters, name })
+    ...options.query,
+    enabled: Boolean(options.name && (options.query?.enabled ?? true)),
+    queryFn: async (context) => {
+      const [, { scopeKey: _, ...parameters }] = context.queryKey
+      if (!parameters.name) throw new Error('name is required')
+      return getEnsAddress(config, { ...parameters, name: parameters.name })
     },
     queryKey: getEnsAddressQueryKey(options),
-  } as const satisfies QueryOptions<
-    GetEnsAddressQueryFnData,
-    GetEnsAddressErrorType,
-    GetEnsAddressData,
-    GetEnsAddressQueryKey<config>
-  >
+  }
 }
 
 export type GetEnsAddressQueryFnData = GetEnsAddressReturnType
@@ -39,7 +45,9 @@ export type GetEnsAddressQueryFnData = GetEnsAddressReturnType
 export type GetEnsAddressData = GetEnsAddressQueryFnData
 
 export function getEnsAddressQueryKey<config extends Config>(
-  options: GetEnsAddressOptions<config> = {},
+  options: Compute<
+    ExactPartial<GetEnsAddressParameters<config>> & ScopeKeyParameter
+  > = {},
 ) {
   return ['ensAddress', filterQueryOptions(options)] as const
 }
@@ -47,3 +55,13 @@ export function getEnsAddressQueryKey<config extends Config>(
 export type GetEnsAddressQueryKey<config extends Config> = ReturnType<
   typeof getEnsAddressQueryKey<config>
 >
+
+export type GetEnsAddressQueryOptions<
+  config extends Config,
+  selectData = GetEnsAddressData,
+> = QueryOptions<
+  GetEnsAddressQueryFnData,
+  GetEnsAddressErrorType,
+  selectData,
+  GetEnsAddressQueryKey<config>
+>

package/src/query/getEnsAvatar.ts

@@ -1,5 +1,3 @@
-import type { QueryOptions } from '@tanstack/query-core'
-
 import {
   type GetEnsAvatarErrorType,
   type GetEnsAvatarParameters,
@@ -8,30 +6,38 @@ import {
 } from '../actions/getEnsAvatar.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 GetEnsAvatarOptions<config extends Config> = Compute<
-  ExactPartial<GetEnsAvatarParameters<config>> & ScopeKeyParameter
->
+export type GetEnsAvatarOptions<
+  config extends Config,
+  selectData = GetEnsAvatarData,
+> = Compute<ExactPartial<GetEnsAvatarParameters<config>> & ScopeKeyParameter> &
+  QueryParameter<
+    GetEnsAvatarQueryFnData,
+    GetEnsAvatarErrorType,
+    selectData,
+    GetEnsAvatarQueryKey<config>
+  >
 
-export function getEnsAvatarQueryOptions<config extends Config>(
+export function getEnsAvatarQueryOptions<
+  config extends Config,
+  selectData = GetEnsAvatarData,
+>(
   config: config,
-  options: GetEnsAvatarOptions<config> = {},
-) {
+  options: GetEnsAvatarOptions<config, selectData> = {},
+): GetEnsAvatarQueryOptions<config, selectData> {
   return {
-    async queryFn({ queryKey }) {
-      const { name, scopeKey: _, ...parameters } = queryKey[1]
-      if (!name) throw new Error('name is required')
-      return getEnsAvatar(config, { ...parameters, name })
+    ...options.query,
+    enabled: Boolean(options.name && (options.query?.enabled ?? true)),
+    queryFn: async (context) => {
+      const [, { scopeKey: _, ...parameters }] = context.queryKey
+      if (!parameters.name) throw new Error('name is required')
+      return getEnsAvatar(config, { ...parameters, name: parameters.name })
     },
     queryKey: getEnsAvatarQueryKey(options),
-  } as const satisfies QueryOptions<
-    GetEnsAvatarQueryFnData,
-    GetEnsAvatarErrorType,
-    GetEnsAvatarData,
-    GetEnsAvatarQueryKey<config>
-  >
+  }
 }
 
 export type GetEnsAvatarQueryFnData = GetEnsAvatarReturnType
@@ -39,7 +45,9 @@ export type GetEnsAvatarQueryFnData = GetEnsAvatarReturnType
 export type GetEnsAvatarData = GetEnsAvatarQueryFnData
 
 export function getEnsAvatarQueryKey<config extends Config>(
-  options: GetEnsAvatarOptions<config> = {},
+  options: Compute<
+    ExactPartial<GetEnsAvatarParameters<config>> & ScopeKeyParameter
+  > = {},
 ) {
   return ['ensAvatar', filterQueryOptions(options)] as const
 }
@@ -47,3 +55,13 @@ export function getEnsAvatarQueryKey<config extends Config>(
 export type GetEnsAvatarQueryKey<config extends Config> = ReturnType<
   typeof getEnsAvatarQueryKey<config>
 >
+
+export type GetEnsAvatarQueryOptions<
+  config extends Config,
+  selectData = GetEnsAvatarData,
+> = QueryOptions<
+  GetEnsAvatarQueryFnData,
+  GetEnsAvatarErrorType,
+  selectData,
+  GetEnsAvatarQueryKey<config>
+>

package/src/query/getEnsName.ts

@@ -1,5 +1,3 @@
-import type { QueryOptions } from '@tanstack/query-core'
-
 import {
   type GetEnsNameErrorType,
   type GetEnsNameParameters,
@@ -8,30 +6,38 @@ import {
 } from '../actions/getEnsName.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 GetEnsNameOptions<config extends Config> = Compute<
-  ExactPartial<GetEnsNameParameters<config>> & ScopeKeyParameter
->
+export type GetEnsNameOptions<
+  config extends Config,
+  selectData = GetEnsNameData,
+> = Compute<ExactPartial<GetEnsNameParameters<config>> & ScopeKeyParameter> &
+  QueryParameter<
+    GetEnsNameQueryFnData,
+    GetEnsNameErrorType,
+    selectData,
+    GetEnsNameQueryKey<config>
+  >
 
-export function getEnsNameQueryOptions<config extends Config>(
+export function getEnsNameQueryOptions<
+  config extends Config,
+  selectData = GetEnsNameData,
+>(
   config: config,
-  options: GetEnsNameOptions<config> = {},
-) {
+  options: GetEnsNameOptions<config, selectData> = {},
+): GetEnsNameQueryOptions<config, selectData> {
   return {
-    async queryFn({ queryKey }) {
-      const { address, scopeKey: _, ...parameters } = queryKey[1]
-      if (!address) throw new Error('address is required')
-      return getEnsName(config, { ...parameters, address })
+    ...options.query,
+    enabled: Boolean(options.address && (options.query?.enabled ?? true)),
+    queryFn: async (context) => {
+      const [, { scopeKey: _, ...parameters }] = context.queryKey
+      if (!parameters.address) throw new Error('address is required')
+      return getEnsName(config, { ...parameters, address: parameters.address })
     },
     queryKey: getEnsNameQueryKey(options),
-  } as const satisfies QueryOptions<
-    GetEnsNameQueryFnData,
-    GetEnsNameErrorType,
-    GetEnsNameData,
-    GetEnsNameQueryKey<config>
-  >
+  }
 }
 
 export type GetEnsNameQueryFnData = GetEnsNameReturnType
@@ -39,7 +45,9 @@ export type GetEnsNameQueryFnData = GetEnsNameReturnType
 export type GetEnsNameData = GetEnsNameQueryFnData
 
 export function getEnsNameQueryKey<config extends Config>(
-  options: GetEnsNameOptions<config> = {},
+  options: Compute<
+    ExactPartial<GetEnsNameParameters<config>> & ScopeKeyParameter
+  > = {},
 ) {
   return ['ensName', filterQueryOptions(options)] as const
 }
@@ -47,3 +55,13 @@ export function getEnsNameQueryKey<config extends Config>(
 export type GetEnsNameQueryKey<config extends Config> = ReturnType<
   typeof getEnsNameQueryKey<config>
 >
+
+export type GetEnsNameQueryOptions<
+  config extends Config,
+  selectData = GetEnsNameData,
+> = QueryOptions<
+  GetEnsNameQueryFnData,
+  GetEnsNameErrorType,
+  selectData,
+  GetEnsNameQueryKey<config>
+>

package/src/query/getEnsResolver.ts

@@ -1,5 +1,3 @@
-import type { QueryOptions } from '@tanstack/query-core'
-
 import {
   type GetEnsResolverErrorType,
   type GetEnsResolverParameters,
@@ -8,30 +6,40 @@ import {
 } from '../actions/getEnsResolver.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 GetEnsResolverOptions<config extends Config> = Compute<
+export type GetEnsResolverOptions<
+  config extends Config,
+  selectData = GetEnsResolverData,
+> = Compute<
   ExactPartial<GetEnsResolverParameters<config>> & ScopeKeyParameter
->
+> &
+  QueryParameter<
+    GetEnsResolverQueryFnData,
+    GetEnsResolverErrorType,
+    selectData,
+    GetEnsResolverQueryKey<config>
+  >
 
-export function getEnsResolverQueryOptions<config extends Config>(
+export function getEnsResolverQueryOptions<
+  config extends Config,
+  selectData = GetEnsResolverData,
+>(
   config: config,
-  options: GetEnsResolverOptions<config> = {},
-) {
+  options: GetEnsResolverOptions<config, selectData> = {},
+): GetEnsResolverQueryOptions<config, selectData> {
   return {
-    async queryFn({ queryKey }) {
-      const { name, scopeKey: _, ...parameters } = queryKey[1]
-      if (!name) throw new Error('name is required')
-      return getEnsResolver(config, { ...parameters, name })
+    ...options.query,
+    enabled: Boolean(options.name && (options.query?.enabled ?? true)),
+    queryFn: async (context) => {
+      const [, { scopeKey: _, ...parameters }] = context.queryKey
+      if (!parameters.name) throw new Error('name is required')
+      return getEnsResolver(config, { ...parameters, name: parameters.name })
     },
     queryKey: getEnsResolverQueryKey(options),
-  } as const satisfies QueryOptions<
-    GetEnsResolverQueryFnData,
-    GetEnsResolverErrorType,
-    GetEnsResolverData,
-    GetEnsResolverQueryKey<config>
-  >
+  }
 }
 
 export type GetEnsResolverQueryFnData = GetEnsResolverReturnType
@@ -39,7 +47,9 @@ export type GetEnsResolverQueryFnData = GetEnsResolverReturnType
 export type GetEnsResolverData = GetEnsResolverQueryFnData
 
 export function getEnsResolverQueryKey<config extends Config>(
-  options: GetEnsResolverOptions<config> = {},
+  options: Compute<
+    ExactPartial<GetEnsResolverParameters<config>> & ScopeKeyParameter
+  > = {},
 ) {
   return ['ensResolver', filterQueryOptions(options)] as const
 }
@@ -47,3 +57,13 @@ export function getEnsResolverQueryKey<config extends Config>(
 export type GetEnsResolverQueryKey<config extends Config> = ReturnType<
   typeof getEnsResolverQueryKey<config>
 >
+
+export type GetEnsResolverQueryOptions<
+  config extends Config,
+  selectData = GetEnsResolverData,
+> = QueryOptions<
+  GetEnsResolverQueryFnData,
+  GetEnsResolverErrorType,
+  selectData,
+  GetEnsResolverQueryKey<config>
+>