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

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/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/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/getRawBlockTransaction.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 GetRawBlockTransactionParameters = ZkSyncNumberParameter
+
+export type GetRawBlockTransactionReturnType = ZkSyncRawBlockTransactions
+
+export async function getRawBlockTransactions<
+  TChain extends Chain | undefined,
+  TAccount extends Account | undefined,
+>(
+  client: Client<Transport, TChain, TAccount, PublicZkSyncRpcSchema>,
+  parameters: GetRawBlockTransactionParameters,
+): Promise<GetRawBlockTransactionReturnType> {
+  const result = await client.request({
+    method: 'zks_getRawBlockTransactions',
+    params: [parameters.number],
+  })
+  return camelCaseKeys(result) as GetRawBlockTransactionReturnType
+}

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