@aztec/bb.js 0.0.1-alpha.7 → 0.0.1-commit.0208eb9

package/src/barretenberg/testing/fields.ts

@@ -0,0 +1,63 @@
+import { randomBytes } from '../../random/index.js';
+import {
+  buffer32BytesToBigIntBE,
+  uint8ArrayToBigIntBE,
+  bigIntToBufferBE,
+  bigIntToUint8ArrayBE,
+} from './bigint-buffer.js';
+
+export class Fr {
+  static ZERO = new Fr(0n);
+  static MODULUS = 0x30644e72e131a029b85045b68181585d2833e84879b9709143e1f593f0000001n;
+  static MAX_VALUE = this.MODULUS - 1n;
+  static SIZE_IN_BYTES = 32;
+  value: Uint8Array;
+
+  constructor(value: Uint8Array | Buffer | bigint) {
+    // We convert buffer value to bigint to be able to check it fits within modulus
+    const valueBigInt =
+      typeof value === 'bigint'
+        ? value
+        : value instanceof Buffer
+          ? buffer32BytesToBigIntBE(value)
+          : uint8ArrayToBigIntBE(value);
+
+    if (valueBigInt > Fr.MAX_VALUE) {
+      throw new Error(`Value 0x${valueBigInt.toString(16)} is greater or equal to field modulus.`);
+    }
+
+    this.value =
+      typeof value === 'bigint' ? bigIntToUint8ArrayBE(value) : value instanceof Buffer ? new Uint8Array(value) : value;
+  }
+
+  static random() {
+    const r = uint8ArrayToBigIntBE(randomBytes(64)) % Fr.MODULUS;
+    return new this(r);
+  }
+
+  toBuffer() {
+    return this.value;
+  }
+
+  toString() {
+    return '0x' + this.toBuffer().reduce((accumulator, byte) => accumulator + byte.toString(16).padStart(2, '0'), '');
+  }
+
+  equals(rhs: Fr) {
+    return this.value.every((v, i) => v === rhs.value[i]);
+  }
+
+  isZero() {
+    return this.value.every(v => v === 0);
+  }
+
+  static fromBuffer(value: Uint8Array): Fr {
+    return Fr.fromBufferReduce(value);
+  }
+
+  static fromBufferReduce(value: Uint8Array): Fr {
+    const valueBigInt = uint8ArrayToBigIntBE(value);
+    const reducedValue = valueBigInt % Fr.MODULUS;
+    return new Fr(reducedValue);
+  }
+}

package/src/barretenberg_wasm/barretenberg_wasm_base/index.ts

