viem 2.0.0-beta.9 → 2.0.0-rc.0

package/chains/opStack/actions/getTimeToFinalize.ts

@@ -0,0 +1,122 @@
+import {
+  type MulticallErrorType,
+  multicall,
+} from '../../../actions/public/multicall.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 type { Hash } from '../../../types/misc.js'
+import { l2OutputOracleAbi, portalAbi } from '../abis.js'
+import type { GetContractAddressParameter } from '../types/contract.js'
+
+export type GetTimeToFinalizeParameters<
+  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' | 'portal'> & {
+    withdrawalHash: Hash
+  }
+export type GetTimeToFinalizeReturnType = {
+  /** The finalization period (in seconds). */
+  period: number
+  /** Seconds until the withdrawal can be finalized. */
+  seconds: number
+  /** Timestamp of when the withdrawal can be finalized. */
+  timestamp: number
+}
+export type GetTimeToFinalizeErrorType = MulticallErrorType | ErrorType
+
+const buffer = 10
+
+/**
+ * Returns the time until the withdrawal transaction can be finalized. Used for the [Withdrawal](/op-stack/guides/withdrawals.html) flow.
+ *
+ * - Docs: https://viem.sh/op-stack/actions/getTimeToFinalize.html
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetTimeToFinalizeParameters}
+ * @returns Time until finalize. {@link GetTimeToFinalizeReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { getBlockNumber } from 'viem/actions'
+ * import { mainnet, optimism } from 'viem/chains'
+ * import { getTimeToFinalize } from 'viem/op-stack'
+ *
+ * const publicClientL1 = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const publicClientL2 = createPublicClient({
+ *   chain: optimism,
+ *   transport: http(),
+ * })
+ *
+ * const receipt = await getTransactionReceipt(publicClientL2, {
+ *   hash: '0x9a2f4283636ddeb9ac32382961b22c177c9e86dd3b283735c154f897b1a7ff4a',
+ * })
+ *
+ * const [withdrawal] = getWithdrawals(receipt)
+ *
+ * const { seconds } = await getTimeToFinalize(publicClientL1, {
+ *   withdrawalHash: withdrawal.withdrawalHash,
+ *   targetChain: optimism
+ * })
+ */
+export async function getTimeToFinalize<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+  chainOverride extends Chain | undefined = undefined,
+>(
+  client: Client<Transport, chain, account>,
+  parameters: GetTimeToFinalizeParameters<chain, chainOverride>,
+): Promise<GetTimeToFinalizeReturnType> {
+  const { chain = client.chain, withdrawalHash, 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 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 [[_outputRoot, proveTimestamp, _l2OutputIndex], period] =
+    await multicall(client, {
+      allowFailure: false,
+      contracts: [
+        {
+          abi: portalAbi,
+          address: portalAddress,
+          functionName: 'provenWithdrawals',
+          args: [withdrawalHash],
+        },
+        {
+          abi: l2OutputOracleAbi,
+          address: l2OutputOracleAddress,
+          functionName: 'FINALIZATION_PERIOD_SECONDS',
+        },
+      ],
+    })
+
+  const secondsSinceProven = Date.now() / 1000 - Number(proveTimestamp)
+  const secondsToFinalize = Number(period) - secondsSinceProven
+
+  const seconds = Math.floor(
+    secondsToFinalize < 0 ? 0 : secondsToFinalize + buffer,
+  )
+  const timestamp = Date.now() + seconds * 1000
+
+  return { period: Number(period), seconds, timestamp }
+}

package/chains/opStack/actions/getTimeToNextL2Output.ts

@@ -0,0 +1,162 @@
+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
+    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
+}
+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.html) flow.
+ *
+ * - Docs: https://viem.sh/op-stack/actions/getTimeToNextL2Output.html
+ *
+ * @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

