viem 0.0.0-main.20240103T193024 → 0.0.0-main.20240103T195854

package/chains/opStack/types/deposit.ts

@@ -0,0 +1,28 @@
+import type { Address } from 'abitype'
+import type { Hex } from '../../../types/misc.js'
+
+export type DepositRequest = {
+  /** Gas limit for transaction execution on the L2. */
+  gas: bigint
+  /** Value in wei to mint (deposit) on the L2. Debited from the caller's L1 balance. */
+  mint?: bigint
+  /** Value in wei sent with this transaction on the L2. Debited from the caller's L2 balance. */
+  value?: bigint
+} & (
+  | {
+      /** Encoded contract method & arguments. */
+      data?: Hex
+      /** Whether or not this is a contract deployment transaction. */
+      isCreation?: false
+      /** L2 Transaction recipient. */
+      to?: Address
+    }
+  | {
+      /** Contract deployment bytecode. Required for contract deployment transactions. */
+      data: Hex
+      /** Whether or not this is a contract deployment transaction. */
+      isCreation: true
+      /** L2 Transaction recipient. Cannot exist for contract deployment transactions. */
+      to?: never
+    }
+)

package/chains/opStack/types/transaction.ts

@@ -0,0 +1,108 @@
+import type { FeeValuesEIP1559 } from '../../../types/fee.js'
+import type { Hex } from '../../../types/misc.js'
+import type {
+  Index,
+  Quantity,
+  RpcTransaction as RpcTransaction_,
+  RpcTransactionReceipt,
+} from '../../../types/rpc.js'
+import type {
+  Transaction as Transaction_,
+  TransactionBase,
+  TransactionReceipt,
+  TransactionSerializable,
+  TransactionSerializableBase,
+  TransactionSerialized,
+  TransactionType,
+} from '../../../types/transaction.js'
+import type { RequiredBy } from '../../../types/utils.js'
+
+type RpcTransaction<TPending extends boolean = boolean> =
+  RpcTransaction_<TPending> & {
+    isSystemTx?: undefined
+    mint?: undefined
+    sourceHash?: undefined
+  }
+
+export type OpStackRpcDepositTransaction<TPending extends boolean = boolean> =
+  Omit<TransactionBase<Quantity, Index, TPending>, 'typeHex'> &
+    FeeValuesEIP1559<Quantity> & {
+      isSystemTx?: boolean
+      mint?: Hex
+      sourceHash: Hex
+      type: '0x7e'
+    }
+export type OpStackRpcTransaction<TPending extends boolean = boolean> =
+  | RpcTransaction<TPending>
+  | OpStackRpcDepositTransaction<TPending>
+
+export type OpStackRpcTransactionReceiptOverrides = {
+  l1GasPrice: Hex | null
+  l1GasUsed: Hex | null
+  l1Fee: Hex | null
+  l1FeeScalar: `${number}` | null
+}
+export type OpStackRpcTransactionReceipt = RpcTransactionReceipt &
+  OpStackRpcTransactionReceiptOverrides
+
+type Transaction<TPending extends boolean = boolean> = Transaction_<
+  bigint,
+  number,
+  TPending
+> & {
+  isSystemTx?: undefined
+  mint?: undefined
+  sourceHash?: undefined
+}
+
+export type OpStackDepositTransaction<TPending extends boolean = boolean> =
+  TransactionBase<bigint, number, TPending> &
+    FeeValuesEIP1559 & {
+      isSystemTx?: boolean
+      mint?: bigint
+      sourceHash: Hex
+      type: 'deposit'
+    }
+
+export type OpStackTransaction<TPending extends boolean = boolean> =
+  | Transaction<TPending>
+  | OpStackDepositTransaction<TPending>
+
+export type OpStackTransactionReceiptOverrides = {
+  l1GasPrice: bigint | null
+  l1GasUsed: bigint | null
+  l1Fee: bigint | null
+  l1FeeScalar: number | null
+}
+export type OpStackTransactionReceipt = TransactionReceipt &
+  OpStackTransactionReceiptOverrides
+
+export type OpStackTransactionSerializable =
+  | RequiredBy<TransactionSerializableDeposit, 'type'>
+  | (TransactionSerializable & {
+      isSystemTx?: undefined
+      mint?: undefined
+      sourceHash?: undefined
+    })
+
+export type OpStackTransactionSerialized<
+  TType extends OpStackTransactionType = 'legacy',
+> = TransactionSerialized<TType> | TransactionSerializedDeposit
+
+export type OpStackTransactionType = TransactionType | 'deposit'
+
+export type TransactionSerializableDeposit<
+  TQuantity = bigint,
+  TIndex = number,
+> = Omit<
+  TransactionSerializableBase<TQuantity, TIndex>,
+  'nonce' | 'r' | 's' | 'v'
+> & {
+  from: Hex
+  isSystemTx?: boolean
+  mint?: bigint
+  sourceHash: Hex
+  type?: 'deposit'
+}
+
+export type TransactionSerializedDeposit = `0x7e${string}`

