@wagmi/core 2.0.0-alpha.0 → 2.0.0-alpha.1

package/query/package.json

@@ -0,0 +1,5 @@
+{
+  "type": "module",
+  "types": "../dist/types/exports/query.d.ts",
+  "main": "../dist/esm/exports/query.js"
+}

package/src/actions/getBlock.ts

@@ -0,0 +1,63 @@
+import type { BlockTag, Chain } from 'viem'
+import {
+  type GetBlockParameters as viem_GetBlockParameters,
+  type GetBlockReturnType as viem_GetBlockReturnType,
+  getBlock as viem_getBlock,
+} from 'viem/actions'
+
+import { type Config } from '../createConfig.js'
+import type { SelectChains } from '../types/chain.js'
+import type { ChainIdParameter } from '../types/properties.js'
+import type { Evaluate } from '../types/utils.js'
+
+export type GetBlockParameters<
+  includeTransactions extends boolean = false,
+  blockTag extends BlockTag = 'latest',
+  config extends Config = Config,
+  chainId extends
+    | config['chains'][number]['id'] = config['chains'][number]['id'],
+> = Evaluate<
+  viem_GetBlockParameters<includeTransactions, blockTag> &
+    ChainIdParameter<config, chainId>
+>
+
+export type GetBlockReturnType<
+  includeTransactions extends boolean = false,
+  blockTag extends BlockTag = 'latest',
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  ///
+  chains extends readonly Chain[] = SelectChains<config, chainId>,
+> = Evaluate<
+  {
+    [key in keyof chains]: viem_GetBlockReturnType<
+      chains[key],
+      includeTransactions,
+      blockTag
+    >
+  }[number]
+>
+
+export type GetBlockError = Error
+
+/** https://alpha.wagmi.sh/core/actions/getBlock */
+export function getBlock<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+  includeTransactions extends boolean = false,
+  blockTag extends BlockTag = 'latest',
+>(
+  config: config,
+  parameters: GetBlockParameters<
+    includeTransactions,
+    blockTag,
+    config,
+    chainId
+  > = {},
+): Promise<GetBlockReturnType<includeTransactions, blockTag, config, chainId>> {
+  const { chainId } = parameters
+  const client = config.getClient({ chainId })
+  return viem_getBlock(client, parameters) as {} as Promise<
+    GetBlockReturnType<includeTransactions, blockTag, config, chainId>
+  >
+}

package/src/actions/getBlockNumber.ts

@@ -8,18 +8,22 @@ import { type Config } from '../createConfig.js'
 import type { ChainIdParameter } from '../types/properties.js'
 import type { Evaluate } from '../types/utils.js'
 
-export type GetBlockNumberParameters<config extends Config = Config> = Evaluate<
-  viem_GetBlockNumberParameters & ChainIdParameter<config>
->
+export type GetBlockNumberParameters<
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+> = Evaluate<viem_GetBlockNumberParameters & ChainIdParameter<config, chainId>>
 
 export type GetBlockNumberReturnType = viem_GetBlockNumberReturnType
 
 export type GetBlockNumberError = Error
 
 /** https://alpha.wagmi.sh/core/api/actions/getBlockNumber */
