@aztec/foundation 0.1.0-alpha23 → 0.1.0-alpha25

package/src/fields/point.ts

@@ -1,5 +1,5 @@
 import { BufferReader } from '../serialize/buffer_reader.js';
-import { Coordinate } from './coordinate.js';
+import { Fr } from './fields.js';
 
 /**
  * Represents a Point on an elliptic curve with x and y coordinates.
@@ -7,7 +7,7 @@ import { Coordinate } from './coordinate.js';
  * converting instances to various output formats, and checking the equality of points.
  */
 export class Point {
-  static ZERO = new Point(Coordinate.ZERO, Coordinate.ZERO);
+  static ZERO = new Point(Fr.ZERO, Fr.ZERO);
 
   /** Used to differentiate this class from AztecAddress */
   public readonly kind = 'point';
@@ -16,11 +16,11 @@ export class Point {
     /**
      * The point's x coordinate
      */
-    public readonly x: Coordinate,
+    public readonly x: Fr,
     /**
      * The point's y coordinate
      */
-    public readonly y: Coordinate,
+    public readonly y: Fr,
   ) {}
 
   /**
@@ -30,7 +30,7 @@ export class Point {
    */
   static random() {
     // TODO is this a random point on the curve?
-    return new Point(Coordinate.random(), Coordinate.random());
+    return new Point(Fr.random(), Fr.random());
   }
 
   /**
@@ -42,17 +42,7 @@ export class Point {
    */
   static fromBuffer(buffer: Buffer | BufferReader) {
     const reader = BufferReader.asReader(buffer);
-    return new this(Coordinate.fromBuffer(reader.readBytes(32)), Coordinate.fromBuffer(reader.readBytes(32)));
-  }
-
-  /**
-   * Creates a point instance from its x and y coordinates.
-   * @param x - X coordinate.
-   * @param y - Y coordinate.
-   * @returns A Point instance.
-   */
-  static fromCoordinates(x: Coordinate, y: Coordinate) {
-    return new this(x, y);
+    return new this(Fr.fromBuffer(reader.readBytes(32)), Fr.fromBuffer(reader.readBytes(32)));
   }
 
   /**
@@ -68,22 +58,11 @@ export class Point {
   }
 
   /**
-   * Convert the Point instance to a Buffer representation of fields
-   * The output buffer's length will be (128 bytes).
-   * This method is useful for serialization and deserialization of the Point object.
-   *
-   * @returns A Buffer representation of the Point instance.
-   */
-  toFieldsBuffer() {
-    return Buffer.concat([this.x.toFieldsBuffer(), this.y.toFieldsBuffer()]);
-  }
-
-  /**
-   * Returns the contents of the point as an array of 4 fields.
-   * @returns The point as an array of 4 fields
+   * Returns the contents of the point as an array of 2 fields.
+   * @returns The point as an array of 2 fields
    */
   toFields() {
-    return this.x.toFields().concat(this.y.toFields());
+    return [this.x, this.y];
   }
 
   /**
@@ -91,11 +70,9 @@ export class Point {
    * @returns The point as BigInts
    */
   toBigInts() {
-    const x = this.x.toBigInt();
-    const y = this.y.toBigInt();
     return {
-      x,
-      y,
+      x: this.x.value,
+      y: this.y.value,
     };
   }
 

package/src/fifo/bounded_serial_queue.ts

@@ -1,4 +1,4 @@
-import { createLogger } from '../log/console.js';
+import { createDebugLogger } from '../log/index.js';
 import { Semaphore } from './semaphore.js';
 import { SerialQueue } from './serial_queue.js';
 
@@ -10,7 +10,7 @@ export class BoundedSerialQueue {
   private readonly queue = new SerialQueue();
   private semaphore: Semaphore;
 
-  constructor(maxQueueSize: number, private log = createLogger('aztec:foundation:bounded_serial_queue')) {
+  constructor(maxQueueSize: number, private log = createDebugLogger('aztec:foundation:bounded_serial_queue')) {
     this.semaphore = new Semaphore(maxQueueSize);
   }
 

package/src/fifo/memory_fifo.ts

@@ -1,4 +1,4 @@
-import { createLogger } from '../log/console.js';
+import { createDebugLogger } from '../log/index.js';
 
 /**
  * A simple fifo queue. It can grow unbounded. It can have multiple producers and consumers.
@@ -10,7 +10,7 @@ export class MemoryFifo<T> {
   private items: T[] = [];
   private flushing = false;
 
-  constructor(private log = createLogger('aztec:foundation:memory_fifo')) {}
+  constructor(private log = createDebugLogger('aztec:foundation:memory_fifo')) {}
 
   /**
    * Returns the current number of items in the queue.

package/src/json-rpc/client/index.ts

@@ -1 +1 @@
-export { createJsonRpcClient, JsonStringify } from './json_rpc_client.js';
+export { createJsonRpcClient, JsonStringify, mustSucceedFetch, defaultFetch } from './json_rpc_client.js';

package/src/json-rpc/client/json_rpc_client.test.ts

@@ -1,6 +1,7 @@
 import request from 'supertest';
+
+import { TestNote, TestState } from '../fixtures/test_state.js';
 import { JsonRpcServer } from '../server/json_rpc_server.js';
-import { TestState, TestNote } from '../fixtures/test_state.js';
 import { createJsonRpcClient } from './json_rpc_client.js';
 
 test('test an RPC function over client', async () => {

package/src/json-rpc/client/json_rpc_client.ts

@@ -3,9 +3,10 @@
 //  This takes a {foo(): T} and makes {foo(): Promise<T>}
 //  while avoiding Promise of Promise.
 import { RemoteObject } from 'comlink';
+
 import { createDebugLogger } from '../../log/index.js';
 import { retry } from '../../retry/index.js';
-import { ClassConverter, StringClassConverterInput, JsonClassConverterInput } from '../class_converter.js';
+import { ClassConverter, JsonClassConverterInput, StringClassConverterInput } from '../class_converter.js';
 import { JsonStringify, convertFromJsonObj, convertToJsonObj } from '../convert.js';
 
 export { JsonStringify } from '../convert.js';
@@ -91,12 +92,13 @@ export function createJsonRpcClient<T extends object>(
   return new Proxy(
     {},
     {
-      get:
-        (_, rpcMethod: string) =>
-        (...params: any[]) => {
+      get: (target, rpcMethod: string) => {
+        if (['then', 'catch'].includes(rpcMethod)) return Reflect.get(target, rpcMethod);
+        return (...params: any[]) => {
           debug(`JsonRpcClient.constructor`, 'proxy', rpcMethod, '<-', params);
           return request(rpcMethod, params);
-        },
+        };
+      },
     },
   ) as RemoteObject<T>;
 }

package/src/json-rpc/convert.test.ts

@@ -1,9 +1,9 @@
+import { Buffer } from 'buffer';
+
 import { ClassConverter } from './class_converter.js';
 import { convertFromJsonObj, convertToJsonObj } from './convert.js';
 import { TestNote } from './fixtures/test_state.js';
 
-import { Buffer } from 'buffer';
-
 const TEST_BASE64 = 'YmFzZTY0IGRlY29kZXI=';
 test('test an RPC function over client', () => {
   const cc = new ClassConverter({ TestNote });

package/src/json-rpc/convert.ts

@@ -1,6 +1,7 @@
-import { ClassConverter } from './class_converter.js';
 import { Buffer } from 'buffer';
 
+import { ClassConverter } from './class_converter.js';
+
 /**
  * Recursively looks through an object for bigints and converts them to object format.
  * @param obj - The object to convert.

package/src/json-rpc/index.ts

@@ -5,4 +5,4 @@ export {
   ClassConverter,
 } from './class_converter.js';
 export { JsonRpcServer, JsonProxy } from './server/index.js';
-export { createJsonRpcClient, JsonStringify } from './client/index.js';
+export { createJsonRpcClient, JsonStringify, mustSucceedFetch, defaultFetch } from './client/index.js';

package/src/json-rpc/server/json_proxy.ts

@@ -1,5 +1,5 @@
 import { createDebugLogger } from '../../log/index.js';
-import { ClassConverter, StringClassConverterInput, JsonClassConverterInput } from '../class_converter.js';
+import { ClassConverter, JsonClassConverterInput, StringClassConverterInput } from '../class_converter.js';
 import { convertFromJsonObj, convertToJsonObj } from '../convert.js';
 import { assert, hasOwnProperty } from '../js_utils.js';
 
@@ -25,9 +25,10 @@ export class JsonProxy {
    * @returns The remote result.
    */
   public async call(methodName: string, jsonParams: any[] = []) {
+    debug(`JsonProxy:call`, methodName, jsonParams);
     // Get access to our class members
     const proto = Object.getPrototypeOf(this.handler);
-    assert(hasOwnProperty(proto, methodName), 'JsonProxy: Method not found!');
+    assert(hasOwnProperty(proto, methodName), `JsonProxy: Method ${methodName} not found!`);
     assert(Array.isArray(jsonParams), 'JsonProxy: Params not an array!');
     // convert the params from json representation to classes
     const convertedParams = jsonParams.map(param => convertFromJsonObj(this.classConverter, param));

package/src/json-rpc/server/json_rpc_server.test.ts

@@ -1,5 +1,6 @@
 import request from 'supertest';
-import { TestState, TestNote } from '../fixtures/test_state.js';
+
+import { TestNote, TestState } from '../fixtures/test_state.js';
 import { JsonRpcServer } from './json_rpc_server.js';
 
 test('test an RPC function with a primitive parameter', async () => {

package/src/json-rpc/server/json_rpc_server.ts

@@ -1,14 +1,14 @@
-import http from 'http';
-import Router from 'koa-router';
 import cors from '@koa/cors';
-import compress from 'koa-compress';
+import http from 'http';
 import Koa from 'koa';
 import bodyParser from 'koa-bodyparser';
+import compress from 'koa-compress';
+import Router from 'koa-router';
 
-import { createLogger } from '../../log/index.js';
-import { StringClassConverterInput, JsonClassConverterInput } from '../class_converter.js';
-import { JsonProxy } from './json_proxy.js';
+import { createDebugLogger } from '../../log/index.js';
+import { JsonClassConverterInput, StringClassConverterInput } from '../class_converter.js';
 import { convertBigintsInObj } from '../convert.js';
+import { JsonProxy } from './json_proxy.js';
 
 /**
  * JsonRpcServer.
@@ -22,7 +22,7 @@ export class JsonRpcServer {
     objectClassMap: JsonClassConverterInput,
     private createApi: boolean,
     private disallowedMethods: string[] = [],
-    private log = createLogger('aztec:foundation:json-rpc:server'),
+    private log = createDebugLogger('aztec:foundation:json-rpc:server'),
   ) {
     this.proxy = new JsonProxy(handler, stringClassMap, objectClassMap);
   }

package/src/log/console.ts

@@ -1,11 +1,5 @@
 /* eslint-disable no-console */
-
-/**
- * Logger is a utility type that represents a logging function that accepts any number of arguments.
- * It is used to provide customizable logging functionality, allowing developers to easily log messages
- * with optional prefixes and custom formatting or output destinations.
- */
-export type Logger = (...args: any[]) => void;
+import { LogFn } from './index.js';
 
 /**
  * ConsoleLogger is a utility class that provides customizable console logging functionality.
@@ -36,7 +30,7 @@ class ConsoleLogger {
  * @param prefix - The optional string to prepend to each log message.
  * @returns A Logger function that accepts any number of arguments and logs them with the specified prefix.
  */
-export function createLogger(prefix?: string): Logger {
+export function createConsoleLogger(prefix?: string): LogFn {
   if (prefix) {
     const logger = new ConsoleLogger(prefix, console.log);
     return (...args: any[]) => logger.log(...args);

package/src/log/debug.ts

@@ -1,5 +1,7 @@
 import debug from 'debug';
 
+import { LogFn } from './index.js';
+
 let preLogHook: ((...args: any[]) => void) | undefined;
 let postLogHook: ((...args: any[]) => void) | undefined;
 
@@ -23,17 +25,12 @@ function theFunctionThroughWhichAllLogsPass(logger: any, ...args: any[]) {
   }
 }
 
-/**
- * A debug logger.
- */
-export type DebugLogger = (...args: any[]) => void;
-
 /**
  * Return a logger, meant to be silent by default and verbose during debugging.
  * @param name - The module name of the logger.
  * @returns A callable log function.
  */
-export function createDebugLogger(name: string): DebugLogger {
+export function createDebugOnlyLogger(name: string): LogFn {
   const logger = debug(name);
   return (...args: any[]) => theFunctionThroughWhichAllLogsPass(logger, ...args);
 }

package/src/log/index.ts

@@ -1,3 +1,9 @@
+/**
+ * A callable logger instance.
+ */
+export type LogFn = (...args: any[]) => void;
+
 export * from './console.js';
 export * from './debug.js';
+export * from './logger.js';
 export * from './log_history.js';

package/src/log/log_history.test.ts

@@ -1,5 +1,6 @@
 import { jest } from '@jest/globals';
-import { createDebugLogger, enableLogs } from './debug.js';
+
+import { createDebugOnlyLogger, enableLogs } from './debug.js';
 import { LogHistory } from './log_history.js';
 
 jest.useFakeTimers({ doNotFake: ['performance'] });
@@ -11,7 +12,7 @@ describe('log history', () => {
   const name = 'test:a';
 
   beforeEach(() => {
-    debug = createDebugLogger(name);
+    debug = createDebugOnlyLogger(name);
     enableLogs(name);
     logHistory = new LogHistory();
   });
@@ -52,7 +53,7 @@ describe('log history', () => {
   it('only keeps logs with enabled namespace', () => {
     logHistory.enable();
     const name2 = 'test:b';
-    const debug2 = createDebugLogger(name2);
+    const debug2 = createDebugOnlyLogger(name2);
     debug('0');
     debug2('zero');
     expect(logHistory.getLogs()).toEqual([[timestemp, name, '0']]);

package/src/log/logger.ts

@@ -0,0 +1,87 @@
+import debug from 'debug';
+import isNode from 'detect-node';
+import { isatty } from 'tty';
+
+import { LogFn } from './index.js';
+
+const LogLevels = ['silent', 'fatal', 'error', 'warn', 'info', 'debug'] as const;
+const DefaultLogLevel = 'info' as const;
+
+/**
+ * A valid log severity level.
+ */
+type LogLevel = (typeof LogLevels)[number];
+
+const envLogLevel = process.env.LOG_LEVEL?.toLowerCase() as LogLevel;
+const currentLevel = LogLevels.includes(envLogLevel) ? envLogLevel : DefaultLogLevel;
+
+/**
+ * Logger that supports multiple severity levels.
+ */
+export type Logger = { [K in LogLevel]: LogFn };
+
+/**
+ * Logger that supports multiple severity levels and can be called directly to issue a debug statement.
+ * Intended as a drop-in replacement for the debug module.
+ */
+export type DebugLogger = LogFn & Logger;
+
+/**
+ * Creates a new DebugLogger for the current module, defaulting to the LOG_LEVEL env var.
+ * If DEBUG="[module]" env is set, will enable debug logging if the module matches.
+ * Uses npm debug for debug level and console.error for other levels.
+ * @param name - Name of the module.
+ * @returns A debug logger.
+ */
+export function createDebugLogger(name: string): DebugLogger {
+  const debugLogger = debug(name);
+  if (currentLevel === 'debug') debugLogger.enabled = true;
+
+  const logger = {
+    silent: () => {},
+    fatal: (...args: any[]) => logWithDebug(debugLogger, 'fatal', args),
+    error: (...args: any[]) => logWithDebug(debugLogger, 'error', args),
+    warn: (...args: any[]) => logWithDebug(debugLogger, 'warn', args),
+    info: (...args: any[]) => logWithDebug(debugLogger, 'info', args),
+    debug: (...args: any[]) => logWithDebug(debugLogger, 'debug', args),
+  };
+  return Object.assign(debugLogger, logger);
+}
+
+/**
+ * Logs args to npm debug if enabled or log level is debug, console.error otherwise.
+ * @param debug - Instance of npm debug.
+ * @param level - Intended log level.
+ * @param args - Args to log.
+ */
+function logWithDebug(debug: debug.Debugger, level: LogLevel, args: any[]) {
+  if (debug.enabled) {
+    debug(args[0], ...args.slice(1));
+  } else if (LogLevels.indexOf(level) <= LogLevels.indexOf(currentLevel)) {
+    printLog([getPrefix(debug, level), ...args]);
+  }
+}
+
+/**
+ * Returns a log prefix that emulates that of npm debug. Uses colors if in node and in a tty.
+ * @param debugLogger - Instance of npm debug logger.
+ * @param level - Intended log level (printed out if strictly above current log level).
+ * @returns Log prefix.
+ */
+function getPrefix(debugLogger: debug.Debugger, level: LogLevel) {
+  const levelLabel = currentLevel !== level ? ` ${level.toUpperCase}` : '';
+  const prefix = `${debugLogger.namespace.replace(/^aztec:/, '')}${levelLabel}`;
+  if (!isNode || !isatty(process.stderr.fd)) return prefix;
+  const colorIndex = debug.selectColor(debugLogger.namespace) as number;
+  const colorCode = '\u001B[3' + (colorIndex < 8 ? colorIndex : '8;5;' + colorIndex);
+  return `  ${colorCode};1m${prefix}\u001B[0m`;
+}
+
+/**
+ * Outputs to console error.
+ * @param args - Args to log.
+ */
+function printLog(args: any[]) {
+  // eslint-disable-next-line no-console
+  console.error(...args);
+}

package/src/mutex/mutex.test.ts

@@ -1,4 +1,5 @@
 import { jest } from '@jest/globals';
+
 import { Mutex } from './index.js';
 import { MutexDatabase } from './mutex_database.js';
 

package/src/retry/index.ts

@@ -1,4 +1,4 @@
-import { createLogger } from '../log/index.js';
+import { createDebugLogger } from '../log/index.js';
 import { sleep } from '../sleep/index.js';
 import { Timer } from '../timer/index.js';
 
@@ -32,7 +32,7 @@ export async function retry<Result>(
   fn: () => Promise<Result>,
   name = 'Operation',
   backoff = backoffGenerator(),
-  log = createLogger('aztec:foundation:retry'),
+  log = createDebugLogger('aztec:foundation:retry'),
 ) {
   while (true) {
     try {

package/src/serialize/buffer_reader.test.ts

@@ -1,8 +1,9 @@
 import { jest } from '@jest/globals';
+
+import { randomBytes } from '../crypto/index.js';
 import { Fq, Fr } from '../fields/fields.js';
 import { BufferReader } from './buffer_reader.js';
 import { serializeBufferArrayToVector } from './free_funcs.js';
-import { randomBytes } from '../crypto/index.js';
 
 const ARRAY = Array.from(Array(32)).map((_, idx) => (idx % 2 === 0 ? 0 : 1));
 const BUFFER = Buffer.from(ARRAY);

package/src/serialize/buffer_reader.ts

@@ -1,4 +1,4 @@
-import { Fr, Fq } from '../fields/fields.js';
+import { Fq, Fr } from '../fields/fields.js';
 import { Tuple } from './types.js';
 
 /**

package/src/serialize/serialize.test.ts

@@ -1,12 +1,12 @@
 import { randomBytes } from '../crypto/index.js';
 import { Fr } from '../fields/fields.js';
 import {
-  serializeBufferToVector,
+  deserializeArrayFromVector,
   deserializeBufferFromVector,
-  deserializeUInt32,
   deserializeField,
+  deserializeUInt32,
   serializeBufferArrayToVector,
-  deserializeArrayFromVector,
+  serializeBufferToVector,
 } from './index.js';
 
 describe('serialize', () => {

package/src/serialize/serializer.ts

@@ -1,4 +1,3 @@
-import { serializeBufferArrayToVector } from './index.js';
 import {
   boolToByte,
   numToInt32BE,
@@ -7,6 +6,7 @@ import {
   serializeBufferToVector,
   serializeDate,
 } from './free_funcs.js';
+import { serializeBufferArrayToVector } from './index.js';
 
 /**
  * The Serializer class provides a convenient and efficient way to serialize various data types into binary format.

package/src/transport/browser/shared_worker_listener.ts

@@ -1,4 +1,5 @@
 import EventEmitter from 'events';
+
 import { Listener } from '../interface/listener.js';
 import { MessagePortSocket } from './message_port_socket.js';
 

package/src/transport/browser/worker_listener.ts

@@ -1,4 +1,5 @@
 import EventEmitter from 'events';
+
 import { Listener } from '../interface/listener.js';
 import { MessagePortSocket } from './message_port_socket.js';
 

package/src/transport/dispatch/create_dispatch_fn.ts

@@ -1,4 +1,4 @@
-import { createDebugLogger } from '../../log/debug.js';
+import { createDebugLogger } from '../../log/index.js';
 
 /**
  * Represents a message object for dispatching function calls.

package/src/transport/dispatch/create_dispatch_proxy.ts

@@ -1,7 +1,8 @@
-import { DispatchMsg } from './create_dispatch_fn.js';
-import { TransportClient } from '../transport_client.js';
 import { EventEmitter } from 'events';
-import { isTransferDescriptor, TransferDescriptor } from '../interface/transferable.js';
+
+import { TransferDescriptor, isTransferDescriptor } from '../interface/transferable.js';
+import { TransportClient } from '../transport_client.js';
+import { DispatchMsg } from './create_dispatch_fn.js';
 
 /**
  * FilterOutAttributes type filters out all non-method properties of an object, leaving only the attributes

package/src/transport/interface/listener.ts

@@ -1,4 +1,5 @@
 import EventEmitter from 'events';
+
 import { Socket } from './socket.js';
 
 /**

package/src/transport/node/node_connector.ts

@@ -1,4 +1,5 @@
 import { Worker } from 'worker_threads';
+
 import { Connector } from '../interface/connector.js';
 import { NodeConnectorSocket } from './node_connector_socket.js';
 

package/src/transport/node/node_connector_socket.ts

@@ -1,4 +1,5 @@
 import { TransferListItem, Worker } from 'worker_threads';
+
 import { Socket } from '../interface/socket.js';
 
 /**

package/src/transport/node/node_listener.ts

@@ -1,5 +1,6 @@
-import { parentPort } from 'worker_threads';
 import EventEmitter from 'events';
+import { parentPort } from 'worker_threads';
+
 import { Listener } from '../interface/listener.js';
 import { NodeListenerSocket } from './node_listener_socket.js';
 

package/src/transport/node/node_listener_socket.ts

@@ -1,4 +1,5 @@
 import { MessagePort, TransferListItem } from 'worker_threads';
+
 import { Socket } from '../interface/socket.js';
 
 /**

package/src/transport/transport_client.ts

@@ -1,8 +1,9 @@
 import EventEmitter from 'events';
-import { EventMessage, isEventMessage, ResponseMessage } from './dispatch/messages.js';
+
+import { createDebugLogger } from '../log/index.js';
+import { EventMessage, ResponseMessage, isEventMessage } from './dispatch/messages.js';
 import { Connector } from './interface/connector.js';
 import { Socket } from './interface/socket.js';
-import { createDebugLogger } from '../log/index.js';
 
 const debug = createDebugLogger('aztec:transport_client');
 

package/src/wasm/wasm/empty_wasi_sdk.ts

@@ -1,4 +1,4 @@
-import { createDebugLogger } from '../../log/index.js';
+import { createDebugOnlyLogger } from '../../log/index.js';
 
 /**
  * Dummy implementation of a necessary part of the wasi api:
@@ -7,7 +7,7 @@ import { createDebugLogger } from '../../log/index.js';
  * TODO find a way to update off of wasi 12.
  */
 /* eslint-disable camelcase */
-export const getEmptyWasiSdk = (debug = createDebugLogger('wasm:empty_wasi_sdk')) => ({
+export const getEmptyWasiSdk = (debug = createDebugOnlyLogger('wasm:empty_wasi_sdk')) => ({
   /**
    * Retrieves the current time from the system clock.
    * This function is a dummy implementation of the WASI API's `clock_time_get` method,

package/src/wasm/wasm/wasm_module.test.ts

@@ -1,7 +1,8 @@
-import { WasmModule } from './wasm_module.js';
-import { fileURLToPath } from 'url';
 import { readFile } from 'fs/promises';
 import { dirname } from 'path';
+import { fileURLToPath } from 'url';
+
+import { WasmModule } from './wasm_module.js';
 
 /**
  * Fetch a simple WASM.