@aztec/bb.js 0.0.0-devnet

package/src/crs/node/ignition_files_crs.ts

@@ -0,0 +1,74 @@
+import { existsSync } from 'fs';
+import { readFile } from 'fs/promises';
+import { dirname } from 'path';
+import { fileURLToPath } from 'url';
+
+function getCurrentDir() {
+  if (typeof __dirname !== 'undefined') {
+    return __dirname;
+  } else {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    return dirname(fileURLToPath(import.meta.url));
+  }
+}
+
+/**
+ * The path to our SRS object, assuming that we are in e.g. barretenberg/ts/dest/node/crs/node folder.
+ */
+export const SRS_DEV_PATH = getCurrentDir() + '/../../../../../cpp/srs_db/ignition/monomial';
+export const GRUMPKIN_SRS_DEV_PATH = getCurrentDir() + '/../../../../../cpp/srs_db/grumpkin/monomial';
+
+/**
+ * Downloader for CRS from a local file (for Node).
+ */
+export class IgnitionFilesCrs {
+  private data!: Uint8Array;
+  private g2Data!: Uint8Array;
+
+  constructor(
+    /**
+     * The number of circuit gates.
+     */
+    public readonly numPoints: number,
+    private path = SRS_DEV_PATH,
+  ) {}
+
+  pathExists() {
+    return existsSync(this.path);
+  }
+
+  /**
+   * Read the data file.
+   */
+  async init() {
+    // We need this.numPoints number of g1 points.
+    // numPoints should be circuitSize + 1.
+    const g1Start = 28;
+    const g1End = g1Start + this.numPoints * 64;
+
+    const data = await readFile(this.path + '/transcript00.dat');
+    this.data = data.subarray(g1Start, g1End);
+
+    // TODO(https://github.com/AztecProtocol/barretenberg/issues/811): proper abstraction from Grumpkin which does not have g2
+    if (existsSync(this.path + '/g2.dat')) {
+      this.g2Data = await readFile(this.path + '/g2.dat');
+    }
+  }
+
+  /**
+   * G1 points data for prover key.
+   * @returns The points data.
+   */
+  getG1Data(): Uint8Array {
+    return this.data;
+  }
+
+  /**
+   * G2 points data for verification key.
+   * @returns The points data.
+   */
+  getG2Data(): Uint8Array {
+    return this.g2Data;
+  }
+}

package/src/crs/node/index.ts

@@ -0,0 +1,102 @@
+import { NetCrs, NetGrumpkinCrs } from '../net_crs.js';
+import { closeSync, mkdirSync, openSync, readFileSync, readSync, writeFileSync } from 'fs';
+import { stat } from 'fs/promises';
+import createDebug from 'debug';
+import { homedir } from 'os';
+
+const debug = createDebug('bb.js:crs');
+
+/**
+ * Generic CRS finder utility class.
+ */
+export class Crs {
+  constructor(public readonly numPoints: number, public readonly path: string) {}
+
+  static async new(numPoints: number, crsPath = homedir() + '/.bb-crs') {
+    const crs = new Crs(numPoints, crsPath);
+    await crs.init();
+    return crs;
+  }
+
+  async init() {
+    mkdirSync(this.path, { recursive: true });
+
+    const g1FileSize = await stat(this.path + '/bn254_g1.dat')
+      .then(stats => stats.size)
+      .catch(() => 0);
+    const g2FileSize = await stat(this.path + '/bn254_g2.dat')
+      .then(stats => stats.size)
+      .catch(() => 0);
+
+    if (g1FileSize >= this.numPoints * 64 && g1FileSize % 64 == 0 && g2FileSize == 128) {
+      debug(`using cached crs of size: ${g1FileSize / 64}`);
+      return;
+    }
+
+    debug(`downloading crs of size: ${this.numPoints}`);
+    const crs = new NetCrs(this.numPoints);
+    await crs.init();
+    writeFileSync(this.path + '/bn254_g1.dat', crs.getG1Data());
+    writeFileSync(this.path + '/bn254_g2.dat', crs.getG2Data());
+  }
+
+  /**
+   * G1 points data for prover key.
+   * @returns The points data.
+   */
+  getG1Data(): Uint8Array {
+    const length = this.numPoints * 64;
+    const fd = openSync(this.path + '/bn254_g1.dat', 'r');
+    const buffer = new Uint8Array(length);
+    readSync(fd, buffer, 0, length, 0);
+    closeSync(fd);
+    return buffer;
+  }
+
+  /**
+   * G2 points data for verification key.
+   * @returns The points data.
+   */
+  getG2Data(): Uint8Array {
+    return readFileSync(this.path + '/bn254_g2.dat');
+  }
+}
+
+/**
+ * Generic Grumpkin CRS finder utility class.
+ */
+export class GrumpkinCrs {
+  constructor(public readonly numPoints: number, public readonly path: string) {}
+
+  static async new(numPoints: number, crsPath = homedir() + '/.bb-crs') {
+    const crs = new GrumpkinCrs(numPoints, crsPath);
+    await crs.init();
+    return crs;
+  }
+
+  async init() {
+    mkdirSync(this.path, { recursive: true });
+
+    const g1FileSize = await stat(this.path + '/grumpkin_g1.dat')
+      .then(stats => stats.size)
+      .catch(() => 0);
+
+    if (g1FileSize >= this.numPoints * 64 && g1FileSize % 64 == 0) {
+      debug(`using cached crs of size: ${g1FileSize / 64}`);
+      return;
+    }
+
+    debug(`downloading crs of size: ${this.numPoints}`);
+    const crs = new NetGrumpkinCrs(this.numPoints);
+    await crs.init();
+    writeFileSync(this.path + '/grumpkin_g1.dat', crs.getG1Data());
+  }
+
+  /**
+   * G1 points data for prover key.
+   * @returns The points data.
+   */
+  getG1Data(): Uint8Array {
+    return readFileSync(this.path + '/grumpkin_g1.dat');
+  }
+}

