viem 2.0.0-beta.1 → 2.0.0-beta.11

package/chains/opStack/parsers.ts

@@ -0,0 +1,88 @@
+import { InvalidSerializedTransactionError } from '../../errors/transaction.js'
+import type { ErrorType } from '../../errors/utils.js'
+import { isHex } from '../../utils/data/isHex.js'
+import { sliceHex } from '../../utils/data/slice.js'
+import { hexToBigInt, hexToBool } from '../../utils/encoding/fromHex.js'
+import type { GetSerializedTransactionType } from '../../utils/transaction/getSerializedTransactionType.js'
+import {
+  type ParseTransactionErrorType as ParseTransactionErrorType_,
+  type ParseTransactionReturnType as ParseTransactionReturnType_,
+  parseTransaction as parseTransaction_,
+  toTransactionArray,
+} from '../../utils/transaction/parseTransaction.js'
+import { assertTransactionDeposit } from './serializers.js'
+import type {
+  OpStackTransactionSerialized,
+  OpStackTransactionType,
+  TransactionSerializableDeposit,
+  TransactionSerializedDeposit,
+} from './types/transaction.js'
+
+export type ParseTransactionReturnType<
+  TSerialized extends
+    OpStackTransactionSerialized = OpStackTransactionSerialized,
+  TType extends
+    OpStackTransactionType = GetSerializedTransactionType<TSerialized>,
+> = TSerialized extends TransactionSerializedDeposit
+  ? TransactionSerializableDeposit
+  : ParseTransactionReturnType_<TSerialized, TType>
+
+export type ParseTransactionErrorType = ParseTransactionErrorType_ | ErrorType
+
+export function parseTransaction<
+  TSerialized extends OpStackTransactionSerialized,
+>(serializedTransaction: TSerialized): ParseTransactionReturnType<TSerialized> {
+  const serializedType = sliceHex(serializedTransaction, 0, 1)
+
+  if (serializedType === '0x7e')
+    return parseTransactionDeposit(
+      serializedTransaction as TransactionSerializedDeposit,
+    ) as ParseTransactionReturnType<TSerialized>
+
+  return parseTransaction_(
+    serializedTransaction,
+  ) as ParseTransactionReturnType<TSerialized>
+}
+
+function parseTransactionDeposit(
+  serializedTransaction: TransactionSerializedDeposit,
+): ParseTransactionReturnType<TransactionSerializedDeposit> {
+  const transactionArray = toTransactionArray(serializedTransaction)
+
+  const [sourceHash, from, to, mint, value, gas, isSystemTx, data] =
+    transactionArray
+
+  if (transactionArray.length !== 8 || !isHex(sourceHash) || !isHex(from))
+    throw new InvalidSerializedTransactionError({
+      attributes: {
+        sourceHash,
+        from,
+        gas,
+        to,
+        mint,
+        value,
+        isSystemTx,
+        data,
+      },
+      serializedTransaction,
+      type: 'deposit',
+    })
+
+  const transaction: TransactionSerializableDeposit = {
+    sourceHash,
+    from,
+    type: 'deposit',
+  }
+
+  if (isHex(gas) && gas !== '0x') transaction.gas = hexToBigInt(gas)
+  if (isHex(to) && to !== '0x') transaction.to = to
+  if (isHex(mint) && mint !== '0x') transaction.mint = hexToBigInt(mint)
+  if (isHex(value) && value !== '0x') transaction.value = hexToBigInt(value)
+  if (isHex(isSystemTx) && isSystemTx !== '0x')
+    transaction.isSystemTx = hexToBool(isSystemTx)
+  if (isHex(data) && data !== '0x') transaction.data = data
+
+  assertTransactionDeposit(transaction)
+
+  return transaction
+}

package/chains/opStack/serializers.ts

