viem 2.50.4 → 2.51.0

package/actions/public/createAccessList.ts

@@ -7,6 +7,7 @@ import {
 } from '../../accounts/utils/parseAccount.js'
 import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
+import { BaseError, type BaseErrorType } from '../../errors/base.js'
 import type { ErrorType } from '../../errors/utils.js'
 import type { BlockTag } from '../../types/block.js'
 import type { Chain } from '../../types/chain.js'
@@ -66,6 +67,7 @@ export type CreateAccessListReturnType = Prettify<{
 export type CreateAccessListErrorType = GetCallErrorReturnType<
   | ParseAccountErrorType
   | AssertRequestErrorType
+  | BaseErrorType
   | NumberToHexErrorType
   | FormatTransactionRequestErrorType
   | RequestErrorType
@@ -149,6 +151,8 @@ export async function createAccessList<chain extends Chain | undefined>(
       method: 'eth_createAccessList',
       params: [request as ExactPartial<RpcTransactionRequest>, block],
     })
+    if (response.error)
+      throw new BaseError(response.error, { details: response.error })
     return {
       accessList: response.accessList,
       gasUsed: BigInt(response.gasUsed),

package/actions/public/getBlockReceipts.ts

@@ -0,0 +1,101 @@
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import {
+  BlockNotFoundError,
+  type BlockNotFoundErrorType,
+} from '../../errors/block.js'
+import type { ErrorType } from '../../errors/utils.js'
+import type { BlockTag } from '../../types/block.js'
+import type { Chain } from '../../types/chain.js'
+import type { Hash } from '../../types/misc.js'
+import type { RequestErrorType } from '../../utils/buildRequest.js'
+import {
+  type NumberToHexErrorType,
+  numberToHex,
+} from '../../utils/encoding/toHex.js'
+import {
+  type FormattedTransactionReceipt,
+  formatTransactionReceipt,
+} from '../../utils/formatters/transactionReceipt.js'
+
+export type GetBlockReceiptsParameters =
+  | {
+      /** Hash of the block. */
+      blockHash?: Hash | undefined
+      blockNumber?: undefined
+      blockTag?: undefined
+    }
+  | {
+      blockHash?: undefined
+      /** The block number. */
+      blockNumber?: bigint | undefined
+      blockTag?: undefined
+    }
+  | {
+      blockHash?: undefined
+      blockNumber?: undefined
+      /** The block tag. Defaults to 'latest'. */
+      blockTag?: BlockTag | undefined
+    }
+
+export type GetBlockReceiptsReturnType<
+  chain extends Chain | undefined = undefined,
+> = FormattedTransactionReceipt<chain>[]
+
+export type GetBlockReceiptsErrorType =
+  | BlockNotFoundErrorType
+  | NumberToHexErrorType
+  | RequestErrorType
+  | ErrorType
+
+/**
+ * Returns the transaction receipts of a block at a block number, hash, or tag.
+ *
+ * - Docs: https://viem.sh/docs/actions/public/getBlockReceipts
+ * - JSON-RPC Methods: [`eth_getBlockReceipts`](https://ethereum.github.io/execution-apis/api/methods/eth_getBlockReceipts/)
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetBlockReceiptsParameters}
+ * @returns The transaction receipts. {@link GetBlockReceiptsReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getBlockReceipts } from 'viem/public'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const receipts = await getBlockReceipts(client, {
+ *   blockNumber: 69420n,
+ * })
+ */
+export async function getBlockReceipts<chain extends Chain | undefined>(
+  client: Client<Transport, chain>,
+  {
+    blockHash,
+    blockNumber,
+    blockTag = client.experimental_blockTag ?? 'latest',
+  }: GetBlockReceiptsParameters = {},
+): Promise<GetBlockReceiptsReturnType<chain>> {
+  const blockNumberHex =
+    blockNumber !== undefined ? numberToHex(blockNumber) : undefined
+
+  const receipts = await client.request(
+    {
+      method: 'eth_getBlockReceipts',
+      params: [blockHash || blockNumberHex || blockTag],
+    },
+    { dedupe: Boolean(blockHash || blockNumberHex) },
+  )
+
+  if (!receipts) throw new BlockNotFoundError({ blockHash, blockNumber })
+
+  const format =
+    client.chain?.formatters?.transactionReceipt?.format ||
+    formatTransactionReceipt
+  return receipts.map((receipt) =>
+    format(receipt, 'getBlockReceipts'),
+  ) as GetBlockReceiptsReturnType<chain>
+}

package/actions/wallet/prepareTransactionRequest.ts

@@ -50,7 +50,10 @@ import { blobsToCommitments } from '../../utils/blob/blobsToCommitments.js'
 import { blobsToProofs } from '../../utils/blob/blobsToProofs.js'
 import { commitmentsToVersionedHashes } from '../../utils/blob/commitmentsToVersionedHashes.js'
 import { toBlobSidecars } from '../../utils/blob/toBlobSidecars.js'
-import type { FormattedTransactionRequest } from '../../utils/formatters/transactionRequest.js'
+import type {
+  ExtractFormattedTransactionRequest,
+  FormattedTransactionRequest,
+} from '../../utils/formatters/transactionRequest.js'
 import { getAction } from '../../utils/getAction.js'
 import { LruMap } from '../../utils/lru.js'
 import type { NonceManager } from '../../utils/nonceManager.js'
@@ -98,12 +101,6 @@ type ParameterTypeToParameters<
 > = parameterType extends 'fees'
   ? 'maxFeePerGas' | 'maxPriorityFeePerGas' | 'gasPrice'
   : parameterType
-type ExtractTransactionRequest<transactionRequest, transactionType> =
-  transactionRequest extends { type?: infer type | undefined }
-    ? Extract<transactionType, type> extends never
-      ? never
-      : transactionRequest
-    : never
 
 export type PrepareTransactionRequestRequest<
   chain extends Chain | undefined = Chain | undefined,
@@ -164,9 +161,9 @@ export type PrepareTransactionRequestReturnType<
     : GetTransactionType<request> extends 'legacy'
       ? unknown
       : GetTransactionType<request>,
-  _transactionRequest = ExtractTransactionRequest<
-    UnionOmit<FormattedTransactionRequest<_derivedChain>, 'from'>,
-    _transactionType
+  _transactionRequest = ExtractFormattedTransactionRequest<
+    _derivedChain,
+    { type?: _transactionType extends string ? _transactionType : undefined }
   >,
 > = Prettify<
   UnionRequiredBy<

package/chains/definitions/somnia.ts

@@ -4,6 +4,7 @@ export const somnia = /*#__PURE__*/ defineChain({
   id: 5031,
   name: 'Somnia',
   nativeCurrency: { name: 'Somnia', symbol: 'SOMI', decimals: 18 },
+  blockTime: 100,
   rpcUrls: {
     default: {
       http: ['https://api.infra.mainnet.somnia.network'],
@@ -16,5 +17,11 @@ export const somnia = /*#__PURE__*/ defineChain({
       apiUrl: 'https://explorer.somnia.network/api',
     },
   },
+  contracts: {
+    multicall3: {
+      address: '0x5e44F178E8cF9B2F5409B6f18ce936aB817C5a11',
+      blockCreated: 38516341,
+    },
+  },
   testnet: false,
 })

package/chains/definitions/somniaTestnet.ts

@@ -4,15 +4,16 @@ export const somniaTestnet = /*#__PURE__*/ defineChain({
   id: 50312,
   name: 'Somnia Testnet',
   nativeCurrency: { name: 'STT', symbol: 'STT', decimals: 18 },
+  blockTime: 100,
   rpcUrls: {
     default: {
-      http: ['https://dream-rpc.somnia.network'],
+      http: ['https://api.infra.testnet.somnia.network'],
     },
   },
   blockExplorers: {
     default: {
       name: 'Somnia Testnet Explorer',
-      url: 'https://shannon-explorer.somnia.network/',
+      url: 'https://shannon-explorer.somnia.network',
       apiUrl: 'https://shannon-explorer.somnia.network/api',
     },
   },

package/clients/decorators/public.ts

@@ -97,6 +97,11 @@ import {
   type GetBlockNumberReturnType,
   getBlockNumber,
 } from '../../actions/public/getBlockNumber.js'
+import {
+  type GetBlockReceiptsParameters,
+  type GetBlockReceiptsReturnType,
+  getBlockReceipts,
+} from '../../actions/public/getBlockReceipts.js'
 import {
   type GetBlockTransactionCountParameters,
   type GetBlockTransactionCountReturnType,
@@ -671,6 +676,30 @@ export type PublicActions<
   >(
     args?: GetBlockParameters<includeTransactions, blockTag> | undefined,
   ) => Promise<GetBlockReturnType<chain, includeTransactions, blockTag>>
+  /**
+   * Returns the transaction receipts of a block at a block number, hash, or tag.
+   *
+   * - Docs: https://viem.sh/docs/actions/public/getBlockReceipts
+   * - JSON-RPC Methods: [`eth_getBlockReceipts`](https://ethereum.github.io/execution-apis/api/methods/eth_getBlockReceipts/)
+   *
+   * @param args - {@link GetBlockReceiptsParameters}
+   * @returns The transaction receipts. {@link GetBlockReceiptsReturnType}
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { mainnet } from 'viem/chains'
+   *
+   * const client = createPublicClient({
+   *   chain: mainnet,
+   *   transport: http(),
+   * })
+   * const receipts = await client.getBlockReceipts({
+   *   blockNumber: 69420n,
+   * })
+   */
+  getBlockReceipts: (
+    args?: GetBlockReceiptsParameters | undefined,
+  ) => Promise<GetBlockReceiptsReturnType<chain>>
   /**
    * Returns the number of the most recent block seen.
    *
@@ -2086,6 +2115,7 @@ export function publicActions<
     getBlobBaseFee: () => getBlobBaseFee(client),
     getBlock: (args) => getBlock(client, args),
     getBlockNumber: (args) => getBlockNumber(client, args),
+    getBlockReceipts: (args) => getBlockReceipts(client, args),
     getBlockTransactionCount: (args) => getBlockTransactionCount(client, args),
     getBytecode: (args) => getCode(client, args),
     getChainId: () => getChainId(client),

package/errors/version.ts

@@ -1 +1 @@
-export const version = '2.50.4'
+export const version = '2.51.0'

package/index.ts

@@ -168,6 +168,11 @@ export type {
   GetBlockNumberParameters,
   GetBlockNumberReturnType,
 } from './actions/public/getBlockNumber.js'
+export type {
+  GetBlockReceiptsErrorType,
+  GetBlockReceiptsParameters,
+  GetBlockReceiptsReturnType,
+} from './actions/public/getBlockReceipts.js'
 export type {
   GetBlockTransactionCountErrorType,
   GetBlockTransactionCountParameters,
@@ -1635,6 +1640,7 @@ export {
 export {
   type DefineTransactionRequestErrorType,
   defineTransactionRequest,
+  type ExtractFormattedTransactionRequest,
   type FormatTransactionRequestErrorType,
   type FormattedTransactionRequest,
   formatTransactionRequest,

package/op-stack/actions/buildProveWithdrawal.ts

@@ -27,6 +27,10 @@ import { toRlp } from '../../utils/encoding/toRlp.js'
 import { keccak256 } from '../../utils/hash/keccak256.js'
 import { contracts } from '../contracts.js'
 import type { Withdrawal } from '../types/withdrawal.js'
+import {
+  type GetL2BlockNumberAtTimestampErrorType,
+  getL2BlockNumberAtTimestamp,
+} from '../utils/getL2BlockNumberAtTimestamp.js'
 import {
   type GetWithdrawalHashStorageSlotErrorType,
   getWithdrawalHashStorageSlot,
@@ -73,6 +77,7 @@ export type BuildProveWithdrawalReturnType<
 export type BuildProveWithdrawalErrorType =
   | GetBlockErrorType
   | GetProofErrorType
+  | GetL2BlockNumberAtTimestampErrorType
   | GetWithdrawalHashStorageSlotErrorType
   | ErrorType
 
@@ -120,19 +125,29 @@ export async function buildProveWithdrawal<
 
   const { withdrawalHash } = withdrawal
   const { l2BlockNumber } = game ?? output
+  const blockNumber = game?.usesSuperRoots
+    ? await getL2BlockNumberAtTimestamp(client, {
+        timestamp: game.l2BlockNumber,
+      })
+    : l2BlockNumber
 
   const slot = getWithdrawalHashStorageSlot({ withdrawalHash })
   const [proof, block] = await Promise.all([
     getProof(client, {
       address: contracts.l2ToL1MessagePasser.address,
       storageKeys: [slot],
-      blockNumber: l2BlockNumber,
+      blockNumber,
     }),
     getBlock(client, {
-      blockNumber: l2BlockNumber,
+      blockNumber,
     }),
   ])
 
+  if (game?.usesSuperRoots && block.timestamp !== game.l2BlockNumber)
+    throw new Error(
+      `L2 block timestamp ${block.timestamp} does not match dispute game timestamp ${game.l2BlockNumber}.`,
+    )
+
   return {
     account,
     l2OutputIndex: game?.index ?? output?.outputIndex,

package/op-stack/actions/getGame.ts

@@ -42,7 +42,14 @@ export type GetGameParameters<
     strategy?: 'latest' | 'random'
   }
 export type GetGameReturnType = Game & {
+  /**
+   * L2 block number anchored by the dispute game. For super-root games, this
+   * value is the L2 timestamp instead. Check `usesSuperRoots` to distinguish
+   * the unit.
+   */
   l2BlockNumber: bigint
+  /** Whether the dispute game anchors on super roots. */
+  usesSuperRoots: boolean
 }
 
 export type GetGameErrorType =

package/op-stack/actions/getGames.ts

@@ -17,6 +17,7 @@ import type {
   GetChainParameter,
 } from '../../types/chain.js'
 import { disputeGameAbi, disputeGameFactoryAbi, portal2Abi } from '../abis.js'
+import { isSuperGameType } from '../gameTypes.js'
 import type { GetContractAddressParameter } from '../types/contract.js'
 import type { Game } from '../types/withdrawal.js'
 
@@ -40,7 +41,14 @@ export type GetGamesParameters<
     limit?: number | undefined
   }
 export type GetGamesReturnType = (Game & {
+  /**
+   * L2 block number anchored by the dispute game. For super-root games, this
+   * value is the L2 timestamp instead. Check `usesSuperRoots` to distinguish
+   * the unit.
+   */
   l2BlockNumber: bigint
+  /** Whether the dispute game anchors on super roots. */
+  usesSuperRoots: boolean
 })[]
 export type GetGamesErrorType =
   | ReadContractErrorType
@@ -133,11 +141,12 @@ export async function getGames<
     })),
   })
 
