viem 2.10.11 → 2.11.0

package/zksync/types/eip1193.ts

@@ -0,0 +1,155 @@
+import type { Address } from 'abitype'
+import type { Hash, Hex } from '../../types/misc.js'
+import type { ZkSyncBatchDetails, ZkSyncBlockDetails } from './block.js'
+import type { ZkSyncFee } from './fee.js'
+import type { MessageProof } from './proof.js'
+import type {
+  TransactionRequest,
+  ZkSyncTransactionDetails,
+} from './transaction.js'
+
+export type CommonDataRawBlockTransaction = {
+  sender: Address
+  maxFeePerGas: Hex
+  gasLimit: Hex
+  gasPerPubdataLimit: Hex
+  ethHash: Hash
+  ethBlock: number
+  canonicalTxHash: Hash
+  toMint: Hex
+  refundRecipient: Address
+}
+
+export type RawBlockTransactions = {
+  common_data: {
+    L1?: {
+      serialId: number
+      deadlineBlock: number
+      layer2TipFee: Hex
+      fullFee: Hex
+      opProcessingType: string
+      priorityQueueType: string
+    } & CommonDataRawBlockTransaction
+    L2?: {
+      nonce: number
+      fee: ZkSyncFee<Hex>
+      initiatorAddress: Address
+      signature: Uint8Array
+      transactionType: string
+      input?: {
+        hash: Hash
+        data: Uint8Array
+      }
+      paymasterParams: {
+        paymaster: Address
+        paymasterInput: Uint8Array
+      }
+    }
+    ProtocolUpgrade?: {
+      upgradeId: string
+    } & CommonDataRawBlockTransaction
+  }
+  execute: {
+    calldata: Hash
+    contractAddress: Address
+    factoryDeps?: Hash
+    value: bigint
+  }
+  received_timestamp_ms: number
+  raw_bytes?: string
+}[]
+
+export type PublicZkSyncRpcSchema = [
+  {
+    Method: 'zks_estimateFee'
+    Parameters: [TransactionRequest]
+    ReturnType: {
+      gas_limit: Hex
+      gas_per_pubdata_limit: Hex
+      max_fee_per_gas: Hex
+      max_priority_fee_per_gas: Hex
+    }
+  },
+  {
+    Method: 'zks_estimateGasL1ToL2'
+    Parameters: [TransactionRequest]
+    ReturnType: bigint
+  },
+  {
+    Method: 'zks_getBridgeContracts'
+    Parameters?: undefined
+    ReturnType: {
+      l1Erc20DefaultBridge: Address
+      l2Erc20DefaultBridge: Address
+      l1WethBridge: Address
+      l2WethBridge: Address
+      l1SharedDefaultBridge: Address
+      l2SharedDefaultBridge: Address
+    }
+  },
+  {
+    Method: 'zks_getAllAccountBalances'
+    Parameters: [Address]
+    ReturnType: { [key: Address]: Hex }
+  },
+  {
+    Method: 'zks_getTestnetPaymaster'
+    Parameters: undefined
+    ReturnType: Address
+  },
+  {
+    Method: 'zks_L1ChainId'
+    Parameters: undefined
+    ReturnType: Hex
+  },
+  {
+    Method: 'zks_getMainContract'
+    Parameters: undefined
+    ReturnType: Address
+  },
+  {
+    Method: 'zks_L1BatchNumber'
+    Parameters: undefined
+    ReturnType: Hex
+  },
+  {
+    Method: 'zks_getL2ToL1LogProof'
+    Parameters: [Hash, number | undefined]
+    ReturnType: MessageProof
+  },
+  {
+    Method: 'zks_getL1BatchBlockRange'
+    Parameters: [number]
+    ReturnType: [Hex, Hex]
+  },
+  {
+    Method: 'zks_getL1BatchDetails'
+    Parameters: [number]
+    ReturnType: ZkSyncBatchDetails
+  },
+  {
+    Method: 'zks_getRawBlockTransactions'
+    Parameters: [number]
+    ReturnType: RawBlockTransactions
+  },
+  {
+    Method: 'zks_getBlockDetails'
+    Parameters: [number]
+    ReturnType: ZkSyncBlockDetails
+  },
+  {
+    Method: 'zks_getTransactionDetails'
+    Parameters: [Hash]
+    ReturnType: ZkSyncTransactionDetails
+  },
+  {
+    Method: 'zks_getBridgehubContract'
+    Parameters: undefined
+    ReturnType: Address
+  },
+  {
+    Method: 'zks_getBaseTokenL1Address'
+    Parameters: undefined
+    ReturnType: Address
+  },
+]

