wagmi 3.3.2 → 3.4.0

package/src/tempo/hooks/amm.ts

@@ -13,6 +13,7 @@ import {
   useMutation,
   useQuery,
 } from '../../utils/query.js'
+import type { QueryParameter } from '../utils.js'
 
 /**
  * Hook for getting the reserves for a liquidity pool.
@@ -60,9 +61,13 @@ export declare namespace usePool {
     config extends Config = ResolvedRegister['config'],
     selectData = Actions.amm.getPool.ReturnValue,
   > = ConfigParameter<config> &
-    ExactPartial<
-      Actions.amm.getPool.queryOptions.Parameters<config, selectData>
-    >
+    QueryParameter<
+      Actions.amm.getPool.ReturnValue,
+      Actions.amm.getPool.ErrorType,
+      selectData,
+      Actions.amm.getPool.QueryKey<config>
+    > &
+    ExactPartial<Actions.amm.getPool.Parameters<config>>
 
   export type ReturnValue<selectData = Actions.amm.getPool.ReturnValue> =
     UseQueryReturnType<selectData, Error>
@@ -114,12 +119,13 @@ export declare namespace useLiquidityBalance {
     config extends Config = ResolvedRegister['config'],
     selectData = Actions.amm.getLiquidityBalance.ReturnValue,
   > = ConfigParameter<config> &
-    ExactPartial<
-      Actions.amm.getLiquidityBalance.queryOptions.Parameters<
-        config,
-        selectData
-      >
-    >
+    QueryParameter<
+      Actions.amm.getLiquidityBalance.ReturnValue,
+      Actions.amm.getLiquidityBalance.ErrorType,
+      selectData,
+      Actions.amm.getLiquidityBalance.QueryKey<config>
+    > &
+    ExactPartial<Actions.amm.getLiquidityBalance.Parameters<config>>
 
   export type ReturnValue<
     selectData = Actions.amm.getLiquidityBalance.ReturnValue,

package/src/tempo/hooks/dex.ts

@@ -13,6 +13,7 @@ import {
   useMutation,
   useQuery,
 } from '../../utils/query.js'
+import type { QueryParameter } from '../utils.js'
 
 /**
  * Hook for buying a specific amount of tokens.
@@ -616,9 +617,13 @@ export declare namespace useBalance {
     config extends Config = ResolvedRegister['config'],
     selectData = Actions.dex.getBalance.ReturnValue,
   > = ConfigParameter<config> &
-    ExactPartial<
-      Actions.dex.getBalance.queryOptions.Parameters<config, selectData>
-    >
+    QueryParameter<
+      Actions.dex.getBalance.ReturnValue,
+      Actions.dex.getBalance.ErrorType,
+      selectData,
+      Actions.dex.getBalance.QueryKey<config>
+    > &
+    ExactPartial<Actions.dex.getBalance.Parameters<config>>
 
   export type ReturnValue<selectData = Actions.dex.getBalance.ReturnValue> =
     UseQueryReturnType<selectData, Error>
@@ -666,9 +671,13 @@ export declare namespace useBuyQuote {
     config extends Config = ResolvedRegister['config'],
     selectData = Actions.dex.getBuyQuote.ReturnValue,
   > = ConfigParameter<config> &
-    ExactPartial<
-      Actions.dex.getBuyQuote.queryOptions.Parameters<config, selectData>
-    >
+    QueryParameter<
+      Actions.dex.getBuyQuote.ReturnValue,
+      Actions.dex.getBuyQuote.ErrorType,
+      selectData,
+      Actions.dex.getBuyQuote.QueryKey<config>
+    > &
+    ExactPartial<Actions.dex.getBuyQuote.Parameters<config>>
 
   export type ReturnValue<selectData = Actions.dex.getBuyQuote.ReturnValue> =
     UseQueryReturnType<selectData, Error>
@@ -714,9 +723,13 @@ export declare namespace useOrder {
     config extends Config = ResolvedRegister['config'],
     selectData = Actions.dex.getOrder.ReturnValue,
   > = ConfigParameter<config> &
-    ExactPartial<
-      Actions.dex.getOrder.queryOptions.Parameters<config, selectData>
-    >
+    QueryParameter<
+      Actions.dex.getOrder.ReturnValue,
+      Actions.dex.getOrder.ErrorType,
+      selectData,
+      Actions.dex.getOrder.QueryKey<config>
+    > &
+    ExactPartial<Actions.dex.getOrder.Parameters<config>>
 
   export type ReturnValue<selectData = Actions.dex.getOrder.ReturnValue> =
     UseQueryReturnType<selectData, Error>
@@ -763,9 +776,13 @@ export declare namespace useOrderbook {
     config extends Config = ResolvedRegister['config'],
     selectData = Actions.dex.getOrderbook.ReturnValue,
   > = ConfigParameter<config> &
-    ExactPartial<
-      Actions.dex.getOrderbook.queryOptions.Parameters<config, selectData>
-    >
+    QueryParameter<
+      Actions.dex.getOrderbook.ReturnValue,
+      Actions.dex.getOrderbook.ErrorType,
+      selectData,
+      Actions.dex.getOrderbook.QueryKey<config>
+    > &
+    ExactPartial<Actions.dex.getOrderbook.Parameters<config>>
 
   export type ReturnValue<selectData = Actions.dex.getOrderbook.ReturnValue> =
     UseQueryReturnType<selectData, Error>
@@ -814,9 +831,13 @@ export declare namespace useTickLevel {
     config extends Config = ResolvedRegister['config'],
     selectData = Actions.dex.getTickLevel.ReturnValue,
   > = ConfigParameter<config> &
-    ExactPartial<
-      Actions.dex.getTickLevel.queryOptions.Parameters<config, selectData>
-    >
+    QueryParameter<
+      Actions.dex.getTickLevel.ReturnValue,
+      Actions.dex.getTickLevel.ErrorType,
+      selectData,
+      Actions.dex.getTickLevel.QueryKey<config>
+    > &
+    ExactPartial<Actions.dex.getTickLevel.Parameters<config>>
 
   export type ReturnValue<selectData = Actions.dex.getTickLevel.ReturnValue> =
     UseQueryReturnType<selectData, Error>
@@ -864,9 +885,13 @@ export declare namespace useSellQuote {
     config extends Config = ResolvedRegister['config'],
     selectData = Actions.dex.getSellQuote.ReturnValue,
   > = ConfigParameter<config> &
-    ExactPartial<
-      Actions.dex.getSellQuote.queryOptions.Parameters<config, selectData>
-    >
+    QueryParameter<
+      Actions.dex.getSellQuote.ReturnValue,
+      Actions.dex.getSellQuote.ErrorType,
+      selectData,
+      Actions.dex.getSellQuote.QueryKey<config>
+    > &
+    ExactPartial<Actions.dex.getSellQuote.Parameters<config>>
 
   export type ReturnValue<selectData = Actions.dex.getSellQuote.ReturnValue> =
     UseQueryReturnType<selectData, Error>

package/src/tempo/hooks/fee.ts

@@ -13,6 +13,7 @@ import {
   useMutation,
   useQuery,
 } from '../../utils/query.js'
+import type { QueryParameter } from '../utils.js'
 
 /**
  * Hook for getting the user's default fee token.
@@ -54,9 +55,13 @@ export declare namespace useUserToken {
     config extends Config = ResolvedRegister['config'],
     selectData = Actions.fee.getUserToken.ReturnValue,
   > = ConfigParameter<config> &
-    ExactPartial<
-      Actions.fee.getUserToken.queryOptions.Parameters<config, selectData>
-    >
+    QueryParameter<
+      Actions.fee.getUserToken.ReturnValue,
+      Actions.fee.getUserToken.ErrorType,
+      selectData,
+      Actions.fee.getUserToken.QueryKey<config>
+    > &
+    ExactPartial<Actions.fee.getUserToken.Parameters<config>>
 
   export type ReturnValue<selectData = Actions.fee.getUserToken.ReturnValue> =
     UseQueryReturnType<selectData, Error>

package/src/tempo/hooks/nonce.ts

@@ -7,6 +7,7 @@ import { useChainId } from '../../hooks/useChainId.js'
 import { useConfig } from '../../hooks/useConfig.js'
 import type { ConfigParameter } from '../../types/properties.js'
 import { type UseQueryReturnType, useQuery } from '../../utils/query.js'
+import type { QueryParameter } from '../utils.js'
 
 /**
  * Hook for getting the nonce for an account and nonce key.
@@ -49,9 +50,13 @@ export declare namespace useNonce {
     config extends Config = ResolvedRegister['config'],
     selectData = Actions.nonce.getNonce.ReturnValue,
   > = ConfigParameter<config> &
-    ExactPartial<
-      Actions.nonce.getNonce.queryOptions.Parameters<config, selectData>
-    >
+    QueryParameter<
+      Actions.nonce.getNonce.ReturnValue,
+      Actions.nonce.getNonce.ErrorType,
+      selectData,
+      Actions.nonce.getNonce.QueryKey<config>
+    > &
+    ExactPartial<Actions.nonce.getNonce.Parameters<config>>
 
   export type ReturnValue<selectData = Actions.nonce.getNonce.ReturnValue> =
     UseQueryReturnType<selectData, Error>

package/src/tempo/hooks/policy.ts

@@ -13,6 +13,7 @@ import {
   useMutation,
   useQuery,
 } from '../../utils/query.js'
+import type { QueryParameter } from '../utils.js'
 
 /**
  * Hook for creating a new policy.
@@ -602,9 +603,13 @@ export declare namespace useData {
     config extends Config = ResolvedRegister['config'],
     selectData = Actions.policy.getData.ReturnValue,
   > = ConfigParameter<config> &
-    ExactPartial<
-      Actions.policy.getData.queryOptions.Parameters<config, selectData>
-    >
+    QueryParameter<
+      Actions.policy.getData.ReturnValue,
+      Actions.policy.getData.ErrorType,
+      selectData,
+      Actions.policy.getData.QueryKey<config>
+    > &
+    ExactPartial<Actions.policy.getData.Parameters<config>>
 
   export type ReturnValue<selectData = Actions.policy.getData.ReturnValue> =
     UseQueryReturnType<selectData, Error>
@@ -651,9 +656,13 @@ export declare namespace useIsAuthorized {
     config extends Config = ResolvedRegister['config'],
     selectData = Actions.policy.isAuthorized.ReturnValue,
   > = ConfigParameter<config> &
-    ExactPartial<
-      Actions.policy.isAuthorized.queryOptions.Parameters<config, selectData>
-    >
+    QueryParameter<
+      Actions.policy.isAuthorized.ReturnValue,
+      Actions.policy.isAuthorized.ErrorType,
+      selectData,
+      Actions.policy.isAuthorized.QueryKey<config>
+    > &
+    ExactPartial<Actions.policy.isAuthorized.Parameters<config>>
 
   export type ReturnValue<
     selectData = Actions.policy.isAuthorized.ReturnValue,

package/src/tempo/hooks/reward.ts

@@ -13,6 +13,7 @@ import {
   useMutation,
   useQuery,
 } from '../../utils/query.js'
+import type { QueryParameter } from '../utils.js'
 
 /**
  * Hook for claiming accumulated rewards.
@@ -186,12 +187,13 @@ export declare namespace useGetGlobalRewardPerToken {
     config extends Config = ResolvedRegister['config'],
     selectData = Actions.reward.getGlobalRewardPerToken.ReturnValue,
   > = ConfigParameter<config> &
-    ExactPartial<
-      Actions.reward.getGlobalRewardPerToken.queryOptions.Parameters<
-        config,
-        selectData
-      >
-    >
+    QueryParameter<
+      Actions.reward.getGlobalRewardPerToken.ReturnValue,
+      Actions.reward.getGlobalRewardPerToken.ErrorType,
+      selectData,
+      Actions.reward.getGlobalRewardPerToken.QueryKey<config>
+    > &
+    ExactPartial<Actions.reward.getGlobalRewardPerToken.Parameters<config>>
 
   export type ReturnValue<
     selectData = Actions.reward.getGlobalRewardPerToken.ReturnValue,
@@ -245,12 +247,13 @@ export declare namespace useUserRewardInfo {
     config extends Config = ResolvedRegister['config'],
     selectData = Actions.reward.getUserRewardInfo.ReturnValue,
   > = ConfigParameter<config> &
-    ExactPartial<
-      Actions.reward.getUserRewardInfo.queryOptions.Parameters<
-        config,
-        selectData
-      >
-    >
+    QueryParameter<
+      Actions.reward.getUserRewardInfo.ReturnValue,
+      Actions.reward.getUserRewardInfo.ErrorType,
+      selectData,
+      Actions.reward.getUserRewardInfo.QueryKey<config>
+    > &
+    ExactPartial<Actions.reward.getUserRewardInfo.Parameters<config>>
 
   export type ReturnValue<
     selectData = Actions.reward.getUserRewardInfo.ReturnValue,

package/src/tempo/hooks/token.ts

@@ -13,6 +13,7 @@ import {
   useMutation,
   useQuery,
 } from '../../utils/query.js'
+import type { QueryParameter } from '../utils.js'
 
 /**
  * Hook for approving a spender to transfer TIP20 tokens.
@@ -877,9 +878,13 @@ export declare namespace useGetAllowance {
     config extends Config = ResolvedRegister['config'],
     selectData = Actions.token.getAllowance.ReturnValue,
   > = ConfigParameter<config> &
-    ExactPartial<
-      Actions.token.getAllowance.queryOptions.Parameters<config, selectData>
-    >
+    QueryParameter<
+      Actions.token.getAllowance.ReturnValue,
+      Actions.token.getAllowance.ErrorType,
+      selectData,
+      Actions.token.getAllowance.QueryKey<config>
+    > &
+    ExactPartial<Actions.token.getAllowance.Parameters<config>>
 
   export type ReturnValue<selectData = Actions.token.getAllowance.ReturnValue> =
     UseQueryReturnType<selectData, Error>
@@ -925,9 +930,13 @@ export declare namespace useGetBalance {
     config extends Config = ResolvedRegister['config'],
     selectData = Actions.token.getBalance.ReturnValue,
   > = ConfigParameter<config> &
-    ExactPartial<
-      Actions.token.getBalance.queryOptions.Parameters<config, selectData>
-    >
+    QueryParameter<
+      Actions.token.getBalance.ReturnValue,
+      Actions.token.getBalance.ErrorType,
+      selectData,
+      Actions.token.getBalance.QueryKey<config>
+    > &
+    ExactPartial<Actions.token.getBalance.Parameters<config>>
 
   export type ReturnValue<selectData = Actions.token.getBalance.ReturnValue> =
     UseQueryReturnType<selectData, Error>
@@ -973,9 +982,13 @@ export declare namespace useGetMetadata {
     config extends Config = ResolvedRegister['config'],
     selectData = Actions.token.getMetadata.ReturnValue,
   > = ConfigParameter<config> &
-    ExactPartial<
-      Actions.token.getMetadata.queryOptions.Parameters<config, selectData>
-    >
+    QueryParameter<
+      Actions.token.getMetadata.ReturnValue,
+      Actions.token.getMetadata.ErrorType,
+      selectData,
+      Actions.token.getMetadata.QueryKey<config>
+    > &
+    ExactPartial<Actions.token.getMetadata.Parameters<config>>
 
   export type ReturnValue<selectData = Actions.token.getMetadata.ReturnValue> =
     UseQueryReturnType<selectData, Error>
@@ -1022,9 +1035,13 @@ export declare namespace useGetRoleAdmin {
     config extends Config = ResolvedRegister['config'],
     selectData = Actions.token.getRoleAdmin.ReturnValue,
   > = ConfigParameter<config> &
-    ExactPartial<
-      Actions.token.getRoleAdmin.queryOptions.Parameters<config, selectData>
-    >
+    QueryParameter<
+      Actions.token.getRoleAdmin.ReturnValue,
+      Actions.token.getRoleAdmin.ErrorType,
+      selectData,
+      Actions.token.getRoleAdmin.QueryKey<config>
+    > &
+    ExactPartial<Actions.token.getRoleAdmin.Parameters<config>>
 
   export type ReturnValue<selectData = Actions.token.getRoleAdmin.ReturnValue> =
     UseQueryReturnType<selectData, Error>
@@ -1209,9 +1226,13 @@ export declare namespace useHasRole {
     config extends Config = ResolvedRegister['config'],
     selectData = Actions.token.hasRole.ReturnValue,
   > = ConfigParameter<config> &
-    ExactPartial<
-      Actions.token.hasRole.queryOptions.Parameters<config, selectData>
-    >
+    QueryParameter<
+      Actions.token.hasRole.ReturnValue,
+      Actions.token.hasRole.ErrorType,
+      selectData,
+      Actions.token.hasRole.QueryKey<config>
+    > &
+    ExactPartial<Actions.token.hasRole.Parameters<config>>
 
   export type ReturnValue<selectData = Actions.token.hasRole.ReturnValue> =
     UseQueryReturnType<selectData, Error>

package/src/tempo/utils.ts

@@ -0,0 +1,16 @@
+import type * as Query from '@tanstack/react-query'
+import type { UnionLooseOmit } from '@wagmi/core/internal'
+
+export type QueryParameter<
+  queryFnData = unknown,
+  error = Query.DefaultError,
+  data = queryFnData,
+  queryKey extends Query.QueryKey = Query.QueryKey,
+> = {
+  query?:
+    | UnionLooseOmit<
+        Query.UseQueryOptions<queryFnData, error, data, queryKey>,
+        'queryKey' | 'queryFn'
+      >
+    | undefined
+}

package/src/utils/query.ts

@@ -1,5 +1,6 @@
 import {
   type DefaultError,
+  type MutateFunction,
   type QueryKey,
   useInfiniteQuery as tanstack_useInfiniteQuery,
   useQuery as tanstack_useQuery,
@@ -19,6 +20,8 @@ import type {
 } from '@wagmi/core/internal'
 import { hashFn } from '@wagmi/core/query'
 
+export { useMutation }
+
 export type UseMutationParameters<
   data = unknown,
   error = Error,
@@ -36,17 +39,36 @@ export type UseMutationReturnType<
   error = Error,
   variables = void,
   context = unknown,
+  mutate = MutateFunction,
+  mutateAsync = MutateFunction,
 > = Compute<
   UnionStrictOmit<
     UseMutationResult<data, error, variables, context>,
     'mutate' | 'mutateAsync'
-  >
+  > & {
+    mutate: mutate
+    mutateAsync: mutateAsync
+  }
 >
 
-export { useMutation }
-
 ////////////////////////////////////////////////////////////////////////////////
 
+// Adding some basic customization.
+// Ideally we don't have this function, but `import('@tanstack/react-query').useQuery` currently has some quirks where it is super hard to
+// pass down the inferred `initialData` type because of it's discriminated overload in the on `useQuery`.
+export function useQuery<queryFnData, error, data, queryKey extends QueryKey>(
+  parameters: UseQueryParameters<queryFnData, error, data, queryKey> & {
+    queryKey: QueryKey
+  },
+): UseQueryReturnType<data, error> {
+  const result = tanstack_useQuery({
+    ...(parameters as any),
+    queryKeyHashFn: hashFn, // for bigint support
+  }) as UseQueryReturnType<data, error>
+  result.queryKey = parameters.queryKey
+  return result
+}
+
 export type UseQueryParameters<
   queryFnData = unknown,
   error = DefaultError,
@@ -69,24 +91,27 @@ export type UseQueryReturnType<data = unknown, error = DefaultError> = Compute<
   }
 >
 
+////////////////////////////////////////////////////////////////////////////////
+
 // Adding some basic customization.
-// Ideally we don't have this function, but `import('@tanstack/react-query').useQuery` currently has some quirks where it is super hard to
-// pass down the inferred `initialData` type because of it's discriminated overload in the on `useQuery`.
-export function useQuery<queryFnData, error, data, queryKey extends QueryKey>(
-  parameters: UseQueryParameters<queryFnData, error, data, queryKey> & {
+export function useInfiniteQuery<
+  queryFnData,
+  error,
+  data,
+  queryKey extends QueryKey,
+>(
+  parameters: UseInfiniteQueryParameters<queryFnData, error, data, queryKey> & {
     queryKey: QueryKey
   },
-): UseQueryReturnType<data, error> {
-  const result = tanstack_useQuery({
+): UseInfiniteQueryReturnType<data, error> {
+  const result = tanstack_useInfiniteQuery({
     ...(parameters as any),
     queryKeyHashFn: hashFn, // for bigint support
-  }) as UseQueryReturnType<data, error>
+  }) as UseInfiniteQueryReturnType<data, error>
   result.queryKey = parameters.queryKey
   return result
 }
 
-////////////////////////////////////////////////////////////////////////////////
-
 export type UseInfiniteQueryParameters<
   queryFnData = unknown,
   error = DefaultError,
@@ -124,22 +149,3 @@ export type UseInfiniteQueryReturnType<
 > = UseInfiniteQueryResult<data, error> & {
   queryKey: QueryKey
 }
-
-// Adding some basic customization.
-export function useInfiniteQuery<
-  queryFnData,
-  error,
-  data,
-  queryKey extends QueryKey,
->(
-  parameters: UseInfiniteQueryParameters<queryFnData, error, data, queryKey> & {
-    queryKey: QueryKey
-  },
-): UseInfiniteQueryReturnType<data, error> {
-  const result = tanstack_useInfiniteQuery({
-    ...(parameters as any),
-    queryKeyHashFn: hashFn, // for bigint support
-  }) as UseInfiniteQueryReturnType<data, error>
-  result.queryKey = parameters.queryKey
-  return result
-}

package/src/version.ts

@@ -1 +1 @@
-export const version = '3.3.2'
+export const version = '3.4.0'