@aztec/simulator 0.0.0-test.0

package/README.md

@@ -0,0 +1,49 @@
+# Simulator
+
+## Responsibilities
+
+This library package is responsible for simulating function circuits compiled to ACIR / AVM.
+
+Simulating a function implies generating the partial witness and the public inputs of the function, as well as collecting all the data (such as created notes or nullifiers, or state changes) that are necessary for components upstream.
+
+It's able to simulate three different types of functions:
+
+### Private Functions
+
+Private functions are simulated and proved client-side, and verified client-side in the private kernel circuit.
+
+The public inputs of private functions is defined [here](../stdlib/src/structs/private_circuit_public_inputs.ts).
+
+They are run with the assistance of a DB oracle that provides any private data requested by the function.
+
+Private functions can call another private function, and can request to call a public function, but the public function execution will be performed by the sequencer asynchronously, thus having no access to the return values.
+
+### Public Functions
+
+Public functions are simulated and proved on the sequencer side, and verified by the public kernel circuit.
+
+The public inputs of public functions is defined [here](../stdlib/src/structs/avm/avm_circuit_public_inputs.ts).
+
+They are run with the assistance of an oracle that provides any value read from the public state tree.
+
+Public functions can call other public function, but no private functions.
+
+### Unconstrained Functions
+
+Unconstrained functions are useful to extract useful data for users that could produce very large execution traces - such as the summed balance of all a users notes
+They are not proved, and are simulated client-side.
+
+They are run with the assistance of a DB oracle that provides any private data requested by the function.
+
+At the moment, unconstrained functions cannot call any other function.
+It would be possible to allow them to call other unconstrained functions.
+
+## Usage
+
+### Development
+
+Same steps as any other library. They are detailed [here](../README.md#development)
+
+### Testing
+
+Same steps as any other library. They are detailed [here](../README.md#tests)

package/dest/client.d.ts

@@ -0,0 +1,5 @@
+export * from './private/index.js';
+export { WASMSimulator } from './private/providers/acvm_wasm.js';
+export { type SimulationProvider } from './private/providers/simulation_provider.js';
+export * from './common/index.js';
+//# sourceMappingURL=client.d.ts.map

package/dest/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,4CAA4C,CAAC;AACrF,cAAc,mBAAmB,CAAC"}

package/dest/client.js

@@ -0,0 +1,3 @@
+export * from './private/index.js';
+export { WASMSimulator } from './private/providers/acvm_wasm.js';
+export * from './common/index.js';

package/dest/common/db_interfaces.d.ts

@@ -0,0 +1,80 @@
+import type { L1_TO_L2_MSG_TREE_HEIGHT } from '@aztec/constants';
+import type { Fr } from '@aztec/foundation/fields';
+import type { FunctionSelector } from '@aztec/stdlib/abi';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { ContractInstanceWithAddress } from '@aztec/stdlib/contract';
+import type { NullifierMembershipWitness } from '@aztec/stdlib/trees';
+import type { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
+/**
+ * Database interface for providing access to public state.
+ */
+export interface PublicStateDB {
+    /**
+     * Reads a value from public storage, returning zero if none.
+     * @param contract - Owner of the storage.
+     * @param slot - Slot to read in the contract storage.
+     * @returns The current value in the storage slot.
+     */
+    storageRead(contract: AztecAddress, slot: Fr): Promise<Fr>;
+    /**
+     * Records a write to public storage.
+     * @param contract - Owner of the storage.
+     * @param slot - Slot to read in the contract storage.
+     * @param newValue - The new value to store.
+     */
+    storageWrite(contract: AztecAddress, slot: Fr, newValue: Fr): Promise<void>;
+}
+/**
+ * Database interface for providing access to public contract data.
+ */
+export interface PublicContractsDB {
+    /**
+     * Returns a publicly deployed contract instance.
+     * @param address - Address of the contract.
+     * @returns The contract instance or undefined if not found.
+     */
+    getContractInstance(address: AztecAddress): Promise<ContractInstanceWithAddress | undefined>;
+    getDebugFunctionName(contractAddress: AztecAddress, selector: FunctionSelector): Promise<string | undefined>;
+}
+/** Database interface for providing access to commitment tree, l1 to l2 message tree, and nullifier tree. */
+export interface CommitmentsDB {
+    /**
+     * Fetches a message from the db, 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<MessageLoadOracleInputs<typeof L1_TO_L2_MSG_TREE_HEIGHT>>;
+    /**
+     * @param leafIndex the leaf to look up
+     * @returns The l1 to l2 leaf value or undefined if not found.
+     */
+    getL1ToL2LeafValue(leafIndex: bigint): Promise<Fr | undefined>;
+    /**
+     * Gets the index of a commitment in the note hash tree.
+     * @param commitment - The commitment.
+     * @returns - The index of the commitment. Undefined if it does not exist in the tree.
+     */
+    getCommitmentIndex(commitment: Fr): Promise<bigint | undefined>;
+    /**
+     * Gets commitment in the note hash tree given a leaf index.
+     * @param leafIndex - the leaf to look up.
+     * @returns - The commitment at that index. Undefined if leaf index is not found.
+     */
+    getCommitmentValue(leafIndex: bigint): Promise<Fr | undefined>;
+    /**
+     * Gets the index of a nullifier in the nullifier tree.
+     * @param nullifier - The nullifier.
+     * @returns - The index of the nullifier. Undefined if it does not exist in the tree.
+     */
+    getNullifierIndex(nullifier: Fr): Promise<bigint | undefined>;
+    /**
+     * Returns a nullifier membership witness for the given nullifier or undefined if not found.
+     * REFACTOR: Same as getL1ToL2MembershipWitness, can be combined with aztec-node method that does almost the same thing.
+     * @param nullifier - Nullifier we're looking for.
+     */
+    getNullifierMembershipWitnessAtLatestBlock(nullifier: Fr): Promise<NullifierMembershipWitness | undefined>;
+}
+//# sourceMappingURL=db_interfaces.d.ts.map

package/dest/common/db_interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"db_interfaces.d.ts","sourceRoot":"","sources":["../../src/common/db_interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AACjE,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAC1E,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AAEtE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAE/E;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;OAKG;IACH,WAAW,CAAC,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;IAE3D;;;;;OAKG;IACH,YAAY,CAAC,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7E;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,mBAAmB,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,2BAA2B,GAAG,SAAS,CAAC,CAAC;IAE7F,oBAAoB,CAAC,eAAe,EAAE,YAAY,EAAE,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CAC9G;AAED,6GAA6G;AAC7G,MAAM,WAAW,aAAa;IAC5B;;;;;;;OAOG;IACH,0BAA0B,CACxB,eAAe,EAAE,YAAY,EAC7B,WAAW,EAAE,EAAE,EACf,MAAM,EAAE,EAAE,GACT,OAAO,CAAC,uBAAuB,CAAC,OAAO,wBAAwB,CAAC,CAAC,CAAC;IAErE;;;OAGG;IACH,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,GAAG,SAAS,CAAC,CAAC;IAE/D;;;;OAIG;IACH,kBAAkB,CAAC,UAAU,EAAE,EAAE,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAEhE;;;;OAIG;IACH,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,GAAG,SAAS,CAAC,CAAC;IAE/D;;;;OAIG;IACH,iBAAiB,CAAC,SAAS,EAAE,EAAE,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAE9D;;;;OAIG;IACH,0CAA0C,CAAC,SAAS,EAAE,EAAE,GAAG,OAAO,CAAC,0BAA0B,GAAG,SAAS,CAAC,CAAC;CAC5G"}

package/dest/common/db_interfaces.js

@@ -0,0 +1 @@
+/** Database interface for providing access to commitment tree, l1 to l2 message tree, and nullifier tree. */ export { };

package/dest/common/debug_fn_name.d.ts

@@ -0,0 +1,5 @@
+import type { Fr } from '@aztec/foundation/fields';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { WorldStateDB } from '../public/public_db_sources.js';
+export declare function getPublicFunctionDebugName(db: WorldStateDB, contractAddress: AztecAddress, calldata: Fr[]): Promise<string>;
+//# sourceMappingURL=debug_fn_name.d.ts.map

package/dest/common/debug_fn_name.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"debug_fn_name.d.ts","sourceRoot":"","sources":["../../src/common/debug_fn_name.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAEnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAEhE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAEnE,wBAAsB,0BAA0B,CAC9C,EAAE,EAAE,YAAY,EAChB,eAAe,EAAE,YAAY,EAC7B,QAAQ,EAAE,EAAE,EAAE,GACb,OAAO,CAAC,MAAM,CAAC,CAOjB"}

package/dest/common/debug_fn_name.js

@@ -0,0 +1,6 @@
+import { FunctionSelector } from '@aztec/stdlib/abi';
+export async function getPublicFunctionDebugName(db, contractAddress, calldata) {
+    // Public function is dispatched and therefore the target function is passed in the first argument.
+    const targetFunction = calldata[0] !== undefined ? await db.getDebugFunctionName(contractAddress, FunctionSelector.fromField(calldata[0])) : `<calldata[0] undefined> (Contract Address: ${contractAddress})`;
+    return `${targetFunction}`;
+}

package/dest/common/errors.d.ts

@@ -0,0 +1,54 @@
+import type { Fr } from '@aztec/foundation/fields';
+import type { BrilligFunctionId, FunctionAbi, FunctionDebugMetadata, OpcodeLocation } from '@aztec/stdlib/abi';
+import { type FailingFunction, type NoirCallStack, SimulationError, type SourceCodeLocation } from '@aztec/stdlib/errors';
+import type { RawAssertionPayload } from '@noir-lang/acvm_js';
+/**
+ * An error that occurred during the execution of a function.
+ * @param message - the error message
+ * @param failingFunction - the Aztec function that failed
+ * @param noirCallStack - the internal call stack of the function that failed (within the failing Aztec function)
+ * @param options - additional error options (an optional "cause" entry allows for a recursive error stack where
+ *                  an error's cause may be an ExecutionError itself)
+ */
+export declare class ExecutionError extends Error {
+    /**
+     * The function that failed.
+     */
+    failingFunction: FailingFunction;
+    /**
+     * The noir call stack of the function that failed.
+     */
+    noirCallStack?: NoirCallStack | undefined;
+    constructor(message: string, 
+    /**
+     * The function that failed.
+     */
+    failingFunction: FailingFunction, 
+    /**
+     * The noir call stack of the function that failed.
+     */
+    noirCallStack?: NoirCallStack | undefined, options?: ErrorOptions);
+}
+/**
+ * Traverses the cause chain of an error.
+ * @param error - The error to start from.
+ * @param callback - A callback on every error, including the first one.
+ */
+export declare function traverseCauseChain(error: Error, callback: (error: Error) => void): void;
+/**
+ * Creates a simulation error from an error chain generated during the execution of a function.
+ * @param error - The error thrown during execution.
+ * @returns - A simulation error.
+ */
+export declare function createSimulationError(error: Error, revertData?: Fr[]): SimulationError;
+/**
+ * Extracts the source code locations for an array of opcode locations
+ * @param opcodeLocations - The opcode locations that caused the error.
+ * @param debug - The debug metadata of the function.
+ * @returns The source code locations.
+ */
+export declare function resolveOpcodeLocations(opcodeLocations: OpcodeLocation[], debug: FunctionDebugMetadata, brilligFunctionId?: BrilligFunctionId): SourceCodeLocation[];
+export declare function resolveAssertionMessage(errorPayload: RawAssertionPayload, abi: FunctionAbi): string | undefined;
+export declare function resolveAssertionMessageFromRevertData(revertData: Fr[], abi: FunctionAbi): string | undefined;
+export declare function resolveAssertionMessageFromError(err: Error, abi: FunctionAbi): string;
+//# sourceMappingURL=errors.d.ts.map

package/dest/common/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/common/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAEnD,OAAO,KAAK,EAAE,iBAAiB,EAAE,WAAW,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAC/G,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,aAAa,EAClB,eAAe,EACf,KAAK,kBAAkB,EACxB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAG9D;;;;;;;GAOG;AACH,qBAAa,cAAe,SAAQ,KAAK;IAGrC;;OAEG;IACI,eAAe,EAAE,eAAe;IACvC;;OAEG;IACI,aAAa,CAAC;gBARrB,OAAO,EAAE,MAAM;IACf;;OAEG;IACI,eAAe,EAAE,eAAe;IACvC;;OAEG;IACI,aAAa,CAAC,2BAAe,EACpC,OAAO,CAAC,EAAE,YAAY;CAIzB;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,QAUhF;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,CAAC,EAAE,EAAE,EAAE,GAAG,eAAe,CAgBtF;AAuDD;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,eAAe,EAAE,cAAc,EAAE,EACjC,KAAK,EAAE,qBAAqB,EAC5B,iBAAiB,CAAC,EAAE,iBAAiB,GACpC,kBAAkB,EAAE,CAItB;AAED,wBAAgB,uBAAuB,CAAC,YAAY,EAAE,mBAAmB,EAAE,GAAG,EAAE,WAAW,GAAG,MAAM,GAAG,SAAS,CAW/G;AAED,wBAAgB,qCAAqC,CAAC,UAAU,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,WAAW,GAAG,MAAM,GAAG,SAAS,CAc5G;AAED,wBAAgB,gCAAgC,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,GAAG,MAAM,CAMrF"}

package/dest/common/errors.js

@@ -0,0 +1,135 @@
+import { jsonStringify } from '@aztec/foundation/json-rpc';
+import { SimulationError } from '@aztec/stdlib/errors';
+import { abiDecodeError } from '@noir-lang/noirc_abi';
+/**
+ * An error that occurred during the execution of a function.
+ * @param message - the error message
+ * @param failingFunction - the Aztec function that failed
+ * @param noirCallStack - the internal call stack of the function that failed (within the failing Aztec function)
+ * @param options - additional error options (an optional "cause" entry allows for a recursive error stack where
+ *                  an error's cause may be an ExecutionError itself)
+ */ export class ExecutionError extends Error {
+    failingFunction;
+    noirCallStack;
+    constructor(message, /**
+     * The function that failed.
+     */ failingFunction, /**
+     * The noir call stack of the function that failed.
+     */ noirCallStack, options){
+        super(message, options), this.failingFunction = failingFunction, this.noirCallStack = noirCallStack;
+    }
+}
+/**
+ * Traverses the cause chain of an error.
+ * @param error - The error to start from.
+ * @param callback - A callback on every error, including the first one.
+ */ export function traverseCauseChain(error, callback) {
+    let currentError = error;
+    while(currentError){
+        callback(currentError);
+        if (currentError.cause && currentError.cause instanceof Error) {
+            currentError = currentError.cause;
+        } else {
+            currentError = undefined;
+        }
+    }
+}
+/**
+ * Creates a simulation error from an error chain generated during the execution of a function.
+ * @param error - The error thrown during execution.
+ * @returns - A simulation error.
+ */ export function createSimulationError(error, revertData) {
+    let rootCause = error;
+    let noirCallStack = undefined;
+    const aztecCallStack = [];
+    traverseCauseChain(error, (cause)=>{
+        rootCause = cause;
+        if (cause instanceof ExecutionError) {
+            aztecCallStack.push(cause.failingFunction);
+            if (cause.noirCallStack) {
+                noirCallStack = cause.noirCallStack;
+            }
+        }
+    });
+    return new SimulationError(rootCause.message, aztecCallStack, revertData, noirCallStack, {
+        cause: rootCause
+    });
+}
+/**
+ * Extracts a brillig location from an opcode location.
+ * @param opcodeLocation - The opcode location to extract from. It should be in the format `acirLocation.brilligLocation` or `acirLocation`.
+ * @returns The brillig location if the opcode location contains one.
+ */ function extractBrilligLocation(opcodeLocation) {
+    const splitted = opcodeLocation.split('.');
+    if (splitted.length === 2) {
+        return splitted[1];
+    }
+    return undefined;
+}
+/**
+ * Extracts the call stack from the location of a failing opcode and the debug metadata.
+ * One opcode can point to multiple calls due to inlining.
+ */ function getSourceCodeLocationsFromOpcodeLocation(opcodeLocation, debug, brilligFunctionId) {
+    const { debugSymbols, files } = debug;
+    let callStack = debugSymbols.locations[opcodeLocation] || [];
+    if (callStack.length === 0) {
+        const brilligLocation = extractBrilligLocation(opcodeLocation);
+        if (brilligFunctionId !== undefined && brilligLocation !== undefined) {
+            callStack = debugSymbols.brillig_locations[brilligFunctionId][brilligLocation] || [];
+        }
+    }
+    return callStack.map((call)=>{
+        const { file: fileId, span } = call;
+        const { path, source } = files[fileId];
+        const locationText = source.substring(span.start, span.end);
+        const precedingText = source.substring(0, span.start);
+        const previousLines = precedingText.split('\n');
+        // Lines and columns in stacks are one indexed.
+        const line = previousLines.length;
+        const column = previousLines[previousLines.length - 1].length + 1;
+        return {
+            filePath: path,
+            line,
+            column,
+            fileSource: source,
+            locationText
+        };
+    });
+}
+/**
+ * Extracts the source code locations for an array of opcode locations
+ * @param opcodeLocations - The opcode locations that caused the error.
+ * @param debug - The debug metadata of the function.
+ * @returns The source code locations.
+ */ export function resolveOpcodeLocations(opcodeLocations, debug, brilligFunctionId) {
+    return opcodeLocations.flatMap((opcodeLocation)=>getSourceCodeLocationsFromOpcodeLocation(opcodeLocation, debug, brilligFunctionId));
+}
+export function resolveAssertionMessage(errorPayload, abi) {
+    const decoded = abiDecodeError({
+        parameters: [],
+        error_types: abi.errorTypes,
+        return_type: null
+    }, errorPayload);
+    if (typeof decoded === 'string') {
+        return decoded;
+    } else {
+        return jsonStringify(decoded);
+    }
+}
+export function resolveAssertionMessageFromRevertData(revertData, abi) {
+    if (revertData.length == 0) {
+        return undefined;
+    }
+    const [errorSelector, ...errorData] = revertData;
+    return resolveAssertionMessage({
+        selector: errorSelector.toBigInt().toString(),
+        data: errorData.map((f)=>f.toString())
+    }, abi);
+}
+export function resolveAssertionMessageFromError(err, abi) {
+    if (typeof err === 'object' && err !== null && 'rawAssertionPayload' in err && err.rawAssertionPayload) {
+        return `Assertion failed: ${resolveAssertionMessage(err.rawAssertionPayload, abi)}`;
+    } else {
+        return err.message;
+    }
+}

package/dest/common/index.d.ts

@@ -0,0 +1,4 @@
+export * from './errors.js';
+export * from './stats/index.js';
+export * from './message_load_oracle_inputs.js';
+//# sourceMappingURL=index.d.ts.map

package/dest/common/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,iCAAiC,CAAC"}

package/dest/common/index.js

@@ -0,0 +1,3 @@
+export * from './errors.js';
+export * from './stats/index.js';
+export * from './message_load_oracle_inputs.js';

package/dest/common/message_load_oracle_inputs.d.ts

@@ -0,0 +1,15 @@
+import { Fr } from '@aztec/foundation/fields';
+import type { SiblingPath } from '@aztec/foundation/trees';
+export declare class MessageLoadOracleInputs<N extends number> {
+    /** The index of the message commitment in the merkle tree. */
+    index: bigint;
+    /** The path in the merkle tree to the message. */
+    siblingPath: SiblingPath<N>;
+    constructor(
+    /** The index of the message commitment in the merkle tree. */
+    index: bigint, 
+    /** The path in the merkle tree to the message. */
+    siblingPath: SiblingPath<N>);
+    toFields(): Fr[];
+}
+//# sourceMappingURL=message_load_oracle_inputs.d.ts.map

package/dest/common/message_load_oracle_inputs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"message_load_oracle_inputs.d.ts","sourceRoot":"","sources":["../../src/common/message_load_oracle_inputs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAE3D,qBAAa,uBAAuB,CAAC,CAAC,SAAS,MAAM;IAEjD,8DAA8D;IACvD,KAAK,EAAE,MAAM;IACpB,kDAAkD;IAC3C,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;;IAHlC,8DAA8D;IACvD,KAAK,EAAE,MAAM;IACpB,kDAAkD;IAC3C,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;IAGpC,QAAQ,IAAI,EAAE,EAAE;CAGjB"}

package/dest/common/message_load_oracle_inputs.js

@@ -0,0 +1,15 @@
+import { Fr } from '@aztec/foundation/fields';
+export class MessageLoadOracleInputs {
+    index;
+    siblingPath;
+    constructor(/** The index of the message commitment in the merkle tree. */ index, /** The path in the merkle tree to the message. */ siblingPath){
+        this.index = index;
+        this.siblingPath = siblingPath;
+    }
+    toFields() {
+        return [
+            new Fr(this.index),
+            ...this.siblingPath.toFields()
+        ];
+    }
+}

package/dest/common/stats/index.d.ts

@@ -0,0 +1,2 @@
+export * from './stats.js';
+//# sourceMappingURL=index.d.ts.map

package/dest/common/stats/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/common/stats/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC"}

package/dest/common/stats/index.js

@@ -0,0 +1 @@
+export * from './stats.js';

package/dest/common/stats/stats.d.ts

@@ -0,0 +1,4 @@
+import type { Logger } from '@aztec/foundation/log';
+import type { CircuitName } from '@aztec/stdlib/stats';
+export declare function emitCircuitSimulationStats(circuitName: CircuitName, duration: number, inputSize: number, outputSize: number, logger: Logger): void;
+//# sourceMappingURL=stats.d.ts.map

package/dest/common/stats/stats.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stats.d.ts","sourceRoot":"","sources":["../../../src/common/stats/stats.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,KAAK,EAAE,WAAW,EAA0B,MAAM,qBAAqB,CAAC;AAE/E,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,WAAW,EACxB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,QAWf"}

package/dest/common/stats/stats.js

@@ -0,0 +1,10 @@
+export function emitCircuitSimulationStats(circuitName, duration, inputSize, outputSize, logger) {
+    const stats = {
+        eventName: 'circuit-simulation',
+        circuitName,
+        inputSize,
+        outputSize,
+        duration
+    };
+    logger.debug('Circuit simulation stats', stats);
+}

package/dest/private/acvm/acvm.d.ts

@@ -0,0 +1,35 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import type { FunctionDebugMetadata } from '@aztec/stdlib/abi';
+import type { NoirCallStack } from '@aztec/stdlib/errors';
+import { type ExecutionError, type ForeignCallInput, type ForeignCallOutput } from '@noir-lang/acvm_js';
+import type { ACVMWitness } from './acvm_types.js';
+import type { ORACLE_NAMES } from './oracle/index.js';
+/**
+ * The callback interface for the ACIR.
+ */
+export type ACIRCallback = Record<ORACLE_NAMES, (...args: ForeignCallInput[]) => void | Promise<void> | ForeignCallOutput | ForeignCallOutput[] | Promise<ForeignCallOutput> | Promise<ForeignCallOutput[]>>;
+/**
+ * The result of executing an ACIR.
+ */
+export interface ACIRExecutionResult {
+    /**
+     * An execution result contains two witnesses.
+     * 1. The partial witness of the execution.
+     * 2. The return witness which contains the given public return values within the full witness.
+     */
+    partialWitness: ACVMWitness;
+    returnWitness: ACVMWitness;
+}
+/**
+ * The function call that executes an ACIR.
+ */
+export declare function acvm(acir: Buffer, initialWitness: ACVMWitness, callback: ACIRCallback): Promise<ACIRExecutionResult>;
+/**
+ * Extracts the call stack from an thrown by the acvm.
+ * @param error - The error to extract from.
+ * @param debug - The debug metadata of the function called.
+ * @returns The call stack, if available.
+ */
+export declare function extractCallStack(error: Error | ExecutionError, debug?: FunctionDebugMetadata): NoirCallStack | undefined;
+//# sourceMappingURL=acvm.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"acvm.d.ts","sourceRoot":"","sources":["../../../src/private/acvm/acvm.ts"],"names":[],"mappings":";;AACA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EAEvB,MAAM,oBAAoB,CAAC;AAG5B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAC/B,YAAY,EACZ,CACE,GAAG,IAAI,EAAE,gBAAgB,EAAE,KAEzB,IAAI,GACJ,OAAO,CAAC,IAAI,CAAC,GACb,iBAAiB,GACjB,iBAAiB,EAAE,GACnB,OAAO,CAAC,iBAAiB,CAAC,GAC1B,OAAO,CAAC,iBAAiB,EAAE,CAAC,CACjC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,cAAc,EAAE,WAAW,CAAC;IAC5B,aAAa,EAAE,WAAW,CAAC;CAC5B;AAED;;GAEG;AACH,wBAAsB,IAAI,CACxB,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,WAAW,EAC3B,QAAQ,EAAE,YAAY,GACrB,OAAO,CAAC,mBAAmB,CAAC,CAkD9B;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,KAAK,GAAG,cAAc,EAC7B,KAAK,CAAC,EAAE,qBAAqB,GAC5B,aAAa,GAAG,SAAS,CAc3B"}

package/dest/private/acvm/acvm.js

@@ -0,0 +1,70 @@
+import { createLogger } from '@aztec/foundation/log';
+import { executeCircuitWithReturnWitness } from '@noir-lang/acvm_js';
+import { resolveOpcodeLocations, traverseCauseChain } from '../../common/errors.js';
+/**
+ * The function call that executes an ACIR.
+ */ export async function acvm(acir, initialWitness, callback) {
+    const logger = createLogger('simulator:acvm');
+    const solvedAndReturnWitness = await executeCircuitWithReturnWitness(acir, initialWitness, async (name, args)=>{
+        try {
+            logger.debug(`Oracle callback ${name}`);
+            const oracleFunction = callback[name];
+            if (!oracleFunction) {
+                throw new Error(`Oracle callback ${name} not found`);
+            }
+            const result = await oracleFunction.call(callback, ...args);
+            if (typeof result === 'undefined') {
+                return [];
+            } else if (result instanceof Array && !result.every((item)=>typeof item === 'string')) {
+                // We are dealing with a nested array which means that we do not need it wrap it in another array as to have
+                // the nested array structure it is already "wrapped".
+                return result;
+            } else {
+                return [
+                    result
+                ];
+            }
+        } catch (err) {
+            let typedError;
+            if (err instanceof Error) {
+                typedError = err;
+            } else {
+                typedError = new Error(`Error in oracle callback ${err}`);
+            }
+            logger.error(`Error in oracle callback ${name}: ${typedError.message}`);
+            throw typedError;
+        }
+    }).catch((err)=>{
+        // Wasm callbacks act as a boundary for stack traces, so we capture it here and complete the error if it happens.
+        const stack = new Error().stack;
+        traverseCauseChain(err, (cause)=>{
+            if (cause.stack) {
+                cause.stack += stack;
+            }
+        });
+        throw err;
+    });
+    return {
+        partialWitness: solvedAndReturnWitness.solvedWitness,
+        returnWitness: solvedAndReturnWitness.returnWitness
+    };
+}
+/**
+ * Extracts the call stack from an thrown by the acvm.
+ * @param error - The error to extract from.
+ * @param debug - The debug metadata of the function called.
+ * @returns The call stack, if available.
+ */ export function extractCallStack(error, debug) {
+    if (!('callStack' in error) || !error.callStack) {
+        return undefined;
+    }
+    const { callStack, brilligFunctionId } = error;
+    if (!debug) {
+        return callStack;
+    }
+    try {
+        return resolveOpcodeLocations(callStack, debug, brilligFunctionId);
+    } catch (err) {
+        return callStack;
+    }
+}

package/dest/private/acvm/acvm_types.d.ts

@@ -0,0 +1,10 @@
+import type { WitnessMap } from '@noir-lang/acvm_js';
+/**
+ * ACVMField
+ */
+export type ACVMField = string;
+/**
+ * The format for witnesses of the ACVM.
+ */
+export type ACVMWitness = WitnessMap;
+//# sourceMappingURL=acvm_types.d.ts.map

package/dest/private/acvm/acvm_types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"acvm_types.d.ts","sourceRoot":"","sources":["../../../src/private/acvm/acvm_types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAE/B;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC"}

package/dest/private/acvm/acvm_types.js

@@ -0,0 +1,3 @@
+/**
+ * The format for witnesses of the ACVM.
+ */ export { };

package/dest/private/acvm/deserialize.d.ts

@@ -0,0 +1,36 @@
+import { Fr } from '@aztec/foundation/fields';
+import type { ACVMField, ACVMWitness } from './acvm_types.js';
+/**
+ * Converts an ACVM field to a Fr.
+ * @param field - The ACVM field to convert.
+ * @returns The Fr.
+ */
+export declare function fromACVMField(field: ACVMField): Fr;
+/**
+ * Converts a field to a number.
+ * @param fr - The field to convert.
+ * @returns The number.
+ * TODO(#4102): Nuke this once block number is big int.
+ */
+export declare function frToNumber(fr: Fr): number;
+/**
+ * Converts a field to a boolean.
+ * @param fr - The field to convert.
+ */
+export declare function frToBoolean(fr: Fr): boolean;
+/**
+ * Converts a Noir BoundedVec of Fields into an Fr array. Note that BoundedVecs are structs, and therefore translated as
+ * two separate ACVMField values (an array and a single field).
+ *
+ * @param storage The array with the BoundedVec's storage (i.e. BoundedVec::storage())
+ * @param length The length of the BoundedVec (i.e. BoundedVec::len())
+ * @returns An array with the same content as the Noir version. Elements past the length are discarded.
+ */
+export declare function fromBoundedVec(storage: ACVMField[], length: ACVMField): Fr[];
+/**
+ * Transforms a witness map to its field elements.
+ * @param witness - The witness to extract from.
+ * @returns The return values.
+ */
+export declare function witnessMapToFields(witness: ACVMWitness): Fr[];
+//# sourceMappingURL=deserialize.d.ts.map

package/dest/private/acvm/deserialize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deserialize.d.ts","sourceRoot":"","sources":["../../../src/private/acvm/deserialize.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAE9C,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9D;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,SAAS,GAAG,EAAE,CAElD;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,EAAE,EAAE,EAAE,GAAG,MAAM,CAEzC;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,EAAE,EAAE,EAAE,GAAG,OAAO,CAE3C;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,SAAS,GAAG,EAAE,EAAE,CAE5E;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,WAAW,GAAG,EAAE,EAAE,CAG7D"}