viem 2.10.11 → 2.11.0

package/celo/types.ts

@@ -76,7 +76,6 @@ export type CeloRpcTransaction<TPending extends boolean = boolean> =
 
 export type CeloRpcTransactionRequest =
   | RpcTransactionRequest
-  | RpcTransactionRequestCIP42
   | RpcTransactionRequestCIP64
 
 export type CeloTransaction<TPending extends boolean = boolean> =
@@ -86,13 +85,10 @@ export type CeloTransaction<TPending extends boolean = boolean> =
 
 export type CeloTransactionRequest =
   | TransactionRequest
-  | TransactionRequestCIP42
   | TransactionRequestCIP64
 
 export type CeloTransactionSerializable = OneOf<
-  | TransactionSerializable
-  | TransactionSerializableCIP42
-  | TransactionSerializableCIP64
+  TransactionSerializable | TransactionSerializableCIP64
 >
 
 export type CeloTransactionSerialized<
@@ -113,8 +109,6 @@ type RpcTransaction<TPending extends boolean = boolean> =
 
 type RpcTransactionRequest = RpcTransactionRequest_ & {
   feeCurrency?: Address | undefined
-  gatewayFee?: Hex | undefined
-  gatewayFeeRecipient?: Address | undefined
 }
 
 export type RpcTransactionCIP42<TPending extends boolean = boolean> = Omit<
@@ -139,18 +133,6 @@ export type RpcTransactionCIP64<TPending extends boolean = boolean> = Omit<
     type: '0x7b'
   }
 
-export type RpcTransactionRequestCIP42 = TransactionRequestBase<
-  Quantity,
-  Index
-> &
-  ExactPartial<FeeValuesEIP1559<Quantity>> & {
-    accessList?: AccessList | undefined
-    feeCurrency?: Address | undefined
-    gatewayFee?: Hex | undefined
-    gatewayFeeRecipient?: Address | undefined
-    type?: '0x7c' | undefined
-  }
-
 export type RpcTransactionRequestCIP64 = TransactionRequestBase<
   Quantity,
   Index
@@ -158,8 +140,6 @@ export type RpcTransactionRequestCIP64 = TransactionRequestBase<
   ExactPartial<FeeValuesEIP1559<Quantity>> & {
     accessList?: AccessList | undefined
     feeCurrency?: Address | undefined
-    gatewayFee?: undefined
-    gatewayFeeRecipient?: undefined
     type?: '0x7b' | undefined
   }
 
@@ -169,8 +149,8 @@ type Transaction<TPending extends boolean = boolean> = Transaction_<
   TPending
 > & {
   feeCurrency: Address | null
-  gatewayFee: bigint | null
-  gatewayFeeRecipient: Address | null
+  gatewayFee?: undefined
+  gatewayFeeRecipient?: undefined
 }
 
 export type TransactionCIP42<TPending extends boolean = boolean> =
@@ -193,25 +173,12 @@ export type TransactionCIP64<TPending extends boolean = boolean> =
 
 type TransactionRequest = TransactionRequest_ & {
   feeCurrency?: Address | undefined
-  gatewayFee?: bigint | undefined
-  gatewayFeeRecipient?: Address | undefined
 }
 
-export type TransactionRequestCIP42 = TransactionRequestBase &
-  ExactPartial<FeeValuesEIP1559> & {
-    accessList?: AccessList | undefined
-    feeCurrency?: Address | undefined
-    gatewayFee?: bigint | undefined
-    gatewayFeeRecipient?: Address | undefined
-    type?: 'cip42' | undefined
-  }
-
 export type TransactionRequestCIP64 = TransactionRequestBase &
   ExactPartial<FeeValuesEIP1559> & {
     accessList?: AccessList | undefined
     feeCurrency?: Address | undefined
-    gatewayFee?: undefined
-    gatewayFeeRecipient?: undefined
     type?: 'cip64' | undefined
   }
 
@@ -235,8 +202,6 @@ export type TransactionSerializableCIP64<
   ExactPartial<FeeValuesEIP1559<TQuantity>> & {
     accessList?: AccessList | undefined
     feeCurrency?: Address | undefined
-    gatewayFee?: undefined
-    gatewayFeeRecipient?: undefined
     chainId: number
     type?: 'cip64' | undefined
   }

package/celo/utils.ts

@@ -3,7 +3,6 @@ import { trim } from '../utils/data/trim.js'
 import type {
   CeloTransactionRequest,
   CeloTransactionSerializable,
-  TransactionSerializableCIP42,
   TransactionSerializableCIP64,
 } from './types.js'
 
