@aztec/simulator 0.0.0-test.0

package/dest/private/providers/acvm_wasm_with_blobs.d.ts

@@ -0,0 +1,19 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import type { NoirCompiledCircuit } from '@aztec/stdlib/noir';
+import type { WitnessMap } from '@noir-lang/types';
+import type { ACIRCallback, ACIRExecutionResult } from '../acvm/acvm.js';
+import type { ACVMWitness } from '../acvm/acvm_types.js';
+import { type SimulationProvider } from './simulation_provider.js';
+/**
+ * A simulation provider that uses the WASM simulator with the ability to handle blobs via the foreign call handler.
+ * This class is temporary while brillig cannot handle the blob math, and it is kept separate
+ * because the zkg commitment library used in the blob code is not browser compatible.
+ *
+ * It is only used in the context of server-side code executing simulated protocol circuits.
+ */
+export declare class WASMSimulatorWithBlobs implements SimulationProvider {
+    executeProtocolCircuit(input: WitnessMap, compiledCircuit: NoirCompiledCircuit): Promise<WitnessMap>;
+    executeUserCircuit(_acir: Buffer, _initialWitness: ACVMWitness, _callback: ACIRCallback): Promise<ACIRExecutionResult>;
+}
+//# sourceMappingURL=acvm_wasm_with_blobs.d.ts.map

package/dest/private/providers/acvm_wasm_with_blobs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"acvm_wasm_with_blobs.d.ts","sourceRoot":"","sources":["../../../src/private/providers/acvm_wasm_with_blobs.ts"],"names":[],"mappings":";;AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAG9D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,OAAO,KAAK,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACzE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,KAAK,kBAAkB,EAAqB,MAAM,0BAA0B,CAAC;AAEtF;;;;;;GAMG;AACH,qBAAa,sBAAuB,YAAW,kBAAkB;IACzD,sBAAsB,CAAC,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC;IAwB1G,kBAAkB,CAChB,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,WAAW,EAC5B,SAAS,EAAE,YAAY,GACtB,OAAO,CAAC,mBAAmB,CAAC;CAGhC"}

package/dest/private/providers/acvm_wasm_with_blobs.js

@@ -0,0 +1,32 @@
+import { foreignCallHandler } from '@aztec/noir-protocol-circuits-types/server';
+import { executeCircuit } from '@noir-lang/acvm_js';
+import { parseErrorPayload } from './simulation_provider.js';
+/**
+ * A simulation provider that uses the WASM simulator with the ability to handle blobs via the foreign call handler.
+ * This class is temporary while brillig cannot handle the blob math, and it is kept separate
+ * because the zkg commitment library used in the blob code is not browser compatible.
+ *
+ * It is only used in the context of server-side code executing simulated protocol circuits.
+ */ export class WASMSimulatorWithBlobs {
+    async executeProtocolCircuit(input, compiledCircuit) {
+        // Execute the circuit on those initial witness values
+        //
+        // Decode the bytecode from base64 since the acvm does not know about base64 encoding
+        const decodedBytecode = Buffer.from(compiledCircuit.bytecode, 'base64');
+        //
+        // Execute the circuit
+        try {
+            const _witnessMap = await executeCircuit(decodedBytecode, input, foreignCallHandler);
+            return _witnessMap;
+        } catch (err) {
+            // Typescript types catched errors as unknown or any, so we need to narrow its type to check if it has raw assertion payload.
+            if (typeof err === 'object' && err !== null && 'rawAssertionPayload' in err) {
+                throw parseErrorPayload(compiledCircuit.abi, err);
+            }
+            throw new Error(`Circuit execution failed: ${err}`);
+        }
+    }
+    executeUserCircuit(_acir, _initialWitness, _callback) {
+        throw new Error('Not implemented');
+    }
+}

package/dest/private/providers/factory.d.ts

@@ -0,0 +1,12 @@
+import { type Logger } from '@aztec/foundation/log';
+import type { SimulationProvider } from './simulation_provider.js';
+export type SimulationProviderConfig = {
+    acvmBinaryPath?: string;
+    acvmWorkingDirectory?: string;
+};
+export declare function getSimulationProviderConfigFromEnv(): {
+    acvmWorkingDirectory: string | undefined;
+    acvmBinaryPath: string | undefined;
+};
+export declare function createSimulationProvider(config: SimulationProviderConfig, logger?: Logger): Promise<SimulationProvider>;
+//# sourceMappingURL=factory.d.ts.map

