viem 2.22.8 → 2.22.10

package/zksync/actions/withdraw.ts

@@ -0,0 +1,185 @@
+import type { Address } from 'abitype'
+import type { Account } from '../../accounts/types.js'
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import { AccountNotFoundError } from '../../errors/account.js'
+import type { GetAccountParameter } from '../../types/account.js'
+import type { GetChainParameter } from '../../types/chain.js'
+import type { UnionOmit } from '../../types/utils.js'
+import type { EncodeFunctionDataReturnType } from '../../utils/abi/encodeFunctionData.js'
+import {
+  encodeFunctionData,
+  isAddressEqual,
+  parseAccount,
+} from '../../utils/index.js'
+import { ethTokenAbi, l2SharedBridgeAbi } from '../constants/abis.js'
+import {
+  ethAddressInContracts,
+  l2BaseTokenAddress,
+  legacyEthAddress,
+} from '../constants/address.js'
+import type { ChainEIP712 } from '../types/chain.js'
+import type { ZksyncTransactionRequest } from '../types/transaction.js'
+import { getDefaultBridgeAddresses } from './getDefaultBridgeAddresses.js'
+import { getL2TokenAddress } from './getL2TokenAddress.js'
+import {
+  type SendTransactionErrorType,
+  type SendTransactionParameters,
+  type SendTransactionReturnType,
+  sendTransaction,
+} from './sendTransaction.js'
+
+export type WithdrawParameters<
+  chain extends ChainEIP712 | undefined = ChainEIP712 | undefined,
+  account extends Account | undefined = Account | undefined,
+  chainOverride extends ChainEIP712 | undefined = ChainEIP712 | undefined,
+> = UnionOmit<
+  ZksyncTransactionRequest,
+  'from' | 'type' | 'value' | 'data' | 'to' | 'factoryDeps' | 'maxFeePerBlobGas'
+> &
+  Partial<GetAccountParameter<account>> &
+  Partial<GetChainParameter<chain, chainOverride>> & {
+    /** The address of the recipient on L1. Defaults to the sender address. */
+    to?: Address
+    /** The address of the token. */
+    token: Address
+    /** The amount of the token to withdraw. */
+    amount: bigint
+    /** The address of the bridge contract to be used. */
+    bridgeAddress?: Address
+  }
+
+export type WithdrawReturnType = SendTransactionReturnType
+
+export type WithdrawErrorType = SendTransactionErrorType
+
+/**
+ * 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 client - Client to use
+ * @param parameters - {@link WithdrawParameters}
+ * @returns hash - The [Transaction](https://viem.sh/docs/glossary/terms#transaction) hash. {@link WithdrawReturnType}
+ *
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { privateKeyToAccount } from 'viem/accounts'
+ * import { zksync } from 'viem/chains'
+ * import { withdraw, legacyEthAddress } from 'viem/zksync'
+ *
+ * const client = createPublicClient({
+ *   chain: zksync,
+ *   transport: http(),
+ * })
+ *
+ * const hash = await withdraw(client, {
+ *     account: privateKeyToAccount('0x…'),
+ *     amount: 1_000_000_000_000_000_000n,
+ *     token: legacyEthAddress,
+ * })
+ *
+ * @example Account Hoisting
+ * import { createPublicClient, createWalletClient, http } from 'viem'
+ * import { privateKeyToAccount } from 'viem/accounts'
+ * import { zksync } from 'viem/chains'
+ * import { withdraw, legacyEthAddress } from 'viem/zksync'
+ *
+ * const client = createWalletClient({
+ *   account: privateKeyToAccount('0x…'),
+ *   chain: zksync,
+ *   transport: http(),
+ * })
+ *
+ * const hash = await withdraw(client, {
+ *     amount: 1_000_000_000_000_000_000n,
+ *     token: legacyEthAddress,
+ * })
+ *
+ * @example Paymaster
+ * import { createPublicClient, http } from 'viem'
+ * import { privateKeyToAccount } from 'viem/accounts'
+ * import { zksync } from 'viem/chains'
+ * import {
+ *   withdraw,
+ *   legacyEthAddress,
+ *   getApprovalBasedPaymasterInput
+ * } from 'viem/zksync'
+ *
+ * const client = createPublicClient({
+ *   chain: zksync,
+ *   transport: http(),
+ * })
+ *
+ * const hash = await withdraw(client, {
+ *     account: privateKeyToAccount('0x…'),
+ *     amount: 1_000_000_000_000_000_000n,
+ *     token: legacyEthAddress,
+ *     paymaster: '0x0EEc6f45108B4b806e27B81d9002e162BD910670',
+ *     paymasterInput: getApprovalBasedPaymasterInput({
+ *       minAllowance: 1n,
+ *       token: '0x2dc3685cA34163952CF4A5395b0039c00DFa851D',
+ *       innerInput: new Uint8Array(),
+ *     }),
+ * })
+ */
+export async function withdraw<
+  chain extends ChainEIP712 | undefined,
+  account extends Account | undefined,
+  chainOverride extends ChainEIP712 | undefined = undefined,
+>(
+  client: Client<Transport, chain, account>,
+  parameters: WithdrawParameters<chain, account, chainOverride>,
+): Promise<WithdrawReturnType> {
+  let {
+    account: account_ = client.account,
+    token = l2BaseTokenAddress,
+    to,
+    amount,
+    bridgeAddress,
+    ...rest
+  } = parameters
+  const account = account_ ? parseAccount(account_) : client.account
+  if (!account)
+    throw new AccountNotFoundError({
+      docsPath: '/docs/actions/wallet/sendTransaction',
+    })
+
+  if (!to) to = account.address
+  let data: EncodeFunctionDataReturnType
+  let contract: Address
+  let value = 0n
+
+  if (
+    isAddressEqual(token, legacyEthAddress) ||
+    isAddressEqual(token, ethAddressInContracts)
+  )
+    token = await getL2TokenAddress(client, { token: ethAddressInContracts })
+
+  if (isAddressEqual(token, l2BaseTokenAddress)) {
+    data = encodeFunctionData({
+      abi: ethTokenAbi,
+      functionName: 'withdraw',
+      args: [to],
+    })
+    value = amount
+    contract = l2BaseTokenAddress
+  } else {
+    data = encodeFunctionData({
+      abi: l2SharedBridgeAbi,
+      functionName: 'withdraw',
+      args: [to, token, amount],
+    })
+    contract = bridgeAddress
+      ? bridgeAddress
+      : (await getDefaultBridgeAddresses(client)).sharedL2
+  }
+
+  return await sendTransaction(client, {
+    account,
+    to: contract,
+    data,
+    value,
+    ...rest,
+  } as SendTransactionParameters)
+}