@@ -0,0 +1,137 @@
+import { randomBytes } from '../../random/index.js';
+
+/**
+ * Base implementation of BarretenbergWasm.
+ * Contains code that is common to the "main thread" implementation and the "child thread" implementation.
+ */
+export class BarretenbergWasmBase {
+  protected memStore: { [key: string]: Uint8Array } = {};
+  protected memory!: WebAssembly.Memory;
+  protected instance!: WebAssembly.Instance;
+  protected logger: (msg: string) => void = () => {};
+
+  protected getImportObj(memory: WebAssembly.Memory) {
+    /* eslint-disable camelcase */
+    const importObj = {
+      // We need to implement a part of the wasi api:
+      // https://github.com/WebAssembly/WASI/blob/main/phases/snapshot/docs.md
+      // We literally only need to support random_get, everything else is noop implementated in barretenberg.wasm.
+      wasi_snapshot_preview1: {
+        random_get: (out: any, length: number) => {
+          out = out >>> 0;
+          const randomData = randomBytes(length);
+          const mem = this.getMemory();
+          mem.set(randomData, out);
+        },
+        clock_time_get: (a1: number, a2: number, out: number) => {
+          out = out >>> 0;
+          const ts = BigInt(new Date().getTime()) * 1000000n;
+          const view = new DataView(this.getMemory().buffer);
+          view.setBigUint64(out, ts, true);
+        },
+        proc_exit: () => {
+          this.logger('PANIC: proc_exit was called.');
+          throw new Error();
+        },
+      },
+
+      // These are functions implementations for imports we've defined are needed.
+      // The native C++ build defines these in a module called "env". We must implement TypeScript versions here.
+      env: {
+        /**
+         * The 'info' call we use for logging in C++, calls this under the hood.
+         * The native code will just print to std:err (to avoid std::cout which is used for IPC).
+         * Here we just emit the log line for the client to decide what to do with.
+         */
+        logstr: (addr: number) => {
+          const str = this.stringFromAddress(addr);
+          const m = this.getMemory();
+          const str2 = `${str} (mem: ${(m.length / (1024 * 1024)).toFixed(2)}MiB)`;
+          this.logger(str2);
+        },
+
+        throw_or_abort_impl: (addr: number) => {
+          const str = this.stringFromAddress(addr);
+          throw new Error(str);
+        },
+
+        get_data: (keyAddr: number, outBufAddr: number) => {
+          const key = this.stringFromAddress(keyAddr);
+          outBufAddr = outBufAddr >>> 0;
+          const data = this.memStore[key];
+          if (!data) {
+            this.logger(`get_data miss ${key}`);
+            return;
+          }
+          // this.logger(`get_data hit ${key} size: ${data.length} dest: ${outBufAddr}`);
+          // this.logger(Buffer.from(data.slice(0, 64)).toString('hex'));
+          this.writeMemory(outBufAddr, data);
+        },
+
+        set_data: (keyAddr: number, dataAddr: number, dataLength: number) => {
+          const key = this.stringFromAddress(keyAddr);
+          dataAddr = dataAddr >>> 0;
+          this.memStore[key] = this.getMemorySlice(dataAddr, dataAddr + dataLength);
+          // this.logger(`set_data: ${key} length: ${dataLength}`);
+        },
+
+        memory,
+      },
+    };
+    /* eslint-enable camelcase */
+
+    return importObj;
+  }
+
+  public exports(): any {
+    return this.instance.exports;
+  }
+
+  /**
+   * When returning values from the WASM, use >>> operator to convert signed representation to unsigned representation.
+   */
+  public call(name: string, ...args: any) {
+    if (!this.exports()[name]) {
+      throw new Error(`WASM function ${name} not found.`);
+    }
+    try {
+      return this.exports()[name](...args) >>> 0;
+    } catch (err: any) {
+      const message = `WASM function ${name} aborted, error: ${err}`;
+      this.logger(message);
+      this.logger(err.stack);
+      throw err;
+    }
+  }
+
+  public memSize() {
+    return this.getMemory().length;
+  }
+
+  /**
+   * Returns a copy of the data, not a view.
+   */
+  public getMemorySlice(start: number, end: number) {
+    return this.getMemory().subarray(start, end).slice();
+  }
+
+  public writeMemory(offset: number, arr: Uint8Array) {
+    const mem = this.getMemory();
+    mem.set(arr, offset);
+  }
+
+  public getMemory() {
+    return new Uint8Array(this.memory.buffer);
+  }
+
+  // PRIVATE METHODS
+
+  private stringFromAddress(addr: number) {
+    addr = addr >>> 0;
+    const m = this.getMemory();
+    let i = addr;
+    for (; m[i] !== 0; ++i);
+    const textDecoder = new TextDecoder('ascii');
+    return textDecoder.decode(m.slice(addr, i));
+  }
+}

package/src/barretenberg_wasm/barretenberg_wasm_main/factory/browser/index.ts

@@ -0,0 +1,9 @@
+import { readinessListener } from '../../../helpers/browser/index.js';
+
+export async function createMainWorker() {
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  const worker = new Worker(new URL('./main.worker.js', import.meta.url), { type: 'module' });
+  await new Promise<void>(resolve => readinessListener(worker, resolve));
+  return worker;
+}

package/src/barretenberg_wasm/barretenberg_wasm_main/factory/browser/main.worker.ts