package/dest/private/providers/factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../../src/private/providers/factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,uBAAuB,CAAC;AAMlE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAEnE,MAAM,MAAM,wBAAwB,GAAG;IACrC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,wBAAgB,kCAAkC;;;EAMjD;AAED,wBAAsB,wBAAwB,CAC5C,MAAM,EAAE,wBAAwB,EAChC,MAAM,GAAE,MAAkC,GACzC,OAAO,CAAC,kBAAkB,CAAC,CAa7B"}

package/dest/private/providers/factory.js

@@ -0,0 +1,27 @@
+import { createLogger } from '@aztec/foundation/log';
+import { promises as fs } from 'fs';
+import { NativeACVMSimulator } from './acvm_native.js';
+import { WASMSimulator } from './acvm_wasm.js';
+export function getSimulationProviderConfigFromEnv() {
+    const { ACVM_BINARY_PATH, ACVM_WORKING_DIRECTORY } = process.env;
+    return {
+        acvmWorkingDirectory: ACVM_WORKING_DIRECTORY ? ACVM_WORKING_DIRECTORY : undefined,
+        acvmBinaryPath: ACVM_BINARY_PATH ? ACVM_BINARY_PATH : undefined
+    };
+}
+export async function createSimulationProvider(config, logger = createLogger('simulator')) {
+    if (config.acvmBinaryPath && config.acvmWorkingDirectory) {
+        try {
+            await fs.access(config.acvmBinaryPath, fs.constants.R_OK);
+            await fs.mkdir(config.acvmWorkingDirectory, {
+                recursive: true
+            });
+            logger.info(`Using native ACVM at ${config.acvmBinaryPath} and working directory ${config.acvmWorkingDirectory}`);
+            return new NativeACVMSimulator(config.acvmWorkingDirectory, config.acvmBinaryPath);
+        } catch  {
+            logger.warn(`Failed to access ACVM at ${config.acvmBinaryPath}, falling back to WASM`);
+        }
+    }
+    logger.info('Using WASM ACVM simulation');
+    return new WASMSimulator();
+}

package/dest/private/providers/simulation_provider.d.ts

@@ -0,0 +1,19 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import type { NoirCompiledCircuit } from '@aztec/stdlib/noir';
+import type { ExecutionError } from '@noir-lang/acvm_js';
+import type { Abi, WitnessMap } from '@noir-lang/types';
+import type { ACIRCallback, ACIRExecutionResult } from '../acvm/acvm.js';
+import type { ACVMWitness } from '../acvm/acvm_types.js';
+/**
+ * Low level simulation interface
+ */
+export interface SimulationProvider {
+    executeProtocolCircuit(input: WitnessMap, compiledCircuit: NoirCompiledCircuit): Promise<WitnessMap>;
+    executeUserCircuit(acir: Buffer, initialWitness: ACVMWitness, callback: ACIRCallback): Promise<ACIRExecutionResult>;
+}
+export type ErrorWithPayload = ExecutionError & {
+    decodedAssertionPayload?: any;
+};
+export declare function parseErrorPayload(abi: Abi, originalError: ExecutionError): Error;
+//# sourceMappingURL=simulation_provider.d.ts.map

package/dest/private/providers/simulation_provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"simulation_provider.d.ts","sourceRoot":"","sources":["../../../src/private/providers/simulation_provider.ts"],"names":[],"mappings":";;AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAE9D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEzD,OAAO,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAExD,OAAO,KAAK,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACzE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,sBAAsB,CAAC,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IACrG,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;CACrH;AAED,MAAM,MAAM,gBAAgB,GAAG,cAAc,GAAG;IAAE,uBAAuB,CAAC,EAAE,GAAG,CAAA;CAAE,CAAC;AAIlF,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,aAAa,EAAE,cAAc,GAAG,KAAK,CAuBhF"}

package/dest/private/providers/simulation_provider.js

