applesauce-core 0.0.0-next-20250123214405 → 0.0.0-next-20250123215242

package/dist/event-store/common.d.ts

@@ -0,0 +1 @@
+export declare const INDEXABLE_TAGS: Set<string>;

package/dist/event-store/common.js

@@ -0,0 +1,2 @@
+const LETTERS = "abcdefghijklmnopqrstuvwxyz";
+export const INDEXABLE_TAGS = new Set((LETTERS + LETTERS.toUpperCase()).split(""));

package/dist/event-store/database.d.ts

@@ -0,0 +1,64 @@
+import { Filter, NostrEvent } from "nostr-tools";
+import { Subject } from "rxjs";
+import { LRU } from "../helpers/lru.js";
+/**
+ * An in-memory database for nostr events
+ * NOTE: does not handle replaceable events
+ */
+export declare class Database {
+    protected log: import("debug").Debugger;
+    /** Indexes */
+    protected kinds: Map<number, Set<import("nostr-tools").Event>>;
+    protected authors: Map<string, Set<import("nostr-tools").Event>>;
+    protected tags: LRU<Set<import("nostr-tools").Event>>;
+    protected created_at: NostrEvent[];
+    /** LRU cache of last events touched */
+    events: LRU<import("nostr-tools").Event>;
+    protected replaceable: Map<string, import("nostr-tools").Event[]>;
+    /** A stream of events inserted into the database */
+    inserted: Subject<import("nostr-tools").Event>;
+    /** A stream of events that have been updated */
+    updated: Subject<import("nostr-tools").Event>;
+    /** A stream of events removed of the database */
+    deleted: Subject<import("nostr-tools").Event>;
+    get size(): number;
+    protected claims: WeakMap<import("nostr-tools").Event, any>;
+    /** Index helper methods */
+    protected getKindIndex(kind: number): Set<import("nostr-tools").Event>;
+    protected getAuthorsIndex(author: string): Set<import("nostr-tools").Event>;
+    protected getTagIndex(tagAndValue: string): Set<import("nostr-tools").Event>;
+    /** Moves an event to the top of the LRU cache */
+    touch(event: NostrEvent): void;
+    /** Checks if the database contains an event without touching it */
+    hasEvent(id: string): boolean;
+    /** Gets a single event based on id */
+    getEvent(id: string): NostrEvent | undefined;
+    /** Checks if the database contains a replaceable event without touching it */
+    hasReplaceable(kind: number, pubkey: string, d?: string): boolean;
+    /** Gets an array of replaceable events */
+    getReplaceable(kind: number, pubkey: string, d?: string): NostrEvent[] | undefined;
+    /** Inserts an event into the database and notifies all subscriptions */
+    addEvent(event: NostrEvent): NostrEvent;
+    /** Inserts and event into the database and notifies all subscriptions that the event has updated */
+    updateEvent(event: NostrEvent): NostrEvent;
+    /** Deletes an event from the database and notifies all subscriptions */
+    deleteEvent(eventOrId: string | NostrEvent): boolean;
+    /** Sets the claim on the event and touches it */
+    claimEvent(event: NostrEvent, claim: any): void;
+    /** Checks if an event is claimed by anything */
+    isClaimed(event: NostrEvent): boolean;
+    /** Removes a claim from an event */
+    removeClaim(event: NostrEvent, claim: any): void;
+    /** Removes all claims on an event */
+    clearClaim(event: NostrEvent): void;
+    iterateAuthors(authors: Iterable<string>): Generator<NostrEvent>;
+    iterateTag(tag: string, values: Iterable<string>): Generator<NostrEvent>;
+    iterateKinds(kinds: Iterable<number>): Generator<NostrEvent>;
+    iterateTime(since: number | undefined, until: number | undefined): Generator<NostrEvent>;
+    iterateIds(ids: Iterable<string>): Generator<NostrEvent>;
+    /** Returns all events that match the filter */
+    getEventsForFilter(filter: Filter): Set<NostrEvent>;
+    getForFilters(filters: Filter[]): Set<NostrEvent>;
+    /** Remove the oldest events that are not claimed */
+    prune(limit?: number): number;
+}

package/dist/event-store/database.js

