@noir-lang/acvm_js 0.47.0-e100017.nightly → 0.47.0-ec728dd.nightly

package/nodejs/acvm_js.d.ts

@@ -1,72 +1,45 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
-* 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 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.
+* Sets the package's logging level.
 *
-* @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 {LogLevel} level - The maximum level of logging to be emitted.
 */
-export function executeCircuitWithReturnWitness(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<SolvedAndReturnWitness>;
+export function initLogLevel(filter: string): void;
 /**
-* Executes an ACIR circuit to generate the solved witness from the initial witness.
-*
-* @param {Uint8Array} program - A serialized representation of an ACIR program
-* @param {WitnessMap} initial_witness - The initial witness map defining all of the inputs to `program`.
-* @param {ForeignCallHandler} foreign_call_handler - A callback to process any foreign calls from the program.
-* @returns {WitnessStack} The solved witness calculated by executing the program on the provided inputs.
+* 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 executeProgram(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessStack>;
+export function buildInfo(): BuildInfo;
 /**
-* Extracts a `WitnessMap` containing the witness indices corresponding to the circuit's return values.
+* Compresses a `WitnessMap` into the binary format outputted by Nargo.
 *
-* @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} witness_map - A witness map.
+* @returns {Uint8Array} A compressed witness map
 */
-export function getReturnWitness(program: Uint8Array, witness_map: WitnessMap): WitnessMap;
+export function compressWitness(witness_map: WitnessMap): Uint8Array;
 /**
-* Extracts a `WitnessMap` containing the witness indices corresponding to the circuit's public parameters.
+* 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} 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 {Uint8Array} compressed_witness - A compressed witness.
+* @returns {WitnessMap} The decompressed witness map.
 */
-export function getPublicParametersWitness(program: Uint8Array, solved_witness: WitnessMap): WitnessMap;
+export function decompressWitness(compressed_witness: Uint8Array): WitnessMap;
 /**
-* Extracts a `WitnessMap` containing the witness indices corresponding to the circuit's public inputs.
+* Compresses a `WitnessStack` into the binary format outputted by Nargo.
 *
-* @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 {WitnessStack} witness_stack - A witness stack.
+* @returns {Uint8Array} A compressed witness stack
 */
-export function getPublicWitness(program: Uint8Array, solved_witness: WitnessMap): WitnessMap;
+export function compressWitnessStack(witness_stack: WitnessStack): Uint8Array;
 /**
-* Sets the package's logging level.
+* Decompresses a compressed witness stack as outputted by Nargo into a `WitnessStack`.
 *
-* @param {LogLevel} level - The maximum level of logging to be emitted.
+* @param {Uint8Array} compressed_witness - A compressed witness.
+* @returns {WitnessStack} The decompressed witness stack.
 */
-export function initLogLevel(filter: string): void;
+export function decompressWitnessStack(compressed_witness: Uint8Array): WitnessStack;
 /**
 * Performs a bitwise AND operation between `lhs` and `rhs`
 * @param {string} lhs
@@ -118,62 +91,77 @@ 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.
+* 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 buildInfo(): BuildInfo;
+export function executeCircuit(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessMap>;
 /**
-* Compresses a `WitnessMap` into the binary format outputted by Nargo.
+* 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 {WitnessMap} witness_map - A witness map.
-* @returns {Uint8Array} A compressed witness map
+* @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.
 */
-export function compressWitness(witness_map: WitnessMap): Uint8Array;
+export function executeCircuitWithReturnWitness(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<SolvedAndReturnWitness>;
 /**
-* 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.
+* Executes an ACIR circuit to generate the solved witness from the initial witness.
 *
-* @param {Uint8Array} compressed_witness - A compressed witness.
-* @returns {WitnessMap} The decompressed witness map.
+* @param {Uint8Array} program - A serialized representation of an ACIR program
+* @param {WitnessMap} initial_witness - The initial witness map defining all of the inputs to `program`.
+* @param {ForeignCallHandler} foreign_call_handler - A callback to process any foreign calls from the program.
+* @returns {WitnessStack} The solved witness calculated by executing the program on the provided inputs.
 */
-export function decompressWitness(compressed_witness: Uint8Array): WitnessMap;
+export function executeProgram(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessStack>;
 /**
-* Compresses a `WitnessStack` into the binary format outputted by Nargo.
+* Extracts a `WitnessMap` containing the witness indices corresponding to the circuit's return values.
 *
-* @param {WitnessStack} witness_stack - A witness stack.
-* @returns {Uint8Array} A compressed witness stack
+* @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}
 */
-export function compressWitnessStack(witness_stack: WitnessStack): Uint8Array;
+export function getReturnWitness(program: Uint8Array, witness_map: WitnessMap): WitnessMap;
 /**
-* Decompresses a compressed witness stack as outputted by Nargo into a `WitnessStack`.
+* Extracts a `WitnessMap` containing the witness indices corresponding to the circuit's public parameters.
 *
-* @param {Uint8Array} compressed_witness - A compressed witness.
-* @returns {WitnessStack} The decompressed witness stack.
+* @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}
 */
-export function decompressWitnessStack(compressed_witness: Uint8Array): WitnessStack;
-
-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 function getPublicParametersWitness(program: Uint8Array, solved_witness: WitnessMap): WitnessMap;
+/**
+* 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 public inputs.
+* @param {Uint8Array} program
+* @param {WitnessMap} solved_witness
+* @returns {WitnessMap}
+*/
+export function getPublicWitness(program: Uint8Array, solved_witness: WitnessMap): WitnessMap;
 
 /**
- * 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.
+* @typedef {Object} BuildInfo - Information about how the installed package was built
+* @property {string} gitHash - The hash of the git commit from which the package was built. 
+* @property {string} version - The version of the package at the built git commit.
+* @property {boolean} dirty - Whether the package contained uncommitted changes when built.
  */
-export type SolvedAndReturnWitness = {
-    solvedWitness: WitnessMap;
-    returnWitness: WitnessMap;
+export type BuildInfo = {
+  gitHash: string;
+  version: string;
+  dirty: string;
 }
 
 
@@ -201,16 +189,28 @@ export type ForeignCallHandler = (name: string, inputs: ForeignCallInput[]) => P
 
 
 
+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>;
+
 /**
-* @typedef {Object} BuildInfo - Information about how the installed package was built
-* @property {string} gitHash - The hash of the git commit from which the package was built. 
-* @property {string} version - The version of the package at the built git commit.
-* @property {boolean} dirty - Whether the package contained uncommitted changes when built.
+ * 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 BuildInfo = {
-  gitHash: string;
-  version: string;
-  dirty: string;
+export type SolvedAndReturnWitness = {
+    solvedWitness: WitnessMap;
+    returnWitness: WitnessMap;
 }