viem 1.13.1 → 1.14.0

package/utils/abi/decodeFunctionResult.ts

@@ -2,7 +2,9 @@ import type { Abi, ExtractAbiFunctionNames } from 'abitype'
 
 import {
   AbiFunctionNotFoundError,
+  type AbiFunctionNotFoundErrorType,
   AbiFunctionOutputsNotFoundError,
+  type AbiFunctionOutputsNotFoundErrorType,
 } from '../../errors/abi.js'
 import type {
   AbiItem,
@@ -12,8 +14,16 @@ import type {
 } from '../../types/contract.js'
 import type { Hex } from '../../types/misc.js'
 
-import { decodeAbiParameters } from './decodeAbiParameters.js'
-import { type GetAbiItemParameters, getAbiItem } from './getAbiItem.js'
+import type { ErrorType } from '../../errors/utils.js'
+import {
+  type DecodeAbiParametersErrorType,
+  decodeAbiParameters,
+} from './decodeAbiParameters.js'
+import {
+  type GetAbiItemErrorType,
+  type GetAbiItemParameters,
+  getAbiItem,
+} from './getAbiItem.js'
 
 const docsPath = '/docs/contract/decodeFunctionResult'
 
@@ -42,6 +52,13 @@ export type DecodeFunctionResultReturnType<
   ? ContractFunctionResult<TAbi, TFunctionName>
   : ContractFunctionResult<TAbi, _FunctionName>
 
+export type DecodeFunctionResultErrorType =
+  | AbiFunctionNotFoundErrorType
+  | AbiFunctionOutputsNotFoundErrorType
+  | DecodeAbiParametersErrorType
+  | GetAbiItemErrorType
+  | ErrorType
+
 export function decodeFunctionResult<
   const TAbi extends Abi | readonly unknown[],
   TFunctionName extends string | undefined = undefined,

package/utils/abi/encodeAbiParameters.ts

@@ -6,22 +6,44 @@ import type {
 
 import {
   AbiEncodingArrayLengthMismatchError,
+  type AbiEncodingArrayLengthMismatchErrorType,
   AbiEncodingBytesSizeMismatchError,
+  type AbiEncodingBytesSizeMismatchErrorType,
   AbiEncodingLengthMismatchError,
+  type AbiEncodingLengthMismatchErrorType,
   InvalidAbiEncodingTypeError,
+  type InvalidAbiEncodingTypeErrorType,
   InvalidArrayError,
+  type InvalidArrayErrorType,
 } from '../../errors/abi.js'
-import { InvalidAddressError } from '../../errors/address.js'
+import {
+  InvalidAddressError,
+  type InvalidAddressErrorType,
+} from '../../errors/address.js'
+import type { ErrorType } from '../../errors/utils.js'
 import type { Hex } from '../../types/misc.js'
-import { isAddress } from '../address/isAddress.js'
-import { concat } from '../data/concat.js'
-import { padHex } from '../data/pad.js'
-import { size } from '../data/size.js'
-import { slice } from '../data/slice.js'
-import { boolToHex, numberToHex, stringToHex } from '../encoding/toHex.js'
+import { type IsAddressErrorType, isAddress } from '../address/isAddress.js'
+import { type ConcatErrorType, concat } from '../data/concat.js'
+import { type PadHexErrorType, padHex } from '../data/pad.js'
+import { type SizeErrorType, size } from '../data/size.js'
+import { type SliceErrorType, slice } from '../data/slice.js'
+import {
+  type BoolToHexErrorType,
+  type NumberToHexErrorType,
+  type StringToHexErrorType,
+  boolToHex,
+  numberToHex,
+  stringToHex,
+} from '../encoding/toHex.js'
 
 export type EncodeAbiParametersReturnType = Hex
 
+export type EncodeAbiParametersErrorType =
+  | AbiEncodingLengthMismatchErrorType
+  | PrepareParamsErrorType
+  | EncodeParamsErrorType
+  | ErrorType
+
 /**
  * @description Encodes a list of primitive values into an ABI-encoded hex value.
  */
@@ -55,6 +77,8 @@ type PreparedParam = { dynamic: boolean; encoded: Hex }
 type TupleAbiParameter = AbiParameter & { components: readonly AbiParameter[] }
 type Tuple = AbiParameterToPrimitiveType<TupleAbiParameter>
 
+export type PrepareParamsErrorType = ErrorType
+
 function prepareParams<const TParams extends readonly AbiParameter[]>({
   params,
   values,
@@ -69,6 +93,11 @@ function prepareParams<const TParams extends readonly AbiParameter[]>({
   return preparedParams
 }
 
+export type PrepareParamErrorType =
+  | GetArrayComponentsErrorType
+  | InvalidAbiEncodingTypeErrorType
+  | ErrorType
+
 function prepareParam<const TParam extends AbiParameter>({
   param,
   value,
@@ -109,6 +138,11 @@ function prepareParam<const TParam extends AbiParameter>({
 
 /////////////////////////////////////////////////////////////////
 
+export type EncodeParamsErrorType =
+  | NumberToHexErrorType
+  | SizeErrorType
+  | ErrorType
+
 function encodeParams(preparedParams: PreparedParam[]): Hex {
   // 1. Compute the size of the static part of the parameters.
   let staticSize = 0
@@ -139,11 +173,25 @@ function encodeParams(preparedParams: PreparedParam[]): Hex {
 
 /////////////////////////////////////////////////////////////////
 
+export type EncodeAddressErrorType =
+  | InvalidAddressErrorType
+  | IsAddressErrorType
+  | ErrorType
+
 function encodeAddress(value: Hex): PreparedParam {
   if (!isAddress(value)) throw new InvalidAddressError({ address: value })
   return { dynamic: false, encoded: padHex(value.toLowerCase() as Hex) }
 }
 
+export type EncodeArrayErrorType =
+  | AbiEncodingArrayLengthMismatchErrorType
+  | ConcatErrorType
+  | EncodeParamsErrorType
+  | InvalidArrayErrorType
+  | NumberToHexErrorType
+  | PrepareParamErrorType
+  | ErrorType
+
 function encodeArray<const TParam extends AbiParameter>(
   value: AbiParameterToPrimitiveType<TParam>,
   {
@@ -189,6 +237,14 @@ function encodeArray<const TParam extends AbiParameter>(
   }
 }
 
+export type EncodeBytesErrorType =
+  | AbiEncodingBytesSizeMismatchErrorType
+  | ConcatErrorType
+  | PadHexErrorType
+  | NumberToHexErrorType
+  | SizeErrorType
+  | ErrorType
+
 function encodeBytes<const TParam extends AbiParameter>(
   value: Hex,
   { param }: { param: TParam },
@@ -217,10 +273,17 @@ function encodeBytes<const TParam extends AbiParameter>(
   return { dynamic: false, encoded: padHex(value, { dir: 'right' }) }
 }
 
+export type EncodeBoolErrorType =
+  | PadHexErrorType
+  | BoolToHexErrorType
+  | ErrorType
+
 function encodeBool(value: boolean): PreparedParam {
   return { dynamic: false, encoded: padHex(boolToHex(value)) }
 }
 
+export type EncodeNumberErrorType = NumberToHexErrorType | ErrorType
+
 function encodeNumber(
   value: number,
   { signed }: { signed: boolean },
@@ -234,6 +297,15 @@ function encodeNumber(
   }
 }
 
+export type EncodeStringErrorType =
+  | ConcatErrorType
+  | NumberToHexErrorType
+  | PadHexErrorType
+  | SizeErrorType
+  | SliceErrorType
+  | StringToHexErrorType
+  | ErrorType
+
 function encodeString(value: string): PreparedParam {
   const hexValue = stringToHex(value)
   const partsLength = Math.ceil(size(hexValue) / 32)
@@ -254,6 +326,12 @@ function encodeString(value: string): PreparedParam {
   }
 }
 
+export type EncodeTupleErrorType =
+  | ConcatErrorType
+  | EncodeParamsErrorType
+  | PrepareParamErrorType
+  | ErrorType
+
 function encodeTuple<
   const TParam extends AbiParameter & { components: readonly AbiParameter[] },
 >(
@@ -280,6 +358,8 @@ function encodeTuple<
   }
 }
 
+export type GetArrayComponentsErrorType = ErrorType
+
 export function getArrayComponents(
   type: string,
 ): [length: number | null, innerType: string] | undefined {

package/utils/abi/encodeDeployData.ts

@@ -2,13 +2,18 @@ import type { Abi } from 'abitype'
 
 import {
   AbiConstructorNotFoundError,
+  type AbiConstructorNotFoundErrorType,
   AbiConstructorParamsNotFoundError,
 } from '../../errors/abi.js'
 import type { GetConstructorArgs } from '../../types/contract.js'
 import type { Hex } from '../../types/misc.js'
-import { concatHex } from '../data/concat.js'
+import { type ConcatHexErrorType, concatHex } from '../data/concat.js'
 
-import { encodeAbiParameters } from './encodeAbiParameters.js'
+import type { ErrorType } from '../../errors/utils.js'
+import {
+  type EncodeAbiParametersErrorType,
+  encodeAbiParameters,
+} from './encodeAbiParameters.js'
 
 const docsPath = '/docs/contract/encodeDeployData'
 
@@ -19,6 +24,12 @@ export type EncodeDeployDataParameters<
   bytecode: Hex
 } & GetConstructorArgs<TAbi>
 
+export type EncodeDeployDataErrorType =
+  | AbiConstructorNotFoundErrorType
+  | ConcatHexErrorType
+  | EncodeAbiParametersErrorType
+  | ErrorType
+
 export function encodeDeployData<const TAbi extends Abi | readonly unknown[]>({
   abi,
   args,

package/utils/abi/encodeErrorResult.ts

@@ -10,12 +10,23 @@ import type {
   InferErrorName,
 } from '../../types/contract.js'
 import type { Hex } from '../../types/misc.js'
-import { concatHex } from '../data/concat.js'
-import { getFunctionSelector } from '../hash/getFunctionSelector.js'
+import { type ConcatHexErrorType, concatHex } from '../data/concat.js'
+import {
+  type GetFunctionSelectorErrorType,
+  getFunctionSelector,
+} from '../hash/getFunctionSelector.js'
 
-import { encodeAbiParameters } from './encodeAbiParameters.js'
-import { formatAbiItem } from './formatAbiItem.js'
-import { type GetAbiItemParameters, getAbiItem } from './getAbiItem.js'
+import type { ErrorType } from '../../errors/utils.js'
+import {
+  type EncodeAbiParametersErrorType,
+  encodeAbiParameters,
+} from './encodeAbiParameters.js'
+import { type FormatAbiItemErrorType, formatAbiItem } from './formatAbiItem.js'
+import {
+  type GetAbiItemErrorType,
+  type GetAbiItemParameters,
+  getAbiItem,
+} from './getAbiItem.js'
 
 const docsPath = '/docs/contract/encodeErrorResult'
 
@@ -31,6 +42,14 @@ export type EncodeErrorResultParameters<
   ? { abi: [TAbi[number]] } & GetErrorArgs<TAbi, _ErrorName>
   : never)
 
+export type EncodeErrorResultErrorType =
+  | GetAbiItemErrorType
+  | FormatAbiItemErrorType
+  | GetFunctionSelectorErrorType
+  | EncodeAbiParametersErrorType
+  | ConcatHexErrorType
+  | ErrorType
+
 export function encodeErrorResult<
   const TAbi extends Abi | readonly unknown[],
   TErrorName extends string | undefined = undefined,

package/utils/abi/encodeEventTopics.ts

@@ -1,7 +1,13 @@
 import type { Abi, AbiParameter, AbiParameterToPrimitiveType } from 'abitype'
 
-import { AbiEventNotFoundError } from '../../errors/abi.js'
-import { FilterTypeNotSupportedError } from '../../errors/log.js'
+import {
+  AbiEventNotFoundError,
+  type AbiEventNotFoundErrorType,
+} from '../../errors/abi.js'
+import {
+  FilterTypeNotSupportedError,
+  type FilterTypeNotSupportedErrorType,
+} from '../../errors/log.js'
 import type {
   AbiItem,
   EventDefinition,
@@ -9,12 +15,19 @@ import type {
   InferEventName,
 } from '../../types/contract.js'
 import type { Hex } from '../../types/misc.js'
-import { toBytes } from '../encoding/toBytes.js'
-import { getEventSelector } from '../hash/getEventSelector.js'
-import { keccak256 } from '../hash/keccak256.js'
+import { type ToBytesErrorType, toBytes } from '../encoding/toBytes.js'
+import {
+  type GetEventSelectorErrorType,
+  getEventSelector,
+} from '../hash/getEventSelector.js'
+import { type Keccak256ErrorType, keccak256 } from '../hash/keccak256.js'
 
-import { encodeAbiParameters } from './encodeAbiParameters.js'
-import { formatAbiItem } from './formatAbiItem.js'
+import type { ErrorType } from '../../errors/utils.js'
+import {
+  type EncodeAbiParametersErrorType,
+  encodeAbiParameters,
+} from './encodeAbiParameters.js'
+import { type FormatAbiItemErrorType, formatAbiItem } from './formatAbiItem.js'
 import { type GetAbiItemParameters, getAbiItem } from './getAbiItem.js'
 
 export type EncodeEventTopicsParameters<
@@ -29,6 +42,13 @@ export type EncodeEventTopicsParameters<
   ? { abi: [TAbi[number]]; args?: GetEventArgs<TAbi, _EventName> }
   : never)
 
+export type EncodeEventTopicsErrorType =
+  | AbiEventNotFoundErrorType
+  | EncodeArgErrorType
+  | FormatAbiItemErrorType
+  | GetEventSelectorErrorType
+  | ErrorType
+
 export function encodeEventTopics<
   const TAbi extends Abi | readonly unknown[],
   TEventName extends string | undefined = undefined,
@@ -81,6 +101,13 @@ export function encodeEventTopics<
   return [signature, ...topics]
 }
 
+export type EncodeArgErrorType =
+  | Keccak256ErrorType
+  | ToBytesErrorType
+  | EncodeAbiParametersErrorType
+  | FilterTypeNotSupportedErrorType
+  | ErrorType
+
 function encodeArg({
   param,
   value,

package/utils/abi/encodeFunctionData.ts

@@ -1,17 +1,31 @@
 import type { Abi } from 'abitype'
 
-import { AbiFunctionNotFoundError } from '../../errors/abi.js'
+import {
+  AbiFunctionNotFoundError,
+  type AbiFunctionNotFoundErrorType,
+} from '../../errors/abi.js'
 import type {
   AbiItem,
   GetFunctionArgs,
   InferFunctionName,
 } from '../../types/contract.js'
-import { concatHex } from '../data/concat.js'
-import { getFunctionSelector } from '../hash/getFunctionSelector.js'
+import { type ConcatHexErrorType, concatHex } from '../data/concat.js'
+import {
+  type GetFunctionSelectorErrorType,
+  getFunctionSelector,
+} from '../hash/getFunctionSelector.js'
 
-import { encodeAbiParameters } from './encodeAbiParameters.js'
-import { formatAbiItem } from './formatAbiItem.js'
-import { type GetAbiItemParameters, getAbiItem } from './getAbiItem.js'
+import type { ErrorType } from '../../errors/utils.js'
+import {
+  type EncodeAbiParametersErrorType,
+  encodeAbiParameters,
+} from './encodeAbiParameters.js'
+import { type FormatAbiItemErrorType, formatAbiItem } from './formatAbiItem.js'
+import {
+  type GetAbiItemErrorType,
+  type GetAbiItemParameters,
+  getAbiItem,
+} from './getAbiItem.js'
 
 export type EncodeFunctionDataParameters<
   TAbi extends Abi | readonly unknown[] = Abi,
@@ -25,6 +39,15 @@ export type EncodeFunctionDataParameters<
   ? { abi: [TAbi[number]] } & GetFunctionArgs<TAbi, _FunctionName>
   : never)
 
+export type EncodeFunctionDataErrorType =
+  | AbiFunctionNotFoundErrorType
+  | ConcatHexErrorType
+  | EncodeAbiParametersErrorType
+  | FormatAbiItemErrorType
+  | GetAbiItemErrorType
+  | GetFunctionSelectorErrorType
+  | ErrorType
+
 export function encodeFunctionData<
   const TAbi extends Abi | readonly unknown[],
   TFunctionName extends string | undefined = undefined,

package/utils/abi/encodeFunctionResult.ts

@@ -10,8 +10,16 @@ import type {
   InferFunctionName,
 } from '../../types/contract.js'
 
-import { encodeAbiParameters } from './encodeAbiParameters.js'
-import { type GetAbiItemParameters, getAbiItem } from './getAbiItem.js'
+import type { ErrorType } from '../../errors/utils.js'
+import {
+  type EncodeAbiParametersErrorType,
+  encodeAbiParameters,
+} from './encodeAbiParameters.js'
+import {
+  type GetAbiItemErrorType,
+  type GetAbiItemParameters,
+  getAbiItem,
+} from './getAbiItem.js'
 
 const docsPath = '/docs/contract/encodeFunctionResult'
 
@@ -30,6 +38,13 @@ export type EncodeFunctionResultParameters<
     }
   : never)
 
+export type EncodeFunctionResultErrorType =
+  | AbiFunctionOutputsNotFoundError
+  | AbiFunctionNotFoundError
+  | EncodeAbiParametersErrorType
+  | GetAbiItemErrorType
+  | ErrorType
+
 export function encodeFunctionResult<
   const TAbi extends Abi | readonly unknown[],
   TFunctionName extends string | undefined = undefined,

package/utils/abi/encodePacked.ts

@@ -12,15 +12,28 @@ import type {
 
 import {
   AbiEncodingLengthMismatchError,
+  type AbiEncodingLengthMismatchErrorType,
   BytesSizeMismatchError,
+  type BytesSizeMismatchErrorType,
   UnsupportedPackedAbiType,
 } from '../../errors/abi.js'
-import { InvalidAddressError } from '../../errors/address.js'
+import {
+  InvalidAddressError,
+  type InvalidAddressErrorType,
+} from '../../errors/address.js'
+import type { ErrorType } from '../../errors/utils.js'
 import type { Hex } from '../../types/misc.js'
-import { isAddress } from '../address/isAddress.js'
-import { concatHex } from '../data/concat.js'
-import { pad } from '../data/pad.js'
-import { boolToHex, numberToHex, stringToHex } from '../encoding/toHex.js'
+import { type IsAddressErrorType, isAddress } from '../address/isAddress.js'
+import { type ConcatHexErrorType, concatHex } from '../data/concat.js'
+import { type PadErrorType, pad } from '../data/pad.js'
+import {
+  type BoolToHexErrorType,
+  type NumberToHexErrorType,
+  type StringToHexErrorType,
+  boolToHex,
+  numberToHex,
+  stringToHex,
+} from '../encoding/toHex.js'
 import { arrayRegex, bytesRegex, integerRegex } from '../regex.js'
 
 type PackedAbiType =
@@ -39,6 +52,12 @@ type EncodePackedValues<
     : unknown
 }
 
+export type EncodePackedErrorType =
+  | AbiEncodingLengthMismatchErrorType
+  | ConcatHexErrorType
+  | EncodeErrorType
+  | ErrorType
+
 export function encodePacked<
   const TPackedAbiTypes extends readonly PackedAbiType[] | readonly unknown[],
 >(types: TPackedAbiTypes, values: EncodePackedValues<TPackedAbiTypes>): Hex {
@@ -57,6 +76,17 @@ export function encodePacked<
   return concatHex(data)
 }
 
+type EncodeErrorType =
+  | BoolToHexErrorType
+  | BytesSizeMismatchErrorType
+  | InvalidAddressErrorType
+  | IsAddressErrorType
+  | NumberToHexErrorType
+  | PadErrorType
+  | StringToHexErrorType
+  | UnsupportedPackedAbiType
+  | ErrorType
+
 function encode<const TPackedAbiType extends PackedAbiType | unknown>(
   type: TPackedAbiType,
   value: EncodePackedValues<[TPackedAbiType]>[0],

package/utils/abi/formatAbiItem.ts

@@ -1,8 +1,17 @@
 import type { AbiParameter } from 'abitype'
 
-import { InvalidDefinitionTypeError } from '../../errors/abi.js'
+import {
+  InvalidDefinitionTypeError,
+  type InvalidDefinitionTypeErrorType,
+} from '../../errors/abi.js'
+import type { ErrorType } from '../../errors/utils.js'
 import type { AbiItem } from '../../types/contract.js'
 
+export type FormatAbiItemErrorType =
+  | FormatAbiParamsErrorType
+  | InvalidDefinitionTypeErrorType
+  | ErrorType
+
 export function formatAbiItem(
   abiItem: AbiItem,
   { includeName = false }: { includeName?: boolean } = {},
@@ -17,6 +26,8 @@ export function formatAbiItem(
   return `${abiItem.name}(${formatAbiParams(abiItem.inputs, { includeName })})`
 }
 
+export type FormatAbiParamsErrorType = ErrorType
+
 export function formatAbiParams(
   params: readonly AbiParameter[] | undefined,
   { includeName = false }: { includeName?: boolean } = {},
@@ -27,6 +38,8 @@ export function formatAbiParams(
     .join(includeName ? ', ' : ',')
 }
 
+export type FormatAbiParamErrorType = ErrorType
+
 function formatAbiParam(
   param: AbiParameter,
   { includeName }: { includeName: boolean },

package/utils/abi/formatAbiItemWithArgs.ts

@@ -1,8 +1,11 @@
 import type { AbiParameter } from 'abitype'
 
+import type { ErrorType } from '../../errors/utils.js'
 import type { AbiItem } from '../../types/contract.js'
 import { stringify } from '../stringify.js'
 
+export type FormatAbiItemWithArgsErrorType = ErrorType
+
 export function formatAbiItemWithArgs({
   abiItem,
   args,

package/utils/abi/getAbiItem.ts

@@ -1,11 +1,15 @@
 import type { Abi, AbiParameter, Address } from 'abitype'
 
+import type { ErrorType } from '../../errors/utils.js'
 import type { GetFunctionArgs, InferItemName } from '../../types/contract.js'
 import type { Hex } from '../../types/misc.js'
-import { isHex } from '../../utils/data/isHex.js'
+import { type IsHexErrorType, isHex } from '../../utils/data/isHex.js'
 import { getEventSelector } from '../../utils/hash/getEventSelector.js'
-import { getFunctionSelector } from '../../utils/hash/getFunctionSelector.js'
-import { isAddress } from '../address/isAddress.js'
+import {
+  type GetFunctionSelectorErrorType,
+  getFunctionSelector,
+} from '../../utils/hash/getFunctionSelector.js'
+import { type IsAddressErrorType, isAddress } from '../address/isAddress.js'
 
 export type GetAbiItemParameters<
   TAbi extends Abi | readonly unknown[] = Abi,
@@ -25,6 +29,12 @@ export type GetAbiItemReturnType<
   }
 >
 
+export type GetAbiItemErrorType =
+  | IsArgOfTypeErrorType
+  | IsHexErrorType
+  | GetFunctionSelectorErrorType
+  | ErrorType
+
 export function getAbiItem<
   const TAbi extends Abi | readonly unknown[],
   TItemName extends string,
@@ -70,6 +80,8 @@ export function getAbiItem<
   return abiItems[0] as any
 }
 
+export type IsArgOfTypeErrorType = IsAddressErrorType | ErrorType
+
 export function isArgOfType(arg: unknown, abiParameter: AbiParameter): boolean {
   const argType = typeof arg
   const abiParameterType = abiParameter.type

package/utils/address/getAddress.ts

@@ -1,10 +1,18 @@
 import type { Address } from 'abitype'
 
 import { InvalidAddressError } from '../../errors/address.js'
-import { stringToBytes } from '../encoding/toBytes.js'
-import { keccak256 } from '../hash/keccak256.js'
+import type { ErrorType } from '../../errors/utils.js'
+import {
+  type StringToBytesErrorType,
+  stringToBytes,
+} from '../encoding/toBytes.js'
+import { type Keccak256ErrorType, keccak256 } from '../hash/keccak256.js'
+import { type IsAddressErrorType, isAddress } from './isAddress.js'
 
-import { isAddress } from './isAddress.js'
+export type ChecksumAddressErrorType =
+  | Keccak256ErrorType
+  | StringToBytesErrorType
+  | ErrorType
 
 export function checksumAddress(address_: Address, chainId?: number): Address {
   const hexAddress = chainId
@@ -27,6 +35,11 @@ export function checksumAddress(address_: Address, chainId?: number): Address {
   return `0x${address.join('')}`
 }
 
+export type GetAddressErrorType =
+  | ChecksumAddressErrorType
+  | IsAddressErrorType
+  | ErrorType
+
 export function getAddress(address: string, chainId?: number): Address {
   if (!isAddress(address)) throw new InvalidAddressError({ address })
   return checksumAddress(address, chainId)