@aztec/simulator 0.55.1 → 0.57.0

package/src/client/client_execution_context.ts

@@ -1,50 +1,37 @@
 import {
   type AuthWitness,
   type AztecNode,
+  CountedLog,
+  CountedNoteLog,
+  CountedPublicExecutionRequest,
   EncryptedL2Log,
   EncryptedL2NoteLog,
-  Event,
-  L1EventPayload,
-  L1NotePayload,
   Note,
+  NoteAndSlot,
   type NoteStatus,
+  type PrivateExecutionResult,
   PublicExecutionRequest,
-  TaggedLog,
   type UnencryptedL2Log,
 } from '@aztec/circuit-types';
 import {
   CallContext,
   FunctionSelector,
   type Header,
-  type KeyValidationRequest,
+  PUBLIC_DISPATCH_SELECTOR,
   PrivateContextInputs,
   type TxContext,
 } from '@aztec/circuits.js';
-import { Aes128 } from '@aztec/circuits.js/barretenberg';
 import { computeUniqueNoteHash, siloNoteHash } from '@aztec/circuits.js/hash';
-import {
-  EventSelector,
-  type FunctionAbi,
-  type FunctionArtifact,
-  type NoteSelector,
-  countArgumentsSize,
-} from '@aztec/foundation/abi';
+import { type FunctionAbi, type FunctionArtifact, type NoteSelector, countArgumentsSize } from '@aztec/foundation/abi';
 import { type AztecAddress } from '@aztec/foundation/aztec-address';
 import { poseidon2HashWithSeparator } from '@aztec/foundation/crypto';
-import { Fr, GrumpkinScalar, type Point } from '@aztec/foundation/fields';
+import { Fr } from '@aztec/foundation/fields';
 import { applyStringFormatting, createDebugLogger } from '@aztec/foundation/log';
 
 import { type NoteData, toACVMWitness } from '../acvm/index.js';
 import { type PackedValuesCache } from '../common/packed_values_cache.js';
 import { type DBOracle } from './db_oracle.js';
 import { type ExecutionNoteCache } from './execution_note_cache.js';
-import {
-  CountedLog,
-  CountedNoteLog,
-  CountedPublicExecutionRequest,
-  type ExecutionResult,
-  type NoteAndSlot,
-} from './execution_result.js';
 import { pickNotes } from './pick_notes.js';
 import { executePrivateFunction } from './private_execution.js';
 import { ViewDataOracle } from './view_data_oracle.js';
@@ -75,7 +62,7 @@ export class ClientExecutionContext extends ViewDataOracle {
   private noteEncryptedLogs: CountedNoteLog[] = [];
   private encryptedLogs: CountedLog<EncryptedL2Log>[] = [];
   private unencryptedLogs: CountedLog<UnencryptedL2Log>[] = [];
-  private nestedExecutions: ExecutionResult[] = [];
+  private nestedExecutions: PrivateExecutionResult[] = [];
   private enqueuedPublicFunctionCalls: CountedPublicExecutionRequest[] = [];
   private publicTeardownFunctionCall: PublicExecutionRequest = PublicExecutionRequest.empty();
 
@@ -314,11 +301,7 @@ export class ClientExecutionContext extends ViewDataOracle {
       },
       counter,
     );
