@aztec/ethereum 0.0.1-commit.f1df4d2 → 0.0.1-commit.f224bb98b

package/src/l1_tx_utils/config.ts

@@ -5,6 +5,7 @@ import {
   getConfigFromMappings,
   getDefaultConfig,
   numberConfigHelper,
+  optionalNumberConfigHelper,
 } from '@aztec/foundation/config';
 
 export interface L1TxUtilsConfig {
@@ -60,6 +61,12 @@ export interface L1TxUtilsConfig {
    * How long a tx nonce can be unseen in the mempool before considering it dropped
    */
   txUnseenConsideredDroppedMs?: number;
+  /** Enable tx delayer. When true, wraps the viem client to intercept and delay txs. Test-only. */
+  enableDelayer?: boolean;
+  /** Max seconds into an L1 slot for tx inclusion. Txs sent later are deferred to next slot. Only used when enableDelayer is true. */
+  txDelayerMaxInclusionTimeIntoSlot?: number;
+  /** How many seconds an L1 slot lasts. */
+  ethereumSlotDuration?: number;
 }
 
 export const l1TxUtilsConfigMappings: ConfigMappingsType<L1TxUtilsConfig> = {
@@ -142,6 +149,19 @@ export const l1TxUtilsConfigMappings: ConfigMappingsType<L1TxUtilsConfig> = {
     env: 'L1_TX_MONITOR_TX_UNSEEN_CONSIDERED_DROPPED_MS',
     ...numberConfigHelper(6 * 12 * 1000), // 6 L1 blocks
   },
+  enableDelayer: {
+    description: 'Enable tx delayer for testing.',
+    ...booleanConfigHelper(false),
+  },
+  txDelayerMaxInclusionTimeIntoSlot: {
+    description: 'Max seconds into L1 slot for tx inclusion when delayer is enabled.',
+    ...optionalNumberConfigHelper(),
+  },
+  ethereumSlotDuration: {
+    env: 'ETHEREUM_SLOT_DURATION',
+    description: 'How many seconds an L1 slot lasts.',
+    ...numberConfigHelper(12),
+  },
 };
 
 // We abuse the fact that all mappings above have a non null default value and force-type this to Required

package/src/l1_tx_utils/factory.ts

@@ -1,64 +1,64 @@
+import type { BlobKzgInstance } from '@aztec/blob-lib/types';
 import { EthAddress } from '@aztec/foundation/eth-address';
 import type { Logger } from '@aztec/foundation/log';
 import { DateProvider } from '@aztec/foundation/timer';
 
-import type { TransactionSerializable } from 'viem';
-
 import type { EthSigner } from '../eth-signer/eth-signer.js';
 import type { ExtendedViemWalletClient, ViemClient } from '../types.js';
 import type { L1TxUtilsConfig } from './config.js';
 import type { IL1TxMetrics, IL1TxStore } from './interfaces.js';
 import { L1TxUtils } from './l1_tx_utils.js';
 import { createViemSigner } from './signer.js';
+import { Delayer } from './tx_delayer.js';
 import type { SigningCallback } from './types.js';
 
-export function createL1TxUtilsFromViemWallet(
-  client: ExtendedViemWalletClient,
-  deps?: {
-    logger?: Logger;
-    dateProvider?: DateProvider;
-    store?: IL1TxStore;
-    metrics?: IL1TxMetrics;
-  },
-  config?: Partial<L1TxUtilsConfig> & { debugMaxGasLimit?: boolean },
-): L1TxUtils {
-  return new L1TxUtils(
+/** Source of signing capability: either a wallet client or a separate client + signer. */
+export type L1SignerSource = ExtendedViemWalletClient | { client: ViemClient; signer: EthSigner };
+
+export function resolveSignerSource(source: L1SignerSource): {
+  client: ViemClient;
+  address: EthAddress;
+  signingCallback: SigningCallback;
+} {
+  if ('account' in source && source.account) {
+    return {
+      client: source as ExtendedViemWalletClient,
+      address: EthAddress.fromString((source as ExtendedViemWalletClient).account.address),
+      signingCallback: createViemSigner(source as ExtendedViemWalletClient),
+    };
+  }
+  const { client, signer } = source as { client: ViemClient; signer: EthSigner };
+  return {
     client,
-    EthAddress.fromString(client.account.address),
-    createViemSigner(client),
-    deps?.logger,
-    deps?.dateProvider,
-    config,
-    config?.debugMaxGasLimit ?? false,
-    deps?.store,
-    deps?.metrics,
-  );
+    address: signer.address,
+    signingCallback: async (tx, _addr) => (await signer.signTransaction(tx)).toViemTransactionSignature(),
+  };
 }
 
-export function createL1TxUtilsFromEthSigner(
-  client: ViemClient,
-  signer: EthSigner,
+export function createL1TxUtils(
+  source: L1SignerSource,
   deps?: {
     logger?: Logger;
     dateProvider?: DateProvider;
     store?: IL1TxStore;
     metrics?: IL1TxMetrics;
+    kzg?: BlobKzgInstance;
+    delayer?: Delayer;
   },
   config?: Partial<L1TxUtilsConfig> & { debugMaxGasLimit?: boolean },
 ): L1TxUtils {
-  const callback: SigningCallback = async (transaction: TransactionSerializable, _signingAddress) => {
-    return (await signer.signTransaction(transaction)).toViemTransactionSignature();
-  };
-
+  const { client, address, signingCallback } = resolveSignerSource(source);
   return new L1TxUtils(
     client,
-    signer.address,
-    callback,
+    address,
+    signingCallback,
     deps?.logger,
     deps?.dateProvider,
     config,
     config?.debugMaxGasLimit ?? false,
     deps?.store,
     deps?.metrics,
+    deps?.kzg,
+    deps?.delayer,
   );
 }

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

@@ -134,7 +134,7 @@ export const P75AllTxsPriorityFeeStrategy: PriorityFeeStrategy = {
     // Sanity check: cap competitive fee at 100x network estimate to avoid using unrealistic fees
     const maxReasonableFee = networkEstimate * 100n;
     if (competitiveFee > maxReasonableFee && networkEstimate > 0n) {
-      logger?.warn('Competitive fee exceeds sanity cap, using capped value', {
+      logger?.debug('Competitive fee exceeds sanity cap, using capped value', {
         competitiveFee: formatGwei(competitiveFee),
         networkEstimate: formatGwei(networkEstimate),
         cappedTo: formatGwei(maxReasonableFee),

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

@@ -207,7 +207,7 @@ export const P75BlobTxsOnlyPriorityFeeStrategy: PriorityFeeStrategy = {
 
         // Debug: Log suspicious fees from history
         if (medianHistoricalFee > 100n * WEI_CONST) {
-          logger?.warn('Suspicious high fee in history', {
+          logger?.debug('Suspicious high fee in history', {
             historicalMedian: formatGwei(medianHistoricalFee),
             allP75Fees: percentile75Fees.map(f => formatGwei(f)),
           });

package/src/l1_tx_utils/forwarder_l1_tx_utils.ts

@@ -1,25 +1,27 @@
+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 type { EthSigner } from '../eth-signer/eth-signer.js';
 import { FORWARDER_ABI } from '../forwarder_proxy.js';
-import type { ExtendedViemWalletClient, ViemClient } from '../types.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 { L1TxUtilsWithBlobs } from './l1_tx_utils_with_blobs.js';
-import { createViemSigner } from './signer.js';
+import { L1TxUtils } from './l1_tx_utils.js';
+import { Delayer } from './tx_delayer.js';
 import type { L1BlobInputs, L1TxConfig, L1TxRequest, SigningCallback } from './types.js';
 
 /**
- * Extends L1TxUtilsWithBlobs to wrap all transactions through a forwarder contract.
+ * 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 L1TxUtilsWithBlobs {
+export class ForwarderL1TxUtils extends L1TxUtils {
   constructor(
-    client: ViemClient | ExtendedViemWalletClient,
+    client: ViemClient,
     senderAddress: EthAddress,
     signingCallback: SigningCallback,
     logger: Logger | undefined,
@@ -28,9 +30,23 @@ export class ForwarderL1TxUtils extends L1TxUtilsWithBlobs {
     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);
+    super(
+      client,
+      senderAddress,
+      signingCallback,
+      logger,
+      dateProvider,
+      config,
+      debugMaxGasLimit,
+      store,
+      metrics,
+      kzg,
+      delayer,
+    );
   }
 
   /**
@@ -61,59 +77,32 @@ export class ForwarderL1TxUtils extends L1TxUtilsWithBlobs {
   }
 }
 
-export function createForwarderL1TxUtilsFromViemWallet(
-  client: ExtendedViemWalletClient,
+export function createForwarderL1TxUtils(
+  source: L1SignerSource,
   forwarderAddress: EthAddress,
-  deps: {
+  deps?: {
     logger?: Logger;
     dateProvider?: DateProvider;
     store?: IL1TxStore;
     metrics?: IL1TxMetrics;
-  } = {},
-  config: Partial<L1TxUtilsConfig> = {},
-  debugMaxGasLimit: boolean = false,
-) {
+    kzg?: BlobKzgInstance;
+    delayer?: Delayer;
+  },
+  config?: Partial<L1TxUtilsConfig> & { debugMaxGasLimit?: boolean },
+): ForwarderL1TxUtils {
+  const { client, address, signingCallback } = resolveSignerSource(source);
   return new ForwarderL1TxUtils(
     client,
-    EthAddress.fromString(client.account.address),
-    createViemSigner(client),
-    deps.logger,
-    deps.dateProvider,
-    config,
-    debugMaxGasLimit,
-    deps.store,
-    deps.metrics,
-    forwarderAddress,
-  );
-}
-
-export function createForwarderL1TxUtilsFromEthSigner(
-  client: ViemClient,
-  signer: EthSigner,
-  forwarderAddress: EthAddress,
-  deps: {
-    logger?: Logger;
-    dateProvider?: DateProvider;
-    store?: IL1TxStore;
-    metrics?: IL1TxMetrics;
-  } = {},
-  config: Partial<L1TxUtilsConfig> = {},
-  debugMaxGasLimit: boolean = false,
-) {
-  const callback: SigningCallback = async (transaction, _signingAddress) => {
-    return (await signer.signTransaction(transaction)).toViemTransactionSignature();
-  };
-
-  return new ForwarderL1TxUtils(
-    client,
-    signer.address,
-    callback,
-    deps.logger,
-    deps.dateProvider,
-    config,
-    debugMaxGasLimit,
-    deps.store,
-    deps.metrics,
+    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

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

package/src/l1_tx_utils/index.ts

@@ -8,6 +8,7 @@ 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/l1_tx_utils.ts

@@ -1,8 +1,9 @@
+import type { BlobKzgInstance } from '@aztec/blob-lib/types';
 import { maxBigint } from '@aztec/foundation/bigint';
 import { merge, pick } from '@aztec/foundation/collection';
 import { InterruptError, TimeoutError } from '@aztec/foundation/error';
 import { EthAddress } from '@aztec/foundation/eth-address';
-import { type Logger, createLogger } from '@aztec/foundation/log';
+import { type Logger, type LoggerBindings, createLogger } from '@aztec/foundation/log';
 import { retryUntil } from '@aztec/foundation/retry';
 import { sleep } from '@aztec/foundation/sleep';
 import { DateProvider } from '@aztec/foundation/timer';
@@ -13,16 +14,13 @@ import {
   type Abi,
   type BlockOverrides,
   type Hex,
-  type NonceManager,
   type PrepareTransactionRequestRequest,
   type StateOverride,
   type TransactionReceipt,
   type TransactionSerializable,
-  createNonceManager,
   formatGwei,
   serializeTransaction,
 } from 'viem';
-import { jsonRpc } from 'viem/nonce';
 
 import type { ViemClient } from '../types.js';
 import { formatViemError } from '../utils.js';
@@ -30,6 +28,7 @@ import { type L1TxUtilsConfig, l1TxUtilsConfigMappings } from './config.js';
 import { MAX_L1_TX_LIMIT } from './constants.js';
 import type { IL1TxMetrics, IL1TxStore } from './interfaces.js';
 import { ReadOnlyL1TxUtils } from './readonly_l1_tx_utils.js';
+import { Delayer, createDelayer, wrapClientWithDelayer } from './tx_delayer.js';
 import {
   DroppedTransactionError,
   type L1BlobInputs,
@@ -45,8 +44,13 @@ import {
 const MAX_L1_TX_STATES = 32;
 
 export class L1TxUtils extends ReadOnlyL1TxUtils {
-  protected nonceManager: NonceManager;
   protected txs: L1TxState[] = [];
+  /** Last nonce successfully sent to the chain. Used as a lower bound when a fallback RPC node returns a stale count. */
+  private lastSentNonce: number | undefined;
+  /** Tx delayer for testing. Only set when enableDelayer config is true. */
+  public delayer?: Delayer;
+  /** KZG instance for blob operations. */
+  protected kzg?: BlobKzgInstance;
 
   constructor(
     public override client: ViemClient,
@@ -58,9 +62,25 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
     debugMaxGasLimit: boolean = false,
     protected store?: IL1TxStore,
     protected metrics?: IL1TxMetrics,
+    kzg?: BlobKzgInstance,
+    delayer?: Delayer,
   ) {
     super(client, logger, dateProvider, config, debugMaxGasLimit);
-    this.nonceManager = createNonceManager({ source: jsonRpc() });
+    this.kzg = kzg;
+
+    // Set up delayer: use provided one or create new
+    if (config?.enableDelayer && config?.ethereumSlotDuration) {
+      this.delayer =
+        delayer ?? this.createDelayer({ ethereumSlotDuration: config.ethereumSlotDuration }, logger.getBindings());
+      this.client = wrapClientWithDelayer(this.client, this.delayer);
+      if (config.txDelayerMaxInclusionTimeIntoSlot !== undefined) {
+        this.delayer.setMaxInclusionTimeIntoSlot(config.txDelayerMaxInclusionTimeIntoSlot);
+      }
+    } else if (delayer) {
+      // Delayer provided but enableDelayer not set — just store it without wrapping
+      logger.warn('Delayer provided but enableDelayer config is not set; delayer will not be used');
+      this.delayer = delayer;
+    }
   }
 
   public get state() {
@@ -87,6 +107,11 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
       this.metrics?.recordMinedTx(l1TxState, new Date(l1Timestamp));
     } else if (newState === TxUtilsState.NOT_MINED) {
       this.metrics?.recordDroppedTx(l1TxState);
+      // The tx was dropped: the chain nonce reverted to l1TxState.nonce, so our lower bound is
+      // no longer valid. Clear it so the next send fetches the real nonce from the chain.
+      if (this.lastSentNonce === l1TxState.nonce) {
+        this.lastSentNonce = undefined;
+      }
     }
 
     // Update state in the store
@@ -221,15 +246,6 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
         throw new InterruptError(`Transaction sending is interrupted`);
       }
 
-      const nonce = await this.nonceManager.consume({
-        client: this.client,
-        address: account,
-        chainId: this.client.chain.id,
-      });
-
-      const baseState = { request, gasLimit, blobInputs, gasPrice, nonce };
-      const txData = this.makeTxData(baseState, { isCancelTx: false });
-
       const now = new Date(await this.getL1Timestamp());
       if (gasConfig.txTimeoutAt && now > gasConfig.txTimeoutAt) {
         throw new TimeoutError(
@@ -237,9 +253,20 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
         );
       }
 
+      const chainNonce = await this.client.getTransactionCount({ address: account, blockTag: 'pending' });
+      // If a fallback RPC node returns a stale count (lower than what we last sent), use our
+      // local lower bound to avoid sending a duplicate of an already-pending transaction.
+      const nonce =
+        this.lastSentNonce !== undefined && chainNonce <= this.lastSentNonce ? this.lastSentNonce + 1 : chainNonce;
+
+      const baseState = { request, gasLimit, blobInputs, gasPrice, nonce };
+      const txData = this.makeTxData(baseState, { isCancelTx: false });
+
       // Send the new tx
       const signedRequest = await this.prepareSignedTransaction(txData);
       const txHash = await this.client.sendRawTransaction({ serializedTransaction: signedRequest });
+      // Update after tx is sent successfully
+      this.lastSentNonce = nonce;
 
       // Create the new state for monitoring
       const l1TxState: L1TxState = {
@@ -423,7 +450,6 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
             { nonce, account, pendingNonce, timePassed },
           );
           await this.updateState(state, TxUtilsState.NOT_MINED);
-          this.nonceManager.reset({ address: account, chainId: this.client.chain.id });
           throw new DroppedTransactionError(nonce, account);
         }
 
@@ -515,12 +541,7 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
 
     // Oh no, the transaction has timed out!
     if (isCancelTx || !gasConfig.cancelTxOnTimeout) {
-      // If this was already a cancellation tx, or we are configured to not cancel txs, we just mark it as NOT_MINED
-      // and reset the nonce manager, so the next tx that comes along can reuse the nonce if/when this tx gets dropped.
-      // This is the nastiest scenario for us, since the new tx could acquire the next nonce, but then this tx is dropped,
-      // and the new tx would never get mined. Eventually, the new tx would also drop.
       await this.updateState(state, TxUtilsState.NOT_MINED);
-      this.nonceManager.reset({ address: account, chainId: this.client.chain.id });
     } else {
       // Otherwise we fire the cancellation without awaiting to avoid blocking the caller,
       // and monitor it in the background so we can speed it up as needed.
@@ -659,7 +680,6 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
         { nonce, account },
       );
       await this.updateState(state, TxUtilsState.NOT_MINED);
-      this.nonceManager.reset({ address: account, chainId: this.client.chain.id });
       return;
     }
 
@@ -671,7 +691,6 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
         { nonce, account, currentNonce },
       );
       await this.updateState(state, TxUtilsState.NOT_MINED);
-      this.nonceManager.reset({ address: account, chainId: this.client.chain.id });
       return;
     }
 
@@ -731,8 +750,17 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
     return Number(timestamp) * 1000;
   }
 
-  /** Makes empty blob inputs for the cancellation tx. To be overridden in L1TxUtilsWithBlobs. */
-  protected makeEmptyBlobInputs(_maxFeePerBlobGas: bigint): Required<L1BlobInputs> {
-    throw new Error('Cannot make empty blob inputs for cancellation');
+  /** Makes empty blob inputs for the cancellation tx. */
+  protected makeEmptyBlobInputs(maxFeePerBlobGas: bigint): Required<L1BlobInputs> {
+    if (!this.kzg) {
+      throw new Error('Cannot make empty blob inputs for cancellation without kzg');
+    }
+    const blobData = new Uint8Array(131072).fill(0);
+    return { blobs: [blobData], kzg: this.kzg, maxFeePerBlobGas };
+  }
+
+  /** Creates a new delayer instance. */
+  protected createDelayer(opts: { ethereumSlotDuration: bigint | number }, bindings: LoggerBindings): Delayer {
+    return createDelayer(this.dateProvider, opts, bindings);
   }
 }

package/src/l1_tx_utils/readonly_l1_tx_utils.ts

@@ -130,9 +130,10 @@ export class ReadOnlyL1TxUtils {
     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;
+      // ceil, (a+b-1)/b, to avoid truncation at small values (e.g. 1 wei blob base fee)
+      maxFeePerGas = (maxFeePerGas * (1_000n + 125n) + 999n) / 1_000n;
       // same for blob gas fee
-      maxFeePerBlobGas = (maxFeePerBlobGas * (1_000n + 125n)) / 1_000n;
+      maxFeePerBlobGas = (maxFeePerBlobGas * (1_000n + 125n) + 999n) / 1_000n;
     }
 
     if (attempt > 0) {
@@ -242,13 +243,16 @@ export class ReadOnlyL1TxUtils {
     const gasConfig = { ...this.config, ..._gasConfig };
     let initialEstimate = 0n;
     if (_blobInputs) {
-      // @note requests with blobs also require maxFeePerBlobGas to be set
+      // @note requests with blobs also require maxFeePerBlobGas to be set.
+      // Use 2x buffer for maxFeePerBlobGas to avoid stale fees and to pass EIP-4844 validation (even if it is a gas estimation call).
+      // 1. maxFeePerBlobGas >= blobBaseFee
+      // 2. account balance >= gas * maxFeePerGas + maxFeePerBlobGas * blobCount + value
       const gasPrice = await this.getGasPrice(gasConfig, true, 0);
       initialEstimate = await this.client.estimateGas({
         account,
         ...request,
         ..._blobInputs,
-        maxFeePerBlobGas: gasPrice.maxFeePerBlobGas!,
+        maxFeePerBlobGas: gasPrice.maxFeePerBlobGas! * 2n,
         gas: MAX_L1_TX_LIMIT,
         blockTag: 'latest',
       });