@@ -0,0 +1,6 @@
+import { expose } from 'comlink';
+import { BarretenbergWasmMain } from '../../index.js';
+import { Ready } from '../../../helpers/browser/index.js';
+
+expose(new BarretenbergWasmMain());
+postMessage(Ready);

package/src/barretenberg_wasm/barretenberg_wasm_main/factory/node/index.ts

@@ -0,0 +1,19 @@
+import { Worker } from 'worker_threads';
+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));
+  }
+}
+
+export function createMainWorker() {
+  const __dirname = getCurrentDir();
+  const worker = new Worker(__dirname + `/main.worker.js`);
+  return Promise.resolve(worker);
+}

package/src/barretenberg_wasm/barretenberg_wasm_main/factory/node/main.worker.ts

@@ -0,0 +1,10 @@
+import { parentPort } from 'worker_threads';
+import { expose } from 'comlink';
+import { BarretenbergWasmMain } from '../../index.js';
+import { nodeEndpoint } from '../../../helpers/node/node_endpoint.js';
+
+if (!parentPort) {
+  throw new Error('No parentPort');
+}
+
+expose(new BarretenbergWasmMain(), nodeEndpoint(parentPort));

package/src/barretenberg_wasm/barretenberg_wasm_main/heap_allocator.ts

@@ -0,0 +1,72 @@
+import { type BarretenbergWasmMain } from './index.js';
+
+/**
+ * Keeps track of heap allocations so they can be easily freed.
+ * The WASM memory layout has 1024 bytes of unused "scratch" space at the start (addresses 0-1023).
+ * We can leverage this for IO rather than making expensive bb_malloc bb_free calls.
+ * Heap allocations will be created for input/output args that don't fit into the scratch space.
+ * Input scratch grows UP from 0, output scratch grows DOWN from 1024, meeting in the middle.
+ * This maximizes space utilization while preventing overlap.
+ */
+export class HeapAllocator {
+  private allocs: number[] = [];
+  private inScratchPtr = 0; // Next input starts here, grows UP
+  private outScratchPtr = 1024; // Next output ends here, grows DOWN
+
+  constructor(private wasm: BarretenbergWasmMain) {}
+
+  getInputs(buffers: (Uint8Array | number)[]) {
+    return buffers.map(bufOrNum => {
+      if (typeof bufOrNum === 'object') {
+        const size = bufOrNum.length;
+        // Check if there's room in scratch space (inputs grow up, outputs grow down)
+        if (this.inScratchPtr + size <= this.outScratchPtr) {
+          const ptr = this.inScratchPtr;
+          this.inScratchPtr += size; // Grow UP
+          this.wasm.writeMemory(ptr, bufOrNum);
+          return ptr;
+        } else {
+          // Fall back to heap allocation
+          const ptr = this.wasm.call('bbmalloc', size);
+          this.wasm.writeMemory(ptr, bufOrNum);
+          this.allocs.push(ptr);
+          return ptr;
+        }
+      } else {
+        return bufOrNum;
+      }
+    });
+  }
+
+  getOutputPtrs(outLens: (number | undefined)[]) {
+    return outLens.map(len => {
+      // If the obj is variable length, we need a 4 byte ptr to write the serialized data address to.
+      // WARNING: 4 only works with WASM as it has 32 bit memory.
+      const size = len || 4;
+
+      // Check if there's room in scratch space (inputs grow up, outputs grow down)
+      if (this.inScratchPtr + size <= this.outScratchPtr) {
+        this.outScratchPtr -= size; // Grow DOWN
+        return this.outScratchPtr;
+      } else {
+        // Fall back to heap allocation
+        const ptr = this.wasm.call('bbmalloc', size);
+        this.allocs.push(ptr);
+        return ptr;
+      }
+    });
+  }
+
+  addOutputPtr(ptr: number) {
+    // Only add to dealloc list if it's a heap allocation (not in scratch space 0-1023)
+    if (ptr >= 1024) {
+      this.allocs.push(ptr);
+    }
+  }
+
+  freeAll() {
+    for (const ptr of this.allocs) {
+      this.wasm.call('bbfree', ptr);
+    }
+  }
+}