package/chains/opStack/types/withdrawal.ts

@@ -0,0 +1,23 @@
+import type { Address } from 'abitype'
+import type { Hex } from '../../../types/misc.js'
+
+export type WithdrawalRequest = {
+  /** Encoded contract method & arguments. */
+  data?: Hex
+  /** Gas limit for transaction execution on the L1. */
+  gas: bigint
+  /** L1 Transaction recipient. */
+  to: Address
+  /** Value in wei to withdrawal to the L1. Debited from the caller's L2 balance. */
+  value?: bigint
+}
+
+export type Withdrawal = {
+  nonce: bigint
+  sender: Hex
+  target: Hex
+  value: bigint
+  gasLimit: bigint
+  data: Hex
+  withdrawalHash: Hex
+}

package/chains/opStack/utils/extractTransactionDepositedLogs.ts

@@ -0,0 +1,36 @@
+import type { ErrorType } from '../../../errors/utils.js'
+import type { Log } from '../../../types/log.js'
+import {
+  type ParseEventLogsErrorType,
+  parseEventLogs,
+} from '../../../utils/abi/parseEventLogs.js'
+import { portalAbi } from '../abis.js'
+
+export type ExtractTransactionDepositedLogsParameters = {
+  /** An opaque array of logs. */
+  logs: Log[]
+}
+
+export type ExtractTransactionDepositedLogsReturnType = Log<
+  bigint,
+  number,
+  false,
+  undefined,
+  true,
+  typeof portalAbi,
+  'TransactionDeposited'
+>[]
+
+export type ExtractTransactionDepositedLogsErrorType =
+  | ParseEventLogsErrorType
+  | ErrorType
+
+export function extractTransactionDepositedLogs({
+  logs,
+}: ExtractTransactionDepositedLogsParameters) {
+  return parseEventLogs({
+    abi: portalAbi,
+    eventName: 'TransactionDeposited',
+    logs,
+  })
+}

package/chains/opStack/utils/extractWithdrawalMessageLogs.ts

@@ -0,0 +1,36 @@
+import type { ErrorType } from '../../../errors/utils.js'
+import type { Log } from '../../../types/log.js'
+import {
+  type ParseEventLogsErrorType,
+  parseEventLogs,
+} from '../../../utils/abi/parseEventLogs.js'
+import { l2ToL1MessagePasserAbi } from '../abis.js'
+
+export type ExtractWithdrawalMessageLogsParameters = {
+  /** An opaque array of logs. */
+  logs: Log[]
+}
+
+export type ExtractWithdrawalMessageLogsReturnType = Log<
+  bigint,
+  number,
+  false,
+  undefined,
+  true,
+  typeof l2ToL1MessagePasserAbi,
+  'MessagePassed'
+>[]
+
+export type ExtractWithdrawalMessageLogsErrorType =
+  | ParseEventLogsErrorType
+  | ErrorType
+
+export function extractWithdrawalMessageLogs({
+  logs,
+}: ExtractWithdrawalMessageLogsParameters) {
+  return parseEventLogs({
+    abi: l2ToL1MessagePasserAbi,
+    eventName: 'MessagePassed',
+    logs,
+  })
+}