@@ -0,0 +1,24 @@
+import { abiDecodeError } from '@noir-lang/noirc_abi';
+// Error handling taken from noir/noir-repo/tooling/noir_js/src/witness_generation.ts.
+// TODO: import this in isolation without having to import noir_js in its entirety.
+export function parseErrorPayload(abi, originalError) {
+    const payload = originalError.rawAssertionPayload;
+    if (!payload) {
+        return originalError;
+    }
+    const enrichedError = originalError;
+    try {
+        // Decode the payload
+        const decodedPayload = abiDecodeError(abi, payload);
+        if (typeof decodedPayload === 'string') {
+            // If it's a string, just add it to the error message
+            enrichedError.message = `Circuit execution failed: ${decodedPayload}`;
+        } else {
+            // If not, attach the payload to the original error
+            enrichedError.decodedAssertionPayload = decodedPayload;
+        }
+    } catch (_errorDecoding) {
+    // Ignore errors decoding the payload
+    }
+    return enrichedError;
+}

package/dest/private/simulator.d.ts

@@ -0,0 +1,34 @@
+import type { FunctionCall } from '@aztec/stdlib/abi';
+import { FunctionSelector } from '@aztec/stdlib/abi';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
+import { PrivateExecutionResult, TxExecutionRequest } from '@aztec/stdlib/tx';
+import type { ExecutionDataProvider } from './execution_data_provider.js';
+import type { SimulationProvider } from './providers/simulation_provider.js';
+/**
+ * The ACIR simulator.
+ */
+export declare class AcirSimulator {
+    private executionDataProvider;
+    private simulationProvider;
+    private log;
+    constructor(executionDataProvider: ExecutionDataProvider, simulationProvider: SimulationProvider);
+    /**
+     * Runs a private function.
+     * @param request - The transaction request.
+     * @param entryPointArtifact - The artifact of the entry point function.
+     * @param contractAddress - The address of the contract (should match request.origin)
+     * @param msgSender - The address calling the function. This can be replaced to simulate a call from another contract or a specific account.
+     * @param scopes - The accounts whose notes we can access in this call. Currently optional and will default to all.
+     * @returns The result of the execution.
+     */
+    run(request: TxExecutionRequest, contractAddress: AztecAddress, selector: FunctionSelector, msgSender?: AztecAddress, scopes?: AztecAddress[]): Promise<PrivateExecutionResult>;
+    /**
+     * Runs an unconstrained function.
+     * @param request - The transaction request.
+     * @param entryPointArtifact - The artifact of the entry point function.
+     * @param contractAddress - The address of the contract.
+     * @param scopes - The accounts whose notes we can access in this call. Currently optional and will default to all.
+     */
+    runUnconstrained(request: FunctionCall, contractAddress: AztecAddress, selector: FunctionSelector, scopes?: AztecAddress[]): Promise<import("@aztec/stdlib/abi").AbiDecoded>;
+}
+//# sourceMappingURL=simulator.d.ts.map

package/dest/private/simulator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"simulator.d.ts","sourceRoot":"","sources":["../../src/private/simulator.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAgB,MAAM,mBAAmB,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAe,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAG3F,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAK1E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AAI7E;;GAEG;AACH,qBAAa,aAAa;IAGZ,OAAO,CAAC,qBAAqB;IAAyB,OAAO,CAAC,kBAAkB;IAF5F,OAAO,CAAC,GAAG,CAAS;gBAEA,qBAAqB,EAAE,qBAAqB,EAAU,kBAAkB,EAAE,kBAAkB;IAIhH;;;;;;;;OAQG;IACU,GAAG,CACd,OAAO,EAAE,kBAAkB,EAC3B,eAAe,EAAE,YAAY,EAC7B,QAAQ,EAAE,gBAAgB,EAC1B,SAAS,eAA6C,EACtD,MAAM,CAAC,EAAE,YAAY,EAAE,GACtB,OAAO,CAAC,sBAAsB,CAAC;IA8DlC;;;;;;OAMG;IACU,gBAAgB,CAC3B,OAAO,EAAE,YAAY,EACrB,eAAe,EAAE,YAAY,EAC7B,QAAQ,EAAE,gBAAgB,EAC1B,MAAM,CAAC,EAAE,YAAY,EAAE;CA+B1B"}

package/dest/private/simulator.js

