@noir-lang/noir_wasm 0.23.0-f466fa1.nightly → 0.24.0-10e8292.nightly

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

@@ -1,25 +1,25 @@
-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 compile_program_(entry_point: string, dependency_graph: DependencyGraph | undefined, file_source_map: PathToFileSourceMap): ProgramCompileResult;
+export function compile_contract_(entry_point: string, dependency_graph: DependencyGraph | undefined, file_source_map: PathToFileSourceMap): ContractCompileResult;
+export function compile_program(entry_point: string, dependency_graph: DependencyGraph | undefined, file_source_map: PathToFileSourceMap): ProgramCompileResult;
+export function compile_contract(entry_point: string, dependency_graph: DependencyGraph | undefined, file_source_map: PathToFileSourceMap): ContractCompileResult;
+export function init_log_level(level: string): void;
 export function build_info(): any;
 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_05d6d198f3477d6f(): number;
+export function __wbg_constructor_e8767839abf8a966(arg0: any): 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;
@@ -72,14 +72,14 @@ export class CompilerContext {
     add_dependency_edge(crate_name: string, from: CrateId, to: CrateId): void;
     /**
     * @param {number} program_width
-    * @returns {CompileResult}
+    * @returns {ProgramCompileResult}
     */
-    compile_program(program_width: number): CompileResult;
+    compile_program(program_width: number): ProgramCompileResult;
     /**
     * @param {number} program_width
-    * @returns {CompileResult}
+    * @returns {ContractCompileResult}
     */
-    compile_contract(program_width: number): CompileResult;
+    compile_contract(program_width: number): ContractCompileResult;
 }
 /**
 */

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

@@ -1,25 +1,39 @@
 /**
+* 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}
+* @returns {ProgramCompileResult}
 */
-export function compile(entry_point: string, contracts: boolean | undefined, dependency_graph: DependencyGraph | undefined, file_source_map: PathToFileSourceMap): CompileResult;
+export function compile_program_(entry_point: string, dependency_graph: DependencyGraph | undefined, file_source_map: PathToFileSourceMap): ProgramCompileResult;
 /**
 * 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}
+* @returns {ContractCompileResult}
+*/
+export function compile_contract_(entry_point: string, dependency_graph: DependencyGraph | undefined, file_source_map: PathToFileSourceMap): ContractCompileResult;
+/**
+* @param {string} entry_point
+* @param {DependencyGraph | undefined} dependency_graph
+* @param {PathToFileSourceMap} file_source_map
+* @returns {ProgramCompileResult}
+*/
+export function compile_program(entry_point: string, dependency_graph: DependencyGraph | undefined, file_source_map: PathToFileSourceMap): ProgramCompileResult;
+/**
+* @param {string} entry_point
+* @param {DependencyGraph | undefined} dependency_graph
+* @param {PathToFileSourceMap} file_source_map
+* @returns {ContractCompileResult}
 */
-export function compile_(entry_point: string, contracts: boolean | undefined, dependency_graph: DependencyGraph | undefined, file_source_map: PathToFileSourceMap): CompileResult;
+export function compile_contract(entry_point: string, dependency_graph: DependencyGraph | undefined, file_source_map: PathToFileSourceMap): ContractCompileResult;
 /**
-* @param {string} filter
+* @param {string} level
 */
-export function init_log_level(filter: string): void;
+export function init_log_level(level: string): void;
 /**
 * @returns {any}
 */
@@ -56,14 +70,14 @@ export class CompilerContext {
     add_dependency_edge(crate_name: string, from: CrateId, to: CrateId): void;
     /**
     * @param {number} program_width
-    * @returns {CompileResult}
+    * @returns {ProgramCompileResult}
     */
-    compile_program(program_width: number): CompileResult;
+    compile_program(program_width: number): ProgramCompileResult;
     /**
     * @param {number} program_width
-    * @returns {CompileResult}
+    * @returns {ContractCompileResult}
     */
-    compile_contract(program_width: number): CompileResult;
+    compile_contract(program_width: number): ContractCompileResult;
 }
 /**
 */

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

@@ -1,8 +1,69 @@
 import { FileManager } from './noir/file-manager/file-manager';
 import { createNodejsFileManager } from './noir/file-manager/nodejs-file-manager';
 import { LogFn } from './utils';
-import { CompilationResult } from './types/noir_artifact';
+import { ContractCompilationArtifacts, ProgramCompilationArtifacts } from './types/noir_artifact';
 import { inflateDebugSymbols } from './noir/debug';
