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

package/src/public/state_manager/state_manager.ts

@@ -1,16 +1,10 @@
-import {
-  CANONICAL_AUTH_REGISTRY_ADDRESS,
-  CONTRACT_CLASS_REGISTRY_CONTRACT_ADDRESS,
-  CONTRACT_INSTANCE_REGISTRY_CONTRACT_ADDRESS,
-  FEE_JUICE_ADDRESS,
-  MULTI_CALL_ENTRYPOINT_ADDRESS,
-  ROUTER_ADDRESS,
-} from '@aztec/constants';
-import { poseidon2Hash } from '@aztec/foundation/crypto';
-import { Fr } from '@aztec/foundation/fields';
+import { CONTRACT_INSTANCE_REGISTRY_CONTRACT_ADDRESS, MAX_PROTOCOL_CONTRACTS } from '@aztec/constants';
+import { poseidon2Hash } from '@aztec/foundation/crypto/poseidon';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { jsonStringify } from '@aztec/foundation/json-rpc';
-import { type LogLevel, createLogger } from '@aztec/foundation/log';
+import { type LogLevel, type Logger, type LoggerBindings, createLogger } from '@aztec/foundation/log';
 import { ProtocolContractAddress } from '@aztec/protocol-contracts';
+import { FunctionSelector } from '@aztec/stdlib/abi';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
 import type { ContractClassPublicWithCommitment, ContractInstanceWithAddress } from '@aztec/stdlib/contract';
 import { SerializableContractInstance } from '@aztec/stdlib/contract';
@@ -26,7 +20,7 @@ import { strict as assert } from 'assert';
 
 import type { AvmExecutionEnvironment } from '../avm/avm_execution_environment.js';
 import type { PublicContractsDBInterface } from '../db_interfaces.js';