package/zksync/constants/abis.ts

@@ -647,6 +647,252 @@ export const l2SharedBridgeAbi = [
   },
 ] as const
 
+export const ethTokenAbi = [
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'account',
+        type: 'address',
+      },
+      {
+        indexed: false,
+        internalType: 'uint256',
+        name: 'amount',
+        type: 'uint256',
+      },
+    ],
+    name: 'Mint',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'from',
+        type: 'address',
+      },
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'to',
+        type: 'address',
+      },
+      {
+        indexed: false,
+        internalType: 'uint256',
+        name: 'value',
+        type: 'uint256',
+      },
+    ],
+    name: 'Transfer',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'address',
+        name: '_l2Sender',
+        type: 'address',
+      },
+      {
+        indexed: true,
+        internalType: 'address',
+        name: '_l1Receiver',
+        type: 'address',
+      },
+      {
+        indexed: false,
+        internalType: 'uint256',
+        name: '_amount',
+        type: 'uint256',
+      },
+    ],
+    name: 'Withdrawal',
+    type: 'event',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'address',
+        name: '_l2Sender',
+        type: 'address',
+      },
+      {
+        indexed: true,
+        internalType: 'address',
+        name: '_l1Receiver',
+        type: 'address',
+      },
+      {
+        indexed: false,
+        internalType: 'uint256',
+        name: '_amount',
+        type: 'uint256',
+      },
+      {
+        indexed: false,
+        internalType: 'bytes',
+        name: '_additionalData',
+        type: 'bytes',
+      },
+    ],
+    name: 'WithdrawalWithMessage',
+    type: 'event',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'uint256',
+        name: '',
+        type: 'uint256',
+      },
+    ],
+    name: 'balanceOf',
+    outputs: [
+      {
+        internalType: 'uint256',
+        name: '',
+        type: 'uint256',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'decimals',
+    outputs: [
+      {
+        internalType: 'uint8',
+        name: '',
+        type: 'uint8',
+      },
+    ],
+    stateMutability: 'pure',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'address',
+        name: '_account',
+        type: 'address',
+      },
+      {
+        internalType: 'uint256',
+        name: '_amount',
+        type: 'uint256',
+      },
+    ],
+    name: 'mint',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'name',
+    outputs: [
+      {
+        internalType: 'string',
+        name: '',
+        type: 'string',
+      },
+    ],
+    stateMutability: 'pure',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'symbol',
+    outputs: [
+      {
+        internalType: 'string',
+        name: '',
+        type: 'string',
+      },
+    ],
+    stateMutability: 'pure',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'totalSupply',
+    outputs: [
+      {
+        internalType: 'uint256',
+        name: '',
+        type: 'uint256',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'address',
+        name: '_from',
+        type: 'address',
+      },
+      {
+        internalType: 'address',
+        name: '_to',
+        type: 'address',
+      },
+      {
+        internalType: 'uint256',
+        name: '_amount',
+        type: 'uint256',
+      },
+    ],
+    name: 'transferFromTo',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'address',
+        name: '_l1Receiver',
+        type: 'address',
+      },
+    ],
+    name: 'withdraw',
+    outputs: [],
+    stateMutability: 'payable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'address',
+        name: '_l1Receiver',
+        type: 'address',
+      },
+      {
+        internalType: 'bytes',
+        name: '_additionalData',
+        type: 'bytes',
+      },
+    ],
+    name: 'withdrawWithMessage',
+    outputs: [],
+    stateMutability: 'payable',
+    type: 'function',
+  },
+] as const
+
 export const bridgehubAbi = [
   {
     anonymous: false,

package/zksync/constants/address.ts

@@ -4,11 +4,13 @@ export const contractDeployerAddress =
 export const contract2FactoryAddress =
   '0x0000000000000000000000000000000000010000' as const
 
+/** The address of the L1 `ETH` token. */
 export const legacyEthAddress =
   '0x0000000000000000000000000000000000000000' as const
 
 export const ethAddressInContracts =
   '0x0000000000000000000000000000000000000001' as const
 
+/** The address of the base token. */
 export const l2BaseTokenAddress =
   '0x000000000000000000000000000000000000800a' as const

package/zksync/decorators/walletL2.ts

@@ -0,0 +1,95 @@
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Account } from '../../types/account.js'
+import {
+  type WithdrawParameters,
+  type WithdrawReturnType,
+  withdraw,
+} from '../actions/withdraw.js'
+import type { ChainEIP712 } from '../types/chain.js'
+
+export type WalletActionsL2<
+  chain extends ChainEIP712 | undefined = ChainEIP712 | 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 args - {@link WithdrawParameters}
+   * @returns hash - The [Transaction](https://viem.sh/docs/glossary/terms#transaction) hash. {@link WithdrawReturnType}
+   *
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { privateKeyToAccount } from 'viem/accounts'
+   * import { zksync } from 'viem/chains'
+   * import { publicActionsL2, legacyEthAddress } from 'viem/zksync'
+   *
+   * const client = createPublicClient({
+   *   chain: zksync,
+   *   transport: http(),
+   * }).extend(publicActionsL2())
+   *
+   * const hash = await client.withdraw({
+   *     account: privateKeyToAccount('0x…'),
+   *     amount: 1_000_000_000_000_000_000n,
+   *     token: legacyEthAddress,
+   * })
+   *
+   * @example Account Hoisting
+   * import { createWalletClient, http } from 'viem'
+   * import { privateKeyToAccount } from 'viem/accounts'
+   * import { zksync } from 'viem/chains'
+   * import { publicActionsL2, legacyEthAddress } from 'viem/zksync'
+   *
+   * const client = createWalletClient({
+   *   account: privateKeyToAccount('0x…'),
+   *   chain: zksync,
+   *   transport: http(),
+   * }).extend(publicActionsL2())
+   *
+   * const hash = await client.withdraw({
+   *     amount: 1_000_000_000_000_000_000n,
+   *     token: legacyEthAddress,
+   * })
+   *
+   * @example Paymaster
+   * import { createPublicClient, http } from 'viem'
+   * import { privateKeyToAccount } from 'viem/accounts'
+   * import { zksync } from 'viem/chains'
+   * import { publicActionsL2, legacyEthAddress } from 'viem/zksync'
+   *
+   * const client = createPublicClient({
+   *   chain: zksync,
+   *   transport: http(),
+   * }).extend(publicActionsL2())
+   *
+   * const hash = await client.withdraw({
+   *     account: privateKeyToAccount('0x…'),
+   *     amount: 1_000_000_000_000_000_000n,
+   *     token: legacyEthAddress,
+   *     paymaster: '0x0EEc6f45108B4b806e27B81d9002e162BD910670',
+   *     paymasterInput: getApprovalBasedPaymasterInput({
+   *       minAllowance: 1n,
+   *       token: '0x2dc3685cA34163952CF4A5395b0039c00DFa851D',
+   *       innerInput: new Uint8Array(),
+   *     }),
+   * })
+   */
+  withdraw: <chainOverride extends ChainEIP712 | undefined = undefined>(
+    args: WithdrawParameters<chain, account, chainOverride>,
+  ) => Promise<WithdrawReturnType>
+}
+
+export function walletActionsL2() {
+  return <
+    transport extends Transport,
+    chain extends ChainEIP712 | undefined = ChainEIP712 | undefined,
+    account extends Account | undefined = Account | undefined,
+  >(
+    client: Client<transport, chain, account>,
+  ): WalletActionsL2<chain, account> => ({
+    withdraw: (args) => withdraw(client, args),
+  })
+}

package/zksync/index.ts

@@ -135,6 +135,17 @@ export {
   type GetL1TokenAddressParameters,
   getL1TokenAddress,
 } from './actions/getL1TokenAddress.js'
+export {
+  type WithdrawErrorType,
+  type WithdrawParameters,
+  type WithdrawReturnType,
+  withdraw,
+} from './actions/withdraw.js'
+
+export {
+  legacyEthAddress,
+  l2BaseTokenAddress,
+} from './constants/address.js'
 
 export {
   /** @deprecated Use `zksync` instead */
@@ -176,6 +187,11 @@ export {
   type WalletActionsL1,
 } from './decorators/walletL1.js'
 
+export {
+  walletActionsL2,
+  type WalletActionsL2,
+} from './decorators/walletL2.js'
+
 export { serializeTransaction } from './serializers.js'
 
 export type { ZksyncSmartAccount } from './types/account.js'