@aztec/foundation 0.0.0-test.1 → 0.0.1-commit.017a351

package/src/collection/lru_map.ts

@@ -0,0 +1,143 @@
+/** Node in a doubly-linked list used by {@link LruMap}. */
+type LruNode<K, V> = {
+  key: K;
+  value: V;
+  prev: LruNode<K, V> | undefined;
+  next: LruNode<K, V> | undefined;
+};
+
+/**
+ * A bounded key-value map with Least Recently Used (LRU) eviction.
+ * Both {@link get} and {@link set} count as an access and refresh the entry's
+ * recency, so entries that are actively used stay in the map longest.
+ *
+ * Uses a doubly-linked list for O(1) ordering and a Map for O(1) lookup.
+ * Head = least recent, tail = most recent.
+ */
+export class LruMap<K, V> {
+  /** Map from key to its linked-list node for O(1) lookup. */
+  private readonly map = new Map<K, LruNode<K, V>>();
+  private head: LruNode<K, V> | undefined;
+  private tail: LruNode<K, V> | undefined;
+
+  constructor(private readonly maxSize: number) {
+    if (maxSize < 1) {
+      throw new Error('LruMap maxSize must be at least 1');
+    }
+  }
+
+  /** Number of entries in the map. */
+  get size(): number {
+    return this.map.size;
+  }
+
+  /** Returns true if the key is present, without refreshing its recency. */
+  has(key: K): boolean {
+    return this.map.has(key);
+  }
+
+  /**
+   * Returns the value for the key, or undefined if absent.
+   * Refreshes the entry's recency so it becomes the most recently used.
+   */
+  get(key: K): V | undefined {
+    const node = this.map.get(key);
+    if (!node) {
+      return undefined;
+    }
+    this.moveToTail(node);
+    return node.value;
+  }
+
+  /**
+   * Stores a value for the key, refreshing its recency. If the key already exists, overwrites the value.
+   * If the map is at capacity, evicts the least recently used entry.
+   */
+  set(key: K, value: V): void {
+    const existing = this.map.get(key);
+    if (existing) {
+      existing.value = value;
+      this.moveToTail(existing);
+      return;
+    }
+
+    if (this.map.size >= this.maxSize) {
+      this.evictHead();
+    }
+
+    const node: LruNode<K, V> = { key, value, prev: this.tail, next: undefined };
+    if (this.tail) {
+      this.tail.next = node;
+    } else {
+      this.head = node;
+    }
+    this.tail = node;
+    this.map.set(key, node);
+  }
+
+  /** Removes the entry for the key, returning true if it was present. */
+  delete(key: K): boolean {
+    const node = this.map.get(key);
+    if (!node) {
+      return false;
+    }
+    this.unlink(node);
+    this.map.delete(key);
+    return true;
+  }
+
+  /** Removes all entries from the map. */
+  clear(): void {
+    this.map.clear();
+    this.head = undefined;
+    this.tail = undefined;
+  }
+
+  /** Unlinks a node from its current position and relinks it at the tail. */
+  private moveToTail(node: LruNode<K, V>): void {
+    if (node === this.tail) {
+      return;
+    }
+    this.unlink(node);
+
+    node.prev = this.tail;
+    node.next = undefined;
+    if (this.tail) {
+      this.tail.next = node;
+    } else {
+      this.head = node;
+    }
+    this.tail = node;
+  }
+
+  /** Detaches a node from the linked list, fixing up its neighbours and the head/tail pointers. */
+  private unlink(node: LruNode<K, V>): void {
+    if (node.prev) {
+      node.prev.next = node.next;
+    } else {
+      this.head = node.next;
+    }
+    if (node.next) {
+      node.next.prev = node.prev;
+    } else {
+      this.tail = node.prev;
+    }
+    node.prev = undefined;
+    node.next = undefined;
+  }
+
+  /** Evicts the head (least recently used) node. */
+  private evictHead(): void {
+    const oldHead = this.head;
+    if (!oldHead) {
+      return;
+    }
+    this.head = oldHead.next;
+    if (this.head) {
+      this.head.prev = undefined;
+    } else {
+      this.tail = undefined;
+    }
+    this.map.delete(oldHead.key);
+  }
+}

package/src/collection/lru_set.ts

