viem 2.9.2 → 2.9.3

package/op-stack/actions/buildProveWithdrawal.ts

@@ -0,0 +1,180 @@
+import type { Address } from 'abitype'
+import {
+  type GetBlockErrorType,
+  getBlock,
+} from '../../actions/public/getBlock.js'
+import {
+  type GetProofErrorType,
+  getProof,
+} from '../../actions/public/getProof.js'
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { ErrorType } from '../../errors/utils.js'
+import type {
+  Account,
+  DeriveAccount,
+  GetAccountParameter,
+} from '../../types/account.js'
+import type {
+  Chain,
+  DeriveChain,
+  GetChainParameter,
+} from '../../types/chain.js'
+import { type Hex } from '../../types/misc.js'
+import type { OneOf, Prettify } from '../../types/utils.js'
+import { fromRlp } from '../../utils/encoding/fromRlp.js'
+import { toRlp } from '../../utils/encoding/toRlp.js'
+import { keccak256 } from '../../utils/hash/keccak256.js'
+import { contracts } from '../contracts.js'
+import type { Withdrawal } from '../types/withdrawal.js'
+import {
+  type GetWithdrawalHashStorageSlotErrorType,
+  getWithdrawalHashStorageSlot,
+} from '../utils/getWithdrawalHashStorageSlot.js'
+import { type GetGameReturnType } from './getGame.js'
+import type { GetL2OutputReturnType } from './getL2Output.js'
+import type { ProveWithdrawalParameters } from './proveWithdrawal.js'
+
+const outputRootProofVersion =
+  '0x0000000000000000000000000000000000000000000000000000000000000000' as const
+
+export type BuildProveWithdrawalParameters<
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = Account | undefined,
+  chainOverride extends Chain | undefined = Chain | undefined,
+  accountOverride extends Account | Address | undefined =
+    | Account
+    | Address
+    | undefined,
+  _derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>,
+> = GetAccountParameter<account, accountOverride, false> &
+  GetChainParameter<chain, chainOverride> & {
+    withdrawal: Withdrawal
+  } & OneOf<{ output: GetL2OutputReturnType } | { game: GetGameReturnType }>
+
+export type BuildProveWithdrawalReturnType<
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = Account | undefined,
+  chainOverride extends Chain | undefined = Chain | undefined,
+  accountOverride extends Account | Address | undefined =
+    | Account
+    | Address
+    | undefined,
+> = Prettify<
+  Pick<
+    ProveWithdrawalParameters,
+    'l2OutputIndex' | 'outputRootProof' | 'withdrawalProof' | 'withdrawal'
+  > & {
+    account: DeriveAccount<account, accountOverride>
+    targetChain: DeriveChain<chain, chainOverride>
+  }
+>
+
+export type BuildProveWithdrawalErrorType =
+  | GetBlockErrorType
+  | GetProofErrorType
+  | GetWithdrawalHashStorageSlotErrorType
+  | ErrorType
+
+/**
+ * Builds the transaction that proves a withdrawal was initiated on an L2. Used in the Withdrawal flow.
+ *
+ * - Docs: https://viem.sh/op-stack/actions/buildProveWithdrawal
+ *
+ * @param client - Client to use
+ * @param parameters - {@link BuildProveWithdrawalParameters}
+ * @returns The prove withdraw transaction request. {@link BuildProveWithdrawalReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { optimism } from 'viem/chains'
+ * import { buildProveWithdrawal } from 'viem/op-stack'
+ *
+ * const publicClientL2 = createPublicClient({
+ *   chain: optimism,
+ *   transport: http(),
+ * })
+ *
+ * const args = await buildProveWithdrawal(publicClientL2, {
+ *   output: { ... },
+ *   withdrawal: { ... },
+ * })
+ */
+export async function buildProveWithdrawal<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+  chainOverride extends Chain | undefined = undefined,
+  accountOverride extends Account | Address | undefined = undefined,
+>(
+  client: Client<Transport, chain, account>,
+  args: BuildProveWithdrawalParameters<
+    chain,
+    account,
+    chainOverride,
+    accountOverride
+  >,
+): Promise<
+  BuildProveWithdrawalReturnType<chain, account, chainOverride, accountOverride>
+> {
+  const { account, chain = client.chain, game, output, withdrawal } = args
+
+  const { withdrawalHash } = withdrawal
+  const { l2BlockNumber } = game ?? output
+
+  const slot = getWithdrawalHashStorageSlot({ withdrawalHash })
+  const [proof, block] = await Promise.all([
+    getProof(client, {
+      address: contracts.l2ToL1MessagePasser.address,
+      storageKeys: [slot],
+      blockNumber: l2BlockNumber,
+    }),
+    getBlock(client, {
+      blockNumber: l2BlockNumber,
+    }),
+  ])
+
+  return {
+    account,
+    l2OutputIndex: game?.index ?? output?.outputIndex,
+    outputRootProof: {
+      latestBlockhash: block.hash,
+      messagePasserStorageRoot: proof.storageHash,
+      stateRoot: block.stateRoot,
+      version: outputRootProofVersion,
+    },
+    targetChain: chain,
+    withdrawalProof: maybeAddProofNode(
+      keccak256(slot),
+      proof.storageProof[0].proof,
+    ),
+    withdrawal,
+  } as unknown as BuildProveWithdrawalReturnType<
+    chain,
+    account,
+    chainOverride,
+    accountOverride
+  >
+}
+
+export function maybeAddProofNode(key: string, proof: readonly Hex[]) {
+  const lastProofRlp = proof[proof.length - 1]
+  const lastProof = fromRlp(lastProofRlp)
+  if (lastProof.length !== 17) return proof
+
+  const modifiedProof = [...proof]
+  for (const item of lastProof) {
+    // Find any nodes located inside of the branch node.
+    if (!Array.isArray(item)) continue
+    // Check if the key inside the node matches the key we're looking for. We remove the first
+    // two characters (0x) and then we remove one more character (the first nibble) since this
+    // is the identifier for the type of node we're looking at. In this case we don't actually
+    // care what type of node it is because a branch node would only ever be the final proof
+    // element if (1) it includes the leaf node we're looking for or (2) it stores the value
+    // within itself. If (1) then this logic will work, if (2) then this won't find anything
+    // and we won't append any proof elements, which is exactly what we would want.
+    const suffix = item[0].slice(3)
+    if (typeof suffix !== 'string' || !key.endsWith(suffix)) continue
+    modifiedProof.push(toRlp(item))
+  }
+  return modifiedProof
+}

