viem 2.23.1 → 2.23.3

package/zksync/decorators/walletL1.ts

@@ -2,6 +2,11 @@ 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 FinalizeWithdrawalParameters,
+  type FinalizeWithdrawalReturnType,
+  finalizeWithdrawal,
+} from '../actions/finalizeWithdrawal.js'
 import {
   type RequestExecuteParameters,
   type RequestExecuteReturnType,
@@ -13,6 +18,48 @@ export type WalletActionsL1<
   chain extends Chain | undefined = Chain | undefined,
   account extends Account | undefined = Account | undefined,
 > = {
+  /**
+   * Initiates the withdrawal process which withdraws ETH or any ERC20 token
+   * from the associated account on L2 network to the target account on L1 network.
+   *
+   * @param parameters - {@link FinalizeWithdrawalParameters}
+   * @returns hash - The [Transaction](https://viem.sh/docs/glossary/terms#transaction) hash. {@link FinalizeWithdrawalReturnType}
+   *
+   * @example
+   * import { createPublicClient, createWalletClient, http } from 'viem'
+   * import { privateKeyToAccount } from 'viem/accounts'
+   * import { mainnet, zksync } from 'viem/chains'
+   * import { walletActionsL1, publicActionsL2 } from 'viem/zksync'
+   *
+   * const walletClient = createWalletClient({
+   *   account: privateKeyToAccount('0x…'),
+   *   chain: mainnet,
+   *   transport: http(),
+   * }).extend(walletActionsL1())
+   *
+   * const clientL2 = createPublicClient({
+   *   chain: zksync,
+   *   transport: http(),
+   * }).extend(publicActionsL2())
+   *
+   * const hash = await walletClient.finalizeWithdrawal({
+   *     client: clientL2,
+   *     hash: '0x…',
+   * })
+   */
+  finalizeWithdrawal: <
+    chainOverride extends Chain | undefined = undefined,
+    chainL2 extends ChainEIP712 | undefined = ChainEIP712 | undefined,
+    accountL2 extends Account | undefined = Account | undefined,
+  >(
+    parameters: FinalizeWithdrawalParameters<
+      chain,
+      account,
+      chainOverride,
+      chainL2,
+      accountL2
+    >,
+  ) => Promise<FinalizeWithdrawalReturnType>
   /**
    * Requests execution of a L2 transaction from L1.
    *
@@ -66,6 +113,7 @@ export function walletActionsL1() {
   >(
     client: Client<transport, chain, account>,
   ): WalletActionsL1<chain, account> => ({
+    finalizeWithdrawal: (args) => finalizeWithdrawal(client, args),
     requestExecute: (args) => requestExecute(client, args),
   })
 }

package/zksync/errors/bridge.ts

@@ -1,4 +1,5 @@
 import { BaseError } from '../../errors/base.js'
+import type { Hash } from '../../types/misc.js'
 
 export type BaseFeeHigherThanValueErrorType = BaseFeeHigherThanValueError & {
   name: 'BaseFeeHigherThanValueError'
@@ -27,3 +28,19 @@ export class TxHashNotFoundInLogsError extends BaseError {
     })
   }
 }
+
+export type WithdrawalLogNotFoundErrorType = WithdrawalLogNotFoundError & {
+  name: 'WithdrawalLogNotFoundError'
+}
+export class WithdrawalLogNotFoundError extends BaseError {
+  constructor({ hash }: { hash: Hash }) {
+    super(
+      [
+        `Withdrawal log with hash ${hash} not found.`,
+        '',
+        'Either the withdrawal transaction is still processing or it did not finish successfully.',
+      ].join('\n'),
+      { name: 'WithdrawalLogNotFoundError' },
+    )
+  }
+}

package/zksync/index.ts

@@ -141,6 +141,12 @@ export {
   type WithdrawReturnType,
   withdraw,
 } from './actions/withdraw.js'
+export {
+  type FinalizeWithdrawalErrorType,
+  type FinalizeWithdrawalParameters,
+  type FinalizeWithdrawalReturnType,
+  finalizeWithdrawal,
+} from './actions/finalizeWithdrawal.js'
 
 export {
   legacyEthAddress,

package/zksync/utils/bridge/getWithdrawalL2ToL1Log.ts

@@ -0,0 +1,47 @@
+import type { Address } from 'abitype'
+import type { Account } from '../../../accounts/index.js'
+import { getTransactionReceipt } from '../../../actions/index.js'
+import type { Client } from '../../../clients/createClient.js'
+import type { Transport } from '../../../clients/transports/createTransport.js'
+import type { Chain } from '../../../types/chain.js'
+import type { Hash } from '../../../types/misc.js'
+import { isAddressEqual } from '../../../utils/index.js'
+import { l1MessengerAddress } from '../../constants/address.js'
+import type { ZksyncL2ToL1Log } from '../../types/log.js'
+import type { ZksyncTransactionReceipt } from '../../types/transaction.js'
+
+export type GetWithdrawalL2ToL1LogParameters = {
+  /** Hash of the L2 transaction where the withdrawal was initiated. */
+  hash: Hash
+  /** In case there were multiple withdrawals in one transaction, you may pass an index of the
+   withdrawal you want to finalize. */
+  index?: number | undefined
+}
+
+export type GetWithdrawalL2ToL1LogReturnType = {
+  l2ToL1LogIndex: number | null
+  l2ToL1Log: ZksyncL2ToL1Log
+}
+
+/** @internal */
+export async function getWithdrawalL2ToL1Log<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+>(
+  client: Client<Transport, chain, account>,
+  parameters: GetWithdrawalL2ToL1LogParameters,
+): Promise<GetWithdrawalL2ToL1LogReturnType> {
+  const { hash, index = 0 } = parameters
+  const receipt = (await getTransactionReceipt(client, {
+    hash,
+  })) as ZksyncTransactionReceipt
+  const messages = Array.from(receipt.l2ToL1Logs.entries()).filter(([, log]) =>
+    isAddressEqual(log.sender as Address, l1MessengerAddress),
+  )
+  const [l2ToL1LogIndex, l2ToL1Log] = messages[index]
+
+  return {
+    l2ToL1LogIndex,
+    l2ToL1Log,
+  }
+}

package/zksync/utils/bridge/getWithdrawalLog.ts

@@ -0,0 +1,47 @@
+import type { Account } from '../../../accounts/types.js'
+import { getTransactionReceipt } from '../../../actions/index.js'
+import type { Client } from '../../../clients/createClient.js'
+import type { Transport } from '../../../clients/transports/createTransport.js'
+import type { Chain } from '../../../types/chain.js'
+import type { Hash } from '../../../types/misc.js'
+import { isAddressEqual, toFunctionHash } from '../../../utils/index.js'
+import { l1MessengerAddress } from '../../constants/address.js'
+import type { ZksyncLog } from '../../types/log.js'
+import type { ZksyncTransactionReceipt } from '../../types/transaction.js'
+
+export type GetWithdrawalLogParameters = {
+  /** Hash of the L2 transaction where the withdrawal was initiated. */
+  hash: Hash
+  /** In case there were multiple withdrawals in one transaction, you may pass an index of the
+     withdrawal you want to finalize. */
+  index?: number | undefined
+}
+
+export type GetWithdrawalLogReturnType = {
+  log: ZksyncLog
+  l1BatchTxId: bigint | null
+}
+
+/** @internal */
+export async function getWithdrawalLog<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+>(
+  client: Client<Transport, chain, account>,
+  parameters: GetWithdrawalLogParameters,
+): Promise<GetWithdrawalLogReturnType> {
+  const { hash, index = 0 } = parameters
+  const receipt = (await getTransactionReceipt(client, {
+    hash,
+  })) as ZksyncTransactionReceipt
+  const log = receipt.logs.filter(
+    (log) =>
+      isAddressEqual(log.address, l1MessengerAddress) &&
+      log.topics[0] === toFunctionHash('L1MessageSent(address,bytes32,bytes)'),
+  )[index]
+
+  return {
+    log,
+    l1BatchTxId: receipt.l1BatchTxIndex,
+  }
+}