workspace with decoupled nostr package

2023-02-11 21:05:46 +01:00
parent 52e0809622
commit 2a211b78a1
260 changed files with 2363 additions and 714 deletions
--- a/packages/nostr/src/Subscriptions.ts
+++ b/packages/nostr/src/Subscriptions.ts
@ -0,0 +1,176 @@
+import { v4 as uuid } from "uuid";
+import { TaggedRawEvent, RawReqFilter, u256 } from "./index";
+import Connection from "./Connection";
+import EventKind from "./EventKind";
+
+export type NEventHandler = (e: TaggedRawEvent) => void;
+export type OnEndHandler = (c: Connection) => void;
+
+export class Subscriptions {
+  /**
+   * A unique id for this subscription filter
+   */
+  Id: u256;
+
+  /**
+   * a list of event ids or prefixes
+   */
+  Ids?: Set<u256>;
+
+  /**
+   * a list of pubkeys or prefixes, the pubkey of an event must be one of these
+   */
+  Authors?: Set<u256>;
+
+  /**
+   * a list of a kind numbers
+   */
+  Kinds?: Set<EventKind>;
+
+  /**
+   * a list of event ids that are referenced in an "e" tag
+   */
+  ETags?: Set<u256>;
+
+  /**
+   * a list of pubkeys that are referenced in a "p" tag
+   */
+  PTags?: Set<u256>;
+
+  /**
+   * A list of "t" tags to search
+   */
+  HashTags?: Set<string>;
+
+  /**
+   * A litst of "d" tags to search
+   */
+  DTags?: Set<string>;
+
+  /**
+   * A litst of "r" tags to search
+   */
+  RTags?: Set<string>;
+
+  /**
+   * A list of search terms
+   */
+  Search?: string;
+
+  /**
+   * a timestamp, events must be newer than this to pass
+   */
+  Since?: number;
+
+  /**
+   * a timestamp, events must be older than this to pass
+   */
+  Until?: number;
+
+  /**
+   * maximum number of events to be returned in the initial query
+   */
+  Limit?: number;
+
+  /**
+   * Handler function for this event
+   */
+  OnEvent: NEventHandler;
+
+  /**
+   * End of data event
+   */
+  OnEnd: OnEndHandler;
+
+  /**
+   * Collection of OR sub scriptions linked to this
+   */
+  OrSubs: Array<Subscriptions>;
+
+  /**
+   * Start time for this subscription
+   */
+  Started: Map<string, number>;
+
+  /**
+   * End time for this subscription
+   */
+  Finished: Map<string, number>;
+
+  constructor(sub?: RawReqFilter) {
+    this.Id = uuid();
+    this.Ids = sub?.ids ? new Set(sub.ids) : undefined;
+    this.Authors = sub?.authors ? new Set(sub.authors) : undefined;
+    this.Kinds = sub?.kinds ? new Set(sub.kinds) : undefined;
+    this.ETags = sub?.["#e"] ? new Set(sub["#e"]) : undefined;
+    this.PTags = sub?.["#p"] ? new Set(sub["#p"]) : undefined;
+    this.DTags = sub?.["#d"] ? new Set(["#d"]) : undefined;
+    this.RTags = sub?.["#r"] ? new Set(["#r"]) : undefined;
+    this.Search = sub?.search ?? undefined;
+    this.Since = sub?.since ?? undefined;
+    this.Until = sub?.until ?? undefined;
+    this.Limit = sub?.limit ?? undefined;
+    this.OnEvent = () => {
+      console.warn(`No event handler was set on subscription: ${this.Id}`);
+    };
+    this.OnEnd = () => undefined;
+    this.OrSubs = [];
+    this.Started = new Map<string, number>();
+    this.Finished = new Map<string, number>();
+  }
+
+  /**
+   * Adds OR filter subscriptions
+   */
+  AddSubscription(sub: Subscriptions) {
+    this.OrSubs.push(sub);
+  }
+
+  /**
+   * If all relays have responded with EOSE
+   */
+  IsFinished() {
+    return this.Started.size === this.Finished.size;
+  }
+
+  ToObject(): RawReqFilter {
+    const ret: RawReqFilter = {};
+    if (this.Ids) {
+      ret.ids = Array.from(this.Ids);
+    }
+    if (this.Authors) {
+      ret.authors = Array.from(this.Authors);
+    }
+    if (this.Kinds) {
+      ret.kinds = Array.from(this.Kinds);
+    }
+    if (this.ETags) {
+      ret["#e"] = Array.from(this.ETags);
+    }
+    if (this.PTags) {
+      ret["#p"] = Array.from(this.PTags);
+    }
+    if (this.HashTags) {
+      ret["#t"] = Array.from(this.HashTags);
+    }
+    if (this.DTags) {
+      ret["#d"] = Array.from(this.DTags);
+    }
+    if (this.RTags) {
+      ret["#r"] = Array.from(this.RTags);
+    }
+    if (this.Search) {
+      ret.search = this.Search;
+    }
+    if (this.Since !== null) {
+      ret.since = this.Since;
+    }
+    if (this.Until !== null) {
+      ret.until = this.Until;
+    }
+    if (this.Limit !== null) {
+      ret.limit = this.Limit;
+    }
+    return ret;
+  }
+}