@aztec/pxe 0.0.1-commit.e3c1de76 → 0.0.1-commit.e588bc7e5

package/dest/contract_function_simulator/oracle/private_execution_oracle.js

@@ -6,11 +6,10 @@ import { toACVMWitness } from '@aztec/simulator/client';
 import { FunctionSelector, countArgumentsSize } from '@aztec/stdlib/abi';
 import { siloNullifier } from '@aztec/stdlib/hash';
 import { PrivateContextInputs } from '@aztec/stdlib/kernel';
-import { DirectionalAppTaggingSecret } from '@aztec/stdlib/logs';
+import { ExtendedDirectionalAppTaggingSecret } from '@aztec/stdlib/logs';
 import { Tag } from '@aztec/stdlib/logs';
 import { Note } from '@aztec/stdlib/note';
 import { CallContext, CountedContractClassLog, NoteAndSlot } from '@aztec/stdlib/tx';
-import { ensureContractSynced } from '../../contract_sync/index.js';
 import { NoteService } from '../../notes/note_service.js';
 import { syncSenderTaggingIndexes } from '../../tagging/index.js';
 import { pickNotes } from '../pick_notes.js';
@@ -19,10 +18,21 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
 /**
  * The execution oracle for the private part of a transaction.
  */ export class PrivateExecutionOracle extends UtilityExecutionOracle {
+    isPrivate = true;
+    /**
+   * New notes created during this execution.
+   * It's possible that a note in this list has been nullified (in the same or other executions) and doesn't exist in
+   * the ExecutionNoteCache and the final proof data. But we still include those notes in the execution result because
+   * their commitments are still in the public inputs of this execution.
+   * This information is only for references (currently used for tests), and is not used for any sort of constrains.
+   * Users can also use this to get a clearer idea of what's happened during a simulation.
+   */ newNotes = [];
+    noteHashNullifierCounterMap = new Map();
+    contractClassLogs = [];
+    nestedExecutionResults = [];
     argsHash;
     txContext;
     callContext;
-    anchorBlockHeader;
     utilityExecutor;
     executionCache;
     noteCache;
@@ -32,21 +42,24 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
     sideEffectCounter;
     senderForTags;
     simulator;
-    isPrivate;
-    /**
-   * New notes created during this execution.
-   * It's possible that a note in this list has been nullified (in the same or other executions) and doesn't exist in
-   * the ExecutionNoteCache and the final proof data. But we still include those notes in the execution result because
-   * their commitments are still in the public inputs of this execution.
-   * This information is only for references (currently used for tests), and is not used for any sort of constrains.
-   * Users can also use this to get a clearer idea of what's happened during a simulation.
-   */ newNotes;
-    noteHashNullifierCounterMap;
-    contractClassLogs;
-    offchainEffects;
-    nestedExecutionResults;
-    constructor(argsHash, txContext, callContext, /** Header of a block whose state is used during private execution (not the block the transaction is included in). */ anchorBlockHeader, /** Needed to trigger contract synchronization before nested calls */ utilityExecutor, /** List of transient auth witnesses to be used during this simulation */ authWitnesses, capsules, executionCache, noteCache, taggingIndexCache, contractStore, noteStore, keyStore, addressStore, aztecNode, senderTaggingStore, recipientTaggingStore, senderAddressBookStore, capsuleStore, privateEventStore, jobId, totalPublicCalldataCount = 0, sideEffectCounter = 0, log = createLogger('simulator:client_execution_context'), scopes, senderForTags, simulator){
-        super(callContext.contractAddress, authWitnesses, capsules, anchorBlockHeader, contractStore, noteStore, keyStore, addressStore, aztecNode, recipientTaggingStore, senderAddressBookStore, capsuleStore, privateEventStore, jobId, log, scopes), this.argsHash = argsHash, this.txContext = txContext, this.callContext = callContext, this.anchorBlockHeader = anchorBlockHeader, this.utilityExecutor = utilityExecutor, this.executionCache = executionCache, this.noteCache = noteCache, this.taggingIndexCache = taggingIndexCache, this.senderTaggingStore = senderTaggingStore, this.totalPublicCalldataCount = totalPublicCalldataCount, this.sideEffectCounter = sideEffectCounter, this.senderForTags = senderForTags, this.simulator = simulator, this.isPrivate = true, this.newNotes = [], this.noteHashNullifierCounterMap = new Map(), this.contractClassLogs = [], this.offchainEffects = [], this.nestedExecutionResults = [];
+    constructor(args){
+        super({
+            ...args,
+            contractAddress: args.callContext.contractAddress,
+            log: args.log ?? createLogger('simulator:client_execution_context')
+        });
+        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.totalPublicCalldataCount = args.totalPublicCalldataCount ?? 0;
+        this.sideEffectCounter = args.sideEffectCounter ?? 0;
+        this.senderForTags = args.senderForTags;
+        this.simulator = args.simulator;
     }
     getPrivateContextInputs() {
         return new PrivateContextInputs(this.callContext, this.anchorBlockHeader, this.txContext, this.sideEffectCounter);
@@ -87,14 +100,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.
@@ -110,7 +118,7 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
    *
    * The value persists through nested calls, meaning all calls down the stack will use the same
    * 'senderForTags' value (unless it is replaced).
-   */ privateGetSenderForTags() {
+   */ getSenderForTags() {
         return Promise.resolve(this.senderForTags);
     }
     /**
@@ -123,7 +131,7 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
    * 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) {
+   */ setSenderForTags(senderForTags) {
         this.senderForTags = senderForTags;
         return Promise.resolve();
     }
@@ -132,20 +140,29 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
    * @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 secret = await this.#calculateDirectionalAppTaggingSecret(this.contractAddress, sender, recipient);
-        const index = await this.#getIndexToUseForSecret(secret);
-        this.log.debug(`Incrementing tagging index for sender: ${sender}, recipient: ${recipient}, contract: ${this.contractAddress} to ${index}`);
-        this.taggingIndexCache.setLastUsedIndex(secret, index);
+   */ async getNextAppTagAsSender(sender, recipient) {
+        const extendedSecret = await this.#calculateExtendedDirectionalAppTaggingSecret(this.contractAddress, sender, recipient);
+        if (!extendedSecret) {
+            // We'd only fail to compute an extended secret if the recipient is an invalid address. To prevent
+            // king-of-the-hill attacks, instead of failing we use a random tag. By including a correct-looking tag in the
+            // log, the transaction shape is preserved and no privacy is leaked, even if the tag is bogus.
+            this.logger.warn(`Computing a tag for invalid recipient ${recipient} - returning a random tag instead`, {
+                contractAddress: this.contractAddress
+            });
+            return new Tag(Fr.random());
+        }
+        const index = await this.#getIndexToUseForSecret(extendedSecret);
+        this.logger.debug(`Incrementing tagging index for sender: ${sender}, recipient: ${recipient}, contract: ${this.contractAddress} to ${index}`);
+        this.taggingIndexCache.setLastUsedIndex(extendedSecret, index);
         return Tag.compute({
-            secret,
+            extendedSecret,
             index
         });
     }
-    async #calculateDirectionalAppTaggingSecret(contractAddress, sender, recipient) {
-        const senderCompleteAddress = await this.getCompleteAddress(sender);
+    async #calculateExtendedDirectionalAppTaggingSecret(contractAddress, sender, recipient) {
+        const senderCompleteAddress = await this.getCompleteAddressOrFail(sender);
         const senderIvsk = await this.keyStore.getMasterIncomingViewingSecretKey(sender);
-        return DirectionalAppTaggingSecret.compute(senderCompleteAddress, senderIvsk, recipient, contractAddress, recipient);
+        return ExtendedDirectionalAppTaggingSecret.compute(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.
@@ -156,7 +173,7 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
             // This is a tagging secret we've not yet used in this tx, so first sync our store to make sure its indices
             // are up to date. We do this here because this store is not synced as part of the global sync because
             // that'd be wasteful as most tagging secrets are not used in each tx.
-            await syncSenderTaggingIndexes(secret, this.contractAddress, this.aztecNode, this.senderTaggingStore, await this.anchorBlockHeader.hash(), this.jobId);
+            await syncSenderTaggingIndexes(secret, this.aztecNode, this.senderTaggingStore, await this.anchorBlockHeader.hash(), this.jobId);
             const lastUsedIndex = await this.senderTaggingStore.getLastUsedIndex(secret, this.jobId);
             // If lastUsedIndex is undefined, we've never used this secret, so start from 0
             // Otherwise, the next index to use is one past the last used index
@@ -167,29 +184,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.
@@ -211,7 +228,7 @@ 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) {
         // Nullified pending notes are already removed from the list.
         const pendingNotes = this.noteCache.getNotes(this.callContext.contractAddress, owner, storageSlot);
         const pendingNullifiers = this.noteCache.getNullifiers(this.callContext.contractAddress);
@@ -242,7 +259,7 @@ 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(', ')}`);
+        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 notes;
     }
     /**
@@ -255,8 +272,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,
@@ -287,7 +304,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);
@@ -298,19 +315,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);
@@ -321,10 +338,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) {
@@ -339,20 +356,50 @@ 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 ensureContractSynced(targetContractAddress, functionSelector, this.utilityExecutor, this.aztecNode, this.contractStore, this.anchorBlockHeader);
+        await this.contractSyncService.ensureContractSynced(targetContractAddress, functionSelector, this.utilityExecutor, this.anchorBlockHeader, this.jobId, this.scopes);
         const targetArtifact = await this.contractStore.getFunctionArtifactWithDebugMetadata(targetContractAddress, functionSelector);
         const derivedTxContext = this.txContext.clone();
         const derivedCallContext = await this.deriveCallContext(targetContractAddress, targetArtifact, isStaticCall);
-        const privateExecutionOracle = new PrivateExecutionOracle(argsHash, derivedTxContext, derivedCallContext, this.anchorBlockHeader, this.utilityExecutor, this.authWitnesses, this.capsules, this.executionCache, this.noteCache, this.taggingIndexCache, this.contractStore, this.noteStore, this.keyStore, this.addressStore, this.aztecNode, this.senderTaggingStore, this.recipientTaggingStore, this.senderAddressBookStore, this.capsuleStore, this.privateEventStore, this.jobId, this.totalPublicCalldataCount, sideEffectCounter, this.log, this.scopes, this.senderForTags, this.simulator);
+        const privateExecutionOracle = new PrivateExecutionOracle({
+            argsHash,
+            txContext: derivedTxContext,
+            callContext: derivedCallContext,
+            anchorBlockHeader: this.anchorBlockHeader,
+            utilityExecutor: this.utilityExecutor,
+            authWitnesses: this.authWitnesses,
+            capsules: this.capsules,
+            executionCache: this.executionCache,
+            noteCache: this.noteCache,
+            taggingIndexCache: this.taggingIndexCache,
+            contractStore: this.contractStore,
+            noteStore: this.noteStore,
+            keyStore: this.keyStore,
+            addressStore: this.addressStore,
+            aztecNode: this.aztecNode,
+            senderTaggingStore: this.senderTaggingStore,
+            recipientTaggingStore: this.recipientTaggingStore,
+            senderAddressBookStore: this.senderAddressBookStore,
+            capsuleService: this.capsuleService,
+            privateEventStore: this.privateEventStore,
+            messageContextService: this.messageContextService,
+            contractSyncService: this.contractSyncService,
+            jobId: this.jobId,
+            totalPublicCalldataCount: this.totalPublicCalldataCount,
+            sideEffectCounter,
+            log: this.logger,
+            scopes: this.scopes,
+            senderForTags: this.senderForTags,
+            simulator: this.simulator
+        });
         const setupTime = simulatorSetupTimer.ms();
         const childExecutionResult = await executePrivateFunction(this.simulator, privateExecutionOracle, targetArtifact, targetContractAddress, functionSelector);
         if (isStaticCall) {
@@ -369,7 +416,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');
@@ -378,31 +425,12 @@ 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();
-    }
-    privateNotifySetMinRevertibleSideEffectCounter(minRevertibleSideEffectCounter) {
+    notifyRevertiblePhaseStart(minRevertibleSideEffectCounter) {
         return this.noteCache.setMinRevertibleSideEffectCounter(minRevertibleSideEffectCounter);
     }
-    privateIsSideEffectCounterRevertible(sideEffectCounter) {
+    isExecutionInRevertiblePhase(sideEffectCounter) {
         return Promise.resolve(this.noteCache.isSideEffectCounterRevertible(sideEffectCounter));
     }
     /**
@@ -417,10 +445,4 @@ 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();
-    }
 }