@aztec/stdlib 0.0.1-commit.9ef841308 → 0.0.1-commit.a4600f49

package/src/block/l2_block_stream/event_driven_l2_block_stream.ts

@@ -0,0 +1,207 @@
+import { type Logger, createLogger } from '@aztec/foundation/log';
+import { RunningPromise } from '@aztec/foundation/running-promise';
+
+import type { BlockData } from '../block_data.js';
+import type { L2Block } from '../l2_block.js';
+import {
+  type ArchiverEmitter,
+  type BlockQuery,
+  type BlocksQuery,
+  type L2BlockSource,
+  type L2BlockSourceEventEmitter,
+  L2BlockSourceEvents,
+  type L2BlockSourceUpdatedEvent,
+  type L2Tips,
+} from '../l2_block_source.js';
+import { type L2BlockStreamEventHandler, type L2BlockStreamLocalDataProvider, localTipsMatch } from './interfaces.js';
+import { L2BlockStream, type L2BlockStreamOptions, type L2BlockStreamSource } from './l2_block_stream.js';
+
+/** Derives the metadata-only {@link BlockData} view of a hydrated {@link L2Block}. */
+async function l2BlockToBlockData(block: L2Block): Promise<BlockData> {
+  return {
+    header: block.header,
+    archive: block.archive,
+    blockHash: await block.hash(),
+    checkpointNumber: block.checkpointNumber,
+    indexWithinCheckpoint: block.indexWithinCheckpoint,
+  };
+}
+
+/** Returns the event emitter of a source that exposes one, or undefined for plain (e.g. RPC-backed) sources. */
+function getEmitter(source: L2BlockSource | L2BlockSourceEventEmitter): ArchiverEmitter | undefined {
+  return 'events' in source ? source.events : undefined;
+}
+
+/** Fast-path context for a single sync pass: blocks to serve by number, plus the tips to report as the source's. */
+type ActiveUpdate = { byNumber: Map<number, L2Block>; toTips: L2Tips };
+
+/**
+ * Wraps a block source so a single sync pass can be served from blocks delivered by an aggregate update event,
+ * avoiding round-trips to archiver storage. The fast path is only armed (via {@link activate}) for a pass that is
+ * confirmed caught up to the event's pre-pass tips: in that case the event's `blocksAdded` contiguously cover the
+ * pass's download range and `toTips` is the exact post-pass tip, so `getL2Tips` can report it without querying the
+ * source. When the fast path is not armed, every read delegates to the source, so a stale or partial cache never
+ * changes the sync outcome.
+ */
+class HotBlockSourceAdapter implements L2BlockStreamSource {
+  /** Set for the duration of one fast-path pass; undefined when reads must delegate to the source. */
+  private active: ActiveUpdate | undefined;
+
+  constructor(
+    private readonly source: L2BlockStreamSource,
+    private readonly log: Logger,
+  ) {}
+
+  /** Arms the fast path for the current pass: serve these blocks and report `toTips` as the source tips. */
+  public activate(blocks: readonly L2Block[], toTips: L2Tips): void {
+    const byNumber = new Map<number, L2Block>();
+    for (const block of blocks) {
+      byNumber.set(block.number, block);
+    }
+    this.active = { byNumber, toTips };
+    this.log.trace(`Armed hot-block fast path`, { blocks: byNumber.size, toTips });
+  }
+
+  /** Disarms the fast path so subsequent reads delegate to the source again. */
+  public deactivate(): void {
+    this.active = undefined;
+  }
+
+  public getL2Tips(): Promise<L2Tips> {
+    return this.active ? Promise.resolve(this.active.toTips) : this.source.getL2Tips();
+  }
+
+  public getBlocks(query: BlocksQuery): Promise<L2Block[]> {
+    const served = this.active ? this.tryServeBlocksFromCache(query) : undefined;
+    return served ? Promise.resolve(served) : this.source.getBlocks(query);
+  }
+
+  public getBlockData(query: BlockQuery): Promise<BlockData | undefined> {
+    if (this.active && 'number' in query) {
+      const block = this.active.byNumber.get(query.number);
+      if (block) {
+        return l2BlockToBlockData(block);
+      }
+    }
+    return this.source.getBlockData(query);
+  }
+
+  /** Serves a block range from the cache only when it is fully covered by contiguous cached blocks. */
+  private tryServeBlocksFromCache(query: BlocksQuery): L2Block[] | undefined {
+    // Only the by-range form is cacheable, and only for the full (not checkpointed-only) chain: the cache may hold
+    // uncheckpointed blocks that an onlyCheckpointed query must not receive.
+    if (!this.active || !('from' in query) || query.onlyCheckpointed) {
+      return undefined;
+    }
+    const from = query.from;
+    const to = from + query.limit - 1;
+    const blocks: L2Block[] = [];
+    for (let n = from; n <= to; n++) {
+      const block = this.active.byNumber.get(n);
+      if (!block) {
+        // A gap inside the requested range: bail out and let the source serve the whole range.
+        return undefined;
+      }
+      blocks.push(block);
+    }
+    return blocks;
+  }
+}
+
+/**
+ * Event-driven wrapper around {@link L2BlockStream}. Subscribes to the source's aggregate `l2BlockSourceUpdated`
+ * event (when the source exposes one) to trigger an immediate reconciliation, while keeping the periodic poll as
+ * the correctness fallback. Subsystems keep consuming the same {@link L2BlockStreamEvent}s; the archiver aggregate
+ * event is handled entirely here.
+ *
+ * The event is passed through to the sync pass via {@link RunningPromise.trigger}. If, at the time the pass runs,
+ * the stream's local tips match the event's `fromTips` (it is caught up to where the event began), the event's
+ * hydrated blocks are served back through a hot-block cache and the event's `toTips` is reported as the source tips
+ * — so the triggered sync re-reads neither block bodies nor tips from the archiver. Otherwise the pass delegates
+ * entirely to the source, and the periodic poll guarantees eventual catch-up.
+ */
+export class EventDrivenL2BlockStream {
+  private readonly adapter: HotBlockSourceAdapter;
+  private readonly blockStream: L2BlockStream;
+  private readonly runningPromise: RunningPromise<L2BlockSourceUpdatedEvent>;
+  private readonly emitter: ArchiverEmitter | undefined;
+  private started = false;
+
+  private readonly onSourceUpdated = (event: L2BlockSourceUpdatedEvent) => {
+    // Fire-and-forget: trigger coalesces with any in-flight or periodic pass (see RunningPromise.trigger), so a
+    // burst of events does not run passes concurrently. Errors are swallowed by the inner stream's own handler.
+    void this.runningPromise
+      .trigger(event)
+      .catch(err => this.log.error(`Error in event-triggered block stream sync`, err));
+  };
+
+  constructor(
+    source: L2BlockSource | L2BlockSourceEventEmitter,
+    private readonly localData: L2BlockStreamLocalDataProvider,
+    handler: L2BlockStreamEventHandler,
+    private readonly log = createLogger('types:event_driven_block_stream'),
+    opts: L2BlockStreamOptions = {},
+  ) {
+    this.adapter = new HotBlockSourceAdapter(source, log);
+    // The inner stream's own RunningPromise is never started; this wrapper owns the polling loop and drives the
+    // stream through `sync()` (which runs `work()` directly when the inner loop is stopped).
+    this.blockStream = new L2BlockStream(this.adapter, localData, handler, log, opts);
+    this.runningPromise = new RunningPromise<L2BlockSourceUpdatedEvent>(
+      this.runPass.bind(this),
+      log,
+      opts.pollIntervalMS ?? 1000,
+    );
+    this.emitter = getEmitter(source);
+  }
+
+  public start(): void {
+    if (this.started) {
+      this.log.warn(`Attempted to start an already-started event-driven block stream`);
+      return;
+    }
+    this.started = true;
+    this.emitter?.on(L2BlockSourceEvents.L2BlockSourceUpdated, this.onSourceUpdated);
+    this.runningPromise.start();
+  }
+
+  public async stop(): Promise<void> {
+    this.started = false;
+    this.emitter?.off(L2BlockSourceEvents.L2BlockSourceUpdated, this.onSourceUpdated);
+    await this.runningPromise.stop();
+    await this.blockStream.stop();
+  }
+
+  public isRunning(): boolean {
+    return this.runningPromise.isRunning();
+  }
+
+  /**
+   * Runs a synchronization pass now, bypassing the poll interval, and resolves once that pass completes. Concurrent
+   * callers and periodic ticks coalesce onto a single pass; a caller that coalesces onto an already in-flight pass
+   * can resolve against a pass that began just before it, so this guarantees freshness only up to that coalescing
+   * window. The periodic poll and per-pass reorg handling make the gap a latency effect, never a correctness one.
+   */
+  public sync(): Promise<void> {
+    return this.runningPromise.trigger();
+  }
+
+  /**
+   * Runs a single pass over the underlying block stream. When triggered by an aggregate event and the stream is
+   * caught up to the event's pre-pass tips, the event's blocks and tips serve the pass directly; the fast path is
+   * always disarmed afterwards so a subsequent poll-driven pass reads from the source.
+   */
+  private async runPass(event?: L2BlockSourceUpdatedEvent): Promise<void> {
+    if (event) {
+      const localTips = await this.localData.getL2Tips();
+      if (localTipsMatch(localTips, event.fromTips)) {
+        this.adapter.activate(event.blocksAdded, event.toTips);
+      }
+    }
+
+    try {
+      await this.blockStream.sync();
+    } finally {
+      this.adapter.deactivate();
+    }
+  }
+}