package/chains/opStack/utils/getL2TransactionHash.ts

@@ -0,0 +1,52 @@
+// Adapted from https://github.com/ethereum-optimism/optimism/blob/develop/packages/core-utils/src/optimism/deposit-transaction.ts#L117
+
+import type { ErrorType } from '../../../errors/utils.js'
+import type { Log } from '../../../types/log.js'
+import type { Hex } from '../../../types/misc.js'
+import { keccak256 } from '../../../utils/hash/keccak256.js'
+import type { portalAbi } from '../abis.js'
+import { serializeTransaction } from '../serializers.js'
+import { getSourceHash } from './getSourceHash.js'
+import { opaqueDataToDepositData } from './opaqueDataToDepositData.js'
+
+export type GetL2TransactionHashParameters = {
+  /** The "TransactionDeposited" log to compute the L2 hash from. */
+  log: Log<
+    bigint,
+    number,
+    false,
+    undefined,
+    true,
+    typeof portalAbi,
+    'TransactionDeposited'
+  >
+}
+
+export type GetL2TransactionHashReturnType = Hex
+
+export type GetL2TransactionHashErrorType = ErrorType
+
+export function getL2TransactionHash({ log }: GetL2TransactionHashParameters) {
+  const sourceHash = getSourceHash({
+    domain: 'userDeposit',
+    l1BlockHash: log.blockHash,
+    l1LogIndex: log.logIndex,
+  })
+  const { data, gas, isCreation, mint, value } = opaqueDataToDepositData(
+    log.args.opaqueData,
+  )
+
+  return keccak256(
+    serializeTransaction({
+      from: log.args.from,
+      to: isCreation ? undefined : log.args.to,
+      sourceHash,
+      data,
+      gas,
+      isSystemTx: false,
+      mint,
+      type: 'deposit',
+      value,
+    }),
+  )
+}

package/chains/opStack/utils/getL2TransactionHashes.ts

@@ -0,0 +1,21 @@
+import type { ErrorType } from '../../../errors/utils.js'
+import type { Log } from '../../../types/log.js'
+import type { Hex } from '../../../types/misc.js'
+import { extractTransactionDepositedLogs } from './extractTransactionDepositedLogs.js'
+import { getL2TransactionHash } from './getL2TransactionHash.js'
+
+export type GetL2TransactionHashesParameters = {
+  /** The L1 transaction receipt logs. */
+  logs: Log[]
+}
+
+export type GetL2TransactionHashesReturnType = Hex[]
+
+export type GetL2TransactionHashesErrorType = ErrorType
+
+export function getL2TransactionHashes({
+  logs,
+}: GetL2TransactionHashesParameters): GetL2TransactionHashesReturnType {
+  const extractedLogs = extractTransactionDepositedLogs({ logs })
+  return extractedLogs.map((log) => getL2TransactionHash({ log }))
+}

package/chains/opStack/utils/getSourceHash.ts

