@noir-lang/acvm_js 1.0.0-beta.15-1fce7ca.nightly → 1.0.0-beta.15-881acee.nightly

package/nodejs/acvm_js.d.ts

@@ -1,35 +1,62 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Performs a bitwise AND operation between `lhs` and `rhs`
+ * 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 and(lhs: string, rhs: string): string;
+export function compressWitness(witness_map: WitnessMap): Uint8Array;
 /**
- * Performs a bitwise XOR operation between `lhs` and `rhs`
+ * 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 xor(lhs: string, rhs: string): string;
+export function decompressWitness(compressed_witness: Uint8Array): WitnessMap;
 /**
- * Sha256 compression function
+ * 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 sha256_compression(inputs: Uint32Array, state: Uint32Array): Uint32Array;
+export function compressWitnessStack(witness_stack: WitnessStack): Uint8Array;
 /**
- * Calculates the Blake2s256 hash of the input bytes
+ * 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 blake2s256(inputs: Uint8Array): Uint8Array;
+export function decompressWitnessStack(compressed_witness: Uint8Array): WitnessStack;
 /**
- * Verifies a ECDSA signature over the secp256k1 curve.
+ * 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 ecdsa_secp256k1_verify(hashed_msg: Uint8Array, public_key_x_bytes: Uint8Array, public_key_y_bytes: Uint8Array, signature: Uint8Array): boolean;
+export function executeCircuit(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessMap>;
 /**
- * Verifies a ECDSA signature over the secp256r1 curve.
+ * 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} 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 ecdsa_secp256r1_verify(hashed_msg: Uint8Array, public_key_x_bytes: Uint8Array, public_key_y_bytes: Uint8Array, signature: Uint8Array): boolean;
+export function executeCircuitWithReturnWitness(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<SolvedAndReturnWitness>;
 /**
- * Sets the package's logging level.
+ * Executes an ACIR circuit to generate the solved witness from the initial witness.
  *
- * @param {LogLevel} level - The maximum level of logging to be emitted.
+ * @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 initLogLevel(filter: string): void;
+export function executeProgram(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessStack>;
 /**
  * Returns the `BuildInfo` object containing information about how the installed package was built.
  * @returns {BuildInfo} - Information on how the installed package was built.
@@ -60,71 +87,35 @@ export function getPublicParametersWitness(program: Uint8Array, solved_witness:
  */
 export function getPublicWitness(program: Uint8Array, solved_witness: WitnessMap): WitnessMap;
 /**
- * Compresses a `WitnessMap` into the binary format outputted by Nargo.
- *
- * @param {WitnessMap} witness_map - A witness map.
- * @returns {Uint8Array} A compressed witness map
+ * Performs a bitwise AND operation between `lhs` and `rhs`
  */
-export function compressWitness(witness_map: WitnessMap): Uint8Array;
+export function and(lhs: string, rhs: string): string;
 /**
- * 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.
+ * Performs a bitwise XOR operation between `lhs` and `rhs`
  */
-export function decompressWitness(compressed_witness: Uint8Array): WitnessMap;
+export function xor(lhs: string, rhs: string): string;
 /**
- * Compresses a `WitnessStack` into the binary format outputted by Nargo.
- *
- * @param {WitnessStack} witness_stack - A witness stack.
- * @returns {Uint8Array} A compressed witness stack
+ * Sha256 compression function
  */
-export function compressWitnessStack(witness_stack: WitnessStack): Uint8Array;
+export function sha256_compression(inputs: Uint32Array, state: Uint32Array): Uint32Array;
 /**
- * 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.
+ * Calculates the Blake2s256 hash of the input bytes
  */
-export function decompressWitnessStack(compressed_witness: Uint8Array): WitnessStack;
+export function blake2s256(inputs: Uint8Array): Uint8Array;
 /**
- * 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.
+ * Verifies a ECDSA signature over the secp256k1 curve.
  */
-export function executeCircuit(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessMap>;
+export function ecdsa_secp256k1_verify(hashed_msg: Uint8Array, public_key_x_bytes: Uint8Array, public_key_y_bytes: Uint8Array, signature: Uint8Array): boolean;
 /**
- * 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} 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.
+ * Verifies a ECDSA signature over the secp256r1 curve.
  */
-export function executeCircuitWithReturnWitness(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<SolvedAndReturnWitness>;
+export function ecdsa_secp256r1_verify(hashed_msg: Uint8Array, public_key_x_bytes: Uint8Array, public_key_y_bytes: Uint8Array, signature: Uint8Array): boolean;
 /**
- * Executes an ACIR circuit to generate the solved witness from the initial witness.
+ * Sets the package's logging level.
  *
- * @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.
+ * @param {LogLevel} level - The maximum level of logging to be emitted.
  */
-export function executeProgram(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessStack>;
-
-export type StackItem = {
-    index: number;
-    witness: WitnessMap;
-}
-
-export type WitnessStack = Array<StackItem>;
-
-
+export function initLogLevel(filter: string): void;
 
 /**
 * @typedef {Object} BuildInfo - Information about how the installed package was built
@@ -182,3 +173,12 @@ export type ForeignCallOutput = string | string[]
 export type ForeignCallHandler = (name: string, inputs: ForeignCallInput[]) => Promise<ForeignCallOutput[]>;
 
 
+
+export type StackItem = {
+    index: number;
+    witness: WitnessMap;
+}
+
+export type WitnessStack = Array<StackItem>;
+
+