@@ -38,23 +37,6 @@ export function isEIP1559(
   )
 }
 
-// process as CIP42 if any of these fields are present. realistically gatewayfee is not used but is part of spec
-export function isCIP42(
-  transaction: CeloTransactionSerializable | CeloTransactionRequest,
-): transaction is TransactionSerializableCIP42 {
-  // Enable end-user to force the tx to be considered as a cip42
-  if (transaction.type === 'cip42') {
-    return true
-  }
-
-  return (
-    isEIP1559(transaction) &&
-    (isPresent(transaction.feeCurrency) ||
-      isPresent(transaction.gatewayFeeRecipient) ||
-      isPresent(transaction.gatewayFee))
-  )
-}
-
 export function isCIP64(
   transaction: CeloTransactionSerializable | CeloTransactionRequest,
 ): transaction is TransactionSerializableCIP64 {
@@ -72,10 +54,5 @@ export function isCIP64(
     return true
   }
 
-  return (
-    isEIP1559(transaction) &&
-    isPresent(transaction.feeCurrency) &&
-    isEmpty(transaction.gatewayFee) &&
-    isEmpty(transaction.gatewayFeeRecipient)
-  )
+  return isEIP1559(transaction) && isPresent(transaction.feeCurrency)
 }

package/chains/index.ts

@@ -302,11 +302,9 @@ export type {
   CeloTransactionSerialized,
   RpcTransactionCIP42,
   RpcTransactionCIP64,
-  RpcTransactionRequestCIP42,
   RpcTransactionRequestCIP64,
   TransactionCIP42,
   TransactionCIP64,
-  TransactionRequestCIP42,
   TransactionRequestCIP64,
   TransactionSerializableCIP42,
   TransactionSerializableCIP64,

package/errors/version.ts

@@ -1 +1 @@
-export const version = '2.10.11'
+export const version = '2.11.0'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "2.10.11",
+  "version": "2.11.0",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",

package/zksync/actions/estimateFee.ts

@@ -0,0 +1,46 @@
+import { parseAccount } from '../../accounts/utils/parseAccount.js'
+import type { SendTransactionParameters } from '../../actions/wallet/sendTransaction.js'
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Account } from '../../types/account.js'
+import { hexToBigInt } from '../../utils/encoding/fromHex.js'
+import type { ChainEIP712 } from '../types/chain.js'
+import type { PublicZkSyncRpcSchema } from '../types/eip1193.js'
+import type { ZkSyncFee } from '../types/fee.js'
+
+export type EstimateFeeParameters<
+  chain extends ChainEIP712 | undefined = ChainEIP712 | undefined,
+  account extends Account | undefined = Account | undefined,
+  chainOverride extends ChainEIP712 | undefined = ChainEIP712 | undefined,
+> = SendTransactionParameters<chain, account, chainOverride>
+
+export type EstimateFeeReturnType = ZkSyncFee
+
+export async function estimateFee<
+  chain extends ChainEIP712 | undefined,
+  account extends Account | undefined,
+>(
+  client: Client<Transport, chain, account, PublicZkSyncRpcSchema>,
+  parameters: EstimateFeeParameters<chain, account>,
+): Promise<EstimateFeeReturnType> {
+  const { account: account_, ...request } = parameters
+  const account = account_ ? parseAccount(account_) : client.account
+
+  const formatters = client.chain?.formatters
+  const formatted = formatters?.transactionRequest?.format({
+    ...request,
+    from: account?.address,
+  })
+
+  const result = await client.request({
+    method: 'zks_estimateFee',
+    params: [formatted],
+  })
+
+  return {
+    gasLimit: hexToBigInt(result.gas_limit),
+    gasPerPubdataLimit: hexToBigInt(result.gas_per_pubdata_limit),
+    maxPriorityFeePerGas: hexToBigInt(result.max_priority_fee_per_gas),
+    maxFeePerGas: hexToBigInt(result.max_fee_per_gas),
+  }
+}

package/zksync/actions/estimateGasL1ToL2.ts

