viem 2.6.1 → 2.7.1

package/actions/public/waitForTransactionReceipt.ts

@@ -12,7 +12,10 @@ import type { Hash } from '../../types/misc.js'
 import type { Transaction } from '../../types/transaction.js'
 import { getAction } from '../../utils/getAction.js'
 import { type ObserveErrorType, observe } from '../../utils/observe.js'
-import { withRetry } from '../../utils/promise/withRetry.js'
+import {
+  type WithRetryParameters,
+  withRetry,
+} from '../../utils/promise/withRetry.js'
 import { stringify } from '../../utils/stringify.js'
 
 import { type GetBlockErrorType, getBlock } from './getBlock.js'
@@ -62,6 +65,16 @@ export type WaitForTransactionReceiptParameters<
    * @default client.pollingInterval
    */
   pollingInterval?: number
+  /**
+   * Number of times to retry if the transaction or block is not found.
+   * @default 6 (exponential backoff)
+   */
+  retryCount?: WithRetryParameters['retryCount']
+  /**
+   * Time to wait (in ms) between retries.
+   * @default `({ count }) => ~~(1 << count) * 200` (exponential backoff)
+   */
+  retryDelay?: WithRetryParameters['delay']
   /** Optional timeout (in milliseconds) to wait before stopping polling. */
   timeout?: number
 }
@@ -121,6 +134,8 @@ export async function waitForTransactionReceipt<
     hash,
     onReplaced,
     pollingInterval = client.pollingInterval,
+    retryCount = 6,
+    retryDelay = ({ count }) => ~~(1 << count) * 200, // exponential backoff
     timeout,
   }: WaitForTransactionReceiptParameters<TChain>,
 ): Promise<WaitForTransactionReceiptReturnType<TChain>> {
@@ -193,9 +208,8 @@ export async function waitForTransactionReceipt<
                       blockNumber = transaction.blockNumber
                   },
                   {
-                    // exponential backoff
-                    delay: ({ count }) => ~~(1 << count) * 200,
-                    retryCount: 6,
+                    delay: retryDelay,
+                    retryCount,
                   },
                 )
                 retrying = false
@@ -247,9 +261,8 @@ export async function waitForTransactionReceipt<
                         includeTransactions: true,
                       }),
                     {
-                      // exponential backoff
-                      delay: ({ count }) => ~~(1 << count) * 200,
-                      retryCount: 6,
+                      delay: retryDelay,
+                      retryCount,
                       shouldRetry: ({ error }) =>
                         error instanceof BlockNotFoundError,
                     },

package/errors/version.ts

@@ -1 +1 @@
-export const version = '2.6.1'
+export const version = '2.7.1'

package/index.ts