-    this.newNotes.push({
-      storageSlot,
-      noteTypeId,
-      note,
-    });
+    this.newNotes.push(new NoteAndSlot(note, storageSlot, noteTypeId));
   }
 
   /**
@@ -373,62 +356,6 @@ export class ClientExecutionContext extends ViewDataOracle {
     this.noteEncryptedLogs.push(encryptedLog);
   }
 
-  /**
-   * Encrypt an event
-   * @param contractAddress - The contract emitting the encrypted event.
-   * @param randomness - A value used to mask the contract address we are siloing with.
-   * @param eventTypeId - The type ID of the event (function selector).
-   * @param ovKeys - The outgoing viewing keys to use to encrypt.
-   * @param ivpkM - The master incoming viewing public key.
-   * @param recipient - The recipient of the encrypted event log.
-   * @param preimage - The event preimage.
-   */
-  public override computeEncryptedEventLog(
-    contractAddress: AztecAddress,
-    randomness: Fr,
-    eventTypeId: Fr,
-    ovKeys: KeyValidationRequest,
-    ivpkM: Point,
-    recipient: AztecAddress,
-    preimage: Fr[],
-  ) {
-    const event = new Event(preimage);
-    const l1EventPayload = new L1EventPayload(event, contractAddress, randomness, EventSelector.fromField(eventTypeId));
-    const taggedEvent = new TaggedLog(l1EventPayload);
-
-    const ephSk = GrumpkinScalar.random();
-
-    return taggedEvent.encrypt(ephSk, recipient, ivpkM, ovKeys);
-  }
-
-  /**
-   * Encrypt a note
-   * @param contractAddress - The contract address of the note.
-   * @param storageSlot - The storage slot the note is at.
-   * @param noteTypeId - The type ID of the note.
-   * @param ovKeys - The outgoing viewing keys to use to encrypt.
-   * @param ivpkM - The master incoming viewing public key.
-   * @param recipient - The recipient of the encrypted note log.
-   * @param preimage - The note preimage.
-   */
-  public override computeEncryptedNoteLog(
-    contractAddress: AztecAddress,
-    storageSlot: Fr,
-    noteTypeId: NoteSelector,
-    ovKeys: KeyValidationRequest,
-    ivpkM: Point,
-    recipient: AztecAddress,
-    preimage: Fr[],
-  ) {
-    const note = new Note(preimage);
-    const l1NotePayload = new L1NotePayload(note, contractAddress, storageSlot, noteTypeId);
-    const taggedNote = new TaggedLog(l1NotePayload);
-
-    const ephSk = GrumpkinScalar.random();
-
-    return taggedNote.encrypt(ephSk, recipient, ivpkM, ovKeys);
-  }
-
   /**
    * Emit an unencrypted log.
    * @param log - The unencrypted log to be emitted.
@@ -457,7 +384,7 @@ export class ClientExecutionContext extends ViewDataOracle {
     return Fr.fromBuffer(log.hash());
   }
 
-  #checkValidStaticCall(childExecutionResult: ExecutionResult) {
+  #checkValidStaticCall(childExecutionResult: PrivateExecutionResult) {
     if (
       childExecutionResult.callStackItem.publicInputs.noteHashes.some(item => !item.isEmpty()) ||
       childExecutionResult.callStackItem.publicInputs.nullifiers.some(item => !item.isEmpty()) ||
@@ -568,7 +495,7 @@ export class ClientExecutionContext extends ViewDataOracle {
     const args = this.packedValuesCache.unpack(argsHash);
 
     this.log.verbose(
-      `Created PublicExecutionRequest of type [${callType}], side-effect counter [${sideEffectCounter}] to ${targetContractAddress}:${functionSelector}(${targetArtifact.name})`,
+      `Created PublicExecutionRequest to ${targetArtifact.name}@${targetContractAddress}, of type [${callType}], side-effect counter [${sideEffectCounter}]`,
     );
 
     const request = PublicExecutionRequest.from({
@@ -602,16 +529,27 @@ export class ClientExecutionContext extends ViewDataOracle {
     sideEffectCounter: number,
     isStaticCall: boolean,
     isDelegateCall: boolean,
-  ) {
+  ): Promise<Fr> {
+    // TODO(https://github.com/AztecProtocol/aztec-packages/issues/8985): Fix this.
+    // WARNING: This is insecure and should be temporary!
+    // The oracle repacks the arguments and returns a new args_hash.
+    // new_args = [selector, ...old_args], so as to make it suitable to call the public dispatch function.
+    // We don't validate or compute it in the circuit because a) it's harder to do with slices, and
+    // b) this is only temporary.
+    const newArgsHash = this.packedValuesCache.pack([
+      functionSelector.toField(),
+      ...this.packedValuesCache.unpack(argsHash),
+    ]);
     await this.createPublicExecutionRequest(
       'enqueued',
       targetContractAddress,
-      functionSelector,
-      argsHash,
+      FunctionSelector.fromField(new Fr(PUBLIC_DISPATCH_SELECTOR)),
+      newArgsHash,
       sideEffectCounter,
       isStaticCall,
       isDelegateCall,
     );
+    return newArgsHash;
   }
 
   /**
@@ -632,16 +570,27 @@ export class ClientExecutionContext extends ViewDataOracle {
     sideEffectCounter: number,
     isStaticCall: boolean,
     isDelegateCall: boolean,
-  ) {
+  ): Promise<Fr> {
+    // TODO(https://github.com/AztecProtocol/aztec-packages/issues/8985): Fix this.
+    // WARNING: This is insecure and should be temporary!
+    // The oracle repacks the arguments and returns a new args_hash.
+    // new_args = [selector, ...old_args], so as to make it suitable to call the public dispatch function.
+    // We don't validate or compute it in the circuit because a) it's harder to do with slices, and
+    // b) this is only temporary.
+    const newArgsHash = this.packedValuesCache.pack([
+      functionSelector.toField(),
+      ...this.packedValuesCache.unpack(argsHash),
+    ]);
     await this.createPublicExecutionRequest(
       'teardown',
       targetContractAddress,
-      functionSelector,
-      argsHash,
+      FunctionSelector.fromField(new Fr(PUBLIC_DISPATCH_SELECTOR)),
+      newArgsHash,
       sideEffectCounter,
       isStaticCall,
       isDelegateCall,
     );
+    return newArgsHash;
   }
 
   public override notifySetMinRevertibleSideEffectCounter(minRevertibleSideEffectCounter: number): void {
@@ -698,11 +647,6 @@ export class ClientExecutionContext extends ViewDataOracle {
     return values;
   }
 
-  public override aes128Encrypt(input: Buffer, initializationVector: Buffer, key: Buffer): Buffer {
-    const aes128 = new Aes128();
-    return aes128.encryptBufferCBC(input, initializationVector, key);
-  }
-
   public override debugLog(message: string, fields: Fr[]) {
     this.log.verbose(`debug_log ${applyStringFormatting(message, fields)}`);
   }

package/src/client/index.ts

@@ -1,5 +1,4 @@
 export * from './simulator.js';
 export * from './db_oracle.js';
-export * from './execution_result.js';
 export * from './pick_notes.js';
 export * from './execution_note_cache.js';

package/src/client/private_execution.ts

@@ -1,3 +1,4 @@
+import { PrivateExecutionResult } from '@aztec/circuit-types';
 import { type CircuitWitnessGenerationStats } from '@aztec/circuit-types/stats';
 import { Fr, FunctionData, PrivateCallStackItem, PrivateCircuitPublicInputs } from '@aztec/circuits.js';
 import type { FunctionArtifact, FunctionSelector } from '@aztec/foundation/abi';
@@ -9,7 +10,6 @@ import { witnessMapToFields } from '../acvm/deserialize.js';
 import { Oracle, acvm, extractCallStack } from '../acvm/index.js';
 import { ExecutionError } from '../common/errors.js';
 import { type ClientExecutionContext } from './client_execution_context.js';
-import { type ExecutionResult } from './execution_result.js';
 
 /**
  * Execute a private function and return the execution result.
@@ -19,10 +19,10 @@ export async function executePrivateFunction(
   artifact: FunctionArtifact,
   contractAddress: AztecAddress,
   functionSelector: FunctionSelector,
-  log = createDebugLogger('aztec:simulator:secret_execution'),
-): Promise<ExecutionResult> {
+  log = createDebugLogger('aztec:simulator:private_execution'),
+): Promise<PrivateExecutionResult> {
   const functionName = await context.getDebugFunctionName();
-  log.verbose(`Executing external function ${contractAddress}:${functionSelector}(${functionName})`);
+  log.verbose(`Executing external function ${functionName}@${contractAddress}`);
   const acir = artifact.bytecode;
   const initialWitness = context.getInitialWitness(artifact);
   const acvmCallback = new Oracle(context);
@@ -75,20 +75,20 @@ export async function executePrivateFunction(
 
   log.debug(`Returning from call to ${contractAddress.toString()}:${functionSelector}`);
 
-  return {
+  return new PrivateExecutionResult(
     acir,
+    Buffer.from(artifact.verificationKey!, 'hex'),
     partialWitness,
     callStackItem,
-    returnValues: rawReturnValues,
     noteHashLeafIndexMap,
     newNotes,
     noteHashNullifierCounterMap,
-    vk: Buffer.from(artifact.verificationKey!, 'hex'),
+    rawReturnValues,
     nestedExecutions,
     enqueuedPublicFunctionCalls,
-    noteEncryptedLogs,
     publicTeardownFunctionCall,
+    noteEncryptedLogs,
     encryptedLogs,
     unencryptedLogs,
-  };
+  );
 }

package/src/client/simulator.ts

@@ -1,4 +1,4 @@
-import { type AztecNode, type FunctionCall, type Note, type TxExecutionRequest } from '@aztec/circuit-types';
+import type { AztecNode, FunctionCall, Note, PrivateExecutionResult, TxExecutionRequest } from '@aztec/circuit-types';
 import { CallContext } from '@aztec/circuits.js';
 import {
   type ArrayType,
@@ -17,7 +17,6 @@ import { PackedValuesCache } from '../common/packed_values_cache.js';
 import { ClientExecutionContext } from './client_execution_context.js';
 import { type DBOracle } from './db_oracle.js';
 import { ExecutionNoteCache } from './execution_note_cache.js';
-import { type ExecutionResult } from './execution_result.js';
 import { executePrivateFunction } from './private_execution.js';
 import { executeUnconstrainedFunction } from './unconstrained_execution.js';
 import { ViewDataOracle } from './view_data_oracle.js';
@@ -47,7 +46,7 @@ export class AcirSimulator {
     contractAddress: AztecAddress,
     msgSender = AztecAddress.fromField(Fr.MAX_FIELD_VALUE),
     scopes?: AztecAddress[],
-  ): Promise<ExecutionResult> {
+  ): Promise<PrivateExecutionResult> {
     if (entryPointArtifact.functionType !== FunctionType.PRIVATE) {
       throw new Error(`Cannot run ${entryPointArtifact.functionType} function as private`);
     }

package/src/client/test_utils.ts

@@ -1,8 +1,35 @@
-import { Fq, Fr, GeneratorIndex, Point } from '@aztec/circuits.js';
+import { Fq, Fr, Point } from '@aztec/circuits.js';
 import { Grumpkin } from '@aztec/circuits.js/barretenberg';
-import { pedersenCommit } from '@aztec/foundation/crypto';
 
 // Copied over from `noir-projects/aztec-nr/aztec/src/generators.nr`
+const GENERATORS = [
+  new Point(
+    new Fr(0x30426e64aee30e998c13c8ceecda3a77807dbead52bc2f3bf0eae851b4b710c1n),
+    new Fr(0x113156a068f603023240c96b4da5474667db3b8711c521c748212a15bc034ea6n),
+    false,
+  ),
+  new Point(
+    new Fr(0x2825c79cc6a5cbbeef7d6a8f1b6a12b312aa338440aefeb4396148c89147c049n),
+    new Fr(0x129bfd1da54b7062d6b544e7e36b90736350f6fba01228c41c72099509f5701en),
+    false,
+  ),
+  new Point(
+    new Fr(0x0edb1e293c3ce91bfc04e3ceaa50d2c541fa9d091c72eb403efb1cfa2cb3357fn),
+    new Fr(0x1341d675fa030ece3113ad53ca34fd13b19b6e9762046734f414824c4d6ade35n),
+    false,
+  ),
+  new Point(
+    new Fr(0x0e0dad2250583f2a9f0acb04ededf1701b85b0393cae753fe7e14b88af81cb52n),
+    new Fr(0x0973b02c5caac339ee4ad5dab51329920f7bf1b6a07e1dabe5df67040b300962n),
+    false,
+  ),
+  new Point(
+    new Fr(0x2f3342e900e8c488a28931aae68970738fdc68afde2910de7b320c00c902087dn),
+    new Fr(0x1bf958dc63cb09d59230603a0269ae86d6f92494da244910351f1132df20fc08n),
+    false,
+  ),
+];
+
 const G_SLOT = new Point(
   new Fr(0x041223147b680850dc82e8a55a952d4df20256fe0593d949a9541ca00f0abf15n),
   new Fr(0x0a8c72e60d0e60f5d804549d48f3044d06140b98ed717a9b532af630c1530791n),
@@ -16,14 +43,14 @@ const G_SLOT = new Point(
  * @returns A note hash.
  */
 export function computeNoteHash(storageSlot: Fr, noteContent: Fr[]): Fr {
-  // TODO(#7771): update this to do only 1 MSM call
-  const c = pedersenCommit(
-    noteContent.map(f => f.toBuffer()),
-    GeneratorIndex.NOTE_HIDING_POINT,
-  );
-  const noteHidingPointBeforeSlotting = new Point(new Fr(c[0]), new Fr(c[1]), false);
-
   const grumpkin = new Grumpkin();
+  const noteHidingPointBeforeSlotting = noteContent
+    .slice(1)
+    .reduce(
+      (acc, item, i) => grumpkin.add(acc, grumpkin.mul(GENERATORS[i + 1], new Fq(item.toBigInt()))),
+      grumpkin.mul(GENERATORS[0], new Fq(noteContent[0].toBigInt())),
+    );
+
   const slotPoint = grumpkin.mul(G_SLOT, new Fq(storageSlot.toBigInt()));
   const noteHidingPoint = grumpkin.add(noteHidingPointBeforeSlotting, slotPoint);
   return noteHidingPoint.x;

package/src/client/unconstrained_execution.ts

@@ -1,9 +1,4 @@
-import {
-  type DecodedReturn,
-  type FunctionArtifact,
-  type FunctionSelector,
-  decodeReturnValues,
-} from '@aztec/foundation/abi';
+import { type AbiDecoded, type FunctionArtifact, type FunctionSelector, decodeFromAbi } from '@aztec/foundation/abi';
 import { type AztecAddress } from '@aztec/foundation/aztec-address';
 import { type Fr } from '@aztec/foundation/fields';
 import { createDebugLogger } from '@aztec/foundation/log';
@@ -24,7 +19,7 @@ export async function executeUnconstrainedFunction(
   functionSelector: FunctionSelector,
   args: Fr[],
   log = createDebugLogger('aztec:simulator:unconstrained_execution'),
-): Promise<DecodedReturn> {
+): Promise<AbiDecoded> {
   log.verbose(`Executing unconstrained function ${contractAddress}:${functionSelector}(${artifact.name})`);
 
   const acir = artifact.bytecode;
@@ -42,6 +37,6 @@ export async function executeUnconstrainedFunction(
   });
 
   const returnWitness = witnessMapToFields(acirExecutionResult.returnWitness);
-  return decodeReturnValues(artifact.returnTypes, returnWitness);
+  return decodeFromAbi(artifact.returnTypes, returnWitness);
 }
 // docs:end:execute_unconstrained_function

