@aztec/bb.js 0.0.1-alpha.0

package/src/serialize/serialize.ts

@@ -0,0 +1,157 @@
+import { RawBuffer } from '../types/raw_buffer.js';
+
+// For serializing bool.
+export function boolToBuffer(b: boolean) {
+  const buf = new Uint8Array(1);
+  buf[0] = b ? 1 : 0;
+  return buf;
+}
+
+// For serializing numbers to 32 bit little-endian form.
+export function numToUInt32LE(n: number, bufferSize = 4) {
+  const buf = new Uint8Array(bufferSize);
+  new DataView(buf.buffer).setUint32(buf.byteLength - 4, n, true);
+  return buf;
+}
+
+// For serializing numbers to 32 bit big-endian form.
+export function numToUInt32BE(n: number, bufferSize = 4) {
+  const buf = new Uint8Array(bufferSize);
+  new DataView(buf.buffer).setUint32(buf.byteLength - 4, n, false);
+  return buf;
+}
+
+// For serializing signed numbers to 32 bit big-endian form.
+export function numToInt32BE(n: number, bufferSize = 4) {
+  const buf = new Uint8Array(bufferSize);
+  new DataView(buf.buffer).setInt32(buf.byteLength - 4, n, false);
+  return buf;
+}
+
+// For serializing numbers to 8 bit form.
+export function numToUInt8(n: number) {
+  const buf = new Uint8Array(1);
+  buf[0] = n;
+  return buf;
+}
+
+export function concatenateUint8Arrays(arrayOfUint8Arrays: Uint8Array[]) {
+  const totalLength = arrayOfUint8Arrays.reduce((prev, curr) => prev + curr.length, 0);
+  const result = new Uint8Array(totalLength);
+  let length = 0;
+  for (const array of arrayOfUint8Arrays) {
+    result.set(array, length);
+    length += array.length;
+  }
+  return result;
+}
+
+export function uint8ArrayToHexString(uint8Array: Uint8Array) {
+  return uint8Array.reduce((accumulator, byte) => accumulator + byte.toString(16).padStart(2, '0'), '');
+}
+
+// For serializing a buffer as a vector.
+export function serializeBufferToVector(buf: Uint8Array) {
+  return concatenateUint8Arrays([numToInt32BE(buf.length), buf]);
+}
+
+export function serializeBigInt(n: bigint, width = 32) {
+  const buf = new Uint8Array(width);
+  for (let i = 0; i < width; i++) {
+    buf[width - i - 1] = Number((n >> BigInt(i * 8)) & 0xffn);
+  }
+  return buf;
+}
+
+export function deserializeBigInt(buf: Uint8Array, offset = 0, width = 32) {
+  let result = 0n;
+  for (let i = 0; i < width; i++) {
+    result = (result << BigInt(8)) | BigInt(buf[offset + i]);
+  }
+  return { elem: result, adv: width };
+}
+
+export function serializeDate(date: Date) {
+  return serializeBigInt(BigInt(date.getTime()), 8);
+}
+
+export function deserializeBufferFromVector(vector: Uint8Array, offset = 0) {
+  const length = new DataView(vector.buffer, vector.byteOffset + offset, 4).getUint32(0, false);
+  const adv = 4 + length;
+  const elem = vector.slice(offset + 4, offset + adv);
+  return { elem, adv };
+}
+
+export function deserializeBool(buf: Uint8Array, offset = 0) {
+  const adv = 1;
+  const elem = buf[offset] !== 0;
+  return { elem, adv };
+}
+
+export function deserializeUInt32(buf: Uint8Array, offset = 0) {
+  const adv = 4;
+  const elem = new DataView(buf.buffer, buf.byteOffset + offset, adv).getUint32(0, false);
+  return { elem, adv };
+}
+
+export function deserializeInt32(buf: Uint8Array, offset = 0) {
+  const adv = 4;
+  const elem = new DataView(buf.buffer, buf.byteOffset + offset, adv).getInt32(0, false);
+  return { elem, adv };
+}
+
+export function deserializeField(buf: Uint8Array, offset = 0) {
+  const adv = 32;
+  const elem = buf.slice(offset, offset + adv);
+  return { elem, adv };
+}
+
+// For serializing an array of fixed length elements.
+export function serializeBufferArrayToVector(arr: Uint8Array[]) {
+  return concatenateUint8Arrays([numToUInt32BE(arr.length), ...arr.flat()]);
+}
+
+export function deserializeArrayFromVector<T>(
+  deserialize: (buf: Uint8Array, offset: number) => { elem: T; adv: number },
+  vector: Uint8Array,
+  offset = 0,
+) {
+  let pos = offset;
+  const size = new DataView(vector.buffer, vector.byteOffset + pos, 4).getUint32(0, false);
+  pos += 4;
+  const arr = new Array<T>(size);
+  for (let i = 0; i < size; ++i) {
+    const { elem, adv } = deserialize(vector, pos);
+    pos += adv;
+    arr[i] = elem;
+  }
+  return { elem: arr, adv: pos - offset };
+}
+
+/** A type that can be written to a buffer. */
+export type Bufferable = boolean | Uint8Array | number | string | { toBuffer: () => Uint8Array } | Bufferable[];
+
+/**
+ * Serializes a list of objects contiguously for calling into wasm.
+ * @param objs - Objects to serialize.
+ * @returns A buffer list with the concatenation of all fields.
+ */
+export function serializeBufferable(obj: Bufferable): Uint8Array {
+  if (Array.isArray(obj)) {
+    return serializeBufferArrayToVector(obj.map(serializeBufferable));
+  } else if (obj instanceof RawBuffer) {
+    return obj;
+  } else if (obj instanceof Uint8Array) {
+    return serializeBufferToVector(obj);
+  } else if (typeof obj === 'boolean') {
+    return boolToBuffer(obj);
+  } else if (typeof obj === 'number') {
+    return numToUInt32BE(obj);
+  } else if (typeof obj === 'bigint') {
+    return serializeBigInt(obj);
+  } else if (typeof obj === 'string') {
+    return serializeBufferToVector(new TextEncoder().encode(obj));
+  } else {
+    return obj.toBuffer();
+  }
+}

