@noir-lang/acvm_js 0.26.0

package/nodejs/acvm_js_bg.wasm.d.ts

@@ -0,0 +1,24 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export function buildInfo(): number;
+export function executeCircuitWithBlackBoxSolver(a: number, b: number, c: number, d: number, e: number): number;
+export function executeCircuit(a: number, b: number, c: number, d: number): number;
+export function createBlackBoxSolver(): number;
+export function __wbg_wasmblackboxfunctionsolver_free(a: number): void;
+export function decompressWitness(a: number, b: number, c: number): void;
+export function compressWitness(a: number, b: number): void;
+export function initLogLevel(a: number): void;
+export function getPublicWitness(a: number, b: number, c: number, d: number): void;
+export function getPublicParametersWitness(a: number, b: number, c: number, d: number): void;
+export function getReturnWitness(a: number, b: number, c: number, d: number): void;
+export function __wbg_trap_free(a: number): void;
+export function trap___wbgd_downcast_token(): number;
+export function __wbindgen_malloc(a: number, b: number): number;
+export function __wbindgen_realloc(a: number, b: number, c: number, d: number): number;
+export const __wbindgen_export_2: WebAssembly.Table;
+export function _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h8fdacd768a9ff6b4(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, c: number): void;
+export function __wbindgen_exn_store(a: number): void;
+export function wasm_bindgen__convert__closures__invoke2_mut__h2def3b115f9d10e4(a: number, b: number, c: number, d: number): void;

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@noir-lang/acvm_js",
+  "version": "0.26.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/noir-lang/acvm.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "collaborators": [
+    "The Noir Team <team@noir-lang.org>"
+  ],
+  "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
+}

package/web/acvm_js.d.ts

@@ -0,0 +1,189 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+* 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;
+/**
+* Executes an ACIR circuit to generate the solved witness from the initial witness.
+*
+* @param {&WasmBlackBoxFunctionSolver} solver - A black box solver.
+* @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 executeCircuitWithBlackBoxSolver(solver: WasmBlackBoxFunctionSolver, circuit: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessMap>;
+/**
+* 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(circuit: Uint8Array, initial_witness: WitnessMap, foreign_call_handler: ForeignCallHandler): Promise<WitnessMap>;
+/**
+* @returns {Promise<WasmBlackBoxFunctionSolver>}
+*/
+export function createBlackBoxSolver(): Promise<WasmBlackBoxFunctionSolver>;
+/**
+* Decompresses a compressed witness as outputted by Nargo into a `WitnessMap`.
+*
+* @param {Uint8Array} compressed_witness - A compressed witness.
+* @returns {WitnessMap} The decompressed witness map.
+*/
+export function decompressWitness(compressed_witness: Uint8Array): WitnessMap;
+/**
+* Compresses a `WitnessMap` into the binary format outputted by Nargo.
+*
+* @param {Uint8Array} compressed_witness - A witness map.
+* @returns {WitnessMap} A compressed witness map
+*/
+export function compressWitness(witness_map: WitnessMap): Uint8Array;
+/**
+* Sets the package's logging level.
+*
+* @param {LogLevel} level - The maximum level of logging to be emitted.
+*/
+export function initLogLevel(level: LogLevel): void;
+/**
+* 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} circuit
+* @param {WitnessMap} solved_witness
+* @returns {WitnessMap}
+*/
+export function getPublicWitness(circuit: 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 {WitnessMap} solved_witness
+* @returns {WitnessMap}
+*/
+export function getPublicParametersWitness(circuit: 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 {WitnessMap} witness_map
+* @returns {WitnessMap}
+*/
+export function getReturnWitness(circuit: Uint8Array, witness_map: WitnessMap): 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 ExecutionError = Error & {
+    callStack?: string[];
+};
+
+
+
+export type LogLevel = "OFF" | "ERROR" | "WARN" | "INFO" | "DEBUG" | "TRACE";
+
+
+
+// Map from witness index to hex string value of witness.
+export type WitnessMap = Map<number, string>;
+
+
+/**
+* A struct representing a Trap
+*/
+export class Trap {
+  free(): void;
+/**
+* @returns {Symbol}
+*/
+  static __wbgd_downcast_token(): Symbol;
+}
+/**
+*/
+export class WasmBlackBoxFunctionSolver {
+  free(): void;
+}
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+  readonly memory: WebAssembly.Memory;
+  readonly buildInfo: () => number;
+  readonly executeCircuitWithBlackBoxSolver: (a: number, b: number, c: number, d: number, e: number) => number;
+  readonly executeCircuit: (a: number, b: number, c: number, d: number) => number;
+  readonly createBlackBoxSolver: () => number;
+  readonly __wbg_wasmblackboxfunctionsolver_free: (a: number) => void;
+  readonly decompressWitness: (a: number, b: number, c: number) => void;
+  readonly compressWitness: (a: number, b: number) => void;
+  readonly initLogLevel: (a: number) => void;
+  readonly getPublicWitness: (a: number, b: number, c: number, d: number) => void;
+  readonly getPublicParametersWitness: (a: number, b: number, c: number, d: number) => void;
+  readonly getReturnWitness: (a: number, b: number, c: number, d: number) => void;
+  readonly __wbg_trap_free: (a: number) => void;
+  readonly trap___wbgd_downcast_token: () => number;
+  readonly __wbindgen_malloc: (a: number, b: number) => number;
+  readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+  readonly __wbindgen_export_2: WebAssembly.Table;
+  readonly _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h8fdacd768a9ff6b4: (a: number, b: number, c: number) => void;
+  readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
+  readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+  readonly __wbindgen_exn_store: (a: number) => void;
+  readonly wasm_bindgen__convert__closures__invoke2_mut__h2def3b115f9d10e4: (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>;