package/src/block/l2_block_stream/index.ts

@@ -1,3 +1,4 @@
+export * from './event_driven_l2_block_stream.js';
 export * from './interfaces.js';
 export * from './l2_block_stream.js';
 export * from './l2_tips_memory_store.js';

package/src/block/l2_block_stream/interfaces.ts

@@ -1,11 +1,72 @@
-import type { PublishedCheckpoint } from '../../checkpoint/published_checkpoint.js';
+import type { BlockNumber } from '@aztec/foundation/branded-types';
+
 import type { L2Block } from '../l2_block.js';
-import type { CheckpointId, L2BlockId, L2Tips } from '../l2_block_source.js';
+import type { CheckpointId, L2BlockId, L2TipId, L2Tips, LocalL2Tips } from '../l2_block_source.js';
+
+/** Provides the current chain tips. Implemented by world-state, l2-tips-store, and AztecNode. */
+export interface L2TipsProvider {
+  getL2Tips(): Promise<LocalL2Tips>;
+}
+
+/**
+ * A block id reported by a local data provider, whose hash may be unknown when the provider cannot resolve it (e.g.
+ * world-state cannot resolve the hash of a proven tip ahead of its synced range).
+ */
+export type LocalL2BlockId = { number: BlockNumber; hash?: string };
+
+/**
+ * Minimal local view of the chain the block stream needs to drive sync. `checkpointed` is only required when the
+ * stream emits checkpoint events (i.e. `ignoreCheckpoints` is off).
+ */
+export type LocalChainTips = {
+  proposed: LocalL2BlockId;
+  checkpointed?: { block: LocalL2BlockId; checkpoint: CheckpointId };
+  proven: { block: LocalL2BlockId };
+  finalized: { block: LocalL2BlockId };
+};
 