package/src/barretenberg_wasm/barretenberg_wasm_main/index.ts

@@ -0,0 +1,251 @@
+import { type Worker } from 'worker_threads';
+import { Remote } from 'comlink';
+import { getNumCpu, getRemoteBarretenbergWasm, getSharedMemoryAvailable } from '../helpers/index.js';
+import { createThreadWorker } from '../barretenberg_wasm_thread/factory/node/index.js';
+import { type BarretenbergWasmThreadWorker } from '../barretenberg_wasm_thread/index.js';
+import { BarretenbergWasmBase } from '../barretenberg_wasm_base/index.js';
+import { HeapAllocator } from './heap_allocator.js';
+
+/**
+ * This is the "main thread" implementation of BarretenbergWasm.
+ * It spawns a bunch of "child thread" implementations.
+ * In a browser context, this still runs on a worker, as it will block waiting on child threads.
+ */
+export class BarretenbergWasmMain extends BarretenbergWasmBase {
+  static MAX_THREADS = 32;
+  private workers: Worker[] = [];
+  private remoteWasms: BarretenbergWasmThreadWorker[] = [];
+  private nextWorker = 0;
+  private nextThreadId = 1;
+  private useCustomLogger = false;
+
+  // Pre-allocated scratch buffers for msgpack I/O to avoid malloc/free overhead
+  private msgpackInputScratch: number = 0; // 8MB input buffer
+  private msgpackOutputScratch: number = 0; // 8MB output buffer
+  private readonly MSGPACK_SCRATCH_SIZE = 1024 * 1024 * 8; // 8MB
+
+  public getNumThreads() {
+    return this.workers.length + 1;
+  }
+
+  /**
+   * Init as main thread. Spawn child threads.
+   */
+  public async init(
+    module: WebAssembly.Module,
+    threads = Math.min(getNumCpu(), BarretenbergWasmMain.MAX_THREADS),
+    logger?: (msg: string) => void,
+    initial = 35,
+    maximum = this.getDefaultMaximumMemoryPages(),
+  ) {
+    // Track whether a custom logger was provided so workers know whether to postMessage logs
+    this.useCustomLogger = logger !== undefined;
+    this.logger = logger ?? (() => {});
+
+    const initialMb = (initial * 2 ** 16) / (1024 * 1024);
+    const maxMb = (maximum * 2 ** 16) / (1024 * 1024);
+    const shared = getSharedMemoryAvailable();
+
+    this.logger(
+      `Initializing bb wasm: initial memory ${initial} pages ${initialMb}MiB; ` +
+        `max memory: ${maximum} pages, ${maxMb}MiB; ` +
+        `threads: ${threads}; shared memory: ${shared}`,
+    );
+
+    this.memory = new WebAssembly.Memory({ initial, maximum, shared });
+
+    const instance = await WebAssembly.instantiate(module, this.getImportObj(this.memory));
+
+    this.instance = instance;
+
+    // Init all global/static data.
+    this.call('_initialize');
+
+    // Allocate dedicated msgpack scratch buffers (never freed, reused for all msgpack calls)
+    this.msgpackInputScratch = this.call('bbmalloc', this.MSGPACK_SCRATCH_SIZE);
+    this.msgpackOutputScratch = this.call('bbmalloc', this.MSGPACK_SCRATCH_SIZE);
+    this.logger(
+      `Allocated msgpack scratch buffers: ` +
+        `input @ ${this.msgpackInputScratch}, output @ ${this.msgpackOutputScratch} (${this.MSGPACK_SCRATCH_SIZE} bytes each)`,
+    );
+
+    // Create worker threads. Create 1 less than requested, as main thread counts as a thread.
+    if (threads > 1) {
+      this.logger(`Creating ${threads} worker threads`);
+      this.workers = await Promise.all(Array.from({ length: threads - 1 }).map(createThreadWorker));
+
+      // Set up log message forwarding from workers to our logger (only if custom logger provided)
+      if (this.useCustomLogger) {
+        this.workers.forEach(worker => this.setupWorkerLogForwarding(worker));
+      }
+
+      this.remoteWasms = await Promise.all(this.workers.map(getRemoteBarretenbergWasm<BarretenbergWasmThreadWorker>));
+      await Promise.all(this.remoteWasms.map(w => w.initThread(module, this.memory, this.useCustomLogger)));
+    }
+  }
+
+  private getDefaultMaximumMemoryPages(): number {
+    // iOS browser is very aggressive with memory. Check if running in browser and on iOS
+    // We at any rate expect the mobile iOS browser to kill us >=1GB, so we don't set a maximum higher than that.
+    if (typeof window !== 'undefined' && /iPad|iPhone/.test(navigator.userAgent)) {
+      return 2 ** 14;
+    }
+    return 2 ** 16;
+  }
+
+  /**
+   * Set up forwarding of log messages from worker threads to our logger.
+   * Workers post messages with { type: 'log', msg: string } which we intercept here.
+   */
+  private setupWorkerLogForwarding(worker: Worker) {
+    const handler = (data: unknown) => {
+      if (data && typeof data === 'object' && 'type' in data && data.type === 'log' && 'msg' in data) {
+        this.logger(data.msg as string);
+      }
+    };
+
+    // Node Workers use 'on' method, browser Workers use 'addEventListener'
+    // The 'worker' variable is typed as Node's Worker, but at runtime in browser
+    // it will be a browser Worker (due to browser_postprocess.sh import rewriting)
+    if ('on' in worker && typeof worker.on === 'function') {
+      // Node.js worker_threads Worker
+      worker.on('message', handler);
+    } else if ('addEventListener' in worker) {
+      // Browser Web Worker
+      (worker as unknown as globalThis.Worker).addEventListener('message', (event: MessageEvent) => {
+        handler(event.data);
+      });
+    }
+  }
+
+  /**
+   * Called on main thread. Signals child threads to gracefully exit.
+   */
+  public async destroy() {
+    await Promise.all(this.workers.map(w => w.terminate()));
+  }
+
+  protected getImportObj(memory: WebAssembly.Memory) {
+    const baseImports = super.getImportObj(memory);
+
+    /* eslint-disable camelcase */
+    return {
+      ...baseImports,
+      wasi: {
+        'thread-spawn': (arg: number) => {
+          arg = arg >>> 0;
+          const id = this.nextThreadId++;
+          const worker = this.nextWorker++ % this.remoteWasms.length;
+          // this.logger(`spawning thread ${id} on worker ${worker} with arg ${arg >>> 0}`);
+          this.remoteWasms[worker].call('wasi_thread_start', id, arg).catch(this.logger);
+          // this.remoteWasms[worker].postMessage({ msg: 'thread', data: { id, arg } });
+          return id;
+        },
+      },
+      env: {
+        ...baseImports.env,
+        env_hardware_concurrency: () => {
+          // If there are no workers (we're already running as a worker, or the main thread requested no workers)
+          // then we return 1, which should cause any algos using threading to just not create a thread.
+          return this.remoteWasms.length + 1;
+        },
+      },
+    };
+    /* eslint-enable camelcase */
+  }
+
+  callWasmExport(funcName: string, inArgs: (Uint8Array | number)[], outLens: (number | undefined)[]) {
+    const alloc = new HeapAllocator(this);
+    const inPtrs = alloc.getInputs(inArgs);
+    const outPtrs = alloc.getOutputPtrs(outLens);
+    this.call(funcName, ...inPtrs, ...outPtrs);
+    const outArgs = this.getOutputArgs(outLens, outPtrs, alloc);
+    alloc.freeAll();
+    return outArgs;
+  }
+
+  private getOutputArgs(outLens: (number | undefined)[], outPtrs: number[], alloc: HeapAllocator) {
+    return outLens.map((len, i) => {
+      if (len) {
+        return this.getMemorySlice(outPtrs[i], outPtrs[i] + len);
+      }
+      const slice = this.getMemorySlice(outPtrs[i], outPtrs[i] + 4);
+      const ptr = new DataView(slice.buffer, slice.byteOffset, slice.byteLength).getUint32(0, true);
+
+      // Add our heap buffer to the dealloc list.
+      alloc.addOutputPtr(ptr);
+
+      // The length will be found in the first 4 bytes of the buffer, big endian. See to_heap_buffer.
+      const lslice = this.getMemorySlice(ptr, ptr + 4);
+      const length = new DataView(lslice.buffer, lslice.byteOffset, lslice.byteLength).getUint32(0, false);
+
+      return this.getMemorySlice(ptr + 4, ptr + 4 + length);
+    });
+  }
+
+  cbindCall(cbind: string, inputBuffer: Uint8Array): any {
+    const needsCustomInputBuffer = inputBuffer.length > this.MSGPACK_SCRATCH_SIZE;
+    let inputPtr: number;
+
+    if (needsCustomInputBuffer) {
+      // Allocate temporary buffer for oversized input
+      inputPtr = this.call('bbmalloc', inputBuffer.length);
+    } else {
+      // Use pre-allocated scratch buffer
+      inputPtr = this.msgpackInputScratch;
+    }
+
+    // Write input to buffer
+    this.writeMemory(inputPtr, inputBuffer);
+
+    // Setup output scratch buffer with IN-OUT parameter pattern:
+    // Reserve 8 bytes for metadata (pointer + size), rest is scratch data space
+    const METADATA_SIZE = 8;
+    const outputPtrLocation = this.msgpackOutputScratch;
+    const outputSizeLocation = this.msgpackOutputScratch + 4;
+    const scratchDataPtr = this.msgpackOutputScratch + METADATA_SIZE;
+    const scratchDataSize = this.MSGPACK_SCRATCH_SIZE - METADATA_SIZE;
+
+    // Get memory and create DataView for writing IN values
+    let mem = this.getMemory();
+    let view = new DataView(mem.buffer);
+
+    // Write IN values: provide scratch buffer pointer and size to C++
+    view.setUint32(outputPtrLocation, scratchDataPtr, true);
+    view.setUint32(outputSizeLocation, scratchDataSize, true);
+
+    // Call WASM
+    this.call(cbind, inputPtr, inputBuffer.length, outputPtrLocation, outputSizeLocation);
+
+    // Free custom input buffer if allocated
+    if (needsCustomInputBuffer) {
+      this.call('bbfree', inputPtr);
+    }
+
+    // Re-fetch memory after WASM call, as the buffer may have been detached if memory grew
+    mem = this.getMemory();
+    view = new DataView(mem.buffer);
+
+    // Read OUT values: C++ returns actual buffer pointer and size
+    const outputDataPtr = view.getUint32(outputPtrLocation, true);
+    const outputSize = view.getUint32(outputSizeLocation, true);
+
+    // Check if C++ used scratch (pointer unchanged) or allocated (pointer changed)
+    const usedScratch = outputDataPtr === scratchDataPtr;
+
+    // Copy output data from WASM memory
+    const encodedResult = this.getMemorySlice(outputDataPtr, outputDataPtr + outputSize);
+
+    // Only free if C++ allocated beyond scratch
+    if (!usedScratch) {
+      this.call('bbfree', outputDataPtr);
+    }
+
+    return encodedResult;
+  }
+}
+
+/**
+ * The comlink type that asyncifies the BarretenbergWasmMain api.
+ */
+export type BarretenbergWasmMainWorker = Remote<BarretenbergWasmMain>;

