@noir-lang/noir_wasm 0.23.0 → 0.24.0-3386067.nightly

package/dist/types/build/cjs/index.d.ts

@@ -1,25 +1,23 @@
-export function compile(entry_point: string, contracts: boolean | undefined, dependency_graph: DependencyGraph | undefined, file_source_map: PathToFileSourceMap): CompileResult;
 export function compile_(entry_point: string, contracts: boolean | undefined, dependency_graph: DependencyGraph | undefined, file_source_map: PathToFileSourceMap): CompileResult;
-export function init_log_level(filter: string): void;
+export function init_log_level(level: string): void;
 export function build_info(): any;
+export function compile(entry_point: string, contracts: boolean | undefined, dependency_graph: DependencyGraph | undefined, file_source_map: PathToFileSourceMap): CompileResult;
 export function __wbindgen_object_drop_ref(arg0: any): void;
-export function __wbg_constructor_28ca684b2f9696ac(...args: any[]): any;
 export function __wbindgen_is_undefined(arg0: any): boolean;
-export function __wbg_constructor_287b714b768ecf13(...args: any[]): any;
-export function __wbg_new_abda76e883ba8a5f(...args: any[]): any;
-export function __wbg_stack_658279fe44541cf6(...args: any[]): any;
-export function __wbg_error_f851667af71bcfc6(...args: any[]): any;
+export function __wbg_constructor_e8767839abf8a966(arg0: any): number;
+export function __wbg_constructor_05d6d198f3477d6f(): number;
+export function __wbg_new_abda76e883ba8a5f(): number;
+export function __wbg_stack_658279fe44541cf6(arg0: any, arg1: any): void;
+export function __wbg_error_f851667af71bcfc6(arg0: any, arg1: any): void;
 export function __wbindgen_string_new(arg0: any, arg1: any): number;
-export function __wbg_debug_e3f6a1578e6d45ca(...args: any[]): any;
-export function __wbg_debug_efabe4eb183aa5d4(...args: any[]): any;
-export function __wbg_error_a7e23606158b68b9(...args: any[]): any;
-export function __wbg_error_50f42b952a595a23(...args: any[]): any;
-export function __wbg_info_05db236d79f1b785(...args: any[]): any;
-export function __wbg_info_24d8f53d98f12b95(...args: any[]): any;
-export function __wbg_log_dc06ec929fc95a20(...args: any[]): any;
-export function __wbg_log_2f6947e39440ae3b(...args: any[]): any;
-export function __wbg_warn_9bdd743e9f5fe1e0(...args: any[]): any;
-export function __wbg_warn_8342bfbc6028193a(...args: any[]): any;
+export function __wbg_debug_e3f6a1578e6d45ca(arg0: any): void;
+export function __wbg_debug_efabe4eb183aa5d4(arg0: any, arg1: any, arg2: any, arg3: any): void;
+export function __wbg_error_a7e23606158b68b9(arg0: any): void;
+export function __wbg_error_50f42b952a595a23(arg0: any, arg1: any, arg2: any, arg3: any): void;
+export function __wbg_info_05db236d79f1b785(arg0: any): void;
+export function __wbg_info_24d8f53d98f12b95(arg0: any, arg1: any, arg2: any, arg3: any): void;
+export function __wbg_warn_9bdd743e9f5fe1e0(arg0: any): void;
+export function __wbg_warn_8342bfbc6028193a(arg0: any, arg1: any, arg2: any, arg3: any): void;
 export function __wbindgen_string_get(arg0: any, arg1: any): void;
 export function __wbg_parse_76a8a18ca3f8730b(...args: any[]): any;
 export function __wbg_stringify_d06ad2addc54d51e(...args: any[]): any;

package/dist/types/build/esm/index.d.ts

@@ -1,12 +1,4 @@
 /**
-* @param {string} entry_point
-* @param {boolean | undefined} contracts
-* @param {DependencyGraph | undefined} dependency_graph
-* @param {PathToFileSourceMap} file_source_map
-* @returns {CompileResult}
-*/
-export function compile(entry_point: string, contracts: boolean | undefined, dependency_graph: DependencyGraph | undefined, file_source_map: PathToFileSourceMap): CompileResult;
-/**
 * This is a method that exposes the same API as `compile`
 * But uses the Context based APi internally
 * @param {string} entry_point
@@ -17,14 +9,22 @@ export function compile(entry_point: string, contracts: boolean | undefined, dep
 */
 export function compile_(entry_point: string, contracts: boolean | undefined, dependency_graph: DependencyGraph | undefined, file_source_map: PathToFileSourceMap): CompileResult;
 /**
-* @param {string} filter
+* @param {string} level
 */
