@aztec/pxe 3.0.0-canary.a9708bd → 3.0.0-devnet.20251212

package/src/contract_function_simulator/oracle/utility_execution_oracle.ts

@@ -1,25 +1,31 @@
-import { Aes128 } from '@aztec/foundation/crypto';
-import { Fr, Point } from '@aztec/foundation/fields';
-import { applyStringFormatting, createLogger } from '@aztec/foundation/log';
+import type { BlockNumber } from '@aztec/foundation/branded-types';
+import { Aes128 } from '@aztec/foundation/crypto/aes128';
+import { Fr } from '@aztec/foundation/curves/bn254';
+import { Point } from '@aztec/foundation/curves/grumpkin';
+import { LogLevels, applyStringFormatting, createLogger } from '@aztec/foundation/log';
 import type { AuthWitness } from '@aztec/stdlib/auth-witness';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
 import type { CompleteAddress, ContractInstance } from '@aztec/stdlib/contract';
 import { siloNullifier } from '@aztec/stdlib/hash';
 import type { KeyValidationRequest } from '@aztec/stdlib/kernel';
-import { IndexedTaggingSecret } from '@aztec/stdlib/logs';
 import type { NoteStatus } from '@aztec/stdlib/note';
 import { type MerkleTreeId, type NullifierMembershipWitness, PublicDataWitness } from '@aztec/stdlib/trees';
 import type { BlockHeader, Capsule } from '@aztec/stdlib/tx';
-import type { UInt64 } from '@aztec/stdlib/types';
 
 import type { ExecutionDataProvider } from '../execution_data_provider.js';
+import { UtilityContext } from '../noir-structs/utility_context.js';
 import { pickNotes } from '../pick_notes.js';
-import { type NoteData, TypedOracle } from './typed_oracle.js';
+import type { IMiscOracle, IUtilityExecutionOracle, NoteData } from './interfaces.js';
 
 /**
  * The oracle for an execution of utility contract functions.
  */
