@aztec/sequencer-client 0.0.1-commit.42ee6df9b → 0.0.1-commit.431c48d

package/src/config.ts

@@ -3,8 +3,10 @@ import { type L1ReaderConfig, l1ReaderConfigMappings } from '@aztec/ethereum/l1-
 import {
   type ConfigMappingsType,
   booleanConfigHelper,
+  floatConfigHelper,
   getConfigFromMappings,
   numberConfigHelper,
+  optionalNumberConfigHelper,
   pickConfigMappings,
 } from '@aztec/foundation/config';
 import { EthAddress } from '@aztec/foundation/eth-address';
@@ -13,12 +15,13 @@ import { type P2PConfig, p2pConfigMappings } from '@aztec/p2p/config';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
 import {
   type ChainConfig,
-  type PipelineConfig,
+  DEFAULT_BLOCK_DURATION_MS,
+  DEFAULT_MAX_BLOCKS_PER_CHECKPOINT,
   type SequencerConfig,
   chainConfigMappings,
-  pipelineConfigMappings,
   sharedSequencerConfigMappings,
 } from '@aztec/stdlib/config';
+import { MIN_PER_BLOCK_ALLOCATION_MULTIPLIER, MIN_PER_BLOCK_DA_ALLOCATION_MULTIPLIER } from '@aztec/stdlib/gas';
 import type { ResolvedSequencerConfig } from '@aztec/stdlib/interfaces/server';
 import { DEFAULT_P2P_PROPAGATION_TIME } from '@aztec/stdlib/timetable';
 import { type ValidatorClientConfig, validatorClientConfigMappings } from '@aztec/validator-client/config';