@@ -0,0 +1,88 @@
+import { InvalidAddressError } from '../../errors/address.js'
+import type { ErrorType } from '../../errors/utils.js'
+import type { ChainSerializers } from '../../types/chain.js'
+import type { Hex } from '../../types/misc.js'
+import type { TransactionSerializable } from '../../types/transaction.js'
+import type { RequiredBy } from '../../types/utils.js'
+import { isAddress } from '../../utils/address/isAddress.js'
+import { concatHex } from '../../utils/data/concat.js'
+import { toHex } from '../../utils/encoding/toHex.js'
+import { toRlp } from '../../utils/encoding/toRlp.js'
+import {
+  type SerializeTransactionErrorType as SerializeTransactionErrorType_,
+  type SerializeTransactionFn,
+  serializeTransaction as serializeTransaction_,
+} from '../../utils/transaction/serializeTransaction.js'
+import type {
+  OpStackTransactionSerializable,
+  TransactionSerializableDeposit,
+  TransactionSerializedDeposit,
+} from './types/transaction.js'
+
+export type SerializeTransactionReturnType = ReturnType<
+  typeof serializeTransaction
+>
+
+export type SerializeTransactionErrorType =
+  | SerializeTransactionErrorType_
+  | ErrorType
+
+export const serializeTransaction: SerializeTransactionFn<
+  OpStackTransactionSerializable
+> = (transaction, signature) => {
+  if (isDeposit(transaction)) return serializeTransactionDeposit(transaction)
+  return serializeTransaction_(
+    transaction as TransactionSerializable,
+    signature,
+  )
+}
+
+export const serializers = {
+  transaction: serializeTransaction,
+} as const satisfies ChainSerializers
+
+//////////////////////////////////////////////////////////////////////////////
+// Serializers
+
+export type SerializeTransactionDepositReturnType = TransactionSerializedDeposit
+
+function serializeTransactionDeposit(
+  transaction: TransactionSerializableDeposit,
+): SerializeTransactionDepositReturnType {
+  assertTransactionDeposit(transaction)
+
+  const { sourceHash, data, from, gas, isSystemTx, mint, to, value } =
+    transaction
+
+  const serializedTransaction: Hex[] = [
+    sourceHash,
+    from,
+    to ?? '0x',
+    mint ? toHex(mint) : '0x',
+    value ? toHex(value) : '0x',
+    gas ? toHex(gas) : '0x',
+    isSystemTx ? '0x1' : '0x',
+    data ?? '0x',
+  ]
+
+  return concatHex([
+    '0x7e',
+    toRlp(serializedTransaction),
+  ]) as SerializeTransactionDepositReturnType
+}
+
+function isDeposit(
+  transaction: OpStackTransactionSerializable,
+): transaction is RequiredBy<TransactionSerializableDeposit, 'type'> {
+  if (transaction.type === 'deposit') return true
+  if (typeof transaction.sourceHash !== 'undefined') return true
+  return false
+}
+
+export function assertTransactionDeposit(
+  transaction: TransactionSerializableDeposit,
+) {
+  const { from, to } = transaction
+  if (from && !isAddress(from)) throw new InvalidAddressError({ address: from })
+  if (to && !isAddress(to)) throw new InvalidAddressError({ address: to })
+}

package/chains/opStack/types/block.ts

@@ -0,0 +1,34 @@
+import type { Block, BlockTag } from '../../../types/block.js'
+import type { Hash } from '../../../types/misc.js'
+import type { RpcBlock } from '../../../types/rpc.js'
+import type {
+  OpStackRpcTransaction,
+  OpStackTransaction,
+} from './transaction.js'
+
+export type OpStackBlockOverrides = {
+  stateRoot: Hash
+}
+export type OpStackBlock<
+  TIncludeTransactions extends boolean = boolean,
+  TBlockTag extends BlockTag = BlockTag,
+> = Block<
+  bigint,
+  TIncludeTransactions,
+  TBlockTag,
+  OpStackTransaction<TBlockTag extends 'pending' ? true : false>
+> &
+  OpStackBlockOverrides
+
+export type OpStackRpcBlockOverrides = {
+  stateRoot: Hash
+}
+export type OpStackRpcBlock<
+  TBlockTag extends BlockTag = BlockTag,
+  TIncludeTransactions extends boolean = boolean,
+> = RpcBlock<
+  TBlockTag,
+  TIncludeTransactions,
+  OpStackRpcTransaction<TBlockTag extends 'pending' ? true : false>
+> &
+  OpStackRpcBlockOverrides

