@aztec/sequencer-client 0.0.0-test.1 → 0.0.1-commit.017a351

package/src/sequencer/checkpoint_proposal_job_metrics.ts

@@ -0,0 +1,128 @@
+import {
+  Attributes,
+  type Gauge,
+  type Histogram,
+  type Meter,
+  Metrics,
+  type TelemetryClient,
+} from '@aztec/telemetry-client';
+
+type CheckpointProposalJobInstruments = {
+  checkpointAttestationDelay: Histogram;
+  checkpointBuildDuration: Histogram;
+  checkpointStartToFirstBlockDuration: Histogram;
+  checkpointLastBlockToBroadcastDuration: Histogram;
+  pipelinedCheckpointBuildStartOffsetFromSlotBoundary: Histogram;
+  checkpointBlockCount: Gauge;
+  checkpointTxCount: Gauge;
+  checkpointTotalMana: Gauge;
+};
+
+/**
+ * Per-job recording surface used by {@link CheckpointProposalJob}.
+ *
+ * Ownership split:
+ * - {@link CheckpointProposalJobMetrics} owns the OpenTelemetry meter and instruments and should live for the
+ *   lifetime of the sequencer process.
+ * - A recorder owns only mutable timing state for one checkpoint proposal job so overlapping jobs cannot
+ *   overwrite each other's timing markers.
+ */
+export interface CheckpointProposalJobMetricsRecorder {
+  recordCheckpointAttestationDelay(durationMs: number): void;
+  recordCheckpointBuild(durationMs: number, blockCount: number, txCount: number, totalMana: number): void;
+  recordPipelinedCheckpointBuildStartOffsetFromSlotBoundary(offsetMs: number): void;
+  startCheckpointTiming(nowMs: number): void;
+  noteCheckpointBlockBuilt(nowMs: number, opts: { isFirstBlock: boolean; isLastBlock: boolean }): void;
+  noteCheckpointBroadcast(nowMs: number): void;
+}
+
+/**
+ * Concrete per-job recorder.
+ *
+ * This class should be short-lived: create one recorder per checkpoint proposal job and discard it when the job
+ * completes. It intentionally does not create instruments; it only holds the job-local timestamps needed to derive
+ * timing metrics safely.
+ */
+class CheckpointProposalJobMetricsRecorderImpl implements CheckpointProposalJobMetricsRecorder {
+  private checkpointStartedAt?: number;
+  private checkpointLastBlockBuiltAt?: number;
+
+  constructor(private readonly instruments: CheckpointProposalJobInstruments) {}
+
+  public recordCheckpointAttestationDelay(durationMs: number) {
+    this.instruments.checkpointAttestationDelay.record(Math.ceil(durationMs));
+  }
+
+  public recordCheckpointBuild(durationMs: number, blockCount: number, txCount: number, totalMana: number) {
+    this.instruments.checkpointBuildDuration.record(Math.ceil(durationMs));
+    this.instruments.checkpointBlockCount.record(blockCount);
+    this.instruments.checkpointTxCount.record(txCount);
+    this.instruments.checkpointTotalMana.record(totalMana);
+  }
+
+  public recordPipelinedCheckpointBuildStartOffsetFromSlotBoundary(offsetMs: number) {
+    this.instruments.pipelinedCheckpointBuildStartOffsetFromSlotBoundary.record(Math.ceil(Math.abs(offsetMs)), {
+      [Attributes.SLOT_BOUNDARY_SIDE]: offsetMs < 0 ? 'before' : 'after',
+    });
+  }
+
+  public startCheckpointTiming(nowMs: number) {
+    this.checkpointStartedAt = nowMs;
+    this.checkpointLastBlockBuiltAt = undefined;
+  }
+
+  public noteCheckpointBlockBuilt(nowMs: number, opts: { isFirstBlock: boolean; isLastBlock: boolean }) {
+    if (opts.isFirstBlock && this.checkpointStartedAt !== undefined) {
+      this.instruments.checkpointStartToFirstBlockDuration.record(Math.ceil(nowMs - this.checkpointStartedAt));
+    }
+
+    if (opts.isLastBlock) {
+      this.checkpointLastBlockBuiltAt = nowMs;
+    }
+  }
+
+  public noteCheckpointBroadcast(nowMs: number) {
+    if (this.checkpointLastBlockBuiltAt !== undefined) {
+      this.instruments.checkpointLastBlockToBroadcastDuration.record(
+        Math.ceil(nowMs - this.checkpointLastBlockBuiltAt),
+      );
+    }
+
+    this.checkpointLastBlockBuiltAt = undefined;
+  }
+}
+
+/**
+ * Long-lived owner of checkpoint proposal job telemetry instruments.
+ *
+ * The sequencer should construct this once and reuse it across jobs. Each call to {@link createRecorder} returns a
+ * lightweight recorder with isolated mutable state for a single checkpoint proposal job.
+ */
+export class CheckpointProposalJobMetrics {
+  private readonly meter: Meter;
+  private readonly instruments: CheckpointProposalJobInstruments;
+
+  constructor(client: TelemetryClient, name = 'CheckpointProposalJob') {
+    this.meter = client.getMeter(name);
+    this.instruments = {
+      checkpointAttestationDelay: this.meter.createHistogram(Metrics.SEQUENCER_CHECKPOINT_ATTESTATION_DELAY),
+      checkpointBuildDuration: this.meter.createHistogram(Metrics.SEQUENCER_CHECKPOINT_BUILD_DURATION),
+      checkpointStartToFirstBlockDuration: this.meter.createHistogram(
+        Metrics.SEQUENCER_CHECKPOINT_START_TO_FIRST_BLOCK_DURATION,
+      ),
+      checkpointLastBlockToBroadcastDuration: this.meter.createHistogram(
+        Metrics.SEQUENCER_CHECKPOINT_LAST_BLOCK_TO_BROADCAST_DURATION,
+      ),
+      pipelinedCheckpointBuildStartOffsetFromSlotBoundary: this.meter.createHistogram(
+        Metrics.SEQUENCER_PIPELINED_CHECKPOINT_BUILD_START_OFFSET_FROM_SLOT_BOUNDARY,
+      ),
+      checkpointBlockCount: this.meter.createGauge(Metrics.SEQUENCER_CHECKPOINT_BLOCK_COUNT),
+      checkpointTxCount: this.meter.createGauge(Metrics.SEQUENCER_CHECKPOINT_TX_COUNT),
+      checkpointTotalMana: this.meter.createGauge(Metrics.SEQUENCER_CHECKPOINT_TOTAL_MANA),
+    };
+  }
+
+  public createRecorder(): CheckpointProposalJobMetricsRecorder {
+    return new CheckpointProposalJobMetricsRecorderImpl(this.instruments);
+  }
+}

