@wagmi/core 3.2.2 → 3.3.0

package/src/exports/query.ts

@@ -17,6 +17,8 @@ export {
   type ConnectData,
   type ConnectMutate,
   type ConnectMutateAsync,
+  type ConnectMutationOptions,
+  type ConnectOptions,
   type ConnectVariables,
   connectMutationOptions,
 } from '../query/connect.js'
@@ -25,6 +27,8 @@ export {
   type DeployContractData,
   type DeployContractMutate,
   type DeployContractMutateAsync,
+  type DeployContractMutationOptions,
+  type DeployContractOptions,
   type DeployContractVariables,
   deployContractMutationOptions,
 } from '../query/deployContract.js'
@@ -33,6 +37,8 @@ export {
   type DisconnectData,
   type DisconnectMutate,
   type DisconnectMutateAsync,
+  type DisconnectMutationOptions,
+  type DisconnectOptions,
   type DisconnectVariables,
   disconnectMutationOptions,
 } from '../query/disconnect.js'
@@ -77,6 +83,16 @@ export {
   getBalanceQueryOptions,
 } from '../query/getBalance.js'
 
+export {
+  type GetBlobBaseFeeData,
+  type GetBlobBaseFeeOptions,
+  type GetBlobBaseFeeQueryFnData,
+  type GetBlobBaseFeeQueryKey,
+  type GetBlobBaseFeeQueryOptions,
+  getBlobBaseFeeQueryKey,
+  getBlobBaseFeeQueryOptions,
+} from '../query/getBlobBaseFee.js'
+
 export {
   type GetBlockData,
   type GetBlockOptions,
@@ -147,6 +163,16 @@ export {
   getConnectorClientQueryOptions,
 } from '../query/getConnectorClient.js'
 
+export {
+  type GetContractEventsData,
+  type GetContractEventsOptions,
+  type GetContractEventsQueryFnData,
+  type GetContractEventsQueryKey,
+  type GetContractEventsQueryOptions,
+  getContractEventsQueryKey,
+  getContractEventsQueryOptions,
+} from '../query/getContractEvents.js'
+
 export {
   type GetEnsAddressData,
   type GetEnsAddressOptions,
@@ -330,6 +356,8 @@ export {
   type ReconnectData,
   type ReconnectMutate,
   type ReconnectMutateAsync,
+  type ReconnectMutationOptions,
+  type ReconnectOptions,
   type ReconnectVariables,
   reconnectMutationOptions,
 } from '../query/reconnect.js'
@@ -338,6 +366,8 @@ export {
   type SendCallsData,
   type SendCallsMutate,
   type SendCallsMutateAsync,
+  type SendCallsMutationOptions,
+  type SendCallsOptions,
   type SendCallsVariables,
   sendCallsMutationOptions,
 } from '../query/sendCalls.js'
@@ -346,6 +376,8 @@ export {
   type SendCallsSyncData,
   type SendCallsSyncMutate,
   type SendCallsSyncMutateAsync,
+  type SendCallsSyncMutationOptions,
+  type SendCallsSyncOptions,
   type SendCallsSyncVariables,
   sendCallsSyncMutationOptions,
 } from '../query/sendCallsSync.js'
@@ -354,6 +386,8 @@ export {
   type SendTransactionData,
   type SendTransactionMutate,
   type SendTransactionMutateAsync,
+  type SendTransactionMutationOptions,
+  type SendTransactionOptions,
   type SendTransactionVariables,
   sendTransactionMutationOptions,
 } from '../query/sendTransaction.js'
@@ -362,6 +396,8 @@ export {
   type SendTransactionSyncData,
   type SendTransactionSyncMutate,
   type SendTransactionSyncMutateAsync,
+  type SendTransactionSyncMutationOptions,
+  type SendTransactionSyncOptions,
   type SendTransactionSyncVariables,
   sendTransactionSyncMutationOptions,
 } from '../query/sendTransactionSync.js'
@@ -370,6 +406,8 @@ export {
   type ShowCallsStatusData,
   type ShowCallsStatusMutate,
   type ShowCallsStatusMutateAsync,
+  type ShowCallsStatusMutationOptions,
+  type ShowCallsStatusOptions,
   type ShowCallsStatusVariables,
   showCallsStatusMutationOptions,
 } from '../query/showCallsStatus.js'
@@ -378,6 +416,8 @@ export {
   type SignMessageData,
   type SignMessageMutate,
   type SignMessageMutateAsync,
+  type SignMessageMutationOptions,
+  type SignMessageOptions,
   type SignMessageVariables,
   signMessageMutationOptions,
 } from '../query/signMessage.js'
@@ -386,6 +426,8 @@ export {
   type SignTypedDataData,
   type SignTypedDataMutate,
   type SignTypedDataMutateAsync,
+  type SignTypedDataMutationOptions,
+  type SignTypedDataOptions,
   type SignTypedDataVariables,
   signTypedDataMutationOptions,
 } from '../query/signTypedData.js'
@@ -404,6 +446,8 @@ export {
   type SwitchChainData,
   type SwitchChainMutate,
   type SwitchChainMutateAsync,
+  type SwitchChainMutationOptions,
+  type SwitchChainOptions,
   type SwitchChainVariables,
   switchChainMutationOptions,
 } from '../query/switchChain.js'
@@ -418,6 +462,12 @@ export {
   /** @deprecated use `SwitchConnectionMutateAsync` instead */
   type SwitchConnectionMutateAsync as SwitchAccountMutateAsync,
   type SwitchConnectionMutateAsync,
+  /** @deprecated use `SwitchConnectionMutationOptions` instead */
+  type SwitchConnectionMutationOptions as SwitchAccountMutationOptions,
+  type SwitchConnectionMutationOptions,
+  /** @deprecated use `SwitchConnectionOptions` instead */
+  type SwitchConnectionOptions as SwitchAccountOptions,
+  type SwitchConnectionOptions,
   /** @deprecated use `SwitchConnectionVariables` instead */
   type SwitchConnectionVariables as SwitchAccountVariables,
   type SwitchConnectionVariables,
@@ -475,6 +525,8 @@ export {
   type WatchAssetData,
   type WatchAssetMutate,
   type WatchAssetMutateAsync,
+  type WatchAssetMutationOptions,
+  type WatchAssetOptions,
   type WatchAssetVariables,
   watchAssetMutationOptions,
 } from '../query/watchAsset.js'
@@ -483,6 +535,18 @@ export {
   type WriteContractData,
   type WriteContractMutate,
   type WriteContractMutateAsync,
+  type WriteContractMutationOptions,
+  type WriteContractOptions,
   type WriteContractVariables,
   writeContractMutationOptions,
 } from '../query/writeContract.js'
+
+export {
+  type WriteContractSyncData,
+  type WriteContractSyncMutate,
+  type WriteContractSyncMutateAsync,
+  type WriteContractSyncMutationOptions,
+  type WriteContractSyncOptions,
+  type WriteContractSyncVariables,
+  writeContractSyncMutationOptions,
+} from '../query/writeContractSync.js'

package/src/query/connect.ts

@@ -1,5 +1,4 @@
 import type { MutateOptions, MutationOptions } from '@tanstack/query-core'
-
 import {
   type ConnectErrorType,
   type ConnectParameters,
@@ -8,21 +7,38 @@ import {
 } from '../actions/connect.js'
 import type { CreateConnectorFn } from '../connectors/createConnector.js'
 import type { Config, Connector } from '../createConfig.js'
+import type { MutationParameter } from '../types/query.js'
 import type { Compute } from '../types/utils.js'
 
-export function connectMutationOptions<config extends Config>(config: config) {
+export type ConnectOptions<
+  config extends Config,
+  context = unknown,
+> = MutationParameter<
+  ConnectData<config, config['connectors'][number], boolean>,
+  ConnectErrorType,
+  ConnectVariables<config, config['connectors'][number], boolean>,
+  context
+>
+
+export function connectMutationOptions<config extends Config, context>(
+  config: config,
+  options: ConnectOptions<config, context> = {},
+): ConnectMutationOptions<config> {
   return {
-    mutationFn(variables) {
+    ...(options.mutation as any),
+    mutationFn: async (variables) => {
       return connect(config, variables)
     },
     mutationKey: ['connect'],
-  } as const satisfies MutationOptions<
-    ConnectData<config, Connector | CreateConnectorFn, boolean>,
-    ConnectErrorType,
-    ConnectVariables<config, Connector | CreateConnectorFn, boolean>
-  >
+  }
 }
 
+export type ConnectMutationOptions<config extends Config> = MutationOptions<
+  ConnectData<config, config['connectors'][number], boolean>,
+  ConnectErrorType,
+  ConnectVariables<config, config['connectors'][number], boolean>
+>
+
 export type ConnectData<
   config extends Config,
   connector extends Connector | CreateConnectorFn,

package/src/query/deployContract.ts

@@ -1,6 +1,5 @@
 import type { MutateOptions, MutationOptions } from '@tanstack/query-core'
 import type { Abi, ContractConstructorArgs } from 'viem'
-
 import {
   type DeployContractErrorType,
   type DeployContractParameters,
@@ -8,22 +7,38 @@ import {
   deployContract,
 } from '../actions/deployContract.js'
 import type { Config } from '../createConfig.js'
+import type { MutationParameter } from '../types/query.js'
 import type { Compute } from '../types/utils.js'
 
-export function deployContractMutationOptions<config extends Config>(
+export type DeployContractOptions<
+  config extends Config,
+  context = unknown,
+> = MutationParameter<
+  DeployContractData,
+  DeployContractErrorType,
+  DeployContractVariables<Abi, config, config['chains'][number]['id']>,
+  context
+>
+
+export function deployContractMutationOptions<config extends Config, context>(
   config: config,
-) {
+  options: DeployContractOptions<config, context> = {},
+): DeployContractMutationOptions<config> {
   return {
+    ...(options.mutation as any),
     mutationFn(variables) {
       return deployContract(config, variables)
     },
     mutationKey: ['deployContract'],
-  } as const satisfies MutationOptions<
+  }
+}
+
+export type DeployContractMutationOptions<config extends Config> =
+  MutationOptions<
     DeployContractData,
     DeployContractErrorType,
     DeployContractVariables<Abi, config, config['chains'][number]['id']>
   >
-}
 
 export type DeployContractData = Compute<DeployContractReturnType>
 

package/src/query/disconnect.ts

@@ -1,5 +1,4 @@
 import type { MutationOptions } from '@tanstack/query-core'
-
 import {
   type DisconnectErrorType,
   type DisconnectParameters,
@@ -7,23 +6,35 @@ import {
   disconnect,
 } from '../actions/disconnect.js'
 import type { Config } from '../createConfig.js'
+import type { MutationParameter } from '../types/query.js'
 import type { Mutate, MutateAsync } from './types.js'
 
-export function disconnectMutationOptions<config extends Config>(
+export type DisconnectOptions<context = unknown> = MutationParameter<
+  DisconnectData,
+  DisconnectErrorType,
+  DisconnectVariables,
+  context
+>
+
+export function disconnectMutationOptions<config extends Config, context>(
   config: config,
-) {
+  options: DisconnectOptions<context> = {},
+): DisconnectMutationOptions {
   return {
-    mutationFn(variables) {
+    ...(options.mutation as any),
+    mutationFn: async (variables) => {
       return disconnect(config, variables)
     },
     mutationKey: ['disconnect'],
-  } as const satisfies MutationOptions<
-    DisconnectData,
-    DisconnectErrorType,
-    DisconnectVariables
-  >
+  }
 }
 
+export type DisconnectMutationOptions = MutationOptions<
+  DisconnectData,
+  DisconnectErrorType,
+  DisconnectVariables
+>
+
 export type DisconnectData = DisconnectReturnType
 
 export type DisconnectVariables = DisconnectParameters | undefined

package/src/query/getBlobBaseFee.ts

@@ -0,0 +1,75 @@
+import {
+  type GetBlobBaseFeeErrorType,
+  type GetBlobBaseFeeParameters,
+  type GetBlobBaseFeeReturnType,
+  getBlobBaseFee,
+} from '../actions/getBlobBaseFee.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 GetBlobBaseFeeOptions<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+  selectData = GetBlobBaseFeeData,
+> = Compute<
+  ExactPartial<GetBlobBaseFeeParameters<config, chainId>> & ScopeKeyParameter
+> &
+  QueryParameter<
+    GetBlobBaseFeeQueryFnData,
+    GetBlobBaseFeeErrorType,
+    selectData,
+    GetBlobBaseFeeQueryKey<config, chainId>
+  >
+
+export function getBlobBaseFeeQueryOptions<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+  selectData = GetBlobBaseFeeData,
+>(
+  config: config,
+  options: GetBlobBaseFeeOptions<config, chainId, selectData> = {},
+): GetBlobBaseFeeQueryOptions<config, chainId, selectData> {
+  return {
+    ...options.query,
+    queryFn: async (context) => {
+      const [, { scopeKey: _, ...parameters }] = context.queryKey
+      const blobBaseFee = await getBlobBaseFee(config, parameters)
+      return blobBaseFee ?? null
+    },
+    queryKey: getBlobBaseFeeQueryKey(options),
+  }
+}
+
+export type GetBlobBaseFeeQueryFnData = GetBlobBaseFeeReturnType
+
+export type GetBlobBaseFeeData = GetBlobBaseFeeQueryFnData
+
+export function getBlobBaseFeeQueryKey<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+>(
+  options: Compute<
+    ExactPartial<GetBlobBaseFeeParameters<config, chainId>> & ScopeKeyParameter
+  > = {},
+) {
+  return ['blobBaseFee', filterQueryOptions(options)] as const
+}
+
+export type GetBlobBaseFeeQueryKey<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+> = ReturnType<typeof getBlobBaseFeeQueryKey<config, chainId>>
+
+export type GetBlobBaseFeeQueryOptions<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+  selectData = GetBlobBaseFeeData,
+> = QueryOptions<
+  GetBlobBaseFeeQueryFnData,
+  GetBlobBaseFeeErrorType,
+  selectData,
+  GetBlobBaseFeeQueryKey<config, chainId>
+>

package/src/query/getContractEvents.ts

@@ -0,0 +1,214 @@
+import type { Abi, BlockNumber, BlockTag, ContractEventName } from 'viem'
+import {
+  type GetContractEventsErrorType,
+  type GetContractEventsParameters,
+  type GetContractEventsReturnType,
+  getContractEvents,
+} from '../actions/getContractEvents.js'
+import type { Config } from '../createConfig.js'
+import type { ScopeKeyParameter } from '../types/properties.js'
+import type { QueryOptions, QueryParameter } from '../types/query.js'
+import type { UnionExactPartial } from '../types/utils.js'
+import { filterQueryOptions, structuralSharing } from './utils.js'
+
+export type GetContractEventsOptions<
+  abi extends Abi | readonly unknown[],
+  eventName extends ContractEventName<abi> | undefined,
+  strict extends boolean | undefined,
+  fromBlock extends BlockNumber | BlockTag | undefined,
+  toBlock extends BlockNumber | BlockTag | undefined,
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+  selectData = GetContractEventsData<
+    abi,
+    eventName,
+    strict,
+    fromBlock,
+    toBlock
+  >,
+> = UnionExactPartial<
+  GetContractEventsParameters<
+    abi,
+    eventName,
+    strict,
+    fromBlock,
+    toBlock,
+    config,
+    chainId
+  >
+> &
+  ScopeKeyParameter &
+  QueryParameter<
+    GetContractEventsQueryFnData<abi, eventName, strict, fromBlock, toBlock>,
+    GetContractEventsErrorType,
+    selectData,
+    GetContractEventsQueryKey<
+      config,
+      chainId,
+      abi,
+      eventName,
+      strict,
+      fromBlock,
+      toBlock
+    >
+  >
+
+export function getContractEventsQueryOptions<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+  const abi extends Abi | readonly unknown[],
+  eventName extends ContractEventName<abi> | undefined,
+  strict extends boolean | undefined = undefined,
+  fromBlock extends BlockNumber | BlockTag | undefined = undefined,
+  toBlock extends BlockNumber | BlockTag | undefined = undefined,
+  selectData = GetContractEventsData<
+    abi,
+    eventName,
+    strict,
+    fromBlock,
+    toBlock
+  >,
+>(
+  config: config,
+  options: GetContractEventsOptions<
+    abi,
+    eventName,
+    strict,
+    fromBlock,
+    toBlock,
+    config,
+    chainId,
+    selectData
+  > = {} as any,
+): GetContractEventsQueryOptions<
+  abi,
+  eventName,
+  strict,
+  fromBlock,
+  toBlock,
+  config,
+  chainId,
+  selectData
+> {
+  return {
+    ...options.query,
+    enabled: Boolean(options.abi && (options.query?.enabled ?? true)),
+    queryFn: async (context) => {
+      if (!options.abi) throw new Error('abi is required')
+      const [, { scopeKey: _, ...parameters }] = context.queryKey
+      const result = await getContractEvents(config, {
+        ...(parameters as any),
+        abi: options.abi,
+      })
+      return result as GetContractEventsData<
+        abi,
+        eventName,
+        strict,
+        fromBlock,
+        toBlock
+      >
+    },
+    queryKey: getContractEventsQueryKey(options as any) as any,
+    structuralSharing,
+  } as GetContractEventsQueryOptions<
+    abi,
+    eventName,
+    strict,
+    fromBlock,
+    toBlock,
+    config,
+    chainId,
+    selectData
+  >
+}
+
+export type GetContractEventsQueryFnData<
+  abi extends Abi | readonly unknown[],
+  eventName extends ContractEventName<abi> | undefined,
+  strict extends boolean | undefined,
+  fromBlock extends BlockNumber | BlockTag | undefined,
+  toBlock extends BlockNumber | BlockTag | undefined,
+> = GetContractEventsReturnType<abi, eventName, strict, fromBlock, toBlock>
+
+export type GetContractEventsData<
+  abi extends Abi | readonly unknown[],
+  eventName extends ContractEventName<abi> | undefined,
+  strict extends boolean | undefined,
+  fromBlock extends BlockNumber | BlockTag | undefined,
+  toBlock extends BlockNumber | BlockTag | undefined,
+> = GetContractEventsQueryFnData<abi, eventName, strict, fromBlock, toBlock>
+
+export function getContractEventsQueryKey<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+  const abi extends Abi | readonly unknown[],
+  eventName extends ContractEventName<abi> | undefined,
+  strict extends boolean | undefined = undefined,
+  fromBlock extends BlockNumber | BlockTag | undefined = undefined,
+  toBlock extends BlockNumber | BlockTag | undefined = undefined,
+>(
+  options: UnionExactPartial<
+    GetContractEventsParameters<
+      abi,
+      eventName,
+      strict,
+      fromBlock,
+      toBlock,
+      config,
+      chainId
+    >
+  > &
+    ScopeKeyParameter = {} as any,
+) {
+  return ['getContractEvents', filterQueryOptions(options)] as const
+}
+
+export type GetContractEventsQueryKey<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+  abi extends Abi | readonly unknown[],
+  eventName extends ContractEventName<abi> | undefined,
+  strict extends boolean | undefined,
+  fromBlock extends BlockNumber | BlockTag | undefined,
+  toBlock extends BlockNumber | BlockTag | undefined,
+> = ReturnType<
+  typeof getContractEventsQueryKey<
+    config,
+    chainId,
+    abi,
+    eventName,
+    strict,
+    fromBlock,
+    toBlock
+  >
+>
+
+export type GetContractEventsQueryOptions<
+  abi extends Abi | readonly unknown[],
+  eventName extends ContractEventName<abi> | undefined,
+  strict extends boolean | undefined,
+  fromBlock extends BlockNumber | BlockTag | undefined,
+  toBlock extends BlockNumber | BlockTag | undefined,
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+  selectData = GetContractEventsData<
+    abi,
+    eventName,
+    strict,
+    fromBlock,
+    toBlock
+  >,
+> = QueryOptions<
+  GetContractEventsQueryFnData<abi, eventName, strict, fromBlock, toBlock>,
+  GetContractEventsErrorType,
+  selectData,
+  GetContractEventsQueryKey<
+    config,
+    chainId,
+    abi,
+    eventName,
+    strict,
+    fromBlock,
+    toBlock
+  >
+>

package/src/query/readContracts.ts

@@ -92,14 +92,24 @@ export function readContractsQueryKey<
     ChainIdParameter<config> = {},
 ) {
   const contracts = []
+  let hasContractWithoutChainId = false
   for (const contract of (options.contracts ??
     []) as (ContractFunctionParameters & { chainId: number })[]) {
     const { abi: _, ...rest } = contract
-    contracts.push({ ...rest, chainId: rest.chainId ?? options.chainId })
+    if (rest.chainId === undefined) hasContractWithoutChainId = true
+    const chainId = rest.chainId ?? options.chainId
+    contracts.push({ ...rest, ...(chainId ? { chainId } : {}) })
   }
+  const { chainId: _, ...rest } = options
   return [
     'readContracts',
-    filterQueryOptions({ ...options, contracts }),
+    filterQueryOptions({
+      ...rest,
+      ...(hasContractWithoutChainId && options.chainId
+        ? { chainId: options.chainId }
+        : {}),
+      contracts,
+    }),
   ] as const
 }
 

package/src/query/reconnect.ts

@@ -1,5 +1,4 @@
 import type { MutationOptions } from '@tanstack/query-core'
-
 import {
   type ReconnectErrorType,
   type ReconnectParameters,
@@ -7,22 +6,36 @@ import {
   reconnect,
 } from '../actions/reconnect.js'
 import type { Config } from '../createConfig.js'
+import type { MutationParameter } from '../types/query.js'
 import type { Compute } from '../types/utils.js'
 import type { Mutate, MutateAsync } from './types.js'
 
-export function reconnectMutationOptions(config: Config) {
+export type ReconnectOptions<context = unknown> = MutationParameter<
+  ReconnectData,
+  ReconnectErrorType,
+  ReconnectVariables,
+  context
+>
+
+export function reconnectMutationOptions<context>(
+  config: Config,
+  options: ReconnectOptions<context> = {},
+): ReconnectMutationOptions {
   return {
+    ...(options.mutation as any),
     mutationFn(variables) {
       return reconnect(config, variables)
     },
     mutationKey: ['reconnect'],
-  } as const satisfies MutationOptions<
-    ReconnectData,
-    ReconnectErrorType,
-    ReconnectVariables
-  >
+  }
 }
 
+export type ReconnectMutationOptions = MutationOptions<
+  ReconnectData,
+  ReconnectErrorType,
+  ReconnectVariables
+>
+
 export type ReconnectData = Compute<ReconnectReturnType>
 
 export type ReconnectVariables = ReconnectParameters | undefined