viem 2.10.11 → 2.11.0

package/zksync/actions/getLogProof.ts

@@ -0,0 +1,28 @@
+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 { Hash } from '../../types/misc.js'
+import type { PublicZkSyncRpcSchema } from '../types/eip1193.js'
+import type { MessageProof } from '../types/proof.js'
+
+export type GetLogProofParameters = {
+  txHash: Hash
+  index?: number | undefined
+}
+
+export type GetLogProofReturnType = MessageProof | null
+
+export async function getLogProof<
+  TChain extends Chain | undefined,
+  TAccount extends Account | undefined,
+>(
+  client: Client<Transport, TChain, TAccount, PublicZkSyncRpcSchema>,
+  parameters: GetLogProofParameters,
+): Promise<MessageProof | null> {
+  const result = await client.request({
+    method: 'zks_getL2ToL1LogProof',
+    params: [parameters.txHash, parameters.index],
+  })
+  return result
+}

package/zksync/actions/getMainContractAddress.ts

@@ -0,0 +1,18 @@
+import type { Address } from 'abitype'
+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 { PublicZkSyncRpcSchema } from '../types/eip1193.js'
+
+export type GetMainContractAddressReturnType = Address
+
+export async function getMainContractAddress<
+  TChain extends Chain | undefined,
+  TAccount extends Account | undefined,
+>(
+  client: Client<Transport, TChain, TAccount, PublicZkSyncRpcSchema>,
+): Promise<GetMainContractAddressReturnType> {
+  const address = await client.request({ method: 'zks_getMainContract' })
+  return address
+}

package/zksync/actions/getRawBlockTransactions.ts

@@ -0,0 +1,26 @@
+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 { ZkSyncNumberParameter } from '../types/block.js'
+import type { PublicZkSyncRpcSchema } from '../types/eip1193.js'
+import type { ZkSyncRawBlockTransactions } from '../types/transaction.js'
+import { camelCaseKeys } from '../utils/camelCaseKeys.js'
+
+export type GetRawBlockTransactionsParameters = ZkSyncNumberParameter
+
+export type GetRawBlockTransactionsReturnType = ZkSyncRawBlockTransactions
+
+export async function getRawBlockTransactions<
+  TChain extends Chain | undefined,
+  TAccount extends Account | undefined,
+>(
+  client: Client<Transport, TChain, TAccount, PublicZkSyncRpcSchema>,
+  parameters: GetRawBlockTransactionsParameters,
+): Promise<GetRawBlockTransactionsReturnType> {
+  const result = await client.request({
+    method: 'zks_getRawBlockTransactions',
+    params: [parameters.number],
+  })
+  return camelCaseKeys(result) as GetRawBlockTransactionsReturnType
+}

package/zksync/actions/getTestnetPaymasterAddress.ts

@@ -0,0 +1,18 @@
+import type { Address } from 'abitype'
+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 { PublicZkSyncRpcSchema } from '../types/eip1193.js'
+
+export type GetTestnetPaymasterAddressReturnType = Address | null
+
+export async function getTestnetPaymasterAddress<
+  TChain extends Chain | undefined,
+  TAccount extends Account | undefined,
+>(
+  client: Client<Transport, TChain, TAccount, PublicZkSyncRpcSchema>,
+): Promise<GetTestnetPaymasterAddressReturnType> {
+  const result = await client.request({ method: 'zks_getTestnetPaymaster' })
+  return result
+}

package/zksync/actions/getTransactionDetails.ts

@@ -0,0 +1,27 @@
+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 { Hash } from '../../types/misc.js'
+import type { PublicZkSyncRpcSchema } from '../types/eip1193.js'
+import type { ZkSyncTransactionDetails } from '../types/transaction.js'
+
+export type GetTransactionDetailsParameters = {
+  txHash: Hash
+}
+
+export type GetTransactionDetailsReturnType = ZkSyncTransactionDetails
+
+export async function getTransactionDetails<
+  TChain extends Chain | undefined,
+  TAccount extends Account | undefined,
+>(
+  client: Client<Transport, TChain, TAccount, PublicZkSyncRpcSchema>,
+  parameters: GetTransactionDetailsParameters,
+): Promise<GetTransactionDetailsReturnType> {
+  const result = await client.request({
+    method: 'zks_getTransactionDetails',
+    params: [parameters.txHash],
+  })
+  return result
+}

