@aztec/pxe 0.0.1-commit.e558bd1c → 0.0.1-commit.e5a3663dd

package/dest/contract_function_simulator/oracle/oracle.js

@@ -6,6 +6,8 @@ import { FunctionSelector, NoteSelector } from '@aztec/stdlib/abi';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
 import { BlockHash } from '@aztec/stdlib/block';
 import { ContractClassLog, ContractClassLogFields } from '@aztec/stdlib/logs';
+import { ORACLE_VERSION_MAJOR, ORACLE_VERSION_MINOR } from '../../oracle_version.js';
+import { buildLegacyOracleCallbacks } from './legacy_oracle_mappings.js';
 import { packAsHintedNote } from './note_packing_utils.js';
 export class UnavailableOracleError extends Error {
     constructor(oracleName){
@@ -14,6 +16,25 @@ export class UnavailableOracleError extends Error {
 }
 /**
  * A data source that has all the apis required by Aztec.nr.
+ *
+ * ## Oracle naming conventions
+ *
+ * We try to keep oracle naming consistent, please see below the conventions we adhere to.
+ *
+ * Each oracle method name has the form `aztec_{scope}_{verb}{Object}`, where:
+ *
+ * - **Scope prefix** indicates the execution context required:
+ *   - `aztec_prv_` — available only during private function execution.
+ *   - `aztec_utl_` — available during both utility and private execution.
+ *
+ * - **Verb** signals the operation's semantics (verb-first, then object):
+ *   - `get`              — read / lookup / get data from oracle into contract.
+ *   - `does`/`is`/`has`  — predicate (returns boolean).
+ *   - `emit`/`notify`    — propagate data from contract to oracle.
+ *   - `set`              — contract driven oracle state mutation (capsules, execution cache, tagging, etc).
+ *   - `call`             — trigger nested execution (control flow).
+ *   - `assert`           — validate a condition, throw on failure.
+ *   - Standalone verbs (`delete`, `copy`, `decrypt`, `log`, etc) are used when no generic verb fits.
  */ export class Oracle {
     handler;
     constructor(handler){
@@ -48,11 +69,11 @@ export class UnavailableOracleError extends Error {
         ];
         // Get all the oracle function names
         const oracleNames = Object.getOwnPropertyNames(Oracle.prototype).filter((name)=>!excludedProps.includes(name));
-        // Validate oracle names - these must be prefixed with either "private" or "utility" to indicate their scope
+        // Validate oracle names - these must be prefixed with either "aztec_prv_" or "aztec_utl_" to indicate their scope
         // and must correspond to a function on the Oracle class.
         oracleNames.forEach((name)=>{
-            if (!name.startsWith('private') && !name.startsWith('utility')) {
-                throw new Error(`Oracle function "${name}" must be prefixed with either "private" or "utility" to indicate its scope`);
+            if (!name.startsWith('aztec_prv_') && !name.startsWith('aztec_utl_')) {
+                throw new Error(`Oracle function "${name}" must be prefixed with either "aztec_prv_" or "aztec_utl_" to indicate its scope`);
             }
             const method = this[name];
             if (typeof method !== 'function') {
@@ -60,42 +81,78 @@ export class UnavailableOracleError extends Error {
             }
         });
         // Build callback object and return it
-        return oracleNames.reduce((acc, name)=>{
+        const callback = oracleNames.reduce((acc, name)=>{
             const method = this[name];
             acc[name] = method.bind(this);
             return acc;
         }, {});
+        const allCallbacks = {
+            ...callback,
+            ...buildLegacyOracleCallbacks(this)
+        };
+        // Wrap in a Proxy to intercept access to missing oracle names and provide enhanced error messages when the
+        // contract's minor version is higher than the PXE's (i.e. the contract expects oracles that were added in a newer
+        // minor version).
+        const handler = this.handler;
+        return new Proxy(allCallbacks, {
+            get (target, prop) {
+                if (prop in target) {
+                    return target[prop];
+                }
+                // Return a function that throws with an enhanced error message if applicable
+                return ()=>{
+                    let contractVersion = undefined;
+                    if ('nonOracleFunctionGetContractOracleVersion' in handler) {
+                        contractVersion = handler.nonOracleFunctionGetContractOracleVersion();
+                    }
+                    if (!contractVersion) {
+                        throw new Error(`Oracle '${prop}' not found and the contract's oracle version is unknown (the version check oracle ` + `was not called before '${prop}'). This usually means the contract was not compiled with the ` + `#[aztec] macro, which injects the version check as the first oracle call in every private/utility ` + `external function. If you're using a custom entry point, ensure assert_compatible_oracle_version() ` + `is called before any other oracle calls. See https://docs.aztec.network/errors/8`);
+                    } else if (contractVersion.minor > ORACLE_VERSION_MINOR) {
+                        throw new Error(`Oracle '${prop}' not found.` + ` This usually means the contract requires a newer private execution environment than you have.` + ` Upgrade your private execution environment to a compatible version. The contract was compiled with` + ` Aztec.nr oracle version ${contractVersion.major}.${contractVersion.minor}, but this private` + ` execution environment only supports up to ${ORACLE_VERSION_MAJOR}.${ORACLE_VERSION_MINOR}.` + ` See https://docs.aztec.network/errors/8`);
+                    } else {
+                        throw new Error(`Oracle '${prop}' not found.` + ` The contract's oracle version (${contractVersion.major}.${contractVersion.minor}) is compatible` + ` with this private execution environment (${ORACLE_VERSION_MAJOR}.${ORACLE_VERSION_MINOR}), so all` + ` standard oracles should be available. This could mean the contract was compiled against a modified` + ` version of Aztec.nr, or that it references an oracle that does not exist.` + ` See https://docs.aztec.network/errors/8`);
+                    }
+                };
+            }
+        });
     }
-    utilityAssertCompatibleOracleVersion([version]) {
-        this.handlerAsMisc().utilityAssertCompatibleOracleVersion(Fr.fromString(version).toNumber());
+    // eslint-disable-next-line camelcase
+    aztec_utl_assertCompatibleOracleVersionV2([major], [minor]) {
+        this.handlerAsMisc().assertCompatibleOracleVersion(Fr.fromString(major).toNumber(), Fr.fromString(minor).toNumber());
         return Promise.resolve([]);
     }
-    utilityGetRandomField() {
-        const val = this.handlerAsMisc().utilityGetRandomField();
+    // eslint-disable-next-line camelcase
+    aztec_utl_getRandomField() {
+        const val = this.handlerAsMisc().getRandomField();
         return Promise.resolve([
             toACVMField(val)
         ]);
     }
-    privateStoreInExecutionCache(values, [hash]) {
-        this.handlerAsPrivate().privateStoreInExecutionCache(values.map(Fr.fromString), Fr.fromString(hash));
+    // eslint-disable-next-line camelcase
+    aztec_prv_setHashPreimage(values, [hash]) {
+        this.handlerAsPrivate().setHashPreimage(values.map(Fr.fromString), Fr.fromString(hash));
         return Promise.resolve([]);
     }
-    async privateLoadFromExecutionCache([returnsHash]) {
-        const values = await this.handlerAsPrivate().privateLoadFromExecutionCache(Fr.fromString(returnsHash));
+    // eslint-disable-next-line camelcase
+    async aztec_prv_getHashPreimage([returnsHash]) {
+        const values = await this.handlerAsPrivate().getHashPreimage(Fr.fromString(returnsHash));
         return [
             values.map(toACVMField)
         ];
     }
-    utilityGetUtilityContext() {
-        const context = this.handlerAsUtility().utilityGetUtilityContext();
+    // eslint-disable-next-line camelcase
+    aztec_utl_getUtilityContext() {
+        const context = this.handlerAsUtility().getUtilityContext();
         return Promise.resolve(context.toNoirRepresentation());
     }
-    async utilityGetKeyValidationRequest([pkMHash]) {
-        const keyValidationRequest = await this.handlerAsUtility().utilityGetKeyValidationRequest(Fr.fromString(pkMHash));
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getKeyValidationRequest([pkMHash]) {
+        const keyValidationRequest = await this.handlerAsUtility().getKeyValidationRequest(Fr.fromString(pkMHash));
         return keyValidationRequest.toFields().map(toACVMField);
     }
-    async utilityGetContractInstance([address]) {
-        const instance = await this.handlerAsUtility().utilityGetContractInstance(AztecAddress.fromField(Fr.fromString(address)));
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getContractInstance([address]) {
+        const instance = await this.handlerAsUtility().getContractInstance(AztecAddress.fromField(Fr.fromString(address)));
         return [
             instance.salt,
             instance.deployer,
@@ -104,62 +161,69 @@ export class UnavailableOracleError extends Error {
             ...instance.publicKeys.toFields()
         ].map(toACVMField);
     }
-    async utilityGetNoteHashMembershipWitness([anchorBlockHash], [noteHash]) {
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getNoteHashMembershipWitness([anchorBlockHash], [noteHash]) {
         const parsedAnchorBlockHash = BlockHash.fromString(anchorBlockHash);
         const parsedNoteHash = Fr.fromString(noteHash);
-        const witness = await this.handlerAsUtility().utilityGetNoteHashMembershipWitness(parsedAnchorBlockHash, parsedNoteHash);
+        const witness = await this.handlerAsUtility().getNoteHashMembershipWitness(parsedAnchorBlockHash, parsedNoteHash);
         if (!witness) {
             throw new Error(`Note hash ${noteHash} not found in the note hash tree at anchor block hash ${parsedAnchorBlockHash.toString()}.`);
         }
         return witness.toNoirRepresentation();
     }
-    async utilityGetBlockHashMembershipWitness([anchorBlockHash], [blockHash]) {
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getBlockHashMembershipWitness([anchorBlockHash], [blockHash]) {
         const parsedAnchorBlockHash = BlockHash.fromString(anchorBlockHash);
         const parsedBlockHash = BlockHash.fromString(blockHash);
-        const witness = await this.handlerAsUtility().utilityGetBlockHashMembershipWitness(parsedAnchorBlockHash, parsedBlockHash);
+        const witness = await this.handlerAsUtility().getBlockHashMembershipWitness(parsedAnchorBlockHash, parsedBlockHash);
         if (!witness) {
             throw new Error(`Block hash ${parsedBlockHash.toString()} not found in the archive tree at anchor block ${parsedAnchorBlockHash.toString()}.`);
         }
         return witness.toNoirRepresentation();
     }
-    async utilityGetNullifierMembershipWitness([blockHash], [nullifier]) {
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getNullifierMembershipWitness([blockHash], [nullifier]) {
         const parsedBlockHash = BlockHash.fromString(blockHash);
         const parsedNullifier = Fr.fromString(nullifier);
-        const witness = await this.handlerAsUtility().utilityGetNullifierMembershipWitness(parsedBlockHash, parsedNullifier);
+        const witness = await this.handlerAsUtility().getNullifierMembershipWitness(parsedBlockHash, parsedNullifier);
         if (!witness) {
             throw new Error(`Nullifier witness not found for nullifier ${parsedNullifier} at block hash ${parsedBlockHash.toString()}.`);
         }
         return witness.toNoirRepresentation();
     }
-    async utilityGetLowNullifierMembershipWitness([blockHash], [nullifier]) {
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getLowNullifierMembershipWitness([blockHash], [nullifier]) {
         const parsedBlockHash = BlockHash.fromString(blockHash);
         const parsedNullifier = Fr.fromString(nullifier);
-        const witness = await this.handlerAsUtility().utilityGetLowNullifierMembershipWitness(parsedBlockHash, parsedNullifier);
+        const witness = await this.handlerAsUtility().getLowNullifierMembershipWitness(parsedBlockHash, parsedNullifier);
         if (!witness) {
             throw new Error(`Low nullifier witness not found for nullifier ${parsedNullifier} at block hash ${parsedBlockHash.toString()}.`);
         }
         return witness.toNoirRepresentation();
     }
-    async utilityGetPublicDataWitness([blockHash], [leafSlot]) {
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getPublicDataWitness([blockHash], [leafSlot]) {
         const parsedBlockHash = BlockHash.fromString(blockHash);
         const parsedLeafSlot = Fr.fromString(leafSlot);
-        const witness = await this.handlerAsUtility().utilityGetPublicDataWitness(parsedBlockHash, parsedLeafSlot);
+        const witness = await this.handlerAsUtility().getPublicDataWitness(parsedBlockHash, parsedLeafSlot);
         if (!witness) {
             throw new Error(`Public data witness not found for slot ${parsedLeafSlot} at block hash ${parsedBlockHash.toString()}.`);
         }
         return witness.toNoirRepresentation();
     }
-    async utilityGetBlockHeader([blockNumber]) {
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getBlockHeader([blockNumber]) {
         const parsedBlockNumber = Fr.fromString(blockNumber).toNumber();
-        const header = await this.handlerAsUtility().utilityGetBlockHeader(BlockNumber(parsedBlockNumber));
+        const header = await this.handlerAsUtility().getBlockHeader(BlockNumber(parsedBlockNumber));
         if (!header) {
             throw new Error(`Block header not found for block ${parsedBlockNumber}.`);
         }
         return header.toFields().map(toACVMField);
     }
-    async utilityGetAuthWitness([messageHash]) {
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getAuthWitness([messageHash]) {
         const messageHashField = Fr.fromString(messageHash);
-        const witness = await this.handlerAsUtility().utilityGetAuthWitness(messageHashField);
+        const witness = await this.handlerAsUtility().getAuthWitness(messageHashField);
         if (!witness) {
             throw new Error(`Unknown auth witness for message hash ${messageHashField}`);
         }
@@ -167,9 +231,10 @@ export class UnavailableOracleError extends Error {
             witness.map(toACVMField)
         ];
     }
-    async utilityTryGetPublicKeysAndPartialAddress([address]) {
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getPublicKeysAndPartialAddress([address]) {
         const parsedAddress = AztecAddress.fromField(Fr.fromString(address));
-        const result = await this.handlerAsUtility().utilityTryGetPublicKeysAndPartialAddress(parsedAddress);
+        const result = await this.handlerAsUtility().getPublicKeysAndPartialAddress(parsedAddress);
         // We are going to return a Noir Option struct to represent the possibility of null values. Options are a struct
         // with two fields: `some` (a boolean) and `value` (a field array in this case).
         if (result === undefined) {
@@ -189,10 +254,11 @@ export class UnavailableOracleError extends Error {
             ];
         }
     }
-    async utilityGetNotes([ownerSome], [ownerValue], [storageSlot], [numSelects], selectByIndexes, selectByOffsets, selectByLengths, selectValues, selectComparators, sortByIndexes, sortByOffsets, sortByLengths, sortOrder, [limit], [offset], [status], [maxNotes], [packedHintedNoteLength]) {
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getNotes([ownerSome], [ownerValue], [storageSlot], [numSelects], selectByIndexes, selectByOffsets, selectByLengths, selectValues, selectComparators, sortByIndexes, sortByOffsets, sortByLengths, sortOrder, [limit], [offset], [status], [maxNotes], [packedHintedNoteLength]) {
         // Parse Option<AztecAddress>: ownerSome is 0 for None, 1 for Some
         const owner = Fr.fromString(ownerSome).toNumber() === 1 ? AztecAddress.fromString(ownerValue) : undefined;
-        const noteDatas = await this.handlerAsUtility().utilityGetNotes(owner, Fr.fromString(storageSlot), +numSelects, selectByIndexes.map((s)=>+s), selectByOffsets.map((s)=>+s), selectByLengths.map((s)=>+s), selectValues.map(Fr.fromString), selectComparators.map((s)=>+s), sortByIndexes.map((s)=>+s), sortByOffsets.map((s)=>+s), sortByLengths.map((s)=>+s), sortOrder.map((s)=>+s), +limit, +offset, +status);
+        const noteDatas = await this.handlerAsUtility().getNotes(owner, Fr.fromString(storageSlot), +numSelects, selectByIndexes.map((s)=>+s), selectByOffsets.map((s)=>+s), selectByLengths.map((s)=>+s), selectValues.map(Fr.fromString), selectComparators.map((s)=>+s), sortByIndexes.map((s)=>+s), sortByOffsets.map((s)=>+s), sortByLengths.map((s)=>+s), sortOrder.map((s)=>+s), +limit, +offset, +status);
         const returnDataAsArrayOfPackedHintedNotes = noteDatas.map((noteData)=>packAsHintedNote({
                 contractAddress: noteData.contractAddress,
                 owner: noteData.owner,
@@ -207,57 +273,74 @@ export class UnavailableOracleError extends Error {
         // At last we convert the array of arrays to a bounded vec of arrays
         return arrayOfArraysToBoundedVecOfArrays(returnDataAsArrayOfACVMFieldArrays, +maxNotes, +packedHintedNoteLength);
     }
-    privateNotifyCreatedNote([owner], [storageSlot], [randomness], [noteTypeId], note, [noteHash], [counter]) {
-        this.handlerAsPrivate().privateNotifyCreatedNote(AztecAddress.fromString(owner), Fr.fromString(storageSlot), Fr.fromString(randomness), NoteSelector.fromField(Fr.fromString(noteTypeId)), note.map(Fr.fromString), Fr.fromString(noteHash), +counter);
+    // eslint-disable-next-line camelcase
+    aztec_prv_notifyCreatedNote([owner], [storageSlot], [randomness], [noteTypeId], note, [noteHash], [counter]) {
+        this.handlerAsPrivate().notifyCreatedNote(AztecAddress.fromString(owner), Fr.fromString(storageSlot), Fr.fromString(randomness), NoteSelector.fromField(Fr.fromString(noteTypeId)), note.map(Fr.fromString), Fr.fromString(noteHash), +counter);
         return Promise.resolve([]);
     }
-    async privateNotifyNullifiedNote([innerNullifier], [noteHash], [counter]) {
-        await this.handlerAsPrivate().privateNotifyNullifiedNote(Fr.fromString(innerNullifier), Fr.fromString(noteHash), +counter);
+    // eslint-disable-next-line camelcase
+    async aztec_prv_notifyNullifiedNote([innerNullifier], [noteHash], [counter]) {
+        await this.handlerAsPrivate().notifyNullifiedNote(Fr.fromString(innerNullifier), Fr.fromString(noteHash), +counter);
         return [];
     }
-    async privateNotifyCreatedNullifier([innerNullifier]) {
-        await this.handlerAsPrivate().privateNotifyCreatedNullifier(Fr.fromString(innerNullifier));
+    // eslint-disable-next-line camelcase
+    async aztec_prv_notifyCreatedNullifier([innerNullifier]) {
+        await this.handlerAsPrivate().notifyCreatedNullifier(Fr.fromString(innerNullifier));
         return [];
     }
-    async privateIsNullifierPending([innerNullifier], [contractAddress]) {
-        const isPending = await this.handlerAsPrivate().privateIsNullifierPending(Fr.fromString(innerNullifier), AztecAddress.fromString(contractAddress));
+    // eslint-disable-next-line camelcase
+    async aztec_prv_isNullifierPending([innerNullifier], [contractAddress]) {
+        const isPending = await this.handlerAsPrivate().isNullifierPending(Fr.fromString(innerNullifier), AztecAddress.fromString(contractAddress));
         return [
             toACVMField(isPending)
         ];
     }
-    async utilityCheckNullifierExists([innerNullifier]) {
-        const exists = await this.handlerAsUtility().utilityCheckNullifierExists(Fr.fromString(innerNullifier));
+    // eslint-disable-next-line camelcase
+    async aztec_utl_doesNullifierExist([innerNullifier]) {
+        const exists = await this.handlerAsUtility().doesNullifierExist(Fr.fromString(innerNullifier));
         return [
             toACVMField(exists)
         ];
     }
-    async utilityGetL1ToL2MembershipWitness([contractAddress], [messageHash], [secret]) {
-        const message = await this.handlerAsUtility().utilityGetL1ToL2MembershipWitness(AztecAddress.fromString(contractAddress), Fr.fromString(messageHash), Fr.fromString(secret));
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getL1ToL2MembershipWitness([contractAddress], [messageHash], [secret]) {
+        const message = await this.handlerAsUtility().getL1ToL2MembershipWitness(AztecAddress.fromString(contractAddress), Fr.fromString(messageHash), Fr.fromString(secret));
         return message.toNoirRepresentation();
     }
-    async utilityStorageRead([blockHash], [contractAddress], [startStorageSlot], [numberOfElements]) {
-        const values = await this.handlerAsUtility().utilityStorageRead(BlockHash.fromString(blockHash), new AztecAddress(Fr.fromString(contractAddress)), Fr.fromString(startStorageSlot), +numberOfElements);
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getFromPublicStorage([blockHash], [contractAddress], [startStorageSlot], [numberOfElements]) {
+        const values = await this.handlerAsUtility().getFromPublicStorage(BlockHash.fromString(blockHash), new AztecAddress(Fr.fromString(contractAddress)), Fr.fromString(startStorageSlot), +numberOfElements);
         return [
             values.map(toACVMField)
         ];
     }
-    privateNotifyCreatedContractClassLog([contractAddress], message, [length], [counter]) {
+    // eslint-disable-next-line camelcase
+    async aztec_utl_callUtilityFunction([contractAddress], [functionSelector], args) {
+        const result = await this.handlerAsUtility().callUtilityFunction(AztecAddress.fromField(Fr.fromString(contractAddress)), FunctionSelector.fromField(Fr.fromString(functionSelector)), args.map(Fr.fromString));
+        return [
+            result.map(toACVMField)
+        ];
+    }
+    // eslint-disable-next-line camelcase
+    aztec_prv_notifyCreatedContractClassLog([contractAddress], message, [length], [counter]) {
         const logFields = new ContractClassLogFields(message.map(Fr.fromString));
         const log = new ContractClassLog(new AztecAddress(Fr.fromString(contractAddress)), logFields, +length);
-        this.handlerAsPrivate().privateNotifyCreatedContractClassLog(log, +counter);
+        this.handlerAsPrivate().notifyCreatedContractClassLog(log, +counter);
         return Promise.resolve([]);
     }
-    utilityDebugLog(level, message, _ignoredFieldsSize, fields) {
+    // eslint-disable-next-line camelcase
+    async aztec_utl_log(level, message, _ignoredFieldsSize, fields) {
         const levelFr = Fr.fromString(level[0]);
         const messageStr = message.map((acvmField)=>String.fromCharCode(Fr.fromString(acvmField).toNumber())).join('');
         const fieldsFr = fields.map(Fr.fromString);
-        this.handlerAsMisc().utilityDebugLog(levelFr.toNumber(), messageStr, fieldsFr);
-        return Promise.resolve([]);
+        await this.handlerAsMisc().log(levelFr.toNumber(), messageStr, fieldsFr);
+        return [];
     }
     // This function's name is directly hardcoded in `circuit_recorder.ts`. Don't forget to update it there if you
     // change the name here.
-    async privateCallPrivateFunction([contractAddress], [functionSelector], [argsHash], [sideEffectCounter], [isStaticCall]) {
-        const { endSideEffectCounter, returnsHash } = await this.handlerAsPrivate().privateCallPrivateFunction(AztecAddress.fromField(Fr.fromString(contractAddress)), FunctionSelector.fromField(Fr.fromString(functionSelector)), Fr.fromString(argsHash), Fr.fromString(sideEffectCounter).toNumber(), Fr.fromString(isStaticCall).toBool());
+    // eslint-disable-next-line camelcase
+    async aztec_prv_callPrivateFunction([contractAddress], [functionSelector], [argsHash], [sideEffectCounter], [isStaticCall]) {
+        const { endSideEffectCounter, returnsHash } = await this.handlerAsPrivate().callPrivateFunction(AztecAddress.fromField(Fr.fromString(contractAddress)), FunctionSelector.fromField(Fr.fromString(functionSelector)), Fr.fromString(argsHash), Fr.fromString(sideEffectCounter).toNumber(), Fr.fromString(isStaticCall).toBool());
         return [
             [
                 endSideEffectCounter,
@@ -265,48 +348,84 @@ export class UnavailableOracleError extends Error {
             ].map(toACVMField)
         ];
     }
-    async privateNotifyEnqueuedPublicFunctionCall([contractAddress], [calldataHash], [sideEffectCounter], [isStaticCall]) {
-        await this.handlerAsPrivate().privateNotifyEnqueuedPublicFunctionCall(AztecAddress.fromString(contractAddress), Fr.fromString(calldataHash), Fr.fromString(sideEffectCounter).toNumber(), Fr.fromString(isStaticCall).toBool());
+    // eslint-disable-next-line camelcase
+    async aztec_prv_assertValidPublicCalldata([calldataHash]) {
+        await this.handlerAsPrivate().assertValidPublicCalldata(Fr.fromString(calldataHash));
         return [];
     }
-    async privateNotifySetPublicTeardownFunctionCall([contractAddress], [calldataHash], [sideEffectCounter], [isStaticCall]) {
-        await this.handlerAsPrivate().privateNotifySetPublicTeardownFunctionCall(AztecAddress.fromString(contractAddress), Fr.fromString(calldataHash), Fr.fromString(sideEffectCounter).toNumber(), Fr.fromString(isStaticCall).toBool());
-        return [];
-    }
-    async privateNotifySetMinRevertibleSideEffectCounter([minRevertibleSideEffectCounter]) {
-        await this.handlerAsPrivate().privateNotifySetMinRevertibleSideEffectCounter(Fr.fromString(minRevertibleSideEffectCounter).toNumber());
+    // eslint-disable-next-line camelcase
+    async aztec_prv_notifyRevertiblePhaseStart([minRevertibleSideEffectCounter]) {
+        await this.handlerAsPrivate().notifyRevertiblePhaseStart(Fr.fromString(minRevertibleSideEffectCounter).toNumber());
         return Promise.resolve([]);
     }
-    async privateIsSideEffectCounterRevertible([sideEffectCounter]) {
-        const isRevertible = await this.handlerAsPrivate().privateIsSideEffectCounterRevertible(Fr.fromString(sideEffectCounter).toNumber());
+    // eslint-disable-next-line camelcase
+    async aztec_prv_isExecutionInRevertiblePhase([sideEffectCounter]) {
+        const isRevertible = await this.handlerAsPrivate().isExecutionInRevertiblePhase(Fr.fromString(sideEffectCounter).toNumber());
         return Promise.resolve([
             toACVMField(isRevertible)
         ]);
     }
-    async privateGetNextAppTagAsSender([sender], [recipient]) {
-        const tag = await this.handlerAsPrivate().privateGetNextAppTagAsSender(AztecAddress.fromString(sender), AztecAddress.fromString(recipient));
+    // eslint-disable-next-line camelcase
+    async aztec_prv_getNextAppTagAsSender([sender], [recipient]) {
+        const tag = await this.handlerAsPrivate().getNextAppTagAsSender(AztecAddress.fromString(sender), AztecAddress.fromString(recipient));
         return [
             toACVMField(tag.value)
         ];
     }
-    async utilityFetchTaggedLogs([pendingTaggedLogArrayBaseSlot]) {
-        await this.handlerAsUtility().utilityFetchTaggedLogs(Fr.fromString(pendingTaggedLogArrayBaseSlot));
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getPendingTaggedLogs([pendingTaggedLogArrayBaseSlot], [scope]) {
+        await this.handlerAsUtility().getPendingTaggedLogs(Fr.fromString(pendingTaggedLogArrayBaseSlot), AztecAddress.fromString(scope));
+        return [];
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getPendingTaggedLogs_v2([scope]) {
+        const slot = await this.handlerAsUtility().getPendingTaggedLogsV2(AztecAddress.fromString(scope));
+        return [
+            toACVMField(slot)
+        ];
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_validateAndStoreEnqueuedNotesAndEvents([contractAddress], [noteValidationRequestsArrayBaseSlot], [eventValidationRequestsArrayBaseSlot], [maxNotePackedLen], [maxEventSerializedLen], [scope]) {
+        await this.handlerAsUtility().validateAndStoreEnqueuedNotesAndEvents(AztecAddress.fromString(contractAddress), Fr.fromString(noteValidationRequestsArrayBaseSlot), Fr.fromString(eventValidationRequestsArrayBaseSlot), Fr.fromString(maxNotePackedLen).toNumber(), Fr.fromString(maxEventSerializedLen).toNumber(), AztecAddress.fromString(scope));
         return [];
     }
-    async utilityValidateAndStoreEnqueuedNotesAndEvents([contractAddress], [noteValidationRequestsArrayBaseSlot], [eventValidationRequestsArrayBaseSlot]) {
-        await this.handlerAsUtility().utilityValidateAndStoreEnqueuedNotesAndEvents(AztecAddress.fromString(contractAddress), Fr.fromString(noteValidationRequestsArrayBaseSlot), Fr.fromString(eventValidationRequestsArrayBaseSlot));
+    // eslint-disable-next-line camelcase
+    async aztec_utl_validateAndStoreEnqueuedNotesAndEvents_v2([noteValidationRequestsArrayBaseSlot], [eventValidationRequestsArrayBaseSlot], [maxNotePackedLen], [maxEventSerializedLen], [scope]) {
+        await this.handlerAsUtility().validateAndStoreEnqueuedNotesAndEventsV2(Fr.fromString(noteValidationRequestsArrayBaseSlot), Fr.fromString(eventValidationRequestsArrayBaseSlot), Fr.fromString(maxNotePackedLen).toNumber(), Fr.fromString(maxEventSerializedLen).toNumber(), AztecAddress.fromString(scope));
         return [];
     }
-    async utilityBulkRetrieveLogs([contractAddress], [logRetrievalRequestsArrayBaseSlot], [logRetrievalResponsesArrayBaseSlot]) {
-        await this.handlerAsUtility().utilityBulkRetrieveLogs(AztecAddress.fromString(contractAddress), Fr.fromString(logRetrievalRequestsArrayBaseSlot), Fr.fromString(logRetrievalResponsesArrayBaseSlot));
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getLogsByTag([contractAddress], [logRetrievalRequestsArrayBaseSlot], [logRetrievalResponsesArrayBaseSlot], [scope]) {
+        await this.handlerAsUtility().getLogsByTag(AztecAddress.fromString(contractAddress), Fr.fromString(logRetrievalRequestsArrayBaseSlot), Fr.fromString(logRetrievalResponsesArrayBaseSlot), AztecAddress.fromString(scope));
         return [];
     }
-    async utilityStoreCapsule([contractAddress], [slot], capsule) {
-        await this.handlerAsUtility().utilityStoreCapsule(AztecAddress.fromField(Fr.fromString(contractAddress)), Fr.fromString(slot), capsule.map(Fr.fromString));
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getMessageContextsByTxHash([contractAddress], [messageContextRequestsArrayBaseSlot], [messageContextResponsesArrayBaseSlot], [scope]) {
+        await this.handlerAsUtility().getMessageContextsByTxHash(AztecAddress.fromString(contractAddress), Fr.fromString(messageContextRequestsArrayBaseSlot), Fr.fromString(messageContextResponsesArrayBaseSlot), AztecAddress.fromString(scope));
         return [];
     }
-    async utilityLoadCapsule([contractAddress], [slot], [tSize]) {
-        const values = await this.handlerAsUtility().utilityLoadCapsule(AztecAddress.fromField(Fr.fromString(contractAddress)), Fr.fromString(slot));
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getLogsByTag_v2([requestArrayBaseSlot]) {
+        const responseSlot = await this.handlerAsUtility().getLogsByTagV2(Fr.fromString(requestArrayBaseSlot));
+        return [
+            toACVMField(responseSlot)
+        ];
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getMessageContextsByTxHash_v2([requestArrayBaseSlot]) {
+        const responseSlot = await this.handlerAsUtility().getMessageContextsByTxHashV2(Fr.fromString(requestArrayBaseSlot));
+        return [
+            toACVMField(responseSlot)
+        ];
+    }
+    // eslint-disable-next-line camelcase
+    aztec_utl_setCapsule([contractAddress], [slot], capsule, [scope]) {
+        this.handlerAsUtility().setCapsule(AztecAddress.fromField(Fr.fromString(contractAddress)), Fr.fromString(slot), capsule.map(Fr.fromString), AztecAddress.fromField(Fr.fromString(scope)));
+        return Promise.resolve([]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getCapsule([contractAddress], [slot], [tSize], [scope]) {
+        const values = await this.handlerAsUtility().getCapsule(AztecAddress.fromField(Fr.fromString(contractAddress)), Fr.fromString(slot), AztecAddress.fromField(Fr.fromString(scope)));
         // We are going to return a Noir Option struct to represent the possibility of null values. Options are a struct
         // with two fields: `some` (a boolean) and `value` (a field array in this case).
         if (values === null) {
@@ -323,35 +442,107 @@ export class UnavailableOracleError extends Error {
             ];
         }
     }
-    async utilityDeleteCapsule([contractAddress], [slot]) {
-        await this.handlerAsUtility().utilityDeleteCapsule(AztecAddress.fromField(Fr.fromString(contractAddress)), Fr.fromString(slot));
-        return [];
+    // eslint-disable-next-line camelcase
+    aztec_utl_deleteCapsule([contractAddress], [slot], [scope]) {
+        this.handlerAsUtility().deleteCapsule(AztecAddress.fromField(Fr.fromString(contractAddress)), Fr.fromString(slot), AztecAddress.fromField(Fr.fromString(scope)));
+        return Promise.resolve([]);
     }
-    async utilityCopyCapsule([contractAddress], [srcSlot], [dstSlot], [numEntries]) {
-        await this.handlerAsUtility().utilityCopyCapsule(AztecAddress.fromField(Fr.fromString(contractAddress)), Fr.fromString(srcSlot), Fr.fromString(dstSlot), Fr.fromString(numEntries).toNumber());
+    // eslint-disable-next-line camelcase
+    async aztec_utl_copyCapsule([contractAddress], [srcSlot], [dstSlot], [numEntries], [scope]) {
+        await this.handlerAsUtility().copyCapsule(AztecAddress.fromField(Fr.fromString(contractAddress)), Fr.fromString(srcSlot), Fr.fromString(dstSlot), Fr.fromString(numEntries).toNumber(), AztecAddress.fromField(Fr.fromString(scope)));
         return [];
     }
-    async utilityAes128Decrypt(ciphertextBVecStorage, [ciphertextLength], iv, symKey) {
+    // eslint-disable-next-line camelcase
+    aztec_utl_pushEphemeral([slot], elements) {
+        const newLen = this.handlerAsUtility().pushEphemeral(Fr.fromString(slot), elements.map(Fr.fromString));
+        return Promise.resolve([
+            toACVMField(newLen)
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    aztec_utl_popEphemeral([slot]) {
+        const element = this.handlerAsUtility().popEphemeral(Fr.fromString(slot));
+        return Promise.resolve([
+            element.map(toACVMField)
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    aztec_utl_getEphemeral([slot], [index]) {
+        const element = this.handlerAsUtility().getEphemeral(Fr.fromString(slot), Fr.fromString(index).toNumber());
+        return Promise.resolve([
+            element.map(toACVMField)
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    aztec_utl_setEphemeral([slot], [index], elements) {
+        this.handlerAsUtility().setEphemeral(Fr.fromString(slot), Fr.fromString(index).toNumber(), elements.map(Fr.fromString));
+        return Promise.resolve([]);
+    }
+    // eslint-disable-next-line camelcase
+    aztec_utl_getEphemeralLen([slot]) {
+        const len = this.handlerAsUtility().getEphemeralLen(Fr.fromString(slot));
+        return Promise.resolve([
+            toACVMField(len)
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    aztec_utl_removeEphemeral([slot], [index]) {
+        this.handlerAsUtility().removeEphemeral(Fr.fromString(slot), Fr.fromString(index).toNumber());
+        return Promise.resolve([]);
+    }
+    // eslint-disable-next-line camelcase
+    aztec_utl_clearEphemeral([slot]) {
+        this.handlerAsUtility().clearEphemeral(Fr.fromString(slot));
+        return Promise.resolve([]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_decryptAes128(ciphertextBVecStorage, [ciphertextLength], iv, symKey) {
         const ciphertext = fromUintBoundedVec(ciphertextBVecStorage, ciphertextLength, 8);
         const ivBuffer = fromUintArray(iv, 8);
         const symKeyBuffer = fromUintArray(symKey, 8);
-        const plaintext = await this.handlerAsUtility().utilityAes128Decrypt(ciphertext, ivBuffer, symKeyBuffer);
-        return bufferToBoundedVec(plaintext, ciphertextBVecStorage.length);
+        // Noir Option<BoundedVec> is encoded as [is_some: Field, storage: Field[], length: Field].
+        try {
+            const plaintext = await this.handlerAsUtility().decryptAes128(ciphertext, ivBuffer, symKeyBuffer);
+            const [storage, length] = bufferToBoundedVec(plaintext, ciphertextBVecStorage.length);
+            return [
+                toACVMField(1),
+                storage,
+                length
+            ];
+        } catch  {
+            const zeroStorage = Array(ciphertextBVecStorage.length).fill(toACVMField(0));
+            return [
+                toACVMField(0),
+                zeroStorage,
+                toACVMField(0)
+            ];
+        }
     }
-    async utilityGetSharedSecret([address], [ephPKField0], [ephPKField1], [ephPKField2]) {
-        const secret = await this.handlerAsUtility().utilityGetSharedSecret(AztecAddress.fromField(Fr.fromString(address)), Point.fromFields([
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getSharedSecret([address], [ephPKField0], [ephPKField1], [ephPKField2], [contractAddress]) {
+        const secret = await this.handlerAsUtility().getSharedSecret(AztecAddress.fromField(Fr.fromString(address)), Point.fromFields([
             ephPKField0,
             ephPKField1,
             ephPKField2
-        ].map(Fr.fromString)));
-        return secret.toFields().map(toACVMField);
+        ].map(Fr.fromString)), AztecAddress.fromField(Fr.fromString(contractAddress)));
+        return [
+            toACVMField(secret)
+        ];
+    }
+    // eslint-disable-next-line camelcase
+    aztec_utl_setContractSyncCacheInvalid([contractAddress], scopes, [scopeCount]) {
+        const scopeAddresses = scopes.slice(0, +scopeCount).map((s)=>AztecAddress.fromField(Fr.fromString(s)));
+        this.handlerAsUtility().setContractSyncCacheInvalid(AztecAddress.fromField(Fr.fromString(contractAddress)), scopeAddresses);
+        return Promise.resolve([]);
     }
-    async utilityEmitOffchainEffect(data) {
-        await this.handlerAsPrivate().utilityEmitOffchainEffect(data.map(Fr.fromString));
+    // eslint-disable-next-line camelcase
+    async aztec_utl_emitOffchainEffect(data) {
+        await this.handlerAsUtility().emitOffchainEffect(data.map(Fr.fromString));
         return [];
     }
-    async privateGetSenderForTags() {
-        const sender = await this.handlerAsPrivate().privateGetSenderForTags();
+    // eslint-disable-next-line camelcase
+    async aztec_prv_getSenderForTags() {
+        const sender = await this.handlerAsPrivate().getSenderForTags();
         // Return [1, address] for Some(address), [0, 0] for None
         return sender ? [
             toACVMField(1n),
@@ -361,8 +552,9 @@ export class UnavailableOracleError extends Error {
             toACVMField(0n)
         ];
     }
-    async privateSetSenderForTags([senderForTags]) {
-        await this.handlerAsPrivate().privateSetSenderForTags(AztecAddress.fromField(Fr.fromString(senderForTags)));
+    // eslint-disable-next-line camelcase
+    async aztec_prv_setSenderForTags([senderForTags]) {
+        await this.handlerAsPrivate().setSenderForTags(AztecAddress.fromField(Fr.fromString(senderForTags)));
         return [];
     }
 }

package/dest/contract_function_simulator/oracle/private_execution.js

@@ -45,11 +45,11 @@ import { Oracle } from './oracle.js';
         appCircuitName: functionName
     });
     const contractClassLogs = privateExecutionOracle.getContractClassLogs();
-    const rawReturnValues = await privateExecutionOracle.privateLoadFromExecutionCache(publicInputs.returnsHash);
+    const rawReturnValues = await privateExecutionOracle.getHashPreimage(publicInputs.returnsHash);
     const newNotes = privateExecutionOracle.getNewNotes();
     const noteHashNullifierCounterMap = privateExecutionOracle.getNoteHashNullifierCounterMap();
     const offchainEffects = privateExecutionOracle.getOffchainEffects();
-    const preTags = privateExecutionOracle.getUsedPreTags();
+    const taggingIndexRanges = privateExecutionOracle.getUsedTaggingIndexRanges();
     const nestedExecutionResults = privateExecutionOracle.getNestedExecutionResults();
     let timerSubtractionList = nestedExecutionResults;
     let witgenTime = duration;
@@ -59,7 +59,9 @@ import { Oracle } from './oracle.js';
         timerSubtractionList = timerSubtractionList.flatMap((nested)=>nested.nestedExecutionResults ?? []);
     }
     log.debug(`Returning from call to ${contractAddress.toString()}:${functionSelector}`);
-    return new PrivateCallExecutionResult(artifact.bytecode, Buffer.from(artifact.verificationKey, 'base64'), partialWitness, publicInputs, newNotes, noteHashNullifierCounterMap, rawReturnValues, offchainEffects, preTags, nestedExecutionResults, contractClassLogs, {
+    return new PrivateCallExecutionResult(artifact.bytecode, Buffer.from(artifact.verificationKey, 'base64'), partialWitness, publicInputs, newNotes, noteHashNullifierCounterMap, rawReturnValues, offchainEffects.map((e)=>({
+            data: e.data
+        })), taggingIndexRanges, nestedExecutionResults, contractClassLogs, {
         timings: {
             witgen: witgenTime,
             oracles: acirExecutionResult.oracles