viem 0.0.0-main.20240519T155930 → 0.0.0-main.20240519T233212

package/zksync/decorators/publicL2.ts

@@ -0,0 +1,425 @@
+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,
+  EstimateFeeReturnType,
+} from '../actions/estimateFee.js'
+import {
+  type EstimateGasL1ToL2Parameters,
+  estimateGasL1ToL2,
+} from '../actions/estimateGasL1ToL2.js'
+import {
+  type GetAllBalancesParameters,
+  type GetAllBalancesReturnType,
+  getAllBalances,
+} from '../actions/getAllBalances.js'
+import { getBaseTokenL1Address } from '../actions/getBaseTokenL1Address.js'
+import {
+  type GetBlockDetailsParameters,
+  type GetBlockDetailsReturnType,
+  getBlockDetails,
+} from '../actions/getBlockDetails.js'
+import { getBridgehubContractAddress } from '../actions/getBridgehubContractAddress.js'
+import {
+  type GetDefaultBridgeAddressesReturnType,
+  getDefaultBridgeAddresses,
+} from '../actions/getDefaultBridgeAddresses.js'
+import {
+  type GetL1BatchBlockRangeParameters,
+  type GetL1BatchBlockRangeReturnParameters,
+  getL1BatchBlockRange,
+} from '../actions/getL1BatchBlockRange.js'
+import {
+  type GetL1BatchDetailsParameters,
+  type GetL1BatchDetailsReturnType,
+  getL1BatchDetails,
+} from '../actions/getL1BatchDetails.js'
+import { getL1BatchNumber } from '../actions/getL1BatchNumber.js'
+import { 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,
+  getRawBlockTransactions,
+} from '../actions/getRawBlockTransaction.js'
+import { getTestnetPaymasterAddress } from '../actions/getTestnetPaymasterAddress.js'
+import {
+  type GetTransactionDetailsParameters,
+  type GetTransactionDetailsReturnType,
+  getTransactionDetails,
+} from '../actions/getTransactionDetails.js'
+import type { ChainEIP712 } from '../types/chain.js'
+
+export type PublicActionsL2<
+  TChain extends ChainEIP712 | undefined = ChainEIP712 | undefined,
+  TAccount extends Account | undefined = Account | undefined,
+> = {
+  /**
+   * Returns the addresses of the default zkSync Era bridge contracts on both L1 and L2.
+   *
+   * @returns The Addresses of the default zkSync Era bridge contracts on both L1 and L2. {@link DefaultBridgeAddressesReturnType}
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { zkSyncLocalNode } from 'viem/chains'
+   * import { publicActionsL2 } from 'viem/zksync'
+   *
+   * const client = createPublicClient({
+   *   chain: zkSyncLocalNode,
+   *   transport: http(),
+   * }).extend(publicActionsL2())
+   *
+   * const addresses = await client.getDefaultBridgeAddresses();
+   */
+  getDefaultBridgeAddresses: () => Promise<GetDefaultBridgeAddressesReturnType>
+
+  /**
+   * Returns Testnet Paymaster Address.
+   *
+   * @returns The Address. {@link Address}
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { zkSyncLocalNode } from 'viem/chains'
+   * import { publicActionsL2 } from 'viem/zksync'
+   *
+   * const client = createPublicClient({
+   *   chain: zkSyncLocalNode,
+   *   transport: http(),
+   * }).extend(publicActionsL2())
+   *
+   * const address = await client.getTestnetPaymasterAddress();
+   */
+  getTestnetPaymasterAddress: () => Promise<Address | null>
+
+  /**
+   * Returns the Chain Id of underlying L1 network.
+   *
+   * @returns number
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { zkSyncLocalNode } from 'viem/chains'
+   * import { publicActionsL2 } from 'viem/zksync'
+   *
+   * const client = createPublicClient({
+   *   chain: zkSyncLocalNode,
+   *   transport: http(),
+   * }).extend(publicActionsL2())
+   *
+   * const chainId = await client.getL1ChainId();
+   */
+
+  getL1ChainId: () => Promise<Hex>
+
+  /**
+   * Returns the address of a Main zkSync Contract.
+   *
+   * @returns The Address. {@link Address}
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { zkSyncLocalNode } from 'viem/chains'
+   * import { publicActionsL2 } from 'viem/zksync'
+   *
+   * const client = createPublicClient({
+   *   chain: zkSyncLocalNode,
+   *   transport: http(),
+   * }).extend(publicActionsL2())
+   *
+   * const address = await client.getMainContractAddress();
+   */
+  getMainContractAddress: () => Promise<Address>
+
+  /**
+   * Returns all known balances for a given account.
+   *
+   * @returns The balances for a given account. {@link GetAllBalancesReturnType}
+   * @param args - {@link GetAllBalancesParameters}
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { zkSyncLocalNode } from 'viem/chains'
+   * import { publicActionsL2 } from 'viem/zksync'
+   *
+   * const client = createPublicClient({
+   *   chain: zkSyncLocalNode,
+   *   transport: http(),
+   * }).extend(publicActionsL2())
+   *
+   * const balances = await client.getAllBalances({account: "0x36615Cf349d7F6344891B1e7CA7C72883F5dc049"});
+   */
+  getAllBalances: (
+    args: GetAllBalancesParameters,
+  ) => Promise<GetAllBalancesReturnType>
+
+  /**
+   * Returns data of transactions in a block.
+   *
+   * @returns data of transactions {@link RawBlockTransactions}
+   * @param args - {@link GetRawBlockTransactionParameters}
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { zkSyncLocalNode } from 'viem/chains'
+   * import { publicActionsL2 } from 'viem/zksync'
+   *
+   * const client = createPublicClient({
+   *   chain: zkSyncLocalNode,
+   *   transport: http(),
+   * }).extend(publicActionsL2())
+   *
+   * const rawTx = await client.getRawBlockTransaction({number: 1});
+   */
+  getRawBlockTransaction: (
+    args: GetRawBlockTransactionParameters,
+  ) => Promise<GetRawBlockTransactionReturnType>
+
+  /**
+   * Returns additional zkSync-specific information about the L2 block.
+   *
+   * @returns zkSync-specific information about the L2 block {@link BaseBlockDetails}
+   * @param args - {@link GetBlockDetailsParameters}
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { zkSyncLocalNode } from 'viem/chains'
+   * import { publicActionsL2 } from 'viem/zksync'
+   *
+   * const client = createPublicClient({
+   *   chain: zkSyncLocalNode,
+   *   transport: http(),
+   * }).extend(publicActionsL2())
+   *
+   * const blockDetails = await client.getBlockDetails({number: 1});
+   */
+  getBlockDetails: (
+    args: GetBlockDetailsParameters,
+  ) => Promise<GetBlockDetailsReturnType>
+
+  /**
+   * Returns data pertaining to a given batch.
+   *
+   * @returns data pertaining to a given batch {@link BatchDetails}
+   * @param args - {@link GetL1BatchDetailsParameters}
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { zkSyncLocalNode } from 'viem/chains'
+   * import { publicActionsL2 } from 'viem/zksync'
+   *
+   * const client = createPublicClient({
+   *   chain: zkSyncLocalNode,
+   *   transport: http(),
+   * }).extend(publicActionsL2())
+   *
+   * const batchDetails = await client.getL1BatchDetails({number: 1});
+   */
+  getL1BatchDetails: (
+    args: GetL1BatchDetailsParameters,
+  ) => Promise<GetL1BatchDetailsReturnType>
+
+  /**
+   * Returns the range of blocks contained within a batch given by batch number.
+   *
+   * @returns range of blocks contained withing a batch {@link GetL1BatchBlockRangeReturnParameters}
+   * @param args - {@link GetL1BatchBlockRangeParameters}
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { zkSyncLocalNode } from 'viem/chains'
+   * import { publicActionsL2 } from 'viem/zksync'
+   *
+   * const client = createPublicClient({
+   *   chain: zkSyncLocalNode,
+   *   transport: http(),
+   * }).extend(publicActionsL2())
+   *
+   * const batchBlockRange = await client.getL1BatchBlockRange({number: 1});
+   */
+  getL1BatchBlockRange: (
+    args: GetL1BatchBlockRangeParameters,
+  ) => Promise<GetL1BatchBlockRangeReturnParameters>
+
+  /**
+   * Returns the latest L1 batch number
+   *
+   * @returns latest L1 batch number
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { zkSyncLocalNode } from 'viem/chains'
+   * import { publicActionsL2 } from 'viem/zksync'
+   *
+   * const client = createPublicClient({
+   *   chain: zkSyncLocalNode,
+   *   transport: http(),
+   * }).extend(publicActionsL2())
+   *
+   * const latestNumber = await client.getL1BatchNumber({number: 1});
+   */
+  getL1BatchNumber: () => Promise<Hex>
+
+  /**
+   * 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.
+   *
+   * @returns the proof for the corresponding L2 to L1 log.
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { zkSyncLocalNode } from 'viem/chains'
+   * import { publicActionsL2 } from 'viem/zksync'
+   *
+   * const client = createPublicClient({
+   *   chain: zkSyncLocalNode,
+   *   transport: http(),
+   * }).extend(publicActionsL2())
+   *
+   * const proof = await client.getLogProof({txHash: "0x...",index:1});
+   */
+  getLogProof: (args: GetLogProofParameters) => Promise<GetLogProofReturnType>
+
+  /**
+   * Returns data from a specific transaction given by the transaction hash
+   *
+   * @returns data from a specific transaction given by the transaction hash
+   *
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { zkSyncLocalNode } from 'viem/chains'
+   * import { publicActionsL2 } from 'viem/zksync'
+   *
+   * const client = createPublicClient({
+   *   chain: zkSyncLocalNode,
+   *   transport: http(),
+   * }).extend(publicActionsL2())
+   *
+   * const details = await client.getTransactionDetails({txHash: "0x..."});
+   */
+  getTransactionDetails: (
+    args: GetTransactionDetailsParameters,
+  ) => Promise<GetTransactionDetailsReturnType>
+
+  /**
+   * Returns an estimated Fee for requested transaction.
+   *
+   * @returns an estimated {@link Fee} for requested transaction.
+   * @param args - {@link EstimateFeeParameters}
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { zkSyncLocalNode } from 'viem/chains'
+   * import { publicActionsL2 } from 'viem/zksync'
+   *
+   * const client = createPublicClient({
+   *   chain: zkSyncLocalNode,
+   *   transport: http(),
+   * }).extend(publicActionsL2())
+   *
+   * const details = await client.estimateFee({transactionRequest: {...}}});
+   */
+  estimateFee: (
+    args: EstimateFeeParameters<TChain, TAccount>,
+  ) => Promise<EstimateFeeReturnType>
+
+  /**
+   * Returns an estimated gas for L1 to L2 execution.
+   *
+   * @returns an estimated gas.
+   * @param args - {@link EstimateGasL1ToL2Parameters}
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { zkSyncLocalNode } from 'viem/chains'
+   * import { publicActionsL2 } from 'viem/zksync'
+   *
+   * const client = createPublicClient({
+   *   chain: zkSyncLocalNode,
+   *   transport: http(),
+   * }).extend(publicActionsL2())
+   *
+   * const details = await client.estimateGasL1ToL2({transactionRequest: {...}}});
+   */
+  estimateGasL1ToL2: (
+    args: EstimateGasL1ToL2Parameters<TChain, TAccount>,
+  ) => Promise<bigint>
+
+  /**
+   * Returns the Bridgehub smart contract address.
+   *
+   * @returns address of the Bridgehub smart contract address.
+   *
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { zkSyncLocalNode } from 'viem/chains'
+   * import { publicActionsL2 } from 'viem/zksync'
+   *
+   * const client = createPublicClient({
+   *   chain: zkSyncLocalNode,
+   *   transport: http(),
+   * }).extend(publicActionsL2())
+   *
+   * const address = await client.getBridgehubContractAddress();
+   */
+  getBridgehubContractAddress: () => Promise<Address>
+
+  /**
+   * Returns the address of the base L1 token.
+   *
+   * @returns address of the base L1 token.
+   *
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { zkSyncLocalNode } from 'viem/chains'
+   * import { publicActionsL2 } from 'viem/zksync'
+   *
+   * const client = createPublicClient({
+   *   chain: zkSyncLocalNode,
+   *   transport: http(),
+   * }).extend(publicActionsL2())
+   *
+   * const address = await client.getBaseTokenL1Address();
+   */
+  getBaseTokenL1Address: () => Promise<Address>
+}
+
+export function publicActionsL2() {
+  return <
+    TTransport extends Transport = Transport,
+    TChain extends ChainEIP712 | undefined = ChainEIP712 | undefined,
+    TAccount extends Account | undefined = Account | undefined,
+  >(
+    client: Client<TTransport, TChain, TAccount>,
+  ): PublicActionsL2<TChain, TAccount> => {
+    return {
+      estimateGasL1ToL2: (args) => estimateGasL1ToL2(client, args),
+      getDefaultBridgeAddresses: () => getDefaultBridgeAddresses(client),
+      getTestnetPaymasterAddress: () => getTestnetPaymasterAddress(client),
+      getL1ChainId: () => getL1ChainId(client),
+      getMainContractAddress: () => getMainContractAddress(client),
+      getAllBalances: (args) => getAllBalances(client, args),
+      getRawBlockTransaction: (args) => getRawBlockTransactions(client, args),
+      getBlockDetails: (args) => getBlockDetails(client, args),
+      getL1BatchDetails: (args) => getL1BatchDetails(client, args),
+      getL1BatchBlockRange: (args) => getL1BatchBlockRange(client, args),
+      getL1BatchNumber: () => getL1BatchNumber(client),
+      getLogProof: (args) => getLogProof(client, args),
+      getTransactionDetails: (args) => getTransactionDetails(client, args),
+      estimateFee: (args) => estimateFee(client, args),
+      getBridgehubContractAddress: () => getBridgehubContractAddress(client),
+      getBaseTokenL1Address: () => getBaseTokenL1Address(client),
+    }
+  }
+}

