@aztec/pxe 0.0.1-commit.181e2d196 → 0.0.1-commit.189eedb3

package/dest/contract_function_simulator/oracle/private_execution_oracle.js

@@ -4,14 +4,16 @@ import { createLogger } from '@aztec/foundation/log';
 import { Timer } from '@aztec/foundation/timer';
 import { toACVMWitness } from '@aztec/simulator/client';
 import { FunctionSelector, countArgumentsSize } from '@aztec/stdlib/abi';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
 import { siloNullifier } from '@aztec/stdlib/hash';
 import { PrivateContextInputs } from '@aztec/stdlib/kernel';
-import { ExtendedDirectionalAppTaggingSecret } from '@aztec/stdlib/logs';
-import { Tag } from '@aztec/stdlib/logs';
+import { AppTaggingSecret } from '@aztec/stdlib/logs';
 import { Note } from '@aztec/stdlib/note';
 import { CallContext, CountedContractClassLog, NoteAndSlot } from '@aztec/stdlib/tx';
 import { NoteService } from '../../notes/note_service.js';
 import { syncSenderTaggingIndexes } from '../../tagging/index.js';
+import { BoundedVec } from '../noir-structs/bounded_vec.js';
+import { Option } from '../noir-structs/option.js';
 import { pickNotes } from '../pick_notes.js';
 import { executePrivateFunction } from './private_execution.js';
 import { UtilityExecutionOracle } from './utility_execution_oracle.js';
@@ -29,21 +31,17 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
    */ newNotes = [];
     noteHashNullifierCounterMap = new Map();
     contractClassLogs = [];
-    offchainEffects = [];
     nestedExecutionResults = [];
     argsHash;
     txContext;
     callContext;
-    utilityExecutor;
     executionCache;
     noteCache;
     taggingIndexCache;
     senderTaggingStore;
-    contractSyncService;
     totalPublicCalldataCount;