package/src/barretenberg_wasm/barretenberg_wasm_thread/factory/browser/index.ts

@@ -0,0 +1,9 @@
+import { readinessListener } from '../../../helpers/browser/index.js';
+
+export async function createThreadWorker() {
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  const worker = new Worker(new URL('./thread.worker.js', import.meta.url), { type: 'module' });
+  await new Promise<void>(resolve => readinessListener(worker, resolve));
+  return worker;
+}

package/src/barretenberg_wasm/barretenberg_wasm_thread/factory/browser/thread.worker.ts

@@ -0,0 +1,6 @@
+import { expose } from 'comlink';
+import { BarretenbergWasmThread } from '../../index.js';
+import { Ready } from '../../../helpers/browser/index.js';
+
+expose(new BarretenbergWasmThread());
+postMessage(Ready);

package/src/barretenberg_wasm/barretenberg_wasm_thread/factory/node/index.ts

@@ -0,0 +1,19 @@
+import { Worker } from 'worker_threads';
+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));
+  }
+}
+
+export function createThreadWorker() {
+  const __dirname = getCurrentDir();
+  const worker = new Worker(__dirname + `/thread.worker.js`);
+  return Promise.resolve(worker);
+}

package/src/barretenberg_wasm/barretenberg_wasm_thread/factory/node/thread.worker.ts

