feat: benchmark avm simulator

yarn-project/bb-prover/src/avm_proving_tests/avm_check_circuit1.test.ts

@@ -19,7 +19,7 @@ describe('AVM WitGen & Circuit – check circuit', () => {
   let tester: AvmProvingTester;
 
   beforeEach(async () => {
-    tester = await AvmProvingTester.create(/*checkCircuitOnly*/ true);
+    tester = await AvmProvingTester.new(/*checkCircuitOnly*/ true);
     avmTestContractInstance = await tester.registerAndDeployContract(
       /*constructorArgs=*/ [],
       /*deployer=*/ AztecAddress.fromNumber(420),

yarn-project/bb-prover/src/avm_proving_tests/avm_check_circuit2.test.ts

@@ -13,7 +13,7 @@ describe('AVM WitGen & Circuit – check circuit', () => {
   let tester: AvmProvingTester;
 
   beforeEach(async () => {
-    tester = await AvmProvingTester.create(/*checkCircuitOnly*/ true);
+    tester = await AvmProvingTester.new(/*checkCircuitOnly*/ true);
     avmTestContractInstance = await tester.registerAndDeployContract(
       /*constructorArgs=*/ [],
       /*deployer=*/ AztecAddress.fromNumber(420),
@@ -44,7 +44,7 @@ describe('AVM WitGen & Circuit – check circuit', () => {
   // FIXME(dbanks12): fails with "Lookup PERM_MAIN_ALU failed."
   it.skip('top-level exceptional halts due to a non-existent contract in app-logic and teardown', async () => {
     // don't insert contracts into trees, and make sure retrieval fails
-    const tester = await AvmProvingTester.create(/*checkCircuitOnly=*/ true);
+    const tester = await AvmProvingTester.new(/*checkCircuitOnly=*/ true);
     await tester.simProveVerify(
       sender,
       /*setupCalls=*/ [],

yarn-project/bb-prover/src/avm_proving_tests/avm_check_circuit3.test.ts

@@ -13,7 +13,7 @@ describe('AVM WitGen & Circuit – check circuit', () => {
   let tester: AvmProvingTester;
 
   beforeEach(async () => {
-    tester = await AvmProvingTester.create(/*checkCircuitOnly*/ true);
+    tester = await AvmProvingTester.new(/*checkCircuitOnly*/ true);
     avmTestContractInstance = await tester.registerAndDeployContract(
       /*constructorArgs=*/ [],
       /*deployer=*/ AztecAddress.fromNumber(420),

yarn-project/bb-prover/src/avm_proving_tests/avm_contract_class_limits.test.ts

@@ -15,7 +15,7 @@ describe('AVM WitGen & Circuit – check circuit - contract class limits', () =>
   let avmTestContractAddress: AztecAddress;
 
   beforeEach(async () => {
-    tester = await AvmProvingTester.create(/*checkCircuitOnly=*/ true);
+    tester = await AvmProvingTester.new(/*checkCircuitOnly=*/ true);
     // create enough unique contract classes to hit the limit
     instances = [];
     for (let i = 0; i <= MAX_PUBLIC_CALLS_TO_UNIQUE_CONTRACT_CLASS_IDS; i++) {

yarn-project/bb-prover/src/avm_proving_tests/avm_contract_updates.test.ts

@@ -1,7 +1,7 @@
 import { Fr } from '@aztec/foundation/fields';
 import { AvmTestContractArtifact } from '@aztec/noir-contracts.js/AvmTest';
 import { ProtocolContractAddress } from '@aztec/protocol-contracts';
-import { DEFAULT_BLOCK_NUMBER } from '@aztec/simulator/public/fixtures';
+import { defaultGlobals } from '@aztec/simulator/public/fixtures';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
 import type { ContractInstanceWithAddress } from '@aztec/stdlib/contract';
 import { ScheduledDelayChange, ScheduledValueChange, SharedMutableValuesWithHash } from '@aztec/stdlib/shared-mutable';
@@ -43,7 +43,8 @@ describe.skip('AVM WitGen & Circuit - contract updates', () => {
     async () => {
       // Contract was not originally the avmTestContract
       const originalClassId = new Fr(27);
-      const tester = await AvmProvingTester.create(/*checkCircuitOnly*/ true);
+      const globals = defaultGlobals();
+      const tester = await AvmProvingTester.new(/*checkCircuitOnly*/ true, globals);
 
       avmTestContractInstance = await tester.registerAndDeployContract(
         /*constructorArgs=*/ [],
@@ -59,7 +60,7 @@ describe.skip('AVM WitGen & Circuit - contract updates', () => {
         avmTestContractInstance.address,
         avmTestContractInstance.originalContractClassId,
         avmTestContractInstance.currentContractClassId,
-        DEFAULT_BLOCK_NUMBER,
+        globals.blockNumber.toNumber(),
       );
 
       await tester.simProveVerify(
@@ -80,8 +81,8 @@ describe.skip('AVM WitGen & Circuit - contract updates', () => {
     async () => {
       // Contract was not originally the avmTestContract
       const originalClassId = new Fr(27);
-
-      const tester = await AvmProvingTester.create(/*checkCircuitOnly*/ true);
+      const globals = defaultGlobals();
+      const tester = await AvmProvingTester.new(/*checkCircuitOnly*/ true, globals);
       avmTestContractInstance = await tester.registerAndDeployContract(
         /*constructorArgs=*/ [],
         sender,
@@ -96,7 +97,7 @@ describe.skip('AVM WitGen & Circuit - contract updates', () => {
         avmTestContractInstance.address,
         avmTestContractInstance.originalContractClassId,
         avmTestContractInstance.currentContractClassId,
-        DEFAULT_BLOCK_NUMBER + 1,
+        globals.blockNumber.toNumber() + 1,
       );
 
       await expect(
@@ -120,7 +121,8 @@ describe.skip('AVM WitGen & Circuit - contract updates', () => {
       // Contract was not originally the avmTestContract
       const newClassId = new Fr(27);
 
-      const tester = await AvmProvingTester.create(/*checkCircuitOnly*/ true);
+      const globals = defaultGlobals();
+      const tester = await AvmProvingTester.new(/*checkCircuitOnly*/ true, globals);
       avmTestContractInstance = await tester.registerAndDeployContract(
         /*constructorArgs=*/ [],
         sender,
@@ -134,7 +136,7 @@ describe.skip('AVM WitGen & Circuit - contract updates', () => {
         avmTestContractInstance.address,
         avmTestContractInstance.currentContractClassId,
         newClassId,
-        DEFAULT_BLOCK_NUMBER + 1,
+        globals.blockNumber.toNumber() + 1,
       );
 
       await tester.simProveVerify(
@@ -156,7 +158,8 @@ describe.skip('AVM WitGen & Circuit - contract updates', () => {
       // Contract was not originally the avmTestContract
       const newClassId = new Fr(27);
 
-      const tester = await AvmProvingTester.create(/*checkCircuitOnly*/ true);
+      const globals = defaultGlobals();
+      const tester = await AvmProvingTester.new(/*checkCircuitOnly*/ true, globals);
       avmTestContractInstance = await tester.registerAndDeployContract(
         /*constructorArgs=*/ [],
         sender,
@@ -170,7 +173,7 @@ describe.skip('AVM WitGen & Circuit - contract updates', () => {
         avmTestContractInstance.address,
         avmTestContractInstance.currentContractClassId,
         newClassId,
-        DEFAULT_BLOCK_NUMBER - 1,
+        globals.blockNumber.toNumber() - 1,
       );
 
       await expect(

yarn-project/bb-prover/src/avm_proving_tests/avm_proven_amm.test.ts

@@ -15,7 +15,7 @@ describe('AVM Witgen & Circuit apps tests: AMM', () => {
   jest.setTimeout(TIMEOUT);
   const admin = AztecAddress.fromNumber(42);
   const liquidityProvider = AztecAddress.fromNumber(111);
-  const otherLiqduidityProvider = AztecAddress.fromNumber(222);
+  const otherLiquidityProvider = AztecAddress.fromNumber(222);
   const swapper = AztecAddress.fromNumber(333);
 
   let token0: ContractInstanceWithAddress;
@@ -25,7 +25,7 @@ describe('AVM Witgen & Circuit apps tests: AMM', () => {
   let tester: AvmProvingTester;
 
   beforeEach(async () => {
-    tester = await AvmProvingTester.create(/*checkCircuitOnly*/ true);
+    tester = await AvmProvingTester.new(/*checkCircuitOnly*/ true);
   });
 
   // TODO(dbanks12): add tester support for authwit and finish implementing this test
@@ -52,8 +52,8 @@ describe('AVM Witgen & Circuit apps tests: AMM', () => {
 
     await mint(/*to=*/ liquidityProvider, /*amount=*/ INITIAL_TOKEN_BALANCE, token0);
     await mint(/*to=*/ liquidityProvider, /*amount=*/ INITIAL_TOKEN_BALANCE, token1);
-    await mint(/*to=*/ otherLiqduidityProvider, /*amount=*/ INITIAL_TOKEN_BALANCE, token0);
-    await mint(/*to=*/ otherLiqduidityProvider, /*amount=*/ INITIAL_TOKEN_BALANCE, token1);
+    await mint(/*to=*/ otherLiquidityProvider, /*amount=*/ INITIAL_TOKEN_BALANCE, token0);
+    await mint(/*to=*/ otherLiquidityProvider, /*amount=*/ INITIAL_TOKEN_BALANCE, token1);
     await mint(/*to=*/ swapper, /*amount=*/ INITIAL_TOKEN_BALANCE, token0);
 
     //const ammBalancesBefore = await getAmmBalances();

yarn-project/bb-prover/src/avm_proving_tests/avm_proven_token.test.ts

@@ -20,7 +20,7 @@ describe('AVM Witgen & Circuit apps tests: TokenContract', () => {
   let tester: AvmProvingTester;
 
   beforeEach(async () => {
-    tester = await AvmProvingTester.create(/*checkCircuitOnly*/ true);
+    tester = await AvmProvingTester.new(/*checkCircuitOnly*/ true);
 
     const constructorArgs = [admin, /*name=*/ 'Token', /*symbol=*/ 'TOK', /*decimals=*/ new Fr(18)];
     token = await tester.registerAndDeployContract(constructorArgs, /*deployer=*/ admin, TokenContractArtifact);

yarn-project/bb-prover/src/avm_proving_tests/avm_proving_and_verification.test.ts

@@ -12,7 +12,7 @@ describe('AVM WitGen & Circuit – proving and verification', () => {
   let tester: AvmProvingTester;
 
   beforeEach(async () => {
-    tester = await AvmProvingTester.create(/*checkCircuitOnly*/ false);
+    tester = await AvmProvingTester.new(/*checkCircuitOnly*/ false);
     avmTestContractInstance = await tester.registerAndDeployContract(
       /*constructorArgs=*/ [],
       /*deployer=*/ AztecAddress.fromNumber(420),

yarn-project/bb-prover/src/avm_proving_tests/avm_proving_tester.ts

@@ -4,6 +4,7 @@ import type { AvmCircuitInputs } from '@aztec/stdlib/avm';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
 import type { MerkleTreeWriteOperations } from '@aztec/stdlib/interfaces/server';
 import { makeAvmCircuitInputs } from '@aztec/stdlib/testing';
+import type { GlobalVariables } from '@aztec/stdlib/tx';
 import { VerificationKeyData } from '@aztec/stdlib/vks';
 import { NativeWorldStateService } from '@aztec/world-state';
 
@@ -30,16 +31,18 @@ export class AvmProvingTester extends PublicTxSimulationTester {
     private checkCircuitOnly: boolean,
     merkleTree: MerkleTreeWriteOperations,
     contractDataSource: SimpleContractDataSource,
+    globals?: GlobalVariables,
   ) {
-    super(merkleTree, contractDataSource);
+    super(merkleTree, contractDataSource, globals);
   }
 
-  static override async create(checkCircuitOnly: boolean = false) {
+  // overriding parent class' create is a pain, so we use a different nam
+  static async new(checkCircuitOnly: boolean = false, globals?: GlobalVariables) {
     const bbWorkingDirectory = await fs.mkdtemp(path.join(tmpdir(), 'bb-'));
 
     const contractDataSource = new SimpleContractDataSource();
     const merkleTrees = await (await NativeWorldStateService.tmp()).fork();
-    return new AvmProvingTester(bbWorkingDirectory, checkCircuitOnly, merkleTrees, contractDataSource);
+    return new AvmProvingTester(bbWorkingDirectory, checkCircuitOnly, merkleTrees, contractDataSource, globals);
   }
 
   async prove(avmCircuitInputs: AvmCircuitInputs): Promise<BBResult> {
@@ -108,16 +111,17 @@ export class AvmProvingTesterV2 extends PublicTxSimulationTester {
     private bbWorkingDirectory: string,
     contractDataSource: SimpleContractDataSource,
     merkleTrees: MerkleTreeWriteOperations,
+    globals?: GlobalVariables,
   ) {
-    super(merkleTrees, contractDataSource);
+    super(merkleTrees, contractDataSource, globals);
   }
 
-  static override async create() {
+  static async new(globals?: GlobalVariables) {
     const bbWorkingDirectory = await fs.mkdtemp(path.join(tmpdir(), 'bb-'));
 
     const contractDataSource = new SimpleContractDataSource();
     const merkleTrees = await (await NativeWorldStateService.tmp()).fork();
-    return new AvmProvingTesterV2(bbWorkingDirectory, contractDataSource, merkleTrees);
+    return new AvmProvingTesterV2(bbWorkingDirectory, contractDataSource, merkleTrees, globals);
   }
 
   async proveV2(avmCircuitInputs: AvmCircuitInputs): Promise<BBResult> {

yarn-project/bb-prover/src/avm_proving_tests/avm_public_fee_payment.test.ts

@@ -16,7 +16,7 @@ describe('AVM WitGen & Circuit – public fee payment', () => {
   let tester: AvmProvingTester;
 
   beforeEach(async () => {
-    tester = await AvmProvingTester.create(/*checkCircuitOnly*/ true);
+    tester = await AvmProvingTester.new(/*checkCircuitOnly*/ true);
 
     await tester.registerFeeJuiceContract();
     await tester.setFeePayerBalance(feePayer, initialFeeJuiceBalance);

yarn-project/bb-prover/src/avm_proving_tests/avm_v2.test.ts

@@ -11,7 +11,7 @@ describe('AVM v2', () => {
   let tester: AvmProvingTesterV2;
 
   beforeEach(async () => {
-    tester = await AvmProvingTesterV2.create();
+    tester = await AvmProvingTesterV2.new();
     avmTestContractInstance = await tester.registerAndDeployContract(
       /*constructorArgs=*/ [],
       /*deployer=*/ AztecAddress.fromNumber(420),

yarn-project/end-to-end/src/bench/utils.ts

@@ -1,16 +1,12 @@
 import type { AztecNodeService } from '@aztec/aztec-node';
 import { type AztecNode, BatchCall, INITIAL_L2_BLOCK_NUM, type SentTx, type WaitOpts } from '@aztec/aztec.js';
 import { mean, stdDev, times } from '@aztec/foundation/collection';
-import { randomInt } from '@aztec/foundation/crypto';
 import { BenchmarkingContract } from '@aztec/noir-contracts.js/Benchmarking';
 import { type PXEService, type PXEServiceConfig, createPXEService } from '@aztec/pxe/server';
 import type { MetricsType } from '@aztec/telemetry-client';
 import type { BenchmarkDataPoint, BenchmarkMetricsType, BenchmarkTelemetryClient } from '@aztec/telemetry-client/bench';
 
 import { writeFileSync } from 'fs';
-import { mkdirpSync } from 'fs-extra';
-import { globSync } from 'glob';
-import { join } from 'path';
 
 import { type EndToEndContext, type SetupOptions, setup } from '../fixtures/utils.js';
 
@@ -94,30 +90,6 @@ function getMetricValues(points: BenchmarkDataPoint[]) {
   }
 }
 
-/**
- * Creates and returns a directory with the current job name and a random number.
- * @param index - Index to merge into the dir path.
- * @returns A path to a created dir.
- */
-export function makeDataDirectory(index: number) {
-  const testName = expect.getState().currentTestName!.split(' ')[0].replaceAll('/', '_');
-  const db = join('data', testName, index.toString(), `${randomInt(99)}`);
-  mkdirpSync(db);
-  return db;
-}
-
-/**
- * Returns the size in disk of a folder.
- * @param path - Path to the folder.
- * @returns Size in bytes.
- */
-export function getFolderSize(path: string): number {
-  return globSync('**', { stat: true, cwd: path, nodir: true, withFileTypes: true }).reduce(
-    (accum, file) => accum + (file as any as { /** Size */ size: number }).size,
-    0,
-  );
-}
-
 /**
  * Returns a call to the benchmark contract. Each call has a private execution (account entrypoint),
  * a nested private call (create_note), a public call (increment_balance), and a nested public

yarn-project/end-to-end/src/e2e_block_building.test.ts

@@ -33,7 +33,7 @@ import {
   PublicProcessorFactory,
   type PublicTreesDB,
   type PublicTxResult,
-  PublicTxSimulator,
+  TelemetryPublicTxSimulator,
 } from '@aztec/simulator/server';
 import type { AztecNodeAdmin } from '@aztec/stdlib/interfaces/client';
 import type { Tx } from '@aztec/stdlib/tx';
@@ -608,7 +608,7 @@ async function sendAndWait(calls: ContractFunctionInteraction[]) {
 
 const TEST_PUBLIC_TX_SIMULATION_DELAY_MS = 300;
 
-class TestPublicTxSimulator extends PublicTxSimulator {
+class TestPublicTxSimulator extends TelemetryPublicTxSimulator {
   public override async simulate(tx: Tx): Promise<PublicTxResult> {
     await sleep(TEST_PUBLIC_TX_SIMULATION_DELAY_MS);
     return super.simulate(tx);
@@ -622,7 +622,7 @@ class TestPublicProcessorFactory extends PublicProcessorFactory {
     doMerkleOperations: boolean,
     skipFeeEnforcement: boolean,
     telemetryClient?: TelemetryClient,
-  ): PublicTxSimulator {
+  ) {
     return new TestPublicTxSimulator(
       treesDB,
       contractsDB,

yarn-project/simulator/README.md

@@ -47,3 +47,9 @@ Same steps as any other library. They are detailed [here](../README.md#developme
 ### Testing
 
 Same steps as any other library. They are detailed [here](../README.md#tests)
+
+### Benchmarking
+
+```
+LOG_LEVEL=info yarn test src/public/public_tx_simulator/apps_tests/bench.test.ts
+```

yarn-project/simulator/src/public/avm/avm_contract_call_result.ts

@@ -17,10 +17,13 @@ export class AvmContractCallResult {
     public output: Fr[],
     public gasLeft: AvmGas,
     public revertReason?: AvmRevertReason,
+    public totalInstructions: number = 0, // including nested calls
   ) {}
 
   toString(): string {
-    let resultsStr = `reverted: ${this.reverted}, output: ${this.output}, gasLeft: ${inspect(this.gasLeft)}`;
+    let resultsStr = `reverted: ${this.reverted}, output: ${this.output}, gasLeft: ${inspect(
+      this.gasLeft,
+    )}, totalInstructions: ${this.totalInstructions}`;
     if (this.revertReason) {
       resultsStr += `, revertReason: ${this.revertReason}`;
     }
@@ -29,7 +32,13 @@ export class AvmContractCallResult {
 
   finalize(): AvmFinalizedCallResult {
     const revertReason = this.revertReason ? createSimulationError(this.revertReason, this.output) : undefined;
-    return new AvmFinalizedCallResult(this.reverted, this.output, Gas.from(this.gasLeft), revertReason);
+    return new AvmFinalizedCallResult(
+      this.reverted,
+      this.output,
+      Gas.from(this.gasLeft),
+      revertReason,
+      this.totalInstructions,
+    );
   }
 }
 
@@ -43,10 +52,13 @@ export class AvmFinalizedCallResult {
     public output: Fr[],
     public gasLeft: Gas,
     public revertReason?: SimulationError,
+    public totalInstructions: number = 0, // including nested calls
   ) {}
 
   toString(): string {
-    let resultsStr = `reverted: ${this.reverted}, output: ${this.output}, gasLeft: ${inspect(this.gasLeft)}`;
+    let resultsStr = `reverted: ${this.reverted}, output: ${this.output}, gasLeft: ${inspect(
+      this.gasLeft,
+    )}, totalInstructions: ${this.totalInstructions}`;
     if (this.revertReason) {
       resultsStr += `, revertReason: ${this.revertReason}`;
     }

yarn-project/simulator/src/public/avm/avm_machine_state.ts

@@ -68,6 +68,11 @@ export class AvmMachineState {
   /** Output data must NOT be modified once it is set */
   private output: Fr[] = [];
 
+  // Metrics only - not needed for execution
+  /** instruction counter, including nested calls */
+  public instrCounter: number = 0;
+  // End metrics only
+
   constructor(gasLeft: Gas);
   constructor(l2GasLeft: number, daGasLeft: number);
   constructor(gasLeftOrL2GasLeft: Gas | number, daGasLeft?: number) {