@aztec/simulator 2.1.0-rc.9 → 3.0.0-devnet.2

package/dest/public/public_tx_simulator/public_tx_simulator.js

@@ -1,31 +1,64 @@
-import { AVM_MAX_PROCESSABLE_L2_GAS } from '@aztec/constants';
+import { AVM_MAX_PROCESSABLE_L2_GAS, DEFAULT_MAX_DEBUG_LOG_MEMORY_READS } from '@aztec/constants';
+import { Fr } from '@aztec/foundation/fields';
 import { createLogger } from '@aztec/foundation/log';
-import { ProtocolContractAddress } from '@aztec/protocol-contracts';
+import { ProtocolContractAddress, ProtocolContractsList } from '@aztec/protocol-contracts';
 import { computeFeePayerBalanceStorageSlot } from '@aztec/protocol-contracts/fee-juice';
 import { AvmCircuitInputs, AvmExecutionHints, AvmTxHint } from '@aztec/stdlib/avm';
 import { SimulationError } from '@aztec/stdlib/errors';
 import { ProvingRequestType } from '@aztec/stdlib/proofs';
 import { NestedProcessReturnValues, TxExecutionPhase } from '@aztec/stdlib/tx';
+import { strict as assert } from 'assert';
 import { AvmSimulator } from '../avm/index.js';
 import { getPublicFunctionDebugName } from '../debug_fn_name.js';
 import { HintingMerkleWriteOperations, HintingPublicContractsDB } from '../hinting_db_sources.js';
 import { PublicTreesDB } from '../public_db_sources.js';
+import { L2ToL1MessageLimitReachedError, NoteHashLimitReachedError, NullifierCollisionError, NullifierLimitReachedError } from '../side_effect_errors.js';
 import { PublicTxContext } from './public_tx_context.js';