@@ -0,0 +1,115 @@
+/** Node in a doubly-linked list used by {@link LruSet}. */
+type LruNode<T> = {
+  value: T;
+  prev: LruNode<T> | undefined;
+  next: LruNode<T> | undefined;
+};
+
+/**
+ * A bounded set with Least Recently Used (LRU) eviction.
+ * Both {@link has} and {@link add} count as an access and refresh the entry's
+ * recency, so items that are actively checked stay in the set longest.
+ *
+ * Uses a doubly-linked list for O(1) ordering and a Map for O(1) lookup.
+ * Head = least recent, tail = most recent.
+ */
+export class LruSet<T> {
+  /** Map from value to its linked-list node for O(1) lookup. */
+  private readonly map = new Map<T, LruNode<T>>();
+  private head: LruNode<T> | undefined;
+  private tail: LruNode<T> | undefined;
+
+  constructor(private readonly maxSize: number) {
+    if (maxSize < 1) {
+      throw new Error('LruSet maxSize must be at least 1');
+    }
+  }
+
+  /** Number of entries in the set. */
+  get size(): number {
+    return this.map.size;
+  }
+
+  /**
+   * Returns true if the item is in the set.
+   * Refreshes the item's recency so it becomes the most recently used.
+   */
+  has(item: T): boolean {
+    const node = this.map.get(item);
+    if (!node) {
+      return false;
+    }
+    this.moveToTail(node);
+    return true;
+  }
+
+  /**
+   * Adds an item to the set. If the item already exists, refreshes its recency.
+   * If the set is at capacity, evicts the least recently used item.
+   */
+  add(item: T): void {
+    const existing = this.map.get(item);
+    if (existing) {
+      this.moveToTail(existing);
+      return;
+    }
+
+    if (this.map.size >= this.maxSize) {
+      this.evictHead();
+    }
+
+    const node: LruNode<T> = { value: item, prev: this.tail, next: undefined };
+    if (this.tail) {
+      this.tail.next = node;
+    } else {
+      this.head = node;
+    }
+    this.tail = node;
+    this.map.set(item, node);
+  }
+
+  /** Removes all entries from the set. */
+  clear(): void {
+    this.map.clear();
+    this.head = undefined;
+    this.tail = undefined;
+  }
+
+  /** Unlinks a node from its current position and relinks it at the tail. */
+  private moveToTail(node: LruNode<T>): void {
+    if (node === this.tail) {
+      return;
+    }
+
+    // Unlink
+    if (node.prev) {
+      node.prev.next = node.next;
+    } else {
+      this.head = node.next;
+    }
+    if (node.next) {
+      node.next.prev = node.prev;
+    }
+
+    // Relink at tail
+    node.prev = this.tail;
+    node.next = undefined;
+    if (this.tail) {
+      this.tail.next = node;
+    }
+    this.tail = node;
+  }
+
+  /** Evicts the head (least recently used) node. */
+  private evictHead(): void {
+    const oldHead = this.head!;
+    this.map.delete(oldHead.value);
+
+    this.head = oldHead.next;
+    if (this.head) {
+      this.head.prev = undefined;
+    } else {
+      this.tail = undefined;
+    }
+  }
+}

package/src/collection/object.ts

@@ -50,3 +50,40 @@ export function omit<T extends object>(object: T, ...props: string[]): Partial<T
   }
   return obj;
 }
+
+/** Equivalent to Object.keys but preserves types. */
+export function getKeys<T extends object>(obj: T): (keyof T)[] {
+  return Object.keys(obj) as (keyof T)[];
+}
+
+/** Equivalent to Object.entries but preserves types. */
+export function getEntries<T extends Record<PropertyKey, unknown>>(obj: T): { [K in keyof T]: [K, T[K]] }[keyof T][] {
+  // See https://stackoverflow.com/a/76176570
+  return Object.entries(obj) as { [K in keyof T]: [K, T[K]] }[keyof T][];
+}
+
+/** Equivalent to Object.fromEntries but preserves types. */
+export function fromEntries<const T extends ReadonlyArray<readonly [PropertyKey, unknown]>>(
+  entries: T,
+): { [K in T[number] as K[0]]: K[1] } {
+  // See https://stackoverflow.com/a/76176570
+  return Object.fromEntries(entries) as { [K in T[number] as K[0]]: K[1] };
+}
+
+/** Asserts all values in object are not undefined. */
+export function assertRequired<T extends object>(obj: T): Required<T> {
+  for (const key in obj) {
+    if (obj[key] === undefined) {
+      throw new Error(`Missing property ${key}`);
+    }
+  }
+  return obj as Required<T>;
+}
+
+/** Returns the result of merging two objects ignoring properties with undefined values. */
+export function merge<T extends object, U extends object>(
+  obj1: T,
+  obj2: U | undefined,
+): T & { [P in keyof U]+?: Exclude<U[P], undefined> } {
+  return { ...obj1, ...compact(obj2 ?? {}) };
+}

package/src/committable/committable.ts

@@ -24,7 +24,7 @@ export class Committable<T> {
    * Rolls back the uncommitted value.
    */
   public rollback() {
-    this.nextValue === undefined;
+    this.nextValue = undefined;
   }
 
   /**