@aztec/bb.js 0.0.1-alpha.0

package/dest/types/point.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="node" resolution-mode="require"/>
+import { Fr } from './index.js';
+import { BufferReader } from '../serialize/buffer_reader.js';
+export declare class Point {
+    readonly x: Fr;
+    readonly y: Fr;
+    static SIZE_IN_BYTES: number;
+    static EMPTY: Point;
+    constructor(x: Fr, y: Fr);
+    static random(): Point;
+    static fromBuffer(buffer: Uint8Array | BufferReader): Point;
+    static fromString(address: string): Point;
+    toBuffer(): Buffer;
+    toString(): string;
+    equals(rhs: Point): boolean;
+}
+//# sourceMappingURL=point.d.ts.map

package/dest/types/point.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"point.d.ts","sourceRoot":"","sources":["../../src/types/point.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,YAAY,CAAC;AAChC,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAE7D,qBAAa,KAAK;aAIY,CAAC,EAAE,EAAE;aAAkB,CAAC,EAAE,EAAE;IAHxD,MAAM,CAAC,aAAa,SAAM;IAC1B,MAAM,CAAC,KAAK,QAA+B;gBAEf,CAAC,EAAE,EAAE,EAAkB,CAAC,EAAE,EAAE;IAExD,MAAM,CAAC,MAAM;IAKb,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,GAAG,YAAY;IAKnD,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM;IAIjC,QAAQ;IAIR,QAAQ;IAIR,MAAM,CAAC,GAAG,EAAE,KAAK;CAGlB"}

package/dest/types/point.js

@@ -0,0 +1,32 @@
+import { Fr } from './index.js';
+import { BufferReader } from '../serialize/buffer_reader.js';
+class Point {
+    constructor(x, y) {
+        this.x = x;
+        this.y = y;
+    }
+    static random() {
+        // TODO: This is not a point on the curve!
+        return new Point(Fr.random(), Fr.random());
+    }
+    static fromBuffer(buffer) {
+        const reader = BufferReader.asReader(buffer);
+        return new this(Fr.fromBuffer(reader), Fr.fromBuffer(reader));
+    }
+    static fromString(address) {
+        return Point.fromBuffer(Buffer.from(address.replace(/^0x/i, ''), 'hex'));
+    }
+    toBuffer() {
+        return Buffer.concat([this.x.toBuffer(), this.y.toBuffer()]);
+    }
+    toString() {
+        return '0x' + this.toBuffer().toString('hex');
+    }
+    equals(rhs) {
+        return this.x.equals(rhs.x) && this.y.equals(rhs.y);
+    }
+}
+Point.SIZE_IN_BYTES = 64;
+Point.EMPTY = new Point(Fr.ZERO, Fr.ZERO);
+export { Point };
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicG9pbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdHlwZXMvcG9pbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLEVBQUUsRUFBRSxNQUFNLFlBQVksQ0FBQztBQUNoQyxPQUFPLEVBQUUsWUFBWSxFQUFFLE1BQU0sK0JBQStCLENBQUM7QUFFN0QsTUFBYSxLQUFLO0lBSWhCLFlBQTRCLENBQUssRUFBa0IsQ0FBSztRQUE1QixNQUFDLEdBQUQsQ0FBQyxDQUFJO1FBQWtCLE1BQUMsR0FBRCxDQUFDLENBQUk7SUFBRyxDQUFDO0lBRTVELE1BQU0sQ0FBQyxNQUFNO1FBQ1gsMENBQTBDO1FBQzFDLE9BQU8sSUFBSSxLQUFLLENBQUMsRUFBRSxDQUFDLE1BQU0sRUFBRSxFQUFFLEVBQUUsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxDQUFDO0lBQzdDLENBQUM7SUFFRCxNQUFNLENBQUMsVUFBVSxDQUFDLE1BQWlDO1FBQ2pELE1BQU0sTUFBTSxHQUFHLFlBQVksQ0FBQyxRQUFRLENBQUMsTUFBTSxDQUFDLENBQUM7UUFDN0MsT0FBTyxJQUFJLElBQUksQ0FBQyxFQUFFLENBQUMsVUFBVSxDQUFDLE1BQU0sQ0FBQyxFQUFFLEVBQUUsQ0FBQyxVQUFVLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQztJQUNoRSxDQUFDO0lBRUQsTUFBTSxDQUFDLFVBQVUsQ0FBQyxPQUFlO1FBQy9CLE9BQU8sS0FBSyxDQUFDLFVBQVUsQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsTUFBTSxFQUFFLEVBQUUsQ0FBQyxFQUFFLEtBQUssQ0FBQyxDQUFDLENBQUM7SUFDM0UsQ0FBQztJQUVELFFBQVE7UUFDTixPQUFPLE1BQU0sQ0FBQyxNQUFNLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLFFBQVEsRUFBRSxFQUFFLElBQUksQ0FBQyxDQUFDLENBQUMsUUFBUSxFQUFFLENBQUMsQ0FBQyxDQUFDO0lBQy9ELENBQUM7SUFFRCxRQUFRO1FBQ04sT0FBTyxJQUFJLEdBQUcsSUFBSSxDQUFDLFFBQVEsRUFBRSxDQUFDLFFBQVEsQ0FBQyxLQUFLLENBQUMsQ0FBQztJQUNoRCxDQUFDO0lBRUQsTUFBTSxDQUFDLEdBQVU7UUFDZixPQUFPLElBQUksQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsSUFBSSxJQUFJLENBQUMsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFDdEQsQ0FBQzs7QUE3Qk0sbUJBQWEsR0FBRyxFQUFFLENBQUM7QUFDbkIsV0FBSyxHQUFHLElBQUksS0FBSyxDQUFDLEVBQUUsQ0FBQyxJQUFJLEVBQUUsRUFBRSxDQUFDLElBQUksQ0FBQyxDQUFDO1NBRmhDLEtBQUsifQ==

