@aztec/simulator 0.56.0 → 0.58.0

package/src/public/enqueued_call_side_effect_trace.ts

@@ -0,0 +1,552 @@
+import { UnencryptedL2Log } from '@aztec/circuit-types';
+import {
+  AvmContractInstanceHint,
+  AvmExecutionHints,
+  AvmExternalCallHint,
+  AvmKeyValueHint,
+  AztecAddress,
+  CallContext,
+  type CombinedConstantData,
+  type ContractInstanceWithAddress,
+  ContractStorageRead,
+  ContractStorageUpdateRequest,
+  EthAddress,
+  Gas,
+  L2ToL1Message,
+  LogHash,
+  MAX_ENCRYPTED_LOGS_PER_TX,
+  MAX_L1_TO_L2_MSG_READ_REQUESTS_PER_TX,
+  MAX_L2_TO_L1_MSGS_PER_TX,
+  MAX_NOTE_ENCRYPTED_LOGS_PER_TX,
+  MAX_NOTE_HASHES_PER_TX,
+  MAX_NOTE_HASH_READ_REQUESTS_PER_TX,
+  MAX_NULLIFIERS_PER_TX,
+  MAX_NULLIFIER_NON_EXISTENT_READ_REQUESTS_PER_TX,
+  MAX_NULLIFIER_READ_REQUESTS_PER_TX,
+  MAX_PUBLIC_CALL_STACK_LENGTH_PER_TX,
+  MAX_PUBLIC_DATA_READS_PER_TX,
+  MAX_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX,
+  MAX_UNENCRYPTED_LOGS_PER_TX,
+  NoteHash,
+  Nullifier,
+  PublicAccumulatedData,
+  PublicAccumulatedDataArrayLengths,
+  PublicCallRequest,
+  PublicDataRead,
+  PublicDataUpdateRequest,
+  PublicInnerCallRequest,
+  PublicValidationRequestArrayLengths,
+  PublicValidationRequests,
+  ReadRequest,
+  RollupValidationRequests,
+  ScopedL2ToL1Message,
+  ScopedLogHash,
+  ScopedNoteHash,
+  type ScopedNullifier,
+  ScopedReadRequest,
+  TreeLeafReadRequest,
+  VMCircuitPublicInputs,
+} from '@aztec/circuits.js';
+import { computeVarArgsHash } from '@aztec/circuits.js/hash';
+import { makeTuple } from '@aztec/foundation/array';
+import { padArrayEnd } from '@aztec/foundation/collection';
+import { Fr } from '@aztec/foundation/fields';
+import { createDebugLogger } from '@aztec/foundation/log';
+
+import { type AvmContractCallResult } from '../avm/avm_contract_call_result.js';
+import { type AvmExecutionEnvironment } from '../avm/avm_execution_environment.js';
+import { SideEffectLimitReachedError } from './side_effect_errors.js';
+import { type PublicSideEffectTraceInterface } from './side_effect_trace_interface.js';
+
+export type TracedContractInstance = { exists: boolean } & ContractInstanceWithAddress;
+
+/**
+ * A struct containing just the side effects as regular arrays
+ * as opposed to "Tuple" arrays used by circuit public inputs.
+ * This struct is helpful for testing and checking array lengths.
+ **/
+export type SideEffects = {
+  contractStorageReads: ContractStorageRead[];
+  contractStorageUpdateRequests: ContractStorageUpdateRequest[];
+
+  noteHashReadRequests: TreeLeafReadRequest[];
+  noteHashes: ScopedNoteHash[];
+
+  nullifierReadRequests: ScopedReadRequest[];
+  nullifierNonExistentReadRequests: ScopedReadRequest[];
+  nullifiers: ScopedNullifier[];
+
+  l1ToL2MsgReadRequests: TreeLeafReadRequest[];
+  l2ToL1Msgs: ScopedL2ToL1Message[];
+
+  unencryptedLogs: UnencryptedL2Log[];
+  unencryptedLogsHashes: ScopedLogHash[];
+};
+
+/**
+ * Trace side effects for an entire enqueued call.
+ */
+export class PublicEnqueuedCallSideEffectTrace implements PublicSideEffectTraceInterface {
+  public log = createDebugLogger('aztec:public_enqueued_call_side_effect_trace');
+
+  /** The side effect counter increments with every call to the trace. */
+  private sideEffectCounter: number;
+
+  // TODO(dbanks12): make contract address mandatory in ContractStorage* structs,
+  // and include it in serialization, or modify PublicData* structs for this.
+  private contractStorageReads: ContractStorageRead[] = [];
+  private contractStorageUpdateRequests: ContractStorageUpdateRequest[] = [];
+
+  private noteHashReadRequests: TreeLeafReadRequest[] = [];
+  private noteHashes: ScopedNoteHash[] = [];
+
+  private nullifierReadRequests: ScopedReadRequest[] = [];
+  private nullifierNonExistentReadRequests: ScopedReadRequest[] = [];
+  private nullifiers: ScopedNullifier[] = [];
+
+  private l1ToL2MsgReadRequests: TreeLeafReadRequest[] = [];
+  private l2ToL1Msgs: ScopedL2ToL1Message[] = [];
+
+  private unencryptedLogs: UnencryptedL2Log[] = [];
+  private unencryptedLogsHashes: ScopedLogHash[] = [];
+
+  private avmCircuitHints: AvmExecutionHints;
+
+  constructor(
+    /** The counter of this trace's first side effect. */
+    public readonly startSideEffectCounter: number = 0,
+    /** Track parent's (or previous kernel's) lengths so the AVM can properly enforce TX-wide limits,
+     *  otherwise the public kernel can fail to prove because TX limits are breached.
+     */
+    private readonly previousValidationRequestArrayLengths: PublicValidationRequestArrayLengths = PublicValidationRequestArrayLengths.empty(),
+    private readonly previousAccumulatedDataArrayLengths: PublicAccumulatedDataArrayLengths = PublicAccumulatedDataArrayLengths.empty(),
+  ) {
+    this.sideEffectCounter = startSideEffectCounter;
+    this.avmCircuitHints = AvmExecutionHints.empty();
+  }
+
+  public fork() {
+    return new PublicEnqueuedCallSideEffectTrace(
+      this.sideEffectCounter,
+      new PublicValidationRequestArrayLengths(
+        this.previousValidationRequestArrayLengths.noteHashReadRequests + this.noteHashReadRequests.length,
+        this.previousValidationRequestArrayLengths.nullifierReadRequests + this.nullifierReadRequests.length,
+        this.previousValidationRequestArrayLengths.nullifierNonExistentReadRequests +
+          this.nullifierNonExistentReadRequests.length,
+        this.previousValidationRequestArrayLengths.l1ToL2MsgReadRequests + this.l1ToL2MsgReadRequests.length,
+        this.previousValidationRequestArrayLengths.publicDataReads + this.contractStorageReads.length,
+      ),
+      new PublicAccumulatedDataArrayLengths(
+        this.previousAccumulatedDataArrayLengths.noteHashes + this.noteHashes.length,
+        this.previousAccumulatedDataArrayLengths.nullifiers + this.nullifiers.length,
+        this.previousAccumulatedDataArrayLengths.l2ToL1Msgs + this.l2ToL1Msgs.length,
+        this.previousAccumulatedDataArrayLengths.noteEncryptedLogsHashes,
+        this.previousAccumulatedDataArrayLengths.encryptedLogsHashes,
+        this.previousAccumulatedDataArrayLengths.unencryptedLogsHashes + this.unencryptedLogsHashes.length,
+        this.previousAccumulatedDataArrayLengths.publicDataUpdateRequests + this.contractStorageUpdateRequests.length,
+        this.previousAccumulatedDataArrayLengths.publicCallStack,
+      ),
+    );
+  }
+
+  public getCounter() {
+    return this.sideEffectCounter;
+  }
+
+  private incrementSideEffectCounter() {
+    this.sideEffectCounter++;
+  }
+
+  public tracePublicStorageRead(storageAddress: Fr, slot: Fr, value: Fr, _exists: boolean, _cached: boolean) {
+    // NOTE: exists and cached are unused for now but may be used for optimizations or kernel hints later
+    if (
+      this.contractStorageReads.length + this.previousValidationRequestArrayLengths.publicDataReads >=
+      MAX_PUBLIC_DATA_READS_PER_TX
+    ) {
+      throw new SideEffectLimitReachedError('contract storage read', MAX_PUBLIC_DATA_READS_PER_TX);
+    }
+
+    this.contractStorageReads.push(
+      new ContractStorageRead(slot, value, this.sideEffectCounter, AztecAddress.fromField(storageAddress)),
+    );
+    this.avmCircuitHints.storageValues.items.push(
+      new AvmKeyValueHint(/*key=*/ new Fr(this.sideEffectCounter), /*value=*/ value),
+    );
+    this.log.debug(`SLOAD cnt: ${this.sideEffectCounter} val: ${value} slot: ${slot}`);
+    this.incrementSideEffectCounter();
+  }
+
+  public tracePublicStorageWrite(storageAddress: Fr, slot: Fr, value: Fr) {
+    if (
+      this.contractStorageUpdateRequests.length + this.previousAccumulatedDataArrayLengths.publicDataUpdateRequests >=
+      MAX_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX
+    ) {
+      throw new SideEffectLimitReachedError('contract storage write', MAX_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX);
+    }
+
+    this.contractStorageUpdateRequests.push(
+      new ContractStorageUpdateRequest(slot, value, this.sideEffectCounter, storageAddress),
+    );
+    this.log.debug(`SSTORE cnt: ${this.sideEffectCounter} val: ${value} slot: ${slot}`);
+    this.incrementSideEffectCounter();
+  }
+
+  // TODO(8287): _exists can be removed once we have the vm properly handling the equality check
+  public traceNoteHashCheck(_storageAddress: Fr, noteHash: Fr, leafIndex: Fr, exists: boolean) {
+    // NOTE: storageAddress is unused because noteHash is an already-siloed leaf
+    if (
+      this.noteHashReadRequests.length + this.previousValidationRequestArrayLengths.noteHashReadRequests >=
+      MAX_NOTE_HASH_READ_REQUESTS_PER_TX
+    ) {
+      throw new SideEffectLimitReachedError('note hash read request', MAX_NOTE_HASH_READ_REQUESTS_PER_TX);
+    }
+
+    this.noteHashReadRequests.push(new TreeLeafReadRequest(noteHash, leafIndex));
+    this.avmCircuitHints.noteHashExists.items.push(
+      new AvmKeyValueHint(/*key=*/ new Fr(leafIndex), /*value=*/ exists ? Fr.ONE : Fr.ZERO),
+    );
+    // NOTE: counter does not increment for note hash checks (because it doesn't rely on pending note hashes)
+  }
+
+  public traceNewNoteHash(storageAddress: Fr, noteHash: Fr) {
+    if (this.noteHashes.length + this.previousAccumulatedDataArrayLengths.noteHashes >= MAX_NOTE_HASHES_PER_TX) {
+      throw new SideEffectLimitReachedError('note hash', MAX_NOTE_HASHES_PER_TX);
+    }
+
+    this.noteHashes.push(new NoteHash(noteHash, this.sideEffectCounter).scope(AztecAddress.fromField(storageAddress)));
+    this.log.debug(`NEW_NOTE_HASH cnt: ${this.sideEffectCounter}`);
+    this.incrementSideEffectCounter();
+  }
+
+  public traceNullifierCheck(storageAddress: Fr, nullifier: Fr, _leafIndex: Fr, exists: boolean, _isPending: boolean) {
+    // NOTE: isPending and leafIndex are unused for now but may be used for optimizations or kernel hints later
+    this.enforceLimitOnNullifierChecks();
+
+    const readRequest = new ReadRequest(nullifier, this.sideEffectCounter).scope(
+      AztecAddress.fromField(storageAddress),
+    );
+    if (exists) {
+      this.nullifierReadRequests.push(readRequest);
+    } else {
+      this.nullifierNonExistentReadRequests.push(readRequest);
+    }
+    this.avmCircuitHints.nullifierExists.items.push(
+      new AvmKeyValueHint(/*key=*/ new Fr(this.sideEffectCounter), /*value=*/ new Fr(exists ? 1 : 0)),
+    );
+    this.log.debug(`NULLIFIER_EXISTS cnt: ${this.sideEffectCounter}`);
+    this.incrementSideEffectCounter();
+  }
+
+  public traceNewNullifier(storageAddress: Fr, nullifier: Fr) {
+    if (this.nullifiers.length + this.previousAccumulatedDataArrayLengths.nullifiers >= MAX_NULLIFIERS_PER_TX) {
+      throw new SideEffectLimitReachedError('nullifier', MAX_NULLIFIERS_PER_TX);
+    }
+
+    this.nullifiers.push(
+      new Nullifier(nullifier, this.sideEffectCounter, /*noteHash=*/ Fr.ZERO).scope(
+        AztecAddress.fromField(storageAddress),
+      ),
+    );
+    this.log.debug(`NEW_NULLIFIER cnt: ${this.sideEffectCounter}`);
+    this.incrementSideEffectCounter();
+  }
+
+  // TODO(8287): _exists can be removed once we have the vm properly handling the equality check
+  public traceL1ToL2MessageCheck(_contractAddress: Fr, msgHash: Fr, msgLeafIndex: Fr, exists: boolean) {
+    // NOTE: contractAddress is unused because msgHash is an already-siloed leaf
+    if (
+      this.l1ToL2MsgReadRequests.length + this.previousValidationRequestArrayLengths.l1ToL2MsgReadRequests >=
+      MAX_L1_TO_L2_MSG_READ_REQUESTS_PER_TX
+    ) {
+      throw new SideEffectLimitReachedError('l1 to l2 message read request', MAX_L1_TO_L2_MSG_READ_REQUESTS_PER_TX);
+    }
+
+    this.l1ToL2MsgReadRequests.push(new TreeLeafReadRequest(msgHash, msgLeafIndex));
+    this.avmCircuitHints.l1ToL2MessageExists.items.push(
+      new AvmKeyValueHint(/*key=*/ new Fr(msgLeafIndex), /*value=*/ exists ? Fr.ONE : Fr.ZERO),
+    );
+  }
+
+  public traceNewL2ToL1Message(contractAddress: Fr, recipient: Fr, content: Fr) {
+    if (this.l2ToL1Msgs.length + this.previousAccumulatedDataArrayLengths.l2ToL1Msgs >= MAX_L2_TO_L1_MSGS_PER_TX) {
+      throw new SideEffectLimitReachedError('l2 to l1 message', MAX_L2_TO_L1_MSGS_PER_TX);
+    }
+
+    const recipientAddress = EthAddress.fromField(recipient);
+    this.l2ToL1Msgs.push(
+      new L2ToL1Message(recipientAddress, content, this.sideEffectCounter).scope(
+        AztecAddress.fromField(contractAddress),
+      ),
+    );
+    this.log.debug(`NEW_L2_TO_L1_MSG cnt: ${this.sideEffectCounter}`);
+    this.incrementSideEffectCounter();
+  }
+
+  public traceUnencryptedLog(contractAddress: Fr, log: Fr[]) {
+    if (
+      this.unencryptedLogs.length + this.previousAccumulatedDataArrayLengths.unencryptedLogsHashes >=
+      MAX_UNENCRYPTED_LOGS_PER_TX
+    ) {
+      throw new SideEffectLimitReachedError('unencrypted log', MAX_UNENCRYPTED_LOGS_PER_TX);
+    }
+
+    const ulog = new UnencryptedL2Log(
+      AztecAddress.fromField(contractAddress),
+      Buffer.concat(log.map(f => f.toBuffer())),
+    );
+    const basicLogHash = Fr.fromBuffer(ulog.hash());
+    this.unencryptedLogs.push(ulog);
+    // This length is for charging DA and is checked on-chain - has to be length of log preimage + 4 bytes.
+    // The .length call also has a +4 but that is unrelated
+    this.unencryptedLogsHashes.push(
+      new LogHash(basicLogHash, this.sideEffectCounter, new Fr(ulog.length + 4)).scope(
+        AztecAddress.fromField(contractAddress),
+      ),
+    );
+    this.log.debug(`NEW_UNENCRYPTED_LOG cnt: ${this.sideEffectCounter}`);
+    this.incrementSideEffectCounter();
+  }
+
+  public traceGetContractInstance(instance: TracedContractInstance) {
+    this.enforceLimitOnNullifierChecks('(contract address nullifier from GETCONTRACTINSTANCE)');
+    // TODO(dbanks12): should emit a nullifier read request
+
+    this.avmCircuitHints.contractInstances.items.push(
+      new AvmContractInstanceHint(
+        instance.address,
+        new Fr(instance.exists ? 1 : 0),
+        instance.salt,
+        instance.deployer,
+        instance.contractClassId,
+        instance.initializationHash,
+        instance.publicKeys,
+      ),
+    );
+    this.log.debug(`CONTRACT_INSTANCE cnt: ${this.sideEffectCounter}`);
+    this.incrementSideEffectCounter();
+  }
+
+  /**
+   * Trace a nested call.
+   * Accept some results from a finished nested call's trace into this one.
+   */
+  public traceNestedCall(
+    /** The trace of the nested call. */
+    nestedCallTrace: this,
+    /** The execution environment of the nested call. */
+    _nestedEnvironment: AvmExecutionEnvironment,
+    /** How much gas was available for this public execution. */
+    startGasLeft: Gas,
+    /** How much gas was left after this public execution. */
+    endGasLeft: Gas,
+    /** Bytecode used for this execution. */
+    _bytecode: Buffer,
+    /** The call's results */
+    avmCallResults: AvmContractCallResult,
+    /** Function name for logging */
+    _functionName: string = 'unknown',
+  ) {
+    // Store end side effect counter before it gets updated by absorbing nested call trace
+    const endSideEffectCounter = new Fr(this.sideEffectCounter);
+
+    // TODO(4805): check if some threshold is reached for max nested calls (to unique contracts?)
+    // TODO(dbanks12): should emit a nullifier read request. There should be two thresholds.
+    // one for max unique contract calls, and another based on max nullifier reads.
+    // Since this trace function happens _after_ a nested call, such threshold limits must take
+    // place in another trace function that occurs _before_ a nested call.
+    if (avmCallResults.reverted) {
+      this.absorbRevertedNestedTrace(nestedCallTrace);
+    } else {
+      this.absorbSuccessfulNestedTrace(nestedCallTrace);
+    }
+
+    const gasUsed = new Gas(startGasLeft.daGas - endGasLeft.daGas, startGasLeft.l2Gas - endGasLeft.l2Gas);
+
+    this.avmCircuitHints.externalCalls.items.push(
+      new AvmExternalCallHint(
+        /*success=*/ new Fr(avmCallResults.reverted ? 0 : 1),
+        avmCallResults.output,
+        gasUsed,
+        endSideEffectCounter,
+      ),
+    );
+  }
+
+  public absorbSuccessfulNestedTrace(nestedTrace: this) {
+    this.sideEffectCounter = nestedTrace.sideEffectCounter;
+    this.contractStorageReads.push(...nestedTrace.contractStorageReads);
+    this.contractStorageUpdateRequests.push(...nestedTrace.contractStorageUpdateRequests);
+    this.noteHashReadRequests.push(...nestedTrace.noteHashReadRequests);
+    this.noteHashes.push(...nestedTrace.noteHashes);
+    this.nullifierReadRequests.push(...nestedTrace.nullifierReadRequests);
+    this.nullifierNonExistentReadRequests.push(...nestedTrace.nullifierNonExistentReadRequests);
+    this.nullifiers.push(...nestedTrace.nullifiers);
+    this.l1ToL2MsgReadRequests.push(...nestedTrace.l1ToL2MsgReadRequests);
+    this.l2ToL1Msgs.push(...nestedTrace.l2ToL1Msgs);
+    this.unencryptedLogs.push(...nestedTrace.unencryptedLogs);
+    this.unencryptedLogsHashes.push(...nestedTrace.unencryptedLogsHashes);
+  }
+
+  public absorbRevertedNestedTrace(nestedTrace: this) {
+    // All read requests, and any writes (storage & nullifiers) that
+    // require complex validation in public kernel (with end lifetimes)
+    // must be absorbed even on revert.
+
+    // TODO(dbanks12): What should happen to side effect counter on revert?
+    this.sideEffectCounter = nestedTrace.sideEffectCounter;
+    this.contractStorageReads.push(...nestedTrace.contractStorageReads);
+    this.contractStorageUpdateRequests.push(...nestedTrace.contractStorageUpdateRequests);
+    this.noteHashReadRequests.push(...nestedTrace.noteHashReadRequests);
+    // new noteHashes are tossed on revert
+    this.nullifierReadRequests.push(...nestedTrace.nullifierReadRequests);
+    this.nullifierNonExistentReadRequests.push(...nestedTrace.nullifierNonExistentReadRequests);
+    this.nullifiers.push(...nestedTrace.nullifiers);
+    this.l1ToL2MsgReadRequests.push(...nestedTrace.l1ToL2MsgReadRequests);
+    // new l2-to-l1 messages are tossed on revert
+    // new unencrypted logs are tossed on revert
+  }
+
+  public getSideEffects(): SideEffects {
+    return {
+      contractStorageReads: this.contractStorageReads,
+      contractStorageUpdateRequests: this.contractStorageUpdateRequests,
+      noteHashReadRequests: this.noteHashReadRequests,
+      noteHashes: this.noteHashes,
+      nullifierReadRequests: this.nullifierReadRequests,
+      nullifierNonExistentReadRequests: this.nullifierNonExistentReadRequests,
+      nullifiers: this.nullifiers,
+      l1ToL2MsgReadRequests: this.l1ToL2MsgReadRequests,
+      l2ToL1Msgs: this.l2ToL1Msgs,
+      unencryptedLogs: this.unencryptedLogs,
+      unencryptedLogsHashes: this.unencryptedLogsHashes,
+    };
+  }
+
+  public toVMCircuitPublicInputs(
+    /** Constants. */
+    constants: CombinedConstantData,
+    /** The execution environment of the nested call. */
+    avmEnvironment: AvmExecutionEnvironment,
+    /** How much gas was available for this public execution. */
+    startGasLeft: Gas,
+    /** How much gas was left after this public execution. */
+    endGasLeft: Gas,
+    /** The call's results */
+    avmCallResults: AvmContractCallResult,
+  ): VMCircuitPublicInputs {
+    return new VMCircuitPublicInputs(
+      /*constants=*/ constants,
+      /*callRequest=*/ createPublicCallRequest(avmEnvironment),
+      /*publicCallStack=*/ makeTuple(MAX_PUBLIC_CALL_STACK_LENGTH_PER_TX, PublicInnerCallRequest.empty),
+      /*previousValidationRequestArrayLengths=*/ this.previousValidationRequestArrayLengths,
+      /*validationRequests=*/ this.getValidationRequests(),
+      /*previousAccumulatedDataArrayLengths=*/ this.previousAccumulatedDataArrayLengths,
+      /*accumulatedData=*/ this.getAccumulatedData(startGasLeft.sub(endGasLeft)),
+      /*startSideEffectCounter=*/ this.startSideEffectCounter,
+      /*endSideEffectCounter=*/ this.sideEffectCounter,
+      /*startGasLeft=*/ startGasLeft,
+      // TODO(dbanks12): should have endGasLeft
+      /*transactionFee=*/ avmEnvironment.transactionFee,
+      /*reverted=*/ avmCallResults.reverted,
+    );
+  }
+
+  public getUnencryptedLogs() {
+    return this.unencryptedLogs;
+  }
+
+  public getAvmCircuitHints() {
+    return this.avmCircuitHints;
+  }
+
+  private getValidationRequests() {
+    return new PublicValidationRequests(
+      RollupValidationRequests.empty(), // TODO(dbanks12): what should this be?
+      padArrayEnd(this.noteHashReadRequests, TreeLeafReadRequest.empty(), MAX_NOTE_HASH_READ_REQUESTS_PER_TX),
+      padArrayEnd(this.nullifierReadRequests, ScopedReadRequest.empty(), MAX_NULLIFIER_READ_REQUESTS_PER_TX),
+      padArrayEnd(
+        this.nullifierNonExistentReadRequests,
+        ScopedReadRequest.empty(),
+        MAX_NULLIFIER_NON_EXISTENT_READ_REQUESTS_PER_TX,
+      ),
+      padArrayEnd(this.l1ToL2MsgReadRequests, TreeLeafReadRequest.empty(), MAX_L1_TO_L2_MSG_READ_REQUESTS_PER_TX),
+      // TODO(dbanks12): this is only necessary until VMCircuitPublicInputs uses unsiloed storage slots and pairs storage accesses with contract address
+      padArrayEnd(
+        this.contractStorageReads.map(r => new PublicDataRead(r.storageSlot, r.currentValue, r.counter)),
+        PublicDataRead.empty(),
+        MAX_PUBLIC_DATA_READS_PER_TX,
+      ),
+    );
+  }
+
+  private getAccumulatedData(gasUsed: Gas) {
+    return new PublicAccumulatedData(
+      padArrayEnd(this.noteHashes, ScopedNoteHash.empty(), MAX_NOTE_HASHES_PER_TX),
+      // TODO(dbanks12): should be able to use ScopedNullifier here
+      padArrayEnd(
+        this.nullifiers.map(n => new Nullifier(n.nullifier.value, n.nullifier.counter, n.nullifier.noteHash)),
+        Nullifier.empty(),
+        MAX_NULLIFIERS_PER_TX,
+      ),
+      padArrayEnd(this.l2ToL1Msgs, ScopedL2ToL1Message.empty(), MAX_L2_TO_L1_MSGS_PER_TX),
+      /*noteEncryptedLogsHashes=*/ makeTuple(MAX_NOTE_ENCRYPTED_LOGS_PER_TX, LogHash.empty),
+      /*encryptedLogsHashes=*/ makeTuple(MAX_ENCRYPTED_LOGS_PER_TX, ScopedLogHash.empty),
+      padArrayEnd(this.unencryptedLogsHashes, ScopedLogHash.empty(), MAX_UNENCRYPTED_LOGS_PER_TX),
+      // TODO(dbanks12): this is only necessary until VMCircuitPublicInputs uses unsiloed storage slots and pairs storage accesses with contract address
+      padArrayEnd(
+        this.contractStorageUpdateRequests.map(w => new PublicDataUpdateRequest(w.storageSlot, w.newValue, w.counter)),
+        PublicDataUpdateRequest.empty(),
+        MAX_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX,
+      ),
+      /*publicCallStack=*/ makeTuple(MAX_PUBLIC_CALL_STACK_LENGTH_PER_TX, PublicCallRequest.empty),
+      /*gasUsed=*/ gasUsed,
+    );
+  }
+
+  private enforceLimitOnNullifierChecks(errorMsgOrigin: string = '') {
+    // NOTE: Why error if _either_ limit was reached? If user code emits either an existent or non-existent
+    // nullifier read request (NULLIFIEREXISTS, GETCONTRACTINSTANCE, *CALL), and one of the limits has been
+    // reached (MAX_NULLIFIER_NON_EXISTENT_RRS vs MAX_NULLIFIER_RRS), but not the other, we must prevent the
+    // sequencer from lying and saying "this nullifier exists, but MAX_NULLIFIER_RRS has been reached, so I'm
+    // going to skip the read request and just revert instead" when the nullifier actually doesn't exist
+    // (or vice versa). So, if either maximum has been reached, any nullifier-reading operation must error.
+    if (
+      this.nullifierReadRequests.length + this.previousValidationRequestArrayLengths.nullifierReadRequests >=
+      MAX_NULLIFIER_READ_REQUESTS_PER_TX
+    ) {
+      throw new SideEffectLimitReachedError(
+        `nullifier read request ${errorMsgOrigin}`,
+        MAX_NULLIFIER_READ_REQUESTS_PER_TX,
+      );
+    }
+    if (
+      this.nullifierNonExistentReadRequests.length +
+        this.previousValidationRequestArrayLengths.nullifierNonExistentReadRequests >=
+      MAX_NULLIFIER_NON_EXISTENT_READ_REQUESTS_PER_TX
+    ) {
+      throw new SideEffectLimitReachedError(
+        `nullifier non-existent read request ${errorMsgOrigin}`,
+        MAX_NULLIFIER_NON_EXISTENT_READ_REQUESTS_PER_TX,
+      );
+    }
+  }
+}
+
+/**
+ * Helper function to create a public execution request from an AVM execution environment
+ */
+function createPublicCallRequest(avmEnvironment: AvmExecutionEnvironment): PublicCallRequest {
+  const callContext = CallContext.from({
+    msgSender: avmEnvironment.sender,
+    storageContractAddress: avmEnvironment.storageAddress,
+    functionSelector: avmEnvironment.functionSelector,
+    isDelegateCall: avmEnvironment.isDelegateCall,
+    isStaticCall: avmEnvironment.isStaticCall,
+  });
+  return new PublicCallRequest(
+    avmEnvironment.address,
+    callContext,
+    computeVarArgsHash(avmEnvironment.calldata),
+    /*counter=*/ 0,
+  );
+}

