@noir-lang/noir_wasm 0.23.0 → 0.24.0-16d5f18.nightly

package/README.md

@@ -1,9 +1,32 @@
 # Noir Lang WASM JavaScript Package
 
-This JavaScript package enables users to compile a Noir program, i.e. generating its artifacts.
+This JavaScript package enables users to compile a Noir program, i.e. generating its artifacts, both in Node.JS environments and the browser.
 
 The package also handles dependency management like how Nargo (Noir's CLI tool) operates, but the package is used just for compilation, not proving, verifying and simulating functions.
 
+## Usage
+
+```typescript
+// Node.js
+
+import { compile, createFileManager } from '@noir-lang/noir_wasm';
+
+const fm = createFileManager(myProjectPath);
+const myCompiledCode = await compile(fm);
+```
+
+```typescript
+// Browser
+
+import { compile, createFileManager } from '@noir-lang/noir_wasm';
+
+const fm = createFileManager('/');
+for (const path of files) {
+  await fm.writeFile(path, await getFileAsStream(path));
+}
+const myCompiledCode = await compile(fm);
+```
+
 ## Building from source
 
 Outside of the [noir repo](https://github.com/noir-lang/noir), this package can be built using the command below:

package/build/cjs/package.json

@@ -3,7 +3,7 @@
   "collaborators": [
     "The Noir Team <team@noir-lang.org>"
   ],
-  "version": "0.23.0",
+  "version": "0.24.0",
   "license": "MIT OR Apache-2.0",
   "files": [
     "index_bg.wasm",

package/build/esm/package.json

@@ -3,7 +3,7 @@
   "collaborators": [
     "The Noir Team <team@noir-lang.org>"
   ],
-  "version": "0.23.0",
+  "version": "0.24.0",
   "license": "MIT OR Apache-2.0",
   "files": [
     "index_bg.wasm",

package/dist/node/main.js

@@ -32,12 +32,6 @@ function takeObject(idx) {
     return ret;
 }
 
-function _assertBoolean(n) {
-    if (typeof(n) !== 'boolean') {
-        throw new Error('expected a boolean argument');
-    }
-}
-
 let cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
 
 cachedTextDecoder.decode();
@@ -61,8 +55,6 @@ function addHeapObject(obj) {
     const idx = heap_next;
     heap_next = heap[idx];
 
-    if (typeof(heap_next) !== 'number') throw new Error('corrupt heap');
-
     heap[idx] = obj;
     return idx;
 }
@@ -86,8 +78,6 @@ const encodeString = (typeof cachedTextEncoder.encodeInto === 'function'
 
 function passStringToWasm0(arg, malloc, realloc) {
 
-    if (typeof(arg) !== 'string') throw new Error('expected a string argument');
-
     if (realloc === undefined) {
         const buf = cachedTextEncoder.encode(arg);
         const ptr = malloc(buf.length) >>> 0;
@@ -116,7 +106,7 @@ function passStringToWasm0(arg, malloc, realloc) {
         ptr = realloc(ptr, len, len = offset + arg.length * 3) >>> 0;
         const view = getUint8Memory0().subarray(ptr + offset, ptr + len);
         const ret = encodeString(arg, view);
-        if (ret.read !== arg.length) throw new Error('failed to pass whole string');
+
         offset += ret.written;
     }
 
@@ -202,26 +192,6 @@ function debugString(val) {
     return className;
 }
 
-function logError(f, args) {
-    try {
-        return f.apply(this, args);
-    } catch (e) {
-        let error = (function () {
-            try {
-                return e instanceof Error ? `${e.message}\n\nStack:\n${e.stack}` : e.toString();
-            } catch(_) {
-                return "<failed to stringify thrown value>";
-            }
-        }());
-        console.error("wasm-bindgen: imported JS function that was not marked as `catch` threw an error:", error);
-        throw e;
-    }
-}
-
-function _assertNum(n) {
-    if (typeof(n) !== 'number') throw new Error('expected a number argument');
-}
-
 function _assertClass(instance, klass) {
     if (!(instance instanceof klass)) {
         throw new Error(`expected instance of ${klass.name}`);
@@ -229,26 +199,22 @@ function _assertClass(instance, klass) {
     return instance.ptr;
 }
 /**
+* This is a method that exposes the same API as `compile`
+* But uses the Context based APi internally
 * @param {string} entry_point
 * @param {boolean | undefined} contracts
 * @param {DependencyGraph | undefined} dependency_graph
 * @param {PathToFileSourceMap} file_source_map
 * @returns {CompileResult}
 */
-module.exports.compile = function(entry_point, contracts, dependency_graph, file_source_map) {
+module.exports.compile_ = function(entry_point, contracts, dependency_graph, file_source_map) {
     try {
         const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
         const ptr0 = passStringToWasm0(entry_point, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
         const len0 = WASM_VECTOR_LEN;
-        if (!isLikeNone(contracts)) {
-            _assertBoolean(contracts);
-        }
         _assertClass(file_source_map, PathToFileSourceMap);
-        if (file_source_map.__wbg_ptr === 0) {
-            throw new Error('Attempt to use a moved value');
-        }
         var ptr1 = file_source_map.__destroy_into_raw();
-        wasm.compile(retptr, ptr0, len0, isLikeNone(contracts) ? 0xFFFFFF : contracts ? 1 : 0, isLikeNone(dependency_graph) ? 0 : addHeapObject(dependency_graph), ptr1);
+        wasm.compile_(retptr, ptr0, len0, isLikeNone(contracts) ? 0xFFFFFF : contracts ? 1 : 0, isLikeNone(dependency_graph) ? 0 : addHeapObject(dependency_graph), ptr1);
         var r0 = getInt32Memory0()[retptr / 4 + 0];
         var r1 = getInt32Memory0()[retptr / 4 + 1];
         var r2 = getInt32Memory0()[retptr / 4 + 2];
@@ -262,28 +228,37 @@ module.exports.compile = function(entry_point, contracts, dependency_graph, file
 };
 
 /**
-* This is a method that exposes the same API as `compile`
-* But uses the Context based APi internally
+* @param {string} level
+*/
+module.exports.init_log_level = function(level) {
+    const ptr0 = passStringToWasm0(level, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
+    const len0 = WASM_VECTOR_LEN;
+    wasm.init_log_level(ptr0, len0);
+};
+
+/**
+* @returns {any}
+*/
+module.exports.build_info = function() {
+    const ret = wasm.build_info();
+    return takeObject(ret);
+};
+
+/**
 * @param {string} entry_point
 * @param {boolean | undefined} contracts
 * @param {DependencyGraph | undefined} dependency_graph
 * @param {PathToFileSourceMap} file_source_map
 * @returns {CompileResult}
 */
-module.exports.compile_ = function(entry_point, contracts, dependency_graph, file_source_map) {
+module.exports.compile = function(entry_point, contracts, dependency_graph, file_source_map) {
     try {
         const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
         const ptr0 = passStringToWasm0(entry_point, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
         const len0 = WASM_VECTOR_LEN;
-        if (!isLikeNone(contracts)) {
-            _assertBoolean(contracts);
-        }
         _assertClass(file_source_map, PathToFileSourceMap);
-        if (file_source_map.__wbg_ptr === 0) {
-            throw new Error('Attempt to use a moved value');
-        }
         var ptr1 = file_source_map.__destroy_into_raw();
-        wasm.compile_(retptr, ptr0, len0, isLikeNone(contracts) ? 0xFFFFFF : contracts ? 1 : 0, isLikeNone(dependency_graph) ? 0 : addHeapObject(dependency_graph), ptr1);
+        wasm.compile(retptr, ptr0, len0, isLikeNone(contracts) ? 0xFFFFFF : contracts ? 1 : 0, isLikeNone(dependency_graph) ? 0 : addHeapObject(dependency_graph), ptr1);
         var r0 = getInt32Memory0()[retptr / 4 + 0];
         var r1 = getInt32Memory0()[retptr / 4 + 1];
         var r2 = getInt32Memory0()[retptr / 4 + 2];
@@ -296,23 +271,6 @@ module.exports.compile_ = function(entry_point, contracts, dependency_graph, fil
     }
 };
 
-/**
-* @param {string} filter
-*/
-module.exports.init_log_level = function(filter) {
-    const ptr0 = passStringToWasm0(filter, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
-    const len0 = WASM_VECTOR_LEN;
-    wasm.init_log_level(ptr0, len0);
-};
-
-/**
-* @returns {any}
-*/
-module.exports.build_info = function() {
-    const ret = wasm.build_info();
-    return takeObject(ret);
-};
-
 function handleError(f, args) {
     try {
         return f.apply(this, args);
@@ -351,9 +309,6 @@ class CompilerContext {
     */
     constructor(source_map) {
         _assertClass(source_map, PathToFileSourceMap);
-        if (source_map.__wbg_ptr === 0) {
-            throw new Error('Attempt to use a moved value');
-        }
         var ptr0 = source_map.__destroy_into_raw();
         const ret = wasm.compilercontext_new(ptr0);
         return CompilerContext.__wrap(ret);
@@ -363,8 +318,6 @@ class CompilerContext {
     * @returns {CrateId}
     */
     process_root_crate(path_to_crate) {
-        if (this.__wbg_ptr == 0) throw new Error('Attempt to use a moved value');
-        _assertNum(this.__wbg_ptr);
         const ptr0 = passStringToWasm0(path_to_crate, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
         const len0 = WASM_VECTOR_LEN;
         const ret = wasm.compilercontext_process_root_crate(this.__wbg_ptr, ptr0, len0);
@@ -375,8 +328,6 @@ class CompilerContext {
     * @returns {CrateId}
     */
     process_dependency_crate(path_to_crate) {
-        if (this.__wbg_ptr == 0) throw new Error('Attempt to use a moved value');
-        _assertNum(this.__wbg_ptr);
         const ptr0 = passStringToWasm0(path_to_crate, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
         const len0 = WASM_VECTOR_LEN;
         const ret = wasm.compilercontext_process_dependency_crate(this.__wbg_ptr, ptr0, len0);
@@ -389,19 +340,11 @@ class CompilerContext {
     */
     add_dependency_edge(crate_name, from, to) {
         try {
-            if (this.__wbg_ptr == 0) throw new Error('Attempt to use a moved value');
             const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
-            _assertNum(this.__wbg_ptr);
             const ptr0 = passStringToWasm0(crate_name, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
             const len0 = WASM_VECTOR_LEN;
             _assertClass(from, CrateId);
-            if (from.__wbg_ptr === 0) {
-                throw new Error('Attempt to use a moved value');
-            }
             _assertClass(to, CrateId);
-            if (to.__wbg_ptr === 0) {
-                throw new Error('Attempt to use a moved value');
-            }
             wasm.compilercontext_add_dependency_edge(retptr, this.__wbg_ptr, ptr0, len0, from.__wbg_ptr, to.__wbg_ptr);
             var r0 = getInt32Memory0()[retptr / 4 + 0];
             var r1 = getInt32Memory0()[retptr / 4 + 1];
@@ -418,11 +361,8 @@ class CompilerContext {
     */
     compile_program(program_width) {
         try {
-            if (this.__wbg_ptr == 0) throw new Error('Attempt to use a moved value');
             const ptr = this.__destroy_into_raw();
             const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
-            _assertNum(ptr);
-            _assertNum(program_width);
             wasm.compilercontext_compile_program(retptr, ptr, program_width);
             var r0 = getInt32Memory0()[retptr / 4 + 0];
             var r1 = getInt32Memory0()[retptr / 4 + 1];
@@ -441,11 +381,8 @@ class CompilerContext {
     */
     compile_contract(program_width) {
         try {
-            if (this.__wbg_ptr == 0) throw new Error('Attempt to use a moved value');
             const ptr = this.__destroy_into_raw();
             const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
-            _assertNum(ptr);
-            _assertNum(program_width);
             wasm.compilercontext_compile_contract(retptr, ptr, program_width);
             var r0 = getInt32Memory0()[retptr / 4 + 0];
             var r1 = getInt32Memory0()[retptr / 4 + 1];
@@ -464,10 +401,6 @@ module.exports.CompilerContext = CompilerContext;
 */
 class CrateId {
 
-    constructor() {
-        throw new Error('cannot invoke `new` directly');
-    }
-
     static __wrap(ptr) {
         ptr = ptr >>> 0;
         const obj = Object.create(CrateId.prototype);
@@ -524,8 +457,6 @@ class PathToFileSourceMap {
     * @returns {boolean}
     */
     add_source_code(path, source_code) {
-        if (this.__wbg_ptr == 0) throw new Error('Attempt to use a moved value');
-        _assertNum(this.__wbg_ptr);
         const ptr0 = passStringToWasm0(path, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
         const len0 = WASM_VECTOR_LEN;
         const ptr1 = passStringToWasm0(source_code, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
@@ -540,36 +471,35 @@ module.exports.__wbindgen_object_drop_ref = function(arg0) {
     takeObject(arg0);
 };
 
-module.exports.__wbg_constructor_28ca684b2f9696ac = function() { return logError(function () {
-    const ret = new Object();
-    return addHeapObject(ret);
-}, arguments) };
-
 module.exports.__wbindgen_is_undefined = function(arg0) {
     const ret = getObject(arg0) === undefined;
-    _assertBoolean(ret);
     return ret;
 };
 
-module.exports.__wbg_constructor_287b714b768ecf13 = function() { return logError(function (arg0) {
+module.exports.__wbg_constructor_e8767839abf8a966 = function(arg0) {
     const ret = new Error(takeObject(arg0));
     return addHeapObject(ret);
-}, arguments) };
+};
 
-module.exports.__wbg_new_abda76e883ba8a5f = function() { return logError(function () {
+module.exports.__wbg_constructor_05d6d198f3477d6f = function() {
+    const ret = new Object();
+    return addHeapObject(ret);
+};
+
+module.exports.__wbg_new_abda76e883ba8a5f = function() {
     const ret = new Error();
     return addHeapObject(ret);
-}, arguments) };
+};
 
-module.exports.__wbg_stack_658279fe44541cf6 = function() { return logError(function (arg0, arg1) {
+module.exports.__wbg_stack_658279fe44541cf6 = function(arg0, arg1) {
     const ret = getObject(arg1).stack;
     const ptr1 = passStringToWasm0(ret, wasm.__wbindgen_export_0, wasm.__wbindgen_export_1);
     const len1 = WASM_VECTOR_LEN;
     getInt32Memory0()[arg0 / 4 + 1] = len1;
     getInt32Memory0()[arg0 / 4 + 0] = ptr1;
-}, arguments) };
+};
 
-module.exports.__wbg_error_f851667af71bcfc6 = function() { return logError(function (arg0, arg1) {
+module.exports.__wbg_error_f851667af71bcfc6 = function(arg0, arg1) {
     let deferred0_0;
     let deferred0_1;
     try {
@@ -579,52 +509,44 @@ module.exports.__wbg_error_f851667af71bcfc6 = function() { return logError(funct
     } finally {
         wasm.__wbindgen_export_2(deferred0_0, deferred0_1);
     }
-}, arguments) };
+};
 
 module.exports.__wbindgen_string_new = function(arg0, arg1) {
     const ret = getStringFromWasm0(arg0, arg1);
     return addHeapObject(ret);
 };
 
-module.exports.__wbg_debug_e3f6a1578e6d45ca = function() { return logError(function (arg0) {
+module.exports.__wbg_debug_e3f6a1578e6d45ca = function(arg0) {
     console.debug(getObject(arg0));
-}, arguments) };
+};
 
-module.exports.__wbg_debug_efabe4eb183aa5d4 = function() { return logError(function (arg0, arg1, arg2, arg3) {
+module.exports.__wbg_debug_efabe4eb183aa5d4 = function(arg0, arg1, arg2, arg3) {
     console.debug(getObject(arg0), getObject(arg1), getObject(arg2), getObject(arg3));
-}, arguments) };
+};
 
-module.exports.__wbg_error_a7e23606158b68b9 = function() { return logError(function (arg0) {
+module.exports.__wbg_error_a7e23606158b68b9 = function(arg0) {
     console.error(getObject(arg0));
-}, arguments) };
+};
 
-module.exports.__wbg_error_50f42b952a595a23 = function() { return logError(function (arg0, arg1, arg2, arg3) {
+module.exports.__wbg_error_50f42b952a595a23 = function(arg0, arg1, arg2, arg3) {
     console.error(getObject(arg0), getObject(arg1), getObject(arg2), getObject(arg3));
-}, arguments) };
+};
 
-module.exports.__wbg_info_05db236d79f1b785 = function() { return logError(function (arg0) {
+module.exports.__wbg_info_05db236d79f1b785 = function(arg0) {
     console.info(getObject(arg0));
-}, arguments) };
+};
 
-module.exports.__wbg_info_24d8f53d98f12b95 = function() { return logError(function (arg0, arg1, arg2, arg3) {
+module.exports.__wbg_info_24d8f53d98f12b95 = function(arg0, arg1, arg2, arg3) {
     console.info(getObject(arg0), getObject(arg1), getObject(arg2), getObject(arg3));
-}, arguments) };
-
-module.exports.__wbg_log_dc06ec929fc95a20 = function() { return logError(function (arg0) {
-    console.log(getObject(arg0));
-}, arguments) };
-
-module.exports.__wbg_log_2f6947e39440ae3b = function() { return logError(function (arg0, arg1, arg2, arg3, arg4) {
-    console.log(getObject(arg0), getObject(arg1), getObject(arg2), getObject(arg3), getObject(arg4));
-}, arguments) };
+};
 
-module.exports.__wbg_warn_9bdd743e9f5fe1e0 = function() { return logError(function (arg0) {
+module.exports.__wbg_warn_9bdd743e9f5fe1e0 = function(arg0) {
     console.warn(getObject(arg0));
-}, arguments) };
+};
 
-module.exports.__wbg_warn_8342bfbc6028193a = function() { return logError(function (arg0, arg1, arg2, arg3) {
+module.exports.__wbg_warn_8342bfbc6028193a = function(arg0, arg1, arg2, arg3) {
     console.warn(getObject(arg0), getObject(arg1), getObject(arg2), getObject(arg3));
-}, arguments) };
+};
 
 module.exports.__wbindgen_string_get = function(arg0, arg1) {
     const obj = getObject(arg1);
@@ -647,7 +569,6 @@ module.exports.__wbg_stringify_d06ad2addc54d51e = function() { return handleErro
 
 module.exports.__wbg_set_07da13cc24b69217 = function() { return handleError(function (arg0, arg1, arg2) {
     const ret = Reflect.set(getObject(arg0), getObject(arg1), getObject(arg2));
-    _assertBoolean(ret);
     return ret;
 }, arguments) };
 
@@ -686,7 +607,10 @@ module.exports.__wasm = wasm;
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.inflateDebugSymbols = void 0;
 const pako_1 = __webpack_require__(/*! pako */ "../../node_modules/pako/index.js");
-/** Decompresses and decodes the debug symbols */
+/**
+ * Decompresses and decodes the debug symbols
+ * @param debugSymbols - The base64 encoded debug symbols
+ */
 function inflateDebugSymbols(debugSymbols) {
     return JSON.parse((0, pako_1.inflate)(Buffer.from(debugSymbols, 'base64'), { to: 'string', raw: true }));
 }
@@ -1143,8 +1067,9 @@ async function readdirRecursive(dir) {
 }
 exports.readdirRecursive = readdirRecursive;
 /**
- * Creates a new FileManager instance based on nodejs fs
- * @param dataDir - where to store files
+ * Creates a new FileManager instance based on fs in node and memfs in the browser (via webpack alias)
+ *
+ * @param dataDir - root of the file system
  */
 function createNodejsFileManager(dataDir) {
     return new file_manager_1.FileManager({
@@ -1393,7 +1318,7 @@ class Package {
      * Gets this package's dependencies.
      */
     getDependencies() {
-        return this.#config.dependencies;
+        return this.#config.dependencies ?? {};
     }
     /**
      * Gets this package's sources.
@@ -12818,6 +12743,36 @@ const nodejs_file_manager_1 = __webpack_require__(/*! ./noir/file-manager/nodejs
 const noir_wasm_compiler_1 = __webpack_require__(/*! ./noir/noir-wasm-compiler */ "./src/noir/noir-wasm-compiler.ts");
 const debug_1 = __webpack_require__(/*! ./noir/debug */ "./src/noir/debug.ts");
 Object.defineProperty(exports, "inflateDebugSymbols", ({ enumerable: true, get: function () { return debug_1.inflateDebugSymbols; } }));
+/**
+ * Compiles a Noir project
+ *
+ * @param fileManager - The file manager to use
+ * @param projectPath - The path to the project inside the file manager. Defaults to the root of the file manager
+ * @param logFn - A logging function. If not provided, console.log will be used
+ * @param debugLogFn - A debug logging function. If not provided, logFn will be used
+ *
+ * @example
+ * ```typescript
+ * // Node.js
+ *
+ * import { compile, createFileManager } from '@noir-lang/noir_wasm';
+ *
+ * const fm = createFileManager(myProjectPath);
+ * const myCompiledCode = await compile(fm);
+ * ```
+ *
+ * ```typescript
+ * // Browser
+ *
+ * import { compile, createFileManager } from '@noir-lang/noir_wasm';
+ *
+ * const fm = createFileManager('/');
+ * for (const path of files) {
+ *   await fm.writeFile(path, await getFileAsStream(path));
+ * }
+ * const myCompiledCode = await compile(fm);
+ * ```
+ */
 async function compile(fileManager, projectPath, logFn, debugLogFn) {
     if (logFn && !debugLogFn) {
         debugLogFn = logFn;