+  const usesSuperRoots = isSuperGameType(gameType)
   const games = rawGames
     .map((game, i) => {
       const blockNumber = l2SequenceNumbers[i] as bigint
       return !l2BlockNumber || blockNumber > l2BlockNumber
-        ? { ...game, l2BlockNumber: blockNumber }
+        ? { ...game, l2BlockNumber: blockNumber, usesSuperRoots }
         : null
     })
     .filter(Boolean) as GetGamesReturnType

package/op-stack/actions/getTimeToProve.ts

@@ -47,6 +47,10 @@ export type GetTimeToProveParameters<
     intervalBuffer?:
       | GetTimeToNextL2OutputParameters['intervalBuffer']
       | undefined
+    /**
+     * L2 timestamp of the withdrawal. Required for super-root dispute games.
+     */
+    l2Timestamp?: bigint | undefined
     receipt: TransactionReceipt
   }
 
@@ -98,7 +102,7 @@ export async function getTimeToProve<
   client: Client<Transport, chain, account>,
   parameters: GetTimeToProveParameters<chain, chainOverride>,
 ): Promise<GetTimeToProveReturnType> {
-  const { receipt } = parameters
+  const { l2Timestamp, receipt } = parameters
 
   const portalVersion = await getPortalVersion(
     client,
@@ -109,11 +113,11 @@ export async function getTimeToProve<
   if (portalVersion.major < 3)
     return getTimeToNextL2Output(client, {
       ...parameters,
-      l2BlockNumber: receipt.blockNumber,
+      l2BlockNumber: l2Timestamp ?? receipt.blockNumber,
     } as GetTimeToNextL2OutputParameters)
 
   return getTimeToNextGame(client, {
     ...parameters,
-    l2BlockNumber: receipt.blockNumber,
+    l2BlockNumber: l2Timestamp ?? receipt.blockNumber,
   } as GetTimeToNextGameParameters)
 }

package/op-stack/actions/getWithdrawalStatus.ts

@@ -64,6 +64,10 @@ export type GetWithdrawalStatusParameters<
      * @default 100
      */
     gameLimit?: number
+    /**
+     * L2 timestamp of the withdrawal. Required for super-root dispute games.
+     */
+    l2Timestamp?: bigint | undefined
   } & OneOf<
     | {
         /**
@@ -160,7 +164,8 @@ export async function getWithdrawalStatus<
     return Object.values(targetChain.contracts.portal)[0].address
   })()
 
-  const l2BlockNumber = receipt?.blockNumber ?? parameters.l2BlockNumber
+  const l2BlockNumber =
+    parameters.l2Timestamp ?? receipt?.blockNumber ?? parameters.l2BlockNumber
 
   const withdrawal = (() => {
     if (receipt) {

package/op-stack/actions/waitToProve.ts

@@ -49,6 +49,10 @@ export type WaitToProveParameters<
      * @default 100
      */
     gameLimit?: number | undefined
+    /**
+     * L2 timestamp of the withdrawal. Required for super-root dispute games.
+     */
+    l2Timestamp?: bigint | undefined
     receipt: TransactionReceipt
     /**
      * Polling frequency (in ms). Defaults to Client's pollingInterval config.
@@ -105,7 +109,7 @@ export async function waitToProve<
   client: Client<Transport, chain, account>,
   parameters: WaitToProveParameters<chain, chainOverride>,
 ): Promise<WaitToProveReturnType> {
-  const { gameLimit, receipt } = parameters
+  const { gameLimit, l2Timestamp, receipt } = parameters
 
   const [withdrawal] = getWithdrawals(receipt)
 
@@ -123,7 +127,7 @@ export async function waitToProve<
   if (portalVersion.major < 3) {
     const output = await waitForNextL2Output(client, {
       ...parameters,
-      l2BlockNumber: receipt.blockNumber,
+      l2BlockNumber: l2Timestamp ?? receipt.blockNumber,
     } as WaitForNextL2OutputParameters)
     return {
       game: {
@@ -133,6 +137,7 @@ export async function waitToProve<
         metadata: '0x',
         rootClaim: output.outputRoot,
         timestamp: output.timestamp,
+        usesSuperRoots: false,
       },
       output,
       withdrawal,
@@ -142,7 +147,7 @@ export async function waitToProve<
   const game = await waitForNextGame(client, {
     ...parameters,
     limit: gameLimit,
-    l2BlockNumber: receipt.blockNumber,
+    l2BlockNumber: l2Timestamp ?? receipt.blockNumber,
   } as WaitForNextGameParameters)
   return {
     game,

package/op-stack/gameTypes.ts

@@ -0,0 +1,9 @@
+/**
+ * Super dispute game type IDs from the OP Stack contracts
+ * (`contracts-bedrock/src/dispute/lib/Types.sol:99-103`).
+ */
+export const superGameTypes = new Set([4, 5, 7, 9]) as ReadonlySet<number>
+
+export function isSuperGameType(gameType: number): boolean {
+  return superGameTypes.has(gameType)
+}

package/op-stack/index.ts

@@ -207,7 +207,6 @@ export {
 export { chainConfig } from './chainConfig.js'
 
 export * from './chains.js'
-
 export {
   type PublicActionsL1,
   publicActionsL1,
@@ -224,6 +223,7 @@ export {
   type WalletActionsL2,
   walletActionsL2,
 } from './decorators/walletL2.js'
+export { isSuperGameType, superGameTypes } from './gameTypes.js'
 
 export {
   type ParseTransactionErrorType,
@@ -266,6 +266,12 @@ export {
   type ExtractWithdrawalMessageLogsReturnType,
   extractWithdrawalMessageLogs,
 } from './utils/extractWithdrawalMessageLogs.js'
+export {
+  type GetL2BlockNumberAtTimestampErrorType,
+  type GetL2BlockNumberAtTimestampParameters,
+  type GetL2BlockNumberAtTimestampReturnType,
+  getL2BlockNumberAtTimestamp,
+} from './utils/getL2BlockNumberAtTimestamp.js'
 export {
   type GetL2TransactionHashErrorType,
   type GetL2TransactionHashParameters,

package/op-stack/utils/getL2BlockNumberAtTimestamp.ts

@@ -0,0 +1,57 @@
+import {
+  type GetBlockErrorType,
+  getBlock,
+} from '../../actions/public/getBlock.js'
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { ErrorType } from '../../errors/utils.js'
+import type { Account } from '../../types/account.js'
+import type { Chain } from '../../types/chain.js'
+
+export type GetL2BlockNumberAtTimestampParameters = {
+  /** L2 block timestamp. */
+  timestamp: bigint
+}
+
+export type GetL2BlockNumberAtTimestampReturnType = bigint
+
+export type GetL2BlockNumberAtTimestampErrorType = GetBlockErrorType | ErrorType
+
+/**
+ * Gets the L2 block number for a timestamp using the latest L2 block and its parent.
+ *
+ * @param client - Client to use.
+ * @param parameters - {@link GetL2BlockNumberAtTimestampParameters}
+ * @returns L2 block number.
+ */
+export async function getL2BlockNumberAtTimestamp(
+  client: Client<Transport, Chain | undefined, Account | undefined>,
+  parameters: GetL2BlockNumberAtTimestampParameters,
+): Promise<GetL2BlockNumberAtTimestampReturnType> {
+  const latest = await getBlock(client)
+  if (latest.number === null)
+    throw new Error('Latest L2 block number is unavailable.')
+  if (latest.timestamp === undefined)
+    throw new Error('Latest L2 block timestamp is unavailable.')
+  if (latest.number === 0n)
+    throw new Error('Cannot derive L2 block time from genesis block.')
+
+  const parent = await getBlock(client, { blockNumber: latest.number - 1n })
+  if (parent.timestamp === undefined)
+    throw new Error('Parent L2 block timestamp is unavailable.')
+
+  const blockTime = latest.timestamp - parent.timestamp
+  if (blockTime === 0n) throw new Error('L2 block time is zero.')
+
+  const timeDiff = latest.timestamp - parameters.timestamp
+  if (timeDiff < 0n)
+    throw new Error('Timestamp is in the future relative to L2 head.')
+  if (timeDiff % blockTime !== 0n)
+    throw new Error('Timestamp does not align with the L2 block time.')
+
+  const blocksToLookBack = timeDiff / blockTime
+  if (blocksToLookBack > latest.number)
+    throw new Error('Timestamp predates L2 genesis.')
+
+  return latest.number - blocksToLookBack
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "2.50.4",
+  "version": "2.51.0",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",
@@ -230,7 +230,7 @@
     "@scure/bip39": "1.6.0",
     "abitype": "1.2.3",
     "isows": "1.0.7",
-    "ox": "0.14.22",
+    "ox": "https://pkg.pr.new/ox@386a3439fe1ce76d237930f8c6e6bb493746069a",
     "ws": "8.20.1"
   },
   "license": "MIT",