-export class UtilityExecutionOracle extends TypedOracle {
+export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOracle {
+  isMisc = true as const;
+  isUtility = true as const;
+
+  private aztecNrDebugLog = createLogger('aztec-nr:debug_log');
+
   constructor(
     protected readonly contractAddress: AztecAddress,
     /** List of transient auth witnesses to be used during this simulation */
@@ -28,36 +34,25 @@ export class UtilityExecutionOracle extends TypedOracle {
     protected readonly executionDataProvider: ExecutionDataProvider,
     protected log = createLogger('simulator:client_view_context'),
     protected readonly scopes?: AztecAddress[],
-  ) {
-    super();
-  }
+  ) {}
 
-  public override utilityAssertCompatibleOracleVersion(version: number): void {
+  public utilityAssertCompatibleOracleVersion(version: number): void {
     this.executionDataProvider.assertCompatibleOracleVersion(version);
   }
 
-  public override utilityGetRandomField(): Fr {
+  public utilityGetRandomField(): Fr {
     return Fr.random();
   }
 
-  public override utilityGetBlockNumber(): Promise<number> {
-    return this.executionDataProvider.getBlockNumber();
-  }
-
-  public override utilityGetTimestamp(): Promise<UInt64> {
-    return this.executionDataProvider.getTimestamp();
-  }
-
-  public override utilityGetContractAddress(): Promise<AztecAddress> {
-    return Promise.resolve(this.contractAddress);
-  }
-
-  public override utilityGetChainId(): Promise<Fr> {
-    return Promise.resolve(this.executionDataProvider.getChainId().then(id => new Fr(id)));
-  }
-
-  public override utilityGetVersion(): Promise<Fr> {
-    return Promise.resolve(this.executionDataProvider.getVersion().then(v => new Fr(v)));
+  public async utilityGetUtilityContext(): Promise<UtilityContext> {
+    const blockHeader = await this.executionDataProvider.getAnchorBlockHeader();
+    return UtilityContext.from({
+      blockNumber: blockHeader.globalVariables.blockNumber,
+      timestamp: blockHeader.globalVariables.timestamp,
+      contractAddress: this.contractAddress,
+      version: blockHeader.globalVariables.version,
+      chainId: blockHeader.globalVariables.chainId,
+    });
   }
 
   /**
@@ -66,7 +61,7 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @returns A Promise that resolves to nullifier keys.
    * @throws If the keys are not registered in the key store.
    */
-  public override utilityGetKeyValidationRequest(pkMHash: Fr): Promise<KeyValidationRequest> {
+  public utilityGetKeyValidationRequest(pkMHash: Fr): Promise<KeyValidationRequest> {
     return this.executionDataProvider.getKeyValidationRequest(pkMHash, this.contractAddress);
   }
 
@@ -77,7 +72,7 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @param leafValue - The leaf value
    * @returns The index and sibling path concatenated [index, sibling_path]
    */
-  public override utilityGetMembershipWitness(blockNumber: number, treeId: MerkleTreeId, leafValue: Fr): Promise<Fr[]> {
+  public utilityGetMembershipWitness(blockNumber: BlockNumber, treeId: MerkleTreeId, leafValue: Fr): Promise<Fr[]> {
     return this.executionDataProvider.getMembershipWitness(blockNumber, treeId, leafValue);
   }
 
@@ -87,8 +82,8 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @param nullifier - Nullifier we try to find witness for.
    * @returns The nullifier membership witness (if found).
    */
-  public override async utilityGetNullifierMembershipWitness(
-    blockNumber: number,
+  public async utilityGetNullifierMembershipWitness(
+    blockNumber: BlockNumber,
     nullifier: Fr,
   ): Promise<NullifierMembershipWitness | undefined> {
     return await this.executionDataProvider.getNullifierMembershipWitness(blockNumber, nullifier);
@@ -103,8 +98,8 @@ export class UtilityExecutionOracle extends TypedOracle {
    * list structure" of leaves and proving that a lower nullifier is pointing to a bigger next value than the nullifier
    * we are trying to prove non-inclusion for.
    */
-  public override async utilityGetLowNullifierMembershipWitness(
-    blockNumber: number,
+  public async utilityGetLowNullifierMembershipWitness(
+    blockNumber: BlockNumber,
     nullifier: Fr,
   ): Promise<NullifierMembershipWitness | undefined> {
     return await this.executionDataProvider.getLowNullifierMembershipWitness(blockNumber, nullifier);
@@ -116,8 +111,8 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @param leafSlot - The slot of the public data tree to get the witness for.
    * @returns - The witness
    */
-  public override async utilityGetPublicDataWitness(
-    blockNumber: number,
+  public async utilityGetPublicDataWitness(
+    blockNumber: BlockNumber,
     leafSlot: Fr,
   ): Promise<PublicDataWitness | undefined> {
     return await this.executionDataProvider.getPublicDataWitness(blockNumber, leafSlot);
@@ -128,12 +123,12 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @param blockNumber - The number of a block of which to get the block header.
    * @returns Block extracted from a block with block number `blockNumber`.
    */
-  public override async utilityGetBlockHeader(blockNumber: number): Promise<BlockHeader | undefined> {
+  public async utilityGetBlockHeader(blockNumber: BlockNumber): Promise<BlockHeader | undefined> {
     const block = await this.executionDataProvider.getBlock(blockNumber);
     if (!block) {
       return undefined;
     }
-    return block.header;
+    return block.getBlockHeader();
   }
 
   /**
@@ -142,7 +137,7 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @returns A complete address associated with the input address.
    * @throws An error if the account is not registered in the database.
    */
-  public override utilityGetCompleteAddress(account: AztecAddress): Promise<CompleteAddress> {
+  public utilityGetPublicKeysAndPartialAddress(account: AztecAddress): Promise<CompleteAddress> {
     return this.executionDataProvider.getCompleteAddress(account);
   }
 
@@ -151,7 +146,7 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @param address - Address.
    * @returns A contract instance.
    */
-  public override utilityGetContractInstance(address: AztecAddress): Promise<ContractInstance> {
+  public utilityGetContractInstance(address: AztecAddress): Promise<ContractInstance> {
     return this.executionDataProvider.getContractInstance(address);
   }
 
@@ -161,7 +156,7 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @param messageHash - Hash of the message to authenticate.
    * @returns Authentication witness for the requested message hash.
    */
-  public override utilityGetAuthWitness(messageHash: Fr): Promise<Fr[] | undefined> {
+  public utilityGetAuthWitness(messageHash: Fr): Promise<Fr[] | undefined> {
     return Promise.resolve(this.authWitnesses.find(w => w.requestHash.equals(messageHash))?.witness);
   }
 
@@ -174,6 +169,7 @@ export class UtilityExecutionOracle extends TypedOracle {
    * Real notes coming from DB will have a leafIndex which
    * represents their index in the note hash tree.
    *
+   * @param owner - The owner of the notes. If undefined, returns notes for all owners.
    * @param storageSlot - The storage slot.
    * @param numSelects - The number of valid selects in selectBy and selectValues.
    * @param selectBy - An array of indices of the fields to selects.
@@ -186,7 +182,8 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @param status - The status of notes to fetch.
    * @returns Array of note data.
    */
-  public override async utilityGetNotes(
+  public async utilityGetNotes(
+    owner: AztecAddress | undefined,
     storageSlot: Fr,
     numSelects: number,
     selectByIndexes: number[],
@@ -202,7 +199,13 @@ export class UtilityExecutionOracle extends TypedOracle {
     offset: number,
     status: NoteStatus,
   ): Promise<NoteData[]> {
-    const dbNotes = await this.executionDataProvider.getNotes(this.contractAddress, storageSlot, status, this.scopes);
+    const dbNotes = await this.executionDataProvider.getNotes(
+      this.contractAddress,
+      owner,
+      storageSlot,
+      status,
+      this.scopes,
+    );
     return pickNotes<NoteData>(dbNotes, {
       selects: selectByIndexes.slice(0, numSelects).map((index, i) => ({
         selector: { index, offset: selectByOffsets[i], length: selectByLengths[i] },
@@ -223,7 +226,7 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @param innerNullifier - The inner nullifier.
    * @returns A boolean indicating whether the nullifier exists in the tree or not.
    */
-  public override async utilityCheckNullifierExists(innerNullifier: Fr) {
+  public async utilityCheckNullifierExists(innerNullifier: Fr) {
     const nullifier = await siloNullifier(this.contractAddress, innerNullifier!);
     const index = await this.executionDataProvider.getNullifierIndex(nullifier);
     return index !== undefined;
@@ -237,7 +240,7 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @dev Contract address and secret are only used to compute the nullifier to get non-nullified messages
    * @returns The l1 to l2 membership witness (index of message in the tree and sibling path).
    */
-  public override async utilityGetL1ToL2MembershipWitness(contractAddress: AztecAddress, messageHash: Fr, secret: Fr) {
+  public async utilityGetL1ToL2MembershipWitness(contractAddress: AztecAddress, messageHash: Fr, secret: Fr) {
     return await this.executionDataProvider.getL1ToL2MembershipWitness(contractAddress, messageHash, secret);
   }
 
@@ -248,10 +251,10 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @param blockNumber - The block number to read storage at.
    * @param numberOfElements - Number of elements to read from the starting storage slot.
    */
-  public override async utilityStorageRead(
+  public async utilityStorageRead(
     contractAddress: AztecAddress,
     startStorageSlot: Fr,
-    blockNumber: number,
+    blockNumber: BlockNumber,
     numberOfElements: number,
   ) {
     const values = [];
@@ -267,32 +270,21 @@ export class UtilityExecutionOracle extends TypedOracle {
     return values;
   }
 
-  public override utilityDebugLog(message: string, fields: Fr[]): void {
-    this.log.verbose(`${applyStringFormatting(message, fields)}`, { module: `${this.log.module}:debug_log` });
-  }
-
-  /**
-   * Returns the tagging secret for a given sender and recipient pair, siloed to the current contract address.
-   * Includes the next index to be used used for tagging with this secret.
-   * For this to work, the ivsk_m of the sender must be known.
-   * @param sender - The address sending the note
-   * @param recipient - The address receiving the note
-   * @returns A tagging secret that can be used to tag notes.
-   */
-  public override async utilityGetIndexedTaggingSecretAsSender(
-    sender: AztecAddress,
-    recipient: AztecAddress,
-  ): Promise<IndexedTaggingSecret> {
-    return await this.executionDataProvider.getIndexedTaggingSecretAsSender(this.contractAddress, sender, recipient);
+  public utilityDebugLog(level: number, message: string, fields: Fr[]): void {
+    if (!LogLevels[level]) {
+      throw new Error(`Invalid debug log level: ${level}`);
+    }
+    const levelName = LogLevels[level];
+    this.aztecNrDebugLog[levelName](`${applyStringFormatting(message, fields)}`);
   }
 
-  public override async utilityFetchTaggedLogs(pendingTaggedLogArrayBaseSlot: Fr) {
+  public async utilityFetchTaggedLogs(pendingTaggedLogArrayBaseSlot: Fr) {
     await this.executionDataProvider.syncTaggedLogs(this.contractAddress, pendingTaggedLogArrayBaseSlot, this.scopes);
 
-    await this.executionDataProvider.removeNullifiedNotes(this.contractAddress);
+    await this.executionDataProvider.syncNoteNullifiers(this.contractAddress);
   }
 
-  public override async utilityValidateEnqueuedNotesAndEvents(
+  public async utilityValidateEnqueuedNotesAndEvents(
     contractAddress: AztecAddress,
     noteValidationRequestsArrayBaseSlot: Fr,
     eventValidationRequestsArrayBaseSlot: Fr,
@@ -309,7 +301,7 @@ export class UtilityExecutionOracle extends TypedOracle {
     );
   }
 
-  public override async utilityBulkRetrieveLogs(
+  public async utilityBulkRetrieveLogs(
     contractAddress: AztecAddress,
     logRetrievalRequestsArrayBaseSlot: Fr,
     logRetrievalResponsesArrayBaseSlot: Fr,
@@ -326,7 +318,7 @@ export class UtilityExecutionOracle extends TypedOracle {
     );
   }
 
-  public override utilityStoreCapsule(contractAddress: AztecAddress, slot: Fr, capsule: Fr[]): Promise<void> {
+  public utilityStoreCapsule(contractAddress: AztecAddress, slot: Fr, capsule: Fr[]): Promise<void> {
     if (!contractAddress.equals(this.contractAddress)) {
       // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
       throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -334,7 +326,7 @@ export class UtilityExecutionOracle extends TypedOracle {
     return this.executionDataProvider.storeCapsule(this.contractAddress, slot, capsule);
   }
 
-  public override async utilityLoadCapsule(contractAddress: AztecAddress, slot: Fr): Promise<Fr[] | null> {
+  public async utilityLoadCapsule(contractAddress: AztecAddress, slot: Fr): Promise<Fr[] | null> {
     if (!contractAddress.equals(this.contractAddress)) {
       // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
       throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -346,7 +338,7 @@ export class UtilityExecutionOracle extends TypedOracle {
     );
   }
 
-  public override utilityDeleteCapsule(contractAddress: AztecAddress, slot: Fr): Promise<void> {
+  public utilityDeleteCapsule(contractAddress: AztecAddress, slot: Fr): Promise<void> {
     if (!contractAddress.equals(this.contractAddress)) {
       // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
       throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -354,7 +346,7 @@ export class UtilityExecutionOracle extends TypedOracle {
     return this.executionDataProvider.deleteCapsule(this.contractAddress, slot);
   }
 
-  public override utilityCopyCapsule(
+  public utilityCopyCapsule(
     contractAddress: AztecAddress,
     srcSlot: Fr,
     dstSlot: Fr,
@@ -368,16 +360,12 @@ export class UtilityExecutionOracle extends TypedOracle {
   }
 
   // TODO(#11849): consider replacing this oracle with a pure Noir implementation of aes decryption.
-  public override utilityAes128Decrypt(ciphertext: Buffer, iv: Buffer, symKey: Buffer): Promise<Buffer> {
+  public utilityAes128Decrypt(ciphertext: Buffer, iv: Buffer, symKey: Buffer): Promise<Buffer> {
     const aes128 = new Aes128();
     return aes128.decryptBufferCBC(ciphertext, iv, symKey);
   }
 
-  public override utilityGetSharedSecret(address: AztecAddress, ephPk: Point): Promise<Point> {
+  public utilityGetSharedSecret(address: AztecAddress, ephPk: Point): Promise<Point> {
     return this.executionDataProvider.getSharedSecret(address, ephPk);
   }
-
-  public override utilityEmitOffchainEffect(_data: Fr[]): Promise<void> {
-    return Promise.reject(new Error('Cannot emit offchain effects from a utility function'));
-  }
 }

package/src/contract_function_simulator/pick_notes.ts

@@ -1,4 +1,4 @@
-import { Fr } from '@aztec/foundation/fields';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { Comparator, type Note } from '@aztec/stdlib/note';
 
 export interface PropertySelector {