@noir-lang/acvm_js 0.41.0 → 0.42.0-c46b164.nightly

package/nodejs/acvm_js.d.ts

@@ -1,6 +1,56 @@
 /* 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}
+*/
+export function ecdsa_secp256k1_verify(hashed_msg: Uint8Array, public_key_x_bytes: Uint8Array, public_key_y_bytes: Uint8Array, signature: Uint8Array): boolean;
+/**
+* Calculates the Keccak256 hash of the input bytes
+* @param {Uint8Array} inputs
+* @returns {Uint8Array}
+*/
+export function keccak256(inputs: Uint8Array): Uint8Array;
+/**
+* Calculates the Blake2s256 hash of the input bytes
+* @param {Uint8Array} inputs
+* @returns {Uint8Array}
+*/
+export function blake2s256(inputs: Uint8Array): Uint8Array;
+/**
+* Calculates the SHA256 hash of the input bytes
+* @param {Uint8Array} inputs
+* @returns {Uint8Array}
+*/
+export function sha256(inputs: Uint8Array): Uint8Array;
+/**
+* Performs a bitwise XOR operation between `lhs` and `rhs`
+* @param {string} lhs
+* @param {string} rhs
+* @returns {string}
+*/
+export function xor(lhs: string, rhs: string): string;
+/**
+* Performs a bitwise AND operation between `lhs` and `rhs`
+* @param {string} lhs
+* @param {string} rhs
+* @returns {string}
+*/
+export function and(lhs: string, rhs: string): string;
+/**
 * Executes an ACIR circuit to generate the solved witness from the initial witness.
 *
 * @param {&WasmBlackBoxFunctionSolver} solver - A black box solver.
@@ -9,7 +59,7 @@
 * @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>;
+export function executeCircuitWithBlackBoxSolver(solver: WasmBlackBoxFunctionSolver, program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessMap>;
 /**
 * Executes an ACIR circuit to generate the solved witness from the initial witness.
 *
@@ -18,7 +68,7 @@ export function executeCircuitWithBlackBoxSolver(solver: WasmBlackBoxFunctionSol
 * @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>;
+export function executeCircuit(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessMap>;
 /**
 * @returns {Promise<WasmBlackBoxFunctionSolver>}
 */
@@ -29,33 +79,39 @@ export function createBlackBoxSolver(): Promise<WasmBlackBoxFunctionSolver>;
 * @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 {Uint8Array} program
 * @param {WitnessMap} solved_witness
 * @returns {WitnessMap}
 */
-export function getPublicWitness(circuit: Uint8Array, solved_witness: WitnessMap): WitnessMap;
+export function getPublicWitness(program: Uint8Array, solved_witness: WitnessMap): WitnessMap;
 /**
 * 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} circuit
+* @param {Uint8Array} program
 * @param {WitnessMap} solved_witness
 * @returns {WitnessMap}
 */
-export function getPublicParametersWitness(circuit: Uint8Array, solved_witness: WitnessMap): WitnessMap;
+export function getPublicParametersWitness(program: 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 {Uint8Array} program
 * @param {WitnessMap} witness_map
 * @returns {WitnessMap}
 */
-export function getReturnWitness(circuit: Uint8Array, witness_map: WitnessMap): WitnessMap;
+export function getReturnWitness(program: Uint8Array, witness_map: WitnessMap): WitnessMap;
+/**
+* Sets the package's logging level.
+*
+* @param {LogLevel} level - The maximum level of logging to be emitted.
+*/
+export function initLogLevel(filter: string): void;
 /**
 * Decompresses a compressed witness as outputted by Nargo into a `WitnessMap`.
 *
@@ -71,67 +127,22 @@ export function decompressWitness(compressed_witness: Uint8Array): WitnessMap;
 */
 export function compressWitness(witness_map: WitnessMap): Uint8Array;
 /**
-* 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}
-*/
-export function ecdsa_secp256k1_verify(hashed_msg: Uint8Array, public_key_x_bytes: Uint8Array, public_key_y_bytes: Uint8Array, signature: Uint8Array): boolean;
-/**
-* Calculates the Keccak256 hash of the input bytes
-* @param {Uint8Array} inputs
-* @returns {Uint8Array}
-*/
-export function keccak256(inputs: Uint8Array): Uint8Array;
-/**
-* Calculates the Blake2s256 hash of the input bytes
-* @param {Uint8Array} inputs
-* @returns {Uint8Array}
-*/
-export function blake2s256(inputs: Uint8Array): Uint8Array;
-/**
-* Calculates the SHA256 hash of the input bytes
-* @param {Uint8Array} inputs
-* @returns {Uint8Array}
-*/
-export function sha256(inputs: Uint8Array): Uint8Array;
-/**
-* Performs a bitwise XOR operation between `lhs` and `rhs`
-* @param {string} lhs
-* @param {string} rhs
-* @returns {string}
-*/
-export function xor(lhs: string, rhs: string): string;
-/**
-* Performs a bitwise AND operation between `lhs` and `rhs`
-* @param {string} lhs
-* @param {string} rhs
-* @returns {string}
-*/
-export function and(lhs: string, rhs: string): string;
-/**
-* Sets the package's logging level.
-*
-* @param {LogLevel} level - The maximum level of logging to be emitted.
-*/
-export function initLogLevel(filter: string): void;
-/**
 * 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;
 
+export type ExecutionError = Error & {
+    callStack?: string[];
+};
+
+
+
+// Map from witness index to hex string value of witness.
+export type WitnessMap = Map<number, string>;
+
+
+
 export type ForeignCallInput = string[]
 export type ForeignCallOutput = string | string[]
 
@@ -146,17 +157,6 @@ export type ForeignCallHandler = (name: string, inputs: ForeignCallInput[]) => P
 
 
 
-// Map from witness index to hex string value of witness.
-export type WitnessMap = Map<number, string>;
-
-
-
-export type ExecutionError = Error & {
-    callStack?: 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.