@aztec/foundation 0.0.1-commit.9b94fc1 → 0.0.1-commit.9badcec54

package/src/crypto/serialize.ts

@@ -1,85 +0,0 @@
-// TODO find a new home for this as we move to external bb.js
-// See https://github.com/AztecProtocol/aztec-packages/issues/782
-import { Buffer } from 'buffer';
-
-/**
- * For serializing an array of fixed length buffers.
- * TODO move to foundation pkg.
- * @param arr - Array of bufffers.
- * @returns The serialized buffers.
- */
-export function serializeBufferArrayToVector(arr: Buffer[]) {
-  const lengthBuf = Buffer.alloc(4);
-  lengthBuf.writeUInt32BE(arr.length, 0);
-  return Buffer.concat([lengthBuf, ...arr]);
-}
-
-/**
- * Helper function for deserializeArrayFromVector.
- */
-type DeserializeFn<T> = (
-  buf: Buffer,
-  offset: number,
-) => {
-  /**
-   * The deserialized type.
-   */
-  elem: T;
-  /**
-   * How many bytes to advance by.
-   */
-  adv: number;
-};
-
-/**
- * For deserializing numbers to 32-bit little-endian form.
- * TODO move to foundation pkg.
- * @param n - The number.
- * @returns The endian-corrected number.
- */
-export function deserializeArrayFromVector<T>(deserialize: DeserializeFn<T>, vector: Buffer, offset = 0) {
-  let pos = offset;
-  const size = vector.readUInt32BE(pos);
-  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 };
-}
-
-/**
- * For serializing numbers to 32 bit little-endian form.
- * TODO move to foundation pkg.
- * @param n - The number.
- * @returns The endian-corrected number.
- */
-export function numToUInt32LE(n: number, bufferSize = 4) {
-  const buf = Buffer.alloc(bufferSize);
-  buf.writeUInt32LE(n, bufferSize - 4);
-  return buf;
-}
-
-/**
- * Deserialize the 256-bit number at address `offset`.
- * @param buf - The buffer.
- * @param offset - The address.
- * @returns The derserialized 256-bit field.
- */
-export function deserializeField(buf: Buffer, offset = 0) {
-  const adv = 32;
-  return { elem: buf.slice(offset, offset + adv), adv };
-}
-
-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;
-}

package/src/fields/coordinate.ts

@@ -1,104 +0,0 @@
-import { toBigIntBE } from '../bigint-buffer/index.js';
-import type { Tuple } from '../serialize/types.js';
-import { Fr } from './fields.js';
-
-/**
- * Class to wrap a single point coordinate.
- * This class handles the complexities of representing point coordinates as 32 byte buffers as well as fields.
- * The coordinate value is split across 2 fields to ensure that the max size of a field is not breached.
- * This is achieved by placing the most significant byte of the lower field into the least significant byte of the higher field.
- * Calls to 'toBuffer' or 'toBigInt' undo this change and simply return the original 32 byte value.
- * Calls to 'toFieldsBuffer' will return a 64 bytes buffer containing the serialized fields.
- */
-export class Coordinate {
-  static ZERO = new Coordinate([Fr.ZERO, Fr.ZERO]);
-
-  constructor(
-    /**
-     * The fields of the coordinate value. Least significant limb at index 0.
-     */
-    public fields: Tuple<Fr, 2>,
-  ) {}
-
-  /**
-   * Converts the coordinate data into a tuple of fields
-   * @returns A tuple of the coordinate fields
-   */
-  toFields(): Tuple<Fr, 2> {
-    return this.fields;
-  }
-
-  /**
-   * Generates a random coordinate value
-   * @returns The random coordinate
-   */
-  static random(): Coordinate {
-    return this.fromField(Fr.random());
-  }
-
-  /**
-   * serializes the object to buffer of 2 fields.
-   * @returns A buffer serialization of the object.
-   */
-  toFieldsBuffer(): Buffer {
-    return Buffer.concat([this.fields[0].toBuffer(), this.fields[1].toBuffer()]);
-  }
-
-  /**
-   * serializes the coordinate to a single 32 byte buffer.
-   * @returns A buffer serialization of the object.
-   */
-  toBuffer(): Buffer {
-    const buf0 = this.fields[0].toBuffer();
-    const buf1 = this.fields[1].toBuffer();
-    buf0[0] = buf1[31];
-    return buf0;
-  }
-
-  /**
-   * Returns true if this coordinate is equal to the one provided
-   * @param other - The coordinate against which to compare
-   * @returns True if the coordinates are the same, false otherwise
-   */
-  equals(other: Coordinate): boolean {
-    return this.toBigInt() === other.toBigInt();
-  }
-
-  /**
-   * Returns the coordinate's value as a bigint
-   * @returns The coordinate value as a bigint
-   */
-  toBigInt(): bigint {
-    return toBigIntBE(this.toBuffer());
-  }
-
-  /**
-   * Creates a coordinate object from a 32 byte coordinate value
-   * @param coordinate - A buffer containing the 32 byte coordinate value
-   * @returns The new coordinate object
-   */
-  static fromBuffer(coordinate: Buffer) {
-    if (coordinate.length != 32) {
-      throw new Error(`Invalid size of coordinate buffer`);
-    }
-    const buf0 = Buffer.alloc(32);
-    coordinate.copy(buf0, 0, 0, 32);
-    const buf1 = Buffer.alloc(32);
-    buf1[31] = buf0[0];
-    buf0[0] = 0;
-    return new Coordinate([Fr.fromBuffer(buf0), Fr.fromBuffer(buf1)]);
-  }
-
-  /**
-   * Creates a coordinate object from a field
-   * @param coordinate - The field containing the coordinate
-   * @returns The new coordinate object
-   */
-  static fromField(coordinate: Fr) {
-    const buf0 = coordinate.toBuffer();
-    const buf1 = Buffer.alloc(32);
-    buf1[31] = buf0[0];
-    buf0[0] = 0;
-    return new Coordinate([Fr.fromBuffer(buf0), Fr.fromBuffer(buf1)]);
-  }
-}

