viem 2.8.9 → 2.8.11

package/types/misc.ts

@@ -22,13 +22,13 @@ export type Signature = OneOf<
       s: Hex
       /** @deprecated use `yParity`. */
       v: bigint
-      yParity?: number
+      yParity?: number | undefined
     }
   | {
       r: Hex
       s: Hex
       /** @deprecated use `yParity`. */
-      v?: bigint
+      v?: bigint | undefined
       yParity: number
     }
 >

package/types/rpc.ts

@@ -68,38 +68,38 @@ export type RpcTransaction<TPending extends boolean = boolean> = UnionOmit<
 >
 
 type SuccessResult<T> = {
-  method?: never
+  method?: never | undefined
   result: T
-  error?: never
+  error?: never | undefined
 }
 type ErrorResult<T> = {
-  method?: never
-  result?: never
+  method?: never | undefined
+  result?: never | undefined
   error: T
 }
 type Subscription<TResult, TError> = {
   method: 'eth_subscription'
-  error?: never
-  result?: never
+  error?: never | undefined
+  result?: never | undefined
   params: {
     subscription: string
   } & (
     | {
         result: TResult
-        error?: never
+        error?: never | undefined
       }
     | {
-        result?: never
+        result?: never | undefined
         error: TError
       }
   )
 }
 
 export type RpcRequest = {
-  jsonrpc?: '2.0'
+  jsonrpc?: '2.0' | undefined
   method: string
-  params?: any
-  id?: number
+  params?: any | undefined
+  id?: number | undefined
 }
 
 export type RpcResponse<TResult = any, TError = any> = {
@@ -118,15 +118,15 @@ export type RpcStateMapping = {
 
 export type RpcAccountStateOverride = {
   /** Fake balance to set for the account before executing the call. <32 bytes */
-  balance?: Hex
+  balance?: Hex | undefined
   /** Fake nonce to set for the account before executing the call. <8 bytes */
-  nonce?: Hex
+  nonce?: Hex | undefined
   /** Fake EVM bytecode to inject into the account before executing the call. */
-  code?: Hex
+  code?: Hex | undefined
   /** Fake key-value mapping to override all slots in the account storage before executing the call. */
-  state?: RpcStateMapping
+  state?: RpcStateMapping | undefined
   /** Fake key-value mapping to override individual slots in the account storage before executing the call. */
-  stateDiff?: RpcStateMapping
+  stateDiff?: RpcStateMapping | undefined
 }
 
 export type RpcStateOverride = {

package/types/stateOverride.ts

@@ -10,17 +10,17 @@ export type StateMapping = Array<{
 export type StateOverride = Array<
   {
     address: Address
-    balance?: bigint
-    nonce?: number
-    code?: Hex
+    balance?: bigint | undefined
+    nonce?: number | undefined
+    code?: Hex | undefined
   } & OneOf<
     | {
         /** Fake key-value mapping to override all slots in the account storage before executing the call. */
-        state?: StateMapping
+        state?: StateMapping | undefined
       }
     | {
         /** Fake key-value mapping to override individual slots in the account storage before executing the call. */
-        stateDiff?: StateMapping
+        stateDiff?: StateMapping | undefined
       }
   >
 >

package/types/transaction.ts

@@ -9,7 +9,13 @@ import type {
 import type { Kzg } from './kzg.js'
 import type { Log } from './log.js'
 import type { ByteArray, Hash, Hex, Signature } from './misc.js'
-import type { Branded, IsNever, OneOf, RequiredBy } from './utils.js'
+import type {
+  Branded,
+  ExactPartial,
+  IsNever,
+  OneOf,
+  RequiredBy,
+} from './utils.js'
 
 export type AccessList = { address: Address; storageKeys: Hex[] }[]
 
@@ -27,15 +33,15 @@ export type TransactionReceipt<
   TType = TransactionType,
 > = {
   /** The actual value per gas deducted from the sender's account for blob gas. Only specified for blob transactions as defined by EIP-4844. */
-  blobGasPrice?: TQuantity
+  blobGasPrice?: TQuantity | undefined
   /** The amount of blob gas used. Only specified for blob transactions as defined by EIP-4844. */
-  blobGasUsed?: TQuantity
+  blobGasUsed?: TQuantity | undefined
   /** Hash of block containing this transaction */
   blockHash: Hash
   /** Number of block containing this transaction */
   blockNumber: TQuantity
   /** Address of new contract or `null` if no contract was created */
-  contractAddress: Address | null
+  contractAddress: Address | null | undefined
   /** Gas used by this and all preceding transactions in this block */
   cumulativeGasUsed: TQuantity
   /** Pre-London, it is equal to the transaction's gasPrice. Post-London, it is equal to the actual gas price paid for inclusion. */
@@ -49,7 +55,7 @@ export type TransactionReceipt<
   /** Logs bloom filter */
   logsBloom: Hex
   /** The post-transaction state root. Only specified for transactions included before the Byzantium upgrade. */
-  root?: Hash
+  root?: Hash | undefined
   /** `success` if this transaction was successful or `reverted` if it failed */
   status: TStatus
   /** Transaction recipient or `null` if deploying a contract */
@@ -106,11 +112,11 @@ export type TransactionLegacy<
 > = Omit<TransactionBase<TQuantity, TIndex, TPending>, 'yParity'> &
   FeeValuesLegacy<TQuantity> & {
     /** EIP-2930 Access List. */
-    accessList?: never
-    blobVersionedHashes?: never
+    accessList?: never | undefined
+    blobVersionedHashes?: never | undefined
     /** Chain ID that this transaction is valid on. */
-    chainId?: TIndex
-    yParity?: never
+    chainId?: TIndex | undefined
+    yParity?: never | undefined
     type: TType
   }
 export type TransactionEIP2930<
@@ -122,7 +128,7 @@ export type TransactionEIP2930<
   FeeValuesLegacy<TQuantity> & {
     /** EIP-2930 Access List. */
     accessList: AccessList
-    blobVersionedHashes?: never
+    blobVersionedHashes?: never | undefined
     /** Chain ID that this transaction is valid on. */
     chainId: TIndex
     type: TType
@@ -136,7 +142,7 @@ export type TransactionEIP1559<
   FeeValuesEIP1559<TQuantity> & {
     /** EIP-2930 Access List. */
     accessList: AccessList
-    blobVersionedHashes?: never
+    blobVersionedHashes?: never | undefined
     /** Chain ID that this transaction is valid on. */
     chainId: TIndex
     type: TType
@@ -169,58 +175,58 @@ export type Transaction<
 
 export type TransactionRequestBase<TQuantity = bigint, TIndex = number> = {
   /** Contract code or a hashed method call with encoded args */
-  data?: Hex
+  data?: Hex | undefined
   /** Transaction sender */
   from: Address
   /** Gas provided for transaction execution */
-  gas?: TQuantity
+  gas?: TQuantity | undefined
   /** Unique number identifying this transaction */
-  nonce?: TIndex
+  nonce?: TIndex | undefined
   /** Transaction recipient */
-  to?: Address | null
+  to?: Address | null | undefined
   /** Value in wei sent with this transaction */
-  value?: TQuantity
+  value?: TQuantity | undefined
 }
 export type TransactionRequestLegacy<
   TQuantity = bigint,
   TIndex = number,
   TTransactionType = 'legacy',
 > = TransactionRequestBase<TQuantity, TIndex> &
-  Partial<FeeValuesLegacy<TQuantity>> & {
-    accessList?: never
+  ExactPartial<FeeValuesLegacy<TQuantity>> & {
+    accessList?: never | undefined
     blobs?: undefined
-    type?: TTransactionType
+    type?: TTransactionType | undefined
   }
 export type TransactionRequestEIP2930<
   TQuantity = bigint,
   TIndex = number,
   TTransactionType = 'eip2930',
 > = TransactionRequestBase<TQuantity, TIndex> &
-  Partial<FeeValuesLegacy<TQuantity>> & {
-    accessList?: AccessList
+  ExactPartial<FeeValuesLegacy<TQuantity>> & {
+    accessList?: AccessList | undefined
     blobs?: undefined
-    type?: TTransactionType
+    type?: TTransactionType | undefined
   }
 export type TransactionRequestEIP1559<
   TQuantity = bigint,
   TIndex = number,
   TTransactionType = 'eip1559',
 > = TransactionRequestBase<TQuantity, TIndex> &
-  Partial<FeeValuesEIP1559<TQuantity>> & {
-    accessList?: AccessList
+  ExactPartial<FeeValuesEIP1559<TQuantity>> & {
+    accessList?: AccessList | undefined
     blobs?: undefined
-    type?: TTransactionType
+    type?: TTransactionType | undefined
   }
 export type TransactionRequestEIP4844<
   TQuantity = bigint,
   TIndex = number,
   TTransactionType = 'eip4844',
 > = RequiredBy<TransactionRequestBase<TQuantity, TIndex>, 'to'> &
-  RequiredBy<Partial<FeeValuesEIP4844<TQuantity>>, 'maxFeePerBlobGas'> & {
-    accessList?: AccessList
+  RequiredBy<ExactPartial<FeeValuesEIP4844<TQuantity>>, 'maxFeePerBlobGas'> & {
+    accessList?: AccessList | undefined
     /** The blobs associated with this transaction. */
     blobs: readonly Hex[] | readonly ByteArray[]
-    type?: TTransactionType
+    type?: TTransactionType | undefined
   }
 export type TransactionRequest<TQuantity = bigint, TIndex = number> = OneOf<
   | TransactionRequestLegacy<TQuantity, TIndex>
@@ -246,64 +252,65 @@ export type TransactionSerialized<
 export type TransactionSerializableBase<
   TQuantity = bigint,
   TIndex = number,
-> = Omit<TransactionRequestBase<TQuantity, TIndex>, 'from'> & Partial<Signature>
+> = Omit<TransactionRequestBase<TQuantity, TIndex>, 'from'> &
+  ExactPartial<Signature>
 
 export type TransactionSerializableLegacy<
   TQuantity = bigint,
   TIndex = number,
 > = TransactionSerializableBase<TQuantity, TIndex> &
-  Partial<FeeValuesLegacy<TQuantity>> & {
+  ExactPartial<FeeValuesLegacy<TQuantity>> & {
     accessList?: undefined
     blobs?: undefined
     blobVersionedHashes?: undefined
-    chainId?: number
-    type?: 'legacy'
+    chainId?: number | undefined
+    type?: 'legacy' | undefined
   }
 
 export type TransactionSerializableEIP2930<
   TQuantity = bigint,
   TIndex = number,
 > = TransactionSerializableBase<TQuantity, TIndex> &
-  Partial<FeeValuesLegacy<TQuantity>> & {
-    accessList?: AccessList
+  ExactPartial<FeeValuesLegacy<TQuantity>> & {
+    accessList?: AccessList | undefined
     blobs?: undefined
     blobVersionedHashes?: undefined
     chainId: number
-    type?: 'eip2930'
-    yParity?: number
+    type?: 'eip2930' | undefined
+    yParity?: number | undefined
   }
 
 export type TransactionSerializableEIP1559<
   TQuantity = bigint,
   TIndex = number,
 > = TransactionSerializableBase<TQuantity, TIndex> &
-  Partial<FeeValuesEIP1559<TQuantity>> & {
-    accessList?: AccessList
+  ExactPartial<FeeValuesEIP1559<TQuantity>> & {
+    accessList?: AccessList | undefined
     blobs?: undefined
     blobVersionedHashes?: undefined
     chainId: number
-    type?: 'eip1559'
-    yParity?: number
+    type?: 'eip1559' | undefined
+    yParity?: number | undefined
   }
 
 export type TransactionSerializableEIP4844<
   TQuantity = bigint,
   TIndex = number,
 > = TransactionSerializableBase<TQuantity, TIndex> &
-  Partial<FeeValuesEIP4844<TQuantity>> & {
-    accessList?: AccessList
+  ExactPartial<FeeValuesEIP4844<TQuantity>> & {
+    accessList?: AccessList | undefined
     chainId: number
-    type?: 'eip4844'
-    yParity?: number
+    type?: 'eip4844' | undefined
+    yParity?: number | undefined
   } & OneOf<
     | {
         blobVersionedHashes: readonly Hex[]
-        sidecars?: readonly BlobSidecar<Hex>[] | false
+        sidecars?: readonly BlobSidecar<Hex>[] | false | undefined
       }
     | {
         blobs: readonly Hex[] | readonly ByteArray[]
         kzg: Kzg
-        sidecars?: false
+        sidecars?: false | undefined
       }
   >
 
@@ -311,16 +318,16 @@ export type TransactionSerializableGeneric<
   TQuantity = bigint,
   TIndex = number,
 > = TransactionSerializableBase<TQuantity, TIndex> & {
-  accessList?: AccessList
-  blobs?: readonly Hex[] | readonly ByteArray[]
-  blobVersionedHashes?: readonly Hex[]
-  chainId?: number
-  gasPrice?: TQuantity
-  maxFeePerBlobGas?: TQuantity
-  maxFeePerGas?: TQuantity
-  maxPriorityFeePerGas?: TQuantity
-  sidecars?: readonly BlobSidecar<Hex>[] | false
-  type?: string
+  accessList?: AccessList | undefined
+  blobs?: readonly Hex[] | readonly ByteArray[] | undefined
+  blobVersionedHashes?: readonly Hex[] | undefined
+  chainId?: number | undefined
+  gasPrice?: TQuantity | undefined
+  maxFeePerBlobGas?: TQuantity | undefined
+  maxFeePerGas?: TQuantity | undefined
+  maxPriorityFeePerGas?: TQuantity | undefined
+  sidecars?: readonly BlobSidecar<Hex>[] | false | undefined
+  type?: string | undefined
 }
 
 export type TransactionSerializable<

package/types/typedData.ts

@@ -56,5 +56,5 @@ type EIP712DomainDefinition<
   domain: schema extends { EIP712Domain: infer domain }
     ? domain
     : Prettify<TypedDataDomain>
-  message?: never
+  message?: never | undefined
 }

package/types/utils.ts

@@ -115,7 +115,7 @@ export type MaybePromise<T> = T | Promise<T>
  * => { a: string, b?: number }
  */
 export type MaybeRequired<T, TRequired extends boolean> = TRequired extends true
-  ? Required<T>
+  ? ExactRequired<T>
   : T
 
 /**
@@ -166,7 +166,8 @@ export type Omit<type, keys extends keyof type> = Pick<
  * PartialBy<{ a: string, b: number }, 'a'>
  * => { a?: string, b: number }
  */
-export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>
+export type PartialBy<T, K extends keyof T> = Omit<T, K> &
+  ExactPartial<Pick<T, K>>
 
 /**
  * @description Combines members of an intersection into a readable type.
@@ -187,7 +188,8 @@ export type Prettify<T> = {
  * RequiredBy<{ a?: string, b: number }, 'a'>
  * => { a: string, b: number }
  */
-export type RequiredBy<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>
+export type RequiredBy<T, K extends keyof T> = Omit<T, K> &
+  ExactRequired<Pick<T, K>>
 
 /**
  * @description Creates a type that extracts the values of T.
@@ -231,6 +233,10 @@ export type ExactPartial<type> = {
   [key in keyof type]?: type[key] | undefined
 }
 
+export type ExactRequired<type> = {
+  [P in keyof type]-?: Exclude<type[P], undefined>
+}
+
 export type OneOf<
   union extends object,
   fallback extends object | undefined = undefined,

package/types/window.ts

@@ -2,6 +2,6 @@ import type { EIP1193Provider } from './eip1193.js'
 
 declare global {
   interface Window {
-    ethereum?: EIP1193Provider
+    ethereum?: EIP1193Provider | undefined
   }
 }

package/utils/abi/decodeEventLog.ts

@@ -46,7 +46,7 @@ export type DecodeEventLogParameters<
 > = {
   abi: abi
   data?: data | undefined
-  eventName?: eventName | ContractEventName<abi>
+  eventName?: eventName | ContractEventName<abi> | undefined
   strict?: strict | boolean | undefined
   topics: [signature: Hex, ...args: topics] | []
 }

package/utils/abi/decodeFunctionResult.ts

@@ -64,9 +64,9 @@ export type DecodeFunctionResultParameters<
 } & UnionEvaluate<
   IsNarrowable<abi, Abi> extends true
     ? abi['length'] extends 1
-      ? { functionName?: functionName | allFunctionNames }
+      ? { functionName?: functionName | allFunctionNames | undefined }
       : { functionName: functionName | allFunctionNames }
-    : { functionName?: functionName | allFunctionNames }
+    : { functionName?: functionName | allFunctionNames | undefined }
 > &
   UnionEvaluate<
     readonly [] extends allArgs

package/utils/abi/encodeAbiParameters.ts

@@ -20,6 +20,7 @@ import {
   InvalidAddressError,
   type InvalidAddressErrorType,
 } from '../../errors/address.js'
+import { BaseError } from '../../errors/base.js'
 import type { ErrorType } from '../../errors/utils.js'
 import type { Hex } from '../../types/misc.js'
 import { type IsAddressErrorType, isAddress } from '../address/isAddress.js'
@@ -311,6 +312,10 @@ export type EncodeBoolErrorType =
   | ErrorType
 
 function encodeBool(value: boolean): PreparedParam {
+  if (typeof value !== 'boolean')
+    throw new BaseError(
+      `Invalid boolean value: "${value}" (type: ${typeof value}). Expected: \`true\` or \`false\`.`,
+    )
   return { dynamic: false, encoded: padHex(boolToHex(value)) }
 }
 

package/utils/abi/encodeErrorResult.ts

@@ -50,9 +50,9 @@ export type EncodeErrorResultParameters<
 } & UnionEvaluate<
   IsNarrowable<abi, Abi> extends true
     ? abi['length'] extends 1
-      ? { errorName?: errorName | allErrorNames }
+      ? { errorName?: errorName | allErrorNames | undefined }
       : { errorName: errorName | allErrorNames }
-    : { errorName?: errorName | allErrorNames }
+    : { errorName?: errorName | allErrorNames | undefined }
 > &
   (hasErrors extends true ? unknown : never)
 

package/utils/abi/encodeEventTopics.ts

@@ -60,9 +60,9 @@ export type EncodeEventTopicsParameters<
 } & UnionEvaluate<
   IsNarrowable<abi, Abi> extends true
     ? abi['length'] extends 1
-      ? { eventName?: eventName | allErrorNames }
+      ? { eventName?: eventName | allErrorNames | undefined }
       : { eventName: eventName | allErrorNames }
-    : { eventName?: eventName | allErrorNames }
+    : { eventName?: eventName | allErrorNames | undefined }
 > &
   (hasEvents extends true ? unknown : never)
 

package/utils/abi/encodeFunctionData.ts

@@ -52,9 +52,9 @@ export type EncodeFunctionDataParameters<
 } & UnionEvaluate<
   IsNarrowable<abi, Abi> extends true
     ? abi['length'] extends 1
-      ? { functionName?: functionName | allFunctionNames }
+      ? { functionName?: functionName | allFunctionNames | undefined }
       : { functionName: functionName | allFunctionNames }
-    : { functionName?: functionName | allFunctionNames }
+    : { functionName?: functionName | allFunctionNames | undefined }
 > &
   UnionEvaluate<
     readonly [] extends allArgs

package/utils/abi/encodeFunctionResult.ts

@@ -49,9 +49,9 @@ export type EncodeFunctionResultParameters<
 } & UnionEvaluate<
   IsNarrowable<abi, Abi> extends true
     ? abi['length'] extends 1
-      ? { functionName?: functionName | allFunctionNames }
+      ? { functionName?: functionName | allFunctionNames | undefined }
       : { functionName: functionName | allFunctionNames }
-    : { functionName?: functionName | allFunctionNames }
+    : { functionName?: functionName | allFunctionNames | undefined }
 > &
   (hasFunctions extends true ? unknown : never)
 

package/utils/abi/formatAbiItem.ts

@@ -14,7 +14,7 @@ export type FormatAbiItemErrorType =
 
 export function formatAbiItem(
   abiItem: AbiItem,
-  { includeName = false }: { includeName?: boolean } = {},
+  { includeName = false }: { includeName?: boolean | undefined } = {},
 ) {
   if (
     abiItem.type !== 'function' &&
@@ -30,7 +30,7 @@ export type FormatAbiParamsErrorType = ErrorType
 
 export function formatAbiParams(
   params: readonly AbiParameter[] | undefined,
-  { includeName = false }: { includeName?: boolean } = {},
+  { includeName = false }: { includeName?: boolean | undefined } = {},
 ): string {
   if (!params) return ''
   return params

package/utils/abi/formatAbiItemWithArgs.ts

@@ -14,8 +14,8 @@ export function formatAbiItemWithArgs({
 }: {
   abiItem: AbiItem
   args: readonly unknown[]
-  includeFunctionName?: boolean
-  includeName?: boolean
+  includeFunctionName?: boolean | undefined
+  includeName?: boolean | undefined
 }) {
   if (!('name' in abiItem)) return
   if (!('inputs' in abiItem)) return

package/utils/address/getAddress.ts

@@ -14,7 +14,10 @@ export type ChecksumAddressErrorType =
   | StringToBytesErrorType
   | ErrorType
 
-export function checksumAddress(address_: Address, chainId?: number): Address {
+export function checksumAddress(
+  address_: Address,
+  chainId?: number | undefined,
+): Address {
   const hexAddress = chainId
     ? `${chainId}${address_.toLowerCase()}`
     : address_.substring(2).toLowerCase()

package/utils/address/getContractAddress.ts

@@ -31,7 +31,7 @@ export type GetCreate2AddressOptions =
 
 export type GetContractAddressOptions =
   | ({
-      opcode?: 'CREATE'
+      opcode?: 'CREATE' | undefined
     } & GetCreateAddressOptions)
   | ({ opcode: 'CREATE2' } & GetCreate2AddressOptions)
 

package/utils/address/isAddress.ts

@@ -13,7 +13,7 @@ export type IsAddressOptions = {
    *
    * @default true
    */
-  strict?: boolean
+  strict?: boolean | undefined
 }
 
 export type IsAddressErrorType = ErrorType

package/utils/blob/commitmentToVersionedHash.ts

@@ -14,7 +14,7 @@ export type CommitmentToVersionedHashParameters<
   /** Return type. */
   to?: to | To | undefined
   /** Version to tag onto the hash. */
-  version?: number
+  version?: number | undefined
 }
 
 export type CommitmentToVersionedHashReturnType<to extends To> =

package/utils/blob/commitmentsToVersionedHashes.ts

@@ -16,7 +16,7 @@ export type CommitmentsToVersionedHashesParameters<
   /** Return type. */
   to?: to | To | undefined
   /** Version to tag onto the hashes. */
-  version?: number
+  version?: number | undefined
 }
 
 export type CommitmentsToVersionedHashesReturnType<to extends To> =

package/utils/blob/sidecarsToVersionedHashes.ts

@@ -17,7 +17,7 @@ export type SidecarsToVersionedHashesParameters<
   /** Return type. */
   to?: to | To | undefined
   /** Version to tag onto the hashes. */
-  version?: number
+  version?: number | undefined
 }
 
 export type SidecarsToVersionedHashesReturnType<to extends To> =

package/utils/chain/assertCurrentChain.ts

@@ -8,7 +8,7 @@ import type { ErrorType } from '../../errors/utils.js'
 import type { Chain } from '../../types/chain.js'
 
 export type AssertCurrentChainParameters = {
-  chain?: Chain
+  chain?: Chain | undefined
   currentChainId: number
 }
 

package/utils/chain/getChainContractAddress.ts

@@ -12,7 +12,7 @@ export function getChainContractAddress({
   chain,
   contract: name,
 }: {
-  blockNumber?: bigint
+  blockNumber?: bigint | undefined
   chain: Chain
   contract: string
 }) {

package/utils/cursor.ts

@@ -210,7 +210,7 @@ const staticCursor: Cursor = {
   },
 }
 
-type CursorConfig = { recursiveReadLimit?: number }
+type CursorConfig = { recursiveReadLimit?: number | undefined }
 
 export function createCursor(
   bytes: ByteArray,

package/utils/data/isHex.ts

@@ -5,7 +5,7 @@ export type IsHexErrorType = ErrorType
 
 export function isHex(
   value: unknown,
-  { strict = true }: { strict?: boolean } = {},
+  { strict = true }: { strict?: boolean | undefined } = {},
 ): value is Hex {
   if (!value) return false
   if (typeof value !== 'string') return false