applesauce-relay 0.0.0-next-20250923113611 → 0.0.0-next-20251015123951

package/dist/group.d.ts

@@ -1,27 +1,47 @@
-import { type NostrEvent } from "nostr-tools";
+import { Filter, type NostrEvent } from "nostr-tools";
 import { Observable } from "rxjs";
-import { IAsyncEventStoreActions, IEventStoreActions } from "applesauce-core";
+import { IAsyncEventStoreActions, IAsyncEventStoreRead, IEventStoreActions, IEventStoreRead } from "applesauce-core";
+import { NegentropySyncOptions, type ReconcileFunction } from "./negentropy.js";
 import { FilterInput, IGroup, IRelay, PublishOptions, PublishResponse, RequestOptions, SubscriptionOptions, SubscriptionResponse } from "./types.js";
+import { SyncDirection } from "./relay.js";
+/** Options for negentropy sync on a group of relays */
+export type GroupNegentropySyncOptions = NegentropySyncOptions & {
+    /** Whether to sync in parallel (default true) */
+    parallel?: boolean;
+};
+/** Options for a subscription on a group of relays */
+export type GroupSubscriptionOptions = SubscriptionOptions & {
+    /** Deduplicate events with an event store (default is a temporary instance of EventMemory), null will disable deduplication */
+    eventStore?: IEventStoreActions | IAsyncEventStoreActions | null;
+};
+/** Options for a request on a group of relays */
+export type GroupRequestOptions = RequestOptions & {
+    /** Deduplicate events with an event store (default is a temporary instance of EventMemory), null will disable deduplication */
+    eventStore?: IEventStoreActions | IAsyncEventStoreActions | null;
+};
 export declare class RelayGroup implements IGroup {
     relays: IRelay[];
     constructor(relays: IRelay[]);
     /** Takes an array of observables and only emits EOSE when all observables have emitted EOSE */
-    protected mergeEOSE(requests: Observable<SubscriptionResponse>[], eventStore?: IEventStoreActions | IAsyncEventStoreActions): Observable<import("nostr-tools").Event | "EOSE">;
+    protected mergeEOSE(requests: Observable<SubscriptionResponse>[], eventStore?: IEventStoreActions | IAsyncEventStoreActions | null): Observable<import("nostr-tools").Event | "EOSE">;
     /**
      * 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 */
+    negentropy(store: IEventStoreRead | IAsyncEventStoreRead | NostrEvent[], filter: Filter, reconcile: ReconcileFunction, opts?: GroupNegentropySyncOptions): Promise<boolean>;
     /** Publish an event to all relays with retries ( default 3 retries ) */
     publish(event: NostrEvent, opts?: PublishOptions): Promise<PublishResponse[]>;
     /** Request events from all relays with retries ( default 3 retries ) */
-    request(filters: FilterInput, opts?: RequestOptions & {
-        eventStore?: IEventStoreActions;
-    }): Observable<NostrEvent>;
+    request(filters: FilterInput, opts?: GroupRequestOptions): Observable<NostrEvent>;
     /** Open a subscription to all relays with retries ( default 3 retries ) */
-    subscription(filters: FilterInput, opts?: SubscriptionOptions & {
-        eventStore?: IEventStoreActions;
-    }): Observable<SubscriptionResponse>;
+    subscription(filters: FilterInput, opts?: GroupSubscriptionOptions): Observable<SubscriptionResponse>;
+    /** Negentropy sync events with the relays and an event store */
+    sync(store: IEventStoreRead | IAsyncEventStoreRead | NostrEvent[], filter: Filter, direction?: SyncDirection): Observable<NostrEvent>;
 }

package/dist/group.js

@@ -1,6 +1,6 @@
 import { nanoid } from "nanoid";
