@aztec/ethereum 3.0.0-nightly.20250925 → 3.0.0-nightly.20250927

package/src/l1_tx_utils/readonly_l1_tx_utils.ts

@@ -0,0 +1,368 @@
+import { times } from '@aztec/foundation/collection';
+import { type Logger, createLogger } from '@aztec/foundation/log';
+import { makeBackoff, retry } from '@aztec/foundation/retry';
+import { DateProvider } from '@aztec/foundation/timer';
+import { RollupAbi } from '@aztec/l1-artifacts/RollupAbi';
+
+import pickBy from 'lodash.pickby';
+import {
+  type Abi,
+  type Account,
+  type BaseError,
+  type BlockOverrides,
+  type ContractFunctionExecutionError,
+  type Hex,
+  MethodNotFoundRpcError,
+  MethodNotSupportedRpcError,
+  type StateOverride,
+  decodeErrorResult,
+  formatGwei,
+  getContractError,
+  hexToBytes,
+} from 'viem';
+
+import type { ViemClient } from '../types.js';
+import { type L1TxUtilsConfig, defaultL1TxUtilsConfig, l1TxUtilsConfigMappings } from './config.js';
+import {
+  BLOCK_TIME_MS,
+  LARGE_GAS_LIMIT,
+  MIN_BLOB_REPLACEMENT_BUMP_PERCENTAGE,
+  MIN_REPLACEMENT_BUMP_PERCENTAGE,
+  WEI_CONST,
+} from './constants.js';
+import type { GasPrice, L1BlobInputs, L1TxRequest, TransactionStats } from './types.js';
+import { getCalldataGasUsage, tryGetCustomErrorNameContractFunction } from './utils.js';
+
+export class ReadOnlyL1TxUtils {
+  public readonly config: L1TxUtilsConfig;
+  protected interrupted = false;
+
+  constructor(
+    public client: ViemClient,
+    protected logger: Logger = createLogger('ReadOnlyL1TxUtils'),
+    public readonly dateProvider: DateProvider,
+    config?: Partial<L1TxUtilsConfig>,
+    protected debugMaxGasLimit: boolean = false,
+  ) {
+    this.config = {
+      ...defaultL1TxUtilsConfig,
+      ...(config || {}),
+    };
+  }
+
+  public interrupt() {
+    this.interrupted = true;
+  }
+
+  public restart() {
+    this.interrupted = false;
+  }
+
+  public getBlock() {
+    return this.client.getBlock();
+  }
+
+  public getBlockNumber() {
+    return this.client.getBlockNumber();
+  }
+
+  /**
+   * Gets the current gas price with bounds checking
+   */
+  public async getGasPrice(
+    _gasConfig?: L1TxUtilsConfig,
+    isBlobTx: boolean = false,
+    attempt: number = 0,
+    previousGasPrice?: typeof attempt extends 0 ? never : GasPrice,
+  ): Promise<GasPrice> {
+    const gasConfig = { ...this.config, ..._gasConfig };
+    const block = await this.client.getBlock({ blockTag: 'latest' });
+    const baseFee = block.baseFeePerGas ?? 0n;
+
+    // Get blob base fee if available
+    let blobBaseFee = 0n;
+    if (isBlobTx) {
+      try {
+        blobBaseFee = await retry<bigint>(
+          () => this.client.getBlobBaseFee(),
+          'Getting L1 blob base fee',
+          makeBackoff(times(2, () => 1)),
+          this.logger,
+          true,
+        );
+        this.logger?.debug('L1 Blob base fee:', { blobBaseFee: formatGwei(blobBaseFee) });
+      } catch {
+        this.logger?.warn('Failed to get L1 blob base fee', attempt);
+      }
+    }
+
+    let priorityFee: bigint;
+    if (gasConfig.fixedPriorityFeePerGas) {
+      this.logger?.debug('Using fixed priority fee per L1 gas', {
+        fixedPriorityFeePerGas: gasConfig.fixedPriorityFeePerGas,
+      });
+      // try to maintain precision up to 1000000 wei
+      priorityFee = BigInt(gasConfig.fixedPriorityFeePerGas * 1_000_000) * (WEI_CONST / 1_000_000n);
+    } else {
+      // Get initial priority fee from the network
+      priorityFee = await this.client.estimateMaxPriorityFeePerGas();
+    }
+    let maxFeePerGas = baseFee;
+
+    let maxFeePerBlobGas = blobBaseFee;
+
+    // Bump base fee so it's valid for next blocks if it stalls
+    const numBlocks = Math.ceil(gasConfig.stallTimeMs! / BLOCK_TIME_MS);
+    for (let i = 0; i < numBlocks; i++) {
+      // each block can go up 12.5% from previous baseFee
+      maxFeePerGas = (maxFeePerGas * (1_000n + 125n)) / 1_000n;
+      // same for blob gas fee
+      maxFeePerBlobGas = (maxFeePerBlobGas * (1_000n + 125n)) / 1_000n;
+    }
+    if (attempt > 0) {
+      const configBump =
+        gasConfig.priorityFeeRetryBumpPercentage ?? defaultL1TxUtilsConfig.priorityFeeRetryBumpPercentage!;
+
+      // if this is a blob tx, we have to use the blob bump percentage
+      const minBumpPercentage = isBlobTx ? MIN_BLOB_REPLACEMENT_BUMP_PERCENTAGE : MIN_REPLACEMENT_BUMP_PERCENTAGE;
+
+      const bumpPercentage = configBump > minBumpPercentage ? configBump : minBumpPercentage;
+      // Calculate minimum required fees based on previous attempt
+      // multiply by 100 & divide by 100 to maintain some precision
+      const minPriorityFee =
+        (previousGasPrice!.maxPriorityFeePerGas * (100_00n + BigInt(bumpPercentage * 1_00))) / 100_00n;
+      const minMaxFee = (previousGasPrice!.maxFeePerGas * (100_00n + BigInt(bumpPercentage * 1_00))) / 100_00n;
+
+      // Add priority fee to maxFeePerGas
+      maxFeePerGas += priorityFee;
+
+      // Use maximum between current network values and minimum required values
+      priorityFee = priorityFee > minPriorityFee ? priorityFee : minPriorityFee;
+      maxFeePerGas = maxFeePerGas > minMaxFee ? maxFeePerGas : minMaxFee;
+    } else {
+      // first attempt, just bump priority fee, unless it's a fixed config
+      // multiply by 100 & divide by 100 to maintain some precision
+      if (!gasConfig.fixedPriorityFeePerGas) {
+        priorityFee = (priorityFee * (100_00n + BigInt((gasConfig.priorityFeeBumpPercentage || 0) * 1_00))) / 100_00n;
+      }
+      maxFeePerGas += priorityFee;
+    }
+
+    // Ensure we don't exceed maxGwei
+    const maxGweiInWei = gasConfig.maxGwei! * WEI_CONST;
+    maxFeePerGas = maxFeePerGas > maxGweiInWei ? maxGweiInWei : maxFeePerGas;
+
+    // Ensure we don't exceed maxBlobGwei
+    if (maxFeePerBlobGas) {
+      const maxBlobGweiInWei = gasConfig.maxBlobGwei! * WEI_CONST;
+      maxFeePerBlobGas = maxFeePerBlobGas > maxBlobGweiInWei ? maxBlobGweiInWei : maxFeePerBlobGas;
+    }
+
+    // Ensure priority fee doesn't exceed max fee
+    const maxPriorityFeePerGas = priorityFee > maxFeePerGas ? maxFeePerGas : priorityFee;
+
+    if (attempt > 0 && previousGasPrice?.maxFeePerBlobGas) {
+      const bumpPercentage =
+        gasConfig.priorityFeeRetryBumpPercentage! > MIN_BLOB_REPLACEMENT_BUMP_PERCENTAGE
+          ? gasConfig.priorityFeeRetryBumpPercentage!
+          : MIN_BLOB_REPLACEMENT_BUMP_PERCENTAGE;
+
+      // calculate min blob fee based on previous attempt
+      const minBlobFee = (previousGasPrice.maxFeePerBlobGas * (100_00n + BigInt(bumpPercentage * 1_00))) / 100_00n;
+
+      // use max between current network values and min required values
+      maxFeePerBlobGas = maxFeePerBlobGas > minBlobFee ? maxFeePerBlobGas : minBlobFee;
+    }
+
+    this.logger?.debug(`Computed L1 gas price`, {
+      attempt,
+      baseFee: formatGwei(baseFee),
+      maxFeePerGas: formatGwei(maxFeePerGas),
+      maxPriorityFeePerGas: formatGwei(maxPriorityFeePerGas),
+      ...(maxFeePerBlobGas && { maxFeePerBlobGas: formatGwei(maxFeePerBlobGas) }),
+    });
+
+    return {
+      maxFeePerGas,
+      maxPriorityFeePerGas,
+      ...(maxFeePerBlobGas && { maxFeePerBlobGas: maxFeePerBlobGas }),
+    };
+  }
+
+  /**
+   * Estimates gas and adds buffer
+   */
+  public async estimateGas(
+    account: Account | Hex,
+    request: L1TxRequest,
+    _gasConfig?: L1TxUtilsConfig,
+    _blobInputs?: L1BlobInputs,
+  ): Promise<bigint> {
+    const gasConfig = { ...this.config, ..._gasConfig };
+    let initialEstimate = 0n;
+    if (_blobInputs) {
+      // @note requests with blobs also require maxFeePerBlobGas to be set
+      const gasPrice = await this.getGasPrice(gasConfig, true, 0);
+      initialEstimate = await this.client.estimateGas({
+        account,
+        ...request,
+        ..._blobInputs,
+        maxFeePerBlobGas: gasPrice.maxFeePerBlobGas!,
+        gas: LARGE_GAS_LIMIT,
+      });
+
+      this.logger?.debug(`L1 gas used in estimateGas by blob tx: ${initialEstimate}`);
+    } else {
+      initialEstimate = await this.client.estimateGas({ account, ...request, gas: LARGE_GAS_LIMIT });
+      this.logger?.debug(`L1 gas used in estimateGas by non-blob tx: ${initialEstimate}`);
+    }
+
+    // Add buffer based on either fixed amount or percentage
+    const withBuffer = this.bumpGasLimit(initialEstimate, gasConfig);
+
+    return withBuffer;
+  }
+
+  async getTransactionStats(txHash: string): Promise<TransactionStats | undefined> {
+    const tx = await this.client.getTransaction({ hash: txHash as Hex });
+    if (!tx) {
+      return undefined;
+    }
+    const calldata = hexToBytes(tx.input);
+    return {
+      sender: tx.from.toString(),
+      transactionHash: tx.hash,
+      calldataSize: calldata.length,
+      calldataGas: getCalldataGasUsage(calldata),
+    };
+  }
+
+  public async tryGetErrorFromRevertedTx(
+    data: Hex,
+    args: {
+      args: readonly any[];
+      functionName: string;
+      abi: Abi;
+      address: Hex;
+    },
+    blobInputs: (L1BlobInputs & { maxFeePerBlobGas: bigint }) | undefined,
+    stateOverride: StateOverride = [],
+  ) {
+    try {
+      await this.client.simulateContract({
+        ...args,
+        account: this.client.account,
+        stateOverride,
+      });
+      this.logger?.trace('Simulated blob tx', { blobInputs });
+      // If the above passes, we have a blob error. We cannot simulate blob txs, and failed txs no longer throw errors.
+      // Strangely, the only way to throw the revert reason as an error and provide blobs is prepareTransactionRequest.
+      // See: https://github.com/wevm/viem/issues/2075
+      // This throws a EstimateGasExecutionError with the custom error information:
+      const request = blobInputs
+        ? {
+            account: this.client.account,
+            to: args.address,
+            data,
+            blobs: blobInputs.blobs,
+            kzg: blobInputs.kzg,
+            maxFeePerBlobGas: blobInputs.maxFeePerBlobGas,
+          }
+        : {
+            account: this.client.account,
+            to: args.address,
+            data,
+          };
+      this.logger?.trace('Preparing tx', { request });
+      await this.client.prepareTransactionRequest(request);
+      this.logger?.trace('Prepared tx');
+      return undefined;
+    } catch (simulationErr: any) {
+      // If we don't have a ContractFunctionExecutionError, we have a blob related error => use getContractError to get the error msg.
+      const contractErr =
+        simulationErr.name === 'ContractFunctionExecutionError'
+          ? simulationErr
+          : getContractError(simulationErr as BaseError, {
+              args: [],
+              abi: args.abi,
+              functionName: args.functionName,
+              address: args.address,
+            });
+      if (contractErr.name === 'ContractFunctionExecutionError') {
+        const execErr = contractErr as ContractFunctionExecutionError;
+        return tryGetCustomErrorNameContractFunction(execErr);
+      }
+      this.logger?.error(`Error getting error from simulation`, simulationErr);
+    }
+  }
+
+  public async simulate(
+    request: L1TxRequest & { gas?: bigint; from?: Hex },
+    blockOverrides: BlockOverrides<bigint, number> = {},
+    stateOverrides: StateOverride = [],
+    abi: Abi = RollupAbi,
+    _gasConfig?: L1TxUtilsConfig & { fallbackGasEstimate?: bigint },
+  ): Promise<{ gasUsed: bigint; result: `0x${string}` }> {
+    const gasConfig = { ...this.config, ..._gasConfig };
+
+    const call: any = {
+      to: request.to!,
+      data: request.data,
+      ...(request.from && { from: request.from }),
+    };
+
+    return await this._simulate(call, blockOverrides, stateOverrides, gasConfig, abi);
+  }
+
+  protected async _simulate(
+    call: any,
+    blockOverrides: BlockOverrides<bigint, number> = {},
+    stateOverrides: StateOverride = [],
+    gasConfig: L1TxUtilsConfig & { fallbackGasEstimate?: bigint },
+    abi: Abi,
+  ) {
+    try {
+      const result = await this.client.simulateBlocks({
+        validation: false,
+        blocks: [
+          {
+            blockOverrides,
+            stateOverrides,
+            calls: [call],
+          },
+        ],
+      });
+
+      if (result[0].calls[0].status === 'failure') {
+        this.logger?.error('L1 transaction simulation failed', result[0].calls[0].error);
+        const decodedError = decodeErrorResult({ abi, data: result[0].calls[0].data });
+
+        throw new Error(
+          `L1 transaction simulation failed with error ${decodedError.errorName}(${decodedError.args?.join(',')})`,
+        );
+      }
+      this.logger?.debug(`L1 transaction simulation succeeded`, { ...result[0].calls[0] });
+      return { gasUsed: result[0].gasUsed, result: result[0].calls[0].data as `0x${string}` };
+    } catch (err) {
+      if (err instanceof MethodNotFoundRpcError || err instanceof MethodNotSupportedRpcError) {
+        if (gasConfig.fallbackGasEstimate) {
+          this.logger?.warn(
+            `Node does not support eth_simulateV1 API. Using fallback gas estimate: ${gasConfig.fallbackGasEstimate}`,
+          );
+          return { gasUsed: gasConfig.fallbackGasEstimate, result: '0x' as `0x${string}` };
+        }
+        this.logger?.error('Node does not support eth_simulateV1 API');
+      }
+      throw err;
+    }
+  }
+
+  public bumpGasLimit(gasLimit: bigint, _gasConfig?: L1TxUtilsConfig): bigint {
+    const gasConfig = { ...this.config, ..._gasConfig };
+    const bumpedGasLimit = gasLimit + (gasLimit * BigInt((gasConfig?.gasLimitBufferPercentage || 0) * 1_00)) / 100_00n;
+
+    const cleanGasConfig = pickBy(gasConfig, (_, key) => key in l1TxUtilsConfigMappings);
+    this.logger?.debug('Bumping gas limit', { gasLimit, gasConfig: cleanGasConfig, bumpedGasLimit });
+    return bumpedGasLimit;
+  }
+}

