applesauce-loaders 0.0.0-next-20250111214201 → 0.0.0-next-20250114214607
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/helpers/address-pointer.d.ts +11 -2
- package/dist/helpers/address-pointer.js +38 -3
- package/dist/helpers/address-pointer.test.d.ts +1 -0
- package/dist/helpers/address-pointer.test.js +19 -0
- package/dist/helpers/event-pointer.d.ts +5 -0
- package/dist/helpers/event-pointer.js +19 -0
- package/dist/helpers/pointer.d.ts +3 -0
- package/dist/helpers/pointer.js +13 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/loaders/index.d.ts +2 -0
- package/dist/loaders/index.js +2 -0
- package/dist/loaders/loader.d.ts +2 -0
- package/dist/loaders/replaceable-loader.d.ts +2 -5
- package/dist/loaders/replaceable-loader.js +3 -3
- package/dist/loaders/single-event-loader.d.ts +26 -0
- package/dist/loaders/single-event-loader.js +78 -0
- package/dist/loaders/single-relay-replaceable-loader.js +2 -2
- package/dist/loaders/user-sets-loader.d.ts +31 -0
- package/dist/loaders/user-sets-loader.js +64 -0
- package/dist/operators/address-pointers-request.d.ts +1 -1
- package/dist/operators/address-pointers-request.js +3 -3
- package/dist/operators/distinct-by-relays.d.ts +9 -0
- package/dist/operators/distinct-by-relays.js +39 -0
- package/dist/operators/distinct-timeout.d.ts +3 -0
- package/dist/operators/distinct-timeout.js +15 -0
- package/dist/operators/group-by-relays.d.ts +8 -0
- package/dist/operators/group-by-relays.js +10 -0
- package/dist/operators/index.d.ts +5 -2
- package/dist/operators/index.js +5 -2
- package/package.json +2 -2
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { AddressPointerWithoutD } from "applesauce-core/helpers";
|
|
2
2
|
import { Filter } from "nostr-tools";
|
|
3
|
+
import { AddressPointer } from "nostr-tools/nip19";
|
|
3
4
|
/** Converts an array of address pointers to a filter */
|
|
4
|
-
export declare function createFilterFromAddressPointers(pointers: AddressPointerWithoutD[]): Filter;
|
|
5
|
+
export declare function createFilterFromAddressPointers(pointers: AddressPointerWithoutD[] | AddressPointer[]): Filter;
|
|
5
6
|
/** Takes a set of address pointers, groups them, then returns filters for the groups */
|
|
6
7
|
export declare function createFiltersFromAddressPointers(pointers: AddressPointerWithoutD[]): Filter[];
|
|
7
8
|
/** Checks if a relay will understand an address pointer */
|
|
@@ -11,6 +12,14 @@ export declare function groupAddressPointersByKind(pointers: AddressPointerWitho
|
|
|
11
12
|
/** Group an array of address pointers by pubkey */
|
|
12
13
|
export declare function groupAddressPointersByPubkey(pointers: AddressPointerWithoutD[]): Map<string, AddressPointerWithoutD[]>;
|
|
13
14
|
/** Groups address pointers by kind or pubkey depending on which is most optimal */
|
|
14
|
-
export declare function groupAddressPointersByPubkeyOrKind(pointers: AddressPointerWithoutD[]): Map<
|
|
15
|
+
export declare function groupAddressPointersByPubkeyOrKind(pointers: AddressPointerWithoutD[]): Map<string, AddressPointerWithoutD[]> | Map<number, AddressPointerWithoutD[]>;
|
|
15
16
|
export declare function getRelaysFromPointers(pointers: AddressPointerWithoutD[]): Set<string>;
|
|
16
17
|
export declare function getAddressPointerId<T extends AddressPointerWithoutD>(pointer: T): string;
|
|
18
|
+
/** deduplicates an array of address pointers and merges their relays array */
|
|
19
|
+
export declare function consolidateAddressPointers<T extends {
|
|
20
|
+
kind: number;
|
|
21
|
+
pubkey: string;
|
|
22
|
+
identifier?: string;
|
|
23
|
+
relays?: string[];
|
|
24
|
+
force?: boolean;
|
|
25
|
+
}>(pointers: T[]): T[];
|
|
@@ -13,8 +13,19 @@ export function createFilterFromAddressPointers(pointers) {
|
|
|
13
13
|
}
|
|
14
14
|
/** Takes a set of address pointers, groups them, then returns filters for the groups */
|
|
15
15
|
export function createFiltersFromAddressPointers(pointers) {
|
|
16
|
-
|
|
17
|
-
|
|
16
|
+
// split the points in to two groups so they they don't mix in the filters
|
|
17
|
+
const parameterizedReplaceable = pointers.filter((p) => isParameterizedReplaceableKind(p.kind));
|
|
18
|
+
const replaceable = pointers.filter((p) => isReplaceableKind(p.kind));
|
|
19
|
+
const filters = [];
|
|
20
|
+
if (replaceable.length > 0) {
|
|
21
|
+
const groups = groupAddressPointersByPubkeyOrKind(replaceable);
|
|
22
|
+
filters.push(...Array.from(groups.values()).map(createFilterFromAddressPointers));
|
|
23
|
+
}
|
|
24
|
+
if (parameterizedReplaceable.length > 0) {
|
|
25
|
+
const groups = groupAddressPointersByPubkeyOrKind(parameterizedReplaceable);
|
|
26
|
+
filters.push(...Array.from(groups.values()).map(createFilterFromAddressPointers));
|
|
27
|
+
}
|
|
28
|
+
return filters;
|
|
18
29
|
}
|
|
19
30
|
/** Checks if a relay will understand an address pointer */
|
|
20
31
|
export function isLoadableAddressPointer(pointer) {
|
|
@@ -49,7 +60,7 @@ export function groupAddressPointersByPubkey(pointers) {
|
|
|
49
60
|
export function groupAddressPointersByPubkeyOrKind(pointers) {
|
|
50
61
|
const kinds = new Set(pointers.map((p) => p.kind));
|
|
51
62
|
const pubkeys = new Set(pointers.map((p) => p.pubkey));
|
|
52
|
-
return pubkeys.size
|
|
63
|
+
return pubkeys.size < kinds.size ? groupAddressPointersByPubkey(pointers) : groupAddressPointersByKind(pointers);
|
|
53
64
|
}
|
|
54
65
|
export function getRelaysFromPointers(pointers) {
|
|
55
66
|
const relays = new Set();
|
|
@@ -65,3 +76,27 @@ export function getRelaysFromPointers(pointers) {
|
|
|
65
76
|
export function getAddressPointerId(pointer) {
|
|
66
77
|
return getReplaceableUID(pointer.kind, pointer.pubkey, pointer.identifier);
|
|
67
78
|
}
|
|
79
|
+
/** deduplicates an array of address pointers and merges their relays array */
|
|
80
|
+
export function consolidateAddressPointers(pointers) {
|
|
81
|
+
const byCoordinate = new Map();
|
|
82
|
+
for (const pointer of pointers) {
|
|
83
|
+
let cord = getAddressPointerId(pointer);
|
|
84
|
+
let existing = byCoordinate.get(cord);
|
|
85
|
+
if (existing) {
|
|
86
|
+
// override force flag
|
|
87
|
+
if (pointer.force)
|
|
88
|
+
existing.force = pointer.force;
|
|
89
|
+
// merge relays
|
|
90
|
+
if (pointer.relays) {
|
|
91
|
+
if (!existing.relays)
|
|
92
|
+
existing.relays = [...pointer.relays];
|
|
93
|
+
else
|
|
94
|
+
existing.relays = [...existing.relays, ...pointer.relays.filter((r) => !existing.relays.includes(r))];
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
else {
|
|
98
|
+
byCoordinate.set(cord, pointer);
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
return Array.from(byCoordinate.values());
|
|
102
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { describe, it, expect } from "vitest";
|
|
2
|
+
import { createFiltersFromAddressPointers } from "./address-pointer.js";
|
|
3
|
+
import { kinds } from "nostr-tools";
|
|
4
|
+
describe("address pointer helpers", () => {
|
|
5
|
+
describe("createFiltersFromAddressPointers", () => {
|
|
6
|
+
it("should separate replaceable and parameterized replaceable pointers", () => {
|
|
7
|
+
expect(createFiltersFromAddressPointers([
|
|
8
|
+
{ kind: kinds.BookmarkList, pubkey: "pubkey" },
|
|
9
|
+
{ kind: kinds.Metadata, pubkey: "pubkey" },
|
|
10
|
+
{ kind: kinds.Metadata, pubkey: "pubkey2" },
|
|
11
|
+
{ kind: kinds.Bookmarksets, identifier: "funny", pubkey: "pubkey" },
|
|
12
|
+
])).toEqual(expect.arrayContaining([
|
|
13
|
+
{ kinds: [kinds.Metadata], authors: ["pubkey", "pubkey2"] },
|
|
14
|
+
{ kinds: [kinds.BookmarkList], authors: ["pubkey"] },
|
|
15
|
+
{ "#d": ["funny"], authors: ["pubkey"], kinds: [kinds.Bookmarksets] },
|
|
16
|
+
]));
|
|
17
|
+
});
|
|
18
|
+
});
|
|
19
|
+
});
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/** deduplicates an array of event pointers and merges their relays array */
|
|
2
|
+
export function consolidateEventPointers(pointers) {
|
|
3
|
+
let ids = new Map();
|
|
4
|
+
for (let pointer of pointers) {
|
|
5
|
+
let existing = ids.get(pointer.id);
|
|
6
|
+
if (existing) {
|
|
7
|
+
// merge relays
|
|
8
|
+
if (pointer.relays) {
|
|
9
|
+
if (!existing.relays)
|
|
10
|
+
existing.relays = [...pointer.relays];
|
|
11
|
+
else
|
|
12
|
+
existing.relays = [...existing.relays, ...pointer.relays.filter((r) => !existing.relays.includes(r))];
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
else
|
|
16
|
+
ids.set(pointer.id, pointer);
|
|
17
|
+
}
|
|
18
|
+
return Array.from(ids.values());
|
|
19
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
export function groupByRelay(pointers, defaultKey) {
|
|
2
|
+
let byRelay = new Map();
|
|
3
|
+
for (const pointer of pointers) {
|
|
4
|
+
let relays = pointer.relays?.length ? pointer.relays : defaultKey ? [defaultKey] : [];
|
|
5
|
+
for (const relay of relays) {
|
|
6
|
+
if (!byRelay.has(relay))
|
|
7
|
+
byRelay.set(relay, [pointer]);
|
|
8
|
+
else
|
|
9
|
+
byRelay.get(relay)?.push(pointer);
|
|
10
|
+
}
|
|
11
|
+
}
|
|
12
|
+
return byRelay;
|
|
13
|
+
}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export *
|
|
1
|
+
export * from "./loaders/index.js";
|
|
2
2
|
export * as Operators from "./operators/index.js";
|
package/dist/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export *
|
|
1
|
+
export * from "./loaders/index.js";
|
|
2
2
|
export * as Operators from "./operators/index.js";
|
package/dist/loaders/index.d.ts
CHANGED
package/dist/loaders/index.js
CHANGED
package/dist/loaders/loader.d.ts
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
|
+
import { Filter, NostrEvent } from "nostr-tools";
|
|
1
2
|
import { Observable, OperatorFunction, Subject, Subscribable } from "rxjs";
|
|
3
|
+
export type CacheRequest = (filters: Filter[]) => Observable<NostrEvent>;
|
|
2
4
|
export interface ILoader<T, R> extends Subscribable<R> {
|
|
3
5
|
next: (value: T) => void;
|
|
4
6
|
pipe: Observable<R>["pipe"];
|
|
@@ -1,8 +1,6 @@
|
|
|
1
|
-
import { Observable } from "rxjs";
|
|
2
1
|
import { EventPacket, RxNostr } from "rx-nostr";
|
|
3
|
-
import { Filter, NostrEvent } from "nostr-tools";
|
|
4
2
|
import { logger } from "applesauce-core";
|
|
5
|
-
import { Loader } from "./loader.js";
|
|
3
|
+
import { CacheRequest, Loader } from "./loader.js";
|
|
6
4
|
export type LoadableAddressPointer = {
|
|
7
5
|
kind: number;
|
|
8
6
|
pubkey: string;
|
|
@@ -13,14 +11,13 @@ export type LoadableAddressPointer = {
|
|
|
13
11
|
/** Load this address pointer even if it has already been loaded */
|
|
14
12
|
force?: boolean;
|
|
15
13
|
};
|
|
16
|
-
export type CacheRequest = (filters: Filter[]) => Observable<NostrEvent>;
|
|
17
14
|
export type ReplaceableLoaderOptions = {
|
|
18
15
|
/**
|
|
19
16
|
* Time interval to buffer requests in ms
|
|
20
17
|
* @default 1000
|
|
21
18
|
*/
|
|
22
19
|
bufferTime?: number;
|
|
23
|
-
/**
|
|
20
|
+
/** A method used to load events from a local cache */
|
|
24
21
|
cacheRequest?: CacheRequest;
|
|
25
22
|
/** Fallback lookup relays to check when event cant be found */
|
|
26
23
|
lookupRelays?: string[];
|
|
@@ -4,7 +4,7 @@ import { logger } from "applesauce-core";
|
|
|
4
4
|
import { nanoid } from "nanoid";
|
|
5
5
|
import { Loader } from "./loader.js";
|
|
6
6
|
import { generatorSequence } from "../operators/generator-sequence.js";
|
|
7
|
-
import {
|
|
7
|
+
import { addressPointersRequest } from "../operators/address-pointers-request.js";
|
|
8
8
|
import { createFiltersFromAddressPointers, getAddressPointerId, getRelaysFromPointers, isLoadableAddressPointer, } from "../helpers/address-pointer.js";
|
|
9
9
|
import { unique } from "../helpers/array.js";
|
|
10
10
|
/** deep clone a loadable pointer to ensure its safe to modify */
|
|
@@ -59,7 +59,7 @@ function* cacheFirstSequence(rxNostr, pointers, log, opts) {
|
|
|
59
59
|
const remoteRelays = [...pointerRelays, ...defaultRelays];
|
|
60
60
|
if (remoteRelays.length > 0) {
|
|
61
61
|
log(`Requesting`, remoteRelays, remaining);
|
|
62
|
-
const results = yield from([remaining]).pipe(
|
|
62
|
+
const results = yield from([remaining]).pipe(addressPointersRequest(rxNostr, id, remoteRelays));
|
|
63
63
|
if (handleResults(results))
|
|
64
64
|
return;
|
|
65
65
|
}
|
|
@@ -69,7 +69,7 @@ function* cacheFirstSequence(rxNostr, pointers, log, opts) {
|
|
|
69
69
|
const relays = opts.lookupRelays.filter((r) => !pointerRelays.includes(r));
|
|
70
70
|
if (relays.length > 0) {
|
|
71
71
|
log(`Request from lookup`, relays, remaining);
|
|
72
|
-
const results = yield from([remaining]).pipe(
|
|
72
|
+
const results = yield from([remaining]).pipe(addressPointersRequest(rxNostr, id, relays));
|
|
73
73
|
if (handleResults(results))
|
|
74
74
|
return;
|
|
75
75
|
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { EventPacket, RxNostr } from "rx-nostr";
|
|
2
|
+
import { logger } from "applesauce-core";
|
|
3
|
+
import { CacheRequest, Loader } from "./loader.js";
|
|
4
|
+
export type LoadableEventPointer = {
|
|
5
|
+
id: string;
|
|
6
|
+
/** Relays to load from */
|
|
7
|
+
relays?: string[];
|
|
8
|
+
};
|
|
9
|
+
export type SingleEventLoaderOptions = {
|
|
10
|
+
/**
|
|
11
|
+
* Time interval to buffer requests in ms
|
|
12
|
+
* @default 1000
|
|
13
|
+
*/
|
|
14
|
+
bufferTime?: number;
|
|
15
|
+
/** A method used to load events from a local cache */
|
|
16
|
+
cacheRequest?: CacheRequest;
|
|
17
|
+
/**
|
|
18
|
+
* How long the loader should wait before it allows an event pointer to be refreshed from a relay
|
|
19
|
+
* @default 60000
|
|
20
|
+
*/
|
|
21
|
+
refreshTimeout?: number;
|
|
22
|
+
};
|
|
23
|
+
export declare class SingleEventLoader extends Loader<LoadableEventPointer, EventPacket> {
|
|
24
|
+
log: typeof logger;
|
|
25
|
+
constructor(rxNostr: RxNostr, opts?: SingleEventLoaderOptions);
|
|
26
|
+
}
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
import { bufferTime, filter, from, map, mergeAll, share, tap } from "rxjs";
|
|
2
|
+
import { createRxOneshotReq } from "rx-nostr";
|
|
3
|
+
import { markFromCache } from "applesauce-core/helpers";
|
|
4
|
+
import { logger } from "applesauce-core";
|
|
5
|
+
import { nanoid } from "nanoid";
|
|
6
|
+
import { Loader } from "./loader.js";
|
|
7
|
+
import { generatorSequence } from "../operators/generator-sequence.js";
|
|
8
|
+
import { distinctRelays } from "../operators/distinct-by-relays.js";
|
|
9
|
+
import { groupByRelay } from "../helpers/pointer.js";
|
|
10
|
+
import { consolidateEventPointers } from "../helpers/event-pointer.js";
|
|
11
|
+
/** Consolidate a batch of event pointers */
|
|
12
|
+
function consolidateLoadableEventPointers() {
|
|
13
|
+
return (source) => source.pipe(map(consolidateEventPointers));
|
|
14
|
+
}
|
|
15
|
+
function* cacheFirstSequence(rxNostr, pointers, opts, log) {
|
|
16
|
+
let remaining = [...pointers];
|
|
17
|
+
const id = nanoid(8);
|
|
18
|
+
log = log.extend(id);
|
|
19
|
+
const loaded = (packets) => {
|
|
20
|
+
const ids = new Set(packets.map((p) => p.event.id));
|
|
21
|
+
remaining = remaining.filter((p) => !ids.has(p.id));
|
|
22
|
+
};
|
|
23
|
+
if (opts?.cacheRequest) {
|
|
24
|
+
let filter = { ids: remaining.map((e) => e.id) };
|
|
25
|
+
const results = yield opts.cacheRequest([filter]).pipe(
|
|
26
|
+
// mark the event as from the cache
|
|
27
|
+
tap((event) => markFromCache(event)),
|
|
28
|
+
// convert to event packets
|
|
29
|
+
map((e) => ({ event: e, from: "cache", subId: "cache", type: "EVENT" })));
|
|
30
|
+
if (results.length > 0) {
|
|
31
|
+
log(`Loaded ${results.length} events from cache`);
|
|
32
|
+
loaded(results);
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
// exit early if all pointers are loaded
|
|
36
|
+
if (remaining.length === 0)
|
|
37
|
+
return;
|
|
38
|
+
let byRelay = groupByRelay(remaining, "default");
|
|
39
|
+
// load remaining pointers from the relays
|
|
40
|
+
let results = yield from(Array.from(byRelay.entries()).map(([relay, pointers]) => {
|
|
41
|
+
let filter = { ids: pointers.map((e) => e.id) };
|
|
42
|
+
let count = 0;
|
|
43
|
+
const req = createRxOneshotReq({ filters: [filter], rxReqId: id });
|
|
44
|
+
log(`Requesting from ${relay}`, filter.ids);
|
|
45
|
+
let sub$;
|
|
46
|
+
// don't specify relay if this is the "default" relay
|
|
47
|
+
if (relay === "default")
|
|
48
|
+
sub$ = rxNostr.use(req);
|
|
49
|
+
else
|
|
50
|
+
sub$ = rxNostr.use(req, { on: { relays: [relay] } });
|
|
51
|
+
return sub$.pipe(tap({
|
|
52
|
+
next: () => count++,
|
|
53
|
+
complete: () => log(`Completed ${relay}, loaded ${count} events`),
|
|
54
|
+
}));
|
|
55
|
+
})).pipe(mergeAll());
|
|
56
|
+
loaded(results);
|
|
57
|
+
if (remaining.length > 0) {
|
|
58
|
+
// failed to find remaining
|
|
59
|
+
log("Failed to load", remaining.map((p) => p.id));
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
export class SingleEventLoader extends Loader {
|
|
63
|
+
log = logger.extend("SingleEventLoader");
|
|
64
|
+
constructor(rxNostr, opts) {
|
|
65
|
+
let options = opts || {};
|
|
66
|
+
super((source) => source.pipe(distinctRelays((p) => p.id, options.refreshTimeout ?? 60_000),
|
|
67
|
+
// load first from cache
|
|
68
|
+
bufferTime(opts?.bufferTime ?? 1000),
|
|
69
|
+
// ignore empty buffers
|
|
70
|
+
filter((buffer) => buffer.length > 0),
|
|
71
|
+
// ensure there is only one of each event pointer
|
|
72
|
+
consolidateLoadableEventPointers(),
|
|
73
|
+
// run the loader sequence
|
|
74
|
+
generatorSequence((pointers) => cacheFirstSequence(rxNostr, pointers, options, this.log)),
|
|
75
|
+
// share the response with all subscribers
|
|
76
|
+
share()));
|
|
77
|
+
}
|
|
78
|
+
}
|
|
@@ -3,7 +3,7 @@ import { getReplaceableUID } from "applesauce-core/helpers";
|
|
|
3
3
|
import { nanoid } from "nanoid";
|
|
4
4
|
import { Loader } from "./loader.js";
|
|
5
5
|
import { isLoadableAddressPointer } from "../helpers/address-pointer.js";
|
|
6
|
-
import {
|
|
6
|
+
import { addressPointersRequest } from "../operators/address-pointers-request.js";
|
|
7
7
|
const defaultRelayReplaceableLoaderOptions = {
|
|
8
8
|
bufferTime: 1000,
|
|
9
9
|
};
|
|
@@ -44,7 +44,7 @@ export class SingleRelayReplaceableLoader extends Loader {
|
|
|
44
44
|
// batch and filter
|
|
45
45
|
singleRelayBatcher(opts),
|
|
46
46
|
// breakout the batches so they can complete
|
|
47
|
-
mergeMap((pointers) => from([pointers]).pipe(
|
|
47
|
+
mergeMap((pointers) => from([pointers]).pipe(addressPointersRequest(rxNostr, nanoid(8), [relay]))),
|
|
48
48
|
// share the response with all subscribers
|
|
49
49
|
share()));
|
|
50
50
|
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { EventPacket, RxNostr } from "rx-nostr";
|
|
2
|
+
import { logger } from "applesauce-core";
|
|
3
|
+
import { CacheRequest, Loader } from "./loader.js";
|
|
4
|
+
export type LoadableSetPointer = {
|
|
5
|
+
/** A replaceable kind >= 30000 & < 40000 */
|
|
6
|
+
kind: number;
|
|
7
|
+
pubkey: string;
|
|
8
|
+
/** Relays to load from */
|
|
9
|
+
relays?: string[];
|
|
10
|
+
/** Load the sets even if it has already been loaded */
|
|
11
|
+
force?: boolean;
|
|
12
|
+
};
|
|
13
|
+
export type UserSetsLoaderOptions = {
|
|
14
|
+
/**
|
|
15
|
+
* Time interval to buffer requests in ms
|
|
16
|
+
* @default 1000
|
|
17
|
+
*/
|
|
18
|
+
bufferTime?: number;
|
|
19
|
+
/** A method used to load events from a local cache */
|
|
20
|
+
cacheRequest?: CacheRequest;
|
|
21
|
+
/**
|
|
22
|
+
* How long the loader should wait before it allows an event pointer to be refreshed from a relay
|
|
23
|
+
* @default 120000
|
|
24
|
+
*/
|
|
25
|
+
refreshTimeout?: number;
|
|
26
|
+
};
|
|
27
|
+
/** A loader that can be used to load users NIP-51 sets events ( kind >= 30000 < 40000) */
|
|
28
|
+
export declare class UserSetsLoader extends Loader<LoadableSetPointer, EventPacket> {
|
|
29
|
+
log: typeof logger;
|
|
30
|
+
constructor(rxNostr: RxNostr, opts?: UserSetsLoaderOptions);
|
|
31
|
+
}
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import { share, tap, from, filter, map, mergeAll, bufferTime } from "rxjs";
|
|
2
|
+
import { createRxOneshotReq } from "rx-nostr";
|
|
3
|
+
import { markFromCache } from "applesauce-core/helpers";
|
|
4
|
+
import { logger } from "applesauce-core";
|
|
5
|
+
import { nanoid } from "nanoid";
|
|
6
|
+
import { Loader } from "./loader.js";
|
|
7
|
+
import { generatorSequence } from "../operators/generator-sequence.js";
|
|
8
|
+
import { consolidateAddressPointers, createFiltersFromAddressPointers } from "../helpers/address-pointer.js";
|
|
9
|
+
import { groupByRelay } from "../helpers/pointer.js";
|
|
10
|
+
import { distinctRelays } from "../operators/distinct-by-relays.js";
|
|
11
|
+
/** A generator that tries to load the address pointers from the cache first, then tries the relays */
|
|
12
|
+
function* cacheFirstSequence(rxNostr, pointers, log, opts) {
|
|
13
|
+
const id = nanoid(8);
|
|
14
|
+
log = log.extend(id);
|
|
15
|
+
// first attempt, load from cache relays
|
|
16
|
+
if (opts?.cacheRequest) {
|
|
17
|
+
log(`Checking cache`);
|
|
18
|
+
const filters = createFiltersFromAddressPointers(pointers);
|
|
19
|
+
const results = yield opts.cacheRequest(filters).pipe(
|
|
20
|
+
// mark the event as from the cache
|
|
21
|
+
tap((event) => markFromCache(event)),
|
|
22
|
+
// convert to event packets
|
|
23
|
+
map((e) => ({ event: e, from: "cache", subId: "cache", type: "EVENT" })));
|
|
24
|
+
if (results.length > 0) {
|
|
25
|
+
log(`Loaded ${results.length} events from cache`);
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
let byRelay = groupByRelay(pointers, "default");
|
|
29
|
+
// load sets from relays
|
|
30
|
+
yield from(Array.from(byRelay.entries()).map(([relay, pointers]) => {
|
|
31
|
+
let filters = createFiltersFromAddressPointers(pointers);
|
|
32
|
+
let count = 0;
|
|
33
|
+
const req = createRxOneshotReq({ filters, rxReqId: id });
|
|
34
|
+
log(`Requesting from ${relay}`, pointers);
|
|
35
|
+
let sub$;
|
|
36
|
+
// don't specify relay if this is the "default" relay
|
|
37
|
+
if (relay === "default")
|
|
38
|
+
sub$ = rxNostr.use(req);
|
|
39
|
+
else
|
|
40
|
+
sub$ = rxNostr.use(req, { on: { relays: [relay] } });
|
|
41
|
+
return sub$.pipe(tap({
|
|
42
|
+
next: () => count++,
|
|
43
|
+
complete: () => log(`Completed ${relay}, loaded ${count} events`),
|
|
44
|
+
}));
|
|
45
|
+
})).pipe(mergeAll());
|
|
46
|
+
}
|
|
47
|
+
/** A loader that can be used to load users NIP-51 sets events ( kind >= 30000 < 40000) */
|
|
48
|
+
export class UserSetsLoader extends Loader {
|
|
49
|
+
log = logger.extend("UserSetsLoader");
|
|
50
|
+
constructor(rxNostr, opts) {
|
|
51
|
+
let options = opts || {};
|
|
52
|
+
super((source) => source.pipe(distinctRelays((p) => p.kind + ":" + p.pubkey, options.refreshTimeout ?? 120_000),
|
|
53
|
+
// load first from cache
|
|
54
|
+
bufferTime(options?.bufferTime ?? 1000),
|
|
55
|
+
// ignore empty buffers
|
|
56
|
+
filter((buffer) => buffer.length > 0),
|
|
57
|
+
// deduplicate address pointers
|
|
58
|
+
map(consolidateAddressPointers),
|
|
59
|
+
// check cache, relays, lookup relays in that order
|
|
60
|
+
generatorSequence((pointers) => cacheFirstSequence(rxNostr, pointers, this.log, options)),
|
|
61
|
+
// share the response with all subscribers
|
|
62
|
+
share()));
|
|
63
|
+
}
|
|
64
|
+
}
|
|
@@ -2,4 +2,4 @@ import { EventPacket, RxNostr } from "rx-nostr";
|
|
|
2
2
|
import { OperatorFunction } from "rxjs";
|
|
3
3
|
import { AddressPointerWithoutD } from "applesauce-core/helpers";
|
|
4
4
|
/** Makes a request to relays for every set of address pointers */
|
|
5
|
-
export declare function
|
|
5
|
+
export declare function addressPointersRequest<T extends AddressPointerWithoutD>(rxNostr: RxNostr, id: string, relays?: string[]): OperatorFunction<T[], EventPacket>;
|
|
@@ -3,15 +3,15 @@ import { logger } from "applesauce-core";
|
|
|
3
3
|
import { relaysRequest } from "./relay-request.js";
|
|
4
4
|
import { createFiltersFromAddressPointers } from "../helpers/address-pointer.js";
|
|
5
5
|
/** Makes a request to relays for every set of address pointers */
|
|
6
|
-
export function
|
|
6
|
+
export function addressPointersRequest(rxNostr, id, relays) {
|
|
7
7
|
return (source) => {
|
|
8
|
-
const log = logger.extend(`
|
|
8
|
+
const log = logger.extend(`addressPointersRequest:${id}`);
|
|
9
9
|
return source.pipe(
|
|
10
10
|
// convert pointers to filters
|
|
11
11
|
map(createFiltersFromAddressPointers),
|
|
12
12
|
// make requests
|
|
13
13
|
tap((filters) => {
|
|
14
|
-
log(`Requesting`,
|
|
14
|
+
log(`Requesting`, filters, "from", relays);
|
|
15
15
|
}),
|
|
16
16
|
// make requests
|
|
17
17
|
relaysRequest(rxNostr, id, relays),
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { OperatorFunction } from "rxjs";
|
|
2
|
+
interface Message {
|
|
3
|
+
relays?: string[];
|
|
4
|
+
/** Ignore timeout and force message through */
|
|
5
|
+
force?: boolean;
|
|
6
|
+
[key: string]: any;
|
|
7
|
+
}
|
|
8
|
+
export declare function distinctRelays<T extends Message>(keyFn: (message: T) => string, timeout?: number): OperatorFunction<T, T>;
|
|
9
|
+
export {};
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { filter, map, share } from "rxjs";
|
|
2
|
+
export function distinctRelays(keyFn, timeout = 1000) {
|
|
3
|
+
return (source$) => {
|
|
4
|
+
const cache = new Map();
|
|
5
|
+
return source$.pipe(map((message) => {
|
|
6
|
+
if (message.force)
|
|
7
|
+
return message;
|
|
8
|
+
let key = keyFn(message);
|
|
9
|
+
let now = Date.now();
|
|
10
|
+
if (message.relays) {
|
|
11
|
+
// requesting from specific relays
|
|
12
|
+
let relays = message.relays;
|
|
13
|
+
relays = relays.filter((relay) => {
|
|
14
|
+
let relayKey = key + " " + relay;
|
|
15
|
+
let last = cache.get(relayKey);
|
|
16
|
+
if (!last || now >= last + timeout) {
|
|
17
|
+
cache.set(relayKey, now);
|
|
18
|
+
return true;
|
|
19
|
+
}
|
|
20
|
+
else
|
|
21
|
+
return false;
|
|
22
|
+
});
|
|
23
|
+
if (relays.length === 0)
|
|
24
|
+
return null;
|
|
25
|
+
return { ...message, relays };
|
|
26
|
+
}
|
|
27
|
+
else {
|
|
28
|
+
// requesting from default relays
|
|
29
|
+
let last = cache.get(key);
|
|
30
|
+
if (!last || now >= last + timeout) {
|
|
31
|
+
cache.set(key, now);
|
|
32
|
+
return message;
|
|
33
|
+
}
|
|
34
|
+
else
|
|
35
|
+
return null;
|
|
36
|
+
}
|
|
37
|
+
}), filter((message) => message !== null && !!message.relays?.length), share());
|
|
38
|
+
};
|
|
39
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { LRU } from "applesauce-core/helpers";
|
|
2
|
+
import { filter } from "rxjs";
|
|
3
|
+
/** Filters out duplicate values based on a key getter and a TTL */
|
|
4
|
+
export function distinctTimeout(keyFn, ttl = 1000) {
|
|
5
|
+
const seen = new LRU(undefined, ttl);
|
|
6
|
+
return (source) => source.pipe(filter((value) => {
|
|
7
|
+
const key = keyFn(value);
|
|
8
|
+
if (seen.has(key))
|
|
9
|
+
return false;
|
|
10
|
+
else {
|
|
11
|
+
seen.set(key, Date.now());
|
|
12
|
+
return true;
|
|
13
|
+
}
|
|
14
|
+
}));
|
|
15
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { GroupedObservable, OperatorFunction } from "rxjs";
|
|
2
|
+
interface Message {
|
|
3
|
+
relays?: string[];
|
|
4
|
+
[key: string]: any;
|
|
5
|
+
}
|
|
6
|
+
/** Splits a stream of messages out into relay specific observables */
|
|
7
|
+
export declare function groupByRelays<T extends Message>(defaultRelay: string): OperatorFunction<T, GroupedObservable<string, T>>;
|
|
8
|
+
export {};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { from, groupBy, map, mergeMap, share } from "rxjs";
|
|
2
|
+
/** Splits a stream of messages out into relay specific observables */
|
|
3
|
+
export function groupByRelays(defaultRelay) {
|
|
4
|
+
return (source$) => {
|
|
5
|
+
return source$.pipe(mergeMap((message) => {
|
|
6
|
+
const relays = message.relays?.length ? message.relays : [defaultRelay];
|
|
7
|
+
return from(relays).pipe(map((relay) => ({ relay, message })));
|
|
8
|
+
}), groupBy((pair) => pair.relay, { element: (pair) => pair.message }), share());
|
|
9
|
+
};
|
|
10
|
+
}
|
|
@@ -1,4 +1,7 @@
|
|
|
1
|
+
export * from "./address-pointers-request.js";
|
|
2
|
+
export * from "./distinct-by-relays.js";
|
|
3
|
+
export * from "./distinct-timeout.js";
|
|
1
4
|
export * from "./generator-sequence.js";
|
|
2
|
-
export * from "./
|
|
5
|
+
export * from "./group-by-relays.js";
|
|
3
6
|
export * from "./max-filters.js";
|
|
4
|
-
export * from "./
|
|
7
|
+
export * from "./relay-request.js";
|
package/dist/operators/index.js
CHANGED
|
@@ -1,4 +1,7 @@
|
|
|
1
|
+
export * from "./address-pointers-request.js";
|
|
2
|
+
export * from "./distinct-by-relays.js";
|
|
3
|
+
export * from "./distinct-timeout.js";
|
|
1
4
|
export * from "./generator-sequence.js";
|
|
2
|
-
export * from "./
|
|
5
|
+
export * from "./group-by-relays.js";
|
|
3
6
|
export * from "./max-filters.js";
|
|
4
|
-
export * from "./
|
|
7
|
+
export * from "./relay-request.js";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "applesauce-loaders",
|
|
3
|
-
"version": "0.0.0-next-
|
|
3
|
+
"version": "0.0.0-next-20250114214607",
|
|
4
4
|
"description": "A collection of observable based loaders built on rx-nostr",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -41,7 +41,7 @@
|
|
|
41
41
|
}
|
|
42
42
|
},
|
|
43
43
|
"dependencies": {
|
|
44
|
-
"applesauce-core": "0.0.0-next-
|
|
44
|
+
"applesauce-core": "0.0.0-next-20250114214607",
|
|
45
45
|
"nanoid": "^5.0.9",
|
|
46
46
|
"nostr-tools": "^2.10.3",
|
|
47
47
|
"rx-nostr": "^3.4.1",
|