@aztec/bb.js 0.0.1-fake-ceab37513c → 0.0.1-fake-c83136db25

package/src/serialize/serialize.ts

@@ -1,5 +1,3 @@
-import { RawBuffer } from '../types/raw_buffer.js';
-
 // For serializing bool.
 export function boolToBuffer(b: boolean) {
   const buf = new Uint8Array(1);
@@ -7,13 +5,6 @@ export function boolToBuffer(b: boolean) {
   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);
@@ -28,13 +19,6 @@ export function numToInt32BE(n: number, bufferSize = 4) {
   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);
@@ -46,10 +30,6 @@ export function concatenateUint8Arrays(arrayOfUint8Arrays: Uint8Array[]) {
   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]);
@@ -63,71 +43,11 @@ export function serializeBigInt(n: bigint, width = 32) {
   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[];
 
@@ -139,8 +59,6 @@ export type Bufferable = boolean | Uint8Array | number | string | { toBuffer: ()
 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') {

package/src/types/fields.ts

@@ -5,13 +5,12 @@ import {
   bigIntToBufferBE,
   bigIntToUint8ArrayBE,
 } from '../bigint-array/index.js';
-import { BufferReader, uint8ArrayToHexString } from '../serialize/index.js';
 
-// TODO(#4189): Replace with implementation in yarn-project/foundation/src/fields/fields.ts
 /**
- * Fr field class.
- * @dev This class is used to represent elements of BN254 scalar field or elements in the base field of Grumpkin.
- * (Grumpkin's scalar field corresponds to BN254's base field and vice versa.)
+ * Internal Fr field class for tests.
+ * @dev This minimal implementation is provided for testing barretenberg directly.
+ * Projects using bb.js should create their own field abstraction using the curve constants
+ * exported from the barretenberg binary (see CurveConstants generation).
  */
 export class Fr {
   static ZERO = new Fr(0n);
@@ -42,14 +41,18 @@ export class Fr {
     return new this(r);
   }
 
-  static fromBuffer(buffer: Uint8Array | Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-    return new this(reader.readBytes(this.SIZE_IN_BYTES));
+  static fromBuffer(buffer: Uint8Array | Buffer) {
+    if (buffer.length !== this.SIZE_IN_BYTES) {
+      throw new Error(`Expected ${this.SIZE_IN_BYTES} bytes, got ${buffer.length}`);
+    }
+    return new this(buffer);
   }
 
-  static fromBufferReduce(buffer: Uint8Array | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-    return new this(uint8ArrayToBigIntBE(reader.readBytes(this.SIZE_IN_BYTES)) % Fr.MODULUS);
+  static fromBufferReduce(buffer: Uint8Array | Buffer) {
+    if (buffer.length !== this.SIZE_IN_BYTES) {
+      throw new Error(`Expected ${this.SIZE_IN_BYTES} bytes, got ${buffer.length}`);
+    }
+    return new this(uint8ArrayToBigIntBE(buffer instanceof Buffer ? new Uint8Array(buffer) : buffer) % Fr.MODULUS);
   }
 
   static fromString(str: string) {
@@ -61,7 +64,7 @@ export class Fr {
   }
 
   toString() {
-    return '0x' + uint8ArrayToHexString(this.toBuffer());
+    return '0x' + this.toBuffer().reduce((accumulator, byte) => accumulator + byte.toString(16).padStart(2, '0'), '');
   }
 
   equals(rhs: Fr) {
@@ -72,55 +75,3 @@ export class Fr {
     return this.value.every(v => v === 0);
   }
 }
-
-/**
- * Fq field class.
- * @dev This class is used to represent elements of BN254 base field or elements in the scalar field of Grumpkin.
- * (Grumpkin's scalar field corresponds to BN254's base field and vice versa.)
- */
-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 = uint8ArrayToBigIntBE(randomBytes(64)) % Fq.MODULUS;
-    return new this(r);
-  }
-
-  static fromBuffer(buffer: Uint8Array | Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-    return new this(uint8ArrayToBigIntBE(reader.readBytes(this.SIZE_IN_BYTES)));
-  }
-
-  static fromBufferReduce(buffer: Uint8Array | Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-    return new this(uint8ArrayToBigIntBE(reader.readBytes(this.SIZE_IN_BYTES)) % Fr.MODULUS);
-  }
-
-  static fromString(str: string) {
-    return this.fromBuffer(Buffer.from(str.replace(/^0x/i, ''), 'hex'));
-  }
-
-  toBuffer() {
-    return bigIntToBufferBE(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/index.ts

@@ -1,5 +1,2 @@
-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

@@ -1,6 +1,11 @@
-import { Fr } from './index.js';
-import { BufferReader } from '../serialize/buffer_reader.js';
-
+import { Fr } from './fields.js';
+
+/**
+ * Internal Point class for tests.
+ * @dev This minimal implementation is provided for testing barretenberg directly.
+ * Projects using bb.js should create their own point abstraction using the curve point
+ * types and operations exported from the barretenberg API.
+ */
 export class Point {
   static SIZE_IN_BYTES = 64;
   static EMPTY = new Point(Fr.ZERO, Fr.ZERO);
@@ -10,28 +15,17 @@ export class Point {
     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'));
+  static fromBuffer(buffer: Uint8Array) {
+    if (buffer.length !== this.SIZE_IN_BYTES) {
+      throw new Error(`Expected ${this.SIZE_IN_BYTES} bytes, got ${buffer.length}`);
+    }
+    return new this(Fr.fromBuffer(buffer.subarray(0, 32)), Fr.fromBuffer(buffer.subarray(32, 64)));
   }
 
   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/barretenberg/common.test.ts

@@ -1,23 +0,0 @@
-import { Barretenberg } from './index.js';
-
-describe('env', () => {
-  let api: Barretenberg;
-
-  beforeAll(async () => {
-    api = await Barretenberg.new({ threads: 3 });
-  }, 30000);
-
-  afterAll(async () => {
-    if (api) {
-      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);
-  });
-});