@noir-lang/acvm_js 0.46.0-7936262.nightly → 0.46.0

package/nodejs/acvm_js.d.ts

@@ -1,67 +1,16 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
-* 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 compressWitness(witness_map: WitnessMap): 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 decompressWitness(compressed_witness: Uint8Array): WitnessMap;
-/**
-* 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 compressWitnessStack(witness_stack: WitnessStack): 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 decompressWitnessStack(compressed_witness: Uint8Array): 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 return values.
-* @param {Uint8Array} program
-* @param {WitnessMap} witness_map
-* @returns {WitnessMap}
-*/
-export function getReturnWitness(program: Uint8Array, witness_map: WitnessMap): WitnessMap;
-/**
-* Extracts a `WitnessMap` containing the witness indices corresponding to the circuit's public parameters.
+* Sets the package's logging level.
 *
-* @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 {LogLevel} level - The maximum level of logging to be emitted.
 */
-export function getPublicParametersWitness(program: Uint8Array, solved_witness: WitnessMap): WitnessMap;
+export function initLogLevel(filter: string): void;
 /**
-* 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}
+* 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 getPublicWitness(program: Uint8Array, solved_witness: WitnessMap): WitnessMap;
+export function buildInfo(): BuildInfo;
 /**
 * Performs a bitwise AND operation between `lhs` and `rhs`
 * @param {string} lhs
@@ -113,6 +62,35 @@ 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;
 /**
+* 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 compressWitness(witness_map: WitnessMap): 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 decompressWitness(compressed_witness: Uint8Array): WitnessMap;
+/**
+* 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 compressWitnessStack(witness_stack: WitnessStack): 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 decompressWitnessStack(compressed_witness: Uint8Array): WitnessStack;
+/**
 * @returns {Promise<WasmBlackBoxFunctionSolver>}
 */
 export function createBlackBoxSolver(): Promise<WasmBlackBoxFunctionSolver>;
@@ -153,16 +131,38 @@ export function executeProgram(program: Uint8Array, initial_witness: WitnessMap,
 */
 export function executeProgramWithBlackBoxSolver(solver: WasmBlackBoxFunctionSolver, program: Uint8Array, initial_witness: WitnessMap, foreign_call_executor: ForeignCallHandler): Promise<WitnessStack>;
 /**
-* Sets the package's logging level.
+* Extracts a `WitnessMap` containing the witness indices corresponding to the circuit's return values.
 *
-* @param {LogLevel} level - The maximum level of logging to be emitted.
+* @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 initLogLevel(filter: string): void;
+export function getReturnWitness(program: Uint8Array, witness_map: WitnessMap): WitnessMap;
 /**
-* Returns the `BuildInfo` object containing information about how the installed package was built.
-* @returns {BuildInfo} - Information on how the installed package was built.
+* Extracts a `WitnessMap` containing the witness indices corresponding to the circuit's public parameters.
+*
+* @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 buildInfo(): BuildInfo;
+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;
 
 // Map from witness index to hex string value of witness.
 export type WitnessMap = Map<number, string>;
@@ -179,17 +179,6 @@ export type SolvedAndReturnWitness = {
 
 
 
-export type RawAssertionPayload = {
-    selector: string;
-    data: string[];
-};
-export type ExecutionError = Error & {
-    callStack?: string[];
-    rawAssertionPayload?: RawAssertionPayload;
-};
-
-
-
 /**
 * @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. 
@@ -218,6 +207,17 @@ export type ForeignCallHandler = (name: string, inputs: ForeignCallInput[]) => P
 
 
 
+export type RawAssertionPayload = {
+    selector: string;
+    data: string[];
+};
+export type ExecutionError = Error & {
+    callStack?: string[];
+    rawAssertionPayload?: RawAssertionPayload;
+};
+
+
+
 export type StackItem = {
     index: number;
     witness: WitnessMap;