@aztec/stdlib 0.0.1-commit.a072138 → 0.0.1-commit.a5db02d

package/src/tx/tx_receipt.ts

@@ -1,10 +1,21 @@
-import { BlockNumber, BlockNumberSchema } from '@aztec/foundation/branded-types';
+import {
+  BlockNumber,
+  BlockNumberSchema,
+  EpochNumber,
+  EpochNumberSchema,
+  SlotNumber,
+  SlotNumberSchema,
+} from '@aztec/foundation/branded-types';
+import type { DefineIfFlag, FieldsOf, PickDefined } from '@aztec/foundation/types';
 
 import { z } from 'zod';
 
 import { RevertCode } from '../avm/revert_code.js';
 import { BlockHash } from '../block/block_hash.js';
+import { DebugLog } from '../logs/debug_log.js';
 import { type ZodFor, schemas } from '../schemas/schemas.js';
+import { Tx } from './tx.js';
+import { TxEffect } from './tx_effect.js';
 import { TxHash } from './tx_hash.js';
 
 /** Block inclusion/finalization status. */
@@ -14,7 +25,7 @@ export enum TxStatus {
   PROPOSED = 'proposed',
   CHECKPOINTED = 'checkpointed',
   PROVEN = 'proven',
-  FINALIZED = 'finalized', // TODO(#13569): Implement finalized status properly
+  FINALIZED = 'finalized',
 }
 
 /** Tx status sorted by finalization progress. */
@@ -27,117 +38,301 @@ export const SortedTxStatuses: TxStatus[] = [
   TxStatus.FINALIZED,
 ];
 
+/** The four statuses a mined transaction can hold, ordered by finalization progress. */
+export const MinedTxStatuses = [TxStatus.PROPOSED, TxStatus.CHECKPOINTED, TxStatus.PROVEN, TxStatus.FINALIZED] as const;
+
+/** Block finalization status of a mined transaction. */
+export type MinedTxStatus = (typeof MinedTxStatuses)[number];
+
 /** Execution result - only set when tx is in a block. */
 export enum TxExecutionResult {
   SUCCESS = 'success',
-  APP_LOGIC_REVERTED = 'app_logic_reverted',
-  TEARDOWN_REVERTED = 'teardown_reverted',
-  BOTH_REVERTED = 'both_reverted',
+  REVERTED = 'reverted',
+}
+
+/** Returned from a `getTxReceipt` call to the node RPC API. */
+export interface TxReceiptInterface {
+  /** The transaction's block finalization status. */
+  status: TxStatus;
+  /** The execution result of the transaction, only set when the tx is in a block. */
+  executionResult?: TxExecutionResult;
+  /** Description of the transaction error, if any. */
+  error?: string;
+  /** The transaction fee paid for the transaction. */
+  transactionFee?: bigint;
+  /** The hash of the block containing the transaction. */
+  blockHash?: BlockHash;
+  /** The block number in which the transaction was included. */
+  blockNumber?: BlockNumber;
+  /** The slot number in which the transaction's block was built. */
+  slotNumber?: SlotNumber;
+  /** The epoch number in which the transaction was included. */
+  epochNumber?: EpochNumber;
+  /** The index of the transaction within its block. */
+  txIndexInBlock?: number;
+  /** The full transaction effect, attached when requested via `includeTxEffect`. */
+  txEffect?: TxEffect;
+  /** The pending transaction, attached when requested via `includePendingTx`. */
+  tx?: Tx;
+  /**
+   * Debug logs collected during public function execution. Served only when the node is in test mode and placed on
+   * the receipt only because it's a convenient place for it (the logs are printed out by the wallet when a mined
+   * tx receipt is obtained).
+   */
+  debugLogs?: DebugLog[];
+
+  /** Returns true (and narrows) if the transaction has been included in a block. */
+  isMined(): this is MinedTxReceipt;
+
+  /** Returns true (and narrows) if the transaction is pending. */
+  isPending(): this is PendingTxReceipt;
+
+  /** Returns true (and narrows) if the transaction was dropped. */
+  isDropped(): this is DroppedTxReceipt;
+
+  /** Returns true if the transaction was executed successfully. */
+  hasExecutionSucceeded(): boolean;
+
+  /** Returns true if the transaction execution reverted. */
+  hasExecutionReverted(): boolean;
 }
 
 /**
- * Represents a transaction receipt in the Aztec network.
- * Contains essential information about the transaction including its status, origin, and associated addresses.
- * REFACTOR: TxReceipt should be returned only once the tx is mined, and all its fields should be required.
- * We should not be using a TxReceipt to answer a query for a pending or dropped tx.
+ * Common surface shared by every transaction receipt variant ({@link PendingTxReceipt}, {@link DroppedTxReceipt},
+ * {@link MinedTxReceipt}).
+ *
+ * Every cross-variant field is declared once here, optional except for `txHash` (always present) and `status`
+ * (abstract, narrowed by each subclass). Declaring the fields optional on the base lets callers read a bare
+ * {@link TxReceipt} union (without first narrowing) and keep compiling. Use the `is*` guards to narrow to the strong
+ * variant type and gain access to its required fields.
  */
