@aztec/simulator 0.40.0 → 0.41.0

package/src/public/tail_phase_manager.ts

@@ -1,9 +1,10 @@
 import { type PublicKernelRequest, PublicKernelType, type Tx } from '@aztec/circuit-types';
 import {
-  Fr,
+  type Fr,
   type GlobalVariables,
   type Header,
   type KernelCircuitPublicInputs,
+  type LogHash,
   MAX_NEW_NOTE_HASHES_PER_TX,
   MAX_NEW_NULLIFIERS_PER_TX,
   MAX_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX,
@@ -12,7 +13,6 @@ import {
   type Proof,
   type PublicKernelCircuitPublicInputs,
   PublicKernelTailCircuitPrivateInputs,
-  SideEffect,
   makeEmptyProof,
   mergeAccumulatedData,
   sortByCounter,
@@ -70,7 +70,7 @@ export class TailPhaseManager extends AbstractPhaseManager {
       finalKernelOutput,
       publicKernelProof: makeEmptyProof(),
       revertReason: undefined,
-      returnValues: undefined,
+      returnValues: [],
       gasUsed: undefined,
     };
   }
@@ -159,10 +159,8 @@ export class TailPhaseManager extends AbstractPhaseManager {
     return sortByCounter(noteHashes).map(n => n.value) as Tuple<Fr, N>;
   }
 
-  private sortLogsHashes<N extends number>(unencryptedLogsHashes: Tuple<SideEffect, N>): Tuple<SideEffect, N> {
+  private sortLogsHashes<N extends number>(unencryptedLogsHashes: Tuple<LogHash, N>): Tuple<LogHash, N> {
     // TODO(6052): logs here may have duplicate counters from nested calls
-    return sortByCounter(
-      unencryptedLogsHashes.map(n => ({ ...n, counter: n.counter.toNumber(), isEmpty: () => n.isEmpty() })),
-    ).map(h => new SideEffect(h.value, new Fr(h.counter))) as Tuple<SideEffect, N>;
+    return sortByCounter(unencryptedLogsHashes);
   }
 }

package/src/public/teardown_phase_manager.ts

@@ -71,7 +71,7 @@ export class TeardownPhaseManager extends AbstractPhaseManager {
       publicKernelOutput,
       publicKernelProof,
       revertReason,
-      returnValues: undefined,
+      returnValues: [],
       gasUsed,
     };
   }

package/src/public/transitional_adaptors.ts

@@ -10,6 +10,9 @@ import {
 } from '@aztec/circuits.js';
 import { Fr } from '@aztec/foundation/fields';
 
+import { promisify } from 'util';
+import { gunzip } from 'zlib';
+
 import { type AvmContext } from '../avm/avm_context.js';
 import { AvmExecutionEnvironment } from '../avm/avm_execution_environment.js';
 import { type AvmContractCallResults } from '../avm/avm_message_call_result.js';
@@ -111,7 +114,19 @@ export function markBytecodeAsAvm(bytecode: Buffer): Buffer {
   return Buffer.concat([bytecode, AVM_MAGIC_SUFFIX]);
 }
 
