@noir-lang/acvm_js 0.55.0 → 1.0.0-9c1fafc.nightly

package/nodejs/acvm_js.d.ts

@@ -1,166 +1,63 @@
 /* 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;
-/**
-* 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(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessMap>;
-/**
-* 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 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
-* @param {string} rhs
-* @returns {string}
-*/
-export function and(lhs: string, rhs: string): string;
-/**
-* 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;
-/**
-* Sha256 compression function
-* @param {Uint32Array} inputs
-* @param {Uint32Array} state
-* @returns {Uint32Array}
-*/
-export function sha256_compression(inputs: Uint32Array, state: Uint32Array): Uint32Array;
-/**
-* Calculates the Blake2s256 hash of the input bytes
-* @param {Uint8Array} inputs
-* @returns {Uint8Array}
-*/
-export function blake2s256(inputs: Uint8Array): Uint8Array;
-/**
-* 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;
-/**
-* 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;
-/**
-* 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;
-/**
-* Sets the package's logging level.
-*
-* @param {LogLevel} level - The maximum level of logging to be emitted.
-*/
-export function initLogLevel(filter: string): void;
-/**
-* 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.
-*
-* @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 getPublicParametersWitness(program: Uint8Array, solved_witness: WitnessMap): WitnessMap;
+ * @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;
+}
+
+
+
+// Map from witness index to hex string value of witness.
+export type WitnessMap = Map<number, string>;
+
 /**
-* 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;
+ * An execution result containing two witnesses.
+ * 1. The full solved witness of the execution.
+ * 2. The return witness which contains the given public return values within the full witness.
+ */
+export type SolvedAndReturnWitness = {
+    solvedWitness: WitnessMap;
+    returnWitness: WitnessMap;
+}
+
+
 
 export type ForeignCallInput = string[]
 export type ForeignCallOutput = string | 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.
-*/
+ * 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 RawAssertionPayload = {
+    selector: string;
+    data: string[];
+};
+
+export type ExecutionError = Error & {
+    callStack?: string[];
+    rawAssertionPayload?: RawAssertionPayload;
+    acirFunctionId?: number;
+    brilligFunctionId?: number;
+};
+
+
+
 export type StackItem = {
     index: number;
     witness: WitnessMap;
@@ -171,43 +68,135 @@ export type WitnessStack = Array<StackItem>;
 
 
 /**
-* @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.
+ * Performs a bitwise AND operation between `lhs` and `rhs`
  */
-export type BuildInfo = {
-  gitHash: string;
-  version: string;
-  dirty: string;
-}
+export function and(lhs: string, rhs: string): string;
 
+/**
+ * Calculates the Blake2s256 hash of the input bytes
+ */
+export function blake2s256(inputs: Uint8Array): Uint8Array;
 
+/**
+ * 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 RawAssertionPayload = {
-    selector: string;
-    data: string[];
-};
+/**
+ * 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;
 
-export type ExecutionError = Error & {
-    callStack?: string[];
-    rawAssertionPayload?: RawAssertionPayload;
-    brilligFunctionId?: number;
-};
+/**
+ * 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 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;
 
+/**
+ * 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;
 
-// Map from witness index to hex string value of witness.
-export type WitnessMap = Map<number, string>;
+/**
+ * Verifies a ECDSA signature over the secp256k1 curve.
+ */
+export function ecdsa_secp256k1_verify(hashed_msg: Uint8Array, public_key_x_bytes: Uint8Array, public_key_y_bytes: Uint8Array, signature: Uint8Array): boolean;
 
 /**
- * An execution result containing two witnesses.
- * 1. The full solved witness of the execution.
- * 2. The return witness which contains the given public return values within the full witness.
+ * Verifies a ECDSA signature over the secp256r1 curve.
  */
-export type SolvedAndReturnWitness = {
-    solvedWitness: WitnessMap;
-    returnWitness: WitnessMap;
-}
+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.
+ *
+ * @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(program: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessMap>;
+
+/**
+ * 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 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>;
+
+/**
+ * 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.
+ */
+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.
+ */
+export function getPublicWitness(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.
+ */
+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;
 
+/**
+ * Sha256 compression function
+ */
+export function sha256_compression(inputs: Uint32Array, state: Uint32Array): Uint32Array;
+
+/**
+ * Performs a bitwise XOR operation between `lhs` and `rhs`
+ */
+export function xor(lhs: string, rhs: string): string;