chore: modularize bb

ts/package.json

@@ -2,7 +2,11 @@
   "name": "@aztec/barretenberg.js",
   "version": "0.0.0",
   "type": "module",
-  "exports": "./dest/index.js",
+  "exports": {
+    "./crs": "./dest/crs/index.js",
+    "./crypto": "./dest/crypto/index.js",
+    "./wasm": "./dest/wasm/index.js"
+  },
   "typedoc": {
     "entryPoint": "./src/index.ts",
     "displayName": "Barretenberg.js",
@@ -14,7 +18,8 @@
     "clean": "rm -rf ./dest .tsbuildinfo",
     "bundle-deps": "yalc add @aztec/wasm @aztec/log && yalc add -D @aztec/eslint-config",
     "dev-deps": "rm -r node_modules/@aztec/wasm ; yarn link ../../../yarn-project/wasm ; cd ../../../yarn-project/wasm ; yarn build:dev",
-    "formatting": "run -T prettier --check ./src && run -T eslint --max-warnings 0 ./src",
+    "formatting": "prettier --check ./src && eslint --max-warnings 0 ./src",
+    "formatting:fix": "prettier -w ./src",
     "test": "NODE_NO_WARNINGS=1 node --experimental-vm-modules $(yarn bin jest) --no-cache --passWithNoTests",
     "test-debug": "NODE_NO_WARNINGS=1 node --inspect-brk --experimental-vm-modules $(yarn bin jest) --no-cache --passWithNoTests --runInBand"
   },

ts/src/crs/index.ts

@@ -1,15 +1,14 @@
-import { readFile } from "fs/promises";
-import { existsSync } from "fs";
+import { readFile } from 'fs/promises';
+import { existsSync } from 'fs';
 
-import { dirname } from "path";
-import { fileURLToPath } from "url";
+import { dirname } from 'path';
+import { fileURLToPath } from 'url';
 
 /**
  * The path to our SRS object, assuming that we are in barretenberg/ts folder.
  */
 export const SRS_DEV_PATH =
-  dirname(fileURLToPath(import.meta.url)) +
-  "/../../../cpp/srs_db/ignition/monomial/transcript00.dat";
+  dirname(fileURLToPath(import.meta.url)) + '/../../../cpp/srs_db/ignition/monomial/transcript00.dat';
 /**
  * Downloader for CRS from the web or local.
  */
@@ -21,7 +20,7 @@ export class NetCrs {
     /**
      * The number of circuit gates.
      */
-    public readonly numPoints: number
+    public readonly numPoints: number,
   ) {}
 
   /**
@@ -34,14 +33,11 @@ export class NetCrs {
     const g1End = g1Start + this.numPoints * 64 - 1;
 
     // Download required range of data.
-    const response = await fetch(
-      "https://aztec-ignition.s3.amazonaws.com/MAIN%20IGNITION/sealed/transcript00.dat",
-      {
-        headers: {
-          Range: `bytes=${g1Start}-${g1End}`,
-        },
-      }
-    );
+    const response = await fetch('https://aztec-ignition.s3.amazonaws.com/MAIN%20IGNITION/sealed/transcript00.dat', {
+      headers: {
+        Range: `bytes=${g1Start}-${g1End}`,
+      },
+    });
 
     this.data = new Uint8Array(await response.arrayBuffer());
 
@@ -55,14 +51,11 @@ export class NetCrs {
     const g2Start = 28 + 5040000 * 64;
     const g2End = g2Start + 128 - 1;
 
-    const response2 = await fetch(
-      "https://aztec-ignition.s3.amazonaws.com/MAIN%20IGNITION/sealed/transcript00.dat",
-      {
-        headers: {
-          Range: `bytes=${g2Start}-${g2End}`,
-        },
-      }
-    );
+    const response2 = await fetch('https://aztec-ignition.s3.amazonaws.com/MAIN%20IGNITION/sealed/transcript00.dat', {
+      headers: {
+        Range: `bytes=${g2Start}-${g2End}`,
+      },
+    });
 
     this.g2Data = new Uint8Array(await response2.arrayBuffer());
   }
@@ -96,7 +89,7 @@ export class FileCrs {
      * The number of circuit gates.
      */
     public readonly numPoints: number,
