ditto/src/client.ts

183 lines
5.1 KiB
TypeScript
Raw Normal View History

2023-05-07 17:59:55 +00:00
import { Author, findReplyTag, matchFilter, RelayPool, TTLCache } from '@/deps.ts';
2023-04-29 20:49:22 +00:00
import { type Event, type SignedEvent } from '@/event.ts';
2023-03-05 04:10:56 +00:00
2023-05-07 17:59:55 +00:00
import { poolRelays, publishRelays } from './config.ts';
2023-03-05 04:10:56 +00:00
2023-03-18 23:09:16 +00:00
import { eventDateComparator, nostrNow } from './utils.ts';
2023-03-05 04:10:56 +00:00
2023-05-04 03:15:18 +00:00
const db = await Deno.openKv();
2023-05-07 17:59:55 +00:00
type Pool = InstanceType<typeof RelayPool>;
/** HACK: Websockets in Deno are finnicky... get a new pool every 30 minutes. */
const poolCache = new TTLCache<0, Pool>({
ttl: 30 * 60 * 1000,
max: 2,
dispose: (pool) => {
console.log('Closing pool.');
pool.close();
},
});
function getPool(): Pool {
const cached = poolCache.get(0);
if (cached !== undefined) return cached;
console.log('Creating new pool.');
const pool = new RelayPool(poolRelays);
poolCache.set(0, pool);
return pool;
}
2023-03-05 04:10:56 +00:00
type Filter<K extends number = number> = {
ids?: string[];
kinds?: K[];
authors?: string[];
since?: number;
until?: number;
limit?: number;
search?: string;
[key: `#${string}`]: string[];
};
interface GetFilterOpts {
timeout?: number;
}
2023-04-30 01:23:51 +00:00
/** Get events from a NIP-01 filter. */
function getFilter<K extends number>(filter: Filter<K>, opts: GetFilterOpts = {}): Promise<SignedEvent<K>[]> {
2023-04-30 01:23:51 +00:00
return new Promise((resolve) => {
let tid: number;
2023-04-30 01:23:51 +00:00
const results: SignedEvent[] = [];
2023-05-07 17:59:55 +00:00
const unsub = getPool().subscribe(
2023-04-30 01:23:51 +00:00
[filter],
poolRelays,
(event: SignedEvent | null) => {
if (event && matchFilter(filter, event)) {
results.push({
id: event.id,
kind: event.kind,
pubkey: event.pubkey,
content: event.content,
tags: event.tags,
created_at: event.created_at,
sig: event.sig,
});
2023-04-30 01:23:51 +00:00
}
if (filter.limit && results.length >= filter.limit) {
unsub();
clearTimeout(tid);
resolve(results as SignedEvent<K>[]);
}
2023-04-30 01:23:51 +00:00
},
undefined,
() => {
unsub();
clearTimeout(tid);
resolve(results as SignedEvent<K>[]);
},
2023-04-30 01:23:51 +00:00
);
if (typeof opts.timeout === 'number') {
tid = setTimeout(() => {
unsub();
resolve(results as SignedEvent<K>[]);
}, opts.timeout);
}
2023-04-30 01:23:51 +00:00
});
}
2023-04-29 20:54:21 +00:00
/** Get a Nostr event by its ID. */
2023-04-30 01:23:51 +00:00
const getEvent = async <K extends number = number>(id: string, kind?: K): Promise<SignedEvent<K> | undefined> => {
2023-05-07 17:59:55 +00:00
const event = await (getPool().getEventById(id, poolRelays, 0) as Promise<SignedEvent>);
2023-04-30 01:23:51 +00:00
if (event) {
if (event.id !== id) return undefined;
if (kind && event.kind !== kind) return undefined;
return event as SignedEvent<K>;
}
2023-03-05 04:10:56 +00:00
};
2023-04-29 20:54:21 +00:00
/** Get a Nostr `set_medatadata` event for a user's pubkey. */
2023-04-29 22:49:03 +00:00
const getAuthor = async (pubkey: string): Promise<SignedEvent<0> | undefined> => {
2023-05-07 17:59:55 +00:00
const author = new Author(getPool(), poolRelays, pubkey);
2023-03-18 19:49:44 +00:00
const event: SignedEvent<0> | null = await new Promise((resolve) => author.metaData(resolve, 0));
2023-04-29 22:49:03 +00:00
return event?.pubkey === pubkey ? event : undefined;
2023-03-05 04:10:56 +00:00
};
2023-04-29 20:54:21 +00:00
/** Get users the given pubkey follows. */
const getFollows = async (pubkey: string): Promise<SignedEvent<3> | undefined> => {
2023-05-04 02:53:36 +00:00
const [event] = await getFilter({ authors: [pubkey], kinds: [3] }, { timeout: 5000 });
2023-05-04 03:15:18 +00:00
2023-05-07 17:59:55 +00:00
// TODO: figure out a better, more generic & flexible way to handle event cache (and timeouts?)
2023-05-04 03:15:18 +00:00
// Prewarm cache in GET `/api/v1/accounts/verify_credentials`
if (event) {
await db.set(['event3', pubkey], event);
return event;
} else {
return (await db.get<SignedEvent<3>>(['event3', pubkey])).value || undefined;
}
2023-03-05 04:10:56 +00:00
};
interface PaginationParams {
since?: number;
until?: number;
limit?: number;
}
2023-04-29 20:54:21 +00:00
/** Get events from people the user follows. */
async function getFeed(event3: Event<3>, params: PaginationParams = {}): Promise<SignedEvent<1>[]> {
2023-03-18 23:09:16 +00:00
const limit = Math.max(params.limit ?? 20, 40);
const authors = event3.tags
.filter((tag) => tag[0] === 'p')
.map((tag) => tag[1]);
authors.push(event3.pubkey); // see own events in feed
2023-03-18 19:49:44 +00:00
const filter: Filter = {
authors,
kinds: [1],
since: params.since,
until: params.until ?? nostrNow(),
limit,
};
const results = await getFilter(filter, { timeout: 5000 }) as SignedEvent<1>[];
return results.sort(eventDateComparator);
2023-03-18 19:49:44 +00:00
}
2023-04-30 01:23:51 +00:00
async function getAncestors(event: Event<1>, result = [] as Event<1>[]): Promise<Event<1>[]> {
if (result.length < 100) {
2023-04-30 01:33:52 +00:00
const replyTag = findReplyTag(event);
2023-04-30 01:23:51 +00:00
const inReplyTo = replyTag ? replyTag[1] : undefined;
if (inReplyTo) {
const parentEvent = await getEvent(inReplyTo, 1);
if (parentEvent) {
result.push(parentEvent);
return getAncestors(parentEvent, result);
}
}
}
return result.reverse();
}
function getDescendants(eventId: string): Promise<SignedEvent<1>[]> {
return getFilter({ kinds: [1], '#e': [eventId], limit: 200 }, { timeout: 2000 }) as Promise<SignedEvent<1>[]>;
2023-04-30 01:23:51 +00:00
}
2023-05-07 17:59:55 +00:00
/** Publish an event to the Nostr relay. */
function publish(event: SignedEvent, relays = publishRelays): void {
console.log('Publishing event', event);
try {
getPool().publish(event, relays);
} catch (e) {
console.error(e);
}
}
export { getAncestors, getAuthor, getDescendants, getEvent, getFeed, getFilter, getFollows, publish };