package/src/fields/index.ts

@@ -1,5 +0,0 @@
-export * from './fields.js';
-export * from './point.js';
-export * from './coordinate.js';
-export * from './bls12_fields.js';
-export * from './bls12_point.js';

package/src/index.ts

@@ -1,31 +0,0 @@
-// Reexport all folders at the root for packages targeting CommonJS
-export * as asyncMap from './async-map/index.js';
-export * as brandedTypes from './branded-types/index.js';
-export * as bigintBuffer from './bigint-buffer/index.js';
-export * as collection from './collection/index.js';
-export * as committable from './committable/index.js';
-export * as crypto from './crypto/index.js';
-export * as errors from './error/index.js';
-export * as ethAddress from './eth-address/index.js';
-export * as fields from './fields/index.js';
-export * as fifo from './queue/index.js';
-export * as fs from './fs/index.js';
-export * as jsonRpc from './json-rpc/index.js';
-export * as jsonRpcClient from './json-rpc/client/index.js';
-export * as jsonRpcServer from './json-rpc/server/index.js';
-export * as log from './log/index.js';
-export * as mutex from './mutex/index.js';
-export * as retry from './retry/index.js';
-export * as runningPromise from './running-promise/index.js';
-export * as serialize from './serialize/index.js';
-export * as sleep from './sleep/index.js';
-export * as timer from './timer/index.js';
-export * as transport from './transport/index.js';
-export * as trees from './trees/index.js';
-export * as types from './types/index.js';
-export * as url from './url/index.js';
-export * as testing from './testing/index.js';
-export * as profiler from './profiler/index.js';
-export * as config from './config/index.js';
-export * as buffer from './buffer/index.js';
-export * as ethSignature from './eth-signature/index.js';

package/src/transport/dispatch/create_dispatch_fn.ts

@@ -1,35 +0,0 @@
-import { format } from 'util';
-
-import { createLogger } from '../../log/index.js';
-
-/**
- * Represents a message object for dispatching function calls.
- * Contains the function name ('fn') and an array of arguments ('args') required to call the target method.
- */
-export interface DispatchMsg {
-  /**
-   * Name of the target method to be called.
-   */
-  fn: string;
-  /**
-   * An array of arguments to be passed to the target method.
-   */
-  args: any[];
-}
-
-/**
- * Creates a dispatch function that calls the target's specified method with provided arguments.
- * The created dispatch function takes a DispatchMsg object as input, which contains the name of
- * the method to be called ('fn') and an array of arguments to be passed to the method ('args').
- *
- * @param targetFn - A function that returns the target object containing the methods to be dispatched.
- * @param log - Optional logging function for debugging purposes.
- * @returns A dispatch function that accepts a DispatchMsg object and calls the target's method with provided arguments.
- */
-export function createDispatchFn(targetFn: () => any, log = createLogger('foundation:dispatch')) {
-  return async ({ fn, args }: DispatchMsg) => {
-    const target = targetFn();
-    log.debug(format(`dispatching to ${target}: ${fn}`, args));
-    return await target[fn](...args);
-  };
-}