-/** Interface to the local view of the chain. Implemented by world-state and l2-tips-store. */
+/**
+ * Interface to the local view of the chain. Implemented by world-state and l2-tips-store. Anything implementing
+ * {@link L2TipsProvider} also satisfies this contract structurally, since {@link LocalL2Tips} is assignable to
+ * {@link LocalChainTips}.
+ */
 export interface L2BlockStreamLocalDataProvider {
+  getL2Tips(): Promise<LocalChainTips>;
   getL2BlockHash(number: number): Promise<string | undefined>;
-  getL2Tips(): Promise<L2Tips>;
+}
+
+/**
+ * Returns whether a local block id differs from a source block id. Compares block number and, when the local hash is
+ * known, block hash. The hash comparison is skipped when the local hash is undefined: world-state legitimately
+ * reports `undefined` hashes for tips ahead of its synced range, and comparing against an undefined hash would treat
+ * such a tip as different on every poll. An `undefined` local block (no local tip yet) always counts as differing.
+ */
+export function localBlockIdDiffers(localBlock: LocalL2BlockId | undefined, sourceBlock: L2BlockId): boolean {
+  if (localBlock === undefined) {
+    return true;
+  }
+  if (sourceBlock.number !== localBlock.number) {
+    return true;
+  }
+  if (localBlock.hash === undefined) {
+    return false;
+  }
+  return sourceBlock.hash !== localBlock.hash;
+}
+
+/**
+ * Returns whether the local chain tips agree with the given source tips on every tier the local provider exposes.
+ * Each tier is compared at the block level via {@link localBlockIdDiffers} (so an unresolved local hash matches on
+ * number alone); checkpoint ids are not compared, mirroring the stream's own tier reconciliation. The optional
+ * `checkpointed` tier is only compared when present (it is absent when the stream ignores checkpoints).
+ */
+export function localTipsMatch(local: LocalChainTips, source: L2Tips): boolean {
+  return (
+    !localBlockIdDiffers(local.proposed, source.proposed) &&
+    (local.checkpointed === undefined || !localBlockIdDiffers(local.checkpointed.block, source.checkpointed.block)) &&
+    !localBlockIdDiffers(local.proven.block, source.proven.block) &&
+    !localBlockIdDiffers(local.finalized.block, source.finalized.block)
+  );
 }
 
 /** Interface to a handler of events emitted. */