package/src/sequencer/checkpoint_voter.ts

@@ -0,0 +1,119 @@
+import type { SlotNumber } from '@aztec/foundation/branded-types';
+import type { EthAddress } from '@aztec/foundation/eth-address';
+import type { Logger } from '@aztec/foundation/log';
+import type { SlasherClientInterface } from '@aztec/slasher';
+import type { ResolvedSequencerConfig } from '@aztec/stdlib/interfaces/server';
+import type { ValidatorClient } from '@aztec/validator-client';
+import { DutyAlreadySignedError } from '@aztec/validator-ha-signer/errors';
+import { DutyType, type SigningContext } from '@aztec/validator-ha-signer/types';
+
+import type { TypedDataDefinition } from 'viem';
+
+import type { SequencerPublisher } from '../publisher/sequencer-publisher.js';
+import type { SequencerMetrics } from './metrics.js';
+import type { SequencerRollupConstants } from './types.js';
+
+/**
+ * Handles governance and slashing voting for a given slot.
+ */
+export class CheckpointVoter {
+  private governanceSigner: (msg: TypedDataDefinition) => Promise<`0x${string}`>;
+  private slashingSigner: (msg: TypedDataDefinition) => Promise<`0x${string}`>;
+
+  constructor(
+    private readonly slot: SlotNumber,
+    private readonly publisher: SequencerPublisher,
+    private readonly attestorAddress: EthAddress,
+    private readonly validatorClient: ValidatorClient,
+    private readonly slasherClient: SlasherClientInterface | undefined,
+    private readonly l1Constants: SequencerRollupConstants,
+    private readonly config: ResolvedSequencerConfig,
+    private readonly metrics: SequencerMetrics,
+    private readonly log: Logger,
+  ) {
+    // Create separate signers with appropriate duty contexts for governance and slashing votes
+    // These use HA protection to ensure only one node signs per slot/duty
+    const governanceContext: SigningContext = { slot: this.slot, dutyType: DutyType.GOVERNANCE_VOTE };
+    this.governanceSigner = (msg: TypedDataDefinition) =>
+      this.validatorClient.signWithAddress(this.attestorAddress, msg, governanceContext).then(s => s.toString());
+
+    const slashingContext: SigningContext = { slot: this.slot, dutyType: DutyType.SLASHING_VOTE };
+    this.slashingSigner = (msg: TypedDataDefinition) =>
+      this.validatorClient.signWithAddress(this.attestorAddress, msg, slashingContext).then(s => s.toString());
+  }
+
+  /**
+   * Enqueues governance and slashing votes with the publisher.
+   * Returns a tuple of promises that resolve to whether each vote was successfully enqueued.
+   */
+  enqueueVotes(): [Promise<boolean | undefined>, Promise<boolean | undefined>] {
+    try {
+      const enqueueGovernancePromise = this.enqueueGovernanceVote();
+      const enqueueSlashingPromise = this.enqueueSlashingVote();
+
+      return [enqueueGovernancePromise, enqueueSlashingPromise];
+    } catch (err) {
+      this.log.error(`Error enqueueing governance and slashing votes`, err);
+      return [Promise.resolve(false), Promise.resolve(false)];
+    }
+  }
+
+  private async enqueueGovernanceVote(): Promise<boolean | undefined> {
+    const governanceProposerPayload = this.config.governanceProposerPayload;
+    if (!governanceProposerPayload || governanceProposerPayload.isZero()) {
+      return undefined;
+    }
+
+    this.log.info(`Enqueuing vote for ${governanceProposerPayload} governance for slot ${this.slot}`, {
+      slot: this.slot,
+      governanceProposerPayload: governanceProposerPayload.toString(),
+    });
+
+    try {
+      return await this.publisher.enqueueGovernanceCastSignal(
+        governanceProposerPayload,
+        this.slot,
+        this.attestorAddress,
+        this.governanceSigner,
+      );
+    } catch (err) {
+      if (err instanceof DutyAlreadySignedError) {
+        this.log.info(`Governance vote already signed by another node`, {
+          slot: this.slot,
+          signedByNode: err.signedByNode,
+        });
+      } else {
+        this.log.error(`Error enqueueing governance vote`, err);
+      }
+      return false;
+    }
+  }
+
+  private async enqueueSlashingVote(): Promise<boolean | undefined> {
+    try {
+      const actions = await this.slasherClient?.getProposerActions(this.slot);
+      if (!actions || actions.length === 0) {
+        return undefined;
+      }
+
+      this.log.info(`Enqueuing vote for ${actions.length} slashing actions for slot ${this.slot}`, {
+        slot: this.slot,
+        actionCount: actions.length,
+      });
+
+      this.metrics.recordSlashingAttempt(actions.length);
+
+      return await this.publisher.enqueueSlashingActions(actions, this.slot, this.attestorAddress, this.slashingSigner);
+    } catch (err) {
+      if (err instanceof DutyAlreadySignedError) {
+        this.log.info(`Slashing vote already signed by another node`, {
+          slot: this.slot,
+          signedByNode: err.signedByNode,
+        });
+      } else {
+        this.log.error(`Error enqueueing slashing vote`, err);
+      }
+      return false;
+    }
+  }
+}

