viem 2.0.0-beta.2 → 2.0.0-beta.3

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,
+    })
+  }
+}

package/chains/opStack/actions/estimateContractTotalGas.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 EstimateTotalGasErrorType,
+  type EstimateTotalGasParameters,
+  estimateTotalGas,
+} from './estimateTotalGas.js'
+
+export type EstimateContractTotalGasParameters<
+  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<
+    EstimateTotalGasParameters<chain, account, chainOverride>,
+    'data' | 'to' | 'value'
+  > &
+  GetValue<
+    abi,
+    functionName,
+    EstimateTotalGasParameters<
+      chain,
+      account,
+      chainOverride
+    > extends EstimateTotalGasParameters
+      ? EstimateTotalGasParameters<chain, account, chainOverride>['value']
+      : EstimateTotalGasParameters['value']
+  >
+
+export type EstimateContractTotalGasReturnType = bigint
+
+export type EstimateContractTotalGasErrorType = GetContractErrorReturnType<
+  | EncodeFunctionDataErrorType
+  | EstimateTotalGasErrorType
+  | ParseAccountErrorType
+>
+
+/**
+ * Estimates the L1 data gas + L2 gas required to successfully execute a contract write function call.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link EstimateContractTotalGasParameters}
+ * @returns The gas estimate (in wei). {@link EstimateContractTotalGasReturnType}
+ *
+ * @example
+ * import { createPublicClient, http, parseAbi } from 'viem'
+ * import { optimism } from 'viem/chains'
+ * import { estimateContractTotalGas } from 'viem/op-stack'
+ *
+ * const client = createPublicClient({
+ *   chain: optimism,
+ *   transport: http(),
+ * })
+ * const totalGas = await estimateContractTotalGas(client, {
+ *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+ *   abi: parseAbi(['function mint() public']),
+ *   functionName: 'mint',
+ *   account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
+ * })
+ */
+export async function estimateContractTotalGas<
+  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: EstimateContractTotalGasParameters<
+    abi,
+    functionName,
+    args,
+    chain,
+    account,
+    chainOverride
+  >,
+): Promise<EstimateContractTotalGasReturnType> {
+  const { abi, address, args, functionName, ...request } =
+    parameters as EstimateContractTotalGasParameters
+  const data = encodeFunctionData({
+    abi,
+    args,
+    functionName,
+  } as EncodeFunctionDataParameters)
+  try {
+    const gas = await estimateTotalGas(client, {
+      data,
+      to: address,
+      ...request,
+    } as unknown as EstimateTotalGasParameters)
+    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/estimateTotalGas',
+      functionName,
+      sender: account?.address,
+    })
+  }
+}

package/chains/opStack/actions/estimateL1Fee.ts

@@ -0,0 +1,138 @@
+import type { Address } from 'abitype'
+
+import { getChainId } from '../../../actions/public/getChainId.js'
+import {
+  type ReadContractErrorType,
+  readContract,
+} from '../../../actions/public/readContract.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 { maxInt256 } from '../../../constants/number.js'
+import type { ErrorType } from '../../../errors/utils.js'
+import type { Account, GetAccountParameter } from '../../../types/account.js'
+import { type Chain, type GetChain } from '../../../types/chain.js'
+import type { Signature } from '../../../types/misc.js'
+import type { TransactionRequestEIP1559 } from '../../../types/transaction.js'
+import type { RequestErrorType } from '../../../utils/buildRequest.js'
+import { getChainContractAddress } from '../../../utils/chain/getChainContractAddress.js'
+import { type HexToNumberErrorType } from '../../../utils/encoding/fromHex.js'
+import { numberToHex } from '../../../utils/encoding/toHex.js'
+import {
+  type AssertRequestErrorType,
+  assertRequest,
+} from '../../../utils/transaction/assertRequest.js'
+import {
+  type SerializeTransactionErrorType,
+  serializeTransaction,
+} from '../../../utils/transaction/serializeTransaction.js'
+import { gasPriceOracleAbi } from '../abis.js'
+import { contracts } from '../contracts.js'
+
+export type EstimateL1FeeParameters<
+  TChain extends Chain | undefined = Chain | undefined,
+  TAccount extends Account | undefined = Account | undefined,
+  TChainOverride extends Chain | undefined = undefined,
+> = Omit<TransactionRequestEIP1559, 'from'> &
+  GetAccountParameter<TAccount> &
+  GetChain<TChain, TChainOverride> & {
+    /** Gas price oracle address. */
+    gasPriceOracleAddress?: Address
+  }
+
+export type EstimateL1FeeReturnType = bigint
+
+export type EstimateL1FeeErrorType =
+  | RequestErrorType
+  | PrepareTransactionRequestErrorType
+  | AssertRequestErrorType
+  | SerializeTransactionErrorType
+  | HexToNumberErrorType
+  | ReadContractErrorType
+  | ErrorType
+
+const stubSignature = {
+  r: numberToHex(maxInt256),
+  s: numberToHex(maxInt256),
+  v: 28n,
+} as const satisfies Signature
+
+/**
+ * Estimates the L1 fee required to execute an L2 transaction.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link EstimateL1FeeParameters}
+ * @returns The fee (in wei). {@link EstimateL1FeeReturnType}
+ *
+ * @example
+ * import { createPublicClient, http, parseEther } from 'viem'
+ * import { optimism } from 'viem/chains'
+ * import { estimateL1Fee } from 'viem/chains/optimism'
+ *
+ * const client = createPublicClient({
+ *   chain: optimism,
+ *   transport: http(),
+ * })
+ * const l1Fee = await estimateL1Fee(client, {
+ *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
+ *   to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
+ *   value: parseEther('1'),
+ * })
+ */
+export async function estimateL1Fee<
+  TChain extends Chain | undefined,
+  TAccount extends Account | undefined,
+  TChainOverride extends Chain | undefined = undefined,
+>(
+  client: Client<Transport, TChain, TAccount>,
+  args: EstimateL1FeeParameters<TChain, TAccount, TChainOverride>,
+): Promise<EstimateL1FeeReturnType> {
+  const {
+    chain = client.chain,
+    gasPriceOracleAddress: gasPriceOracleAddress_,
+  } = args
+
+  const gasPriceOracleAddress = (() => {
+    if (gasPriceOracleAddress_) return gasPriceOracleAddress_
+    if (chain)
+      return getChainContractAddress({
+        chain,
+        contract: 'gasPriceOracle',
+      })
+    return contracts.gasPriceOracle.address
+  })()
+
+  // Populate transaction with required fields to accurately estimate gas.
+  const [request, chainId] = await Promise.all([
+    prepareTransactionRequest(
+      client,
+      args as PrepareTransactionRequestParameters,
+    ),
+    (async () => {
+      if (chain) return chain.id
+      return getChainId(client)
+    })(),
+  ])
+
+  assertRequest(request)
+
+  const transaction = serializeTransaction(
+    {
+      ...request,
+      chainId,
+      type: 'eip1559',
+    },
+    stubSignature,
+  )
+
+  return readContract(client, {
+    abi: gasPriceOracleAbi,
+    address: gasPriceOracleAddress,
+    functionName: 'getL1Fee',
+    args: [transaction],
+  })
+}