@@ -0,0 +1,38 @@
+import type { SendTransactionParameters } from '../../actions/wallet/sendTransaction.js'
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Account } from '../../types/account.js'
+import { parseAccount } from '../../utils/accounts.js'
+import type { ChainEIP712 } from '../types/chain.js'
+import type { PublicZkSyncRpcSchema } from '../types/eip1193.js'
+
+export type EstimateGasL1ToL2Parameters<
+  chain extends ChainEIP712 | undefined = ChainEIP712 | undefined,
+  account extends Account | undefined = Account | undefined,
+> = SendTransactionParameters<chain, account>
+
+export type EstimateGasL1ToL2ReturnType = bigint
+
+export async function estimateGasL1ToL2<
+  chain extends ChainEIP712 | undefined,
+  account extends Account | undefined,
+>(
+  client: Client<Transport, chain, account, PublicZkSyncRpcSchema>,
+  parameters: EstimateGasL1ToL2Parameters<chain, account>,
+): Promise<EstimateGasL1ToL2ReturnType> {
+  const { account: account_, ...request } = parameters
+  const account = account_ ? parseAccount(account_) : client.account
+
+  const formatters = client.chain?.formatters
+  const formatted = formatters?.transactionRequest?.format({
+    ...request,
+    from: account?.address,
+  })
+
+  const result = await client.request({
+    method: 'zks_estimateGasL1ToL2',
+    params: [formatted],
+  })
+
+  return result
+}

package/zksync/actions/getAllBalances.ts

@@ -0,0 +1,33 @@
+import type { Address } from 'abitype'
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Account, GetAccountParameter } from '../../types/account.js'
+import type { Chain } from '../../types/chain.js'
+import { parseAccount } from '../../utils/accounts.js'
+import { hexToBigInt } from '../../utils/encoding/fromHex.js'
+import type { PublicZkSyncRpcSchema } from '../types/eip1193.js'
+
+export type GetAllBalancesParameters<
+  TAccount extends Account | undefined = Account | undefined,
+> = GetAccountParameter<TAccount>
+
+export type GetAllBalancesReturnType = { [key: Address]: bigint }
+
+export async function getAllBalances<
+  TChain extends Chain | undefined,
+  TAccount extends Account | undefined,
+>(
+  client: Client<Transport, TChain, TAccount, PublicZkSyncRpcSchema>,
+  parameters: GetAllBalancesParameters<TAccount>,
+): Promise<GetAllBalancesReturnType> {
+  const { account: account_ } = parameters
+  const account = account_ ? parseAccount(account_) : client.account
+  const balances = await client.request({
+    method: 'zks_getAllAccountBalances',
+    params: [account!.address],
+  })
+  const convertedBalances: GetAllBalancesReturnType = {}
+  for (const token in balances)
+    (convertedBalances as any)[token] = hexToBigInt((balances as any)[token])
+  return convertedBalances
+}

package/zksync/actions/getBaseTokenL1Address.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 GetBaseTokenL1AddressReturnType = Address
+
+export async function getBaseTokenL1Address<
+  TChain extends Chain | undefined,
+  TAccount extends Account | undefined,
+>(
+  client: Client<Transport, TChain, TAccount, PublicZkSyncRpcSchema>,
+): Promise<GetBaseTokenL1AddressReturnType> {
+  const result = await client.request({ method: 'zks_getBaseTokenL1Address' })
+  return result
+}

package/zksync/actions/getBlockDetails.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 {
+  ZkSyncBlockDetails,
+  ZkSyncNumberParameter,
+} from '../types/block.js'
+import type { PublicZkSyncRpcSchema } from '../types/eip1193.js'
+
+export type GetBlockDetailsParameters = ZkSyncNumberParameter
+
+export type GetBlockDetailsReturnType = ZkSyncBlockDetails
+
+export async function getBlockDetails<
+  TChain extends Chain | undefined,
+  TAccount extends Account | undefined,
+>(
+  client: Client<Transport, TChain, TAccount, PublicZkSyncRpcSchema>,
+  parameters: GetBlockDetailsParameters,
+): Promise<GetBlockDetailsReturnType> {
+  const result = await client.request({
+    method: 'zks_getBlockDetails',
+    params: [parameters.number],
+  })
+  return result
+}

package/zksync/actions/getBridgehubContractAddress.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 GetBridgehubContractAddressReturnType = Address
+
+export async function getBridgehubContractAddress<
+  TChain extends Chain | undefined,
+  TAccount extends Account | undefined,
+>(
+  client: Client<Transport, TChain, TAccount, PublicZkSyncRpcSchema>,
+): Promise<GetBridgehubContractAddressReturnType> {
+  const result = await client.request({ method: 'zks_getBridgehubContract' })
+  return result
+}

package/zksync/actions/getDefaultBridgeAddresses.ts

