applesauce-relay 1.0.1 → 1.1.0

package/dist/__tests__/relay.test.js

@@ -356,9 +356,59 @@ describe("notices$", () => {
         expect(relay.notices$.value).toEqual(["Important notice"]);
     });
 });
+describe("notice$", () => {
+    it("should not trigger connection to relay", async () => {
+        subscribeSpyTo(relay.notice$);
+        await new Promise((resolve) => setTimeout(resolve, 10));
+        expect(relay.connected).toBe(false);
+    });
+    it("should emit NOTICE messages when they are received", async () => {
+        const spy = subscribeSpyTo(relay.notice$);
+        // Start connection
+        subscribeSpyTo(relay.req({ kinds: [1] }));
+        // Send multiple NOTICE messages
+        server.send(["NOTICE", "Notice 1"]);
+        server.send(["NOTICE", "Notice 2"]);
+        server.send(["NOTICE", "Notice 3"]);
+        // Verify the notices state contains all messages
+        expect(spy.getValues()).toEqual(["Notice 1", "Notice 2", "Notice 3"]);
+    });
+    it("should ignore non-NOTICE messages", async () => {
+        const spy = subscribeSpyTo(relay.notice$);
+        // Start connection
+        subscribeSpyTo(relay.req({ kinds: [1] }));
+        server.send(["NOTICE", "Important notice"]);
+        server.send(["OTHER", "other message"]);
+        // Verify only NOTICE messages are in the state
+        expect(spy.getValues()).toEqual(["Important notice"]);
+    });
+});
+describe("message$", () => {
+    it("should not trigger connection to relay", async () => {
+        subscribeSpyTo(relay.message$);
+        await new Promise((resolve) => setTimeout(resolve, 10));
+        expect(relay.connected).toBe(false);
+    });
+    it("should emit all messages when they are received", async () => {
+        const spy = subscribeSpyTo(relay.message$);
+        // Start connection
+        subscribeSpyTo(relay.req({ kinds: [1] }));
+        // Send multiple NOTICE messages
+        server.send(["NOTICE", "Notice 1"]);
+        server.send(["EVENT", "sub1", mockEvent]);
+        server.send(["EOSE", "sub1"]);
+        // Verify the notices state contains all messages
+        expect(spy.getValues()).toEqual([
+            ["NOTICE", "Notice 1"],
+            ["EVENT", "sub1", mockEvent],
+            ["EOSE", "sub1"],
+        ]);
+    });
+});
 describe("challenge$", () => {
     it("should not trigger connection to relay", async () => {
         subscribeSpyTo(relay.challenge$);
+        await new Promise((resolve) => setTimeout(resolve, 10));
         expect(relay.connected).toBe(false);
     });
     it("should set challenge$ when AUTH message received", async () => {

package/dist/group.d.ts

@@ -11,7 +11,7 @@ export declare class RelayGroup implements IGroup {
     /** Send an event to all relays */
     event(event: NostrEvent): Observable<PublishResponse>;
     /** Publish an event to all relays with retries ( default 3 retries ) */
-    publish(event: NostrEvent, opts?: PublishOptions): Observable<PublishResponse[]>;
+    publish(event: NostrEvent, opts?: PublishOptions): Observable<PublishResponse>;
     /** Request events from all relays with retries ( default 3 retries ) */
     request(filters: Filter | Filter[], opts?: RequestOptions): Observable<NostrEvent>;
     /** Open a subscription to all relays with retries ( default 3 retries ) */

package/dist/group.js

@@ -1,5 +1,5 @@
 import { nanoid } from "nanoid";
-import { catchError, EMPTY, endWith, ignoreElements, merge, of, toArray } from "rxjs";
+import { catchError, EMPTY, endWith, ignoreElements, merge, of } from "rxjs";
 import { completeOnEose } from "./operators/complete-on-eose.js";
 import { onlyEvents } from "./operators/only-events.js";
 export class RelayGroup {
@@ -37,7 +37,7 @@ export class RelayGroup {
     publish(event, opts) {
         return merge(...this.relays.map((relay) => relay.publish(event, opts).pipe(
         // Catch error and return as PublishResponse
-        catchError((err) => of({ ok: false, from: relay.url, message: err?.message || "Unknown error" }))))).pipe(toArray());
+        catchError((err) => of({ ok: false, from: relay.url, message: err?.message || "Unknown error" })))));
     }
     /** Request events from all relays with retries ( default 3 retries ) */
     request(filters, opts) {

package/dist/pool.d.ts

@@ -1,13 +1,18 @@
 import { NostrEvent, type Filter } from "nostr-tools";
-import { Observable } from "rxjs";
+import { BehaviorSubject, Observable } from "rxjs";
 import { RelayGroup } from "./group.js";
 import { Relay, RelayOptions } from "./relay.js";
 import { IPool, PublishResponse, PublishOptions, RequestOptions, SubscriptionOptions, SubscriptionResponse } from "./types.js";
 export declare class RelayPool implements IPool {
     options?: RelayOptions | undefined;
-    relays: Map<string, Relay>;
-    groups: Map<string, RelayGroup>;
+    groups$: BehaviorSubject<Map<string, RelayGroup>>;
+    get groups(): Map<string, RelayGroup>;
+    relays$: BehaviorSubject<Map<string, Relay>>;
+    get relays(): Map<string, Relay>;
+    /** An array of relays to never connect to */
+    blacklist: Set<string>;
     constructor(options?: RelayOptions | undefined);
+    protected filterBlacklist(urls: string[]): string[];
     /** Get or create a new relay connection */
     relay(url: string): Relay;
     /** Create a group of relays */
@@ -17,7 +22,7 @@ export declare class RelayPool implements IPool {
     /** Send an EVENT message to multiple relays */
     event(relays: string[], event: NostrEvent): Observable<PublishResponse>;
     /** Publish an event to multiple relays */
-    publish(relays: string[], event: NostrEvent, opts?: PublishOptions): Observable<PublishResponse[]>;
+    publish(relays: string[], event: NostrEvent, opts?: PublishOptions): Observable<PublishResponse>;
     /** Request events from multiple relays */
     request(relays: string[], filters: Filter | Filter[], opts?: RequestOptions): Observable<NostrEvent>;
     /** Open a subscription to multiple relays */

package/dist/pool.js

@@ -1,31 +1,46 @@
+import { BehaviorSubject } from "rxjs";
 import { RelayGroup } from "./group.js";
 import { Relay } from "./relay.js";
 export class RelayPool {
     options;
-    relays = new Map();
-    groups = new Map();
+    groups$ = new BehaviorSubject(new Map());
+    get groups() {
+        return this.groups$.value;
+    }
+    relays$ = new BehaviorSubject(new Map());
+    get relays() {
+        return this.relays$.value;
+    }
+    /** An array of relays to never connect to */
+    blacklist = new Set();
     constructor(options) {
         this.options = options;
     }
+    filterBlacklist(urls) {
+        return urls.filter((url) => !this.blacklist.has(url));
+    }
     /** Get or create a new relay connection */
     relay(url) {
+        if (this.blacklist.has(url))
+            throw new Error("Relay is on blacklist");
         let relay = this.relays.get(url);
         if (relay)
             return relay;
         else {
             relay = new Relay(url, this.options);
-            this.relays.set(url, relay);
+            this.relays$.next(this.relays.set(url, relay));
             return relay;
         }
     }
     /** Create a group of relays */
     group(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.set(key, group);
+        this.groups$.next(this.groups.set(key, group));
         return group;
     }
     /** Make a REQ to multiple relays that does not deduplicate events */

package/dist/relay.d.ts

@@ -28,15 +28,23 @@ export declare class Relay implements IRelay {
     authenticated$: BehaviorSubject<boolean>;
     /** The notices from the relay */
     notices$: BehaviorSubject<string[]>;
+    /** The last connection error */
+    error$: BehaviorSubject<Error | null>;
+    /**
+     * A passive observable of all messages from the relay
+     * @note Subscribing to this will not connect to the relay
+     */
+    message$: Observable<any>;
+    /**
+     * A passive observable of NOTICE messages from the relay
+     * @note Subscribing to this will not connect to the relay
+     */
+    notice$: Observable<string>;
     /** An observable that emits the NIP-11 information document for the relay */
     information$: Observable<RelayInformation | null>;
     protected _nip11: RelayInformation | null;
     /** An observable that emits the limitations for the relay */
     limitations$: Observable<RelayInformation["limitation"] | null>;
-    /** An observable of all messages from the relay */
-    message$: Observable<any>;
-    /** An observable of NOTICE messages from the relay */
-    notice$: Observable<string>;
     get connected(): boolean;
     get challenge(): string | null;
     get notices(): string[];

package/dist/relay.js

@@ -2,7 +2,7 @@ import { logger } from "applesauce-core";
 import { simpleTimeout } from "applesauce-core/observable";
 import { nanoid } from "nanoid";
 import { nip42 } from "nostr-tools";
-import { BehaviorSubject, catchError, combineLatest, defer, filter, from, ignoreElements, map, merge, mergeMap, NEVER, of, retry, scan, share, shareReplay, switchMap, take, tap, throwError, timeout, timer, } from "rxjs";
+import { BehaviorSubject, catchError, combineLatest, defer, filter, from, ignoreElements, map, merge, mergeMap, NEVER, of, retry, scan, share, shareReplay, Subject, switchMap, take, tap, throwError, timeout, timer, } from "rxjs";
 import { webSocket } from "rxjs/webSocket";
 import { completeOnEose } from "./operators/complete-on-eose.js";
 import { markFromRelay } from "./operators/mark-from-relay.js";
@@ -27,15 +27,23 @@ export class Relay {
     authenticated$ = new BehaviorSubject(false);
     /** The notices from the relay */
     notices$ = new BehaviorSubject([]);
+    /** The last connection error */
+    error$ = new BehaviorSubject(null);
+    /**
+     * A passive observable of all messages from the relay
+     * @note Subscribing to this will not connect to the relay
+     */
+    message$;
+    /**
+     * A passive observable of NOTICE messages from the relay
+     * @note Subscribing to this will not connect to the relay
+     */
+    notice$;
     /** An observable that emits the NIP-11 information document for the relay */
     information$;
     _nip11 = null;
     /** An observable that emits the limitations for the relay */
     limitations$;
-    /** An observable of all messages from the relay */
-    message$;
-    /** An observable of NOTICE messages from the relay */
-    notice$;
     // sync state
     get connected() {
         return this.connected$.value;
@@ -91,6 +99,7 @@ export class Relay {
                     this.log("Connected");
                     this.connected$.next(true);
                     this.attempts$.next(0);
+                    this.error$.next(null);
                     this.resetState();
                 },
             },
@@ -107,7 +116,6 @@ export class Relay {
             },
             WebSocketCtor: opts?.WebSocket,
         });
-        this.message$ = this.socket.asObservable();
         // Create an observable to fetch the NIP-11 information document
         this.information$ = defer(() => {
             this.log("Fetching NIP-11 information document");
@@ -123,19 +131,18 @@ export class Relay {
         // Create observables that track if auth is required for REQ or EVENT
         this.authRequiredForReq = combineLatest([this.receivedAuthRequiredForReq, this.limitations$]).pipe(map(([received, limitations]) => received || limitations?.auth_required === true), tap((required) => required && this.log("Auth required for REQ")), shareReplay(1));
         this.authRequiredForEvent = combineLatest([this.receivedAuthRequiredForEvent, this.limitations$]).pipe(map(([received, limitations]) => received || limitations?.auth_required === true), tap((required) => required && this.log("Auth required for EVENT")), shareReplay(1));
-        this.notice$ = this.message$.pipe(
+        // Update the notices state
+        const listenForNotice = this.socket.pipe(
         // listen for NOTICE messages
-        filter((m) => m[0] === "NOTICE"), 
+        filter((m) => Array.isArray(m) && m[0] === "NOTICE"), 
         // pick the string out of the message
-        map((m) => m[1]));
-        // Update the notices state
-        const notice = this.notice$.pipe(
+        map((m) => m[1]), 
         // Track all notices
         scan((acc, notice) => [...acc, notice], []), 
         // Update the notices state
         tap((notices) => this.notices$.next(notices)));
         // Update the challenge state
-        const challenge = this.message$.pipe(
+        const ListenForChallenge = this.socket.pipe(
         // listen for AUTH messages
         filter((message) => message[0] === "AUTH"), 
         // pick the challenge string out
@@ -145,12 +152,21 @@ export class Relay {
             this.log("Received AUTH challenge", challenge);
             this.challenge$.next(challenge);
         }));
+        const allMessagesSubject = new Subject();
+        const listenForAllMessages = this.socket.pipe(tap((message) => allMessagesSubject.next(message)));
+        // Create passive observables for messages and notices
+        this.message$ = allMessagesSubject.asObservable();
+        this.notice$ = this.message$.pipe(
+        // listen for NOTICE messages
+        filter((m) => Array.isArray(m) && m[0] === "NOTICE"), 
+        // pick the string out of the message
+        map((m) => m[1]));
         // Merge all watchers
         this.watchTower = this.ready$.pipe(switchMap((ready) => {
             if (!ready)
                 return NEVER;
             // Only start the watch tower if the relay is ready
-            return merge(notice, challenge, this.information$).pipe(
+            return merge(listenForAllMessages, listenForNotice, ListenForChallenge, this.information$).pipe(
             // Never emit any values
             ignoreElements(), 
             // Start the reconnect timer if the connection has an error
@@ -168,6 +184,7 @@ export class Relay {
     startReconnectTimer(error) {
         if (!this.ready$.value)
             return;
+        this.error$.next(error instanceof Error ? error : new Error("Connection error"));
         this.ready$.next(false);
         this.reconnectTimer(error, this.attempts$.value)
             .pipe(take(1))

package/dist/types.d.ts

@@ -66,7 +66,7 @@ export interface IGroup extends Nip01Actions {
     /** Send an EVENT message with retries */
     publish(event: NostrEvent, opts?: {
         retries?: number;
-    }): Observable<PublishResponse[]>;
+    }): Observable<PublishResponse>;
     /** Send a REQ message with retries */
     request(filters: Filter | Filter[], opts?: {
         id?: string;
@@ -90,7 +90,7 @@ export interface IPool {
     /** Send an EVENT message to relays with retries */
     publish(relays: string[], event: NostrEvent, opts?: {
         retries?: number;
-    }): Observable<PublishResponse[]>;
+    }): Observable<PublishResponse>;
     /** Send a REQ message to relays with retries */
     request(relays: string[], filters: Filter | Filter[], opts?: {
         id?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-relay",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "nostr relay communication framework built on rxjs",
   "type": "module",
   "main": "dist/index.js",