@aztec/foundation 0.32.0 → 0.33.0

package/src/serialize/free_funcs.ts

@@ -1,5 +1,5 @@
 import { Fr } from '../fields/fields.js';
-import { Tuple } from './types.js';
+import { type Tuple } from './types.js';
 
 /**
  * Convert a boolean value to its corresponding byte representation in a Buffer of size 1.

package/src/sleep/index.ts

@@ -67,8 +67,9 @@ export class InterruptibleSleep {
  * The sleep function can be interrupted by the 'interrupt' method of the InterruptibleSleep class.
  *
  * @param ms - The duration in milliseconds for which the sleep operation should last.
+ * @param returnValue - The return value of the promise.
  * @returns A Promise that resolves after the specified duration, allowing the use of 'await' to pause execution.
  */
-export function sleep(ms: number) {
-  return new Promise(resolve => setTimeout(resolve, ms));
+export function sleep<T>(ms: number, returnValue?: T): Promise<T | undefined> {
+  return new Promise(resolve => setTimeout(() => resolve(returnValue), ms));
 }

package/src/transport/browser/message_port_socket.ts

@@ -1,4 +1,4 @@
-import { Socket } from '../interface/socket.js';
+import { type Socket } from '../interface/socket.js';
 
 /**
  * An implementation of a TransportSocket using MessagePorts.

package/src/transport/browser/shared_worker_connector.ts

@@ -1,4 +1,4 @@
-import { Connector } from '../interface/connector.js';
+import { type Connector } from '../interface/connector.js';
 import { MessagePortSocket } from './message_port_socket.js';
 
 /**

package/src/transport/browser/shared_worker_listener.ts

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

package/src/transport/browser/worker_connector.ts

@@ -1,4 +1,4 @@
-import { Connector } from '../interface/connector.js';
+import { type Connector } from '../interface/connector.js';
 import { MessagePortSocket } from './message_port_socket.js';
 
 /**

package/src/transport/browser/worker_listener.ts

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

package/src/transport/dispatch/create_dispatch_proxy.ts

@@ -1,8 +1,8 @@
 import { EventEmitter } from 'events';
 
-import { TransferDescriptor, isTransferDescriptor } from '../interface/transferable.js';
-import { TransportClient } from '../transport_client.js';
-import { DispatchMsg } from './create_dispatch_fn.js';
+import { type TransferDescriptor, isTransferDescriptor } from '../interface/transferable.js';
+import { type TransportClient } from '../transport_client.js';
+import { type 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/connector.ts

@@ -1,4 +1,4 @@
-import { Socket } from './socket.js';
+import { type Socket } from './socket.js';
 
 /**
  * Opens a socket with corresponding TransportListener.

package/src/transport/interface/listener.ts

@@ -1,6 +1,6 @@
-import EventEmitter from 'events';
+import type EventEmitter from 'events';
 
-import { Socket } from './socket.js';
+import { type Socket } from './socket.js';
 
 /**
  * Once opened, an implementation of a TransportListener will emit `new_socket` events as new clients connect.

package/src/transport/node/node_connector.ts

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

package/src/transport/node/node_connector_socket.ts

@@ -1,6 +1,6 @@
-import { TransferListItem, Worker } from 'worker_threads';
+import { type TransferListItem, type Worker } from 'worker_threads';
 
-import { Socket } from '../interface/socket.js';
+import { type Socket } from '../interface/socket.js';
 
 /**
  * NodeConnectorSocket is a wrapper class that implements the Socket interface for messaging between

package/src/transport/node/node_listener.ts

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

package/src/transport/node/node_listener_socket.ts

@@ -1,6 +1,6 @@
-import { MessagePort, TransferListItem } from 'worker_threads';
+import { type MessagePort, type TransferListItem } from 'worker_threads';
 
-import { Socket } from '../interface/socket.js';
+import { type Socket } from '../interface/socket.js';
 
 /**
  * An implementation of a TransportSocket using MessagePorts.

package/src/transport/transport_client.ts

@@ -2,9 +2,9 @@ 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';
+import { type EventMessage, type ResponseMessage, isEventMessage } from './dispatch/messages.js';
+import { type Connector } from './interface/connector.js';
+import { type Socket } from './interface/socket.js';
 
 const debug = createDebugLogger('aztec:transport_client');
 

package/src/transport/transport_server.ts

@@ -1,6 +1,6 @@
-import { RequestMessage, ResponseMessage } from './dispatch/messages.js';
-import { Listener } from './interface/listener.js';
-import { Socket } from './interface/socket.js';
+import { type RequestMessage, type ResponseMessage } from './dispatch/messages.js';
+import { type Listener } from './interface/listener.js';
+import { type Socket } from './interface/socket.js';
 import { isTransferDescriptor } from './interface/transferable.js';
 
 /**

package/src/types/index.ts

@@ -4,5 +4,11 @@ export type FieldsOf<T> = {
   [P in keyof T as T[P] extends Function ? never : P]: T[P];
 };
 
+/** Extracts methods of a type. */
+export type FunctionsOf<T> = {
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  [P in keyof T as T[P] extends Function ? P : never]: T[P];
+};
+
 /** Marks a set of properties of a type as optional. */
 export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;

package/src/wasm/wasm_module.ts

@@ -2,7 +2,7 @@ import { Buffer } from 'buffer';
 
 import { randomBytes } from '../crypto/index.js';
 import { MemoryFifo } from '../fifo/index.js';
-import { LogFn, createDebugOnlyLogger } from '../log/index.js';
+import { type LogFn, createDebugOnlyLogger } from '../log/index.js';
 import { getEmptyWasiSdk } from './empty_wasi_sdk.js';
 
 /**

package/src/worker/browser/start_web_module.ts

@@ -1,5 +1,5 @@
-import { DispatchMsg, TransportServer, WorkerListener } from '../../transport/index.js';
-import { WasmModule } from '../../wasm/index.js';
+import { type DispatchMsg, TransportServer, WorkerListener } from '../../transport/index.js';
+import { type WasmModule } from '../../wasm/index.js';
 
 /**
  * Start the transport server corresponding to this module.

package/src/worker/browser/web_data_store.ts

@@ -1,7 +1,7 @@
-import levelup, { LevelUp } from 'levelup';
+import levelup, { type LevelUp } from 'levelup';
 import memdown from 'memdown';
 
-import { DataStore } from '../data_store.js';
+import { type DataStore } from '../data_store.js';
 
 /**
  * Cache for data used by wasm module.

package/src/worker/browser/web_worker.ts

@@ -1,6 +1,6 @@
-import { DispatchMsg, TransportClient, WorkerConnector, createDispatchProxy } from '../../transport/index.js';
+import { type DispatchMsg, TransportClient, WorkerConnector, createDispatchProxy } from '../../transport/index.js';
 import { WasmModule } from '../../wasm/index.js';
-import { WasmWorker } from '../wasm_worker.js';
+import { type WasmWorker } from '../wasm_worker.js';
 
 /**
  * Instantiate a web worker.

package/src/worker/node/node_data_store.ts

@@ -1,8 +1,8 @@
 import leveldown from 'leveldown';
-import levelup, { LevelUp } from 'levelup';
+import levelup, { type LevelUp } from 'levelup';
 import memdown from 'memdown';
 
-import { DataStore } from '../data_store.js';
+import { type DataStore } from '../data_store.js';
 
 /**
  * Cache for data used by wasm module.

package/src/worker/node/node_worker.ts

@@ -1,8 +1,8 @@
 import { Worker } from 'worker_threads';
 
-import { DispatchMsg, NodeConnector, TransportClient, createDispatchProxy } from '../../transport/index.js';
+import { type DispatchMsg, NodeConnector, TransportClient, createDispatchProxy } from '../../transport/index.js';
 import { WasmModule } from '../../wasm/wasm_module.js';
-import { WasmWorker } from '../wasm_worker.js';
+import { type WasmWorker } from '../wasm_worker.js';
 
 /**
  * Creates a node worker.

package/src/worker/node/start_node_module.ts

@@ -1,7 +1,7 @@
 import { parentPort } from 'worker_threads';
 
-import { DispatchMsg, NodeListener, TransportServer } from '../../transport/index.js';
-import { WasmModule } from '../../wasm/wasm_module.js';
+import { type DispatchMsg, NodeListener, TransportServer } from '../../transport/index.js';
+import { type WasmModule } from '../../wasm/wasm_module.js';
 
 if (!parentPort) {
   throw new Error('InvalidWorker');

package/src/worker/wasm_worker.ts

@@ -1,5 +1,5 @@
-import { Proxify } from '../transport/index.js';
-import { WasmModule } from '../wasm/wasm_module.js';
+import { type Proxify } from '../transport/index.js';
+import { type WasmModule } from '../wasm/wasm_module.js';
 
 /**
  * Represents either a WASM web worker, or node.js worker.

package/src/worker/worker_pool.ts

@@ -1,5 +1,5 @@
 import { createDebugLogger } from '../log/index.js';
-import { WasmWorker } from './wasm_worker.js';
+import { type WasmWorker } from './wasm_worker.js';
 
 const debug = createDebugLogger('bb:worker_pool');