package/src/sequencer/config.ts

@@ -1 +1,9 @@
+import type { GovernanceProposerContract } from '@aztec/ethereum/contracts';
+import type { RollupContract } from '@aztec/ethereum/contracts/rollup';
+
 export { type SequencerConfig } from '@aztec/stdlib/config';
+
+export type SequencerContracts = {
+  rollupContract: RollupContract;
+  governanceProposerContract: GovernanceProposerContract;
+};

package/src/sequencer/errors.ts

@@ -0,0 +1,21 @@
+import type { SequencerState } from './utils.js';
+
+export class SequencerTooSlowError extends Error {
+  constructor(
+    public readonly proposedState: SequencerState,
+    public readonly maxAllowedTime: number,
+    public readonly currentTime: number,
+  ) {
+    super(
+      `Too far into slot for ${proposedState} (time into slot ${currentTime}s greater than ${maxAllowedTime}s allowance)`,
+    );
+    this.name = 'SequencerTooSlowError';
+  }
+}
+
+export class SequencerInterruptedError extends Error {
+  constructor() {
+    super(`Sequencer was interrupted`);
+    this.name = 'SequencerInterruptedError';
+  }
+}

package/src/sequencer/events.ts

@@ -0,0 +1,76 @@
+import type { BlockNumber, CheckpointNumber, IndexWithinCheckpoint, SlotNumber } from '@aztec/foundation/branded-types';
+import type { BlockHash } from '@aztec/stdlib/block';
+
+import type { Action } from '../publisher/sequencer-publisher.js';
+import type { SequencerState } from './utils.js';
+
+export type SequencerEvents = {
+  ['state-changed']: (args: {
+    oldState: SequencerState;
+    newState: SequencerState;
+    secondsIntoSlot?: number;
+    slot?: SlotNumber;
+    timeReferenceSlot?: SlotNumber;
+  }) => void;
+  /**
+   * Emitted by the sequencer once it has decided it is going to attempt to build a
+   * checkpoint for `targetSlot`, after computing the L1 simulation overrides used by
+   * `canProposeAt`. Fired BEFORE the L1 simulation is run, so consumers can observe the
+   * decision regardless of whether the propose ultimately lands.
+   *
+   * - `hadProposedParent` indicates whether the build saw a proposed (pipelined) parent
+   *   checkpoint that hasn't landed on L1 yet.
+   * - `provenOverride` is the assumed proven checkpoint number pinned for the L1
+   *   simulation. The plan always pins both chain tips to short-circuit `canPruneAtTime`,
+   *   so this is populated whenever a simulation plan was built — the value either
+   *   matches the on-chain proven snapshot (defensive pin) or the assumed-proven
+   *   checkpoint when building optimistically across a pruning boundary.
+   * - `simulatedPending` is the pending checkpoint passed to L1 simulation. The plan
+   *   always pins both chain tips to short-circuit `canPruneAtTime`, so this reflects
+   *   either the pipelined/invalidated tip or the on-chain pending snapshot.
+   */
+  ['preparing-checkpoint']: (args: {
+    targetSlot: SlotNumber;
+    checkpointNumber: CheckpointNumber;
+    hadProposedParent: boolean;
+    provenOverride: CheckpointNumber | undefined;
+    simulatedPending: CheckpointNumber | undefined;
+  }) => void;
+  ['proposer-rollup-check-failed']: (args: { reason: string; slot: SlotNumber }) => void;
+  ['block-tx-count-check-failed']: (args: { minTxs: number; availableTxs: number; slot: SlotNumber }) => void;
+  ['block-build-failed']: (args: { reason: string; slot: SlotNumber }) => void;
+  ['block-proposed']: (args: {
+    blockNumber: BlockNumber;
+    blockHash: BlockHash;
+    checkpointNumber: CheckpointNumber;
+    indexWithinCheckpoint: IndexWithinCheckpoint;
+    slot: SlotNumber;
+    buildSlot: SlotNumber;
+  }) => void;
+  ['checkpoint-empty']: (args: { slot: SlotNumber }) => void;
+  /**
+   * Emitted when the proposer's pre-broadcast `validateBlockHeader` simulation fails. This is a
+   * last-chance check before we gossip a checkpoint proposal: a failure here means the header
+   * would not be accepted by L1 (e.g. archive mismatch, stale chain tip, or some other state
+   * drift between when we built the checkpoint and when we are about to broadcast it).
+   */
+  ['header-validation-failed']: (args: {
+    slot: SlotNumber;
+    checkpointNumber: CheckpointNumber;
+    reason: string;
+  }) => void;
+  ['checkpoint-publish-failed']: (args: {
+    slot: SlotNumber;
+    successfulActions?: Action[];
+    failedActions?: Action[];
+    sentActions?: Action[];
+    expiredActions?: Action[];
+  }) => void;
+  ['checkpoint-published']: (args: { checkpoint: CheckpointNumber; slot: SlotNumber }) => void;
+  ['checkpoint-error']: (args: { error: Error }) => void;
+  ['pipelined-checkpoint-discarded']: (args: {
+    slot: SlotNumber;
+    checkpointNumber: CheckpointNumber;
+    reason: string;
+  }) => void;
+};

package/src/sequencer/index.ts

@@ -1,3 +1,7 @@
+export * from './automine/automine_factory.js';
+export * from './automine/automine_sequencer.js';
+export * from './checkpoint_proposal_job.js';
+export * from './checkpoint_voter.js';
 export * from './config.js';
+export * from './events.js';
 export * from './sequencer.js';
-export * from './allowed.js';