viem 2.9.1 → 2.9.3

package/chains/opStack/actions/estimateL1Gas.ts

@@ -1,122 +0,0 @@
-import type { Address } from 'abitype'
-
-import {
-  type ReadContractErrorType,
-  readContract,
-} from '../../../actions/public/readContract.js'
-import {
-  type PrepareTransactionRequestErrorType,
-  type PrepareTransactionRequestParameters,
-  prepareTransactionRequest,
-} from '../../../actions/wallet/prepareTransactionRequest.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, GetAccountParameter } from '../../../types/account.js'
-import { type Chain, type GetChainParameter } from '../../../types/chain.js'
-import type {
-  TransactionRequestEIP1559,
-  TransactionSerializable,
-} from '../../../types/transaction.js'
-import type { RequestErrorType } from '../../../utils/buildRequest.js'
-import { getChainContractAddress } from '../../../utils/chain/getChainContractAddress.js'
-import { type HexToNumberErrorType } from '../../../utils/encoding/fromHex.js'
-import {
-  type AssertRequestErrorType,
-  type AssertRequestParameters,
-  assertRequest,
-} from '../../../utils/transaction/assertRequest.js'
-import {
-  type SerializeTransactionErrorType,
-  serializeTransaction,
-} from '../../../utils/transaction/serializeTransaction.js'
-import { gasPriceOracleAbi } from '../abis.js'
-import { contracts } from '../contracts.js'
-
-export type EstimateL1GasParameters<
-  TChain extends Chain | undefined = Chain | undefined,
-  TAccount extends Account | undefined = Account | undefined,
-  TChainOverride extends Chain | undefined = Chain | undefined,
-> = Omit<TransactionRequestEIP1559, 'from'> &
-  GetAccountParameter<TAccount> &
-  GetChainParameter<TChain, TChainOverride> & {
-    /** Gas price oracle address. */
-    gasPriceOracleAddress?: Address | undefined
-  }
-
-export type EstimateL1GasReturnType = bigint
-
-export type EstimateL1GasErrorType =
-  | RequestErrorType
-  | PrepareTransactionRequestErrorType
-  | AssertRequestErrorType
-  | SerializeTransactionErrorType
-  | HexToNumberErrorType
-  | ReadContractErrorType
-  | ErrorType
-
-/**
- * Estimates the L1 data gas required to execute an L2 transaction.
- *
- * @param client - Client to use
- * @param parameters - {@link EstimateL1GasParameters}
- * @returns The gas estimate. {@link EstimateL1GasReturnType}
- *
- * @example
- * import { createPublicClient, http, parseEther } from 'viem'
- * import { optimism } from 'viem/chains'
- * import { estimateL1Gas } from 'viem/chains/optimism'
- *
- * const client = createPublicClient({
- *   chain: optimism,
- *   transport: http(),
- * })
- * const l1Gas = await estimateL1Gas(client, {
- *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
- *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
- *   value: parseEther('1'),
- * })
- */
-export async function estimateL1Gas<
-  TChain extends Chain | undefined,
-  TAccount extends Account | undefined,
-  TChainOverride extends Chain | undefined = undefined,
->(
-  client: Client<Transport, TChain, TAccount>,
-  args: EstimateL1GasParameters<TChain, TAccount, TChainOverride>,
-): Promise<EstimateL1GasReturnType> {
-  const {
-    chain = client.chain,
-    gasPriceOracleAddress: gasPriceOracleAddress_,
-  } = args
-
-  const gasPriceOracleAddress = (() => {
-    if (gasPriceOracleAddress_) return gasPriceOracleAddress_
-    if (chain)
-      return getChainContractAddress({
-        chain,
-        contract: 'gasPriceOracle',
-      })
-    return contracts.gasPriceOracle.address
-  })()
-
-  // Populate transaction with required fields to accurately estimate gas.
-  const request = await prepareTransactionRequest(
-    client,
-    args as PrepareTransactionRequestParameters,
-  )
-
-  assertRequest(request as AssertRequestParameters)
-
-  const transaction = serializeTransaction({
-    ...request,
-    type: 'eip1559',
-  } as TransactionSerializable)
-
-  return readContract(client, {
-    abi: gasPriceOracleAbi,
-    address: gasPriceOracleAddress,
-    functionName: 'getL1GasUsed',
-    args: [transaction as any],
-  })
-}

package/chains/opStack/actions/estimateProveWithdrawalGas.ts

