@aztec/pxe 0.0.1-commit.b6e433891 → 0.0.1-commit.b8a057fa

package/dest/contract_function_simulator/oracle/private_execution_oracle.js

@@ -6,12 +6,13 @@ 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 { ExtendedDirectionalAppTaggingSecret } from '@aztec/stdlib/logs';
-import { Tag } from '@aztec/stdlib/logs';
+import { AppTaggingSecret, AppTaggingSecretKind, ContractClassLog, ContractClassLogFields } 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';
@@ -32,37 +33,32 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
     nestedExecutionResults = [];
     argsHash;
     txContext;
-    callContext;
-    utilityExecutor;
+    txRequestSalt;
     executionCache;
     noteCache;
     taggingIndexCache;
     senderTaggingStore;
     totalPublicCalldataCount;
-    sideEffectCounter;
-    senderForTags;
-    simulator;
+    initialSideEffectCounter;
+    /** Sender for tags passed in at oracle construction time. Returned by `getSenderForTags`. */ defaultSenderForTags;
     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.txRequestSalt = args.txRequestSalt;
         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;
+        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, this.txRequestSalt);
     }
     // 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
@@ -116,44 +112,154 @@ 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).
+   * Returns the wallet-supplied default sender for tags, or `None` if no default was provided.
    */ getSenderForTags() {
-        return Promise.resolve(this.senderForTags);
+        return Promise.resolve(this.defaultSenderForTags ? Option.some(this.defaultSenderForTags) : Option.none());
     }
     /**
-   * Set the sender for tags.
-   *
-   * 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.
-   *
-   * 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).
-   */ setSenderForTags(senderForTags) {
-        this.senderForTags = senderForTags;
-        return Promise.resolve();
+   * Resolves a custom, caller-defined request via the {@link ResolveCustomRequest} hook, which produces the response
+   * however it needs to. Throws when no hook is configured, since the request cannot be served.
+   */ async resolveCustomRequest(kind, payload) {
+        const hook = this.hooks?.resolveCustomRequest;
+        if (!hook) {
+            throw new Error('Cannot serve a request: no resolveCustomRequest hook is configured');
+        }
+        const contractClassId = await this.#getCurrentContractClassId(this.contractAddress);
+        return hook({
+            contractAddress: this.contractAddress,
+            contractClassId,
+            kind,
+            payload
+        });
+    }
+    /**
+   * Resolves the tagging strategy for a message via the wallet's {@link ResolveTaggingSecretStrategy} hook. The contract receives a ready-to-use {@link ResolvedTaggingStrategy}.
+   * When no hook is configured, applies a default: a non-interactive handshake, except for an unconstrained self-send,
+   * which uses an address-derived secret.
+   */ async resolveTaggingStrategy(sender, recipient, deliveryMode) {
+        const [isUnconstrainedSelfSend, chosenStrategy] = await Promise.all([
+            this.#isUnconstrainedSelfSend(recipient, deliveryMode),
+            this.#chooseTaggingSecretStrategy(sender, recipient, deliveryMode)
+        ]);
+        // For unconstrained delivery, a self-send uses a local address-derived secret instead of a non-interactive
+        // handshake. A self-send is one where the wallet controls the recipient's keys, so both sides' keys are local: no
+        // handshake is needed and nothing is revealed onchain. It also avoids a recursion: a handshake self-delivers its
+        // note via unconstrained delivery, which would establish yet another handshake. This guard runs regardless of the
+        // resolved strategy (hook or default), to protect wallets from invalid configuration.
+        const strategy = isUnconstrainedSelfSend ? {
+            type: 'address-derived'
+        } : chosenStrategy;
+        return this.#resolveTaggingSecretStrategy(strategy, sender, recipient);
+    }
+    async #chooseTaggingSecretStrategy(sender, recipient, deliveryMode) {
+        const hook = this.hooks?.resolveTaggingSecretStrategy;
+        if (!hook) {
+            // With no hook, both delivery modes default to a non-interactive handshake
+            return {
+                type: 'non-interactive-handshake'
+            };
+        }
+        const contractClassId = await this.#getCurrentContractClassId(this.contractAddress);
+        return hook({
+            contractAddress: this.contractAddress,
+            contractClassId,
+            sender,
+            recipient,
+            deliveryMode
+        });
+    }
+    /**
+   * Resolves the class id the given contract runs at this simulation's anchor block. The instance no longer carries
+   * its class id (it is chain-derived), so it is resolved via the anchored contract data instead.
+   */ async #getCurrentContractClassId(address) {
+        const classId = await this.anchoredContractData.getCurrentClassId(address);
+        if (classId === undefined) {
+            throw new Error(`Cannot resolve the current contract class for ${address}`);
+        }
+        return classId;
+    }
+    /** Whether this is an unconstrained delivery to one of the wallet's own accounts (a self-send). */ #isUnconstrainedSelfSend(recipient, deliveryMode) {
+        return deliveryMode === AppTaggingSecretKind.UNCONSTRAINED ? this.keyStore.hasAccount(recipient) : Promise.resolve(false);
+    }
+    /** Resolves a wallet-provided {@link TaggingSecretStrategy} into the app-siloed secret handed to the contract. */ async #resolveTaggingSecretStrategy(strategy, sender, recipient) {
+        // PXE only performs the derivation; it does not reject a strategy that is unsound for the delivery mode (e.g. an
+        // address-derived or arbitrary-secret strategy for constrained delivery). That soundness check belongs in the
+        // Noir circuit, which constrains the resolved strategy against the delivery mode.
+        switch(strategy.type){
+            case 'non-interactive-handshake':
+                return {
+                    type: 'non-interactive-handshake'
+                };
+            case 'interactive-handshake':
+                return {
+                    type: 'interactive-handshake'
+                };
+            case 'address-derived':
+                return this.#addressDerivedSecret(sender, recipient);
+            case 'arbitrary-secret':
+                {
+                    // App-silo the raw arbitrary secret point here so wallets never replicate the derivation.
+                    const appTaggingSecret = await AppTaggingSecret.computeDirectional(strategy.secret, this.contractAddress, recipient);
+                    return {
+                        type: 'unconstrained-secret',
+                        secret: appTaggingSecret.secret
+                    };
+                }
+        }
     }
     /**
-   * Returns the next app tag for a given sender and recipient pair.
+   * The app-siloed, recipient-directional secret derived from the sender's and recipient's address keys via ECDH,
+   * ready to hand to the contract. Callers must validate the recipient in-circuit before reaching here, so an invalid one is unexpected.
+   */ async #addressDerivedSecret(sender, recipient) {
+        const secret = await this.getAppTaggingSecret(sender, recipient);
+        if (!secret.isSome()) {
+            throw new Error(`Cannot derive an address-derived tagging secret for invalid recipient ${recipient}`);
+        }
+        return {
+            type: 'unconstrained-secret',
+            secret: secret.value
+        };
+    }
+    /**
+   * Returns the sender-side app tagging secret for a `(sender, recipient)` pair.
+   *
+   * 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.
+   *
    * @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 getNextAppTagAsSender(sender, recipient) {
-        const extendedSecret = await this.#calculateExtendedDirectionalAppTaggingSecret(this.contractAddress, sender, recipient);
-        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({
-            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();
+        }
+        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.computeViaEcdh(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.
@@ -175,21 +281,21 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
    * Store values in the execution cache.
    * @param values - Values to store.
    * @returns The hash of the values.
-   */ storeInExecutionCache(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.
-   */ loadFromExecutionCache(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 checkNullifierExists(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.
@@ -197,7 +303,7 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
             contractAddress: this.contractAddress
         });
         const nullifier = (await siloNullifier(this.contractAddress, innerNullifier)).toBigInt();
-        return this.noteCache.getNullifiers(this.contractAddress).has(nullifier) || await super.checkNullifierExists(innerNullifier);
+        return this.noteCache.getNullifiers(this.contractAddress).has(nullifier) || await super.doesNullifierExist(innerNullifier);
     }
     /**
    * Gets some notes for a storage slot.
@@ -219,12 +325,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 getNotes(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,
@@ -251,7 +357,11 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
             offset
         });
         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;
+        return BoundedVec.from({
+            data: notes,
+            maxLength: maxNotes,
+            elementSize: packedHintedNoteLength
+        });
     }
     /**
    * Keep track of the new note created during execution.
@@ -327,9 +437,14 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
    * Emit a contract class log.
    * This fn exists because we only carry a poseidon hash through the kernels, and need to
    * keep the preimage in ts for later.
-   * @param log - The contract class log to be emitted.
+   * @param logData - The contract class log to be emitted.
    * @param counter - The contract class log's counter.
-   */ notifyCreatedContractClassLog(log, counter) {
+   */ notifyCreatedContractClassLog(logData, counter) {
+        const log = ContractClassLog.from({
+            contractAddress: logData.contractAddress,
+            fields: new ContractClassLogFields(logData.fields),
+            emittedLength: logData.emittedLength
+        });
         this.contractClassLogs.push(new CountedContractClassLog(log, counter));
         const text = log.toBuffer().toString('hex');
         this.logger.verbose(`Emitted log from ContractClassRegistry: "${text.length > 100 ? text.slice(0, 100) + '...' : text}"`);
@@ -357,12 +472,16 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
         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);
+        const targetArtifact = await this.anchoredContractData.getFunctionArtifactWithDebugMetadata(targetContractAddress, functionSelector);
+        if (!targetArtifact) {
+            throw new Error(`Cannot call ${targetContractAddress}:${functionSelector}: the contract is not registered. ` + `Register it via wallet.registerContract(...).`);
+        }
         const derivedTxContext = this.txContext.clone();
         const derivedCallContext = await this.deriveCallContext(targetContractAddress, targetArtifact, isStaticCall);
         const privateExecutionOracle = new PrivateExecutionOracle({
             argsHash,
             txContext: derivedTxContext,
+            txRequestSalt: this.txRequestSalt,
             callContext: derivedCallContext,
             anchorBlockHeader: this.anchorBlockHeader,
             utilityExecutor: this.utilityExecutor,
@@ -371,28 +490,34 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
             executionCache: this.executionCache,
             noteCache: this.noteCache,
             taggingIndexCache: this.taggingIndexCache,
-            contractStore: this.contractStore,
+            anchoredContractData: this.anchoredContractData,
             noteStore: this.noteStore,
             keyStore: this.keyStore,
             addressStore: this.addressStore,
             aztecNode: this.aztecNode,
             senderTaggingStore: this.senderTaggingStore,
             recipientTaggingStore: this.recipientTaggingStore,
-            senderAddressBookStore: this.senderAddressBookStore,
-            capsuleStore: this.capsuleStore,
+            taggingSecretSourcesStore: this.taggingSecretSourcesStore,
+            capsuleService: this.capsuleService,
+            factService: this.factService,
             privateEventStore: this.privateEventStore,
-            messageContextService: this.messageContextService,
+            txResolver: this.txResolver,
             contractSyncService: this.contractSyncService,
             jobId: this.jobId,
             totalPublicCalldataCount: this.totalPublicCalldataCount,
             sideEffectCounter,
             log: this.logger,
             scopes: this.scopes,
-            senderForTags: this.senderForTags,
-            simulator: this.simulator
+            senderForTags: this.defaultSenderForTags,
+            simulator: this.simulator,
+            hooks: this.hooks,
+            l2TipsStore: this.l2TipsStore,
+            transientArrayService: this.transientArrayService
         });
         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);
         }
