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

package/chains/opStack/decorators/publicL2.ts

@@ -12,6 +12,11 @@ import {
   type BuildDepositTransactionReturnType,
   buildDepositTransaction,
 } from '../actions/buildDepositTransaction.js'
+import {
+  type BuildProveWithdrawalParameters,
+  type BuildProveWithdrawalReturnType,
+  buildProveWithdrawal,
+} from '../actions/buildProveWithdrawal.js'
 import {
   type EstimateContractL1FeeParameters,
   type EstimateContractL1FeeReturnType,
@@ -32,6 +37,11 @@ import {
   type EstimateContractTotalGasReturnType,
   estimateContractTotalGas,
 } from '../actions/estimateContractTotalGas.js'
+import {
+  type EstimateInitiateWithdrawalGasParameters,
+  type EstimateInitiateWithdrawalGasReturnType,
+  estimateInitiateWithdrawalGas,
+} from '../actions/estimateInitiateWithdrawalGas.js'
 import {
   type EstimateL1FeeParameters,
   type EstimateL1FeeReturnType,
@@ -57,6 +67,84 @@ export type PublicActionsL2<
   chain extends Chain | undefined = Chain | undefined,
   account extends Account | undefined = Account | undefined,
 > = {
+  /**
+   * Prepares parameters for a [deposit transaction](https://github.com/ethereum-optimism/optimism/blob/develop/specs/deposits.md) to be initiated on an L1.
+   *
+   * - Docs: https://viem.sh/op-stack/actions/buildDepositTransaction.html
+   *
+   * @param client - Client to use
+   * @param parameters - {@link BuildDepositTransactionParameters}
+   * @returns Parameters for `depositTransaction`. {@link DepositTransactionReturnType}
+   *
+   * @example
+   * import { createWalletClient, http, parseEther } from 'viem'
+   * import { base } from 'viem/chains'
+   * import { publicActionsL2 } from 'viem/op-stack'
+   *
+   * const client = createWalletClient({
+   *   chain: base,
+   *   transport: http(),
+   * }).extend(publicActionsL2())
+   *
+   * const args = await client.buildDepositTransaction({
+   *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+   *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+   *   value: parseEther('1'),
+   * })
+   */
+  buildDepositTransaction: <
+    chainOverride extends Chain | undefined = undefined,
+    accountOverride extends Account | Address | undefined = undefined,
+  >(
+    parameters: BuildDepositTransactionParameters<
+      chain,
+      account,
+      chainOverride,
+      accountOverride
+    >,
+  ) => Promise<BuildDepositTransactionReturnType<account, accountOverride>>
+  /**
+   * Builds the transaction that proves a withdrawal was initiated on an L2. Used in the Withdrawal flow.
+   *
+   * - Docs: https://viem.sh/op-stack/actions/buildProveWithdrawal.html
+   *
+   * @param client - Client to use
+   * @param parameters - {@link BuildProveWithdrawalParameters}
+   * @returns The prove withdraw transaction request. {@link BuildProveWithdrawalReturnType}
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { optimism } from 'viem/chains'
+   * import { publicActionsL2 } from 'viem/op-stack'
+   *
+   * const publicClientL2 = createPublicClient({
+   *   chain: optimism,
+   *   transport: http(),
+   * }).extend(publicActionsL2())
+   *
+   * const args = await publicClientL2.buildProveWithdrawal({
+   *   output: { ... },
+   *   withdrawal: { ... },
+   * })
+   */
+  buildProveWithdrawal: <
+    chainOverride extends Chain | undefined = undefined,
+    accountOverride extends Account | Address | undefined = undefined,
+  >(
+    parameters: BuildProveWithdrawalParameters<
+      chain,
+      account,
+      chainOverride,
+      accountOverride
+    >,
+  ) => Promise<
+    BuildProveWithdrawalReturnType<
+      chain,
+      account,
+      chainOverride,
+      accountOverride
+    >
+  >
   /**
    * Estimates the L1 data fee required to execute an L2 contract write.
    *
@@ -213,6 +301,43 @@ export type PublicActionsL2<
       chainOverride
     >,
   ) => Promise<EstimateContractTotalGasReturnType>
+  /**
+   * Estimates gas required to initiate a [withdrawal](https://community.optimism.io/docs/protocol/withdrawal-flow/#withdrawal-initiating-transaction) on an L2 to the L1.
+   *
+   * - Docs: https://viem.sh/op-stack/actions/estimateInitiateWithdrawalGas.html
+   *
+   * @param client - Client to use
+   * @param parameters - {@link EstimateInitiateWithdrawalGasParameters}
+   * @returns The gas required. {@link EstimateInitiateWithdrawalGasReturnType}
+   *
+   * @example
+   * import { createPublicClient, http, parseEther } from 'viem'
+   * import { base, mainnet } from 'viem/chains'
+   * import { publicActionsL2 } from 'viem/op-stack'
+   *
+   * const client = createPublicClient({
+   *   chain: mainnet,
+   *   transport: http(),
+   * }).extend(publicActionsL2())
+   *
+   * const hash = await client.estimateInitiateWithdrawalGas({
+   *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+   *   request: {
+   *     gas: 21_000n,
+   *     to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+   *     value: parseEther('1'),
+   *   },
+   * })
+   */
+  estimateInitiateWithdrawalGas: <
+    chainOverride extends Chain | undefined = undefined,
+  >(
+    parameters: EstimateInitiateWithdrawalGasParameters<
+      chain,
+      account,
+      chainOverride
+    >,
+  ) => Promise<EstimateInitiateWithdrawalGasReturnType>
   /**
    * Estimates the L1 data fee required to execute an L2 transaction.
    *
@@ -317,42 +442,6 @@ export type PublicActionsL2<
   estimateTotalGas: <chainOverride extends Chain | undefined = undefined>(
     parameters: EstimateTotalGasParameters<chain, account, chainOverride>,
   ) => Promise<EstimateTotalGasReturnType>
-  /**
-   * Prepares parameters for a [deposit transaction](https://github.com/ethereum-optimism/optimism/blob/develop/specs/deposits.md) to be initiated on an L1.
-   *
-   * - Docs: https://viem.sh/op-stack/actions/buildDepositTransaction.html
-   *
-   * @param client - Client to use
-   * @param parameters - {@link BuildDepositTransactionParameters}
-   * @returns Parameters for `depositTransaction`. {@link DepositTransactionReturnType}
-   *
-   * @example
-   * import { createWalletClient, http, parseEther } from 'viem'
-   * import { base } from 'viem/chains'
-   * import { publicActionsL2 } from 'viem/op-stack'
-   *
-   * const client = createWalletClient({
-   *   chain: base,
-   *   transport: http(),
-   * }).extend(publicActionsL2())
-   *
-   * const request = await client.buildDepositTransaction({
-   *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
-   *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
-   *   value: parseEther('1'),
-   * })
-   */
-  buildDepositTransaction: <
-    chainOverride extends Chain | undefined = undefined,
-    accountOverride extends Account | Address | undefined = undefined,
-  >(
-    parameters: BuildDepositTransactionParameters<
-      chain,
-      account,
-      chainOverride,
-      accountOverride
-    >,
-  ) => Promise<BuildDepositTransactionReturnType<account, accountOverride>>
 }
 
 export function publicActionsL2() {
@@ -364,17 +453,20 @@ export function publicActionsL2() {
     client: Client<TTransport, TChain, TAccount>,
   ): PublicActionsL2<TChain, TAccount> => {
     return {
+      buildDepositTransaction: (args) => buildDepositTransaction(client, args),
+      buildProveWithdrawal: (args) => buildProveWithdrawal(client, args),
       estimateContractL1Fee: (args) => estimateContractL1Fee(client, args),
       estimateContractL1Gas: (args) => estimateContractL1Gas(client, args),
       estimateContractTotalFee: (args) =>
         estimateContractTotalFee(client, args),
       estimateContractTotalGas: (args) =>
         estimateContractTotalGas(client, args),
+      estimateInitiateWithdrawalGas: (args) =>
+        estimateInitiateWithdrawalGas(client, args),
       estimateL1Fee: (args) => estimateL1Fee(client, args),
       estimateL1Gas: (args) => estimateL1Gas(client, args),
       estimateTotalFee: (args) => estimateTotalFee(client, args),
       estimateTotalGas: (args) => estimateTotalGas(client, args),
-      buildDepositTransaction: (args) => buildDepositTransaction(client, args),
     }
   }
 }

package/chains/opStack/decorators/walletL1.ts

@@ -7,6 +7,16 @@ import {
   type DepositTransactionReturnType,
   depositTransaction,
 } from '../actions/depositTransaction.js'
+import {
+  type FinalizeWithdrawalParameters,
+  type FinalizeWithdrawalReturnType,
+  finalizeWithdrawal,
+} from '../actions/finalizeWithdrawal.js'
+import {
+  type ProveWithdrawalParameters,
+  type ProveWithdrawalReturnType,
+  proveWithdrawal,
+} from '../actions/proveWithdrawal.js'
 
 export type WalletActionsL1<
   chain extends Chain | undefined = Chain | undefined,
@@ -36,7 +46,7 @@ export type WalletActionsL1<
    *
    * const hash = await client.depositTransaction({
    *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
-   *   args: {
+   *   request: {
    *     gas: 21_000n,
    *     to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
    *     value: parseEther('1'),
@@ -58,7 +68,7 @@ export type WalletActionsL1<
    * }).extend(walletActionsL1())
    *
    * const hash = await client.depositTransaction({
-   *   args: {
+   *   request: {
    *     gas: 21_000n,
    *     to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
    *     value: parseEther('1'),
@@ -69,6 +79,63 @@ export type WalletActionsL1<
   depositTransaction: <chainOverride extends Chain | undefined = undefined>(
     parameters: DepositTransactionParameters<chain, account, chainOverride>,
   ) => Promise<DepositTransactionReturnType>
+  /**
+   * Finalizes a withdrawal that occurred on an L2. Used in the Withdrawal flow.
+   *
+   * - Docs: https://viem.sh/op-stack/actions/finalizeWithdrawal.html
+   *
+   * @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 { walletActionsL1 } from 'viem/op-stack'
+   *
+   * const walletClientL1 = createWalletClient({
+   *   chain: mainnet,
+   *   transport: http(),
+   * }).extend(walletActionsL1)
+   *
+   * const hash = await walletClientL1.finalizeWithdrawal({
+   *   targetChain: optimism,
+   *   withdrawal: { ... },
+   * })
+   */
+  finalizeWithdrawal: <chainOverride extends Chain | undefined = undefined>(
+    parameters: FinalizeWithdrawalParameters<chain, account, chainOverride>,
+  ) => Promise<FinalizeWithdrawalReturnType>
+  /**
+   * Proves a withdrawal that occurred on an L2. Used in the Withdrawal flow.
+   *
+   * - Docs: https://viem.sh/op-stack/actions/proveWithdrawal.html
+   *
+   * @param client - Client to use
+   * @param parameters - {@link ProveWithdrawalParameters}
+   * @returns The prove transaction hash. {@link ProveWithdrawalReturnType}
+   *
+   * @example
+   * import { createWalletClient, http } from 'viem'
+   * import { mainnet, optimism } from 'viem/chains'
+   * import { walletActionsL1 } from 'viem/op-stack'
+   *
+   * const walletClientL1 = createWalletClient({
+   *   chain: mainnet,
+   *   transport: http(),
+   * }).extend(walletActionsL1())
+   *
+   * const hash = await walletClientL1.proveWithdrawal({
+   *   l2OutputIndex: 4529n,
+   *   outputRootProof: { ... },
+   *   targetChain: optimism,
+   *   withdrawalProof: [ ... ],
+   *   withdrawalTransaction: { ... },
+   * })
+   */
+  proveWithdrawal: <chainOverride extends Chain | undefined = undefined>(
+    parameters: ProveWithdrawalParameters<chain, account, chainOverride>,
+  ) => Promise<ProveWithdrawalReturnType>
 }
 
 export function walletActionsL1() {
@@ -81,6 +148,8 @@ export function walletActionsL1() {
   ): WalletActionsL1<TChain, TAccount> => {
     return {
       depositTransaction: (args) => depositTransaction(client, args),
+      finalizeWithdrawal: (args) => finalizeWithdrawal(client, args),
+      proveWithdrawal: (args) => proveWithdrawal(client, args),
     }
   }
 }

package/chains/opStack/decorators/walletL2.ts

@@ -0,0 +1,84 @@
+import type { Client } from '../../../clients/createClient.js'
+import type { Transport } from '../../../clients/transports/createTransport.js'
+import type { Account } from '../../../types/account.js'
+import type { Chain } from '../../../types/chain.js'
+import {
+  type InitiateWithdrawalParameters,
+  type InitiateWithdrawalReturnType,
+  initiateWithdrawal,
+} from '../actions/initiateWithdrawal.js'
+
+export type WalletActionsL2<
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = Account | undefined,
+> = {
+  /**
+   * 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 { walletActionsL2 } from 'viem/op-stack'
+   *
+   * const client = createWalletClient({
+   *   chain: mainnet,
+   *   transport: custom(window.ethereum),
+   * }).extend(walletActionsL2())
+   *
+   * const hash = await client.initiateWithdrawal({
+   *   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 { walletActionsL2 } from 'viem/op-stack'
+   *
+   * const client = createWalletClient({
+   *   account: privateKeyToAccount('0x…'),
+   *   chain: mainnet,
+   *   transport: http(),
+   * }).extend(walletActionsL2())
+   *
+   * const hash = await client.initiateWithdrawal({
+   *   args: {
+   *     gas: 21_000n,
+   *     to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+   *     value: parseEther('1'),
+   *   },
+   * })
+   */
+  initiateWithdrawal: <chainOverride extends Chain | undefined = undefined>(
+    parameters: InitiateWithdrawalParameters<chain, account, chainOverride>,
+  ) => Promise<InitiateWithdrawalReturnType>
+}
+
+export function walletActionsL2() {
+  return <
+    TTransport extends Transport,
+    TChain extends Chain | undefined = Chain | undefined,
+    TAccount extends Account | undefined = Account | undefined,
+  >(
+    client: Client<TTransport, TChain, TAccount>,
+  ): WalletActionsL2<TChain, TAccount> => {
+    return {
+      initiateWithdrawal: (args) => initiateWithdrawal(client, args),
+    }
+  }
+}

package/chains/opStack/errors/withdrawal.ts

@@ -0,0 +1,15 @@
+import { BaseError } from '../../../errors/base.js'
+import type { Hex } from '../../../types/misc.js'
+
+export type ReceiptContainsNoWithdrawalsErrorType =
+  ReceiptContainsNoWithdrawalsError & {
+    name: 'ReceiptContainsNoWithdrawalsError'
+  }
+export class ReceiptContainsNoWithdrawalsError extends BaseError {
+  override name = 'ReceiptContainsNoWithdrawalsError'
+  constructor({ hash }: { hash: Hex }) {
+    super(
+      `The provided transaction receipt with hash "${hash}" contains no withdrawals.`,
+    )
+  }
+}

package/chains/opStack/index.ts

@@ -1,3 +1,21 @@
+export {
+  buildDepositTransaction,
+  type BuildDepositTransactionErrorType,
+  type BuildDepositTransactionParameters,
+  type BuildDepositTransactionReturnType,
+} from './actions/buildDepositTransaction.js'
+export {
+  buildInitiateWithdrawal,
+  type BuildInitiateWithdrawalErrorType,
+  type BuildInitiateWithdrawalParameters,
+  type BuildInitiateWithdrawalReturnType,
+} from './actions/buildInitiateWithdrawal.js'
+export {
+  buildProveWithdrawal,
+  type BuildProveWithdrawalErrorType,
+  type BuildProveWithdrawalParameters,
+  type BuildProveWithdrawalReturnType,
+} from './actions/buildProveWithdrawal.js'
 export {
   depositTransaction,
   type DepositTransactionErrorType,
@@ -53,28 +71,80 @@ export {
   type EstimateTotalGasReturnType,
 } from './actions/estimateTotalGas.js'
 export {
-  buildDepositTransaction,
-  type BuildDepositTransactionErrorType,
-  type BuildDepositTransactionParameters,
-  type BuildDepositTransactionReturnType,
-} from './actions/buildDepositTransaction.js'
+  finalizeWithdrawal,
+  type FinalizeWithdrawalErrorType,
+  type FinalizeWithdrawalParameters,
+  type FinalizeWithdrawalReturnType,
+} from './actions/finalizeWithdrawal.js'
+export {
+  getL2Output,
+  type GetL2OutputErrorType,
+  type GetL2OutputParameters,
+  type GetL2OutputReturnType,
+} from './actions/getL2Output.js'
+export {
+  getTimeToFinalize,
+  type GetTimeToFinalizeErrorType,
+  type GetTimeToFinalizeParameters,
+  type GetTimeToFinalizeReturnType,
+} from './actions/getTimeToFinalize.js'
+export {
+  getTimeToNextL2Output,
+  type GetTimeToNextL2OutputErrorType,
+  type GetTimeToNextL2OutputParameters,
+  type GetTimeToNextL2OutputReturnType,
+} from './actions/getTimeToNextL2Output.js'
+export {
+  getTimeToProve,
+  type GetTimeToProveErrorType,
+  type GetTimeToProveParameters,
+  type GetTimeToProveReturnType,
+} from './actions/getTimeToProve.js'
+export {
+  getWithdrawalStatus,
+  type GetWithdrawalStatusErrorType,
+  type GetWithdrawalStatusParameters,
+  type GetWithdrawalStatusReturnType,
+} from './actions/getWithdrawalStatus.js'
+export {
+  initiateWithdrawal,
+  type InitiateWithdrawalErrorType,
+  type InitiateWithdrawalParameters,
+  type InitiateWithdrawalReturnType,
+} from './actions/initiateWithdrawal.js'
+export {
+  proveWithdrawal,
+  type ProveWithdrawalErrorType,
+  type ProveWithdrawalParameters,
+  type ProveWithdrawalReturnType,
+} from './actions/proveWithdrawal.js'
+export {
+  waitForNextL2Output,
+  type WaitForNextL2OutputErrorType,
+  type WaitForNextL2OutputParameters,
+  type WaitForNextL2OutputReturnType,
+} from './actions/waitForNextL2Output.js'
+export {
+  waitToFinalize,
+  type WaitToFinalizeErrorType,
+  type WaitToFinalizeParameters,
+  type WaitToFinalizeReturnType,
+} from './actions/waitToFinalize.js'
+export {
+  waitToProve,
+  type WaitToProveErrorType,
+  type WaitToProveParameters,
+  type WaitToProveReturnType,
+} from './actions/waitToProve.js'
 
 export { chainConfig } from './chainConfig.js'
 
-export {
-  base,
-  baseGoerli,
-  baseSepolia,
-  optimism,
-  optimismGoerli,
-  optimismSepolia,
-  zora,
-  zoraSepolia,
-  zoraTestnet,
-} from './chains.js'
+export * from './chains.js'
 
+export { publicActionsL1, type PublicActionsL1 } from './decorators/publicL1.js'
 export { publicActionsL2, type PublicActionsL2 } from './decorators/publicL2.js'
 export { walletActionsL1, type WalletActionsL1 } from './decorators/walletL1.js'
+export { walletActionsL2, type WalletActionsL2 } from './decorators/walletL2.js'
 
 export {
   parseTransaction,
@@ -106,6 +176,13 @@ export type {
   OpStackTransactionReceiptOverrides,
 } from './types/transaction.js'
 
+export {
+  extractWithdrawalMessageLogs,
+  type ExtractWithdrawalMessageLogsErrorType,
+  type ExtractWithdrawalMessageLogsParameters,
+  type ExtractWithdrawalMessageLogsReturnType,
+} from './utils/extractWithdrawalMessageLogs.js'
+
 export {
   extractTransactionDepositedLogs,
   type ExtractTransactionDepositedLogsErrorType,
@@ -114,11 +191,11 @@ export {
 } from './utils/extractTransactionDepositedLogs.js'
 
 export {
-  fromOpaqueData,
-  type FromOpaqueDataErrorType,
-  type FromOpaqueDataParameters,
-  type FromOpaqueDataReturnType,
-} from './utils/fromOpaqueData.js'
+  opaqueDataToDepositData,
+  type OpaqueDataToDepositDataErrorType,
+  type OpaqueDataToDepositDataParameters,
+  type OpaqueDataToDepositDataReturnType,
+} from './utils/opaqueDataToDepositData.js'
 
 export {
   getL2TransactionHash,
@@ -140,3 +217,17 @@ export {
   type GetSourceHashParameters,
   type GetSourceHashReturnType,
 } from './utils/getSourceHash.js'
+
+export {
+  getWithdrawalHashStorageSlot,
+  type GetWithdrawalHashStorageSlotErrorType,
+  type GetWithdrawalHashStorageSlotParameters,
+  type GetWithdrawalHashStorageSlotReturnType,
+} from './utils/getWithdrawalHashStorageSlot.js'
+
+export {
+  getWithdrawals,
+  type GetWithdrawalsErrorType,
+  type GetWithdrawalsParameters,
+  type GetWithdrawalsReturnType,
+} from './utils/getWithdrawals.js'

package/chains/opStack/types/deposit.ts

@@ -0,0 +1,28 @@
+import type { Address } from 'abitype'
+import type { Hex } from '../../../types/misc.js'
+
+export type DepositRequest = {
+  /** Gas limit for transaction execution on the L2. */
+  gas: bigint
+  /** Value in wei to mint (deposit) on the L2. Debited from the caller's L1 balance. */
+  mint?: bigint
+  /** Value in wei sent with this transaction on the L2. Debited from the caller's L2 balance. */
+  value?: bigint
+} & (
+  | {
+      /** Encoded contract method & arguments. */
+      data?: Hex
+      /** Whether or not this is a contract deployment transaction. */
+      isCreation?: false
+      /** L2 Transaction recipient. */
+      to?: Address
+    }
+  | {
+      /** Contract deployment bytecode. Required for contract deployment transactions. */
+      data: Hex
+      /** Whether or not this is a contract deployment transaction. */
+      isCreation: true
+      /** L2 Transaction recipient. Cannot exist for contract deployment transactions. */
+      to?: never
+    }
+)

package/chains/opStack/types/withdrawal.ts

@@ -0,0 +1,23 @@
+import type { Address } from 'abitype'
+import type { Hex } from '../../../types/misc.js'
+
+export type WithdrawalRequest = {
+  /** Encoded contract method & arguments. */
+  data?: Hex
+  /** Gas limit for transaction execution on the L1. */
+  gas: bigint
+  /** L1 Transaction recipient. */
+  to: Address
+  /** Value in wei to withdrawal to the L1. Debited from the caller's L2 balance. */
+  value?: bigint
+}
+
+export type Withdrawal = {
+  nonce: bigint
+  sender: Hex
+  target: Hex
+  value: bigint
+  gasLimit: bigint
+  data: Hex
+  withdrawalHash: Hex
+}

package/chains/opStack/utils/extractWithdrawalMessageLogs.ts

@@ -0,0 +1,36 @@
+import type { ErrorType } from '../../../errors/utils.js'
+import type { Log } from '../../../types/log.js'
+import {
+  type ParseEventLogsErrorType,
+  parseEventLogs,
+} from '../../../utils/abi/parseEventLogs.js'
+import { l2ToL1MessagePasserAbi } from '../abis.js'
+
+export type ExtractWithdrawalMessageLogsParameters = {
+  /** An opaque array of logs. */
+  logs: Log[]
+}
+
+export type ExtractWithdrawalMessageLogsReturnType = Log<
+  bigint,
+  number,
+  false,
+  undefined,
+  true,
+  typeof l2ToL1MessagePasserAbi,
+  'MessagePassed'
+>[]
+
+export type ExtractWithdrawalMessageLogsErrorType =
+  | ParseEventLogsErrorType
+  | ErrorType
+
+export function extractWithdrawalMessageLogs({
+  logs,
+}: ExtractWithdrawalMessageLogsParameters) {
+  return parseEventLogs({
+    abi: l2ToL1MessagePasserAbi,
+    eventName: 'MessagePassed',
+    logs,
+  })
+}