@aztec/foundation 0.16.3 → 0.16.5

package/src/transport/transport_client.ts

@@ -1,131 +0,0 @@
-import EventEmitter from 'events';
-import { format } from 'util';
-
-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';
-
-const debug = createDebugLogger('aztec:transport_client');
-
-/**
- * Represents a pending request in the TransportClient.
- * Contains information about the message ID, and resolve/reject functions for handling responses.
- * Used to track and manage asynchronous request/response communication with the TransportServer.
- */
-interface PendingRequest {
-  /**
-   * The unique message identifier used for tracking and matching request/response pairs.
-   */
-  msgId: number;
-  // eslint-disable-next-line jsdoc/require-jsdoc
-  resolve(data: any): void;
-  // eslint-disable-next-line jsdoc/require-jsdoc
-  reject(error: Error): void;
-}
-
-/**
- * Represents a transport client for communication between TransportServer and clients.
- * Provides request/response functionality, event handling, and multiplexing support
- * for efficient and concurrent communication with a corresponding TransportServer.
- */
-export interface ITransportClient<Payload> extends EventEmitter {
-  // eslint-disable-next-line jsdoc/require-jsdoc
-  on(name: 'event_msg', handler: (payload: Payload) => void): this;
-  // eslint-disable-next-line jsdoc/require-jsdoc
-  emit(name: 'event_msg', payload: Payload): boolean;
-}
-
-/**
- * A TransportClient provides a request/response and event api to a corresponding TransportServer.
- * If `broadcast` is called on TransportServer, TransportClients will emit an `event_msg`.
- * The `request` method will block until a response is returned from the TransportServer's dispatch function.
- * Request multiplexing is supported.
- */
-export class TransportClient<Payload> extends EventEmitter {
-  private msgId = 0;
-  private pendingRequests: PendingRequest[] = [];
-  private socket?: Socket;
-
-  constructor(private transportConnect: Connector) {
-    super();
-  }
-
-  /**
-   * Initializes and opens the socket connection for the TransportClient.
-   * This method creates a new Socket instance using the provided Connector,
-   * registers a handler for incoming messages, and establishes the connection.
-   * It should be called before making any requests or handling events.
-   *
-   * @throws An error if the socket is already open or there's an issue opening the connection.
-   * @returns A Promise that resolves when the socket connection is successfully opened.
-   */
-  async open() {
-    this.socket = await this.transportConnect.createSocket();
-    this.socket.registerHandler(msg => this.handleSocketMessage(msg));
-  }
-
-  /**
-   * Close the transport client's socket connection and remove all event listeners.
-   * This method should be called when the client is no longer needed to ensure proper cleanup
-   * and prevent potential memory leaks. Once closed, the client cannot be reused and a new
-   * instance must be created if another connection is needed.
-   */
-  close() {
-    this.socket?.close();
-    this.socket = undefined;
-    this.removeAllListeners();
-  }
-
-  /**
-   * Sends a request to the TransportServer with the given payload and transferable objects.
-   * The method will block until a response from the TransportServer's dispatch function is returned.
-   * Request multiplexing is supported, allowing multiple requests to be sent concurrently.
-   *
-   * @param payload - The message payload to send to the server.
-   * @param transfer - An optional array of ArrayBuffer, MessagePort, or ImageBitmap objects to transfer ownership.
-   * @returns A Promise that resolves with the server's response data or rejects with an error message.
-   */
-  request(payload: Payload, transfer?: Transferable[]) {
-    if (!this.socket) {
-      throw new Error('Socket not open.');
-    }
-    const msgId = this.msgId++;
-    const msg = { msgId, payload };
-    debug(format(`->`, msg));
-    return new Promise<any>((resolve, reject) => {
-      this.pendingRequests.push({ resolve, reject, msgId });
-      this.socket!.send(msg, transfer).catch(reject);
-    });
-  }
-
-  /**
-   * Handles incoming socket messages from the TransportServer, such as ResponseMessage and EventMessage.
-   * If it's an EventMessage, emits an 'event_msg' event with the payload.
-   * If it's a ResponseMessage, resolves or rejects the corresponding pending request based on the message content.
-   *
-   * @param msg - The ResponseMessage or EventMessage received from the TransportServer, or undefined if the remote socket closed.
-   */
-  private handleSocketMessage(msg: ResponseMessage<Payload> | EventMessage<Payload> | undefined) {
-    if (msg === undefined) {
-      // The remote socket closed.
-      this.close();
-      return;
-    }
-    debug(format(`<-`, msg));
-    if (isEventMessage(msg)) {
-      this.emit('event_msg', msg.payload);
-      return;
-    }
-    const reqIndex = this.pendingRequests.findIndex(r => r.msgId === msg.msgId);
-    if (reqIndex === -1) {
-      return;
-    }
-    const [pending] = this.pendingRequests.splice(reqIndex, 1);
-    if (msg.error) {
-      pending.reject(new Error(msg.error));
-    } else {
-      pending.resolve(msg.payload);
-    }
-  }
-}