@@ -0,0 +1,61 @@
+// Adapted from https://github.com/ethereum-optimism/optimism/blob/develop/packages/core-utils/src/optimism/deposit-transaction.ts#L117
+
+import type { ErrorType } from '../../../errors/utils.js'
+import type { Hex } from '../../../types/misc.js'
+import { type ConcatErrorType, concat } from '../../../utils/data/concat.js'
+import { type PadErrorType, pad } from '../../../utils/data/pad.js'
+import { type ToHexErrorType, toHex } from '../../../utils/encoding/toHex.js'
+import {
+  type Keccak256ErrorType,
+  keccak256,
+} from '../../../utils/hash/keccak256.js'
+
+export type GetSourceHashParameters = {
+  /** The L1 block hash. */
+  l1BlockHash: Hex
+} & (
+  | {
+      /** Domain of source hash. */
+      domain: 'userDeposit'
+      /** The index of the log on the L1. */
+      l1LogIndex: number
+      /** The sequence number. */
+      sequenceNumber?: undefined
+    }
+  | {
+      /** Domain of source hash. */
+      domain: 'l1InfoDeposit'
+      /** The index of the log on the L1. */
+      l1LogIndex?: undefined
+      /** The sequence number. */
+      sequenceNumber: number
+    }
+)
+
+export type GetSourceHashReturnType = Hex
+
+export type GetSourceHashErrorType =
+  | ConcatErrorType
+  | Keccak256ErrorType
+  | PadErrorType
+  | ToHexErrorType
+  | ErrorType
+
+const sourceHashDomainMap = {
+  userDeposit: 0,
+  l1InfoDeposit: 1,
+} as const
+
+export function getSourceHash({
+  domain,
+  l1LogIndex,
+  l1BlockHash,
+  sequenceNumber,
+}: GetSourceHashParameters) {
+  const marker = toHex(l1LogIndex! || sequenceNumber!)
+  const input = concat([l1BlockHash, pad(marker, { size: 32 })])
+  const depositIdHash = keccak256(input)
+  const domainHex = toHex(sourceHashDomainMap[domain])
+  const domainInput = concat([pad(domainHex, { size: 32 }), depositIdHash])
+  return keccak256(domainInput)
+}

package/chains/opStack/utils/getWithdrawalHashStorageSlot.ts

@@ -0,0 +1,29 @@
+import type { ErrorType } from '../../../errors/utils.js'
+import type { Hash } from '../../../types/misc.js'
+import {
+  type EncodeAbiParametersErrorType,
+  encodeAbiParameters,
+} from '../../../utils/abi/encodeAbiParameters.js'
+import {
+  type Keccak256ErrorType,
+  keccak256,
+} from '../../../utils/hash/keccak256.js'
+
+export type GetWithdrawalHashStorageSlotParameters = {
+  withdrawalHash: Hash
+}
+export type GetWithdrawalHashStorageSlotReturnType = Hash
+export type GetWithdrawalHashStorageSlotErrorType =
+  | EncodeAbiParametersErrorType
+  | Keccak256ErrorType
+  | ErrorType
+
+export function getWithdrawalHashStorageSlot({
+  withdrawalHash,
+}: GetWithdrawalHashStorageSlotParameters) {
+  const data = encodeAbiParameters(
+    [{ type: 'bytes32' }, { type: 'uint256' }],
+    [withdrawalHash, 0n],
+  )
+  return keccak256(data)
+}

package/chains/opStack/utils/getWithdrawals.ts

@@ -0,0 +1,25 @@
+import type { ErrorType } from '../../../errors/utils.js'
+import type { Log } from '../../../types/log.js'
+import type { Withdrawal } from '../types/withdrawal.js'
+import {
+  type ExtractWithdrawalMessageLogsErrorType,
+  extractWithdrawalMessageLogs,
+} from './extractWithdrawalMessageLogs.js'
+
+export type GetWithdrawalsParameters = {
+  /** The L2 transaction receipt logs. */
+  logs: Log[]
+}
+
+export type GetWithdrawalsReturnType = Withdrawal[]
+
+export type GetWithdrawalsErrorType =
+  | ExtractWithdrawalMessageLogsErrorType
+  | ErrorType
+
+export function getWithdrawals({
+  logs,
+}: GetWithdrawalsParameters): GetWithdrawalsReturnType {
+  const extractedLogs = extractWithdrawalMessageLogs({ logs })
+  return extractedLogs.map((log) => log.args)
+}