@@ -0,0 +1,22 @@
+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 { BridgeContractAddresses } from '../types/contract.js'
+import type { PublicZkSyncRpcSchema } from '../types/eip1193.js'
+
+export type GetDefaultBridgeAddressesReturnType = BridgeContractAddresses
+
+export async function getDefaultBridgeAddresses<
+  TChain extends Chain | undefined,
+  TAccount extends Account | undefined,
+>(
+  client: Client<Transport, TChain, TAccount, PublicZkSyncRpcSchema>,
+): Promise<GetDefaultBridgeAddressesReturnType> {
+  const addresses = await client.request({ method: 'zks_getBridgeContracts' })
+  return {
+    erc20L1: addresses.l1Erc20DefaultBridge,
+    sharedL1: addresses.l1SharedDefaultBridge,
+    sharedL2: addresses.l2SharedDefaultBridge,
+  }
+}

package/zksync/actions/getL1Allowance.ts

@@ -0,0 +1,43 @@
+import type { Address } from 'abitype'
+import { readContract } from '../../actions/public/readContract.js'
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import { erc20Abi } from '../../constants/abis.js'
+import type { AccountNotFoundError } from '../../errors/account.js'
+import type { BaseError } from '../../errors/base.js'
+import type { Account, GetAccountParameter } from '../../types/account.js'
+import type { BlockTag } from '../../types/block.js'
+import type { Chain } from '../../types/chain.js'
+import { parseAccount } from '../../utils/accounts.js'
+
+export type GetL1AllowanceParameters<
+  TAccount extends Account | undefined = Account | undefined,
+> = GetAccountParameter<TAccount> & {
+  bridgeAddress: Address
+  blockTag?: BlockTag
+  token: Address
+}
+
+export type GetL1AllowanceReturnType = bigint
+
+export type GetL1AllowanceErrorType = AccountNotFoundError | BaseError
+
+export async function getL1Allowance<
+  TChain extends Chain | undefined,
+  TAccount extends Account | undefined,
+>(
+  client: Client<Transport, TChain, TAccount>,
+  parameters: GetL1AllowanceParameters<TAccount>,
+): Promise<GetL1AllowanceReturnType> {
+  const { token, bridgeAddress, blockTag, account: account_ } = parameters
+
+  const account = account_ ? parseAccount(account_) : client.account
+
+  return await readContract(client, {
+    abi: erc20Abi,
+    address: token,
+    functionName: 'allowance',
+    args: [account!.address, bridgeAddress],
+    blockTag: blockTag,
+  })
+}

package/zksync/actions/getL1Balance.ts

@@ -0,0 +1,68 @@
+import type { Address } from 'abitype'
+import {
+  type GetBalanceParameters,
+  getBalance,
+} from '../../actions/public/getBalance.js'
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { AccountNotFoundError } from '../../errors/account.js'
+import type { BaseError } from '../../errors/base.js'
+import type { Account, GetAccountParameter } from '../../types/account.js'
+import type { BlockTag } from '../../types/block.js'
+import type { Chain } from '../../types/chain.js'
+import { parseAccount } from '../../utils/accounts.js'
+import { legacyEthAddress } from '../constants/address.js'
+import { isEth } from '../utils/isEth.js'
+import {
+  type GetL1TokenBalanceParameters,
+  getL1TokenBalance,
+} from './getL1TokenBalance.js'
+
+export type GetL1BalanceParameters<
+  TAccount extends Account | undefined = Account | undefined,
+> = GetAccountParameter<TAccount> & { token?: Address | undefined } & (
+    | {
+        /** The balance of the account at a block number. */
+        blockNumber?: bigint | undefined
+        blockTag?: never | undefined
+      }
+    | {
+        blockNumber?: never | undefined
+        /** The balance of the account at a block tag. */
+        blockTag?: BlockTag | undefined
+      }
+  )
+
+export type GetL1BalanceReturnType = bigint
+
+export type GetL1BalanceErrorType = AccountNotFoundError | BaseError
+
+export async function getL1Balance<
+  TChain extends Chain | undefined,
+  TAccount extends Account | undefined,
+>(
+  client: Client<Transport, TChain, TAccount>,
+  ...[parameters = {}]: TAccount extends undefined
+    ? [GetL1BalanceParameters<TAccount>]
+    : [GetL1BalanceParameters<TAccount>] | []
+): Promise<GetL1BalanceReturnType> {
+  const {
+    account: account_ = client.account,
+    blockNumber,
+    blockTag,
+    token = legacyEthAddress,
+  } = parameters
+
+  const account = account_ ? parseAccount(account_) : undefined
+
+  if (isEth(token))
+    return await getBalance(client, {
+      address: account!.address,
+      blockNumber,
+      blockTag,
+    } as GetBalanceParameters)
+
+  return await getL1TokenBalance(client, {
+    ...(parameters as GetL1TokenBalanceParameters<TAccount>),
+  })
+}