+// The errors below are only thrown here in the public tx simulator,
+// and only during revertible phases (revertible insertions, app logic and teardown).
+// These are strictly "checked" errors (not exported and never propagated).
+// They are used internally for control flow to trigger rollbacks to the post-setup state.
+/**
+ * Error thrown when public tx simulation reverts in a known/checked way during revertible insertions.
+ */ class TxSimRevertibleInsertionsRevert extends Error {
+    constructor(){
+        super('Public Tx Simulation reverted during Revertible Insertions');
+        this.name = 'TxSimRevertibleInsertionsRevert';
+    }
+}
+/**
+ * Error thrown when public tx simulation reverts during app logic.
+ */ class TxSimAppLogicRevert extends Error {
+    constructor(){
+        super('Public Tx Simulation reverted during App Logic');
+        this.name = 'TxSimAppLogicRevert';
+    }
+}
+/**
+ * Error thrown when public tx simulation reverts during teardown.
+ */ class TxSimTeardownRevert extends Error {
+    constructor(){
+        super('Public Tx Simulation reverted during Teardown');
+        this.name = 'TxSimTeardownRevert';
+    }
+}
 export class PublicTxSimulator {
     merkleTree;
     contractsDB;
     globalVariables;
-    doMerkleOperations;
-    skipFeeEnforcement;
-    clientInitiatedSimulation;
     log;
-    constructor(merkleTree, contractsDB, globalVariables, doMerkleOperations = false, skipFeeEnforcement = false, clientInitiatedSimulation = false){
+    config;
+    constructor(merkleTree, contractsDB, globalVariables, config){
         this.merkleTree = merkleTree;
         this.contractsDB = contractsDB;
         this.globalVariables = globalVariables;
-        this.doMerkleOperations = doMerkleOperations;
-        this.skipFeeEnforcement = skipFeeEnforcement;
-        this.clientInitiatedSimulation = clientInitiatedSimulation;
+        this.config = {
+            proverId: config?.proverId ?? Fr.ZERO,
+            doMerkleOperations: config?.doMerkleOperations ?? false,
+            skipFeeEnforcement: config?.skipFeeEnforcement ?? false,
+            clientInitiatedSimulation: config?.clientInitiatedSimulation ?? false,
+            maxDebugLogMemoryReads: config?.maxDebugLogMemoryReads ?? DEFAULT_MAX_DEBUG_LOG_MEMORY_READS
+        };
         this.log = createLogger(`simulator:public_tx_simulator`);
     }
     /**
@@ -39,11 +72,11 @@ export class PublicTxSimulator {
                 txHash
             });
             // Create hinting DBs.
-            const hints = new AvmExecutionHints(this.globalVariables, AvmTxHint.fromTx(tx, this.globalVariables.gasFees));
+            const hints = new AvmExecutionHints(this.globalVariables, AvmTxHint.fromTx(tx, this.globalVariables.gasFees), ProtocolContractsList);
             const hintingMerkleTree = await HintingMerkleWriteOperations.create(this.merkleTree, hints);
             const hintingTreesDB = new PublicTreesDB(hintingMerkleTree);
             const hintingContractsDB = new HintingPublicContractsDB(this.contractsDB, hints);
-            const context = await PublicTxContext.create(hintingTreesDB, hintingContractsDB, tx, this.globalVariables, this.doMerkleOperations);
+            const context = await PublicTxContext.create(hintingTreesDB, hintingContractsDB, tx, this.globalVariables, ProtocolContractsList, this.config.doMerkleOperations, this.config.proverId);
             // This will throw if there is a nullifier collision.
             // In that case the transaction will be thrown out.
             await this.insertNonRevertiblesFromPrivate(context, tx);
@@ -60,43 +93,50 @@ export class PublicTxSimulator {
             // The checkpoint we should go back to if anything from now on reverts.
             await context.state.fork();
             try {
-                // This will throw if there is a nullifier collision.
+                // This will throw if there is a nullifier collision or other insertion error (limit reached).
                 await this.insertRevertiblesFromPrivate(context, tx);
                 // Only proceed with app logic if there was no revert during revertible insertion.
                 if (context.hasPhase(TxExecutionPhase.APP_LOGIC)) {
                     const appLogicResult = await this.simulatePhase(TxExecutionPhase.APP_LOGIC, context);
                     processedPhases.push(appLogicResult);
                     if (appLogicResult.reverted) {
-                        throw new Error(`App logic phase reverted! ${appLogicResult.revertReason?.message}`);
+                        throw new TxSimAppLogicRevert();
                     }
                 }
             } catch (e) {
-                this.log.debug(String(e));
-                // We revert to the post-setup state.
-                await context.state.discardForkedState();
-                // But we also create a new fork so that the teardown phase can transparently
-                // commit or rollback at the end of teardown.
-                await context.state.fork();
+                if (e instanceof TxSimRevertibleInsertionsRevert || e instanceof TxSimAppLogicRevert) {
+                    // We revert to the post-setup state.
+                    await context.state.discardForkedState();
+                    // But we also create a new fork so that the teardown phase can transparently
+                    // commit or rollback at the end of teardown.
+                    await context.state.fork();
+                } else {
+                    // Unchecked/unknown error - re-throw as-is
+                    throw e;
+                }
             }
             try {
                 if (context.hasPhase(TxExecutionPhase.TEARDOWN)) {
                     const teardownResult = await this.simulatePhase(TxExecutionPhase.TEARDOWN, context);
                     processedPhases.push(teardownResult);
                     if (teardownResult.reverted) {
-                        throw new Error(`Teardown phase reverted! ${teardownResult.revertReason?.message}`);
+                        throw new TxSimTeardownRevert();
                     }
                 }
                 // We commit the forked state and we are done.
                 await context.state.mergeForkedState();
             } catch (e) {
-                this.log.debug(String(e));
-                // We rollback to the post-setup state.
-                await context.state.discardForkedState();
+                if (e instanceof TxSimTeardownRevert) {
+                    // We revert to the post-setup state and we are done.
+                    await context.state.discardForkedState();
+                } else {
+                    // Unchecked/unknown error - re-throw as-is
+                    throw e;
+                }
             }
             context.halt();
-            if (context.getActualGasUsed().l2Gas > AVM_MAX_PROCESSABLE_L2_GAS) {
-                throw new Error(`Transaction consumes ${context.getActualGasUsed().l2Gas} L2 gas, which exceeds the AVM maximum processable gas of ${AVM_MAX_PROCESSABLE_L2_GAS}`);
-            }
+            // Such transactions should be filtered by GasTxValidator.
+            assert(context.getActualGasUsed().l2Gas <= AVM_MAX_PROCESSABLE_L2_GAS, `Transaction consumes ${context.getActualGasUsed().l2Gas} L2 gas, which exceeds the AVM maximum processable gas of ${AVM_MAX_PROCESSABLE_L2_GAS}`);
             await this.payFee(context);
             const publicInputs = await context.generateAvmCircuitPublicInputs();
             const avmProvingRequest = PublicTxSimulator.generateProvingRequest(publicInputs, hints);
@@ -117,7 +157,8 @@ export class PublicTxSimulator {
                 },
                 revertCode,
                 revertReason: context.revertReason,
-                processedPhases: processedPhases
+                processedPhases: processedPhases,
+                logs: context.state.getActiveStateManager().getLogs()
             };
         } finally{
             // Make sure there are no new contracts in the tx-level cache.
@@ -200,7 +241,7 @@ export class PublicTxSimulator {
         const address = request.contractAddress;
         const sender = request.msgSender;
         this.log.debug(`Executing enqueued public call to external function ${fnName}@${address} with ${allocatedGas.l2Gas} allocated L2 gas.`);
-        const simulator = await AvmSimulator.create(stateManager, address, sender, transactionFee, this.globalVariables, request.isStaticCall, calldata, allocatedGas, this.clientInitiatedSimulation);
+        const simulator = await AvmSimulator.create(stateManager, address, sender, transactionFee, this.globalVariables, request.isStaticCall, calldata, allocatedGas, this.config.clientInitiatedSimulation, this.config.maxDebugLogMemoryReads);
         const avmCallResult = await simulator.execute();
         return avmCallResult.finalize();
     }
@@ -229,7 +270,12 @@ export class PublicTxSimulator {
     }
     /**
    * Insert the revertible accumulated data from private into the public state.
-   * Start by forking state so we can rollback to the end of setup if app logic or teardown reverts.
+   * Throws TxSimRevertibleInsertionsRevert if there is some checked error during revertible insertions.
+   * This function checks for the following errors:
+   * - NullifierLimitReachedError
+   * - NullifierCollisionError
+   * - NoteHashLimitReachedError
+   * - L2ToL1MessageLimitReachedError
    */ async insertRevertiblesFromPrivate(context, tx) {
         const stateManager = context.state.getActiveStateManager();
         try {
@@ -237,25 +283,49 @@ export class PublicTxSimulator {
                 await stateManager.writeSiloedNullifier(siloedNullifier);
             }
         } catch (e) {
-            context.revert(TxExecutionPhase.APP_LOGIC, new SimulationError(`Nullifier collision encountered when inserting revertible nullifiers from private.\nDetails: ${String(e)}`, []));
-            throw e;
+            if (e instanceof NullifierLimitReachedError || e instanceof NullifierCollisionError) {
+                context.revert(TxExecutionPhase.APP_LOGIC, new SimulationError(`Error encountered when inserting revertible nullifiers from private.\nDetails: ${e.message}`, []));
+                throw new TxSimRevertibleInsertionsRevert();
+            } else {
+                // Unchecked/unknown error - re-throw as-is
+                throw e;
+            }
         }
-        for (const noteHash of context.revertibleAccumulatedDataFromPrivate.noteHashes){
-            if (!noteHash.isEmpty()) {
-                // Revertible note hashes from private are not hashed with nonce, since private can't know their final position, only we can.
-                await stateManager.writeSiloedNoteHash(noteHash);
+        try {
+            for (const noteHash of context.revertibleAccumulatedDataFromPrivate.noteHashes){
+                if (!noteHash.isEmpty()) {
+                    // Revertible note hashes from private are not hashed with nonce, since private can't know their final position, only we can.
+                    await stateManager.writeSiloedNoteHash(noteHash);
+                }
+            }
+        } catch (e) {
+            if (e instanceof NoteHashLimitReachedError) {
+                context.revert(TxExecutionPhase.APP_LOGIC, new SimulationError(`Error encountered when inserting revertible note hashes from private.\nDetails: ${e.message}`, []));
+                throw new TxSimRevertibleInsertionsRevert();
+            } else {
+                // Unchecked/unknown error - re-throw as-is
+                throw e;
             }
         }
-        for (const l2ToL1Message of context.revertibleAccumulatedDataFromPrivate.l2ToL1Msgs){
-            if (!l2ToL1Message.isEmpty()) {
-                stateManager.writeScopedL2ToL1Message(l2ToL1Message);
+        try {
+            for (const l2ToL1Message of context.revertibleAccumulatedDataFromPrivate.l2ToL1Msgs){
+                if (!l2ToL1Message.isEmpty()) {
+                    stateManager.writeScopedL2ToL1Message(l2ToL1Message);
+                }
+            }
+        } catch (e) {
+            if (e instanceof L2ToL1MessageLimitReachedError) {
+                context.revert(TxExecutionPhase.APP_LOGIC, new SimulationError(`Error encountered when inserting revertible L2-to-L1 messages from private.\nDetails: ${e.message}`, []));
+                throw new TxSimRevertibleInsertionsRevert();
+            } else {
+                // Unchecked/unknown error - re-throw as-is
+                throw e;
             }
         }
         // add new contracts to the contracts db so that their functions may be found and called
         // FIXME(fcarreiro): this should conceptually use the hinted contracts db.
         // However things should work as they are now because the hinted db would still pick up the new contracts.
         await this.contractsDB.addNewRevertibleContracts(tx);
-        return /*success=*/ true;
     }
     async payFee(context) {
         const txFee = context.getTransactionFee(TxExecutionPhase.TEARDOWN);
@@ -271,11 +341,9 @@ export class PublicTxSimulator {
         // We allow to fake the balance of the fee payer to allow fee estimation
         // When mocking the balance of the fee payer, the circuit should not be able to prove the simulation
         if (currentBalance.lt(txFee)) {
-            if (!this.skipFeeEnforcement) {
-                throw new Error(`Not enough balance for fee payer to pay for transaction (got ${currentBalance.toBigInt()} needs ${txFee.toBigInt()})`);
-            } else {
-                currentBalance = txFee;
-            }
+            // Without "skipFeeEnforcement", such transactions should be filtered by GasTxValidator.
+            assert(this.config.skipFeeEnforcement, `Not enough balance for fee payer to pay for transaction (got ${currentBalance.toBigInt()} needs ${txFee.toBigInt()})`);
+            currentBalance = txFee;
         }
         const updatedBalance = currentBalance.sub(txFee);
         await stateManager.writeStorage(feeJuiceAddress, balanceSlot, updatedBalance, true);

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

@@ -0,0 +1,9 @@
+import type { Tx } from '@aztec/stdlib/tx';
+import type { PublicTxResult } from './public_tx_simulator.js';
+export interface PublicTxSimulatorInterface {
+    simulate(tx: Tx): Promise<PublicTxResult>;
+}
+export interface MeasuredPublicTxSimulatorInterface {
+    simulate(tx: Tx, txLabel: string): Promise<PublicTxResult>;
+}
+//# sourceMappingURL=public_tx_simulator_interface.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"public_tx_simulator_interface.d.ts","sourceRoot":"","sources":["../../../src/public/public_tx_simulator/public_tx_simulator_interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAC;AAE3C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE/D,MAAM,WAAW,0BAA0B;IACzC,QAAQ,CAAC,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;CAC3C;AAED,MAAM,WAAW,kCAAkC;IACjD,QAAQ,CAAC,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;CAC5D"}

package/dest/public/public_tx_simulator/public_tx_simulator_interface.js

@@ -0,0 +1 @@
+export { };

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

@@ -8,12 +8,13 @@ import type { PublicContractsDB } from '../public_db_sources.js';
 import type { PublicPersistableStateManager } from '../state_manager/state_manager.js';
 import { MeasuredPublicTxSimulator } from './measured_public_tx_simulator.js';
 import { PublicTxContext } from './public_tx_context.js';
+import type { PublicTxSimulatorConfig } from './public_tx_simulator.js';
 /**
  * A public tx simulator that tracks runtime/production metrics with telemetry.
  */
 export declare class TelemetryPublicTxSimulator extends MeasuredPublicTxSimulator {
     readonly tracer: Tracer;
-    constructor(merkleTree: MerkleTreeWriteOperations, contractsDB: PublicContractsDB, globalVariables: GlobalVariables, doMerkleOperations?: boolean, skipFeeEnforcement?: boolean, clientInitiatedSimulation?: boolean, telemetryClient?: TelemetryClient);
+    constructor(merkleTree: MerkleTreeWriteOperations, contractsDB: PublicContractsDB, globalVariables: GlobalVariables, telemetryClient?: TelemetryClient, config?: Partial<PublicTxSimulatorConfig>);
     protected simulateEnqueuedCall(phase: TxExecutionPhase, context: PublicTxContext, callRequest: PublicCallRequestWithCalldata): Promise<AvmFinalizedCallResult>;
     protected simulateEnqueuedCallInternal(stateManager: PublicPersistableStateManager, callRequest: PublicCallRequestWithCalldata, allocatedGas: Gas, transactionFee: Fr, fnName: string): Promise<AvmFinalizedCallResult>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"telemetry_public_tx_simulator.d.ts","sourceRoot":"","sources":["../../../src/public/public_tx_simulator/telemetry_public_tx_simulator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AACrE,OAAO,EAAE,KAAK,eAAe,EAAE,6BAA6B,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACzG,OAAO,EAAc,KAAK,eAAe,EAAE,KAAK,MAAM,EAAiC,MAAM,yBAAyB,CAAC;AAEvH,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAEjF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,mCAAmC,CAAC;AACvF,OAAO,EAAE,yBAAyB,EAAE,MAAM,mCAAmC,CAAC;AAC9E,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,yBAAyB;IAEvE,SAAgB,MAAM,EAAE,MAAM,CAAC;gBAG7B,UAAU,EAAE,yBAAyB,EACrC,WAAW,EAAE,iBAAiB,EAC9B,eAAe,EAAE,eAAe,EAChC,kBAAkB,GAAE,OAAe,EACnC,kBAAkB,GAAE,OAAe,EACnC,yBAAyB,GAAE,OAAe,EAC1C,eAAe,GAAE,eAAsC;cAqBhC,oBAAoB,CAC3C,KAAK,EAAE,gBAAgB,EACvB,OAAO,EAAE,eAAe,EACxB,WAAW,EAAE,6BAA6B,GACzC,OAAO,CAAC,sBAAsB,CAAC;cAUT,4BAA4B,CACnD,YAAY,EAAE,6BAA6B,EAC3C,WAAW,EAAE,6BAA6B,EAC1C,YAAY,EAAE,GAAG,EACjB,cAAc,EAAE,EAAE,EAClB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,sBAAsB,CAAC;CAGnC"}
+{"version":3,"file":"telemetry_public_tx_simulator.d.ts","sourceRoot":"","sources":["../../../src/public/public_tx_simulator/telemetry_public_tx_simulator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AACrE,OAAO,EAAE,KAAK,eAAe,EAAE,6BAA6B,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACzG,OAAO,EAAc,KAAK,eAAe,EAAE,KAAK,MAAM,EAAiC,MAAM,yBAAyB,CAAC;AAEvH,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAEjF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,mCAAmC,CAAC;AACvF,OAAO,EAAE,yBAAyB,EAAE,MAAM,mCAAmC,CAAC;AAC9E,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,0BAA0B,CAAC;AAExE;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,yBAAyB;IAEvE,SAAgB,MAAM,EAAE,MAAM,CAAC;gBAG7B,UAAU,EAAE,yBAAyB,EACrC,WAAW,EAAE,iBAAiB,EAC9B,eAAe,EAAE,eAAe,EAChC,eAAe,GAAE,eAAsC,EACvD,MAAM,CAAC,EAAE,OAAO,CAAC,uBAAuB,CAAC;cAalB,oBAAoB,CAC3C,KAAK,EAAE,gBAAgB,EACvB,OAAO,EAAE,eAAe,EACxB,WAAW,EAAE,6BAA6B,GACzC,OAAO,CAAC,sBAAsB,CAAC;cAUT,4BAA4B,CACnD,YAAY,EAAE,6BAA6B,EAC3C,WAAW,EAAE,6BAA6B,EAC1C,YAAY,EAAE,GAAG,EACjB,cAAc,EAAE,EAAE,EAClB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,sBAAsB,CAAC;CAGnC"}

package/dest/public/public_tx_simulator/telemetry_public_tx_simulator.js

@@ -12,9 +12,9 @@ import { MeasuredPublicTxSimulator } from './measured_public_tx_simulator.js';
  * A public tx simulator that tracks runtime/production metrics with telemetry.
  */ export class TelemetryPublicTxSimulator extends MeasuredPublicTxSimulator {
     /* tracer needed by trackSpans */ tracer;
-    constructor(merkleTree, contractsDB, globalVariables, doMerkleOperations = false, skipFeeEnforcement = false, clientInitiatedSimulation = false, telemetryClient = getTelemetryClient()){
+    constructor(merkleTree, contractsDB, globalVariables, telemetryClient = getTelemetryClient(), config){
         const metrics = new ExecutorMetrics(telemetryClient, 'PublicTxSimulator');
-        super(merkleTree, contractsDB, globalVariables, doMerkleOperations, skipFeeEnforcement, clientInitiatedSimulation, metrics);
+        super(merkleTree, contractsDB, globalVariables, metrics, config);
         this.tracer = metrics.tracer;
     }
     async simulateEnqueuedCall(phase, context, callRequest) {

package/dest/public/side_effect_errors.d.ts

@@ -1,4 +1,44 @@
-export declare class SideEffectLimitReachedError extends Error {
+import { CheckedPublicExecutionError } from './public_errors.js';
+/**
+ * Any error that can be thrown during side effect insertion in public.
+ * Includes SideEffectLimitReachedError and NullifierCollisionError.
+ */
+export declare abstract class SideEffectError extends CheckedPublicExecutionError {
+    constructor(message: string);
+}
+export declare class SideEffectLimitReachedError extends SideEffectError {
     constructor(sideEffectType: string, limit: number);
 }
+export declare class MaxCallsToUniqueContractClassIdsError extends SideEffectLimitReachedError {
+    constructor();
+}
+export declare class NullifierLimitReachedError extends SideEffectLimitReachedError {
+    constructor();
+}
+export declare class NoteHashLimitReachedError extends SideEffectLimitReachedError {
+    constructor();
+}
+export declare class L2ToL1MessageLimitReachedError extends SideEffectLimitReachedError {
+    constructor();
+}
+export declare class NullifierCollisionError extends SideEffectError {
+    constructor(message: string);
+}
+/**
+ * Any error that can be thrown during side effect reads in public.
+ * Note: Thrown at state manager level and unknown by simulation, hence NOT considered
+ * CheckedPublicExecutionErrors. Currently only includes append-only tree reads.
+ */
+export declare abstract class SideEffectReadError extends Error {
+    constructor(message: string);
+}
+export declare class IndexOutOfRangeError extends SideEffectReadError {
+    constructor(tree: string, index: number, limit: number);
+}
+export declare class NoteHashIndexOutOfRangeError extends IndexOutOfRangeError {
+    constructor(index: number);
+}
+export declare class L1ToL2MessageIndexOutOfRangeError extends IndexOutOfRangeError {
+    constructor(index: number);
+}
 //# sourceMappingURL=side_effect_errors.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"side_effect_errors.d.ts","sourceRoot":"","sources":["../../src/public/side_effect_errors.ts"],"names":[],"mappings":"AAAA,qBAAa,2BAA4B,SAAQ,KAAK;gBACxC,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;CAIlD"}
+{"version":3,"file":"side_effect_errors.d.ts","sourceRoot":"","sources":["../../src/public/side_effect_errors.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AAEjE;;;GAGG;AACH,8BAAsB,eAAgB,SAAQ,2BAA2B;gBAC3D,OAAO,EAAE,MAAM;CAI5B;AAED,qBAAa,2BAA4B,SAAQ,eAAe;gBAClD,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;CAIlD;AAED,qBAAa,qCAAsC,SAAQ,2BAA2B;;CAKrF;AAED,qBAAa,0BAA2B,SAAQ,2BAA2B;;CAK1E;AAED,qBAAa,yBAA0B,SAAQ,2BAA2B;;CAKzE;AAED,qBAAa,8BAA+B,SAAQ,2BAA2B;;CAK9E;AAED,qBAAa,uBAAwB,SAAQ,eAAe;gBAC9C,OAAO,EAAE,MAAM;CAI5B;AAED;;;;GAIG;AACH,8BAAsB,mBAAoB,SAAQ,KAAK;gBACzC,OAAO,EAAE,MAAM;CAI5B;AAED,qBAAa,oBAAqB,SAAQ,mBAAmB;gBAC/C,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;CAIvD;AAED,qBAAa,4BAA6B,SAAQ,oBAAoB;gBACxD,KAAK,EAAE,MAAM;CAI1B;AAED,qBAAa,iCAAkC,SAAQ,oBAAoB;gBAC7D,KAAK,EAAE,MAAM;CAI1B"}

package/dest/public/side_effect_errors.js

@@ -1,6 +1,75 @@
-export class SideEffectLimitReachedError extends Error {
+import { L1_TO_L2_MSG_TREE_LEAF_COUNT, MAX_L2_TO_L1_MSGS_PER_TX, MAX_NOTE_HASHES_PER_TX, MAX_NULLIFIERS_PER_TX, MAX_PUBLIC_CALLS_TO_UNIQUE_CONTRACT_CLASS_IDS, NOTE_HASH_TREE_LEAF_COUNT } from '@aztec/constants';
+import { CheckedPublicExecutionError } from './public_errors.js';
+/**
+ * Any error that can be thrown during side effect insertion in public.
+ * Includes SideEffectLimitReachedError and NullifierCollisionError.
+ */ export class SideEffectError extends CheckedPublicExecutionError {
+    constructor(message){
+        super(message);
+        this.name = 'SideEffectInsertionError';
+    }
+}
+export class SideEffectLimitReachedError extends SideEffectError {
     constructor(sideEffectType, limit){
         super(`Reached the limit (${limit}) on number of '${sideEffectType}' per tx`);
         this.name = 'SideEffectLimitReachedError';
     }
 }
+export class MaxCallsToUniqueContractClassIdsError extends SideEffectLimitReachedError {
+    constructor(){
+        super('contract calls to unique class IDs', MAX_PUBLIC_CALLS_TO_UNIQUE_CONTRACT_CLASS_IDS);
+        this.name = 'MaxCallsToUniqueContractClassIdsError';
+    }
+}
+export class NullifierLimitReachedError extends SideEffectLimitReachedError {
+    constructor(){
+        super('nullifier', MAX_NULLIFIERS_PER_TX);
+        this.name = 'NullifierLimitReachedError';
+    }
+}
+export class NoteHashLimitReachedError extends SideEffectLimitReachedError {
+    constructor(){
+        super('note hash', MAX_NOTE_HASHES_PER_TX);
+        this.name = 'NoteHashLimitReachedError';
+    }
+}
+export class L2ToL1MessageLimitReachedError extends SideEffectLimitReachedError {
+    constructor(){
+        super('l2 to l1 message', MAX_L2_TO_L1_MSGS_PER_TX);
+        this.name = 'L2ToL1MessageLimitReachedError';
+    }
+}
+export class NullifierCollisionError extends SideEffectError {
+    constructor(message){
+        super(`Nullifier collision: ${message}`);
+        this.name = 'NullifierCollisionError';
+    }
+}
+/**
+ * Any error that can be thrown during side effect reads in public.
+ * Note: Thrown at state manager level and unknown by simulation, hence NOT considered
+ * CheckedPublicExecutionErrors. Currently only includes append-only tree reads.
+ */ export class SideEffectReadError extends Error {
+    constructor(message){
+        super(message);
+        this.name = 'SideEffectReadError';
+    }
+}
+export class IndexOutOfRangeError extends SideEffectReadError {
+    constructor(tree, index, limit){
+        super(`Attempting to read index ${index} of ${tree} tree with maximum ${limit} leaves`);
+        this.name = 'IndexOutOfRangeError';
+    }
+}
+export class NoteHashIndexOutOfRangeError extends IndexOutOfRangeError {
+    constructor(index){
+        super('note hash', index, NOTE_HASH_TREE_LEAF_COUNT);
+        this.name = 'NoteHashIndexOutOfRangeError';
+    }
+}
+export class L1ToL2MessageIndexOutOfRangeError extends IndexOutOfRangeError {
+    constructor(index){
+        super('l1 to l2 message', index, L1_TO_L2_MSG_TREE_LEAF_COUNT);
+        this.name = 'L1ToL2MessageIndexOutOfRangeError';
+    }
+}

package/dest/public/side_effect_trace.d.ts

@@ -1,8 +1,9 @@
 import { Fr } from '@aztec/foundation/fields';
+import { type LogLevel } from '@aztec/foundation/log';
 import { PublicDataUpdateRequest } from '@aztec/stdlib/avm';
 import type { AztecAddress } from '@aztec/stdlib/aztec-address';
 import { NoteHash, Nullifier } from '@aztec/stdlib/kernel';
-import { PublicLog } from '@aztec/stdlib/logs';
+import { DebugLog, PublicLog } from '@aztec/stdlib/logs';
 import { ScopedL2ToL1Message } from '@aztec/stdlib/messaging';
 import type { PublicSideEffectTraceInterface } from './side_effect_trace_interface.js';
 import { UniqueClassIds } from './unique_class_ids.js';
@@ -24,8 +25,8 @@ export declare class SideEffectArrayLengths {
     readonly noteHashes: number;
     readonly nullifiers: number;
     readonly l2ToL1Msgs: number;
-    readonly publicLogs: number;
-    constructor(publicDataWrites: number, protocolPublicDataWrites: number, noteHashes: number, nullifiers: number, l2ToL1Msgs: number, publicLogs: number);
+    readonly publicLogFields: number;
+    constructor(publicDataWrites: number, protocolPublicDataWrites: number, noteHashes: number, nullifiers: number, l2ToL1Msgs: number, publicLogFields: number);
     static empty(): SideEffectArrayLengths;
 }
 /**
@@ -41,6 +42,8 @@ export declare class SideEffectTrace implements PublicSideEffectTraceInterface {
     /** We need to track the set of class IDs used, to enforce limits. */
     private uniqueClassIds;
     private writtenPublicDataSlots;
+    private debugLogs;
+    private debugLogMemoryReads;
     log: import("@aztec/foundation/log").Logger;
     /** The side effect counter increments with every call to the trace. */
     private sideEffectCounter;
@@ -61,7 +64,7 @@ export declare class SideEffectTrace implements PublicSideEffectTraceInterface {
      */
     previousSideEffectArrayLengths?: SideEffectArrayLengths, 
     /** We need to track the set of class IDs used, to enforce limits. */
-    uniqueClassIds?: UniqueClassIds, writtenPublicDataSlots?: Set<string>);
+    uniqueClassIds?: UniqueClassIds, writtenPublicDataSlots?: Set<string>, debugLogs?: DebugLog[], debugLogMemoryReads?: number);
     fork(): SideEffectTrace;
     merge(forkedTrace: this, reverted?: boolean): void;
     getCounter(): number;
@@ -74,6 +77,10 @@ export declare class SideEffectTrace implements PublicSideEffectTraceInterface {
     traceNewNullifier(siloedNullifier: Fr): void;
     traceNewL2ToL1Message(contractAddress: AztecAddress, recipient: Fr, content: Fr): void;
     tracePublicLog(contractAddress: AztecAddress, log: Fr[]): void;
+    traceDebugLog(contractAddress: AztecAddress, level: LogLevel, message: string, fields: Fr[]): void;
+    getDebugLogs(): DebugLog[];
+    getDebugLogMemoryReads(): number;
+    traceDebugLogMemoryReads(memoryReads: number): void;
     traceGetContractClass(contractClassId: Fr, exists: boolean): void;
     getSideEffects(): SideEffects;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"side_effect_trace.d.ts","sourceRoot":"","sources":["../../src/public/side_effect_trace.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAE9C,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAEhE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAiB,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAK7E,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD;;;;IAII;AACJ,MAAM,MAAM,WAAW,GAAG;IACxB,gBAAgB,EAAE,uBAAuB,EAAE,CAAC;IAC5C,UAAU,EAAE,QAAQ,EAAE,CAAC;IACvB,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,UAAU,EAAE,mBAAmB,EAAE,CAAC;IAClC,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB,CAAC;AAEF,qBAAa,sBAAsB;aAEf,gBAAgB,EAAE,MAAM;aACxB,wBAAwB,EAAE,MAAM;aAChC,UAAU,EAAE,MAAM;aAClB,UAAU,EAAE,MAAM;aAClB,UAAU,EAAE,MAAM;aAClB,UAAU,EAAE,MAAM;gBALlB,gBAAgB,EAAE,MAAM,EACxB,wBAAwB,EAAE,MAAM,EAChC,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM;IAGpC,MAAM,CAAC,KAAK;CAGb;AAED;;GAEG;AACH,qBAAa,eAAgB,YAAW,8BAA8B;IAkBlE,qDAAqD;aACrC,sBAAsB,EAAE,MAAM;IAC9C;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,8BAA8B;IAC/C,qEAAqE;IACrE,OAAO,CAAC,cAAc;IACtB,OAAO,CAAC,sBAAsB;IAzBzB,GAAG,yCAA+C;IAEzD,uEAAuE;IACvE,OAAO,CAAC,iBAAiB,CAAS;IAElC,OAAO,CAAC,gBAAgB,CAAiC;IACzD,OAAO,CAAC,8BAA8B,CAAa;IACnD,OAAO,CAAC,0BAA0B,CAAa;IAC/C,OAAO,CAAC,UAAU,CAAkB;IACpC,OAAO,CAAC,UAAU,CAAmB;IACrC,OAAO,CAAC,cAAc,CAA6B;IACnD,OAAO,CAAC,UAAU,CAAmB;IAErC,sDAAsD;IACtD,OAAO,CAAC,uBAAuB,CAAS;;IAGtC,qDAAqD;IACrC,sBAAsB,GAAE,MAAU;IAClD;;OAEG;IACc,8BAA8B,GAAE,sBAAuD;IACxG,qEAAqE;IAC7D,cAAc,GAAE,cAAqC,EACrD,sBAAsB,GAAE,GAAG,CAAC,MAAM,CAAa;IAKlD,IAAI;IAgBJ,KAAK,CAAC,WAAW,EAAE,IAAI,EAAE,QAAQ,GAAE,OAAe;IAyBlD,UAAU;IAIjB,OAAO,CAAC,0BAA0B;IAI3B,gBAAgB;IAIV,uBAAuB,CAClC,eAAe,EAAE,YAAY,EAC7B,IAAI,EAAE,EAAE,EACR,KAAK,EAAE,EAAE,EACT,aAAa,EAAE,OAAO,GACrB,OAAO,CAAC,IAAI,CAAC;IAsChB,OAAO,CAAC,wBAAwB;IAIzB,aAAa,CAAC,eAAe,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,GAAG,OAAO;IAI/D,gBAAgB,CAAC,QAAQ,EAAE,EAAE;IAU7B,iBAAiB,CAAC,eAAe,EAAE,EAAE;IAWrC,qBAAqB,CAAC,eAAe,EAAE,YAAY,EAAE,SAAS,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE;IAW/E,cAAc,CAAC,eAAe,EAAE,YAAY,EAAE,GAAG,EAAE,EAAE,EAAE;IAcvD,qBAAqB,CAAC,eAAe,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO;IAgB1D,cAAc,IAAI,WAAW;CASrC"}
+{"version":3,"file":"side_effect_trace.d.ts","sourceRoot":"","sources":["../../src/public/side_effect_trace.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAC9C,OAAO,EAAE,KAAK,QAAQ,EAAgB,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAEhE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAiB,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAW7E,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD;;;;IAII;AACJ,MAAM,MAAM,WAAW,GAAG;IACxB,gBAAgB,EAAE,uBAAuB,EAAE,CAAC;IAC5C,UAAU,EAAE,QAAQ,EAAE,CAAC;IACvB,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,UAAU,EAAE,mBAAmB,EAAE,CAAC;IAClC,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB,CAAC;AAEF,qBAAa,sBAAsB;aAEf,gBAAgB,EAAE,MAAM;aACxB,wBAAwB,EAAE,MAAM;aAChC,UAAU,EAAE,MAAM;aAClB,UAAU,EAAE,MAAM;aAClB,UAAU,EAAE,MAAM;aAClB,eAAe,EAAE,MAAM;gBALvB,gBAAgB,EAAE,MAAM,EACxB,wBAAwB,EAAE,MAAM,EAChC,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAClB,eAAe,EAAE,MAAM;IAGzC,MAAM,CAAC,KAAK;CAGb;AAED;;GAEG;AACH,qBAAa,eAAgB,YAAW,8BAA8B;IAiBlE,qDAAqD;aACrC,sBAAsB,EAAE,MAAM;IAC9C;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,8BAA8B;IAC/C,qEAAqE;IACrE,OAAO,CAAC,cAAc;IACtB,OAAO,CAAC,sBAAsB;IAC9B,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,mBAAmB;IA1BtB,GAAG,yCAA+C;IAEzD,uEAAuE;IACvE,OAAO,CAAC,iBAAiB,CAAS;IAElC,OAAO,CAAC,gBAAgB,CAAiC;IACzD,OAAO,CAAC,8BAA8B,CAAa;IACnD,OAAO,CAAC,0BAA0B,CAAa;IAC/C,OAAO,CAAC,UAAU,CAAkB;IACpC,OAAO,CAAC,UAAU,CAAmB;IACrC,OAAO,CAAC,cAAc,CAA6B;IACnD,OAAO,CAAC,UAAU,CAAmB;IACrC,sDAAsD;IACtD,OAAO,CAAC,uBAAuB,CAAS;;IAGtC,qDAAqD;IACrC,sBAAsB,GAAE,MAAU;IAClD;;OAEG;IACc,8BAA8B,GAAE,sBAAuD;IACxG,qEAAqE;IAC7D,cAAc,GAAE,cAAqC,EACrD,sBAAsB,GAAE,GAAG,CAAC,MAAM,CAAa,EAC/C,SAAS,GAAE,QAAQ,EAAO,EAC1B,mBAAmB,GAAE,MAAU;IAKlC,IAAI;IAmBJ,KAAK,CAAC,WAAW,EAAE,IAAI,EAAE,QAAQ,GAAE,OAAe;IA2BlD,UAAU;IAIjB,OAAO,CAAC,0BAA0B;IAI3B,gBAAgB;IAIV,uBAAuB,CAClC,eAAe,EAAE,YAAY,EAC7B,IAAI,EAAE,EAAE,EACR,KAAK,EAAE,EAAE,EACT,aAAa,EAAE,OAAO,GACrB,OAAO,CAAC,IAAI,CAAC;IAsChB,OAAO,CAAC,wBAAwB;IAIzB,aAAa,CAAC,eAAe,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,GAAG,OAAO;IAI/D,gBAAgB,CAAC,QAAQ,EAAE,EAAE;IAU7B,iBAAiB,CAAC,eAAe,EAAE,EAAE;IAWrC,qBAAqB,CAAC,eAAe,EAAE,YAAY,EAAE,SAAS,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE;IAW/E,cAAc,CAAC,eAAe,EAAE,YAAY,EAAE,GAAG,EAAE,EAAE,EAAE;IAgBvD,aAAa,CAAC,eAAe,EAAE,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE;IAI3F,YAAY;IAIZ,sBAAsB;IAItB,wBAAwB,CAAC,WAAW,EAAE,MAAM;IAI5C,qBAAqB,CAAC,eAAe,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO;IAa1D,cAAc,IAAI,WAAW;CASrC"}