viem 2.0.0-beta.9 → 2.0.0-rc.0

package/chains/opStack/actions/buildDepositTransaction.ts

@@ -11,7 +11,11 @@ import {
 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, GetAccountParameter } from '../../../types/account.js'
+import type {
+  Account,
+  DeriveAccount,
+  GetAccountParameter,
+} from '../../../types/account.js'
 import type {
   Chain,
   DeriveChain,
@@ -64,8 +68,9 @@ export type BuildDepositTransactionReturnType<
     | Address
     | undefined,
 > = Prettify<
-  UnionOmit<DepositTransactionParameters<Chain, account, Chain>, 'account'> &
-    GetAccountParameter<account, accountOverride>
+  UnionOmit<DepositTransactionParameters<Chain, account, Chain>, 'account'> & {
+    account: DeriveAccount<account, accountOverride>
+  }
 >
 
 export type BuildDepositTransactionErrorType =
@@ -93,7 +98,7 @@ export type BuildDepositTransactionErrorType =
  *   transport: http(),
  * }).extend(publicActionsL2())
  *
- * const request = await buildDepositTransaction(client, {
+ * const args = await buildDepositTransaction(client, {
  *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
  *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  *   value: parseEther('1'),
@@ -138,7 +143,7 @@ export async function buildDepositTransaction<
 
   return {
     account,
-    args: {
+    request: {
       data: request.data,
       gas: request.gas,
       mint,
@@ -147,5 +152,5 @@ export async function buildDepositTransaction<
       value: request.value,
     },
     targetChain: chain,
-  } as BuildDepositTransactionReturnType<account, accountOverride>
+  } as unknown as BuildDepositTransactionReturnType<account, accountOverride>
 }

package/chains/opStack/actions/buildInitiateWithdrawal.ts

@@ -0,0 +1,118 @@
+import type { Address } from 'abitype'
+import {
+  type ParseAccountErrorType,
+  parseAccount,
+} from '../../../accounts/utils/parseAccount.js'
+import {
+  type PrepareTransactionRequestErrorType,
+  type PrepareTransactionRequestParameters,
+  prepareTransactionRequest,
+} from '../../../actions/wallet/prepareTransactionRequest.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, GetAccountParameter } from '../../../types/account.js'
+import type { Chain, GetChainParameter } from '../../../types/chain.js'
+import type { Hex } from '../../../types/misc.js'
+import type { Prettify, UnionOmit } from '../../../types/utils.js'
+import type { InitiateWithdrawalParameters } from './initiateWithdrawal.js'
+
+export type BuildInitiateWithdrawalParameters<
+  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,
+> = GetAccountParameter<account, accountOverride, false> &
+  GetChainParameter<chain, chainOverride> & {
+    /** 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 BuildInitiateWithdrawalReturnType<
+  account extends Account | undefined = Account | undefined,
+  accountOverride extends Account | Address | undefined =
+    | Account
+    | Address
+    | undefined,
+> = Prettify<
+  UnionOmit<InitiateWithdrawalParameters<Chain, account, Chain>, 'account'> &
+    GetAccountParameter<account, accountOverride>
+>
+
+export type BuildInitiateWithdrawalErrorType =
+  | ParseAccountErrorType
+  | PrepareTransactionRequestErrorType
+  | ErrorType
+
+/**
+ * Prepares parameters for a [withdrawal](https://community.optimism.io/docs/protocol/withdrawal-flow/#withdrawal-initiating-transaction) from an L2 to the L1.
+ *
+ * - Docs: https://viem.sh/op-stack/actions/buildInitiateWithdrawal.html
+ *
+ * @param client - Client to use
+ * @param parameters - {@link BuildInitiateWithdrawalParameters}
+ * @returns Parameters for `depositTransaction`. {@link DepositTransactionReturnType}
+ *
+ * @example
+ * import { createPublicClient, http, parseEther } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { buildInitiateWithdrawal } from 'viem/wallet'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ *
+ * const args = await buildInitiateWithdrawal(client, {
+ *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *   value: parseEther('1'),
+ * })
+ */
+export async function buildInitiateWithdrawal<
+  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: BuildInitiateWithdrawalParameters<
+    chain,
+    account,
+    chainOverride,
+    accountOverride
+  >,
+): Promise<BuildInitiateWithdrawalReturnType<account, accountOverride>> {
+  const { account: account_, chain = client.chain, gas, data, to, value } = args
+
+  const account = account_ ? parseAccount(account_) : undefined
+
+  const request = await prepareTransactionRequest(client, {
+    account,
+    chain,
+    gas,
+    data,
+    parameters: ['gas'],
+    to,
+    value,
+  } as PrepareTransactionRequestParameters)
+
+  return {
+    account,
+    request: {
+      data: request.data,
+      gas: request.gas,
+      to: request.to,
+      value: request.value,
+    },
+  } as BuildInitiateWithdrawalReturnType<account, accountOverride>
+}

package/chains/opStack/actions/buildProveWithdrawal.ts

@@ -0,0 +1,149 @@
+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 { Prettify } from '../../../types/utils.js'
+import { contracts } from '../contracts.js'
+import type { Withdrawal } from '../types/withdrawal.js'
+import {
+  type GetWithdrawalHashStorageSlotErrorType,
+  getWithdrawalHashStorageSlot,
+} from '../utils/getWithdrawalHashStorageSlot.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
+    output: GetL2OutputReturnType
+  }
+
+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.html
+ *
+ * @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, output, withdrawal } = args
+  const { withdrawalHash } = withdrawal
+  const { l2BlockNumber } = 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: output.outputIndex,
+    outputRootProof: {
+      latestBlockhash: block.hash,
+      messagePasserStorageRoot: proof.storageHash,
+      stateRoot: block.stateRoot,
+      version: outputRootProofVersion,
+    },
+    targetChain: chain,
+    withdrawalProof: proof.storageProof[0].proof,
+    withdrawal,
+  } as unknown as BuildProveWithdrawalReturnType<
+    chain,
+    account,
+    chainOverride,
+    accountOverride
+  >
+}