package/op-stack/actions/depositTransaction.ts

@@ -0,0 +1,177 @@
+import type { Address } from 'abitype'
+import {
+  type WriteContractErrorType,
+  type WriteContractParameters,
+  writeContract,
+} from '../../actions/wallet/writeContract.js'
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import { zeroAddress } from '../../constants/address.js'
+import type { ErrorType } from '../../errors/utils.js'
+import type { Account, GetAccountParameter } from '../../types/account.js'
+import type {
+  Chain,
+  DeriveChain,
+  GetChainParameter,
+} from '../../types/chain.js'
+import type { Hash } from '../../types/misc.js'
+import type { UnionEvaluate, UnionOmit } from '../../types/utils.js'
+import type { FormattedTransactionRequest } from '../../utils/formatters/transactionRequest.js'
+import { portalAbi } from '../abis.js'
+import type { GetContractAddressParameter } from '../types/contract.js'
+import type { DepositRequest } from '../types/deposit.js'
+import {
+  type EstimateDepositTransactionGasErrorType,
+  type EstimateDepositTransactionGasParameters,
+  estimateDepositTransactionGas,
+} from './estimateDepositTransactionGas.js'
+
+export type DepositTransactionParameters<
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = Account | undefined,
+  chainOverride extends Chain | undefined = Chain | undefined,
+  _derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>,
+> = UnionEvaluate<
+  UnionOmit<
+    FormattedTransactionRequest<_derivedChain>,
+    | 'accessList'
+    | 'data'
+    | 'from'
+    | 'gas'
+    | 'gasPrice'
+    | 'to'
+    | 'type'
+    | 'value'
+  >
+> &
+  GetAccountParameter<account, Account | Address> &
+  GetChainParameter<chain, chainOverride> &
+  GetContractAddressParameter<_derivedChain, 'portal'> & {
+    /** L2 transaction request. */
+    request: DepositRequest
+    /**
+     * Gas limit for transaction execution on the L1.
+     * `null` to skip gas estimation & defer calculation to signer.
+     */
+    gas?: bigint | null | undefined
+  }
+export type DepositTransactionReturnType = Hash
+export type DepositTransactionErrorType =
+  | EstimateDepositTransactionGasErrorType
+  | WriteContractErrorType
+  | ErrorType
+
+/**
+ * Initiates a [deposit transaction](https://github.com/ethereum-optimism/optimism/blob/develop/specs/deposits.md) on an L1, which executes a transaction on L2.
+ *
+ * Internally performs a contract write to the [`depositTransaction` function](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/L1/OptimismPortal.sol#L378)
+ * on the [Optimism Portal contract](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/L1/OptimismPortal.sol).
+ *
+ * - Docs: https://viem.sh/op-stack/actions/depositTransaction
+ *
+ * @param client - Client to use
+ * @param parameters - {@link DepositTransactionParameters}
+ * @returns The L1 transaction hash. {@link DepositTransactionReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom, parseEther } from 'viem'
+ * import { base, mainnet } from 'viem/chains'
+ * import { depositTransaction } from 'viem/op-stack'
+ *
+ * const client = createWalletClient({
+ *   chain: mainnet,
+ *   transport: custom(window.ethereum),
+ * })
+ *
+ * const hash = await depositTransaction(client, {
+ *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ *   request: {
+ *     gas: 21_000n,
+ *     to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *     value: parseEther('1'),
+ *   },
+ *   targetChain: base,
+ * })
+ *
+ * @example
+ * // Account Hoisting
+ * import { createWalletClient, http } from 'viem'
+ * import { privateKeyToAccount } from 'viem/accounts'
+ * import { base, mainnet } from 'viem/chains'
+ * import { depositTransaction } from 'viem/op-stack'
+ *
+ * const client = createWalletClient({
+ *   account: privateKeyToAccount('0x…'),
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ *
+ * const hash = await depositTransaction(client, {
+ *   request: {
+ *     gas: 21_000n,
+ *     to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *     value: parseEther('1'),
+ *   },
+ *   targetChain: base,
+ * })
+ */
+export async function depositTransaction<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+  chainOverride extends Chain | undefined = undefined,
+>(
+  client: Client<Transport, chain, account>,
+  parameters: DepositTransactionParameters<chain, account, chainOverride>,
+) {
+  const {
+    account,
+    chain = client.chain,
+    gas,
+    maxFeePerGas,
+    maxPriorityFeePerGas,
+    nonce,
+    request: {
+      data = '0x',
+      gas: l2Gas,
+      isCreation = false,
+      mint,
+      to = '0x',
+      value,
+    },
+    targetChain,
+  } = parameters
+
+  const portalAddress = (() => {
+    if (parameters.portalAddress) return parameters.portalAddress
+    if (chain) return targetChain!.contracts.portal[chain.id].address
+    return Object.values(targetChain!.contracts.portal)[0].address
+  })()
+
+  const gas_ =
+    typeof gas !== 'number' && gas !== null
+      ? await estimateDepositTransactionGas(
+          client,
+          parameters as EstimateDepositTransactionGasParameters,
+        )
+      : undefined
+
+  return writeContract(client, {
+    account: account!,
+    abi: portalAbi,
+    address: portalAddress,
+    chain,
+    functionName: 'depositTransaction',
+    args: [
+      isCreation ? zeroAddress : to,
+      value ?? mint ?? 0n,
+      l2Gas,
+      isCreation,
+      data,
+    ],
+    maxFeePerGas,
+    maxPriorityFeePerGas,
+    nonce,
+    value: mint,
+    gas: gas_,
+  } satisfies WriteContractParameters as any)
+}

