I'm building a ground-up Nostr websockets library in TypeScript. It's a collection of low-level tiny modules that each do one thing well, as well as a few opinionated modules like NiceRelay and Firehose that combine the pieces into something usable out of the box. Some of the pieces include:
AsyncSocket: get WebSocket messages as a generator, async "send" function that just works.
Relay: low-level websocket wrapper that deals with client-relay messages directly and doesn't care about subscriptions.
Pubsub: data store for managing REQ subscriptions (but it's actually just a general-purpose topics pubsub).
Machina: converts event emitters into async generators.
Reanimator: revives disconnected websockets and triggers a callback.
NiceRelay: keeps a Relay instance internally, revives the socket if dead, provides messages as an async iterator, stores and manages subscriptions, async "send" with a parsed NIP-20 response.
There are problems with existing libraries. For instance, most libraries manage subscriptions in the Relay module itself. Then the Pool shoehorns in an array of Relay instances. This is problematic because the Pool itself wants to manage the subscriptions. By breaking it into smaller parts, we can make the Pool work better, and we can even create opinionated Pool implementations like a Firehose, which can resume subscriptions for newly added relays.
I'll host the code and put up a link today. In case you're wondering what I've been up to on Ditto, this library will solve problems I'm having on both the client and relay side.
Alex Gleason /
npub108…uyev6
2023-10-02 14:54:52
Author Public Key
npub108pv4cg5ag52nq082kd5leu9ffrn2gdg6g4xdwatn73y36uzplmq9uyev6Published at
2023-10-02 14:54:52Event JSON
{
"id": "17ad524358686a4a79920a208d253a8e629748810f2937cc939d1c732326581d",
"pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6",
"created_at": 1696258492,
"kind": 1,
"tags": [
[
"proxy",
"https://gleasonator.com/objects/be104502-aad7-4255-bc71-484b074a593e",
"activitypub"
]
],
"content": "I'm building a ground-up Nostr websockets library in TypeScript. It's a collection of low-level tiny modules that each do one thing well, as well as a few opinionated modules like NiceRelay and Firehose that combine the pieces into something usable out of the box. Some of the pieces include: \n\nAsyncSocket: get WebSocket messages as a generator, async \"send\" function that just works.\n\nRelay: low-level websocket wrapper that deals with client-relay messages directly and doesn't care about subscriptions.\n\nPubsub: data store for managing REQ subscriptions (but it's actually just a general-purpose topics pubsub).\n\nMachina: converts event emitters into async generators.\n\nReanimator: revives disconnected websockets and triggers a callback.\n\nNiceRelay: keeps a Relay instance internally, revives the socket if dead, provides messages as an async iterator, stores and manages subscriptions, async \"send\" with a parsed NIP-20 response.\n\nThere are problems with existing libraries. For instance, most libraries manage subscriptions in the Relay module itself. Then the Pool shoehorns in an array of Relay instances. This is problematic because the Pool itself wants to manage the subscriptions. By breaking it into smaller parts, we can make the Pool work better, and we can even create opinionated Pool implementations like a Firehose, which can resume subscriptions for newly added relays.\n\nI'll host the code and put up a link today. In case you're wondering what I've been up to on Ditto, this library will solve problems I'm having on both the client and relay side.",
"sig": "b6ec9733ffefa371f408bb838dedd4fd38eab5d1317442130403640c436bd6a916ed56791c6a93f9529d9ada58b951e7004d817697a44578ea402cf2dc9d6d1f"
}