package/src/transport/transport_server.ts

@@ -1,108 +0,0 @@
-import { RequestMessage, ResponseMessage } from './dispatch/messages.js';
-import { Listener } from './interface/listener.js';
-import { Socket } from './interface/socket.js';
-import { isTransferDescriptor } from './interface/transferable.js';
-
-/**
- * Keeps track of clients, providing a broadcast, and request/response api with multiplexing.
- */
-export class TransportServer<Payload> {
-  private sockets: Socket[] = [];
-
-  constructor(private listener: Listener, private msgHandlerFn: (msg: Payload) => Promise<any>) {}
-
-  /**
-   * Starts the TransportServer, allowing it to accept new connections and handle incoming messages.
-   * The server will listen for 'new_socket' events from the underlying listener and invoke the provided message handler function
-   * for each received message. The server remains active until the 'stop' method is called.
-   */
-  start() {
-    this.listener.on('new_socket', client => this.handleNewSocket(client));
-    this.listener.open();
-  }
-
-  /**
-   * Stops accepting new connections. It doesn't close existing sockets.
-   * It's expected the clients will gracefully complete by closing their end, sending an `undefined` message.
-   */
-  stop() {
-    this.listener.close();
-  }
-
-  /**
-   * Sends a broadcast message to all connected clients.
-   * The given payload will be sent to all the clients currently connected to the TransportServer.
-   * It waits for all the messages to be sent and resolves when they are all sent successfully.
-   *
-   * @param msg - The payload to broadcast to all connected clients.
-   * @returns A Promise that resolves when all messages have been sent successfully.
-   */
-  async broadcast(msg: Payload) {
-    await Promise.all(this.sockets.map(s => s.send({ payload: msg })));
-  }
-
-  /**
-   * Handles the addition of a new socket to the server by registering a message handler for the client
-   * and adding the socket to the list of active sockets. The message handler processes incoming messages
-   * from the client, including detecting client disconnection and removing the closed socket.
-   *
-   * @param socket - The new Socket instance that has connected to the server.
-   */
-  private handleNewSocket(socket: Socket) {
-    socket.registerHandler(async msg => {
-      if (msg === undefined) {
-        // Client socket has closed. Remove it from the list of sockets. Call close on it for any cleanup.
-        const socketIndex = this.sockets.findIndex(s => s === socket);
-        const [closingSocket] = this.sockets.splice(socketIndex, 1);
-        closingSocket.close();
-        return;
-      }
-      return await this.handleSocketMessage(socket, msg);
-    });
-    this.sockets.push(socket);
-  }
-
-  /**
-   * Detect the 'transferables' argument to our socket from our message
-   * handler return type.
-   * @param data - The compound payload data.
-   * @returns The split data and transferables.
-   */
-  private getPayloadAndTransfers(data: any): [any, Transferable[]] {
-    if (isTransferDescriptor(data)) {
-      // We treat PayloadWithTransfers specially so that we're able to
-      // attach transferables while keeping a simple return-type based usage
-      return [data.send, data.transferables];
-    }
-    if (data instanceof Uint8Array) {
-      // We may want to devise a better solution to this. We maybe given a view over a non cloneable/transferrable
-      // ArrayBuffer (such as a view over wasm memory). In this case we want to take a copy, and then transfer it.
-      const respPayload = data instanceof Uint8Array && ArrayBuffer.isView(data) ? new Uint8Array(data) : data;
-      const transferables = data instanceof Uint8Array ? [respPayload.buffer] : [];
-      return [respPayload, transferables];
-    }
-    return [data, []];
-  }
-  /**
-   * Handles incoming socket messages, processing the request and sending back a response.
-   * This function is responsible for invoking the registered message handler function with the received
-   * payload, extracting the result and transferables, and sending a response message back to the client.
-   * In case of an error during message handling, it sends an error response with the stack trace.
-   *
-   * @param socket - The Socket instance from which the message was received.
-   * @param msg - The RequestMessage object containing the message ID and payload.
-   */
-  private async handleSocketMessage(socket: Socket, { msgId, payload }: RequestMessage<Payload>) {
-    try {
-      const data = await this.msgHandlerFn(payload);
-
-      const [respPayload, transferables] = this.getPayloadAndTransfers(data);
-      const rep: ResponseMessage<Payload> = { msgId, payload: respPayload };
-
-      await socket.send(rep, transferables);
-    } catch (err: any) {
-      const rep: ResponseMessage<Payload> = { msgId, error: err.stack };
-      await socket.send(rep);
-    }
-  }
-}