@@ -0,0 +1,311 @@
+import { binarySearch, insertEventIntoDescendingList } from "nostr-tools/utils";
+import { Subject } from "rxjs";
+import { FromCacheSymbol, getEventUID, getIndexableTags, getReplaceableUID, isReplaceable } from "../helpers/event.js";
+import { INDEXABLE_TAGS } from "./common.js";
+import { logger } from "../logger.js";
+import { LRU } from "../helpers/lru.js";
+/**
+ * An in-memory database for nostr events
+ * NOTE: does not handle replaceable events
+ */
+export class Database {
+    log = logger.extend("Database");
+    /** Indexes */
+    kinds = new Map();
+    authors = new Map();
+    tags = new LRU();
+    created_at = [];
+    /** LRU cache of last events touched */
+    events = new LRU();
+    replaceable = new Map();
+    /** A stream of events inserted into the database */
+    inserted = new Subject();
+    /** A stream of events that have been updated */
+    updated = new Subject();
+    /** A stream of events removed of the database */
+    deleted = new Subject();
+    get size() {
+        return this.events.size;
+    }
+    claims = new WeakMap();
+    /** Index helper methods */
+    getKindIndex(kind) {
+        if (!this.kinds.has(kind))
+            this.kinds.set(kind, new Set());
+        return this.kinds.get(kind);
+    }
+    getAuthorsIndex(author) {
+        if (!this.authors.has(author))
+            this.authors.set(author, new Set());
+        return this.authors.get(author);
+    }
+    getTagIndex(tagAndValue) {
+        if (!this.tags.has(tagAndValue)) {
+            // build new tag index from existing events
+            const events = new Set();
+            const ts = Date.now();
+            for (const event of this.events.values()) {
+                if (getIndexableTags(event).has(tagAndValue)) {
+                    events.add(event);
+                }
+            }
+            const took = Date.now() - ts;
+            if (took > 100)
+                this.log(`Built index ${tagAndValue} took ${took}ms`);
+            this.tags.set(tagAndValue, events);
+        }
+        return this.tags.get(tagAndValue);
+    }
+    /** Moves an event to the top of the LRU cache */
+    touch(event) {
+        this.events.set(event.id, event);
+    }
+    /** Checks if the database contains an event without touching it */
+    hasEvent(id) {
+        return this.events.has(id);
+    }
+    /** Gets a single event based on id */
+    getEvent(id) {
+        return this.events.get(id);
+    }
+    /** Checks if the database contains a replaceable event without touching it */
+    hasReplaceable(kind, pubkey, d) {
+        const events = this.replaceable.get(getReplaceableUID(kind, pubkey, d));
+        return !!events && events.length > 0;
+    }
+    /** Gets an array of replaceable events */
+    getReplaceable(kind, pubkey, d) {
+        return this.replaceable.get(getReplaceableUID(kind, pubkey, d));
+    }
+    /** Inserts an event into the database and notifies all subscriptions */
+    addEvent(event) {
+        const id = event.id;
+        const current = this.events.get(id);
+        if (current) {
+            // if this is a duplicate event, transfer some import symbols
+            if (event[FromCacheSymbol])
+                current[FromCacheSymbol] = event[FromCacheSymbol];
+            return current;
+        }
+        this.events.set(id, event);
+        this.getKindIndex(event.kind).add(event);
+        this.getAuthorsIndex(event.pubkey).add(event);
+        for (const tag of getIndexableTags(event)) {
+            if (this.tags.has(tag)) {
+                this.getTagIndex(tag).add(event);
+            }
+        }
+        // insert into time index
+        insertEventIntoDescendingList(this.created_at, event);
+        // insert into replaceable index
+        if (isReplaceable(event.kind)) {
+            const uid = getEventUID(event);
+            let array = this.replaceable.get(uid);
+            if (!this.replaceable.has(uid)) {
+                array = [];
+                this.replaceable.set(uid, array);
+            }
+            insertEventIntoDescendingList(array, event);
+        }
+        this.inserted.next(event);
+        return event;
+    }
+    /** Inserts and event into the database and notifies all subscriptions that the event has updated */
+    updateEvent(event) {
+        const inserted = this.addEvent(event);
+        this.updated.next(inserted);
+        return inserted;
+    }
+    /** Deletes an event from the database and notifies all subscriptions */
+    deleteEvent(eventOrId) {
+        let event = typeof eventOrId === "string" ? this.events.get(eventOrId) : eventOrId;
+        if (!event)
+            throw new Error("Missing event");
+        const id = event.id;
+        // only remove events that are known
+        if (!this.events.has(id))
+            return false;
+        this.getAuthorsIndex(event.pubkey).delete(event);
+        this.getKindIndex(event.kind).delete(event);
+        for (const tag of getIndexableTags(event)) {
+            if (this.tags.has(tag)) {
+                this.getTagIndex(tag).delete(event);
+            }
+        }
+        // remove from created_at index
+        const i = this.created_at.indexOf(event);
+        this.created_at.splice(i, 1);
+        this.events.delete(id);
+        // remove from replaceable index
+        if (isReplaceable(event.kind)) {
+            const uid = getEventUID(event);
+            const array = this.replaceable.get(uid);
+            if (array && array.includes(event)) {
+                const idx = array.indexOf(event);
+                array.splice(idx, 1);
+            }
+        }
+        this.deleted.next(event);
+        return true;
+    }
+    /** Sets the claim on the event and touches it */
+    claimEvent(event, claim) {
+        if (!this.claims.has(event)) {
+            this.claims.set(event, claim);
+        }
+        // always touch event
+        this.touch(event);
+    }
+    /** Checks if an event is claimed by anything */
+    isClaimed(event) {
+        return this.claims.has(event);
+    }
+    /** Removes a claim from an event */
+    removeClaim(event, claim) {
+        const current = this.claims.get(event);
+        if (current === claim)
+            this.claims.delete(event);
+    }
+    /** Removes all claims on an event */
+    clearClaim(event) {
+        this.claims.delete(event);
+    }
+    *iterateAuthors(authors) {
+        for (const author of authors) {
+            const events = this.authors.get(author);
+            if (events) {
+                for (const event of events)
+                    yield event;
+            }
+        }
+    }
+    *iterateTag(tag, values) {
+        for (const value of values) {
+            const events = this.getTagIndex(tag + ":" + value);
+            if (events) {
+                for (const event of events)
+                    yield event;
+            }
+        }
+    }
+    *iterateKinds(kinds) {
+        for (const kind of kinds) {
+            const events = this.kinds.get(kind);
+            if (events) {
+                for (const event of events)
+                    yield event;
+            }
+        }
+    }
+    *iterateTime(since, until) {
+        let untilIndex = 0;
+        let sinceIndex = this.created_at.length - 1;
+        let start = until
+            ? binarySearch(this.created_at, (mid) => {
+                return mid.created_at - until;
+            })
+            : undefined;
+        if (start)
+            untilIndex = start[0];
+        const end = since
+            ? binarySearch(this.created_at, (mid) => {
+                return mid.created_at - since;
+            })
+            : undefined;
+        if (end)
+            sinceIndex = end[0];
+        for (let i = untilIndex; i < sinceIndex; i++) {
+            yield this.created_at[i];
+        }
+    }
+    *iterateIds(ids) {
+        for (const id of ids) {
+            if (this.events.has(id))
+                yield this.events.get(id);
+        }
+    }
+    /** Returns all events that match the filter */
+    getEventsForFilter(filter) {
+        // search is not supported, return an empty set
+        if (filter.search)
+            return new Set();
+        let first = true;
+        let events = new Set();
+        const and = (iterable) => {
+            const set = iterable instanceof Set ? iterable : new Set(iterable);
+            if (first) {
+                events = set;
+                first = false;
+            }
+            else {
+                for (const event of events) {
+                    if (!set.has(event))
+                        events.delete(event);
+                }
+            }
+            return events;
+        };
+        if (filter.ids)
+            and(this.iterateIds(filter.ids));
+        let time = null;
+        // query for time first if since is set
+        if (filter.since !== undefined) {
+            time = Array.from(this.iterateTime(filter.since, filter.until));
+            and(time);
+        }
+        for (const t of INDEXABLE_TAGS) {
+            const key = `#${t}`;
+            const values = filter[key];
+            if (values?.length)
+                and(this.iterateTag(t, values));
+        }
+        if (filter.authors)
+            and(this.iterateAuthors(filter.authors));
+        if (filter.kinds)
+            and(this.iterateKinds(filter.kinds));
+        // query for time last if only until is set
+        if (filter.since === undefined && filter.until !== undefined) {
+            time = Array.from(this.iterateTime(filter.since, filter.until));
+            and(time);
+        }
+        // if the filter queried on time and has a limit. truncate the events now
+        if (filter.limit && time) {
+            const limited = new Set();
+            for (const event of time) {
+                if (limited.size >= filter.limit)
+                    break;
+                if (events.has(event))
+                    limited.add(event);
+            }
+            return limited;
+        }
+        return events;
+    }
+    getForFilters(filters) {
+        if (filters.length === 0)
+            throw new Error("No Filters");
+        let events = new Set();
+        for (const filter of filters) {
+            const filtered = this.getEventsForFilter(filter);
+            for (const event of filtered)
+                events.add(event);
+        }
+        return events;
+    }
+    /** Remove the oldest events that are not claimed */
+    prune(limit = 1000) {
+        let removed = 0;
+        let cursor = this.events.first;
+        while (cursor) {
+            const event = cursor.value;
+            if (!this.isClaimed(event)) {
+                this.deleteEvent(event);
+                removed++;
+                if (removed >= limit)
+                    break;
+            }
+            cursor = cursor.next;
+        }
+        return removed;
+    }
+}