@@ -42,22 +45,31 @@ export const DefaultSequencerConfig = {
   minTxsPerBlock: 1,
   buildCheckpointIfEmpty: false,
   publishTxsWithProposals: false,
-  perBlockAllocationMultiplier: 1.2,
+  perBlockAllocationMultiplier: MIN_PER_BLOCK_ALLOCATION_MULTIPLIER,
+  perBlockDAAllocationMultiplier: MIN_PER_BLOCK_DA_ALLOCATION_MULTIPLIER,
   redistributeCheckpointBudget: true,
-  enforceTimeTable: true,
+  blockDurationMs: DEFAULT_BLOCK_DURATION_MS,
+  l1PublishingTime: 12,
+  checkpointProposalSyncGraceSeconds: 2 * (DEFAULT_BLOCK_DURATION_MS / 1000),
   attestationPropagationTime: DEFAULT_P2P_PROPAGATION_TIME,
   secondsBeforeInvalidatingBlockAsCommitteeMember: 144, // 12 L1 blocks
   secondsBeforeInvalidatingBlockAsNonCommitteeMember: 432, // 36 L1 blocks
   skipCollectingAttestations: false,
   skipInvalidateBlockAsProposer: false,
+  skipWaitForValidParentCheckpointOnL1: false,
   broadcastInvalidBlockProposal: false,
+  broadcastInvalidCheckpointProposalOnly: false,
   injectFakeAttestation: false,
   injectHighSValueAttestation: false,
   injectUnrecoverableSignatureAttestation: false,
+  injectYParityAttestation: false,
   fishermanMode: false,
+  governanceProposerForcePayloadVote: false,
   shuffleAttestationOrdering: false,
   skipPushProposedBlocksToArchiver: false,
   skipPublishingCheckpointsPercent: 0,
+  maxBlocksPerCheckpoint: DEFAULT_MAX_BLOCKS_PER_CHECKPOINT,
+  minPeersToPropose: 1,
 } satisfies ResolvedSequencerConfig;
 
 /**
@@ -70,7 +82,6 @@ export type SequencerClientConfig = SequencerPublisherConfig &
   SequencerConfig &
   L1ReaderConfig &
   ChainConfig &
-  PipelineConfig &
   Pick<P2PConfig, 'txPublicSetupAllowListExtend'> &
   Pick<L1ContractsConfig, 'ethereumSlotDuration' | 'aztecSlotDuration' | 'aztecEpochDuration'>;
 
@@ -83,7 +94,7 @@ export const sequencerConfigMappings: ConfigMappingsType<SequencerConfig> = {
   maxTxsPerCheckpoint: {
     env: 'SEQ_MAX_TX_PER_CHECKPOINT',
     description: 'The maximum number of txs across all blocks in a checkpoint.',
-    parseEnv: (val: string) => (val ? parseInt(val, 10) : undefined),
+    ...optionalNumberConfigHelper(),
   },
   minTxsPerBlock: {
     env: 'SEQ_MIN_TX_PER_BLOCK',
@@ -102,19 +113,26 @@ export const sequencerConfigMappings: ConfigMappingsType<SequencerConfig> = {
   maxL2BlockGas: {
     env: 'SEQ_MAX_L2_BLOCK_GAS',
     description: 'The maximum L2 block gas.',
-    parseEnv: (val: string) => (val ? parseInt(val, 10) : undefined),
+    ...optionalNumberConfigHelper(),
   },
   maxDABlockGas: {
     env: 'SEQ_MAX_DA_BLOCK_GAS',
     description: 'The maximum DA block gas.',
-    parseEnv: (val: string) => (val ? parseInt(val, 10) : undefined),
+    ...optionalNumberConfigHelper(),
   },
   perBlockAllocationMultiplier: {
     env: 'SEQ_PER_BLOCK_ALLOCATION_MULTIPLIER',
     description:
       'Per-block gas budget multiplier for both L2 and DA gas. Budget per block is (checkpointLimit / maxBlocks) * multiplier.' +
       ' Values greater than one allow early blocks to use more than their even share, relying on checkpoint-level capping for later blocks.',
-    ...numberConfigHelper(DefaultSequencerConfig.perBlockAllocationMultiplier),
+    ...floatConfigHelper(DefaultSequencerConfig.perBlockAllocationMultiplier),
+  },
+  perBlockDAAllocationMultiplier: {
+    env: 'SEQ_PER_BLOCK_DA_ALLOCATION_MULTIPLIER',
+    description:
+      'Per-block budget multiplier applied to DA gas and blob fields in place of perBlockAllocationMultiplier.' +
+      ' Defaults higher than the general multiplier so the largest contract class deploy fits a single block.',
+    ...floatConfigHelper(DefaultSequencerConfig.perBlockDAAllocationMultiplier),
   },
   redistributeCheckpointBudget: {
     env: 'SEQ_REDISTRIBUTE_CHECKPOINT_BUDGET',
@@ -124,12 +142,12 @@ export const sequencerConfigMappings: ConfigMappingsType<SequencerConfig> = {
   },
   coinbase: {
     env: 'COINBASE',
-    parseEnv: (val: string) => (val ? EthAddress.fromString(val) : undefined),
+    parseEnv: (val: string) => EthAddress.fromString(val),
     description: 'Recipient of block reward.',
   },
   feeRecipient: {
     env: 'FEE_RECIPIENT',
-    parseEnv: (val: string) => AztecAddress.fromString(val),
+    parseEnv: (val: string) => AztecAddress.fromStringUnsafe(val),
     description: 'Address to receive fees.',
   },
   acvmWorkingDirectory: {
@@ -140,25 +158,21 @@ export const sequencerConfigMappings: ConfigMappingsType<SequencerConfig> = {
     env: 'ACVM_BINARY_PATH',
     description: 'The path to the ACVM binary',
   },
-  enforceTimeTable: {
-    env: 'SEQ_ENFORCE_TIME_TABLE',
-    description: 'Whether to enforce the time table when building blocks',
-    ...booleanConfigHelper(DefaultSequencerConfig.enforceTimeTable),
-  },
   governanceProposerPayload: {
     env: 'GOVERNANCE_PROPOSER_PAYLOAD_ADDRESS',
     description: 'The address of the payload for the governanceProposer',
     parseEnv: (val: string) => EthAddress.fromString(val),
   },
+  governanceProposerForcePayloadVote: {
+    env: 'GOVERNANCE_PROPOSER_FORCE_PAYLOAD_VOTE',
+    description:
+      'Keep signalling the configured governance payload even if a proposal referencing it was already executed.',
+    ...booleanConfigHelper(DefaultSequencerConfig.governanceProposerForcePayloadVote),
+  },
   l1PublishingTime: {
     env: 'SEQ_L1_PUBLISHING_TIME_ALLOWANCE_IN_SLOT',
-    description: 'How much time (in seconds) we allow in the slot for publishing the L1 tx (defaults to 1 L1 slot).',
-    parseEnv: (val: string) => (val ? parseInt(val, 10) : undefined),
-  },
-  attestationPropagationTime: {
-    env: 'SEQ_ATTESTATION_PROPAGATION_TIME',
-    description: 'How many seconds it takes for proposals and attestations to travel across the p2p layer (one-way)',
-    ...numberConfigHelper(DefaultSequencerConfig.attestationPropagationTime),
+    description: 'How much time in seconds to allow in the slot for publishing the L1 transaction.',
+    ...numberConfigHelper(DefaultSequencerConfig.l1PublishingTime),
   },
   fakeProcessingDelayPerTxMs: {
     description: 'Used for testing to introduce a fake delay after processing each tx',
@@ -189,10 +203,25 @@ export const sequencerConfigMappings: ConfigMappingsType<SequencerConfig> = {
     description: 'Do not invalidate the previous block if invalid when we are the proposer (for testing only)',
     ...booleanConfigHelper(DefaultSequencerConfig.skipInvalidateBlockAsProposer),
   },
+  skipWaitForValidParentCheckpointOnL1: {
+    description:
+      'Bypass the parent checkpoint validity check before submitting a pipelined checkpoint, ' +
+      'allowing the proposer to publish even when the parent landed on L1 with invalid attestations (for testing only)',
+    ...booleanConfigHelper(DefaultSequencerConfig.skipWaitForValidParentCheckpointOnL1),
+  },
   broadcastInvalidBlockProposal: {
     description: 'Broadcast invalid block proposals with corrupted state (for testing only)',
     ...booleanConfigHelper(DefaultSequencerConfig.broadcastInvalidBlockProposal),
   },
+  invalidBlockProposalIndexWithinCheckpoint: {
+    description: 'Broadcast an invalid block proposal only at this indexWithinCheckpoint (for testing only)',
+    ...optionalNumberConfigHelper(),
+  },
+  broadcastInvalidCheckpointProposalOnly: {
+    description:
+      'Broadcast invalid checkpoint proposals while keeping the underlying block proposals valid (for testing only). When unset, the checkpoint follows broadcastInvalidBlockProposal.',
+    ...booleanConfigHelper(DefaultSequencerConfig.broadcastInvalidCheckpointProposalOnly),
+  },
   injectFakeAttestation: {
     description: 'Inject a fake attestation (for testing only)',
     ...booleanConfigHelper(DefaultSequencerConfig.injectFakeAttestation),
@@ -205,6 +234,10 @@ export const sequencerConfigMappings: ConfigMappingsType<SequencerConfig> = {
     description: 'Inject an attestation with an unrecoverable signature (for testing only)',
     ...booleanConfigHelper(DefaultSequencerConfig.injectUnrecoverableSignatureAttestation),
   },
+  injectYParityAttestation: {
+    description: 'Inject a non-proposer attestation slot in yParity form in the packed L1 tuple (for testing only)',
+    ...booleanConfigHelper(DefaultSequencerConfig.injectYParityAttestation),
+  },
   fishermanMode: {
     env: 'FISHERMAN_MODE',
     description:
@@ -222,7 +255,7 @@ export const sequencerConfigMappings: ConfigMappingsType<SequencerConfig> = {
     ...booleanConfigHelper(DefaultSequencerConfig.buildCheckpointIfEmpty),
   },
   skipPushProposedBlocksToArchiver: {
-    description: 'Skip pushing proposed blocks to archiver (default: true)',
+    description: 'Skip pushing proposed blocks to archiver (test only)',
     ...booleanConfigHelper(DefaultSequencerConfig.skipPushProposedBlocksToArchiver),
   },
   minBlocksForCheckpoint: {
@@ -233,18 +266,38 @@ export const sequencerConfigMappings: ConfigMappingsType<SequencerConfig> = {
     description: 'Percent probability (0 - 100) of sequencer skipping checkpoint publishing (testing only)',
     ...numberConfigHelper(DefaultSequencerConfig.skipPublishingCheckpointsPercent),
   },
+  skipBroadcastProposals: {
+    description: 'Skip broadcasting checkpoint and block proposals via gossipsub when proposer (for testing only)',
+    ...booleanConfigHelper(false),
+  },
+  skipBroadcastCheckpointProposal: {
+    description:
+      'Skip broadcasting only the CheckpointProposal via gossipsub when proposer; the held last block is broadcast ' +
+      'standalone instead so peers still receive it as a proposed-but-uncheckpointed tip (for testing only)',
+    ...booleanConfigHelper(false),
+  },
+  pauseProposingForSlots: {
+    description:
+      'List of slots for which the sequencer will not produce a proposal (for testing only). Attestation paths are unaffected.',
+  },
+  minPeersToPropose: {
+    env: 'SEQ_MIN_PEERS_TO_PROPOSE',
+    description:
+      'Minimum number of connected p2p peers required to build and propose a checkpoint (zero to disable the check).' +
+      ' Ignored when p2p is disabled by config.',
+    ...numberConfigHelper(DefaultSequencerConfig.minPeersToPropose),
+  },
   ...pickConfigMappings(p2pConfigMappings, ['txPublicSetupAllowListExtend']),
 };
 
 export const sequencerClientConfigMappings: ConfigMappingsType<SequencerClientConfig> = {
+  ...chainConfigMappings,
   ...validatorClientConfigMappings,
   ...sequencerConfigMappings,
   ...keyStoreConfigMappings,
   ...l1ReaderConfigMappings,
   ...sequencerTxSenderConfigMappings,
   ...sequencerPublisherConfigMappings,
-  ...chainConfigMappings,
-  ...pipelineConfigMappings,
   ...pickConfigMappings(l1ContractsConfigMappings, ['ethereumSlotDuration', 'aztecSlotDuration', 'aztecEpochDuration']),
 };
 

package/src/global_variable_builder/README.md

@@ -0,0 +1,44 @@
+# Fee Prediction
+
+The `FeePredictor` predicts min fees for upcoming L2 slots based on the current L1
+oracle state and an assumed mana usage pattern.
+
+## Prediction Window
+
+The prediction covers `LAG = 2` entries (the next available slot plus 1 more).
+A new oracle update can activate at `startSlot + LAG`, so only the first LAG entries
+are guaranteed stable. Beyond that, L1 fees could change unpredictably.
+
+Each entry uses:
+
+- The **actual L1 fees** the oracle would return for that slot's timestamp (pre or post,
+  depending on whether the slot is before or after `slotOfChange`).
+- A **configurable congestion assumption** (`ManaUsageEstimate`): none (0 mana), target
+  (steady state), or limit (worst case, 2x target).
+
+The client picks `max(predicted[0..LAG-1])` as their `maxFeesPerGas`.
+
+```
+predicted[0]  →  fee at next slot     (current oracle + current congestion)
+predicted[1]  →  fee at next slot + 1 (congestion may change based on usage estimate)
+```
+
+## Why LAG and not LIFETIME?
+
+The L1 gas oracle has two timing constants:
+
+- **LAG = 2 slots**: when new fees are queued, they activate LAG slots later
+- **LIFETIME = 5 slots**: after an oracle update, the next update is rejected until
+  `slotOfChange + (LIFETIME - LAG)` slots have passed
+
+If the oracle cooldown has already elapsed (i.e., no recent update), a new update can
+be enqueued at any moment. Its new values would activate LAG slots later. This means
+predictions beyond LAG slots could be invalidated by an oracle update that happens
+right after we query.
+
+With a LIFETIME-sized window, we'd give a false sense of coverage: the prediction
+would look like it covers 6 slots, but slots beyond LAG could be wrong if an update
+is enqueued after the prediction is computed.
+
+By limiting to LAG entries, we guarantee that all predicted L1 fees are the ones that
+will actually be used — no oracle update can change them within this window.

package/src/global_variable_builder/fee_predictor.ts

@@ -0,0 +1,182 @@
+import { type L1FeeData, MAX_FEE_ASSET_PRICE_MODIFIER_BPS, type RollupContract } from '@aztec/ethereum/contracts';
+import { SlotNumber } from '@aztec/foundation/branded-types';
+import { times } from '@aztec/foundation/collection';
+import type { DateProvider } from '@aztec/foundation/timer';
+import { getSlotAtNextL1Block, getTimestampForSlot } from '@aztec/stdlib/epoch-helpers';
+import {
+  FEE_ORACLE_LAG,
+  GasFees,
+  MIN_ETH_PER_FEE_ASSET,
+  ManaUsageEstimate,
+  computeExcessMana,
+  computeManaMinFee,
+} from '@aztec/stdlib/gas';
+
+/** Cached rollup state for fee prediction. Refreshed once per L1 block. */
+type FeeOracleState = {
+  lastSlot: SlotNumber;
+  excessMana: bigint;
+  ethPerFeeAsset: bigint;
+  manaTarget: bigint;
+  manaLimit: bigint;
+  provingCostPerManaEth: bigint;
+  epochDuration: bigint;
+  /** Pre-resolved L1 fees for each slot in the prediction window. */
+  l1FeesBySlot: L1FeeData[];
+};
+
+/**
+ * Predicts min fees for LAG upcoming slots based on the L1 oracle state.
+ * A new oracle update can activate at startSlot + LAG, so only the first LAG entries
+ * are guaranteed stable. Caches L1 queries per L1 block and recomputes predictions
+ * for each mana usage estimate.
+ */
+export class FeePredictor {
+  private cachedState: Promise<FeeOracleState> | undefined;
+  private cachedL1BlockNumber: bigint | undefined;
+
+  private readonly slotDuration: number;
+  private readonly l1GenesisTime: bigint;
+  private readonly ethereumSlotDuration: number;
+
+  constructor(
+    private readonly rollupContract: RollupContract,
+    private readonly publicClient: { getBlockNumber: (opts?: { cacheTime?: number }) => Promise<bigint> },
+    private readonly dateProvider: DateProvider,
+    config: { slotDuration: number; l1GenesisTime: bigint; ethereumSlotDuration: number },
+  ) {
+    this.slotDuration = config.slotDuration;
+    this.l1GenesisTime = config.l1GenesisTime;
+    this.ethereumSlotDuration = config.ethereumSlotDuration;
+  }
+
+  /** Returns predicted min fees for each slot in the prediction window. */
+  async getPredictedMinFees(manaUsage: ManaUsageEstimate): Promise<GasFees[]> {
+    const state = await this.getState();
+    return this.computePredictions(state, manaUsage);
+  }
+
+  /** Fetches and caches rollup state. Refreshes when L1 block number advances. */
+  private async getState(): Promise<FeeOracleState> {
+    const blockNumber = await this.publicClient.getBlockNumber({ cacheTime: 0 });
+    if (this.cachedL1BlockNumber === undefined || blockNumber > this.cachedL1BlockNumber) {
+      this.cachedL1BlockNumber = blockNumber;
+      // Reset the cached block number on failure so a transient L1 RPC error does not leave a
+      // rejected promise cached for this block, which would replay the same rejection on every
+      // subsequent call until the next L1 block arrives. Only clear it if it still points at the
+      // block this attempt was for, so a stale rejection from an older block cannot wipe a marker
+      // a newer call already advanced (which would also defeat the monotonic block-number guard).
+      this.cachedState = this.fetchState(blockNumber).catch(err => {
+        if (this.cachedL1BlockNumber === blockNumber) {
+          this.cachedL1BlockNumber = undefined;
+        }
+        throw err;
+      });
+    }
+    return this.cachedState!;
+  }
+
+  private async fetchState(blockNumber: bigint): Promise<FeeOracleState> {
+    // Pin all non-constant queries to this L1 block number for a consistent snapshot.
+    const opts = { blockNumber };
+
+    // Cached constants don't need pinning
+    const [manaTarget, manaLimit, provingCostPerManaEth, epochDuration] = await Promise.all([
+      this.rollupContract.getManaTarget(),
+      this.rollupContract.getManaLimit(),
+      this.rollupContract.getProvingCostPerMana(),
+      this.rollupContract.getEpochDuration(),
+    ]);
+
+    // First, compute the earliest possible nextSlot independently of the checkpoint, so we can
+    // evaluate pruneability at the prediction start timestamp instead of the current L1 block time.
+    // This avoids an epoch-boundary edge case where the effective parent differs between now and nextSlot.
+    const slotConfig = { slotDuration: this.slotDuration, l1GenesisTime: this.l1GenesisTime };
+    const currentSlot = await this.rollupContract.getSlotNumber(opts);
+
+    const slotAtNextL1Block = getSlotAtNextL1Block(BigInt(this.dateProvider.nowInSeconds()), {
+      l1GenesisTime: this.l1GenesisTime,
+      slotDuration: this.slotDuration,
+      ethereumSlotDuration: this.ethereumSlotDuration,
+    });
+    const preliminaryNextSlot = SlotNumber(Math.max(currentSlot, slotAtNextL1Block));
+    const nextSlotTimestamp = getTimestampForSlot(preliminaryNextSlot, slotConfig);
+
+    // Resolve the effective checkpoint at the prediction start timestamp
+    const lastCheckpoint = await this.rollupContract.getEffectivePendingCheckpoint(nextSlotTimestamp, opts);
+    const lastSlot = lastCheckpoint.slotNumber;
+    // Refine nextSlot: also account for the slot after the last checkpoint
+    const nextSlot = SlotNumber(Math.max(SlotNumber.add(lastSlot, 1), preliminaryNextSlot));
+    const feeHeader = lastCheckpoint.feeHeader;
+
+    const slotCount = FEE_ORACLE_LAG;
+    const timestamps = times(slotCount, i => getTimestampForSlot(SlotNumber.add(nextSlot, i), slotConfig));
+    const l1FeesBySlot = await Promise.all(timestamps.map(ts => this.rollupContract.getL1FeesAt(ts, opts)));
+
+    return {
+      lastSlot,
+      excessMana: computeExcessMana(feeHeader.excessMana, feeHeader.manaUsed, manaTarget),
+      ethPerFeeAsset: feeHeader.ethPerFeeAsset,
+      manaTarget,
+      manaLimit,
+      provingCostPerManaEth,
+      epochDuration: BigInt(epochDuration),
+      l1FeesBySlot,
+    };
+  }
+
+  /** Computes per-slot fee predictions given cached state and a mana usage assumption. */
+  private computePredictions(state: FeeOracleState, manaUsage: ManaUsageEstimate): GasFees[] {
+    const assumedManaUsed = this.getAssumedManaUsed(state, manaUsage);
+
+    const result: GasFees[] = [];
+    let { excessMana } = state;
+    let { ethPerFeeAsset } = state;
+
+    // Slot 0: current state (next available slot after last checkpoint)
+    result.push(this.computeGasFees(state, excessMana, ethPerFeeAsset, state.l1FeesBySlot[0]));
+
+    // Slots 1..LAG-1: advance excessMana with the assumed mana usage per checkpoint,
+    // and decay ethPerFeeAsset by MAX_FEE_ASSET_PRICE_MODIFIER_BPS per slot for conservative estimates.
+    // Lower ethPerFeeAsset means higher fees in fee asset terms.
+    for (let i = 1; i < state.l1FeesBySlot.length; i++) {
+      excessMana = computeExcessMana(excessMana, assumedManaUsed, state.manaTarget);
+      const decayed = (ethPerFeeAsset * (10000n - MAX_FEE_ASSET_PRICE_MODIFIER_BPS)) / 10000n;
+      ethPerFeeAsset = decayed < MIN_ETH_PER_FEE_ASSET ? MIN_ETH_PER_FEE_ASSET : decayed;
+      result.push(this.computeGasFees(state, excessMana, ethPerFeeAsset, state.l1FeesBySlot[i]));
+    }
+
+    return result;
+  }
+
+  private getAssumedManaUsed(state: FeeOracleState, manaUsage: ManaUsageEstimate): bigint {
+    switch (manaUsage) {
+      case ManaUsageEstimate.None:
+        return 0n;
+      case ManaUsageEstimate.Target:
+        return state.manaTarget;
+      case ManaUsageEstimate.Limit:
+        return state.manaLimit;
+    }
+  }
+
+  private computeGasFees(
+    state: FeeOracleState,
+    excessMana: bigint,
+    ethPerFeeAsset: bigint,
+    l1Fees: L1FeeData,
+  ): GasFees {
+    return new GasFees(
+      0,
+      computeManaMinFee({
+        l1BaseFee: l1Fees.baseFee,
+        l1BlobFee: l1Fees.blobFee,
+        manaTarget: state.manaTarget,
+        epochDuration: state.epochDuration,
+        provingCostPerManaEth: state.provingCostPerManaEth,
+        excessMana,
+        ethPerFeeAsset,
+      }),
+    );
+  }
+}

