viem 2.0.0-alpha.9 → 2.0.0-beta.1

package/actions/index.ts

@@ -1,156 +1,196 @@
 export {
+  type GetEnsAddressErrorType,
   type GetEnsAddressParameters,
   type GetEnsAddressReturnType,
   getEnsAddress,
 } from './ens/getEnsAddress.js'
 export {
+  type GetEnsAvatarErrorType,
   type GetEnsAvatarParameters,
   type GetEnsAvatarReturnType,
   getEnsAvatar,
 } from './ens/getEnsAvatar.js'
 export {
+  type GetEnsNameErrorType,
   type GetEnsNameParameters,
   type GetEnsNameReturnType,
   getEnsName,
 } from './ens/getEnsName.js'
 export {
+  type GetEnsResolverErrorType,
   type GetEnsResolverParameters,
   type GetEnsResolverReturnType,
   getEnsResolver,
 } from './ens/getEnsResolver.js'
 export {
+  type GetEnsTextErrorType,
   type GetEnsTextParameters,
   type GetEnsTextReturnType,
   getEnsText,
 } from './ens/getEnsText.js'
 export {
+  type CallErrorType,
   type CallParameters,
   type CallReturnType,
   call,
 } from './public/call.js'
 export {
+  type CreateBlockFilterErrorType,
   type CreateBlockFilterReturnType,
   createBlockFilter,
 } from './public/createBlockFilter.js'
 export {
+  type CreateContractEventFilterErrorType,
   type CreateContractEventFilterParameters,
   type CreateContractEventFilterReturnType,
   createContractEventFilter,
 } from './public/createContractEventFilter.js'
 export {
+  type CreateEventFilterErrorType,
   type CreateEventFilterParameters,
   type CreateEventFilterReturnType,
   createEventFilter,
 } from './public/createEventFilter.js'
 export {
+  type CreatePendingTransactionFilterErrorType,
   type CreatePendingTransactionFilterReturnType,
   createPendingTransactionFilter,
 } from './public/createPendingTransactionFilter.js'
 export {
+  type EstimateContractGasErrorType,
   type EstimateContractGasParameters,
   type EstimateContractGasReturnType,
   estimateContractGas,
 } from './public/estimateContractGas.js'
 export {
+  type EstimateFeesPerGasErrorType,
   type EstimateFeesPerGasParameters,
   type EstimateFeesPerGasReturnType,
   estimateFeesPerGas,
 } from './public/estimateFeesPerGas.js'
 export {
+  type EstimateMaxPriorityFeePerGasErrorType,
   type EstimateMaxPriorityFeePerGasParameters,
   type EstimateMaxPriorityFeePerGasReturnType,
   estimateMaxPriorityFeePerGas,
 } from './public/estimateMaxPriorityFeePerGas.js'
 export {
+  type EstimateGasErrorType,
   type EstimateGasParameters,
   type EstimateGasReturnType,
   estimateGas,
 } from './public/estimateGas.js'
 export {
+  type GetBalanceErrorType,
   type GetBalanceParameters,
   type GetBalanceReturnType,
   getBalance,
 } from './public/getBalance.js'
 export {
+  type GetBlockErrorType,
   type GetBlockParameters,
   type GetBlockReturnType,
   getBlock,
 } from './public/getBlock.js'
 export {
+  type GetBlockNumberErrorType,
   type GetBlockNumberParameters,
   type GetBlockNumberReturnType,
   getBlockNumber,
 } from './public/getBlockNumber.js'
 export {
+  type GetBlockTransactionCountErrorType,
   type GetBlockTransactionCountParameters,
   type GetBlockTransactionCountReturnType,
   getBlockTransactionCount,
 } from './public/getBlockTransactionCount.js'
 export {
+  type GetBytecodeErrorType,
   type GetBytecodeParameters,
   type GetBytecodeReturnType,
   getBytecode,
 } from './public/getBytecode.js'