package/zksync/types/fee.ts

@@ -1,3 +1,10 @@
+export type ZkSyncFee<TQuantity = bigint> = {
+  gasLimit: TQuantity
+  gasPerPubdataLimit: TQuantity
+  maxPriorityFeePerGas: TQuantity
+  maxFeePerGas: TQuantity
+}
+
 export type ZkSyncFeeValues<TQuantity = bigint> = {
   gasPrice: TQuantity
   maxFeePerGas: TQuantity

package/zksync/types/proof.ts

@@ -0,0 +1,7 @@
+import type { Hash } from '../../types/misc.js'
+
+export type MessageProof = {
+  id: number
+  proof: Hash[]
+  root: Hash
+}

package/zksync/types/transaction.ts

@@ -1,6 +1,6 @@
 import type { Address } from 'abitype'
 import type { FeeValuesEIP1559 } from '../../types/fee.js'
-import type { Hex } from '../../types/misc.js'
+import type { Hash, Hex } from '../../types/misc.js'
 import type {
   Index,
   Quantity,
@@ -22,7 +22,7 @@ import type {
 } from '../../types/transaction.js'
 import type { ExactPartial, OneOf, UnionOmit } from '../../types/utils.js'
 import type { ZkSyncEip712Meta } from './eip712.js'
-import type { ZkSyncFeeValues } from './fee.js'
+import type { ZkSyncFee, ZkSyncFeeValues } from './fee.js'
 import type {
   ZkSyncL2ToL1Log,
   ZkSyncLog,
@@ -117,7 +117,10 @@ export type ZkSyncRpcTransaction<TPending extends boolean = boolean> =
 // Transaction Request
 // https://era.zksync.io/docs/reference/concepts/transactions
 
-type TransactionRequest = TransactionRequest_ & {
+export type TransactionRequest<
+  TQuantity = bigint,
+  TIndex = number,
+> = TransactionRequest_<TQuantity, TIndex> & {
   gasPerPubdata?: undefined
   customSignature?: undefined
   paymaster?: undefined
@@ -125,10 +128,10 @@ type TransactionRequest = TransactionRequest_ & {
   factoryDeps?: undefined
 }
 
-export type ZkSyncTransactionRequestEIP712 = Omit<
-  TransactionRequestBase,
-  'type'
-> &
+export type ZkSyncTransactionRequestEIP712<
+  TQuantity = bigint,
+  TIndex = number,
+> = Omit<TransactionRequestBase<TQuantity, TIndex>, 'type'> &
   ExactPartial<FeeValuesEIP1559> & {
     gasPerPubdata?: bigint | undefined
     customSignature?: Hex | undefined
@@ -139,9 +142,9 @@ export type ZkSyncTransactionRequestEIP712 = Omit<
     | { paymaster?: undefined; paymasterInput?: undefined }
   )
 
-export type ZkSyncTransactionRequest =
-  | TransactionRequest
-  | ZkSyncTransactionRequestEIP712
+export type ZkSyncTransactionRequest<TQuantity = bigint, TIndex = number> =
+  | TransactionRequest<TQuantity, TIndex>
+  | ZkSyncTransactionRequestEIP712<TQuantity, TIndex>
 
 type RpcTransactionRequest = RpcTransactionRequest_ & { eip712Meta?: undefined }
 
@@ -243,3 +246,74 @@ export type TransactionRequestEIP712<
     customSignature?: Hex | undefined
     type?: TTransactionType | undefined
   }
+
+type CommonDataRawBlockTransaction = {
+  sender: Address
+  maxFeePerGas: Hex
+  gasLimit: Hex
+  gasPerPubdataLimit: Hex
+  ethHash: Hash
+  ethBlock: number
+  canonicalTxHash: Hash
+  toMint: Hex
+  refundRecipient: Address
+}
+
+export type ZkSyncRawBlockTransactions = {
+  commonData: {
+    L1?:
+      | ({
+          serialId: number
+          deadlineBlock: number
+          layer2TipFee: Hex
+          fullFee: Hex
+          opProcessingType: string
+          priorityQueueType: string
+        } & CommonDataRawBlockTransaction)
+      | undefined
+    L2?:
+      | {
+          nonce: number
+          fee: ZkSyncFee<Hex>
+          initiatorAddress: Address
+          signature: Uint8Array
+          transactionType: string
+          input?:
+            | {
+                hash: Hash
+                data: Uint8Array
+              }
+            | undefined
+          paymasterParams: {
+            paymaster: Address
+            paymasterInput: Uint8Array
+          }
+        }
+      | undefined
+    ProtocolUpgrade?:
+      | ({
+          upgradeId: string
+        } & CommonDataRawBlockTransaction)
+      | undefined
+  }
+  execute: {
+    calldata: Hash
+    contractAddress: Address
+    factoryDeps?: Hash
+    value: bigint
+  }
+  receivedTimestampMs: number
+  rawBytes?: string | undefined
+}[]
+
+export type ZkSyncTransactionDetails = {
+  isL1Originated: boolean
+  status: string
+  fee: bigint
+  gasPerPubdata: bigint
+  initiatorAddress: Address
+  receivedAt: Date
+  ethCommitTxHash?: Hash | undefined
+  ethProveTxHash?: Hash | undefined
+  ethExecuteTxHash?: Hash | undefined
+}

package/zksync/utils/camelCaseKeys.ts

@@ -0,0 +1,11 @@
+export function camelCaseKeys(response: object): object {
+  if (!response) return response
+  if (typeof response !== 'object') return response
+  if (Array.isArray(response)) return response.map(camelCaseKeys)
+  return Object.fromEntries(
+    Object.entries(response).map(([key, value]) => [
+      key.replace(/_([a-z])/g, (_, letter) => letter.toUpperCase()),
+      camelCaseKeys(value),
+    ]),
+  )
+}

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/zksync/utils/paymaster/getApprovalBasedPaymasterInput.ts

@@ -1,7 +1,10 @@
 import type { Address } from 'abitype'
 import type { ByteArray, Hex } from '../../../types/misc.js'
-import type { EncodeFunctionDataReturnType } from '../../../utils/abi/encodeFunctionData.js'
-import { bytesToHex, encodeFunctionData } from '../../../utils/index.js'
+import {
+  type EncodeFunctionDataReturnType,
+  encodeFunctionData,
+} from '../../../utils/abi/encodeFunctionData.js'
+import { bytesToHex } from '../../../utils/encoding/toHex.js'
 import { paymasterAbi } from '../../constants/abis.js'
 
 export type GetApprovalBasedPaymasterInputParameters = {

package/zksync/utils/paymaster/getGeneralPaymasterInput.ts

@@ -1,6 +1,9 @@
 import type { ByteArray, Hex } from '../../../types/misc.js'
-import type { EncodeFunctionDataReturnType } from '../../../utils/abi/encodeFunctionData.js'
-import { bytesToHex, encodeFunctionData } from '../../../utils/index.js'
+import {
+  type EncodeFunctionDataReturnType,
+  encodeFunctionData,
+} from '../../../utils/abi/encodeFunctionData.js'
+import { bytesToHex } from '../../../utils/encoding/toHex.js'
 import { paymasterAbi } from '../../constants/abis.js'
 
 export type GetGeneralPaymasterInputParameters = {