@aztec/pxe 0.0.0-test.1 → 0.0.1-commit.001888fc

package/dest/contract_function_simulator/contract_function_simulator.js

@@ -0,0 +1,459 @@
+import { AVM_EMITNOTEHASH_BASE_L2_GAS, AVM_EMITNULLIFIER_BASE_L2_GAS, AVM_SENDL2TOL1MSG_BASE_L2_GAS, DA_GAS_PER_FIELD, FIXED_AVM_STARTUP_L2_GAS, L2_GAS_PER_CONTRACT_CLASS_LOG, L2_GAS_PER_L2_TO_L1_MSG, L2_GAS_PER_NOTE_HASH, L2_GAS_PER_NULLIFIER, L2_GAS_PER_PRIVATE_LOG, MAX_CONTRACT_CLASS_LOGS_PER_TX, MAX_ENQUEUED_CALLS_PER_TX, MAX_L2_TO_L1_MSGS_PER_TX, MAX_NOTE_HASHES_PER_TX, MAX_NOTE_HASH_READ_REQUESTS_PER_TX, MAX_NULLIFIERS_PER_TX, MAX_NULLIFIER_READ_REQUESTS_PER_TX, MAX_PRIVATE_LOGS_PER_TX, MAX_TX_LIFETIME, PRIVATE_TX_L2_GAS_OVERHEAD, PUBLIC_TX_L2_GAS_OVERHEAD, TX_DA_GAS_OVERHEAD } from '@aztec/constants';
+import { arrayNonEmptyLength, padArrayEnd } from '@aztec/foundation/collection';
+import { Fr } from '@aztec/foundation/curves/bn254';
+import { createLogger } from '@aztec/foundation/log';
+import { Timer } from '@aztec/foundation/timer';
+import { getVKTreeRoot } from '@aztec/noir-protocol-circuits-types/vk-tree';
+import { protocolContractsHash } from '@aztec/protocol-contracts';
+import { ExecutionError, createSimulationError, extractCallStack, resolveAssertionMessageFromError, toACVMWitness, witnessMapToFields } from '@aztec/simulator/client';
+import { FunctionSelector, FunctionType } from '@aztec/stdlib/abi';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
+import { Gas } from '@aztec/stdlib/gas';
+import { computeNoteHashNonce, computeProtocolNullifier, computeSiloedPrivateLogFirstField, computeUniqueNoteHash, siloNoteHash, siloNullifier } from '@aztec/stdlib/hash';
+import { ClaimedLengthArray, PartialPrivateTailPublicInputsForPublic, PartialPrivateTailPublicInputsForRollup, PrivateKernelTailCircuitPublicInputs, PrivateToPublicAccumulatedData, PrivateToRollupAccumulatedData, PublicCallRequest, ReadRequestActionEnum, ScopedLogHash, ScopedNoteHash, ScopedNullifier, ScopedReadRequest, buildTransientDataHints, getNoteHashReadRequestResetActions, getNullifierReadRequestResetActions } from '@aztec/stdlib/kernel';
+import { PrivateLog } from '@aztec/stdlib/logs';
+import { ScopedL2ToL1Message } from '@aztec/stdlib/messaging';
+import { ChonkProof } from '@aztec/stdlib/proofs';
+import { CallContext, HashedValues, PrivateExecutionResult, TxConstantData, collectNested, collectNoteHashNullifierCounterMap, getFinalMinRevertibleSideEffectCounter } from '@aztec/stdlib/tx';
+import { ExecutionNoteCache } from './execution_note_cache.js';
+import { ExecutionTaggingIndexCache } from './execution_tagging_index_cache.js';
+import { HashedValuesCache } from './hashed_values_cache.js';
+import { Oracle } from './oracle/oracle.js';
+import { executePrivateFunction } from './oracle/private_execution.js';
+import { PrivateExecutionOracle } from './oracle/private_execution_oracle.js';
+import { UtilityExecutionOracle } from './oracle/utility_execution_oracle.js';
+/**
+ * The contract function simulator.
+ */ export class ContractFunctionSimulator {
+    log;
+    contractStore;
+    noteStore;
+    keyStore;
+    addressStore;
+    aztecNode;
+    senderTaggingStore;
+    recipientTaggingStore;
+    senderAddressBookStore;
+    capsuleStore;
+    privateEventStore;
+    simulator;
+    contractSyncService;
+    messageContextService;
+    constructor(args){
+        this.contractStore = args.contractStore;
+        this.noteStore = args.noteStore;
+        this.keyStore = args.keyStore;
+        this.addressStore = args.addressStore;
+        this.aztecNode = args.aztecNode;
+        this.senderTaggingStore = args.senderTaggingStore;
+        this.recipientTaggingStore = args.recipientTaggingStore;
+        this.senderAddressBookStore = args.senderAddressBookStore;
+        this.capsuleStore = args.capsuleStore;
+        this.privateEventStore = args.privateEventStore;
+        this.simulator = args.simulator;
+        this.contractSyncService = args.contractSyncService;
+        this.messageContextService = args.messageContextService;
+        this.log = createLogger('simulator');
+    }
+    /**
+   * Runs a private function.
+   * @param request - The transaction request.
+   */ async run(request, { contractAddress, selector, msgSender = AztecAddress.fromField(Fr.MAX_FIELD_VALUE), anchorBlockHeader, senderForTags, scopes, jobId }) {
+        const simulatorSetupTimer = new Timer();
+        const entryPointArtifact = await this.contractStore.getFunctionArtifactWithDebugMetadata(contractAddress, selector);
+        if (entryPointArtifact.functionType !== FunctionType.PRIVATE) {
+            throw new Error(`Cannot run ${entryPointArtifact.functionType} function as private`);
+        }
+        if (request.origin !== contractAddress) {
+            this.log.warn(`Request origin does not match contract address in simulation. Request origin: ${request.origin}, contract address: ${contractAddress}`);
+        }
+        // reserve the first side effect for the tx hash (inserted by the private kernel)
+        const startSideEffectCounter = 2;
+        const callContext = new CallContext(msgSender, contractAddress, await FunctionSelector.fromNameAndParameters(entryPointArtifact.name, entryPointArtifact.parameters), entryPointArtifact.isStatic);
+        const protocolNullifier = await computeProtocolNullifier(await request.toTxRequest().hash());
+        const noteCache = new ExecutionNoteCache(protocolNullifier);
+        const taggingIndexCache = new ExecutionTaggingIndexCache();
+        const privateExecutionOracle = new PrivateExecutionOracle({
+            argsHash: request.firstCallArgsHash,
+            txContext: request.txContext,
+            callContext,
+            anchorBlockHeader,
+            utilityExecutor: async (call, execScopes)=>{
+                await this.runUtility(call, [], anchorBlockHeader, execScopes, jobId);
+            },
+            authWitnesses: request.authWitnesses,
+            capsules: request.capsules,
+            executionCache: HashedValuesCache.create(request.argsOfCalls),
+            noteCache,
+            taggingIndexCache,
+            contractStore: this.contractStore,
+            noteStore: this.noteStore,
+            keyStore: this.keyStore,
+            addressStore: this.addressStore,
+            aztecNode: this.aztecNode,
+            senderTaggingStore: this.senderTaggingStore,
+            recipientTaggingStore: this.recipientTaggingStore,
+            senderAddressBookStore: this.senderAddressBookStore,
+            capsuleStore: this.capsuleStore,
+            privateEventStore: this.privateEventStore,
+            messageContextService: this.messageContextService,
+            contractSyncService: this.contractSyncService,
+            jobId,
+            totalPublicCalldataCount: 0,
+            sideEffectCounter: startSideEffectCounter,
+            scopes,
+            senderForTags,
+            simulator: this.simulator
+        });
+        const setupTime = simulatorSetupTimer.ms();
+        try {
+            // Note: any nested private function calls are made recursively within this
+            // function call. So this execution result is the result of executing _all_
+            // private functions of this tx (the results of those executions are contained
+            // within executionResult.nestedExecutionResults).
+            const executionResult = await executePrivateFunction(this.simulator, privateExecutionOracle, entryPointArtifact, contractAddress, request.functionSelector);
+            const simulatorTeardownTimer = new Timer();
+            noteCache.finish();
+            const firstNullifierHint = noteCache.getNonceGenerator();
+            const publicCallRequests = collectNested([
+                executionResult
+            ], (r)=>r.publicInputs.publicCallRequests.getActiveItems().map((r)=>r.inner).concat(r.publicInputs.publicTeardownCallRequest.isEmpty() ? [] : [
+                    r.publicInputs.publicTeardownCallRequest
+                ]));
+            const publicFunctionsCalldata = await Promise.all(publicCallRequests.map(async (r)=>{
+                const calldata = await privateExecutionOracle.loadFromExecutionCache(r.calldataHash);
+                return new HashedValues(calldata, r.calldataHash);
+            }));
+            const teardownTime = simulatorTeardownTimer.ms();
+            // Add simulator overhead to topmost call in the stack
+            if (executionResult.profileResult) {
+                executionResult.profileResult.timings.witgen += setupTime + teardownTime;
+            }
+            // Not to be confused with a PrivateCallExecutionResult. This is a superset
+            // of the PrivateCallExecutionResult, containing also firstNullifierHint
+            // and publicFunctionsCalldata.
+            return new PrivateExecutionResult(executionResult, firstNullifierHint, publicFunctionsCalldata);
+        } catch (err) {
+            throw createSimulationError(err instanceof Error ? err : new Error('Unknown error during private execution'));
+        }
+    }
+    // docs:start:execute_utility_function
+    /**
+   * Runs a utility function.
+   * @param call - The function call to execute.
+   * @param authwits - Authentication witnesses required for the function call.
+   * @param anchorBlockHeader - The block header to use as base state for this run.
+   * @param scopes - Optional array of account addresses whose notes can be accessed in this call. Defaults to all
+   * accounts if not specified.
+   * @returns A return value of the utility function in a form as returned by the simulator (Noir fields)
+   */ async runUtility(call, authwits, anchorBlockHeader, scopes, jobId) {
+        const entryPointArtifact = await this.contractStore.getFunctionArtifactWithDebugMetadata(call.to, call.selector);
+        if (entryPointArtifact.functionType !== FunctionType.UTILITY) {
+            throw new Error(`Cannot run ${entryPointArtifact.functionType} function as utility`);
+        }
+        const oracle = new UtilityExecutionOracle({
+            contractAddress: call.to,
+            authWitnesses: authwits,
+            capsules: [],
+            anchorBlockHeader,
+            contractStore: this.contractStore,
+            noteStore: this.noteStore,
+            keyStore: this.keyStore,
+            addressStore: this.addressStore,
+            aztecNode: this.aztecNode,
+            recipientTaggingStore: this.recipientTaggingStore,
+            senderAddressBookStore: this.senderAddressBookStore,
+            capsuleStore: this.capsuleStore,
+            privateEventStore: this.privateEventStore,
+            messageContextService: this.messageContextService,
+            jobId,
+            scopes
+        });
+        try {
+            this.log.verbose(`Executing utility function ${entryPointArtifact.name}`, {
+                contract: call.to,
+                selector: call.selector
+            });
+            const initialWitness = toACVMWitness(0, call.args);
+            const acirExecutionResult = await this.simulator.executeUserCircuit(initialWitness, entryPointArtifact, new Oracle(oracle).toACIRCallback()).catch((err)=>{
+                err.message = resolveAssertionMessageFromError(err, entryPointArtifact);
+                throw new ExecutionError(err.message, {
+                    contractAddress: call.to,
+                    functionSelector: call.selector
+                }, extractCallStack(err, entryPointArtifact.debug), {
+                    cause: err
+                });
+            });
+            this.log.verbose(`Utility execution for ${call.to}.${call.selector} completed`);
+            return {
+                result: witnessMapToFields(acirExecutionResult.returnWitness),
+                offchainEffects: oracle.getOffchainEffects()
+            };
+        } catch (err) {
+            throw createSimulationError(err instanceof Error ? err : new Error('Unknown error during private execution'));
+        }
+    }
+    // docs:end:execute_utility_function
+    /**
+   * Returns the execution statistics collected during the simulator run.
+   * @returns The execution statistics.
+   */ getStats() {
+        const nodeRPCCalls = typeof this.aztecNode.getStats === 'function' ? this.aztecNode.getStats() : {
+            perMethod: {},
+            roundTrips: {
+                roundTrips: 0,
+                totalBlockingTime: 0,
+                roundTripDurations: [],
+                roundTripMethods: []
+            }
+        };
+        return {
+            nodeRPCCalls
+        };
+    }
+}
+class OrderedSideEffect {
+    sideEffect;
+    counter;
+    constructor(sideEffect, counter){
+        this.sideEffect = sideEffect;
+        this.counter = counter;
+    }
+}
+/**
+ * Generates the final public inputs of the tail kernel circuit, an empty Chonk proof
+ * and the execution steps for a `PrivateExecutionResult` as if it had been
+ * processed by the private kernel prover. This skips many of the checks performed by the kernels
+ * (allowing state overrides) and is much faster, while still generating a valid
+ * output that can be sent to the node for public simulation
+ * @param privateExecutionResult - The result of the private execution.
+ * @param debugFunctionNameGetter - A provider for contract data in order to get function names and debug info.
+ * @param node - AztecNode for verifying settled read requests against the note hash and nullifier trees.
+ * @param minRevertibleSideEffectCounterOverride - Optional override for the min revertible side effect counter.
+ * Used by TXE to simulate account contract behavior (setting the counter before app execution).
+ * @returns The simulated proving result.
+ */ export async function generateSimulatedProvingResult(privateExecutionResult, debugFunctionNameGetter, node, minRevertibleSideEffectCounterOverride) {
+    const taggedPrivateLogs = [];
+    const l2ToL1Messages = [];
+    const contractClassLogsHashes = [];
+    const publicCallRequests = [];
+    const executionSteps = [];
+    // Unsiloed scoped arrays — used for squashing, read request verification,
+    // and siloed at the end only for the surviving items
+    const scopedNoteHashes = [];
+    const scopedNullifiers = [];
+    // Read requests for verification
+    const noteHashReadRequests = [];
+    const nullifierReadRequests = [];
+    let publicTeardownCallRequest;
+    // We set expiration timestamp to anchor_block_timestamp + MAX_TX_LIFETIME (24h) just like kernels do
+    let expirationTimestamp = privateExecutionResult.entrypoint.publicInputs.anchorBlockHeader.globalVariables.timestamp + BigInt(MAX_TX_LIFETIME);
+    const executions = [
+        privateExecutionResult.entrypoint
+    ];
+    while(executions.length !== 0){
+        const execution = executions.shift();
+        executions.unshift(...execution.nestedExecutionResults);
+        // Just like kernels we overwrite the default value if the call sets it.
+        const callExpirationTimestamp = execution.publicInputs.expirationTimestamp;
+        if (callExpirationTimestamp !== 0n && callExpirationTimestamp < expirationTimestamp) {
+            expirationTimestamp = callExpirationTimestamp;
+        }
+        const { contractAddress } = execution.publicInputs.callContext;
+        scopedNoteHashes.push(...execution.publicInputs.noteHashes.getActiveItems().filter((nh)=>!nh.isEmpty()).map((nh)=>nh.scope(contractAddress)));
+        scopedNullifiers.push(...execution.publicInputs.nullifiers.getActiveItems().map((n)=>n.scope(contractAddress)));
+        taggedPrivateLogs.push(...await Promise.all(execution.publicInputs.privateLogs.getActiveItems().map(async (metadata)=>{
+            metadata.log.fields[0] = await computeSiloedPrivateLogFirstField(contractAddress, metadata.log.fields[0]);
+            return new OrderedSideEffect(metadata, metadata.counter);
+        })));
+        noteHashReadRequests.push(...execution.publicInputs.noteHashReadRequests.getActiveItems());
+        nullifierReadRequests.push(...execution.publicInputs.nullifierReadRequests.getActiveItems());
+        l2ToL1Messages.push(...execution.publicInputs.l2ToL1Msgs.getActiveItems().map((message)=>new OrderedSideEffect(message.message.scope(contractAddress), message.counter)));
+        contractClassLogsHashes.push(...execution.publicInputs.contractClassLogsHashes.getActiveItems().map((contractClassLogHash)=>new OrderedSideEffect(contractClassLogHash.logHash.scope(contractAddress), contractClassLogHash.counter)));
+        publicCallRequests.push(...execution.publicInputs.publicCallRequests.getActiveItems().map((callRequest)=>new OrderedSideEffect(callRequest.inner, callRequest.counter)));
+        if (publicTeardownCallRequest !== undefined && !execution.publicInputs.publicTeardownCallRequest.isEmpty()) {
+            throw new Error('Trying to set multiple teardown requests');
+        }
+        publicTeardownCallRequest = execution.publicInputs.publicTeardownCallRequest.isEmpty() ? publicTeardownCallRequest : execution.publicInputs.publicTeardownCallRequest;
+        executionSteps.push({
+            functionName: await debugFunctionNameGetter(execution.publicInputs.callContext.contractAddress, execution.publicInputs.callContext.functionSelector),
+            timings: execution.profileResult?.timings ?? {
+                witgen: 0,
+                oracles: {}
+            },
+            bytecode: execution.acir,
+            vk: execution.vk,
+            witness: execution.partialWitness
+        });
+    }
+    const noteHashNullifierCounterMap = collectNoteHashNullifierCounterMap(privateExecutionResult);
+    const minRevertibleSideEffectCounter = minRevertibleSideEffectCounterOverride ?? getFinalMinRevertibleSideEffectCounter(privateExecutionResult);
+    const scopedNoteHashesCLA = new ClaimedLengthArray(padArrayEnd(scopedNoteHashes, ScopedNoteHash.empty(), MAX_NOTE_HASHES_PER_TX), scopedNoteHashes.length);
+    const scopedNullifiersCLA = new ClaimedLengthArray(padArrayEnd(scopedNullifiers, ScopedNullifier.empty(), MAX_NULLIFIERS_PER_TX), scopedNullifiers.length);
+    const { filteredNoteHashes, filteredNullifiers, filteredPrivateLogs } = squashTransientSideEffects(taggedPrivateLogs, scopedNoteHashesCLA, scopedNullifiersCLA, noteHashNullifierCounterMap, minRevertibleSideEffectCounter);
+    await verifyReadRequests(node, await privateExecutionResult.entrypoint.publicInputs.anchorBlockHeader.hash(), noteHashReadRequests, nullifierReadRequests, scopedNoteHashesCLA, scopedNullifiersCLA);
+    const siloedNoteHashes = await Promise.all(filteredNoteHashes.sort((a, b)=>a.counter - b.counter).map(async (nh)=>new OrderedSideEffect(await siloNoteHash(nh.contractAddress, nh.value), nh.counter)));
+    const siloedNullifiers = await Promise.all(filteredNullifiers.sort((a, b)=>a.counter - b.counter).map(async (n)=>new OrderedSideEffect(await siloNullifier(n.contractAddress, n.value), n.counter)));
+    const constantData = new TxConstantData(privateExecutionResult.entrypoint.publicInputs.anchorBlockHeader, privateExecutionResult.entrypoint.publicInputs.txContext, getVKTreeRoot(), protocolContractsHash);
+    const hasPublicCalls = privateExecutionResult.publicFunctionCalldata.length !== 0;
+    let inputsForRollup;
+    let inputsForPublic;
+    let gasUsed;
+    const sortByCounter = (a, b)=>a.counter - b.counter;
+    const getEffect = (orderedSideEffect)=>orderedSideEffect.sideEffect;
+    const isPrivateOnlyTx = privateExecutionResult.publicFunctionCalldata.length === 0;
+    const [nonRevertibleNullifiers, revertibleNullifiers] = splitOrderedSideEffects(siloedNullifiers, minRevertibleSideEffectCounter);
+    const nonceGenerator = privateExecutionResult.firstNullifier;
+    if (nonRevertibleNullifiers.length === 0) {
+        nonRevertibleNullifiers.push(nonceGenerator);
+    } else if (!nonRevertibleNullifiers[0].equals(nonceGenerator)) {
+        throw new Error('The first non revertible nullifier should be equal to the nonce generator. This is a bug!');
+    }
+    if (isPrivateOnlyTx) {
+        // We must make the note hashes unique by using the
+        // nonce generator and their index in the tx.
+        const uniqueNoteHashes = await Promise.all(siloedNoteHashes.map(async (orderedSideEffect, i)=>{
+            const siloedNoteHash = orderedSideEffect.sideEffect;
+            const nonce = await computeNoteHashNonce(nonceGenerator, i);
+            const uniqueNoteHash = await computeUniqueNoteHash(nonce, siloedNoteHash);
+            return uniqueNoteHash;
+        }));
+        const accumulatedDataForRollup = new PrivateToRollupAccumulatedData(padArrayEnd(uniqueNoteHashes, Fr.ZERO, MAX_NOTE_HASHES_PER_TX), padArrayEnd(nonRevertibleNullifiers.concat(revertibleNullifiers), Fr.ZERO, MAX_NULLIFIERS_PER_TX), padArrayEnd(l2ToL1Messages.sort(sortByCounter).map(getEffect), ScopedL2ToL1Message.empty(), MAX_L2_TO_L1_MSGS_PER_TX), padArrayEnd(filteredPrivateLogs.sort(sortByCounter).map(getEffect), PrivateLog.empty(), MAX_PRIVATE_LOGS_PER_TX), padArrayEnd(contractClassLogsHashes.sort(sortByCounter).map(getEffect), ScopedLogHash.empty(), MAX_CONTRACT_CLASS_LOGS_PER_TX));
+        gasUsed = meterGasUsed(accumulatedDataForRollup, isPrivateOnlyTx);
+        inputsForRollup = new PartialPrivateTailPublicInputsForRollup(accumulatedDataForRollup);
+    } else {
+        const [nonRevertibleNoteHashes, revertibleNoteHashes] = splitOrderedSideEffects(siloedNoteHashes, minRevertibleSideEffectCounter);
+        const nonRevertibleUniqueNoteHashes = await Promise.all(nonRevertibleNoteHashes.map(async (noteHash, i)=>{
+            const nonce = await computeNoteHashNonce(nonceGenerator, i);
+            return await computeUniqueNoteHash(nonce, noteHash);
+        }));
+        const [nonRevertibleL2ToL1Messages, revertibleL2ToL1Messages] = splitOrderedSideEffects(l2ToL1Messages.sort(sortByCounter), minRevertibleSideEffectCounter);
+        const [nonRevertibleTaggedPrivateLogs, revertibleTaggedPrivateLogs] = splitOrderedSideEffects(filteredPrivateLogs, minRevertibleSideEffectCounter);
+        const [nonRevertibleContractClassLogHashes, revertibleContractClassLogHashes] = splitOrderedSideEffects(contractClassLogsHashes.sort(sortByCounter), minRevertibleSideEffectCounter);
+        const [nonRevertiblePublicCallRequests, revertiblePublicCallRequests] = splitOrderedSideEffects(publicCallRequests.sort(sortByCounter), minRevertibleSideEffectCounter);
+        const nonRevertibleData = new PrivateToPublicAccumulatedData(padArrayEnd(nonRevertibleUniqueNoteHashes, Fr.ZERO, MAX_NOTE_HASHES_PER_TX), padArrayEnd(nonRevertibleNullifiers, Fr.ZERO, MAX_NULLIFIERS_PER_TX), padArrayEnd(nonRevertibleL2ToL1Messages, ScopedL2ToL1Message.empty(), MAX_L2_TO_L1_MSGS_PER_TX), padArrayEnd(nonRevertibleTaggedPrivateLogs, PrivateLog.empty(), MAX_PRIVATE_LOGS_PER_TX), padArrayEnd(nonRevertibleContractClassLogHashes, ScopedLogHash.empty(), MAX_CONTRACT_CLASS_LOGS_PER_TX), padArrayEnd(nonRevertiblePublicCallRequests, PublicCallRequest.empty(), MAX_ENQUEUED_CALLS_PER_TX));
+        const revertibleData = new PrivateToPublicAccumulatedData(padArrayEnd(revertibleNoteHashes, Fr.ZERO, MAX_NOTE_HASHES_PER_TX), padArrayEnd(revertibleNullifiers, Fr.ZERO, MAX_NULLIFIERS_PER_TX), padArrayEnd(revertibleL2ToL1Messages, ScopedL2ToL1Message.empty(), MAX_L2_TO_L1_MSGS_PER_TX), padArrayEnd(revertibleTaggedPrivateLogs, PrivateLog.empty(), MAX_PRIVATE_LOGS_PER_TX), padArrayEnd(revertibleContractClassLogHashes, ScopedLogHash.empty(), MAX_CONTRACT_CLASS_LOGS_PER_TX), padArrayEnd(revertiblePublicCallRequests, PublicCallRequest.empty(), MAX_ENQUEUED_CALLS_PER_TX));
+        gasUsed = meterGasUsed(revertibleData, isPrivateOnlyTx).add(meterGasUsed(nonRevertibleData, isPrivateOnlyTx));
+        if (publicTeardownCallRequest) {
+            gasUsed = gasUsed.add(privateExecutionResult.entrypoint.publicInputs.txContext.gasSettings.teardownGasLimits);
+        }
+        inputsForPublic = new PartialPrivateTailPublicInputsForPublic(nonRevertibleData, revertibleData, publicTeardownCallRequest ?? PublicCallRequest.empty());
+    }
+    const publicInputs = new PrivateKernelTailCircuitPublicInputs(constantData, /*gasUsed=*/ gasUsed.add(Gas.from({
+        l2Gas: isPrivateOnlyTx ? PRIVATE_TX_L2_GAS_OVERHEAD : PUBLIC_TX_L2_GAS_OVERHEAD,
+        daGas: TX_DA_GAS_OVERHEAD
+    })), /*feePayer=*/ AztecAddress.zero(), /*expirationTimestamp=*/ expirationTimestamp, hasPublicCalls ? inputsForPublic : undefined, !hasPublicCalls ? inputsForRollup : undefined);
+    return {
+        publicInputs,
+        chonkProof: ChonkProof.empty(),
+        executionSteps
+    };
+}
+/**
+ * Squashes transient note hashes and nullifiers, mimicking the behavior
+ * of the reset kernels. Returns the filtered (surviving) scoped items and private logs.
+ */ function squashTransientSideEffects(taggedPrivateLogs, scopedNoteHashesCLA, scopedNullifiersCLA, noteHashNullifierCounterMap, minRevertibleSideEffectCounter) {
+    const { numTransientData, hints: transientDataHints } = buildTransientDataHints(scopedNoteHashesCLA, scopedNullifiersCLA, /*futureNoteHashReads=*/ [], /*futureNullifierReads=*/ [], /*futureLogs=*/ [], noteHashNullifierCounterMap, minRevertibleSideEffectCounter);
+    const squashedNoteHashCounters = new Set();
+    const squashedNullifierCounters = new Set();
+    for(let i = 0; i < numTransientData; i++){
+        const hint = transientDataHints[i];
+        squashedNoteHashCounters.add(scopedNoteHashesCLA.array[hint.noteHashIndex].counter);
+        squashedNullifierCounters.add(scopedNullifiersCLA.array[hint.nullifierIndex].counter);
+    }
+    return {
+        filteredNoteHashes: scopedNoteHashesCLA.getActiveItems().filter((nh)=>!squashedNoteHashCounters.has(nh.counter)),
+        filteredNullifiers: scopedNullifiersCLA.getActiveItems().filter((n)=>!squashedNullifierCounters.has(n.counter)),
+        filteredPrivateLogs: taggedPrivateLogs.filter((item)=>!squashedNoteHashCounters.has(item.sideEffect.noteHashCounter)).map((item)=>new OrderedSideEffect(item.sideEffect.log, item.counter))
+    };
+}
+/**
+ * Verifies settled read requests by checking membership in the note hash and nullifier trees
+ * at the tx's anchor block, mimicking the behavior of the kernels
+ */ async function verifyReadRequests(node, anchorBlockHash, noteHashReadRequests, nullifierReadRequests, scopedNoteHashesCLA, scopedNullifiersCLA) {
+    const noteHashReadRequestsCLA = new ClaimedLengthArray(padArrayEnd(noteHashReadRequests, ScopedReadRequest.empty(), MAX_NOTE_HASH_READ_REQUESTS_PER_TX), noteHashReadRequests.length);
+    const nullifierReadRequestsCLA = new ClaimedLengthArray(padArrayEnd(nullifierReadRequests, ScopedReadRequest.empty(), MAX_NULLIFIER_READ_REQUESTS_PER_TX), nullifierReadRequests.length);
+    const noteHashResetActions = getNoteHashReadRequestResetActions(noteHashReadRequestsCLA, scopedNoteHashesCLA);
+    const nullifierResetActions = getNullifierReadRequestResetActions(nullifierReadRequestsCLA, scopedNullifiersCLA);
+    const settledNoteHashReads = [];
+    for(let i = 0; i < noteHashResetActions.actions.length; i++){
+        if (noteHashResetActions.actions[i] === ReadRequestActionEnum.READ_AS_SETTLED) {
+            settledNoteHashReads.push({
+                index: i,
+                value: noteHashReadRequests[i].value
+            });
+        }
+    }
+    const settledNullifierReads = [];
+    for(let i = 0; i < nullifierResetActions.actions.length; i++){
+        if (nullifierResetActions.actions[i] === ReadRequestActionEnum.READ_AS_SETTLED) {
+            settledNullifierReads.push({
+                index: i,
+                value: nullifierReadRequests[i].value
+            });
+        }
+    }
+    const [noteHashWitnesses, nullifierWitnesses] = await Promise.all([
+        Promise.all(settledNoteHashReads.map(({ value })=>node.getNoteHashMembershipWitness(anchorBlockHash, value))),
+        Promise.all(settledNullifierReads.map(({ value })=>node.getNullifierMembershipWitness(anchorBlockHash, value)))
+    ]);
+    for(let i = 0; i < settledNoteHashReads.length; i++){
+        if (!noteHashWitnesses[i]) {
+            throw new Error(`Note hash read request at index ${settledNoteHashReads[i].index} is reading an unknown note hash: ${settledNoteHashReads[i].value}`);
+        }
+    }
+    for(let i = 0; i < settledNullifierReads.length; i++){
+        if (!nullifierWitnesses[i]) {
+            throw new Error(`Nullifier read request at index ${settledNullifierReads[i].index} is reading an unknown nullifier: ${settledNullifierReads[i].value}`);
+        }
+    }
+}
+function splitOrderedSideEffects(effects, minRevertibleSideEffectCounter) {
+    const revertibleSideEffects = [];
+    const nonRevertibleSideEffects = [];
+    effects.forEach((effect)=>{
+        if (minRevertibleSideEffectCounter === 0 || effect.counter < minRevertibleSideEffectCounter) {
+            nonRevertibleSideEffects.push(effect.sideEffect);
+        } else {
+            revertibleSideEffects.push(effect.sideEffect);
+        }
+    });
+    return [
+        nonRevertibleSideEffects,
+        revertibleSideEffects
+    ];
+}
+function meterGasUsed(data, isPrivateOnlyTx) {
+    let meteredDAFields = 0;
+    let meteredL2Gas = 0;
+    const numNoteHashes = arrayNonEmptyLength(data.noteHashes, (hash)=>hash.isEmpty());
+    meteredDAFields += numNoteHashes;
+    const noteHashBaseGas = isPrivateOnlyTx ? L2_GAS_PER_NOTE_HASH : AVM_EMITNOTEHASH_BASE_L2_GAS;
+    meteredL2Gas += numNoteHashes * noteHashBaseGas;
+    const numNullifiers = arrayNonEmptyLength(data.nullifiers, (nullifier)=>nullifier.isEmpty());
+    meteredDAFields += numNullifiers;
+    const nullifierBaseGas = isPrivateOnlyTx ? L2_GAS_PER_NULLIFIER : AVM_EMITNULLIFIER_BASE_L2_GAS;
+    meteredL2Gas += numNullifiers * nullifierBaseGas;
+    const numL2toL1Messages = arrayNonEmptyLength(data.l2ToL1Msgs, (msg)=>msg.isEmpty());
+    meteredDAFields += numL2toL1Messages;
+    const l2ToL1MessageBaseGas = isPrivateOnlyTx ? L2_GAS_PER_L2_TO_L1_MSG : AVM_SENDL2TOL1MSG_BASE_L2_GAS;
+    meteredL2Gas += numL2toL1Messages * l2ToL1MessageBaseGas;
+    const numPrivatelogs = arrayNonEmptyLength(data.privateLogs, (log)=>log.isEmpty());
+    // Every private log emits its length as an additional field
+    meteredDAFields += data.privateLogs.reduce((acc, log)=>!log.isEmpty() ? acc + log.emittedLength + 1 : acc, 0);
+    meteredL2Gas += numPrivatelogs * L2_GAS_PER_PRIVATE_LOG;
+    const numContractClassLogs = arrayNonEmptyLength(data.contractClassLogsHashes, (log)=>log.isEmpty());
+    // Every contract class log emits its contract address as an additional field
+    meteredDAFields += data.contractClassLogsHashes.reduce((acc, log)=>!log.isEmpty() ? acc + log.logHash.length + 1 : acc, 0);
+    meteredL2Gas += numContractClassLogs * L2_GAS_PER_CONTRACT_CLASS_LOG;
+    const meteredDAGas = meteredDAFields * DA_GAS_PER_FIELD;
+    if (data.publicCallRequests) {
+        const dataForPublic = data;
+        const numPublicCallRequests = arrayNonEmptyLength(dataForPublic.publicCallRequests, (req)=>req.isEmpty());
+        meteredL2Gas += numPublicCallRequests * FIXED_AVM_STARTUP_L2_GAS;
+    }
+    return Gas.from({
+        l2Gas: meteredL2Gas,
+        daGas: meteredDAGas
+    });
+}

