@aztec/simulator 0.0.1-commit.5daedc8 → 0.0.1-commit.6230efd

package/src/public/public_tx_simulator/cpp_public_tx_simulator.ts

@@ -1,9 +1,8 @@
-import { type Logger, createLogger } from '@aztec/foundation/log';
-import { writeTestData } from '@aztec/foundation/testing/files';
-import { avmSimulate, avmSimulateWithHintedDbs } from '@aztec/native';
+import { type Logger, createLogger, logLevel } from '@aztec/foundation/log';
+import { sleep } from '@aztec/foundation/sleep';
+import { type CancellationToken, avmSimulate, cancelSimulation, createCancellationToken } from '@aztec/native';
 import { ProtocolContractsList } from '@aztec/protocol-contracts';
 import {
-  AvmCircuitInputs,
   AvmFastSimulationInputs,
   AvmTxHint,
   type PublicSimulatorConfig,
@@ -12,11 +11,13 @@ import {
 } from '@aztec/stdlib/avm';
 import { SimulationError } from '@aztec/stdlib/errors';
 import type { MerkleTreeWriteOperations } from '@aztec/stdlib/trees';
-import type { GlobalVariables, StateReference, Tx } from '@aztec/stdlib/tx';
+import type { GlobalVariables, Tx } from '@aztec/stdlib/tx';
 import { WorldStateRevisionWithHandle } from '@aztec/stdlib/world-state';
+import { type TelemetryClient, type Tracer, getTelemetryClient } from '@aztec/telemetry-client';
 
 import { strict as assert } from 'assert';
 
+import { ExecutorMetrics } from '../executor_metrics.js';
 import type { ExecutorMetricsInterface } from '../executor_metrics_interface.js';
 import type { PublicContractsDB } from '../public_db_sources.js';
 import { ContractProviderForCpp } from './contract_provider_for_cpp.js';
@@ -30,12 +31,13 @@ import type {
  * C++ implementation of PublicTxSimulator using the C++ simulator.
  * The C++ simulator accesses the world state directly/natively within C++.
  * For contract DB accesses, it makes callbacks through NAPI back to the TS PublicContractsDB cache.
- *
- * TODO(dbanks12): for now this still simulates first in TS to generate hints and public inputs,
- * since the C++ simulator doesn't have hinting & PI generation logic yet.
  */
 export class CppPublicTxSimulator extends PublicTxSimulator implements PublicTxSimulatorInterface {
   protected override log: Logger;
+  /** Current cancellation token for in-flight simulation. */
+  private cancellationToken?: CancellationToken;
+  /** Current simulation promise, used to wait for completion after cancellation. */
+  private simulationPromise?: Promise<Buffer>;
 
   constructor(
     merkleTree: MerkleTreeWriteOperations,
@@ -59,33 +61,6 @@ export class CppPublicTxSimulator extends PublicTxSimulator implements PublicTxS
       txHash,
     });
 
-    // TODO(dbanks12): remove the first run with TS that hints!
-    // Run TS simulation to generate hints and public inputs
-    this.log.debug(`Running TS simulation for tx ${txHash}`);
-
-    // create checkpoint for ws
-    let tsResult: PublicTxResult | undefined;
-    let tsStateRef: StateReference | undefined;
-    await this.merkleTree.createCheckpoint();
-    this.contractsDB.createCheckpoint();
-    try {
-      // Run the full TypeScript simulation using the parent class
-      // This will modify the merkle tree with the transaction's state changes
-      tsResult = await super.simulate(tx);
-      this.log.debug(`TS simulation completed for tx ${txHash}`);
-
-      tsStateRef = await this.merkleTree.getStateReference(); // capture tree roots for later comparsion
-    } catch (error: any) {
-      this.log.warn(`TS simulation failed, but still continuing with C++ simulation: ${error.message} ${error.stack}`);
-    } finally {
-      // revert checkpoint for ws and clear contract db changes
-      // (cpp should reapply exactly the same changes if there are no bugs)
-      await this.merkleTree.revertCheckpoint();
-      this.contractsDB.revertCheckpoint();
-    }
-
-    this.log.debug(`Running C++ simulation for tx ${txHash}`);
-
     // Using the "as WorldStateRevisionWithHandle" is a bit of a "trust me bro", hence the assert.
     let wsRevision = this.merkleTree.getRevision();
     assert(
@@ -95,7 +70,7 @@ export class CppPublicTxSimulator extends PublicTxSimulator implements PublicTxS
     const wsCppHandle = (wsRevision as WorldStateRevisionWithHandle).handle;
     wsRevision = wsRevision.toWorldStateRevision(); // for msgpack serialization, we don't include the handle in the type
 
-    this.log.debug(`Running C++ simulation with world state revision ${JSON.stringify(wsRevision)}`);
+    this.log.trace(`Running C++ simulation with world state revision ${JSON.stringify(wsRevision)}`);
 
     // Create the fast simulation inputs
     const txHint = AvmTxHint.fromTx(tx, this.globalVariables.gasFees);
@@ -112,62 +87,72 @@ export class CppPublicTxSimulator extends PublicTxSimulator implements PublicTxS
     const contractProvider = new ContractProviderForCpp(this.contractsDB, this.globalVariables);
 
     // Serialize to msgpack and call the C++ simulator
-    this.log.verbose(`Serializing fast simulation inputs to msgpack...`);
+    this.log.trace(`Serializing fast simulation inputs to msgpack...`);
     const inputBuffer = fastSimInputs.serializeWithMessagePack();
 
+    // Create cancellation token for this simulation
+    this.cancellationToken = createCancellationToken();
+
+    // Store the promise so cancel() can wait for it
+    this.log.debug(`Calling C++ simulator for tx ${txHash}`);
+    this.simulationPromise = avmSimulate(inputBuffer, contractProvider, wsCppHandle, logLevel, this.cancellationToken);
+
     let resultBuffer: Buffer;
     try {
-      this.log.verbose(`Calling C++ simulator for tx ${txHash}`);
-      resultBuffer = await avmSimulate(inputBuffer, contractProvider, wsCppHandle);
+      resultBuffer = await this.simulationPromise;
     } catch (error: any) {
+      // Check if this was a cancellation
+      if (error.message?.includes('Simulation cancelled')) {
+        throw new SimulationError(`C++ simulation cancelled`, []);
+      }
       throw new SimulationError(`C++ simulation failed: ${error.message}`, []);
+    } finally {
+      this.cancellationToken = undefined;
+      this.simulationPromise = undefined;
     }
 
     // If we've reached this point, C++ succeeded during simulation,
-    // so we assert that TS also succeeded.
-    assert(tsResult !== undefined, 'TS simulation should have succeeded if C++ succeeded');
-    assert(tsStateRef !== undefined, 'TS state reference should have been captured if C++ succeeded');
 
     // Deserialize the msgpack result
-    this.log.verbose(`Deserializing C++ from buffer (size: ${resultBuffer.length})...`);
+    this.log.trace(`Deserializing C++ from buffer (size: ${resultBuffer.length})...`);
     const cppResultJSON: object = deserializeFromMessagePack(resultBuffer);
-    // Write testdata if AZTEC_WRITE_TESTDATA=1.
-    writeTestData(
-      `barretenberg/cpp/src/barretenberg/vm2/testing/tx_result_${txHash}.testdata.bin`,
-      resultBuffer,
-      /*raw=*/ true,
-    );
-    this.log.verbose(`Deserializing C++ result to PublicTxResult...`);
+    this.log.trace(`Deserializing C++ result to PublicTxResult...`);
     const cppResult = PublicTxResult.fromPlainObject(cppResultJSON);
-    this.log.verbose(`Done.`);
-    // TODO(fcarreiro): complete this.
-    assert(cppResult.revertCode.equals(tsResult.revertCode));
-    assert(cppResult.gasUsed.totalGas.equals(tsResult.gasUsed.totalGas));
-    assert(cppResult.gasUsed.publicGas.equals(tsResult.gasUsed.publicGas));
-    assert(cppResult.gasUsed.teardownGas.equals(tsResult.gasUsed.teardownGas));
-    assert(cppResult.gasUsed.billedGas.equals(tsResult.gasUsed.billedGas));
-    assert(cppResult.publicInputs.toBuffer().equals(tsResult.publicInputs.toBuffer()));
-    if (this.config?.collectCallMetadata) {
-      assert(cppResult.appLogicReturnValues.length == tsResult.appLogicReturnValues.length);
-      assert(cppResult.appLogicReturnValues.every((v, i) => v.equals(tsResult.appLogicReturnValues[i])));
-    }
-
-    // Confirm that tree roots match
-    const cppStateRef = await this.merkleTree.getStateReference();
-    assert(
-      cppStateRef.equals(tsStateRef),
-      `Tree roots mismatch between TS and C++ public simulations for tx ${txHash}`,
-    );
 
-    this.log.debug(`C++ simulation completed for tx ${txHash}`, {
+    this.log.trace(`C++ simulation completed for tx ${txHash}`, {
       txHash,
-      reverted: !tsResult.revertCode.isOK(),
-      tsGasUsed: tsResult.gasUsed.totalGas.l2Gas,
-      cppGasUsed: tsResult.gasUsed.totalGas.l2Gas,
+      reverted: !cppResult.revertCode.isOK(),
+      cppGasUsed: cppResult.gasUsed.totalGas.l2Gas,
     });
 
-    // TODO(dbanks12): C++ should return PublicTxResult (or something similar)
-    return tsResult;
+    return cppResult;
+  }
+
+  /**
+   * Cancel the current simulation if one is in progress.
+   * This signals the C++ simulator to stop at the next opcode or before the next WorldState write.
+   * Safe to call even if no simulation is in progress.
+   *
+   * @param waitTimeoutMs - If provided, wait up to this many ms for the simulation to actually stop.
+   *                        This is important because C++ might be in the middle of a slow operation
+   *                        (e.g., pad_trees) and won't check the cancellation flag until it completes.
+   *                        Default timeout of 100ms after cancellation.
+   */
+  public async cancel(waitTimeoutMs: number = 100): Promise<void> {
+    if (this.cancellationToken) {
+      this.log.debug('Cancelling C++ simulation');
+      cancelSimulation(this.cancellationToken);
+    }
+
+    // Wait for the simulation to actually complete if not already done
+    if (this.simulationPromise) {
+      this.log.debug(`Waiting up to ${waitTimeoutMs}ms for C++ simulation to stop`);
+      await Promise.race([
+        this.simulationPromise.catch(() => {}), // Ignore rejection, just wait for completion
+        sleep(waitTimeoutMs),
+      ]);
+      this.log.debug('C++ simulation stopped or wait timed out');
+    }
   }
 }
 
@@ -195,112 +180,21 @@ export class MeasuredCppPublicTxSimulator extends CppPublicTxSimulator implement
 }
 
 /**
- * C++ implementation of PublicTxSimulator using pre-collected hints.
- * This implementation runs TS simulation first to collect all hints,
- * then passes the complete AvmCircuitInputs (hints + public inputs)
- * to C++ to run hinted simulation.
+ * A C++ public tx simulator that tracks runtime/production metrics with telemetry.
  */
-export class CppPublicTxSimulatorHintedDbs extends PublicTxSimulator implements PublicTxSimulatorInterface {
-  protected override log: Logger;
-
-  constructor(
-    merkleTree: MerkleTreeWriteOperations,
-    contractsDB: PublicContractsDB,
-    globalVariables: GlobalVariables,
-    config?: Partial<PublicSimulatorConfig>,
-  ) {
-    super(merkleTree, contractsDB, globalVariables, config);
-    this.log = createLogger(`simulator:cpp_public_tx_simulator_hinted_dbs`);
-  }
-
-  /**
-   * Simulate a transaction's public portion using the C++ vm2 simulator with hinted DBs.
-   *
-   * This implementation:
-   * 1. Runs the full TypeScript simulation to generate AvmCircuitInputs (hints + public inputs)
-   * 2. Passes the complete AvmCircuitInputs to C++ to run hinted simulation
-   *
-   * @param tx - The transaction to simulate.
-   * @returns The result of the transaction's public execution.
-   */
-  public override async simulate(tx: Tx): Promise<PublicTxResult> {
-    const txHash = this.computeTxHash(tx);
-    this.log.debug(`C++ hinted DB simulation of ${tx.publicFunctionCalldata.length} public calls for tx ${txHash}`, {
-      txHash,
-    });
-
-    // First, run TS simulation to generate hints and public inputs
-    this.log.debug(`Running TS simulation for tx ${txHash}`);
-
-    // Run the full TypeScript simulation using the parent class
-    // This will modify the merkle tree with the transaction's state changes
-    const tsResult = await super.simulate(tx);
-    this.log.debug(`TS simulation succeeded for tx ${txHash}`);
+export class TelemetryCppPublicTxSimulator extends MeasuredCppPublicTxSimulator {
+  /* tracer needed by trackSpans */
+  public readonly tracer: Tracer;
 
-    // Extract the full AvmCircuitInputs from the TS result
-    const avmCircuitInputs = new AvmCircuitInputs(tsResult.hints!, tsResult.publicInputs);
-
-    // Second, run C++ simulation with hinted DBs
-    this.log.debug(`Running C++ simulation with hinted DBs for tx ${txHash}`);
-
-    // Serialize to msgpack and call the C++ simulator
-    const inputBuffer = avmCircuitInputs.serializeWithMessagePack();
-
-    let resultBuffer: Buffer;
-    try {
-      resultBuffer = await avmSimulateWithHintedDbs(inputBuffer);
-    } catch (error: any) {
-      throw new SimulationError(`C++ hinted simulation failed: ${error.message}`, []);
-    }
-
-    // Deserialize the msgpack result
-    const cppResultJSON: object = deserializeFromMessagePack(resultBuffer);
-    const cppResult = PublicTxResult.fromPlainObject(cppResultJSON);
-
-    assert(cppResult.revertCode.equals(tsResult.revertCode));
-    assert(cppResult.gasUsed.totalGas.equals(tsResult.gasUsed.totalGas));
-
-    this.log.debug(`C++ hinted simulation completed for tx ${txHash}`, {
-      txHash,
-      reverted: !tsResult.revertCode.isOK(),
-      tsGasUsed: tsResult.gasUsed.totalGas.l2Gas,
-      cppGasUsed: tsResult.gasUsed.totalGas.l2Gas,
-    });
-
-    // TODO(fcarreiro): complete this.
-    return tsResult;
-  }
-}
-
-/**
- * Class to record metrics for simulation.
- *
- * Note(dbanks12): We might not be able to collect all the same metrics in C++ as we do in TS!
- * Unless we move some of the metrics collection to C++, we don't have inner functions exposed
- * to TS for tracking.
- */
-export class MeasuredCppPublicTxSimulatorHintedDbs
-  extends CppPublicTxSimulatorHintedDbs
-  implements MeasuredPublicTxSimulatorInterface
-{
   constructor(
     merkleTree: MerkleTreeWriteOperations,
     contractsDB: PublicContractsDB,
     globalVariables: GlobalVariables,
-    protected readonly metrics: ExecutorMetricsInterface,
+    telemetryClient: TelemetryClient = getTelemetryClient(),
     config?: Partial<PublicSimulatorConfig>,
   ) {
-    super(merkleTree, contractsDB, globalVariables, config);
-  }
-
-  public override async simulate(tx: Tx, txLabel: string = 'unlabeledTx'): Promise<PublicTxResult> {
-    this.metrics.startRecordingTxSimulation(txLabel);
-    let result: PublicTxResult | undefined;
-    try {
-      result = await super.simulate(tx);
-    } finally {
-      this.metrics.stopRecordingTxSimulation(txLabel, result?.gasUsed, result?.revertCode);
-    }
-    return result;
+    const metrics = new ExecutorMetrics(telemetryClient, 'CppPublicTxSimulator');
+    super(merkleTree, contractsDB, globalVariables, metrics, config);
+    this.tracer = metrics.tracer;
   }
 }

package/src/public/public_tx_simulator/cpp_public_tx_simulator_with_hinted_dbs.ts

@@ -0,0 +1,132 @@
+import { type Logger, createLogger, logLevel } from '@aztec/foundation/log';
+import { avmSimulateWithHintedDbs } from '@aztec/native';
+import {
+  AvmCircuitInputs,
+  type PublicSimulatorConfig,
+  PublicTxResult,
+  deserializeFromMessagePack,
+} from '@aztec/stdlib/avm';
+import { SimulationError } from '@aztec/stdlib/errors';
+import type { MerkleTreeWriteOperations } from '@aztec/stdlib/trees';
+import type { GlobalVariables, Tx } from '@aztec/stdlib/tx';
+
+import { strict as assert } from 'assert';
+
+import type { ExecutorMetricsInterface } from '../executor_metrics_interface.js';
+import type { PublicContractsDB } from '../public_db_sources.js';
+import { PublicTxSimulator } from './public_tx_simulator.js';
+import type {
+  MeasuredPublicTxSimulatorInterface,
+  PublicTxSimulatorInterface,
+} from './public_tx_simulator_interface.js';
+
+/**
+ * C++ implementation of PublicTxSimulator using pre-collected hints.
+ * This implementation runs TS simulation first to collect all hints,
+ * then passes the complete AvmCircuitInputs (hints + public inputs)
+ * to C++ to run hinted simulation.
+ */
+export class CppPublicTxSimulatorHintedDbs extends PublicTxSimulator implements PublicTxSimulatorInterface {
+  protected override log: Logger;
+
+  constructor(
+    merkleTree: MerkleTreeWriteOperations,
+    contractsDB: PublicContractsDB,
+    globalVariables: GlobalVariables,
+    config?: Partial<PublicSimulatorConfig>,
+  ) {
+    super(merkleTree, contractsDB, globalVariables, config);
+    this.log = createLogger(`simulator:cpp_public_tx_simulator_hinted_dbs`);
+  }
+
+  /**
+   * Simulate a transaction's public portion using the C++ vm2 simulator with hinted DBs.
+   *
+   * This implementation:
+   * 1. Runs the full TypeScript simulation to generate AvmCircuitInputs (hints + public inputs)
+   * 2. Passes the complete AvmCircuitInputs to C++ to run hinted simulation
+   *
+   * @param tx - The transaction to simulate.
+   * @returns The result of the transaction's public execution.
+   */
+  public override async simulate(tx: Tx): Promise<PublicTxResult> {
+    const txHash = this.computeTxHash(tx);
+    this.log.debug(`C++ hinted DB simulation of ${tx.publicFunctionCalldata.length} public calls for tx ${txHash}`, {
+      txHash,
+    });
+
+    // First, run TS simulation to generate hints and public inputs
+    this.log.debug(`Running TS simulation for tx ${txHash}`);
+
+    // Run the full TypeScript simulation using the parent class
+    // This will modify the merkle tree with the transaction's state changes
+    const tsResult = await super.simulate(tx);
+    this.log.debug(`TS simulation succeeded for tx ${txHash}`);
+
+    // Extract the full AvmCircuitInputs from the TS result
+    const avmCircuitInputs = new AvmCircuitInputs(tsResult.hints!, tsResult.publicInputs!);
+
+    // Second, run C++ simulation with hinted DBs
+    this.log.debug(`Running C++ simulation with hinted DBs for tx ${txHash}`);
+
+    // Serialize to msgpack and call the C++ simulator
+    const inputBuffer = avmCircuitInputs.serializeWithMessagePack();
+
+    let resultBuffer: Buffer;
+    try {
+      resultBuffer = await avmSimulateWithHintedDbs(inputBuffer, logLevel);
+    } catch (error: any) {
+      throw new SimulationError(`C++ hinted simulation failed: ${error.message}`, []);
+    }
+
+    // Deserialize the msgpack result
+    const cppResultJSON: object = deserializeFromMessagePack(resultBuffer);
+    const cppResult = PublicTxResult.fromPlainObject(cppResultJSON);
+
+    assert(cppResult.revertCode.equals(tsResult.revertCode));
+    assert(cppResult.gasUsed.totalGas.equals(tsResult.gasUsed.totalGas));
+
+    this.log.debug(`C++ hinted simulation completed for tx ${txHash}`, {
+      txHash,
+      reverted: !tsResult.revertCode.isOK(),
+      tsGasUsed: tsResult.gasUsed.totalGas.l2Gas,
+      cppGasUsed: tsResult.gasUsed.totalGas.l2Gas,
+    });
+
+    // TODO(fcarreiro): complete this.
+    return tsResult;
+  }
+}
+
+/**
+ * Class to record metrics for simulation.
+ *
+ * Note(dbanks12): We might not be able to collect all the same metrics in C++ as we do in TS!
+ * Unless we move some of the metrics collection to C++, we don't have inner functions exposed
+ * to TS for tracking.
+ */
+export class MeasuredCppPublicTxSimulatorHintedDbs
+  extends CppPublicTxSimulatorHintedDbs
+  implements MeasuredPublicTxSimulatorInterface
+{
+  constructor(
+    merkleTree: MerkleTreeWriteOperations,
+    contractsDB: PublicContractsDB,
+    globalVariables: GlobalVariables,
+    protected readonly metrics: ExecutorMetricsInterface,
+    config?: Partial<PublicSimulatorConfig>,
+  ) {
+    super(merkleTree, contractsDB, globalVariables, config);
+  }
+
+  public override async simulate(tx: Tx, txLabel: string = 'unlabeledTx'): Promise<PublicTxResult> {
+    this.metrics.startRecordingTxSimulation(txLabel);
+    let result: PublicTxResult | undefined;
+    try {
+      result = await super.simulate(tx);
+    } finally {
+      this.metrics.stopRecordingTxSimulation(txLabel, result?.gasUsed, result?.revertCode);
+    }
+    return result;
+  }
+}