-export { type GetChainIdReturnType, getChainId } from './public/getChainId.js'
 export {
+  type GetChainIdErrorType,
+  type GetChainIdReturnType,
+  getChainId,
+} from './public/getChainId.js'
+export {
+  type GetFeeHistoryErrorType,
   type GetFeeHistoryParameters,
   type GetFeeHistoryReturnType,
   getFeeHistory,
 } from './public/getFeeHistory.js'
 export {
+  type GetFilterChangesErrorType,
   type GetFilterChangesParameters,
   type GetFilterChangesReturnType,
   getFilterChanges,
 } from './public/getFilterChanges.js'
 export {
+  type GetFilterLogsErrorType,
   type GetFilterLogsParameters,
   type GetFilterLogsReturnType,
   getFilterLogs,
 } from './public/getFilterLogs.js'
 export {
+  type GetGasPriceErrorType,
   type GetGasPriceReturnType,
   getGasPrice,
 } from './public/getGasPrice.js'
 export {
+  type GetLogsErrorType,
   type GetLogsParameters,
   type GetLogsReturnType,
   getLogs,
 } from './public/getLogs.js'
 export {
+  type GetStorageAtErrorType,
   type GetStorageAtParameters,
   type GetStorageAtReturnType,
   getStorageAt,
 } from './public/getStorageAt.js'
 export {
+  type GetTransactionConfirmationsErrorType,
   type GetTransactionConfirmationsParameters,
   type GetTransactionConfirmationsReturnType,
   getTransactionConfirmations,
 } from './public/getTransactionConfirmations.js'
 export {
+  type GetTransactionCountErrorType,
   type GetTransactionCountParameters,
   type GetTransactionCountReturnType,
   getTransactionCount,
 } from './public/getTransactionCount.js'
 export {
+  type GetTransactionErrorType,
   type GetTransactionParameters,
   type GetTransactionReturnType,
   getTransaction,
 } from './public/getTransaction.js'
 export {
+  type GetTransactionReceiptErrorType,
   type GetTransactionReceiptParameters,
   type GetTransactionReceiptReturnType,
   getTransactionReceipt,
 } from './public/getTransactionReceipt.js'
 export {
+  type ImpersonateAccountErrorType,
   type ImpersonateAccountParameters,
   impersonateAccount,
 } from './test/impersonateAccount.js'
 export {
+  type IncreaseTimeErrorType,
   type IncreaseTimeParameters,
   increaseTime,
 } from './test/increaseTime.js'
