@noir-lang/acvm_js 0.42.0 → 0.43.0-0adeb08.nightly

package/nodejs/acvm_js.d.ts

@@ -1,89 +1,85 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
-* Verifies a ECDSA signature over the secp256r1 curve.
-* @param {Uint8Array} hashed_msg
-* @param {Uint8Array} public_key_x_bytes
-* @param {Uint8Array} public_key_y_bytes
-* @param {Uint8Array} signature
-* @returns {boolean}
-*/
-export function ecdsa_secp256r1_verify(hashed_msg: Uint8Array, public_key_x_bytes: Uint8Array, public_key_y_bytes: Uint8Array, signature: Uint8Array): boolean;
-/**
-* Verifies a ECDSA signature over the secp256k1 curve.
-* @param {Uint8Array} hashed_msg
-* @param {Uint8Array} public_key_x_bytes
-* @param {Uint8Array} public_key_y_bytes
-* @param {Uint8Array} signature
-* @returns {boolean}
+* Compresses a `WitnessMap` into the binary format outputted by Nargo.
+*
+* @param {WitnessMap} witness_map - A witness map.
+* @returns {Uint8Array} A compressed witness map
 */
-export function ecdsa_secp256k1_verify(hashed_msg: Uint8Array, public_key_x_bytes: Uint8Array, public_key_y_bytes: Uint8Array, signature: Uint8Array): boolean;
+export function compressWitness(witness_map: WitnessMap): Uint8Array;
 /**
-* Calculates the Keccak256 hash of the input bytes
-* @param {Uint8Array} inputs
-* @returns {Uint8Array}
+* Decompresses a compressed witness as outputted by Nargo into a `WitnessMap`.
+* This should be used to only fetch the witness map for the main function.
+*
+* @param {Uint8Array} compressed_witness - A compressed witness.
+* @returns {WitnessMap} The decompressed witness map.
 */
-export function keccak256(inputs: Uint8Array): Uint8Array;
+export function decompressWitness(compressed_witness: Uint8Array): WitnessMap;
 /**
-* Calculates the Blake2s256 hash of the input bytes
-* @param {Uint8Array} inputs
-* @returns {Uint8Array}
+* Compresses a `WitnessStack` into the binary format outputted by Nargo.
+*
+* @param {WitnessStack} witness_stack - A witness stack.
+* @returns {Uint8Array} A compressed witness stack
 */
-export function blake2s256(inputs: Uint8Array): Uint8Array;
+export function compressWitnessStack(witness_stack: WitnessStack): Uint8Array;
 /**
-* Calculates the SHA256 hash of the input bytes
-* @param {Uint8Array} inputs
-* @returns {Uint8Array}
+* Decompresses a compressed witness stack as outputted by Nargo into a `WitnessStack`.
+*
+* @param {Uint8Array} compressed_witness - A compressed witness.
+* @returns {WitnessStack} The decompressed witness stack.
 */
-export function sha256(inputs: Uint8Array): Uint8Array;
+export function decompressWitnessStack(compressed_witness: Uint8Array): WitnessStack;
 /**
-* Performs a bitwise XOR operation between `lhs` and `rhs`
-* @param {string} lhs
-* @param {string} rhs
-* @returns {string}
+* @returns {Promise<WasmBlackBoxFunctionSolver>}
 */
-export function xor(lhs: string, rhs: string): string;
+export function createBlackBoxSolver(): Promise<WasmBlackBoxFunctionSolver>;
 /**
-* Performs a bitwise AND operation between `lhs` and `rhs`
-* @param {string} lhs
-* @param {string} rhs
-* @returns {string}
+* 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} 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 and(lhs: string, rhs: string): string;
+export function executeCircuit(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<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.
 *
 * @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.
+* @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 executeCircuitWithBlackBoxSolver(solver: WasmBlackBoxFunctionSolver, program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessMap>;
+export function executeCircuitWithReturnWitness(solver: WasmBlackBoxFunctionSolver, program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<SolvedAndReturnWitness>;
 /**
 * 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} 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 executeCircuit(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessMap>;
+export function executeCircuitWithBlackBoxSolver(solver: WasmBlackBoxFunctionSolver, program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessMap>;
 /**
-* @returns {Promise<WasmBlackBoxFunctionSolver>}
 */