package/chains/opStack/utils/opaqueDataToDepositData.ts

@@ -0,0 +1,45 @@
+import type { ErrorType } from '../../../errors/utils.js'
+import type { Hex } from '../../../types/misc.js'
+import { type SizeErrorType, size } from '../../../utils/data/size.js'
+import { type SliceErrorType, slice } from '../../../utils/data/slice.js'
+import { hexToBigInt } from '../../../utils/encoding/fromHex.js'
+
+export type OpaqueDataToDepositDataParameters = Hex
+
+export type OpaqueDataToDepositDataReturnType = {
+  mint: bigint
+  value: bigint
+  gas: bigint
+  isCreation: boolean
+  data: Hex
+}
+
+export type OpaqueDataToDepositDataErrorType =
+  | SliceErrorType
+  | SizeErrorType
+  | ErrorType
+
+export function opaqueDataToDepositData(
+  opaqueData: Hex,
+): OpaqueDataToDepositDataReturnType {
+  let offset = 0
+  const mint = slice(opaqueData, offset, offset + 32)
+  offset += 32
+  const value = slice(opaqueData, offset, offset + 32)
+  offset += 32
+  const gas = slice(opaqueData, offset, offset + 8)
+  offset += 8
+  const isCreation = BigInt(slice(opaqueData, offset, offset + 1)) === 1n
+  offset += 1
+  const data =
+    offset > size(opaqueData) - 1
+      ? '0x'
+      : slice(opaqueData, offset, opaqueData.length)
+  return {
+    mint: hexToBigInt(mint),
+    value: hexToBigInt(value),
+    gas: hexToBigInt(gas),
+    isCreation,
+    data,
+  }
+}

package/chains/utils/package.json

@@ -1,6 +1,6 @@
 {
   "type": "module",
-  "types": "../../_types/chains/utils/index.d.ts",
-  "module": "../../_esm/chains/utils/index.js",
-  "main": "../../_cjs/chains/utils/index.js"
+  "types": "../../_types/chains/utils.d.ts",
+  "module": "../../_esm/chains/utils.js",
+  "main": "../../_cjs/chains/utils.js"
 }

package/chains/utils.ts

@@ -0,0 +1,16 @@
+export {
+  type AssertCurrentChainErrorType,
+  type AssertCurrentChainParameters,
+  assertCurrentChain,
+} from '../utils/chain/assertCurrentChain.js'
+export { defineChain } from '../utils/chain/defineChain.js'
+export {
+  type ExtractChainErrorType,
+  type ExtractChainParameters,
+  type ExtractChainReturnType,
+  extractChain,
+} from '../utils/chain/extractChain.js'
+export {
+  type GetChainContractAddressErrorType,
+  getChainContractAddress,
+} from '../utils/chain/getChainContractAddress.js'

package/chains/zksync/chainConfig.ts

@@ -0,0 +1,7 @@
+import { formatters } from './formatters.js'
+import { serializers } from './serializers.js'
+
+export const chainConfig = {
+  formatters,
+  serializers,
+} as const

package/chains/zksync/formatters.ts

@@ -21,7 +21,7 @@ import type {
   ZkSyncTransactionRequest,
 } from './types.js'
 