package/op-stack/actions/estimateContractL1Fee.ts

@@ -0,0 +1,142 @@
+import type { Abi } from 'abitype'
+
+import type { Account } from '../../accounts/types.js'
+import {
+  type ParseAccountErrorType,
+  parseAccount,
+} from '../../accounts/utils/parseAccount.js'
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { BaseError } from '../../errors/base.js'
+import type { Chain } from '../../types/chain.js'
+import type {
+  ContractFunctionArgs,
+  ContractFunctionName,
+  ContractFunctionParameters,
+  GetValue,
+} from '../../types/contract.js'
+import type { UnionOmit } from '../../types/utils.js'
+import {
+  type EncodeFunctionDataErrorType,
+  type EncodeFunctionDataParameters,
+  encodeFunctionData,
+} from '../../utils/abi/encodeFunctionData.js'
+import {
+  type GetContractErrorReturnType,
+  getContractError,
+} from '../../utils/errors/getContractError.js'
+import {
+  type EstimateL1FeeErrorType,
+  type EstimateL1FeeParameters,
+  estimateL1Fee,
+} from './estimateL1Fee.js'
+
+export type EstimateContractL1FeeParameters<
+  abi extends Abi | readonly unknown[] = Abi,
+  functionName extends ContractFunctionName<
+    abi,
+    'nonpayable' | 'payable'
+  > = ContractFunctionName<abi, 'nonpayable' | 'payable'>,
+  args extends ContractFunctionArgs<
+    abi,
+    'nonpayable' | 'payable',
+    functionName
+  > = ContractFunctionArgs<abi, 'nonpayable' | 'payable', functionName>,
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = undefined,
+  chainOverride extends Chain | undefined = Chain | undefined,
+> = ContractFunctionParameters<
+  abi,
+  'nonpayable' | 'payable',
+  functionName,
+  args
+> &
+  UnionOmit<
+    EstimateL1FeeParameters<chain, account, chainOverride>,
+    'data' | 'to' | 'value'
+  > &
+  GetValue<
+    abi,
+    functionName,
+    EstimateL1FeeParameters<
+      chain,
+      account,
+      chainOverride
+    > extends EstimateL1FeeParameters
+      ? EstimateL1FeeParameters<chain, account, chainOverride>['value']
+      : EstimateL1FeeParameters['value']
+  >
+
+export type EstimateContractL1FeeReturnType = bigint
+
+export type EstimateContractL1FeeErrorType = GetContractErrorReturnType<
+  EncodeFunctionDataErrorType | EstimateL1FeeErrorType | ParseAccountErrorType
+>
+
+/**
+ * Estimates the L1 data fee required to execute an L2 contract write.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link EstimateContractL1FeeParameters}
+ * @returns The gas estimate (in wei). {@link EstimateContractL1FeeReturnType}
+ *
+ * @example
+ * import { createPublicClient, http, parseAbi } from 'viem'
+ * import { optimism } from 'viem/chains'
+ * import { estimateContractL1Fee } from 'viem/op-stack'
+ *
+ * const client = createPublicClient({
+ *   chain: optimism,
+ *   transport: http(),
+ * })
+ * const l1Fee = await estimateContractL1Fee(client, {
+ *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+ *   abi: parseAbi(['function mint() public']),
+ *   functionName: 'mint',
+ *   account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+ * })
+ */
+export async function estimateContractL1Fee<
+  const abi extends Abi | readonly unknown[],
+  functionName extends ContractFunctionName<abi, 'nonpayable' | 'payable'>,
+  args extends ContractFunctionArgs<abi, 'pure' | 'view', functionName>,
+  chain extends Chain | undefined,
+  account extends Account | undefined = undefined,
+  chainOverride extends Chain | undefined = undefined,
+>(
+  client: Client<Transport, chain, account>,
+  parameters: EstimateContractL1FeeParameters<
+    abi,
+    functionName,
+    args,
+    chain,
+    account,
+    chainOverride
+  >,
+): Promise<EstimateContractL1FeeReturnType> {
+  const { abi, address, args, functionName, ...request } =
+    parameters as EstimateContractL1FeeParameters
+  const data = encodeFunctionData({
+    abi,
+    args,
+    functionName,
+  } as EncodeFunctionDataParameters)
+  try {
+    const fee = await estimateL1Fee(client, {
+      data,
+      to: address,
+      ...request,
+    } as unknown as EstimateL1FeeParameters)
+    return fee
+  } catch (error) {
+    const account = request.account ? parseAccount(request.account) : undefined
+    throw getContractError(error as BaseError, {
+      abi,
+      address,
+      args,
+      docsPath: '/docs/chains/op-stack/estimateContractL1Fee',
+      functionName,
+      sender: account?.address,
+    })
+  }
+}

