applesauce-loaders 0.0.0-next-20241207161834
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/LICENSE +21 -0
- package/README.md +72 -0
- package/dist/helpers/address-pointer.d.ts +16 -0
- package/dist/helpers/address-pointer.js +67 -0
- package/dist/helpers/array.d.ts +4 -0
- package/dist/helpers/array.js +21 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +2 -0
- package/dist/loaders/index.d.ts +3 -0
- package/dist/loaders/index.js +3 -0
- package/dist/loaders/loader.d.ts +14 -0
- package/dist/loaders/loader.js +17 -0
- package/dist/loaders/replaceable-loader.d.ts +28 -0
- package/dist/loaders/replaceable-loader.js +146 -0
- package/dist/loaders/single-relay-replaceable-loader.d.ts +14 -0
- package/dist/loaders/single-relay-replaceable-loader.js +50 -0
- package/dist/operators/address-pointers-request.d.ts +5 -0
- package/dist/operators/address-pointers-request.js +27 -0
- package/dist/operators/generator-sequence.d.ts +3 -0
- package/dist/operators/generator-sequence.js +45 -0
- package/dist/operators/index.d.ts +4 -0
- package/dist/operators/index.js +4 -0
- package/dist/operators/max-filters.d.ts +4 -0
- package/dist/operators/max-filters.js +8 -0
- package/dist/operators/relay-request.d.ts +4 -0
- package/dist/operators/relay-request.js +9 -0
- package/package.json +70 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
The MIT License (MIT)
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 hzrd149
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# applesauce-loaders
|
|
2
|
+
|
|
3
|
+
A collection of observable based loaders built on top of [rx-nostr](https://penpenpng.github.io/rx-nostr/)
|
|
4
|
+
|
|
5
|
+
## Replaceable event loader
|
|
6
|
+
|
|
7
|
+
The `ReplaceableLoader` class can be used to load profiles (kind 0), contact lists (kind 3), and any other replaceable (1xxxx) or parameterized replaceable event (3xxxx)
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
import { EventStore } from "applesauce-core";
|
|
11
|
+
import { ReplaceableLoader } from "applesauce-loaders/loaders";
|
|
12
|
+
import { createRxNostr, nip07Signer } from "rx-nostr";
|
|
13
|
+
import { verifier } from "rx-nostr-crypto";
|
|
14
|
+
|
|
15
|
+
export const eventStore = new EventStore();
|
|
16
|
+
|
|
17
|
+
export const rxNostr = createRxNostr({
|
|
18
|
+
verifier,
|
|
19
|
+
signer: nip07Signer(),
|
|
20
|
+
connectionStrategy: "lazy-keep",
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
const replaceableLoader = new ReplaceableLoader(rxNostr, {
|
|
24
|
+
bufferTime: 1000,
|
|
25
|
+
// cache relays will always be checked first
|
|
26
|
+
cacheRelays: ["ws://localhost:4869/"],
|
|
27
|
+
// lookup relays are used as a fallback if the event cant be found
|
|
28
|
+
lookupRelays: ["wss://purplepag.es/"],
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
// start the loader by subscribing to it
|
|
32
|
+
replaceableLoader.subscribe((packet) => {
|
|
33
|
+
// send all loaded events to the event store
|
|
34
|
+
eventStore.add(packet.event, packet.from);
|
|
35
|
+
});
|
|
36
|
+
|
|
37
|
+
// start loading some replaceable events
|
|
38
|
+
replaceableLoader.next({
|
|
39
|
+
kind: 0,
|
|
40
|
+
pubkey: "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d",
|
|
41
|
+
relays: ["wss://pyramid.fiatjaf.com/"],
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
// load a parameterized replaceable event
|
|
45
|
+
replaceableLoader.next({
|
|
46
|
+
kind: 30000,
|
|
47
|
+
pubkey: "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d",
|
|
48
|
+
identifier: "list of bad people",
|
|
49
|
+
relays: ["wss://pyramid.fiatjaf.com/"],
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
// if no relays are provided only the cache and lookup relays will be checked
|
|
53
|
+
replaceableLoader.next({
|
|
54
|
+
kind: 3,
|
|
55
|
+
pubkey: "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d",
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
// passing a new relay will cause it to be loaded again
|
|
59
|
+
replaceableLoader.next({
|
|
60
|
+
kind: 0,
|
|
61
|
+
pubkey: "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d",
|
|
62
|
+
relays: ["wss://relay.westernbtc.com/"],
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
// or force it to load it again from the same relays
|
|
66
|
+
replaceableLoader.next({
|
|
67
|
+
kind: 0,
|
|
68
|
+
pubkey: "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d",
|
|
69
|
+
relays: ["wss://pyramid.fiatjaf.com/"],
|
|
70
|
+
force: true,
|
|
71
|
+
});
|
|
72
|
+
```
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { AddressPointerWithoutD } from "applesauce-core/helpers";
|
|
2
|
+
import { LazyFilter } from "rx-nostr";
|
|
3
|
+
/** Converts an array of address pointers to a filter */
|
|
4
|
+
export declare function createFilterFromAddressPointers(pointers: AddressPointerWithoutD[]): LazyFilter;
|
|
5
|
+
/** Takes a set of address pointers, groups them, then returns filters for the groups */
|
|
6
|
+
export declare function createFiltersFromAddressPointers(pointers: AddressPointerWithoutD[]): LazyFilter[];
|
|
7
|
+
/** Checks if a relay will understand an address pointer */
|
|
8
|
+
export declare function isLoadableAddressPointer<T extends AddressPointerWithoutD>(pointer: T): boolean;
|
|
9
|
+
/** Group an array of address pointers by kind */
|
|
10
|
+
export declare function groupAddressPointersByKind(pointers: AddressPointerWithoutD[]): Map<number, AddressPointerWithoutD[]>;
|
|
11
|
+
/** Group an array of address pointers by pubkey */
|
|
12
|
+
export declare function groupAddressPointersByPubkey(pointers: AddressPointerWithoutD[]): Map<string, AddressPointerWithoutD[]>;
|
|
13
|
+
/** Groups address pointers by kind or pubkey depending on which is most optimal */
|
|
14
|
+
export declare function groupAddressPointersByPubkeyOrKind(pointers: AddressPointerWithoutD[]): Map<number, AddressPointerWithoutD[]> | Map<string, AddressPointerWithoutD[]>;
|
|
15
|
+
export declare function getRelaysFromPointers(pointers: AddressPointerWithoutD[]): Set<string>;
|
|
16
|
+
export declare function getAddressPointerId<T extends AddressPointerWithoutD>(pointer: T): string;
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
import { getReplaceableUID } from "applesauce-core/helpers";
|
|
2
|
+
import { isParameterizedReplaceableKind, isReplaceableKind } from "nostr-tools/kinds";
|
|
3
|
+
import { unique } from "./array.js";
|
|
4
|
+
/** Converts an array of address pointers to a filter */
|
|
5
|
+
export function createFilterFromAddressPointers(pointers) {
|
|
6
|
+
const filter = {};
|
|
7
|
+
filter.kinds = unique(pointers.map((p) => p.kind));
|
|
8
|
+
filter.authors = unique(pointers.map((p) => p.pubkey));
|
|
9
|
+
const identifiers = unique(pointers.map((p) => p.identifier).filter((d) => !!d));
|
|
10
|
+
if (identifiers.length > 0)
|
|
11
|
+
filter["#d"] = identifiers;
|
|
12
|
+
return filter;
|
|
13
|
+
}
|
|
14
|
+
/** Takes a set of address pointers, groups them, then returns filters for the groups */
|
|
15
|
+
export function createFiltersFromAddressPointers(pointers) {
|
|
16
|
+
const groups = groupAddressPointersByPubkeyOrKind(pointers);
|
|
17
|
+
return Array.from(groups.values()).map((pointers) => createFilterFromAddressPointers(pointers));
|
|
18
|
+
}
|
|
19
|
+
/** Checks if a relay will understand an address pointer */
|
|
20
|
+
export function isLoadableAddressPointer(pointer) {
|
|
21
|
+
if (isParameterizedReplaceableKind(pointer.kind))
|
|
22
|
+
return !!pointer.identifier;
|
|
23
|
+
else
|
|
24
|
+
return isReplaceableKind(pointer.kind);
|
|
25
|
+
}
|
|
26
|
+
/** Group an array of address pointers by kind */
|
|
27
|
+
export function groupAddressPointersByKind(pointers) {
|
|
28
|
+
const byKind = new Map();
|
|
29
|
+
for (const pointer of pointers) {
|
|
30
|
+
if (byKind.has(pointer.kind))
|
|
31
|
+
byKind.get(pointer.kind).push(pointer);
|
|
32
|
+
else
|
|
33
|
+
byKind.set(pointer.kind, [pointer]);
|
|
34
|
+
}
|
|
35
|
+
return byKind;
|
|
36
|
+
}
|
|
37
|
+
/** Group an array of address pointers by pubkey */
|
|
38
|
+
export function groupAddressPointersByPubkey(pointers) {
|
|
39
|
+
const byPubkey = new Map();
|
|
40
|
+
for (const pointer of pointers) {
|
|
41
|
+
if (byPubkey.has(pointer.pubkey))
|
|
42
|
+
byPubkey.get(pointer.pubkey).push(pointer);
|
|
43
|
+
else
|
|
44
|
+
byPubkey.set(pointer.pubkey, [pointer]);
|
|
45
|
+
}
|
|
46
|
+
return byPubkey;
|
|
47
|
+
}
|
|
48
|
+
/** Groups address pointers by kind or pubkey depending on which is most optimal */
|
|
49
|
+
export function groupAddressPointersByPubkeyOrKind(pointers) {
|
|
50
|
+
const kinds = new Set(pointers.map((p) => p.kind));
|
|
51
|
+
const pubkeys = new Set(pointers.map((p) => p.pubkey));
|
|
52
|
+
return pubkeys.size > kinds.size ? groupAddressPointersByKind(pointers) : groupAddressPointersByPubkey(pointers);
|
|
53
|
+
}
|
|
54
|
+
export function getRelaysFromPointers(pointers) {
|
|
55
|
+
const relays = new Set();
|
|
56
|
+
for (const pointer of pointers) {
|
|
57
|
+
if (!pointer.relays)
|
|
58
|
+
continue;
|
|
59
|
+
for (const relay of pointer.relays) {
|
|
60
|
+
relays.add(relay);
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
return relays;
|
|
64
|
+
}
|
|
65
|
+
export function getAddressPointerId(pointer) {
|
|
66
|
+
return getReplaceableUID(pointer.kind, pointer.pubkey, pointer.identifier);
|
|
67
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/** Does not preserve order */
|
|
2
|
+
export function unique(arr) {
|
|
3
|
+
return Array.from(new Set(arr));
|
|
4
|
+
}
|
|
5
|
+
/** split array into a set of arrays no larger than batchSize */
|
|
6
|
+
export function reduceToBatches(arr, batchSize) {
|
|
7
|
+
const batches = [];
|
|
8
|
+
for (const value of arr) {
|
|
9
|
+
if (batches.length === 0) {
|
|
10
|
+
batches.push([value]);
|
|
11
|
+
continue;
|
|
12
|
+
}
|
|
13
|
+
const current = batches[batches.length - 1];
|
|
14
|
+
if (current.length <= batchSize) {
|
|
15
|
+
current.push(value);
|
|
16
|
+
}
|
|
17
|
+
else
|
|
18
|
+
batches.push([value]);
|
|
19
|
+
}
|
|
20
|
+
return batches;
|
|
21
|
+
}
|
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { Observable, OperatorFunction, Subject, Subscribable } from "rxjs";
|
|
2
|
+
export interface ILoader<T, R> extends Subscribable<R> {
|
|
3
|
+
next: (value: T) => void;
|
|
4
|
+
pipe: Observable<R>["pipe"];
|
|
5
|
+
}
|
|
6
|
+
/** Base loader class */
|
|
7
|
+
export declare class Loader<T, R> implements ILoader<T, R> {
|
|
8
|
+
protected subject: Subject<T>;
|
|
9
|
+
protected observable: Observable<R>;
|
|
10
|
+
pipe: Observable<R>["pipe"];
|
|
11
|
+
subscribe: Observable<R>["subscribe"];
|
|
12
|
+
constructor(transform: OperatorFunction<T, R>);
|
|
13
|
+
next(value: T): void;
|
|
14
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { Subject } from "rxjs";
|
|
2
|
+
/** Base loader class */
|
|
3
|
+
export class Loader {
|
|
4
|
+
subject = new Subject();
|
|
5
|
+
observable;
|
|
6
|
+
pipe;
|
|
7
|
+
subscribe;
|
|
8
|
+
constructor(transform) {
|
|
9
|
+
this.observable = this.subject.pipe(transform);
|
|
10
|
+
// copy pipe function
|
|
11
|
+
this.pipe = this.observable.pipe.bind(this.observable);
|
|
12
|
+
this.subscribe = this.observable.subscribe.bind(this.observable);
|
|
13
|
+
}
|
|
14
|
+
next(value) {
|
|
15
|
+
this.subject.next(value);
|
|
16
|
+
}
|
|
17
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { EventPacket, RxNostr } from "rx-nostr";
|
|
2
|
+
import { logger } from "applesauce-core";
|
|
3
|
+
import { Loader } from "./loader.js";
|
|
4
|
+
export type LoadableAddressPointer = {
|
|
5
|
+
kind: number;
|
|
6
|
+
pubkey: string;
|
|
7
|
+
/** Optional "d" tag for paramaritized replaceable */
|
|
8
|
+
identifier?: string;
|
|
9
|
+
/** Relays to load from */
|
|
10
|
+
relays?: string[];
|
|
11
|
+
/** Load this address pointer even if it has already been loaded */
|
|
12
|
+
force?: boolean;
|
|
13
|
+
};
|
|
14
|
+
export type ReplaceableLoaderOptions = {
|
|
15
|
+
/**
|
|
16
|
+
* Time interval to buffer requests in ms
|
|
17
|
+
* @default 1000
|
|
18
|
+
*/
|
|
19
|
+
bufferTime?: number;
|
|
20
|
+
/** The cache relays to check first */
|
|
21
|
+
cacheRelays?: string[];
|
|
22
|
+
/** Fallback lookup relays to check when event cant be found */
|
|
23
|
+
lookupRelays?: string[];
|
|
24
|
+
};
|
|
25
|
+
export declare class ReplaceableLoader extends Loader<LoadableAddressPointer, EventPacket> {
|
|
26
|
+
log: typeof logger;
|
|
27
|
+
constructor(rxNostr: RxNostr, opts?: ReplaceableLoaderOptions);
|
|
28
|
+
}
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
import { share, tap, from, filter, bufferTime, map } from "rxjs";
|
|
2
|
+
import { getEventUID, getReplaceableUID, markFromCache } from "applesauce-core/helpers";
|
|
3
|
+
import { logger } from "applesauce-core";
|
|
4
|
+
import { nanoid } from "nanoid";
|
|
5
|
+
import { Loader } from "./loader.js";
|
|
6
|
+
import { generatorSequence } from "../operators/generator-sequence.js";
|
|
7
|
+
import { replaceableRequest } from "../operators/address-pointers-request.js";
|
|
8
|
+
import { getAddressPointerId, getRelaysFromPointers, isLoadableAddressPointer } from "../helpers/address-pointer.js";
|
|
9
|
+
import { unique } from "../helpers/array.js";
|
|
10
|
+
/** deep clone a loadable pointer to ensure its safe to modify */
|
|
11
|
+
function cloneLoadablePointer(pointer) {
|
|
12
|
+
const clone = { ...pointer };
|
|
13
|
+
if (pointer.relays)
|
|
14
|
+
clone.relays = [...pointer.relays];
|
|
15
|
+
return clone;
|
|
16
|
+
}
|
|
17
|
+
/** A generator that tries to load the address pointers from the cache first, then tries the relays */
|
|
18
|
+
function* cacheFirstSequence(rxNostr, pointers, log, opts) {
|
|
19
|
+
const id = nanoid(8);
|
|
20
|
+
log = log.extend(id);
|
|
21
|
+
let remaining = Array.from(pointers);
|
|
22
|
+
const pointerRelays = Array.from(getRelaysFromPointers(pointers));
|
|
23
|
+
// handle previous step results and decide if to exit
|
|
24
|
+
const handleResults = (results) => {
|
|
25
|
+
if (results.length) {
|
|
26
|
+
const coordinates = new Set(results.map((p) => getEventUID(p.event)));
|
|
27
|
+
// if there where results, filter out any pointers that where found
|
|
28
|
+
remaining = remaining.filter((pointer) => {
|
|
29
|
+
const found = coordinates.has(getReplaceableUID(pointer.kind, pointer.pubkey, pointer.identifier));
|
|
30
|
+
if (found && pointer.force !== true)
|
|
31
|
+
return false;
|
|
32
|
+
else
|
|
33
|
+
return true;
|
|
34
|
+
});
|
|
35
|
+
if (remaining.length === 0)
|
|
36
|
+
return true;
|
|
37
|
+
}
|
|
38
|
+
return false;
|
|
39
|
+
};
|
|
40
|
+
// first attempt, load from cache relays
|
|
41
|
+
if (opts?.cacheRelays && opts?.cacheRelays.length > 0) {
|
|
42
|
+
log(`Checking cache`, opts.cacheRelays, remaining);
|
|
43
|
+
const results = yield from([remaining]).pipe(replaceableRequest(rxNostr, opts.cacheRelays, id),
|
|
44
|
+
// mark the event as from the cache
|
|
45
|
+
tap((p) => markFromCache(p.event)));
|
|
46
|
+
if (handleResults(results))
|
|
47
|
+
return;
|
|
48
|
+
}
|
|
49
|
+
// finished loading from the cache, load from pointer relays
|
|
50
|
+
if (pointerRelays.length > 0) {
|
|
51
|
+
log(`Requesting`, pointerRelays, remaining);
|
|
52
|
+
const results = yield from([remaining]).pipe(replaceableRequest(rxNostr, pointerRelays, id));
|
|
53
|
+
if (handleResults(results))
|
|
54
|
+
return;
|
|
55
|
+
}
|
|
56
|
+
// finally load from lookup relays
|
|
57
|
+
if (opts?.lookupRelays) {
|
|
58
|
+
// make sure we aren't asking a relay twice
|
|
59
|
+
const relays = opts.lookupRelays.filter((r) => !pointerRelays.includes(r));
|
|
60
|
+
if (relays.length > 0) {
|
|
61
|
+
log(`Request from lookup`, relays, remaining);
|
|
62
|
+
const results = yield from([remaining]).pipe(replaceableRequest(rxNostr, relays, id));
|
|
63
|
+
if (handleResults(results))
|
|
64
|
+
return;
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
/** Batches address pointers and consolidates them */
|
|
69
|
+
function multiRelayBatcher(buffer) {
|
|
70
|
+
return (source) => source.pipe(
|
|
71
|
+
// buffer on time
|
|
72
|
+
bufferTime(buffer),
|
|
73
|
+
// ignore empty buffers
|
|
74
|
+
filter((buffer) => buffer.length > 0),
|
|
75
|
+
// consolidate buffered pointers
|
|
76
|
+
map((pointers) => {
|
|
77
|
+
const byId = new Map();
|
|
78
|
+
for (const pointer of pointers) {
|
|
79
|
+
const id = getAddressPointerId(pointer);
|
|
80
|
+
if (byId.has(id)) {
|
|
81
|
+
// duplicate, merge pointers
|
|
82
|
+
const current = byId.get(id);
|
|
83
|
+
// merge relays
|
|
84
|
+
if (pointer.relays) {
|
|
85
|
+
if (current.relays)
|
|
86
|
+
current.relays = unique([...current.relays, ...pointer.relays]);
|
|
87
|
+
else
|
|
88
|
+
current.relays = pointer.relays;
|
|
89
|
+
}
|
|
90
|
+
// merge force flag
|
|
91
|
+
if (pointer.force !== undefined) {
|
|
92
|
+
current.force = current.force || pointer.force;
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
else
|
|
96
|
+
byId.set(id, cloneLoadablePointer(pointer));
|
|
97
|
+
}
|
|
98
|
+
// return consolidated pointers
|
|
99
|
+
return Array.from(byId.values());
|
|
100
|
+
}),
|
|
101
|
+
// ignore empty buffer
|
|
102
|
+
filter((buffer) => buffer.length > 0),
|
|
103
|
+
// ensure pointers are only requested from each relay once
|
|
104
|
+
map((pointers) => {
|
|
105
|
+
const requestedFrom = new Map();
|
|
106
|
+
return pointers.filter((pointer) => {
|
|
107
|
+
// if this pointer does not have any relays or is forced, skip
|
|
108
|
+
if (!pointer.relays)
|
|
109
|
+
return true;
|
|
110
|
+
if (pointer.force)
|
|
111
|
+
return true;
|
|
112
|
+
const id = getAddressPointerId(pointer);
|
|
113
|
+
let set = requestedFrom.get(id);
|
|
114
|
+
if (!set) {
|
|
115
|
+
set = new Set();
|
|
116
|
+
requestedFrom.set(id, set);
|
|
117
|
+
}
|
|
118
|
+
// remove any relays that have already been used
|
|
119
|
+
pointer.relays = pointer.relays.filter((relay) => !set.has(relay));
|
|
120
|
+
// remember used relays
|
|
121
|
+
for (const relay of pointer.relays)
|
|
122
|
+
set.add(relay);
|
|
123
|
+
// if there are no new relays, ignore pointer
|
|
124
|
+
return pointer.relays.length > 0;
|
|
125
|
+
});
|
|
126
|
+
}),
|
|
127
|
+
// ignore empty buffer
|
|
128
|
+
filter((buffer) => buffer.length > 0));
|
|
129
|
+
}
|
|
130
|
+
export class ReplaceableLoader extends Loader {
|
|
131
|
+
log = logger.extend("ReplaceableLoader");
|
|
132
|
+
constructor(rxNostr, opts) {
|
|
133
|
+
super((source) => {
|
|
134
|
+
return source.pipe(
|
|
135
|
+
// filter out invalid pointers
|
|
136
|
+
filter(isLoadableAddressPointer),
|
|
137
|
+
// TODO: needs a new batching method that takes the multiple relays (and force) into account
|
|
138
|
+
// batch and filter
|
|
139
|
+
multiRelayBatcher(opts?.bufferTime ?? 1000),
|
|
140
|
+
// check cache, relays, lookup relays in that order
|
|
141
|
+
generatorSequence((pointers) => cacheFirstSequence(rxNostr, pointers, this.log, opts)),
|
|
142
|
+
// share the response with all subscribers
|
|
143
|
+
share());
|
|
144
|
+
});
|
|
145
|
+
}
|
|
146
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { EventPacket, RxNostr } from "rx-nostr";
|
|
2
|
+
import { Loader } from "./loader.js";
|
|
3
|
+
import { LoadableAddressPointer } from "./replaceable-loader.js";
|
|
4
|
+
export type SingleRelayReplaceableOptions = Partial<{
|
|
5
|
+
/**
|
|
6
|
+
* Wait X ms before making a request
|
|
7
|
+
* @default 1000
|
|
8
|
+
*/
|
|
9
|
+
bufferTime: number;
|
|
10
|
+
}>;
|
|
11
|
+
/** A wrapper class around {@link singleRelayBatcher'}, {@link replaceableRequest}, and share */
|
|
12
|
+
export declare class SingleRelayReplaceableLoader extends Loader<LoadableAddressPointer, EventPacket> {
|
|
13
|
+
constructor(rxNostr: RxNostr, relay: string, opts?: SingleRelayReplaceableOptions);
|
|
14
|
+
}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import { bufferTime, filter, from, map, mergeMap, share } from "rxjs";
|
|
2
|
+
import { getReplaceableUID } from "applesauce-core/helpers";
|
|
3
|
+
import { Loader } from "./loader.js";
|
|
4
|
+
import { isLoadableAddressPointer } from "../helpers/address-pointer.js";
|
|
5
|
+
import { replaceableRequest } from "../operators/address-pointers-request.js";
|
|
6
|
+
const defaultRelayReplaceableLoaderOptions = {
|
|
7
|
+
bufferTime: 1000,
|
|
8
|
+
};
|
|
9
|
+
/** Ensures an address pointer is only loaded once from a relay */
|
|
10
|
+
function singleRelayBatcher(opts) {
|
|
11
|
+
return (source) => {
|
|
12
|
+
const loaded = new Set();
|
|
13
|
+
const options = opts ? { ...defaultRelayReplaceableLoaderOptions, ...opts } : defaultRelayReplaceableLoaderOptions;
|
|
14
|
+
return source.pipe(
|
|
15
|
+
// buffer the requests, so we only send requests every second
|
|
16
|
+
bufferTime(options.bufferTime),
|
|
17
|
+
// ignore empty batches
|
|
18
|
+
filter((batch) => batch.length > 0),
|
|
19
|
+
// filter out duplicates
|
|
20
|
+
map((batch) => {
|
|
21
|
+
const filtered = [];
|
|
22
|
+
for (const pointer of batch) {
|
|
23
|
+
const uid = getReplaceableUID(pointer.kind, pointer.pubkey, pointer.identifier);
|
|
24
|
+
if (!loaded.has(uid)) {
|
|
25
|
+
filtered.push(pointer);
|
|
26
|
+
loaded.add(uid);
|
|
27
|
+
}
|
|
28
|
+
else if (pointer.force)
|
|
29
|
+
filtered.push(pointer);
|
|
30
|
+
}
|
|
31
|
+
return filtered;
|
|
32
|
+
}),
|
|
33
|
+
// ignore empty batches
|
|
34
|
+
filter((batch) => batch.length > 0));
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
/** A wrapper class around {@link singleRelayBatcher'}, {@link replaceableRequest}, and share */
|
|
38
|
+
export class SingleRelayReplaceableLoader extends Loader {
|
|
39
|
+
constructor(rxNostr, relay, opts) {
|
|
40
|
+
super((source) => source.pipe(
|
|
41
|
+
// ignore invalid address pointers
|
|
42
|
+
filter(isLoadableAddressPointer),
|
|
43
|
+
// batch and filter
|
|
44
|
+
singleRelayBatcher(opts),
|
|
45
|
+
// breakout the batches so they can complete
|
|
46
|
+
mergeMap((pointers) => from([pointers]).pipe(replaceableRequest(rxNostr, [relay]))),
|
|
47
|
+
// share the response with all subscribers
|
|
48
|
+
share()));
|
|
49
|
+
}
|
|
50
|
+
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { EventPacket, RxNostr } from "rx-nostr";
|
|
2
|
+
import { OperatorFunction } from "rxjs";
|
|
3
|
+
import { AddressPointerWithoutD } from "applesauce-core/helpers";
|
|
4
|
+
/** Makes a request to relays for every set of address pointers */
|
|
5
|
+
export declare function replaceableRequest<T extends AddressPointerWithoutD>(rxNostr: RxNostr, relays: string[], id?: string): OperatorFunction<T[], EventPacket>;
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { map, tap } from "rxjs";
|
|
2
|
+
import { nanoid } from "nanoid";
|
|
3
|
+
import { logger } from "applesauce-core";
|
|
4
|
+
import { relaysRequest } from "./relay-request.js";
|
|
5
|
+
import { createFiltersFromAddressPointers } from "../helpers/address-pointer.js";
|
|
6
|
+
/** Makes a request to relays for every set of address pointers */
|
|
7
|
+
export function replaceableRequest(rxNostr, relays, id) {
|
|
8
|
+
return (source) => {
|
|
9
|
+
id = id || nanoid(8);
|
|
10
|
+
const log = logger.extend(`replaceableRequest:${id}`);
|
|
11
|
+
return source.pipe(
|
|
12
|
+
// convert pointers to filters
|
|
13
|
+
map(createFiltersFromAddressPointers),
|
|
14
|
+
// make requests
|
|
15
|
+
tap((filters) => {
|
|
16
|
+
log(`Requesting`, relays, filters);
|
|
17
|
+
}),
|
|
18
|
+
// make requests
|
|
19
|
+
relaysRequest(rxNostr, relays, id),
|
|
20
|
+
// log when complete
|
|
21
|
+
tap({
|
|
22
|
+
complete: () => {
|
|
23
|
+
log(`Complete`);
|
|
24
|
+
},
|
|
25
|
+
}));
|
|
26
|
+
};
|
|
27
|
+
}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import { Observable } from "rxjs";
|
|
2
|
+
/** Keeps retrying a value until the generator returns */
|
|
3
|
+
export function generatorSequence(createGenerator) {
|
|
4
|
+
return (source) => {
|
|
5
|
+
return new Observable((observer) => {
|
|
6
|
+
let complete = false;
|
|
7
|
+
const sub = source.subscribe({
|
|
8
|
+
next: (value) => {
|
|
9
|
+
const generator = createGenerator(value);
|
|
10
|
+
const next = (prevResults) => {
|
|
11
|
+
const result = generator.next(prevResults);
|
|
12
|
+
// generator complete, exit
|
|
13
|
+
if (result.done)
|
|
14
|
+
return;
|
|
15
|
+
const results = [];
|
|
16
|
+
result.value.subscribe({
|
|
17
|
+
next: (v) => {
|
|
18
|
+
// track results and pass along values
|
|
19
|
+
results.push(v);
|
|
20
|
+
observer.next(v);
|
|
21
|
+
},
|
|
22
|
+
error: (err) => {
|
|
23
|
+
observer.error(err);
|
|
24
|
+
},
|
|
25
|
+
complete: () => {
|
|
26
|
+
// if the upstream observable was complete. exit
|
|
27
|
+
if (complete)
|
|
28
|
+
return observer.complete();
|
|
29
|
+
// run next step
|
|
30
|
+
next(results);
|
|
31
|
+
},
|
|
32
|
+
});
|
|
33
|
+
};
|
|
34
|
+
// start running steps
|
|
35
|
+
next();
|
|
36
|
+
},
|
|
37
|
+
complete: () => {
|
|
38
|
+
// source is complete
|
|
39
|
+
complete = true;
|
|
40
|
+
},
|
|
41
|
+
});
|
|
42
|
+
return () => sub.unsubscribe();
|
|
43
|
+
});
|
|
44
|
+
};
|
|
45
|
+
}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { LazyFilter } from "rx-nostr";
|
|
2
|
+
import { OperatorFunction } from "rxjs";
|
|
3
|
+
/** Splits a batch of filters into multiple requests if necessary */
|
|
4
|
+
export declare function splitMaxFiltersPerRequest(maxFiltersPerRequest: number): OperatorFunction<LazyFilter[], LazyFilter[]>;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { mergeMap } from "rxjs";
|
|
2
|
+
import { reduceToBatches } from "../helpers/array.js";
|
|
3
|
+
/** Splits a batch of filters into multiple requests if necessary */
|
|
4
|
+
export function splitMaxFiltersPerRequest(maxFiltersPerRequest) {
|
|
5
|
+
return (source) => source.pipe(
|
|
6
|
+
// batch the filters into sets no larger than maxFiltersPerRequest
|
|
7
|
+
mergeMap((filters) => reduceToBatches(filters, maxFiltersPerRequest)));
|
|
8
|
+
}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { EventPacket, LazyFilter, RxNostr } from "rx-nostr";
|
|
2
|
+
import { OperatorFunction } from "rxjs";
|
|
3
|
+
/** Makes a request to relays for every set of filters */
|
|
4
|
+
export declare function relaysRequest(rxNostr: RxNostr, relays: string[], id?: string): OperatorFunction<LazyFilter | LazyFilter[], EventPacket>;
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { createRxOneshotReq } from "rx-nostr";
|
|
2
|
+
import { map, mergeAll } from "rxjs";
|
|
3
|
+
/** Makes a request to relays for every set of filters */
|
|
4
|
+
export function relaysRequest(rxNostr, relays, id) {
|
|
5
|
+
return (source) => source.pipe(map((filters) => {
|
|
6
|
+
const req = createRxOneshotReq({ filters, rxReqId: id });
|
|
7
|
+
return rxNostr.use(req, { on: { relays } });
|
|
8
|
+
}), mergeAll());
|
|
9
|
+
}
|
package/package.json
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "applesauce-loaders",
|
|
3
|
+
"version": "0.0.0-next-20241207161834",
|
|
4
|
+
"description": "A collection of observable based loaders built on rx-nostr",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "dist/index.js",
|
|
7
|
+
"types": "dist/index.d.ts",
|
|
8
|
+
"keywords": [
|
|
9
|
+
"nostr"
|
|
10
|
+
],
|
|
11
|
+
"author": "hzrd149",
|
|
12
|
+
"license": "MIT",
|
|
13
|
+
"files": [
|
|
14
|
+
"dist"
|
|
15
|
+
],
|
|
16
|
+
"exports": {
|
|
17
|
+
".": {
|
|
18
|
+
"import": "./dist/index.js",
|
|
19
|
+
"types": "./dist/index.d.ts"
|
|
20
|
+
},
|
|
21
|
+
"./loaders": {
|
|
22
|
+
"import": "./dist/loaders/index.js",
|
|
23
|
+
"types": "./dist/loaders/index.d.ts"
|
|
24
|
+
},
|
|
25
|
+
"./loaders/*": {
|
|
26
|
+
"import": "./dist/loaders/*.js",
|
|
27
|
+
"types": "./dist/loaders/*.d.ts"
|
|
28
|
+
},
|
|
29
|
+
"./operators": {
|
|
30
|
+
"import": "./dist/operators/index.js",
|
|
31
|
+
"types": "./dist/operators/index.d.ts"
|
|
32
|
+
},
|
|
33
|
+
"./operators/*": {
|
|
34
|
+
"import": "./dist/operators/*.js",
|
|
35
|
+
"types": "./dist/operators/*.d.ts"
|
|
36
|
+
}
|
|
37
|
+
},
|
|
38
|
+
"dependencies": {
|
|
39
|
+
"applesauce-core": "0.0.0-next-20241207161834",
|
|
40
|
+
"nanoid": "^5.0.9",
|
|
41
|
+
"nostr-tools": "^2.10.3",
|
|
42
|
+
"rx-nostr": "^3.4.1",
|
|
43
|
+
"rxjs": "^7.8.1"
|
|
44
|
+
},
|
|
45
|
+
"devDependencies": {
|
|
46
|
+
"@jest/globals": "^29.7.0",
|
|
47
|
+
"@types/jest": "^29.5.13",
|
|
48
|
+
"jest": "^29.7.0",
|
|
49
|
+
"jest-extended": "^4.0.2",
|
|
50
|
+
"typescript": "^5.6.3"
|
|
51
|
+
},
|
|
52
|
+
"jest": {
|
|
53
|
+
"roots": [
|
|
54
|
+
"dist"
|
|
55
|
+
],
|
|
56
|
+
"setupFilesAfterEnv": [
|
|
57
|
+
"jest-extended/all"
|
|
58
|
+
]
|
|
59
|
+
},
|
|
60
|
+
"funding": {
|
|
61
|
+
"type": "lightning",
|
|
62
|
+
"url": "lightning:nostrudel@geyser.fund"
|
|
63
|
+
},
|
|
64
|
+
"scripts": {
|
|
65
|
+
"build": "tsc",
|
|
66
|
+
"watch:build": "tsc --watch > /dev/null",
|
|
67
|
+
"test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --passWithNoTests",
|
|
68
|
+
"watch:test": "(trap 'kill 0' SIGINT; pnpm run build -w > /dev/null & pnpm run test --watch)"
|
|
69
|
+
}
|
|
70
|
+
}
|