-import { catchError, EMPTY, endWith, identity, ignoreElements, merge, of } from "rxjs";
-import { filterDuplicateEvents } from "applesauce-core";
+import { catchError, defer, EMPTY, endWith, identity, ignoreElements, merge, of, share, switchMap, } from "rxjs";
+import { EventMemory, filterDuplicateEvents, } from "applesauce-core";
 import { completeOnEose } from "./operators/complete-on-eose.js";
 import { onlyEvents } from "./operators/only-events.js";
 export class RelayGroup {
@@ -9,7 +9,7 @@ export class RelayGroup {
         this.relays = relays;
     }
     /** Takes an array of observables and only emits EOSE when all observables have emitted EOSE */
-    mergeEOSE(requests, eventStore) {
+    mergeEOSE(requests, eventStore = new EventMemory()) {
         // Create stream of events only
         const events = merge(...requests).pipe(
         // Ignore non event responses
@@ -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) {
@@ -41,6 +41,20 @@ export class RelayGroup {
         // Catch error and return as PublishResponse
         catchError((err) => of({ ok: false, from: relay.url, message: err?.message || "Unknown error" })))));
     }
+    /** Negentropy sync events with the relays and an event store */
+    async negentropy(store, filter, reconcile, opts) {
+        // Filter out relays that do not support NIP-77 negentropy sync
+        const supported = await Promise.all(this.relays.map(async (relay) => [relay, await relay.getSupported()]));
+        const relays = supported.filter(([_, supported]) => supported?.includes(77)).map(([relay]) => relay);
+        if (relays.length === 0)
+            throw new Error("No relays support NIP-77 negentropy sync");
+        // Non parallel sync is not supported yet
+        if (!opts?.parallel)
+            throw new Error("Negentropy sync must be parallel (for now)");
+        // Sync all the relays in parallel
+        await Promise.allSettled(relays.map((relay) => relay.negentropy(store, filter, reconcile, opts)));
+        return true;
+    }
     /** Publish an event to all relays with retries ( default 3 retries ) */
     publish(event, opts) {
         return Promise.all(this.relays.map((relay) => relay.publish(event, opts).catch(
@@ -53,7 +67,7 @@ export class RelayGroup {
         // Ignore individual connection errors
         catchError(() => EMPTY)))).pipe(
         // If an event store is provided, filter duplicate events
-        opts?.eventStore ? filterDuplicateEvents(opts.eventStore) : identity);
+        opts?.eventStore == null ? identity : filterDuplicateEvents(opts?.eventStore ?? new EventMemory()));
     }
     /** Open a subscription to all relays with retries ( default 3 retries ) */
     subscription(filters, opts) {
@@ -63,4 +77,19 @@ export class RelayGroup {
         // Pass event store so that duplicate events are removed
         opts?.eventStore);
     }
+    /** Negentropy sync events with the relays and an event store */
+    sync(store, filter, direction) {
+        // Get an array of relays that support NIP-77 negentropy sync
+        return defer(async () => {
+            const supported = await Promise.all(this.relays.map(async (relay) => [relay, await relay.getSupported()]));
+            const relays = supported.filter(([_, supported]) => supported?.includes(77)).map(([relay]) => relay);
+            if (relays.length === 0)
+                throw new Error("No relays support NIP-77 negentropy sync");
+            return relays;
+        }).pipe(
+        // Once relays are selected, sync all the relays in parallel
+        switchMap((relays) => merge(...relays.map((relay) => relay.sync(store, filter, direction)))), 
+        // Only create one upstream subscription
+        share());
+    }
 }

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/negentropy.d.ts

@@ -1,15 +1,31 @@
-import { IEventStoreRead } from "applesauce-core";
+import { IAsyncEventStoreRead, IEventStoreRead } from "applesauce-core";
 import { Filter } from "nostr-tools";
 import { MultiplexWebSocket } from "./types.js";
 import { NegentropyStorageVector } from "./lib/negentropy.js";