@@ -407,7 +532,7 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
             returnsHash: publicInputs.returnsHash
         };
     }
-    /** Validates the calldata preimage exists in the cache and checks cumulative calldata size is within limits. */ validatePublicCalldata(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');
@@ -418,10 +543,13 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
         }
         return Promise.resolve();
     }
+    getTotalPublicCalldataCount() {
+        return this.totalPublicCalldataCount;
+    }
     notifyRevertiblePhaseStart(minRevertibleSideEffectCounter) {
         return this.noteCache.setMinRevertibleSideEffectCounter(minRevertibleSideEffectCounter);
     }
-    inRevertiblePhase(sideEffectCounter) {
+    isExecutionInRevertiblePhase(sideEffectCounter) {
         return Promise.resolve(this.noteCache.isSideEffectCounterRevertible(sideEffectCounter));
     }
     /**
@@ -434,6 +562,9 @@ import { UtilityExecutionOracle } from './utility_execution_oracle.js';
         return new CallContext(this.contractAddress, targetContractAddress, await FunctionSelector.fromNameAndParameters(targetArtifact.name, targetArtifact.parameters), isStaticCall);
     }
     getDebugFunctionName() {
-        return this.contractStore.getDebugFunctionName(this.contractAddress, this.callContext.functionSelector);
+        return this.anchoredContractData.getDebugFunctionName(this.contractAddress, this.callContext.functionSelector);
+    }
+    get callerContext() {
+        return this.callContext.isStaticCall ? 'private view' : 'private';
     }
 }