chore(noir-js): Add program API

tooling/noir_js/fixup.sh

@@ -0,0 +1,15 @@
+# Put these package.json files in the cjs and
+# mjs directory respectively, so that 
+#  tools can recognise that the .js files are either
+# commonjs or ESM files.
+cat >lib/cjs/package.json <<!EOF
+{
+    "type": "commonjs"
+}
+!EOF
+
+cat >lib/mjs/package.json <<!EOF
+{
+    "type": "module"
+}
+!EOF

tooling/noir_js/package.json

@@ -6,7 +6,6 @@
   "version": "0.13.0",
   "packageManager": "yarn@3.5.1",
   "license": "(MIT OR Apache-2.0)",
-  "type": "module",
   "dependencies": {
     "@noir-lang/acvm_js": "workspace:*",
     "@noir-lang/noirc_abi": "workspace:*",
@@ -17,17 +16,20 @@
     "package.json"
   ],
   "source": "src/index.ts",
-  "main": "lib/index.cjs",
-  "module": "lib/index.js",
+  "main": "lib/cjs/index.js",
+  "module": "lib/mjs/index.js",
   "exports": {
-    "require": "./lib/index.cjs",
-    "default": "./lib/index.js",
-    "types": "./lib/index.d.ts"
+    "require": "./lib/cjs/index.js",
+    "default": "./lib/mjs/index.js",
+    "types": "./lib/types/index.d.ts"
   },
-  "types": "lib/index.d.ts",
+  "types": "lib/types/index.d.ts",
   "scripts": {
-    "dev": "tsc-multi --watch",
-    "build": "tsc-multi",
+    "dev": "tsc --watch",
+    "build": "yarn run build:tsc:cjs && yarn run build:tsc:mjs && yarn run build:types && ./fixup.sh",
+    "build:tsc:cjs": "tsc -p tsconfig.cjs.json",
+    "build:tsc:mjs": "tsc -p tsconfig.mjs.json",
+    "build:types": "tsc -p tsconfig.types.json",
     "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",
@@ -47,7 +49,6 @@
     "mocha": "^10.2.0",
     "prettier": "3.0.3",
     "ts-node": "^10.9.1",
-    "tsc-multi": "^1.1.0",
     "typescript": "^5.2.2"
   }
 }

tooling/noir_js/test/backend/barretenberg.ts → tooling/noir_js/src/backend/barretenberg.ts

@@ -1,7 +1,7 @@
+/* eslint-disable  @typescript-eslint/no-explicit-any */
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
 import { Barretenberg, Crs, RawBuffer } from '@aztec/bb.js';
-// TODO: This should be re-exported from @aztec/bb-js
-import { Ptr } from '@aztec/bb.js/dest/browser/types';
 import { acirToUint8Array } from '../../src/index.js';
 import { Backend } from './backend_interface.js';
 