package/src/l1_tx_utils/signer.ts

@@ -0,0 +1,28 @@
+import { EthAddress } from '@aztec/foundation/eth-address';
+import type { ViemTransactionSignature } from '@aztec/foundation/eth-signature';
+
+import { type TransactionSerializable, type WalletClient, parseTransaction } from 'viem';
+
+import type { SigningCallback } from './types.js';
+
+export function createViemSigner(client: WalletClient) {
+  const signer: SigningCallback = async (
+    tx: TransactionSerializable,
+    _address: EthAddress,
+  ): Promise<ViemTransactionSignature> => {
+    const signedTx = await client.signTransaction(tx as any);
+
+    const parsed = parseTransaction(signedTx);
+
+    if (!parsed.r || !parsed.s || (parsed.yParity !== 0 && parsed.yParity !== 1)) {
+      throw new Error('Failed to extract signature from viem signed transaction');
+    }
+
+    return {
+      r: parsed.r,
+      s: parsed.s,
+      yParity: parsed.yParity,
+    };
+  };
+  return signer;
+}

package/src/l1_tx_utils/types.ts

@@ -0,0 +1,52 @@
+import { EthAddress } from '@aztec/foundation/eth-address';
+import type { ViemTransactionSignature } from '@aztec/foundation/eth-signature';
+
+import type { Abi, Address, Hex, TransactionSerializable } from 'viem';
+
+import type { L1TxUtilsConfig } from './config.js';
+
+export interface L1TxRequest {
+  to: Address | null;
+  data?: Hex;
+  value?: bigint;
+  abi?: Abi;
+}
+
+export type L1GasConfig = Partial<L1TxUtilsConfig> & { gasLimit?: bigint; txTimeoutAt?: Date };
+
+export interface L1BlobInputs {
+  blobs: Uint8Array[];
+  kzg: any;
+  maxFeePerBlobGas?: bigint;
+}
+
+export interface GasPrice {
+  maxFeePerGas: bigint;
+  maxPriorityFeePerGas: bigint;
+  maxFeePerBlobGas?: bigint;
+}
+
+export type TransactionStats = {
+  /** Address of the sender. */
+  sender: string;
+  /** Hash of the transaction. */
+  transactionHash: string;
+  /** Size in bytes of the tx calldata */
+  calldataSize: number;
+  /** Gas required to pay for the calldata inclusion (depends on size and number of zeros)  */
+  calldataGas: number;
+};
+
+export enum TxUtilsState {
+  IDLE,
+  SENT,
+  SPEED_UP,
+  CANCELLED,
+  NOT_MINED,
+  MINED,
+}
+
+export type SigningCallback = (
+  transaction: TransactionSerializable,
+  signingAddress: EthAddress,
+) => Promise<ViemTransactionSignature>;

