@aztec/foundation 0.0.1-commit.64b6bbb → 0.0.1-commit.69c59a8b3

package/src/serialize/serialize.ts

@@ -269,6 +269,22 @@ export function serializeBigInt(n: bigint, width = 32) {
   return toBufferBE(n, width);
 }
 
+/**
+ * Serialize a signed BigInt value into a Buffer of specified width using two's complement.
+ * @param n - The signed BigInt value to be serialized.
+ * @param width - The width (in bytes) of the output Buffer, optional with default value 32.
+ * @returns A Buffer containing the serialized signed BigInt value in big-endian format.
+ */
+export function serializeSignedBigInt(n: bigint, width = 32) {
+  const widthBits = BigInt(width * 8);
+  const max = 1n << (widthBits - 1n);
+  if (n < -max || n >= max) {
+    throw new Error(`Signed BigInt ${n.toString()} does not fit into ${width} bytes`);
+  }
+  const unsigned = n < 0n ? (1n << widthBits) + n : n;
+  return toBufferBE(unsigned, width);
+}
+
 /**
  * Deserialize a big integer from a buffer, given an offset and width.
  * Reads the specified number of bytes from the buffer starting at the offset, converts it to a big integer, and returns the deserialized result along with the number of bytes read (advanced).
@@ -282,6 +298,22 @@ export function deserializeBigInt(buf: Buffer, offset = 0, width = 32) {
   return { elem: toBigIntBE(buf.subarray(offset, offset + width)), adv: width };
 }
 
+/**
+ * Deserialize a signed BigInt from a buffer (two's complement).
+ * @param buf - The buffer containing the signed big integer to be deserialized.
+ * @param offset - The position in the buffer where the integer starts. Defaults to 0.
+ * @param width - The number of bytes to read from the buffer for the integer. Defaults to 32.
+ * @returns An object containing the deserialized signed bigint value ('elem') and bytes advanced ('adv').
+ */
+export function deserializeSignedBigInt(buf: Buffer, offset = 0, width = 32) {
+  const { elem, adv } = deserializeBigInt(buf, offset, width);
+  const widthBits = BigInt(width * 8);
+  const signBit = 1n << (widthBits - 1n);
+  const fullRange = 1n << widthBits;
+  const signed = elem >= signBit ? elem - fullRange : elem;
+  return { elem: signed, adv };
+}
+
 /**
  * Serializes a Date object into a Buffer containing its timestamp as a big integer value.
  * The resulting Buffer has a fixed width of 8 bytes, representing a 64-bit big-endian integer.

package/src/sleep/index.ts

@@ -22,6 +22,7 @@ import { InterruptError } from '../error/index.js';
  */
 export class InterruptibleSleep {
   private interrupts: Array<(shouldThrow: boolean) => void> = [];
+  private timeoutIds: NodeJS.Timeout[] = [];
 
   /**
    * Sleep for a specified amount of time in milliseconds.
@@ -38,9 +39,15 @@ export class InterruptibleSleep {
       this.interrupts.push(resolve);
     });
 
-    const timeoutPromise = new Promise<boolean>(resolve => setTimeout(() => resolve(false), ms));
+    let timeoutId: NodeJS.Timeout;
+    const timeoutPromise = new Promise<boolean>(resolve => {
+      timeoutId = setTimeout(() => resolve(false), ms);
+      this.timeoutIds.push(timeoutId);
+    });
     const shouldThrow = await Promise.race([interruptPromise, timeoutPromise]);
 
+    clearTimeout(timeoutId!);
+    this.timeoutIds = this.timeoutIds.filter(id => id !== timeoutId);
     this.interrupts = this.interrupts.filter(res => res !== interruptResolve);
 
     if (shouldThrow) {
@@ -58,6 +65,8 @@ export class InterruptibleSleep {
   public interrupt(sleepShouldThrow = false): void {
     this.interrupts.forEach(resolve => resolve(sleepShouldThrow));
     this.interrupts = [];
+    this.timeoutIds.forEach(id => clearTimeout(id));
+    this.timeoutIds = [];
   }
 }
 

package/src/string/index.ts

@@ -58,7 +58,7 @@ export function urlJoin(...args: string[]): string {
       end--;
     }
 
-    if (start < end) {
+    if (start <= end) {
       processed.push(arg.slice(start, end + 1));
     }
   }

package/src/timer/date.ts

@@ -32,6 +32,12 @@ export class TestDateProvider extends DateProvider {
     this.logger.warn(`Time set to ${new Date(timeMs).toISOString()}`, { offset: this.offset, timeMs });
   }
 
+  /** Resets the time back to real time (offset = 0). */
+  public reset() {
+    this.offset = 0;
+    this.logger.warn('Time reset to real time');
+  }
+
   /** Advances the time by the given number of seconds. */
   public advanceTime(seconds: number) {
     this.offset += seconds * 1000;

package/src/transport/dispatch/create_dispatch_proxy.ts

@@ -2,7 +2,17 @@ import { EventEmitter } from 'events';
 
 import { type TransferDescriptor, isTransferDescriptor } from '../interface/transferable.js';
 import type { TransportClient } from '../transport_client.js';
-import type { DispatchMsg } from './create_dispatch_fn.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[];
+}
 
 /**
  * FilterOutAttributes type filters out all non-method properties of an object, leaving only the attributes

package/src/transport/index.ts

@@ -1,4 +1,3 @@
-export * from './dispatch/create_dispatch_fn.js';
 export * from './dispatch/create_dispatch_proxy.js';
 export * from './dispatch/messages.js';
 export * from './interface/connector.js';

package/src/transport/transport_client.ts

@@ -91,7 +91,7 @@ export class TransportClient<Payload> extends EventEmitter {
     }
     const msgId = this.msgId++;
     const msg = { msgId, payload };
-    log.debug(format(`->`, msg));
+    log.trace(format(`->`, msg));
     return new Promise<any>((resolve, reject) => {
       this.pendingRequests.push({ resolve, reject, msgId });
       this.socket!.send(msg, transfer).catch(reject);
@@ -111,7 +111,7 @@ export class TransportClient<Payload> extends EventEmitter {
       this.close();
       return;
     }
-    log.debug(format(`<-`, msg));
+    log.trace(format(`<-`, msg));
     if (isEventMessage(msg)) {
       this.emit('event_msg', msg.payload);
       return;

package/src/trees/indexed_merkle_tree_calculator.ts

@@ -40,7 +40,11 @@ export class IndexedMerkleTreeCalculator<T extends IndexedTreeLeafPreimage, N ex
     }
     const sorted = values
       .map((v, i) => ({ value: v, index: i }))
-      .sort((a, b) => Number(toBigIntBE(b.value) - toBigIntBE(a.value)));
+      .sort((a, b): -1 | 0 | 1 => {
+        const aBigInt = toBigIntBE(a.value);
+        const bBigInt = toBigIntBE(b.value);
+        return aBigInt < bBigInt ? 1 : aBigInt > bBigInt ? -1 : 0;
+      });
     const indexedLeaves = sorted.map((item, i) => ({
       leaf: this.factory.fromBuffer(
         Buffer.concat([

package/dest/crypto/serialize.d.ts

@@ -1,51 +0,0 @@
-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 declare function serializeBufferArrayToVector(arr: Buffer[]): Buffer<ArrayBuffer>;
-/**
- * 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 declare function deserializeArrayFromVector<T>(deserialize: DeserializeFn<T>, vector: Buffer, offset?: number): {
-    elem: T[];
-    adv: number;
-};
-/**
- * For serializing numbers to 32 bit little-endian form.
- * TODO move to foundation pkg.
- * @param n - The number.
- * @returns The endian-corrected number.
- */
-export declare function numToUInt32LE(n: number, bufferSize?: number): Buffer<ArrayBuffer>;
-/**
- * Deserialize the 256-bit number at address `offset`.
- * @param buf - The buffer.
- * @param offset - The address.
- * @returns The derserialized 256-bit field.
- */
-export declare function deserializeField(buf: Buffer, offset?: number): {
-    elem: Buffer<ArrayBuffer>;
-    adv: number;
-};
-export declare function concatenateUint8Arrays(arrayOfUint8Arrays: Uint8Array[]): Uint8Array<ArrayBuffer>;
-export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VyaWFsaXplLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY3J5cHRvL3NlcmlhbGl6ZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFFQSxPQUFPLEVBQUUsTUFBTSxFQUFFLE1BQU0sUUFBUSxDQUFDO0FBRWhDOzs7OztHQUtHO0FBQ0gsd0JBQWdCLDRCQUE0QixDQUFDLEdBQUcsRUFBRSxNQUFNLEVBQUUsdUJBSXpEO0FBRUQ7O0dBRUc7QUFDSCxLQUFLLGFBQWEsQ0FBQyxDQUFDLElBQUksQ0FDdEIsR0FBRyxFQUFFLE1BQU0sRUFDWCxNQUFNLEVBQUUsTUFBTSxLQUNYO0lBQ0g7O09BRUc7SUFDSCxJQUFJLEVBQUUsQ0FBQyxDQUFDO0lBQ1I7O09BRUc7SUFDSCxHQUFHLEVBQUUsTUFBTSxDQUFDO0NBQ2IsQ0FBQztBQUVGOzs7OztHQUtHO0FBQ0gsd0JBQWdCLDBCQUEwQixDQUFDLENBQUMsRUFBRSxXQUFXLEVBQUUsYUFBYSxDQUFDLENBQUMsQ0FBQyxFQUFFLE1BQU0sRUFBRSxNQUFNLEVBQUUsTUFBTSxTQUFJOzs7RUFXdEc7QUFFRDs7Ozs7R0FLRztBQUNILHdCQUFnQixhQUFhLENBQUMsQ0FBQyxFQUFFLE1BQU0sRUFBRSxVQUFVLFNBQUksdUJBSXREO0FBRUQ7Ozs7O0dBS0c7QUFDSCx3QkFBZ0IsZ0JBQWdCLENBQUMsR0FBRyxFQUFFLE1BQU0sRUFBRSxNQUFNLFNBQUk7OztFQUd2RDtBQUVELHdCQUFnQixzQkFBc0IsQ0FBQyxrQkFBa0IsRUFBRSxVQUFVLEVBQUUsMkJBU3RFIn0=

package/dest/crypto/serialize.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"serialize.d.ts","sourceRoot":"","sources":["../../src/crypto/serialize.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,MAAM,EAAE,uBAIzD;AAED;;GAEG;AACH,KAAK,aAAa,CAAC,CAAC,IAAI,CACtB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,KACX;IACH;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC;IACR;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,CAAC,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,SAAI;;;EAWtG;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,SAAI,uBAItD;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,SAAI;;;EAGvD;AAED,wBAAgB,sBAAsB,CAAC,kBAAkB,EAAE,UAAU,EAAE,2BAStE"}

package/dest/crypto/serialize.js

@@ -1,68 +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) {
-    const lengthBuf = Buffer.alloc(4);
-    lengthBuf.writeUInt32BE(arr.length, 0);
-    return Buffer.concat([
-        lengthBuf,
-        ...arr
-    ]);
-}
-/**
- * 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(deserialize, vector, offset = 0) {
-    let pos = offset;
-    const size = vector.readUInt32BE(pos);
-    pos += 4;
-    const arr = new Array(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, 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, offset = 0) {
-    const adv = 32;
-    return {
-        elem: buf.slice(offset, offset + adv),
-        adv
-    };
-}
-export function concatenateUint8Arrays(arrayOfUint8Arrays) {
-    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/dest/transport/dispatch/create_dispatch_fn.d.ts

@@ -1,25 +0,0 @@
-/**
- * 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 declare function createDispatchFn(targetFn: () => any, log?: import("../../log/pino-logger.js").Logger): ({ fn, args }: DispatchMsg) => Promise<any>;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY3JlYXRlX2Rpc3BhdGNoX2ZuLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvdHJhbnNwb3J0L2Rpc3BhdGNoL2NyZWF0ZV9kaXNwYXRjaF9mbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFJQTs7O0dBR0c7QUFDSCxNQUFNLFdBQVcsV0FBVztJQUMxQjs7T0FFRztJQUNILEVBQUUsRUFBRSxNQUFNLENBQUM7SUFDWDs7T0FFRztJQUNILElBQUksRUFBRSxHQUFHLEVBQUUsQ0FBQztDQUNiO0FBRUQ7Ozs7Ozs7O0dBUUc7QUFDSCx3QkFBZ0IsZ0JBQWdCLENBQUMsUUFBUSxFQUFFLE1BQU0sR0FBRyxFQUFFLEdBQUcsNENBQXNDLCtDQU05RiJ9

package/dest/transport/dispatch/create_dispatch_fn.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"create_dispatch_fn.d.ts","sourceRoot":"","sources":["../../../src/transport/dispatch/create_dispatch_fn.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,GAAG,EAAE,CAAC;CACb;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,EAAE,GAAG,4CAAsC,+CAM9F"}

package/dest/transport/dispatch/create_dispatch_fn.js

@@ -1,17 +0,0 @@
-import { format } from 'util';
-import { createLogger } from '../../log/index.js';
-/**
- * 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, log = createLogger('foundation:dispatch')) {
-    return async ({ fn, args })=>{
-        const target = targetFn();
-        log.debug(format(`dispatching to ${target}: ${fn}`, args));
-        return await target[fn](...args);
-    };
-}

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/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);
-  };
-}