@noir-lang/acvm_js 0.30.0 → 0.31.0-ff96ba4.nightly

package/nodejs/acvm_js.d.ts

@@ -1,19 +1,67 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
-* Decompresses a compressed witness as outputted by Nargo into a `WitnessMap`.
+* Extracts a `WitnessMap` containing the witness indices corresponding to the circuit's public inputs.
 *
-* @param {Uint8Array} compressed_witness - A compressed witness.
-* @returns {WitnessMap} The decompressed witness map.
+* @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} circuit
+* @param {WitnessMap} solved_witness
+* @returns {WitnessMap}
 */
-export function decompressWitness(compressed_witness: Uint8Array): WitnessMap;
+export function getPublicWitness(circuit: Uint8Array, solved_witness: WitnessMap): WitnessMap;
 /**
-* Compresses a `WitnessMap` into the binary format outputted by Nargo.
+* Extracts a `WitnessMap` containing the witness indices corresponding to the circuit's public parameters.
 *
-* @param {Uint8Array} compressed_witness - A witness map.
-* @returns {WitnessMap} A compressed witness map
+* @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} circuit
+* @param {WitnessMap} solved_witness
+* @returns {WitnessMap}
 */
-export function compressWitness(witness_map: WitnessMap): Uint8Array;
+export function getPublicParametersWitness(circuit: Uint8Array, solved_witness: WitnessMap): WitnessMap;
+/**
+* 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} circuit
+* @param {WitnessMap} witness_map
+* @returns {WitnessMap}
+*/
+export function getReturnWitness(circuit: Uint8Array, witness_map: WitnessMap): WitnessMap;
+/**
+* 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 executeCircuitWithBlackBoxSolver(solver: WasmBlackBoxFunctionSolver, circuit: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessMap>;
+/**
+* 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(circuit: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessMap>;
+/**
+* @returns {Promise<WasmBlackBoxFunctionSolver>}
+*/
+export function createBlackBoxSolver(): Promise<WasmBlackBoxFunctionSolver>;
+/**
+* Sets the package's logging level.
+*
+* @param {LogLevel} level - The maximum level of logging to be emitted.
+*/
+export function initLogLevel(level: LogLevel): void;
 /**
 * Verifies a ECDSA signature over the secp256r1 curve.
 * @param {Uint8Array} hashed_msg
@@ -66,72 +114,24 @@ export function xor(lhs: string, rhs: string): string;
 */
 export function and(lhs: string, rhs: string): string;
 /**
-* 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;
-/**
-* 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 executeCircuitWithBlackBoxSolver(solver: WasmBlackBoxFunctionSolver, circuit: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessMap>;
-/**
-* 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(circuit: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessMap>;
-/**
-* @returns {Promise<WasmBlackBoxFunctionSolver>}
-*/
-export function createBlackBoxSolver(): Promise<WasmBlackBoxFunctionSolver>;
-/**
-* Sets the package's logging level.
-*
-* @param {LogLevel} level - The maximum level of logging to be emitted.
-*/
-export function initLogLevel(level: LogLevel): void;
-/**
-* Extracts a `WitnessMap` containing the witness indices corresponding to the circuit's public inputs.
+* Decompresses a compressed witness as outputted by Nargo into a `WitnessMap`.
 *
-* @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} circuit
-* @param {WitnessMap} solved_witness
-* @returns {WitnessMap}
+* @param {Uint8Array} compressed_witness - A compressed witness.
+* @returns {WitnessMap} The decompressed witness map.
 */
-export function getPublicWitness(circuit: 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 parameters.
+* 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 public parameters.
-* @param {Uint8Array} circuit
-* @param {WitnessMap} solved_witness
-* @returns {WitnessMap}
+* @param {Uint8Array} compressed_witness - A witness map.
+* @returns {WitnessMap} A compressed witness map
 */
-export function getPublicParametersWitness(circuit: Uint8Array, solved_witness: WitnessMap): WitnessMap;
+export function compressWitness(witness_map: WitnessMap): Uint8Array;
 /**
-* 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} circuit
-* @param {WitnessMap} witness_map
-* @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 getReturnWitness(circuit: Uint8Array, witness_map: WitnessMap): WitnessMap;
+export function buildInfo(): BuildInfo;
 
 export type ForeignCallInput = string[]
 export type ForeignCallOutput = string | string[]
@@ -147,21 +147,12 @@ export type ForeignCallHandler = (name: string, inputs: ForeignCallInput[]) => P
 
 
 
-/**
-* @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 BuildInfo = {
-  gitHash: string;
-  version: string;
-  dirty: string;
-}
+export type LogLevel = "OFF" | "ERROR" | "WARN" | "INFO" | "DEBUG" | "TRACE";
 
 
 
-export type LogLevel = "OFF" | "ERROR" | "WARN" | "INFO" | "DEBUG" | "TRACE";
+// Map from witness index to hex string value of witness.
+export type WitnessMap = Map<number, string>;
 
 
 
@@ -171,8 +162,17 @@ export type ExecutionError = Error & {
 
 
 
-// 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.
+ */
+export type BuildInfo = {
+  gitHash: string;
+  version: string;
+  dirty: string;
+}
 
 
 /**