package/dest/types/ptr.d.ts

@@ -0,0 +1,13 @@
+import { BufferReader } from '../serialize/index.js';
+/**
+ * Holds an opaque pointer into WASM memory.
+ * Currently only 4 bytes, but could grow to 8 bytes with wasm64.
+ */
+export declare class Ptr {
+    readonly value: Uint8Array;
+    static SIZE_IN_BYTES: number;
+    constructor(value: Uint8Array);
+    static fromBuffer(buffer: Uint8Array | BufferReader): Ptr;
+    toBuffer(): Uint8Array;
+}
+//# sourceMappingURL=ptr.d.ts.map

package/dest/types/ptr.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ptr.d.ts","sourceRoot":"","sources":["../../src/types/ptr.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD;;;GAGG;AACH,qBAAa,GAAG;aAGc,KAAK,EAAE,UAAU;IAF7C,MAAM,CAAC,aAAa,SAAK;gBAEG,KAAK,EAAE,UAAU;IAE7C,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,GAAG,YAAY;IAKnD,QAAQ;CAGT"}

package/dest/types/ptr.js

@@ -0,0 +1,20 @@
+import { BufferReader } from '../serialize/index.js';
+/**
+ * Holds an opaque pointer into WASM memory.
+ * Currently only 4 bytes, but could grow to 8 bytes with wasm64.
+ */
+class Ptr {
+    constructor(value) {
+        this.value = value;
+    }
+    static fromBuffer(buffer) {
+        const reader = BufferReader.asReader(buffer);
+        return new this(reader.readBytes(this.SIZE_IN_BYTES));
+    }
+    toBuffer() {
+        return this.value;
+    }
+}
+Ptr.SIZE_IN_BYTES = 4;
+export { Ptr };
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHRyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3R5cGVzL3B0ci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsWUFBWSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFFckQ7OztHQUdHO0FBQ0gsTUFBYSxHQUFHO0lBR2QsWUFBNEIsS0FBaUI7UUFBakIsVUFBSyxHQUFMLEtBQUssQ0FBWTtJQUFHLENBQUM7SUFFakQsTUFBTSxDQUFDLFVBQVUsQ0FBQyxNQUFpQztRQUNqRCxNQUFNLE1BQU0sR0FBRyxZQUFZLENBQUMsUUFBUSxDQUFDLE1BQU0sQ0FBQyxDQUFDO1FBQzdDLE9BQU8sSUFBSSxJQUFJLENBQUMsTUFBTSxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsYUFBYSxDQUFDLENBQUMsQ0FBQztJQUN4RCxDQUFDO0lBRUQsUUFBUTtRQUNOLE9BQU8sSUFBSSxDQUFDLEtBQUssQ0FBQztJQUNwQixDQUFDOztBQVhNLGlCQUFhLEdBQUcsQ0FBQyxDQUFDO1NBRGQsR0FBRyJ9

