viem 2.0.0-beta.0 → 2.0.0-beta.10

package/chains/opStack/actions/depositTransaction.ts

@@ -0,0 +1,171 @@
+import type { Address } from 'abitype'
+import {
+  type WriteContractErrorType,
+  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, Hex } 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'
+
+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'> & {
+    /** 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
+        }
+    )
+  }
+export type DepositTransactionReturnType = Hash
+export type DepositTransactionErrorType = 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.html
+ *
+ * @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 { walletActionsL1 } from 'viem/op-stack'
+ * import { depositTransaction } from 'viem/wallet'
+ *
+ * const client = createWalletClient({
+ *   chain: mainnet,
+ *   transport: custom(window.ethereum),
+ * }).extend(walletActionsL1())
+ *
+ * const hash = await depositTransaction(client, {
+ *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ *   args: {
+ *     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 { walletActionsL1 } from 'viem/op-stack'
+ * import { depositTransaction } from 'viem/wallet'
+ *
+ * const client = createWalletClient({
+ *   account: privateKeyToAccount('0x…'),
+ *   chain: mainnet,
+ *   transport: http(),
+ * }).extend(walletActionsL1())
+ *
+ * const hash = await depositTransaction(client, {
+ *   args: {
+ *     gas: 21_000n,
+ *     to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *     value: parseEther('1'),
+ *   },
+ *   targetChain: base,
+ * })
+ */
+export 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>,
+) {
+  const {
+    account,
+    args: { data = '0x', gas, isCreation = false, mint, to = '0x', value },
+    chain = client.chain,
+    maxFeePerGas,
+    maxPriorityFeePerGas,
+    nonce,
+    targetChain,
+  } = args
+
+  const portalAddress = (() => {
+    if (args.portalAddress) return args.portalAddress
+    if (chain) return targetChain!.contracts.portal[chain.id].address
+    return Object.values(targetChain!.contracts.portal)[0].address
+  })()
+
+  return writeContract(client, {
+    account,
+    abi: portalAbi,
+    address: portalAddress,
+    chain,
+    functionName: 'depositTransaction',
+    args: [
+      isCreation ? zeroAddress : to,
+      value ?? mint ?? 0n,
+      gas,
+      isCreation,
+      data,
+    ],
+    maxFeePerGas,
+    maxPriorityFeePerGas,
+    nonce,
+    value: mint,
+  } as any)
+}

package/chains/opStack/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/chains/opStack/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,
+    })
+  }
+}

package/chains/opStack/actions/estimateContractTotalFee.ts

@@ -0,0 +1,144 @@
+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 EstimateTotalFeeErrorType,
+  type EstimateTotalFeeParameters,
+  estimateTotalFee,
+} from './estimateTotalFee.js'
+
+export type EstimateContractTotalFeeParameters<
+  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<
+    EstimateTotalFeeParameters<chain, account, chainOverride>,
+    'data' | 'to' | 'value'
+  > &
+  GetValue<
+    abi,
+    functionName,
+    EstimateTotalFeeParameters<
+      chain,
+      account,
+      chainOverride
+    > extends EstimateTotalFeeParameters
+      ? EstimateTotalFeeParameters<chain, account, chainOverride>['value']
+      : EstimateTotalFeeParameters['value']
+  >
+
+export type EstimateContractTotalFeeReturnType = bigint
+
+export type EstimateContractTotalFeeErrorType = GetContractErrorReturnType<
+  | EncodeFunctionDataErrorType
+  | EstimateTotalFeeErrorType
+  | ParseAccountErrorType
+>
+
+/**
+ * Estimates the L1 data fee + L2 fee to execute an L2 contract write.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link EstimateContractTotalFeeParameters}
+ * @returns The gas estimate (in wei). {@link EstimateContractTotalFeeReturnType}
+ *
+ * @example
+ * import { createPublicClient, http, parseAbi } from 'viem'
+ * import { optimism } from 'viem/chains'
+ * import { estimateContractTotalFee } from 'viem/op-stack'
+ *
+ * const client = createPublicClient({
+ *   chain: optimism,
+ *   transport: http(),
+ * })
+ * const totalFee = await estimateContractTotalFee(client, {
+ *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+ *   abi: parseAbi(['function mint() public']),
+ *   functionName: 'mint',
+ *   account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+ * })
+ */
+export async function estimateContractTotalFee<
+  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: EstimateContractTotalFeeParameters<
+    abi,
+    functionName,
+    args,
+    chain,
+    account,
+    chainOverride
+  >,
+): Promise<EstimateContractTotalFeeReturnType> {
+  const { abi, address, args, functionName, ...request } =
+    parameters as EstimateContractTotalFeeParameters
+  const data = encodeFunctionData({
+    abi,
+    args,
+    functionName,
+  } as EncodeFunctionDataParameters)
+  try {
+    const fee = await estimateTotalFee(client, {
+      data,
+      to: address,
+      ...request,
+    } as unknown as EstimateTotalFeeParameters)
+    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/estimateTotalFee',
+      functionName,
+      sender: account?.address,
+    })
+  }
+}