-export { type MineParameters, mine } from './test/mine.js'
 export {
+  type MineErrorType,
+  type MineParameters,
+  mine,
+} from './test/mine.js'
+export {
+  type MulticallErrorType,
   type MulticallParameters,
   type MulticallReturnType,
   multicall,
@@ -158,6 +198,7 @@ export {
 export {
   type OnBlock,
   type OnBlockParameter,
+  type WatchBlocksErrorType,
   type WatchBlocksParameters,
   type WatchBlocksReturnType,
   watchBlocks,
@@ -165,17 +206,14 @@ export {
 export {
   type OnBlockNumberFn,
   type OnBlockNumberParameter,
+  type WatchBlockNumberErrorType,
   type WatchBlockNumberParameters,
   type WatchBlockNumberReturnType,
   watchBlockNumber,
 } from './public/watchBlockNumber.js'
 export {
   type WatchEventOnLogsFn,
-  /** @deprecated - use `WatchEventOnLogsFn` instead. */
-  type WatchEventOnLogsFn as OnLogsFn,
   type WatchEventOnLogsParameter,
-  /** @deprecated - use `WatchEventOnLogsParameter` instead. */
-  type WatchEventOnLogsParameter as OnLogsParameter,
   type WatchEventParameters,
   type WatchEventReturnType,
   watchEvent,
@@ -183,35 +221,42 @@ export {
 export {
   type OnTransactionsFn,
   type OnTransactionsParameter,
+  type WatchPendingTransactionsErrorType,
   type WatchPendingTransactionsParameters,
   type WatchPendingTransactionsReturnType,
   watchPendingTransactions,
 } from './public/watchPendingTransactions.js'
 export {
+  type ReadContractErrorType,
   type ReadContractParameters,
   type ReadContractReturnType,
   readContract,
 } from './public/readContract.js'
 export {
+  type GetAddressesErrorType,
   type GetAddressesReturnType,
   getAddresses,
 } from './wallet/getAddresses.js'
 export {
+  type GetPermissionsErrorType,
   type GetPermissionsReturnType,
   getPermissions,
 } from './wallet/getPermissions.js'
 export {
   type ReplacementReason,
   type ReplacementReturnType,
+  type WaitForTransactionReceiptErrorType,
   type WaitForTransactionReceiptParameters,
   type WaitForTransactionReceiptReturnType,
   waitForTransactionReceipt,
 } from './public/waitForTransactionReceipt.js'
 export {
+  type RequestAddressesErrorType,
   type RequestAddressesReturnType,
   requestAddresses,
 } from './wallet/requestAddresses.js'
 export {
+  type RequestPermissionsErrorType,
   type RequestPermissionsReturnType,
   type RequestPermissionsParameters,
   requestPermissions,
@@ -221,136 +266,188 @@ export {
   dropTransaction,
 } from './test/dropTransaction.js'
 export {
+  type GetAutomineErrorType,
   type GetAutomineReturnType,
   getAutomine,
 } from './test/getAutomine.js'
 export {
+  type GetTxpoolContentErrorType,
   type GetTxpoolContentReturnType,
   getTxpoolContent,
 } from './test/getTxpoolContent.js'
 export {
+  type GetTxpoolStatusErrorType,
   type GetTxpoolStatusReturnType,
   getTxpoolStatus,
 } from './test/getTxpoolStatus.js'
 export {
+  type InspectTxpoolErrorType,
   type InspectTxpoolReturnType,
   inspectTxpool,
 } from './test/inspectTxpool.js'
-export { type ResetParameters, reset } from './test/reset.js'
-export { type RevertParameters, revert } from './test/revert.js'
 export {
+  type ResetErrorType,
+  type ResetParameters,
+  reset,
+} from './test/reset.js'
+export {
+  type RevertErrorType,
+  type RevertParameters,
+  revert,
+} from './test/revert.js'
+export {
+  type PrepareTransactionRequestErrorType,
   type PrepareTransactionRequestParameters,
   type PrepareTransactionRequestReturnType,
   prepareTransactionRequest,
 } from './wallet/prepareTransactionRequest.js'
 export {
+  type SendTransactionErrorType,
   type SendTransactionParameters,
   type SendTransactionReturnType,
   sendTransaction,
 } from './wallet/sendTransaction.js'
 export {
+  type SignTransactionErrorType,
   type SignTransactionParameters,
   type SignTransactionReturnType,
   signTransaction,
 } from './wallet/signTransaction.js'
 export {
+  type SendRawTransactionErrorType,
   type SendRawTransactionParameters,
   type SendRawTransactionReturnType,
   sendRawTransaction,
 } from './wallet/sendRawTransaction.js'
 export {
+  type SendUnsignedTransactionErrorType,
   type SendUnsignedTransactionParameters,
   type SendUnsignedTransactionReturnType,
   sendUnsignedTransaction,
 } from './test/sendUnsignedTransaction.js'
-export { type SetBalanceParameters, setBalance } from './test/setBalance.js'
-export { setAutomine } from './test/setAutomine.js'
 export {
+  type SetBalanceErrorType,
+  type SetBalanceParameters,
+  setBalance,
+} from './test/setBalance.js'
+export { type SetAutomineErrorType, setAutomine } from './test/setAutomine.js'
+export {
+  type SetBlockGasLimitErrorType,
   type SetBlockGasLimitParameters,
   setBlockGasLimit,
 } from './test/setBlockGasLimit.js'
 export {
+  type SetBlockTimestampIntervalErrorType,
   type SetBlockTimestampIntervalParameters,
   setBlockTimestampInterval,
 } from './test/setBlockTimestampInterval.js'
-export { type SetCodeParameters, setCode } from './test/setCode.js'
-export { type SetCoinbaseParameters, setCoinbase } from './test/setCoinbase.js'
 export {
+  type SetCodeErrorType,
+  type SetCodeParameters,
+  setCode,
+} from './test/setCode.js'
+export {
+  type SetCoinbaseErrorType,
+  type SetCoinbaseParameters,
+  setCoinbase,
+} from './test/setCoinbase.js'
+export {
+  type SetIntervalMiningErrorType,
   type SetIntervalMiningParameters,
   setIntervalMining,
 } from './test/setIntervalMining.js'
 export {
+  type SetMinGasPriceErrorType,
   type SetMinGasPriceParameters,
   setMinGasPrice,
 } from './test/setMinGasPrice.js'
 export {
+  type SetNextBlockBaseFeePerGasErrorType,
   type SetNextBlockBaseFeePerGasParameters,
   setNextBlockBaseFeePerGas,
 } from './test/setNextBlockBaseFeePerGas.js'
 export {
+  type SetNextBlockTimestampErrorType,
   type SetNextBlockTimestampParameters,
   setNextBlockTimestamp,
 } from './test/setNextBlockTimestamp.js'
-export { type SetNonceParameters, setNonce } from './test/setNonce.js'
 export {
+  type SetNonceErrorType,
+  type SetNonceParameters,
+  setNonce,
+} from './test/setNonce.js'
+export {
+  type SetStorageAtErrorType,
   type SetStorageAtParameters,
   setStorageAt,
 } from './test/setStorageAt.js'
-export { snapshot } from './test/snapshot.js'
+export { type SnapshotErrorType, snapshot } from './test/snapshot.js'
 export {
+  type SignMessageErrorType,
   type SignMessageParameters,
   type SignMessageReturnType,
   signMessage,
 } from './wallet/signMessage.js'
 export {
+  type SignTypedDataErrorType,
   type SignTypedDataParameters,
   type SignTypedDataReturnType,
   signTypedData,
 } from './wallet/signTypedData.js'
 export {
+  type SimulateContractErrorType,
   type SimulateContractParameters,
   type SimulateContractReturnType,
   simulateContract,
 } from './public/simulateContract.js'
 export {
+  type StopImpersonatingAccountErrorType,
   type StopImpersonatingAccountParameters,
   stopImpersonatingAccount,
 } from './test/stopImpersonatingAccount.js'
 export {
+  type SwitchChainErrorType,
   type SwitchChainParameters,
   switchChain,
 } from './wallet/switchChain.js'
 export {
+  type UninstallFilterErrorType,
   type UninstallFilterParameters,
   type UninstallFilterReturnType,
   uninstallFilter,
 } from './public/uninstallFilter.js'
 export {
+  type VerifyHashErrorType,
   type VerifyHashParameters,
   type VerifyHashReturnType,
   verifyHash,
 } from './public/verifyHash.js'
 export {
+  type VerifyMessageErrorType,
   type VerifyMessageParameters,
   type VerifyMessageReturnType,
   verifyMessage,
 } from './public/verifyMessage.js'
 export {
+  type VerifyTypedDataErrorType,
   type VerifyTypedDataParameters,
   type VerifyTypedDataReturnType,
   verifyTypedData,
 } from './public/verifyTypedData.js'
 export {
+  type WatchAssetErrorType,
   type WatchAssetParameters,
   type WatchAssetReturnType,
   watchAsset,
 } from './wallet/watchAsset.js'
 export {
+  type WatchContractEventErrorType,
   type WatchContractEventParameters,
   type WatchContractEventReturnType,
   watchContractEvent,
 } from './public/watchContractEvent.js'
 export {
+  type WriteContractErrorType,
   type WriteContractParameters,
   type WriteContractReturnType,
   writeContract,

package/actions/public/call.ts

@@ -1,7 +1,10 @@
 import type { Address } from 'abitype'
 
 import type { Account } from '../../accounts/types.js'
-import { parseAccount } from '../../accounts/utils/parseAccount.js'
+import {
+  type ParseAccountErrorType,
+  parseAccount,
+} from '../../accounts/utils/parseAccount.js'
 import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
 import { multicall3Abi } from '../../constants/abis.js'
@@ -11,26 +14,53 @@ import {
   ChainDoesNotSupportContract,
   ClientChainNotConfiguredError,
 } from '../../errors/chain.js'
-import { RawContractError } from '../../errors/contract.js'
+import {
+  RawContractError,
+  type RawContractErrorType,
+} from '../../errors/contract.js'
+import type { ErrorType } from '../../errors/utils.js'
 import type { BlockTag } from '../../types/block.js'
 import type { Chain } from '../../types/chain.js'
 import type { Hex } from '../../types/misc.js'
 import type { RpcTransactionRequest } from '../../types/rpc.js'
 import type { TransactionRequest } from '../../types/transaction.js'
 import type { UnionOmit } from '../../types/utils.js'
-import { decodeFunctionResult } from '../../utils/abi/decodeFunctionResult.js'
-import { encodeFunctionData } from '../../utils/abi/encodeFunctionData.js'
-import { getChainContractAddress } from '../../utils/chain.js'
-import { numberToHex } from '../../utils/encoding/toHex.js'
-import { getCallError } from '../../utils/errors/getCallError.js'
+import {
+  type DecodeFunctionResultErrorType,
+  decodeFunctionResult,
+} from '../../utils/abi/decodeFunctionResult.js'
+import {
+  type EncodeFunctionDataErrorType,
+  encodeFunctionData,
+} from '../../utils/abi/encodeFunctionData.js'
+import type { RequestErrorType } from '../../utils/buildRequest.js'
+import {
+  type GetChainContractAddressErrorType,
+  getChainContractAddress,
+} from '../../utils/chain/getChainContractAddress.js'
+import {
+  type NumberToHexErrorType,
+  numberToHex,
+} from '../../utils/encoding/toHex.js'
+import {
+  type GetCallErrorReturnType,
+  getCallError,
+} from '../../utils/errors/getCallError.js'
 import { extract } from '../../utils/formatters/extract.js'
 import {
+  type FormatTransactionRequestErrorType,
   type FormattedTransactionRequest,
   formatTransactionRequest,
 } from '../../utils/formatters/transactionRequest.js'
-import { createBatchScheduler } from '../../utils/promise/createBatchScheduler.js'
+import {
+  type CreateBatchSchedulerErrorType,
+  createBatchScheduler,
+} from '../../utils/promise/createBatchScheduler.js'
 import { assertRequest } from '../../utils/transaction/assertRequest.js'
-import type { AssertRequestParameters } from '../../utils/transaction/assertRequest.js'
+import type {
+  AssertRequestErrorType,
+  AssertRequestParameters,
+} from '../../utils/transaction/assertRequest.js'
 
 export type FormattedCall<
   TChain extends Chain | undefined = Chain | undefined,
@@ -59,6 +89,15 @@ export type CallParameters<
 
 export type CallReturnType = { data: Hex | undefined }
 
+export type CallErrorType = GetCallErrorReturnType<
+  | ParseAccountErrorType
+  | AssertRequestErrorType
+  | NumberToHexErrorType
+  | FormatTransactionRequestErrorType
+  | ScheduleMulticallErrorType
+  | RequestErrorType
+>
+
 /**
  * Executes a new message call immediately without submitting a transaction to the network.
  *
@@ -112,12 +151,12 @@ export async function call<TChain extends Chain | undefined>(
     const blockNumberHex = blockNumber ? numberToHex(blockNumber) : undefined
     const block = blockNumberHex || blockTag
 
-    const format =
-      client.chain?.formatters?.transactionRequest?.format ||
-      formatTransactionRequest
+    const chainFormat = client.chain?.formatters?.transactionRequest?.format
+    const format = chainFormat || formatTransactionRequest
+
     const request = format({
       // Pick out extra data that might exist on the chain's transaction request type.
-      ...extract(rest, { format }),
+      ...extract(rest, { format: chainFormat }),
       from: account?.address,
       accessList,
       data,
@@ -162,7 +201,7 @@ export async function call<TChain extends Chain | undefined>(
     if (data?.slice(0, 10) === offchainLookupSignature && to) {
       return { data: await offchainLookup(client, { data, to }) }
     }
-    throw getCallError(err as BaseError, {
+    throw getCallError(err as ErrorType, {
       ...args,
       account,
       chain: client.chain,
@@ -196,7 +235,16 @@ type ScheduleMulticallParameters<TChain extends Chain | undefined> = Pick<
   to: Address
 }
 
-async function scheduleMulticall<TChain extends Chain | undefined,>(
+export type ScheduleMulticallErrorType =
+  | GetChainContractAddressErrorType
+  | NumberToHexErrorType
+  | CreateBatchSchedulerErrorType
+  | EncodeFunctionDataErrorType
+  | DecodeFunctionResultErrorType
+  | RawContractErrorType
+  | ErrorType
+
+async function scheduleMulticall<TChain extends Chain | undefined>(
   client: Client<Transport>,
   args: ScheduleMulticallParameters<TChain>,
 ) {
@@ -276,6 +324,8 @@ async function scheduleMulticall<TChain extends Chain | undefined,>(
   return { data: returnData }
 }
 
+export type GetRevertErrorDataErrorType = ErrorType
+
 export function getRevertErrorData(err: unknown) {
   if (!(err instanceof BaseError)) return undefined
   const error = err.walk() as RawContractError

package/actions/public/createBlockFilter.ts

@@ -1,11 +1,15 @@
 import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
+import type { ErrorType } from '../../errors/utils.js'
 import type { Chain } from '../../types/chain.js'
 import type { Filter } from '../../types/filter.js'
+import type { RequestErrorType } from '../../utils/buildRequest.js'
 import { createFilterRequestScope } from '../../utils/filters/createFilterRequestScope.js'
 
 export type CreateBlockFilterReturnType = Filter<'block'>
 
+export type CreateBlockFilterErrorType = RequestErrorType | ErrorType
+
 /**
  * Creates a [`Filter`](https://viem.sh/docs/glossary/types.html#filter) to listen for new block hashes that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges.html).
  *

package/actions/public/createContractEventFilter.ts

@@ -2,6 +2,7 @@ import type { Abi, Address } from 'abitype'
 
 import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
+import type { ErrorType } from '../../errors/utils.js'
 import type { BlockNumber, BlockTag } from '../../types/block.js'
 import type { Chain } from '../../types/chain.js'
 import type {
@@ -11,10 +12,15 @@ import type {
 import type { Filter } from '../../types/filter.js'
 import type { Hex } from '../../types/misc.js'
 import {
+  type EncodeEventTopicsErrorType,
   type EncodeEventTopicsParameters,
   encodeEventTopics,
 } from '../../utils/abi/encodeEventTopics.js'
-import { numberToHex } from '../../utils/encoding/toHex.js'
+import type { RequestErrorType } from '../../utils/buildRequest.js'
+import {
+  type NumberToHexErrorType,
+  numberToHex,
+} from '../../utils/encoding/toHex.js'
 import { createFilterRequestScope } from '../../utils/filters/createFilterRequestScope.js'
 
 export type CreateContractEventFilterParameters<
@@ -35,7 +41,7 @@ export type CreateContractEventFilterParameters<
    * Whether or not the logs must match the indexed/non-indexed arguments in the event ABI item.
    * @default false
    */
-  strict?: strict
+  strict?: strict | boolean | undefined
   toBlock?: toBlock | BlockNumber | BlockTag
 } & (undefined extends eventName
   ? {
@@ -60,6 +66,12 @@ export type CreateContractEventFilterReturnType<
   toBlock extends BlockNumber | BlockTag | undefined = undefined,
 > = Filter<'event', abi, eventName, args, strict, fromBlock, toBlock>
 
+export type CreateContractEventFilterErrorType =
+  | EncodeEventTopicsErrorType
+  | RequestErrorType
+  | NumberToHexErrorType
+  | ErrorType
+
 /**
  * Creates a Filter to retrieve event logs that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges.html) or [`getFilterLogs`](https://viem.sh/docs/actions/public/getFilterLogs.html).
  *