viem 2.9.1 → 2.9.3

package/chains/opStack/actions/getTimeToNextGame.ts

@@ -1,143 +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 type { GetContractAddressParameter } from '../types/contract.js'
-import { type GetGamesErrorType, getGames } from './getGames.js'
-
-export type GetTimeToNextGameParameters<
-  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 buffer to account for discrepencies between non-deterministic time intervals.
-     * @default 1.1
-     */
-    intervalBuffer?: number | undefined
-    /**
-     * The minimum L2 block number of the next game.
-     */
-    l2BlockNumber: bigint
-  }
-export type GetTimeToNextGameReturnType = {
-  /** The estimated interval (in seconds) between L2 dispute games. */
-  interval: number
-  /**
-   * Estimated seconds until the next L2 dispute game.
-   * `0` if the next L2 dispute game has already been submitted.
-   */
-  seconds: number
-  /**
-   * Estimated timestamp of the next L2 dispute game.
-   * `undefined` if the next L2 dispute game has already been submitted.
-   */
-  timestamp?: number | undefined
-}
-export type GetTimeToNextGameErrorType = GetGamesErrorType | ErrorType
-
-/**
- * Returns the time until the next L2 dispute game (after the provided block number) is submitted.
- * Used for the [Withdrawal](/op-stack/guides/withdrawals) flow.
- *
- * - Docs: https://viem.sh/op-stack/actions/getTimeToNextGame
- *
- * @param client - Client to use
- * @param parameters - {@link GetTimeToNextGameParameters}
- * @returns The L2 transaction hash. {@link GetTimeToNextGameReturnType}
- *
- * @example
- * import { createPublicClient, http } from 'viem'
- * import { getBlockNumber } from 'viem/actions'
- * import { mainnet, optimism } from 'viem/chains'
- * import { getTimeToNextGame } from 'viem/op-stack'
- *
- * const publicClientL1 = createPublicClient({
- *   chain: mainnet,
- *   transport: http(),
- * })
- *
- * const { seconds } = await getTimeToNextGame(publicClientL1, {
- *   l2BlockNumber: 113405763n,
- *   targetChain: optimism
- * })
- */
-export async function getTimeToNextGame<
-  chain extends Chain | undefined,
-  account extends Account | undefined,
-  chainOverride extends Chain | undefined = undefined,
->(
-  client: Client<Transport, chain, account>,
-  parameters: GetTimeToNextGameParameters<chain, chainOverride>,
-): Promise<GetTimeToNextGameReturnType> {
-  const { intervalBuffer = 1.1, l2BlockNumber } = parameters
-
-  const games = await getGames(client, {
-    ...parameters,
-    l2BlockNumber: undefined,
-    limit: 10,
-  })
-
-  const deltas = games
-    .map(({ l2BlockNumber, timestamp }, index) => {
-      return index === games.length - 1
-        ? null
-        : [
-            games[index + 1].timestamp - timestamp,
-            games[index + 1].l2BlockNumber - l2BlockNumber,
-          ]
-    })
-    .filter(Boolean)
-  const interval = Math.ceil(
-    (deltas as [bigint, bigint][]).reduce(
-      (a, [b]) => Number(a) - Number(b),
-      0,
-    ) / deltas.length,
-  )
-  const blockInterval = Math.ceil(
-    (deltas as [bigint, bigint][]).reduce(
-      (a, [_, b]) => Number(a) - Number(b),
-      0,
-    ) / deltas.length,
-  )
-
-  const latestGame = games[0]
-  const latestGameTimestamp = Number(latestGame.timestamp) * 1000
-
-  const intervalWithBuffer = Math.ceil(interval * intervalBuffer)
-
-  const now = Date.now()
-
-  const seconds = (() => {
-    // If the current timestamp is lesser than the latest dispute game timestamp,
-    // then we assume that the dispute game has already been submitted.
-    if (now < latestGameTimestamp) return 0
-
-    // If the latest dispute game block is newer than the provided dispute game block number,
-    // then we assume that the dispute game has already been submitted.
-    if (latestGame.l2BlockNumber > l2BlockNumber) return 0
-
-    const elapsedBlocks = Number(l2BlockNumber - latestGame.l2BlockNumber)
-
-    const elapsed = Math.ceil((now - latestGameTimestamp) / 1000)
-    const secondsToNextOutput =
-      intervalWithBuffer - (elapsed % intervalWithBuffer)
-    return elapsedBlocks < blockInterval
-      ? secondsToNextOutput
-      : Math.floor(elapsedBlocks / Number(blockInterval)) * intervalWithBuffer +
-          secondsToNextOutput
-  })()
-
-  const timestamp = seconds > 0 ? now + seconds * 1000 : undefined
-
-  return { interval, seconds, timestamp }
-}