-    sideEffectCounter;
-    senderForTags;
-    simulator;
+    initialSideEffectCounter;
+    /** Sender for tags passed in at oracle construction time. Returned by `getSenderForTags`. */ defaultSenderForTags;
     constructor(args){
         super({
             ...args,
@@ -53,19 +51,16 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
         this.argsHash = args.argsHash;
         this.txContext = args.txContext;
         this.callContext = args.callContext;
-        this.utilityExecutor = args.utilityExecutor;
         this.executionCache = args.executionCache;
         this.noteCache = args.noteCache;
         this.taggingIndexCache = args.taggingIndexCache;
         this.senderTaggingStore = args.senderTaggingStore;
-        this.contractSyncService = args.contractSyncService;
         this.totalPublicCalldataCount = args.totalPublicCalldataCount ?? 0;
-        this.sideEffectCounter = args.sideEffectCounter ?? 0;
-        this.senderForTags = args.senderForTags;
-        this.simulator = args.simulator;
+        this.initialSideEffectCounter = args.sideEffectCounter ?? 0;
+        this.defaultSenderForTags = args.senderForTags;
     }
     getPrivateContextInputs() {
-        return new PrivateContextInputs(this.callContext, this.anchorBlockHeader, this.txContext, this.sideEffectCounter);
+        return new PrivateContextInputs(this.callContext, this.anchorBlockHeader, this.txContext, this.initialSideEffectCounter);
     }
     // We still need this function until we can get user-defined ordering of structs for fn arguments
     // TODO When that is sorted out on noir side, we can use instead the utilities in serialize.ts
@@ -103,14 +98,9 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
         return this.contractClassLogs;
     }
     /**
-   * Return the offchain effects emitted during this execution.
-   */ getOffchainEffects() {
-        return this.offchainEffects;
-    }
-    /**
-   * Returns the pre-tags that were used in this execution (and that need to be stored in the db).
-   */ getUsedPreTags() {
-        return this.taggingIndexCache.getUsedPreTags();
+   * Returns the tagging index ranges that were used in this execution (and that need to be stored in the db).
+   */ getUsedTaggingIndexRanges() {
+        return this.taggingIndexCache.getUsedTaggingIndexRanges();
     }
     /**
    * Return the nested execution results during this execution.
@@ -124,44 +114,50 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
    * for a tag in order to emit a log. Constrained tagging should not use this as there is no
    * guarantee that the recipient knows about the sender, and hence about the shared secret.
    *
-   * The value persists through nested calls, meaning all calls down the stack will use the same
-   * 'senderForTags' value (unless it is replaced).
-   */ privateGetSenderForTags() {
-        return Promise.resolve(this.senderForTags);
+   * Returns the wallet-supplied default sender for tags, or `None` if no default was provided.
+   */ getSenderForTags() {
+        return Promise.resolve(this.defaultSenderForTags ? Option.some(this.defaultSenderForTags) : Option.none(AztecAddress.ZERO));
     }
     /**
-   * Set the sender for tags.
+   * Returns the sender-side app tagging secret for a `(sender, recipient)` pair.
    *
-   * This unconstrained value is used as the sender when computing an unconstrained shared secret
-   * for a tag in order to emit a log. Constrained tagging should not use this as there is no
-   * guarantee that the recipient knows about the sender, and hence about the shared secret.
+   * The caller obtains an index via {@link getNextTaggingIndex} and computes the final tag itself.
+   * The only expected `None` case is an invalid recipient address; missing sender data fails while deriving.
    *
-   * Account contracts typically set this value before calling other contracts. The value persists
-   * through nested calls, meaning all calls down the stack will use the same 'senderForTags'
-   * value (unless it is replaced by another call to this setter).
-   */ privateSetSenderForTags(senderForTags) {
-        this.senderForTags = senderForTags;
-        return Promise.resolve();
-    }
-    /**
-   * Returns the next app tag for a given sender and recipient pair.
    * @param sender - The address sending the log
    * @param recipient - The address receiving the log
-   * @returns An app tag to be used in a log.
-   */ async privateGetNextAppTagAsSender(sender, recipient) {
-        const extendedSecret = await this.#calculateExtendedDirectionalAppTaggingSecret(this.contractAddress, sender, recipient);
-        const index = await this.#getIndexToUseForSecret(extendedSecret);
-        this.log.debug(`Incrementing tagging index for sender: ${sender}, recipient: ${recipient}, contract: ${this.contractAddress} to ${index}`);
-        this.taggingIndexCache.setLastUsedIndex(extendedSecret, index);
-        return Tag.compute({
-            extendedSecret,
-            index
-        });
+   * @returns The app tagging secret, or `None` if the recipient is invalid.
+   */ async getAppTaggingSecret(sender, recipient) {
+        const extendedSecret = await this.#calculateAppTaggingSecret(this.contractAddress, sender, recipient);
+        if (!extendedSecret) {
+            this.logger.warn(`Computing a tagging secret for invalid recipient ${recipient} - returning no secret`, {
+                contractAddress: this.contractAddress
+            });
+            return Option.none(Fr.ZERO);
+        }
+        return Option.some(extendedSecret.secret);
     }
-    async #calculateExtendedDirectionalAppTaggingSecret(contractAddress, sender, recipient) {
+    /**
+   * Returns the next sender-side tagging index for a given secret and delivery mode.
+   *
+   * @param secret - The tagging secret to allocate an index for.
+   * @param kind - The sender-side index namespace.
+   * @returns The next index to use for this secret.
+   */ async getNextTaggingIndex(secret, kind) {
+        const appTaggingSecret = new AppTaggingSecret(secret, this.contractAddress, kind);
+        const index = await this.#reserveNextIndexForSecret(appTaggingSecret);
+        this.logger.debug(`Incrementing ${kind} tagging index for secret in contract ${this.contractAddress} to ${index}`);
+        return index;
+    }
+    /** Resolves the next index for a given tagging secret, syncing from chain if it is missing from the in-tx cache. */ async #reserveNextIndexForSecret(secret) {
+        const index = await this.#getIndexToUseForSecret(secret);
+        this.taggingIndexCache.setLastUsedIndex(secret, index);
+        return index;
+    }
+    async #calculateAppTaggingSecret(contractAddress, sender, recipient) {
         const senderCompleteAddress = await this.getCompleteAddressOrFail(sender);
         const senderIvsk = await this.keyStore.getMasterIncomingViewingSecretKey(sender);
-        return ExtendedDirectionalAppTaggingSecret.compute(senderCompleteAddress, senderIvsk, recipient, contractAddress, recipient);
+        return AppTaggingSecret.computeUnconstrained(senderCompleteAddress, senderIvsk, recipient, contractAddress, recipient);
     }
     async #getIndexToUseForSecret(secret) {
         // If we have the tagging index in the cache, we use it. If not we obtain it from the execution data provider.
@@ -183,29 +179,29 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
    * Store values in the execution cache.
    * @param values - Values to store.
    * @returns The hash of the values.
-   */ privateStoreInExecutionCache(values, hash) {
+   */ setHashPreimage(values, hash) {
         return this.executionCache.store(values, hash);
     }
     /**
    * Gets values from the execution cache.
    * @param hash - Hash of the values.
    * @returns The values.
-   */ privateLoadFromExecutionCache(hash) {
+   */ getHashPreimage(hash) {
         const preimage = this.executionCache.getPreimage(hash);
         if (!preimage) {
             throw new Error(`Preimage for hash ${hash.toString()} not found in cache`);
         }
         return Promise.resolve(preimage);
     }
-    async utilityCheckNullifierExists(innerNullifier) {
+    async doesNullifierExist(innerNullifier) {
         // This oracle must be overridden because while utility execution can only meaningfully check if a nullifier exists
         // in the synched block, during private execution there's also the possibility of it being pending, i.e. created
         // in the current transaction.
-        this.log.debug(`Checking existence of inner nullifier ${innerNullifier}`, {
+        this.logger.debug(`Checking existence of inner nullifier ${innerNullifier}`, {
             contractAddress: this.contractAddress
         });
         const nullifier = (await siloNullifier(this.contractAddress, innerNullifier)).toBigInt();
-        return this.noteCache.getNullifiers(this.contractAddress).has(nullifier) || await super.utilityCheckNullifierExists(innerNullifier);
+        return this.noteCache.getNullifiers(this.contractAddress).has(nullifier) || await super.doesNullifierExist(innerNullifier);
     }
     /**
    * Gets some notes for a storage slot.
@@ -227,12 +223,12 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
    * @param offset - The starting index for pagination.
    * @param status - The status of notes to fetch.
    * @returns Array of note data.
-   */ async utilityGetNotes(owner, storageSlot, numSelects, selectByIndexes, selectByOffsets, selectByLengths, selectValues, selectComparators, sortByIndexes, sortByOffsets, sortByLengths, sortOrder, limit, offset, status) {
+   */ async getNotes(owner, storageSlot, numSelects, selectByIndexes, selectByOffsets, selectByLengths, selectValues, selectComparators, sortByIndexes, sortByOffsets, sortByLengths, sortOrder, limit, offset, status, maxNotes, packedHintedNoteLength) {
         // Nullified pending notes are already removed from the list.
-        const pendingNotes = this.noteCache.getNotes(this.callContext.contractAddress, owner, storageSlot);
+        const pendingNotes = this.noteCache.getNotes(this.callContext.contractAddress, owner.value, storageSlot);
         const pendingNullifiers = this.noteCache.getNullifiers(this.callContext.contractAddress);
         const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockHeader, this.jobId);
-        const dbNotes = await noteService.getNotes(this.callContext.contractAddress, owner, storageSlot, status, this.scopes);
+        const dbNotes = await noteService.getNotes(this.callContext.contractAddress, owner.value, storageSlot, status, this.scopes);
         const dbNotesFiltered = dbNotes.filter((n)=>!pendingNullifiers.has(n.siloedNullifier.value));
         const notes = pickNotes([
             ...dbNotesFiltered,
@@ -258,8 +254,12 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
             limit,
             offset
         });
-        this.log.debug(`Returning ${notes.length} notes for ${this.callContext.contractAddress} at ${storageSlot}: ${notes.map((n)=>`${n.noteNonce.toString()}:[${n.note.items.map((i)=>i.toString()).join(',')}]`).join(', ')}`);
-        return notes;
+        this.logger.debug(`Returning ${notes.length} notes for ${this.callContext.contractAddress} at ${storageSlot}: ${notes.map((n)=>`${n.noteNonce.toString()}:[${n.note.items.map((i)=>i.toString()).join(',')}]`).join(', ')}`);
+        return BoundedVec.from({
+            data: notes,
+            maxLength: maxNotes,
+            elementSize: packedHintedNoteLength
+        });
     }
     /**
    * Keep track of the new note created during execution.
@@ -271,8 +271,8 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
    * @param noteItems - The items to be included in a Note.
    * @param noteHash - A hash of the new note.
    * @returns
-   */ privateNotifyCreatedNote(owner, storageSlot, randomness, noteTypeId, noteItems, noteHash, counter) {
-        this.log.debug(`Notified of new note with inner hash ${noteHash}`, {
+   */ notifyCreatedNote(owner, storageSlot, randomness, noteTypeId, noteItems, noteHash, counter) {
+        this.logger.debug(`Notified of new note with inner hash ${noteHash}`, {
             contractAddress: this.callContext.contractAddress,
             storageSlot,
             randomness,
@@ -303,7 +303,7 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
    * within the current transaction/execution.
    * @param innerNullifier - The pending nullifier to add in the list (not yet siloed by contract address).
    * @param noteHash - A hash of the new note.
-   */ async privateNotifyNullifiedNote(innerNullifier, noteHash, counter) {
+   */ async notifyNullifiedNote(innerNullifier, noteHash, counter) {
         const nullifiedNoteHashCounter = await this.noteCache.nullifyNote(this.callContext.contractAddress, innerNullifier, noteHash);
         if (nullifiedNoteHashCounter !== undefined) {
             this.noteHashNullifierCounterMap.set(nullifiedNoteHashCounter, counter);
@@ -314,19 +314,19 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
    * within the current transaction/execution.
    * @param innerNullifier - The pending nullifier to add in the list (not yet siloed by contract address).
    * @param noteHash - A hash of the new note.
-   */ privateNotifyCreatedNullifier(innerNullifier) {
-        this.log.debug(`Notified of new inner nullifier ${innerNullifier}`, {
+   */ notifyCreatedNullifier(innerNullifier) {
+        this.logger.debug(`Notified of new inner nullifier ${innerNullifier}`, {
             contractAddress: this.contractAddress
         });
         return this.noteCache.nullifierCreated(this.callContext.contractAddress, innerNullifier);
     }
     /**
-   * Check if a nullifier has been emitted in the same transaction, i.e. if privateNotifyCreatedNullifier has been
+   * Check if a nullifier has been emitted in the same transaction, i.e. if notifyCreatedNullifier has been
    * called for this inner nullifier from the contract with the specified address.
    * @param innerNullifier - The inner nullifier to check.
    * @param contractAddress - Address of the contract that emitted the nullifier.
    * @returns A boolean indicating whether the nullifier is pending or not.
-   */ async privateIsNullifierPending(innerNullifier, contractAddress) {
+   */ async isNullifierPending(innerNullifier, contractAddress) {
         const siloedNullifier = await siloNullifier(contractAddress, innerNullifier);
         const isNullifierPending = this.noteCache.getNullifiers(contractAddress).has(siloedNullifier.toBigInt());
         return Promise.resolve(isNullifierPending);
@@ -337,10 +337,10 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
    * keep the preimage in ts for later.
    * @param log - The contract class log to be emitted.
    * @param counter - The contract class log's counter.
-   */ privateNotifyCreatedContractClassLog(log, counter) {
+   */ notifyCreatedContractClassLog(log, counter) {
         this.contractClassLogs.push(new CountedContractClassLog(log, counter));
         const text = log.toBuffer().toString('hex');
-        this.log.verbose(`Emitted log from ContractClassRegistry: "${text.length > 100 ? text.slice(0, 100) + '...' : text}"`);
+        this.logger.verbose(`Emitted log from ContractClassRegistry: "${text.length > 100 ? text.slice(0, 100) + '...' : text}"`);
     }
     #checkValidStaticCall(childExecutionResult) {
         if (childExecutionResult.publicInputs.noteHashes.claimedLength > 0 || childExecutionResult.publicInputs.nullifiers.claimedLength > 0 || childExecutionResult.publicInputs.l2ToL1Msgs.claimedLength > 0 || childExecutionResult.publicInputs.privateLogs.claimedLength > 0 || childExecutionResult.publicInputs.contractClassLogsHashes.claimedLength > 0) {
@@ -355,14 +355,14 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
    * @param sideEffectCounter - The side effect counter at the start of the call.
    * @param isStaticCall - Whether the call is a static call.
    * @returns The execution result.
-   */ async privateCallPrivateFunction(targetContractAddress, functionSelector, argsHash, sideEffectCounter, isStaticCall) {
+   */ async callPrivateFunction(targetContractAddress, functionSelector, argsHash, sideEffectCounter, isStaticCall) {
         if (!this.simulator) {
             // In practice it is only when creating inline private contexts in a Noir test using TXE that we create an
             // instance of this class without a simulator.
             throw new Error('No simulator provided, cannot perform a nested private call');
         }
         const simulatorSetupTimer = new Timer();
-        this.log.debug(`Calling private function ${targetContractAddress}:${functionSelector} from ${this.callContext.contractAddress}`);
+        this.logger.debug(`Calling private function ${targetContractAddress}:${functionSelector} from ${this.callContext.contractAddress}`);
         isStaticCall = isStaticCall || this.callContext.isStaticCall;
         await this.contractSyncService.ensureContractSynced(targetContractAddress, functionSelector, this.utilityExecutor, this.anchorBlockHeader, this.jobId, this.scopes);
         const targetArtifact = await this.contractStore.getFunctionArtifactWithDebugMetadata(targetContractAddress, functionSelector);
@@ -387,19 +387,24 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
             senderTaggingStore: this.senderTaggingStore,
             recipientTaggingStore: this.recipientTaggingStore,
             senderAddressBookStore: this.senderAddressBookStore,
-            capsuleStore: this.capsuleStore,
+            capsuleService: this.capsuleService,
             privateEventStore: this.privateEventStore,
+            messageContextService: this.messageContextService,
             contractSyncService: this.contractSyncService,
             jobId: this.jobId,
             totalPublicCalldataCount: this.totalPublicCalldataCount,
             sideEffectCounter,
-            log: this.log,
+            log: this.logger,
             scopes: this.scopes,
-            senderForTags: this.senderForTags,
-            simulator: this.simulator
+            senderForTags: this.defaultSenderForTags,
+            simulator: this.simulator,
+            hooks: this.hooks,
+            l2TipsStore: this.l2TipsStore
         });
         const setupTime = simulatorSetupTimer.ms();
         const childExecutionResult = await executePrivateFunction(this.simulator, privateExecutionOracle, targetArtifact, targetContractAddress, functionSelector);
+        // Propagate the nested call's calldata count so the parent sees its increments on subsequent enqueues.
+        this.totalPublicCalldataCount = privateExecutionOracle.getTotalPublicCalldataCount();
         if (isStaticCall) {
             this.#checkValidStaticCall(childExecutionResult);
         }
@@ -414,7 +419,7 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
             returnsHash: publicInputs.returnsHash
         };
     }
-    #onNewPublicFunctionCall(calldataHash) {
+    /** Validates the calldata preimage exists in the cache and checks cumulative calldata size is within limits. */ assertValidPublicCalldata(calldataHash) {
         const calldata = this.executionCache.getPreimage(calldataHash);
         if (!calldata) {
             throw new Error('Calldata for public call not found in cache');
@@ -423,31 +428,15 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
         if (this.totalPublicCalldataCount > MAX_FR_CALLDATA_TO_ALL_ENQUEUED_CALLS) {
             throw new Error(`Too many total args to all enqueued public calls! (> ${MAX_FR_CALLDATA_TO_ALL_ENQUEUED_CALLS})`);
         }
-    }
-    /**
-   * Verify relevant information when a public function is enqueued.
-   * @param targetContractAddress - The address of the contract to call.
-   * @param calldataHash - The hash of the function selector and arguments.
-   * @param sideEffectCounter - The side effect counter at the start of the call.
-   * @param isStaticCall - Whether the call is a static call.
-   */ privateNotifyEnqueuedPublicFunctionCall(_targetContractAddress, calldataHash, _sideEffectCounter, _isStaticCall) {
-        this.#onNewPublicFunctionCall(calldataHash);
         return Promise.resolve();
     }
-    /**
-   * Verify relevant information when a public teardown function is set.
-   * @param targetContractAddress - The address of the contract to call.
-   * @param argsHash - The arguments hash to pass to the function.
-   * @param sideEffectCounter - The side effect counter at the start of the call.
-   * @param isStaticCall - Whether the call is a static call.
-   */ privateNotifySetPublicTeardownFunctionCall(_targetContractAddress, calldataHash, _sideEffectCounter, _isStaticCall) {
-        this.#onNewPublicFunctionCall(calldataHash);
-        return Promise.resolve();
+    getTotalPublicCalldataCount() {
+        return this.totalPublicCalldataCount;
     }
-    privateNotifySetMinRevertibleSideEffectCounter(minRevertibleSideEffectCounter) {
+    notifyRevertiblePhaseStart(minRevertibleSideEffectCounter) {
         return this.noteCache.setMinRevertibleSideEffectCounter(minRevertibleSideEffectCounter);
     }
-    privateIsSideEffectCounterRevertible(sideEffectCounter) {
+    isExecutionInRevertiblePhase(sideEffectCounter) {
         return Promise.resolve(this.noteCache.isSideEffectCounterRevertible(sideEffectCounter));
     }
     /**
@@ -462,10 +451,7 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
     getDebugFunctionName() {
         return this.contractStore.getDebugFunctionName(this.contractAddress, this.callContext.functionSelector);
     }
-    utilityEmitOffchainEffect(data) {
-        this.offchainEffects.push({
-            data
-        });
-        return Promise.resolve();
+    get callerContext() {
+        return this.callContext.isStaticCall ? 'private view' : 'private';
     }
 }