@@ -1,139 +0,0 @@
-import type { Address } from 'abitype'
-import {
-  type EstimateContractGasErrorType,
-  type EstimateContractGasParameters,
-  estimateContractGas,
-} from '../../../actions/public/estimateContractGas.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, GetAccountParameter } from '../../../types/account.js'
-import type {
-  Chain,
-  DeriveChain,
-  GetChainParameter,
-} from '../../../types/chain.js'
-import type { Hex } from '../../../types/misc.js'
-import type { UnionEvaluate, UnionOmit } from '../../../types/utils.js'
-import type { FormattedTransactionRequest } from '../../../utils/formatters/transactionRequest.js'
-import { portalAbi } from '../abis.js'
-import type { GetContractAddressParameter } from '../types/contract.js'
-
-export type EstimateProveWithdrawalGasParameters<
-  chain extends Chain | undefined = Chain | undefined,
-  account extends Account | undefined = Account | undefined,
-  chainOverride extends Chain | undefined = Chain | undefined,
-  _derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>,
-> = UnionEvaluate<
-  UnionOmit<
-    FormattedTransactionRequest<_derivedChain>,
-    | 'accessList'
-    | 'data'
-    | 'from'
-    | 'gas'
-    | 'gasPrice'
-    | 'to'
-    | 'type'
-    | 'value'
-  >
-> &
-  GetAccountParameter<account, Account | Address> &
-  GetChainParameter<chain, chainOverride> &
-  GetContractAddressParameter<_derivedChain, 'portal'> & {
-    /** Gas limit for transaction execution on the L2. */
-    gas?: bigint | null | undefined
-    l2OutputIndex: bigint
-    outputRootProof: {
-      version: Hex
-      stateRoot: Hex
-      messagePasserStorageRoot: Hex
-      latestBlockhash: Hex
-    }
-    withdrawalProof: readonly Hex[]
-    withdrawal: {
-      data: Hex
-      gasLimit: bigint
-      nonce: bigint
-      sender: Address
-      target: Address
-      value: bigint
-    }
-  }
-export type EstimateProveWithdrawalGasReturnType = bigint
-export type EstimateProveWithdrawalGasErrorType =
-  | EstimateContractGasErrorType
-  | ErrorType
-
-/**
- * Estimates gas required to prove a withdrawal that occurred on an L2.
- *
- * - Docs: https://viem.sh/op-stack/actions/estimateProveWithdrawalGas
- *
- * @param client - Client to use
- * @param parameters - {@link EstimateProveWithdrawalGasParameters}
- * @returns Estimated gas. {@link EstimateProveWithdrawalGasReturnType}
- *
- * @example
- * import { createPublicClient, http, parseEther } from 'viem'
- * import { base, mainnet } from 'viem/chains'
- * import { estimateProveWithdrawalGas } from 'viem/op-stack'
- *
- * const client = createPublicClient({
- *   chain: mainnet,
- *   transport: http(),
- * })
- *
- * const gas = await estimateProveWithdrawalGas(client, {
- *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
- *   l2OutputIndex: 4529n,
- *   outputRootProof: { ... },
- *   targetChain: optimism,
- *   withdrawalProof: [ ... ],
- *   withdrawal: { ... },
- * })
- */
-export async function estimateProveWithdrawalGas<
-  chain extends Chain | undefined,
-  account extends Account | undefined,
-  chainOverride extends Chain | undefined = undefined,
->(
-  client: Client<Transport, chain, account>,
-  parameters: EstimateProveWithdrawalGasParameters<
-    chain,
-    account,
-    chainOverride
-  >,
-) {
-  const {
-    account,
-    chain = client.chain,
-    gas,
-    l2OutputIndex,
-    maxFeePerGas,
-    maxPriorityFeePerGas,
-    nonce,
-    outputRootProof,
-    targetChain,
-    withdrawalProof,
-    withdrawal,
-  } = parameters
-
-  const portalAddress = (() => {
-    if (parameters.portalAddress) return parameters.portalAddress
-    if (chain) return targetChain!.contracts.portal[chain.id].address
-    return Object.values(targetChain!.contracts.portal)[0].address
-  })()
-
-  return estimateContractGas(client, {
-    account,
-    abi: portalAbi,
-    address: portalAddress,
-    chain,
-    functionName: 'proveWithdrawalTransaction',
-    args: [withdrawal, l2OutputIndex, outputRootProof, withdrawalProof],
-    gas,
-    maxFeePerGas,
-    maxPriorityFeePerGas,
-    nonce,
-  } as EstimateContractGasParameters)
-}

package/chains/opStack/actions/estimateTotalFee.ts