@@ -872,6 +872,7 @@ export type {
   TransactionBase,
   TransactionEIP1559,
   TransactionEIP2930,
+  TransactionEIP4844,
   TransactionLegacy,
   TransactionReceipt,
   TransactionRequest,
@@ -942,6 +943,7 @@ export type {
   FeeHistory,
   FeeValues,
   FeeValuesEIP1559,
+  FeeValuesEIP4844,
   FeeValuesLegacy,
   FeeValuesType,
 } from './types/fee.js'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "2.6.1",
+  "version": "2.7.1",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",

package/types/block.ts

@@ -16,8 +16,12 @@ export type Block<
 > = {
   /** Base fee per gas */
   baseFeePerGas: TQuantity | null
+  /** Total used blob gas by all transactions in this block */
+  blobGasUsed: TQuantity
   /** Difficulty for this block */
   difficulty: TQuantity
+  /** Excess blob gas */
+  excessBlobGas: TQuantity
   /** "Extra data" field of this block */
   extraData: Hex
   /** Maximum gas allowed in this block */

package/types/fee.ts

@@ -1,3 +1,5 @@
+import type { Assign } from './utils.js'
+
 export type FeeHistory<TQuantity = bigint> = {
   /**
    * An array of block base fees per gas (in wei). This includes the next block after
@@ -15,21 +17,31 @@ export type FeeHistory<TQuantity = bigint> = {
 export type FeeValuesLegacy<TQuantity = bigint> = {
   /** Base fee per gas. */
   gasPrice: TQuantity
+  maxFeePerBlobGas?: never
   maxFeePerGas?: never
   maxPriorityFeePerGas?: never
 }
 
 export type FeeValuesEIP1559<TQuantity = bigint> = {
-  /** Base fee per gas. */
   gasPrice?: never
+  maxFeePerBlobGas?: never
   /** Total fee per gas in wei (gasPrice/baseFeePerGas + maxPriorityFeePerGas). */
   maxFeePerGas: TQuantity
   /** Max priority fee per gas (in wei). */
   maxPriorityFeePerGas: TQuantity
 }
 
+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 FeeValues<TQuantity = bigint> =
   | FeeValuesLegacy<TQuantity>
   | FeeValuesEIP1559<TQuantity>
+  | FeeValuesEIP4844<TQuantity>
 
-export type FeeValuesType = 'legacy' | 'eip1559'
+export type FeeValuesType = 'legacy' | 'eip1559' | 'eip4844'

package/types/rpc.ts

@@ -11,6 +11,7 @@ import type { Proof } from './proof.js'
 import type {
   TransactionEIP1559,
   TransactionEIP2930,
+  TransactionEIP4844,
   TransactionLegacy,
   TransactionReceipt,
   TransactionRequestEIP1559,
@@ -50,7 +51,8 @@ export type RpcTransaction<TPending extends boolean = boolean> = UnionOmit<
   UnionPartialBy<
     | TransactionLegacy<Quantity, Index, TPending, '0x0'>
     | TransactionEIP2930<Quantity, Index, TPending, '0x1'>
-    | TransactionEIP1559<Quantity, Index, TPending, '0x2'>,
+    | 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'

package/types/transaction.ts

@@ -1,15 +1,22 @@
 import type { Address } from 'abitype'
 
-import type { transactionType } from '../utils/formatters/transaction.js'
-
-import type { FeeValuesEIP1559, FeeValuesLegacy } from './fee.js'
+import type {
+  FeeValuesEIP1559,
+  FeeValuesEIP4844,
+  FeeValuesLegacy,
+} from './fee.js'
 import type { Log } from './log.js'
 import type { Hash, Hex, Signature } from './misc.js'
-import type { ValueOf } from './utils.js'
+import type { OneOf } from './utils.js'
 
 export type AccessList = { address: Address; storageKeys: Hex[] }[]
 
-export type TransactionType = ValueOf<typeof transactionType> | (string & {})
+export type TransactionType =
+  | 'legacy'
+  | 'eip1559'
+  | 'eip2930'
+  | 'eip4844'
+  | (string & {})
 
 export type TransactionReceipt<
   TQuantity = bigint,
@@ -17,6 +24,10 @@ export type TransactionReceipt<
   TStatus = 'success' | 'reverted',
   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
+  /** The amount of blob gas used. Only specified for blob transactions as defined by EIP-4844. */
+  blobGasUsed?: TQuantity
   /** Hash of block containing this transaction */
   blockHash: Hash
   /** Number of block containing this transaction */
@@ -94,6 +105,7 @@ export type TransactionLegacy<
   FeeValuesLegacy<TQuantity> & {
     /** EIP-2930 Access List. */
     accessList?: never
+    blobVersionedHashes?: never
     /** Chain ID that this transaction is valid on. */
     chainId?: TIndex
     yParity?: never
@@ -108,6 +120,7 @@ export type TransactionEIP2930<
   FeeValuesLegacy<TQuantity> & {
     /** EIP-2930 Access List. */
     accessList: AccessList
+    blobVersionedHashes?: never
     /** Chain ID that this transaction is valid on. */
     chainId: TIndex
     type: TType
@@ -121,6 +134,22 @@ export type TransactionEIP1559<
   FeeValuesEIP1559<TQuantity> & {
     /** EIP-2930 Access List. */
     accessList: AccessList
+    blobVersionedHashes?: never
+    /** Chain ID that this transaction is valid on. */
+    chainId: TIndex
+    type: TType
+  }
+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: Hex[]
     /** Chain ID that this transaction is valid on. */
     chainId: TIndex
     type: TType
@@ -129,10 +158,12 @@ export type Transaction<
   TQuantity = bigint,
   TIndex = number,
   TPending extends boolean = boolean,
-> =
+> = OneOf<
   | TransactionLegacy<TQuantity, TIndex, TPending>
   | TransactionEIP2930<TQuantity, TIndex, TPending>
   | TransactionEIP1559<TQuantity, TIndex, TPending>
+  | TransactionEIP4844<TQuantity, TIndex, TPending>
+>
 
 export type TransactionRequestBase<TQuantity = bigint, TIndex = number> = {
   /** Contract code or a hashed method call with encoded args */

package/utils/formatters/block.ts

@@ -48,7 +48,11 @@ export function formatBlock(block: Partial<RpcBlock>) {
   return {
     ...block,
     baseFeePerGas: block.baseFeePerGas ? BigInt(block.baseFeePerGas) : null,
+    blobGasUsed: block.blobGasUsed ? BigInt(block.blobGasUsed) : undefined,
     difficulty: block.difficulty ? BigInt(block.difficulty) : undefined,
+    excessBlobGas: block.excessBlobGas
+      ? BigInt(block.excessBlobGas)
+      : undefined,
     gasLimit: block.gasLimit ? BigInt(block.gasLimit) : undefined,
     gasUsed: block.gasUsed ? BigInt(block.gasUsed) : undefined,
     hash: block.hash ? block.hash : null,

package/utils/formatters/transaction.ts

@@ -37,6 +37,7 @@ export const transactionType = {
   '0x0': 'legacy',
   '0x1': 'eip2930',
   '0x2': 'eip1559',
+  '0x3': 'eip4844',
 } as const
 
 export type FormatTransactionErrorType = ErrorType
@@ -51,6 +52,9 @@ export function formatTransaction(transaction: Partial<RpcTransaction>) {
     chainId: transaction.chainId ? hexToNumber(transaction.chainId) : undefined,
     gas: transaction.gas ? BigInt(transaction.gas) : undefined,
     gasPrice: transaction.gasPrice ? BigInt(transaction.gasPrice) : undefined,
+    maxFeePerBlobGas: transaction.maxFeePerBlobGas
+      ? BigInt(transaction.maxFeePerBlobGas)
+      : undefined,
     maxFeePerGas: transaction.maxFeePerGas
       ? BigInt(transaction.maxFeePerGas)
       : undefined,
@@ -86,14 +90,19 @@ export function formatTransaction(transaction: Partial<RpcTransaction>) {
 
   if (transaction_.type === 'legacy') {
     delete transaction_.accessList
+    delete transaction_.maxFeePerBlobGas
     delete transaction_.maxFeePerGas
     delete transaction_.maxPriorityFeePerGas
     delete transaction_.yParity
   }
   if (transaction_.type === 'eip2930') {
+    delete transaction_.maxFeePerBlobGas
     delete transaction_.maxFeePerGas
     delete transaction_.maxPriorityFeePerGas
   }
+  if (transaction_.type === 'eip1559') {
+    delete transaction_.maxFeePerBlobGas
+  }
   return transaction_
 }
 

package/utils/formatters/transactionReceipt.ts

@@ -29,7 +29,7 @@ export type FormatTransactionReceiptErrorType = ErrorType
 export function formatTransactionReceipt(
   transactionReceipt: Partial<RpcTransactionReceipt>,
 ) {
-  return {
+  const receipt = {
     ...transactionReceipt,
     blockNumber: transactionReceipt.blockNumber
       ? BigInt(transactionReceipt.blockNumber)
@@ -62,6 +62,13 @@ export function formatTransactionReceipt(
         ] || transactionReceipt.type
       : null,
   } as TransactionReceipt
+
+  if (transactionReceipt.blobGasPrice)
+    receipt.blobGasPrice = BigInt(transactionReceipt.blobGasPrice)
+  if (transactionReceipt.blobGasUsed)
+    receipt.blobGasUsed = BigInt(transactionReceipt.blobGasUsed)
+
+  return receipt
 }
 
 export type DefineTransactionReceiptErrorType =

package/utils/formatters/transactionRequest.ts

@@ -20,6 +20,7 @@ export const rpcTransactionType = {
   legacy: '0x0',
   eip2930: '0x1',
   eip1559: '0x2',
+  eip4844: '0x3',
 } as const
 
 export type FormatTransactionRequestErrorType = ErrorType

package/utils/promise/withRetry.ts

@@ -1,6 +1,21 @@
 import type { ErrorType } from '../../errors/utils.js'
 import { wait } from '../wait.js'
 
+export type WithRetryParameters = {
+  // The delay (in ms) between retries.
+  delay?: ((config: { count: number; error: Error }) => number) | number
+  // The max number of times to retry.
+  retryCount?: number
+  // Whether or not to retry when an error is thrown.
+  shouldRetry?: ({
+    count,
+    error,
+  }: {
+    count: number
+    error: Error
+  }) => Promise<boolean> | boolean
+}
+
 export type WithRetryErrorType = ErrorType
 
 export function withRetry<TData>(
@@ -9,20 +24,7 @@ export function withRetry<TData>(
     delay: delay_ = 100,
     retryCount = 2,
     shouldRetry = () => true,
-  }: {
-    // The delay (in ms) between retries.
-    delay?: ((config: { count: number; error: Error }) => number) | number
-    // The max number of times to retry.
-    retryCount?: number
-    // Whether or not to retry when an error is thrown.
-    shouldRetry?: ({
-      count,
-      error,
-    }: {
-      count: number
-      error: Error
-    }) => Promise<boolean> | boolean
-  } = {},
+  }: WithRetryParameters = {},
 ) {
   return new Promise<TData>((resolve, reject) => {
     const attemptRetry = async ({ count = 0 } = {}) => {