@aztec/foundation 0.66.0 → 0.67.0

package/src/queue/base_memory_queue.ts

@@ -1,11 +1,11 @@
 import { TimeoutError } from '../error/index.js';
-import { createDebugLogger } from '../log/index.js';
+import { createLogger } from '../log/index.js';
 
 export abstract class BaseMemoryQueue<T> {
   private waiting: ((item: T | null) => void)[] = [];
   private flushing = false;
 
-  constructor(private log = createDebugLogger('aztec:foundation:memory_fifo')) {}
+  constructor(private log = createLogger('foundation:memory_fifo')) {}
 
   protected abstract get items(): {
     length: number;

package/src/queue/bounded_serial_queue.ts

@@ -1,4 +1,4 @@
-import { createDebugLogger } from '../log/index.js';
+import { createLogger } 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 = createDebugLogger('aztec:foundation:bounded_serial_queue')) {
+  constructor(maxQueueSize: number, private log = createLogger('foundation:bounded_serial_queue')) {
     this.semaphore = new Semaphore(maxQueueSize);
   }
 

package/src/queue/fifo_memory_queue.ts

@@ -1,4 +1,4 @@
-import { type DebugLogger } from '../log/index.js';
+import { type Logger } from '../log/index.js';
 import { BaseMemoryQueue } from './base_memory_queue.js';
 
 /**
@@ -9,7 +9,7 @@ import { BaseMemoryQueue } from './base_memory_queue.js';
 export class FifoMemoryQueue<T> extends BaseMemoryQueue<T> {
   private container = new FifoQueue<T>();
 
-  constructor(log?: DebugLogger) {
+  constructor(log?: Logger) {
     super(log);
   }
 

package/src/retry/index.ts

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

package/src/schemas/utils.ts

@@ -3,13 +3,16 @@ import {
   type ParseInput,
   type ParseReturnType,
   ZodFirstPartyTypeKind,
+  type ZodObject,
   ZodOptional,
   ZodParsedType,
+  type ZodRawShape,
   type ZodType,
   type ZodTypeAny,
   z,
 } from 'zod';
 
+import { pick } from '../collection/object.js';
 import { isHex, withoutHexPrefix } from '../string/index.js';
 import { type ZodFor } from './types.js';
 
@@ -72,10 +75,10 @@ export function hexSchemaFor<TClass extends { fromString(str: string): any } | {
   string
 > {
   const stringSchema = refinement ? z.string().refine(refinement, `Not a valid instance`) : z.string();
-  const hexSchema = stringSchema.refine(isHex, 'Not a valid hex string').transform(withoutHexPrefix);
+  const hexSchema = stringSchema.refine(isHex, 'Not a valid hex string');
   return 'fromString' in klazz
     ? hexSchema.transform(klazz.fromString.bind(klazz))
-    : hexSchema.transform(str => Buffer.from(str, 'hex')).transform(klazz.fromBuffer.bind(klazz));
+    : hexSchema.transform(str => Buffer.from(withoutHexPrefix(str), 'hex')).transform(klazz.fromBuffer.bind(klazz));
 }
 
 /**
@@ -102,3 +105,8 @@ export function mapSchema<TKey, TValue>(key: ZodFor<TKey>, value: ZodFor<TValue>
 export function setSchema<T>(value: ZodFor<T>): ZodFor<Set<T>> {
   return z.array(value).transform(entries => new Set(entries));
 }
+
+/** Given an already parsed and validated object, extracts the keys defined in the given schema. Does not validate again. */
+export function pickFromSchema<T extends object, S extends ZodObject<ZodRawShape>>(obj: T, schema: S) {
+  return pick(obj, ...Object.keys(schema.shape));
+}

package/src/testing/test_data.ts

@@ -5,12 +5,21 @@ import { createConsoleLogger } from '../log/console.js';
 import { fileURLToPath } from '../url/index.js';
 
 const testData: { [key: string]: unknown[] } = {};
+let generateProtocolCircuitTestData = false;
 
 /** Returns whether test data generation is enabled */
 export function isGenerateTestDataEnabled() {
   return ['1', 'true'].includes(process.env.AZTEC_GENERATE_TEST_DATA ?? '') && typeof expect !== 'undefined';
 }
 
+/**
+ * This is separate so Prover.tomls don't get edited everytime any test is run,
+ * Only full.test updates prover tomls, then switches this off.
+ */
+export function switchGenerateProtocolCircuitTestData() {
+  generateProtocolCircuitTestData = !generateProtocolCircuitTestData;
+}
+
 /** Pushes test data with the given name, only if test data generation is enabled. */
 export function pushTestData<T>(itemName: string, data: T) {
   if (!isGenerateTestDataEnabled()) {
@@ -76,6 +85,22 @@ export function updateInlineTestData(targetFileFromRepoRoot: string, itemName: s
   logger(`Updated test data in ${targetFile} for ${itemName} to ${value}`);
 }
 
+/**
+ * Updates the sample Prover.toml files in noir-projects/noir-protocol-circuits/crates/.
+ * @remarks Requires AZTEC_GENERATE_TEST_DATA=1 & generateProtocolCircuitTestData=true to be set
+ * To re-gen, run 'AZTEC_GENERATE_TEST_DATA=1 FAKE_PROOFS=1 yarn workspace @aztec/end-to-end test full.test'
+ */
+export function updateProtocolCircuitSampleInputs(circuitName: string, value: string) {
+  if (!isGenerateTestDataEnabled() || !generateProtocolCircuitTestData) {
+    return;
+  }
+  const logger = createConsoleLogger('aztec:testing:test_data');
+  const targetFileFromRepoRoot = `noir-projects/noir-protocol-circuits/crates/${circuitName}/Prover.toml`;
+  const targetFile = getPathToFile(targetFileFromRepoRoot);
+  writeFileSync(targetFile, value);
+  logger(`Updated test data in ${targetFile} for ${circuitName}`);
+}
+
 function getPathToFile(targetFileFromRepoRoot: string) {
   const repoRoot = resolve(dirname(fileURLToPath(import.meta.url)), '../../../../');
   if (!existsSync(join(repoRoot, 'CODEOWNERS'))) {

package/src/transport/dispatch/create_dispatch_fn.ts

@@ -1,6 +1,6 @@
 import { format } from 'util';
 
-import { createDebugLogger } from '../../log/index.js';
+import { createLogger } from '../../log/index.js';
 
 /**
  * Represents a message object for dispatching function calls.
@@ -26,7 +26,7 @@ export interface DispatchMsg {
  * @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 = createDebugLogger('aztec:foundation:dispatch')) {
+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));

package/src/transport/transport_client.ts

@@ -1,12 +1,12 @@
 import EventEmitter from 'events';
 import { format } from 'util';
 
-import { createDebugLogger } from '../log/index.js';
+import { createLogger } from '../log/index.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 log = createDebugLogger('aztec:transport_client');
+const log = createLogger('foundation:transport_client');
 
 /**
  * Represents a pending request in the TransportClient.

package/src/wasm/wasm_module.ts

@@ -59,7 +59,7 @@ export class WasmModule implements IWasmModule {
   constructor(
     private module: WebAssembly.Module | Buffer,
     private importFn: (module: WasmModule) => any,
-    loggerName = 'aztec:wasm',
+    loggerName = 'wasm',
   ) {
     this.debug = createDebugOnlyLogger(loggerName);
     this.mutexQ.put(true);

package/src/worker/worker_pool.ts

@@ -1,7 +1,7 @@
-import { createDebugLogger } from '../log/index.js';
+import { createLogger } from '../log/index.js';
 import { type WasmWorker } from './wasm_worker.js';
 
-const log = createDebugLogger('bb:worker_pool');
+const log = createLogger('foundation:worker_pool');
 
 /**
  * Type of a worker factory.