package/src/examples/simple.rawtest.ts

@@ -0,0 +1,38 @@
+import { Crs } from '../crs/index.js';
+import createDebug from 'debug';
+import { Barretenberg } from '../barretenberg/index.js';
+import { RawBuffer } from '../types/index.js';
+
+createDebug.enable('*');
+const debug = createDebug('simple_test');
+
+async function main() {
+  const CIRCUIT_SIZE = 2 ** 19;
+
+  debug('starting test...');
+  const api = await Barretenberg.new();
+
+  // // Important to init slab allocator as first thing, to ensure maximum memory efficiency.
+  // TODO(https://github.com/AztecProtocol/barretenberg/issues/1129): Do slab allocator initialization?
+  // await api.commonInitSlabAllocator(CIRCUIT_SIZE);
+
+  // Plus 1 needed!
+  const crs = await Crs.new(CIRCUIT_SIZE + 1);
+  await api.srsInitSrs(new RawBuffer(crs.getG1Data()), crs.numPoints, new RawBuffer(crs.getG2Data()));
+
+  const iterations = 10;
+  let totalTime = 0;
+  for (let i = 0; i < iterations; ++i) {
+    const start = new Date().getTime();
+    debug(`iteration ${i} starting...`);
+    await api.examplesSimpleCreateAndVerifyProof();
+    totalTime += new Date().getTime() - start;
+  }
+
+  await api.destroy();
+
+  debug(`avg iteration time: ${totalTime / iterations}ms`);
+  debug('test complete.');
+}
+
+void main();

package/src/examples/simple.test.ts

@@ -0,0 +1,28 @@
+import { Crs } from '../crs/index.js';
+import { Barretenberg } from '../barretenberg/index.js';
+import { RawBuffer } from '../types/index.js';
+
+describe('simple', () => {
+  let api: Barretenberg;
+
+  beforeAll(async () => {
+    api = await Barretenberg.new();
+
+    // // Important to init slab allocator as first thing, to ensure maximum memory efficiency.
+    // TODO(https://github.com/AztecProtocol/barretenberg/issues/1129): Do slab allocator initialization?
+    // const CIRCUIT_SIZE = 2 ** 19;
+    // await api.commonInitSlabAllocator(CIRCUIT_SIZE);
+
+    const crs = await Crs.new(2 ** 20 + 1);
+    await api.srsInitSrs(new RawBuffer(crs.getG1Data()), crs.numPoints, new RawBuffer(crs.getG2Data()));
+  }, 60000);
+
+  afterAll(async () => {
+    await api.destroy();
+  });
+
+  it('should construct 512k gate proof', async () => {
+    const valid = await api.examplesSimpleCreateAndVerifyProof();
+    expect(valid).toBe(true);
+  }, 300000);
+});

package/src/index.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>My App</title>
+  </head>
+  <body>
+    <script src="simple_test.js"></script>
+  </body>
+</html>

package/src/index.ts

@@ -0,0 +1,12 @@
+export { Crs, GrumpkinCrs } from './crs/index.js';
+export {
+  BackendOptions,
+  Barretenberg,
+  BarretenbergSync,
+  BarretenbergVerifier,
+  UltraPlonkBackend,
+  UltraHonkBackend,
+  AztecClientBackend,
+} from './barretenberg/index.js';
+export { RawBuffer, Fr } from './types/index.js';
+export { splitHonkProof, reconstructHonkProof, ProofData } from './proof/index.js';