-export function createBlackBoxSolver(): Promise<WasmBlackBoxFunctionSolver>;
+export function executeProgram(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessStack>;
 /**
-* Extracts a `WitnessMap` containing the witness indices corresponding to the circuit's public inputs.
+*/
+export function executeProgramWithBlackBoxSolver(solver: WasmBlackBoxFunctionSolver, program: Uint8Array, initial_witness: WitnessMap, foreign_call_executor: ForeignCallHandler): Promise<WitnessStack>;
+/**
+* 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} witness_map - The completed witness map after executing the circuit.
-* @returns {WitnessMap} A witness map containing the circuit's public inputs.
+* @returns {WitnessMap} A witness map containing the circuit's return values.
 * @param {Uint8Array} program
-* @param {WitnessMap} solved_witness
+* @param {WitnessMap} witness_map
 * @returns {WitnessMap}
 */
-export function getPublicWitness(program: Uint8Array, solved_witness: WitnessMap): WitnessMap;
+export function getReturnWitness(program: Uint8Array, witness_map: WitnessMap): WitnessMap;
 /**
 * Extracts a `WitnessMap` containing the witness indices corresponding to the circuit's public parameters.
 *
@@ -96,50 +92,99 @@ export function getPublicWitness(program: Uint8Array, solved_witness: WitnessMap
 */
 export function getPublicParametersWitness(program: Uint8Array, solved_witness: WitnessMap): WitnessMap;
 /**
-* Extracts a `WitnessMap` containing the witness indices corresponding to the circuit's return values.
+* Extracts a `WitnessMap` containing the witness indices corresponding to the circuit's public inputs.
 *
 * @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.
+* @returns {WitnessMap} A witness map containing the circuit's public inputs.
 * @param {Uint8Array} program
-* @param {WitnessMap} witness_map
+* @param {WitnessMap} solved_witness
 * @returns {WitnessMap}
 */
-export function getReturnWitness(program: Uint8Array, witness_map: WitnessMap): WitnessMap;
+export function getPublicWitness(program: Uint8Array, solved_witness: WitnessMap): WitnessMap;
 /**
-* Sets the package's logging level.
-*
-* @param {LogLevel} level - The maximum level of logging to be emitted.
+* Performs a bitwise AND operation between `lhs` and `rhs`
+* @param {string} lhs
+* @param {string} rhs
+* @returns {string}
 */
-export function initLogLevel(filter: string): void;
+export function and(lhs: string, rhs: string): string;
 /**
-* Decompresses a compressed witness as outputted by Nargo into a `WitnessMap`.
-*
-* @param {Uint8Array} compressed_witness - A compressed witness.
-* @returns {WitnessMap} The decompressed witness map.
+* Performs a bitwise XOR operation between `lhs` and `rhs`
+* @param {string} lhs
+* @param {string} rhs
+* @returns {string}
 */
-export function decompressWitness(compressed_witness: Uint8Array): WitnessMap;
+export function xor(lhs: string, rhs: string): string;
 /**
-* Compresses a `WitnessMap` into the binary format outputted by Nargo.
-*
-* @param {Uint8Array} compressed_witness - A witness map.
-* @returns {WitnessMap} A compressed witness map
+* Calculates the SHA256 hash of the input bytes
+* @param {Uint8Array} inputs
+* @returns {Uint8Array}
 */
-export function compressWitness(witness_map: WitnessMap): Uint8Array;
+export function sha256(inputs: Uint8Array): Uint8Array;
+/**
+* Calculates the Blake2s256 hash of the input bytes
+* @param {Uint8Array} inputs
+* @returns {Uint8Array}
+*/
+export function blake2s256(inputs: Uint8Array): Uint8Array;
+/**
+* Calculates the Keccak256 hash of the input bytes
+* @param {Uint8Array} inputs
+* @returns {Uint8Array}
+*/
+export function keccak256(inputs: Uint8Array): Uint8Array;
+/**
+* Verifies a ECDSA signature over the secp256k1 curve.
+* @param {Uint8Array} hashed_msg
+* @param {Uint8Array} public_key_x_bytes
+* @param {Uint8Array} public_key_y_bytes
+* @param {Uint8Array} signature
+* @returns {boolean}
+*/
+export function ecdsa_secp256k1_verify(hashed_msg: Uint8Array, public_key_x_bytes: Uint8Array, public_key_y_bytes: Uint8Array, signature: Uint8Array): boolean;
+/**
+* Verifies a ECDSA signature over the secp256r1 curve.
+* @param {Uint8Array} hashed_msg
+* @param {Uint8Array} public_key_x_bytes
+* @param {Uint8Array} public_key_y_bytes
+* @param {Uint8Array} signature
+* @returns {boolean}
+*/
+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.
 */
 export function buildInfo(): BuildInfo;
+/**
+* Sets the package's logging level.
+*
+* @param {LogLevel} level - The maximum level of logging to be emitted.
+*/
+export function initLogLevel(filter: string): void;
 
-export type ExecutionError = Error & {
-    callStack?: string[];
-};
+// Map from witness index to hex string value of witness.
+export type WitnessMap = Map<number, 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;
+}
 
 
-// Map from witness index to hex string value of witness.
-export type WitnessMap = Map<number, string>;
+
+export type StackItem = {
+    index: number;
+    witness: WitnessMap;
+}
+
+export type WitnessStack = Array<StackItem>;
 
 
 
@@ -170,6 +215,12 @@ export type BuildInfo = {
 }
 
 
+
+export type ExecutionError = Error & {
+    callStack?: string[];
+};
+
+
 /**
 */
 export class WasmBlackBoxFunctionSolver {