package/src/l1_tx_utils/utils.ts

@@ -0,0 +1,16 @@
+import { compactArray } from '@aztec/foundation/collection';
+
+import type { ContractFunctionExecutionError } from 'viem';
+
+export function tryGetCustomErrorNameContractFunction(err: ContractFunctionExecutionError) {
+  return compactArray([err.shortMessage, ...(err.metaMessages ?? []).slice(0, 2).map(s => s.trim())]).join(' ');
+}
+
+/*
+ * Returns cost of calldata usage in Ethereum.
+ * @param data - Calldata.
+ * @returns 4 for each zero byte, 16 for each nonzero.
+ */
+export function getCalldataGasUsage(data: Uint8Array) {
+  return data.filter(byte => byte === 0).length * 4 + data.filter(byte => byte !== 0).length * 16;
+}

package/src/publisher_manager.ts

@@ -1,7 +1,7 @@
 import { pick } from '@aztec/foundation/collection';
 import { createLogger } from '@aztec/foundation/log';
 
-import { L1TxUtils, TxUtilsState } from './l1_tx_utils.js';
+import { L1TxUtils, TxUtilsState } from './l1_tx_utils/index.js';
 
 const sortOrder = [TxUtilsState.IDLE, TxUtilsState.MINED];
 const invalidStates = [TxUtilsState.SENT, TxUtilsState.SPEED_UP, TxUtilsState.CANCELLED, TxUtilsState.NOT_MINED]; // Cancelled and not mined are states that can be handled by a later iteration

