viem 1.13.2 → 1.15.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "1.13.2",
+  "version": "1.15.0",
   "type": "module",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
@@ -86,42 +86,18 @@
   },
   "typesVersions": {
     "*": {
-      "abi": [
-        "./_types/abi/index.d.ts"
-      ],
-      "accounts": [
-        "./_types/accounts/index.d.ts"
-      ],
-      "actions": [
-        "./_types/actions/index.d.ts"
-      ],
-      "chains": [
-        "./_types/chains/index.d.ts"
-      ],
-      "chains/utils": [
-        "./_types/chains/utils/index.d.ts"
-      ],
-      "contract": [
-        "./_types/contract/index.d.ts"
-      ],
-      "ens": [
-        "./_types/ens/index.d.ts"
-      ],
-      "public": [
-        "./_types/public/index.d.ts"
-      ],
-      "test": [
-        "./_types/test/index.d.ts"
-      ],
-      "utils": [
-        "./_types/utils/index.d.ts"
-      ],
-      "wallet": [
-        "./_types/wallet/index.d.ts"
-      ],
-      "window": [
-        "./_types/window/index.d.ts"
-      ]
+      "abi": ["./_types/abi/index.d.ts"],
+      "accounts": ["./_types/accounts/index.d.ts"],
+      "actions": ["./_types/actions/index.d.ts"],
+      "chains": ["./_types/chains/index.d.ts"],
+      "chains/utils": ["./_types/chains/utils/index.d.ts"],
+      "contract": ["./_types/contract/index.d.ts"],
+      "ens": ["./_types/ens/index.d.ts"],
+      "public": ["./_types/public/index.d.ts"],
+      "test": ["./_types/test/index.d.ts"],
+      "utils": ["./_types/utils/index.d.ts"],
+      "wallet": ["./_types/wallet/index.d.ts"],
+      "window": ["./_types/window/index.d.ts"]
     }
   },
   "peerDependencies": {
@@ -145,21 +121,12 @@
   },
   "license": "MIT",
   "repository": "wagmi-dev/viem",
-  "authors": [
-    "awkweb.eth",
-    "jxom.eth"
-  ],
+  "authors": ["awkweb.eth", "jxom.eth"],
   "funding": [
     {
       "type": "github",
       "url": "https://github.com/sponsors/wagmi-dev"
     }
   ],
-  "keywords": [
-    "eth",
-    "ethereum",
-    "dapps",
-    "wallet",
-    "web3"
-  ]
+  "keywords": ["eth", "ethereum", "dapps", "wallet", "web3"]
 }

package/public/index.ts

@@ -2,106 +2,132 @@
 
 export {
   call,
+  type CallErrorType,
   type CallParameters,
   type CallReturnType,
 } from '../actions/public/call.js'
 export {
   createBlockFilter,
+  type CreateBlockFilterErrorType,
   type CreateBlockFilterReturnType,
 } from '../actions/public/createBlockFilter.js'
 export {
   createEventFilter,
+  type CreateEventFilterErrorType,
   type CreateEventFilterParameters,
   type CreateEventFilterReturnType,
 } from '../actions/public/createEventFilter.js'
 export {
   createPendingTransactionFilter,
+  type CreatePendingTransactionFilterErrorType,
   type CreatePendingTransactionFilterReturnType,
 } from '../actions/public/createPendingTransactionFilter.js'
 export {
   estimateGas,
+  type EstimateGasErrorType,
   type EstimateGasParameters,
   type EstimateGasReturnType,
 } from '../actions/public/estimateGas.js'
 export {
   getBalance,
+  type GetBalanceErrorType,
   type GetBalanceParameters,
   type GetBalanceReturnType,
 } from '../actions/public/getBalance.js'
 export {
   getBlock,
+  type GetBlockErrorType,
   type GetBlockParameters,
   type GetBlockReturnType,
 } from '../actions/public/getBlock.js'
 export {
   getBlockNumber,
   getBlockNumberCache,
+  type GetBlockNumberErrorType,
   type GetBlockNumberParameters,
   type GetBlockNumberReturnType,
 } from '../actions/public/getBlockNumber.js'
 export {
   getBlockTransactionCount,
+  type GetBlockTransactionCountErrorType,
   type GetBlockTransactionCountParameters,
   type GetBlockTransactionCountReturnType,
 } from '../actions/public/getBlockTransactionCount.js'
 export {
   getBytecode,
+  type GetBytecodeErrorType,
   type GetBytecodeParameters,
   type GetBytecodeReturnType,
 } from '../actions/public/getBytecode.js'
 export { getChainId } from '../actions/public/getChainId.js'
 export {
   getFeeHistory,
+  type GetFeeHistoryErrorType,
   type GetFeeHistoryParameters,
   type GetFeeHistoryReturnType,
 } from '../actions/public/getFeeHistory.js'
 export {
   estimateFeesPerGas,
+  type EstimateFeesPerGasErrorType,
   type EstimateFeesPerGasParameters,
   type EstimateFeesPerGasReturnType,
 } from '../actions/public/estimateFeesPerGas.js'
 export {
   getFilterChanges,
+  type GetFilterChangesErrorType,
   type GetFilterChangesParameters,
   type GetFilterChangesReturnType,
 } from '../actions/public/getFilterChanges.js'
 export {
   getFilterLogs,
+  type GetFilterLogsErrorType,
   type GetFilterLogsParameters,
   type GetFilterLogsReturnType,
 } from '../actions/public/getFilterLogs.js'