package/dist/event-store/event-store.d.ts

@@ -0,0 +1,49 @@
+import { Filter, NostrEvent } from "nostr-tools";
+import { Observable } from "rxjs";
+import { Database } from "./database.js";
+export declare class EventStore {
+    database: Database;
+    /** Enable this to keep old versions of replaceable events */
+    keepOldVersions: boolean;
+    constructor();
+    /** Adds an event to the database and update subscriptions */
+    add(event: NostrEvent, fromRelay?: string): NostrEvent;
+    /** Removes an event from the database and updates subscriptions */
+    remove(event: string | NostrEvent): boolean;
+    protected deletedIds: Set<string>;
+    protected deletedCoords: Map<string, number>;
+    protected handleDeleteEvent(deleteEvent: NostrEvent): void;
+    protected checkDeleted(event: NostrEvent): boolean;
+    /** Removes any event that is not being used by a subscription */
+    prune(max?: number): number;
+    /** Add an event to the store and notifies all subscribes it has updated */
+    update(event: NostrEvent): NostrEvent;
+    getAll(filters: Filter[]): Set<NostrEvent>;
+    hasEvent(uid: string): boolean;
+    getEvent(uid: string): NostrEvent | undefined;
+    hasReplaceable(kind: number, pubkey: string, d?: string): boolean;
+    /** Gets the latest version of a replaceable event */
+    getReplaceable(kind: number, pubkey: string, d?: string): NostrEvent | undefined;
+    /** Returns all versions of a replaceable event */
+    getReplaceableHistory(kind: number, pubkey: string, d?: string): NostrEvent[] | undefined;
+    /** Creates an observable that updates a single event */
+    event(id: string): Observable<NostrEvent | undefined>;
+    /** Creates an observable that subscribes to multiple events */
+    events(ids: string[]): Observable<Record<string, NostrEvent>>;
+    /** Creates an observable with the latest version of a replaceable event */
+    replaceable(kind: number, pubkey: string, d?: string): Observable<NostrEvent | undefined>;
+    /** Creates an observable with the latest versions of replaceable events */
+    replaceableSet(pointers: {
+        kind: number;
+        pubkey: string;
+        identifier?: string;
+    }[]): Observable<Record<string, NostrEvent>>;
+    /**
+     * Creates an observable that streams all events that match the filter
+     * @param filters
+     * @param [onlyNew=false] Only subscribe to new events
+     */
+    stream(filters: Filter | Filter[], onlyNew?: boolean): Observable<NostrEvent>;
+    /** Creates an observable that updates with an array of sorted events */
+    timeline(filters: Filter | Filter[], keepOldVersions?: boolean): Observable<NostrEvent[]>;
+}