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

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 { 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,
@@ -59,7 +53,7 @@ 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),
   ) {}
@@ -71,18 +65,10 @@ export class PublicPersistableStateManager {
     treesDB: PublicTreesDB,
     contractsDB: PublicContractsDBInterface,
     trace: PublicSideEffectTraceInterface,
-    doMerkleOperations: boolean = false,
     firstNullifier: Fr,
     timestamp: UInt64,
   ): PublicPersistableStateManager {
-    return new PublicPersistableStateManager(
-      treesDB,
-      contractsDB,
-      trace,
-      firstNullifier,
-      timestamp,
-      doMerkleOperations,
-    );
+    return new PublicPersistableStateManager(treesDB, contractsDB, trace, firstNullifier, timestamp);
   }
 
   /**
@@ -171,7 +157,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}`,
@@ -437,6 +422,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 +526,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 +542,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

@@ -2,6 +2,7 @@ import { sum } from '@aztec/foundation/collection';
 import { type Logger, 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,7 +19,7 @@ export interface PublicEnqueuedCallMetrics {
 export interface PublicTxMetrics {
   // TS simulation
   totalDurationMs: number;
-  manaUsed: number;
+  manaUsed: number | undefined;
   totalInstructionsExecuted: number;
   nonRevertiblePrivateInsertionsUs: number | undefined;
   revertiblePrivateInsertionsUs: number | undefined;
@@ -99,7 +100,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 +110,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;
@@ -202,8 +203,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`;
       }
 

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);
-    });
-  }
-}