viem 2.13.6 → 2.13.8

package/types/transaction.ts

@@ -13,11 +13,15 @@ import type {
   Branded,
   ExactPartial,
   IsNever,
+  Omit,
   OneOf,
   RequiredBy,
 } from './utils.js'
 
-export type AccessList = { address: Address; storageKeys: Hex[] }[]
+export type AccessList = readonly {
+  address: Address
+  storageKeys: readonly Hex[]
+}[]
 
 export type TransactionType =
   | 'legacy'
@@ -27,66 +31,66 @@ export type TransactionType =
   | (string & {})
 
 export type TransactionReceipt<
-  TQuantity = bigint,
-  TIndex = number,
-  TStatus = 'success' | 'reverted',
-  TType = TransactionType,
+  quantity = bigint,
+  index = number,
+  status = 'success' | 'reverted',
+  type = 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 | undefined
+  blobGasPrice?: quantity | undefined
   /** The amount of blob gas used. Only specified for blob transactions as defined by EIP-4844. */
-  blobGasUsed?: TQuantity | undefined
+  blobGasUsed?: quantity | undefined
   /** Hash of block containing this transaction */
   blockHash: Hash
   /** Number of block containing this transaction */
-  blockNumber: TQuantity
+  blockNumber: quantity
   /** Address of new contract or `null` if no contract was created */
   contractAddress: Address | null | undefined
   /** Gas used by this and all preceding transactions in this block */
-  cumulativeGasUsed: TQuantity
+  cumulativeGasUsed: quantity
   /** Pre-London, it is equal to the transaction's gasPrice. Post-London, it is equal to the actual gas price paid for inclusion. */
-  effectiveGasPrice: TQuantity
+  effectiveGasPrice: quantity
   /** Transaction sender */
   from: Address
   /** Gas used by this transaction */
-  gasUsed: TQuantity
+  gasUsed: quantity
   /** List of log objects generated by this transaction */
-  logs: Log<TQuantity, TIndex, false>[]
+  logs: Log<quantity, index, false>[]
   /** Logs bloom filter */
   logsBloom: Hex
   /** The post-transaction state root. Only specified for transactions included before the Byzantium upgrade. */
   root?: Hash | undefined
   /** `success` if this transaction was successful or `reverted` if it failed */
-  status: TStatus
+  status: status
   /** Transaction recipient or `null` if deploying a contract */
   to: Address | null
   /** Hash of this transaction */
   transactionHash: Hash
   /** Index of this transaction in the block */
-  transactionIndex: TIndex
+  transactionIndex: index
   /** Transaction type */
-  type: TType
+  type: type
 }
 
 export type TransactionBase<
-  TQuantity = bigint,
-  TIndex = number,
-  TPending extends boolean = boolean,
+  quantity = bigint,
+  index = number,
+  isPending extends boolean = boolean,
 > = {
   /** Hash of block containing this transaction or `null` if pending */
-  blockHash: TPending extends true ? null : Hash
+  blockHash: isPending extends true ? null : Hash
   /** Number of block containing this transaction or `null` if pending */
-  blockNumber: TPending extends true ? null : TQuantity
+  blockNumber: isPending extends true ? null : quantity
   /** Transaction sender */
   from: Address
   /** Gas provided for transaction execution */
-  gas: TQuantity
+  gas: quantity
   /** Hash of this transaction */
   hash: Hash
   /** Contract code or a hashed method call */
   input: Hex
   /** Unique number identifying this transaction */
-  nonce: TIndex
+  nonce: index
   /** ECDSA signature r */
   r: Hex
   /** ECDSA signature s */
@@ -94,233 +98,241 @@ export type TransactionBase<
   /** Transaction recipient or `null` if deploying a contract */
   to: Address | null
   /** Index of this transaction in the block or `null` if pending */
-  transactionIndex: TPending extends true ? null : TIndex
+  transactionIndex: isPending extends true ? null : index
   /** The type represented as hex. */
   typeHex: Hex | null
   /** ECDSA recovery ID */
-  v: TQuantity
+  v: quantity
   /** Value in wei sent with this transaction */
-  value: TQuantity
+  value: quantity
   /** The parity of the y-value of the secp256k1 signature. */
-  yParity: TIndex
+  yParity: index
 }
