@aztec/pxe 0.0.0-test.1 → 0.0.1-commit.023c3e5

package/dest/private_kernel/private_kernel_execution_prover.d.ts

@@ -0,0 +1,45 @@
+import { type LoggerBindings } from '@aztec/foundation/log';
+import type { PrivateKernelProver } from '@aztec/stdlib/interfaces/client';
+import { type PrivateKernelExecutionProofOutput, type PrivateKernelTailCircuitPublicInputs } from '@aztec/stdlib/kernel';
+import { type PrivateExecutionResult, TxRequest } from '@aztec/stdlib/tx';
+import type { PrivateKernelOracle } from './private_kernel_oracle.js';
+export interface PrivateKernelExecutionProverConfig {
+    simulate: boolean;
+    skipFeeEnforcement: boolean;
+    profileMode: 'gates' | 'execution-steps' | 'full' | 'none';
+}
+/**
+ * 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 declare class PrivateKernelExecutionProver {
+    private oracle;
+    private proofCreator;
+    private fakeProofs;
+    private log;
+    constructor(oracle: PrivateKernelOracle, proofCreator: PrivateKernelProver, fakeProofs?: boolean, bindings?: LoggerBindings);
+    /**
+     * 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.
+     */
+    proveWithKernels(txRequest: TxRequest, executionResult: PrivateExecutionResult, { simulate, skipFeeEnforcement, profileMode }?: PrivateKernelExecutionProverConfig): Promise<PrivateKernelExecutionProofOutput<PrivateKernelTailCircuitPublicInputs>>;
+    /**
+     * 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.
+     */
+    private ensurePublicInputsMatch;
+    private getVkData;
+    private createPrivateCallData;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJpdmF0ZV9rZXJuZWxfZXhlY3V0aW9uX3Byb3Zlci5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3ByaXZhdGVfa2VybmVsL3ByaXZhdGVfa2VybmVsX2V4ZWN1dGlvbl9wcm92ZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBRUEsT0FBTyxFQUFlLEtBQUssY0FBYyxFQUFnQixNQUFNLHVCQUF1QixDQUFDO0FBTXZGLE9BQU8sS0FBSyxFQUFFLG1CQUFtQixFQUFFLE1BQU0saUNBQWlDLENBQUM7QUFDM0UsT0FBTyxFQVFMLEtBQUssaUNBQWlDLEVBS3RDLEtBQUssb0NBQW9DLEVBRTFDLE1BQU0sc0JBQXNCLENBQUM7QUFFOUIsT0FBTyxFQUVMLEtBQUssc0JBQXNCLEVBQzNCLFNBQVMsRUFHVixNQUFNLGtCQUFrQixDQUFDO0FBSTFCLE9BQU8sS0FBSyxFQUFFLG1CQUFtQixFQUFFLE1BQU0sNEJBQTRCLENBQUM7QUFTdEUsTUFBTSxXQUFXLGtDQUFrQztJQUNqRCxRQUFRLEVBQUUsT0FBTyxDQUFDO0lBQ2xCLGtCQUFrQixFQUFFLE9BQU8sQ0FBQztJQUM1QixXQUFXLEVBQUUsT0FBTyxHQUFHLGlCQUFpQixHQUFHLE1BQU0sR0FBRyxNQUFNLENBQUM7Q0FDNUQ7QUFFRDs7Ozs7R0FLRztBQUNILHFCQUFhLDRCQUE0QjtJQUlyQyxPQUFPLENBQUMsTUFBTTtJQUNkLE9BQU8sQ0FBQyxZQUFZO0lBQ3BCLE9BQU8sQ0FBQyxVQUFVO0lBTHBCLE9BQU8sQ0FBQyxHQUFHLENBQVM7SUFFcEIsWUFDVSxNQUFNLEVBQUUsbUJBQW1CLEVBQzNCLFlBQVksRUFBRSxtQkFBbUIsRUFDakMsVUFBVSxVQUFRLEVBQzFCLFFBQVEsQ0FBQyxFQUFFLGNBQWMsRUFHMUI7SUFFRDs7Ozs7Ozs7OztPQVVHO0lBQ0csZ0JBQWdCLENBQ3BCLFNBQVMsRUFBRSxTQUFTLEVBQ3BCLGVBQWUsRUFBRSxzQkFBc0IsRUFDdkMsRUFBRSxRQUFRLEVBQUUsa0JBQWtCLEVBQUUsV0FBVyxFQUFFLEdBQUUsa0NBSTlDLEdBQ0EsT0FBTyxDQUFDLGlDQUFpQyxDQUFDLG9DQUFvQyxDQUFDLENBQUMsQ0FvUmxGO0lBRUQ7Ozs7O09BS0c7SUFDSCxPQUFPLENBQUMsdUJBQXVCO1lBb0JqQixTQUFTO1lBU1QscUJBQXFCO0NBK0JwQyJ9

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

