@aztec/pxe 0.0.0-test.1 → 0.0.1-commit.017a351

package/dest/private_kernel/private_kernel_execution_prover.js

@@ -0,0 +1,386 @@
+import { MAX_APPS_PER_KERNEL } from '@aztec/constants';
+import { uniqueBy } from '@aztec/foundation/collection';
+import { vkAsFieldsMegaHonk } from '@aztec/foundation/crypto/keys';
+import { Fr } from '@aztec/foundation/curves/bn254';
+import { createLogger } from '@aztec/foundation/log';
+import { pushTestData } from '@aztec/foundation/testing';
+import { Timer } from '@aztec/foundation/timer';
+import { getVKTreeRoot } from '@aztec/noir-protocol-circuits-types/vk-tree';
+import { ProtocolContractsList } from '@aztec/protocol-contracts';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
+import { HidingKernelToPublicPrivateInputs, HidingKernelToRollupPrivateInputs, PaddedSideEffectAmounts, PrivateCallData, PrivateKernelCircuitPublicInputs, PrivateKernelData, PrivateKernelInit2CircuitPrivateInputs, PrivateKernelInit3CircuitPrivateInputs, PrivateKernelInitCircuitPrivateInputs, PrivateKernelInner2CircuitPrivateInputs, PrivateKernelInner3CircuitPrivateInputs, PrivateKernelInnerCircuitPrivateInputs, PrivateKernelTailCircuitPrivateInputs, PrivateVerificationKeyHints } from '@aztec/stdlib/kernel';
+import { ChonkProof } from '@aztec/stdlib/proofs';
+import { collectNested, collectNoteHashNullifierCounterMap, getFinalMinRevertibleSideEffectCounter } from '@aztec/stdlib/tx';
+import { VerificationKeyAsFields, VerificationKeyData, VkData } from '@aztec/stdlib/vks';
+import { BatchPlanner } from './batch_planner.js';
+import { computeTxExpirationTimestamp } from './hints/compute_tx_expiration_timestamp.js';
+import { PrivateKernelResetPrivateInputsBuilder } from './hints/private_kernel_reset_private_inputs_builder.js';
+const NULL_SIMULATE_OUTPUT = {
+    publicInputs: PrivateKernelCircuitPublicInputs.empty(),
+    verificationKey: VerificationKeyData.empty(),
+    outputWitness: new Map(),
+    bytecode: Buffer.from([])
+};
+/**
+ * The PrivateKernelExecutionProver class is responsible for taking a transaction request and sequencing the
+ * the execution of the private functions within, sequenced with private kernel "glue" to check protocol rules.
+ * The result can be a chonk proof of the private transaction portion, or just a simulation that can e.g.
+ * inform state tree updates.
+ */ export class PrivateKernelExecutionProver {
+    oracle;
+    proofCreator;
+    fakeProofs;
+    maxBatchSize;
+    log;
+    constructor(oracle, proofCreator, fakeProofs = false, bindings, maxBatchSize = MAX_APPS_PER_KERNEL){
+        this.oracle = oracle;
+        this.proofCreator = proofCreator;
+        this.fakeProofs = fakeProofs;
+        this.maxBatchSize = maxBatchSize;
+        this.log = createLogger('pxe:private-kernel-execution-prover', bindings);
+    }
+    /**
+   * Generate a proof for a given transaction request and execution result.
+   * The function iterates through the nested executions in the execution result, creates private call data,
+   * and generates a proof using the provided ProofCreator instance. It also maintains an index of new notes
+   * created during the execution and returns them as a part of the KernelProverOutput.
+   *
+   * @param txRequest - The authenticated transaction request object.
+   * @param executionResult - The execution result object containing nested executions and preimages.
+   * @param profile - Set true to profile the gate count for each circuit
+   * @returns A Promise that resolves to a KernelProverOutput object containing proof, public inputs, and output notes.
+   */ async proveWithKernels(txRequest, executionResult, { simulate, skipFeeEnforcement, profileMode } = {
+        simulate: false,
+        skipFeeEnforcement: false,
+        profileMode: 'none'
+    }) {
+        const skipProofGeneration = this.fakeProofs || simulate;
+        const generateWitnesses = !skipProofGeneration || profileMode !== 'none';
+        const timer = new Timer();
+        const isPrivateOnlyTx = executionResult.publicFunctionCalldata.length === 0;
+        // Initialize an executionStack, beginning with the PrivateCallExecutionResult
+        // of the entrypoint function of the tx.
+        const executionStack = [
+            executionResult.entrypoint
+        ];
+        let firstIteration = true;
+        let output = NULL_SIMULATE_OUTPUT;
+        const executionSteps = [];
+        const noteHashNullifierCounterMap = collectNoteHashNullifierCounterMap(executionResult);
+        const minRevertibleSideEffectCounter = getFinalMinRevertibleSideEffectCounter(executionResult);
+        const splitCounter = isPrivateOnlyTx ? 0 : minRevertibleSideEffectCounter;
+        // Each kernel iteration absorbs up to `maxBatchSize` apps. The planner walks the upcoming
+        // apps and decides where the next reset must fall by using an accumulator and
+        // reusing the existing single-app `needsReset()` check.
+        const planner = new BatchPlanner(noteHashNullifierCounterMap, splitCounter, this.maxBatchSize);
+        const updatedClassIdHintsMap = await this.prefetchUpdatedClassIdHints(executionResult);
+        while(executionStack.length){
+            if (!firstIteration) {
+                let resetBuilder = new PrivateKernelResetPrivateInputsBuilder(output, executionStack, noteHashNullifierCounterMap, splitCounter);
+                while(resetBuilder.needsReset()){
+                    // Inner reset: without siloing.
+                    const witgenTimer = new Timer();
+                    const privateInputs = await resetBuilder.build(this.oracle);
+                    output = generateWitnesses ? await this.proofCreator.generateResetOutput(privateInputs) : await this.proofCreator.simulateReset(privateInputs);
+                    executionSteps.push({
+                        functionName: 'private_kernel_reset',
+                        bytecode: output.bytecode,
+                        witness: output.outputWitness,
+                        vk: output.verificationKey.keyAsBytes,
+                        timings: {
+                            witgen: witgenTimer.ms()
+                        }
+                    });
+                    resetBuilder = new PrivateKernelResetPrivateInputsBuilder(output, executionStack, noteHashNullifierCounterMap, splitCounter);
+                }
+            }
+            const batchSize = planner.decideBatchSize(output.publicInputs, executionStack);
+            const apps = [];
+            for(let i = 0; i < batchSize; i++){
+                apps.push(await this.consumeNextApp(executionStack, executionSteps, updatedClassIdHintsMap));
+            }
+            output = await this.runBatchedKernel({
+                apps,
+                firstIteration,
+                previousOutput: output,
+                txRequest,
+                isPrivateOnlyTx,
+                firstNullifierHint: executionResult.firstNullifier,
+                minRevertibleSideEffectCounter,
+                executionSteps,
+                generateWitnesses
+            });
+            firstIteration = false;
+        }
+        // Final reset: include siloing of note hashes, nullifiers and private logs.
+        const finalResetBuilder = new PrivateKernelResetPrivateInputsBuilder(output, [], noteHashNullifierCounterMap, splitCounter);
+        if (!finalResetBuilder.needsReset()) {
+            // The final reset must be performed exactly once, because each tx has at least one nullifier that requires
+            // siloing, and siloing cannot be done multiple times.
+            // While, in theory, it might be possible to silo note hashes first and then run another reset to silo nullifiers
+            // and/or private logs, we currently don't have standalone dimensions for the arrays that require siloing. As a
+            // result, all necessary siloing must be done together in a single reset.
+            // Refer to the possible combinations of dimensions in private_kernel_reset_config.json.
+            throw new Error('Nothing to reset for the final reset.');
+        } else {
+            const witgenTimer = new Timer();
+            const privateInputs = await finalResetBuilder.build(this.oracle);
+            output = generateWitnesses ? await this.proofCreator.generateResetOutput(privateInputs) : await this.proofCreator.simulateReset(privateInputs);
+            executionSteps.push({
+                functionName: 'private_kernel_reset',
+                bytecode: output.bytecode,
+                witness: output.outputWitness,
+                vk: output.verificationKey.keyAsBytes,
+                timings: {
+                    witgen: witgenTimer.ms()
+                }
+            });
+        }
+        if (output.publicInputs.feePayer.isZero() && skipFeeEnforcement) {
+            if (!skipProofGeneration) {
+                throw new Error('Fee payment must be enforced when creating real proof.');
+            }
+            output.publicInputs.feePayer = new AztecAddress(Fr.MAX_FIELD_VALUE);
+        }
+        // Private tail.
+        const vkData = await this.getVkData(output.verificationKey);
+        const previousKernelData = new PrivateKernelData(output.publicInputs, vkData);
+        this.log.debug(`Calling private kernel tail with hwm ${previousKernelData.publicInputs.minRevertibleSideEffectCounter}`);
+        // TODO: Enable padding once we better understand the final amounts to pad to.
+        const paddedSideEffectAmounts = PaddedSideEffectAmounts.empty();
+        // Round the aggregated expirationTimestamp down to reduce precision and avoid leaking which private
+        // functions were called via their exact expiration offsets.
+        const expirationTimestampUpperBound = computeTxExpirationTimestamp(previousKernelData.publicInputs);
+        const privateInputs = new PrivateKernelTailCircuitPrivateInputs(previousKernelData, paddedSideEffectAmounts, expirationTimestampUpperBound);
+        const witgenTimer = new Timer();
+        const tailOutput = generateWitnesses ? await this.proofCreator.generateTailOutput(privateInputs) : await this.proofCreator.simulateTail(privateInputs);
+        executionSteps.push({
+            functionName: 'private_kernel_tail',
+            bytecode: tailOutput.bytecode,
+            witness: tailOutput.outputWitness,
+            vk: tailOutput.verificationKey.keyAsBytes,
+            timings: {
+                witgen: witgenTimer.ms()
+            }
+        });
+        // Hiding kernel is only executed if we are generating witnesses.
+        // For simulation, we can end with the tail, since the Hiding kernel will simply return the same tail output.
+        if (generateWitnesses) {
+            const previousKernelVkData = await this.getVkData(tailOutput.verificationKey);
+            const witgenTimer = new Timer();
+            let hidingOutput;
+            if (tailOutput.publicInputs.forPublic) {
+                const privateInputs = new HidingKernelToPublicPrivateInputs(tailOutput.publicInputs.toPrivateToPublicKernelCircuitPublicInputs(), previousKernelVkData);
+                hidingOutput = await this.proofCreator.generateHidingToPublicOutput(privateInputs);
+            } else {
+                const privateInputs = new HidingKernelToRollupPrivateInputs(tailOutput.publicInputs.toPrivateToRollupKernelCircuitPublicInputs(), previousKernelVkData);
+                hidingOutput = await this.proofCreator.generateHidingToRollupOutput(privateInputs);
+            }
+            executionSteps.push({
+                functionName: 'hiding_kernel',
+                bytecode: hidingOutput.bytecode,
+                witness: hidingOutput.outputWitness,
+                vk: hidingOutput.verificationKey.keyAsBytes,
+                timings: {
+                    witgen: witgenTimer.ms()
+                }
+            });
+        }
+        if (profileMode == 'gates' || profileMode == 'full') {
+            for (const entry of executionSteps){
+                const gateCountTimer = new Timer();
+                const gateCount = await this.proofCreator.computeGateCountForCircuit(entry.bytecode, entry.functionName);
+                entry.gateCount = gateCount;
+                entry.timings.gateCount = gateCountTimer.ms();
+            }
+        }
+        if (profileMode === 'gates') {
+            for (const entry of executionSteps){
+                // These buffers are often a few megabytes in size - prevent accidentally serializing them if not requested.
+                entry.bytecode = Buffer.from([]);
+                entry.witness = new Map();
+            }
+        }
+        if (generateWitnesses) {
+            this.log.info(`Private kernel witness generation took ${timer.ms()}ms`);
+        }
+        let chonkProof;
+        // TODO(#7368) how do we 'bincode' encode these inputs?
+        let provingTime;
+        if (!skipProofGeneration) {
+            const provingTimer = new Timer();
+            const proofWithPublicInputs = await this.proofCreator.createChonkProof(executionSteps);
+            provingTime = provingTimer.ms();
+            this.ensurePublicInputsMatch(proofWithPublicInputs, tailOutput.publicInputs);
+            chonkProof = proofWithPublicInputs.removePublicInputs();
+        } else {
+            chonkProof = ChonkProof.random();
+        }
+        return {
+            publicInputs: tailOutput.publicInputs,
+            executionSteps,
+            chonkProof,
+            timings: provingTime ? {
+                proving: provingTime
+            } : undefined
+        };
+    }
+    /**
+   * Checks that the public inputs of the chonk proof match the public inputs of the tail circuit.
+   * This can only mismatch if there is a circuit / noir / bb bug.
+   * @param chonkProof - The chonk proof with public inputs.
+   * @param tailPublicInputs - The public inputs resulting from witness generation of the tail circuit.
+   */ ensurePublicInputsMatch(chonkProof, tailPublicInputs) {
+        const serializedChonkProofPublicInputs = chonkProof.getPublicInputs();
+        const serializedTailPublicInputs = tailPublicInputs.publicInputs().toFields();
+        if (serializedChonkProofPublicInputs.length !== serializedTailPublicInputs.length) {
+            throw new Error(`Public inputs length mismatch: ${serializedChonkProofPublicInputs.length} !== ${serializedTailPublicInputs.length}`);
+        }
+        if (!serializedChonkProofPublicInputs.every((input, index)=>input.equals(serializedTailPublicInputs[index]))) {
+            throw new Error(`Public inputs mismatch between kernel and chonk proof`);
+        }
+    }
+    async getVkData(verificationKey) {
+        const previousVkMembershipWitness = await this.oracle.getVkMembershipWitness(verificationKey.keyAsFields);
+        return new VkData(verificationKey, Number(previousVkMembershipWitness.leafIndex), previousVkMembershipWitness.siblingPath);
+    }
+    /**
+   * Pops the next app off the execution stack, pushes its nested calls back on (preserving DFS
+   * order), records the app's execution step, and returns its constructed `PrivateCallData`.
+   * Caller is responsible for ensuring the stack is non-empty.
+   */ async consumeNextApp(executionStack, executionSteps, updatedClassIdHintsMap) {
+        const next = executionStack.pop();
+        executionStack.push(...[
+            ...next.nestedExecutionResults
+        ].reverse());
+        const functionName = await this.oracle.getDebugFunctionName(next.publicInputs.callContext.contractAddress, next.publicInputs.callContext.functionSelector);
+        executionSteps.push({
+            functionName: functionName,
+            bytecode: next.acir,
+            witness: next.partialWitness,
+            vk: next.vk,
+            timings: {
+                witgen: next.profileResult?.timings.witgen ?? 0,
+                oracles: next.profileResult?.timings.oracles
+            }
+        });
+        return await this.createPrivateCallData(next, updatedClassIdHintsMap);
+    }
+    /** Prefetches updated class id hints for all unique contracts in the execution tree in parallel. */ async prefetchUpdatedClassIdHints(executionResult) {
+        const allAddresses = collectNested([
+            executionResult.entrypoint
+        ], (exec)=>[
+                exec.publicInputs.callContext.contractAddress
+            ]);
+        const uniqueAddresses = uniqueBy(allAddresses, (a)=>a.toString());
+        return new Map(await Promise.all(uniqueAddresses.map(async (addr)=>[
+                addr.toString(),
+                await this.oracle.getUpdatedClassIdHints(addr)
+            ])));
+    }
+    async createPrivateCallData({ publicInputs, vk: vkAsBuffer }, updatedClassIdHintsMap) {
+        const { contractAddress, functionSelector } = publicInputs.callContext;
+        const vkAsFields = await vkAsFieldsMegaHonk(vkAsBuffer);
+        const vk = await VerificationKeyAsFields.fromKey(vkAsFields);
+        const { currentContractClassId, publicKeys, saltedInitializationHash } = await this.oracle.getContractAddressPreimage(contractAddress);
+        const functionLeafMembershipWitness = await this.oracle.getFunctionMembershipWitness(currentContractClassId, functionSelector);
+        const { artifactHash: contractClassArtifactHash, publicBytecodeCommitment: contractClassPublicBytecodeCommitment } = await this.oracle.getContractClassIdPreimage(currentContractClassId);
+        const updatedClassIdHints = updatedClassIdHintsMap.get(contractAddress.toString());
+        return PrivateCallData.from({
+            publicInputs,
+            vk,
+            verificationKeyHints: PrivateVerificationKeyHints.from({
+                publicKeys,
+                contractClassArtifactHash,
+                contractClassPublicBytecodeCommitment,
+                saltedInitializationHash,
+                functionLeafMembershipWitness,
+                updatedClassIdHints
+            })
+        });
+    }
+    /**
+   * Runs one batched kernel iteration. Picks the right circuit variant based on whether this is
+   * the first iteration or a later one and the size of the batch.
+   */ async runBatchedKernel(args) {
+        const { apps, firstIteration, previousOutput, txRequest, isPrivateOnlyTx, firstNullifierHint, minRevertibleSideEffectCounter, executionSteps, generateWitnesses } = args;
+        const witgenTimer = new Timer();
+        let output;
+        let functionName;
+        if (firstIteration) {
+            const vkTreeRoot = getVKTreeRoot();
+            switch(apps.length){
+                case 1:
+                    {
+                        const proofInput = new PrivateKernelInitCircuitPrivateInputs(txRequest, vkTreeRoot, ProtocolContractsList, apps[0], isPrivateOnlyTx, firstNullifierHint, minRevertibleSideEffectCounter);
+                        this.log.debug(`Calling private kernel init with isPrivateOnly ${isPrivateOnlyTx} and firstNullifierHint ${proofInput.firstNullifierHint}`);
+                        pushTestData('private-kernel-inputs-init', proofInput);
+                        output = generateWitnesses ? await this.proofCreator.generateInitOutput(proofInput) : await this.proofCreator.simulateInit(proofInput);
+                        functionName = 'private_kernel_init';
+                        break;
+                    }
+                case 2:
+                    {
+                        const proofInput = new PrivateKernelInit2CircuitPrivateInputs(txRequest, vkTreeRoot, ProtocolContractsList, apps[0], apps[1], isPrivateOnlyTx, firstNullifierHint, minRevertibleSideEffectCounter);
+                        this.log.debug(`Calling private kernel init_2 with isPrivateOnly ${isPrivateOnlyTx} and firstNullifierHint ${proofInput.firstNullifierHint}`);
+                        pushTestData('private-kernel-inputs-init-2', proofInput);
+                        output = generateWitnesses ? await this.proofCreator.generateInit2Output(proofInput) : await this.proofCreator.simulateInit2(proofInput);
+                        functionName = 'private_kernel_init_2';
+                        break;
+                    }
+                case 3:
+                    {
+                        const proofInput = new PrivateKernelInit3CircuitPrivateInputs(txRequest, vkTreeRoot, ProtocolContractsList, apps[0], apps[1], apps[2], isPrivateOnlyTx, firstNullifierHint, minRevertibleSideEffectCounter);
+                        this.log.debug(`Calling private kernel init_3 with isPrivateOnly ${isPrivateOnlyTx} and firstNullifierHint ${proofInput.firstNullifierHint}`);
+                        pushTestData('private-kernel-inputs-init-3', proofInput);
+                        output = generateWitnesses ? await this.proofCreator.generateInit3Output(proofInput) : await this.proofCreator.simulateInit3(proofInput);
+                        functionName = 'private_kernel_init_3';
+                        break;
+                    }
+                default:
+                    throw new Error(`Unsupported init kernel batch size: ${apps.length}`);
+            }
+        } else {
+            const vkData = await this.getVkData(previousOutput.verificationKey);
+            const previousKernelData = new PrivateKernelData(previousOutput.publicInputs, vkData);
+            switch(apps.length){
+                case 1:
+                    {
+                        const proofInput = new PrivateKernelInnerCircuitPrivateInputs(previousKernelData, apps[0]);
+                        pushTestData('private-kernel-inputs-inner', proofInput);
+                        output = generateWitnesses ? await this.proofCreator.generateInnerOutput(proofInput) : await this.proofCreator.simulateInner(proofInput);
+                        functionName = 'private_kernel_inner';
+                        break;
+                    }
+                case 2:
+                    {
+                        const proofInput = new PrivateKernelInner2CircuitPrivateInputs(previousKernelData, apps[0], apps[1]);
+                        pushTestData('private-kernel-inputs-inner-2', proofInput);
+                        output = generateWitnesses ? await this.proofCreator.generateInner2Output(proofInput) : await this.proofCreator.simulateInner2(proofInput);
+                        functionName = 'private_kernel_inner_2';
+                        break;
+                    }
+                case 3:
+                    {
+                        const proofInput = new PrivateKernelInner3CircuitPrivateInputs(previousKernelData, apps[0], apps[1], apps[2]);
+                        pushTestData('private-kernel-inputs-inner-3', proofInput);
+                        output = generateWitnesses ? await this.proofCreator.generateInner3Output(proofInput) : await this.proofCreator.simulateInner3(proofInput);
+                        functionName = 'private_kernel_inner_3';
+                        break;
+                    }
+                default:
+                    throw new Error(`Unsupported inner kernel batch size: ${apps.length}`);
+            }
+        }
+        executionSteps.push({
+            functionName,
+            bytecode: output.bytecode,
+            witness: output.outputWitness,
+            vk: output.verificationKey.keyAsBytes,
+            timings: {
+                witgen: witgenTimer.ms()
+            }
+        });
+        return output;
+    }
+}