package/chains/opStack/actions/getTimeToNextL2Output.ts

@@ -1,162 +0,0 @@
-import {
-  type MulticallErrorType,
-  multicall,
-} from '../../../actions/public/multicall.js'
-import {
-  type ReadContractErrorType,
-  readContract,
-} from '../../../actions/public/readContract.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,
-  DeriveChain,
-  GetChainParameter,
-} from '../../../types/chain.js'
-import { l2OutputOracleAbi } from '../abis.js'
-import type { GetContractAddressParameter } from '../types/contract.js'
-
-export type GetTimeToNextL2OutputParameters<
-  chain extends Chain | undefined = Chain | undefined,
-  chainOverride extends Chain | undefined = Chain | undefined,
-  _derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>,
-> = GetChainParameter<chain, chainOverride> &
-  GetContractAddressParameter<_derivedChain, 'l2OutputOracle'> & {
-    /**
-     * The buffer to account for discrepencies between non-deterministic time intervals.
-     * @default 1.1
-     */
-    intervalBuffer?: number | undefined
-    l2BlockNumber: bigint
-  }
-export type GetTimeToNextL2OutputReturnType = {
-  /** The interval (in seconds) between L2 outputs. */
-  interval: number
-  /**
-   * Seconds until the next L2 output.
-   * `0` if the next L2 output has already been submitted.
-   */
-  seconds: number
-  /**
-   * Estimated timestamp of the next L2 output.
-   * `undefined` if the next L2 output has already been submitted.
-   */
-  timestamp?: number | undefined
-}
-export type GetTimeToNextL2OutputErrorType =
-  | MulticallErrorType
-  | ReadContractErrorType
-  | ErrorType
-
-/**
- * Returns the time until the next L2 output (after the provided block number) is submitted. Used for the [Withdrawal](/op-stack/guides/withdrawals) flow.
- *
- * - Docs: https://viem.sh/op-stack/actions/getTimeToNextL2Output
- *
- * @param client - Client to use
- * @param parameters - {@link GetTimeToNextL2OutputParameters}
- * @returns The L2 transaction hash. {@link GetTimeToNextL2OutputReturnType}
- *
- * @example
- * import { createPublicClient, http } from 'viem'
- * import { getBlockNumber } from 'viem/actions'
- * import { mainnet, optimism } from 'viem/chains'
- * import { getTimeToNextL2Output } from 'viem/op-stack'
- *
- * const publicClientL1 = createPublicClient({
- *   chain: mainnet,
- *   transport: http(),
- * })
- * const publicClientL2 = createPublicClient({
- *   chain: optimism,
- *   transport: http(),
- * })
- *
- * const { seconds } = await getTimeToNextL2Output(publicClientL1, {
- *   targetChain: optimism
- * })
- */
-export async function getTimeToNextL2Output<
-  chain extends Chain | undefined,
-  account extends Account | undefined,
-  chainOverride extends Chain | undefined = undefined,
->(
-  client: Client<Transport, chain, account>,
-  parameters: GetTimeToNextL2OutputParameters<chain, chainOverride>,
-): Promise<GetTimeToNextL2OutputReturnType> {
-  const {
-    intervalBuffer = 1.1,
-    chain = client.chain,
-    l2BlockNumber,
-    targetChain,
-  } = parameters
-
-  const l2OutputOracleAddress = (() => {
-    if (parameters.l2OutputOracleAddress)
-      return parameters.l2OutputOracleAddress
-    if (chain) return targetChain!.contracts.l2OutputOracle[chain.id].address
-    return Object.values(targetChain!.contracts.l2OutputOracle)[0].address
-  })()
-
-  const [latestOutputIndex, blockTime, blockInterval] = await multicall(
-    client,
-    {
-      allowFailure: false,
-      contracts: [
-        {
-          abi: l2OutputOracleAbi,
-          address: l2OutputOracleAddress,
-          functionName: 'latestOutputIndex',
-        },
-        {
-          abi: l2OutputOracleAbi,
-          address: l2OutputOracleAddress,
-          functionName: 'L2_BLOCK_TIME',
-        },
-        {
-          abi: l2OutputOracleAbi,
-          address: l2OutputOracleAddress,
-          functionName: 'SUBMISSION_INTERVAL',
-        },
-      ],
-    },
-  )
-  const latestOutput = await readContract(client, {
-    abi: l2OutputOracleAbi,
-    address: l2OutputOracleAddress,
-    functionName: 'getL2Output',
-    args: [latestOutputIndex],
-  })
-  const latestOutputTimestamp = Number(latestOutput.timestamp) * 1000
-
-  const interval = Number(blockInterval * blockTime)
-  const intervalWithBuffer = Math.ceil(interval * intervalBuffer)
-
-  const now = Date.now()
-
-  const seconds = (() => {
-    // If the current timestamp is lesser than the latest L2 output timestamp,
-    // then we assume that the L2 output has already been submitted.
-    if (now < latestOutputTimestamp) return 0
-
-    // If the latest L2 output block is newer than the provided L2 block number,
-    // then we assume that the L2 output has already been submitted.
-    if (latestOutput.l2BlockNumber > l2BlockNumber) return 0
-
-    const elapsedBlocks = Number(l2BlockNumber - latestOutput.l2BlockNumber)
-
-    const elapsed = Math.ceil((now - latestOutputTimestamp) / 1000)
-    const secondsToNextOutput =
-      intervalWithBuffer - (elapsed % intervalWithBuffer)
-    return elapsedBlocks < blockInterval
-      ? secondsToNextOutput
-      : Math.floor(elapsedBlocks / Number(blockInterval)) * intervalWithBuffer +
-          secondsToNextOutput
-  })()
-
-  const timestamp = seconds > 0 ? now + seconds * 1000 : undefined
-
-  return { interval, seconds, timestamp }
-}