package/chains/opStack/actions/depositTransaction.ts

@@ -1,6 +1,7 @@
 import type { Address } from 'abitype'
 import {
   type WriteContractErrorType,
+  type WriteContractParameters,
   writeContract,
 } from '../../../actions/wallet/writeContract.js'
 import type { Client } from '../../../clients/createClient.js'
@@ -13,11 +14,17 @@ import type {
   DeriveChain,
   GetChainParameter,
 } from '../../../types/chain.js'
-import type { Hash, Hex } from '../../../types/misc.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,
@@ -40,35 +47,19 @@ export type DepositTransactionParameters<
   GetAccountParameter<account, Account | Address> &
   GetChainParameter<chain, chainOverride> &
   GetContractAddressParameter<_derivedChain, 'portal'> & {
-    /** Arguments supplied to the L2 transaction. */
-    args: {
-      /** 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
-        }
-    )
+    /** 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
   }
 export type DepositTransactionReturnType = Hash
-export type DepositTransactionErrorType = WriteContractErrorType | ErrorType
+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.
@@ -85,17 +76,16 @@ export type DepositTransactionErrorType = WriteContractErrorType | ErrorType
  * @example
  * import { createWalletClient, custom, parseEther } from 'viem'
  * import { base, mainnet } from 'viem/chains'
- * import { walletActionsL1 } from 'viem/op-stack'
- * import { depositTransaction } from 'viem/wallet'
+ * import { depositTransaction } from 'viem/op-stack'
  *
  * const client = createWalletClient({
  *   chain: mainnet,
  *   transport: custom(window.ethereum),
- * }).extend(walletActionsL1())
+ * })
  *
  * const hash = await depositTransaction(client, {
  *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
- *   args: {
+ *   request: {
  *     gas: 21_000n,
  *     to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  *     value: parseEther('1'),
@@ -108,17 +98,16 @@ export type DepositTransactionErrorType = WriteContractErrorType | ErrorType
  * import { createWalletClient, http } from 'viem'
  * import { privateKeyToAccount } from 'viem/accounts'
  * import { base, mainnet } from 'viem/chains'
- * import { walletActionsL1 } from 'viem/op-stack'
- * import { depositTransaction } from 'viem/wallet'
+ * import { depositTransaction } from 'viem/op-stack'
  *
  * const client = createWalletClient({
  *   account: privateKeyToAccount('0x…'),
  *   chain: mainnet,
  *   transport: http(),
- * }).extend(walletActionsL1())
+ * })
  *
  * const hash = await depositTransaction(client, {
- *   args: {
+ *   request: {
  *     gas: 21_000n,
  *     to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  *     value: parseEther('1'),
@@ -126,32 +115,48 @@ export type DepositTransactionErrorType = WriteContractErrorType | ErrorType
  *   targetChain: base,
  * })
  */
-export function depositTransaction<
+export async function depositTransaction<
   chain extends Chain | undefined,
   account extends Account | undefined,
   chainOverride extends Chain | undefined = undefined,
 >(
   client: Client<Transport, chain, account>,
-  args: DepositTransactionParameters<chain, account, chainOverride>,
+  parameters: DepositTransactionParameters<chain, account, chainOverride>,
 ) {
   const {
     account,
-    args: { data = '0x', gas, isCreation = false, mint, to = '0x', value },
     chain = client.chain,
+    gas,
     maxFeePerGas,
     maxPriorityFeePerGas,
     nonce,
+    request: {
+      data = '0x',
+      gas: l2Gas,
+      isCreation = false,
+      mint,
+      to = '0x',
+      value,
+    },
     targetChain,
-  } = args
+  } = parameters
 
   const portalAddress = (() => {
-    if (args.portalAddress) return args.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: account!,
     abi: portalAbi,
     address: portalAddress,
     chain,
@@ -159,7 +164,7 @@ export function depositTransaction<
     args: [
       isCreation ? zeroAddress : to,
       value ?? mint ?? 0n,
-      gas,
+      l2Gas,
       isCreation,
       data,
     ],
@@ -167,5 +172,6 @@ export function depositTransaction<
     maxPriorityFeePerGas,
     nonce,
     value: mint,
-  } as any)
+    gas: gas_,
+  } satisfies WriteContractParameters as any)
 }