package/src/trees/index.ts

@@ -1,48 +0,0 @@
-/**
- * A leaf of an indexed merkle tree.
- */
-export interface IndexedTreeLeaf {
-  /**
-   * Returns key of the leaf. It's used for indexing.
-   */
-  getKey(): bigint;
-  /**
-   * Serializes the leaf into a buffer.
-   */
-  toBuffer(): Buffer;
-  /**
-   * Returns true if the leaf is empty.
-   */
-  isEmpty(): boolean;
-}
-
-/**
- * Preimage of an indexed merkle tree leaf.
- */
-export interface IndexedTreeLeafPreimage {
-  /**
-   * Returns key of the leaf corresponding to this preimage.
-   */
-  getKey(): bigint;
-  /**
-   * Returns the key of the next leaf.
-   */
-  getNextKey(): bigint;
-  /**
-   * Returns the index of the next leaf.
-   */
-  getNextIndex(): bigint;
-
-  /**
-   * Returns the preimage as a leaf.
-   */
-  asLeaf(): IndexedTreeLeaf;
-  /**
-   * Serializes the preimage into a buffer.
-   */
-  toBuffer(): Buffer;
-  /**
-   * Serializes the preimage to an array of buffers for hashing.
-   */
-  toHashInputs(): Buffer[];
-}

package/src/types/index.ts

@@ -1,7 +0,0 @@
-/**
- * Strips methods of a type.
- */
-export type FieldsOf<T> = {
-  // eslint-disable-next-line @typescript-eslint/ban-types
-  [P in keyof T as T[P] extends Function ? never : P]: T[P];
-};

package/src/url/index.ts