package/chains/opStack/actions/getTimeToProve.ts

@@ -1,119 +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 type { TransactionReceipt } from '../../../types/transaction.js'
-import type { OneOf } from '../../../types/utils.js'
-import type { GetContractAddressParameter } from '../types/contract.js'
-import {
-  type GetPortalVersionErrorType,
-  type GetPortalVersionParameters,
-  getPortalVersion,
-} from './getPortalVersion.js'
-import {
-  type GetTimeToNextGameErrorType,
-  type GetTimeToNextGameParameters,
-  type GetTimeToNextGameReturnType,
-  getTimeToNextGame,
-} from './getTimeToNextGame.js'
-import {
-  type GetTimeToNextL2OutputErrorType,
-  type GetTimeToNextL2OutputParameters,
-  type GetTimeToNextL2OutputReturnType,
-  getTimeToNextL2Output,
-} from './getTimeToNextL2Output.js'
-
-export type GetTimeToProveParameters<
-  chain extends Chain | undefined = Chain | undefined,
-  chainOverride extends Chain | undefined = Chain | undefined,
-  _derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>,
-> = GetChainParameter<chain, chainOverride> &
-  OneOf<
-    | GetContractAddressParameter<_derivedChain, 'l2OutputOracle'>
-    | GetContractAddressParameter<
-        _derivedChain,
-        'disputeGameFactory' | 'portal'
-      >
-  > & {
-    /**
-     * The buffer to account for discrepencies between non-deterministic time intervals.
-     * @default 1.1
-     */
-    intervalBuffer?:
-      | GetTimeToNextL2OutputParameters['intervalBuffer']
-      | undefined
-    receipt: TransactionReceipt
-  }
-
-export type GetTimeToProveReturnType =
-  | GetTimeToNextGameReturnType
-  | GetTimeToNextL2OutputReturnType
-
-export type GetTimeToProveErrorType =
-  | GetPortalVersionErrorType
-  | GetTimeToNextGameErrorType
-  | GetTimeToNextL2OutputErrorType
-  | ErrorType
-
-/**
- * Returns the time until the withdrawal transaction is ready to prove. Used for the [Withdrawal](/op-stack/guides/withdrawals) flow.
- *
- * - Docs: https://viem.sh/op-stack/actions/getTimeToProve
- *
- * @param client - Client to use
- * @param parameters - {@link GetTimeToNextL2OutputParameters}
- * @returns Time until prove step is ready. {@link GetTimeToNextL2OutputReturnType}
- *
- * @example
- * import { createPublicClient, http } from 'viem'
- * import { getBlockNumber } from 'viem/actions'
- * import { mainnet, optimism } from 'viem/chains'
- * import { getTimeToProve } from 'viem/op-stack'
- *
- * const publicClientL1 = createPublicClient({
- *   chain: mainnet,
- *   transport: http(),
- * })
- * const publicClientL2 = createPublicClient({
- *   chain: optimism,
- *   transport: http(),
- * })
- *
- * const receipt = await publicClientL2.getTransactionReceipt({ hash: '0x...' })
- * const { period, seconds, timestamp } = await getTimeToProve(publicClientL1, {
- *   receipt,
- *   targetChain: optimism
- * })
- */
-export async function getTimeToProve<
-  chain extends Chain | undefined,
-  account extends Account | undefined,
-  chainOverride extends Chain | undefined = undefined,
->(
-  client: Client<Transport, chain, account>,
-  parameters: GetTimeToProveParameters<chain, chainOverride>,
-): Promise<GetTimeToProveReturnType> {
-  const { receipt } = parameters
-
-  const portalVersion = await getPortalVersion(
-    client,
-    parameters as GetPortalVersionParameters,
-  )
-
-  // Legacy
-  if (portalVersion.major < 3)
-    return getTimeToNextL2Output(client, {
-      ...parameters,
-      l2BlockNumber: receipt.blockNumber,
-    } as GetTimeToNextL2OutputParameters)
-
-  return getTimeToNextGame(client, {
-    ...parameters,
-    l2BlockNumber: receipt.blockNumber,
-  } as GetTimeToNextGameParameters)
-}

