Jon Staab
72 lines
3.5 KiB
Markdown
72 lines
3.5 KiB
Markdown
# Paravel [](https://npmjs.com/package/paravel)
|
|
|
|
A nostr toolkit focused on creating highly a configurable client system. What paravel provides is less a library of code than a library of abstractions. Odds are you will end up creating a custom implementation of every component to suit your needs, but if you start with paravel that will be much easier than if you pile on parameters over time.
|
|
|
|
This is a monorepo which is split into several different packages.
|
|
|
|
## @coracle.social/lib
|
|
|
|
Some general-purpose utilities used elsewhere in paravel.
|
|
|
|
- `Deferred` is just a promise with `resolve` and `reject` methods.
|
|
- `Emitter` extends EventEmitter to support `emitter.on('*', ...)`.
|
|
- `Fluent` is a wrapper around arrays with chained methods that modify and copy the underlying array.
|
|
- `LRUCache` is an implementation of an LRU cache.
|
|
- `Worker` is an implementation of an asynchronous queue.
|
|
- `Tools` is a collection of general-purpose utility functions.
|
|
- `Store` is an implementation of svelte-like subscribable stores with extra features.
|
|
|
|
## @coracle.social/util
|
|
|
|
Some nostr-specific utilities. For the most part, these will not have side effects or manage state.
|
|
|
|
- `Address` contains utilities for dealing with nostr addresses.
|
|
- `Events` contains utilities for dealing with nostr events.
|
|
- `Filters` contains utilities for dealing with nostr filters.
|
|
- `Kinds` contains kind constants and related utility functions.
|
|
- `Relays` contains utilities related to relay urls.
|
|
- `Router` is a utility for selecting relay urls based on user preferences and protocol hints.
|
|
- `Tags` provides a convenient way to access and modify tags.
|
|
|
|
## @coracle.social/network
|
|
|
|
Utilities having to do with connection management and nostr messages.
|
|
|
|
- `ConnectionMeta` tracks stats for a given `Connection`.
|
|
- `Connection` is a wrapper for `Socket` with send and receive queues, and a `ConnectionMeta` instance.
|
|
- `Executor` implements common nostr flows on `target`
|
|
- `Pool` is a thin wrapper around `Map` for use with `Relay`s.
|
|
- `Socket` is a wrapper around isomorphic-ws that handles json parsing/serialization.
|
|
- `Subscription` is a higher-level utility for making requests against multiple nostr relays.
|
|
|
|
Executor targets extend `Emitter`, and have a `send` method, a `cleanup` method, and a `connections` getter. They are intended to be passed to an `Executor` for use.
|
|
|
|
- `Multi` allows you to compose multiple targets together.
|
|
- `Plex` takes an array of urls and a `Connection` and sends and receives wrapped nostr messages over that connection.
|
|
- `Relay` takes a `Connection` and provides listeners for different verbs.
|
|
- `Relays` takes an array of `Connection`s and provides listeners for different verbs, merging all events into a single stream.
|
|
|
|
# Example
|
|
|
|
Functionality is split into small chunks to allow for changing out implementations as needed. This is useful when attempting to support novel use cases. Here's a simple implementation of an agent that can use a multiplexer if enabled, or can fall back to communicating directly with all relays.
|
|
|
|
```javascript
|
|
class Agent {
|
|
pool = new Pool()
|
|
|
|
constructor(readonly multiplexerUrl: string) {}
|
|
|
|
getTarget(urls) {
|
|
return this.multiplexerUrl
|
|
? new Plex(urls, this.pool.get(this.multiplexerUrl))
|
|
: new Relays(urls.map(url => this.pool.get(url)))
|
|
}
|
|
|
|
subscribe(urls, filters, id, {onEvent, onEose}) {
|
|
const executor = new Executor(this.getTarget(urls))
|
|
|
|
return executor.subscribe(filters, id, {onEvent, onEose})
|
|
}
|
|
}
|
|
```
|