@@ -0,0 +1 @@
+{"version":3,"file":"private_kernel_execution_prover.d.ts","sourceRoot":"","sources":["../../src/private_kernel/private_kernel_execution_prover.ts"],"names":[],"mappings":"AAEA,OAAO,EAAe,KAAK,cAAc,EAAgB,MAAM,uBAAuB,CAAC;AAMvF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,OAAO,EAQL,KAAK,iCAAiC,EAKtC,KAAK,oCAAoC,EAE1C,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAEL,KAAK,sBAAsB,EAC3B,SAAS,EAGV,MAAM,kBAAkB,CAAC;AAI1B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAStE,MAAM,WAAW,kCAAkC;IACjD,QAAQ,EAAE,OAAO,CAAC;IAClB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,WAAW,EAAE,OAAO,GAAG,iBAAiB,GAAG,MAAM,GAAG,MAAM,CAAC;CAC5D;AAED;;;;;GAKG;AACH,qBAAa,4BAA4B;IAIrC,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,UAAU;IALpB,OAAO,CAAC,GAAG,CAAS;IAEpB,YACU,MAAM,EAAE,mBAAmB,EAC3B,YAAY,EAAE,mBAAmB,EACjC,UAAU,UAAQ,EAC1B,QAAQ,CAAC,EAAE,cAAc,EAG1B;IAED;;;;;;;;;;OAUG;IACG,gBAAgB,CACpB,SAAS,EAAE,SAAS,EACpB,eAAe,EAAE,sBAAsB,EACvC,EAAE,QAAQ,EAAE,kBAAkB,EAAE,WAAW,EAAE,GAAE,kCAI9C,GACA,OAAO,CAAC,iCAAiC,CAAC,oCAAoC,CAAC,CAAC,CAoRlF;IAED;;;;;OAKG;IACH,OAAO,CAAC,uBAAuB;YAoBjB,SAAS;YAST,qBAAqB;CA+BpC"}

package/dest/private_kernel/private_kernel_execution_prover.js