package/zksync/constants/address.ts

@@ -1,2 +1,11 @@
 export const contractDeployerAddress =
   '0x0000000000000000000000000000000000008006' as const
+
+export const legacyEthAddress =
+  '0x0000000000000000000000000000000000000000' as const
+
+export const ethAddressInContracts =
+  '0x0000000000000000000000000000000000000001' as const
+
+export const l2BaseTokenAddress =
+  '0x000000000000000000000000000000000000800a' as const

package/zksync/decorators/publicL1.ts

@@ -0,0 +1,180 @@
+import type { Chain } from '../../chains/index.js'
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Account } from '../../types/account.js'
+import {
+  type GetL1AllowanceParameters,
+  type GetL1AllowanceReturnType,
+  getL1Allowance,
+} from '../actions/getL1Allowance.js'
+import {
+  type GetL1BalanceParameters,
+  type GetL1BalanceReturnType,
+  getL1Balance,
+} from '../actions/getL1Balance.js'
+import {
+  type GetL1TokenBalanceParameters,
+  type GetL1TokenBalanceReturnType,
+  getL1TokenBalance,
+} from '../actions/getL1TokenBalance.js'
+
+export type PublicActionsL1<
+  TAccount extends Account | undefined = Account | undefined,
+> = {
+  /**
+   * Returns the amount of approved tokens for a specific L1 bridge.
+   *
+   * - Docs: https://viem.sh/zksync/actions/getL1Allowance
+   *
+   * @param client - Client to use
+   * @param parameters - {@link AllowanceL1Parameters}
+   * @returns The amount of approved tokens for a specific L1 bridge. {@link GetL1AllowanceReturnType}
+   *
+   * @example
+   * import { createPublicClient, custom, parseEther } from 'viem'
+   * import { base, mainnet } from 'viem/chains'
+   * import { publicActionsL1 } from 'viem/zksync'
+   *
+   * const client = createPublicClient({
+   *   chain: mainnet,
+   *   transport: custom(window.ethereum),
+   * }).extend(publicActionsL1())
+   *
+   * const data = await client.getL1Allowance({
+   *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+   *   token: '0x5C221E77624690fff6dd741493D735a17716c26B'
+   *   bridgeAddress: '0x84DbCC0B82124bee38e3Ce9a92CdE2f943bab60D',
+   * })
+   *
+   * @example
+   * // Account Hoisting
+   * import { createWalletClient, http } from 'viem'
+   * import { privateKeyToAccount } from 'viem/accounts'
+   * import { base, mainnet } from 'viem/chains'
+   * import { publicActionsL1 } from 'viem/zksync'
+   *
+   * const client = createWalletClient({
+   *   account: privateKeyToAccount('0x…'),
+   *   chain: mainnet,
+   *   transport: http(),
+   * }).extend(publicActionsL1())
+   *
+   * const data = await client.getL1Allowance({
+   *   token: '0x5C221E77624690fff6dd741493D735a17716c26B'
+   *   bridgeAddress: '0x84DbCC0B82124bee38e3Ce9a92CdE2f943bab60D',
+   * })
+   */
+  getL1Allowance: (
+    parameters: GetL1AllowanceParameters<TAccount>,
+  ) => Promise<GetL1AllowanceReturnType>
+  /**
+   * Returns the amount of the ERC20 token the client has on specific address.
+   *
+   * - Docs: https://viem.sh/zksync/actions/getL1TokenBalance
+   *
+   * @param client - Client to use
+   * @param parameters - {@link GetL1TokenBalanceParameters}
+   * @returns The amount of the ERC20 token the client has on specific addresse. {@link GetL1TokenBalanceReturnType}
+   *
+   * @example
+   * import { createPublicClient, custom, parseEther } from 'viem'
+   * import { base, mainnet } from 'viem/chains'
+   * import { publicActionsL1 } from 'viem/zksync'
+   *
+   * const client = createPublicClient({
+   *   chain: mainnet,
+   *   transport: custom(window.ethereum),
+   * }).extend(publicActionsL1())
+   *
+   * const data = await client.getL1TokenBalance({
+   *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+   *   token: '0x5C221E77624690fff6dd741493D735a17716c26B'
+   * })
+   *
+   * @example
+   * // Account Hoisting
+   * import { createWalletClient, http } from 'viem'
+   * import { privateKeyToAccount } from 'viem/accounts'
+   * import { base, mainnet } from 'viem/chains'
+   * import { publicActionsL1 } from 'viem/zksync'
+   *
+   * const client = createWalletClient({
+   *   account: privateKeyToAccount('0x…'),
+   *   chain: mainnet,
+   *   transport: http(),
+   * }).extend(publicActionsL1())
+   *
+   * const data = await client.getL1TokenBalance({
+   *   token: '0x5C221E77624690fff6dd741493D735a17716c26B'
+   * })
+   */
+  getL1TokenBalance: (
+    parameters: GetL1TokenBalanceParameters<TAccount>,
+  ) => Promise<GetL1TokenBalanceReturnType>
+  /**
+   * Returns the amount of the token held by the account on the L1 network.
+   *
+   * - Docs: https://viem.sh/zksync/actions/getL1TokenBalance
+   *
+   * @param client - Client to use
+   * @param parameters - {@link BalanceL1Parameters}
+   * @returns Returns the amount of the token held by the account on the L1 network. {@link GetL1BalanceReturnType}
+   *
+   * @example
+   * import { createPublicClient, custom, parseEther } from 'viem'
+   * import { base, mainnet } from 'viem/chains'
+   * import { publicActionsL1 } from 'viem/zksync'
+   *
+   * const client = createPublicClient({
+   *   chain: mainnet,
+   *   transport: custom(window.ethereum),
+   * }).extend(publicActionsL1())
+   *
+   * const data = await client.getL1Balance({
+   *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'
+   * })
+   *
+   * const data = await client.getL1Balance({
+   *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+   *   token: '0x5C221E77624690fff6dd741493D735a17716c26B'
+   * })
+   *
+   * @example
+   * // Account Hoisting
+   * import { createWalletClient, http } from 'viem'
+   * import { privateKeyToAccount } from 'viem/accounts'
+   * import { base, mainnet } from 'viem/chains'
+   * import { publicActionsL1 } from 'viem/zksync'
+   *
+   * const client = createWalletClient({
+   *   account: privateKeyToAccount('0x…'),
+   *   chain: mainnet,
+   *   transport: http(),
+   * }).extend(publicActionsL1())
+   *
+   * const data = await client.getL1Balance({})
+   *
+   * const data = await client.getL1Balance({
+   *  token: '0x5C221E77624690fff6dd741493D735a17716c26B'
+   * })
+   */
+  getL1Balance: (
+    ...parameters: TAccount extends undefined
+      ? [GetL1BalanceParameters<TAccount>]
+      : [GetL1BalanceParameters<TAccount>] | []
+  ) => Promise<GetL1BalanceReturnType>
+}
+
+export function publicActionsL1() {
+  return <
+    TChain extends Chain | undefined = Chain | undefined,
+    TAccount extends Account | undefined = Account | undefined,
+  >(
+    client: Client<Transport, TChain, TAccount>,
+  ): PublicActionsL1<TAccount> => ({
+    getL1Allowance: (args) => getL1Allowance(client, args),
+    getL1TokenBalance: (args) => getL1TokenBalance(client, args),
+    // @ts-expect-error
+    getL1Balance: (args) => getL1Balance(client, args),
+  })
+}