package/src/global_variable_builder/fee_provider.ts

@@ -0,0 +1,97 @@
+import { RollupContract } from '@aztec/ethereum/contracts';
+import type { ViemPublicClient } from '@aztec/ethereum/types';
+import { SlotNumber } from '@aztec/foundation/branded-types';
+import type { DateProvider } from '@aztec/foundation/timer';
+import { getNextL1SlotTimestamp } from '@aztec/stdlib/epoch-helpers';
+import { GasFees, ManaUsageEstimate } from '@aztec/stdlib/gas';
+import type { FeeProvider } from '@aztec/stdlib/tx';
+
+import { FeePredictor } from './fee_predictor.js';
+import type { GlobalVariableBuilderConfig } from './global_builder.js';
+
+/** Provides current and predicted fee information based on on-chain state. */
+export class FeeProviderImpl implements FeeProvider {
+  private currentMinFees: Promise<GasFees> = Promise.resolve(new GasFees(0, 0));
+  private currentL1BlockNumber: bigint | undefined = undefined;
+
+  private readonly rollupContract: RollupContract;
+  private readonly feePredictor: FeePredictor;
+  private readonly ethereumSlotDuration: number;
+  private readonly l1GenesisTime: bigint;
+
+  constructor(
+    private readonly dateProvider: DateProvider,
+    private readonly publicClient: ViemPublicClient,
+    config: GlobalVariableBuilderConfig,
+  ) {
+    this.ethereumSlotDuration = config.ethereumSlotDuration;
+    this.l1GenesisTime = config.l1GenesisTime;
+
+    this.rollupContract = new RollupContract(this.publicClient, config.rollupAddress);
+    this.feePredictor = new FeePredictor(this.rollupContract, this.publicClient, this.dateProvider, {
+      slotDuration: config.slotDuration,
+      l1GenesisTime: config.l1GenesisTime,
+      ethereumSlotDuration: config.ethereumSlotDuration,
+    });
+  }
+
+  /**
+   * Computes the "current" min fees, e.g., the price that you currently should pay to get include in the next block
+   * @returns Min fees for the next block
+   */
+  private async computeCurrentMinFees(): Promise<GasFees> {
+    // Since this might be called in the middle of a slot where a block might have been published,
+    // we need to fetch the last block written, and estimate the earliest timestamp for the next block.
+    // The timestamp of that last block will act as a lower bound for the next block.
+
+    const lastCheckpoint = await this.rollupContract.getPendingCheckpoint();
+    const earliestTimestamp = await this.rollupContract.getTimestampForSlot(
+      SlotNumber.fromBigInt(BigInt(lastCheckpoint.slotNumber) + 1n),
+    );
+    const nextEthTimestamp = getNextL1SlotTimestamp(this.dateProvider.nowInSeconds(), {
+      l1GenesisTime: this.l1GenesisTime,
+      ethereumSlotDuration: this.ethereumSlotDuration,
+    });
+    const timestamp = earliestTimestamp > nextEthTimestamp ? earliestTimestamp : nextEthTimestamp;
+
+    return new GasFees(0, await this.rollupContract.getManaMinFeeAt(timestamp, true));
+  }
+
+  public async getCurrentMinFees(): Promise<GasFees> {
+    // Get the current block number
+    const blockNumber = await this.publicClient.getBlockNumber({ cacheTime: 0 });
+
+    // If the L1 block number has changed then chain a new promise to get the current min fees.
+    // We chain off the previous promise's settlement (via a swallowing catch) rather than its
+    // fulfillment, so a prior rejection does not short-circuit the new computation. If the new
+    // computation fails (e.g. a transient L1 RPC error), reset the cached block number so the
+    // next call recomputes instead of permanently replaying the rejected promise — otherwise a
+    // single transient failure would wedge fee estimation until the next L1 block arrives. Only
+    // clear it if it still points at the block this attempt was for, so a stale rejection from an
+    // older block cannot wipe a marker a newer call already advanced (which would also defeat the
+    // monotonic block-number guard).
+    if (this.currentL1BlockNumber === undefined || blockNumber > this.currentL1BlockNumber) {
+      this.currentL1BlockNumber = blockNumber;
+      this.currentMinFees = this.currentMinFees
+        .catch(() => undefined)
+        .then(() =>
+          this.computeCurrentMinFees().catch(err => {
+            if (this.currentL1BlockNumber === blockNumber) {
+              this.currentL1BlockNumber = undefined;
+            }
+            throw err;
+          }),
+        );
+    }
+    return this.currentMinFees;
+  }
+
+  public async getPredictedMinFees(manaUsage?: ManaUsageEstimate): Promise<GasFees[]> {
+    const [currentMinFees, predictedMinFees] = await Promise.all([
+      this.getCurrentMinFees(),
+      this.feePredictor.getPredictedMinFees(manaUsage ?? ManaUsageEstimate.Target),
+    ]);
+
+    return [currentMinFees, ...predictedMinFees];
+  }
+}