@wagmi/core 2.0.0 → 2.0.2

package/src/actions/switchAccount.ts

@@ -1,7 +1,11 @@
-import type { Address } from 'viem'
+import { type Address } from 'viem'
 
 import { type Config, type Connector } from '../createConfig.js'
-import { ConnectorNotConnectedError } from '../errors/config.js'
+import type { BaseError, ErrorType } from '../errors/base.js'
+import {
+  ConnectorNotConnectedError,
+  type ConnectorNotConnectedErrorType,
+} from '../errors/config.js'
 
 export type SwitchAccountParameters = {
   connector: Connector
@@ -14,14 +18,18 @@ export type SwitchAccountReturnType<config extends Config = Config> = {
     | (number extends config['chains'][number]['id'] ? number : number & {})
 }
 
-export type SwitchAccountError = ConnectorNotConnectedError | Error
+export type SwitchAccountErrorType =
+  | ConnectorNotConnectedErrorType
+  | BaseError
+  | ErrorType
 
-/** https://alpha.wagmi.sh/core/api/actions/switchAccount */
+/** https://wagmi.sh/core/api/actions/switchAccount */
 export async function switchAccount<config extends Config>(
   config: config,
   parameters: SwitchAccountParameters,
 ): Promise<SwitchAccountReturnType<config>> {
   const { connector } = parameters
+
   const connection = config.state.connections.get(connector.uid)
   if (!connection) throw new ConnectorNotConnectedError()
 

package/src/actions/switchChain.ts

@@ -1,23 +1,29 @@
 import {
-  SwitchChainError as SwitchChainError_,
-  UserRejectedRequestError,
+  type SwitchChainErrorType as viem_SwitchChainErrorType,
+  type UserRejectedRequestErrorType,
 } from 'viem'
 
 import { type Config } from '../createConfig.js'
-import type { BaseError } from '../errors/base.js'
-import { ChainNotConfiguredError } from '../errors/config.js'
-import { SwitchChainNotSupportedError } from '../errors/connector.js'
-import { type ProviderNotFoundError } from '../errors/connector.js'
+import type { BaseErrorType, ErrorType } from '../errors/base.js'
+import {
+  ChainNotConfiguredError,
+  type ChainNotConfiguredErrorType,
+} from '../errors/config.js'
+import {
+  type ProviderNotFoundErrorType,
+  SwitchChainNotSupportedError,
+  type SwitchChainNotSupportedErrorType,
+} from '../errors/connector.js'
 import type { ConnectorParameter } from '../types/properties.js'
-import type { Evaluate } from '../types/utils.js'
+import { type Evaluate } from '../types/utils.js'
 
 export type SwitchChainParameters<
   config extends Config = Config,
   chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
 > = Evaluate<
-  {
+  ConnectorParameter & {
     chainId: chainId | config['chains'][number]['id']
-  } & ConnectorParameter
+  }
 >
 
 export type SwitchChainReturnType<
@@ -28,14 +34,19 @@ export type SwitchChainReturnType<
   { id: Config extends config ? number : chainId }
 >
 
-export type SwitchChainError =
-  | ProviderNotFoundError
-  | SwitchChainError_
-  | UserRejectedRequestError
-  | BaseError
-  | Error
+export type SwitchChainErrorType =
+  | SwitchChainNotSupportedErrorType
+  | ChainNotConfiguredErrorType
+  // connector.switchChain()
+  | ProviderNotFoundErrorType
+  | UserRejectedRequestErrorType
+  // base
+  | BaseErrorType
+  | ErrorType
+  // viem
+  | viem_SwitchChainErrorType
 
-/** https://alpha.wagmi.sh/core/api/actions/switchChain */
+/** https://wagmi.sh/core/api/actions/switchChain */
 export async function switchChain<
   config extends Config,
   chainId extends config['chains'][number]['id'],

package/src/actions/verifyMessage.ts

@@ -0,0 +1,28 @@
+import {
+  type VerifyMessageErrorType as viem_VerifyMessageErrorType,
+  type VerifyMessageParameters as viem_VerifyMessageParameters,
+  type VerifyMessageReturnType as viem_VerifyMessageReturnType,
+  verifyMessage as viem_verifyMessage,
+} from 'viem/actions'
+
+import { type Config } from '../createConfig.js'
+import { type ChainIdParameter } from '../types/properties.js'
+import { type Evaluate } from '../types/utils.js'
+
+export type VerifyMessageParameters<config extends Config = Config> = Evaluate<
+  viem_VerifyMessageParameters & ChainIdParameter<config>
+>
+
+export type VerifyMessageReturnType = viem_VerifyMessageReturnType
+
+export type VerifyMessageErrorType = viem_VerifyMessageErrorType
+
+/** https://wagmi.sh/core/api/actions/verifyMessage */
+export async function verifyMessage<config extends Config>(
+  config: config,
+  parameters: VerifyMessageParameters<config>,
+): Promise<VerifyMessageReturnType> {
+  const { chainId, ...rest } = parameters
+  const client = config.getClient({ chainId })
+  return viem_verifyMessage(client, rest)
+}

package/src/actions/verifyTypedData.ts

@@ -0,0 +1,38 @@
+import { type TypedData } from 'viem'
+import {
+  type VerifyTypedDataErrorType as viem_VerifyTypedDataErrorType,
+  type VerifyTypedDataParameters as viem_VerifyTypedDataParameters,
+  type VerifyTypedDataReturnType as viem_VerifyTypedDataReturnType,
+  verifyTypedData as viem_verifyTypedData,
+} from 'viem/actions'
+
+import { type Config } from '../createConfig.js'
+import { type ChainIdParameter } from '../types/properties.js'
+import { type Evaluate } from '../types/utils.js'
+
+export type VerifyTypedDataParameters<
+  typedData extends TypedData | Record<string, unknown> = TypedData,
+  primaryType extends keyof typedData | 'EIP712Domain' = keyof typedData,
+  config extends Config = Config,
+> = Evaluate<
+  viem_VerifyTypedDataParameters<typedData, primaryType> &
+    ChainIdParameter<config>
+>
+
+export type VerifyTypedDataReturnType = viem_VerifyTypedDataReturnType
+
+export type VerifyTypedDataErrorType = viem_VerifyTypedDataErrorType
+
+/** https://wagmi.sh/core/api/actions/verifyTypedData */
+export async function verifyTypedData<
+  config extends Config,
+  const typedData extends TypedData | Record<string, unknown>,
+  primaryType extends keyof typedData | 'EIP712Domain',
+>(
+  config: config,
+  parameters: VerifyTypedDataParameters<typedData, primaryType, config>,
+): Promise<VerifyTypedDataReturnType> {
+  const { chainId, ...rest } = parameters
+  const client = config.getClient({ chainId })
+  return viem_verifyTypedData(client, rest as viem_VerifyTypedDataParameters)
+}

package/src/actions/waitForTransactionReceipt.ts

@@ -1,20 +1,18 @@
-import type {
-  CallParameters,
-  Chain,
-  WaitForTransactionReceiptParameters as viem_WaitForTransactionReceiptParameters,
-  WaitForTransactionReceiptReturnType as viem_WaitForTransactionReceiptReturnType,
-} from 'viem'
+import type { CallParameters, Chain } from 'viem'
 import { hexToString } from 'viem'
 import {
+  type WaitForTransactionReceiptErrorType as viem_WaitForTransactionReceiptErrorType,
+  type WaitForTransactionReceiptParameters as viem_WaitForTransactionReceiptParameters,
+  type WaitForTransactionReceiptReturnType as viem_WaitForTransactionReceiptReturnType,
   call,
   getTransaction,
   waitForTransactionReceipt as viem_waitForTransactionReceipt,
 } from 'viem/actions'
 
-import type { Config } from '../createConfig.js'
+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'
+import { type ChainIdParameter } from '../types/properties.js'
+import { type Evaluate, type IsNarrowable } from '../types/utils.js'
 
 export type WaitForTransactionReceiptParameters<
   config extends Config = Config,
@@ -30,11 +28,14 @@ export type WaitForTransactionReceiptReturnType<
   chains extends readonly Chain[] = SelectChains<config, chainId>,
 > = Evaluate<
   {
-    [key in keyof chains]: viem_WaitForTransactionReceiptReturnType<chains[key]>
+    [key in keyof chains]: viem_WaitForTransactionReceiptReturnType<
+      IsNarrowable<chains[key], Chain> extends true ? chains[key] : undefined
+    > & { chainId: chains[key]['id'] }
   }[number]
 >
 
-export type WaitForTransactionReceiptError = Error
+export type WaitForTransactionReceiptErrorType =
+  viem_WaitForTransactionReceiptErrorType
 
 export async function waitForTransactionReceipt<
   config extends Config,
@@ -44,12 +45,13 @@ export async function waitForTransactionReceipt<
   parameters: WaitForTransactionReceiptParameters<config, chainId>,
 ): Promise<WaitForTransactionReceiptReturnType<config, chainId>> {
   const { chainId, timeout = 0, ...rest } = parameters
-  const client = config.getClient({ chainId })
 
+  const client = config.getClient({ chainId })
   const receipt = await viem_waitForTransactionReceipt(client, {
     ...rest,
     timeout,
   })
+
   if (receipt.status === 'reverted') {
     const txn = await getTransaction(client, { hash: receipt.transactionHash })
     const code = (await call(client, {
@@ -62,8 +64,12 @@ export async function waitForTransactionReceipt<
     const reason = hexToString(`0x${code.substring(138)}`)
     throw new Error(reason)
   }
-  return receipt as unknown as WaitForTransactionReceiptReturnType<
-    config,
-    chainId
-  >
+
+  return {
+    ...(receipt as unknown as WaitForTransactionReceiptReturnType<
+      config,
+      chainId
+    >),
+    chainId: client.chain.id,
+  }
 }

package/src/actions/watchAccount.ts

@@ -11,12 +11,13 @@ export type WatchAccountParameters = {
 
 export type WatchAccountReturnType = () => void
 
-/** https://alpha.wagmi.sh/core/api/actions/watchAccount */
+/** https://wagmi.sh/core/api/actions/watchAccount */
 export function watchAccount(
   config: Config,
   parameters: WatchAccountParameters,
 ): WatchAccountReturnType {
   const { onChange } = parameters
+
   return config.subscribe(() => getAccount(config), onChange, {
     equalityFn(a, b) {
       const { connector: aConnector, ...aRest } = a

package/src/actions/watchBlockNumber.ts

@@ -35,7 +35,7 @@ export type WatchBlockNumberParameters<
 export type WatchBlockNumberReturnType = viem_WatchBlockNumberReturnType
 
 // TODO: wrap in viem's `observe` to avoid duplicate invocations.
-/** https://alpha.wagmi.sh/core/api/actions/watchBlockNumber */
+/** https://wagmi.sh/core/api/actions/watchBlockNumber */
 export function watchBlockNumber<
   config extends Config,
   chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
@@ -44,7 +44,7 @@ export function watchBlockNumber<
   parameters: WatchBlockNumberParameters<config, chainId>,
 ): WatchBlockNumberReturnType {
   const { syncConnectedChain = config._internal.syncConnectedChain, ...rest } =
-    parameters
+    parameters as WatchBlockNumberParameters
 
   let unwatch: WatchBlockNumberReturnType | undefined
   const listener = (chainId: number | undefined) => {
@@ -53,7 +53,7 @@ export function watchBlockNumber<
     const client = config.getClient({ chainId })
     unwatch = viem_watchBlockNumber(
       client,
-      rest as unknown as viem_WatchBlockNumberParameters,
+      rest as viem_WatchBlockNumberParameters,
     )
     return unwatch
   }
@@ -66,9 +66,7 @@ export function watchBlockNumber<
   if (syncConnectedChain && !parameters.chainId)
     unsubscribe = config.subscribe(
       ({ chainId }) => chainId,
-      async (chainId) => {
-        return listener(chainId)
-      },
+      async (chainId) => listener(chainId),
     )
 
   return () => {

package/src/actions/watchBlocks.ts

@@ -0,0 +1,85 @@
+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 { IsNarrowable, 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,
+      IsNarrowable<chains[key], Chain> extends true ? chains[key] : undefined,
+      includeTransactions,
+      blockTag
+    > &
+      ChainIdParameter<config, chainId> &
+      SyncConnectedChainParameter
+  >
+}[number]
+
+export type WatchBlocksReturnType = viem_WatchBlocksReturnType
+
+// TODO: wrap in viem's `observe` to avoid duplicate invocations.
+/** https://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 as WatchBlocksParameters
+
+  let unwatch: WatchBlocksReturnType | undefined
+  const listener = (chainId: number | undefined) => {
+    if (unwatch) unwatch()
+
+    const client = config.getClient({ chainId })
+    unwatch = viem_watchBlocks(client, rest 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) => listener(chainId),
+    )
+
+  return () => {
+    unlisten?.()
+    unsubscribe?.()
+  }
+}

package/src/actions/watchChainId.ts

@@ -1,4 +1,4 @@
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
 import type { GetChainIdReturnType } from './getChainId.js'
 
 export type WatchChainIdParameters<config extends Config = Config> = {
@@ -10,7 +10,7 @@ export type WatchChainIdParameters<config extends Config = Config> = {
 
 export type WatchChainIdReturnType = () => void
 
-/** https://alpha.wagmi.sh/core/api/actions/watchChainId */
+/** https://wagmi.sh/core/api/actions/watchChainId */
 export function watchChainId<config extends Config>(
   config: config,
   parameters: WatchChainIdParameters<config>,

package/src/actions/watchClient.ts

@@ -1,4 +1,4 @@
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
 import { type GetClientReturnType, getClient } from './getClient.js'
 
 export type WatchClientParameters<
@@ -13,7 +13,7 @@ export type WatchClientParameters<
 
 export type WatchClientReturnType = () => void
 
-/** https://alpha.wagmi.sh/core/api/actions/watchClient */
+/** https://wagmi.sh/core/api/actions/watchClient */
 export function watchClient<
   config extends Config,
   chainId extends config['chains'][number]['id'],

package/src/actions/watchConnections.ts

@@ -1,4 +1,4 @@
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
 import { deepEqual } from '../utils/deepEqual.js'
 import {
   type GetConnectionsReturnType,
@@ -14,7 +14,7 @@ export type WatchConnectionsParameters = {
 
 export type WatchConnectionsReturnType = () => void
 
-/** https://alpha.wagmi.sh/core/api/actions/watchConnections */
+/** https://wagmi.sh/core/api/actions/watchConnections */
 export function watchConnections(
   config: Config,
   parameters: WatchConnectionsParameters,

package/src/actions/watchConnectors.ts

@@ -0,0 +1,22 @@
+import { type Config } from '../createConfig.js'
+import { type GetConnectorsReturnType } from './getConnectors.js'
+
+export type WatchConnectorsParameters = {
+  onChange(
+    connections: GetConnectorsReturnType,
+    prevConnectors: GetConnectorsReturnType,
+  ): void
+}
+
+export type WatchConnectorsReturnType = () => void
+
+/** https://wagmi.sh/core/api/actions/watchConnectors */
+export function watchConnectors(
+  config: Config,
+  parameters: WatchConnectorsParameters,
+): WatchConnectorsReturnType {
+  const { onChange } = parameters
+  return config._internal.connectors.subscribe((connectors, prevConnectors) => {
+    onChange(Object.values(connectors), prevConnectors)
+  })
+}

package/src/actions/watchContractEvent.ts

@@ -10,13 +10,14 @@ import {
   type WatchContractEventReturnType as viem_WatchContractEventReturnType,
   watchContractEvent as viem_watchContractEvent,
 } from 'viem/actions'
-import type { Config } from '../createConfig.js'
-import type { SelectChains } from '../types/chain.js'
-import type {
-  ChainIdParameter,
-  SyncConnectedChainParameter,
+
+import { type Config } from '../createConfig.js'
+import { type SelectChains } from '../types/chain.js'
+import {
+  type ChainIdParameter,
+  type SyncConnectedChainParameter,
 } from '../types/properties.js'
-import type { UnionEvaluate } from '../types/utils.js'
+import { type UnionEvaluate } from '../types/utils.js'
 
 export type WatchContractEventParameters<
   abi extends Abi | readonly unknown[] = Abi,
@@ -46,7 +47,7 @@ export type WatchContractEventParameters<
 export type WatchContractEventReturnType = viem_WatchContractEventReturnType
 
 // TODO: wrap in viem's `observe` to avoid duplicate invocations.
-/** https://alpha.wagmi.sh/core/api/actions/watchContractEvent */
+/** https://wagmi.sh/core/api/actions/watchContractEvent */
 export function watchContractEvent<
   config extends Config,
   chainId extends config['chains'][number]['id'],
@@ -86,9 +87,7 @@ export function watchContractEvent<
   if (syncConnectedChain && !parameters.chainId)
     unsubscribe = config.subscribe(
       ({ chainId }) => chainId,
-      async (chainId) => {
-        return listener(chainId)
-      },
+      async (chainId) => listener(chainId),
     )
 
   return () => {

package/src/actions/watchPendingTransactions.ts

@@ -5,7 +5,7 @@ import {
   watchPendingTransactions as viem_watchPendingTransactions,
 } from 'viem/actions'
 
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
 import type { SelectChains } from '../types/chain.js'
 import type {
   ChainIdParameter,
@@ -36,7 +36,7 @@ export type WatchPendingTransactionsReturnType =
   viem_WatchPendingTransactionsReturnType
 
 // TODO: wrap in viem's `observe` to avoid duplicate invocations.
-/** https://alpha.wagmi.sh/core/api/actions/watchPendingTransactions */
+/** https://wagmi.sh/core/api/actions/watchPendingTransactions */
 export function watchPendingTransactions<
   config extends Config,
   chainId extends config['chains'][number]['id'],
@@ -67,9 +67,7 @@ export function watchPendingTransactions<
   if (syncConnectedChain && !parameters.chainId)
     unsubscribe = config.subscribe(
       ({ chainId }) => chainId,
-      async (chainId) => {
-        return listener(chainId)
-      },
+      async (chainId) => listener(chainId),
     )
 
   return () => {

package/src/actions/watchPublicClient.ts

@@ -1,4 +1,4 @@
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
 import {
   type GetPublicClientReturnType,
   getPublicClient,
@@ -16,7 +16,7 @@ export type WatchPublicClientParameters<
 
 export type WatchPublicClientReturnType = () => void
 
-/** https://alpha.wagmi.sh/core/api/actions/watchPublicClient */
+/** https://wagmi.sh/core/api/actions/watchPublicClient */
 export function watchPublicClient<
   config extends Config,
   chainId extends config['chains'][number]['id'],