-export declare function buildStorageFromFilter(store: IEventStoreRead, filter: Filter): NegentropyStorageVector;
+/**
+ * A function that reconciles the storage vectors with a remote relay
+ * @param have - The ids that the local storage has
+ * @param need - The ids that the remote relay has
+ * @returns A promise that resolves when the reconciliation is complete
+ */
+export type ReconcileFunction = (have: string[], need: string[]) => Promise<void>;
+/** Options for the negentropy sync */
+export type NegentropySyncOptions = {
+    frameSizeLimit?: number;
+    signal?: AbortSignal;
+};
+/** Creates a NegentropyStorageVector from an event store and filter */
+export declare function buildStorageFromFilter(store: IEventStoreRead | IAsyncEventStoreRead, filter: Filter): Promise<NegentropyStorageVector>;
+/** Creates a NegentropyStorageVector from an array of items */
 export declare function buildStorageVector(items: {
     id: string;
     created_at: number;
 }[]): NegentropyStorageVector;
+/**
+ * Sync the storage vectors with a remote relay
+ * @throws {Error} if the sync fails
+ * @returns true if the sync was successful, false if the sync was aborted
+ */
 export declare function negentropySync(storage: NegentropyStorageVector, socket: MultiplexWebSocket & {
     next: (msg: any) => void;
-}, filter: Filter, reconcile: (have: string[], need: string[]) => Promise<void>, opts?: {
-    frameSizeLimit?: number;
-    signal?: AbortSignal;
-}): Promise<boolean>;
+}, filter: Filter, reconcile: ReconcileFunction, opts?: NegentropySyncOptions): Promise<boolean>;

package/dist/negentropy.js

@@ -3,13 +3,15 @@ import { map, share, firstValueFrom } from "rxjs";
 import { nanoid } from "nanoid";
 import { Negentropy, NegentropyStorageVector } from "./lib/negentropy.js";
 const log = logger.extend("negentropy");
