@aztec/simulator 0.56.0 → 0.58.0

package/src/public/enqueued_calls_processor.ts

@@ -1,5 +1,5 @@
 import {
-  type MerkleTreeOperations,
+  type MerkleTreeReadOperations,
   type NestedProcessReturnValues,
   type ProcessedTx,
   ProvingRequestType,
@@ -28,7 +28,7 @@ import {
 } from '@aztec/circuits.js';
 import { type DebugLogger, createDebugLogger } from '@aztec/foundation/log';
 import { Timer } from '@aztec/foundation/timer';
-import { ProtocolCircuitVks, getVKIndex, getVKSiblingPath } from '@aztec/noir-protocol-circuits-types';
+import { ProtocolCircuitVks, TubeVk, getVKIndex, getVKSiblingPath } from '@aztec/noir-protocol-circuits-types';
 
 import { inspect } from 'util';
 
@@ -93,7 +93,7 @@ export class EnqueuedCallsProcessor {
   }
 
   static create(
-    db: MerkleTreeOperations,
+    db: MerkleTreeReadOperations,
     publicExecutor: PublicExecutor,
     publicKernelSimulator: PublicKernelCircuitSimulator,
     globalVariables: GlobalVariables,
@@ -377,9 +377,7 @@ export class EnqueuedCallsProcessor {
     // The proof is not used in simulation.
     const proof = makeEmptyRecursiveProof(NESTED_RECURSIVE_PROOF_LENGTH);
 
-    const vk = isFromPrivate
-      ? ProtocolCircuitVks.PrivateKernelTailToPublicArtifact
-      : ProtocolCircuitVks.PublicKernelMergeArtifact;
+    const vk = isFromPrivate ? TubeVk : ProtocolCircuitVks.PublicKernelMergeArtifact;
     const vkIndex = getVKIndex(vk);
     const siblingPath = getVKSiblingPath(vkIndex);
 

package/src/public/execution.ts

@@ -1,4 +1,5 @@
 import {
+  NestedProcessReturnValues,
   type PublicExecutionRequest,
   type SimulationError,
   type UnencryptedFunctionL2Logs,
@@ -21,8 +22,6 @@ import {
 } from '@aztec/circuits.js';
 import { computeVarArgsHash } from '@aztec/circuits.js/hash';
 
-import { type Gas as AvmGas } from '../avm/avm_gas.js';
-
 /**
  * The public function execution result.
  */
@@ -35,9 +34,9 @@ export interface PublicExecutionResult {
   /** The side effect counter after executing this function call */
   endSideEffectCounter: Fr;
   /** How much gas was available for this public execution. */
-  startGasLeft: AvmGas;
+  startGasLeft: Gas;
   /** How much gas was left after this public execution. */
-  endGasLeft: AvmGas;
+  endGasLeft: Gas;
   /** Transaction fee set for this tx. */
   transactionFee: Fr;
 
@@ -86,8 +85,6 @@ export interface PublicExecutionResult {
    */
   allUnencryptedLogs: UnencryptedFunctionL2Logs;
 
-  // TODO(dbanks12): add contract instance read requests
-
   /** The requests to call public functions made by this call. */
   publicCallRequests: PublicInnerCallRequest[];
   /** The results of nested calls. */
@@ -100,6 +97,18 @@ export interface PublicExecutionResult {
   functionName: string;
 }
 
+/**
+ * Recursively accummulate the return values of a call result and its nested executions,
+ * so they can be retrieved in order.
+ * @param executionResult
+ * @returns
+ */
+export function accumulatePublicReturnValues(executionResult: PublicExecutionResult): NestedProcessReturnValues {
+  const acc = new NestedProcessReturnValues(executionResult.returnValues);
+  acc.nested = executionResult.nestedExecutions.map(nestedExecution => accumulatePublicReturnValues(nestedExecution));
+  return acc;
+}
+
 export function collectExecutionResults(result: PublicExecutionResult): PublicExecutionResult[] {
   return [result, ...result.nestedExecutions.map(collectExecutionResults)].flat();
 }

package/src/public/executor.ts

@@ -1,6 +1,15 @@
 import { type PublicExecutionRequest } from '@aztec/circuit-types';
 import { type AvmSimulationStats } from '@aztec/circuit-types/stats';
-import { Fr, Gas, type GlobalVariables, type Header, type Nullifier, type TxContext } from '@aztec/circuits.js';
+import {
+  type CombinedConstantData,
+  Fr,
+  Gas,
+  type GlobalVariables,
+  type Nullifier,
+  PublicAccumulatedDataArrayLengths,
+  PublicValidationRequestArrayLengths,
+  type TxContext,
+} from '@aztec/circuits.js';
 import { createDebugLogger } from '@aztec/foundation/log';
 import { Timer } from '@aztec/foundation/timer';
 import { type TelemetryClient } from '@aztec/telemetry-client';
@@ -10,6 +19,9 @@ import { AvmExecutionEnvironment } from '../avm/avm_execution_environment.js';
 import { AvmMachineState } from '../avm/avm_machine_state.js';
 import { AvmSimulator } from '../avm/avm_simulator.js';
 import { AvmPersistableStateManager } from '../avm/journal/index.js';
+import { getPublicFunctionDebugName } from '../common/debug_fn_name.js';
+import { DualSideEffectTrace } from './dual_side_effect_trace.js';
+import { PublicEnqueuedCallSideEffectTrace } from './enqueued_call_side_effect_trace.js';
 import { type PublicExecutionResult } from './execution.js';
 import { ExecutorMetrics } from './executor_metrics.js';
 import { type WorldStateDB } from './public_db_sources.js';
@@ -21,7 +33,7 @@ import { PublicSideEffectTrace } from './side_effect_trace.js';
 export class PublicExecutor {
   metrics: ExecutorMetrics;
 
-  constructor(private readonly worldStateDB: WorldStateDB, private readonly header: Header, client: TelemetryClient) {
+  constructor(private readonly worldStateDB: WorldStateDB, client: TelemetryClient) {
     this.metrics = new ExecutorMetrics(client, 'PublicExecutor');
   }
 
@@ -30,45 +42,50 @@ export class PublicExecutor {
   /**
    * Executes a public execution request.
    * @param executionRequest - The execution to run.
-   * @param globalVariables - The global variables to use.
-   * @param availableGas - The gas available at the start of this enqueued call.
+   * @param constants - The constants (including global variables) to use.
+   * @param allocatedGas - The gas available at the start of this enqueued call.
    * @param txContext - Transaction context.
    * @param pendingSiloedNullifiers - The pending nullifier set from earlier parts of this TX.
    * @param transactionFee - Fee offered for this TX.
    * @param startSideEffectCounter - The counter of the first side-effect generated by this simulation.
+   * @param previousValidationRequestArrayLengths - Side effect array lengths from previous kernel
+   * @param previousAccumulatedDataArrayLengths - Side effect array lengths from previous kernel
    * @returns The result of execution, including the results of all nested calls.
    */
   public async simulate(
     executionRequest: PublicExecutionRequest,
-    globalVariables: GlobalVariables,
-    availableGas: Gas,
+    constants: CombinedConstantData,
+    allocatedGas: Gas,
     _txContext: TxContext,
     pendingSiloedNullifiers: Nullifier[],
     transactionFee: Fr = Fr.ZERO,
     startSideEffectCounter: number = 0,
+    previousValidationRequestArrayLengths: PublicValidationRequestArrayLengths = PublicValidationRequestArrayLengths.empty(),
+    previousAccumulatedDataArrayLengths: PublicAccumulatedDataArrayLengths = PublicAccumulatedDataArrayLengths.empty(),
   ): Promise<PublicExecutionResult> {
     const address = executionRequest.contractAddress;
     const selector = executionRequest.callContext.functionSelector;
-    const fnName = (await this.worldStateDB.getDebugFunctionName(address, selector)) ?? `${address}:${selector}`;
+    const fnName = await getPublicFunctionDebugName(this.worldStateDB, address, selector, executionRequest.args);
 
-    PublicExecutor.log.verbose(`[AVM] Executing public external function ${fnName}.`);
+    PublicExecutor.log.verbose(`[AVM] Executing public external function ${fnName}@${address}.`);
     const timer = new Timer();
 
-    const trace = new PublicSideEffectTrace(startSideEffectCounter);
+    const innerCallTrace = new PublicSideEffectTrace(startSideEffectCounter);
+    const enqueuedCallTrace = new PublicEnqueuedCallSideEffectTrace(
+      startSideEffectCounter,
+      previousValidationRequestArrayLengths,
+      previousAccumulatedDataArrayLengths,
+    );
+    const trace = new DualSideEffectTrace(innerCallTrace, enqueuedCallTrace);
     const avmPersistableState = AvmPersistableStateManager.newWithPendingSiloedNullifiers(
       this.worldStateDB,
       trace,
       pendingSiloedNullifiers.map(n => n.value),
     );
 
-    const avmExecutionEnv = createAvmExecutionEnvironment(
-      executionRequest,
-      this.header,
-      globalVariables,
-      transactionFee,
-    );
+    const avmExecutionEnv = createAvmExecutionEnvironment(executionRequest, constants.globalVariables, transactionFee);
 
-    const avmMachineState = new AvmMachineState(availableGas);
+    const avmMachineState = new AvmMachineState(allocatedGas);
     const avmContext = new AvmContext(avmPersistableState, avmExecutionEnv, avmMachineState);
     const simulator = new AvmSimulator(avmContext);
     const avmResult = await simulator.execute();
@@ -94,7 +111,7 @@ export class PublicExecutor {
 
     const publicExecutionResult = trace.toPublicExecutionResult(
       avmExecutionEnv,
-      /*startGasLeft=*/ availableGas,
+      /*startGasLeft=*/ allocatedGas,
       /*endGasLeft=*/ Gas.from(avmContext.machineState.gasLeft),
       bytecode,
       avmResult,
@@ -107,6 +124,14 @@ export class PublicExecutor {
       this.metrics.recordFunctionSimulation(bytecode.length, timer.ms());
     }
 
+    const _vmCircuitPublicInputs = enqueuedCallTrace.toVMCircuitPublicInputs(
+      constants,
+      avmExecutionEnv,
+      /*startGasLeft=*/ allocatedGas,
+      /*endGasLeft=*/ Gas.from(avmContext.machineState.gasLeft),
+      avmResult,
+    );
+
     return publicExecutionResult;
   }
 }
@@ -120,7 +145,6 @@ export class PublicExecutor {
  */
 function createAvmExecutionEnvironment(
   executionRequest: PublicExecutionRequest,
-  header: Header,
   globalVariables: GlobalVariables,
   transactionFee: Fr,
 ): AvmExecutionEnvironment {
@@ -131,7 +155,6 @@ function createAvmExecutionEnvironment(
     executionRequest.callContext.functionSelector,
     /*contractCallDepth=*/ Fr.zero(),
     transactionFee,
-    header,
     globalVariables,
     executionRequest.callContext.isStaticCall,
     executionRequest.callContext.isDelegateCall,

package/src/public/fee_payment.ts

@@ -1,14 +1,13 @@
-import { FEE_JUICE_ADDRESS } from '@aztec/circuits.js';
 import { computePublicDataTreeLeafSlot, deriveStorageSlotInMap } from '@aztec/circuits.js/hash';
-import { AztecAddress } from '@aztec/foundation/aztec-address';
+import { type AztecAddress } from '@aztec/foundation/aztec-address';
 import { Fr } from '@aztec/foundation/fields';
-import { FeeJuiceArtifact } from '@aztec/protocol-contracts/fee-juice';
+import { ProtocolContractAddress, ProtocolContractArtifact } from '@aztec/protocol-contracts';
 
 /**
  * Computes the storage slot within the Fee Juice contract for the balance of the fee payer.
  */
 export function computeFeePayerBalanceStorageSlot(feePayer: AztecAddress) {
-  return deriveStorageSlotInMap(FeeJuiceArtifact.storageLayout.balances.slot, feePayer);
+  return deriveStorageSlotInMap(ProtocolContractArtifact.FeeJuice.storageLayout.balances.slot, feePayer);
 }
 
 /**
@@ -18,7 +17,6 @@ export function computeFeePayerBalanceLeafSlot(feePayer: AztecAddress): Fr {
   if (feePayer.isZero()) {
     return Fr.ZERO;
   }
-  const feeJuice = AztecAddress.fromBigInt(FEE_JUICE_ADDRESS);
   const balanceSlot = computeFeePayerBalanceStorageSlot(feePayer);
-  return computePublicDataTreeLeafSlot(feeJuice, balanceSlot);
+  return computePublicDataTreeLeafSlot(ProtocolContractAddress.FeeJuice, balanceSlot);
 }

package/src/public/hints_builder.ts

@@ -29,10 +29,10 @@ import {
 import { makeTuple } from '@aztec/foundation/array';
 import { type Tuple } from '@aztec/foundation/serialize';
 import { type IndexedTreeLeafPreimage } from '@aztec/foundation/trees';
-import { type MerkleTreeOperations } from '@aztec/world-state';
+import { type MerkleTreeReadOperations } from '@aztec/world-state';
 
 export class HintsBuilder {
-  constructor(private db: MerkleTreeOperations) {}
+  constructor(private db: MerkleTreeReadOperations) {}
 
   async getNoteHashReadRequestsHints(
     readRequests: Tuple<TreeLeafReadRequest, typeof MAX_NOTE_HASH_READ_REQUESTS_PER_TX>,
@@ -49,15 +49,13 @@ export class HintsBuilder {
     nullifierReadRequests: Tuple<ScopedReadRequest, typeof MAX_NULLIFIER_READ_REQUESTS_PER_TX>,
     pendingNullifiers: Tuple<Nullifier, typeof MAX_NULLIFIERS_PER_TX>,
   ) {
-    return (
-      await buildSiloedNullifierReadRequestHints(
-        this,
-        nullifierReadRequests,
-        pendingNullifiers,
-        MAX_NULLIFIER_READ_REQUESTS_PER_TX,
-        MAX_NULLIFIER_READ_REQUESTS_PER_TX,
-      )
-    ).hints;
+    return await buildSiloedNullifierReadRequestHints(
+      this,
+      nullifierReadRequests,
+      pendingNullifiers,
+      MAX_NULLIFIER_READ_REQUESTS_PER_TX,
+      MAX_NULLIFIER_READ_REQUESTS_PER_TX,
+    );
   }
 
   getNullifierNonExistentReadRequestHints(

package/src/public/public_db_sources.ts

@@ -1,9 +1,18 @@
-import { MerkleTreeId, NullifierMembershipWitness, type Tx } from '@aztec/circuit-types';
+import {
+  MerkleTreeId,
+  type MerkleTreeReadOperations,
+  type MerkleTreeWriteOperations,
+  NullifierMembershipWitness,
+  type Tx,
+} from '@aztec/circuit-types';
 import { type PublicDBAccessStats } from '@aztec/circuit-types/stats';
 import {
   type AztecAddress,
+  type ContractClassPublic,
   ContractClassRegisteredEvent,
+  type ContractDataSource,
   ContractInstanceDeployedEvent,
+  type ContractInstanceWithAddress,
   Fr,
   FunctionSelector,
   type L1_TO_L2_MSG_TREE_HEIGHT,
@@ -14,19 +23,13 @@ import {
 import { computeL1ToL2MessageNullifier, computePublicDataTreeLeafSlot } from '@aztec/circuits.js/hash';
 import { createDebugLogger } from '@aztec/foundation/log';
 import { Timer } from '@aztec/foundation/timer';
-import { ClassRegistererAddress } from '@aztec/protocol-contracts/class-registerer';
+import { ProtocolContractAddress } from '@aztec/protocol-contracts';
 import {
   type CommitmentsDB,
   MessageLoadOracleInputs,
   type PublicContractsDB,
   type PublicStateDB,
 } from '@aztec/simulator';
-import {
-  type ContractClassPublic,
-  type ContractDataSource,
-  type ContractInstanceWithAddress,
-} from '@aztec/types/contracts';
-import { type MerkleTreeOperations } from '@aztec/world-state';
 
 /**
  * Implements the PublicContractsDB using a ContractDataSource.
@@ -47,7 +50,7 @@ export class ContractsDataSourcePublicDB implements PublicContractsDB {
   public addNewContracts(tx: Tx): Promise<void> {
     // Extract contract class and instance data from logs and add to cache for this block
     const logs = tx.unencryptedLogs.unrollLogs();
-    ContractClassRegisteredEvent.fromLogs(logs, ClassRegistererAddress).forEach(e => {
+    ContractClassRegisteredEvent.fromLogs(logs, ProtocolContractAddress.ContractClassRegisterer).forEach(e => {
       this.log.debug(`Adding class ${e.contractClassId.toString()} to public execution contract cache`);
       this.classCache.set(e.contractClassId.toString(), e.toContractClassPublic());
     });
@@ -70,7 +73,7 @@ export class ContractsDataSourcePublicDB implements PublicContractsDB {
     // Let's say we have two txs adding the same contract on the same block. If the 2nd one reverts,
     // wouldn't that accidentally remove the contract added on the first one?
     const logs = tx.unencryptedLogs.unrollLogs();
-    ContractClassRegisteredEvent.fromLogs(logs, ClassRegistererAddress).forEach(e =>
+    ContractClassRegisteredEvent.fromLogs(logs, ProtocolContractAddress.ContractClassRegisterer).forEach(e =>
       this.classCache.delete(e.contractClassId.toString()),
     );
     ContractInstanceDeployedEvent.fromLogs(logs).forEach(e => this.instanceCache.delete(e.address.toString()));
@@ -124,7 +127,7 @@ export class WorldStateDB extends ContractsDataSourcePublicDB implements PublicS
   private publicCheckpointedWriteCache: Map<bigint, Fr> = new Map();
   private publicUncommittedWriteCache: Map<bigint, Fr> = new Map();
 
-  constructor(private db: MerkleTreeOperations, dataSource: ContractDataSource) {
+  constructor(private db: MerkleTreeWriteOperations, dataSource: ContractDataSource) {
     super(dataSource);
   }
 
@@ -149,17 +152,7 @@ export class WorldStateDB extends ContractsDataSourcePublicDB implements PublicS
       return committed;
     }
 
-    const lowLeafResult = await this.db.getPreviousValueIndex(MerkleTreeId.PUBLIC_DATA_TREE, leafSlot);
-    if (!lowLeafResult || !lowLeafResult.alreadyPresent) {
-      return Fr.ZERO;
-    }
-
-    const preimage = (await this.db.getLeafPreimage(
-      MerkleTreeId.PUBLIC_DATA_TREE,
-      lowLeafResult.index,
-    )) as PublicDataTreeLeafPreimage;
-
-    return preimage.value;
+    return await readPublicState(this.db, contract, slot);
   }
 
   /**
@@ -325,3 +318,19 @@ export class WorldStateDB extends ContractsDataSourcePublicDB implements PublicS
     return Promise.resolve();
   }
 }
+
+export async function readPublicState(db: MerkleTreeReadOperations, contract: AztecAddress, slot: Fr): Promise<Fr> {
+  const leafSlot = computePublicDataTreeLeafSlot(contract, slot).toBigInt();
+
+  const lowLeafResult = await db.getPreviousValueIndex(MerkleTreeId.PUBLIC_DATA_TREE, leafSlot);
+  if (!lowLeafResult || !lowLeafResult.alreadyPresent) {
+    return Fr.ZERO;
+  }
+
+  const preimage = (await db.getLeafPreimage(
+    MerkleTreeId.PUBLIC_DATA_TREE,
+    lowLeafResult.index,
+  )) as PublicDataTreeLeafPreimage;
+
+  return preimage.value;
+}

package/src/public/public_kernel_tail_simulator.ts

@@ -11,19 +11,19 @@ import {
   mergeAccumulatedData,
 } from '@aztec/circuits.js';
 import { ProtocolCircuitVks, getVKIndex, getVKSiblingPath } from '@aztec/noir-protocol-circuits-types';
-import { type MerkleTreeOperations } from '@aztec/world-state';
+import { type MerkleTreeReadOperations } from '@aztec/world-state';
 
 import { HintsBuilder } from './hints_builder.js';
 import { type PublicKernelCircuitSimulator } from './public_kernel_circuit_simulator.js';
 
 export class PublicKernelTailSimulator {
   constructor(
-    private db: MerkleTreeOperations,
+    private db: MerkleTreeReadOperations,
     private publicKernelSimulator: PublicKernelCircuitSimulator,
     private hintsBuilder: HintsBuilder,
   ) {}
 
-  static create(db: MerkleTreeOperations, publicKernelSimulator: PublicKernelCircuitSimulator) {
+  static create(db: MerkleTreeReadOperations, publicKernelSimulator: PublicKernelCircuitSimulator) {
     const hintsBuilder = new HintsBuilder(db);
     return new PublicKernelTailSimulator(db, publicKernelSimulator, hintsBuilder);
   }

package/src/public/public_processor.ts

@@ -1,5 +1,6 @@
 import {
   type FailedTx,
+  type MerkleTreeWriteOperations,
   NestedProcessReturnValues,
   type ProcessedTx,
   type ProcessedTxHandler,
@@ -9,9 +10,8 @@ import {
   validateProcessedTx,
 } from '@aztec/circuit-types';
 import {
-  AztecAddress,
   ContractClassRegisteredEvent,
-  FEE_JUICE_ADDRESS,
+  type ContractDataSource,
   type GlobalVariables,
   type Header,
   MAX_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX,
@@ -21,10 +21,8 @@ import {
 import { times } from '@aztec/foundation/collection';
 import { createDebugLogger } from '@aztec/foundation/log';
 import { Timer } from '@aztec/foundation/timer';
-import { ClassRegistererAddress } from '@aztec/protocol-contracts/class-registerer';
+import { ProtocolContractAddress } from '@aztec/protocol-contracts';
 import { Attributes, type TelemetryClient, type Tracer, trackSpan } from '@aztec/telemetry-client';
-import { type ContractDataSource } from '@aztec/types/contracts';
-import { type MerkleTreeOperations } from '@aztec/world-state';
 
 import { type SimulationProvider } from '../providers/index.js';
 import { EnqueuedCallsProcessor } from './enqueued_calls_processor.js';
@@ -40,7 +38,6 @@ import { PublicProcessorMetrics } from './public_processor_metrics.js';
  */
 export class PublicProcessorFactory {
   constructor(
-    private merkleTree: MerkleTreeOperations,
     private contractDataSource: ContractDataSource,
     private simulator: SimulationProvider,
     private telemetryClient: TelemetryClient,
@@ -52,12 +49,16 @@ export class PublicProcessorFactory {
    * @param globalVariables - The global variables for the block being processed.
    * @returns A new instance of a PublicProcessor.
    */
-  public create(maybeHistoricalHeader: Header | undefined, globalVariables: GlobalVariables): PublicProcessor {
-    const { merkleTree, telemetryClient } = this;
+  public create(
+    merkleTree: MerkleTreeWriteOperations,
+    maybeHistoricalHeader: Header | undefined,
+    globalVariables: GlobalVariables,
+  ): PublicProcessor {
+    const { telemetryClient } = this;
     const historicalHeader = maybeHistoricalHeader ?? merkleTree.getInitialHeader();
 
     const worldStateDB = new WorldStateDB(merkleTree, this.contractDataSource);
-    const publicExecutor = new PublicExecutor(worldStateDB, historicalHeader, telemetryClient);
+    const publicExecutor = new PublicExecutor(worldStateDB, telemetryClient);
     const publicKernelSimulator = new RealPublicKernelCircuitSimulator(this.simulator);
 
     return PublicProcessor.create(
@@ -79,7 +80,7 @@ export class PublicProcessorFactory {
 export class PublicProcessor {
   private metrics: PublicProcessorMetrics;
   constructor(
-    protected db: MerkleTreeOperations,
+    protected db: MerkleTreeWriteOperations,
     protected publicExecutor: PublicExecutor,
     protected publicKernel: PublicKernelCircuitSimulator,
     protected globalVariables: GlobalVariables,
@@ -93,7 +94,7 @@ export class PublicProcessor {
   }
 
   static create(
-    db: MerkleTreeOperations,
+    db: MerkleTreeWriteOperations,
     publicExecutor: PublicExecutor,
     publicKernelSimulator: PublicKernelCircuitSimulator,
     globalVariables: GlobalVariables,
@@ -216,7 +217,7 @@ export class PublicProcessor {
       return finalPublicDataUpdateRequests;
     }
 
-    const feeJuiceAddress = AztecAddress.fromBigInt(FEE_JUICE_ADDRESS);
+    const feeJuiceAddress = ProtocolContractAddress.FeeJuice;
     const balanceSlot = computeFeePayerBalanceStorageSlot(feePayer);
     const leafSlot = computeFeePayerBalanceLeafSlot(feePayer);
     const txFee = tx.data.getTransactionFee(this.globalVariables.gasFees);
@@ -269,7 +270,10 @@ export class PublicProcessor {
     });
 
     this.metrics.recordClassRegistration(
-      ...ContractClassRegisteredEvent.fromLogs(tx.unencryptedLogs.unrollLogs(), ClassRegistererAddress),
+      ...ContractClassRegisteredEvent.fromLogs(
+        tx.unencryptedLogs.unrollLogs(),
+        ProtocolContractAddress.ContractClassRegisterer,
+      ),
     );
 
     const phaseCount = processedPhases.length;

package/src/public/side_effect_errors.ts

@@ -0,0 +1,6 @@
+export class SideEffectLimitReachedError extends Error {
+  constructor(sideEffectType: string, limit: number) {
+    super(`Reached the limit on number of '${sideEffectType}' side effects: ${limit}`);
+    this.name = 'SideEffectLimitReachedError';
+  }
+}