viem 2.13.5 → 2.13.7

package/types/chain.ts

@@ -61,41 +61,12 @@ export type Chain<
 
   /** Custom chain data. */
   custom?: custom | undefined
-  /**
-   * Modifies how chain data structures (ie. Blocks, Transactions, etc)
-   * are formatted & typed.
-   */
-  formatters?: formatters | undefined
-  /** Modifies how data (ie. Transactions) is serialized. */
-  serializers?: ChainSerializers<formatters> | undefined
   /** Modifies how fees are derived. */
   fees?: ChainFees<formatters | undefined> | undefined
-}
-
-/////////////////////////////////////////////////////////////////////
-// Constants
-
-type ChainBlockExplorer = {
-  name: string
-  url: string
-  apiUrl?: string | undefined
-}
-
-export type ChainContract = {
-  address: Address
-  blockCreated?: number | undefined
-}
-
-type ChainNativeCurrency = {
-  name: string
-  /** 2-6 characters long */
-  symbol: string
-  decimals: number
-}
-
-type ChainRpcUrls = {
-  http: readonly string[]
-  webSocket?: readonly string[] | undefined
+  /** Modifies how data is formatted and typed (e.g. blocks and transactions) */
+  formatters?: formatters | undefined
+  /** Modifies how data is serialized (e.g. transactions). */
+  serializers?: ChainSerializers<formatters> | undefined
 }
 
 /////////////////////////////////////////////////////////////////////
@@ -129,17 +100,13 @@ export type ChainFees<
    * Overrides the return value in the [`estimateFeesPerGas` Action](/docs/actions/public/estimateFeesPerGas).
    */
   estimateFeesPerGas?:
-    | ChainEstimateFeesPerGasFn<formatters>
     | bigint
+    | ((
+        args: ChainEstimateFeesPerGasFnParameters<formatters>,
+      ) => Promise<EstimateFeesPerGasReturnType | null>)
     | undefined
 }
 