package/zksync/actions/getL1BatchBlockRange.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 { hexToNumber } from '../../utils/encoding/fromHex.js'
+import type { PublicZkSyncRpcSchema } from '../types/eip1193.js'
+
+export type GetL1BatchBlockRangeParameters = {
+  l1BatchNumber: number
+}
+
+export type GetL1BatchBlockRangeReturnParameters = [number, number]
+
+export async function getL1BatchBlockRange<
+  TChain extends Chain | undefined,
+  TAccount extends Account | undefined,
+>(
+  client: Client<Transport, TChain, TAccount, PublicZkSyncRpcSchema>,
+  parameters: GetL1BatchBlockRangeParameters,
+): Promise<GetL1BatchBlockRangeReturnParameters> {
+  const [number_1, number_2] = await client.request({
+    method: 'zks_getL1BatchBlockRange',
+    params: [parameters.l1BatchNumber],
+  })
+  return [hexToNumber(number_1), hexToNumber(number_2)]
+}

package/zksync/actions/getL1BatchDetails.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 {
+  ZkSyncBatchDetails,
+  ZkSyncNumberParameter,
+} from '../types/block.js'
+import type { PublicZkSyncRpcSchema } from '../types/eip1193.js'
+
+export type GetL1BatchDetailsParameters = ZkSyncNumberParameter
+
+export type GetL1BatchDetailsReturnType = ZkSyncBatchDetails
+
+export async function getL1BatchDetails<
+  TChain extends Chain | undefined,
+  TAccount extends Account | undefined,
+>(
+  client: Client<Transport, TChain, TAccount, PublicZkSyncRpcSchema>,
+  parameters: GetL1BatchDetailsParameters,
+): Promise<GetL1BatchDetailsReturnType> {
+  const result = await client.request({
+    method: 'zks_getL1BatchDetails',
+    params: [parameters.number],
+  })
+  return result
+}

package/zksync/actions/getL1BatchNumber.ts

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

package/zksync/actions/getL1ChainId.ts

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

package/zksync/actions/getL1TokenBalance.ts

@@ -0,0 +1,63 @@
+import type { Address } from '../../accounts/index.js'
+import { readContract } from '../../actions/index.js'
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import { erc20Abi } from '../../constants/abis.js'
+import type { AccountNotFoundError } from '../../errors/account.js'
+import type { BaseError } from '../../errors/base.js'
+import type { Account, GetAccountParameter } from '../../types/account.js'
+import type { BlockTag } from '../../types/block.js'
+import type { Chain } from '../../types/chain.js'
+import { parseAccount } from '../../utils/accounts.js'
+import { TokenIsEthError } from '../errors/token-is-eth.js'
+import { isEth } from '../utils/isEth.js'
+
+export type GetL1TokenBalanceParameters<
+  TAccount extends Account | undefined = Account | undefined,
+> = GetAccountParameter<TAccount> & { token: Address } & (
+    | {
+        /** The balance of the account at a block number. */
+        blockNumber?: bigint | undefined
+        blockTag?: never | undefined
+      }
+    | {
+        blockNumber?: never | undefined
+        /** The balance of the account at a block tag. */
+        blockTag?: BlockTag | undefined
+      }
+  )
+
+export type GetL1TokenBalanceReturnType = bigint
+
+export type GetL1TokenBalanceErrorType =
+  | AccountNotFoundError
+  | BaseError
+  | TokenIsEthError
+
+export async function getL1TokenBalance<
+  TChain extends Chain | undefined,
+  TAccount extends Account | undefined,
+>(
+  client: Client<Transport, TChain, TAccount>,
+  parameters: GetL1TokenBalanceParameters<TAccount>,
+): Promise<GetL1TokenBalanceReturnType> {
+  const {
+    account: account_ = client.account,
+    blockTag,
+    blockNumber,
+    token,
+  } = parameters
+
+  if (isEth(token!)) throw new TokenIsEthError()
+
+  const account = account_ ? parseAccount(account_) : client.account
+
+  return await readContract(client, {
+    abi: erc20Abi,
+    address: token!,
+    functionName: 'balanceOf',
+    args: [account!.address],
+    blockNumber: blockNumber,
+    blockTag: blockTag,
+  })
+}