+
 export type TransactionLegacy<
-  TQuantity = bigint,
-  TIndex = number,
-  TPending extends boolean = boolean,
-  TType = 'legacy',
-> = Omit<TransactionBase<TQuantity, TIndex, TPending>, 'yParity'> &
-  FeeValuesLegacy<TQuantity> & {
-    /** EIP-2930 Access List. */
-    accessList?: undefined
-    blobVersionedHashes?: undefined
-    /** Chain ID that this transaction is valid on. */
-    chainId?: TIndex | undefined
-    yParity?: undefined
-    type: TType
-  }
+  quantity = bigint,
+  index = number,
+  isPending extends boolean = boolean,
+  type = 'legacy',
+> = Omit<TransactionBase<quantity, index, isPending>, 'yParity'> & {
+  /** EIP-2930 Access List. */
+  accessList?: undefined
+  blobVersionedHashes?: undefined
+  /** Chain ID that this transaction is valid on. */
+  chainId?: index | undefined
+  yParity?: undefined
+  type: type
+} & FeeValuesLegacy<quantity>
+
 export type TransactionEIP2930<
-  TQuantity = bigint,
-  TIndex = number,
-  TPending extends boolean = boolean,
-  TType = 'eip2930',
-> = TransactionBase<TQuantity, TIndex, TPending> &
-  FeeValuesLegacy<TQuantity> & {
-    /** EIP-2930 Access List. */
-    accessList: AccessList
-    blobVersionedHashes?: undefined
-    /** Chain ID that this transaction is valid on. */
-    chainId: TIndex
-    type: TType
-  }
+  quantity = bigint,
+  index = number,
+  isPending extends boolean = boolean,
+  type = 'eip2930',
+> = TransactionBase<quantity, index, isPending> & {
+  /** EIP-2930 Access List. */
+  accessList: AccessList
+  blobVersionedHashes?: undefined
+  /** Chain ID that this transaction is valid on. */
+  chainId: index
+  type: type
+} & FeeValuesLegacy<quantity>
+
 export type TransactionEIP1559<
-  TQuantity = bigint,
-  TIndex = number,
-  TPending extends boolean = boolean,
-  TType = 'eip1559',
-> = TransactionBase<TQuantity, TIndex, TPending> &
-  FeeValuesEIP1559<TQuantity> & {
-    /** EIP-2930 Access List. */
-    accessList: AccessList
-    blobVersionedHashes?: undefined
-    /** Chain ID that this transaction is valid on. */
-    chainId: TIndex
-    type: TType
-  }
+  quantity = bigint,
+  index = number,
+  isPending extends boolean = boolean,
+  type = 'eip1559',
+> = TransactionBase<quantity, index, isPending> & {
+  /** EIP-2930 Access List. */
+  accessList: AccessList
+  blobVersionedHashes?: undefined
+  /** Chain ID that this transaction is valid on. */
+  chainId: index
+  type: type
+} & FeeValuesEIP1559<quantity>
+
 export type TransactionEIP4844<
-  TQuantity = bigint,
-  TIndex = number,
-  TPending extends boolean = boolean,
-  TType = 'eip4844',
-> = TransactionBase<TQuantity, TIndex, TPending> &
-  FeeValuesEIP4844<TQuantity> & {
-    /** EIP-2930 Access List. */
-    accessList: AccessList
-    /** List of versioned blob hashes associated with the transaction's blobs. */
-    blobVersionedHashes: readonly Hex[]
-    /** Chain ID that this transaction is valid on. */
-    chainId: TIndex
-    type: TType
-  }
+  quantity = bigint,
+  index = number,
+  isPending extends boolean = boolean,
+  type = 'eip4844',
+> = TransactionBase<quantity, index, isPending> & {
+  /** EIP-2930 Access List. */
+  accessList: AccessList
+  /** List of versioned blob hashes associated with the transaction's blobs. */
+  blobVersionedHashes: readonly Hex[]
+  /** Chain ID that this transaction is valid on. */
+  chainId: index
+  type: type
+} & FeeValuesEIP4844<quantity>
+
 export type Transaction<
