@noir-lang/acvm_js 0.45.0 → 0.46.0-23a6477.nightly

package/nodejs/acvm_js.d.ts

@@ -51,43 +51,45 @@ export function ecdsa_secp256k1_verify(hashed_msg: Uint8Array, public_key_x_byte
 */
 export function ecdsa_secp256r1_verify(hashed_msg: Uint8Array, public_key_x_bytes: Uint8Array, public_key_y_bytes: Uint8Array, signature: Uint8Array): boolean;
 /**
-* Returns the `BuildInfo` object containing information about how the installed package was built.
-* @returns {BuildInfo} - Information on how the installed package was built.
+* @returns {Promise<WasmBlackBoxFunctionSolver>}
 */
-export function buildInfo(): BuildInfo;
+export function createBlackBoxSolver(): Promise<WasmBlackBoxFunctionSolver>;
 /**
-* Extracts a `WitnessMap` containing the witness indices corresponding to the circuit's return values.
+* Executes an ACIR circuit to generate the solved witness from the initial witness.
 *
 * @param {Uint8Array} circuit - A serialized representation of an ACIR circuit
-* @param {WitnessMap} witness_map - The completed witness map after executing the circuit.
-* @returns {WitnessMap} A witness map containing the circuit's return values.
-* @param {Uint8Array} program
-* @param {WitnessMap} witness_map
-* @returns {WitnessMap}
+* @param {WitnessMap} initial_witness - The initial witness map defining all of the inputs to `circuit`..
+* @param {ForeignCallHandler} foreign_call_handler - A callback to process any foreign calls from the circuit.
+* @returns {WitnessMap} The solved witness calculated by executing the circuit on the provided inputs.
 */
-export function getReturnWitness(program: Uint8Array, witness_map: WitnessMap): WitnessMap;
+export function executeCircuit(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessMap>;
 /**
-* Extracts a `WitnessMap` containing the witness indices corresponding to the circuit's public parameters.
+* Executes an ACIR circuit to generate the solved witness from the initial witness.
+* This method also extracts the public return values from the solved witness into its own return witness.
 *
+* @param {&WasmBlackBoxFunctionSolver} solver - A black box solver.
 * @param {Uint8Array} circuit - A serialized representation of an ACIR circuit
-* @param {WitnessMap} witness_map - The completed witness map after executing the circuit.
-* @returns {WitnessMap} A witness map containing the circuit's public parameters.
-* @param {Uint8Array} program
-* @param {WitnessMap} solved_witness
-* @returns {WitnessMap}
+* @param {WitnessMap} initial_witness - The initial witness map defining all of the inputs to `circuit`..
+* @param {ForeignCallHandler} foreign_call_handler - A callback to process any foreign calls from the circuit.
+* @returns {SolvedAndReturnWitness} The solved witness calculated by executing the circuit on the provided inputs, as well as the return witness indices as specified by the circuit.
 */
-export function getPublicParametersWitness(program: Uint8Array, solved_witness: WitnessMap): WitnessMap;
+export function executeCircuitWithReturnWitness(_solver: WasmBlackBoxFunctionSolver, program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<SolvedAndReturnWitness>;
 /**
-* Extracts a `WitnessMap` containing the witness indices corresponding to the circuit's public inputs.
+* Executes an ACIR circuit to generate the solved witness from the initial witness.
 *
+* @param {&WasmBlackBoxFunctionSolver} solver - A black box solver.
 * @param {Uint8Array} circuit - A serialized representation of an ACIR circuit
-* @param {WitnessMap} witness_map - The completed witness map after executing the circuit.
-* @returns {WitnessMap} A witness map containing the circuit's public inputs.
-* @param {Uint8Array} program
-* @param {WitnessMap} solved_witness
-* @returns {WitnessMap}
+* @param {WitnessMap} initial_witness - The initial witness map defining all of the inputs to `circuit`..
+* @param {ForeignCallHandler} foreign_call_handler - A callback to process any foreign calls from the circuit.
+* @returns {WitnessMap} The solved witness calculated by executing the circuit on the provided inputs.
 */
-export function getPublicWitness(program: Uint8Array, solved_witness: WitnessMap): WitnessMap;
+export function executeCircuitWithBlackBoxSolver(_solver: WasmBlackBoxFunctionSolver, program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessMap>;
+/**
+*/
+export function executeProgram(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessStack>;
+/**
+*/
+export function executeProgramWithBlackBoxSolver(_solver: WasmBlackBoxFunctionSolver, program: Uint8Array, initial_witness: WitnessMap, foreign_call_executor: ForeignCallHandler): Promise<WitnessStack>;
 /**
 * Sets the package's logging level.
 *
@@ -95,6 +97,11 @@ export function getPublicWitness(program: Uint8Array, solved_witness: WitnessMap
 */
 export function initLogLevel(filter: string): void;
 /**
+* Returns the `BuildInfo` object containing information about how the installed package was built.
+* @returns {BuildInfo} - Information on how the installed package was built.
+*/
+export function buildInfo(): BuildInfo;
+/**
 * Compresses a `WitnessMap` into the binary format outputted by Nargo.
 *
 * @param {WitnessMap} witness_map - A witness map.
@@ -124,64 +131,61 @@ export function compressWitnessStack(witness_stack: WitnessStack): Uint8Array;
 */
 export function decompressWitnessStack(compressed_witness: Uint8Array): WitnessStack;
 /**
-* @returns {Promise<WasmBlackBoxFunctionSolver>}
-*/
-export function createBlackBoxSolver(): Promise<WasmBlackBoxFunctionSolver>;
-/**
-* Executes an ACIR circuit to generate the solved witness from the initial witness.
+* Extracts a `WitnessMap` containing the witness indices corresponding to the circuit's return values.
 *
 * @param {Uint8Array} circuit - A serialized representation of an ACIR circuit
-* @param {WitnessMap} initial_witness - The initial witness map defining all of the inputs to `circuit`..
-* @param {ForeignCallHandler} foreign_call_handler - A callback to process any foreign calls from the circuit.
-* @returns {WitnessMap} The solved witness calculated by executing the circuit on the provided inputs.
+* @param {WitnessMap} witness_map - The completed witness map after executing the circuit.
+* @returns {WitnessMap} A witness map containing the circuit's return values.
+* @param {Uint8Array} program
+* @param {WitnessMap} witness_map
+* @returns {WitnessMap}
 */
-export function executeCircuit(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessMap>;
+export function getReturnWitness(program: Uint8Array, witness_map: WitnessMap): WitnessMap;
 /**
-* Executes an ACIR circuit to generate the solved witness from the initial witness.
-* This method also extracts the public return values from the solved witness into its own return witness.
+* Extracts a `WitnessMap` containing the witness indices corresponding to the circuit's public parameters.
 *
-* @param {&WasmBlackBoxFunctionSolver} solver - A black box solver.
 * @param {Uint8Array} circuit - A serialized representation of an ACIR circuit
-* @param {WitnessMap} initial_witness - The initial witness map defining all of the inputs to `circuit`..
-* @param {ForeignCallHandler} foreign_call_handler - A callback to process any foreign calls from the circuit.
-* @returns {SolvedAndReturnWitness} The solved witness calculated by executing the circuit on the provided inputs, as well as the return witness indices as specified by the circuit.
+* @param {WitnessMap} witness_map - The completed witness map after executing the circuit.
+* @returns {WitnessMap} A witness map containing the circuit's public parameters.
+* @param {Uint8Array} program
+* @param {WitnessMap} solved_witness
+* @returns {WitnessMap}
 */
-export function executeCircuitWithReturnWitness(solver: WasmBlackBoxFunctionSolver, program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<SolvedAndReturnWitness>;
+export function getPublicParametersWitness(program: Uint8Array, solved_witness: WitnessMap): WitnessMap;
 /**
-* Executes an ACIR circuit to generate the solved witness from the initial witness.
+* Extracts a `WitnessMap` containing the witness indices corresponding to the circuit's public inputs.
 *
-* @param {&WasmBlackBoxFunctionSolver} solver - A black box solver.
 * @param {Uint8Array} circuit - A serialized representation of an ACIR circuit
-* @param {WitnessMap} initial_witness - The initial witness map defining all of the inputs to `circuit`..
-* @param {ForeignCallHandler} foreign_call_handler - A callback to process any foreign calls from the circuit.
-* @returns {WitnessMap} The solved witness calculated by executing the circuit on the provided inputs.
-*/
-export function executeCircuitWithBlackBoxSolver(solver: WasmBlackBoxFunctionSolver, program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessMap>;
-/**
-*/
-export function executeProgram(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessStack>;
-/**
+* @param {WitnessMap} witness_map - The completed witness map after executing the circuit.
+* @returns {WitnessMap} A witness map containing the circuit's public inputs.
+* @param {Uint8Array} program
+* @param {WitnessMap} solved_witness
+* @returns {WitnessMap}
 */
-export function executeProgramWithBlackBoxSolver(solver: WasmBlackBoxFunctionSolver, program: Uint8Array, initial_witness: WitnessMap, foreign_call_executor: ForeignCallHandler): Promise<WitnessStack>;
+export function getPublicWitness(program: Uint8Array, solved_witness: WitnessMap): WitnessMap;
 
+export type RawAssertionPayload = {
+    selector: string;
+    data: string[];
+};
 export type ExecutionError = Error & {
     callStack?: string[];
+    rawAssertionPayload?: RawAssertionPayload;
 };
 
 
 
-// Map from witness index to hex string value of witness.
-export type WitnessMap = Map<number, string>;
+export type ForeignCallInput = string[]
+export type ForeignCallOutput = string | string[]
 
 /**
- * An execution result containing two witnesses.
- * 1. The full solved witness of the execution.
- * 2. The return witness which contains the given public return values within the full witness.
- */
-export type SolvedAndReturnWitness = {
-    solvedWitness: WitnessMap;
-    returnWitness: WitnessMap;
-}
+* A callback which performs an foreign call and returns the response.
+* @callback ForeignCallHandler
+* @param {string} name - The identifier for the type of foreign call being performed.
+* @param {string[][]} inputs - An array of hex encoded inputs to the foreign call.
+* @returns {Promise<string[]>} outputs - An array of hex encoded outputs containing the results of the foreign call.
+*/
+export type ForeignCallHandler = (name: string, inputs: ForeignCallInput[]) => Promise<ForeignCallOutput[]>;
 
 
 
@@ -199,17 +203,18 @@ export type BuildInfo = {
 
 
 
-export type ForeignCallInput = string[]
-export type ForeignCallOutput = string | string[]
+// Map from witness index to hex string value of witness.
+export type WitnessMap = Map<number, string>;
 
 /**
-* A callback which performs an foreign call and returns the response.
-* @callback ForeignCallHandler
-* @param {string} name - The identifier for the type of foreign call being performed.
-* @param {string[][]} inputs - An array of hex encoded inputs to the foreign call.
-* @returns {Promise<string[]>} outputs - An array of hex encoded outputs containing the results of the foreign call.
-*/
-export type ForeignCallHandler = (name: string, inputs: ForeignCallInput[]) => Promise<ForeignCallOutput[]>;
+ * An execution result containing two witnesses.
+ * 1. The full solved witness of the execution.
+ * 2. The return witness which contains the given public return values within the full witness.
+ */
+export type SolvedAndReturnWitness = {
+    solvedWitness: WitnessMap;
+    returnWitness: WitnessMap;
+}