viem 2.9.2 → 2.9.4

package/op-stack/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/op-stack/types/chain.ts

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

package/op-stack/types/contract.ts

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

package/op-stack/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 | undefined
+  /** Value in wei sent with this transaction on the L2. Debited from the caller's L2 balance. */
+  value?: bigint | undefined
+} & (
+  | {
+      /** Encoded contract method & arguments. */
+      data?: Hex | undefined
+      /** Whether or not this is a contract deployment transaction. */
+      isCreation?: false | undefined
+      /** L2 Transaction recipient. */
+      to?: Address | undefined
+    }
+  | {
+      /** 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 | undefined
+    }
+)

package/op-stack/types/transaction.ts

@@ -0,0 +1,106 @@
+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 { OneOf } 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 | undefined
+      mint?: Hex | undefined
+      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 | undefined
+      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 = OneOf<
+  TransactionSerializableDeposit | TransactionSerializable
+>
+
+export type OpStackTransactionSerialized<
+  TType extends OpStackTransactionType = OpStackTransactionType,
+> = TType extends 'deposit'
+  ? TransactionSerializedDeposit
+  : TransactionSerialized<TType>
+
+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 | undefined
+  sourceHash: Hex
+  type: 'deposit'
+}
+
+export type TransactionSerializedDeposit = `0x7e${string}`

package/op-stack/types/withdrawal.ts

@@ -0,0 +1,31 @@
+import type { Address } from 'abitype'
+import type { Hex } from '../../types/misc.js'
+
+export type Game = {
+  index: bigint
+  metadata: Hex
+  timestamp: bigint
+  rootClaim: Hex
+  extraData: Hex
+}
+
+export type WithdrawalRequest = {
+  /** Encoded contract method & arguments. */
+  data?: Hex | undefined
+  /** 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 | undefined
+}
+
+export type Withdrawal = {
+  nonce: bigint
+  sender: Hex
+  target: Hex
+  value: bigint
+  gasLimit: bigint
+  data: Hex
+  withdrawalHash: Hex
+}

package/op-stack/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/op-stack/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/op-stack/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/op-stack/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/op-stack/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/op-stack/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/op-stack/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/op-stack/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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "2.9.2",
+  "version": "2.9.4",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",
@@ -33,9 +33,9 @@
       "default": "./_cjs/actions/index.js"
     },
     "./celo": {
-      "types": "./_types/chains/celo/index.d.ts",
-      "import": "./_esm/chains/celo/index.js",
-      "default": "./_cjs/chains/celo/index.js"
+      "types": "./_types/celo/index.d.ts",
+      "import": "./_esm/celo/index.js",
+      "default": "./_cjs/celo/index.js"
     },
     "./chains": {
       "types": "./_types/chains/index.d.ts",
@@ -58,9 +58,9 @@
       "default": "./_cjs/node/index.js"
     },
     "./op-stack": {
-      "types": "./_types/chains/opStack/index.d.ts",
-      "import": "./_esm/chains/opStack/index.js",
-      "default": "./_cjs/chains/opStack/index.js"
+      "types": "./_types/op-stack/index.d.ts",
+      "import": "./_esm/op-stack/index.js",
+      "default": "./_cjs/op-stack/index.js"
     },
     "./utils": {
       "types": "./_types/utils/index.d.ts",
@@ -73,9 +73,9 @@
       "default": "./_cjs/window/index.js"
     },
     "./zksync": {
-      "types": "./_types/chains/zksync/index.d.ts",
-      "import": "./_esm/chains/zksync/index.js",
-      "default": "./_cjs/chains/zksync/index.js"
+      "types": "./_types/zksync/index.d.ts",
+      "import": "./_esm/zksync/index.js",
+      "default": "./_cjs/zksync/index.js"
     },
     "./package.json": "./package.json"
   },
@@ -88,7 +88,7 @@
         "./_types/actions/index.d.ts"
       ],
       "celo": [
-        "./_types/chains/celo/index.d.ts"
+        "./_types/celo/index.d.ts"
       ],
       "chains": [
         "./_types/chains/index.d.ts"
@@ -103,7 +103,7 @@
         "./_types/node/index.d.ts"
       ],
       "op-stack": [
-        "./_types/chains/opStack/index.d.ts"
+        "./_types/op-stack/index.d.ts"
       ],
       "utils": [
         "./_types/utils/index.d.ts"
@@ -112,7 +112,7 @@
         "./_types/window/index.d.ts"
       ],
       "zksync": [
-        "./_types/chains/zksync/index.d.ts"
+        "./_types/zksync/index.d.ts"
       ]
     }
   },