-export const formattersZkSync = {
+export const formatters = {
   block: /*#__PURE__*/ defineBlock({
     format(
       args: ZkSyncRpcBlockOverrides & {
@@ -32,7 +32,7 @@ export const formattersZkSync = {
     } {
       const transactions = args.transactions?.map((transaction) => {
         if (typeof transaction === 'string') return transaction
-        const formatted = formattersZkSync.transaction.format(
+        const formatted = formatters.transaction.format(
           transaction as ZkSyncRpcTransaction,
         ) as ZkSyncTransaction
         if (formatted.typeHex === '0x71') formatted.type = 'eip712'

package/chains/zksync/index.ts

@@ -0,0 +1,33 @@
+export { chainConfig } from './chainConfig.js'
+
+export { serializeTransaction } from './serializers.js'
+
+export type {
+  ZkSyncBlock,
+  ZkSyncBlockOverrides,
+  ZkSyncEip712Meta,
+  ZkSyncFeeValues,
+  ZkSyncL2ToL1Log,
+  ZkSyncLog,
+  ZkSyncRpcBlock,
+  ZkSyncRpcBlockOverrides,
+  ZkSyncRpcL2ToL1Log,
+  ZkSyncRpcLog,
+  ZkSyncRpcTransaction,
+  ZkSyncRpcTransactionEIP712,
+  ZkSyncRpcTransactionPriority,
+  ZkSyncRpcTransactionReceiptOverrides,
+  ZkSyncRpcTransactionRequest,
+  ZkSyncRpcTransactionRequestEIP712,
+  ZkSyncTransaction,
+  ZkSyncTransactionEIP712,
+  ZkSyncTransactionReceipt,
+  ZkSyncTransactionReceiptOverrides,
+  ZkSyncTransactionRequest,
+  ZkSyncTransactionRequestEIP712,
+  ZkSyncTransactionSerializable,
+  ZkSyncTransactionSerializableEIP712,
+  ZkSyncTransactionSerialized,
+  ZkSyncTransactionSerializedEIP712,
+  ZkSyncTransactionType,
+} from './types.js'

package/chains/zksync/serializers.ts

@@ -9,7 +9,7 @@ import { toHex } from '../../utils/encoding/toHex.js'
 import { toRlp } from '../../utils/encoding/toRlp.js'
 import {
   type SerializeTransactionFn,
-  serializeTransaction,
+  serializeTransaction as serializeTransaction_,
 } from '../../utils/transaction/serializeTransaction.js'
 import type {
   ZkSyncTransactionSerializable,
@@ -17,18 +17,16 @@ import type {
   ZkSyncTransactionSerializedEIP712,
 } from './types.js'
 
-export const serializeTransactionZkSync: SerializeTransactionFn<
+export const serializeTransaction: SerializeTransactionFn<
   ZkSyncTransactionSerializable
 > = (tx, signature) => {
   if (isEIP712(tx))
-    return serializeTransactionZkSyncEIP712(
-      tx as ZkSyncTransactionSerializableEIP712,
-    )
-  return serializeTransaction(tx as TransactionSerializable, signature)
+    return serializeTransactionEIP712(tx as ZkSyncTransactionSerializableEIP712)
+  return serializeTransaction_(tx as TransactionSerializable, signature)
 }
 
-export const serializersZkSync = {
-  transaction: serializeTransactionZkSync,
+export const serializers = {
+  transaction: serializeTransaction,
 } as const satisfies ChainSerializers
 
 //////////////////////////////////////////////////////////////////////////////
@@ -37,7 +35,7 @@ export const serializersZkSync = {
 export type SerializeTransactionEIP712ReturnType =
   ZkSyncTransactionSerializedEIP712
 
-function serializeTransactionZkSyncEIP712(
+function serializeTransactionEIP712(
   transaction: ZkSyncTransactionSerializableEIP712,
 ): SerializeTransactionEIP712ReturnType {
   const {

package/clients/createClient.ts

@@ -122,7 +122,7 @@ type Client_Base<
   /** The Account of the Client. */
   account: account
   /** Flags for batch settings. */
-  batch?: ClientConfig['batch']
+  batch?: ClientConfig['batch'] | undefined
   /** Time (in ms) that cached data will remain in memory. */
   cacheTime: number
   /** Chain for the client. */

package/clients/createWalletClient.ts

@@ -103,7 +103,7 @@ export function createWalletClient(
     ...parameters,
     key,
     name,
-    transport: (opts) => transport({ ...opts, retryCount: 0 }),
+    transport,
     type: 'walletClient',
   })
   return client.extend(walletActions)