package/chains/opStack/actions/estimateDepositTransactionGas.ts

@@ -0,0 +1,138 @@
+import type { Address } from 'abitype'
+import {
+  type EstimateContractGasErrorType,
+  type EstimateContractGasParameters,
+  estimateContractGas,
+} from '../../../actions/public/estimateContractGas.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 { 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'
+
+export type EstimateDepositTransactionGasParameters<
+  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. */
+    gas?: bigint | null
+  }
+export type EstimateDepositTransactionGasReturnType = bigint
+export type EstimateDepositTransactionGasErrorType =
+  | EstimateContractGasErrorType
+  | ErrorType
+
+/**
+ * Estimates gas required to initiate a [deposit transaction](https://github.com/ethereum-optimism/optimism/blob/develop/specs/deposits.md) on an L1, which executes a transaction on L2.
+ *
+ * - Docs: https://viem.sh/op-stack/actions/estimateDepositTransactionGas.html
+ *
+ * @param client - Client to use
+ * @param parameters - {@link EstimateDepositTransactionGasParameters}
+ * @returns The L1 transaction hash. {@link EstimateDepositTransactionGasReturnType}
+ *
+ * @example
+ * import { createPublicClient, custom, parseEther } from 'viem'
+ * import { base, mainnet } from 'viem/chains'
+ * import { estimateDepositTransactionGas } from 'viem/op-stack'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: custom(window.ethereum),
+ * })
+ *
+ * const gas = await estimateDepositTransactionGas(client, {
+ *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ *   args: {
+ *     gas: 21_000n,
+ *     to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *     value: parseEther('1'),
+ *   },
+ *   targetChain: base,
+ * })
+ */
+export async function estimateDepositTransactionGas<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+  chainOverride extends Chain | undefined = undefined,
+>(
+  client: Client<Transport, chain, account>,
+  parameters: EstimateDepositTransactionGasParameters<
+    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
+  })()
+
+  return estimateContractGas(client, {
+    account,
+    abi: portalAbi,
+    address: portalAddress,
+    chain,
+    functionName: 'depositTransaction',
+    args: [
+      isCreation ? zeroAddress : to,
+      value ?? mint ?? 0n,
+      l2Gas,
+      isCreation,
+      data,
+    ],
+    gas,
+    maxFeePerGas,
+    maxPriorityFeePerGas,
+    nonce,
+    value: mint,
+  } as EstimateContractGasParameters)
+}