package/chains/opStack/actions/getWithdrawalStatus.ts

@@ -1,244 +0,0 @@
-import {
-  type ReadContractErrorType,
-  readContract,
-} from '../../../actions/public/readContract.js'
-import type { Client } from '../../../clients/createClient.js'
-import type { Transport } from '../../../clients/transports/createTransport.js'
-import { ContractFunctionRevertedError } from '../../../errors/contract.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 type { TransactionReceipt } from '../../../types/transaction.js'
-import type { OneOf } from '../../../types/utils.js'
-import { portal2Abi, portalAbi } from '../abis.js'
-import { ReceiptContainsNoWithdrawalsError } from '../errors/withdrawal.js'
-import type { TargetChain } from '../types/chain.js'
-import type { GetContractAddressParameter } from '../types/contract.js'
-import {
-  type GetWithdrawalsErrorType,
-  getWithdrawals,
-} from '../utils/getWithdrawals.js'
-import {
-  type GetGameErrorType,
-  type GetGameParameters,
-  getGame,
-} from './getGame.js'
-import {
-  type GetL2OutputErrorType,
-  type GetL2OutputParameters,
-  getL2Output,
-} from './getL2Output.js'
-import {
-  type GetPortalVersionParameters,
-  getPortalVersion,
-} from './getPortalVersion.js'
-import {
-  type GetTimeToFinalizeErrorType,
-  type GetTimeToFinalizeParameters,
-  getTimeToFinalize,
-} from './getTimeToFinalize.js'
-
-export type GetWithdrawalStatusParameters<
-  chain extends Chain | undefined = Chain | undefined,
-  chainOverride extends Chain | undefined = Chain | undefined,
-  _derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>,
-> = GetChainParameter<chain, chainOverride> &
-  OneOf<
-    | GetContractAddressParameter<_derivedChain, 'l2OutputOracle' | 'portal'>
-    | GetContractAddressParameter<
-        _derivedChain,
-        'disputeGameFactory' | 'portal'
-      >
-  > & {
-    /**
-     * Limit of games to extract to check withdrawal status.
-     * @default 100
-     */
-    gameLimit?: number
-    receipt: TransactionReceipt
-  }
-export type GetWithdrawalStatusReturnType =
-  | 'waiting-to-prove'
-  | 'ready-to-prove'
-  | 'waiting-to-finalize'
-  | 'ready-to-finalize'
-  | 'finalized'
-export type GetWithdrawalStatusErrorType =
-  | GetL2OutputErrorType
-  | GetTimeToFinalizeErrorType
-  | GetWithdrawalsErrorType
-  | ReadContractErrorType
-  | ErrorType
-
-/**
- * Returns the current status of a withdrawal. Used for the [Withdrawal](/op-stack/guides/withdrawals) flow.
- *
- * - Docs: https://viem.sh/op-stack/actions/getWithdrawalStatus
- *
- * @param client - Client to use
- * @param parameters - {@link GetWithdrawalStatusParameters}
- * @returns Status of the withdrawal. {@link GetWithdrawalStatusReturnType}
- *
- * @example
- * import { createPublicClient, http } from 'viem'
- * import { getBlockNumber } from 'viem/actions'
- * import { mainnet, optimism } from 'viem/chains'
- * import { getWithdrawalStatus } from 'viem/op-stack'
- *
- * const publicClientL1 = createPublicClient({
- *   chain: mainnet,
- *   transport: http(),
- * })
- * const publicClientL2 = createPublicClient({
- *   chain: optimism,
- *   transport: http(),
- * })
- *
- * const receipt = await publicClientL2.getTransactionReceipt({ hash: '0x...' })
- * const status = await getWithdrawalStatus(publicClientL1, {
- *   receipt,
- *   targetChain: optimism
- * })
- */
-export async function getWithdrawalStatus<
-  chain extends Chain | undefined,
-  account extends Account | undefined,
-  chainOverride extends Chain | undefined = undefined,
->(
-  client: Client<Transport, chain, account>,
-  parameters: GetWithdrawalStatusParameters<chain, chainOverride>,
-): Promise<GetWithdrawalStatusReturnType> {
-  const {
-    chain = client.chain,
-    gameLimit = 100,
-    receipt,
-    targetChain: targetChain_,
-  } = parameters
-
-  const targetChain = targetChain_ as unknown as TargetChain
-
-  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 [withdrawal] = getWithdrawals(receipt)
-
-  if (!withdrawal)
-    throw new ReceiptContainsNoWithdrawalsError({
-      hash: receipt.transactionHash,
-    })
-
-  const portalVersion = await getPortalVersion(
-    client,
-    parameters as GetPortalVersionParameters,
-  )
-
-  // Legacy (Portal < v3)
-  if (portalVersion.major < 3) {
-    const [outputResult, proveResult, finalizedResult, timeToFinalizeResult] =
-      await Promise.allSettled([
-        getL2Output(client, {
-          ...parameters,
-          l2BlockNumber: receipt.blockNumber,
-        } as GetL2OutputParameters),
-        readContract(client, {
-          abi: portalAbi,
-          address: portalAddress,
-          functionName: 'provenWithdrawals',
-          args: [withdrawal.withdrawalHash],
-        }),
-        readContract(client, {
-          abi: portalAbi,
-          address: portalAddress,
-          functionName: 'finalizedWithdrawals',
-          args: [withdrawal.withdrawalHash],
-        }),
-        getTimeToFinalize(client, {
-          ...parameters,
-          withdrawalHash: withdrawal.withdrawalHash,
-        } as GetTimeToFinalizeParameters),
-      ])
-
-    // If the L2 Output is not processed yet (ie. the actions throws), this means
-    // that the withdrawal is not ready to prove.
-    if (outputResult.status === 'rejected') {
-      const error = outputResult.reason as GetL2OutputErrorType
-      if (
-        error.cause instanceof ContractFunctionRevertedError &&
-        error.cause.data?.args?.[0] ===
-          'L2OutputOracle: cannot get output for a block that has not been proposed'
-      )
-        return 'waiting-to-prove'
-      throw error
-    }
-    if (proveResult.status === 'rejected') throw proveResult.reason
-    if (finalizedResult.status === 'rejected') throw finalizedResult.reason
-    if (timeToFinalizeResult.status === 'rejected')
-      throw timeToFinalizeResult.reason
-
-    const [_, proveTimestamp] = proveResult.value
-    if (!proveTimestamp) return 'ready-to-prove'
-
-    const finalized = finalizedResult.value
-    if (finalized) return 'finalized'
-
-    const { seconds } = timeToFinalizeResult.value
-    return seconds > 0 ? 'waiting-to-finalize' : 'ready-to-finalize'
-  }
-
-  const [disputeGameResult, checkWithdrawalResult, finalizedResult] =
-    await Promise.allSettled([
-      getGame(client, {
-        ...parameters,
-        l2BlockNumber: receipt.blockNumber,
-        limit: gameLimit,
-      } as GetGameParameters),
-      readContract(client, {
-        abi: portal2Abi,
-        address: portalAddress,
-        functionName: 'checkWithdrawal',
-        args: [withdrawal.withdrawalHash],
-      }),
-      readContract(client, {
-        abi: portal2Abi,
-        address: portalAddress,
-        functionName: 'finalizedWithdrawals',
-        args: [withdrawal.withdrawalHash],
-      }),
-    ])
-
-  if (finalizedResult.status === 'fulfilled' && finalizedResult.value)
-    return 'finalized'
-
-  if (disputeGameResult.status === 'rejected') {
-    const error = disputeGameResult.reason as GetGameErrorType
-    if (error.name === 'GameNotFoundError') return 'waiting-to-prove'
-    throw disputeGameResult.reason
-  }
-  if (checkWithdrawalResult.status === 'rejected') {
-    const error = checkWithdrawalResult.reason as ReadContractErrorType
-    if (error.cause instanceof ContractFunctionRevertedError) {
-      const errorMessage = error.cause.data?.args?.[0]
-      if (errorMessage === 'OptimismPortal: withdrawal has not been proven yet')
-        return 'ready-to-prove'
-      if (
-        errorMessage ===
-          'OptimismPortal: proven withdrawal has not matured yet' ||
-        errorMessage ===
-          'OptimismPortal: output proposal has not been finalized yet' ||
-        errorMessage === 'OptimismPortal: output proposal in air-gap'
-      )
-        return 'waiting-to-finalize'
-    }
-    throw checkWithdrawalResult.reason
-  }
-  if (finalizedResult.status === 'rejected') throw finalizedResult.reason
-
-  return 'ready-to-finalize'
-}