-    private path: string
+    private path: string,
   ) {}
 
   /**
@@ -143,11 +136,9 @@ export class Crs {
     /**
      * The number of circuit gates.
      */
-    public readonly numPoints: number
+    public readonly numPoints: number,
   ) {
-    this.crs = existsSync(SRS_DEV_PATH)
-      ? new FileCrs(numPoints, SRS_DEV_PATH)
-      : new NetCrs(numPoints);
+    this.crs = existsSync(SRS_DEV_PATH) ? new FileCrs(numPoints, SRS_DEV_PATH) : new NetCrs(numPoints);
   }
 
   /**

ts/src/crypto/index.ts

@@ -1 +1 @@
-export * from "./pedersen/index.js";
+export * from './pedersen/index.js';

ts/src/crypto/pedersen/index.ts

@@ -1 +1 @@
-export * from "./pedersen.js";
+export * from './pedersen.js';

ts/src/crypto/pedersen/pedersen.test.ts

@@ -1,7 +1,7 @@
-import { BarretenbergWasm } from "../../wasm/index.js";
-import { pedersenGetHashTree } from "./pedersen.js";
+import { BarretenbergWasm } from '../../wasm/barretenberg_wasm.js';
+import { pedersenGetHashTree } from './pedersen.js';
 
-describe("pedersen", () => {
+describe('pedersen', () => {
   let barretenbergWasm!: BarretenbergWasm;
   const values: Buffer[] = [];
 
@@ -16,7 +16,7 @@ describe("pedersen", () => {
     }
   });
 
-  it("hasher_consistency_and_benchmark", () => {
+  it('hasher_consistency_and_benchmark', () => {
     const start1 = new Date().getTime();
     const result = pedersenGetHashTree(barretenbergWasm, values);
     const end1 = new Date().getTime() - start1;

ts/src/crypto/pedersen/pedersen.ts

@@ -1,10 +1,6 @@
-import { BarretenbergWasm } from "../../wasm/index.js";
-import {
-  deserializeArrayFromVector,
-  deserializeField,
-  serializeBufferArrayToVector,
-} from "../../wasm/serialize.js";
-import { Buffer } from "buffer";
+import { BarretenbergWasm } from '../../wasm/index.js';
+import { deserializeArrayFromVector, deserializeField, serializeBufferArrayToVector } from '../../wasm/serialize.js';
+import { Buffer } from 'buffer';
 
 /**
  * Combines two 32-byte hashes.
@@ -13,17 +9,13 @@ import { Buffer } from "buffer";
  * @param rhs - The second hash.
  * @returns The new 32-byte hash.
  */
