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

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

@@ -1,11 +1,13 @@
-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;
+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 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 __wbindgen_is_undefined(arg0: any): boolean;
-export function __wbg_constructor_e8767839abf8a966(arg0: any): number;
 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;
@@ -70,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

@@ -2,28 +2,42 @@
 * 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;
 /**
-* @param {string} level
+* This is a method that exposes the same API as `compile`
+* But uses the Context based APi internally
+* @param {string} entry_point
+* @param {DependencyGraph | undefined} dependency_graph
+* @param {PathToFileSourceMap} file_source_map
+* @returns {ContractCompileResult}
 */
-export function init_log_level(level: string): void;
+export function compile_contract_(entry_point: string, dependency_graph: DependencyGraph | undefined, file_source_map: PathToFileSourceMap): ContractCompileResult;
 /**
-* @returns {any}
+* @param {string} entry_point
+* @param {DependencyGraph | undefined} dependency_graph
+* @param {PathToFileSourceMap} file_source_map
+* @returns {ProgramCompileResult}
 */
-export function build_info(): any;
+export function compile_program(entry_point: string, dependency_graph: DependencyGraph | undefined, file_source_map: PathToFileSourceMap): ProgramCompileResult;
 /**
 * @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} level
 */
-export function compile(entry_point: string, contracts: boolean | undefined, dependency_graph: DependencyGraph | undefined, file_source_map: PathToFileSourceMap): CompileResult;
+export function init_log_level(level: string): void;
+/**
+* @returns {any}
+*/
+export function build_info(): any;
 /**
 * This is a wrapper class that is wasm-bindgen compatible
 * We do not use js_name and rename it like CrateId because
@@ -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,7 +1,7 @@
 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';
 /**
  * Compiles a Noir project
@@ -15,24 +15,55 @@ import { inflateDebugSymbols } from './noir/debug';
  * ```typescript
  * // Node.js
  *
- * import { compile, createFileManager } from '@noir-lang/noir_wasm';
+ * import { compile_program, createFileManager } from '@noir-lang/noir_wasm';
  *
  * const fm = createFileManager(myProjectPath);
- * const myCompiledCode = await compile(fm);
+ * const myCompiledCode = await compile_program(fm);
  * ```
  *
  * ```typescript
  * // Browser
  *
- * import { compile, createFileManager } from '@noir-lang/noir_wasm';
+ * 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(fm);
+ * const myCompiledCode = await compile_program(fm);
  * ```
  */
-declare function compile(fileManager: FileManager, projectPath?: string, logFn?: LogFn, debugLogFn?: LogFn): Promise<CompilationResult>;
+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,7 +1,7 @@
 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';
 /**
  * Compiles a Noir project
@@ -15,24 +15,55 @@ import { inflateDebugSymbols } from './noir/debug';
  * ```typescript
  * // Node.js
  *
- * import { compile, createFileManager } from '@noir-lang/noir_wasm';
+ * import { compile_program, createFileManager } from '@noir-lang/noir_wasm';
  *
  * const fm = createFileManager(myProjectPath);
- * const myCompiledCode = await compile(fm);
+ * const myCompiledCode = await compile_program(fm);
  * ```
  *
  * ```typescript
  * // Browser
  *
- * import { compile, createFileManager } from '@noir-lang/noir_wasm';
+ * 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(fm);
+ * const myCompiledCode = await compile_program(fm);
  * ```
  */
-declare function compile(fileManager: FileManager, projectPath?: string, logFn?: LogFn, debugLogFn?: LogFn): Promise<CompilationResult>;
+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/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/types/noir_artifact.d.ts

@@ -161,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;