@@ -1,86 +0,0 @@
-import {
-  type EstimateGasErrorType,
-  type EstimateGasParameters,
-  estimateGas,
-} from '../../../actions/public/estimateGas.js'
-import {
-  type GetGasPriceErrorType,
-  getGasPrice,
-} from '../../../actions/public/getGasPrice.js'
-import {
-  type PrepareTransactionRequestErrorType,
-  type PrepareTransactionRequestParameters,
-  prepareTransactionRequest,
-} from '../../../actions/wallet/prepareTransactionRequest.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'
-import type { RequestErrorType } from '../../../utils/buildRequest.js'
-import {
-  type EstimateL1FeeErrorType,
-  type EstimateL1FeeParameters,
-  estimateL1Fee,
-} from './estimateL1Fee.js'
-
-export type EstimateTotalFeeParameters<
-  TChain extends Chain | undefined = Chain | undefined,
-  TAccount extends Account | undefined = Account | undefined,
-  TChainOverride extends Chain | undefined = Chain | undefined,
-> = EstimateL1FeeParameters<TChain, TAccount, TChainOverride>
-
-export type EstimateTotalFeeReturnType = bigint
-
-export type EstimateTotalFeeErrorType =
-  | RequestErrorType
-  | PrepareTransactionRequestErrorType
-  | EstimateL1FeeErrorType
-  | EstimateGasErrorType
-  | GetGasPriceErrorType
-  | ErrorType
-
-/**
- * Estimates the L1 data fee + L2 fee to execute an L2 transaction.
- *
- * @param client - Client to use
- * @param parameters - {@link EstimateTotalFeeParameters}
- * @returns The fee (in wei). {@link EstimateTotalFeeReturnType}
- *
- * @example
- * import { createPublicClient, http, parseEther } from 'viem'
- * import { optimism } from 'viem/chains'
- * import { estimateTotalFee } from 'viem/chains/optimism'
- *
- * const client = createPublicClient({
- *   chain: optimism,
- *   transport: http(),
- * })
- * const totalGas = await estimateTotalFee(client, {
- *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
- *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
- *   value: parseEther('1'),
- * })
- */
-export async function estimateTotalFee<
-  TChain extends Chain | undefined,
-  TAccount extends Account | undefined,
-  TChainOverride extends Chain | undefined = undefined,
->(
-  client: Client<Transport, TChain, TAccount>,
-  args: EstimateTotalFeeParameters<TChain, TAccount, TChainOverride>,
-): Promise<EstimateTotalFeeReturnType> {
-  // Populate transaction with required fields to accurately estimate gas.
-  const request = await prepareTransactionRequest(
-    client,
-    args as PrepareTransactionRequestParameters,
-  )
-
-  const [l1Fee, l2Gas, l2GasPrice] = await Promise.all([
-    estimateL1Fee(client, request as EstimateL1FeeParameters),
-    estimateGas(client, request as EstimateGasParameters),
-    getGasPrice(client),
-  ])
-
-  return l1Fee + l2Gas * l2GasPrice
-}

package/chains/opStack/actions/estimateTotalGas.ts

@@ -1,80 +0,0 @@
-import {
-  type EstimateGasErrorType,
-  type EstimateGasParameters,
-  estimateGas,
-} from '../../../actions/public/estimateGas.js'
-import {
-  type PrepareTransactionRequestErrorType,
-  type PrepareTransactionRequestParameters,
-  prepareTransactionRequest,
-} from '../../../actions/wallet/prepareTransactionRequest.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'
-import type { RequestErrorType } from '../../../utils/buildRequest.js'
-import {
-  type EstimateL1GasErrorType,
-  type EstimateL1GasParameters,
-  estimateL1Gas,
-} from './estimateL1Gas.js'
-
-export type EstimateTotalGasParameters<
-  TChain extends Chain | undefined = Chain | undefined,
-  TAccount extends Account | undefined = Account | undefined,
-  TChainOverride extends Chain | undefined = Chain | undefined,
-> = EstimateL1GasParameters<TChain, TAccount, TChainOverride>
-
-export type EstimateTotalGasReturnType = bigint
-
-export type EstimateTotalGasErrorType =
-  | RequestErrorType
-  | PrepareTransactionRequestErrorType
-  | EstimateL1GasErrorType
-  | EstimateGasErrorType
-  | ErrorType
-
-/**
- * Estimates the amount of L1 data gas + L2 gas required to execute an L2 transaction.
- *
- * @param client - Client to use
- * @param parameters - {@link EstimateTotalGasParameters}
- * @returns The gas estimate. {@link EstimateTotalGasReturnType}
- *
- * @example
- * import { createPublicClient, http, parseEther } from 'viem'
- * import { optimism } from 'viem/chains'
- * import { estimateTotalGas } from 'viem/chains/optimism'
- *
- * const client = createPublicClient({
- *   chain: optimism,
- *   transport: http(),
- * })
- * const totalGas = await estimateTotalGas(client, {
- *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
- *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
- *   value: parseEther('1'),
- * })
- */
-export async function estimateTotalGas<
-  TChain extends Chain | undefined,
-  TAccount extends Account | undefined,
-  TChainOverride extends Chain | undefined = undefined,
->(
-  client: Client<Transport, TChain, TAccount>,
-  args: EstimateTotalGasParameters<TChain, TAccount, TChainOverride>,
-): Promise<EstimateTotalGasReturnType> {
-  // Populate transaction with required fields to accurately estimate gas.
-  const request = await prepareTransactionRequest(
-    client,
-    args as PrepareTransactionRequestParameters,
-  )
-
-  const [l1Gas, l2Gas] = await Promise.all([
-    estimateL1Gas(client, request as EstimateL1GasParameters),
-    estimateGas(client, request as EstimateGasParameters),
-  ])
-
-  return l1Gas + l2Gas
-}