-export function getBlockNumber<config extends Config>(
+export function getBlockNumber<
+  config extends Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+>(
   config: config,
-  parameters: GetBlockNumberParameters<config> = {},
+  parameters: GetBlockNumberParameters<config, chainId> = {},
 ): Promise<GetBlockNumberReturnType> {
   const { chainId } = parameters
   const client = config.getClient({ chainId })

package/src/actions/signTypedData.ts

@@ -12,7 +12,14 @@ import { getConnectorClient } from './getConnectorClient.js'
 export type SignTypedDataParameters<
   typedData extends TypedData | Record<string, unknown> = TypedData,
   primaryType extends keyof typedData | 'EIP712Domain' = keyof typedData,
-> = viem_SignTypedDataParameters<typedData, primaryType, Account> &
+  ///
+  primaryTypes = typedData extends TypedData ? keyof typedData : string,
+> = viem_SignTypedDataParameters<
+  typedData,
+  primaryType,
+  Account,
+  primaryTypes
+> &
   ConnectorParameter
 
 export type SignTypedDataReturnType = viem_SignTypedDataReturnType

package/src/actions/watchBlocks.ts

@@ -0,0 +1,90 @@
+import {
+  type WatchBlocksParameters as viem_WatchBlocksParameters,
+  type WatchBlocksReturnType as viem_WatchBlocksReturnType,
+  watchBlocks as viem_watchBlocks,
+} from 'viem/actions'
+
+import type { BlockTag, Chain, Transport, WebSocketTransport } from 'viem'
+import { type Config } from '../createConfig.js'
+import type { SelectChains } from '../types/chain.js'
+import type {
+  ChainIdParameter,
+  SyncConnectedChainParameter,
+} from '../types/properties.js'
+import type { UnionEvaluate } from '../types/utils.js'
+
+export type WatchBlocksParameters<
+  includeTransactions extends boolean = false,
+  blockTag extends BlockTag = 'latest',
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  ///
+  chains extends readonly Chain[] = SelectChains<config, chainId>,
+> = {
+  [key in keyof chains]: UnionEvaluate<
+    viem_WatchBlocksParameters<
+      config['_internal']['transports'][chains[key]['id']] extends infer transport extends Transport
+        ? Transport extends transport
+          ? WebSocketTransport
+          : transport
+        : WebSocketTransport,
+      chains[key],
+      includeTransactions,
+      blockTag
+    > &
+      ChainIdParameter<config, chainId> &
+      SyncConnectedChainParameter
+  >
+}[number]
+
+export type WatchBlocksReturnType = viem_WatchBlocksReturnType
+
+// TODO: wrap in viem's `observe` to avoid duplicate invocations.
+/** https://alpha.wagmi.sh/core/actions/watchBlocks */
+export function watchBlocks<
+  config extends Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  includeTransactions extends boolean = false,
+  blockTag extends BlockTag = 'latest',
+>(
+  config: config,
+  parameters: WatchBlocksParameters<
+    includeTransactions,
+    blockTag,
+    config,
+    chainId
+  >,
+): WatchBlocksReturnType {
+  const { syncConnectedChain = config._internal.syncConnectedChain, ...rest } =
+    parameters
+
+  let unwatch: WatchBlocksReturnType | undefined
+  const listener = (chainId: number | undefined) => {
+    if (unwatch) unwatch()
+
+    const client = config.getClient({ chainId })
+    unwatch = viem_watchBlocks(
+      client,
+      rest as unknown as viem_WatchBlocksParameters,
+    )
+    return unwatch
+  }
+
+  // set up listener for block number changes
+  const unlisten = listener(parameters.chainId)
+
+  // set up subscriber for connected chain changes
+  let unsubscribe: (() => void) | undefined
+  if (syncConnectedChain && !parameters.chainId)
+    unsubscribe = config.subscribe(
+      ({ chainId }) => chainId,
+      async (chainId) => {
+        return listener(chainId)
+      },
+    )
+
+  return () => {
+    unlisten?.()
+    unsubscribe?.()
+  }
+}

package/src/actions/writeContract.ts

@@ -37,6 +37,7 @@ export type WriteContractParameters<
   config extends Config = Config,
   chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
   ///
+  allFunctionNames = ContractFunctionName<abi, 'nonpayable' | 'payable'>,
   chains extends readonly Chain[] = SelectChains<config, chainId>,
 > = {
   [key in keyof chains]: UnionOmit<
@@ -46,7 +47,8 @@ export type WriteContractParameters<
       args,
       chains[key],
       Account,
-      chains[key]
+      chains[key],
+      allFunctionNames
     >,
     'chain'
   >

package/src/exports/index.ts

@@ -52,6 +52,13 @@ export {
   getBalance,
 } from '../actions/getBalance.js'
 
+export {
+  type GetBlockError,
+  type GetBlockParameters,
+  type GetBlockReturnType,
+  getBlock,
+} from '../actions/getBlock.js'
+
 export {
   type GetBlockNumberError,
   type GetBlockNumberParameters,
@@ -212,6 +219,12 @@ export {
   watchAccount,
 } from '../actions/watchAccount.js'
 
+export {
+  type WatchBlocksParameters,
+  type WatchBlocksReturnType,
+  watchBlocks,
+} from '../actions/watchBlocks.js'
+
 export {
   type WatchBlockNumberParameters,
   type WatchBlockNumberReturnType,

package/src/exports/internal.ts

@@ -17,6 +17,7 @@ export {
   type Omit,
   type OneOf,
   type UnionEvaluate,
+  type UnionOmit,
   type UnionPartial,
 } from '../types/utils.js'
 

package/src/exports/query.ts

@@ -44,6 +44,15 @@ export {
   getBalanceQueryOptions,
 } from '../query/getBalance.js'
 
+export {
+  type GetBlockData,
+  type GetBlockOptions,
+  type GetBlockQueryFnData,
+  type GetBlockQueryKey,
+  getBlockQueryKey,
+  getBlockQueryOptions,
+} from '../query/getBlock.js'
+
 export {
   type GetBlockNumberData,
   type GetBlockNumberOptions,

package/src/query/getBlock.ts

@@ -0,0 +1,80 @@
+import { type QueryOptions } from '@tanstack/query-core'
+import type { BlockTag } from 'viem'
+
+import {
+  type GetBlockError,
+  type GetBlockParameters,
+  type GetBlockReturnType,
+  getBlock,
+} from '../actions/getBlock.js'
+import type { Config } from '../createConfig.js'
+import type { Evaluate, ExactPartial } from '../types/utils.js'
+import type { ScopeKeyParameter } from './types.js'
+import { filterQueryOptions } from './utils.js'
+
+export type GetBlockOptions<
+  includeTransactions extends boolean,
+  blockTag extends BlockTag,
+  config extends Config,
+  chainId extends
+    | config['chains'][number]['id'] = config['chains'][number]['id'],
+> = Evaluate<
+  ExactPartial<
+    GetBlockParameters<includeTransactions, blockTag, config, chainId>
+  > &
+    ScopeKeyParameter
+>
+
+export function getBlockQueryOptions<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+  includeTransactions extends boolean = false,
+  blockTag extends BlockTag = 'latest',
+>(
+  config: config,
+  options: GetBlockOptions<includeTransactions, blockTag, config, chainId> = {},
+) {
+  return {
+    async queryFn({ queryKey }) {
+      const { scopeKey: _, ...parameters } = queryKey[1]
+      const block = await getBlock(config, parameters)
+      return block ?? null
+    },
+    queryKey: getBlockQueryKey(options),
+  } as const satisfies QueryOptions<
+    GetBlockQueryFnData,
+    GetBlockError,
+    GetBlockData,
+    GetBlockQueryKey<includeTransactions, blockTag, config, chainId>
+  >
+}
+
+export type GetBlockQueryFnData<
+  includeTransactions extends boolean = false,
+  blockTag extends BlockTag = 'latest',
+> = GetBlockReturnType<includeTransactions, blockTag>
+
+export type GetBlockData<
+  includeTransactions extends boolean = false,
+  blockTag extends BlockTag = 'latest',
+> = GetBlockQueryFnData<includeTransactions, blockTag>
+
+export function getBlockQueryKey<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+  includeTransactions extends boolean = false,
+  blockTag extends BlockTag = 'latest',
+>(
+  options: GetBlockOptions<includeTransactions, blockTag, config, chainId> = {},
+) {
+  return ['block', filterQueryOptions(options)] as const
+}
+
+export type GetBlockQueryKey<
+  includeTransactions extends boolean,
+  blockTag extends BlockTag,
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+> = ReturnType<
+  typeof getBlockQueryKey<config, chainId, includeTransactions, blockTag>
+>

package/src/query/getBlockNumber.ts

@@ -11,14 +11,17 @@ import type { Evaluate, ExactPartial } from '../types/utils.js'
 import type { ScopeKeyParameter } from './types.js'
 import { filterQueryOptions } from './utils.js'
 
-export type GetBlockNumberOptions<config extends Config> = Evaluate<
-  ExactPartial<GetBlockNumberParameters<config>> & ScopeKeyParameter
+export type GetBlockNumberOptions<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+> = Evaluate<
+  ExactPartial<GetBlockNumberParameters<config, chainId>> & ScopeKeyParameter
 >
 
-export function getBlockNumberQueryOptions<config extends Config>(
-  config: config,
-  options: GetBlockNumberOptions<config> = {},
-) {
+export function getBlockNumberQueryOptions<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+>(config: config, options: GetBlockNumberOptions<config, chainId> = {}) {
   return {
     gcTime: 0,
     async queryFn({ queryKey }) {
@@ -31,7 +34,7 @@ export function getBlockNumberQueryOptions<config extends Config>(
     GetBlockNumberQueryFnData,
     GetBlockNumberError,
     GetBlockNumberData,
-    GetBlockNumberQueryKey<config>
+    GetBlockNumberQueryKey<config, chainId>
   >
 }
 
@@ -39,12 +42,14 @@ export type GetBlockNumberQueryFnData = GetBlockNumberReturnType
 
 export type GetBlockNumberData = GetBlockNumberQueryFnData
 
-export function getBlockNumberQueryKey<config extends Config>(
-  options: GetBlockNumberOptions<config> = {},
-) {
+export function getBlockNumberQueryKey<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+>(options: GetBlockNumberOptions<config, chainId> = {}) {
   return ['blockNumber', filterQueryOptions(options)] as const
 }
 
-export type GetBlockNumberQueryKey<config extends Config> = ReturnType<
-  typeof getBlockNumberQueryKey<config>
->
+export type GetBlockNumberQueryKey<
+  config extends Config,
+  chainId extends config['chains'][number]['id'],
+> = ReturnType<typeof getBlockNumberQueryKey<config, chainId>>

package/src/query/getConnectorClient.ts

@@ -24,6 +24,7 @@ export function getConnectorClientQueryOptions<
   chainId extends config['chains'][number]['id'],
 >(config: config, options: GetConnectorClientOptions<config, chainId> = {}) {
   return {
+    gcTime: 0,
     async queryFn({ queryKey }) {
       const { connector } = options
       const { connectorUid: _, scopeKey: _s, ...parameters } = queryKey[1]

package/src/query/getWalletClient.ts

@@ -23,6 +23,7 @@ export function getWalletClientQueryOptions<
   chainId extends config['chains'][number]['id'],
 >(config: config, options: GetWalletClientOptions<config, chainId> = {}) {
   return {
+    gcTime: 0,
     async queryFn({ queryKey }) {
       const { connector } = options
       const { connectorUid: _, scopeKey: _s, ...parameters } = queryKey[1]

package/src/query/signTypedData.ts

@@ -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>,
@@ -41,7 +43,12 @@ export type SignTypedDataMutate<context = unknown> = <
     | MutateOptions<
         SignTypedDataData,
         SignTypedDataError,
-        SignTypedDataVariables<typedData, primaryType>,
+        SignTypedDataVariables<
+          typedData,
+          primaryType,
+          // use `primaryType` to make sure it's not union of all possible primary types
+          primaryType
+        >,
         context
       >
     | undefined,
@@ -56,7 +63,12 @@ export type SignTypedDataMutateAsync<context = unknown> = <
     | MutateOptions<
         SignTypedDataData,
         SignTypedDataError,
-        SignTypedDataVariables<typedData, primaryType>,
+        SignTypedDataVariables<
+          typedData,
+          primaryType,
+          // use `primaryType` to make sure it's not union of all possible primary types
+          primaryType
+        >,
         context
       >
     | undefined,

package/src/query/writeContract.ts

@@ -43,7 +43,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[],
@@ -60,7 +69,15 @@ export type WriteContractMutate<config extends Config, context = unknown> = <
     | MutateOptions<
         WriteContractData,
         WriteContractError,
-        WriteContractVariables<abi, functionName, args, config, chainId>,
+        WriteContractVariables<
+          abi,
+          functionName,
+          args,
+          config,
+          chainId,
+          // use `functionName` to make sure it's not union of all possible function names
+          functionName
+        >,
         context
       >
     | undefined,
@@ -84,7 +101,15 @@ export type WriteContractMutateAsync<
     | MutateOptions<
         WriteContractData,
         WriteContractError,
-        WriteContractVariables<abi, functionName, args, config, chainId>,
+        WriteContractVariables<
+          abi,
+          functionName,
+          args,
+          config,
+          chainId,
+          // use `functionName` to make sure it's not union of all possible function names
+          functionName
+        >,
         context
       >
     | undefined,

package/src/types/utils.ts

@@ -37,6 +37,14 @@ export type Mutable<type extends object> = {
   -readonly [key in keyof type]: type[key]
 }
 
+/**
+ * Use to prevent a usage of type from being inferred in other generics.
+
+ * @see https://github.com/pelotom/type-zoo/#noinfert
+ * @see https://github.com/Microsoft/TypeScript/issues/14829#issuecomment-322267089
+ */
+export type NoInfer<type> = type & { [key in keyof type]: type[key] }
+
 /** Strict version of built-in Omit type */
 export type Omit<type, keys extends keyof type> = Pick<
   type,

package/src/version.ts

@@ -1 +1 @@
-export const version = '2.0.0-alpha.0'
+export const version = '2.0.0-alpha.1'