package/src/types/fields.ts

@@ -0,0 +1,98 @@
+import { randomBytes } from '../random/index.js';
+import { toBigIntBE, toBufferBE } from '../bigint-array/index.js';
+import { BufferReader, uint8ArrayToHexString } from '../serialize/index.js';
+
+export class Fr {
+  static ZERO = new Fr(0n);
+  static MODULUS = 0x30644e72e131a029b85045b68181585d2833e84879b9709143e1f593f0000001n;
+  static MAX_VALUE = this.MODULUS - 1n;
+  static SIZE_IN_BYTES = 32;
+
+  constructor(public readonly value: bigint) {
+    if (value > Fr.MAX_VALUE) {
+      throw new Error(`Fr out of range ${value}.`);
+    }
+  }
+
+  static random() {
+    const r = toBigIntBE(randomBytes(64)) % Fr.MODULUS;
+    return new this(r);
+  }
+
+  static fromBuffer(buffer: Uint8Array | BufferReader) {
+    const reader = BufferReader.asReader(buffer);
+    return new this(toBigIntBE(reader.readBytes(this.SIZE_IN_BYTES)));
+  }
+
+  static fromBufferReduce(buffer: Uint8Array | BufferReader) {
+    const reader = BufferReader.asReader(buffer);
+    return new this(toBigIntBE(reader.readBytes(this.SIZE_IN_BYTES)) % Fr.MODULUS);
+  }
+
+  static fromString(str: string) {
+    return this.fromBuffer(Buffer.from(str.replace(/^0x/i, ''), 'hex'));
+  }
+
+  toBuffer() {
+    return toBufferBE(this.value, Fr.SIZE_IN_BYTES);
+  }
+
+  toString() {
+    return '0x' + uint8ArrayToHexString(this.toBuffer());
+  }
+
+  equals(rhs: Fr) {
+    return this.value === rhs.value;
+  }
+
+  isZero() {
+    return this.value === 0n;
+  }
+}
+
+export class Fq {
+  static MODULUS = 0x30644e72e131a029b85045b68181585d97816a916871ca8d3c208c16d87cfd47n;
+  static MAX_VALUE = this.MODULUS - 1n;
+  static SIZE_IN_BYTES = 32;
+
+  constructor(public readonly value: bigint) {
+    if (value > Fq.MAX_VALUE) {
+      throw new Error(`Fq out of range ${value}.`);
+    }
+  }
+
+  static random() {
+    const r = toBigIntBE(randomBytes(64)) % Fq.MODULUS;
+    return new this(r);
+  }
+
+  static fromBuffer(buffer: Uint8Array | BufferReader) {
+    const reader = BufferReader.asReader(buffer);
+    return new this(toBigIntBE(reader.readBytes(this.SIZE_IN_BYTES)));
+  }
+
+  static fromBufferReduce(buffer: Uint8Array | BufferReader) {
+    const reader = BufferReader.asReader(buffer);
+    return new this(toBigIntBE(reader.readBytes(this.SIZE_IN_BYTES)) % Fr.MODULUS);
+  }
+
+  static fromString(str: string) {
+    return this.fromBuffer(Buffer.from(str.replace(/^0x/i, ''), 'hex'));
+  }
+
+  toBuffer() {
+    return toBufferBE(this.value, Fq.SIZE_IN_BYTES);
+  }
+
+  toString() {
+    return '0x' + this.value.toString(16);
+  }
+
+  equals(rhs: Fq) {
+    return this.value === rhs.value;
+  }
+
+  isZero() {
+    return this.value === 0n;
+  }
+}