@@ -0,0 +1,79 @@
+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 { GetContractAddressParameter } from '../types/contract.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> &
+  GetContractAddressParameter<_derivedChain, 'l2OutputOracle'> & {
+    /**
+     * The buffer to account for discrepencies between non-deterministic time intervals.
+     * @default 1.1
+     */
+    intervalBuffer?: GetTimeToNextL2OutputParameters['intervalBuffer']
+    receipt: TransactionReceipt
+  }
+export type GetTimeToProveReturnType = GetTimeToNextL2OutputReturnType
+export type GetTimeToProveErrorType = GetTimeToNextL2OutputErrorType | ErrorType
+
+/**
+ * Returns the time until the withdrawal transaction is ready to prove. Used for the [Withdrawal](/op-stack/guides/withdrawals.html) flow.
+ *
+ * - Docs: https://viem.sh/op-stack/actions/getTimeToProve.html
+ *
+ * @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 getTransactionReceipt(publicClientL2, { 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
+
+  return getTimeToNextL2Output(client, {
+    ...parameters,
+    l2BlockNumber: receipt.blockNumber,
+  })
+}

package/chains/opStack/actions/getWithdrawalStatus.ts

@@ -0,0 +1,152 @@
+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 { portalAbi } from '../abis.js'
+import { ReceiptContainsNoWithdrawalsError } from '../errors/withdrawal.js'
+import type { GetContractAddressParameter } from '../types/contract.js'
+import {
+  type GetWithdrawalsErrorType,
+  getWithdrawals,
+} from '../utils/getWithdrawals.js'
+import { type GetL2OutputErrorType, getL2Output } from './getL2Output.js'
+import {
+  type GetTimeToFinalizeErrorType,
+  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> &
+  GetContractAddressParameter<_derivedChain, 'l2OutputOracle' | 'portal'> & {
+    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.html) flow.
+ *
+ * - Docs: https://viem.sh/op-stack/actions/getWithdrawalStatus.html
+ *
+ * @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 getTransactionReceipt(publicClientL2, { 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, receipt, targetChain } = 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 [withdrawal] = getWithdrawals(receipt)
+
+  if (!withdrawal)
+    throw new ReceiptContainsNoWithdrawalsError({
+      hash: receipt.transactionHash,
+    })
+
+  const [outputResult, proveResult, finalizedResult, timeToFinalizeResult] =
+    await Promise.allSettled([
+      getL2Output(client, {
+        ...parameters,
+        l2BlockNumber: receipt.blockNumber,
+      }),
+      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,
+      }),
+    ])
+
+  // 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'
+}

package/chains/opStack/actions/initiateWithdrawal.ts

@@ -0,0 +1,153 @@
+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 { l2ToL1MessagePasserAbi } from '../abis.js'
+import { contracts } from '../contracts.js'
+import type { WithdrawalRequest } from '../types/withdrawal.js'
+import {
+  type EstimateInitiateWithdrawalGasErrorType,
+  type EstimateInitiateWithdrawalGasParameters,
+  estimateInitiateWithdrawalGas,
+} from './estimateInitiateWithdrawalGas.js'
+
+export type InitiateWithdrawalParameters<
+  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> & {
+    /**
+     * Gas limit for transaction execution on the L2.
+     * `null` to skip gas estimation & defer calculation to signer.
+     */
+    gas?: bigint | null
+    /** Withdrawal request. Supplied to the L2ToL1MessagePasser `initiateWithdrawal` method. */
+    request: WithdrawalRequest
+  }
+export type InitiateWithdrawalReturnType = Hash
+export type InitiateWithdrawalErrorType =
+  | EstimateInitiateWithdrawalGasErrorType
+  | WriteContractErrorType
+  | ErrorType
+
+/**
+ * Initiates a [withdrawal](https://community.optimism.io/docs/protocol/withdrawal-flow/#withdrawal-initiating-transaction) on an L2 to the L1.
+ *
+ * Internally performs a contract write to the [`initiateWithdrawal` function](https://github.com/ethereum-optimism/optimism/blob/283f0aa2e3358ced30ff7cbd4028c0c0c3faa140/packages/contracts-bedrock/src/L2/L2ToL1MessagePasser.sol#L73)
+ * on the [Optimism L2ToL1MessagePasser predeploy contract](https://github.com/ethereum-optimism/optimism/blob/283f0aa2e3358ced30ff7cbd4028c0c0c3faa140/packages/contracts-bedrock/src/L2/L2ToL1MessagePasser.sol).
+ *
+ * - Docs: https://viem.sh/op-stack/actions/initiateWithdrawal.html
+ *
+ * @param client - Client to use
+ * @param parameters - {@link InitiateWithdrawalParameters}
+ * @returns The L2 transaction hash. {@link InitiateWithdrawalReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom, parseEther } from 'viem'
+ * import { base, mainnet } from 'viem/chains'
+ * import { initiateWithdrawal } from 'viem/op-stack'
+ *
+ * const client = createWalletClient({
+ *   chain: mainnet,
+ *   transport: custom(window.ethereum),
+ * })
+ *
+ * const hash = await initiateWithdrawal(client, {
+ *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ *   args: {
+ *     gas: 21_000n,
+ *     to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *     value: parseEther('1'),
+ *   },
+ * })
+ *
+ * @example
+ * // Account Hoisting
+ * import { createWalletClient, http } from 'viem'
+ * import { privateKeyToAccount } from 'viem/accounts'
+ * import { base, mainnet } from 'viem/chains'
+ * import { initiateWithdrawal } from 'viem/op-stack'
+ *
+ * const client = createWalletClient({
+ *   account: privateKeyToAccount('0x…'),
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ *
+ * const hash = await initiateWithdrawal(client, {
+ *   request: {
+ *     gas: 21_000n,
+ *     to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *     value: parseEther('1'),
+ *   },
+ * })
+ */
+export async function initiateWithdrawal<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+  chainOverride extends Chain | undefined = undefined,
+>(
+  client: Client<Transport, chain, account>,
+  parameters: InitiateWithdrawalParameters<chain, account, chainOverride>,
+) {
+  const {
+    account,
+    chain = client.chain,
+    gas,
+    maxFeePerGas,
+    maxPriorityFeePerGas,
+    nonce,
+    request: { data = '0x', gas: l1Gas, to, value },
+  } = parameters
+
+  const gas_ =
+    typeof gas !== 'number' && gas !== null
+      ? await estimateInitiateWithdrawalGas(
+          client,
+          parameters as EstimateInitiateWithdrawalGasParameters,
+        )
+      : undefined
+
+  return writeContract(client, {
+    account: account!,
+    abi: l2ToL1MessagePasserAbi,
+    address: contracts.l2ToL1MessagePasser.address,
+    chain,
+    functionName: 'initiateWithdrawal',
+    args: [to, l1Gas, data],
+    gas: gas_,
+    maxFeePerGas,
+    maxPriorityFeePerGas,
+    nonce,
+    value,
+  } satisfies WriteContractParameters as any)
+}