-export function init_log_level(filter: string): void;
+export function init_log_level(level: string): void;
 /**
 * @returns {any}
 */
 export function build_info(): any;
 /**
+* @param {string} entry_point
+* @param {boolean | undefined} contracts
+* @param {DependencyGraph | undefined} dependency_graph
+* @param {PathToFileSourceMap} file_source_map
+* @returns {CompileResult}
+*/
+export function compile(entry_point: string, contracts: boolean | undefined, dependency_graph: DependencyGraph | undefined, file_source_map: PathToFileSourceMap): CompileResult;
+/**
 * This is a wrapper class that is wasm-bindgen compatible
 * We do not use js_name and rename it like CrateId because
 * then the impl block is not picked up in javascript.

package/dist/types/src/index.d.cts

@@ -3,6 +3,36 @@ import { createNodejsFileManager } from './noir/file-manager/nodejs-file-manager
 import { LogFn } from './utils';
 import { CompilationResult } from './types/noir_artifact';
 import { inflateDebugSymbols } from './noir/debug';
+/**
+ * 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);
+ * ```
+ */
 declare function compile(fileManager: FileManager, projectPath?: string, logFn?: LogFn, debugLogFn?: LogFn): Promise<CompilationResult>;
 declare const createFileManager: typeof createNodejsFileManager;
 export { compile, createFileManager, inflateDebugSymbols, CompilationResult };

package/dist/types/src/index.d.mts

@@ -3,6 +3,36 @@ import { createNodejsFileManager } from './noir/file-manager/nodejs-file-manager
 import { LogFn } from './utils';
 import { CompilationResult } from './types/noir_artifact';
 import { inflateDebugSymbols } from './noir/debug';
+/**
+ * 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);
+ * ```
+ */
 declare function compile(fileManager: FileManager, projectPath?: string, logFn?: LogFn, debugLogFn?: LogFn): Promise<CompilationResult>;
 declare const createFileManager: typeof createNodejsFileManager;
 export { compile, createFileManager, inflateDebugSymbols, CompilationResult };

package/dist/types/src/noir/debug.d.ts

@@ -1,2 +1,5 @@
-/** Decompresses and decodes the debug symbols */
+/**
+ * Decompresses and decodes the debug symbols
+ * @param debugSymbols - The base64 encoded debug symbols
+ */
 export declare function inflateDebugSymbols(debugSymbols: string): any;

package/dist/types/src/noir/file-manager/nodejs-file-manager.d.ts

@@ -1,7 +1,8 @@
 import { FileManager } from './file-manager';
 export declare function readdirRecursive(dir: string): Promise<string[]>;
 /**
- * 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
  */
 export declare function createNodejsFileManager(dataDir: string): FileManager;

package/dist/types/src/noir/package.d.ts

@@ -40,13 +40,13 @@ export declare class Package {
             backend?: string | undefined;
             license?: string | undefined;
         };
-        dependencies: Record<string, {
+        dependencies?: Record<string, {
             git: string;
             tag: string;
             directory?: string | undefined;
         } | {
             path: string;
-        }>;
+        }> | undefined;
     };
     /**
      * The path to the source directory.

package/dist/types/src/types/noir_artifact.d.ts

@@ -1,4 +1,4 @@
-import { Abi, AbiType } from '@noir-lang/noirc_abi';
+import { Abi, AbiType } from '@noir-lang/types';
 /**
  * A named type.
  */
@@ -67,6 +67,8 @@ export interface ContractArtifact {
  * The compilation result of an Noir contract.
  */
 export interface ProgramArtifact {
+    /** Version of noir used for the build. */
+    noir_version: string;
     /** The hash of the circuit. */
     hash?: number;
     /** * The ABI of the function. */

package/dist/types/src/types/noir_package_config.d.ts

@@ -18,7 +18,7 @@ type NoirPackageConfigSchema = {
         backend?: string;
         license?: string;
     };
-    dependencies: Record<string, GitDependencyConfig | LocalDependencyConfig>;
+    dependencies?: Record<string, GitDependencyConfig | LocalDependencyConfig>;
 };
 /**
  * Noir package configuration.

package/dist/types/webpack.config.d.ts

@@ -1,4 +1,3 @@
 import webpack from 'webpack';
-import 'webpack-dev-server';
 declare const _default: webpack.Configuration[];
 export default _default;