@noir-lang/noir_js 0.16.0 → 0.17.0

package/lib/index.cjs

@@ -23,15 +23,10 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Noir = exports.witnessMapToUint8Array = exports.acirToUint8Array = exports.generateWitness = exports.abi = exports.acvm = void 0;
+exports.Noir = exports.abi = exports.acvm = void 0;
 const acvm = __importStar(require("@noir-lang/acvm_js"));
 exports.acvm = acvm;
 const abi = __importStar(require("@noir-lang/noirc_abi"));
 exports.abi = abi;
-var witness_generation_js_1 = require("./witness_generation.cjs");
-Object.defineProperty(exports, "generateWitness", { enumerable: true, get: function () { return witness_generation_js_1.generateWitness; } });
-var serialize_js_1 = require("./serialize.cjs");
-Object.defineProperty(exports, "acirToUint8Array", { enumerable: true, get: function () { return serialize_js_1.acirToUint8Array; } });
-Object.defineProperty(exports, "witnessMapToUint8Array", { enumerable: true, get: function () { return serialize_js_1.witnessMapToUint8Array; } });
 var program_js_1 = require("./program.cjs");
 Object.defineProperty(exports, "Noir", { enumerable: true, get: function () { return program_js_1.Noir; } });

package/lib/index.d.ts

@@ -1,6 +1,5 @@
 import * as acvm from '@noir-lang/acvm_js';
 import * as abi from '@noir-lang/noirc_abi';
 export { acvm, abi };
-export { generateWitness } from './witness_generation.js';
-export { acirToUint8Array, witnessMapToUint8Array } from './serialize.js';
+export { WitnessMap } from '@noir-lang/acvm_js';
 export { Noir } from './program.js';

package/lib/index.mjs

@@ -1,6 +1,4 @@
 import * as acvm from '@noir-lang/acvm_js';
 import * as abi from '@noir-lang/noirc_abi';
 export { acvm, abi };
-export { generateWitness } from "./witness_generation.mjs";
-export { acirToUint8Array, witnessMapToUint8Array } from "./serialize.mjs";
 export { Noir } from "./program.mjs";

package/lib/program.cjs

@@ -1,12 +1,32 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Noir = void 0;
 const witness_generation_js_1 = require("./witness_generation.cjs");
-const noirc_abi_1 = __importDefault(require("@noir-lang/noirc_abi"));
-const acvm_js_1 = __importDefault(require("@noir-lang/acvm_js"));
+const noirc_abi_1 = __importStar(require("@noir-lang/noirc_abi"));
+const acvm_js_1 = __importStar(require("@noir-lang/acvm_js"));
 class Noir {
     circuit;
     backend;
@@ -22,14 +42,28 @@ class Noir {
             await Promise.all([(0, noirc_abi_1.default)(), (0, acvm_js_1.default)()]);
         }
     }
+    async destroy() {
+        await this.backend?.destroy();
+    }
+    getBackend() {
+        if (this.backend === undefined)
+            throw new Error('Operation requires a backend but none was provided');
+        return this.backend;
+    }
     // Initial inputs to your program