@@ -18,27 +79,56 @@ export type L2BlockStreamEvent =
       type: 'blocks-added';
       blocks: L2Block[];
     }
-  | /** Emits checkpoints published to L1. */ {
+  | /**
+   * Reports the new proposed tip of the chain. Emitted once per sync pass when the source's proposed tip differs
+   * from the pre-pass local one (downloads, a prune, or a thin tip movement). Carries only the block id; in block
+   * mode the corresponding payloads arrive via preceding `blocks-added` events, while in tips-only mode this is the
+   * sole signal that the proposed tip moved. Consumers that only track the proposed tip can ignore `blocks-added`
+   * entirely and anchor on this event instead.
+   */ {
+      type: 'chain-proposed';
+      block: L2BlockId;
+    }
+  | /**
+   * Reports a new checkpointed tip. Emitted at most once per sync pass when the source's checkpointed tip
+   * leads the local one. Carries only the block + checkpoint ids; consumers that need the full checkpoint
+   * payload fetch it on demand from the block source.
+   */ {
       type: 'chain-checkpointed';
-      checkpoint: PublishedCheckpoint;
       block: L2BlockId;
+      checkpoint: CheckpointId;
     }
   | /**
    * Reports last correct block (new tip of the proposed chain). Note that this is not necessarily the anchor block
    * that will be used in the transaction - if the chain has already moved past the reorg, we'll also see blocks-added
-   * events that will push the anchor block forward.
+   * events that will push the anchor block forward. `block` is the prune target (the new proposed tip); `checkpointed`
+   * and `proven` are the source's confirmed checkpointed and proven tips (each a block and checkpoint id). Each is used
+   * to clamp the corresponding local cursor when it leads the source tip, so a cursor never overshoots its own source
+   * frontier during a prune (the source guarantees proven <= checkpointed).
    */ {
       type: 'chain-pruned';
       block: L2BlockId;
-      checkpoint: CheckpointId;
+      checkpointed: L2TipId;
+      proven: L2TipId;
     }
   | /** Reports new proven block. */ {
       type: 'chain-proven';
       block: L2BlockId;
+      checkpoint: CheckpointId;
     }
   | /** Reports new finalized block (proven and finalized on L1). */ {
       type: 'chain-finalized';
       block: L2BlockId;
+      checkpoint: CheckpointId;
     };
 
-export type L2TipsStore = L2BlockStreamEventHandler & L2BlockStreamLocalDataProvider;
+export type L2TipsStore = L2BlockStreamEventHandler &
+  L2TipsProvider &
+  Pick<L2BlockStreamLocalDataProvider, 'getL2BlockHash'> & {
+    /**
+     * Records `(number → hash)` witnesses into the walk-back hash index without moving any tip cursor. Consumers that
+     * materialize per-height state should record a witness for each height they materialize, so a reorg below the
+     * nearest sparse anchor does not produce an over-deep prune event. See {@link L2TipsStoreBase.recordBlockHashes}.
+     */
+    recordBlockHashes(blocks: L2BlockId[]): Promise<void>;
+  };