-export function buildStorageFromFilter(store, filter) {
+/** Creates a NegentropyStorageVector from an event store and filter */
+export async function buildStorageFromFilter(store, filter) {
     const storage = new NegentropyStorageVector();
-    for (const event of store.getByFilters(filter))
+    for (const event of await store.getByFilters(filter))
         storage.insert(event.created_at, event.id);
     storage.seal();
     return storage;
 }
+/** Creates a NegentropyStorageVector from an array of items */
 export function buildStorageVector(items) {
     const storage = new NegentropyStorageVector();
     for (const item of items)
@@ -17,6 +19,11 @@ export function buildStorageVector(items) {
     storage.seal();
     return storage;
 }
+/**
+ * Sync the storage vectors with a remote relay
+ * @throws {Error} if the sync fails
+ * @returns true if the sync was successful, false if the sync was aborted
+ */
 export async function negentropySync(storage, socket, filter, reconcile, opts) {
     let id = nanoid();
     let ne = new Negentropy(storage, opts?.frameSizeLimit);
@@ -46,7 +53,7 @@ export async function negentropySync(storage, socket, filter, reconcile, opts) {
         return msg[2];
     }), share());
     // keep an additional subscription open while waiting for async operations
-    const sub = incoming.subscribe((m) => console.log(m));
+    const sub = incoming.subscribe((m) => log(m));
     try {
         while (msg && opts?.signal?.aborted !== true) {
             const received = await firstValueFrom(incoming);

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/pool.d.ts

@@ -1,8 +1,10 @@
-import { type NostrEvent } from "nostr-tools";
+import type { IAsyncEventStoreRead, IEventStoreRead } from "applesauce-core";
+import { Filter, type NostrEvent } from "nostr-tools";
 import { BehaviorSubject, Observable, Subject } from "rxjs";
 import { RelayGroup } from "./group.js";
-import { Relay, RelayOptions } from "./relay.js";
-import { FilterInput, IPool, IRelay, PublishResponse, SubscriptionResponse } from "./types.js";
+import type { NegentropySyncOptions, ReconcileFunction } from "./negentropy.js";
+import { Relay, SyncDirection, type RelayOptions } from "./relay.js";
+import type { FilterInput, IPool, IRelay, PublishResponse, SubscriptionResponse } from "./types.js";
 export declare class RelayPool implements IPool {
     options?: RelayOptions | undefined;
     groups$: BehaviorSubject<Map<string, RelayGroup>>;
@@ -27,10 +29,14 @@ export declare class RelayPool implements IPool {
     req(relays: string[], filters: FilterInput, id?: string): Observable<SubscriptionResponse>;
     /** Send an EVENT message to multiple relays */
     event(relays: string[], 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?: NegentropySyncOptions): Promise<boolean>;
     /** Publish an event to multiple relays */
     publish(relays: string[], event: Parameters<RelayGroup["publish"]>[0], opts?: Parameters<RelayGroup["publish"]>[1]): Promise<PublishResponse[]>;
     /** Request events from multiple relays */
     request(relays: string[], filters: Parameters<RelayGroup["request"]>[0], opts?: Parameters<RelayGroup["request"]>[1]): Observable<NostrEvent>;
     /** Open a subscription to multiple relays */
-    subscription(relays: string[], filters: Parameters<RelayGroup["subscription"]>[0], opts?: Parameters<RelayGroup["subscription"]>[1]): Observable<SubscriptionResponse>;
+    subscription(relays: string[], filters: Parameters<RelayGroup["subscription"]>[0], options?: Parameters<RelayGroup["subscription"]>[1]): Observable<SubscriptionResponse>;
+    /** Negentropy sync events with the relays and an event store */
+    sync(relays: string[], store: IEventStoreRead | IAsyncEventStoreRead | NostrEvent[], filter: Filter, direction?: SyncDirection): Observable<NostrEvent>;
 }

package/dist/pool.js

@@ -1,5 +1,5 @@
-import { BehaviorSubject, Subject } from "rxjs";
 import { normalizeURL } from "applesauce-core/helpers";
+import { BehaviorSubject, Subject } from "rxjs";
 import { RelayGroup } from "./group.js";
 import { Relay } from "./relay.js";
 export class RelayPool {
@@ -96,6 +96,10 @@ export class RelayPool {
     event(relays, event) {
         return this.group(relays).event(event);
     }
+    /** Negentropy sync event ids with the relays and an event store */
+    negentropy(relays, store, filter, reconcile, opts) {
+        return this.group(relays).negentropy(store, filter, reconcile, opts);
+    }
     /** Publish an event to multiple relays */
     publish(relays, event, opts) {
         return this.group(relays).publish(event, opts);
@@ -105,7 +109,11 @@ export class RelayPool {
         return this.group(relays).request(filters, opts);
     }
     /** Open a subscription to multiple relays */
-    subscription(relays, filters, opts) {
-        return this.group(relays).subscription(filters, opts);
+    subscription(relays, filters, options) {
+        return this.group(relays).subscription(filters, options);
+    }
+    /** 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

@@ -1,9 +1,16 @@
-import { logger } from "applesauce-core";
+import { IAsyncEventStoreRead, IEventStoreRead, logger } from "applesauce-core";
 import { type Filter, type NostrEvent } from "nostr-tools";
 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";
+/** Flags for the negentropy sync type */
+export declare enum SyncDirection {
+    RECEIVE = 1,
+    SEND = 2,
+    BOTH = 3
+}
 /** An error that is thrown when a REQ is closed from the relay side */
 export declare class ReqCloseError extends Error {
 }
@@ -56,6 +63,8 @@ export declare class Relay implements IRelay {
     protected _nip11: RelayInformation | null;
     /** An observable that emits the limitations for the relay */
     limitations$: Observable<RelayInformation["limitation"] | null>;
+    /** An array of supported NIPs from the NIP-11 information document */
+    supported$: Observable<number[] | null>;
     /** An observable that emits when underlying websocket is opened */
     open$: Subject<Event>;
     /** An observable that emits when underlying websocket is closed */
@@ -99,6 +108,8 @@ export declare class Relay implements IRelay {
     event(event: NostrEvent, verb?: "EVENT" | "AUTH"): Observable<PublishResponse>;
     /** send and AUTH message */
     auth(event: NostrEvent): Promise<PublishResponse>;
+    /** Negentropy sync event ids with the relay and an event store */
+    negentropy(store: IEventStoreRead | IAsyncEventStoreRead | NostrEvent[], filter: Filter, reconcile: ReconcileFunction, opts?: NegentropySyncOptions): Promise<boolean>;
     /** Authenticate with the relay using a signer */
     authenticate(signer: AuthSigner): Promise<PublishResponse>;
     /** Internal operator for creating the retry() operator */
@@ -113,12 +124,16 @@ export declare class Relay implements IRelay {
     request(filters: Filter | Filter[], 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 */
+    sync(store: IEventStoreRead | IAsyncEventStoreRead | NostrEvent[], filter: Filter, direction?: SyncDirection): Observable<NostrEvent>;
     /** Force close the connection */
     close(): void;
     /** An async method that returns the NIP-11 information document for the relay */
     getInformation(): Promise<RelayInformation | null>;
     /** An async method that returns the NIP-11 limitations for the relay */
     getLimitations(): Promise<RelayInformation["limitation"] | null>;
+    /** An async method that returns the supported NIPs for the relay */
+    getSupported(): Promise<number[] | null>;
     /** Static method to fetch the NIP-11 information document for a relay */
     static fetchInformationDocument(url: string): Observable<RelayInformation | null>;
     /** Static method to create a reconnection method for each relay */

package/dist/relay.js

@@ -3,11 +3,18 @@ import { ensureHttpURL } from "applesauce-core/helpers";
 import { simpleTimeout } from "applesauce-core/observable";
 import { nanoid } from "nanoid";
 import { nip42 } from "nostr-tools";
-import { BehaviorSubject, catchError, combineLatest, defer, endWith, filter, finalize, firstValueFrom, from, identity, ignoreElements, isObservable, lastValueFrom, map, merge, mergeMap, mergeWith, NEVER, of, repeat, retry, scan, share, shareReplay, Subject, switchMap, take, takeUntil, tap, throwError, timeout, timer, } from "rxjs";
+import { BehaviorSubject, catchError, combineLatest, defer, endWith, filter, finalize, firstValueFrom, from, identity, ignoreElements, isObservable, lastValueFrom, map, merge, mergeMap, mergeWith, NEVER, Observable, of, repeat, retry, scan, share, shareReplay, Subject, switchMap, take, takeUntil, 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";
 const DEFAULT_RETRY_CONFIG = { count: 10, delay: 1000, resetOnSuccess: true };
+/** Flags for the negentropy sync type */
+export var SyncDirection;
+(function (SyncDirection) {
+    SyncDirection[SyncDirection["RECEIVE"] = 1] = "RECEIVE";
+    SyncDirection[SyncDirection["SEND"] = 2] = "SEND";
+    SyncDirection[SyncDirection["BOTH"] = 3] = "BOTH";
+})(SyncDirection || (SyncDirection = {}));
 /** An error that is thrown when a REQ is closed from the relay side */
 export class ReqCloseError extends Error {
 }
@@ -48,6 +55,8 @@ export class Relay {
     _nip11 = null;
     /** An observable that emits the limitations for the relay */
     limitations$;
+    /** An array of supported NIPs from the NIP-11 information document */
+    supported$;
     /** An observable that emits when underlying websocket is opened */
     open$ = new Subject();
     /** An observable that emits when underlying websocket is closed */
@@ -153,7 +162,8 @@ export class Relay {
         tap((info) => (this._nip11 = info)), 
         // cache the result
         shareReplay(1));
-        this.limitations$ = this.information$.pipe(map((info) => info?.limitation));
+        this.limitations$ = this.information$.pipe(map((info) => (info ? info.limitation : null)));
+        this.supported$ = this.information$.pipe(map((info) => info && Array.isArray(info.supported_nips) ? info.supported_nips.filter((n) => typeof n === "number") : null));
         // Create observables that track if auth is required for REQ or EVENT
         this.authRequiredForRead$ = this.receivedAuthRequiredForReq.pipe(tap((required) => required && this.log("Auth required for REQ")), shareReplay(1));
         this.authRequiredForPublish$ = this.receivedAuthRequiredForEvent.pipe(tap((required) => required && this.log("Auth required for EVENT")), shareReplay(1));
@@ -352,6 +362,16 @@ export class Relay {
         // update authenticated
         tap((result) => this.authenticationResponse$.next(result))));
     }
+    /** Negentropy sync event ids with the relay and an event store */
+    async negentropy(store, filter, reconcile, opts) {
+        // Check relay supports NIP-77 sync
+        if ((await this.getSupported())?.includes(77) === false)
+            throw new Error("Relay does not support NIP-77");
+        // Import negentropy functions dynamically
+        const { buildStorageVector, buildStorageFromFilter, negentropySync } = await import("./negentropy.js");
+        const storage = Array.isArray(store) ? buildStorageVector(store) : await buildStorageFromFilter(store, filter);
+        return negentropySync(storage, this.socket, filter, reconcile, opts);
+    }
     /** Authenticate with the relay using a signer */
     authenticate(signer) {
         if (!this.challenge)
@@ -431,6 +451,39 @@ export class Relay {
         // Single subscription
         share()));
     }
+    /** Negentropy sync events with the relay and an event store */
+    sync(store, filter, direction = SyncDirection.RECEIVE) {
+        const getEvents = async (ids) => {
+            if (Array.isArray(store))
+                return store.filter((event) => ids.includes(event.id));
+            else
+                return store.getByFilters({ ids });
+        };
+        return new Observable((observer) => {
+            const controller = new AbortController();
+            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
+                if (direction & SyncDirection.SEND && have.length > 0) {
+                    const events = await getEvents(have);
+                    // Send all events to the relay
+                    await Promise.allSettled(events.map((event) => lastValueFrom(this.event(event))));
+                }
+                // Fetch missing events from the relay
+                if (direction & SyncDirection.RECEIVE && need.length > 0) {
+                    await lastValueFrom(this.req({ ids: need }).pipe(completeOnEose(), tap((event) => observer.next(event))));
+                }
+            }, { signal: controller.signal })
+                // Complete the observable when the sync is complete
+                .then(() => observer.complete())
+                // Error the observable when the sync fails
+                .catch((err) => observer.error(err));
+            // Cancel the sync when the observable is unsubscribed
+            return () => controller.abort();
+        }).pipe(
+        // Only create one upstream subscription
+        share());
+    }
     /** Force close the connection */
     close() {
         this.socket.unsubscribe();
@@ -443,6 +496,10 @@ export class Relay {
     async getLimitations() {
         return firstValueFrom(this.limitations$);
     }
+    /** An async method that returns the supported NIPs for the relay */
+    async getSupported() {
+        return firstValueFrom(this.supported$);
+    }
     /** Static method to fetch the NIP-11 information document for a relay */
     static fetchInformationDocument(url) {
         return from(fetch(ensureHttpURL(url), { headers: { Accept: "application/nostr+json" } }).then((res) => res.json())).pipe(

package/dist/types.d.ts

@@ -1,6 +1,11 @@
-import { type EventTemplate, type Filter, type NostrEvent } from "nostr-tools";
-import { Observable, repeat, retry } from "rxjs";
-import { WebSocketSubject } from "rxjs/webSocket";
+import type { EventTemplate, Filter, NostrEvent } from "nostr-tools";
+import type { RelayInformation } from "nostr-tools/nip11";
+import type { Observable, repeat, retry } from "rxjs";
+import type { WebSocketSubject } from "rxjs/webSocket";
+import type { NegentropySyncOptions, ReconcileFunction } from "./negentropy.js";
+import type { IAsyncEventStoreRead, IEventStoreRead } from "applesauce-core";
+import type { SyncDirection } from "./relay.js";
+import type { GroupNegentropySyncOptions, GroupRequestOptions, GroupSubscriptionOptions } from "./group.js";
 export type SubscriptionResponse = NostrEvent | "EOSE";
 export type PublishResponse = {
     ok: boolean;
@@ -60,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;
@@ -73,6 +81,8 @@ export interface IRelay extends MultiplexWebSocket {
     event(event: NostrEvent): Observable<PublishResponse>;
     /** Send an AUTH message */
     auth(event: NostrEvent): Promise<PublishResponse>;
+    /** Negentropy sync event ids with the relay and an event store */
+    negentropy(store: IEventStoreRead | IAsyncEventStoreRead | NostrEvent[], filter: Filter, reconcile: ReconcileFunction, opts?: NegentropySyncOptions): Promise<boolean>;
     /** Authenticate with the relay using a signer */
     authenticate(signer: AuthSigner): Promise<PublishResponse>;
     /** Send an EVENT message with retries */
@@ -81,18 +91,30 @@ export interface IRelay extends MultiplexWebSocket {
     request(filters: FilterInput, opts?: RequestOptions): Observable<NostrEvent>;
     /** Open a subscription with retries */
     subscription(filters: FilterInput, opts?: SubscriptionOptions): Observable<SubscriptionResponse>;
+    /** Negentropy sync events with the relay and an event store */
+    sync(store: IEventStoreRead | IAsyncEventStoreRead | NostrEvent[], filter: Filter, direction?: SyncDirection): Observable<NostrEvent>;
+    /** Get the NIP-11 information document for the relay */
+    getInformation(): Promise<RelayInformation | null>;
+    /** Get the limitations for the relay */
+    getLimitations(): Promise<RelayInformation["limitation"] | null>;
+    /** Get the supported NIPs for the relay */
+    getSupported(): Promise<number[] | null>;
 }
 export interface IGroup {
     /** Send a REQ message */
     req(filters: FilterInput, id?: string): Observable<SubscriptionResponse>;
     /** Send an EVENT message */
     event(event: NostrEvent): 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>;
     /** Send an EVENT message with retries */
     publish(event: NostrEvent, opts?: PublishOptions): Promise<PublishResponse[]>;
     /** Send a REQ message with retries */
-    request(filters: FilterInput, opts?: RequestOptions): Observable<NostrEvent>;
+    request(filters: FilterInput, opts?: GroupRequestOptions): Observable<NostrEvent>;
     /** Open a subscription with retries */
-    subscription(filters: FilterInput, opts?: SubscriptionOptions): Observable<SubscriptionResponse>;
+    subscription(filters: FilterInput, opts?: GroupSubscriptionOptions): Observable<SubscriptionResponse>;
+    /** Negentropy sync events with the relay and an event store */
+    sync(store: IEventStoreRead | IAsyncEventStoreRead | NostrEvent[], filter: Filter, direction?: SyncDirection): Observable<NostrEvent>;
 }
 /** Signals emitted by the pool */
 export interface IPoolSignals {
@@ -110,10 +132,14 @@ export interface IPool extends IPoolSignals {
     req(relays: string[], filters: FilterInput, id?: string): Observable<SubscriptionResponse>;
     /** Send an EVENT message */
     event(relays: string[], 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>;
     /** Send an EVENT message to relays with retries */
     publish(relays: string[], 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>;
     /** Open a subscription to relays with retries */
     subscription(relays: string[], filters: Parameters<IGroup["subscription"]>[0], opts?: Parameters<IGroup["subscription"]>[1]): Observable<SubscriptionResponse>;
+    /** Negentropy sync events with the relay and an event store */
+    sync(relays: string[], store: IEventStoreRead | IAsyncEventStoreRead | NostrEvent[], filter: Filter, direction?: SyncDirection): Observable<NostrEvent>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-relay",
-  "version": "0.0.0-next-20250923113611",
+  "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-20250923113611",
+    "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-20250923113611",
+    "applesauce-signers": "0.0.0-next-20251015123951",
     "rimraf": "^6.0.1",
     "typescript": "^5.7.3",
     "vitest": "^3.2.4",