@@ -0,0 +1,76 @@
+import { Fr } from '@aztec/foundation/fields';
+import { createLogger } from '@aztec/foundation/log';
+import { FunctionSelector, FunctionType } from '@aztec/stdlib/abi';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
+import { CallContext, PrivateExecutionResult } from '@aztec/stdlib/tx';
+import { createSimulationError } from '../common/errors.js';
+import { ExecutionNoteCache } from './execution_note_cache.js';
+import { HashedValuesCache } from './hashed_values_cache.js';
+import { executePrivateFunction, verifyCurrentClassId } from './private_execution.js';
+import { PrivateExecutionOracle } from './private_execution_oracle.js';
+import { executeUnconstrainedFunction } from './unconstrained_execution.js';
+import { UnconstrainedExecutionOracle } from './unconstrained_execution_oracle.js';
+/**
+ * The ACIR simulator.
+ */ export class AcirSimulator {
+    executionDataProvider;
+    simulationProvider;
+    log;
+    constructor(executionDataProvider, simulationProvider){
+        this.executionDataProvider = executionDataProvider;
+        this.simulationProvider = simulationProvider;
+        this.log = createLogger('simulator');
+    }
+    /**
+   * Runs a private function.
+   * @param request - The transaction request.
+   * @param entryPointArtifact - The artifact of the entry point function.
+   * @param contractAddress - The address of the contract (should match request.origin)
+   * @param msgSender - The address calling the function. This can be replaced to simulate a call from another contract or a specific account.
+   * @param scopes - The accounts whose notes we can access in this call. Currently optional and will default to all.
+   * @returns The result of the execution.
+   */ async run(request, contractAddress, selector, msgSender = AztecAddress.fromField(Fr.MAX_FIELD_VALUE), scopes) {
+        const header = await this.executionDataProvider.getBlockHeader();
+        await verifyCurrentClassId(contractAddress, this.executionDataProvider);
+        const entryPointArtifact = await this.executionDataProvider.getFunctionArtifact(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 = 1;
+        const callContext = new CallContext(msgSender, contractAddress, await FunctionSelector.fromNameAndParameters(entryPointArtifact.name, entryPointArtifact.parameters), entryPointArtifact.isStatic);
+        const txRequestHash = await request.toTxRequest().hash();
+        const noteCache = new ExecutionNoteCache(txRequestHash);
+        const context = new PrivateExecutionOracle(request.firstCallArgsHash, request.txContext, callContext, header, request.authWitnesses, request.capsules, HashedValuesCache.create(request.argsOfCalls), noteCache, this.executionDataProvider, this.simulationProvider, /*totalPublicArgsCount=*/ 0, startSideEffectCounter, undefined, scopes);
+        try {
+            const executionResult = await executePrivateFunction(this.simulationProvider, context, entryPointArtifact, contractAddress, request.functionSelector);
+            const { usedTxRequestHashForNonces } = noteCache.finish();
+            const firstNullifierHint = usedTxRequestHashForNonces ? Fr.ZERO : noteCache.getAllNullifiers()[0];
+            return new PrivateExecutionResult(executionResult, firstNullifierHint);
+        } catch (err) {
+            throw createSimulationError(err instanceof Error ? err : new Error('Unknown error during private execution'));
+        }
+    }
+    /**
+   * Runs an unconstrained function.
+   * @param request - The transaction request.
+   * @param entryPointArtifact - The artifact of the entry point function.
+   * @param contractAddress - The address of the contract.
+   * @param scopes - The accounts whose notes we can access in this call. Currently optional and will default to all.
+   */ async runUnconstrained(request, contractAddress, selector, scopes) {
+        await verifyCurrentClassId(contractAddress, this.executionDataProvider);
+        const entryPointArtifact = await this.executionDataProvider.getFunctionArtifact(contractAddress, selector);
+        if (entryPointArtifact.functionType !== FunctionType.UNCONSTRAINED) {
+            throw new Error(`Cannot run ${entryPointArtifact.functionType} function as unconstrained`);
+        }
+        const context = new UnconstrainedExecutionOracle(contractAddress, [], [], this.executionDataProvider, undefined, scopes);
+        try {
+            return await executeUnconstrainedFunction(this.simulationProvider, context, entryPointArtifact, contractAddress, request.selector, request.args);
+        } catch (err) {
+            throw createSimulationError(err instanceof Error ? err : new Error('Unknown error during private execution'));
+        }
+    }
+}

package/dest/private/unconstrained_execution.d.ts

@@ -0,0 +1,10 @@
+import type { Fr } from '@aztec/foundation/fields';
+import { type AbiDecoded, type FunctionArtifact, type FunctionSelector } from '@aztec/stdlib/abi';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { SimulationProvider } from './providers/simulation_provider.js';
+import type { UnconstrainedExecutionOracle } from './unconstrained_execution_oracle.js';
+/**
+ * Execute an unconstrained function and return the decoded values.
+ */
+export declare function executeUnconstrainedFunction(simulatorProvider: SimulationProvider, oracle: UnconstrainedExecutionOracle, artifact: FunctionArtifact, contractAddress: AztecAddress, functionSelector: FunctionSelector, args: Fr[], log?: import("@aztec/foundation/log").Logger): Promise<AbiDecoded>;
+//# sourceMappingURL=unconstrained_execution.d.ts.map

package/dest/private/unconstrained_execution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unconstrained_execution.d.ts","sourceRoot":"","sources":["../../src/private/unconstrained_execution.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAEnD,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,gBAAgB,EAAE,KAAK,gBAAgB,EAAiB,MAAM,mBAAmB,CAAC;AACjH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAKhE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,qCAAqC,CAAC;AAGxF;;GAEG;AACH,wBAAsB,4BAA4B,CAChD,iBAAiB,EAAE,kBAAkB,EACrC,MAAM,EAAE,4BAA4B,EACpC,QAAQ,EAAE,gBAAgB,EAC1B,eAAe,EAAE,YAAY,EAC7B,gBAAgB,EAAE,gBAAgB,EAClC,IAAI,EAAE,EAAE,EAAE,EACV,GAAG,yCAAoD,GACtD,OAAO,CAAC,UAAU,CAAC,CAyBrB"}

package/dest/private/unconstrained_execution.js

@@ -0,0 +1,27 @@
+import { createLogger } from '@aztec/foundation/log';
+import { decodeFromAbi } from '@aztec/stdlib/abi';
+import { ExecutionError, resolveAssertionMessageFromError } from '../common/errors.js';
+import { witnessMapToFields } from './acvm/deserialize.js';
+import { Oracle, extractCallStack, toACVMWitness } from './acvm/index.js';
+// docs:start:execute_unconstrained_function
+/**
+ * Execute an unconstrained function and return the decoded values.
+ */ export async function executeUnconstrainedFunction(simulatorProvider, oracle, artifact, contractAddress, functionSelector, args, log = createLogger('simulator:unconstrained_execution')) {
+    log.verbose(`Executing unconstrained function ${artifact.name}`, {
+        contract: contractAddress,
+        selector: functionSelector
+    });
+    const acir = artifact.bytecode;
+    const initialWitness = toACVMWitness(0, args);
+    const acirExecutionResult = await simulatorProvider.executeUserCircuit(acir, initialWitness, new Oracle(oracle)).catch((err)=>{
+        err.message = resolveAssertionMessageFromError(err, artifact);
+        throw new ExecutionError(err.message, {
+            contractAddress,
+            functionSelector
+        }, extractCallStack(err, artifact.debug), {
+            cause: err
+        });
+    });
+    const returnWitness = witnessMapToFields(acirExecutionResult.returnWitness);
+    return decodeFromAbi(artifact.returnTypes, returnWitness);
+} // docs:end:execute_unconstrained_function

package/dest/private/unconstrained_execution_oracle.d.ts

@@ -0,0 +1,161 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import { Fr } from '@aztec/foundation/fields';
+import type { AuthWitness } from '@aztec/stdlib/auth-witness';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { CompleteAddress, ContractInstance } from '@aztec/stdlib/contract';
+import type { KeyValidationRequest } from '@aztec/stdlib/kernel';
+import { IndexedTaggingSecret, LogWithTxData } from '@aztec/stdlib/logs';
+import type { NoteStatus } from '@aztec/stdlib/note';
+import { type MerkleTreeId, type NullifierMembershipWitness, PublicDataWitness } from '@aztec/stdlib/trees';
+import type { BlockHeader, Capsule } from '@aztec/stdlib/tx';
+import { type NoteData, TypedOracle } from './acvm/index.js';
+import type { ExecutionDataProvider } from './execution_data_provider.js';
+/**
+ * The oracle for an unconstrained function execution.
+ */
+export declare class UnconstrainedExecutionOracle extends TypedOracle {
+    protected readonly contractAddress: AztecAddress;
+    /** List of transient auth witnesses to be used during this simulation */
+    protected readonly authWitnesses: AuthWitness[];
+    protected readonly capsules: Capsule[];
+    protected readonly executionDataProvider: ExecutionDataProvider;
+    protected log: import("@aztec/foundation/log").Logger;
+    protected readonly scopes?: AztecAddress[] | undefined;
+    constructor(contractAddress: AztecAddress, 
+    /** List of transient auth witnesses to be used during this simulation */
+    authWitnesses: AuthWitness[], capsules: Capsule[], executionDataProvider: ExecutionDataProvider, log?: import("@aztec/foundation/log").Logger, scopes?: AztecAddress[] | undefined);
+    getBlockNumber(): Promise<number>;
+    getContractAddress(): Promise<AztecAddress>;
+    getChainId(): Promise<Fr>;
+    getVersion(): Promise<Fr>;
+    /**
+     * Retrieve keys associated with a specific master public key and app address.
+     * @param pkMHash - The master public key hash.
+     * @returns A Promise that resolves to nullifier keys.
+     * @throws If the keys are not registered in the key store.
+     */
+    getKeyValidationRequest(pkMHash: Fr): Promise<KeyValidationRequest>;
+    /**
+     * Fetches the index and sibling path of a leaf at a given block from a given tree.
+     * @param blockNumber - The block number at which to get the membership witness.
+     * @param treeId - Id of the tree to get the sibling path from.
+     * @param leafValue - The leaf value
+     * @returns The index and sibling path concatenated [index, sibling_path]
+     */
+    getMembershipWitness(blockNumber: number, treeId: MerkleTreeId, leafValue: Fr): Promise<Fr[]>;
+    /**
+     * Returns a nullifier membership witness for a given nullifier at a given block.
+     * @param blockNumber - The block number at which to get the index.
+     * @param nullifier - Nullifier we try to find witness for.
+     * @returns The nullifier membership witness (if found).
+     */
+    getNullifierMembershipWitness(blockNumber: number, nullifier: Fr): Promise<NullifierMembershipWitness | undefined>;
+    /**
+     * Returns a low nullifier membership witness for a given nullifier at a given block.
+     * @param blockNumber - The block number at which to get the index.
+     * @param nullifier - Nullifier we try to find the low nullifier witness for.
+     * @returns The low nullifier membership witness (if found).
+     * @remarks Low nullifier witness can be used to perform a nullifier non-inclusion proof by leveraging the "linked
+     * list structure" of leaves and proving that a lower nullifier is pointing to a bigger next value than the nullifier
+     * we are trying to prove non-inclusion for.
+     */
+    getLowNullifierMembershipWitness(blockNumber: number, nullifier: Fr): Promise<NullifierMembershipWitness | undefined>;
+    /**
+     * Returns a public data tree witness for a given leaf slot at a given block.
+     * @param blockNumber - The block number at which to get the index.
+     * @param leafSlot - The slot of the public data tree to get the witness for.
+     * @returns - The witness
+     */
+    getPublicDataTreeWitness(blockNumber: number, leafSlot: Fr): Promise<PublicDataWitness | undefined>;
+    /**
+     * Fetches a block header of a given block.
+     * @param blockNumber - The number of a block of which to get the block header.
+     * @returns Block extracted from a block with block number `blockNumber`.
+     */
+    getBlockHeader(blockNumber: number): Promise<BlockHeader | undefined>;
+    /**
+     * Retrieve the complete address associated to a given address.
+     * @param account - The account address.
+     * @returns A complete address associated with the input address.
+     * @throws An error if the account is not registered in the database.
+     */
+    getCompleteAddress(account: AztecAddress): Promise<CompleteAddress>;
+    /**
+     * Returns a contract instance associated with an address or throws if not found.
+     * @param address - Address.
+     * @returns A contract instance.
+     */
+    getContractInstance(address: AztecAddress): Promise<ContractInstance>;
+    /**
+     * Returns an auth witness for the given message hash. Checks on the list of transient witnesses
+     * for this transaction first, and falls back to the local database if not found.
+     * @param messageHash - Hash of the message to authenticate.
+     * @returns Authentication witness for the requested message hash.
+     */
+    getAuthWitness(messageHash: Fr): Promise<Fr[] | undefined>;
+    /**
+     * Gets some notes for a contract address and storage slot.
+     * Returns a flattened array containing filtered notes.
+     *
+     * @remarks
+     * Check for pending notes with matching slot.
+     * Real notes coming from DB will have a leafIndex which
+     * represents their index in the note hash tree.
+     *
+     * @param storageSlot - The storage slot.
+     * @param numSelects - The number of valid selects in selectBy and selectValues.
+     * @param selectBy - An array of indices of the fields to selects.
+     * @param selectValues - The values to match.
+     * @param selectComparators - The comparators to use to match values.
+     * @param sortBy - An array of indices of the fields to sort.
+     * @param sortOrder - The order of the corresponding index in sortBy. (1: DESC, 2: ASC, 0: Do nothing)
+     * @param limit - The number of notes to retrieve per query.
+     * @param offset - The starting index for pagination.
+     * @param status - The status of notes to fetch.
+     * @returns Array of note data.
+     */
+    getNotes(storageSlot: Fr, numSelects: number, selectByIndexes: number[], selectByOffsets: number[], selectByLengths: number[], selectValues: Fr[], selectComparators: number[], sortByIndexes: number[], sortByOffsets: number[], sortByLengths: number[], sortOrder: number[], limit: number, offset: number, status: NoteStatus): Promise<NoteData[]>;
+    /**
+     * Check if a nullifier exists in the nullifier tree.
+     * @param innerNullifier - The inner nullifier.
+     * @returns A boolean indicating whether the nullifier exists in the tree or not.
+     */
+    checkNullifierExists(innerNullifier: Fr): Promise<boolean>;
+    /**
+     * Fetches a message from the executionDataProvider, given its key.
+     * @param contractAddress - Address of a contract by which the message was emitted.
+     * @param messageHash - Hash of the message.
+     * @param secret - Secret used to compute a nullifier.
+     * @dev Contract address and secret are only used to compute the nullifier to get non-nullified messages
+     * @returns The l1 to l2 membership witness (index of message in the tree and sibling path).
+     */
+    getL1ToL2MembershipWitness(contractAddress: AztecAddress, messageHash: Fr, secret: Fr): Promise<import("../client.js").MessageLoadOracleInputs<39>>;
+    /**
+     * Read the public storage data.
+     * @param contractAddress - The address to read storage from.
+     * @param startStorageSlot - The starting storage slot.
+     * @param blockNumber - The block number to read storage at.
+     * @param numberOfElements - Number of elements to read from the starting storage slot.
+     */
+    storageRead(contractAddress: AztecAddress, startStorageSlot: Fr, blockNumber: number, numberOfElements: number): Promise<Fr[]>;
+    debugLog(message: string, fields: Fr[]): void;
+    /**
+     * Returns the tagging secret for a given sender and recipient pair, siloed to the current contract address.
+     * Includes the next index to be used used for tagging with this secret.
+     * For this to work, the ivsk_m of the sender must be known.
+     * @param sender - The address sending the note
+     * @param recipient - The address receiving the note
+     * @returns A tagging secret that can be used to tag notes.
+     */
+    getIndexedTaggingSecretAsSender(sender: AztecAddress, recipient: AztecAddress): Promise<IndexedTaggingSecret>;
+    syncNotes(): Promise<void>;
+    deliverNote(contractAddress: AztecAddress, storageSlot: Fr, nonce: Fr, content: Fr[], noteHash: Fr, nullifier: Fr, txHash: Fr, recipient: AztecAddress): Promise<void>;
+    getLogByTag(tag: Fr): Promise<LogWithTxData | null>;
+    storeCapsule(contractAddress: AztecAddress, slot: Fr, capsule: Fr[]): Promise<void>;
+    loadCapsule(contractAddress: AztecAddress, slot: Fr): Promise<Fr[] | null>;
+    deleteCapsule(contractAddress: AztecAddress, slot: Fr): Promise<void>;
+    copyCapsule(contractAddress: AztecAddress, srcSlot: Fr, dstSlot: Fr, numEntries: number): Promise<void>;
+    aes128Decrypt(ciphertext: Buffer, iv: Buffer, symKey: Buffer): Promise<Buffer>;
+}
+//# sourceMappingURL=unconstrained_execution_oracle.d.ts.map

package/dest/private/unconstrained_execution_oracle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unconstrained_execution_oracle.d.ts","sourceRoot":"","sources":["../../src/private/unconstrained_execution_oracle.ts"],"names":[],"mappings":";;AACA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAE9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAEhF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACzE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,0BAA0B,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC5G,OAAO,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE7D,OAAO,EAAE,KAAK,QAAQ,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAG1E;;GAEG;AACH,qBAAa,4BAA6B,SAAQ,WAAW;IAEzD,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE,YAAY;IAChD,yEAAyE;IACzE,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,WAAW,EAAE;IAC/C,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE;IACtC,SAAS,CAAC,QAAQ,CAAC,qBAAqB,EAAE,qBAAqB;IAC/D,SAAS,CAAC,GAAG;IACb,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC;gBANP,eAAe,EAAE,YAAY;IAChD,yEAAyE;IACtD,aAAa,EAAE,WAAW,EAAE,EAC5B,QAAQ,EAAE,OAAO,EAAE,EACnB,qBAAqB,EAAE,qBAAqB,EACrD,GAAG,yCAAgD,EAC1C,MAAM,CAAC,4BAAgB;IAK5B,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC;IAIjC,kBAAkB,IAAI,OAAO,CAAC,YAAY,CAAC;IAI3C,UAAU,IAAI,OAAO,CAAC,EAAE,CAAC;IAIzB,UAAU,IAAI,OAAO,CAAC,EAAE,CAAC;IAIzC;;;;;OAKG;IACa,uBAAuB,CAAC,OAAO,EAAE,EAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAInF;;;;;;OAMG;IACa,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,EAAE,GAAG,OAAO,CAAC,EAAE,EAAE,CAAC;IAI7G;;;;;OAKG;IACmB,6BAA6B,CACjD,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,EAAE,GACZ,OAAO,CAAC,0BAA0B,GAAG,SAAS,CAAC;IAIlD;;;;;;;;OAQG;IACmB,gCAAgC,CACpD,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,EAAE,GACZ,OAAO,CAAC,0BAA0B,GAAG,SAAS,CAAC;IAIlD;;;;;OAKG;IACmB,wBAAwB,CAC5C,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,EAAE,GACX,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAIzC;;;;OAIG;IACmB,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAQ3F;;;;;OAKG;IACa,kBAAkB,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,eAAe,CAAC;IAInF;;;;OAIG;IACa,mBAAmB,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAIrF;;;;;OAKG;IACa,cAAc,CAAC,WAAW,EAAE,EAAE,GAAG,OAAO,CAAC,EAAE,EAAE,GAAG,SAAS,CAAC;IAO1E;;;;;;;;;;;;;;;;;;;;OAoBG;IACmB,QAAQ,CAC5B,WAAW,EAAE,EAAE,EACf,UAAU,EAAE,MAAM,EAClB,eAAe,EAAE,MAAM,EAAE,EACzB,eAAe,EAAE,MAAM,EAAE,EACzB,eAAe,EAAE,MAAM,EAAE,EACzB,YAAY,EAAE,EAAE,EAAE,EAClB,iBAAiB,EAAE,MAAM,EAAE,EAC3B,aAAa,EAAE,MAAM,EAAE,EACvB,aAAa,EAAE,MAAM,EAAE,EACvB,aAAa,EAAE,MAAM,EAAE,EACvB,SAAS,EAAE,MAAM,EAAE,EACnB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,UAAU,GACjB,OAAO,CAAC,QAAQ,EAAE,CAAC;IAiBtB;;;;OAIG;IACmB,oBAAoB,CAAC,cAAc,EAAE,EAAE;IAM7D;;;;;;;OAOG;IACmB,0BAA0B,CAAC,eAAe,EAAE,YAAY,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE;IAI3G;;;;;;OAMG;IACmB,WAAW,CAC/B,eAAe,EAAE,YAAY,EAC7B,gBAAgB,EAAE,EAAE,EACpB,WAAW,EAAE,MAAM,EACnB,gBAAgB,EAAE,MAAM;IAeV,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,IAAI;IAQ7D;;;;;;;OAOG;IACmB,+BAA+B,CACnD,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,YAAY,GACtB,OAAO,CAAC,oBAAoB,CAAC;IAIV,SAAS;IAcT,WAAW,CAC/B,eAAe,EAAE,YAAY,EAC7B,WAAW,EAAE,EAAE,EACf,KAAK,EAAE,EAAE,EACT,OAAO,EAAE,EAAE,EAAE,EACb,QAAQ,EAAE,EAAE,EACZ,SAAS,EAAE,EAAE,EACb,MAAM,EAAE,EAAE,EACV,SAAS,EAAE,YAAY;IAmBT,WAAW,CAAC,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;IAInD,YAAY,CAAC,eAAe,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ7E,WAAW,CAAC,eAAe,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,GAAG,OAAO,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC;IAWhF,aAAa,CAAC,eAAe,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAQrE,WAAW,CACzB,eAAe,EAAE,YAAY,EAC7B,OAAO,EAAE,EAAE,EACX,OAAO,EAAE,EAAE,EACX,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC;IASA,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAI/F"}