@@ -0,0 +1,285 @@
+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, PrivateKernelInitCircuitPrivateInputs, PrivateKernelInnerCircuitPrivateInputs, PrivateKernelTailCircuitPrivateInputs, PrivateVerificationKeyHints } from '@aztec/stdlib/kernel';
+import { ChonkProof } from '@aztec/stdlib/proofs';
+import { collectNoteHashNullifierCounterMap, getFinalMinRevertibleSideEffectCounter } from '@aztec/stdlib/tx';
+import { VerificationKeyAsFields, VerificationKeyData, VkData } from '@aztec/stdlib/vks';
+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;
+    log;
+    constructor(oracle, proofCreator, fakeProofs = false, bindings){
+        this.oracle = oracle;
+        this.proofCreator = proofCreator;
+        this.fakeProofs = fakeProofs;
+        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;
+        while(executionStack.length){
+            if (!firstIteration) {
+                let resetBuilder = new PrivateKernelResetPrivateInputsBuilder(output, executionStack, noteHashNullifierCounterMap, splitCounter);
+                while(resetBuilder.needsReset()){
+                    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 currentExecution = executionStack.pop();
+            executionStack.push(...[
+                ...currentExecution.nestedExecutionResults
+            ].reverse());
+            const functionName = await this.oracle.getDebugFunctionName(currentExecution.publicInputs.callContext.contractAddress, currentExecution.publicInputs.callContext.functionSelector);
+            executionSteps.push({
+                functionName: functionName,
+                bytecode: currentExecution.acir,
+                witness: currentExecution.partialWitness,
+                vk: currentExecution.vk,
+                timings: {
+                    witgen: currentExecution.profileResult?.timings.witgen ?? 0,
+                    oracles: currentExecution.profileResult?.timings.oracles
+                }
+            });
+            const privateCallData = await this.createPrivateCallData(currentExecution);
+            if (firstIteration) {
+                const witgenTimer = new Timer();
+                const proofInput = new PrivateKernelInitCircuitPrivateInputs(txRequest, getVKTreeRoot(), ProtocolContractsList, privateCallData, isPrivateOnlyTx, executionResult.firstNullifier, 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);
+                executionSteps.push({
+                    functionName: 'private_kernel_init',
+                    bytecode: output.bytecode,
+                    witness: output.outputWitness,
+                    vk: output.verificationKey.keyAsBytes,
+                    timings: {
+                        witgen: witgenTimer.ms()
+                    }
+                });
+            } else {
+                const witgenTimer = new Timer();
+                const vkData = await this.getVkData(output.verificationKey);
+                const previousKernelData = new PrivateKernelData(output.publicInputs, vkData);
+                const proofInput = new PrivateKernelInnerCircuitPrivateInputs(previousKernelData, privateCallData);
+                pushTestData('private-kernel-inputs-inner', proofInput);
+                output = generateWitnesses ? await this.proofCreator.generateInnerOutput(proofInput) : await this.proofCreator.simulateInner(proofInput);
+                executionSteps.push({
+                    functionName: 'private_kernel_inner',
+                    bytecode: output.bytecode,
+                    witness: output.outputWitness,
+                    vk: output.verificationKey.keyAsBytes,
+                    timings: {
+                        witgen: witgenTimer.ms()
+                    }
+                });
+            }
+            firstIteration = false;
+        }
+        // Reset.
+        let resetBuilder = new PrivateKernelResetPrivateInputsBuilder(output, [], noteHashNullifierCounterMap, splitCounter);
+        while(resetBuilder.needsReset()){
+            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, [], noteHashNullifierCounterMap, splitCounter);
+        }
+        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();
+        // Use the aggregated includeByTimestamp set throughout the tx execution.
+        // TODO: Call `computeTxIncludeByTimestamp` to round the value down and reduce precision, improving privacy.
+        const includeByTimestampUpperBound = previousKernelData.publicInputs.includeByTimestamp;
+        const anchorBlockTimestamp = previousKernelData.publicInputs.constants.anchorBlockHeader.globalVariables.timestamp;
+        if (includeByTimestampUpperBound <= anchorBlockTimestamp) {
+            throw new Error(`Include-by timestamp must be greater than the anchor block timestamp. Anchor block timestamp: ${anchorBlockTimestamp}. Include-by timestamp: ${includeByTimestampUpperBound}.`);
+        }
+        const privateInputs = new PrivateKernelTailCircuitPrivateInputs(previousKernelData, paddedSideEffectAmounts, includeByTimestampUpperBound);
+        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);
+    }
+    async createPrivateCallData({ publicInputs, vk: vkAsBuffer }) {
+        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 = await this.oracle.getUpdatedClassIdHints(contractAddress);
+        return PrivateCallData.from({
+            publicInputs,
+            vk,
+            verificationKeyHints: PrivateVerificationKeyHints.from({
+                publicKeys,
+                contractClassArtifactHash,
+                contractClassPublicBytecodeCommitment,
+                saltedInitializationHash,
+                functionLeafMembershipWitness,
+                updatedClassIdHints
+            })
+        });
+    }
+}

package/dest/private_kernel/private_kernel_oracle.d.ts

