@aztec/txe 0.0.0-test.0 → 0.0.1-commit.001888fc

package/dest/rpc_translator.js

@@ -0,0 +1,791 @@
+import { Fr, Point } from '@aztec/aztec.js/fields';
+import { MAX_NOTE_HASHES_PER_TX, MAX_NULLIFIERS_PER_TX } from '@aztec/constants';
+import { BlockNumber } from '@aztec/foundation/branded-types';
+import { packAsHintedNote } from '@aztec/pxe/simulator';
+import { EventSelector, FunctionSelector, NoteSelector } from '@aztec/stdlib/abi';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
+import { BlockHash } from '@aztec/stdlib/block';
+import { addressFromSingle, arrayOfArraysToBoundedVecOfArrays, arrayToBoundedVec, bufferToU8Array, fromArray, fromSingle, fromUintArray, fromUintBoundedVec, toArray, toForeignCallResult, toSingle } from './util/encoding.js';
+const MAX_EVENT_LEN = 10; // This is MAX_MESSAGE_CONTENT_LEN - PRIVATE_EVENT_MSG_PLAINTEXT_RESERVED_FIELDS_LEN
+const MAX_PRIVATE_EVENTS_PER_TXE_QUERY = 5;
+export class UnavailableOracleError extends Error {
+    constructor(oracleName){
+        super(`${oracleName} oracles not available with the current handler`);
+    }
+}
+export class RPCTranslator {
+    stateHandler;
+    oracleHandler;
+    /**
+   * Create a new instance of `RPCTranslator` that will translate all TXE RPC calls to and from the foreign
+   * (`ForeignCallSingle`, `ForeignCallResult`, etc.) and native TS types, delegating actual execution of the oracles
+   * to the different handlers.
+   * @param stateHandler The handler that will process TXE session state transitions, such as entering a private or
+   * public context.
+   * @param oracleHandler The handler that will process all other oracle calls that are not directly related to session
+   * state.
+   */ constructor(stateHandler, oracleHandler){
+        this.stateHandler = stateHandler;
+        this.oracleHandler = oracleHandler;
+    }
+    // Note: If you rename the following functions to not start with "handlerAs", you must also update the validation
+    // check in `TXESession.processFunction`.
+    handlerAsMisc() {
+        if (!('isMisc' in this.oracleHandler)) {
+            throw new UnavailableOracleError('Misc');
+        }
+        return this.oracleHandler;
+    }
+    handlerAsUtility() {
+        if (!('isUtility' in this.oracleHandler)) {
+            throw new UnavailableOracleError('Utility');
+        }
+        return this.oracleHandler;
+    }
+    handlerAsPrivate() {
+        if (!('isPrivate' in this.oracleHandler)) {
+            throw new UnavailableOracleError('Private');
+        }
+        return this.oracleHandler;
+    }
+    handlerAsAvm() {
+        if (!('isAvm' in this.oracleHandler)) {
+            throw new UnavailableOracleError('Avm');
+        }
+        return this.oracleHandler;
+    }
+    handlerAsTxe() {
+        if (!('isTxe' in this.oracleHandler)) {
+            throw new UnavailableOracleError('Txe');
+        }
+        return this.oracleHandler;
+    }
+    // TXE session state transition functions - these get handled by the state handler
+    // eslint-disable-next-line camelcase
+    async aztec_txe_setTopLevelTXEContext() {
+        await this.stateHandler.enterTopLevelState();
+        return toForeignCallResult([]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_txe_setPrivateTXEContext(foreignContractAddressIsSome, foreignContractAddressValue, foreignAnchorBlockNumberIsSome, foreignAnchorBlockNumberValue) {
+        const contractAddress = fromSingle(foreignContractAddressIsSome).toBool() ? AztecAddress.fromField(fromSingle(foreignContractAddressValue)) : undefined;
+        const anchorBlockNumber = fromSingle(foreignAnchorBlockNumberIsSome).toBool() ? BlockNumber(fromSingle(foreignAnchorBlockNumberValue).toNumber()) : undefined;
+        const privateContextInputs = await this.stateHandler.enterPrivateState(contractAddress, anchorBlockNumber);
+        return toForeignCallResult(privateContextInputs.toFields().map(toSingle));
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_txe_setPublicTXEContext(foreignContractAddressIsSome, foreignContractAddressValue) {
+        const contractAddress = fromSingle(foreignContractAddressIsSome).toBool() ? AztecAddress.fromField(fromSingle(foreignContractAddressValue)) : undefined;
+        await this.stateHandler.enterPublicState(contractAddress);
+        return toForeignCallResult([]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_txe_setUtilityTXEContext(foreignContractAddressIsSome, foreignContractAddressValue) {
+        const contractAddress = fromSingle(foreignContractAddressIsSome).toBool() ? AztecAddress.fromField(fromSingle(foreignContractAddressValue)) : undefined;
+        await this.stateHandler.enterUtilityState(contractAddress);
+        return toForeignCallResult([]);
+    }
+    // Other oracles - these get handled by the oracle handler
+    // TXE-specific oracles
+    // eslint-disable-next-line camelcase
+    aztec_txe_getDefaultAddress() {
+        const defaultAddress = this.handlerAsTxe().getDefaultAddress();
+        return toForeignCallResult([
+            toSingle(defaultAddress)
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_txe_getNextBlockNumber() {
+        const nextBlockNumber = await this.handlerAsTxe().getNextBlockNumber();
+        return toForeignCallResult([
+            toSingle(nextBlockNumber)
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_txe_getNextBlockTimestamp() {
+        const nextBlockTimestamp = await this.handlerAsTxe().getNextBlockTimestamp();
+        return toForeignCallResult([
+            toSingle(nextBlockTimestamp)
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_txe_advanceBlocksBy(foreignBlocks) {
+        const blocks = fromSingle(foreignBlocks).toNumber();
+        await this.handlerAsTxe().advanceBlocksBy(blocks);
+        return toForeignCallResult([]);
+    }
+    // eslint-disable-next-line camelcase
+    aztec_txe_advanceTimestampBy(foreignDuration) {
+        const duration = fromSingle(foreignDuration).toBigInt();
+        this.handlerAsTxe().advanceTimestampBy(duration);
+        return toForeignCallResult([]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_txe_deploy(artifact, instance, foreignSecret) {
+        const secret = fromSingle(foreignSecret);
+        await this.handlerAsTxe().deploy(artifact, instance, secret);
+        return toForeignCallResult([
+            toArray([
+                instance.salt,
+                instance.deployer.toField(),
+                instance.currentContractClassId,
+                instance.initializationHash,
+                ...instance.publicKeys.toFields()
+            ])
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_txe_createAccount(foreignSecret) {
+        const secret = fromSingle(foreignSecret);
+        const completeAddress = await this.handlerAsTxe().createAccount(secret);
+        return toForeignCallResult([
+            toSingle(completeAddress.address),
+            ...completeAddress.publicKeys.toFields().map(toSingle)
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_txe_addAccount(artifact, instance, foreignSecret) {
+        const secret = fromSingle(foreignSecret);
+        const completeAddress = await this.handlerAsTxe().addAccount(artifact, instance, secret);
+        return toForeignCallResult([
+            toSingle(completeAddress.address),
+            ...completeAddress.publicKeys.toFields().map(toSingle)
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_txe_addAuthWitness(foreignAddress, foreignMessageHash) {
+        const address = addressFromSingle(foreignAddress);
+        const messageHash = fromSingle(foreignMessageHash);
+        await this.handlerAsTxe().addAuthWitness(address, messageHash);
+        return toForeignCallResult([]);
+    }
+    // PXE oracles
+    // eslint-disable-next-line camelcase
+    aztec_utl_assertCompatibleOracleVersion(foreignVersion) {
+        const version = fromSingle(foreignVersion).toNumber();
+        this.handlerAsMisc().assertCompatibleOracleVersion(version);
+        return toForeignCallResult([]);
+    }
+    // eslint-disable-next-line camelcase
+    aztec_utl_getRandomField() {
+        const randomField = this.handlerAsMisc().getRandomField();
+        return toForeignCallResult([
+            toSingle(randomField)
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_txe_getLastBlockTimestamp() {
+        const timestamp = await this.handlerAsTxe().getLastBlockTimestamp();
+        return toForeignCallResult([
+            toSingle(new Fr(timestamp))
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_txe_getLastTxEffects() {
+        const { txHash, noteHashes, nullifiers } = await this.handlerAsTxe().getLastTxEffects();
+        return toForeignCallResult([
+            toSingle(txHash.hash),
+            ...arrayToBoundedVec(toArray(noteHashes), MAX_NOTE_HASHES_PER_TX),
+            ...arrayToBoundedVec(toArray(nullifiers), MAX_NULLIFIERS_PER_TX)
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_txe_getPrivateEvents(foreignSelector, foreignContractAddress, foreignScope) {
+        const selector = EventSelector.fromField(fromSingle(foreignSelector));
+        const contractAddress = addressFromSingle(foreignContractAddress);
+        const scope = addressFromSingle(foreignScope);
+        // TODO(F-335): Avoid doing the following 2 calls here.
+        {
+            await this.handlerAsTxe().syncContractNonOracleMethod(contractAddress, scope, this.stateHandler.getCurrentJob());
+            // We cycle job to commit the stores after the contract sync.
+            await this.stateHandler.cycleJob();
+        }
+        const events = await this.handlerAsTxe().getPrivateEvents(selector, contractAddress, scope);
+        if (events.length > MAX_PRIVATE_EVENTS_PER_TXE_QUERY) {
+            throw new Error(`Array of length ${events.length} larger than maxLen ${MAX_PRIVATE_EVENTS_PER_TXE_QUERY}`);
+        }
+        if (events.some((e)=>e.length > MAX_EVENT_LEN)) {
+            throw new Error(`Some private event has length larger than maxLen ${MAX_EVENT_LEN}`);
+        }
+        // This is a workaround as Noir does not currently let us return nested structs with arrays. We instead return a raw
+        // multidimensional array in get_private_events_oracle and create the BoundedVecs here.
+        const rawArrayStorage = events.map((e)=>e.concat(Array(MAX_EVENT_LEN - e.length).fill(new Fr(0)))).concat(Array(MAX_PRIVATE_EVENTS_PER_TXE_QUERY - events.length).fill(Array(MAX_EVENT_LEN).fill(new Fr(0)))).flat();
+        const eventLengths = events.map((e)=>new Fr(e.length)).concat(Array(MAX_PRIVATE_EVENTS_PER_TXE_QUERY - events.length).fill(new Fr(0)));
+        const queryLength = new Fr(events.length);
+        return toForeignCallResult([
+            toArray(rawArrayStorage),
+            toArray(eventLengths),
+            toSingle(queryLength)
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    aztec_prv_storeInExecutionCache(foreignValues, foreignHash) {
+        const values = fromArray(foreignValues);
+        const hash = fromSingle(foreignHash);
+        this.handlerAsPrivate().storeInExecutionCache(values, hash);
+        return toForeignCallResult([]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_prv_loadFromExecutionCache(foreignHash) {
+        const hash = fromSingle(foreignHash);
+        const returns = await this.handlerAsPrivate().loadFromExecutionCache(hash);
+        return toForeignCallResult([
+            toArray(returns)
+        ]);
+    }
+    // When the argument is a slice, noir automatically adds a length field to oracle call.
+    // When the argument is an array, we add the field length manually to the signature.
+    // eslint-disable-next-line camelcase
+    async aztec_utl_log(foreignLevel, foreignMessage, _foreignLength, foreignFields) {
+        const level = fromSingle(foreignLevel).toNumber();
+        const message = fromArray(foreignMessage).map((field)=>String.fromCharCode(field.toNumber())).join('');
+        const fields = fromArray(foreignFields);
+        await this.handlerAsMisc().log(level, message, fields);
+        return toForeignCallResult([]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_storageRead(foreignBlockHash, foreignContractAddress, foreignStartStorageSlot, foreignNumberOfElements) {
+        const blockHash = new BlockHash(fromSingle(foreignBlockHash));
+        const contractAddress = addressFromSingle(foreignContractAddress);
+        const startStorageSlot = fromSingle(foreignStartStorageSlot);
+        const numberOfElements = fromSingle(foreignNumberOfElements).toNumber();
+        const values = await this.handlerAsUtility().storageRead(blockHash, contractAddress, startStorageSlot, numberOfElements);
+        return toForeignCallResult([
+            toArray(values)
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getPublicDataWitness(foreignBlockHash, foreignLeafSlot) {
+        const blockHash = new BlockHash(fromSingle(foreignBlockHash));
+        const leafSlot = fromSingle(foreignLeafSlot);
+        const witness = await this.handlerAsUtility().getPublicDataWitness(blockHash, leafSlot);
+        if (!witness) {
+            throw new Error(`Public data witness not found for slot ${leafSlot} at block ${blockHash.toString()}.`);
+        }
+        return toForeignCallResult(witness.toNoirRepresentation());
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getNotes(foreignOwnerIsSome, foreignOwnerValue, foreignStorageSlot, foreignNumSelects, foreignSelectByIndexes, foreignSelectByOffsets, foreignSelectByLengths, foreignSelectValues, foreignSelectComparators, foreignSortByIndexes, foreignSortByOffsets, foreignSortByLengths, foreignSortOrder, foreignLimit, foreignOffset, foreignStatus, foreignMaxNotes, foreignPackedHintedNoteLength) {
+        // Parse Option<AztecAddress>: ownerIsSome is 0 for None, 1 for Some
+        const owner = fromSingle(foreignOwnerIsSome).toBool() ? AztecAddress.fromField(fromSingle(foreignOwnerValue)) : undefined;
+        const storageSlot = fromSingle(foreignStorageSlot);
+        const numSelects = fromSingle(foreignNumSelects).toNumber();
+        const selectByIndexes = fromArray(foreignSelectByIndexes).map((fr)=>fr.toNumber());
+        const selectByOffsets = fromArray(foreignSelectByOffsets).map((fr)=>fr.toNumber());
+        const selectByLengths = fromArray(foreignSelectByLengths).map((fr)=>fr.toNumber());
+        const selectValues = fromArray(foreignSelectValues);
+        const selectComparators = fromArray(foreignSelectComparators).map((fr)=>fr.toNumber());
+        const sortByIndexes = fromArray(foreignSortByIndexes).map((fr)=>fr.toNumber());
+        const sortByOffsets = fromArray(foreignSortByOffsets).map((fr)=>fr.toNumber());
+        const sortByLengths = fromArray(foreignSortByLengths).map((fr)=>fr.toNumber());
+        const sortOrder = fromArray(foreignSortOrder).map((fr)=>fr.toNumber());
+        const limit = fromSingle(foreignLimit).toNumber();
+        const offset = fromSingle(foreignOffset).toNumber();
+        const status = fromSingle(foreignStatus).toNumber();
+        const maxNotes = fromSingle(foreignMaxNotes).toNumber();
+        const packedHintedNoteLength = fromSingle(foreignPackedHintedNoteLength).toNumber();
+        const noteDatas = await this.handlerAsUtility().getNotes(owner, storageSlot, numSelects, selectByIndexes, selectByOffsets, selectByLengths, selectValues, selectComparators, sortByIndexes, sortByOffsets, sortByLengths, sortOrder, limit, offset, status);
+        const returnDataAsArrayOfArrays = noteDatas.map((noteData)=>packAsHintedNote({
+                contractAddress: noteData.contractAddress,
+                owner: noteData.owner,
+                randomness: noteData.randomness,
+                storageSlot: noteData.storageSlot,
+                noteNonce: noteData.noteNonce,
+                isPending: noteData.isPending,
+                note: noteData.note
+            }));
+        // Now we convert each sub-array to an array of ForeignCallSingles
+        const returnDataAsArrayOfForeignCallSingleArrays = returnDataAsArrayOfArrays.map((subArray)=>subArray.map(toSingle));
+        // At last we convert the array of arrays to a bounded vec of arrays
+        return toForeignCallResult(arrayOfArraysToBoundedVecOfArrays(returnDataAsArrayOfForeignCallSingleArrays, maxNotes, packedHintedNoteLength));
+    }
+    // eslint-disable-next-line camelcase
+    aztec_prv_notifyCreatedNote(foreignOwner, foreignStorageSlot, foreignRandomness, foreignNoteTypeId, foreignNote, foreignNoteHash, foreignCounter) {
+        const owner = addressFromSingle(foreignOwner);
+        const storageSlot = fromSingle(foreignStorageSlot);
+        const randomness = fromSingle(foreignRandomness);
+        const noteTypeId = NoteSelector.fromField(fromSingle(foreignNoteTypeId));
+        const note = fromArray(foreignNote);
+        const noteHash = fromSingle(foreignNoteHash);
+        const counter = fromSingle(foreignCounter).toNumber();
+        this.handlerAsPrivate().notifyCreatedNote(owner, storageSlot, randomness, noteTypeId, note, noteHash, counter);
+        return toForeignCallResult([]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_prv_notifyNullifiedNote(foreignInnerNullifier, foreignNoteHash, foreignCounter) {
+        const innerNullifier = fromSingle(foreignInnerNullifier);
+        const noteHash = fromSingle(foreignNoteHash);
+        const counter = fromSingle(foreignCounter).toNumber();
+        await this.handlerAsPrivate().notifyNullifiedNote(innerNullifier, noteHash, counter);
+        return toForeignCallResult([]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_prv_notifyCreatedNullifier(foreignInnerNullifier) {
+        const innerNullifier = fromSingle(foreignInnerNullifier);
+        await this.handlerAsPrivate().notifyCreatedNullifier(innerNullifier);
+        return toForeignCallResult([]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_prv_isNullifierPending(foreignInnerNullifier, foreignContractAddress) {
+        const innerNullifier = fromSingle(foreignInnerNullifier);
+        const contractAddress = addressFromSingle(foreignContractAddress);
+        const isPending = await this.handlerAsPrivate().isNullifierPending(innerNullifier, contractAddress);
+        return toForeignCallResult([
+            toSingle(new Fr(isPending))
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_checkNullifierExists(foreignInnerNullifier) {
+        const innerNullifier = fromSingle(foreignInnerNullifier);
+        const exists = await this.handlerAsUtility().checkNullifierExists(innerNullifier);
+        return toForeignCallResult([
+            toSingle(new Fr(exists))
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getContractInstance(foreignAddress) {
+        const address = addressFromSingle(foreignAddress);
+        const instance = await this.handlerAsUtility().getContractInstance(address);
+        return toForeignCallResult([
+            instance.salt,
+            instance.deployer.toField(),
+            instance.currentContractClassId,
+            instance.initializationHash,
+            ...instance.publicKeys.toFields()
+        ].map(toSingle));
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_tryGetPublicKeysAndPartialAddress(foreignAddress) {
+        const address = addressFromSingle(foreignAddress);
+        const result = await this.handlerAsUtility().tryGetPublicKeysAndPartialAddress(address);
+        // 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) {
+            // No data was found so we set `some` to 0 and pad `value` with zeros get the correct return size.
+            return toForeignCallResult([
+                toSingle(new Fr(0)),
+                toArray(Array(13).fill(new Fr(0)))
+            ]);
+        } else {
+            // Data was found so we set `some` to 1 and return it along with `value`.
+            return toForeignCallResult([
+                toSingle(new Fr(1)),
+                toArray([
+                    ...result.publicKeys.toFields(),
+                    result.partialAddress
+                ])
+            ]);
+        }
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getKeyValidationRequest(foreignPkMHash) {
+        const pkMHash = fromSingle(foreignPkMHash);
+        const keyValidationRequest = await this.handlerAsUtility().getKeyValidationRequest(pkMHash);
+        return toForeignCallResult(keyValidationRequest.toFields().map(toSingle));
+    }
+    // eslint-disable-next-line camelcase
+    aztec_prv_callPrivateFunction(_foreignTargetContractAddress, _foreignFunctionSelector, _foreignArgsHash, _foreignSideEffectCounter, _foreignIsStaticCall) {
+        throw new Error('Contract calls are forbidden inside a `TestEnvironment::private_context`, use `private_call` instead');
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getNullifierMembershipWitness(foreignBlockHash, foreignNullifier) {
+        const blockHash = new BlockHash(fromSingle(foreignBlockHash));
+        const nullifier = fromSingle(foreignNullifier);
+        const witness = await this.handlerAsUtility().getNullifierMembershipWitness(blockHash, nullifier);
+        if (!witness) {
+            throw new Error(`Nullifier membership witness not found at block ${blockHash}.`);
+        }
+        return toForeignCallResult(witness.toNoirRepresentation());
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getAuthWitness(foreignMessageHash) {
+        const messageHash = fromSingle(foreignMessageHash);
+        const authWitness = await this.handlerAsUtility().getAuthWitness(messageHash);
+        if (!authWitness) {
+            throw new Error(`Auth witness not found for message hash ${messageHash}.`);
+        }
+        return toForeignCallResult([
+            toArray(authWitness)
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    aztec_prv_validatePublicCalldata(_foreignCalldataHash) {
+        throw new Error('Enqueueing public calls is not supported in TestEnvironment::private_context');
+    }
+    // eslint-disable-next-line camelcase
+    aztec_prv_notifyRevertiblePhaseStart(_foreignMinRevertibleSideEffectCounter) {
+        throw new Error('Enqueueing public calls is not supported in TestEnvironment::private_context');
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_prv_inRevertiblePhase(foreignSideEffectCounter) {
+        const sideEffectCounter = fromSingle(foreignSideEffectCounter).toNumber();
+        const isRevertible = await this.handlerAsPrivate().inRevertiblePhase(sideEffectCounter);
+        return toForeignCallResult([
+            toSingle(new Fr(isRevertible))
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    aztec_utl_getUtilityContext() {
+        const context = this.handlerAsUtility().getUtilityContext();
+        return toForeignCallResult(context.toNoirRepresentation());
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getBlockHeader(foreignBlockNumber) {
+        const blockNumber = BlockNumber(fromSingle(foreignBlockNumber).toNumber());
+        const header = await this.handlerAsUtility().getBlockHeader(blockNumber);
+        if (!header) {
+            throw new Error(`Block header not found for block ${blockNumber}.`);
+        }
+        return toForeignCallResult(header.toFields().map(toSingle));
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getNoteHashMembershipWitness(foreignAnchorBlockHash, foreignNoteHash) {
+        const blockHash = new BlockHash(fromSingle(foreignAnchorBlockHash));
+        const noteHash = fromSingle(foreignNoteHash);
+        const witness = await this.handlerAsUtility().getNoteHashMembershipWitness(blockHash, noteHash);
+        if (!witness) {
+            throw new Error(`Note hash ${noteHash} not found in the note hash tree at block ${blockHash.toString()}.`);
+        }
+        return toForeignCallResult(witness.toNoirRepresentation());
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getBlockHashMembershipWitness(foreignAnchorBlockHash, foreignBlockHash) {
+        const anchorBlockHash = new BlockHash(fromSingle(foreignAnchorBlockHash));
+        const blockHash = new BlockHash(fromSingle(foreignBlockHash));
+        const witness = await this.handlerAsUtility().getBlockHashMembershipWitness(anchorBlockHash, blockHash);
+        if (!witness) {
+            throw new Error(`Block hash ${blockHash.toString()} not found in the archive tree at anchor block ${anchorBlockHash.toString()}.`);
+        }
+        return toForeignCallResult(witness.toNoirRepresentation());
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getLowNullifierMembershipWitness(foreignBlockHash, foreignNullifier) {
+        const blockHash = new BlockHash(fromSingle(foreignBlockHash));
+        const nullifier = fromSingle(foreignNullifier);
+        const witness = await this.handlerAsUtility().getLowNullifierMembershipWitness(blockHash, nullifier);
+        if (!witness) {
+            throw new Error(`Low nullifier witness not found for nullifier ${nullifier} at block ${blockHash}.`);
+        }
+        return toForeignCallResult(witness.toNoirRepresentation());
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_fetchTaggedLogs(foreignPendingTaggedLogArrayBaseSlot) {
+        const pendingTaggedLogArrayBaseSlot = fromSingle(foreignPendingTaggedLogArrayBaseSlot);
+        await this.handlerAsUtility().fetchTaggedLogs(pendingTaggedLogArrayBaseSlot);
+        return toForeignCallResult([]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_validateAndStoreEnqueuedNotesAndEvents(foreignContractAddress, foreignNoteValidationRequestsArrayBaseSlot, foreignEventValidationRequestsArrayBaseSlot, foreignMaxNotePackedLen, foreignMaxEventSerializedLen) {
+        const contractAddress = AztecAddress.fromField(fromSingle(foreignContractAddress));
+        const noteValidationRequestsArrayBaseSlot = fromSingle(foreignNoteValidationRequestsArrayBaseSlot);
+        const eventValidationRequestsArrayBaseSlot = fromSingle(foreignEventValidationRequestsArrayBaseSlot);
+        const maxNotePackedLen = fromSingle(foreignMaxNotePackedLen).toNumber();
+        const maxEventSerializedLen = fromSingle(foreignMaxEventSerializedLen).toNumber();
+        await this.handlerAsUtility().validateAndStoreEnqueuedNotesAndEvents(contractAddress, noteValidationRequestsArrayBaseSlot, eventValidationRequestsArrayBaseSlot, maxNotePackedLen, maxEventSerializedLen);
+        return toForeignCallResult([]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_bulkRetrieveLogs(foreignContractAddress, foreignLogRetrievalRequestsArrayBaseSlot, foreignLogRetrievalResponsesArrayBaseSlot) {
+        const contractAddress = AztecAddress.fromField(fromSingle(foreignContractAddress));
+        const logRetrievalRequestsArrayBaseSlot = fromSingle(foreignLogRetrievalRequestsArrayBaseSlot);
+        const logRetrievalResponsesArrayBaseSlot = fromSingle(foreignLogRetrievalResponsesArrayBaseSlot);
+        await this.handlerAsUtility().bulkRetrieveLogs(contractAddress, logRetrievalRequestsArrayBaseSlot, logRetrievalResponsesArrayBaseSlot);
+        return toForeignCallResult([]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_utilityResolveMessageContexts(foreignContractAddress, foreignMessageContextRequestsArrayBaseSlot, foreignMessageContextResponsesArrayBaseSlot) {
+        const contractAddress = AztecAddress.fromField(fromSingle(foreignContractAddress));
+        const messageContextRequestsArrayBaseSlot = fromSingle(foreignMessageContextRequestsArrayBaseSlot);
+        const messageContextResponsesArrayBaseSlot = fromSingle(foreignMessageContextResponsesArrayBaseSlot);
+        await this.handlerAsUtility().utilityResolveMessageContexts(contractAddress, messageContextRequestsArrayBaseSlot, messageContextResponsesArrayBaseSlot);
+        return toForeignCallResult([]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_storeCapsule(foreignContractAddress, foreignSlot, foreignCapsule) {
+        const contractAddress = AztecAddress.fromField(fromSingle(foreignContractAddress));
+        const slot = fromSingle(foreignSlot);
+        const capsule = fromArray(foreignCapsule);
+        await this.handlerAsUtility().storeCapsule(contractAddress, slot, capsule);
+        return toForeignCallResult([]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_loadCapsule(foreignContractAddress, foreignSlot, foreignTSize) {
+        const contractAddress = AztecAddress.fromField(fromSingle(foreignContractAddress));
+        const slot = fromSingle(foreignSlot);
+        const tSize = fromSingle(foreignTSize).toNumber();
+        const values = await this.handlerAsUtility().loadCapsule(contractAddress, slot);
+        // 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) {
+            // No data was found so we set `some` to 0 and pad `value` with zeros get the correct return size.
+            return toForeignCallResult([
+                toSingle(new Fr(0)),
+                toArray(Array(tSize).fill(new Fr(0)))
+            ]);
+        } else {
+            // Data was found so we set `some` to 1 and return it along with `value`.
+            return toForeignCallResult([
+                toSingle(new Fr(1)),
+                toArray(values)
+            ]);
+        }
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_deleteCapsule(foreignContractAddress, foreignSlot) {
+        const contractAddress = AztecAddress.fromField(fromSingle(foreignContractAddress));
+        const slot = fromSingle(foreignSlot);
+        await this.handlerAsUtility().deleteCapsule(contractAddress, slot);
+        return toForeignCallResult([]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_copyCapsule(foreignContractAddress, foreignSrcSlot, foreignDstSlot, foreignNumEntries) {
+        const contractAddress = AztecAddress.fromField(fromSingle(foreignContractAddress));
+        const srcSlot = fromSingle(foreignSrcSlot);
+        const dstSlot = fromSingle(foreignDstSlot);
+        const numEntries = fromSingle(foreignNumEntries).toNumber();
+        await this.handlerAsUtility().copyCapsule(contractAddress, srcSlot, dstSlot, numEntries);
+        return toForeignCallResult([]);
+    }
+    // TODO: I forgot to add a corresponding function here, when I introduced an oracle method to txe_oracle.ts.
+    // The compiler didn't throw an error, so it took me a while to learn of the existence of this file, and that I need
+    // to implement this function here. Isn't there a way to programmatically identify that this is missing, given the
+    // existence of a txe_oracle method?
+    // TODO(F-452): Return Option and wrap in try/catch so BB exceptions don't crash TXE.
+    // eslint-disable-next-line camelcase
+    async aztec_utl_aes128Decrypt(foreignCiphertextBVecStorage, foreignCiphertextLength, foreignIv, foreignSymKey) {
+        const ciphertext = fromUintBoundedVec(foreignCiphertextBVecStorage, foreignCiphertextLength, 8);
+        const iv = fromUintArray(foreignIv, 8);
+        const symKey = fromUintArray(foreignSymKey, 8);
+        const plaintextBuffer = await this.handlerAsUtility().aes128Decrypt(ciphertext, iv, symKey);
+        return toForeignCallResult(arrayToBoundedVec(bufferToU8Array(plaintextBuffer), foreignCiphertextBVecStorage.length));
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_utl_getSharedSecret(foreignAddress, foreignEphPKField0, foreignEphPKField1, foreignEphPKField2) {
+        const address = AztecAddress.fromField(fromSingle(foreignAddress));
+        const ephPK = Point.fromFields([
+            fromSingle(foreignEphPKField0),
+            fromSingle(foreignEphPKField1),
+            fromSingle(foreignEphPKField2)
+        ]);
+        const secret = await this.handlerAsUtility().getSharedSecret(address, ephPK);
+        return toForeignCallResult(secret.toFields().map(toSingle));
+    }
+    // eslint-disable-next-line camelcase
+    aztec_utl_emitOffchainEffect(_foreignData) {
+        throw new Error('Offchain effects are not yet supported in the TestEnvironment');
+    }
+    // AVM opcodes
+    // eslint-disable-next-line camelcase
+    aztec_avm_emitPublicLog(_foreignMessage) {
+        // TODO(#8811): Implement
+        return toForeignCallResult([]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_avm_storageRead(foreignSlot, foreignContractAddress) {
+        const slot = fromSingle(foreignSlot);
+        const contractAddress = AztecAddress.fromField(fromSingle(foreignContractAddress));
+        const value = (await this.handlerAsAvm().storageRead(slot, contractAddress)).value;
+        return toForeignCallResult([
+            toSingle(new Fr(value))
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_avm_storageWrite(foreignSlot, foreignValue) {
+        const slot = fromSingle(foreignSlot);
+        const value = fromSingle(foreignValue);
+        await this.handlerAsAvm().storageWrite(slot, value);
+        return toForeignCallResult([]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_avm_getContractInstanceDeployer(foreignAddress) {
+        const address = addressFromSingle(foreignAddress);
+        const instance = await this.handlerAsUtility().getContractInstance(address);
+        return toForeignCallResult([
+            toSingle(instance.deployer),
+            // AVM requires an extra boolean indicating the instance was found
+            toSingle(new Fr(1))
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_avm_getContractInstanceClassId(foreignAddress) {
+        const address = addressFromSingle(foreignAddress);
+        const instance = await this.handlerAsUtility().getContractInstance(address);
+        return toForeignCallResult([
+            toSingle(instance.currentContractClassId),
+            // AVM requires an extra boolean indicating the instance was found
+            toSingle(new Fr(1))
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_avm_getContractInstanceInitializationHash(foreignAddress) {
+        const address = addressFromSingle(foreignAddress);
+        const instance = await this.handlerAsUtility().getContractInstance(address);
+        return toForeignCallResult([
+            toSingle(instance.initializationHash),
+            // AVM requires an extra boolean indicating the instance was found
+            toSingle(new Fr(1))
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_avm_sender() {
+        const sender = await this.handlerAsAvm().sender();
+        return toForeignCallResult([
+            toSingle(sender)
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_avm_emitNullifier(foreignNullifier) {
+        const nullifier = fromSingle(foreignNullifier);
+        await this.handlerAsAvm().emitNullifier(nullifier);
+        return toForeignCallResult([]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_avm_emitNoteHash(foreignNoteHash) {
+        const noteHash = fromSingle(foreignNoteHash);
+        await this.handlerAsAvm().emitNoteHash(noteHash);
+        return toForeignCallResult([]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_avm_nullifierExists(foreignSiloedNullifier) {
+        const siloedNullifier = fromSingle(foreignSiloedNullifier);
+        const exists = await this.handlerAsAvm().nullifierExists(siloedNullifier);
+        return toForeignCallResult([
+            toSingle(new Fr(exists))
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_avm_address() {
+        const contractAddress = await this.handlerAsAvm().address();
+        return toForeignCallResult([
+            toSingle(contractAddress.toField())
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_avm_blockNumber() {
+        const blockNumber = await this.handlerAsAvm().blockNumber();
+        return toForeignCallResult([
+            toSingle(new Fr(blockNumber))
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_avm_timestamp() {
+        const timestamp = await this.handlerAsAvm().timestamp();
+        return toForeignCallResult([
+            toSingle(new Fr(timestamp))
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_avm_isStaticCall() {
+        const isStaticCall = await this.handlerAsAvm().isStaticCall();
+        return toForeignCallResult([
+            toSingle(new Fr(isStaticCall ? 1 : 0))
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_avm_chainId() {
+        const chainId = await this.handlerAsAvm().chainId();
+        return toForeignCallResult([
+            toSingle(chainId)
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_avm_version() {
+        const version = await this.handlerAsAvm().version();
+        return toForeignCallResult([
+            toSingle(version)
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    aztec_avm_returndataSize() {
+        throw new Error('Contract calls are forbidden inside a `TestEnvironment::public_context`, use `public_call` instead');
+    }
+    // eslint-disable-next-line camelcase
+    aztec_avm_returndataCopy(_foreignRdOffset, _foreignCopySize) {
+        throw new Error('Contract calls are forbidden inside a `TestEnvironment::public_context`, use `public_call` instead');
+    }
+    // eslint-disable-next-line camelcase
+    aztec_avm_call(_foreignL2Gas, _foreignDaGas, _foreignAddress, _foreignLength, _foreignArgs) {
+        throw new Error('Contract calls are forbidden inside a `TestEnvironment::public_context`, use `public_call` instead');
+    }
+    // eslint-disable-next-line camelcase
+    aztec_avm_staticCall(_foreignL2Gas, _foreignDaGas, _foreignAddress, _foreignLength, _foreignArgs) {
+        throw new Error('Contract calls are forbidden inside a `TestEnvironment::public_context`, use `public_call` instead');
+    }
+    // eslint-disable-next-line camelcase
+    aztec_avm_successCopy() {
+        throw new Error('Contract calls are forbidden inside a `TestEnvironment::public_context`, use `public_call` instead');
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_txe_privateCallNewFlow(foreignFrom, foreignTargetContractAddress, foreignFunctionSelector, foreignArgs, foreignArgsHash, foreignIsStaticCall) {
+        const from = addressFromSingle(foreignFrom);
+        const targetContractAddress = addressFromSingle(foreignTargetContractAddress);
+        const functionSelector = FunctionSelector.fromField(fromSingle(foreignFunctionSelector));
+        const args = fromArray(foreignArgs);
+        const argsHash = fromSingle(foreignArgsHash);
+        const isStaticCall = fromSingle(foreignIsStaticCall).toBool();
+        const returnValues = await this.handlerAsTxe().privateCallNewFlow(from, targetContractAddress, functionSelector, args, argsHash, isStaticCall, this.stateHandler.getCurrentJob());
+        // TODO(F-335): Avoid doing the following call here.
+        await this.stateHandler.cycleJob();
+        return toForeignCallResult([
+            toArray(returnValues)
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_txe_executeUtilityFunction(foreignTargetContractAddress, foreignFunctionSelector, foreignArgs) {
+        const targetContractAddress = addressFromSingle(foreignTargetContractAddress);
+        const functionSelector = FunctionSelector.fromField(fromSingle(foreignFunctionSelector));
+        const args = fromArray(foreignArgs);
+        const returnValues = await this.handlerAsTxe().executeUtilityFunction(targetContractAddress, functionSelector, args, this.stateHandler.getCurrentJob());
+        // TODO(F-335): Avoid doing the following call here.
+        await this.stateHandler.cycleJob();
+        return toForeignCallResult([
+            toArray(returnValues)
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_txe_publicCallNewFlow(foreignFrom, foreignAddress, foreignCalldata, foreignIsStaticCall) {
+        const from = addressFromSingle(foreignFrom);
+        const address = addressFromSingle(foreignAddress);
+        const calldata = fromArray(foreignCalldata);
+        const isStaticCall = fromSingle(foreignIsStaticCall).toBool();
+        const returnValues = await this.handlerAsTxe().publicCallNewFlow(from, address, calldata, isStaticCall);
+        // TODO(F-335): Avoid doing the following call here.
+        await this.stateHandler.cycleJob();
+        return toForeignCallResult([
+            toArray(returnValues)
+        ]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_prv_getSenderForTags() {
+        const sender = await this.handlerAsPrivate().getSenderForTags();
+        // Return a Noir Option struct with `some` and `value` fields
+        if (sender === undefined) {
+            // No sender found, return Option with some=0 and value=0
+            return toForeignCallResult([
+                toSingle(0),
+                toSingle(0)
+            ]);
+        } else {
+            // Sender found, return Option with some=1 and value=sender address
+            return toForeignCallResult([
+                toSingle(1),
+                toSingle(sender)
+            ]);
+        }
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_prv_setSenderForTags(foreignSenderForTags) {
+        const senderForTags = AztecAddress.fromField(fromSingle(foreignSenderForTags));
+        await this.handlerAsPrivate().setSenderForTags(senderForTags);
+        return toForeignCallResult([]);
+    }
+    // eslint-disable-next-line camelcase
+    async aztec_prv_getNextAppTagAsSender(foreignSender, foreignRecipient) {
+        const sender = AztecAddress.fromField(fromSingle(foreignSender));
+        const recipient = AztecAddress.fromField(fromSingle(foreignRecipient));
+        const nextAppTag = await this.handlerAsPrivate().getNextAppTagAsSender(sender, recipient);
+        return toForeignCallResult([
+            toSingle(nextAppTag.value)
+        ]);
+    }
+}