applesauce-relay 4.0.0 → 4.2.0

package/dist/pool.js

@@ -1,13 +1,9 @@
-import { normalizeURL } from "applesauce-core/helpers";
-import { BehaviorSubject, Subject } from "rxjs";
+import { createFilterMap, isFilterEqual, normalizeURL } from "applesauce-core/helpers";
+import { BehaviorSubject, distinctUntilChanged, isObservable, map, of, Subject } from "rxjs";
 import { RelayGroup } from "./group.js";
 import { Relay } from "./relay.js";
 export class RelayPool {
     options;
-    groups$ = new BehaviorSubject(new Map());
-    get groups() {
-        return this.groups$.value;
-    }
     relays$ = new BehaviorSubject(new Map());
     get relays() {
         return this.relays$.value;
@@ -16,34 +12,13 @@ export class RelayPool {
     add$ = new Subject();
     /** A signal when a relay is removed */
     remove$ = new Subject();
-    /** An array of relays to never connect to */
-    blacklist = new Set();
     constructor(options) {
         this.options = options;
-        // Listen for relays being added and removed to emit connect / disconnect signals
-        // const listeners = new Map<IRelay, Subscription>();
-        // this.add$.subscribe((relay) =>
-        //   listeners.set(
-        //     relay,
-        //     relay.connected$.subscribe((conn) => (conn ? this.connect$.next(relay) : this.disconnect$.next(relay))),
-        //   ),
-        // );
-        // this.remove$.subscribe((relay) => {
-        //   const listener = listeners.get(relay);
-        //   if (listener) listener.unsubscribe();
-        //   listeners.delete(relay);
-        // });
-    }
-    filterBlacklist(urls) {
-        return urls.filter((url) => !this.blacklist.has(url));
     }
     /** Get or create a new relay connection */
     relay(url) {
         // Normalize the url
         url = normalizeURL(url);
-        // Check if the url is blacklisted
-        if (this.blacklist.has(url))
-            throw new Error("Relay is on blacklist");
         // Check if the relay already exists
         let relay = this.relays.get(url);
         if (relay)
@@ -57,17 +32,9 @@ export class RelayPool {
     }
     /** Create a group of relays */
     group(relays) {
-        // Normalize all urls
-        relays = relays.map((url) => normalizeURL(url));
-        // Filter out any blacklisted relays
-        relays = this.filterBlacklist(relays);
-        const key = relays.sort().join(",");
-        let group = this.groups.get(key);
-        if (group)
-            return group;
-        group = new RelayGroup(relays.map((url) => this.relay(url)));
-        this.groups$.next(this.groups.set(key, group));
-        return group;
+        return new RelayGroup(Array.isArray(relays)
+            ? relays.map((url) => this.relay(url))
+            : relays.pipe(map((urls) => urls.map((url) => this.relay(url)))));
     }
     /** Removes a relay from the pool and defaults to closing the connection */
     remove(relay, close = true) {
@@ -112,6 +79,34 @@ export class RelayPool {
     subscription(relays, filters, options) {
         return this.group(relays).subscription(filters, options);
     }
+    /** Open a subscription for a map of relays and filters */
+    subscriptionMap(relays, options) {
+        // Convert input to observable
+        const relays$ = isObservable(relays) ? relays : of(relays);
+        return this.group(
+        // Create a group with an observable of dynamic relay urls
+        relays$.pipe(map((dir) => Object.keys(dir)))).subscription((relay) => {
+            // Return observable to subscribe to the relays unique filters
+            return relays$.pipe(
+            // Select the relays filters
+            map((dir) => dir[relay.url]), 
+            // Don't send duplicate filters
+            distinctUntilChanged(isFilterEqual));
+        }, options);
+    }
+    /** Open a subscription for an {@link OutboxMap} and filter */
+    outboxSubscription(outboxes, filter, options) {
+        const filterMap = isObservable(outboxes)
+            ? outboxes.pipe(
+            // Project outbox map to filter map
+            map((outboxes) => createFilterMap(outboxes, filter)))
+            : createFilterMap(outboxes, filter);
+        return this.subscriptionMap(filterMap, options);
+    }
+    /** Count events on multiple relays */
+    count(relays, filters, id) {
+        return this.group(relays).count(filters, id);
+    }
     /** Negentropy sync events with the relays and an event store */
     sync(relays, store, filter, direction) {
         return this.group(relays).sync(store, filter, direction);

package/dist/relay.d.ts

@@ -4,7 +4,7 @@ import { RelayInformation } from "nostr-tools/nip11";
 import { BehaviorSubject, MonoTypeOperatorFunction, Observable, RepeatConfig, RetryConfig, Subject } from "rxjs";
 import { WebSocketSubject, WebSocketSubjectConfig } from "rxjs/webSocket";
 import { type NegentropySyncOptions, type ReconcileFunction } from "./negentropy.js";
-import { AuthSigner, FilterInput, IRelay, PublishOptions, PublishResponse, RequestOptions, SubscriptionOptions, SubscriptionResponse } from "./types.js";
+import { AuthSigner, CountResponse, FilterInput, IRelay, PublishOptions, PublishResponse, RequestOptions, SubscriptionOptions, SubscriptionResponse } from "./types.js";
 /** Flags for the negentropy sync type */
 export declare enum SyncDirection {
     RECEIVE = 1,
@@ -104,6 +104,8 @@ export declare class Relay implements IRelay {
     send(message: any): void;
     /** Create a REQ observable that emits events or "EOSE" or errors */
     req(filters: FilterInput, id?: string): Observable<SubscriptionResponse>;
+    /** Create a COUNT observable that emits a single count response */
+    count(filters: Filter | Filter[], id?: string): Observable<CountResponse>;
     /** Send an EVENT or AUTH message and return an observable of PublishResponse that completes or errors */
     event(event: NostrEvent, verb?: "EVENT" | "AUTH"): Observable<PublishResponse>;
     /** send and AUTH message */
@@ -118,10 +120,12 @@ export declare class Relay implements IRelay {
     protected customRepeatOperator<T extends unknown = unknown>(times: undefined | boolean | number | RepeatConfig | undefined): MonoTypeOperatorFunction<T>;
     /** Internal operator for creating the timeout() operator */
     protected customTimeoutOperator<T extends unknown = unknown>(timeout: undefined | boolean | number, defaultTimeout: number): MonoTypeOperatorFunction<T>;
+    /** Internal operator for handling auth-required errors from REQ/COUNT operations */
+    protected handleAuthRequiredForReq(operation: "REQ" | "COUNT"): MonoTypeOperatorFunction<any>;
     /** Creates a REQ that retries when relay errors ( default 3 retries ) */
-    subscription(filters: Filter | Filter[], opts?: SubscriptionOptions): Observable<SubscriptionResponse>;
+    subscription(filters: FilterInput, opts?: SubscriptionOptions): Observable<SubscriptionResponse>;
     /** Makes a single request that retires on errors and completes on EOSE */
-    request(filters: Filter | Filter[], opts?: RequestOptions): Observable<NostrEvent>;
+    request(filters: FilterInput, opts?: RequestOptions): Observable<NostrEvent>;
     /** Publishes an event to the relay and retries when relay errors or responds with auth-required ( default 3 retries ) */
     publish(event: NostrEvent, opts?: PublishOptions): Promise<PublishResponse>;
     /** Negentropy sync events with the relay and an event store */

package/dist/relay.js

@@ -7,6 +7,7 @@ import { BehaviorSubject, catchError, combineLatest, defer, endWith, filter, fin
 import { webSocket } from "rxjs/webSocket";
 import { completeOnEose } from "./operators/complete-on-eose.js";
 import { markFromRelay } from "./operators/mark-from-relay.js";
+const AUTH_REQUIRED_PREFIX = "auth-required:";
 const DEFAULT_RETRY_CONFIG = { count: 10, delay: 1000, resetOnSuccess: true };
 /** Flags for the negentropy sync type */
 export var SyncDirection;
@@ -264,7 +265,15 @@ export class Relay {
     /** Create a REQ observable that emits events or "EOSE" or errors */
     req(filters, id = nanoid()) {
         // Convert filters input into an observable, if its a normal value merge it with NEVER so it never completes
-        const input = isObservable(filters) ? filters : merge(of(filters), NEVER);
+        let input;
+        // Create input from filters input
+        if (typeof filters === "function") {
+            const result = filters(this);
+            input = (isObservable(result) ? result : merge(of(result), NEVER)).pipe(map((f) => (Array.isArray(f) ? f : [f])));
+        }
+        else {
+            input = (isObservable(filters) ? filters : merge(of(filters), NEVER)).pipe(map((f) => (Array.isArray(f) ? f : [f])));
+        }
         // Create an observable that completes when the upstream observable completes
         const filtersComplete = input.pipe(ignoreElements(), endWith(null));
         // Create an observable that filters responses from the relay to just the ones for this REQ
@@ -274,7 +283,7 @@ export class Relay {
         // Create an observable that controls sending the filters and closing the REQ
         const control = input.pipe(
         // Send the filters when they change
-        tap((filters) => this.socket.next(Array.isArray(filters) ? ["REQ", id, ...filters] : ["REQ", id, filters])), 
+        tap((filters) => this.socket.next(["REQ", id, ...filters])), 
         // Send the CLOSE message when unsubscribed or input completes
         finalize(() => this.socket.next(["CLOSE", id])), 
         // Once filters have been sent, switch to listening for messages
@@ -294,21 +303,11 @@ export class Relay {
                 throw new ReqCloseError(message[2]);
             else
                 return message[2];
-        }), catchError((error) => {
-            // Set REQ auth required if the REQ is closed with auth-required
-            if (error instanceof ReqCloseError &&
-                error.message.startsWith("auth-required") &&
-                !this.receivedAuthRequiredForReq.value) {
-                this.log("Auth required for REQ");
-                this.receivedAuthRequiredForReq.next(true);
-            }
-            // Pass the error through
-            return throwError(() => error);
-        }), 
+        }), this.handleAuthRequiredForReq("REQ"), 
         // mark events as from relays
         markFromRelay(this.url), 
         // if no events are seen in 10s, emit EOSE
-        // TODO: this should emit EOSE event if events are seen, the timeout should be for only the EOSE message
+        // TODO: this timeout should only emit EOSE after the last event is seen and no EOSE has been sent in (timeout ms)
         timeout({
             first: this.eoseTimeout,
             with: () => merge(of("EOSE"), NEVER),
@@ -318,6 +317,38 @@ export class Relay {
         // Wait for auth if required and make sure to start the watch tower
         return this.waitForReady(this.waitForAuth(this.authRequiredForRead$, observable));
     }
+    /** Create a COUNT observable that emits a single count response */
+    count(filters, id = nanoid()) {
+        // Create an observable that filters responses from the relay to just the ones for this COUNT
+        const messages = this.socket.pipe(filter((m) => Array.isArray(m) && (m[0] === "COUNT" || m[0] === "CLOSED") && m[1] === id), 
+        // Singleton (prevents duplicate subscriptions)
+        share());
+        // Send the COUNT message and listen for response
+        const observable = defer(() => {
+            // Send the COUNT message when subscription starts
+            this.socket.next(Array.isArray(filters) ? ["COUNT", id, ...filters] : ["COUNT", id, filters]);
+            // Merge with watch tower to keep connection alive
+            return merge(this.watchTower, messages);
+        }).pipe(
+        // Map the messages to count responses or throw an error
+        map((message) => {
+            if (message[0] === "COUNT")
+                return message[2];
+            else
+                throw new ReqCloseError(message[2]);
+        }), this.handleAuthRequiredForReq("COUNT"), 
+        // Complete on first value (COUNT responses are single-shot)
+        take(1), 
+        // Add timeout
+        timeout({
+            first: this.eoseTimeout,
+            with: () => throwError(() => new Error("COUNT timeout")),
+        }), 
+        // Only create one upstream subscription
+        share());
+        // Start the watch tower and wait for auth if required
+        return this.waitForReady(this.waitForAuth(this.authRequiredForRead$, observable));
+    }
     /** Send an EVENT or AUTH message and return an observable of PublishResponse that completes or errors */
     event(event, verb = "EVENT") {
         const messages = defer(() => {
@@ -338,7 +369,7 @@ export class Relay {
         take(1), 
         // listen for OK auth-required
         tap(({ ok, message }) => {
-            if (ok === false && message?.startsWith("auth-required") && !this.receivedAuthRequiredForEvent.value) {
+            if (ok === false && message?.startsWith(AUTH_REQUIRED_PREFIX) && !this.receivedAuthRequiredForEvent.value) {
                 this.log("Auth required for publish");
                 this.receivedAuthRequiredForEvent.next(true);
             }
@@ -414,6 +445,20 @@ export class Relay {
         else
             return simpleTimeout(timeout ?? defaultTimeout);
     }
+    /** Internal operator for handling auth-required errors from REQ/COUNT operations */
+    handleAuthRequiredForReq(operation) {
+        return catchError((error) => {
+            // Set auth required if the operation is closed with auth-required
+            if (error instanceof ReqCloseError &&
+                error.message.startsWith(AUTH_REQUIRED_PREFIX) &&
+                !this.receivedAuthRequiredForReq.value) {
+                this.log(`Auth required for ${operation}`);
+                this.receivedAuthRequiredForReq.next(true);
+            }
+            // Pass the error through
+            return throwError(() => error);
+        });
+    }
     /** Creates a REQ that retries when relay errors ( default 3 retries ) */
     subscription(filters, opts) {
         return this.req(filters, opts?.id).pipe(
@@ -440,7 +485,7 @@ export class Relay {
     publish(event, opts) {
         return lastValueFrom(this.event(event).pipe(mergeMap((result) => {
             // If the relay responds with auth-required, throw an error for the retry operator to handle
-            if (result.ok === false && result.message?.startsWith("auth-required:"))
+            if (result.ok === false && result.message?.startsWith(AUTH_REQUIRED_PREFIX))
                 return throwError(() => new Error(result.message));
             return of(result);
         }), 
@@ -461,6 +506,14 @@ export class Relay {
         };
         return new Observable((observer) => {
             const controller = new AbortController();
+            let cleanupCalled = false;
+            // Store reference to cleanup the negentropy properly
+            const cleanup = () => {
+                if (!cleanupCalled) {
+                    cleanupCalled = true;
+                    controller.abort();
+                }
+            };
             this.negentropy(store, filter, async (have, need) => {
                 // NOTE: it may be more efficient to sync all the events later in a single batch
                 // Send missing events to the relay
@@ -475,11 +528,17 @@ export class Relay {
                 }
             }, { signal: controller.signal })
                 // Complete the observable when the sync is complete
-                .then(() => observer.complete())
+                .then(() => {
+                if (!cleanupCalled)
+                    observer.complete();
+            })
                 // Error the observable when the sync fails
-                .catch((err) => observer.error(err));
+                .catch((err) => {
+                if (!cleanupCalled)
+                    observer.error(err);
+            });
             // Cancel the sync when the observable is unsubscribed
-            return () => controller.abort();
+            return cleanup;
         }).pipe(
         // Only create one upstream subscription
         share());

package/dist/types.d.ts

@@ -12,6 +12,9 @@ export type PublishResponse = {
     message?: string;
     from: string;
 };
+export type CountResponse = {
+    count: number;
+};
 export type MultiplexWebSocket<T = any> = Pick<WebSocketSubject<T>, "multiplex">;
 /** Options for the publish method on the pool and relay */
 export type PublishOptions = {
@@ -55,8 +58,8 @@ export type SubscriptionOptions = {
 export type AuthSigner = {
     signEvent: (event: EventTemplate) => NostrEvent | Promise<NostrEvent>;
 };
-/** The type of input the REQ method accepts */
-export type FilterInput = Filter | Filter[] | Observable<Filter | Filter[]>;
+/** Filters that can be passed to request methods on the pool or relay */
+export type FilterInput = Filter | Filter[] | Observable<Filter | Filter[]> | ((relay: IRelay) => Filter | Filter[] | Observable<Filter | Filter[]>);
 export interface IRelay extends MultiplexWebSocket {
     url: string;
     message$: Observable<any>;
@@ -65,6 +68,9 @@ export interface IRelay extends MultiplexWebSocket {
     challenge$: Observable<string | null>;
     authenticated$: Observable<boolean>;
     notices$: Observable<string[]>;
+    open$: Observable<Event>;
+    close$: Observable<CloseEvent>;
+    closing$: Observable<void>;
     error$: Observable<Error | null>;
     readonly connected: boolean;
     readonly authenticated: boolean;
@@ -74,6 +80,8 @@ export interface IRelay extends MultiplexWebSocket {
     close(): void;
     /** Send a REQ message */
     req(filters: FilterInput, id?: string): Observable<SubscriptionResponse>;
+    /** Send a COUNT message */
+    count(filters: Filter | Filter[], id?: string): Observable<CountResponse>;
     /** Send an EVENT message */
     event(event: NostrEvent): Observable<PublishResponse>;
     /** Send an AUTH message */
@@ -97,19 +105,28 @@ export interface IRelay extends MultiplexWebSocket {
     /** Get the supported NIPs for the relay */
     getSupported(): Promise<number[] | null>;
 }
+export type IGroupRelayInput = IRelay[] | Observable<IRelay[]>;
 export interface IGroup {
     /** Send a REQ message */
-    req(filters: FilterInput, id?: string): Observable<SubscriptionResponse>;
+    req(filters: Parameters<IRelay["req"]>[0], id?: string): Observable<SubscriptionResponse>;
     /** Send an EVENT message */
-    event(event: NostrEvent): Observable<PublishResponse>;
+    event(event: Parameters<IRelay["event"]>[0]): Observable<PublishResponse>;
     /** Negentropy sync event ids with the relays and an event store */
     negentropy(store: IEventStoreRead | IAsyncEventStoreRead | NostrEvent[], filter: Filter, reconcile: ReconcileFunction, opts?: NegentropySyncOptions): Promise<boolean>;
+    /** Add a relay to the group */
+    add(relay: IRelay): void;
+    /** Remove a relay from the group */
+    remove(relay: IRelay): void;
+    /** Check if a relay is in the group */
+    has(relay: IRelay | string): boolean;
     /** Send an EVENT message with retries */
-    publish(event: NostrEvent, opts?: PublishOptions): Promise<PublishResponse[]>;
+    publish(event: Parameters<IRelay["event"]>[0], opts?: PublishOptions): Promise<PublishResponse[]>;
     /** Send a REQ message with retries */
-    request(filters: FilterInput, opts?: GroupRequestOptions): Observable<NostrEvent>;
+    request(filters: Parameters<IRelay["request"]>[0], opts?: GroupRequestOptions): Observable<NostrEvent>;
     /** Open a subscription with retries */
-    subscription(filters: FilterInput, opts?: GroupSubscriptionOptions): Observable<SubscriptionResponse>;
+    subscription(filters: Parameters<IRelay["subscription"]>[0], opts?: GroupSubscriptionOptions): Observable<SubscriptionResponse>;
+    /** Count events on the relays and an event store */
+    count(filters: Filter | Filter[], id?: string): Observable<Record<string, CountResponse>>;
     /** Negentropy sync events with the relay and an event store */
     sync(store: IEventStoreRead | IAsyncEventStoreRead | NostrEvent[], filter: Filter, direction?: SyncDirection): Observable<NostrEvent>;
 }
@@ -118,25 +135,28 @@ export interface IPoolSignals {
     add$: Observable<IRelay>;
     remove$: Observable<IRelay>;
 }
+export type IPoolRelayInput = string[] | Observable<string[]>;
 export interface IPool extends IPoolSignals {
     /** Get or create a relay */
     relay(url: string): IRelay;
     /** Create a relay group */
-    group(relays: string[]): IGroup;
+    group(relays: IPoolRelayInput): IGroup;
     /** Removes a relay from the pool and defaults to closing the connection */
     remove(relay: string | IRelay, close?: boolean): void;
     /** Send a REQ message */
-    req(relays: string[], filters: FilterInput, id?: string): Observable<SubscriptionResponse>;
+    req(relays: IPoolRelayInput, filters: FilterInput, id?: string): Observable<SubscriptionResponse>;
     /** Send an EVENT message */
-    event(relays: string[], event: NostrEvent): Observable<PublishResponse>;
+    event(relays: IPoolRelayInput, event: NostrEvent): Observable<PublishResponse>;
     /** Negentropy sync event ids with the relays and an event store */
-    negentropy(relays: string[], store: IEventStoreRead | IAsyncEventStoreRead | NostrEvent[], filter: Filter, reconcile: ReconcileFunction, opts?: GroupNegentropySyncOptions): Promise<boolean>;
+    negentropy(relays: IPoolRelayInput, store: IEventStoreRead | IAsyncEventStoreRead | NostrEvent[], filter: Filter, reconcile: ReconcileFunction, opts?: GroupNegentropySyncOptions): Promise<boolean>;
     /** Send an EVENT message to relays with retries */
-    publish(relays: string[], event: Parameters<IGroup["publish"]>[0], opts?: Parameters<IGroup["publish"]>[1]): Promise<PublishResponse[]>;
+    publish(relays: IPoolRelayInput, event: Parameters<IGroup["publish"]>[0], opts?: Parameters<IGroup["publish"]>[1]): Promise<PublishResponse[]>;
     /** Send a REQ message to relays with retries */
-    request(relays: string[], filters: Parameters<IGroup["request"]>[0], opts?: Parameters<IGroup["request"]>[1]): Observable<NostrEvent>;
+    request(relays: IPoolRelayInput, filters: Parameters<IGroup["request"]>[0], opts?: Parameters<IGroup["request"]>[1]): Observable<NostrEvent>;
     /** Open a subscription to relays with retries */
-    subscription(relays: string[], filters: Parameters<IGroup["subscription"]>[0], opts?: Parameters<IGroup["subscription"]>[1]): Observable<SubscriptionResponse>;
+    subscription(relays: IPoolRelayInput, filters: Parameters<IGroup["subscription"]>[0], opts?: Parameters<IGroup["subscription"]>[1]): Observable<SubscriptionResponse>;
+    /** Count events on the relays and an event store */
+    count(relays: IPoolRelayInput, filters: Filter | Filter[], id?: string): Observable<Record<string, CountResponse>>;
     /** Negentropy sync events with the relay and an event store */
-    sync(relays: string[], store: IEventStoreRead | IAsyncEventStoreRead | NostrEvent[], filter: Filter, direction?: SyncDirection): Observable<NostrEvent>;
+    sync(relays: IPoolRelayInput, store: IEventStoreRead | IAsyncEventStoreRead | NostrEvent[], filter: Filter, direction?: SyncDirection): Observable<NostrEvent>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-relay",
-  "version": "4.0.0",
+  "version": "4.2.0",
   "description": "nostr relay communication framework built on rxjs",
   "type": "module",
   "main": "dist/index.js",
@@ -52,14 +52,14 @@
   },
   "dependencies": {
     "@noble/hashes": "^1.7.1",
-    "applesauce-core": "^4.0.0",
+    "applesauce-core": "^4.2.0",
     "nanoid": "^5.0.9",
     "nostr-tools": "~2.17",
     "rxjs": "^7.8.1"
   },
   "devDependencies": {
     "@hirez_io/observer-spy": "^2.2.0",
-    "applesauce-signers": "^4.0.0",
+    "applesauce-signers": "^4.2.0",
     "rimraf": "^6.0.1",
     "typescript": "^5.7.3",
     "vitest": "^3.2.4",