package/chains/opStack/actions/finalizeWithdrawal.ts

@@ -1,131 +0,0 @@
-import type { Address } from 'abitype'
-import {
-  type WriteContractErrorType,
-  type WriteContractParameters,
-  writeContract,
-} from '../../../actions/wallet/writeContract.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, GetAccountParameter } from '../../../types/account.js'
-import type {
-  Chain,
-  DeriveChain,
-  GetChainParameter,
-} from '../../../types/chain.js'
-import type { Hash } from '../../../types/misc.js'
-import type { UnionEvaluate, UnionOmit } from '../../../types/utils.js'
-import type { FormattedTransactionRequest } from '../../../utils/formatters/transactionRequest.js'
-import { portalAbi } from '../abis.js'
-import type { GetContractAddressParameter } from '../types/contract.js'
-import type { Withdrawal } from '../types/withdrawal.js'
-import {
-  type EstimateFinalizeWithdrawalGasErrorType,
-  type EstimateFinalizeWithdrawalGasParameters,
-  estimateFinalizeWithdrawalGas,
-} from './estimateFinalizeWithdrawalGas.js'
-
-export type FinalizeWithdrawalParameters<
-  chain extends Chain | undefined = Chain | undefined,
-  account extends Account | undefined = Account | undefined,
-  chainOverride extends Chain | undefined = Chain | undefined,
-  _derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>,
-> = UnionEvaluate<
-  UnionOmit<
-    FormattedTransactionRequest<_derivedChain>,
-    | 'accessList'
-    | 'data'
-    | 'from'
-    | 'gas'
-    | 'gasPrice'
-    | 'to'
-    | 'type'
-    | 'value'
-  >
-> &
-  GetAccountParameter<account, Account | Address> &
-  GetChainParameter<chain, chainOverride> &
-  GetContractAddressParameter<_derivedChain, 'portal'> & {
-    /**
-     * Gas limit for transaction execution on the L1.
-     * `null` to skip gas estimation & defer calculation to signer.
-     */
-    gas?: bigint | null | undefined
-    withdrawal: Withdrawal
-  }
-export type FinalizeWithdrawalReturnType = Hash
-export type FinalizeWithdrawalErrorType =
-  | EstimateFinalizeWithdrawalGasErrorType
-  | WriteContractErrorType
-  | ErrorType
-
-/**
- * Finalizes a withdrawal that occurred on an L2. Used in the Withdrawal flow.
- *
- * - Docs: https://viem.sh/op-stack/actions/finalizeWithdrawal
- *
- * @param client - Client to use
- * @param parameters - {@link FinalizeWithdrawalParameters}
- * @returns The finalize transaction hash. {@link FinalizeWithdrawalReturnType}
- *
- * @example
- * import { createWalletClient, http } from 'viem'
- * import { mainnet, optimism } from 'viem/chains'
- * import { finalizeWithdrawal } from 'viem/op-stack'
- *
- * const walletClientL1 = createWalletClient({
- *   chain: mainnet,
- *   transport: http(),
- * })
- *
- * const request = await finalizeWithdrawal(walletClientL1, {
- *   targetChain: optimism,
- *   withdrawal: { ... },
- * })
- */
-export async function finalizeWithdrawal<
-  chain extends Chain | undefined,
-  account extends Account | undefined,
-  chainOverride extends Chain | undefined = undefined,
->(
-  client: Client<Transport, chain, account>,
-  parameters: FinalizeWithdrawalParameters<chain, account, chainOverride>,
-): Promise<FinalizeWithdrawalReturnType> {
-  const {
-    account,
-    chain = client.chain,
-    gas,
-    maxFeePerGas,
-    maxPriorityFeePerGas,
-    nonce,
-    targetChain,
-    withdrawal,
-  } = parameters
-
-  const portalAddress = (() => {
-    if (parameters.portalAddress) return parameters.portalAddress
-    if (chain) return targetChain!.contracts.portal[chain.id].address
-    return Object.values(targetChain!.contracts.portal)[0].address
-  })()
-
-  const gas_ =
-    typeof gas !== 'number' && gas !== null
-      ? await estimateFinalizeWithdrawalGas(
-          client,
-          parameters as EstimateFinalizeWithdrawalGasParameters,
-        )
-      : undefined
-
-  return writeContract(client, {
-    account: account!,
-    abi: portalAbi,
-    address: portalAddress,
-    chain,
-    functionName: 'finalizeWithdrawalTransaction',
-    args: [withdrawal],
-    gas: gas_,
-    maxFeePerGas,
-    maxPriorityFeePerGas,
-    nonce,
-  } satisfies WriteContractParameters as any)
-}