-import { getPublicFunctionDebugName } from '../debug_fn_name.js';
+import { getPublicFunctionDebugName, getPublicFunctionSelectorAndName } from '../debug_fn_name.js';
 import type { PublicTreesDB } from '../public_db_sources.js';
 import {
   L1ToL2MessageIndexOutOfRangeError,
@@ -48,7 +42,7 @@ import { PublicStorage } from './public_storage.js';
  * Manages merging of successful/reverted child state into current state.
  */
 export class PublicPersistableStateManager {
-  private readonly log = createLogger('simulator:state_manager');
+  private readonly log: Logger;
 
   /** Make sure a forked state is never merged twice. */
   private alreadyMergedIntoParent = false;
@@ -59,10 +53,13 @@ export class PublicPersistableStateManager {
     private readonly trace: PublicSideEffectTraceInterface,
     private readonly firstNullifier: Fr, // Needed for note hashes.
     private readonly timestamp: UInt64, // Needed for contract updates.
-    private readonly doMerkleOperations: boolean = false,
+    private readonly doMerkleOperations: boolean = true,
     private readonly publicStorage: PublicStorage = new PublicStorage(treesDB),
     private readonly nullifiers: NullifierManager = new NullifierManager(treesDB),
-  ) {}
+    bindings?: LoggerBindings,
+  ) {
+    this.log = createLogger('simulator:state_manager', bindings);
+  }
 
   /**
    * Create a new state manager
@@ -71,9 +68,9 @@ export class PublicPersistableStateManager {
     treesDB: PublicTreesDB,
     contractsDB: PublicContractsDBInterface,
     trace: PublicSideEffectTraceInterface,
-    doMerkleOperations: boolean = false,
     firstNullifier: Fr,
     timestamp: UInt64,
+    bindings?: LoggerBindings,
   ): PublicPersistableStateManager {
     return new PublicPersistableStateManager(
       treesDB,
@@ -81,7 +78,10 @@ export class PublicPersistableStateManager {
       trace,
       firstNullifier,
       timestamp,
-      doMerkleOperations,
+      undefined,
+      undefined,
+      undefined,
+      bindings,
     );
   }
 
@@ -99,6 +99,7 @@ export class PublicPersistableStateManager {
       this.doMerkleOperations,
       this.publicStorage.fork(),
       this.nullifiers.fork(),
+      this.log.getBindings(),
     );
   }
 
@@ -171,7 +172,6 @@ export class PublicPersistableStateManager {
     if (this.doMerkleOperations) {
       return await this.treesDB.storageRead(contractAddress, slot);
     } else {
-      // TODO(fcarreiro): I don't get this. PublicStorage CAN end up reading the tree. Why is it in the "dont do merkle operations" branch?
       const read = await this.publicStorage.read(contractAddress, slot);
       this.log.trace(
         `Storage read results (address=${contractAddress}, slot=${slot}): value=${read.value}, cached=${read.cached}`,
@@ -248,7 +248,15 @@ export class PublicPersistableStateManager {
   public async checkNullifierExists(contractAddress: AztecAddress, nullifier: Fr): Promise<boolean> {
     this.log.trace(`Checking existence of nullifier (address=${contractAddress}, nullifier=${nullifier})`);
     const siloedNullifier = await siloNullifier(contractAddress, nullifier);
+    return this.checkSiloedNullifierExists(siloedNullifier);
+  }
 
+  /**
+   * Check if a siloed nullifier exists.
+   * @param siloedNullifier - the siloed nullifier to check
+   * @returns exists - whether the nullifier exists in the nullifier set
+   */
+  public async checkSiloedNullifierExists(siloedNullifier: Fr): Promise<boolean> {
     if (this.doMerkleOperations) {
       const exists = await this.treesDB.checkNullifierExists(siloedNullifier);
       this.log.trace(`Checked siloed nullifier ${siloedNullifier} (exists=${exists})`);
@@ -437,6 +445,8 @@ export class PublicPersistableStateManager {
         await this.readStorage(ProtocolContractAddress.ContractInstanceRegistry, storageSlot);
 
       const hash = await readDeployerStorage(delayedPublicMutableHashSlot);
+      // NOTE: The below reads are either not performed (if hash.isZero()) or only performed in unconstrained in c++ simulation.
+      // See UpdateCheck::check_current_class_id documentation - this means if we generate hints from the merkle db, they are unused:
       const delayedPublicMutableValues = await DelayedPublicMutableValues.readFromTree(
         delayedPublicMutableSlot,
         readDeployerStorage,
@@ -539,6 +549,12 @@ export class PublicPersistableStateManager {
     return await getPublicFunctionDebugName(this.contractsDB, avmEnvironment.address, avmEnvironment.calldata);
   }
 
+  public async getPublicFunctionSelectorAndName(
+    avmEnvironment: AvmExecutionEnvironment,
+  ): Promise<{ functionSelector?: FunctionSelector; functionName?: string }> {
+    return await getPublicFunctionSelectorAndName(this.contractsDB, avmEnvironment.address, avmEnvironment.calldata);
+  }
+
   public async padTree(treeId: MerkleTreeId, leavesToInsert: number): Promise<void> {
     await this.treesDB.padTree(treeId, leavesToInsert);
   }
@@ -549,12 +565,5 @@ export class PublicPersistableStateManager {
 }
 
 function contractAddressIsCanonical(contractAddress: AztecAddress): boolean {
-  return (
-    contractAddress.equals(AztecAddress.fromNumber(CANONICAL_AUTH_REGISTRY_ADDRESS)) ||
-    contractAddress.equals(AztecAddress.fromNumber(CONTRACT_INSTANCE_REGISTRY_CONTRACT_ADDRESS)) ||
-    contractAddress.equals(AztecAddress.fromNumber(CONTRACT_CLASS_REGISTRY_CONTRACT_ADDRESS)) ||
-    contractAddress.equals(AztecAddress.fromNumber(MULTI_CALL_ENTRYPOINT_ADDRESS)) ||
-    contractAddress.equals(AztecAddress.fromNumber(FEE_JUICE_ADDRESS)) ||
-    contractAddress.equals(AztecAddress.fromNumber(ROUTER_ADDRESS))
-  );
+  return contractAddress.toBigInt() >= 1 && contractAddress.toBigInt() <= MAX_PROTOCOL_CONTRACTS;
 }

package/src/public/test_executor_metrics.ts

@@ -1,7 +1,8 @@
 import { sum } from '@aztec/foundation/collection';
-import { type Logger, createLogger } from '@aztec/foundation/log';
+import { type Logger, type LoggerBindings, createLogger } from '@aztec/foundation/log';
 import { Timer } from '@aztec/foundation/timer';
 import type { RevertCode } from '@aztec/stdlib/avm';
+import type { GasUsed } from '@aztec/stdlib/gas';
 
 import { strict as assert } from 'assert';
 
@@ -18,8 +19,9 @@ export interface PublicEnqueuedCallMetrics {
 export interface PublicTxMetrics {
   // TS simulation
   totalDurationMs: number;
-  manaUsed: number;
+  manaUsed: number | undefined;
   totalInstructionsExecuted: number;
+  bytecodeSizes: { contractName: string; sizeBytes: number }[];
   nonRevertiblePrivateInsertionsUs: number | undefined;
   revertiblePrivateInsertionsUs: number | undefined;
   enqueuedCalls: PublicEnqueuedCallMetrics[];
@@ -61,6 +63,7 @@ function createEmptyTxMetrics(): PublicTxMetrics {
     totalDurationMs: 0,
     manaUsed: 0,
     totalInstructionsExecuted: 0,
+    bytecodeSizes: [],
     nonRevertiblePrivateInsertionsUs: undefined,
     revertiblePrivateInsertionsUs: undefined,
     enqueuedCalls: [],
@@ -87,8 +90,8 @@ export class TestExecutorMetrics implements ExecutorMetricsInterface {
   private currentTxLabel: string | undefined;
   private txTimer: Timer | undefined;
 
-  constructor() {
-    this.logger = createLogger(`simulator:test_executor_metrics`);
+  constructor(bindings?: LoggerBindings) {
+    this.logger = createLogger(`simulator:test_executor_metrics`, bindings);
   }
 
   startRecordingTxSimulation(txLabel: string) {
@@ -99,7 +102,7 @@ export class TestExecutorMetrics implements ExecutorMetricsInterface {
     this.txTimer = new Timer();
   }
 
-  stopRecordingTxSimulation(txLabel: string, revertedCode?: RevertCode) {
+  stopRecordingTxSimulation(txLabel: string, gasUsed?: GasUsed, revertedCode?: RevertCode) {
     assert(this.currentTxLabel === txLabel, 'Cannot stop recording metrics for tx when another is live');
 
     const txMetrics = this.txMetrics.get(txLabel)!;
@@ -109,7 +112,7 @@ export class TestExecutorMetrics implements ExecutorMetricsInterface {
     this.logger.debug(`Public TX simulation of ${txLabel} took ${txMetrics.totalDurationMs}ms`);
 
     // add manaUsed across all enqueued calls
-    txMetrics.manaUsed = sum(txMetrics.enqueuedCalls.map(call => call.manaUsed));
+    txMetrics.manaUsed = gasUsed?.publicGas.l2Gas;
     // add totalInstructionsExecuted across all enqueued calls
     txMetrics.totalInstructionsExecuted = sum(txMetrics.enqueuedCalls.map(call => call.totalInstructionsExecuted));
     txMetrics.revertedCode = revertedCode;
@@ -171,6 +174,12 @@ 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());
@@ -202,8 +211,9 @@ export class TestExecutorMetrics implements ExecutorMetricsInterface {
         pretty += `${INDENT0}Total duration: ${fmtNum(txMetrics.totalDurationMs, 'ms')}\n`;
       }
       if (filter === PublicTxMetricsFilter.TOTALS || filter === PublicTxMetricsFilter.ALL) {
-        pretty += `${INDENT0}Total mana used: ${fmtNum(txMetrics.manaUsed)}\n`;
-        const manaPerSecond = Math.round((txMetrics.manaUsed * 1000) / txMetrics.totalDurationMs);
+        const manaUsed = txMetrics.manaUsed || 0;
+        pretty += `${INDENT0}Total mana used: ${fmtNum(manaUsed)}\n`;
+        const manaPerSecond = Math.round((manaUsed * 1000) / txMetrics.totalDurationMs);
         pretty += `${INDENT0}Mana per second: ${fmtNum(manaPerSecond)}\n`;
       }
 
@@ -214,6 +224,15 @@ 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`;
@@ -385,6 +404,13 @@ 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/tx_contract_cache.d.ts

@@ -1,41 +0,0 @@
-import type { Fr } from '@aztec/foundation/fields';
-import type { AztecAddress } from '@aztec/stdlib/aztec-address';
-import type { ContractClassPublic, ContractInstanceWithAddress } from '@aztec/stdlib/contract';
-/**
- * A cache for contract classes and instances for a single transaction.
- * Useful for tracking/retrieving contracts for a tx while leaving
- * the option to clear them if the tx is reverted.
- */
-export declare class TxContractCache {
-    private instanceCache;
-    private classCache;
-    /**
-     * Add a contract instance to the cache
-     */
-    addInstance(address: AztecAddress, instance: ContractInstanceWithAddress): void;
-    /**
-     * Add a contract class to the cache
-     */
-    addClass(classId: Fr, contractClass: ContractClassPublic): void;
-    /**
-     * Get a contract instance from the cache
-     */
-    getInstance(address: AztecAddress): ContractInstanceWithAddress | undefined;
-    /**
-     * Get a contract class from the cache
-     */
-    getClass(classId: Fr): ContractClassPublic | undefined;
-    /**
-     * Check if the cache has a contract class
-     */
-    hasClass(classId: Fr): boolean;
-    /**
-     * Clear all entries from the cache
-     */
-    clear(): void;
-    /**
-     * Merge another cache into this one
-     */
-    mergeFrom(other: TxContractCache): void;
-}
-//# sourceMappingURL=tx_contract_cache.d.ts.map

package/dest/public/tx_contract_cache.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"tx_contract_cache.d.ts","sourceRoot":"","sources":["../../src/public/tx_contract_cache.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,mBAAmB,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAE/F;;;;GAIG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,aAAa,CAAkD;IACvE,OAAO,CAAC,UAAU,CAA0C;IAE5D;;OAEG;IACI,WAAW,CAAC,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,2BAA2B,GAAG,IAAI;IAItF;;OAEG;IACI,QAAQ,CAAC,OAAO,EAAE,EAAE,EAAE,aAAa,EAAE,mBAAmB,GAAG,IAAI;IAItE;;OAEG;IACI,WAAW,CAAC,OAAO,EAAE,YAAY,GAAG,2BAA2B,GAAG,SAAS;IAIlF;;OAEG;IACI,QAAQ,CAAC,OAAO,EAAE,EAAE,GAAG,mBAAmB,GAAG,SAAS;IAI7D;;OAEG;IACI,QAAQ,CAAC,OAAO,EAAE,EAAE,GAAG,OAAO;IAIrC;;OAEG;IACI,KAAK,IAAI,IAAI;IAKpB;;OAEG;IACI,SAAS,CAAC,KAAK,EAAE,eAAe,GAAG,IAAI;CAS/C"}

package/dest/public/tx_contract_cache.js

@@ -1,49 +0,0 @@
-/**
- * A cache for contract classes and instances for a single transaction.
- * Useful for tracking/retrieving contracts for a tx while leaving
- * the option to clear them if the tx is reverted.
- */ export class TxContractCache {
-    instanceCache = new Map();
-    classCache = new Map();
-    /**
-   * Add a contract instance to the cache
-   */ addInstance(address, instance) {
-        this.instanceCache.set(address.toString(), instance);
-    }
-    /**
-   * Add a contract class to the cache
-   */ addClass(classId, contractClass) {
-        this.classCache.set(classId.toString(), contractClass);
-    }
-    /**
-   * Get a contract instance from the cache
-   */ getInstance(address) {
-        return this.instanceCache.get(address.toString());
-    }
-    /**
-   * Get a contract class from the cache
-   */ getClass(classId) {
-        return this.classCache.get(classId.toString());
-    }
-    /**
-   * Check if the cache has a contract class
-   */ hasClass(classId) {
-        return this.classCache.has(classId.toString());
-    }
-    /**
-   * Clear all entries from the cache
-   */ clear() {
-        this.instanceCache.clear();
-        this.classCache.clear();
-    }
-    /**
-   * Merge another cache into this one
-   */ mergeFrom(other) {
-        other.instanceCache.forEach((value, key)=>{
-            this.instanceCache.set(key, value);
-        });
-        other.classCache.forEach((value, key)=>{
-            this.classCache.set(key, value);
-        });
-    }
-}

package/src/public/tx_contract_cache.ts

@@ -1,69 +0,0 @@
-import type { Fr } from '@aztec/foundation/fields';
-import type { AztecAddress } from '@aztec/stdlib/aztec-address';
-import type { ContractClassPublic, ContractInstanceWithAddress } from '@aztec/stdlib/contract';
-
-/**
- * A cache for contract classes and instances for a single transaction.
- * Useful for tracking/retrieving contracts for a tx while leaving
- * the option to clear them if the tx is reverted.
- */
-export class TxContractCache {
-  private instanceCache = new Map<string, ContractInstanceWithAddress>();
-  private classCache = new Map<string, ContractClassPublic>();
-
-  /**
-   * Add a contract instance to the cache
-   */
-  public addInstance(address: AztecAddress, instance: ContractInstanceWithAddress): void {
-    this.instanceCache.set(address.toString(), instance);
-  }
-
-  /**
-   * Add a contract class to the cache
-   */
-  public addClass(classId: Fr, contractClass: ContractClassPublic): void {
-    this.classCache.set(classId.toString(), contractClass);
-  }
-
-  /**
-   * Get a contract instance from the cache
-   */
-  public getInstance(address: AztecAddress): ContractInstanceWithAddress | undefined {
-    return this.instanceCache.get(address.toString());
-  }
-
-  /**
-   * Get a contract class from the cache
-   */
-  public getClass(classId: Fr): ContractClassPublic | undefined {
-    return this.classCache.get(classId.toString());
-  }
-
-  /**
-   * Check if the cache has a contract class
-   */
-  public hasClass(classId: Fr): boolean {
-    return this.classCache.has(classId.toString());
-  }
-
-  /**
-   * Clear all entries from the cache
-   */
-  public clear(): void {
-    this.instanceCache.clear();
-    this.classCache.clear();
-  }
-
-  /**
-   * Merge another cache into this one
-   */
-  public mergeFrom(other: TxContractCache): void {
-    other.instanceCache.forEach((value, key) => {
-      this.instanceCache.set(key, value);
-    });
-
-    other.classCache.forEach((value, key) => {
-      this.classCache.set(key, value);
-    });
-  }
-}