package/op-stack/actions/estimateContractL1Gas.ts

@@ -0,0 +1,142 @@
+import type { Abi } from 'abitype'
+
+import type { Account } from '../../accounts/types.js'
+import {
+  type ParseAccountErrorType,
+  parseAccount,
+} from '../../accounts/utils/parseAccount.js'
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { BaseError } from '../../errors/base.js'
+import type { Chain } from '../../types/chain.js'
+import type {
+  ContractFunctionArgs,
+  ContractFunctionName,
+  ContractFunctionParameters,
+  GetValue,
+} from '../../types/contract.js'
+import type { UnionOmit } from '../../types/utils.js'
+import {
+  type EncodeFunctionDataErrorType,
+  type EncodeFunctionDataParameters,
+  encodeFunctionData,
+} from '../../utils/abi/encodeFunctionData.js'
+import {
+  type GetContractErrorReturnType,
+  getContractError,
+} from '../../utils/errors/getContractError.js'
+import {
+  type EstimateL1GasErrorType,
+  type EstimateL1GasParameters,
+  estimateL1Gas,
+} from './estimateL1Gas.js'
+
+export type EstimateContractL1GasParameters<
+  abi extends Abi | readonly unknown[] = Abi,
+  functionName extends ContractFunctionName<
+    abi,
+    'nonpayable' | 'payable'
+  > = ContractFunctionName<abi, 'nonpayable' | 'payable'>,
+  args extends ContractFunctionArgs<
+    abi,
+    'nonpayable' | 'payable',
+    functionName
+  > = ContractFunctionArgs<abi, 'nonpayable' | 'payable', functionName>,
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = undefined,
+  chainOverride extends Chain | undefined = Chain | undefined,
+> = ContractFunctionParameters<
+  abi,
+  'nonpayable' | 'payable',
+  functionName,
+  args
+> &
+  UnionOmit<
+    EstimateL1GasParameters<chain, account, chainOverride>,
+    'data' | 'to' | 'value'
+  > &
+  GetValue<
+    abi,
+    functionName,
+    EstimateL1GasParameters<
+      chain,
+      account,
+      chainOverride
+    > extends EstimateL1GasParameters
+      ? EstimateL1GasParameters<chain, account, chainOverride>['value']
+      : EstimateL1GasParameters['value']
+  >
+
+export type EstimateContractL1GasReturnType = bigint
+
+export type EstimateContractL1GasErrorType = GetContractErrorReturnType<
+  EncodeFunctionDataErrorType | EstimateL1GasErrorType | ParseAccountErrorType
+>
+
+/**
+ * Estimates the L1 data gas required to successfully execute a contract write function call.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link EstimateContractL1GasParameters}
+ * @returns The gas estimate (in wei). {@link EstimateContractL1GasReturnType}
+ *
+ * @example
+ * import { createPublicClient, http, parseAbi } from 'viem'
+ * import { optimism } from 'viem/chains'
+ * import { estimateContractL1Gas } from 'viem/op-stack'
+ *
+ * const client = createPublicClient({
+ *   chain: optimism,
+ *   transport: http(),
+ * })
+ * const l1Gas = await estimateContractL1Gas(client, {
+ *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+ *   abi: parseAbi(['function mint() public']),
+ *   functionName: 'mint',
+ *   account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+ * })
+ */
+export async function estimateContractL1Gas<
+  const abi extends Abi | readonly unknown[],
+  functionName extends ContractFunctionName<abi, 'nonpayable' | 'payable'>,
+  args extends ContractFunctionArgs<abi, 'pure' | 'view', functionName>,
+  chain extends Chain | undefined,
+  account extends Account | undefined = undefined,
+  chainOverride extends Chain | undefined = undefined,
+>(
+  client: Client<Transport, chain, account>,
+  parameters: EstimateContractL1GasParameters<
+    abi,
+    functionName,
+    args,
+    chain,
+    account,
+    chainOverride
+  >,
+): Promise<EstimateContractL1GasReturnType> {
+  const { abi, address, args, functionName, ...request } =
+    parameters as EstimateContractL1GasParameters
+  const data = encodeFunctionData({
+    abi,
+    args,
+    functionName,
+  } as EncodeFunctionDataParameters)
+  try {
+    const gas = await estimateL1Gas(client, {
+      data,
+      to: address,
+      ...request,
+    } as unknown as EstimateL1GasParameters)
+    return gas
+  } catch (error) {
+    const account = request.account ? parseAccount(request.account) : undefined
+    throw getContractError(error as BaseError, {
+      abi,
+      address,
+      args,
+      docsPath: '/docs/chains/op-stack/estimateContractL1Gas',
+      functionName,
+      sender: account?.address,
+    })
+  }
+}