package/zksync/index.ts

@@ -1,3 +1,58 @@
+export {
+  type DeployContractErrorType,
+  type DeployContractParameters,
+  type DeployContractReturnType,
+  deployContract,
+} from './actions/deployContract.js'
+export {
+  type EstimateFeeParameters,
+  type EstimateFeeReturnType,
+  estimateFee,
+} from './actions/estimateFee.js'
+export {
+  type GetAllBalancesParameters,
+  type GetAllBalancesReturnType,
+  getAllBalances,
+} from './actions/getAllBalances.js'
+export {
+  type GetBlockDetailsParameters,
+  type GetBlockDetailsReturnType,
+  getBlockDetails,
+} from './actions/getBlockDetails.js'
+export {
+  type GetDefaultBridgeAddressesReturnType,
+  getDefaultBridgeAddresses,
+} from './actions/getDefaultBridgeAddresses.js'
+export { getBridgehubContractAddress } from './actions/getBridgehubContractAddress.js'
+export {
+  type GetL1BatchBlockRangeParameters,
+  type GetL1BatchBlockRangeReturnParameters,
+  getL1BatchBlockRange,
+} from './actions/getL1BatchBlockRange.js'
+export {
+  type GetL1BatchDetailsParameters,
+  type GetL1BatchDetailsReturnType,
+  getL1BatchDetails,
+} from './actions/getL1BatchDetails.js'
+export { getL1BatchNumber } from './actions/getL1BatchNumber.js'
+export { getL1ChainId } from './actions/getL1ChainId.js'
+export {
+  type GetLogProofReturnType,
+  type GetLogProofParameters,
+  getLogProof,
+} from './actions/getLogProof.js'
+export { getMainContractAddress } from './actions/getMainContractAddress.js'
+export {
+  type GetRawBlockTransactionParameters,
+  type GetRawBlockTransactionReturnType,
+  getRawBlockTransactions,
+} from './actions/getRawBlockTransaction.js'
+export { getTestnetPaymasterAddress } from './actions/getTestnetPaymasterAddress.js'
+export {
+  type GetTransactionDetailsParameters,
+  type GetTransactionDetailsReturnType,
+  getTransactionDetails,
+} from './actions/getTransactionDetails.js'
 export {
   type SendTransactionErrorType,
   type SendTransactionParameters,
@@ -22,12 +77,6 @@ export {
   type SignTransactionReturnType,
   signTransaction,
 } from './actions/signTransaction.js'
-export {
-  type DeployContractErrorType,
-  type DeployContractParameters,
-  type DeployContractReturnType,
-  deployContract,
-} from './actions/deployContract.js'
 
 export {
   zkSync,
@@ -44,6 +93,11 @@ export {
 
 export { serializeTransaction } from './serializers.js'
 
+export {
+  publicActionsL2,
+  type PublicActionsL2,
+} from './decorators/publicL2.js'
+
 export type {
   ZkSyncBlock,
   ZkSyncBlockOverrides,
@@ -66,6 +120,7 @@ export type {
 export type {
   TransactionRequestEIP712,
   ZkSyncEIP712TransactionSignable,
+  ZkSyncRawBlockTransactions,
   ZkSyncRpcTransaction,
   ZkSyncRpcTransactionEIP712,
   ZkSyncRpcTransactionPriority,
@@ -83,6 +138,7 @@ export type {
   ZkSyncTransactionSerialized,
   ZkSyncTransactionSerializedEIP712,
   ZkSyncTransactionType,
+  ZkSyncTransactionDetails,
 } from './types/transaction.js'
 
 export {

package/zksync/types/block.ts

@@ -1,8 +1,17 @@
+import type { Address } from 'abitype'
 import type { Block, BlockTag } from '../../types/block.js'
-import type { Hex } from '../../types/misc.js'
+import type { Hash, Hex } from '../../types/misc.js'
 import type { RpcBlock } from '../../types/rpc.js'
 import type { ZkSyncRpcTransaction, ZkSyncTransaction } from './transaction.js'
 
+export type ZkSyncBatchDetails = Omit<
+  ZkSyncBlockDetails,
+  'operatorAddress' | 'protocolVersion'
+> & {
+  l1GasPrice: number
+  l2FairGasPrice: number
+}
+
 export type ZkSyncBlockOverrides = {
   l1BatchNumber: bigint | null
   l1BatchTimestamp: bigint | null
@@ -19,10 +28,33 @@ export type ZkSyncBlock<
 > &
   ZkSyncBlockOverrides
 
+export type ZkSyncBlockDetails = {
+  number: number
+  timestamp: number
+  l1BatchNumber: number
+  l1TxCount: number
+  l2TxCount: number
+  rootHash?: Hash
+  status: string
+  commitTxHash?: Hash
+  committedAt?: Date
+  proveTxHash?: Hash
+  provenAt?: Date
+  executeTxHash?: Hash
+  executedAt?: Date
+  baseSystemContractsHashes: {
+    bootloader: Hash
+    default_aa: Hash
+  }
+  operatorAddress: Address
+  protocolVersion?: string
+}
+
 export type ZkSyncRpcBlockOverrides = {
   l1BatchNumber: Hex | null
   l1BatchTimestamp: Hex | null
 }
+
 export type ZkSyncRpcBlock<
   TBlockTag extends BlockTag = BlockTag,
   TIncludeTransactions extends boolean = boolean,
@@ -32,3 +64,7 @@ export type ZkSyncRpcBlock<
   ZkSyncRpcTransaction<TBlockTag extends 'pending' ? true : false>
 > &
   ZkSyncRpcBlockOverrides
+
+export type ZkSyncNumberParameter = {
+  number: number
+}

package/zksync/types/contract.ts

@@ -1,3 +1,11 @@
+import type { Address } from 'abitype'
+
+export type BridgeContractAddresses = {
+  erc20L1: Address
+  sharedL1: Address
+  sharedL2: Address
+}
+
 export type ContractDeploymentType =
   | 'create'
   | 'create2'