@aztec/noir-acvm_js 0.75.0-commit.8a71f57856e217a77b6e50cbc8833c1cd5395b96

package/nodejs/acvm_js_bg.wasm.d.ts

@@ -0,0 +1,30 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export function executeCircuit(a: number, b: number, c: number, d: number): number;
+export function executeCircuitWithReturnWitness(a: number, b: number, c: number, d: number): number;
+export function executeProgram(a: number, b: number, c: number, d: number): number;
+export function initLogLevel(a: number, b: number, c: number): void;
+export function compressWitness(a: number, b: number): void;
+export function decompressWitness(a: number, b: number, c: number): void;
+export function compressWitnessStack(a: number, b: number): void;
+export function decompressWitnessStack(a: number, b: number, c: number): void;
+export function and(a: number, b: number): number;
+export function xor(a: number, b: number): number;
+export function sha256_compression(a: number, b: number, c: number, d: number, e: number): void;
+export function blake2s256(a: number, b: number, c: number): void;
+export function ecdsa_secp256k1_verify(a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number): number;
+export function ecdsa_secp256r1_verify(a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number): number;
+export function buildInfo(): number;
+export function getReturnWitness(a: number, b: number, c: number, d: number): void;
+export function getPublicParametersWitness(a: number, b: number, c: number, d: number): void;
+export function getPublicWitness(a: number, b: number, c: number, d: number): void;
+export function __wbindgen_malloc(a: number): number;
+export function __wbindgen_realloc(a: number, b: number, c: number): number;
+export const __wbindgen_export_2: WebAssembly.Table;
+export function wasm_bindgen__convert__closures__invoke1_mut__h88a56384c96b757b(a: number, b: number, c: number): void;
+export function __wbindgen_add_to_stack_pointer(a: number): number;
+export function __wbindgen_free(a: number, b: number): void;
+export function wasm_bindgen__convert__closures__invoke3_mut__h24d1dd0bd469df82(a: number, b: number, c: number, d: number, e: number): void;
+export function __wbindgen_exn_store(a: number): void;
+export function wasm_bindgen__convert__closures__invoke2_mut__h57a2220e5f1e0a1e(a: number, b: number, c: number, d: number): void;

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@aztec/noir-acvm_js",
+  "version": "0.75.0-commit.8a71f57856e217a77b6e50cbc8833c1cd5395b96",
+  "publishConfig": {
+    "access": "public"
+  },
+  "contributors": [
+    "The Noir Team <team@noir-lang.org>"
+  ],
+  "homepage": "https://noir-lang.org/",
+  "repository": {
+    "url": "https://github.com/noir-lang/noir.git",
+    "directory": "acvm_repo/acvm_js",
+    "type": "git"
+  },
+  "bugs": {
+    "url": "https://github.com/noir-lang/noir/issues"
+  },
+  "license": "MIT",
+  "main": "./nodejs/acvm_js.js",
+  "types": "./web/acvm_js.d.ts",
+  "module": "./web/acvm_js.js",
+  "files": [
+    "nodejs",
+    "web",
+    "package.json"
+  ],
+  "sideEffects": false,
+  "packageManager": "yarn@3.5.1",
+  "scripts": {
+    "build": "bash ./build.sh",
+    "test": "env TS_NODE_COMPILER_OPTIONS='{\"module\": \"commonjs\" }' mocha",
+    "test:browser": "web-test-runner",
+    "lint": "NODE_NO_WARNINGS=1 eslint . --ext .ts --ignore-path ./.eslintignore  --max-warnings 0",
+    "publish": "echo 📡 publishing `$npm_package_name` && yarn npm publish",
+    "nightly:version": "jq --arg new_version \"-$(git rev-parse --short HEAD)$1\" '.version = .version + $new_version' package.json > package-tmp.json && mv package-tmp.json package.json",
+    "clean": "chmod u+w web nodejs || true && rm -rf web nodejs"
+  },
+  "devDependencies": {
+    "@esm-bundle/chai": "^4.3.4-fix.0",
+    "@web/dev-server-esbuild": "^0.3.6",
+    "@web/test-runner": "^0.18.1",
+    "@web/test-runner-playwright": "^0.11.0",
+    "chai": "^4.4.1",
+    "eslint": "^8.57.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "mocha": "^10.2.0",
+    "prettier": "3.2.5",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.4.2"
+  }
+}

