@noir-lang/noir_js 0.12.0 → 0.16.0

package/lib/base64_decode.cjs

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.base64Decode = void 0;
+// Since this is a simple function, we can use feature detection to
+// see if we are in the nodeJs environment or the browser environment.
+function base64Decode(input) {
+    if (typeof Buffer !== 'undefined') {
+        // Node.js environment
+        return Buffer.from(input, 'base64');
+    }
+    else if (typeof atob === 'function') {
+        // Browser environment
+        return Uint8Array.from(atob(input), (c) => c.charCodeAt(0));
+    }
+    else {
+        throw new Error('No implementation found for base64 decoding.');
+    }
+}
+exports.base64Decode = base64Decode;

package/lib/base64_decode.d.ts

@@ -0,0 +1 @@
+export declare function base64Decode(input: string): Uint8Array;

package/lib/base64_decode.mjs

@@ -0,0 +1,15 @@
+// Since this is a simple function, we can use feature detection to
+// see if we are in the nodeJs environment or the browser environment.
+export function base64Decode(input) {
+    if (typeof Buffer !== 'undefined') {
+        // Node.js environment
+        return Buffer.from(input, 'base64');
+    }
+    else if (typeof atob === 'function') {
+        // Browser environment
+        return Uint8Array.from(atob(input), (c) => c.charCodeAt(0));
+    }
+    else {
+        throw new Error('No implementation found for base64 decoding.');
+    }
+}

package/lib/index.cjs

@@ -0,0 +1,37 @@
+"use strict";
+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 = exports.witnessMapToUint8Array = exports.acirToUint8Array = exports.generateWitness = 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,3 +1,6 @@
-import * as acvm from "@noir-lang/acvm_js";
-import * as noirc from "@noir-lang/noirc_abi";
-export { acvm, noirc };
+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 { Noir } from './program.js';

package/lib/index.mjs

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+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"));
+class Noir {
+    circuit;
+    backend;
+    constructor(circuit, backend) {
+        this.circuit = circuit;
+        this.backend = backend;
+    }
+    async init() {
+        // If these are available, then we are in the
+        // web environment. For the node environment, this
+        // is a no-op.
+        if (typeof noirc_abi_1.default === 'function') {
+            await Promise.all([(0, noirc_abi_1.default)(), (0, acvm_js_1.default)()]);
+        }
+    }
+    // Initial inputs to your program
+    async generateFinalProof(inputs) {
+        await this.init();
+        const serializedWitness = await (0, witness_generation_js_1.generateWitness)(this.circuit, inputs);
+        return this.backend.generateFinalProof(serializedWitness);
+    }
+    async verifyFinalProof(proof) {
+        return this.backend.verifyFinalProof(proof);
+    }
+}
+exports.Noir = Noir;

package/lib/program.d.ts

@@ -0,0 +1,9 @@
+import { Backend, CompiledCircuit } from '@noir-lang/types';
+export declare class Noir {
+    private circuit;
+    private backend;
+    constructor(circuit: CompiledCircuit, backend: Backend);
+    init(): Promise<void>;
+    generateFinalProof(inputs: any): Promise<Uint8Array>;
+    verifyFinalProof(proof: Uint8Array): Promise<boolean>;
+}

package/lib/program.mjs

@@ -0,0 +1,28 @@
+import { generateWitness } from "./witness_generation.mjs";
+import initAbi from '@noir-lang/noirc_abi';
+import initACVM from '@noir-lang/acvm_js';
+export class Noir {
+    circuit;
+    backend;
+    constructor(circuit, backend) {
+        this.circuit = circuit;
+        this.backend = backend;
+    }
+    async init() {
+        // If these are available, then we are in the
+        // web environment. For the node environment, this
+        // is a no-op.
+        if (typeof initAbi === 'function') {
+            await Promise.all([initAbi(), initACVM()]);
+        }
+    }
+    // Initial inputs to your program
+    async generateFinalProof(inputs) {
+        await this.init();
+        const serializedWitness = await generateWitness(this.circuit, inputs);
+        return this.backend.generateFinalProof(serializedWitness);
+    }
+    async verifyFinalProof(proof) {
+        return this.backend.verifyFinalProof(proof);
+    }
+}

package/lib/serialize.cjs

@@ -0,0 +1,20 @@
+"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

@@ -0,0 +1,3 @@
+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

@@ -0,0 +1,15 @@
+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);
+}

package/lib/witness_generation.cjs

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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);
+    // 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);
+    }
+    catch (err) {
+        throw new Error(`Circuit execution failed: ${err}`);
+    }
+}
+exports.generateWitness = generateWitness;

package/lib/witness_generation.d.ts

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

package/lib/witness_generation.mjs

@@ -0,0 +1,20 @@
+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);
+    // 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);
+    }
+    catch (err) {
+        throw new Error(`Circuit execution failed: ${err}`);
+    }
+}

package/package.json

@@ -3,23 +3,54 @@
   "collaborators": [
     "The Noir Team <team@noir-lang.org>"
   ],
-  "version": "0.12.0",
+  "version": "0.16.0",
   "packageManager": "yarn@3.5.1",
   "license": "(MIT OR Apache-2.0)",
+  "type": "module",
   "dependencies": {
-    "@noir-lang/acvm_js": "0.26.1",
-    "@noir-lang/noirc_abi": "workspace:*"
+    "@noir-lang/acvm_js": "0.28.0",
+    "@noir-lang/noirc_abi": "0.16.0",
+    "@noir-lang/types": "0.14.1",
+    "fflate": "^0.8.0"
   },
   "files": [
     "lib",
     "package.json"
   ],
-  "main": "lib/index.js",
+  "source": "src/index.ts",
+  "main": "lib/index.cjs",
+  "module": "lib/index.mjs",
+  "exports": {
+    "require": "./lib/index.cjs",
+    "types": "./lib/index.d.ts",
+    "default": "./lib/index.mjs"
+  },
   "types": "lib/index.d.ts",
   "scripts": {
-    "build": "tsc"
+    "dev": "tsc-multi --watch",
+    "build": "tsc-multi",
+    "test": "yarn test:node:esm && yarn test:node:cjs",
+    "test:node:esm": "mocha --timeout 25000 --exit --config ./.mocharc.json",
+    "test:node:cjs": "mocha --timeout 25000 --exit --config ./.mocharc.cjs.json",
+    "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",
+    "clean": "rm -rf ./lib"
   },
   "devDependencies": {
+    "@aztec/bb.js": "0.7.2",
+    "@types/chai": "^4",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^20.6.2",
+    "@types/prettier": "^3",
+    "chai": "^4.3.8",
+    "eslint": "^8.50.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "mocha": "^10.2.0",
+    "prettier": "3.0.3",
+    "ts-node": "^10.9.1",
+    "tsc-multi": "^1.1.0",
     "typescript": "^5.2.2"
   }
-}
+}

package/lib/index.js

@@ -1,3 +0,0 @@
-import * as acvm from "@noir-lang/acvm_js";
-import * as noirc from "@noir-lang/noirc_abi";
-export { acvm, noirc };