-export { getLogs } from '../actions/public/getLogs.js'
+export {
+  getLogs,
+  type GetLogsErrorType,
+  type GetLogsParameters,
+  type GetLogsReturnType,
+} from '../actions/public/getLogs.js'
 export {
   getGasPrice,
+  type GetGasPriceErrorType,
   type GetGasPriceReturnType,
 } from '../actions/public/getGasPrice.js'
 export {
   estimateMaxPriorityFeePerGas,
+  type EstimateMaxPriorityFeePerGasErrorType,
   type EstimateMaxPriorityFeePerGasParameters,
   type EstimateMaxPriorityFeePerGasReturnType,
 } from '../actions/public/estimateMaxPriorityFeePerGas.js'
 export {
   getTransaction,
+  type GetTransactionErrorType,
   type GetTransactionParameters,
   type GetTransactionReturnType,
 } from '../actions/public/getTransaction.js'
 export {
   getTransactionConfirmations,
+  type GetTransactionConfirmationsErrorType,
   type GetTransactionConfirmationsParameters,
   type GetTransactionConfirmationsReturnType,
 } from '../actions/public/getTransactionConfirmations.js'
 export {
   getTransactionCount,
+  type GetTransactionCountErrorType,
   type GetTransactionCountParameters,
   type GetTransactionCountReturnType,
 } from '../actions/public/getTransactionCount.js'
 export {
   getTransactionReceipt,
+  type GetTransactionReceiptErrorType,
   type GetTransactionReceiptParameters,
   type GetTransactionReceiptReturnType,
 } from '../actions/public/getTransactionReceipt.js'
 export {
   uninstallFilter,
+  type UninstallFilterErrorType,
   type UninstallFilterParameters,
   type UninstallFilterReturnType,
 } from '../actions/public/uninstallFilter.js'
@@ -109,6 +135,7 @@ export {
   waitForTransactionReceipt,
   type ReplacementReason,
   type ReplacementReturnType,
+  type WaitForTransactionReceiptErrorType,
   type WaitForTransactionReceiptParameters,
   type WaitForTransactionReceiptReturnType,
 } from '../actions/public/waitForTransactionReceipt.js'
