@aztec/ethereum 0.0.1-commit.b655e406 → 0.0.1-commit.b6e433891

package/src/l1_tx_utils/fee-strategies/types.ts

@@ -0,0 +1,56 @@
+import type { Logger } from '@aztec/foundation/log';
+
+import type { Block } from 'viem';
+
+import type { ViemClient } from '../../types.js';
+import type { L1TxUtilsConfig } from '../config.js';
+
+/**
+ * Historical block count for fee history queries
+ */
+export const HISTORICAL_BLOCK_COUNT = 5;
+
+/**
+ * Result from a priority fee strategy calculation
+ */
+export interface PriorityFeeStrategyResult {
+  /** The calculated priority fee in wei */
+  priorityFee: bigint;
+  /** The latest block (fetched as part of the strategy) */
+  latestBlock: Block;
+  /** The blob base fee (only present for blob transactions) */
+  blobBaseFee?: bigint;
+  /** Optional debug info about how the fee was calculated */
+  debugInfo?: Record<string, string | number>;
+}
+
+/**
+ * Context passed to the strategy function
+ */
+export interface PriorityFeeStrategyContext {
+  /** Gas configuration */
+  gasConfig: L1TxUtilsConfig;
+  /** Whether this is for a blob transaction */
+  isBlobTx: boolean;
+  /** Logger for debugging */
+  logger?: Logger;
+}
+
+/**
+ * A strategy for calculating the priority fee for L1 transactions.
+ * The function handles all RPC calls and returns
+ * the priority fee, along with any block data needed by the caller.
+ */
+export type PriorityFeeStrategy = {
+  /** Human-readable name for logging */
+  name: string;
+  /** Unique identifier for metrics */
+  id: string;
+  /**
+   * Calculate the priority fee.
+   * @param client - The viem client to use for RPC calls
+   * @param context - Contains gas config, whether it's a blob tx, and logger
+   * @returns The calculated priority fee result including block data
+   */
+  execute: (client: ViemClient, context: PriorityFeeStrategyContext) => Promise<PriorityFeeStrategyResult>;
+};

package/src/l1_tx_utils/forwarder_l1_tx_utils.ts

@@ -0,0 +1,108 @@
+import type { BlobKzgInstance } from '@aztec/blob-lib/types';
+import { EthAddress } from '@aztec/foundation/eth-address';
+import type { Logger } from '@aztec/foundation/log';
+import type { DateProvider } from '@aztec/foundation/timer';
+
+import { type Hex, encodeFunctionData } from 'viem';
+
+import { FORWARDER_ABI } from '../forwarder_proxy.js';
+import type { ViemClient } from '../types.js';
+import type { L1TxUtilsConfig } from './config.js';
+import type { L1SignerSource } from './factory.js';
+import { resolveSignerSource } from './factory.js';
+import type { IL1TxMetrics, IL1TxStore } from './interfaces.js';
+import { L1TxUtils } from './l1_tx_utils.js';
+import { Delayer } from './tx_delayer.js';
+import type { L1BlobInputs, L1TxConfig, L1TxRequest, SigningCallback } from './types.js';
+
+/**
+ * Extends L1TxUtils to wrap all transactions through a forwarder contract.
+ * This is mainly used for testing the archiver's ability to decode transactions that go through proxies.
+ */
+export class ForwarderL1TxUtils extends L1TxUtils {
+  constructor(
+    client: ViemClient,
+    senderAddress: EthAddress,
+    signingCallback: SigningCallback,
+    logger: Logger | undefined,
+    dateProvider: DateProvider | undefined,
+    config: Partial<L1TxUtilsConfig>,
+    debugMaxGasLimit: boolean,
+    store: IL1TxStore | undefined,
+    metrics: IL1TxMetrics | undefined,
+    kzg: BlobKzgInstance | undefined,
+    delayer: Delayer | undefined,
+    private readonly forwarderAddress: EthAddress,
+  ) {
+    super(
+      client,
+      senderAddress,
+      signingCallback,
+      logger,
+      dateProvider,
+      config,
+      debugMaxGasLimit,
+      store,
+      metrics,
+      kzg,
+      delayer,
+    );
+  }
+
+  /**
+   * Wraps the transaction request in a call to the forwarder contract.
+   */
+  private wrapInForwarder(request: L1TxRequest): L1TxRequest {
+    const forwarderCalldata = encodeFunctionData({
+      abi: FORWARDER_ABI,
+      functionName: 'forward',
+      args: [request.to as Hex, request.data as Hex],
+    });
+
+    return {
+      to: this.forwarderAddress.toString() as Hex,
+      data: forwarderCalldata,
+      value: request.value,
+      abi: request.abi, // Preserve the original ABI for error decoding
+    };
+  }
+
+  /**
+   * Override sendAndMonitorTransaction to wrap the request in a forwarder call.
+   */
+  public override sendAndMonitorTransaction(request: L1TxRequest, gasConfig?: L1TxConfig, blobInputs?: L1BlobInputs) {
+    this.logger.debug(`Wrapping transaction to ${request.to} in forwarder at ${this.forwarderAddress.toString()}`);
+    const wrappedRequest = this.wrapInForwarder(request);
+    return super.sendAndMonitorTransaction(wrappedRequest, gasConfig, blobInputs);
+  }
+}
+
+export function createForwarderL1TxUtils(
+  source: L1SignerSource,
+  forwarderAddress: EthAddress,
+  deps?: {
+    logger?: Logger;
+    dateProvider?: DateProvider;
+    store?: IL1TxStore;
+    metrics?: IL1TxMetrics;
+    kzg?: BlobKzgInstance;
+    delayer?: Delayer;
+  },
+  config?: Partial<L1TxUtilsConfig> & { debugMaxGasLimit?: boolean },
+): ForwarderL1TxUtils {
+  const { client, address, signingCallback } = resolveSignerSource(source);
+  return new ForwarderL1TxUtils(
+    client,
+    address,
+    signingCallback,
+    deps?.logger,
+    deps?.dateProvider,
+    config ?? {},
+    config?.debugMaxGasLimit ?? false,
+    deps?.store,
+    deps?.metrics,
+    deps?.kzg,
+    deps?.delayer,
+    forwarderAddress,
+  );
+}

package/src/l1_tx_utils/index-blobs.ts

@@ -0,0 +1,2 @@
+export { createForwarderL1TxUtils, ForwarderL1TxUtils } from './forwarder_l1_tx_utils.js';
+export { createL1TxUtils, type L1SignerSource, resolveSignerSource } from './factory.js';

package/src/l1_tx_utils/index.ts

@@ -1,11 +1,14 @@
 export * from './config.js';
 export * from './constants.js';
 export * from './factory.js';
+export * from './fee-strategies/index.js';
 export * from './interfaces.js';
+export * from './l1_fee_analyzer.js';
 export * from './l1_tx_utils.js';
 export * from './readonly_l1_tx_utils.js';
 export * from './signer.js';
 export * from './types.js';
+export * from './tx_delayer.js';
 export * from './utils.js';
 
 // Note: We intentionally do not export l1_tx_utils_with_blobs.js

package/src/l1_tx_utils/interfaces.ts

@@ -46,7 +46,7 @@ export interface IL1TxStore {
    * @param account - The sender account address
    * @param stateId - The state ID to delete
    */
-  deleteState(account: string, stateId: number): Promise<void>;
+  deleteState(account: string, ...stateId: number[]): Promise<void>;
 
   /**
    * Clears all transaction states for a specific account.