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

package/src/public/public_processor/public_processor_metrics.ts

@@ -1,6 +1,6 @@
 import type { ContractClassPublishedEvent } from '@aztec/protocol-contracts/class-registry';
 import type { Gas } from '@aztec/stdlib/gas';
-import type { TxExecutionPhase } from '@aztec/stdlib/tx';
+import { TxExecutionPhase } from '@aztec/stdlib/tx';
 import {
   Attributes,
   type Gauge,
@@ -9,7 +9,7 @@ import {
   type TelemetryClient,
   type Tracer,
   type UpDownCounter,
-  ValueType,
+  createUpDownCounterWithDefault,
 } from '@aztec/telemetry-client';
 
 export class PublicProcessorMetrics {
@@ -30,64 +30,43 @@ export class PublicProcessorMetrics {
 
   private treeInsertionDuration: Histogram;
 
+  private silentlySkippedCount: UpDownCounter;
+  private silentlySkippedDuration: Histogram;
+
   constructor(client: TelemetryClient, name = 'PublicProcessor') {
     this.tracer = client.getTracer(name);
     const meter = client.getMeter(name);
 
-    this.txDuration = meter.createHistogram(Metrics.PUBLIC_PROCESSOR_TX_DURATION, {
-      description: 'How long it takes to process a transaction',
-      unit: 'ms',
-      valueType: ValueType.INT,
-    });
+    this.txDuration = meter.createHistogram(Metrics.PUBLIC_PROCESSOR_TX_DURATION);
 
-    this.txCount = meter.createUpDownCounter(Metrics.PUBLIC_PROCESSOR_TX_COUNT, {
-      description: 'Number of transactions processed',
+    this.txCount = createUpDownCounterWithDefault(meter, Metrics.PUBLIC_PROCESSOR_TX_COUNT, {
+      [Attributes.OK]: [true, false],
     });
 
-    this.txPhaseCount = meter.createUpDownCounter(Metrics.PUBLIC_PROCESSOR_TX_PHASE_COUNT, {
-      description: 'Number of phases processed',
-    });
+    this.txPhaseCount = createUpDownCounterWithDefault(meter, Metrics.PUBLIC_PROCESSOR_TX_PHASE_COUNT);
 
-    this.phaseDuration = meter.createHistogram(Metrics.PUBLIC_PROCESSOR_PHASE_DURATION, {
-      description: 'How long it takes to process a phase',
-      unit: 'ms',
-      valueType: ValueType.INT,
-    });
+    this.phaseDuration = meter.createHistogram(Metrics.PUBLIC_PROCESSOR_PHASE_DURATION);
 
-    this.phaseCount = meter.createUpDownCounter(Metrics.PUBLIC_PROCESSOR_PHASE_COUNT, {
-      description: 'Number of failed phases',
+    this.phaseCount = createUpDownCounterWithDefault(meter, Metrics.PUBLIC_PROCESSOR_PHASE_COUNT, {
+      [Attributes.TX_PHASE_NAME]: [TxExecutionPhase.SETUP, TxExecutionPhase.APP_LOGIC, TxExecutionPhase.TEARDOWN],
+      [Attributes.OK]: [true, false],
     });
 
-    this.bytecodeDeployed = meter.createHistogram(Metrics.PUBLIC_PROCESSOR_DEPLOY_BYTECODE_SIZE, {
-      description: 'Size of deployed bytecode',
-      unit: 'By',
-    });
+    this.bytecodeDeployed = meter.createHistogram(Metrics.PUBLIC_PROCESSOR_DEPLOY_BYTECODE_SIZE);
 
-    this.totalGas = meter.createGauge(Metrics.PUBLIC_PROCESSOR_TOTAL_GAS, {
-      description: 'Total gas used in block',
-      unit: 'gas',
-    });
+    this.totalGas = meter.createGauge(Metrics.PUBLIC_PROCESSOR_TOTAL_GAS);
 
-    this.totalGasHistogram = meter.createHistogram(Metrics.PUBLIC_PROCESSOR_TOTAL_GAS_HISTOGRAM, {
-      description: 'Total gas used in block as histogram',
-      unit: 'gas/block',
-    });
+    this.totalGasHistogram = meter.createHistogram(Metrics.PUBLIC_PROCESSOR_TOTAL_GAS_HISTOGRAM);
 
-    this.txGas = meter.createHistogram(Metrics.PUBLIC_PROCESSOR_TX_GAS, {
-      description: 'Gas used in transaction',
-      unit: 'gas/tx',
-    });
+    this.txGas = meter.createHistogram(Metrics.PUBLIC_PROCESSOR_TX_GAS);
 
-    this.gasRate = meter.createHistogram(Metrics.PUBLIC_PROCESSOR_GAS_RATE, {
-      description: 'L2 gas per second for complete block',
-      unit: 'gas/s',
-    });
+    this.gasRate = meter.createHistogram(Metrics.PUBLIC_PROCESSOR_GAS_RATE);
 
-    this.treeInsertionDuration = meter.createHistogram(Metrics.PUBLIC_PROCESSOR_TREE_INSERTION, {
-      description: 'How long it takes for tree insertion',
-      unit: 'us',
-      valueType: ValueType.INT,
-    });
+    this.treeInsertionDuration = meter.createHistogram(Metrics.PUBLIC_PROCESSOR_TREE_INSERTION);
+
+    this.silentlySkippedCount = createUpDownCounterWithDefault(meter, Metrics.PUBLIC_PROCESSOR_SILENTLY_SKIPPED_COUNT);
+
+    this.silentlySkippedDuration = meter.createHistogram(Metrics.PUBLIC_PROCESSOR_SILENTLY_SKIPPED_DURATION);
   }
 
   recordPhaseDuration(phaseName: TxExecutionPhase, durationMs: number) {
@@ -151,4 +130,9 @@ export class PublicProcessorMetrics {
   recordTreeInsertions(durationUs: number) {
     this.treeInsertionDuration.record(Math.ceil(durationUs));
   }
+
+  recordSilentlySkipped(durationMs: number) {
+    this.silentlySkippedCount.add(1);
+    this.silentlySkippedDuration.record(Math.ceil(durationMs));
+  }
 }

package/src/public/public_tx_simulator/contract_provider_for_cpp.ts

@@ -0,0 +1,125 @@
+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());
+  };
+}

package/src/public/public_tx_simulator/dumping_public_tx_simulator.ts

@@ -0,0 +1,83 @@
+import type { LoggerBindings } from '@aztec/foundation/log';
+import {
+  AvmCircuitInputs,
+  AvmCircuitPublicInputs,
+  AvmExecutionHints,
+  type PublicSimulatorConfig,
+  PublicTxResult,
+  serializeWithMessagePack,
+} from '@aztec/stdlib/avm';
+import type { MerkleTreeWriteOperations } from '@aztec/stdlib/trees';
+import type { GlobalVariables, Tx, TxHash } from '@aztec/stdlib/tx';
+
+import { strict as assert } from 'assert';
+import { mkdirSync, writeFileSync } from 'fs';
+import { join } from 'path';
+
+import type { PublicContractsDB } from '../public_db_sources.js';
+import { PublicTxSimulator } from './public_tx_simulator.js';
+
+/**
+ * A C++ public tx simulator that dumps AVM circuit inputs to disk after simulation.
+ * Used during nightly CI runs to collect circuit inputs for benchmarking.
+ */
+export class DumpingPublicTxSimulator extends PublicTxSimulator {
+  private readonly outputDir: string;
+
+  constructor(
+    merkleTree: MerkleTreeWriteOperations,
+    contractsDB: PublicContractsDB,
+    globalVariables: GlobalVariables,
+    config: Partial<PublicSimulatorConfig>,
+    outputDir: string,
+    bindings?: LoggerBindings,
+  ) {
+    super(merkleTree, contractsDB, globalVariables, config, bindings);
+    assert(config.collectHints === true, 'collectHints must be enabled to dump AVM circuit inputs');
+    assert(config.collectPublicInputs === true, 'collectPublicInputs must be enabled to dump AVM circuit inputs');
+    this.outputDir = outputDir;
+  }
+
+  public override async simulate(tx: Tx): Promise<PublicTxResult> {
+    const result = await super.simulate(tx);
+
+    // Dump the circuit inputs after successful simulation
+    const txHash = this.computeTxHash(tx);
+    this.dumpAvmCircuitInputs(result, txHash);
+
+    return result;
+  }
+
+  /**
+   * Dumps AVM circuit inputs to disk.
+   *
+   * @param result - The simulation result containing hints and public inputs
+   * @param txHash - The transaction hash to use in the filename
+   */
+  private dumpAvmCircuitInputs(result: PublicTxResult, txHash: TxHash): void {
+    try {
+      // Ensure the output directory exists
+      mkdirSync(this.outputDir, { recursive: true });
+
+      // Generate filename using transaction hash
+      const filename = `avm-circuit-inputs-tx-${txHash.toString()}.bin`;
+      const filepath = join(this.outputDir, filename);
+
+      // Create circuit inputs from the result
+      const hints = result.hints ?? AvmExecutionHints.empty();
+      const publicInputs = result.publicInputs ?? AvmCircuitPublicInputs.empty();
+      const avmCircuitInputs = new AvmCircuitInputs(hints, publicInputs);
+
+      // Serialize the circuit inputs using MessagePack
+      const serialized = serializeWithMessagePack(avmCircuitInputs);
+
+      // Write to disk
+      writeFileSync(filepath, serialized);
+
+      this.log.debug(`Dumped AVM circuit inputs to ${filepath}`);
+    } catch (error) {
+      // Non-blocking error handling - log but don't interrupt processing
+      this.log.warn(`Failed to dump AVM circuit inputs for tx ${txHash.toString()}: ${error}`);
+    }
+  }
+}

package/src/public/public_tx_simulator/factories.ts

@@ -0,0 +1,44 @@
+import type { LoggerBindings } from '@aztec/foundation/log';
+import { PublicSimulatorConfig } from '@aztec/stdlib/avm';
+import type { MerkleTreeWriteOperations } from '@aztec/stdlib/trees';
+import type { GlobalVariables } from '@aztec/stdlib/tx';
+import type { TelemetryClient } from '@aztec/telemetry-client';
+
+import type { PublicContractsDB } from '../public_db_sources.js';
+import { DumpingPublicTxSimulator } from './dumping_public_tx_simulator.js';
+import { TelemetryPublicTxSimulator } from './public_tx_simulator.js';
+
+/**
+ * Creates a public tx simulator for block building.
+ * Uses DumpingPublicTxSimulator if DUMP_AVM_INPUTS_TO_DIR env var is set (for CI/testing avm circuit),
+ * otherwise uses TelemetryPublicTxSimulator (for production).
+ */
+export function createPublicTxSimulatorForBlockBuilding(
+  merkleTree: MerkleTreeWriteOperations,
+  contractsDB: PublicContractsDB,
+  globalVariables: GlobalVariables,
+  telemetryClient: TelemetryClient,
+  bindings?: LoggerBindings,
+  collectDebugLogs = false,
+) {
+  const config = PublicSimulatorConfig.from({
+    skipFeeEnforcement: false,
+    collectDebugLogs,
+    collectHints: false,
+    collectPublicInputs: false,
+    collectStatistics: false,
+    collectCallMetadata: false,
+  });
+
+  const dumpDir = process.env.DUMP_AVM_INPUTS_TO_DIR;
+  if (dumpDir) {
+    // must collect hints and PIs for dumping
+    const dumpingConfig = {
+      ...config,
+      collectHints: true,
+      collectPublicInputs: true,
+    };
+    return new DumpingPublicTxSimulator(merkleTree, contractsDB, globalVariables, dumpingConfig, dumpDir, bindings);
+  }
+  return new TelemetryPublicTxSimulator(merkleTree, contractsDB, globalVariables, telemetryClient, config, bindings);
+}

package/src/public/public_tx_simulator/index.ts

@@ -1,3 +1,5 @@
-export * from './public_tx_simulator.js';
+export { PublicTxSimulator, TelemetryPublicTxSimulator } from './public_tx_simulator.js';
+export { DumpingPublicTxSimulator } from './dumping_public_tx_simulator.js';
+export { createPublicTxSimulatorForBlockBuilding } from './factories.js';
 export type { PublicTxSimulatorInterface } from './public_tx_simulator_interface.js';
-export { TelemetryPublicTxSimulator } from './telemetry_public_tx_simulator.js';
+export type { PublicTxResult, PublicSimulatorConfig as PublicTxSimulatorConfig } from '@aztec/stdlib/avm';