@aztec/simulator 0.0.1-commit.b9865e97 → 0.0.1-commit.be03c316

package/src/public/public_tx_simulator/public_tx_simulator_base.ts

@@ -1,15 +1,16 @@
 import { type Logger, type LoggerBindings, createLogger } from '@aztec/foundation/log';
 import { ProtocolContractsList } from '@aztec/protocol-contracts';
 import { PublicSimulatorConfig } from '@aztec/stdlib/avm';
-import type { MerkleTreeWriteOperations } from '@aztec/stdlib/trees';
 import type { GlobalVariables, ProtocolContracts, Tx } from '@aztec/stdlib/tx';
 
+import type { AvmSimulator } from '../avm_simulator.js';
 import type { PublicContractsDB } from '../public_db_sources.js';
 
 /**
- * Shared base for public tx simulators. Holds the common configuration, world-state and contract DB
- * handles, logger, and the tx-hash helper. Concrete simulators (e.g. the C++ simulator) extend this
- * and implement `simulate`.
+ * Shared base for public tx simulators: holds the common configuration, the {@link AvmSimulator} used
+ * to run the transaction's public calls, the contracts DB and fork id that scope the simulation's
+ * contract-data lookups, the logger, and the tx-hash helper. Concrete simulators extend this and
+ * implement `simulate`.
  */
 export abstract class PublicTxSimulatorBase {
   protected log: Logger;
@@ -17,9 +18,10 @@ export abstract class PublicTxSimulatorBase {
   protected readonly bindings?: LoggerBindings;
 
   constructor(
-    protected merkleTree: MerkleTreeWriteOperations,
-    protected contractsDB: PublicContractsDB,
+    protected avmSimulator: AvmSimulator,
     protected globalVariables: GlobalVariables,
+    protected contractsDB: PublicContractsDB,
+    protected forkId: number,
     config?: Partial<PublicSimulatorConfig>,
     protected protocolContracts: ProtocolContracts = ProtocolContractsList,
     bindings?: LoggerBindings,

package/src/public/public_tx_simulator/public_tx_simulator_interface.ts

@@ -5,14 +5,14 @@ export interface PublicTxSimulatorInterface {
   simulate(tx: Tx): Promise<PublicTxResult>;
   /**
    * Cancel the current simulation if one is in progress.
-   * This signals the underlying simulator (e.g., C++) to stop at the next safe point.
+   * This signals the underlying simulator to stop at the next safe point.
    * Safe to call even if no simulation is in progress.
    * Optional - not all implementations support cancellation.
    *
    * @param waitTimeoutMs - If provided, wait up to this many ms for the simulation to actually stop.
-   *                        This is important because signaling cancellation doesn't immediately stop C++ -
-   *                        it only sets a flag that C++ checks at certain points. If C++ is in the middle
-   *                        of a slow operation (e.g., pad_trees), it won't stop until that completes.
+   *                        Cancellation is cooperative: signaling it only sets a flag the simulator
+   *                        checks at certain points, so if it's mid slow-operation it won't stop until
+   *                        that completes.
    * @returns Promise that resolves when cancellation is signaled (and optionally when simulation stops)
    */
   cancel?(waitTimeoutMs?: number): Promise<void>;
@@ -22,7 +22,7 @@ export interface MeasuredPublicTxSimulatorInterface {
   simulate(tx: Tx, txLabel: string): Promise<PublicTxResult>;
   /**
    * Cancel the current simulation if one is in progress.
-   * This signals the underlying simulator (e.g., C++) to stop at the next safe point.
+   * This signals the underlying simulator to stop at the next safe point.
    * Safe to call even if no simulation is in progress.
    * Optional - not all implementations support cancellation.
    *

package/src/public/test_executor_metrics.ts

@@ -21,7 +21,6 @@ export interface PublicTxMetrics {
   totalDurationMs: number;
   manaUsed: number | undefined;
   totalInstructionsExecuted: number;
-  bytecodeSizes: { contractName: string; sizeBytes: number }[];
   nonRevertiblePrivateInsertionsUs: number | undefined;
   revertiblePrivateInsertionsUs: number | undefined;
   enqueuedCalls: PublicEnqueuedCallMetrics[];
@@ -63,7 +62,6 @@ function createEmptyTxMetrics(): PublicTxMetrics {
     totalDurationMs: 0,
     manaUsed: 0,
     totalInstructionsExecuted: 0,
-    bytecodeSizes: [],
     nonRevertiblePrivateInsertionsUs: undefined,
     revertiblePrivateInsertionsUs: undefined,
     enqueuedCalls: [],
@@ -174,12 +172,6 @@ export class TestExecutorMetrics implements ExecutorMetricsInterface {
     }
   }
 
-  recordBytecodeSize(txLabel: string, contractName: string, sizeBytes: number) {
-    const txMetrics = this.txMetrics.get(txLabel);
-    assert(txMetrics, `Cannot record bytecode size for unknown tx label: ${txLabel}`);
-    txMetrics.bytecodeSizes.push({ contractName, sizeBytes });
-  }
-
   recordProverMetrics(txLabel: string, metrics: Partial<PublicTxMetrics>) {
     if (!this.txMetrics.has(txLabel)) {
       this.txMetrics.set(txLabel, createEmptyTxMetrics());
@@ -224,15 +216,6 @@ export class TestExecutorMetrics implements ExecutorMetricsInterface {
       ) {
         pretty += `${INDENT0}Total instructions executed: ${fmtNum(txMetrics.totalInstructionsExecuted)}\n`;
       }
-      if (
-        (filter === PublicTxMetricsFilter.TOTALS || filter === PublicTxMetricsFilter.ALL) &&
-        txMetrics.bytecodeSizes.length > 0
-      ) {
-        pretty += `${INDENT0}Bytecode sizes:\n`;
-        for (const { contractName, sizeBytes } of txMetrics.bytecodeSizes) {
-          pretty += `${INDENT1}${contractName}: ${fmtNum(sizeBytes, 'bytes')}\n`;
-        }
-      }
       if (filter === PublicTxMetricsFilter.DURATIONS || filter === PublicTxMetricsFilter.ALL) {
         pretty += `${INDENT0}Private insertions:\n`;
         pretty += `${INDENT1}Non-revertible: ${fmtNum(txMetrics.nonRevertiblePrivateInsertionsUs! / 1_000, 'ms')}\n`;
@@ -404,13 +387,6 @@ export class TestExecutorMetrics implements ExecutorMetricsInterface {
           });
         }
       }
-      for (const { contractName, sizeBytes } of txMetrics.bytecodeSizes) {
-        data.push({
-          name: `${txLabel}/bytecodeSizeBytes/${contractName}`,
-          value: sizeBytes,
-          unit: 'bytes',
-        });
-      }
     }
     return JSON.stringify(data, null, indent);
   }

package/dest/public/public_tx_simulator/contract_provider_for_cpp.d.ts

@@ -1,19 +0,0 @@
-import { type LoggerBindings } from '@aztec/foundation/log';
-import type { ContractProvider } from '@aztec/native';
-import type { GlobalVariables } from '@aztec/stdlib/tx';
-import type { PublicContractsDB } from '../public_db_sources.js';
-export declare class ContractProviderForCpp implements ContractProvider {
-    private contractsDB;
-    private globalVariables;
-    private log;
-    constructor(contractsDB: PublicContractsDB, globalVariables: GlobalVariables, bindings?: LoggerBindings);
-    getContractInstance: (address: string) => Promise<Buffer<ArrayBufferLike> | undefined>;
-    getContractClass: (classId: string) => Promise<Buffer<ArrayBufferLike> | undefined>;
-    addContracts: (contractDeploymentDataBuffer: Buffer<ArrayBufferLike>) => Promise<void>;
-    getBytecodeCommitment: (classId: string) => Promise<Buffer<ArrayBufferLike> | undefined>;
-    getDebugFunctionName: (address: string, selector: string) => Promise<string | undefined>;
-    createCheckpoint: () => Promise<void>;
-    commitCheckpoint: () => Promise<void>;
-    revertCheckpoint: () => Promise<void>;
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udHJhY3RfcHJvdmlkZXJfZm9yX2NwcC5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3B1YmxpYy9wdWJsaWNfdHhfc2ltdWxhdG9yL2NvbnRyYWN0X3Byb3ZpZGVyX2Zvcl9jcHAudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxFQUFlLEtBQUssY0FBYyxFQUFnQixNQUFNLHVCQUF1QixDQUFDO0FBQ3ZGLE9BQU8sS0FBSyxFQUFFLGdCQUFnQixFQUFFLE1BQU0sZUFBZSxDQUFDO0FBS3RELE9BQU8sS0FBSyxFQUFFLGVBQWUsRUFBRSxNQUFNLGtCQUFrQixDQUFDO0FBRXhELE9BQU8sS0FBSyxFQUFFLGlCQUFpQixFQUFFLE1BQU0seUJBQXlCLENBQUM7QUFFakUscUJBQWEsc0JBQXVCLFlBQVcsZ0JBQWdCO0lBSTNELE9BQU8sQ0FBQyxXQUFXO0lBQ25CLE9BQU8sQ0FBQyxlQUFlO0lBSnpCLE9BQU8sQ0FBQyxHQUFHLENBQVM7SUFFcEIsWUFDVSxXQUFXLEVBQUUsaUJBQWlCLEVBQzlCLGVBQWUsRUFBRSxlQUFlLEVBQ3hDLFFBQVEsQ0FBQyxFQUFFLGNBQWMsRUFHMUI7SUFFTSxtQkFBbUIsb0VBYXhCO0lBRUssZ0JBQWdCLG9FQWVyQjtJQUdLLFlBQVksMkVBV2pCO0lBRUsscUJBQXFCLG9FQWdCMUI7SUFFSyxvQkFBb0IscUVBc0J6QjtJQUVLLGdCQUFnQixzQkFHckI7SUFFSyxnQkFBZ0Isc0JBR3JCO0lBRUssZ0JBQWdCLHNCQUdyQjtDQUNIIn0=

package/dest/public/public_tx_simulator/contract_provider_for_cpp.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"contract_provider_for_cpp.d.ts","sourceRoot":"","sources":["../../../src/public/public_tx_simulator/contract_provider_for_cpp.ts"],"names":[],"mappings":"AACA,OAAO,EAAe,KAAK,cAAc,EAAgB,MAAM,uBAAuB,CAAC;AACvF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAKtD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAExD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAEjE,qBAAa,sBAAuB,YAAW,gBAAgB;IAI3D,OAAO,CAAC,WAAW;IACnB,OAAO,CAAC,eAAe;IAJzB,OAAO,CAAC,GAAG,CAAS;IAEpB,YACU,WAAW,EAAE,iBAAiB,EAC9B,eAAe,EAAE,eAAe,EACxC,QAAQ,CAAC,EAAE,cAAc,EAG1B;IAEM,mBAAmB,oEAaxB;IAEK,gBAAgB,oEAerB;IAGK,YAAY,2EAWjB;IAEK,qBAAqB,oEAgB1B;IAEK,oBAAoB,qEAsBzB;IAEK,gBAAgB,sBAGrB;IAEK,gBAAgB,sBAGrB;IAEK,gBAAgB,sBAGrB;CACH"}

package/dest/public/public_tx_simulator/contract_provider_for_cpp.js

@@ -1,99 +0,0 @@
-import { Fr } from '@aztec/foundation/curves/bn254';
-import { createLogger } from '@aztec/foundation/log';
-import { FunctionSelector } from '@aztec/stdlib/abi';
-import { deserializeFromMessagePack, serializeWithMessagePack } from '@aztec/stdlib/avm';
-import { AztecAddress } from '@aztec/stdlib/aztec-address';
-import { ContractDeploymentData } from '@aztec/stdlib/contract';
-export class ContractProviderForCpp {
-    contractsDB;
-    globalVariables;
-    log;
-    constructor(contractsDB, globalVariables, bindings){
-        this.contractsDB = contractsDB;
-        this.globalVariables = globalVariables;
-        this.getContractInstance = async (address)=>{
-            this.log.trace(`Contract provider callback: getContractInstance(${address})`);
-            const aztecAddr = AztecAddress.fromString(address);
-            const instance = await this.contractsDB.getContractInstance(aztecAddr, this.globalVariables.timestamp);
-            if (!instance) {
-                this.log.debug(`Contract instance not found: ${address}`);
-                return undefined;
-            }
-            return serializeWithMessagePack(instance);
-        };
-        this.getContractClass = async (classId)=>{
-            this.log.trace(`Contract provider callback: getContractClass(${classId})`);
-            // Parse classId string to Fr
-            const classIdFr = Fr.fromString(classId);
-            // Fetch contract class from the contracts DB
-            const contractClass = await this.contractsDB.getContractClass(classIdFr);
-            if (!contractClass) {
-                this.log.debug(`Contract class not found: ${classId}`);
-                return undefined;
-            }
-            return serializeWithMessagePack(contractClass);
-        };
-        this.addContracts = async (contractDeploymentDataBuffer)=>{
-            this.log.trace(`Contract provider callback: addContracts`);
-            const rawData = deserializeFromMessagePack(contractDeploymentDataBuffer);
-            // Construct ContractDeploymentData from plain object.
-            const contractDeploymentData = ContractDeploymentData.fromPlainObject(rawData);
-            // Add contracts to the contracts DB
-            this.log.trace(`Calling contractsDB.addContractsFromLogs`);
-            this.contractsDB.addContractsFromLogs(contractDeploymentData);
-        };
-        this.getBytecodeCommitment = async (classId)=>{
-            this.log.trace(`Contract provider callback: getBytecodeCommitment(${classId})`);
-            // Parse classId string to Fr
-            const classIdFr = Fr.fromString(classId);
-            // Fetch bytecode commitment from the contracts DB
-            const commitment = await this.contractsDB.getBytecodeCommitment(classIdFr);
-            if (!commitment) {
-                this.log.debug(`Bytecode commitment not found: ${classId}`);
-                return undefined;
-            }
-            // Serialize the Fr to buffer
-            return serializeWithMessagePack(commitment);
-        };
-        this.getDebugFunctionName = async (address, selector)=>{
-            this.log.trace(`Contract provider callback: getDebugFunctionName(${address}, ${selector})`);
-            // Parse address and selector strings
-            const aztecAddr = AztecAddress.fromString(address);
-            const selectorFr = Fr.fromString(selector);
-            const functionSelector = FunctionSelector.fromFieldOrUndefined(selectorFr);
-            if (!functionSelector) {
-                this.log.trace(`calldata[0] is not a function selector: ${selector}`);
-                return undefined;
-            }
-            // Fetch debug function name from the contracts DB
-            const name = await this.contractsDB.getDebugFunctionName(aztecAddr, functionSelector);
-            if (!name) {
-                this.log.trace(`Debug function name not found for ${address}:${selector}`);
-                return undefined;
-            }
-            return name;
-        };
-        this.createCheckpoint = ()=>{
-            this.log.trace(`Contract provider callback: createCheckpoint`);
-            return Promise.resolve(this.contractsDB.createCheckpoint());
-        };
-        this.commitCheckpoint = ()=>{
-            this.log.trace(`Contract provider callback: commitCheckpoint`);
-            return Promise.resolve(this.contractsDB.commitCheckpoint());
-        };
-        this.revertCheckpoint = ()=>{
-            this.log.trace(`Contract provider callback: revertCheckpoint`);
-            return Promise.resolve(this.contractsDB.revertCheckpoint());
-        };
-        this.log = createLogger('simulator:contract_provider_for_cpp', bindings);
-    }
-    getContractInstance;
-    getContractClass;
-    // eslint-disable-next-line require-await
-    addContracts;
-    getBytecodeCommitment;
-    getDebugFunctionName;
-    createCheckpoint;
-    commitCheckpoint;
-    revertCheckpoint;
-}

package/src/public/public_tx_simulator/contract_provider_for_cpp.ts

@@ -1,125 +0,0 @@
-import { Fr } from '@aztec/foundation/curves/bn254';
-import { type Logger, type LoggerBindings, createLogger } from '@aztec/foundation/log';
-import type { ContractProvider } from '@aztec/native';
-import { FunctionSelector } from '@aztec/stdlib/abi';
-import { deserializeFromMessagePack, serializeWithMessagePack } from '@aztec/stdlib/avm';
-import { AztecAddress } from '@aztec/stdlib/aztec-address';
-import { ContractDeploymentData } from '@aztec/stdlib/contract';
-import type { GlobalVariables } from '@aztec/stdlib/tx';
-
-import type { PublicContractsDB } from '../public_db_sources.js';
-
-export class ContractProviderForCpp implements ContractProvider {
-  private log: Logger;
-
-  constructor(
-    private contractsDB: PublicContractsDB,
-    private globalVariables: GlobalVariables,
-    bindings?: LoggerBindings,
-  ) {
-    this.log = createLogger('simulator:contract_provider_for_cpp', bindings);
-  }
-
-  public getContractInstance = async (address: string): Promise<Buffer | undefined> => {
-    this.log.trace(`Contract provider callback: getContractInstance(${address})`);
-
-    const aztecAddr = AztecAddress.fromString(address);
-
-    const instance = await this.contractsDB.getContractInstance(aztecAddr, this.globalVariables.timestamp);
-
-    if (!instance) {
-      this.log.debug(`Contract instance not found: ${address}`);
-      return undefined;
-    }
-
-    return serializeWithMessagePack(instance);
-  };
-
-  public getContractClass = async (classId: string): Promise<Buffer | undefined> => {
-    this.log.trace(`Contract provider callback: getContractClass(${classId})`);
-
-    // Parse classId string to Fr
-    const classIdFr = Fr.fromString(classId);
-
-    // Fetch contract class from the contracts DB
-    const contractClass = await this.contractsDB.getContractClass(classIdFr);
-
-    if (!contractClass) {
-      this.log.debug(`Contract class not found: ${classId}`);
-      return undefined;
-    }
-
-    return serializeWithMessagePack(contractClass);
-  };
-
-  // eslint-disable-next-line require-await
-  public addContracts = async (contractDeploymentDataBuffer: Buffer): Promise<void> => {
-    this.log.trace(`Contract provider callback: addContracts`);
-
-    const rawData: any = deserializeFromMessagePack(contractDeploymentDataBuffer);
-
-    // Construct ContractDeploymentData from plain object.
-    const contractDeploymentData = ContractDeploymentData.fromPlainObject(rawData);
-
-    // Add contracts to the contracts DB
-    this.log.trace(`Calling contractsDB.addContractsFromLogs`);
-    this.contractsDB.addContractsFromLogs(contractDeploymentData);
-  };
-
-  public getBytecodeCommitment = async (classId: string): Promise<Buffer | undefined> => {
-    this.log.trace(`Contract provider callback: getBytecodeCommitment(${classId})`);
-
-    // Parse classId string to Fr
-    const classIdFr = Fr.fromString(classId);
-
-    // Fetch bytecode commitment from the contracts DB
-    const commitment = await this.contractsDB.getBytecodeCommitment(classIdFr);
-
-    if (!commitment) {
-      this.log.debug(`Bytecode commitment not found: ${classId}`);
-      return undefined;
-    }
-
-    // Serialize the Fr to buffer
-    return serializeWithMessagePack(commitment);
-  };
-
-  public getDebugFunctionName = async (address: string, selector: string): Promise<string | undefined> => {
-    this.log.trace(`Contract provider callback: getDebugFunctionName(${address}, ${selector})`);
-
-    // Parse address and selector strings
-    const aztecAddr = AztecAddress.fromString(address);
-    const selectorFr = Fr.fromString(selector);
-    const functionSelector = FunctionSelector.fromFieldOrUndefined(selectorFr);
-
-    if (!functionSelector) {
-      this.log.trace(`calldata[0] is not a function selector: ${selector}`);
-      return undefined;
-    }
-
-    // Fetch debug function name from the contracts DB
-    const name = await this.contractsDB.getDebugFunctionName(aztecAddr, functionSelector);
-
-    if (!name) {
-      this.log.trace(`Debug function name not found for ${address}:${selector}`);
-      return undefined;
-    }
-
-    return name;
-  };
-
-  public createCheckpoint = (): Promise<void> => {
-    this.log.trace(`Contract provider callback: createCheckpoint`);
-    return Promise.resolve(this.contractsDB.createCheckpoint());
-  };
-
-  public commitCheckpoint = (): Promise<void> => {
-    this.log.trace(`Contract provider callback: commitCheckpoint`);
-    return Promise.resolve(this.contractsDB.commitCheckpoint());
-  };
-
-  public revertCheckpoint = (): Promise<void> => {
-    this.log.trace(`Contract provider callback: revertCheckpoint`);
-    return Promise.resolve(this.contractsDB.revertCheckpoint());
-  };
-}