-export type ChainEstimateFeesPerGasFn<
-  formatters extends ChainFormatters | undefined = ChainFormatters | undefined,
-> = (
-  args: ChainEstimateFeesPerGasFnParameters<formatters>,
-) => Promise<EstimateFeesPerGasReturnType | null>
-
 export type ChainFormatters = {
   /** Modifies how the Block structure is formatted & typed. */
   block?: ChainFormatter<'block'> | undefined
@@ -158,18 +125,18 @@ export type ChainFormatter<type extends string = string> = {
 
 export type ChainSerializers<
   formatters extends ChainFormatters | undefined = undefined,
+  ///
+  transaction extends
+    TransactionSerializableGeneric = formatters extends ChainFormatters
+    ? formatters['transactionRequest'] extends ChainFormatter
+      ? TransactionSerializableGeneric &
+          Parameters<formatters['transactionRequest']['format']>[0]
+      : TransactionSerializable
+    : TransactionSerializable,
 > = {
   /** Modifies how Transactions are serialized. */
   transaction?:
-    | SerializeTransactionFn<
-        formatters extends ChainFormatters
-          ? formatters['transactionRequest'] extends ChainFormatter
-            ? TransactionSerializableGeneric &
-                Parameters<formatters['transactionRequest']['format']>[0]
-            : TransactionSerializable
-          : TransactionSerializable,
-        TransactionSerializedGeneric
-      >
+    | SerializeTransactionFn<transaction, TransactionSerializedGeneric>
     | undefined
 }
 
@@ -201,24 +168,15 @@ export type ChainFeesFnParameters<
 export type ChainEstimateFeesPerGasFnParameters<
   formatters extends ChainFormatters | undefined = ChainFormatters | undefined,
 > = {
-  /**
-   * A function to multiply the base fee based on the `baseFeeMultiplier` value.
-   */
+  /** A function to multiply the base fee based on the `baseFeeMultiplier` value. */
   multiply(x: bigint): bigint
-  /**
-   * The type of fees to return.
-   */
+  /** The type of fees to return. */
   type: FeeValuesType
 } & ChainFeesFnParameters<formatters>
 
 /////////////////////////////////////////////////////////////////////
 // Utils
 
-export type ExtractChain<
-  chains extends readonly Chain[],
-  chainId extends Chain['id'],
-> = Extract<chains[number], { id: chainId }>
-
 export type ExtractChainFormatterExclude<
   chain extends Chain | undefined,
   type extends keyof ChainFormatters,
@@ -267,3 +225,29 @@ export type GetChainParameter<
 > = IsUndefined<chain> extends true
   ? { chain: chainOverride | null }
   : { chain?: chainOverride | null | undefined }
+
+/////////////////////////////////////////////////////////////////////
+// Constants
+
+type ChainBlockExplorer = {
+  name: string
+  url: string
+  apiUrl?: string | undefined
+}
+
+export type ChainContract = {
+  address: Address
+  blockCreated?: number | undefined
+}
+
+type ChainNativeCurrency = {
+  name: string
+  /** 2-6 characters long */
+  symbol: string
+  decimals: number
+}
+
+type ChainRpcUrls = {
+  http: readonly string[]
+  webSocket?: readonly string[] | undefined
+}

package/types/eip1193.ts

@@ -366,7 +366,7 @@ export type PublicRpcSchema = [
       | [
           transaction: TransactionRequest,
           block: BlockNumber | BlockTag,
-          RpcStateOverride,
+          stateOverride: RpcStateOverride,
         ]
     ReturnType: Quantity
   },
@@ -548,11 +548,11 @@ export type PublicRpcSchema = [
         | {
             fromBlock?: BlockNumber | BlockTag | undefined
             toBlock?: BlockNumber | BlockTag | undefined
-            blockHash?: never | undefined
+            blockHash?: undefined
           }
         | {
-            fromBlock?: never | undefined
-            toBlock?: never | undefined
+            fromBlock?: undefined
+            toBlock?: undefined
             blockHash?: Hash | undefined
           }
       ),
@@ -1237,7 +1237,7 @@ export type WalletRpcSchema = [
       | [
           transaction: TransactionRequest,
           block: BlockNumber | BlockTag,
-          RpcStateOverride,
+          stateOverride: RpcStateOverride,
         ]
     ReturnType: Quantity
   },
@@ -1508,7 +1508,7 @@ export type EIP1193Parameters<
             : never
         } & (TRpcSchema[K] extends TRpcSchema[number]
           ? TRpcSchema[K]['Parameters'] extends undefined
-            ? { params?: never | undefined }
+            ? { params?: undefined }
             : { params: TRpcSchema[K]['Parameters'] }
           : never)
       >

package/types/fee.ts

@@ -1,48 +1,50 @@
-import type { Assign, OneOf } from './utils.js'
+import type { OneOf } from './utils.js'
 
-export type FeeHistory<TQuantity = bigint> = {
+export type FeeHistory<quantity = bigint> = {
   /**
    * An array of block base fees per gas (in wei). This includes the next block after
    * the newest of the returned range, because this value can be derived from the newest block.
    * Zeroes are returned for pre-EIP-1559 blocks. */
-  baseFeePerGas: TQuantity[]
+  baseFeePerGas: quantity[]
   /** An array of block gas used ratios. These are calculated as the ratio of gasUsed and gasLimit. */
   gasUsedRatio: number[]
   /** Lowest number block of the returned range. */
-  oldestBlock: TQuantity
+  oldestBlock: quantity
   /** An array of effective priority fees (in wei) per gas data points from a single block. All zeroes are returned if the block is empty. */
-  reward?: TQuantity[][] | undefined
+  reward?: quantity[][] | undefined
 }
 
-export type FeeValuesLegacy<TQuantity = bigint> = {
+export type FeeValuesLegacy<quantity = bigint> = {
   /** Base fee per gas. */
-  gasPrice: TQuantity
-  maxFeePerBlobGas?: never | undefined
-  maxFeePerGas?: never | undefined
-  maxPriorityFeePerGas?: never | undefined
+  gasPrice: quantity
+  maxFeePerBlobGas?: undefined
+  maxFeePerGas?: undefined
+  maxPriorityFeePerGas?: undefined
 }
 
-export type FeeValuesEIP1559<TQuantity = bigint> = {
-  gasPrice?: never | undefined
-  maxFeePerBlobGas?: never | undefined
+export type FeeValuesEIP1559<quantity = bigint> = {
+  gasPrice?: undefined
+  maxFeePerBlobGas?: undefined
   /** Total fee per gas in wei (gasPrice/baseFeePerGas + maxPriorityFeePerGas). */
-  maxFeePerGas: TQuantity
+  maxFeePerGas: quantity
   /** Max priority fee per gas (in wei). */
-  maxPriorityFeePerGas: TQuantity
+  maxPriorityFeePerGas: quantity
 }
 
-export type FeeValuesEIP4844<TQuantity = bigint> = Assign<
-  FeeValuesEIP1559<TQuantity>,
-  {
-    /** The maximum total fee per gas the sender is willing to pay for blob gas (in wei). */
-    maxFeePerBlobGas: TQuantity
-  }
->
+export type FeeValuesEIP4844<quantity = bigint> = {
+  gasPrice?: undefined
+  /** Maximum total fee per gas sender is willing to pay for blob gas (in wei). */
+  maxFeePerBlobGas: quantity
+  /** Total fee per gas in wei (gasPrice/baseFeePerGas + maxPriorityFeePerGas). */
+  maxFeePerGas: quantity
+  /** Max priority fee per gas (in wei). */
+  maxPriorityFeePerGas: quantity
+}
 
-export type FeeValues<TQuantity = bigint> = OneOf<
-  | FeeValuesLegacy<TQuantity>
-  | FeeValuesEIP1559<TQuantity>
-  | FeeValuesEIP4844<TQuantity>
+export type FeeValues<quantity = bigint> = OneOf<
+  | FeeValuesLegacy<quantity>
+  | FeeValuesEIP1559<quantity>
+  | FeeValuesEIP4844<quantity>
 >
 
 export type FeeValuesType = 'legacy' | 'eip1559' | 'eip4844'

package/types/filter.ts

@@ -37,8 +37,8 @@ export type Filter<
       ? undefined extends TEventName
         ? {
             abi: TAbi
-            args?: never | undefined
-            eventName?: never | undefined
+            args?: undefined
+            eventName?: undefined
             strict: TStrict
           }
         : TArgs extends MaybeExtractEventArgsFromAbi<TAbi, TEventName>
@@ -50,14 +50,14 @@ export type Filter<
             }
           : {
               abi: TAbi
-              args?: never | undefined
+              args?: undefined
               eventName: TEventName
               strict: TStrict
             }
       : {
-          abi?: never | undefined
-          args?: never | undefined
-          eventName?: never | undefined
-          strict?: never | undefined
+          abi?: undefined
+          args?: undefined
+          eventName?: undefined
+          strict?: undefined
         })
   : {})

package/types/rpc.ts

@@ -1,4 +1,5 @@
 import type { Address } from 'abitype'
+
 import type {
   Block,
   BlockIdentifier,
@@ -21,7 +22,7 @@ import type {
   TransactionRequestEIP4844,
   TransactionRequestLegacy,
 } from './transaction.js'
-import type { OneOf, UnionOmit, UnionPartialBy } from './utils.js'
+import type { Omit, OneOf, PartialBy } from './utils.js'
 
 export type Index = `0x${string}`
 export type Quantity = `0x${string}`
@@ -52,47 +53,49 @@ export type RpcTransactionRequest = OneOf<
   | TransactionRequestEIP1559<Quantity, Index, '0x2'>
   | TransactionRequestEIP4844<Quantity, Index, '0x3'>
 >
-export type RpcTransaction<TPending extends boolean = boolean> = UnionOmit<
-  UnionPartialBy<
-    OneOf<
-      | TransactionLegacy<Quantity, Index, TPending, '0x0'>
-      | TransactionEIP2930<Quantity, Index, TPending, '0x1'>
-      | TransactionEIP1559<Quantity, Index, TPending, '0x2'>
-      | TransactionEIP4844<Quantity, Index, TPending, '0x3'>
-    >,
-    // `yParity` is optional on the RPC type as some nodes do not return it
-    // for 1559 & 2930 transactions (they should!).
-    'yParity'
-  >,
-  'typeHex'
+// `yParity` is optional on the RPC type as some nodes do not return it
+// for 1559 & 2930 transactions (they should!).
+export type RpcTransaction<TPending extends boolean = boolean> = OneOf<
+  | Omit<TransactionLegacy<Quantity, Index, TPending, '0x0'>, 'typeHex'>
+  | PartialBy<
+      Omit<TransactionEIP2930<Quantity, Index, TPending, '0x1'>, 'typeHex'>,
+      'yParity'
+    >
+  | PartialBy<
+      Omit<TransactionEIP1559<Quantity, Index, TPending, '0x2'>, 'typeHex'>,
+      'yParity'
+    >
+  | PartialBy<
+      Omit<TransactionEIP4844<Quantity, Index, TPending, '0x3'>, 'typeHex'>,
+      'yParity'
+    >
 >
 
-type SuccessResult<T> = {
-  method?: never | undefined
-  result: T
-  error?: never | undefined
+type SuccessResult<result> = {
+  method?: undefined
+  result: result
+  error?: undefined
 }
-type ErrorResult<T> = {
-  method?: never | undefined
-  result?: never | undefined
-  error: T
+type ErrorResult<error> = {
+  method?: undefined
+  result?: undefined
+  error: error
 }
-type Subscription<TResult, TError> = {
+type Subscription<result, error> = {
   method: 'eth_subscription'
-  error?: never | undefined
-  result?: never | undefined
-  params: {
-    subscription: string
-  } & (
+  error?: undefined
+  result?: undefined
+  params:
     | {
-        result: TResult
-        error?: never | undefined
+        subscription: string
+        result: result
+        error?: undefined
       }
     | {
-        result?: never | undefined
-        error: TError
+        subscription: string
+        result?: undefined
+        error: error
       }
-  )
 }
 
 export type RpcRequest = {
@@ -102,14 +105,10 @@ export type RpcRequest = {
   id?: number | undefined
 }
 
-export type RpcResponse<TResult = any, TError = any> = {
+export type RpcResponse<result = any, error = any> = {
   jsonrpc: `${number}`
   id: number
-} & (
-  | SuccessResult<TResult>
-  | ErrorResult<TError>
-  | Subscription<TResult, TError>
-)
+} & (SuccessResult<result> | ErrorResult<error> | Subscription<result, error>)
 
 /** A key-value mapping of slot and storage values (supposedly 32 bytes each) */
 export type RpcStateMapping = {