-    async generateFinalProof(inputs) {
+    async execute(inputs) {
         await this.init();
-        const serializedWitness = await (0, witness_generation_js_1.generateWitness)(this.circuit, inputs);
-        return this.backend.generateFinalProof(serializedWitness);
+        const witness = await (0, witness_generation_js_1.generateWitness)(this.circuit, inputs);
+        const { return_value: returnValue } = (0, noirc_abi_1.abiDecode)(this.circuit.abi, witness);
+        return { witness: (0, acvm_js_1.compressWitness)(witness), returnValue };
+    }
+    // Initial inputs to your program
+    async generateFinalProof(inputs) {
+        const { witness } = await this.execute(inputs);
+        return this.getBackend().generateFinalProof(witness);
     }
-    async verifyFinalProof(proof) {
-        return this.backend.verifyFinalProof(proof);
+    async verifyFinalProof(proofData) {
+        return this.getBackend().verifyFinalProof(proofData);
     }
 }
 exports.Noir = Noir;

package/lib/program.d.ts

@@ -1,9 +1,16 @@
-import { Backend, CompiledCircuit } from '@noir-lang/types';
+import { Backend, CompiledCircuit, ProofData } from '@noir-lang/types';
+import { InputMap, InputValue } from '@noir-lang/noirc_abi';
 export declare class Noir {
     private circuit;
-    private backend;
-    constructor(circuit: CompiledCircuit, backend: Backend);
+    private backend?;
+    constructor(circuit: CompiledCircuit, backend?: Backend | undefined);
     init(): Promise<void>;
-    generateFinalProof(inputs: any): Promise<Uint8Array>;
-    verifyFinalProof(proof: Uint8Array): Promise<boolean>;
+    destroy(): Promise<void>;
+    private getBackend;
+    execute(inputs: InputMap): Promise<{
+        witness: Uint8Array;
+        returnValue: InputValue;
+    }>;
+    generateFinalProof(inputs: InputMap): Promise<ProofData>;
+    verifyFinalProof(proofData: ProofData): Promise<boolean>;
 }

package/lib/program.mjs

@@ -1,6 +1,6 @@
 import { generateWitness } from "./witness_generation.mjs";
-import initAbi from '@noir-lang/noirc_abi';
-import initACVM from '@noir-lang/acvm_js';
+import initAbi, { abiDecode } from '@noir-lang/noirc_abi';
+import initACVM, { compressWitness } from '@noir-lang/acvm_js';
 export class Noir {
     circuit;
     backend;
@@ -16,13 +16,27 @@ export class Noir {
             await Promise.all([initAbi(), initACVM()]);
         }
     }
+    async destroy() {
+        await this.backend?.destroy();
+    }
+    getBackend() {
+        if (this.backend === undefined)
+            throw new Error('Operation requires a backend but none was provided');
+        return this.backend;
+    }
     // Initial inputs to your program
-    async generateFinalProof(inputs) {
+    async execute(inputs) {
         await this.init();
-        const serializedWitness = await generateWitness(this.circuit, inputs);
-        return this.backend.generateFinalProof(serializedWitness);
+        const witness = await generateWitness(this.circuit, inputs);
+        const { return_value: returnValue } = abiDecode(this.circuit.abi, witness);
+        return { witness: compressWitness(witness), returnValue };
+    }
+    // Initial inputs to your program
+    async generateFinalProof(inputs) {
+        const { witness } = await this.execute(inputs);
+        return this.getBackend().generateFinalProof(witness);
     }
-    async verifyFinalProof(proof) {
-        return this.backend.verifyFinalProof(proof);
+    async verifyFinalProof(proofData) {
+        return this.getBackend().verifyFinalProof(proofData);
     }
 }

package/lib/witness_generation.cjs

@@ -4,18 +4,17 @@ exports.generateWitness = void 0;
 const noirc_abi_1 = require("@noir-lang/noirc_abi");
 const base64_decode_js_1 = require("./base64_decode.cjs");
 const acvm_js_1 = require("@noir-lang/acvm_js");
-const serialize_js_1 = require("./serialize.cjs");
 // Generates the witnesses needed to feed into the chosen proving system
 async function generateWitness(compiledProgram, inputs) {
     // Throws on ABI encoding error
-    const witnessMap = (0, noirc_abi_1.abiEncode)(compiledProgram.abi, inputs, null);
+    const witnessMap = (0, noirc_abi_1.abiEncode)(compiledProgram.abi, inputs);
     // Execute the circuit to generate the rest of the witnesses and serialize
     // them into a Uint8Array.
     try {
         const solvedWitness = await (0, acvm_js_1.executeCircuit)((0, base64_decode_js_1.base64Decode)(compiledProgram.bytecode), witnessMap, () => {
             throw Error('unexpected oracle during execution');
         });
-        return (0, serialize_js_1.witnessMapToUint8Array)(solvedWitness);
+        return solvedWitness;
     }
     catch (err) {
         throw new Error(`Circuit execution failed: ${err}`);

package/lib/witness_generation.d.ts

@@ -1,2 +1,4 @@
+import { InputMap } from '@noir-lang/noirc_abi';
+import { WitnessMap } from '@noir-lang/acvm_js';
 import { CompiledCircuit } from '@noir-lang/types';
-export declare function generateWitness(compiledProgram: CompiledCircuit, inputs: unknown): Promise<Uint8Array>;
+export declare function generateWitness(compiledProgram: CompiledCircuit, inputs: InputMap): Promise<WitnessMap>;

package/lib/witness_generation.mjs

@@ -1,18 +1,17 @@
 import { abiEncode } from '@noir-lang/noirc_abi';
 import { base64Decode } from "./base64_decode.mjs";
 import { executeCircuit } from '@noir-lang/acvm_js';
-import { witnessMapToUint8Array } from "./serialize.mjs";
 // Generates the witnesses needed to feed into the chosen proving system
 export async function generateWitness(compiledProgram, inputs) {
     // Throws on ABI encoding error
-    const witnessMap = abiEncode(compiledProgram.abi, inputs, null);
+    const witnessMap = abiEncode(compiledProgram.abi, inputs);
     // Execute the circuit to generate the rest of the witnesses and serialize
     // them into a Uint8Array.
     try {
         const solvedWitness = await executeCircuit(base64Decode(compiledProgram.bytecode), witnessMap, () => {
             throw Error('unexpected oracle during execution');
         });
-        return witnessMapToUint8Array(solvedWitness);
+        return solvedWitness;
     }
     catch (err) {
         throw new Error(`Circuit execution failed: ${err}`);

package/package.json

@@ -3,15 +3,14 @@
   "collaborators": [
     "The Noir Team <team@noir-lang.org>"
   ],
-  "version": "0.16.0",
+  "version": "0.17.0",
   "packageManager": "yarn@3.5.1",
   "license": "(MIT OR Apache-2.0)",
   "type": "module",
   "dependencies": {
-    "@noir-lang/acvm_js": "0.28.0",
-    "@noir-lang/noirc_abi": "0.16.0",
-    "@noir-lang/types": "0.14.1",
-    "fflate": "^0.8.0"
+    "@noir-lang/acvm_js": "0.29.0",
+    "@noir-lang/noirc_abi": "0.17.0",
+    "@noir-lang/types": "0.17.0"
   },
   "files": [
     "lib",
@@ -35,11 +34,11 @@
     "prettier": "prettier 'src/**/*.ts'",
     "prettier:fix": "prettier --write 'src/**/*.ts' 'test/**/*.ts'",
     "lint": "NODE_NO_WARNINGS=1 eslint . --ext .ts --ignore-path ./.eslintignore  --max-warnings 0",
-    "publish": "yarn npm publish",
+    "nightly:version": "jq --arg new_version \"-$(git rev-parse --short HEAD)$1\" '.version = .version + $new_version' package.json > package-tmp.json && mv package-tmp.json package.json",
+    "publish": "echo 📡 publishing `$npm_package_name` && yarn npm publish",
     "clean": "rm -rf ./lib"
   },
   "devDependencies": {
-    "@aztec/bb.js": "0.7.2",
     "@types/chai": "^4",
     "@types/mocha": "^10.0.1",
     "@types/node": "^20.6.2",

package/lib/serialize.cjs

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.acirToUint8Array = exports.witnessMapToUint8Array = void 0;
-const acvm_js_1 = require("@noir-lang/acvm_js");
-const fflate_1 = require("fflate");
-const base64_decode_js_1 = require("./base64_decode.cjs");
-// After solving the witness, to pass it a backend, we need to serialize it to a Uint8Array
-function witnessMapToUint8Array(solvedWitness) {
-    // TODO: We just want to serialize, but this will zip up the witness
-    // TODO so its not ideal
-    const compressedWitness = (0, acvm_js_1.compressWitness)(solvedWitness);
-    return (0, fflate_1.decompressSync)(compressedWitness);
-}
-exports.witnessMapToUint8Array = witnessMapToUint8Array;
-// Converts an bytecode to a Uint8Array
-function acirToUint8Array(base64EncodedBytecode) {
-    const compressedByteCode = (0, base64_decode_js_1.base64Decode)(base64EncodedBytecode);
-    return (0, fflate_1.decompressSync)(compressedByteCode);
-}
-exports.acirToUint8Array = acirToUint8Array;

package/lib/serialize.d.ts

@@ -1,3 +0,0 @@
-import { WitnessMap } from '@noir-lang/acvm_js';
-export declare function witnessMapToUint8Array(solvedWitness: WitnessMap): Uint8Array;
-export declare function acirToUint8Array(base64EncodedBytecode: any): Uint8Array;

package/lib/serialize.mjs

@@ -1,15 +0,0 @@
-import { compressWitness } from '@noir-lang/acvm_js';
-import { decompressSync as gunzip } from 'fflate';
-import { base64Decode } from "./base64_decode.mjs";
-// After solving the witness, to pass it a backend, we need to serialize it to a Uint8Array
-export function witnessMapToUint8Array(solvedWitness) {
-    // TODO: We just want to serialize, but this will zip up the witness
-    // TODO so its not ideal
-    const compressedWitness = compressWitness(solvedWitness);
-    return gunzip(compressedWitness);
-}
-// Converts an bytecode to a Uint8Array
-export function acirToUint8Array(base64EncodedBytecode) {
-    const compressedByteCode = base64Decode(base64EncodedBytecode);
-    return gunzip(compressedByteCode);
-}