-declare function compile(fileManager: FileManager, projectPath?: string, logFn?: LogFn, debugLogFn?: LogFn): Promise<CompilationResult>;
+/**
+ * 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_program, createFileManager } from '@noir-lang/noir_wasm';
+ *
+ * const fm = createFileManager(myProjectPath);
+ * const myCompiledCode = await compile_program(fm);
+ * ```
+ *
+ * ```typescript
+ * // Browser
+ *
+ * import { compile_program, 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_program(fm);
+ * ```
+ */
+declare function compile_program(fileManager: FileManager, projectPath?: string, logFn?: LogFn, debugLogFn?: LogFn): Promise<ProgramCompilationArtifacts>;
+/**
+ * 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_contract, createFileManager } from '@noir-lang/noir_wasm';
+ *
+ * const fm = createFileManager(myProjectPath);
+ * const myCompiledCode = await compile_contract(fm);
+ * ```
+ *
+ * ```typescript
+ * // Browser
+ *
+ * import { compile_contract, 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_contract(fm);
+ * ```
+ */
+declare function compile_contract(fileManager: FileManager, projectPath?: string, logFn?: LogFn, debugLogFn?: LogFn): Promise<ContractCompilationArtifacts>;
 declare const createFileManager: typeof createNodejsFileManager;
-export { compile, createFileManager, inflateDebugSymbols, CompilationResult };
+export { compile_program as compile, compile_program, compile_contract, createFileManager, inflateDebugSymbols, ProgramCompilationArtifacts, ContractCompilationArtifacts, };

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

@@ -1,8 +1,69 @@
 import { FileManager } from './noir/file-manager/file-manager';
 import { createNodejsFileManager } from './noir/file-manager/nodejs-file-manager';
 import { LogFn } from './utils';
-import { CompilationResult } from './types/noir_artifact';
+import { ContractCompilationArtifacts, ProgramCompilationArtifacts } from './types/noir_artifact';
 import { inflateDebugSymbols } from './noir/debug';
-declare function compile(fileManager: FileManager, projectPath?: string, logFn?: LogFn, debugLogFn?: LogFn): Promise<CompilationResult>;
+/**
+ * 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_program, createFileManager } from '@noir-lang/noir_wasm';
+ *
+ * const fm = createFileManager(myProjectPath);
+ * const myCompiledCode = await compile_program(fm);
+ * ```
+ *
+ * ```typescript
+ * // Browser
+ *
+ * import { compile_program, 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_program(fm);
+ * ```
+ */
+declare function compile_program(fileManager: FileManager, projectPath?: string, logFn?: LogFn, debugLogFn?: LogFn): Promise<ProgramCompilationArtifacts>;
+/**
+ * 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_contract, createFileManager } from '@noir-lang/noir_wasm';
+ *
+ * const fm = createFileManager(myProjectPath);
+ * const myCompiledCode = await compile_contract(fm);
+ * ```
+ *
+ * ```typescript
+ * // Browser
+ *
+ * import { compile_contract, 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_contract(fm);
+ * ```
+ */
+declare function compile_contract(fileManager: FileManager, projectPath?: string, logFn?: LogFn, debugLogFn?: LogFn): Promise<ContractCompilationArtifacts>;
 declare const createFileManager: typeof createNodejsFileManager;
-export { compile, createFileManager, inflateDebugSymbols, CompilationResult };
+export { compile_program as compile, compile_program, compile_contract, createFileManager, inflateDebugSymbols, ProgramCompilationArtifacts, ContractCompilationArtifacts, };

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/noir-wasm-compiler.d.ts

@@ -1,6 +1,6 @@
 import { FileManager } from './file-manager/file-manager';
 import { LogFn } from '../utils';
-import { CompilationResult } from '../types/noir_artifact';
+import { ContractCompilationArtifacts, ProgramCompilationArtifacts } from '../types/noir_artifact';
 /** Compilation options */
 export type NoirWasmCompileOptions = {
     /** Logging function */
@@ -24,8 +24,9 @@ export declare class NoirWasmCompiler {
     /**
      * Compile EntryPoint
      */
+    compile_program(): Promise<ProgramCompilationArtifacts>;
     /**
      * Compile EntryPoint
      */
-    compile(): Promise<CompilationResult>;
+    compile_contract(): Promise<ContractCompilationArtifacts>;
 }

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. */
@@ -159,15 +161,3 @@ export interface ProgramCompilationArtifacts {
     /** Compilation warnings. */
     warnings: Warning[];
 }
-/**
- * output of Noir Wasm compilation, can be for a contract or lib/binary
- */
-export type CompilationResult = ContractCompilationArtifacts | ProgramCompilationArtifacts;
-/**
- * Check if it has Contract unique property
- */
-export declare function isContractCompilationArtifacts(artifact: CompilationResult): artifact is ContractCompilationArtifacts;
-/**
- * Check if it has Contract unique property
- */
-export declare function isProgramCompilationArtifacts(artifact: CompilationResult): artifact is ProgramCompilationArtifacts;

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;