package/src/public/enqueued_call_simulator.ts

@@ -23,6 +23,7 @@ import {
   L2ToL1Message,
   LogHash,
   MAX_L1_TO_L2_MSG_READ_REQUESTS_PER_CALL,
+  MAX_L2_GAS_PER_ENQUEUED_CALL,
   MAX_L2_TO_L1_MSGS_PER_CALL,
   MAX_NOTE_HASHES_PER_CALL,
   MAX_NOTE_HASH_READ_REQUESTS_PER_CALL,
@@ -61,10 +62,9 @@ import { makeTuple } from '@aztec/foundation/array';
 import { padArrayEnd } from '@aztec/foundation/collection';
 import { type DebugLogger, createDebugLogger } from '@aztec/foundation/log';
 import { ProtocolCircuitVks } from '@aztec/noir-protocol-circuits-types';
-import { type MerkleTreeOperations } from '@aztec/world-state';
+import { type MerkleTreeReadOperations } from '@aztec/world-state';
 
-import { accumulateReturnValues } from '../common/index.js';
-import { type PublicExecutionResult, collectExecutionResults } from './execution.js';
+import { type PublicExecutionResult, accumulatePublicReturnValues, collectExecutionResults } from './execution.js';
 import { type PublicExecutor } from './executor.js';
 import { type PublicKernelCircuitSimulator } from './public_kernel_circuit_simulator.js';
 
@@ -103,7 +103,7 @@ export type EnqueuedCallResult = {
 export class EnqueuedCallSimulator {
   private log: DebugLogger;
   constructor(
-    private db: MerkleTreeOperations,
+    private db: MerkleTreeReadOperations,
     private publicExecutor: PublicExecutor,
     private publicKernelSimulator: PublicKernelCircuitSimulator,
     private globalVariables: GlobalVariables,
@@ -121,39 +121,60 @@ export class EnqueuedCallSimulator {
     transactionFee: Fr,
     phase: PublicKernelPhase,
   ): Promise<EnqueuedCallResult> {
+    // Gas allocated to an enqueued call can be different from the available gas
+    // if there is more gas available than the max allocation per enqueued call.
+    const allocatedGas = new Gas(
+      /*daGas=*/ availableGas.daGas,
+      /*l2Gas=*/ Math.min(availableGas.l2Gas, MAX_L2_GAS_PER_ENQUEUED_CALL),
+    );
     const pendingNullifiers = this.getSiloedPendingNullifiers(previousPublicKernelOutput);
     const startSideEffectCounter = previousPublicKernelOutput.endSideEffectCounter + 1;
+
+    const prevAccumulatedData =
+      phase === PublicKernelPhase.SETUP
+        ? previousPublicKernelOutput.endNonRevertibleData
+        : previousPublicKernelOutput.end;
+    const previousValidationRequestArrayLengths = PublicValidationRequestArrayLengths.new(
+      previousPublicKernelOutput.validationRequests,
+    );
+    const previousAccumulatedDataArrayLengths = PublicAccumulatedDataArrayLengths.new(prevAccumulatedData);
+
+    // If this is the first enqueued call in public, constants will be empty
+    // because private kernel does not expose them.
+    const constants = previousPublicKernelOutput.constants.clone();
+    constants.globalVariables = this.globalVariables;
+
     const result = await this.publicExecutor.simulate(
       executionRequest,
-      this.globalVariables,
-      availableGas,
+      constants,
+      allocatedGas,
       tx.data.constants.txContext,
       pendingNullifiers,
       transactionFee,
       startSideEffectCounter,
+      previousValidationRequestArrayLengths,
+      previousAccumulatedDataArrayLengths,
     );
 
     const callStack = makeTuple(MAX_PUBLIC_CALL_STACK_LENGTH_PER_TX, PublicInnerCallRequest.empty);
     callStack[0].item.contractAddress = callRequest.contractAddress;
     callStack[0].item.callContext = callRequest.callContext;
     callStack[0].item.argsHash = callRequest.argsHash;
-    const prevAccumulatedData =
-      phase === PublicKernelPhase.SETUP
-        ? previousPublicKernelOutput.endNonRevertibleData
-        : previousPublicKernelOutput.end;
+
     const accumulatedData = PublicAccumulatedData.empty();
     accumulatedData.publicCallStack[0] = callRequest;
+
     const startVMCircuitOutput = new VMCircuitPublicInputs(
       previousPublicKernelOutput.constants,
       callRequest,
       callStack,
-      PublicValidationRequestArrayLengths.new(previousPublicKernelOutput.validationRequests),
+      previousValidationRequestArrayLengths,
       PublicValidationRequests.empty(),
-      PublicAccumulatedDataArrayLengths.new(prevAccumulatedData),
+      previousAccumulatedDataArrayLengths,
       accumulatedData,
       startSideEffectCounter,
       startSideEffectCounter,
-      availableGas,
+      allocatedGas,
       result.transactionFee,
       result.reverted,
     );
@@ -226,7 +247,7 @@ export class EnqueuedCallSimulator {
       provingRequests,
       kernelOutput,
       newUnencryptedLogs: topResult.allUnencryptedLogs,
-      returnValues: accumulateReturnValues(topResult),
+      returnValues: accumulatePublicReturnValues(topResult),
       gasUsed,
       revertReason,
     };