@@ -11,14 +11,21 @@ export class BarretenbergBackend implements Backend {
   // These are initialized asynchronously in the `init` function,
   // constructors cannot be asynchronous which is why we do this.
   api = {} as Barretenberg;
-  acirComposer = {} as Ptr;
+  acirComposer = {} as any;
   acirUncompressedBytecode: Uint8Array;
 
-  constructor(acirBytecodeBase64: string) {
+  private constructor(acirCircuit: { bytecode: string }) {
+    const acirBytecodeBase64 = acirCircuit.bytecode;
     this.acirUncompressedBytecode = acirToUint8Array(acirBytecodeBase64);
   }
 
-  async init(): Promise<void> {
+  static async initialize(acirCircuit: { bytecode: string }): Promise<BarretenbergBackend> {
+    const backend = new BarretenbergBackend(acirCircuit);
+    await backend.init();
+    return backend;
+  }
+
+  private async init(): Promise<void> {
     const numThreads = 4;
 
     const { api, composer } = await this.initBarretenberg(numThreads, this.acirUncompressedBytecode);

tooling/noir_js/src/program.ts

@@ -0,0 +1,20 @@
+/* eslint-disable  @typescript-eslint/no-explicit-any */
+import { Backend } from './backend/backend_interface.js';
+import { generateWitness } from './witness_generation.js';
+
+export class Program {
+  constructor(
+    private circuit: { bytecode: string; abi: any },
+    private backend: Backend,
+  ) {}
+
+  // Initial inputs to your program
+  async generateFinalProof(inputs: any): Promise<Uint8Array> {
+    const serializedWitness = await generateWitness(this.circuit, inputs);
+    return this.backend.generateFinalProof(serializedWitness);
+  }
+
+  async verifyFinalProof(proof: Uint8Array): Promise<boolean> {
+    return this.backend.verifyFinalProof(proof);
+  }
+}

tooling/noir_js/test/node/e2e.test.ts

@@ -1,7 +1,8 @@
 import { expect } from 'chai';
 import assert_lt_json from '../noir_compiled_examples/assert_lt/target/assert_lt.json' assert { type: 'json' };
 import { generateWitness } from '../../src/index.js';
-import { BarretenbergBackend as Backend } from '../backend/barretenberg.js';
+import { Program } from '../../src/program.js';
+import { BarretenbergBackend as Backend } from '../../src/backend/barretenberg.js';
 
 it('end-to-end proof creation and verification (outer)', async () => {
   // Noir.Js part
@@ -14,15 +15,33 @@ it('end-to-end proof creation and verification (outer)', async () => {
   // bb.js part
   //
   // Proof creation
-  const prover = new Backend(assert_lt_json.bytecode);
-  await prover.init();
+  const prover = await Backend.initialize(assert_lt_json);
   const proof = await prover.generateFinalProof(serializedWitness);
 
   // Proof verification
   const isValid = await prover.verifyFinalProof(proof);
   expect(isValid).to.be.true;
 });
 
+it('end-to-end proof creation and verification (outer) -- Program API', async () => {
+  // Noir.Js part
+  const inputs = {
+    x: '2',
+    y: '3',
+  };
+
+  // Initialize backend
+  const backend = await Backend.initialize(assert_lt_json);
+  // Initialize program
+  const program = new Program(assert_lt_json, backend);
+  // Generate proof
+  const proof = await program.generateFinalProof(inputs);
+
+  // Proof verification
+  const isValid = await program.verifyFinalProof(proof);
+  expect(isValid).to.be.true;
+});
+
 it('end-to-end proof creation and verification (inner)', async () => {
   // Noir.Js part
   const inputs = {
@@ -34,8 +53,7 @@ it('end-to-end proof creation and verification (inner)', async () => {
   // bb.js part
   //
   // Proof creation
-  const prover = new Backend(assert_lt_json.bytecode);
-  await prover.init();
+  const prover = await Backend.initialize(assert_lt_json);
   const proof = await prover.generateIntermediateProof(serializedWitness);
 
   // Proof verification
@@ -64,14 +82,12 @@ it('[BUG] -- bb.js null function or function signature mismatch (different insta
   const serializedWitness = await generateWitness(assert_lt_json, inputs);
 
   // bb.js part
-  const prover = new Backend(assert_lt_json.bytecode);
-  await prover.init();
+  const prover = await Backend.initialize(assert_lt_json);
 
   const proof = await prover.generateFinalProof(serializedWitness);
 
   try {
-    const verifier = new Backend(assert_lt_json.bytecode);
-    await verifier.init();
+    const verifier = await Backend.initialize(assert_lt_json);
     await verifier.verifyFinalProof(proof);
     expect.fail(
       'bb.js currently returns a bug when we try to verify a proof with a different Barretenberg instance that created it.',
@@ -101,8 +117,7 @@ it('[BUG] -- bb.js null function or function signature mismatch (outer-inner) ',
   //
   // Proof creation
   //
-  const prover = new Backend(assert_lt_json.bytecode);
-  await prover.init();
+  const prover = await Backend.initialize(assert_lt_json);
   // Create a proof using both proving systems, the majority of the time
   // one would only use outer proofs.
   const proofOuter = await prover.generateFinalProof(serializedWitness);

tooling/noir_js/tsconfig.base.json

@@ -0,0 +1,26 @@
+{
+    "compilerOptions": {
+        "allowJs": true,
+        "emitDeclarationOnly": false,
+        "noImplicitAny": false,
+        "allowSyntheticDefaultImports": true,
+        "baseUrl": "src",
+        "esModuleInterop": true,
+        "inlineSourceMap": false,
+        "lib": ["esnext"],
+        "listEmittedFiles": false,
+        "listFiles": false,
+        "moduleResolution": "node",
+        "noFallthroughCasesInSwitch": true,
+        "pretty": true,
+        "resolveJsonModule": true,
+        "rootDir": "src",
+        "skipLibCheck": true,
+        "strict": true,
+        "traceResolution": false,
+        "types": ["node"]
+    },
+    "compileOnSave": false,
+    "exclude": ["node_modules", "lib"],
+    "include": ["src/**/*.ts"]
+}

tooling/noir_js/tsconfig.cjs.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "outDir": "./lib/cjs",
+    "target": "es2020"
+  }
+}

tooling/noir_js/tsconfig.mjs.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "module": "ESNext",
+    "target": "ESNext",
+    "outDir": "./lib/mjs"
+  }
+}

tooling/noir_js/tsconfig.types.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "declarationDir": "./lib/types",
+    "outDir": "./lib/types",
+    "target": "es2020"
+  }
+}