package/src/types/fixed_size_buffer.ts

@@ -0,0 +1,59 @@
+import { randomBytes } from '../random/index.js';
+import { BufferReader } from '../serialize/index.js';
+
+export class Buffer32 {
+  static SIZE_IN_BYTES = 32;
+
+  constructor(public readonly buffer: Uint8Array) {}
+
+  static fromBuffer(buffer: Uint8Array | BufferReader) {
+    const reader = BufferReader.asReader(buffer);
+    return new Buffer32(reader.readBytes(this.SIZE_IN_BYTES));
+  }
+
+  static random() {
+    return new Buffer32(randomBytes(this.SIZE_IN_BYTES));
+  }
+
+  toBuffer() {
+    return this.buffer;
+  }
+}
+
+export class Buffer64 {
+  static SIZE_IN_BYTES = 64;
+
+  constructor(public readonly buffer: Uint8Array) {}
+
+  static fromBuffer(buffer: Uint8Array | BufferReader) {
+    const reader = BufferReader.asReader(buffer);
+    return new Buffer64(reader.readBytes(this.SIZE_IN_BYTES));
+  }
+
+  static random() {
+    return new Buffer64(randomBytes(this.SIZE_IN_BYTES));
+  }
+
+  toBuffer() {
+    return this.buffer;
+  }
+}
+
+export class Buffer128 {
+  static SIZE_IN_BYTES = 128;
+
+  constructor(public readonly buffer: Uint8Array) {}
+
+  static fromBuffer(buffer: Uint8Array | BufferReader) {
+    const reader = BufferReader.asReader(buffer);
+    return new Buffer128(reader.readBytes(this.SIZE_IN_BYTES));
+  }
+
+  static random() {
+    return new Buffer128(randomBytes(this.SIZE_IN_BYTES));
+  }
+
+  toBuffer() {
+    return this.buffer;
+  }
+}

package/src/types/index.ts

@@ -0,0 +1,5 @@
+export * from './ptr.js';
+export * from './fields.js';
+export * from './point.js';
+export * from './fixed_size_buffer.js';
+export * from './raw_buffer.js';

package/src/types/point.ts

@@ -0,0 +1,35 @@
+import { Fr } from './index.js';
+import { BufferReader } from '../serialize/buffer_reader.js';
+
+export class Point {
+  static SIZE_IN_BYTES = 64;
+  static EMPTY = new Point(Fr.ZERO, Fr.ZERO);
+
+  constructor(public readonly x: Fr, public readonly y: Fr) {}
+
+  static random() {
+    // TODO: This is not a point on the curve!
+    return new Point(Fr.random(), Fr.random());
+  }
+
+  static fromBuffer(buffer: Uint8Array | BufferReader) {
+    const reader = BufferReader.asReader(buffer);
+    return new this(Fr.fromBuffer(reader), Fr.fromBuffer(reader));
+  }
+
+  static fromString(address: string) {
+    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: Point) {
+    return this.x.equals(rhs.x) && this.y.equals(rhs.y);
+  }
+}

package/src/types/ptr.ts

@@ -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.
+ */
+export class Ptr {
+  static SIZE_IN_BYTES = 4;
+
+  constructor(public readonly value: Uint8Array) {}
+
+  static fromBuffer(buffer: Uint8Array | BufferReader) {
+    const reader = BufferReader.asReader(buffer);
+    return new this(reader.readBytes(this.SIZE_IN_BYTES));
+  }
+
+  toBuffer() {
+    return this.value;
+  }
+}

package/src/types/raw_buffer.ts

@@ -0,0 +1,3 @@
+// 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 {}