viem 0.0.0-main.20240519T233212 → 0.0.0-main.20240520T005450

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),
+  })
+}

package/zksync/decorators/publicL2.ts

@@ -2,7 +2,6 @@ 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 { Hex } from '../../types/misc.js'
 import { estimateFee } from '../actions/estimateFee.js'
 import type {
   EstimateFeeParameters,
@@ -10,6 +9,7 @@ import type {
 } from '../actions/estimateFee.js'
 import {
   type EstimateGasL1ToL2Parameters,
+  type EstimateGasL1ToL2ReturnType,
   estimateGasL1ToL2,
 } from '../actions/estimateGasL1ToL2.js'
 import {
@@ -17,13 +17,19 @@ import {
   type GetAllBalancesReturnType,
   getAllBalances,
 } from '../actions/getAllBalances.js'
-import { getBaseTokenL1Address } from '../actions/getBaseTokenL1Address.js'
+import {
+  type GetBaseTokenL1AddressReturnType,
+  getBaseTokenL1Address,
+} from '../actions/getBaseTokenL1Address.js'
 import {
   type GetBlockDetailsParameters,
   type GetBlockDetailsReturnType,
   getBlockDetails,
 } from '../actions/getBlockDetails.js'
-import { getBridgehubContractAddress } from '../actions/getBridgehubContractAddress.js'
+import {
+  type GetBridgehubContractAddressReturnType,
+  getBridgehubContractAddress,
+} from '../actions/getBridgehubContractAddress.js'
 import {
   type GetDefaultBridgeAddressesReturnType,
   getDefaultBridgeAddresses,
@@ -38,20 +44,32 @@ import {
   type GetL1BatchDetailsReturnType,
   getL1BatchDetails,
 } from '../actions/getL1BatchDetails.js'
-import { getL1BatchNumber } from '../actions/getL1BatchNumber.js'
-import { getL1ChainId } from '../actions/getL1ChainId.js'
+import {
+  type GetL1BatchNumberReturnType,
+  getL1BatchNumber,
+} from '../actions/getL1BatchNumber.js'
+import {
+  type GetL1ChainIdReturnType,
+  getL1ChainId,
+} from '../actions/getL1ChainId.js'
 import {
   type GetLogProofParameters,
   type GetLogProofReturnType,
   getLogProof,
 } from '../actions/getLogProof.js'
-import { getMainContractAddress } from '../actions/getMainContractAddress.js'
 import {
-  type GetRawBlockTransactionParameters,
-  type GetRawBlockTransactionReturnType,
+  type GetMainContractAddressReturnType,
+  getMainContractAddress,
+} from '../actions/getMainContractAddress.js'
+import {
+  type GetRawBlockTransactionsParameters,
+  type GetRawBlockTransactionsReturnType,
   getRawBlockTransactions,
-} from '../actions/getRawBlockTransaction.js'
-import { getTestnetPaymasterAddress } from '../actions/getTestnetPaymasterAddress.js'
+} from '../actions/getRawBlockTransactions.js'
+import {
+  type GetTestnetPaymasterAddressReturnType,
+  getTestnetPaymasterAddress,
+} from '../actions/getTestnetPaymasterAddress.js'
 import {
   type GetTransactionDetailsParameters,
   type GetTransactionDetailsReturnType,
@@ -99,7 +117,7 @@ export type PublicActionsL2<
    *
    * const address = await client.getTestnetPaymasterAddress();
    */
-  getTestnetPaymasterAddress: () => Promise<Address | null>
+  getTestnetPaymasterAddress: () => Promise<GetTestnetPaymasterAddressReturnType>
 
   /**
    * Returns the Chain Id of underlying L1 network.
@@ -119,7 +137,7 @@ export type PublicActionsL2<
    * const chainId = await client.getL1ChainId();
    */
 
-  getL1ChainId: () => Promise<Hex>
+  getL1ChainId: () => Promise<GetL1ChainIdReturnType>
 
   /**
    * Returns the address of a Main zkSync Contract.
@@ -138,7 +156,7 @@ export type PublicActionsL2<
    *
    * const address = await client.getMainContractAddress();
    */
-  getMainContractAddress: () => Promise<Address>
+  getMainContractAddress: () => Promise<GetMainContractAddressReturnType>
 
   /**
    * Returns all known balances for a given account.
@@ -166,7 +184,7 @@ export type PublicActionsL2<
    * Returns data of transactions in a block.
    *
    * @returns data of transactions {@link RawBlockTransactions}
-   * @param args - {@link GetRawBlockTransactionParameters}
+   * @param args - {@link GetRawBlockTransactionsParameters}
    *
    * @example
    * import { createPublicClient, http } from 'viem'
@@ -181,8 +199,8 @@ export type PublicActionsL2<
    * const rawTx = await client.getRawBlockTransaction({number: 1});
    */
   getRawBlockTransaction: (
-    args: GetRawBlockTransactionParameters,
-  ) => Promise<GetRawBlockTransactionReturnType>
+    args: GetRawBlockTransactionsParameters,
+  ) => Promise<GetRawBlockTransactionsReturnType>
 
   /**
    * Returns additional zkSync-specific information about the L2 block.
@@ -267,7 +285,7 @@ export type PublicActionsL2<
    *
    * const latestNumber = await client.getL1BatchNumber({number: 1});
    */
-  getL1BatchNumber: () => Promise<Hex>
+  getL1BatchNumber: () => Promise<GetL1BatchNumberReturnType>
 
   /**
    * Given a transaction hash, and an index of the L2 to L1 log produced within the transaction, it returns the proof for the corresponding L2 to L1 log.
@@ -352,7 +370,7 @@ export type PublicActionsL2<
    */
   estimateGasL1ToL2: (
     args: EstimateGasL1ToL2Parameters<TChain, TAccount>,
-  ) => Promise<bigint>
+  ) => Promise<EstimateGasL1ToL2ReturnType>
 
   /**
    * Returns the Bridgehub smart contract address.
@@ -372,7 +390,7 @@ export type PublicActionsL2<
    *
    * const address = await client.getBridgehubContractAddress();
    */
-  getBridgehubContractAddress: () => Promise<Address>
+  getBridgehubContractAddress: () => Promise<GetBridgehubContractAddressReturnType>
 
   /**
    * Returns the address of the base L1 token.
@@ -392,7 +410,7 @@ export type PublicActionsL2<
    *
    * const address = await client.getBaseTokenL1Address();
    */
-  getBaseTokenL1Address: () => Promise<Address>
+  getBaseTokenL1Address: () => Promise<GetBaseTokenL1AddressReturnType>
 }
 
 export function publicActionsL2() {

package/zksync/errors/token-is-eth.ts

@@ -0,0 +1,16 @@
+import { BaseError } from '../../errors/base.js'
+
+export type TokenIsEthErrorType = TokenIsEthError & {
+  name: 'TokenIsEthError'
+}
+export class TokenIsEthError extends BaseError {
+  override name = 'TokenIsEthError'
+
+  constructor() {
+    super(
+      ['Token is an ETH token.', '', 'ETH token cannot be retrived.'].join(
+        '\n',
+      ),
+    )
+  }
+}

package/zksync/index.ts

@@ -24,6 +24,18 @@ export {
   getDefaultBridgeAddresses,
 } from './actions/getDefaultBridgeAddresses.js'
 export { getBridgehubContractAddress } from './actions/getBridgehubContractAddress.js'
+export {
+  type GetL1AllowanceErrorType,
+  type GetL1AllowanceParameters,
+  type GetL1AllowanceReturnType,
+  getL1Allowance,
+} from './actions/getL1Allowance.js'
+export {
+  type GetL1BalanceErrorType,
+  type GetL1BalanceParameters,
+  type GetL1BalanceReturnType,
+  getL1Balance,
+} from './actions/getL1Balance.js'
 export {
   type GetL1BatchBlockRangeParameters,
   type GetL1BatchBlockRangeReturnParameters,
@@ -36,6 +48,12 @@ export {
 } from './actions/getL1BatchDetails.js'
 export { getL1BatchNumber } from './actions/getL1BatchNumber.js'
 export { getL1ChainId } from './actions/getL1ChainId.js'
+export {
+  type GetL1TokenBalanceErrorType,
+  type GetL1TokenBalanceParameters,
+  type GetL1TokenBalanceReturnType,
+  getL1TokenBalance,
+} from './actions/getL1TokenBalance.js'
 export {
   type GetLogProofReturnType,
   type GetLogProofParameters,
@@ -43,10 +61,10 @@ export {
 } from './actions/getLogProof.js'
 export { getMainContractAddress } from './actions/getMainContractAddress.js'
 export {
-  type GetRawBlockTransactionParameters,
-  type GetRawBlockTransactionReturnType,
+  type GetRawBlockTransactionsParameters,
+  type GetRawBlockTransactionsReturnType,
   getRawBlockTransactions,
-} from './actions/getRawBlockTransaction.js'
+} from './actions/getRawBlockTransactions.js'
 export { getTestnetPaymasterAddress } from './actions/getTestnetPaymasterAddress.js'
 export {
   type GetTransactionDetailsParameters,
@@ -91,13 +109,18 @@ export {
   type Eip712WalletActions,
 } from './decorators/eip712.js'
 
-export { serializeTransaction } from './serializers.js'
+export {
+  publicActionsL1,
+  type PublicActionsL1,
+} from './decorators/publicL1.js'
 
 export {
   publicActionsL2,
   type PublicActionsL2,
 } from './decorators/publicL2.js'
 
+export { serializeTransaction } from './serializers.js'
+
 export type {
   ZkSyncBlock,
   ZkSyncBlockOverrides,

package/zksync/utils/isEth.ts

@@ -0,0 +1,20 @@
+import type { Address } from '../../accounts/index.js'
+import {
+  ethAddressInContracts,
+  l2BaseTokenAddress,
+  legacyEthAddress,
+} from '../constants/address.js'
+
+export function isEth(token: Address) {
+  return (
+    token.localeCompare(legacyEthAddress, undefined, {
+      sensitivity: 'accent',
+    }) === 0 ||
+    token.localeCompare(l2BaseTokenAddress, undefined, {
+      sensitivity: 'accent',
+    }) === 0 ||
+    token.localeCompare(ethAddressInContracts, undefined, {
+      sensitivity: 'accent',
+    }) === 0
+  )
+}

package/_cjs/zksync/actions/getRawBlockTransaction.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getRawBlockTransaction.js","sourceRoot":"","sources":["../../../zksync/actions/getRawBlockTransaction.ts"],"names":[],"mappings":";;;AAOA,gEAAyD;AAMlD,KAAK,UAAU,uBAAuB,CAI3C,MAAkE,EAClE,UAA4C;IAE5C,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAClC,MAAM,EAAE,6BAA6B;QACrC,MAAM,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC;KAC5B,CAAC,CAAA;IACF,OAAO,IAAA,gCAAa,EAAC,MAAM,CAAqC,CAAA;AAClE,CAAC;AAZD,0DAYC"}

package/_esm/zksync/actions/getRawBlockTransaction.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getRawBlockTransaction.js","sourceRoot":"","sources":["../../../zksync/actions/getRawBlockTransaction.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAMzD,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAI3C,MAAkE,EAClE,UAA4C;IAE5C,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAClC,MAAM,EAAE,6BAA6B;QACrC,MAAM,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC;KAC5B,CAAC,CAAA;IACF,OAAO,aAAa,CAAC,MAAM,CAAqC,CAAA;AAClE,CAAC"}

package/_types/zksync/actions/getRawBlockTransaction.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getRawBlockTransaction.d.ts","sourceRoot":"","sources":["../../../zksync/actions/getRawBlockTransaction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,6CAA6C,CAAA;AAC5E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AACrD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAA;AAC9D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAA;AAChE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,yBAAyB,CAAA;AAGzE,MAAM,MAAM,gCAAgC,GAAG,qBAAqB,CAAA;AAEpE,MAAM,MAAM,gCAAgC,GAAG,0BAA0B,CAAA;AAEzE,wBAAsB,uBAAuB,CAC3C,MAAM,SAAS,KAAK,GAAG,SAAS,EAChC,QAAQ,SAAS,OAAO,GAAG,SAAS,EAEpC,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,qBAAqB,CAAC,EAClE,UAAU,EAAE,gCAAgC,GAC3C,OAAO,CAAC,gCAAgC,CAAC,CAM3C"}