@@ -116,16 +143,20 @@ export {
   watchBlockNumber,
   type OnBlockNumberFn,
   type OnBlockNumberParameter,
+  type WatchBlockNumberErrorType,
+  type WatchBlockNumberReturnType,
   type WatchBlockNumberParameters,
 } from '../actions/public/watchBlockNumber.js'
 export {
   watchBlocks,
   type OnBlock,
   type OnBlockParameter,
+  type WatchBlocksErrorType,
   type WatchBlocksParameters,
 } from '../actions/public/watchBlocks.js'
 export {
   watchEvent,
+  type WatchEventErrorType,
   type WatchEventOnLogsFn,
   /** @deprecated - use `WatchEventOnLogsFn` instead. */
   type WatchEventOnLogsFn as OnLogsFn,
@@ -137,5 +168,7 @@ export {
   watchPendingTransactions,
   type OnTransactionsFn,
   type OnTransactionsParameter,
+  type WatchPendingTransactionsErrorType,
+  type WatchPendingTransactionsReturnType,
   type WatchPendingTransactionsParameters,
 } from '../actions/public/watchPendingTransactions.js'

package/test/index.ts

@@ -2,84 +2,134 @@
 
 export {
   dropTransaction,
+  type DropTransactionErrorType,
   type DropTransactionParameters,
 } from '../actions/test/dropTransaction.js'
 export {
   getAutomine,
+  type GetAutomineErrorType,
   type GetAutomineReturnType,
 } from '../actions/test/getAutomine.js'
 export {
   getTxpoolContent,
+  type GetTxpoolContentErrorType,
   type GetTxpoolContentReturnType,
 } from '../actions/test/getTxpoolContent.js'
 export {
   getTxpoolStatus,
+  type GetTxpoolStatusErrorType,
   type GetTxpoolStatusReturnType,
 } from '../actions/test/getTxpoolStatus.js'
 export {
   impersonateAccount,
+  type ImpersonateAccountErrorType,
   type ImpersonateAccountParameters,
 } from '../actions/test/impersonateAccount.js'
 export {
   increaseTime,
+  type IncreaseTimeErrorType,
   type IncreaseTimeParameters,
 } from '../actions/test/increaseTime.js'
 export {
   inspectTxpool,
+  type InspectTxpoolErrorType,
   type InspectTxpoolReturnType,
 } from '../actions/test/inspectTxpool.js'
-export { mine, type MineParameters } from '../actions/test/mine.js'
-export { removeBlockTimestampInterval } from '../actions/test/removeBlockTimestampInterval.js'
-export { reset, type ResetParameters } from '../actions/test/reset.js'
-export { revert, type RevertParameters } from '../actions/test/revert.js'
+export {
+  mine,
+  type MineErrorType,
+  type MineParameters,
+} from '../actions/test/mine.js'
+export {
+  removeBlockTimestampInterval,
+  type RemoveBlockTimestampIntervalErrorType,
+} from '../actions/test/removeBlockTimestampInterval.js'
+export {
+  reset,
+  type ResetErrorType,
+  type ResetParameters,
+} from '../actions/test/reset.js'
+export {
+  revert,
+  type RevertErrorType,
+  type RevertParameters,
+} from '../actions/test/revert.js'
 export {
   sendUnsignedTransaction,
+  type SendUnsignedTransactionErrorType,
   type SendUnsignedTransactionParameters,
   type SendUnsignedTransactionReturnType,
 } from '../actions/test/sendUnsignedTransaction.js'
-export { setAutomine } from '../actions/test/setAutomine.js'
+export {
+  setAutomine,
+  type SetAutomineErrorType,
+} from '../actions/test/setAutomine.js'
 export {
   setBalance,
+  type SetBalanceErrorType,
   type SetBalanceParameters,
 } from '../actions/test/setBalance.js'
 export {
   setBlockGasLimit,
+  type SetBlockGasLimitErrorType,
   type SetBlockGasLimitParameters,
 } from '../actions/test/setBlockGasLimit.js'
 export {
   setBlockTimestampInterval,
+  type SetBlockTimestampIntervalErrorType,
   type SetBlockTimestampIntervalParameters,
 } from '../actions/test/setBlockTimestampInterval.js'
-export { setCode, type SetCodeParameters } from '../actions/test/setCode.js'
+export {
+  setCode,
+  type SetCodeErrorType,
+  type SetCodeParameters,
+} from '../actions/test/setCode.js'
 export {
   setCoinbase,
+  type SetCoinbaseErrorType,
   type SetCoinbaseParameters,
 } from '../actions/test/setCoinbase.js'
 export {
   setIntervalMining,
+  type SetIntervalMiningErrorType,
   type SetIntervalMiningParameters,
 } from '../actions/test/setIntervalMining.js'
-export { setLoggingEnabled } from '../actions/test/setLoggingEnabled.js'
+export {
+  setLoggingEnabled,
+  type SetLoggingEnabledErrorType,
+} from '../actions/test/setLoggingEnabled.js'
 export {
   setMinGasPrice,
+  type SetMinGasPriceErrorType,
   type SetMinGasPriceParameters,
 } from '../actions/test/setMinGasPrice.js'
 export {
   setNextBlockBaseFeePerGas,
+  type SetNextBlockBaseFeePerGasErrorType,
   type SetNextBlockBaseFeePerGasParameters,
 } from '../actions/test/setNextBlockBaseFeePerGas.js'
 export {
   setNextBlockTimestamp,
+  type SetNextBlockTimestampErrorType,
   type SetNextBlockTimestampParameters,
 } from '../actions/test/setNextBlockTimestamp.js'
-export { setNonce, type SetNonceParameters } from '../actions/test/setNonce.js'
+export {
+  setNonce,
+  type SetNonceErrorType,
+  type SetNonceParameters,
+} from '../actions/test/setNonce.js'
 export {
   setStorageAt,
+  type SetStorageAtErrorType,
   type SetStorageAtParameters,
 } from '../actions/test/setStorageAt.js'
-export { snapshot } from '../actions/test/snapshot.js'
-export { setRpcUrl } from '../actions/test/setRpcUrl.js'
+export { snapshot, type SnapshotErrorType } from '../actions/test/snapshot.js'
+export {
+  setRpcUrl,
+  type SetRpcUrlErrorType,
+} from '../actions/test/setRpcUrl.js'
 export {
   stopImpersonatingAccount,
+  type StopImpersonatingAccountErrorType,
   type StopImpersonatingAccountParameters,
 } from '../actions/test/stopImpersonatingAccount.js'

package/types/eip1193.ts

@@ -28,6 +28,9 @@ export type EIP1193Provider = EIP1193Events & {
 //////////////////////////////////////////////////
 // Errors
 
+export type ProviderRpcErrorType = ProviderRpcError & {
+  name: 'ProviderRpcError'
+}
 export class ProviderRpcError extends Error {
   code: number
   details: string

package/types/misc.ts

@@ -16,3 +16,9 @@ export type Signature = {
   // TODO(v2): `v` to `recovery`
   v: bigint
 }
+export type CompactSignature = {
+  // TODO(v2): Make `bigint`
+  r: Hex
+  // TODO(v2): Make `bigint`
+  yParityAndS: Hex
+}

package/utils/abi/decodeAbiParameters.ts

@@ -6,22 +6,36 @@ import type {
 
 import {
   AbiDecodingDataSizeTooSmallError,
+  type AbiDecodingDataSizeTooSmallErrorType,
   AbiDecodingZeroDataError,
+  type AbiDecodingZeroDataErrorType,
   InvalidAbiDecodingTypeError,
+  type InvalidAbiDecodingTypeErrorType,
 } from '../../errors/abi.js'
 import type { Hex } from '../../types/misc.js'
-import { checksumAddress } from '../address/getAddress.js'
-import { size } from '../data/size.js'
-import { slice } from '../data/slice.js'
-import { trim } from '../data/trim.js'
 import {
+  type ChecksumAddressErrorType,
+  checksumAddress,
+} from '../address/getAddress.js'
+import { type SizeErrorType, size } from '../data/size.js'
+import { type SliceErrorType, slice } from '../data/slice.js'
+import { type TrimErrorType, trim } from '../data/trim.js'
+import {
+  type HexToBigIntErrorType,
+  type HexToBoolErrorType,
+  type HexToNumberErrorType,
+  type HexToStringErrorType,
   hexToBigInt,
   hexToBool,
   hexToNumber,
   hexToString,
 } from '../encoding/fromHex.js'
 
-import { getArrayComponents } from './encodeAbiParameters.js'
+import type { ErrorType } from '../../errors/utils.js'
+import {
+  type GetArrayComponentsErrorType,
+  getArrayComponents,
+} from './encodeAbiParameters.js'
 
 export type DecodeAbiParametersReturnType<
   TParams extends
@@ -31,6 +45,13 @@ export type DecodeAbiParametersReturnType<
   TParams extends readonly AbiParameter[] ? TParams : AbiParameter[]
 >
 
+export type DecodeAbiParametersErrorType =
+  | AbiDecodingDataSizeTooSmallErrorType
+  | AbiDecodingZeroDataErrorType
+  | DecodeParamsErrorType
+  | SizeErrorType
+  | ErrorType
+
 export function decodeAbiParameters<
   const TParams extends readonly AbiParameter[] | readonly unknown[],
 >(params: TParams, data: Hex): DecodeAbiParametersReturnType<TParams> {
@@ -52,6 +73,8 @@ export function decodeAbiParameters<
 
 type TupleAbiParameter = AbiParameter & { components: readonly AbiParameter[] }
 
+type DecodeParamsErrorType = DecodeParamErrorType | SizeErrorType | ErrorType
+
 function decodeParams<const TParams extends readonly AbiParameter[]>({
   data,
   params,
@@ -77,6 +100,17 @@ function decodeParams<const TParams extends readonly AbiParameter[]>({
   return decodedValues as unknown as AbiParametersToPrimitiveTypes<TParams>
 }
 
+type DecodeParamErrorType =
+  | DecodeArrayErrorType
+  | DecodeTupleErrorType
+  | DecodeStringErrorType
+  | DecodeBytesErrorType
+  | DecodeNumberErrorType
+  | DecodeAddressErrorType
+  | DecodeBoolErrorType
+  | InvalidAbiDecodingTypeErrorType
+  | ErrorType
+
 function decodeParam({
   data,
   param,
@@ -121,10 +155,17 @@ function decodeParam({
 
 ////////////////////////////////////////////////////////////////////
 
+type DecodeAddressErrorType =
+  | ChecksumAddressErrorType
+  | SliceErrorType
+  | ErrorType
+
 function decodeAddress(value: Hex) {
   return { consumed: 32, value: checksumAddress(slice(value, -20)) }
 }
 
+type DecodeArrayErrorType = HexToNumberErrorType | SliceErrorType | ErrorType
+
 function decodeArray<const TParam extends AbiParameter>(
   data: Hex,
   {
@@ -206,10 +247,14 @@ function decodeArray<const TParam extends AbiParameter>(
   return { value, consumed }
 }
 
+type DecodeBoolErrorType = HexToBoolErrorType | ErrorType
+
 function decodeBool(value: Hex) {
   return { consumed: 32, value: hexToBool(value) }
 }
 
+type DecodeBytesErrorType = HexToNumberErrorType | SliceErrorType | ErrorType
+
 function decodeBytes<const TParam extends AbiParameter>(
   data: Hex,
   { param, position }: { param: TParam; position: number },
@@ -238,6 +283,11 @@ function decodeBytes<const TParam extends AbiParameter>(
   return { consumed: 32, value }
 }
 
+type DecodeNumberErrorType =
+  | HexToBigIntErrorType
+  | HexToNumberErrorType
+  | ErrorType
+
 function decodeNumber<const TParam extends AbiParameter>(
   value: Hex,
   { param }: { param: TParam },
@@ -253,6 +303,13 @@ function decodeNumber<const TParam extends AbiParameter>(
   }
 }
 
+type DecodeStringErrorType =
+  | HexToNumberErrorType
+  | HexToStringErrorType
+  | SliceErrorType
+  | TrimErrorType
+  | ErrorType
+
 function decodeString(data: Hex, { position }: { position: number }) {
   const offset = hexToNumber(
     slice(data, position, position + 32, { strict: true }),
@@ -266,6 +323,12 @@ function decodeString(data: Hex, { position }: { position: number }) {
   return { consumed: 32, value }
 }
 
+type DecodeTupleErrorType =
+  | HasDynamicChildErrorType
+  | HexToNumberErrorType
+  | SliceErrorType
+  | ErrorType
+
 function decodeTuple<
   const TParam extends AbiParameter & { components: readonly AbiParameter[] },
 >(data: Hex, { param, position }: { param: TParam; position: number }) {
@@ -316,6 +379,8 @@ function decodeTuple<
   return { consumed, value }
 }
 
+type HasDynamicChildErrorType = GetArrayComponentsErrorType | ErrorType
+
 function hasDynamicChild(param: AbiParameter) {
   const { type } = param
   if (type === 'string') return true

package/utils/abi/decodeDeployData.ts

@@ -2,12 +2,18 @@ import type { Abi } from 'abitype'
 
 import {
   AbiConstructorNotFoundError,
+  type AbiConstructorNotFoundErrorType,
   AbiConstructorParamsNotFoundError,
+  type AbiConstructorParamsNotFoundErrorType,
 } from '../../errors/abi.js'
 import type { GetConstructorArgs } from '../../types/contract.js'
 import type { Hex } from '../../types/misc.js'
 
-import { decodeAbiParameters } from './decodeAbiParameters.js'
+import type { ErrorType } from '../../errors/utils.js'
+import {
+  type DecodeAbiParametersErrorType,
+  decodeAbiParameters,
+} from './decodeAbiParameters.js'
 
 const docsPath = '/docs/contract/decodeDeployData'
 
@@ -18,12 +24,19 @@ export type DecodeDeployDataParameters<
   bytecode: Hex
   data: Hex
 }
+
 export type DecodeDeployDataReturnType<
   TAbi extends Abi | readonly unknown[] = Abi,
 > = {
   bytecode: Hex
 } & GetConstructorArgs<TAbi>
 
+export type DecodeDeployDataErrorType =
+  | AbiConstructorNotFoundErrorType
+  | AbiConstructorParamsNotFoundErrorType
+  | DecodeAbiParametersErrorType
+  | ErrorType
+
 export function decodeDeployData<const TAbi extends Abi | readonly unknown[]>({
   abi,
   bytecode,

package/utils/abi/decodeErrorResult.ts

@@ -3,15 +3,24 @@ import type { Abi, ExtractAbiError, ExtractAbiErrorNames } from 'abitype'
 import { solidityError, solidityPanic } from '../../constants/solidity.js'
 import {
   AbiDecodingZeroDataError,
+  type AbiDecodingZeroDataErrorType,
   AbiErrorSignatureNotFoundError,
+  type AbiErrorSignatureNotFoundErrorType,
 } from '../../errors/abi.js'
 import type { AbiItem, GetErrorArgs } from '../../types/contract.js'
 import type { Hex } from '../../types/misc.js'
 import { slice } from '../data/slice.js'
-import { getFunctionSelector } from '../hash/getFunctionSelector.js'
+import {
+  type GetFunctionSelectorErrorType,
+  getFunctionSelector,
+} from '../hash/getFunctionSelector.js'
 
-import { decodeAbiParameters } from './decodeAbiParameters.js'
-import { formatAbiItem } from './formatAbiItem.js'
+import type { ErrorType } from '../../errors/utils.js'
+import {
+  type DecodeAbiParametersErrorType,
+  decodeAbiParameters,
+} from './decodeAbiParameters.js'
+import { type FormatAbiItemErrorType, formatAbiItem } from './formatAbiItem.js'
 
 export type DecodeErrorResultParameters<
   TAbi extends Abi | readonly unknown[] = Abi,
@@ -32,6 +41,14 @@ export type DecodeErrorResultReturnType<
   }
 }[_ErrorNames]
 
+export type DecodeErrorResultErrorType =
+  | AbiDecodingZeroDataErrorType
+  | AbiErrorSignatureNotFoundErrorType
+  | DecodeAbiParametersErrorType
+  | FormatAbiItemErrorType
+  | GetFunctionSelectorErrorType
+  | ErrorType
+
 export function decodeErrorResult<const TAbi extends Abi | readonly unknown[]>({
   abi,
   data,