@@ -0,0 +1,12 @@
+import { parentPort } from 'worker_threads';
+import { expose } from 'comlink';
+import { BarretenbergWasmThread } from '../../index.js';
+import { nodeEndpoint } from '../../../helpers/node/node_endpoint.js';
+
+if (!parentPort) {
+  throw new Error('No parentPort');
+}
+
+const endpoint = nodeEndpoint(parentPort);
+
+expose(new BarretenbergWasmThread(), endpoint);

package/src/barretenberg_wasm/barretenberg_wasm_thread/index.ts

@@ -0,0 +1,48 @@
+import { Remote } from 'comlink';
+import { killSelf, threadLogger } from '../helpers/index.js';
+import { BarretenbergWasmBase } from '../barretenberg_wasm_base/index.js';
+
+export class BarretenbergWasmThread extends BarretenbergWasmBase {
+  /**
+   * Init as worker thread.
+   * @param useCustomLogger - If true, logs will be posted back to main thread for custom logger routing
+   */
+  public async initThread(module: WebAssembly.Module, memory: WebAssembly.Memory, useCustomLogger = false) {
+    this.logger = threadLogger(useCustomLogger) || this.logger;
+    this.memory = memory;
+    this.instance = await WebAssembly.instantiate(module, this.getImportObj(this.memory));
+  }
+
+  public destroy() {
+    killSelf();
+  }
+
+  protected getImportObj(memory: WebAssembly.Memory) {
+    const baseImports = super.getImportObj(memory);
+
+    /* eslint-disable camelcase */
+    return {
+      ...baseImports,
+      wasi: {
+        'thread-spawn': () => {
+          this.logger('PANIC: threads cannot spawn threads!');
+          this.logger(new Error().stack!);
+          killSelf();
+        },
+      },
+
+      // These are functions implementations for imports we've defined are needed.
+      // The native C++ build defines these in a module called "env". We must implement TypeScript versions here.
+      env: {
+        ...baseImports.env,
+        env_hardware_concurrency: () => {
+          // We return 1, which should cause any algos using threading to just not create a thread.
+          return 1;
+        },
+      },
+    };
+    /* eslint-enable camelcase */
+  }
+}
+
+export type BarretenbergWasmThreadWorker = Remote<BarretenbergWasmThread>;

package/src/barretenberg_wasm/fetch_code/browser/barretenberg-threads.ts

@@ -0,0 +1,3 @@
+import barretenbergThreadsModule from '../../barretenberg-threads.wasm.gz';
+
+export default barretenbergThreadsModule;

package/src/barretenberg_wasm/fetch_code/browser/barretenberg.ts

@@ -0,0 +1,3 @@
+import barretenbergModule from '../../barretenberg.wasm.gz';
+
+export default barretenbergModule;