package/src/test/delayed_tx_utils.ts

@@ -2,8 +2,8 @@ import { EthAddress } from '@aztec/foundation/eth-address';
 import { type Logger, createLogger } from '@aztec/foundation/log';
 import { DateProvider } from '@aztec/foundation/timer';
 
-import { type L1TxUtilsConfig, createViemSigner } from '../l1_tx_utils.js';
-import { L1TxUtilsWithBlobs } from '../l1_tx_utils_with_blobs.js';
+import { type L1TxUtilsConfig, createViemSigner } from '../l1_tx_utils/index.js';
+import { L1TxUtilsWithBlobs } from '../l1_tx_utils/l1_tx_utils_with_blobs.js';
 import type { ExtendedViemWalletClient } from '../types.js';
 import { type Delayer, withDelayer } from './tx_delayer.js';
 

package/src/test/upgrade_utils.ts

@@ -7,7 +7,7 @@ import { type GetContractReturnType, type PrivateKeyAccount, getContract } from
 
 import { extractProposalIdFromLogs } from '../contracts/governance.js';
 import type { L1ContractAddresses } from '../l1_contract_addresses.js';
-import { createL1TxUtilsFromViemWallet } from '../l1_tx_utils.js';
+import { createL1TxUtilsFromViemWallet } from '../l1_tx_utils/index.js';
 import type { ExtendedViemWalletClient, ViemPublicClient } from '../types.js';
 import { EthCheatCodes } from './eth_cheat_codes.js';