package/chains/opStack/actions/getGame.ts

@@ -1,99 +0,0 @@
-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,
-  DeriveChain,
-  GetChainParameter,
-} from '../../../types/chain.js'
-import {
-  GameNotFoundError,
-  type GameNotFoundErrorType,
-} from '../errors/withdrawal.js'
-import type { GetContractAddressParameter } from '../types/contract.js'
-import type { Game } from '../types/withdrawal.js'
-import { type GetGamesErrorType, getGames } from './getGames.js'
-
-export type GetGameParameters<
-  chain extends Chain | undefined = Chain | undefined,
-  chainOverride extends Chain | undefined = Chain | undefined,
-  _derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>,
-> = GetChainParameter<chain, chainOverride> &
-  GetContractAddressParameter<
-    _derivedChain,
-    'portal' | 'disputeGameFactory'
-  > & {
-    /**
-     * The minimum block number of the dispute game.
-     */
-    l2BlockNumber: bigint
-    /**
-     * Limit of games to extract.
-     * @default 100
-     */
-    limit?: number | undefined
-    /**
-     * Strategy for extracting a dispute game.
-     *
-     * - `latest` - Returns the latest dispute game.
-     * - `random` - Returns a random dispute game.
-     */
-    strategy?: 'latest' | 'random'
-  }
-export type GetGameReturnType = Game & {
-  l2BlockNumber: bigint
-}
-
-export type GetGameErrorType =
-  | GetGamesErrorType
-  | GameNotFoundErrorType
-  | ErrorType
-
-/**
- * Retrieves a valid dispute game on an L2 that occurred after a provided L2 block number.
- *
- * - Docs: https://viem.sh/op-stack/actions/getGame
- *
- * @param client - Client to use
- * @param parameters - {@link GetGameParameters}
- * @returns A valid dispute game. {@link GetGameReturnType}
- *
- * @example
- * import { createPublicClient, http } from 'viem'
- * import { mainnet, optimism } from 'viem/chains'
- * import { getGame } from 'viem/op-stack'
- *
- * const publicClientL1 = createPublicClient({
- *   chain: mainnet,
- *   transport: http(),
- * })
- *
- * const game = await getGame(publicClientL1, {
- *   l2BlockNumber: 69420n,
- *   targetChain: optimism
- * })
- */
-export async function getGame<
-  chain extends Chain | undefined,
-  account extends Account | undefined,
-  chainOverride extends Chain | undefined = undefined,
->(
-  client: Client<Transport, chain, account>,
-  parameters: GetGameParameters<chain, chainOverride>,
-): Promise<GetGameReturnType> {
-  const { l2BlockNumber, strategy = 'latest' } = parameters
-
-  const latestGames = await getGames(client, parameters)
-
-  const games = latestGames.filter((game) => game.l2BlockNumber > l2BlockNumber)
-
-  const game = (() => {
-    if (strategy === 'random')
-      return games[Math.floor(Math.random() * games.length)]
-    return games[0]
-  })()
-
-  if (!game) throw new GameNotFoundError()
-  return game
-}