package/chains/opStack/types/chain.ts

@@ -0,0 +1,7 @@
+import type { Chain, ChainContract } from '../../../types/chain.js'
+
+export type TargetChain<chain extends Chain, contractName extends string> = {
+  contracts: {
+    [_ in contractName]: { [_ in chain['id']]: ChainContract }
+  }
+}

package/chains/opStack/types/contract.ts

@@ -0,0 +1,17 @@
+import type { Address } from 'abitype'
+
+import type { Chain } from '../../../types/chain.js'
+import type { TargetChain } from './chain.js'
+
+export type GetContractAddressParameter<
+  chain extends Chain | undefined,
+  contractName extends string,
+> =
+  | (chain extends Chain
+      ? {
+          [_key in `${contractName}Address`]?: undefined
+        } & { targetChain: TargetChain<chain, contractName> }
+      : never)
+  | ({
+      [_key in `${contractName}Address`]: Address
+    } & { targetChain?: undefined })

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/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/fromOpaqueData.ts

@@ -0,0 +1,40 @@
+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 FromOpaqueDataParameters = Hex
+
+export type FromOpaqueDataReturnType = {
+  mint: bigint
+  value: bigint
+  gas: bigint
+  isCreation: boolean
+  data: Hex
+}
+
+export type FromOpaqueDataErrorType = SliceErrorType | SizeErrorType | ErrorType
+
+export function fromOpaqueData(opaqueData: Hex): FromOpaqueDataReturnType {
+  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/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 { fromOpaqueData } from './fromOpaqueData.js'
+import { getSourceHash } from './getSourceHash.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 } = fromOpaqueData(
+    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/utils.ts

@@ -14,86 +14,3 @@ export {
   type GetChainContractAddressErrorType,
   getChainContractAddress,
 } from '../utils/chain/getChainContractAddress.js'
-
-export { formattersCelo } from './celo/formatters.js'
-export {
-  serializeTransactionCelo,
-  serializersCelo,
-} from './celo/serializers.js'
-export { parseTransactionCelo } from './celo/parsers.js'
-export type {
-  CeloBlock,
-  CeloBlockOverrides,
-  CeloRpcBlock,
-  CeloRpcBlockOverrides,
-  CeloRpcTransaction,
-  CeloRpcTransactionReceipt,
-  CeloRpcTransactionReceiptOverrides,
-  CeloRpcTransactionRequest,
-  CeloTransaction,
-  CeloTransactionReceipt,
-  CeloTransactionReceiptOverrides,
-  CeloTransactionRequest,
-  CeloTransactionSerializable,
-  CeloTransactionSerialized,
-  CeloTransactionType,
-  RpcTransactionCIP42,
-  RpcTransactionCIP64,
-  RpcTransactionRequestCIP42,
-  RpcTransactionRequestCIP64,
-  TransactionCIP42,
-  TransactionCIP64,
-  TransactionRequestCIP42,
-  TransactionRequestCIP64,
-  TransactionSerializableCIP42,
-  TransactionSerializableCIP64,
-  TransactionSerializedCIP42,
-  TransactionSerializedCIP64,
-} from './celo/types.js'
-
-export { formattersOptimism } from './optimism/formatters.js'
-export type {
-  OptimismBlock,
-  OptimismBlockOverrides,
-  OptimismDepositTransaction,
-  OptimismRpcBlock,
-  OptimismRpcBlockOverrides,
-  OptimismRpcDepositTransaction,
-  OptimismRpcTransaction,
-  OptimismRpcTransactionReceipt,
-  OptimismRpcTransactionReceiptOverrides,
-  OptimismTransaction,
-  OptimismTransactionReceipt,
-  OptimismTransactionReceiptOverrides,
-} from './optimism/types.js'
-
-export { formattersZkSync } from './zksync/formatters.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 './zksync/types.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'