package/dest/contract_function_simulator/execution_note_cache.d.ts

@@ -0,0 +1,104 @@
+import { Fr } from '@aztec/foundation/curves/bn254';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { NoteData } from './oracle/interfaces.js';
+interface PendingNote {
+    note: NoteData;
+    counter: number;
+    noteHashForConsumption: Fr;
+}
+/**
+ * Data that's accessible by all the function calls in an execution.
+ */
+export declare class ExecutionNoteCache {
+    #private;
+    private readonly protocolNullifier;
+    /**
+     * New notes created in this transaction.
+     * They are pushed to this array in the same order as they are emitted.
+     */
+    private notes;
+    /**
+     * This mapping maps from a contract address to the notes in the contract.
+     */
+    private noteMap;
+    /**
+     * This maps from a contract address to the nullifiers emitted from the contract.
+     * The note which is nullified might be new or not (i.e., was generated in a previous transaction).
+     * Note that their value (bigint representation) is used because Frs cannot be looked up in Sets.
+     */
+    private nullifierMap;
+    /**
+     * Nullifiers emitted by private calls in this transaction.
+     */
+    private emittedNullifiers;
+    /**
+     * The counter that separates non-revertible side effects (which persist even if the tx reverts) from revertible ones.
+     */
+    private minRevertibleSideEffectCounter;
+    private inRevertiblePhase;
+    /**
+     * Whether the protocol nullifier was used for nonce generation.
+     * We don't need to use the protocol nullifier if a non-revertible nullifier is emitted.
+     */
+    private usedProtocolNullifierForNonces;
+    constructor(protocolNullifier: Fr);
+    /**
+     * Enters the revertible phase of the transaction.
+     * @param minRevertibleSideEffectCounter - The counter at which the transaction enters the revertible phase.
+     */
+    setMinRevertibleSideEffectCounter(minRevertibleSideEffectCounter: number): Promise<void>;
+    isSideEffectCounterRevertible(sideEffectCounter: number): boolean;
+    finish(): void;
+    /**
+     * Add a new note to cache.
+     * @param note - New note created during execution.
+     */
+    addNewNote(note: NoteData, counter: number): void;
+    /**
+     * Add a nullifier to cache. It could be for a db note or a new note created during execution.
+     * @param contractAddress - Contract address of the note.
+     * @param innerNullifier - Inner nullifier of the note.
+     * @param noteHash - A hash of the note. If this value equals 0, it means the note being nullified is from a previous
+     * transaction (and thus not a new note).
+     */
+    nullifyNote(contractAddress: AztecAddress, innerNullifier: Fr, noteHash: Fr): Promise<number | undefined>;
+    /**
+     * Adds a nullifier to the cache. Note cache needs to track all nullifiers to decide which nullifier to use for note siloing.
+     * @param contractAddress - Contract address that emitted the nullifier.
+     * @param innerNullifier
+     */
+    nullifierCreated(contractAddress: AztecAddress, innerNullifier: Fr): Promise<void>;
+    /**
+     * Return notes created up to current point in execution.
+     * If a nullifier for a note in this list is emitted, the note will be deleted.
+     * @param contractAddress - Contract address of the notes.
+     * @param owner - Owner of the notes. If undefined, returns all notes regardless of owner.
+     * @param storageSlot - Storage slot of the notes.
+     **/
+    getNotes(contractAddress: AztecAddress, owner: AztecAddress | undefined, storageSlot: Fr): NoteData[];
+    /**
+     * Check if a note exists in the newNotes array.
+     * @param contractAddress - Contract address of the note.
+     * @param storageSlot - Storage slot of the note.
+     * @param noteHash - A hash of the note.
+     **/
+    checkNoteExists(contractAddress: AztecAddress, noteHash: Fr): boolean;
+    /**
+     * Return all nullifiers emitted from a contract.
+     * @param contractAddress - Address of the contract.
+     */
+    getNullifiers(contractAddress: AztecAddress): Set<bigint>;
+    getAllNotes(): PendingNote[];
+    /**
+     * @returns All nullifiers emitted by private calls in this transaction.
+     */
+    getEmittedNullifiers(): Fr[];
+    /**
+     * @returns All nullifiers emitted by private calls in this transaction. If the protocol nullifier was used as the
+     * nonce generator, it is injected as the first nullifier.
+     */
+    getAllNullifiers(): Fr[];
+    getNonceGenerator(): Fr;
+}
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXhlY3V0aW9uX25vdGVfY2FjaGUuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9jb250cmFjdF9mdW5jdGlvbl9zaW11bGF0b3IvZXhlY3V0aW9uX25vdGVfY2FjaGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLEVBQUUsRUFBRSxNQUFNLGdDQUFnQyxDQUFDO0FBQ3BELE9BQU8sS0FBSyxFQUFFLFlBQVksRUFBRSxNQUFNLDZCQUE2QixDQUFDO0FBR2hFLE9BQU8sS0FBSyxFQUFFLFFBQVEsRUFBRSxNQUFNLHdCQUF3QixDQUFDO0FBRXZELFVBQVUsV0FBVztJQUNuQixJQUFJLEVBQUUsUUFBUSxDQUFDO0lBQ2YsT0FBTyxFQUFFLE1BQU0sQ0FBQztJQUNoQixzQkFBc0IsRUFBRSxFQUFFLENBQUM7Q0FDNUI7QUFFRDs7R0FFRztBQUNILHFCQUFhLGtCQUFrQjs7SUFvQ2pCLE9BQU8sQ0FBQyxRQUFRLENBQUMsaUJBQWlCO0lBbkM5Qzs7O09BR0c7SUFDSCxPQUFPLENBQUMsS0FBSyxDQUFxQjtJQUNsQzs7T0FFRztJQUNILE9BQU8sQ0FBQyxPQUFPLENBQXlDO0lBRXhEOzs7O09BSUc7SUFDSCxPQUFPLENBQUMsWUFBWSxDQUF1QztJQUUzRDs7T0FFRztJQUNILE9BQU8sQ0FBQyxpQkFBaUIsQ0FBMEI7SUFFbkQ7O09BRUc7SUFDSCxPQUFPLENBQUMsOEJBQThCLENBQUs7SUFFM0MsT0FBTyxDQUFDLGlCQUFpQixDQUFTO0lBRWxDOzs7T0FHRztJQUNILE9BQU8sQ0FBQyw4QkFBOEIsQ0FBc0I7SUFFNUQsWUFBNkIsaUJBQWlCLEVBQUUsRUFBRSxFQUFJO0lBRXREOzs7T0FHRztJQUNVLGlDQUFpQyxDQUFDLDhCQUE4QixFQUFFLE1BQU0saUJBc0NwRjtJQUVNLDZCQUE2QixDQUFDLGlCQUFpQixFQUFFLE1BQU0sR0FBRyxPQUFPLENBS3ZFO0lBRU0sTUFBTSxTQU1aO0lBRUQ7OztPQUdHO0lBQ0ksVUFBVSxDQUFDLElBQUksRUFBRSxRQUFRLEVBQUUsT0FBTyxFQUFFLE1BQU0sUUFTaEQ7SUFFRDs7Ozs7O09BTUc7SUFDVSxXQUFXLENBQUMsZUFBZSxFQUFFLFlBQVksRUFBRSxjQUFjLEVBQUUsRUFBRSxFQUFFLFFBQVEsRUFBRSxFQUFFLCtCQXlCdkY7SUFFRDs7OztPQUlHO0lBQ1UsZ0JBQWdCLENBQUMsZUFBZSxFQUFFLFlBQVksRUFBRSxjQUFjLEVBQUUsRUFBRSxpQkFHOUU7SUFFRDs7Ozs7O1FBTUk7SUFDRyxRQUFRLENBQUMsZUFBZSxFQUFFLFlBQVksRUFBRSxLQUFLLEVBQUUsWUFBWSxHQUFHLFNBQVMsRUFBRSxXQUFXLEVBQUUsRUFBRSxjQU05RjtJQUVEOzs7OztRQUtJO0lBQ0csZUFBZSxDQUFDLGVBQWUsRUFBRSxZQUFZLEVBQUUsUUFBUSxFQUFFLEVBQUUsV0FHakU7SUFFRDs7O09BR0c7SUFDSSxhQUFhLENBQUMsZUFBZSxFQUFFLFlBQVksR0FBRyxHQUFHLENBQUMsTUFBTSxDQUFDLENBRS9EO0lBVUQsV0FBVyxJQUFJLFdBQVcsRUFBRSxDQUUzQjtJQUVEOztPQUVHO0lBQ0gsb0JBQW9CLElBQUksRUFBRSxFQUFFLENBRTNCO0lBRUQ7OztPQUdHO0lBQ0gsZ0JBQWdCLElBQUksRUFBRSxFQUFFLENBTXZCO0lBRUQsaUJBQWlCLElBQUksRUFBRSxDQUV0QjtDQWFGIn0=