package/dest/types/raw_buffer.d.ts

@@ -0,0 +1,3 @@
+export declare class RawBuffer extends Uint8Array {
+}
+//# sourceMappingURL=raw_buffer.d.ts.map

package/dest/types/raw_buffer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"raw_buffer.d.ts","sourceRoot":"","sources":["../../src/types/raw_buffer.ts"],"names":[],"mappings":"AAEA,qBAAa,SAAU,SAAQ,UAAU;CAAG"}

package/dest/types/raw_buffer.js

@@ -0,0 +1,5 @@
+// Used when the data is to be sent exactly as is. i.e. no length prefix will be added.
+// This is useful for sending structured data that can be parsed-as-you-go, as opposed to just an array of bytes.
+export class RawBuffer extends Uint8Array {
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmF3X2J1ZmZlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy90eXBlcy9yYXdfYnVmZmVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLHVGQUF1RjtBQUN2RixpSEFBaUg7QUFDakgsTUFBTSxPQUFPLFNBQVUsU0FBUSxVQUFVO0NBQUcifQ==

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@aztec/bb.js",
+  "version": "0.0.1-alpha.0",
+  "type": "module",
+  "typedoc": {
+    "entryPoint": "./src/index.ts",
+    "displayName": "Barretenberg.js",
+    "tsconfig": "./tsconfig.json"
+  },
+  "bin": {
+    "bb.js": "./dest/main.js",
+    "bb.js-dev": "./src/main-dev.ts"
+  },
+  "files": [
+    "src/",
+    "dest/",
+    "README.md"
+  ],
+  "scripts": {
+    "clean": "rm -rf ./dest .tsbuildinfo",
+    "build": "yarn clean && yarn build:wasm && tsc -b && webpack && chmod +x ./dest/main.js",
+    "build:dev": "tsc -b --watch",
+    "build:wasm": "cd ../cpp && cmake --preset wasm-threads && cmake --build --preset wasm-threads && cmake --preset wasm && cmake --build --preset wasm",
+    "serve": "webpack serve",
+    "formatting": "prettier --check ./src && eslint --max-warnings 0 ./src",
+    "formatting:fix": "prettier -w ./src",
+    "test": "NODE_OPTIONS='--loader ts-node/esm' NODE_NO_WARNINGS=1 node --experimental-vm-modules $(yarn bin jest) --no-cache --passWithNoTests",
+    "test-debug": "NODE_OPTIONS='--loader ts-node/esm' NODE_NO_WARNINGS=1 node --inspect-brk=0.0.0.0 --experimental-vm-modules $(yarn bin jest) --no-cache --passWithNoTests --runInBand",
+    "simple_test": "NODE_OPTIONS='--loader ts-node/esm' NODE_NO_WARNINGS=1 node ./src/examples/simple.rawtest.ts"
+  },
+  "jest": {
+    "preset": "ts-jest/presets/default-esm",
+    "transform": {
+      "./src/.*\\.ts": [
+        "ts-jest",
+        {
+          "useESM": true
+        }
+      ]
+    },
+    "moduleNameMapper": {
+      "^(\\.{1,2}/.*)\\.js$": "$1"
+    },
+    "testRegex": "./src/.*\\.test\\.ts$",
+    "rootDir": "./src"
+  },
+  "dependencies": {
+    "commander": "^10.0.1",
+    "ts-node": "^10.9.1",
+    "tslib": "^2.4.0"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.4.3",
+    "@types/debug": "^4.1.7",
+    "@types/detect-node": "^2.0.0",
+    "@types/jest": "^29.4.0",
+    "@types/node": "^18.7.23",
+    "@types/source-map-support": "^0.5.6",
+    "@typescript-eslint/eslint-plugin": "^5.54.1",
+    "@typescript-eslint/parser": "^5.54.1",
+    "buffer": "^6.0.3",
+    "comlink": "^4.4.1",
+    "copy-webpack-plugin": "^11.0.0",
+    "debug": "^4.3.4",
+    "eslint": "^8.35.0",
+    "eslint-config-prettier": "^8.8.0",
+    "html-webpack-plugin": "^5.5.1",
+    "idb-keyval": "^6.2.1",
+    "jest": "^29.5.0",
+    "prettier": "^2.8.4",
+    "resolve-typescript-plugin": "^2.0.1",
+    "ts-jest": "^29.1.0",
+    "ts-loader": "^9.4.2",
+    "typescript": "^5.0.4",
+    "webpack": "^5.82.1",
+    "webpack-cli": "^5.1.1",
+    "webpack-dev-server": "^4.15.0"
+  }
+}

