@noir-lang/acvm_js 0.54.0 → 0.55.0

package/nodejs/acvm_js.d.ts

@@ -1,44 +1,62 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
-* Sets the package's logging level.
+* Compresses a `WitnessMap` into the binary format outputted by Nargo.
 *
-* @param {LogLevel} level - The maximum level of logging to be emitted.
+* @param {WitnessMap} witness_map - A witness map.
+* @returns {Uint8Array} A compressed witness map
 */
-export function initLogLevel(filter: string): void;
+export function compressWitness(witness_map: WitnessMap): Uint8Array;
 /**
-* Extracts a `WitnessMap` containing the witness indices corresponding to the circuit's return values.
+* 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 return values.
-* @param {Uint8Array} program
-* @param {WitnessMap} witness_map
-* @returns {WitnessMap}
+* @param {Uint8Array} compressed_witness - A compressed witness.
+* @returns {WitnessMap} The decompressed witness map.
 */
-export function getReturnWitness(program: Uint8Array, witness_map: 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 `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;
+/**
+* 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 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 {WitnessMap} The solved witness calculated by executing the circuit on the provided inputs.
 */
-export function getPublicParametersWitness(program: Uint8Array, solved_witness: 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 inputs.
+* 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 {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 {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 getPublicWitness(program: Uint8Array, solved_witness: WitnessMap): WitnessMap;
+export function executeCircuitWithReturnWitness(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 {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 executeProgram(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessStack>;
 /**
 * Performs a bitwise AND operation between `lhs` and `rhs`
 * @param {string} lhs
@@ -90,73 +108,56 @@ export function ecdsa_secp256r1_verify(hashed_msg: Uint8Array, public_key_x_byte
 */
 export function buildInfo(): BuildInfo;
 /**
-* Executes an ACIR circuit to generate the solved witness from the initial 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 {WitnessMap} The solved witness calculated by executing the circuit on the provided inputs.
+* @param {LogLevel} level - The maximum level of logging to be emitted.
 */
-export function executeCircuit(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessMap>;
+export function initLogLevel(filter: string): void;
 /**
-* 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 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 {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 executeCircuitWithReturnWitness(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 {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 executeProgram(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessStack>;
-/**
-* 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.
+* @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 decompressWitness(compressed_witness: Uint8Array): WitnessMap;
+export function getReturnWitness(program: Uint8Array, witness_map: WitnessMap): WitnessMap;
 /**
-* Compresses a `WitnessStack` into the binary format outputted by Nargo.
+* Extracts a `WitnessMap` containing the witness indices corresponding to the circuit's public parameters.
 *
-* @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 public parameters.
+* @param {Uint8Array} program
+* @param {WitnessMap} solved_witness
+* @returns {WitnessMap}
 */
-export function compressWitnessStack(witness_stack: WitnessStack): Uint8Array;
+export function getPublicParametersWitness(program: Uint8Array, solved_witness: 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 inputs.
 *
-* @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 inputs.
+* @param {Uint8Array} program
+* @param {WitnessMap} solved_witness
+* @returns {WitnessMap}
 */
-export function decompressWitnessStack(compressed_witness: Uint8Array): WitnessStack;
+export function getPublicWitness(program: Uint8Array, solved_witness: WitnessMap): WitnessMap;
 
-export type RawAssertionPayload = {
-    selector: string;
-    data: string[];
-};
+export type ForeignCallInput = string[]
+export type ForeignCallOutput = string | string[]
 
-export type ExecutionError = Error & {
-    callStack?: string[];
-    rawAssertionPayload?: RawAssertionPayload;
-    brilligFunctionId?: number;
-};
+/**
+* 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[]>;
 
 
 
@@ -183,17 +184,16 @@ export type BuildInfo = {
 
 
 
-export type ForeignCallInput = string[]
-export type ForeignCallOutput = string | string[]
+export type RawAssertionPayload = {
+    selector: string;
+    data: 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[]>;
+export type ExecutionError = Error & {
+    callStack?: string[];
+    rawAssertionPayload?: RawAssertionPayload;
+    brilligFunctionId?: number;
+};