-export function isAvmBytecode(bytecode: Buffer): boolean {
+// This is just a helper function for the AVM circuit.
+export async function decompressBytecodeIfCompressed(bytecode: Buffer): Promise<Buffer> {
+  try {
+    return await promisify(gunzip)(bytecode);
+  } catch {
+    // If the bytecode is not compressed, the gunzip call will throw an error
+    // In this case, we assume the bytecode is not compressed and continue.
+    return Promise.resolve(bytecode);
+  }
+}
+
+export async function isAvmBytecode(bytecode: Buffer): Promise<boolean> {
+  const decompressedBytecode = await decompressBytecodeIfCompressed(bytecode);
   const magicSize = AVM_MAGIC_SUFFIX.length;
-  return bytecode.subarray(-magicSize).equals(AVM_MAGIC_SUFFIX);
+  return decompressedBytecode.subarray(-magicSize).equals(AVM_MAGIC_SUFFIX);
 }

package/src/public/utils.ts

@@ -11,6 +11,7 @@ export function lastSideEffectCounter(tx: Tx): number {
   const sideEffectCounters = [
     ...data.endNonRevertibleData.newNoteHashes,
     ...data.endNonRevertibleData.newNullifiers,
+    ...data.endNonRevertibleData.unencryptedLogsHashes,
     ...data.endNonRevertibleData.publicCallStack,
     ...data.end.newNoteHashes,
     ...data.end.newNullifiers,
@@ -24,8 +25,7 @@ export function lastSideEffectCounter(tx: Tx): number {
       // look at both start and end counters because for enqueued public calls start > 0 while end === 0
       max = Math.max(max, sideEffect.startSideEffectCounter.toNumber(), sideEffect.endSideEffectCounter.toNumber());
     } else {
-      const counter = typeof sideEffect.counter === 'number' ? sideEffect.counter : sideEffect.counter.toNumber();
-      max = Math.max(max, counter);
+      max = Math.max(max, sideEffect.counter);
     }
   }
 

package/dest/client/logs_cache.d.ts

@@ -1,33 +0,0 @@
-import { type EncryptedL2Log, type UnencryptedL2Log } from '@aztec/circuit-types';
-/**
- * Log data that's accessible by all the function calls in an execution.
- * This class exists to:
- * 1. Keep track of logs emitted through nested calls in the correct order.
- * 2. TODO(1641): Remove encrypted logs based on notes nullified in the same scope.
- */
-export declare class LogsCache {
-    /**
-     * Logs notes created in this transaction.
-     */
-    private encryptedLogs;
-    private unencryptedLogs;
-    /**
-     * Add a new encrypted log to cache.
-     * @param log - New log created during execution.
-     */
-    addEncryptedLog(log: EncryptedL2Log): void;
-    /**
-     * Add a new unencrypted log to cache.
-     * @param log - New log created during execution.
-     */
-    addUnencryptedLog(log: UnencryptedL2Log): void;
-    /**
-     * Return the encrypted logs.
-     */
-    getEncryptedLogs(): EncryptedL2Log[];
-    /**
-     * Return the encrypted logs.
-     */
-    getUnencryptedLogs(): UnencryptedL2Log[];
-}
-//# sourceMappingURL=logs_cache.d.ts.map

package/dest/client/logs_cache.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"logs_cache.d.ts","sourceRoot":"","sources":["../../src/client/logs_cache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAElF;;;;;GAKG;AACH,qBAAa,SAAS;IACpB;;OAEG;IACH,OAAO,CAAC,aAAa,CAAwB;IAC7C,OAAO,CAAC,eAAe,CAA0B;IAsBjD;;;OAGG;IACI,eAAe,CAAC,GAAG,EAAE,cAAc;IAI1C;;;OAGG;IACI,iBAAiB,CAAC,GAAG,EAAE,gBAAgB;IAI9C;;OAEG;IACI,gBAAgB;IAIvB;;OAEG;IACI,kBAAkB;CAG1B"}

package/dest/client/logs_cache.js

@@ -1,59 +0,0 @@
-/**
- * Log data that's accessible by all the function calls in an execution.
- * This class exists to:
- * 1. Keep track of logs emitted through nested calls in the correct order.
- * 2. TODO(1641): Remove encrypted logs based on notes nullified in the same scope.
- */
-export class LogsCache {
-    constructor() {
-        /**
-         * Logs notes created in this transaction.
-         */
-        this.encryptedLogs = [];
-        this.unencryptedLogs = [];
-    }
-    // TODO Separate encrypted logs linked to note hashes and arbitrary logs:
-    // Maps from note hash to encrypted log - useful for removing transient logs
-    // private encryptedLogsLinkedToNotes: Map<bigint, EncryptedL2Log> = new Map();
-    // /**
-    //  * Remove the encrypted log for a nullified note.
-    //  * This fn should only be called if the note's innerNoteHash != 0.
-    //  * @param noteHashCounter - Side effect counter of the note.
-    //  */
-    // public nullifyNote(noteHashCounter: Fr) {
-    //  // Find and remove the matching new note if the emitted innerNoteHash is not empty.
-    //  const log = this.encryptedLogsLinkedToNotes.get(noteHashCounter.toBigInt()) ?? false;
-    //  // TODO: throw here? Will the log always be here?
-    //  if (!log) {
-    //    throw new Error('Attempt to remove a pending note log that does not exist.');
-    //  }
-    //  this.encryptedLogsLinkedToNotes.delete(noteHashCounter.toBigInt());
-    // }
-    /**
-     * Add a new encrypted log to cache.
-     * @param log - New log created during execution.
-     */
-    addEncryptedLog(log) {
-        this.encryptedLogs.push(log);
-    }
-    /**
-     * Add a new unencrypted log to cache.
-     * @param log - New log created during execution.
-     */
-    addUnencryptedLog(log) {
-        this.unencryptedLogs.push(log);
-    }
-    /**
-     * Return the encrypted logs.
-     */
-    getEncryptedLogs() {
-        return this.encryptedLogs;
-    }
-    /**
-     * Return the encrypted logs.
-     */
-    getUnencryptedLogs() {
-        return this.unencryptedLogs;
-    }
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibG9nc19jYWNoZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9jbGllbnQvbG9nc19jYWNoZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFFQTs7Ozs7R0FLRztBQUNILE1BQU0sT0FBTyxTQUFTO0lBQXRCO1FBQ0U7O1dBRUc7UUFDSyxrQkFBYSxHQUFxQixFQUFFLENBQUM7UUFDckMsb0JBQWUsR0FBdUIsRUFBRSxDQUFDO0lBbURuRCxDQUFDO0lBakRDLHlFQUF5RTtJQUV6RSw0RUFBNEU7SUFDNUUsK0VBQStFO0lBRS9FLE1BQU07SUFDTixvREFBb0Q7SUFDcEQscUVBQXFFO0lBQ3JFLCtEQUErRDtJQUMvRCxNQUFNO0lBQ04sNENBQTRDO0lBQzVDLHVGQUF1RjtJQUN2Rix5RkFBeUY7SUFDekYscURBQXFEO0lBQ3JELGVBQWU7SUFDZixtRkFBbUY7SUFDbkYsS0FBSztJQUNMLHVFQUF1RTtJQUN2RSxJQUFJO0lBRUo7OztPQUdHO0lBQ0ksZUFBZSxDQUFDLEdBQW1CO1FBQ3hDLElBQUksQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQy9CLENBQUM7SUFFRDs7O09BR0c7SUFDSSxpQkFBaUIsQ0FBQyxHQUFxQjtRQUM1QyxJQUFJLENBQUMsZUFBZSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztJQUNqQyxDQUFDO0lBRUQ7O09BRUc7SUFDSSxnQkFBZ0I7UUFDckIsT0FBTyxJQUFJLENBQUMsYUFBYSxDQUFDO0lBQzVCLENBQUM7SUFFRDs7T0FFRztJQUNJLGtCQUFrQjtRQUN2QixPQUFPLElBQUksQ0FBQyxlQUFlLENBQUM7SUFDOUIsQ0FBQztDQUNGIn0=

package/src/client/logs_cache.ts

@@ -1,65 +0,0 @@
-import { type EncryptedL2Log, type UnencryptedL2Log } from '@aztec/circuit-types';
-
-/**
- * Log data that's accessible by all the function calls in an execution.
- * This class exists to:
- * 1. Keep track of logs emitted through nested calls in the correct order.
- * 2. TODO(1641): Remove encrypted logs based on notes nullified in the same scope.
- */
-export class LogsCache {
-  /**
-   * Logs notes created in this transaction.
-   */
-  private encryptedLogs: EncryptedL2Log[] = [];
-  private unencryptedLogs: UnencryptedL2Log[] = [];
-
-  // TODO Separate encrypted logs linked to note hashes and arbitrary logs:
-
-  // Maps from note hash to encrypted log - useful for removing transient logs
-  // private encryptedLogsLinkedToNotes: Map<bigint, EncryptedL2Log> = new Map();
-
-  // /**
-  //  * Remove the encrypted log for a nullified note.
-  //  * This fn should only be called if the note's innerNoteHash != 0.
-  //  * @param noteHashCounter - Side effect counter of the note.
-  //  */
-  // public nullifyNote(noteHashCounter: Fr) {
-  //  // Find and remove the matching new note if the emitted innerNoteHash is not empty.
-  //  const log = this.encryptedLogsLinkedToNotes.get(noteHashCounter.toBigInt()) ?? false;
-  //  // TODO: throw here? Will the log always be here?
-  //  if (!log) {
-  //    throw new Error('Attempt to remove a pending note log that does not exist.');
-  //  }
-  //  this.encryptedLogsLinkedToNotes.delete(noteHashCounter.toBigInt());
-  // }
-
-  /**
-   * Add a new encrypted log to cache.
-   * @param log - New log created during execution.
-   */
-  public addEncryptedLog(log: EncryptedL2Log) {
-    this.encryptedLogs.push(log);
-  }
-
-  /**
-   * Add a new unencrypted log to cache.
-   * @param log - New log created during execution.
-   */
-  public addUnencryptedLog(log: UnencryptedL2Log) {
-    this.unencryptedLogs.push(log);
-  }
-
-  /**
-   * Return the encrypted logs.
-   */
-  public getEncryptedLogs() {
-    return this.encryptedLogs;
-  }
-
-  /**
-   * Return the encrypted logs.
-   */
-  public getUnencryptedLogs() {
-    return this.unencryptedLogs;
-  }
-}