-export class TxReceipt {
+abstract class TxReceiptBase {
+  /** The transaction's block finalization status. */
+  public abstract readonly status: TxStatus;
+  /** Description of the transaction error, if any. */
+  public readonly error?: string;
+
   constructor(
     /** A unique identifier for a transaction. */
-    public txHash: TxHash,
-    /** The transaction's block finalization status. */
-    public status: TxStatus,
-    /** The execution result of the transaction, only set when tx is in a block. */
-    public executionResult: TxExecutionResult | undefined,
-    /** Description of transaction error, if any. */
-    public error: string | undefined,
-    /** The transaction fee paid for the transaction. */
-    public transactionFee?: bigint,
-    /** The hash of the block containing the transaction. */
-    public blockHash?: BlockHash,
-    /** The block number in which the transaction was included. */
-    public blockNumber?: BlockNumber,
+    public readonly txHash: TxHash,
   ) {}
 
+  /** Returns true (and narrows) if the transaction has been included in a block. */
+  public isMined(): this is MinedTxReceipt {
+    return this instanceof MinedTxReceipt;
+  }
+
+  /** Returns true (and narrows) if the transaction is pending. */
+  public isPending(): this is PendingTxReceipt {
+    return this instanceof PendingTxReceipt;
+  }
+
+  /** Returns true (and narrows) if the transaction was dropped. */
+  public isDropped(): this is DroppedTxReceipt {
+    return this instanceof DroppedTxReceipt;
+  }
+
   /** Returns true if the transaction was executed successfully. */
-  hasExecutionSucceeded(): boolean {
-    return this.executionResult === TxExecutionResult.SUCCESS;
+  public hasExecutionSucceeded(): boolean {
+    return false;
   }
 
   /** Returns true if the transaction execution reverted. */
-  hasExecutionReverted(): boolean {
-    return this.executionResult !== undefined && this.executionResult !== TxExecutionResult.SUCCESS;
+  public hasExecutionReverted(): boolean {
+    return false;
   }
+}
 
-  /** Returns true if the transaction has been included in a block (proposed, checkpointed, proven, or finalized). */
-  isMined(): boolean {
-    return (
-      this.status === TxStatus.PROPOSED ||
-      this.status === TxStatus.CHECKPOINTED ||
-      this.status === TxStatus.PROVEN ||
-      this.status === TxStatus.FINALIZED
-    );
+abstract class UnminedTxReceipt extends TxReceiptBase {
+  public readonly executionResult: undefined = undefined;
+  public readonly transactionFee: undefined = undefined;
+  public readonly blockHash: undefined = undefined;
+  public readonly blockNumber: undefined = undefined;
+  public readonly slotNumber: undefined = undefined;
+  public readonly txIndexInBlock: undefined = undefined;
+  public readonly epochNumber: undefined = undefined;
+  public readonly txEffect: undefined = undefined;
+}
+
+/**
+ * Receipt for a transaction that is in the mempool but not yet included in a block.
+ */
+export class PendingTxReceipt<Opts extends GetTxReceiptOptions = GetTxReceiptOptions>
+  extends UnminedTxReceipt
+  implements TxReceiptInterface
+{
+  public override readonly status = TxStatus.PENDING;
+
+  constructor(
+    txHash: TxHash,
+    /** The pending transaction, attached when requested via `includePendingTx`. */
+    public readonly tx: DefineIfFlag<Opts, 'includePendingTx', Tx>,
+  ) {
+    super(txHash);
+  }
+
+  static empty(): PendingTxReceipt {
+    return new PendingTxReceipt(TxHash.zero(), undefined);
+  }
+
+  static from(fields: PickDefined<FieldsOf<PendingTxReceipt>>): PendingTxReceipt {
+    return new PendingTxReceipt(fields.txHash, fields.tx);
+  }
+
+  static get schema(): ZodFor<PendingTxReceipt> {
+    return z
+      .object({
+        txHash: TxHash.schema,
+        status: z.literal(TxStatus.PENDING),
+        tx: Tx.schema.optional(),
+      })
+      .transform(fields => PendingTxReceipt.from({ tx: undefined, ...fields }));
   }
+}
+
+/**
+ * Receipt for a transaction that was dropped from the mempool without being mined.
+ */
+export class DroppedTxReceipt extends UnminedTxReceipt implements TxReceiptInterface {
+  public override readonly status = TxStatus.DROPPED;
 
-  /** Returns true if the transaction is pending. */
-  isPending(): boolean {
-    return this.status === TxStatus.PENDING;
+  public tx: undefined = undefined;
+
+  constructor(
+    txHash: TxHash,
+    public override readonly error?: string,
+  ) {
+    super(txHash);
   }
 
-  /** Returns true if the transaction was dropped. */
-  isDropped(): boolean {
-    return this.status === TxStatus.DROPPED;
+  static empty(): DroppedTxReceipt {
+    return new DroppedTxReceipt(TxHash.zero());
   }
 
-  static empty() {
-    return new TxReceipt(TxHash.zero(), TxStatus.DROPPED, undefined, undefined);
+  static from(fields: PickDefined<FieldsOf<DroppedTxReceipt>>): DroppedTxReceipt {
+    return new DroppedTxReceipt(fields.txHash, fields.error);
   }
 
-  static get schema(): ZodFor<TxReceipt> {
+  static get schema(): ZodFor<DroppedTxReceipt> {
     return z
       .object({
         txHash: TxHash.schema,
-        status: z.nativeEnum(TxStatus),
-        executionResult: z.nativeEnum(TxExecutionResult).optional(),
+        status: z.literal(TxStatus.DROPPED),
         error: z.string().optional(),
-        blockHash: BlockHash.schema.optional(),
-        blockNumber: BlockNumberSchema.optional(),
-        transactionFee: schemas.BigInt.optional(),
       })
-      .transform(fields => TxReceipt.from(fields));
-  }
-
-  static from(fields: {
-    txHash: TxHash;
-    status: TxStatus;
-    executionResult?: TxExecutionResult;
-    error?: string;
-    transactionFee?: bigint;
-    blockHash?: BlockHash;
-    blockNumber?: BlockNumber;
-  }) {
-    return new TxReceipt(
+      .transform(DroppedTxReceipt.from);
+  }
+}
+
+/**
+ * Receipt for a transaction that has been included in a block (proposed, checkpointed, proven, or finalized).
+ * All block-related fields are required for this variant.
+ */
+export class MinedTxReceipt<Opts extends GetTxReceiptOptions = GetTxReceiptOptions>
+  extends TxReceiptBase
+  implements TxReceiptInterface
+{
+  public override readonly status: MinedTxStatus;
+
+  public readonly tx = undefined;
+
+  constructor(
+    txHash: TxHash,
+    status: MinedTxStatus,
+    public readonly executionResult: TxExecutionResult,
+    public readonly transactionFee: bigint,
+    public readonly blockHash: BlockHash,
+    public readonly blockNumber: BlockNumber,
+    public readonly slotNumber: SlotNumber,
+    public readonly txIndexInBlock: number,
+    public readonly epochNumber: EpochNumber,
+    public readonly txEffect: DefineIfFlag<Opts, 'includeTxEffect', TxEffect>,
+    public debugLogs?: DebugLog[],
+  ) {
+    super(txHash);
+    this.status = status;
+  }
+
+  public override hasExecutionSucceeded(): boolean {
+    return this.executionResult === TxExecutionResult.SUCCESS;
+  }
+
+  public override hasExecutionReverted(): boolean {
+    return this.executionResult !== TxExecutionResult.SUCCESS;
+  }
+
+  static from(fields: PickDefined<FieldsOf<MinedTxReceipt>>): MinedTxReceipt {
+    return new MinedTxReceipt(
       fields.txHash,
       fields.status,
       fields.executionResult,
-      fields.error,
       fields.transactionFee,
       fields.blockHash,
       fields.blockNumber,
+      fields.slotNumber,
+      fields.txIndexInBlock,
+      fields.epochNumber,
+      fields.txEffect,
+      fields.debugLogs,
     );
   }
 
+  static get schema(): ZodFor<MinedTxReceipt> {
+    return z
+      .object({
+        txHash: TxHash.schema,
+        status: z.enum([TxStatus.PROPOSED, TxStatus.CHECKPOINTED, TxStatus.PROVEN, TxStatus.FINALIZED]),
+        executionResult: z.nativeEnum(TxExecutionResult),
+        transactionFee: schemas.BigInt,
+        blockHash: BlockHash.schema,
+        blockNumber: BlockNumberSchema,
+        slotNumber: SlotNumberSchema,
+        txIndexInBlock: schemas.Integer,
+        epochNumber: EpochNumberSchema,
+        txEffect: TxEffect.schema.optional(),
+        debugLogs: z.array(DebugLog.schema).optional(),
+      })
+      .transform(fields => MinedTxReceipt.from({ txEffect: undefined, ...fields }));
+  }
+
   public static executionResultFromRevertCode(revertCode: RevertCode): TxExecutionResult {
-    if (revertCode.equals(RevertCode.OK)) {
-      return TxExecutionResult.SUCCESS;
-    } else if (revertCode.equals(RevertCode.APP_LOGIC_REVERTED)) {
-      return TxExecutionResult.APP_LOGIC_REVERTED;
-    } else if (revertCode.equals(RevertCode.TEARDOWN_REVERTED)) {
-      return TxExecutionResult.TEARDOWN_REVERTED;
-    } else if (revertCode.equals(RevertCode.BOTH_REVERTED)) {
-      return TxExecutionResult.BOTH_REVERTED;
-    } else {
-      throw new Error(`Unknown revert code: ${revertCode.getCode()}`);
-    }
+    return revertCode.isOK() ? TxExecutionResult.SUCCESS : TxExecutionResult.REVERTED;
   }
 }
+
+/**
+ * A transaction receipt summarizing the lifecycle of a transaction in the Aztec network. Discriminated over the
+ * transaction's status: {@link PendingTxReceipt} while in the mempool, {@link DroppedTxReceipt} once dropped, and
+ * {@link MinedTxReceipt} once included in a block.
+ */
+export type TxReceipt<Opts extends GetTxReceiptOptions = GetTxReceiptOptions> =
+  | PendingTxReceipt<Opts>
+  | DroppedTxReceipt
+  | MinedTxReceipt<Opts>;
+
+/**
+ * Zod schema for {@link TxReceipt}. Each member constrains its `status` field so the union routes
+ * unambiguously, giving a deterministic serialization round-trip.
+ */
+export const TxReceiptSchema: ZodFor<TxReceipt> = z.union([
+  PendingTxReceipt.schema,
+  DroppedTxReceipt.schema,
+  MinedTxReceipt.schema,
+]) as ZodFor<TxReceipt>;
+
+/** Options controlling which optional data is attached to a {@link TxReceipt}. */
+export type GetTxReceiptOptions = {
+  /** Attach the full {@link TxEffect} (mined txs only). */
+  includeTxEffect?: boolean;
+  /** Attach the pending {@link Tx} (pending txs only). */
+  includePendingTx?: boolean;
+  /** Keep the proof on the attached pending {@link Tx}; only meaningful alongside `includePendingTx`. */
+  includeProof?: boolean;
+};
+
+/** Zod schema for {@link GetTxReceiptOptions}. */
+export const GetTxReceiptOptionsSchema: ZodFor<GetTxReceiptOptions> = z.object({
+  includeTxEffect: z.boolean().optional(),
+  includePendingTx: z.boolean().optional(),
+  includeProof: z.boolean().optional(),
+});

package/src/tx/tx_request.ts

@@ -1,4 +1,4 @@
-import { GeneratorIndex, TX_REQUEST_LENGTH } from '@aztec/constants';
+import { DomainSeparator, TX_REQUEST_LENGTH } from '@aztec/constants';
 import { poseidon2HashWithSeparator } from '@aztec/foundation/crypto/poseidon';
 import { Fr } from '@aztec/foundation/curves/bn254';
 import { BufferReader, serializeToBuffer, serializeToFields } from '@aztec/foundation/serialize';
@@ -68,7 +68,7 @@ export class TxRequest {
   }
 
   hash() {
-    return poseidon2HashWithSeparator(this.toFields(), GeneratorIndex.TX_REQUEST);
+    return poseidon2HashWithSeparator(this.toFields(), DomainSeparator.TX_REQUEST);
   }
 
   static empty() {

package/src/tx/validator/empty_validator.ts

@@ -1,6 +1,6 @@
 import type { AnyTx, TxValidationResult, TxValidator } from './tx_validator.js';
 
-export class EmptyTxValidator<T extends AnyTx = AnyTx> implements TxValidator<T> {
+export class EmptyTxValidator<T = AnyTx> implements TxValidator<T> {
   public validateTx(_tx: T): Promise<TxValidationResult> {
     return Promise.resolve({ result: 'valid' });
   }

package/src/tx/validator/error_texts.ts

@@ -2,17 +2,22 @@
 export const TX_ERROR_INSUFFICIENT_FEE_PER_GAS = 'Insufficient fee per gas';
 export const TX_ERROR_INSUFFICIENT_FEE_PAYER_BALANCE = 'Insufficient fee payer balance';
 export const TX_ERROR_INSUFFICIENT_GAS_LIMIT = 'Gas limit is below the minimum fixed cost';
-export const TX_ERROR_GAS_LIMIT_TOO_HIGH = 'Gas limit is higher than the amount of gas that the AVM can process';
+export const TX_ERROR_GAS_LIMIT_TOO_HIGH =
+  'Gas limit is higher than the maximum amount of gas this network allows per tx';
 
 // Phases
 export const TX_ERROR_SETUP_FUNCTION_NOT_ALLOWED = 'Setup function not on allow list';
+export const TX_ERROR_SETUP_FUNCTION_UNKNOWN_CONTRACT = 'Setup function targets unknown contract';
+export const TX_ERROR_SETUP_ONLY_SELF_WRONG_SENDER = 'Setup only_self function called with incorrect msg_sender';
+export const TX_ERROR_SETUP_NULL_MSG_SENDER = 'Setup function called with null msg sender';
+export const TX_ERROR_SETUP_WRONG_CALLDATA_LENGTH = 'Setup function called with wrong calldata length';
 
 // Nullifiers
 export const TX_ERROR_DUPLICATE_NULLIFIER_IN_TX = 'Duplicate nullifier in tx';
 export const TX_ERROR_EXISTING_NULLIFIER = 'Existing nullifier';
 
 // Metadata
-export const TX_ERROR_INVALID_INCLUDE_BY_TIMESTAMP = 'Invalid expiration timestamp';
+export const TX_ERROR_INVALID_EXPIRATION_TIMESTAMP = 'Invalid expiration timestamp';
 export const TX_ERROR_INCORRECT_L1_CHAIN_ID = 'Incorrect L1 chain id';
 export const TX_ERROR_INCORRECT_ROLLUP_VERSION = 'Incorrect rollup version';
 export const TX_ERROR_INCORRECT_VK_TREE_ROOT = 'Incorrect verification keys tree root';
@@ -37,5 +42,13 @@ export const TX_ERROR_SIZE_ABOVE_LIMIT = 'Transaction size above size limit';
 // Block header
 export const TX_ERROR_BLOCK_HEADER = 'Block header not found';
 
+// Contract instance
+export const TX_ERROR_INCORRECT_CONTRACT_ADDRESS = 'Incorrect contract instance deployment address';
+export const TX_ERROR_MALFORMED_CONTRACT_INSTANCE_LOG = 'Failed to parse contract instance deployment log';
+
+// Contract class
+export const TX_ERROR_INCORRECT_CONTRACT_CLASS_ID = 'Incorrect contract class id';
+export const TX_ERROR_MALFORMED_CONTRACT_CLASS_LOG = 'Failed to parse contract class registration log';
+
 // General
 export const TX_ERROR_DURING_VALIDATION = 'Unexpected error during validation';

package/src/tx/validator/tx_validator.ts

@@ -15,12 +15,9 @@ export function hasPublicCalls(tx: AnyTx): boolean {
   return tx.data.numberOfPublicCallRequests() > 0;
 }
 
-export type TxValidationResult =
-  | { result: 'valid' }
-  | { result: 'invalid'; reason: string[] }
-  | { result: 'skipped'; reason: string[] };
+export type TxValidationResult = { result: 'valid' } | { result: 'invalid'; reason: string[] };
 
-export interface TxValidator<T extends AnyTx = AnyTx> {
+export interface TxValidator<T = AnyTx> {
   validateTx(tx: T): Promise<TxValidationResult>;
 }
 
@@ -28,6 +25,5 @@ export const TxValidationResultSchema = zodFor<TxValidationResult>()(
   z.discriminatedUnion('result', [
     z.object({ result: z.literal('valid') }),
     z.object({ result: z.literal('invalid'), reason: z.array(z.string()) }),
-    z.object({ result: z.literal('skipped'), reason: z.array(z.string()) }),
   ]),
 );

package/src/types/shared.ts

@@ -1,4 +1,4 @@
-import { type Bufferable, serializeToBuffer } from '@aztec/foundation/serialize';
+import { BufferSink, type Bufferable, type Sinkable, serializeToSink } from '@aztec/foundation/serialize';
 
 /**
  * Implementation of a vector. Matches how we are serializing and deserializing vectors in cpp (length in the first position, followed by the items).
@@ -11,8 +11,13 @@ export class Vector<T extends Bufferable> {
     public items: T[],
   ) {}
 
-  toBuffer() {
-    return serializeToBuffer(this.items.length, this.items);
+  toBuffer(): Buffer;
+  toBuffer(sink: BufferSink): void;
+  toBuffer(sink?: BufferSink): Buffer | void {
+    if (!sink) {
+      return BufferSink.serialize(this);
+    }
+    serializeToSink(sink, this.items.length, this.items as Sinkable[]);
   }
 
   toFriendlyJSON() {
@@ -34,13 +39,3 @@ export type UInt64 = bigint;
  * A type alias for a 128-bit unsigned integer.
  */
 export type UInt128 = bigint;
-
-/**
- * CircuitType replaces ComposerType for now. When using Plonk, CircuitType is equivalent to the information of the proving system that will be used
- * to construct a proof. In the future Aztec zk stack, more information must be specified (e.g., the curve over which circuits are  constructed;
- * Plonk vs Honk; zk-SNARK or just SNARK; etc).
- */
-export enum CircuitType {
-  STANDARD = 0,
-  ULTRA = 1,
-}

package/src/update-checker/dev_version.ts

@@ -0,0 +1,2 @@
+/** Placeholder version returned when running from a local monorepo checkout rather than an npm-installed package. */
+export const DEV_VERSION = 'dev';

package/src/update-checker/index.ts

@@ -1 +1,3 @@
-export { UpdateChecker, getPackageVersion } from './update-checker.js';
+export * from './dev_version.js';
+export * from './package_version.js';
+export * from './version_checker.js';

package/src/update-checker/package_version.ts

@@ -0,0 +1,17 @@
+import { fileURLToPath } from '@aztec/foundation/url';
+
+import { readFileSync } from 'fs';
+import { dirname, resolve } from 'path';
+
+import { DEV_VERSION } from './dev_version.js';
+
+/**
+ * Returns the package version from the stdlib `package.json`, or `DEV_VERSION` when the version is the `0.1.0`
+ * placeholder (which indicates a local monorepo checkout rather than an npm-installed package).
+ */
+export function getPackageVersion(): string {
+  const dir = dirname(fileURLToPath(import.meta.url));
+  const packageJsonPath = resolve(dir, '../../package.json');
+  const version = JSON.parse(readFileSync(packageJsonPath).toString()).version;
+  return version === '0.1.0' ? DEV_VERSION : version;
+}

package/src/update-checker/version_checker.ts

@@ -0,0 +1,65 @@
+import { createLogger } from '@aztec/foundation/log';
+import { RunningPromise } from '@aztec/foundation/promise';
+
+import { EventEmitter } from 'node:events';
+
+export type EventMap = {
+  newVersion: [{ name: string; currentVersion: string; latestVersion: string }];
+};
+
+export type VersionCheck = {
+  name: string;
+  currentVersion: string;
+  getLatestVersion: () => Promise<string | undefined>;
+};
+
+export class VersionChecker extends EventEmitter<EventMap> {
+  private runningPromise: RunningPromise;
+  constructor(
+    private checks: Array<VersionCheck>,
+    intervalCheckMs = 60_000,
+    private logger = createLogger('version_checker'),
+  ) {
+    super();
+    this.runningPromise = new RunningPromise(this.run, logger, intervalCheckMs);
+  }
+
+  public start(): void {
+    if (this.runningPromise.isRunning()) {
+      this.logger.warn('VersionChecker is already running');
+      return;
+    }
+
+    this.runningPromise.start();
+    this.logger.info('Version check started');
+  }
+
+  public trigger(): Promise<void> {
+    return this.runningPromise.trigger();
+  }
+
+  public async stop(): Promise<void> {
+    if (!this.runningPromise.isRunning()) {
+      this.logger.warn('VersionChecker is not running');
+      return;
+    }
+
+    await this.runningPromise.stop();
+    this.logger.info('Version checker stopped');
+  }
+
+  private run = async () => {
+    await Promise.allSettled(this.checks.map(check => this.checkVersion(check)));
+  };
+
+  private async checkVersion({ name, currentVersion, getLatestVersion }: VersionCheck): Promise<void> {
+    try {
+      const latestVersion = await getLatestVersion();
+      if (latestVersion && latestVersion !== currentVersion) {
+        this.emit('newVersion', { name, latestVersion, currentVersion });
+      }
+    } catch (err) {
+      this.logger.warn(`Error checking for new ${name} versions: ${err}`, { err });
+    }
+  }
+}

package/src/validators/errors.ts

@@ -36,6 +36,15 @@ export class FailedToReExecuteTransactionsError extends ValidatorError {
   }
 }
 
+export class ReExInitialStateMismatchError extends ValidatorError {
+  constructor(
+    public readonly expectedArchiveRoot: Fr,
+    public readonly actualArchiveRoot: Fr,
+  ) {
+    super('Re-execution initial state mismatch');
+  }
+}
+
 export class ReExStateMismatchError extends ValidatorError {
   constructor(
     public readonly expectedArchiveRoot: Fr,