package/dest/contract_function_simulator/execution_note_cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"execution_note_cache.d.ts","sourceRoot":"","sources":["../../src/contract_function_simulator/execution_note_cache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,gCAAgC,CAAC;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAGhE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAEvD,UAAU,WAAW;IACnB,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,sBAAsB,EAAE,EAAE,CAAC;CAC5B;AAED;;GAEG;AACH,qBAAa,kBAAkB;;IAoCjB,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAnC9C;;;OAGG;IACH,OAAO,CAAC,KAAK,CAAqB;IAClC;;OAEG;IACH,OAAO,CAAC,OAAO,CAAyC;IAExD;;;;OAIG;IACH,OAAO,CAAC,YAAY,CAAuC;IAE3D;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAA0B;IAEnD;;OAEG;IACH,OAAO,CAAC,8BAA8B,CAAK;IAE3C,OAAO,CAAC,iBAAiB,CAAS;IAElC;;;OAGG;IACH,OAAO,CAAC,8BAA8B,CAAsB;IAE5D,YAA6B,iBAAiB,EAAE,EAAE,EAAI;IAEtD;;;OAGG;IACU,iCAAiC,CAAC,8BAA8B,EAAE,MAAM,iBAsCpF;IAEM,6BAA6B,CAAC,iBAAiB,EAAE,MAAM,GAAG,OAAO,CAKvE;IAEM,MAAM,SAMZ;IAED;;;OAGG;IACI,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,QAShD;IAED;;;;;;OAMG;IACU,WAAW,CAAC,eAAe,EAAE,YAAY,EAAE,cAAc,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,+BAyBvF;IAED;;;;OAIG;IACU,gBAAgB,CAAC,eAAe,EAAE,YAAY,EAAE,cAAc,EAAE,EAAE,iBAG9E;IAED;;;;;;QAMI;IACG,QAAQ,CAAC,eAAe,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,GAAG,SAAS,EAAE,WAAW,EAAE,EAAE,cAM9F;IAED;;;;;QAKI;IACG,eAAe,CAAC,eAAe,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,WAGjE;IAED;;;OAGG;IACI,aAAa,CAAC,eAAe,EAAE,YAAY,GAAG,GAAG,CAAC,MAAM,CAAC,CAE/D;IAUD,WAAW,IAAI,WAAW,EAAE,CAE3B;IAED;;OAEG;IACH,oBAAoB,IAAI,EAAE,EAAE,CAE3B;IAED;;;OAGG;IACH,gBAAgB,IAAI,EAAE,EAAE,CAMvB;IAED,iBAAiB,IAAI,EAAE,CAEtB;CAaF"}