@aztec/noir-noir_js 0.0.0-test.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,38 @@
+"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.abi = exports.acvm = exports.Noir = exports.and = exports.xor = exports.blake2s256 = exports.ecdsa_secp256k1_verify = exports.ecdsa_secp256r1_verify = 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 acvm_js_1 = require("@noir-lang/acvm_js");
+Object.defineProperty(exports, "ecdsa_secp256r1_verify", { enumerable: true, get: function () { return acvm_js_1.ecdsa_secp256r1_verify; } });
+Object.defineProperty(exports, "ecdsa_secp256k1_verify", { enumerable: true, get: function () { return acvm_js_1.ecdsa_secp256k1_verify; } });
+Object.defineProperty(exports, "blake2s256", { enumerable: true, get: function () { return acvm_js_1.blake2s256; } });
+Object.defineProperty(exports, "xor", { enumerable: true, get: function () { return acvm_js_1.xor; } });
+Object.defineProperty(exports, "and", { enumerable: true, get: function () { return acvm_js_1.and; } });
+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

@@ -0,0 +1,11 @@
+import * as acvm from '@noir-lang/acvm_js';
+import * as abi from '@noir-lang/noirc_abi';
+import { CompiledCircuit } from '@noir-lang/types';
+export { ecdsa_secp256r1_verify, ecdsa_secp256k1_verify, blake2s256, xor, and } from '@noir-lang/acvm_js';
+export { InputMap } from '@noir-lang/noirc_abi';
+export { WitnessMap, ForeignCallHandler, ForeignCallInput, ForeignCallOutput } from '@noir-lang/acvm_js';
+export { Noir } from './program.js';
+export { ErrorWithPayload } from './witness_generation.js';
+/** @ignore */
+export { acvm, abi };
+export { CompiledCircuit };

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 { ecdsa_secp256r1_verify, ecdsa_secp256k1_verify, blake2s256, xor, and } from '@noir-lang/acvm_js';
+export { Noir } from "./program.mjs";
+/** @ignore */
+export { acvm, abi };

package/lib/program.cjs

@@ -0,0 +1,61 @@
+"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 = void 0;
+const witness_generation_js_1 = require("./witness_generation.cjs");
+const noirc_abi_1 = __importStar(require("@noir-lang/noirc_abi"));
+const acvm_js_1 = __importStar(require("@noir-lang/acvm_js"));
+class Noir {
+    circuit;
+    constructor(circuit) {
+        this.circuit = circuit;
+    }
+    /** @ignore */
+    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)()]);
+        }
+    }
+    /**
+     * @description
+     * Allows to execute a circuit to get its witness and return value.
+     *
+     * @example
+     * ```typescript
+     * async execute(inputs)
+     * ```
+     */
+    async execute(inputs, foreignCallHandler) {
+        await this.init();
+        const witness_stack = await (0, witness_generation_js_1.generateWitness)(this.circuit, inputs, foreignCallHandler);
+        const main_witness = witness_stack[0].witness;
+        const { return_value: returnValue } = (0, noirc_abi_1.abiDecode)(this.circuit.abi, main_witness);
+        return { witness: (0, acvm_js_1.compressWitnessStack)(witness_stack), returnValue };
+    }
+}
+exports.Noir = Noir;

package/lib/program.d.ts

@@ -0,0 +1,22 @@
+import { CompiledCircuit } from '@noir-lang/types';
+import { InputMap, InputValue } from '@noir-lang/noirc_abi';
+import { ForeignCallHandler } from '@noir-lang/acvm_js';
+export declare class Noir {
+    private circuit;
+    constructor(circuit: CompiledCircuit);
+    /** @ignore */
+    init(): Promise<void>;
+    /**
+     * @description
+     * Allows to execute a circuit to get its witness and return value.
+     *
+     * @example
+     * ```typescript
+     * async execute(inputs)
+     * ```
+     */
+    execute(inputs: InputMap, foreignCallHandler?: ForeignCallHandler): Promise<{
+        witness: Uint8Array;
+        returnValue: InputValue;
+    }>;
+}

package/lib/program.mjs

@@ -0,0 +1,34 @@
+import { generateWitness } from "./witness_generation.mjs";
+import initAbi, { abiDecode } from '@noir-lang/noirc_abi';
+import initACVM, { compressWitnessStack } from '@noir-lang/acvm_js';
+export class Noir {
+    circuit;
+    constructor(circuit) {
+        this.circuit = circuit;
+    }
+    /** @ignore */
+    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()]);
+        }
+    }
+    /**
+     * @description
+     * Allows to execute a circuit to get its witness and return value.
+     *
+     * @example
+     * ```typescript
+     * async execute(inputs)
+     * ```
+     */
+    async execute(inputs, foreignCallHandler) {
+        await this.init();
+        const witness_stack = await generateWitness(this.circuit, inputs, foreignCallHandler);
+        const main_witness = witness_stack[0].witness;
+        const { return_value: returnValue } = abiDecode(this.circuit.abi, main_witness);
+        return { witness: compressWitnessStack(witness_stack), returnValue };
+    }
+}

package/lib/witness_generation.cjs

