applesauce-relay 0.0.0-next-20250930093922 → 0.0.0-next-20251015123951

package/dist/group.d.ts

@@ -28,7 +28,10 @@ export declare class RelayGroup implements IGroup {
      * Make a request to all relays
      * @note This does not deduplicate events
      */
-    req(filters: FilterInput, id?: string): Observable<SubscriptionResponse>;
+    req(filters: FilterInput, id?: string, opts?: {
+        /** Deduplicate events with an event store (default is a temporary instance of EventMemory), null will disable deduplication */
+        eventStore?: IEventStoreActions | IAsyncEventStoreActions | null;
+    }): Observable<SubscriptionResponse>;
     /** Send an event to all relays */
     event(event: NostrEvent): Observable<PublishResponse>;
     /** Negentropy sync events with the relays and an event store */

package/dist/group.js

@@ -28,12 +28,12 @@ export class RelayGroup {
      * Make a request to all relays
      * @note This does not deduplicate events
      */
-    req(filters, id = nanoid(8)) {
+    req(filters, id = nanoid(8), opts) {
         const requests = this.relays.map((relay) => relay.req(filters, id).pipe(
         // Ignore connection errors
         catchError(() => of("EOSE"))));
         // Merge events and the single EOSE stream
-        return this.mergeEOSE(requests);
+        return this.mergeEOSE(requests, opts?.eventStore);
     }
     /** Send an event to all relays */
     event(event) {

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./group.js";
+export * from "./liveness.js";
 export * from "./pool.js";
 export * from "./relay.js";
 export * from "./types.js";

package/dist/index.js

@@ -1,4 +1,5 @@
 export * from "./group.js";
+export * from "./liveness.js";
 export * from "./pool.js";
 export * from "./relay.js";
 export * from "./types.js";

package/dist/liveness.d.ts

@@ -0,0 +1,125 @@
+import { Observable } from "rxjs";
+import { IPool } from "./types.js";
+/** Relay health states for liveness tracking */
+export type RelayHealthState = "online" | "offline" | "dead";
+/**
+ * State information for a relay's health tracking
+ */
+export interface RelayState {
+    /** Current relay health state */
+    state: RelayHealthState;
+    /** Number of consecutive failures */
+    failureCount: number;
+    /** Timestamp of last failure */
+    lastFailureTime: number;
+    /** Timestamp of last success */
+    lastSuccessTime: number;
+    /** When the backoff period ends (timestamp) */
+    backoffUntil?: number;
+}
+/** Storage adapter interface for persisting relay liveness state */
+export interface LivenessStorage {
+    /**
+     * Get an item from storage
+     * @param key The storage key
+     * @returns The stored value or null if not found
+     */
+    getItem(key: string): Promise<any> | any;
+    /**
+     * Set an item in storage
+     * @param key The storage key
+     * @param value The value to store
+     */
+    setItem(key: string, value: any): Promise<void> | void;
+}
+/** Configuration options for RelayLiveness */
+export interface LivenessOptions {
+    /** Optional async storage adapter for persistence */
+    storage?: LivenessStorage;
+    /** Maximum failures before moving from offline to dead */
+    maxFailuresBeforeDead?: number;
+    /** Base delay for exponential backoff (ms) */
+    backoffBaseDelay?: number;
+    /** Maximum backoff delay (ms) */
+    backoffMaxDelay?: number;
+}
+/** Record and manage liveness reports for relays */
+export declare class RelayLiveness {
+    private log;
+    private readonly options;
+    private readonly states$;
+    /** Relays that have been seen this session. this should be used when checking dead relays for liveness */
+    readonly seen: Set<string>;
+    /** Storage adapter for persistence */
+    readonly storage?: LivenessStorage;
+    /** An observable of all relays that are online */
+    online$: Observable<string[]>;
+    /** An observable of all relays that are offline */
+    offline$: Observable<string[]>;
+    /** An observable of all relays that are dead */
+    dead$: Observable<string[]>;
+    /** An observable of all relays that are online or not in backoff */
+    healthy$: Observable<string[]>;
+    /** An observable of all relays that are dead or in backoff */
+    unhealthy$: Observable<string[]>;
+    /** Relays that are known to be online */
+    get online(): string[];
+    /** Relays that are known to be offline */
+    get offline(): string[];
+    /** Relays that are known to be dead */
+    get dead(): string[];
+    /** Relays that are online or not in backoff */
+    get healthy(): string[];
+    /** Relays that are dead or in backoff */
+    get unhealthy(): string[];
+    /**
+     * Create a new RelayLiveness instance
+     * @param options Configuration options for the liveness tracker
+     */
+    constructor(options?: LivenessOptions);
+    /** Load relay states from storage */
+    load(): Promise<void>;
+    /** Save all known relays and their states to storage */
+    save(): Promise<void>;
+    /** Filter relay list, removing dead relays and relays in backoff */
+    filter(relays: string[]): string[];
+    /** Subscribe to a relays state */
+    state(relay: string): Observable<RelayState | undefined>;
+    /** Revive a dead relay with the max backoff delay */
+    revive(relay: string): void;
+    /** Get current relay health state for a relay */
+    getState(relay: string): RelayState | undefined;
+    /** Check if a relay is currently in backoff period */
+    isInBackoff(relay: string): boolean;
+    /** Get remaining backoff time for a relay (in ms) */
+    getBackoffRemaining(relay: string): number;
+    /** Calculate backoff delay based on failure count */
+    private calculateBackoffDelay;
+    /**
+     * Record a successful connection
+     * @param relay The relay URL that succeeded
+     */
+    recordSuccess(relay: string): void;
+    /**
+     * Record a failed connection
+     * @param relay The relay URL that failed
+     */
+    recordFailure(relay: string): void;
+    /**
+     * Get all seen relays (for debugging/monitoring)
+     */
+    getSeenRelays(): string[];
+    /**
+     * Reset state for one or all relays
+     * @param relay Optional specific relay URL to reset, or reset all if not provided
+     */
+    reset(relay?: string): void;
+    private connections;
+    /** Connect to a {@link RelayPool} instance and track relay connections */
+    connectToPool(pool: IPool): void;
+    /** Disconnect from a {@link RelayPool} instance */
+    disconnectFromPool(pool: IPool): void;
+    private updateRelayState;
+    private saveKnownRelays;
+    private saveRelayState;
+}

package/dist/liveness.js

@@ -0,0 +1,327 @@
+import { logger } from "applesauce-core";
+import { BehaviorSubject, map } from "rxjs";
+/** Record and manage liveness reports for relays */
+export class RelayLiveness {
+    log = logger.extend("RelayLiveness");
+    options;
+    states$ = new BehaviorSubject({});
+    /** Relays that have been seen this session. this should be used when checking dead relays for liveness */
+    seen = new Set();
+    /** Storage adapter for persistence */
+    storage;
+    /** An observable of all relays that are online */
+    online$;
+    /** An observable of all relays that are offline */
+    offline$;
+    /** An observable of all relays that are dead */
+    dead$;
+    /** An observable of all relays that are online or not in backoff */
+    healthy$;
+    /** An observable of all relays that are dead or in backoff */
+    unhealthy$;
+    /** Relays that are known to be online */
+    get online() {
+        return Object.keys(this.states$.value).filter((relay) => this.states$.value[relay].state === "online");
+    }
+    /** Relays that are known to be offline */
+    get offline() {
+        return Object.keys(this.states$.value).filter((relay) => this.states$.value[relay].state === "offline");
+    }
+    /** Relays that are known to be dead */
+    get dead() {
+        return Object.keys(this.states$.value).filter((relay) => this.states$.value[relay].state === "dead");
+    }
+    /** Relays that are online or not in backoff */
+    get healthy() {
+        return Object.keys(this.states$.value).filter((relay) => {
+            const state = this.states$.value[relay];
+            return state.state === "online" || (state.state === "offline" && !this.isInBackoff(relay));
+        });
+    }
+    /** Relays that are dead or in backoff */
+    get unhealthy() {
+        return Object.keys(this.states$.value).filter((relay) => {
+            const state = this.states$.value[relay];
+            return state.state === "dead" || (state.state === "offline" && this.isInBackoff(relay));
+        });
+    }
+    /**
+     * Create a new RelayLiveness instance
+     * @param options Configuration options for the liveness tracker
+     */
+    constructor(options = {}) {
+        this.options = {
+            maxFailuresBeforeDead: options.maxFailuresBeforeDead ?? 5,
+            backoffBaseDelay: options.backoffBaseDelay ?? 30 * 1000, // 30 seconds
+            backoffMaxDelay: options.backoffMaxDelay ?? 5 * 60 * 1000, // 5 minutes
+        };
+        this.storage = options.storage;
+        // Create observable interfaces
+        this.online$ = this.states$.pipe(map((states) => Object.keys(states).filter((relay) => states[relay].state === "online")));
+        this.offline$ = this.states$.pipe(map((states) => Object.keys(states).filter((relay) => states[relay].state === "offline")));
+        this.dead$ = this.states$.pipe(map((states) => Object.keys(states).filter((relay) => states[relay].state === "dead")));
+        this.healthy$ = this.states$.pipe(map((states) => Object.keys(states).filter((relay) => {
+            const state = states[relay];
+            return state.state === "online" || (state.state === "offline" && !this.isInBackoff(relay));
+        })));
+        this.unhealthy$ = this.states$.pipe(map((states) => Object.keys(states).filter((relay) => {
+            const state = states[relay];
+            return state.state === "dead" || (state.state === "offline" && this.isInBackoff(relay));
+        })));
+    }
+    /** Load relay states from storage */
+    async load() {
+        if (!this.storage)
+            return;
+        const known = await this.storage.getItem("known");
+        if (!Array.isArray(known))
+            return;
+        this.log(`Loading states for ${known.length} known relays`);
+        const states = {};
+        for (const relay of known) {
+            try {
+                const state = await this.storage.getItem(relay);
+                if (state)
+                    states[relay] = state;
+            }
+            catch (error) {
+                // Ignore relay loading errors
+            }
+        }
+        this.states$.next(states);
+    }
+    /** Save all known relays and their states to storage */
+    async save() {
+        await this.saveKnownRelays();
+        await Promise.all(Object.entries(this.states$.value).map(([relay, state]) => this.saveRelayState(relay, state)));
+        this.log("Relay states saved to storage");
+    }
+    /** Filter relay list, removing dead relays and relays in backoff */
+    filter(relays) {
+        const results = [];
+        for (const relay of relays) {
+            // Track that this relay has been seen
+            this.seen.add(relay);
+            const state = this.getState(relay);
+            // Filter based on state and backoff
+            switch (state?.state) {
+                case undefined: // unknown state
+                case "online":
+                    results.push(relay);
+                    break;
+                case "offline":
+                    // Only include if not in backoff
+                    if (!this.isInBackoff(relay))
+                        results.push(relay);
+                    break;
+                case "dead":
+                default:
+                    // Don't include dead relays
+                    break;
+            }
+        }
+        return results;
+    }
+    /** Subscribe to a relays state */
+    state(relay) {
+        return this.states$.pipe(map((states) => states[relay]));
+    }
+    /** Revive a dead relay with the max backoff delay */
+    revive(relay) {
+        const state = this.getState(relay);
+        if (!state)
+            return;
+        this.updateRelayState(relay, {
+            state: "offline",
+            failureCount: 0,
+            lastFailureTime: 0,
+            lastSuccessTime: Date.now(),
+            backoffUntil: this.options.backoffMaxDelay,
+        });
+        this.log(`Relay ${relay} revived to offline state with max backoff delay`);
+    }
+    /** Get current relay health state for a relay */
+    getState(relay) {
+        return this.states$.value[relay];
+    }
+    /** Check if a relay is currently in backoff period */
+    isInBackoff(relay) {
+        const state = this.getState(relay);
+        if (!state?.backoffUntil)
+            return false;
+        return Date.now() < state.backoffUntil;
+    }
+    /** Get remaining backoff time for a relay (in ms) */
+    getBackoffRemaining(relay) {
+        const state = this.getState(relay);
+        if (!state?.backoffUntil)
+            return 0;
+        return Math.max(0, state.backoffUntil - Date.now());
+    }
+    /** Calculate backoff delay based on failure count */
+    calculateBackoffDelay(failureCount) {
+        const delay = this.options.backoffBaseDelay * Math.pow(2, failureCount - 1);
+        return Math.min(delay, this.options.backoffMaxDelay);
+    }
+    /**
+     * Record a successful connection
+     * @param relay The relay URL that succeeded
+     */
+    recordSuccess(relay) {
+        const now = Date.now();
+        const state = this.getState(relay);
+        // Don't update dead relays
+        if (state?.state === "dead") {
+            this.log(`Ignoring success for dead relay ${relay}`);
+            return;
+        }
+        // Record new relays
+        if (state === undefined) {
+            this.seen.add(relay);
+            this.saveKnownRelays();
+        }
+        // TODO: resetting the state back to online might be too aggressive?
+        const newState = {
+            state: "online",
+            failureCount: 0,
+            lastFailureTime: 0,
+            lastSuccessTime: now,
+        };
+        this.updateRelayState(relay, newState);
+        // Log transition if it's not the first time we've seen the relay
+        if (state && state.state !== newState.state)
+            this.log(`Relay ${relay} transitioned ${state?.state} -> online`);
+    }
+    /**
+     * Record a failed connection
+     * @param relay The relay URL that failed
+     */
+    recordFailure(relay) {
+        const state = this.getState(relay);
+        // Don't update dead relays
+        if (state?.state === "dead")
+            return;
+        // Ignore failures during backoff, this should help catch double reporting of failures
+        if (this.isInBackoff(relay))
+            return;
+        const now = Date.now();
+        const failureCount = (state?.failureCount || 0) + 1;
+        // Record new relays
+        if (state === undefined) {
+            this.seen.add(relay);
+            this.saveKnownRelays();
+        }
+        // Calculate backoff delay
+        const backoffDelay = this.calculateBackoffDelay(failureCount);
+        const newState = failureCount >= this.options.maxFailuresBeforeDead ? "dead" : "offline";
+        const relayState = {
+            state: newState,
+            failureCount,
+            lastFailureTime: now,
+            lastSuccessTime: state?.lastSuccessTime || 0,
+            backoffUntil: now + backoffDelay,
+        };
+        this.updateRelayState(relay, relayState);
+        // Log transition if it's not the first time we've seen the relay
+        if (newState !== state?.state)
+            this.log(`Relay ${relay} transitioned ${state?.state} -> ${newState}`);
+        // Set a timeout that will clear the backoff period
+        setTimeout(() => {
+            const state = this.getState(relay);
+            if (!state || state.backoffUntil === undefined)
+                return;
+            this.updateRelayState(relay, { ...state, backoffUntil: undefined });
+        }, backoffDelay);
+    }
+    /**
+     * Get all seen relays (for debugging/monitoring)
+     */
+    getSeenRelays() {
+        return Array.from(this.seen);
+    }
+    /**
+     * Reset state for one or all relays
+     * @param relay Optional specific relay URL to reset, or reset all if not provided
+     */
+    reset(relay) {
+        if (relay) {
+            const newStates = { ...this.states$.value };
+            delete newStates[relay];
+            this.states$.next(newStates);
+            this.seen.delete(relay);
+        }
+        else {
+            // Reset all relays
+            this.states$.next({});
+            this.seen.clear();
+        }
+    }
+    // The connected pools and cleanup methods
+    connections = new Map();
+    /** Connect to a {@link RelayPool} instance and track relay connections */
+    connectToPool(pool) {
+        // Relay cleanup methods
+        const relays = new Map();
+        // Listen for relays being added
+        const add = pool.add$.subscribe((relay) => {
+            // Record seen relays
+            this.seen.add(relay.url);
+            const open = relay.open$.subscribe(() => {
+                this.recordSuccess(relay.url);
+            });
+            const close = relay.close$.subscribe((event) => {
+                if (event.wasClean === false)
+                    this.recordFailure(relay.url);
+            });
+            // Register the cleanup method
+            relays.set(relay, () => {
+                open.unsubscribe();
+                close.unsubscribe();
+            });
+        });
+        // Listen for relays being removed
+        const remove = pool.remove$.subscribe((relay) => {
+            const cleanup = relays.get(relay);
+            if (cleanup)
+                cleanup();
+            relays.delete(relay);
+        });
+        // register the cleanup method
+        this.connections.set(pool, () => {
+            add.unsubscribe();
+            remove.unsubscribe();
+        });
+    }
+    /** Disconnect from a {@link RelayPool} instance */
+    disconnectFromPool(pool) {
+        const cleanup = this.connections.get(pool);
+        if (cleanup)
+            cleanup();
+        this.connections.delete(pool);
+    }
+    updateRelayState(relay, state) {
+        this.states$.next({ ...this.states$.value, [relay]: state });
+        // Auto-save to storage
+        this.saveRelayState(relay, state);
+    }
+    async saveKnownRelays() {
+        if (!this.storage)
+            return;
+        try {
+            await this.storage.setItem("known", Object.keys(this.states$.value));
+        }
+        catch (error) {
+            // Ignore storage errors
+        }
+    }
+    async saveRelayState(relay, state) {
+        if (!this.storage)
+            return;
+        try {
+            await this.storage.setItem(relay, state);
+        }
+        catch (error) {
+            // Ignore storage errors
+        }
+    }
+}

package/dist/operators/index.d.ts

@@ -3,3 +3,4 @@ export * from "./mark-from-relay.js";
 export * from "./only-events.js";
 export * from "./store-events.js";
 export * from "./to-event-store.js";
+export * from "./liveness.js";

package/dist/operators/index.js

@@ -3,3 +3,4 @@ export * from "./mark-from-relay.js";
 export * from "./only-events.js";
 export * from "./store-events.js";
 export * from "./to-event-store.js";
+export * from "./liveness.js";

package/dist/operators/liveness.d.ts

@@ -0,0 +1,17 @@
+import { MonoTypeOperatorFunction, Observable } from "rxjs";
+type ILivenessTracker = {
+    unhealthy$: Observable<string[]>;
+    seen?: Set<string>;
+};
+/** Filters out unhealthy relays from an array of pointers */
+export declare function ignoreUnhealthyRelaysOnPointers<T extends {
+    relays?: string[];
+}, Tracker extends ILivenessTracker>(liveness: Tracker): MonoTypeOperatorFunction<T[]>;
+/** Filters out unhealthy relays from the inboxes and outboxes */
+export declare function ignoreUnhealthyMailboxes<T extends {
+    inboxes?: string[];
+    outboxes?: string[];
+}, Tracker extends ILivenessTracker>(liveness: Tracker): MonoTypeOperatorFunction<T>;
+/** Filters out unhealthy relays from an array of relays */
+export declare function ignoreUnhealthyRelays<Tracker extends ILivenessTracker>(liveness: Tracker): MonoTypeOperatorFunction<string[]>;
+export {};

package/dist/operators/liveness.js

@@ -0,0 +1,47 @@
+import { combineLatestWith, map } from "rxjs";
+function filterRelays(relays, unhealthy, liveness) {
+    return (relays &&
+        relays.filter((relay) => {
+            // Notify the liveness tracker that we've seen this relay
+            liveness.seen?.add(relay);
+            // Exclude unhealthy relays
+            return !unhealthy.includes(relay);
+        }));
+}
+/** Filters out unhealthy relays from an array of pointers */
+export function ignoreUnhealthyRelaysOnPointers(liveness) {
+    return (source) => source.pipe(
+    // Combine with the liveness observable
+    combineLatestWith(liveness.unhealthy$), 
+    // Filters out unhealthy relays from the pointers
+    map(([pointers, unhealthy]) => pointers.map((pointer) => {
+        if (!pointer.relays)
+            return pointer;
+        // Exclude unhealthy relays
+        return { ...pointer, relays: filterRelays(pointer.relays, unhealthy, liveness) };
+    })));
+}
+/** Filters out unhealthy relays from the inboxes and outboxes */
+export function ignoreUnhealthyMailboxes(liveness) {
+    return (source) => source.pipe(
+    // Combine with the liveness observable
+    combineLatestWith(liveness.unhealthy$), 
+    // Filters out unhealthy relays from the inboxes and outboxes
+    map(([mailboxes, unhealthy]) => {
+        if (!mailboxes.inboxes && !mailboxes.outboxes)
+            return mailboxes;
+        return {
+            ...mailboxes,
+            inboxes: filterRelays(mailboxes.inboxes, unhealthy, liveness),
+            outboxes: filterRelays(mailboxes.outboxes, unhealthy, liveness),
+        };
+    }));
+}
+/** Filters out unhealthy relays from an array of relays */
+export function ignoreUnhealthyRelays(liveness) {
+    return (source) => source.pipe(
+    // Combine with the liveness observable
+    combineLatestWith(liveness.unhealthy$), 
+    // Filters out unhealthy relays from the array
+    map(([relays, unhealthy]) => filterRelays(relays, unhealthy, liveness)));
+}

package/dist/types.d.ts

@@ -65,6 +65,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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-relay",
-  "version": "0.0.0-next-20250930093922",
+  "version": "0.0.0-next-20251015123951",
   "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": "0.0.0-next-20250930093922",
+    "applesauce-core": "0.0.0-next-20251015123951",
     "nanoid": "^5.0.9",
     "nostr-tools": "~2.17",
     "rxjs": "^7.8.1"
   },
   "devDependencies": {
     "@hirez_io/observer-spy": "^2.2.0",
-    "applesauce-signers": "0.0.0-next-20250930093922",
+    "applesauce-signers": "0.0.0-next-20251015123951",
     "rimraf": "^6.0.1",
     "typescript": "^5.7.3",
     "vitest": "^3.2.4",