@@ -1,73 +0,0 @@
-/* eslint-disable */
-// Copyright (c) 2014 Nathan Rajlich <nathan@tootallnate.net>
-// Permission is hereby granted, free of charge, to any person obtaining
-// a copy of this software and associated documentation files (the
-// 'Software'), to deal in the Software without restriction, including
-// without limitation the rights to use, copy, modify, merge, publish,
-// distribute, sublicense, and/or sell copies of the Software, and to
-// permit persons to whom the Software is furnished to do so, subject to
-// the following conditions:
-// The above copyright notice and this permission notice shall be
-// included in all copies or substantial portions of the Software.
-// THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-import { sep } from 'path';
-
-/**
- * File URI to Path function.
- *
- * @param {String} uri
- * @return {String} path
- * @api public
- */
-
-export function fileURLToPath(uri: string): string {
-  if (typeof uri !== 'string' || uri.length <= 7 || uri.substring(0, 7) !== 'file://') {
-    throw new TypeError('must pass in a file:// URI to convert to a file path');
-  }
-
-  const rest = decodeURI(uri.substring(7));
-  const firstSlash = rest.indexOf('/');
-  let host = rest.substring(0, firstSlash);
-  let path = rest.substring(firstSlash + 1);
-
-  // 2.  Scheme Definition
-  // As a special case, <host> can be the string "localhost" or the empty
-  // string; this is interpreted as "the machine from which the URL is
-  // being interpreted".
-  if (host === 'localhost') {
-    host = '';
-  }
-
-  if (host) {
-    host = sep + sep + host;
-  }
-
-  // 3.2  Drives, drive letters, mount points, file system root
-  // Drive letters are mapped into the top of a file URI in various ways,
-  // depending on the implementation; some applications substitute
-  // vertical bar ("|") for the colon after the drive letter, yielding
-  // "file:///c|/tmp/test.txt".  In some cases, the colon is left
-  // unchanged, as in "file:///c:/tmp/test.txt".  In other cases, the
-  // colon is simply omitted, as in "file:///c/tmp/test.txt".
-  path = path.replace(/^(.+)\|/, '$1:');
-
-  // for Windows, we need to invert the path separators from what a URI uses
-  if (sep === '\\') {
-    path = path.replace(/\//g, '\\');
-  }
-
-  if (/^.+:/.test(path)) {
-    // has Windows drive at beginning of path
-  } else {
-    // unix path…
-    path = sep + path;
-  }
-
-  return host + path;
-}

package/src/wasm/README.md

@@ -1,6 +0,0 @@
-# wasm
-
-Functionality to:
-
-1.  Call WebAssembly functions
-2.  Create asynchronous workers that host webassembly.

package/src/wasm/empty_wasi_sdk.ts

@@ -1,166 +0,0 @@
-import { createDebugOnlyLogger } from '../log/index.js';
-
-/**
- * Dummy implementation of a necessary part of the wasi api:
- * https://github.com/WebAssembly/WASI/blob/main/phases/snapshot/docs.md
- * We don't use these functions, but the environment expects them.
- * TODO find a way to update off of wasi 12.
- */
-/* eslint-disable camelcase */
-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,
-   * which is expected by the environment but not used in this context.
-   *
-   * No input parameters or return values are required, as the purpose of this function
-   * is solely to satisfy the environment expectations and provide debugging information.
-   */
-  clock_time_get() {
-    debug('clock_time_get');
-  },
-  /**
-   * Dummy implementation of WASI's environ_get function.
-   * This function is used to obtain a snapshot of the current environment variables.
-   * In this dummy implementation, no actual actions are performed, but the debug logger logs 'environ_get' when called.
-   * Environment variables are not used in this context, so the real implementation is not required.
-   *
-   * @see https://github.com/WebAssembly/WASI/blob/main/phases/snapshot/docs.md#environ_get
-   */
-  environ_get() {
-    debug('environ_get');
-  },
-  /**
-   * Retrieves the environment variable sizes from the WebAssembly environment.
-   * This function is part of the WASI API and provides a dummy implementation to fulfill the expected APIs.
-   * It does not have any actual functionality, but serves as a placeholder in the environment.
-   */
-  environ_sizes_get() {
-    debug('environ_sizes_get');
-  },
-  /**
-   * Closes a file descriptor, releasing any resources associated with it.
-   * This function does not perform any actual closing operation, but exists to
-   * satisfy the requirements of the WebAssembly System Interface (WASI) API,
-   * which expects certain functions to be present for compatibility purposes.
-   *
-   * @see https://github.com/WebAssembly/WASI/blob/main/phases/snapshot/docs.md
-   */
-  fd_close() {
-    debug('fd_close');
-  },
-  /**
-   * A dummy implementation of the 'fd_read' function from the WASI API.
-   * This function is required by the environment, but not used in this context.
-   * It would normally read data from a file descriptor into an array buffer,
-   * but here it simply logs the invocation for debugging purposes.
-   */
-  fd_read() {
-    debug('fd_read');
-  },
-  /**
-   * Handles the file descriptor write operation.
-   * This dummy implementation of the WASI 'fd_write' function is part of the wasi API:
-   * https://github.com/WebAssembly/WASI/blob/main/phases/snapshot/docs.md
-   * The environment expects this function, but it is not used in the current implementation.
-   * It is used to write data from WebAssembly memory to a file descriptor.
-   */
-  fd_write() {
-    debug('fd_write');
-  },
-  /**
-   * Perform a file seek operation on the given file descriptor to change its current position.
-   * The new position is calculated using the provided offset and whence values.
-   * Throws an error if the file descriptor is invalid or the operation cannot be performed.
-   *
-   * @param fd - The file descriptor of the file to perform the seek operation on.
-   * @param offset - The relative offset to apply, based on the whence value.
-   * @param whence - The reference point from which the offset should be calculated. One of SEEK_SET (start), SEEK_CUR (current), or SEEK_END (end).
-   * @returns The new position in the file after the seek operation has been performed.
-   */
-  fd_seek() {
-    debug('fd_seek');
-  },
-  /**
-   * This function is a dummy implementation of the 'fd_fdstat_get' function in the WebAssembly System Interface (WASI) API.
-   * Although not actually used in this context, it is present due to the environment's expectation of its existence.
-   * The 'fd_fdstat_get' function is typically responsible for obtaining file descriptor status information.
-   */
-  fd_fdstat_get() {
-    debug('fd_fdstat_get');
-  },
-  /**
-   * Sets the file descriptor flags for a given file descriptor.
-   * This function is a dummy implementation of the WASI API function 'fd_fdstat_set_flags'.
-   * It currently does not perform any operation but logs the function call with a debug instance.
-   * This is provided since the environment expects this function to be present.
-   */
-  fd_fdstat_set_flags() {
-    debug('fd_fdstat_set_flags');
-  },
-  /**
-   * Handles the `fd_prestat_get` function call for the dummy WebAssembly System Interface (WASI) implementation.
-   * This function is expected by the WASI environment, although it is not used in this implementation.
-   * The `fd_prestat_get` function retrieves pre-opened file descriptor properties.
-   *
-   * @returns A constant integer value indicating successful completion of the function call.
-   */
-  fd_prestat_get() {
-    debug('fd_prestat_get');
-    return 8;
-  },
-  /**
-   * Provides a dummy implementation for the `fd_prestat_dir_name` function, which is expected to be called by the WASI environment.
-   * This function is intended to retrieve the pre-opened directory's path associated with the given file descriptor. However, since it's a dummy implementation,
-   * it doesn't perform any actual operation and only logs the function call with the provided debug logger.
-   *
-   * @returns A constant number representing a dummy return value for the function call.
-   */
-  fd_prestat_dir_name() {
-    debug('fd_prestat_dir_name');
-    return 28;
-  },
-  /**
-   * Handles the opening of a file path within the WASI environment.
-   * This function is a dummy implementation required for compatibility with
-   * the WebAssembly System Interface (WASI) API, but it does not perform any
-   * actual file opening operation. It is mainly used for debugging purposes.
-   */
-  path_open() {
-    debug('path_open');
-  },
-  /**
-   * Retrieve file system information of the specified path.
-   * This function retrieves statistics, such as size and permissions, associated with the file or directory
-   * identified by the given path. In case of an error or non-existing path, appropriate debug logs will be generated.
-   *
-   * @returns An object containing file statistics like size, permissions, etc.
-   */
-  path_filestat_get() {
-    debug('path_filestat_get');
-  },
-  /**
-   * Terminate the process normally, performing the regular cleanup for terminating programs.
-   * The input 'status' represents the exit code and is used to indicate success or failure
-   * of the program execution. A zero value typically indicates successful execution,
-   * while non-zero values are treated as errors by the operating system.
-   *
-   * @param status - The exit code representing the success or failure of the program execution.
-   * @returns The exit status code.
-   */
-  proc_exit() {
-    debug('proc_exit');
-    return 52;
-  },
-  /**
-   * Generates a random number and returns it.
-   * This dummy implementation of 'random_get' method in the wasi API is expected by the environment.
-   * In this case, the function always returns 1 to maintain consistency with the environment's expectations.
-   *
-   * @returns A random number. In this implementation, always returns 1.
-   */
-  random_get() {
-    debug('random_get');
-    return 1;
-  },
-});

package/src/wasm/fixtures/gcd.wat

@@ -1,27 +0,0 @@
-(module
-  (func $gcd (param i32 i32) (result i32)
-    (local i32)
-    block  ;; label = @1
-      block  ;; label = @2
-        local.get 0
-        br_if 0 (;@2;)
-        local.get 1
-        local.set 2
-        br 1 (;@1;)
-      end
-      loop  ;; label = @2
-        local.get 1
-        local.get 0
-        local.tee 2
-        i32.rem_u
-        local.set 0
-        local.get 2
-        local.set 1
-        local.get 0
-        br_if 0 (;@2;)
-      end
-    end
-    local.get 2
-  )
-  (export "gcd" (func $gcd))
-)

package/src/wasm/index.ts

@@ -1 +0,0 @@
-export { WasmModule, IWasmModule } from './wasm_module.js';