package/src/async_map/index.ts

@@ -0,0 +1,15 @@
+/**
+ * Much the same as Array.map, only it takes an async fn as an element handler, and ensures that each element handler
+ * is executed sequentially.
+ * The pattern of `await Promise.all(arr.map(async e => { ... }))` only works if one's happy with each element handler
+ * being run concurrently.
+ * If one required sequential execution of async fn's, the only alternative was regular loops with mutable state vars.
+ * The equivalent with asyncMap: `await asyncMap(arr, async e => { ... })`.
+ */
+export async function asyncMap<T, U>(arr: T[], fn: (e: T, i: number) => Promise<U>): Promise<U[]> {
+  const results: U[] = [];
+  for (let i = 0; i < arr.length; ++i) {
+    results.push(await fn(arr[i], i));
+  }
+  return results;
+}

package/src/barretenberg_api/blake2s.test.ts

@@ -0,0 +1,39 @@
+import { newBarretenbergApiSync } from '../factory/index.js';
+import { Buffer32, Fr } from '../types/index.js';
+import { BarretenbergApiSync } from './index.js';
+
+describe('blake2s', () => {
+  let api: BarretenbergApiSync;
+
+  beforeAll(async () => {
+    api = await newBarretenbergApiSync();
+  });
+
+  afterAll(async () => {
+    await api.destroy();
+  });
+
+  it('blake2s', () => {
+    const input = Buffer.from('abcdefghijklmnopqrstuvwxyz0123456789abcdefghijklmnopqrstuvwxyz0123456789');
+    const expected = Buffer32.fromBuffer(
+      new Uint8Array([
+        0x44, 0xdd, 0xdb, 0x39, 0xbd, 0xb2, 0xaf, 0x80, 0xc1, 0x47, 0x89, 0x4c, 0x1d, 0x75, 0x6a, 0xda, 0x3d, 0x1c,
+        0x2a, 0xc2, 0xb1, 0x00, 0x54, 0x1e, 0x04, 0xfe, 0x87, 0xb4, 0xa5, 0x9e, 0x12, 0x43,
+      ]),
+    );
+    const result = api.blake2s(input);
+    expect(result).toEqual(expected);
+  });
+
+  it('blake2sToField', () => {
+    const input = Buffer.from('abcdefghijklmnopqrstuvwxyz0123456789abcdefghijklmnopqrstuvwxyz0123456789');
+    const expected = Fr.fromBufferReduce(
+      new Uint8Array([
+        0x44, 0xdd, 0xdb, 0x39, 0xbd, 0xb2, 0xaf, 0x80, 0xc1, 0x47, 0x89, 0x4c, 0x1d, 0x75, 0x6a, 0xda, 0x3d, 0x1c,
+        0x2a, 0xc2, 0xb1, 0x00, 0x54, 0x1e, 0x04, 0xfe, 0x87, 0xb4, 0xa5, 0x9e, 0x12, 0x43,
+      ]),
+    );
+    const result = api.blake2sToField(input);
+    expect(result).toEqual(expected);
+  });
+});

package/src/barretenberg_api/common.test.ts

@@ -0,0 +1,21 @@
+import { BarretenbergApiAsync, newBarretenbergApiAsync } from '../factory/index.js';
+
+describe('env', () => {
+  let api: BarretenbergApiAsync;
+
+  beforeAll(async () => {
+    api = await newBarretenbergApiAsync(3);
+  });
+
+  afterAll(async () => {
+    await api.destroy();
+  });
+
+  it('thread test', async () => {
+    // Main thread doesn't do anything in this test, so -1.
+    const threads = (await api.getNumThreads()) - 1;
+    const iterations = 100000;
+    const result = await api.testThreads(threads, iterations);
+    expect(result).toBe(iterations);
+  });
+});