@@ -0,0 +1,57 @@
+"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 defaultForeignCallHandler = async (name, args) => {
+    if (name == 'print') {
+        // By default we do not print anything for `print` foreign calls due to a need for formatting,
+        // however we provide an empty response in order to not halt execution.
+        //
+        // If a user needs to print values then they should provide a custom foreign call handler.
+        return [];
+    }
+    throw Error(`Unexpected oracle during execution: ${name}(${args.join(', ')})`);
+};
+function parseErrorPayload(abi, originalError) {
+    const payload = originalError.rawAssertionPayload;
+    if (!payload)
+        return originalError;
+    const enrichedError = originalError;
+    try {
+        // Decode the payload
+        const decodedPayload = (0, noirc_abi_1.abiDecodeError)(abi, payload);
+        if (typeof decodedPayload === 'string') {
+            // If it's a string, just add it to the error message
+            enrichedError.message = `Circuit execution failed: ${decodedPayload}`;
+        }
+        else {
+            // If not, attach the payload to the original error
+            enrichedError.decodedAssertionPayload = decodedPayload;
+        }
+    }
+    catch (_errorDecoding) {
+        // Ignore errors decoding the payload
+    }
+    return enrichedError;
+}
+// Generates the witnesses needed to feed into the chosen proving system
+async function generateWitness(compiledProgram, inputs, foreignCallHandler = defaultForeignCallHandler) {
+    // Throws on ABI encoding error
+    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.executeProgram)((0, base64_decode_js_1.base64Decode)(compiledProgram.bytecode), witnessMap, foreignCallHandler);
+        return solvedWitness;
+    }
+    catch (err) {
+        // Typescript types catched errors as unknown or any, so we need to narrow its type to check if it has raw assertion payload.
+        if (typeof err === 'object' && err !== null && 'rawAssertionPayload' in err) {
+            throw parseErrorPayload(compiledProgram.abi, err);
+        }
+        throw new Error(`Circuit execution failed: ${err}`);
+    }
+}
+exports.generateWitness = generateWitness;

package/lib/witness_generation.d.ts

@@ -0,0 +1,7 @@
+import { InputMap } from '@noir-lang/noirc_abi';
+import { WitnessStack, ForeignCallHandler, ExecutionError } from '@noir-lang/acvm_js';
+import { CompiledCircuit } from '@noir-lang/types';
+export type ErrorWithPayload = ExecutionError & {
+    decodedAssertionPayload?: any;
+};
+export declare function generateWitness(compiledProgram: CompiledCircuit, inputs: InputMap, foreignCallHandler?: ForeignCallHandler): Promise<WitnessStack>;

package/lib/witness_generation.mjs

@@ -0,0 +1,53 @@
+import { abiDecodeError, abiEncode } from '@noir-lang/noirc_abi';
+import { base64Decode } from "./base64_decode.mjs";
+import { executeProgram } from '@noir-lang/acvm_js';
+const defaultForeignCallHandler = async (name, args) => {
+    if (name == 'print') {
+        // By default we do not print anything for `print` foreign calls due to a need for formatting,
+        // however we provide an empty response in order to not halt execution.
+        //
+        // If a user needs to print values then they should provide a custom foreign call handler.
+        return [];
+    }
+    throw Error(`Unexpected oracle during execution: ${name}(${args.join(', ')})`);
+};
+function parseErrorPayload(abi, originalError) {
+    const payload = originalError.rawAssertionPayload;
+    if (!payload)
+        return originalError;
+    const enrichedError = originalError;
+    try {
+        // Decode the payload
+        const decodedPayload = abiDecodeError(abi, payload);
+        if (typeof decodedPayload === 'string') {
+            // If it's a string, just add it to the error message
+            enrichedError.message = `Circuit execution failed: ${decodedPayload}`;
+        }
+        else {
+            // If not, attach the payload to the original error
+            enrichedError.decodedAssertionPayload = decodedPayload;
+        }
+    }
+    catch (_errorDecoding) {
+        // Ignore errors decoding the payload
+    }
+    return enrichedError;
+}
+// Generates the witnesses needed to feed into the chosen proving system
+export async function generateWitness(compiledProgram, inputs, foreignCallHandler = defaultForeignCallHandler) {
+    // Throws on ABI encoding error
+    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 executeProgram(base64Decode(compiledProgram.bytecode), witnessMap, foreignCallHandler);
+        return solvedWitness;
+    }
+    catch (err) {
+        // Typescript types catched errors as unknown or any, so we need to narrow its type to check if it has raw assertion payload.
+        if (typeof err === 'object' && err !== null && 'rawAssertionPayload' in err) {
+            throw parseErrorPayload(compiledProgram.abi, err);
+        }
+        throw new Error(`Circuit execution failed: ${err}`);
+    }
+}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@aztec/noir-noir_js",
+  "contributors": [
+    "The Noir Team <team@noir-lang.org>"
+  ],
+  "version": "0.0.0-test.0",
+  "packageManager": "yarn@3.5.1",
+  "license": "(MIT OR Apache-2.0)",
+  "type": "module",
+  "homepage": "https://noir-lang.org/",
+  "repository": {
+    "url": "https://github.com/noir-lang/noir.git",
+    "directory": "tooling/noir_js",
+    "type": "git"
+  },
+  "bugs": {
+    "url": "https://github.com/noir-lang/noir/issues"
+  },
+  "dependencies": {
+    "@aztec/noir-acvm_js": "0.0.0-test.0",
+    "@aztec/noir-noirc_abi": "0.0.0-test.0",
+    "@aztec/noir-types": "0.0.0-test.0"
+  },
+  "files": [
+    "lib",
+    "package.json"
+  ],
+  "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": {
+    "dev": "tsc-multi --watch",
+    "build": "tsc-multi",
+    "test": "yarn test:compile_program && yarn test:node:esm && yarn test:node:cjs",
+    "test:compile_program": "./scripts/compile_test_programs.sh",
+    "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",
+    "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": {
+    "@types/chai": "^4",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^20.6.2",
+    "@types/prettier": "^3",
+    "chai": "^4.4.1",
+    "eslint": "^8.57.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "mocha": "^10.2.0",
+    "prettier": "3.2.5",
+    "ts-node": "^10.9.1",
+    "tsc-multi": "^1.1.0",
+    "tsx": "^4.6.2",
+    "typescript": "^5.4.2"
+  }
+}