package/src/common/debug_fn_name.ts

@@ -0,0 +1,22 @@
+import { type AztecAddress, Fr, FunctionSelector, PUBLIC_DISPATCH_SELECTOR } from '@aztec/circuits.js';
+
+import { type WorldStateDB } from '../public/public_db_sources.js';
+
+export async function getPublicFunctionDebugName(
+  db: WorldStateDB,
+  contractAddress: AztecAddress,
+  fn: FunctionSelector,
+  calldata: Fr[],
+): Promise<string> {
+  if (fn.equals(FunctionSelector.fromField(new Fr(PUBLIC_DISPATCH_SELECTOR)))) {
+    // If the function is a dispatch, we need to look up the target function which
+    // is expected to be the first argument.
+    const targetFunction =
+      calldata[0] !== undefined
+        ? await db.getDebugFunctionName(contractAddress, FunctionSelector.fromField(calldata[0]))
+        : `<calldata[0] undefined>`;
+    return `${targetFunction} (via dispatch)`;
+  } else {
+    return (await db.getDebugFunctionName(contractAddress, fn)) ?? `${contractAddress}:${fn}`;
+  }
+}

package/src/common/index.ts

@@ -1,4 +1,3 @@
 export * from './packed_values_cache.js';
 export * from './errors.js';
 export * from './side_effect_counter.js';
-export * from './return_values.js';