@@ -0,0 +1,59 @@
+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, Point } 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 { BlockHash } from '@aztec/stdlib/block';
+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 { 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 blockHash;
+    constructor(contractStore: ContractStore, keyStore: KeyStore, node: AztecNode, blockHash: BlockHash);
+    /** 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<import("@aztec/stdlib/contract").ContractClassIdPreimage>;
+    /** 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(): Promise<Fr>;
+    /**
+     * Retrieves the sk_m corresponding to the pk_m.
+     * @throws If the provided public key is not associated with any of the registered accounts.
+     * @param masterPublicKey - The master public key 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(masterPublicKey: Point): 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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJpdmF0ZV9rZXJuZWxfb3JhY2xlLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvcHJpdmF0ZV9rZXJuZWwvcHJpdmF0ZV9rZXJuZWxfb3JhY2xlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxvQkFBb0IsRUFBRSxxQkFBcUIsRUFBMkIsY0FBYyxFQUFFLE1BQU0sa0JBQWtCLENBQUM7QUFDeEgsT0FBTyxLQUFLLEVBQUUsRUFBRSxFQUFFLE1BQU0sZ0NBQWdDLENBQUM7QUFDekQsT0FBTyxLQUFLLEVBQUUsY0FBYyxFQUFFLEtBQUssRUFBRSxNQUFNLG1DQUFtQyxDQUFDO0FBQy9FLE9BQU8sRUFBRSxpQkFBaUIsRUFBRSxNQUFNLHlCQUF5QixDQUFDO0FBQzVELE9BQU8sS0FBSyxFQUFFLFFBQVEsRUFBRSxNQUFNLGtCQUFrQixDQUFDO0FBR2pELE9BQU8sS0FBSyxFQUFFLGdCQUFnQixFQUFFLE1BQU0sbUJBQW1CLENBQUM7QUFDMUQsT0FBTyxLQUFLLEVBQUUsWUFBWSxFQUFFLE1BQU0sNkJBQTZCLENBQUM7QUFDaEUsT0FBTyxFQUFFLFNBQVMsRUFBRSxNQUFNLHFCQUFxQixDQUFDO0FBQ2hELE9BQU8sRUFDTCxLQUFLLDJCQUEyQixFQUdqQyxNQUFNLHdCQUF3QixDQUFDO0FBR2hDLE9BQU8sS0FBSyxFQUFFLFNBQVMsRUFBRSxNQUFNLGlDQUFpQyxDQUFDO0FBQ2pFLE9BQU8sRUFBRSxtQkFBbUIsRUFBRSxNQUFNLHNCQUFzQixDQUFDO0FBQzNELE9BQU8sS0FBSyxFQUFFLDBCQUEwQixFQUFFLE1BQU0scUJBQXFCLENBQUM7QUFDdEUsT0FBTyxLQUFLLEVBQUUsdUJBQXVCLEVBQUUsTUFBTSxtQkFBbUIsQ0FBQztBQUVqRSxPQUFPLEtBQUssRUFBRSxhQUFhLEVBQUUsTUFBTSw2Q0FBNkMsQ0FBQztBQUVqRjs7R0FFRztBQUNILHFCQUFhLG1CQUFtQjtJQUU1QixPQUFPLENBQUMsYUFBYTtJQUNyQixPQUFPLENBQUMsUUFBUTtJQUNoQixPQUFPLENBQUMsSUFBSTtJQUNaLE9BQU8sQ0FBQyxTQUFTO0lBSm5CLFlBQ1UsYUFBYSxFQUFFLGFBQWEsRUFDNUIsUUFBUSxFQUFFLFFBQVEsRUFDbEIsSUFBSSxFQUFFLFNBQVMsRUFDZixTQUFTLEVBQUUsU0FBUyxFQUMxQjtJQUVKLDhGQUE4RjtJQUNqRiwwQkFBMEIsQ0FDckMsT0FBTyxFQUFFLFlBQVksR0FDcEIsT0FBTyxDQUFDLDJCQUEyQixHQUFHO1FBQUUsd0JBQXdCLEVBQUUsRUFBRSxDQUFBO0tBQUUsQ0FBQyxDQVN6RTtJQUVELGtGQUFrRjtJQUNyRSwwQkFBMEIsQ0FBQyxlQUFlLEVBQUUsRUFBRSxxRUFNMUQ7SUFFRCx1R0FBdUc7SUFDMUYsNEJBQTRCLENBQ3ZDLGVBQWUsRUFBRSxFQUFFLEVBQ25CLFFBQVEsRUFBRSxnQkFBZ0IsR0FDekIsT0FBTyxDQUFDLGlCQUFpQixDQUFDLE9BQU8sb0JBQW9CLENBQUMsQ0FBQyxDQVF6RDtJQUVEOzs7T0FHRztJQUNJLHNCQUFzQixDQUFDLEVBQUUsRUFBRSx1QkFBdUIsR0FBRyxPQUFPLENBQUMsaUJBQWlCLENBQUMsT0FBTyxjQUFjLENBQUMsQ0FBQyxDQUc1RztJQUVELCtGQUErRjtJQUMvRiw0QkFBNEIsQ0FBQyxRQUFRLEVBQUUsRUFBRSxHQUFHLE9BQU8sQ0FBQyxpQkFBaUIsQ0FBQyxPQUFPLHFCQUFxQixDQUFDLEdBQUcsU0FBUyxDQUFDLENBRS9HO0lBRUQsOEdBQThHO0lBQzlHLDZCQUE2QixDQUFDLFNBQVMsRUFBRSxFQUFFLEdBQUcsT0FBTyxDQUFDLDBCQUEwQixHQUFHLFNBQVMsQ0FBQyxDQUU1RjtJQUVELHFEQUFxRDtJQUMvQyxtQkFBbUIsSUFBSSxPQUFPLENBQUMsRUFBRSxDQUFDLENBTXZDO0lBRUQ7Ozs7OztPQU1HO0lBQ0ksa0JBQWtCLENBQUMsZUFBZSxFQUFFLEtBQUssR0FBRyxPQUFPLENBQUMsY0FBYyxDQUFDLENBRXpFO0lBRUQsMkVBQTJFO0lBQ3BFLG9CQUFvQixDQUFDLGVBQWUsRUFBRSxZQUFZLEVBQUUsUUFBUSxFQUFFLGdCQUFnQixHQUFHLE9BQU8sQ0FBQyxNQUFNLEdBQUcsU0FBUyxDQUFDLENBRWxIO0lBRUQ7OztPQUdHO0lBQ1Usc0JBQXNCLENBQUMsZUFBZSxFQUFFLFlBQVksR0FBRyxPQUFPLENBQUMsbUJBQW1CLENBQUMsQ0E4Qi9GO0NBQ0YifQ==

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,EAAE,oBAAoB,EAAE,qBAAqB,EAA2B,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACxH,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,mCAAmC,CAAC;AAC/E,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,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EACL,KAAK,2BAA2B,EAGjC,MAAM,wBAAwB,CAAC;AAGhC,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,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,SAAS;IAJnB,YACU,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,SAAS,EACf,SAAS,EAAE,SAAS,EAC1B;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,qEAM1D;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;IAC/F,4BAA4B,CAAC,QAAQ,EAAE,EAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC,OAAO,qBAAqB,CAAC,GAAG,SAAS,CAAC,CAE/G;IAED,8GAA8G;IAC9G,6BAA6B,CAAC,SAAS,EAAE,EAAE,GAAG,OAAO,CAAC,0BAA0B,GAAG,SAAS,CAAC,CAE5F;IAED,qDAAqD;IAC/C,mBAAmB,IAAI,OAAO,CAAC,EAAE,CAAC,CAMvC;IAED;;;;;;OAMG;IACI,kBAAkB,CAAC,eAAe,EAAE,KAAK,GAAG,OAAO,CAAC,cAAc,CAAC,CAEzE;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,CA8B/F;CACF"}

package/dest/private_kernel/private_kernel_oracle.js

@@ -0,0 +1,92 @@
+import { PUBLIC_DATA_TREE_HEIGHT, 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 { computeContractClassIdPreimage, 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;
+    blockHash;
+    constructor(contractStore, keyStore, node, blockHash){
+        this.contractStore = contractStore;
+        this.keyStore = keyStore;
+        this.node = node;
+        this.blockHash = blockHash;
+    }
+    /** 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.getContractClass(contractClassId);
+        if (!contractClass) {
+            throw new Error(`Contract class not found when getting class id preimage. Class id: ${contractClassId}.`);
+        }
+        return computeContractClassIdPreimage(contractClass);
+    }
+    /** 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. */ getNoteHashMembershipWitness(noteHash) {
+        return this.node.getNoteHashMembershipWitness(this.blockHash, noteHash);
+    }
+    /** Returns a membership witness with the sibling path and leaf index in our nullifier indexed merkle tree. */ getNullifierMembershipWitness(nullifier) {
+        return this.node.getNullifierMembershipWitness(this.blockHash, nullifier);
+    }
+    /** Returns the root of our note hash merkle tree. */ async getNoteHashTreeRoot() {
+        const header = await this.node.getBlockHeader(this.blockHash);
+        if (!header) {
+            throw new Error(`No block header found for block hash ${this.blockHash}`);
+        }
+        return header.state.partial.noteHashTree.root;
+    }
+    /**
+   * Retrieves the sk_m corresponding to the pk_m.
+   * @throws If the provided public key is not associated with any of the registered accounts.
+   * @param masterPublicKey - The master public key 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(masterPublicKey) {
+        return this.keyStore.getMasterSecretKey(masterPublicKey);
+    }
+    /** 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 updatedClassIdWitness = await this.node.getPublicDataWitness(this.blockHash, hashLeafSlot);
+        if (!updatedClassIdWitness) {
+            throw new Error(`No public data tree witness found for ${hashLeafSlot}`);
+        }
+        const readStorage = (storageSlot)=>this.node.getPublicStorageAt(this.blockHash, ProtocolContractAddress.ContractInstanceRegistry, storageSlot);
+        const delayedPublicMutableValues = await DelayedPublicMutableValues.readFromTree(delayedPublicMutableSlot, readStorage);
+        return new UpdatedClassIdHints(new MembershipWitness(PUBLIC_DATA_TREE_HEIGHT, updatedClassIdWitness.index, updatedClassIdWitness.siblingPath.toTuple()), updatedClassIdWitness.leafPreimage, delayedPublicMutableValues);
+    }
+}