package/dest/private_kernel/private_kernel_oracle.d.ts

@@ -0,0 +1,63 @@
+import { FUNCTION_TREE_HEIGHT, NOTE_HASH_TREE_HEIGHT, VK_TREE_HEIGHT } from '@aztec/constants';
+import type { Fr } from '@aztec/foundation/curves/bn254';
+import type { GrumpkinScalar } from '@aztec/foundation/curves/grumpkin';
+import { MembershipWitness } from '@aztec/foundation/trees';
+import type { KeyStore } from '@aztec/key-store';
+import type { FunctionSelector } from '@aztec/stdlib/abi';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import { type ContractInstanceWithAddress } from '@aztec/stdlib/contract';
+import type { AztecNode } from '@aztec/stdlib/interfaces/client';
+import { UpdatedClassIdHints } from '@aztec/stdlib/kernel';
+import type { NullifierMembershipWitness } from '@aztec/stdlib/trees';
+import type { BlockHeader } from '@aztec/stdlib/tx';
+import type { VerificationKeyAsFields } from '@aztec/stdlib/vks';
+import type { ContractStore } from '../storage/contract_store/contract_store.js';
+/**
+ * Provides functionality needed by the private kernel for interacting with our state trees.
+ */
+export declare class PrivateKernelOracle {
+    private contractStore;
+    private keyStore;
+    private node;
+    private blockHeader;
+    constructor(contractStore: ContractStore, keyStore: KeyStore, node: AztecNode, blockHeader: BlockHeader);
+    /** Retrieves the preimage of a contract address from the registered contract instances db. */
+    getContractAddressPreimage(address: AztecAddress): Promise<ContractInstanceWithAddress & {
+        saltedInitializationHash: Fr;
+    }>;
+    /** Retrieves the preimage of a contract class id from the contract classes db. */
+    getContractClassIdPreimage(contractClassId: Fr): Promise<{
+        artifactHash: Fr;
+        privateFunctionsRoot: Fr;
+        publicBytecodeCommitment: Fr;
+    }>;
+    /** Returns a membership witness with the sibling path and leaf index in our private functions tree. */
+    getFunctionMembershipWitness(contractClassId: Fr, selector: FunctionSelector): Promise<MembershipWitness<typeof FUNCTION_TREE_HEIGHT>>;
+    /**
+     * Returns a membership witness with the sibling path and leaf index in our protocol VK indexed merkle tree.
+     * Used to validate the previous kernel's verification key.
+     */
+    getVkMembershipWitness(vk: VerificationKeyAsFields): Promise<MembershipWitness<typeof VK_TREE_HEIGHT>>;
+    /** Returns a membership witness with the sibling path and leaf index in our note hash tree. */
+    getNoteHashMembershipWitness(noteHash: Fr): Promise<MembershipWitness<typeof NOTE_HASH_TREE_HEIGHT> | undefined>;
+    /** Returns a membership witness with the sibling path and leaf index in our nullifier indexed merkle tree. */
+    getNullifierMembershipWitness(nullifier: Fr): Promise<NullifierMembershipWitness | undefined>;
+    /** Returns the root of our note hash merkle tree. */
+    getNoteHashTreeRoot(): Fr;
+    /**
+     * Retrieves the sk_m corresponding to the pk_m hash.
+     * @throws If the provided hash is not associated with any of the registered accounts.
+     * @param masterPublicKeyHash - The master public key hash to get secret key for.
+     * @returns A Promise that resolves to sk_m.
+     * @dev Used when feeding the sk_m to the kernel circuit for keys verification.
+     */
+    getMasterSecretKey(masterPublicKeyHash: Fr): Promise<GrumpkinScalar>;
+    /** Use debug data to get the function name corresponding to a selector. */
+    getDebugFunctionName(contractAddress: AztecAddress, selector: FunctionSelector): Promise<string | undefined>;
+    /**
+     * Returns a membership witness and leaf index to our public data indexed merkle tree,
+     * along with an associated DelayedPublicMutable containing the class ID to update.
+     */
+    getUpdatedClassIdHints(contractAddress: AztecAddress): Promise<UpdatedClassIdHints>;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJpdmF0ZV9rZXJuZWxfb3JhY2xlLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvcHJpdmF0ZV9rZXJuZWwvcHJpdmF0ZV9rZXJuZWxfb3JhY2xlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFDTCxvQkFBb0IsRUFDcEIscUJBQXFCLEVBR3JCLGNBQWMsRUFDZixNQUFNLGtCQUFrQixDQUFDO0FBQzFCLE9BQU8sS0FBSyxFQUFFLEVBQUUsRUFBRSxNQUFNLGdDQUFnQyxDQUFDO0FBQ3pELE9BQU8sS0FBSyxFQUFFLGNBQWMsRUFBRSxNQUFNLG1DQUFtQyxDQUFDO0FBQ3hFLE9BQU8sRUFBRSxpQkFBaUIsRUFBRSxNQUFNLHlCQUF5QixDQUFDO0FBQzVELE9BQU8sS0FBSyxFQUFFLFFBQVEsRUFBRSxNQUFNLGtCQUFrQixDQUFDO0FBR2pELE9BQU8sS0FBSyxFQUFFLGdCQUFnQixFQUFFLE1BQU0sbUJBQW1CLENBQUM7QUFDMUQsT0FBTyxLQUFLLEVBQUUsWUFBWSxFQUFFLE1BQU0sNkJBQTZCLENBQUM7QUFDaEUsT0FBTyxFQUFFLEtBQUssMkJBQTJCLEVBQW1DLE1BQU0sd0JBQXdCLENBQUM7QUFHM0csT0FBTyxLQUFLLEVBQUUsU0FBUyxFQUFFLE1BQU0saUNBQWlDLENBQUM7QUFDakUsT0FBTyxFQUFFLG1CQUFtQixFQUFFLE1BQU0sc0JBQXNCLENBQUM7QUFDM0QsT0FBTyxLQUFLLEVBQUUsMEJBQTBCLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQztBQUN0RSxPQUFPLEtBQUssRUFBRSxXQUFXLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQUNwRCxPQUFPLEtBQUssRUFBRSx1QkFBdUIsRUFBRSxNQUFNLG1CQUFtQixDQUFDO0FBRWpFLE9BQU8sS0FBSyxFQUFFLGFBQWEsRUFBRSxNQUFNLDZDQUE2QyxDQUFDO0FBRWpGOztHQUVHO0FBQ0gscUJBQWEsbUJBQW1CO0lBRTVCLE9BQU8sQ0FBQyxhQUFhO0lBQ3JCLE9BQU8sQ0FBQyxRQUFRO0lBQ2hCLE9BQU8sQ0FBQyxJQUFJO0lBQ1osT0FBTyxDQUFDLFdBQVc7SUFKckIsWUFDVSxhQUFhLEVBQUUsYUFBYSxFQUM1QixRQUFRLEVBQUUsUUFBUSxFQUNsQixJQUFJLEVBQUUsU0FBUyxFQUNmLFdBQVcsRUFBRSxXQUFXLEVBQzlCO0lBRUosOEZBQThGO0lBQ2pGLDBCQUEwQixDQUNyQyxPQUFPLEVBQUUsWUFBWSxHQUNwQixPQUFPLENBQUMsMkJBQTJCLEdBQUc7UUFBRSx3QkFBd0IsRUFBRSxFQUFFLENBQUE7S0FBRSxDQUFDLENBU3pFO0lBRUQsa0ZBQWtGO0lBQ3JFLDBCQUEwQixDQUFDLGVBQWUsRUFBRSxFQUFFOzs7O09BVTFEO0lBRUQsdUdBQXVHO0lBQzFGLDRCQUE0QixDQUN2QyxlQUFlLEVBQUUsRUFBRSxFQUNuQixRQUFRLEVBQUUsZ0JBQWdCLEdBQ3pCLE9BQU8sQ0FBQyxpQkFBaUIsQ0FBQyxPQUFPLG9CQUFvQixDQUFDLENBQUMsQ0FRekQ7SUFFRDs7O09BR0c7SUFDSSxzQkFBc0IsQ0FBQyxFQUFFLEVBQUUsdUJBQXVCLEdBQUcsT0FBTyxDQUFDLGlCQUFpQixDQUFDLE9BQU8sY0FBYyxDQUFDLENBQUMsQ0FHNUc7SUFFRCwrRkFBK0Y7SUFDekYsNEJBQTRCLENBQ2hDLFFBQVEsRUFBRSxFQUFFLEdBQ1gsT0FBTyxDQUFDLGlCQUFpQixDQUFDLE9BQU8scUJBQXFCLENBQUMsR0FBRyxTQUFTLENBQUMsQ0FFdEU7SUFFRCw4R0FBOEc7SUFDeEcsNkJBQTZCLENBQUMsU0FBUyxFQUFFLEVBQUUsR0FBRyxPQUFPLENBQUMsMEJBQTBCLEdBQUcsU0FBUyxDQUFDLENBRWxHO0lBRUQscURBQXFEO0lBQ3JELG1CQUFtQixJQUFJLEVBQUUsQ0FFeEI7SUFFRDs7Ozs7O09BTUc7SUFDSSxrQkFBa0IsQ0FBQyxtQkFBbUIsRUFBRSxFQUFFLEdBQUcsT0FBTyxDQUFDLGNBQWMsQ0FBQyxDQUUxRTtJQUVELDJFQUEyRTtJQUNwRSxvQkFBb0IsQ0FBQyxlQUFlLEVBQUUsWUFBWSxFQUFFLFFBQVEsRUFBRSxnQkFBZ0IsR0FBRyxPQUFPLENBQUMsTUFBTSxHQUFHLFNBQVMsQ0FBQyxDQUVsSDtJQUVEOzs7T0FHRztJQUNVLHNCQUFzQixDQUFDLGVBQWUsRUFBRSxZQUFZLEdBQUcsT0FBTyxDQUFDLG1CQUFtQixDQUFDLENBb0MvRjtDQUNGIn0=

package/dest/private_kernel/private_kernel_oracle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"private_kernel_oracle.d.ts","sourceRoot":"","sources":["../../src/private_kernel/private_kernel_oracle.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,qBAAqB,EAGrB,cAAc,EACf,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAGjD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,EAAE,KAAK,2BAA2B,EAAmC,MAAM,wBAAwB,CAAC;AAG3G,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AACtE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAEjE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,6CAA6C,CAAC;AAEjF;;GAEG;AACH,qBAAa,mBAAmB;IAE5B,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,WAAW;IAJrB,YACU,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,SAAS,EACf,WAAW,EAAE,WAAW,EAC9B;IAEJ,8FAA8F;IACjF,0BAA0B,CACrC,OAAO,EAAE,YAAY,GACpB,OAAO,CAAC,2BAA2B,GAAG;QAAE,wBAAwB,EAAE,EAAE,CAAA;KAAE,CAAC,CASzE;IAED,kFAAkF;IACrE,0BAA0B,CAAC,eAAe,EAAE,EAAE;;;;OAU1D;IAED,uGAAuG;IAC1F,4BAA4B,CACvC,eAAe,EAAE,EAAE,EACnB,QAAQ,EAAE,gBAAgB,GACzB,OAAO,CAAC,iBAAiB,CAAC,OAAO,oBAAoB,CAAC,CAAC,CAQzD;IAED;;;OAGG;IACI,sBAAsB,CAAC,EAAE,EAAE,uBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC,OAAO,cAAc,CAAC,CAAC,CAG5G;IAED,+FAA+F;IACzF,4BAA4B,CAChC,QAAQ,EAAE,EAAE,GACX,OAAO,CAAC,iBAAiB,CAAC,OAAO,qBAAqB,CAAC,GAAG,SAAS,CAAC,CAEtE;IAED,8GAA8G;IACxG,6BAA6B,CAAC,SAAS,EAAE,EAAE,GAAG,OAAO,CAAC,0BAA0B,GAAG,SAAS,CAAC,CAElG;IAED,qDAAqD;IACrD,mBAAmB,IAAI,EAAE,CAExB;IAED;;;;;;OAMG;IACI,kBAAkB,CAAC,mBAAmB,EAAE,EAAE,GAAG,OAAO,CAAC,cAAc,CAAC,CAE1E;IAED,2EAA2E;IACpE,oBAAoB,CAAC,eAAe,EAAE,YAAY,EAAE,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAElH;IAED;;;OAGG;IACU,sBAAsB,CAAC,eAAe,EAAE,YAAY,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAoC/F;CACF"}

package/dest/private_kernel/private_kernel_oracle.js

@@ -0,0 +1,98 @@
+import { PUBLIC_DATA_TREE_HEIGHT, UPDATES_VALUE_SIZE, VK_TREE_HEIGHT } from '@aztec/constants';
+import { MembershipWitness } from '@aztec/foundation/trees';
+import { getVKIndex, getVKSiblingPath } from '@aztec/noir-protocol-circuits-types/vk-tree';
+import { ProtocolContractAddress } from '@aztec/protocol-contracts';
+import { computeSaltedInitializationHash } from '@aztec/stdlib/contract';
+import { DelayedPublicMutableValues, DelayedPublicMutableValuesWithHash } from '@aztec/stdlib/delayed-public-mutable';
+import { computePublicDataTreeLeafSlot } from '@aztec/stdlib/hash';
+import { UpdatedClassIdHints } from '@aztec/stdlib/kernel';
+/**
+ * Provides functionality needed by the private kernel for interacting with our state trees.
+ */ export class PrivateKernelOracle {
+    contractStore;
+    keyStore;
+    node;
+    blockHeader;
+    constructor(contractStore, keyStore, node, blockHeader){
+        this.contractStore = contractStore;
+        this.keyStore = keyStore;
+        this.node = node;
+        this.blockHeader = blockHeader;
+    }
+    /** Retrieves the preimage of a contract address from the registered contract instances db. */ async getContractAddressPreimage(address) {
+        const instance = await this.contractStore.getContractInstance(address);
+        if (!instance) {
+            throw new Error(`Contract instance not found when getting address preimage. Contract address: ${address}.`);
+        }
+        return {
+            saltedInitializationHash: await computeSaltedInitializationHash(instance),
+            ...instance
+        };
+    }
+    /** Retrieves the preimage of a contract class id from the contract classes db. */ async getContractClassIdPreimage(contractClassId) {
+        const contractClass = await this.contractStore.getContractClassWithPreimage(contractClassId);
+        if (!contractClass) {
+            throw new Error(`Contract class not found when getting class id preimage. Class id: ${contractClassId}.`);
+        }
+        return {
+            artifactHash: contractClass.artifactHash,
+            privateFunctionsRoot: contractClass.privateFunctionsRoot,
+            publicBytecodeCommitment: contractClass.publicBytecodeCommitment
+        };
+    }
+    /** Returns a membership witness with the sibling path and leaf index in our private functions tree. */ async getFunctionMembershipWitness(contractClassId, selector) {
+        const membershipWitness = await this.contractStore.getFunctionMembershipWitness(contractClassId, selector);
+        if (!membershipWitness) {
+            throw new Error(`Membership witness not found for contract class id ${contractClassId} and selector ${selector}.`);
+        }
+        return membershipWitness;
+    }
+    /**
+   * Returns a membership witness with the sibling path and leaf index in our protocol VK indexed merkle tree.
+   * Used to validate the previous kernel's verification key.
+   */ getVkMembershipWitness(vk) {
+        const leafIndex = getVKIndex(vk);
+        return Promise.resolve(new MembershipWitness(VK_TREE_HEIGHT, BigInt(leafIndex), getVKSiblingPath(leafIndex)));
+    }
+    /** Returns a membership witness with the sibling path and leaf index in our note hash tree. */ async getNoteHashMembershipWitness(noteHash) {
+        return this.node.getNoteHashMembershipWitness(await this.blockHeader.hash(), noteHash);
+    }
+    /** Returns a membership witness with the sibling path and leaf index in our nullifier indexed merkle tree. */ async getNullifierMembershipWitness(nullifier) {
+        return this.node.getNullifierMembershipWitness(await this.blockHeader.hash(), nullifier);
+    }
+    /** Returns the root of our note hash merkle tree. */ getNoteHashTreeRoot() {
+        return this.blockHeader.state.partial.noteHashTree.root;
+    }
+    /**
+   * Retrieves the sk_m corresponding to the pk_m hash.
+   * @throws If the provided hash is not associated with any of the registered accounts.
+   * @param masterPublicKeyHash - The master public key hash to get secret key for.
+   * @returns A Promise that resolves to sk_m.
+   * @dev Used when feeding the sk_m to the kernel circuit for keys verification.
+   */ getMasterSecretKey(masterPublicKeyHash) {
+        return this.keyStore.getMasterSecretKey(masterPublicKeyHash);
+    }
+    /** Use debug data to get the function name corresponding to a selector. */ getDebugFunctionName(contractAddress, selector) {
+        return this.contractStore.getDebugFunctionName(contractAddress, selector);
+    }
+    /**
+   * Returns a membership witness and leaf index to our public data indexed merkle tree,
+   * along with an associated DelayedPublicMutable containing the class ID to update.
+   */ async getUpdatedClassIdHints(contractAddress) {
+        const { delayedPublicMutableSlot, delayedPublicMutableHashSlot } = await DelayedPublicMutableValuesWithHash.getContractUpdateSlots(contractAddress);
+        const hashLeafSlot = await computePublicDataTreeLeafSlot(ProtocolContractAddress.ContractInstanceRegistry, delayedPublicMutableHashSlot);
+        const blockHash = await this.blockHeader.hash();
+        const updatedClassIdWitness = await this.node.getPublicDataWitness(blockHash, hashLeafSlot);
+        if (!updatedClassIdWitness) {
+            throw new Error(`No public data tree witness found for ${hashLeafSlot}`);
+        }
+        // In an indexed merkle tree, getPublicDataWitness returns a leaf whose slot matches our query
+        // only if the slot has been written to. Otherwise, it returns the "low leaf" predecessor, whose
+        // slot will differ. Most contracts are never updated, so we can skip the readFromTree call
+        // (which triggers multiple RPC calls) and return empty values directly.
+        const readStorage = (storageSlot)=>this.node.getPublicStorageAt(blockHash, ProtocolContractAddress.ContractInstanceRegistry, storageSlot);
+        const slotExists = updatedClassIdWitness.leafPreimage.leaf.slot.equals(hashLeafSlot);
+        const delayedPublicMutableValues = slotExists ? await DelayedPublicMutableValues.readFromTree(delayedPublicMutableSlot, readStorage) : DelayedPublicMutableValues.empty(UPDATES_VALUE_SIZE);
+        return new UpdatedClassIdHints(new MembershipWitness(PUBLIC_DATA_TREE_HEIGHT, updatedClassIdWitness.index, updatedClassIdWitness.siblingPath.toTuple()), updatedClassIdWitness.leafPreimage, delayedPublicMutableValues);
+    }
+}