-  TQuantity = bigint,
-  TIndex = number,
-  TPending extends boolean = boolean,
+  quantity = bigint,
+  index = number,
+  isPending extends boolean = boolean,
 > = OneOf<
-  | TransactionLegacy<TQuantity, TIndex, TPending>
-  | TransactionEIP2930<TQuantity, TIndex, TPending>
-  | TransactionEIP1559<TQuantity, TIndex, TPending>
-  | TransactionEIP4844<TQuantity, TIndex, TPending>
+  | TransactionLegacy<quantity, index, isPending>
+  | TransactionEIP2930<quantity, index, isPending>
+  | TransactionEIP1559<quantity, index, isPending>
+  | TransactionEIP4844<quantity, index, isPending>
 >
 
-export type TransactionRequestBase<TQuantity = bigint, TIndex = number> = {
+////////////////////////////////////////////////////////////////////////////////////////////
+// Request
+////////////////////////////////////////////////////////////////////////////////////////////
+
+export type TransactionRequestBase<quantity = bigint, index = number> = {
   /** Contract code or a hashed method call with encoded args */
   data?: Hex | undefined
   /** Transaction sender */
   from: Address
   /** Gas provided for transaction execution */
-  gas?: TQuantity | undefined
+  gas?: quantity | undefined
   /** Unique number identifying this transaction */
-  nonce?: TIndex | undefined
+  nonce?: index | undefined
   /** Transaction recipient */
   to?: Address | null | undefined
   /** Value in wei sent with this transaction */
-  value?: TQuantity | undefined
+  value?: quantity | undefined
 }
+
 export type TransactionRequestLegacy<
-  TQuantity = bigint,
-  TIndex = number,
-  TTransactionType = 'legacy',
-> = TransactionRequestBase<TQuantity, TIndex> &
-  ExactPartial<FeeValuesLegacy<TQuantity>> & {
-    accessList?: undefined
-    blobs?: undefined
-    type?: TTransactionType | undefined
-  }
+  quantity = bigint,
+  index = number,
+  type = 'legacy',
+> = TransactionRequestBase<quantity, index> & {
+  accessList?: undefined
+  blobs?: undefined
+  type?: type | undefined
+} & ExactPartial<FeeValuesLegacy<quantity>>
+
 export type TransactionRequestEIP2930<
-  TQuantity = bigint,
-  TIndex = number,
-  TTransactionType = 'eip2930',
-> = TransactionRequestBase<TQuantity, TIndex> &
-  ExactPartial<FeeValuesLegacy<TQuantity>> & {
-    accessList?: AccessList | undefined
-    blobs?: undefined
-    type?: TTransactionType | undefined
-  }
+  quantity = bigint,
+  index = number,
+  type = 'eip2930',
+> = TransactionRequestBase<quantity, index> & {
+  accessList?: AccessList | undefined
+  blobs?: undefined
+  type?: type | undefined
+} & ExactPartial<FeeValuesLegacy<quantity>>
+
 export type TransactionRequestEIP1559<
-  TQuantity = bigint,
-  TIndex = number,
-  TTransactionType = 'eip1559',
-> = TransactionRequestBase<TQuantity, TIndex> &
-  ExactPartial<FeeValuesEIP1559<TQuantity>> & {
+  quantity = bigint,
+  index = number,
+  type = 'eip1559',
+> = TransactionRequestBase<quantity, index> &
+  ExactPartial<FeeValuesEIP1559<quantity>> & {
     accessList?: AccessList | undefined
     blobs?: undefined
-    type?: TTransactionType | undefined
+    type?: type | undefined
   }
+
 export type TransactionRequestEIP4844<
-  TQuantity = bigint,
-  TIndex = number,
-  TTransactionType = 'eip4844',
-> = RequiredBy<TransactionRequestBase<TQuantity, TIndex>, 'to'> &
-  RequiredBy<ExactPartial<FeeValuesEIP4844<TQuantity>>, 'maxFeePerBlobGas'> & {
-    accessList?: AccessList | undefined
-    /** The blobs associated with this transaction. */
-    blobs: readonly Hex[] | readonly ByteArray[]
-    blobVersionedHashes?: readonly Hex[] | undefined
-    kzg?: Kzg | undefined
-    sidecars?: readonly BlobSidecar<Hex>[] | undefined
-    type?: TTransactionType | undefined
-  }
-export type TransactionRequest<TQuantity = bigint, TIndex = number> = OneOf<
-  | TransactionRequestLegacy<TQuantity, TIndex>
-  | TransactionRequestEIP2930<TQuantity, TIndex>
-  | TransactionRequestEIP1559<TQuantity, TIndex>
-  | TransactionRequestEIP4844<TQuantity, TIndex>
+  quantity = bigint,
+  index = number,
+  type = 'eip4844',
+> = RequiredBy<TransactionRequestBase<quantity, index>, 'to'> & {
+  accessList?: AccessList | undefined
+  /** The blobs associated with this transaction. */
+  blobs: readonly Hex[] | readonly ByteArray[]
+  blobVersionedHashes?: readonly Hex[] | undefined
+  kzg?: Kzg | undefined
+  sidecars?: readonly BlobSidecar<Hex>[] | undefined
+  type?: type | undefined
+} & RequiredBy<ExactPartial<FeeValuesEIP4844<quantity>>, 'maxFeePerBlobGas'>
+
+export type TransactionRequest<quantity = bigint, index = number> = OneOf<
+  | TransactionRequestLegacy<quantity, index>
+  | TransactionRequestEIP2930<quantity, index>
+  | TransactionRequestEIP1559<quantity, index>
+  | TransactionRequestEIP4844<quantity, index>
 >
 
 export type TransactionRequestGeneric<
-  TQuantity = bigint,
-  TIndex = number,
-> = TransactionRequestBase<TQuantity, TIndex> & {
+  quantity = bigint,
+  index = number,
+> = TransactionRequestBase<quantity, index> & {
   accessList?: AccessList | undefined
   blobs?: readonly Hex[] | readonly ByteArray[] | undefined
   blobVersionedHashes?: readonly Hex[] | undefined
-  gasPrice?: TQuantity | undefined
-  maxFeePerBlobGas?: TQuantity | undefined
-  maxFeePerGas?: TQuantity | undefined
-  maxPriorityFeePerGas?: TQuantity | undefined
+  gasPrice?: quantity | undefined
+  maxFeePerBlobGas?: quantity | undefined
+  maxFeePerGas?: quantity | undefined
+  maxPriorityFeePerGas?: quantity | undefined
   type?: string | undefined
 }
 
+////////////////////////////////////////////////////////////////////////////////////////////
+// Serializable
+////////////////////////////////////////////////////////////////////////////////////////////
+
 export type TransactionSerializedEIP1559 = `0x02${string}`
 export type TransactionSerializedEIP2930 = `0x01${string}`
 export type TransactionSerializedEIP4844 = `0x03${string}`
 export type TransactionSerializedLegacy = Branded<`0x${string}`, 'legacy'>
 export type TransactionSerializedGeneric = `0x${string}`
 export type TransactionSerialized<
-  TType extends TransactionType = TransactionType,
+  type extends TransactionType = TransactionType,
   result =
-    | (TType extends 'eip1559' ? TransactionSerializedEIP1559 : never)
-    | (TType extends 'eip2930' ? TransactionSerializedEIP2930 : never)
-    | (TType extends 'eip4844' ? TransactionSerializedEIP4844 : never)
-    | (TType extends 'legacy' ? TransactionSerializedLegacy : never),
+    | (type extends 'eip1559' ? TransactionSerializedEIP1559 : never)
+    | (type extends 'eip2930' ? TransactionSerializedEIP2930 : never)
+    | (type extends 'eip4844' ? TransactionSerializedEIP4844 : never)
+    | (type extends 'legacy' ? TransactionSerializedLegacy : never),
 > = IsNever<result> extends true ? TransactionSerializedGeneric : result
 
 export type TransactionSerializableBase<
-  TQuantity = bigint,
-  TIndex = number,
-> = Omit<TransactionRequestBase<TQuantity, TIndex>, 'from'> &
+  quantity = bigint,
+  index = number,
+> = Omit<TransactionRequestBase<quantity, index>, 'from'> &
   ExactPartial<Signature>
 
 export type TransactionSerializableLegacy<
-  TQuantity = bigint,
-  TIndex = number,
-> = TransactionSerializableBase<TQuantity, TIndex> &
-  ExactPartial<FeeValuesLegacy<TQuantity>> & {
-    accessList?: undefined
-    blobs?: undefined
-    blobVersionedHashes?: undefined
-    chainId?: number | undefined
-    type?: 'legacy' | undefined
-  }
+  quantity = bigint,
+  index = number,
+> = TransactionSerializableBase<quantity, index> & {
+  accessList?: undefined
+  blobs?: undefined
+  blobVersionedHashes?: undefined
+  chainId?: number | undefined
+  type?: 'legacy' | undefined
+} & ExactPartial<FeeValuesLegacy<quantity>>
 
 export type TransactionSerializableEIP2930<
-  TQuantity = bigint,
-  TIndex = number,
-> = TransactionSerializableBase<TQuantity, TIndex> &
-  ExactPartial<FeeValuesLegacy<TQuantity>> & {
-    accessList?: AccessList | undefined
-    blobs?: undefined
-    blobVersionedHashes?: undefined
-    chainId: number
-    type?: 'eip2930' | undefined
-    yParity?: number | undefined
-  }
+  quantity = bigint,
+  index = number,
+> = TransactionSerializableBase<quantity, index> & {
+  accessList?: AccessList | undefined
+  blobs?: undefined
+  blobVersionedHashes?: undefined
+  chainId: number
+  type?: 'eip2930' | undefined
+  yParity?: number | undefined
+} & ExactPartial<FeeValuesLegacy<quantity>>
 
 export type TransactionSerializableEIP1559<
-  TQuantity = bigint,
-  TIndex = number,
-> = TransactionSerializableBase<TQuantity, TIndex> &
-  ExactPartial<FeeValuesEIP1559<TQuantity>> & {
-    accessList?: AccessList | undefined
-    blobs?: undefined
-    blobVersionedHashes?: undefined
-    chainId: number
-    type?: 'eip1559' | undefined
-    yParity?: number | undefined
-  }
+  quantity = bigint,
+  index = number,
+> = TransactionSerializableBase<quantity, index> & {
+  accessList?: AccessList | undefined
+  blobs?: undefined
+  blobVersionedHashes?: undefined
+  chainId: number
+  type?: 'eip1559' | undefined
+  yParity?: number | undefined
+} & ExactPartial<FeeValuesEIP1559<quantity>>
 
 export type TransactionSerializableEIP4844<
-  TQuantity = bigint,
-  TIndex = number,
-> = TransactionSerializableBase<TQuantity, TIndex> &
-  ExactPartial<FeeValuesEIP4844<TQuantity>> & {
-    accessList?: AccessList | undefined
-    chainId: number
-    sidecars?: readonly BlobSidecar<Hex>[] | false | undefined
-    type?: 'eip4844' | undefined
-    yParity?: number | undefined
-  } & OneOf<
+  quantity = bigint,
+  index = number,
+> = TransactionSerializableBase<quantity, index> & {
+  accessList?: AccessList | undefined
+  chainId: number
+  sidecars?: readonly BlobSidecar<Hex>[] | false | undefined
+  type?: 'eip4844' | undefined
+  yParity?: number | undefined
+} & ExactPartial<FeeValuesEIP4844<quantity>> &
+  OneOf<
     | {
         blobs?: readonly Hex[] | readonly ByteArray[] | undefined
         blobVersionedHashes: readonly Hex[]
@@ -332,28 +344,25 @@ export type TransactionSerializableEIP4844<
       }
   >
 
+export type TransactionSerializable<quantity = bigint, index = number> = OneOf<
+  | TransactionSerializableLegacy<quantity, index>
+  | TransactionSerializableEIP2930<quantity, index>
+  | TransactionSerializableEIP1559<quantity, index>
+  | TransactionSerializableEIP4844<quantity, index>
+>
+
 export type TransactionSerializableGeneric<
-  TQuantity = bigint,
-  TIndex = number,
-> = TransactionSerializableBase<TQuantity, TIndex> & {
+  quantity = bigint,
+  index = number,
+> = TransactionSerializableBase<quantity, index> & {
   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
+  gasPrice?: quantity | undefined
+  maxFeePerBlobGas?: quantity | undefined
+  maxFeePerGas?: quantity | undefined
+  maxPriorityFeePerGas?: quantity | undefined
   sidecars?: readonly BlobSidecar<Hex>[] | false | undefined
   type?: string | undefined
 }
-
-export type TransactionSerializable<
-  TQuantity = bigint,
-  TIndex = number,
-> = OneOf<
-  | TransactionSerializableLegacy<TQuantity, TIndex>
-  | TransactionSerializableEIP2930<TQuantity, TIndex>
-  | TransactionSerializableEIP1559<TQuantity, TIndex>
-  | TransactionSerializableEIP4844<TQuantity, TIndex>
->

package/types/transport.ts

@@ -36,7 +36,9 @@ export type HasTransportType<
   type extends string,
 > = GetTransportConfig<transport>['type'] extends type
   ? true
-  : transport extends FallbackTransport<infer transports extends Transport[]>
+  : transport extends FallbackTransport<
+        infer transports extends readonly Transport[]
+      >
     ? Some<
         {
           [key in keyof transports]: GetTransportConfig<transports[key]>['type']

package/types/utils.ts

@@ -57,6 +57,11 @@ export type IsNarrowable<T, U> = IsNever<
  */
 export type IsNever<T> = [T] extends [never] ? true : false
 
+/** Removes `readonly` from all properties of an object. */
+export type Mutable<type extends object> = {
+  -readonly [key in keyof type]: type[key]
+}
+
 /**
  * @description Returns type {@link T} if it is an opaque type of {@link U}
  * @param T - Type to check
@@ -154,9 +159,12 @@ export type NoInfer<type> = [type][type extends any ? 0 : never]
  * @example
  * NoUndefined<string | undefined>
  * => string
+ *
+ * @internal
  */
 export type NoUndefined<T> = T extends undefined ? never : T
 
+/** Strict version of built-in Omit type */
 export type Omit<type, keys extends keyof type> = Pick<
   type,
   Exclude<keyof type, keys>
@@ -184,6 +192,11 @@ export type Prettify<T> = {
   [K in keyof T]: T[K]
 } & {}
 
+/** @internal */
+export type Evaluate<type> = {
+  [key in keyof type]: type[key]
+} & {}
+
 /**
  * @description Creates a type that is T with the required keys K.
  *
@@ -201,12 +214,12 @@ export type RequiredBy<T, K extends keyof T> = Omit<T, K> &
  * Some<[1, 2, 3], 2>
  * => true
  */
-export type Some<array extends unknown[], value> = array extends [
+export type Some<
+  array extends readonly unknown[],
   value,
-  ...unknown[],
-]
+> = array extends readonly [value, ...unknown[]]
   ? true
-  : array extends [unknown, ...infer rest]
+  : array extends readonly [unknown, ...infer rest]
     ? Some<rest, value>
     : false
 
@@ -216,6 +229,8 @@ export type Some<array extends unknown[], value> = array extends [
  * @example
  * ValueOf<{ a: string, b: number }>
  * => string | number
+ *
+ * @internal
  */
 export type ValueOf<T> = T[keyof T]
 
@@ -276,7 +291,10 @@ type KeyofUnion<type> = type extends type ? keyof type : never
 ///////////////////////////////////////////////////////////////////////////
 // Loose types
 
-/** Loose version of {@link Omit} */
+/**
+ * Loose version of {@link Omit}
+ * @internal
+ */
 export type LooseOmit<type, keys extends string> = Pick<
   type,
   Exclude<keyof type, keys>