package/web/acvm_js.d.ts

@@ -0,0 +1,267 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+* 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>;
+/**
+* Sets the package's logging level.
+*
+* @param {LogLevel} level - The maximum level of logging to be emitted.
+*/
+export function initLogLevel(filter: string): void;
+/**
+* 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;
+/**
+* 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;
+/**
+* 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;
+/**
+* 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;
+
+// Map from witness index to hex string value of witness.
+export type WitnessMap = Map<number, string>;
+
+/**
+ * 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.
+*/
+export type ForeignCallHandler = (name: string, inputs: ForeignCallInput[]) => Promise<ForeignCallOutput[]>;
+
+
+
+/**
+* @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 RawAssertionPayload = {
+    selector: string;
+    data: string[];
+};
+
+export type ExecutionError = Error & {
+    callStack?: string[];
+    rawAssertionPayload?: RawAssertionPayload;
+    brilligFunctionId?: number;
+};
+
+
+
+export type StackItem = {
+    index: number;
+    witness: WitnessMap;
+}
+
+export type WitnessStack = Array<StackItem>;
+
+
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+  readonly memory: WebAssembly.Memory;
+  readonly executeCircuit: (a: number, b: number, c: number, d: number) => number;
+  readonly executeCircuitWithReturnWitness: (a: number, b: number, c: number, d: number) => number;
+  readonly executeProgram: (a: number, b: number, c: number, d: number) => number;
+  readonly initLogLevel: (a: number, b: number, c: number) => void;
+  readonly compressWitness: (a: number, b: number) => void;
+  readonly decompressWitness: (a: number, b: number, c: number) => void;
+  readonly compressWitnessStack: (a: number, b: number) => void;
+  readonly decompressWitnessStack: (a: number, b: number, c: number) => void;
+  readonly and: (a: number, b: number) => number;
+  readonly xor: (a: number, b: number) => number;
+  readonly sha256_compression: (a: number, b: number, c: number, d: number, e: number) => void;
+  readonly blake2s256: (a: number, b: number, c: number) => void;
+  readonly ecdsa_secp256k1_verify: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => number;
+  readonly ecdsa_secp256r1_verify: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => number;
+  readonly buildInfo: () => number;
+  readonly getReturnWitness: (a: number, b: number, c: number, d: number) => void;
+  readonly getPublicParametersWitness: (a: number, b: number, c: number, d: number) => void;
+  readonly getPublicWitness: (a: number, b: number, c: number, d: number) => void;
+  readonly __wbindgen_malloc: (a: number) => number;
+  readonly __wbindgen_realloc: (a: number, b: number, c: number) => number;
+  readonly __wbindgen_export_2: WebAssembly.Table;
+  readonly wasm_bindgen__convert__closures__invoke1_mut__h88a56384c96b757b: (a: number, b: number, c: number) => void;
+  readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
+  readonly __wbindgen_free: (a: number, b: number) => void;
+  readonly wasm_bindgen__convert__closures__invoke3_mut__h24d1dd0bd469df82: (a: number, b: number, c: number, d: number, e: number) => void;
+  readonly __wbindgen_exn_store: (a: number) => void;
+  readonly wasm_bindgen__convert__closures__invoke2_mut__h57a2220e5f1e0a1e: (a: number, b: number, c: number, d: number) => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+/**
+* Instantiates the given `module`, which can either be bytes or
+* a precompiled `WebAssembly.Module`.
+*
+* @param {SyncInitInput} module
+*
+* @returns {InitOutput}
+*/
+export function initSync(module: SyncInitInput): InitOutput;
+
+/**
+* If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+* for everything else, calls `WebAssembly.instantiate` directly.
+*
+* @param {InitInput | Promise<InitInput>} module_or_path
+*
+* @returns {Promise<InitOutput>}
+*/
+export default function __wbg_init (module_or_path?: InitInput | Promise<InitInput>): Promise<InitOutput>;