-export function pedersenCompress(
-  wasm: BarretenbergWasm,
-  lhs: Uint8Array,
-  rhs: Uint8Array
-): Buffer {
+export function pedersenCompress(wasm: BarretenbergWasm, lhs: Uint8Array, rhs: Uint8Array): Buffer {
   // If not done already, precompute constants.
-  wasm.call("pedersen__init");
+  wasm.call('pedersen__init');
   // TODO check if lhs and rhs are <= 32 bytes?
   wasm.writeMemory(0, lhs);
   wasm.writeMemory(32, rhs);
-  wasm.call("pedersen__compress_fields", 0, 32, 64);
+  wasm.call('pedersen__compress_fields', 0, 32, 64);
   return Buffer.from(wasm.getMemorySlice(64, 96));
 }
 
@@ -34,15 +26,12 @@ export function pedersenCompress(
  * @param rhs - The second hash.
  * @returns The new 32-byte hash.
  */
-export function pedersenCompressInputs(
-  wasm: BarretenbergWasm,
-  inputs: Buffer[]
-): Buffer {
+export function pedersenCompressInputs(wasm: BarretenbergWasm, inputs: Buffer[]): Buffer {
   // If not done already, precompute constants.
-  wasm.call("pedersen__init");
+  wasm.call('pedersen__init');
   const inputVectors = serializeBufferArrayToVector(inputs);
   wasm.writeMemory(0, inputVectors);
-  wasm.call("pedersen__compress", 0, 0);
+  wasm.call('pedersen__compress', 0, 0);
   return Buffer.from(wasm.getMemorySlice(0, 32));
 }
 
@@ -53,16 +42,12 @@ export function pedersenCompressInputs(
  * @param rhs - The second hash.
  * @returns The new 32-byte hash.
  */
-export function pedersenCompressWithHashIndex(
-  wasm: BarretenbergWasm,
-  inputs: Buffer[],
-  hashIndex: number
-): Buffer {
+export function pedersenCompressWithHashIndex(wasm: BarretenbergWasm, inputs: Buffer[], hashIndex: number): Buffer {
   // If not done already, precompute constants.
-  wasm.call("pedersen__init");
+  wasm.call('pedersen__init');
   const inputVectors = serializeBufferArrayToVector(inputs);
   wasm.writeMemory(0, inputVectors);
-  wasm.call("pedersen__compress_with_hash_index", 0, 0, hashIndex);
+  wasm.call('pedersen__compress_with_hash_index', 0, 0, hashIndex);
   return Buffer.from(wasm.getMemorySlice(0, 32));
 }
 
@@ -74,11 +59,11 @@ export function pedersenCompressWithHashIndex(
  */
 export function pedersenGetHash(wasm: BarretenbergWasm, data: Buffer): Buffer {
   // If not done already, precompute constants.
-  wasm.call("pedersen__init");
-  const mem = wasm.call("bbmalloc", data.length);
+  wasm.call('pedersen__init');
+  const mem = wasm.call('bbmalloc', data.length);
   wasm.writeMemory(mem, data);
-  wasm.call("pedersen__buffer_to_field", mem, data.length, 0);
-  wasm.call("bbfree", mem);
+  wasm.call('pedersen__buffer_to_field', mem, data.length, 0);
+  wasm.call('bbfree', mem);
   return Buffer.from(wasm.getMemorySlice(0, 32));
 }
 
@@ -93,20 +78,16 @@ export function pedersenGetHash(wasm: BarretenbergWasm, data: Buffer): Buffer {
  */
 export function pedersenGetHashTree(wasm: BarretenbergWasm, values: Buffer[]) {
   // If not done already, precompute constants.
-  wasm.call("pedersen__init");
+  wasm.call('pedersen__init');
   const data = serializeBufferArrayToVector(values);
-  const inputPtr = wasm.call("bbmalloc", data.length);
+  const inputPtr = wasm.call('bbmalloc', data.length);
   wasm.writeMemory(inputPtr, data);
 
-  const resultPtr = wasm.call("pedersen__hash_to_tree", inputPtr);
-  const resultNumFields = Buffer.from(
-    wasm.getMemorySlice(resultPtr, resultPtr + 4)
-  ).readUInt32BE(0);
-  const resultData = Buffer.from(
-    wasm.getMemorySlice(resultPtr, resultPtr + 4 + resultNumFields * 32)
-  );
-  wasm.call("bbfree", inputPtr);
-  wasm.call("bbfree", resultPtr);
+  const resultPtr = wasm.call('pedersen__hash_to_tree', inputPtr);
+  const resultNumFields = Buffer.from(wasm.getMemorySlice(resultPtr, resultPtr + 4)).readUInt32BE(0);
+  const resultData = Buffer.from(wasm.getMemorySlice(resultPtr, resultPtr + 4 + resultNumFields * 32));
+  wasm.call('bbfree', inputPtr);
+  wasm.call('bbfree', resultPtr);
 
   return deserializeArrayFromVector(deserializeField, resultData).elem;
 }

ts/src/wasm/barretenberg_wasm.test.ts

@@ -1,53 +1,46 @@
-import { FileCrs, SRS_DEV_PATH } from "../crs/index.js";
-import { BarretenbergWasm } from "./barretenberg_wasm.js";
+import { FileCrs, SRS_DEV_PATH } from '../crs/index.js';
+import { BarretenbergWasm } from './barretenberg_wasm.js';
 
-describe("basic barretenberg smoke test", () => {
+describe('basic barretenberg smoke test', () => {
   const wasm: BarretenbergWasm = new BarretenbergWasm();
 
   beforeAll(async () => {
     await wasm.init();
   });
 
-  it("should new malloc, transfer and slice mem", () => {
+  it('should new malloc, transfer and slice mem', () => {
     const length = 1024;
-    const ptr = wasm.call("bbmalloc", length);
+    const ptr = wasm.call('bbmalloc', length);
     const buf = Buffer.alloc(length, 128);
     wasm.writeMemory(ptr, buf);
-    wasm.call("bbfree", ptr);
+    wasm.call('bbfree', ptr);
     const result = Buffer.from(wasm.getMemorySlice(ptr, ptr + length));
     expect(result).toStrictEqual(buf);
   });
 
-  it("should use asyncify to do an async callback into js", async () => {
-    const addr1 = await wasm.asyncCall("test_async_func", 1024 * 1024, 1);
-    const addr2 = await wasm.asyncCall("test_async_func", 1024 * 1024 * 2, 2);
-    expect(
-      wasm.getMemorySlice(addr1, addr1 + 1024 * 1024).every((v) => v === 1)
-    ).toBe(true);
-    expect(
-      wasm.getMemorySlice(addr2, addr2 + 1024 * 1024 * 2).every((v) => v === 2)
-    ).toBe(true);
+  it('should use asyncify to do an async callback into js', async () => {
+    const addr1 = await wasm.asyncCall('test_async_func', 1024 * 1024, 1);
+    const addr2 = await wasm.asyncCall('test_async_func', 1024 * 1024 * 2, 2);
+    expect(wasm.getMemorySlice(addr1, addr1 + 1024 * 1024).every(v => v === 1)).toBe(true);
+    expect(wasm.getMemorySlice(addr2, addr2 + 1024 * 1024 * 2).every(v => v === 2)).toBe(true);
   });
 
-  it("should correctly pass CRS data through env_load_verifier_crs", async () => {
+  it('should correctly pass CRS data through env_load_verifier_crs', async () => {
     const crs = new FileCrs(0, SRS_DEV_PATH);
     await crs.init();
-    const g2DataPtr = await wasm.asyncCall("test_env_load_verifier_crs");
+    const g2DataPtr = await wasm.asyncCall('test_env_load_verifier_crs');
     const g2Data = wasm.getMemorySlice(g2DataPtr, g2DataPtr + 128);
     expect(Buffer.from(g2Data)).toStrictEqual(crs.getG2Data());
-    wasm.call("bbfree", g2DataPtr);
+    wasm.call('bbfree', g2DataPtr);
   });
 
-  it("should correctly pass CRS data through env_load_prover_crs", async () => {
+  it('should correctly pass CRS data through env_load_prover_crs', async () => {
     const numPoints = 1024;
     const crs = new FileCrs(numPoints, SRS_DEV_PATH);
     await crs.init();
-    const g1DataPtr = await wasm.asyncCall(
-      "test_env_load_prover_crs",
-      numPoints
-    );
+    const g1DataPtr = await wasm.asyncCall('test_env_load_prover_crs', numPoints);
     const g1Data = wasm.getMemorySlice(g1DataPtr, g1DataPtr + numPoints * 64);
     expect(Buffer.from(g1Data)).toStrictEqual(crs.getG1Data());
-    wasm.call("bbfree", g1DataPtr);
+    wasm.call('bbfree', g1DataPtr);
   });
 });