chore: add worker-relay readme
Some checks are pending
continuous-integration/drone/push Build is running
Some checks are pending
continuous-integration/drone/push Build is running
This commit is contained in:
parent
a14a5fa96b
commit
a7c0cf7397
39
packages/worker-relay/README.md
Normal file
39
packages/worker-relay/README.md
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
## Worker Relay
|
||||||
|
|
||||||
|
Worker relay is a Nostr relay built on `sqlite-wasm`
|
||||||
|
|
||||||
|
`WorkerRelayInterface` is the class which accepts the URL of the worker script
|
||||||
|
|
||||||
|
`sqlite-wasm` uses OFPS in order to persist the database.
|
||||||
|
|
||||||
|
OPFS requires special headers to be present when serving your application. Read more about it [here](https://sqlite.org/wasm/doc/trunk/persistence.md#opfs)
|
||||||
|
|
||||||
|
```
|
||||||
|
Cross-Origin-Opener-Policy: same-origin
|
||||||
|
Cross-Origin-Embedder-Policy: require-corp
|
||||||
|
```
|
||||||
|
|
||||||
|
### Usage (Vite)
|
||||||
|
```typescript
|
||||||
|
import WorkerRelayPath from "@snort/worker-relay/dist/worker?worker&url";
|
||||||
|
```
|
||||||
|
|
||||||
|
### Example
|
||||||
|
```typescript
|
||||||
|
const relay = new WorkerRelayInterface(WorkerRelayPath);
|
||||||
|
|
||||||
|
// load sqlite database and run migrations
|
||||||
|
await relay.init();
|
||||||
|
|
||||||
|
// Query worker relay with regular nostr REQ command
|
||||||
|
const results = await relay.query(["REQ", "1", { kinds: [1], limit: 10 }]);
|
||||||
|
|
||||||
|
// publish a new event to the relay
|
||||||
|
const myEvent = {
|
||||||
|
kind: 1,
|
||||||
|
content: "test",
|
||||||
|
};
|
||||||
|
if (await relay.event(myEvent)) {
|
||||||
|
console.log("Success");
|
||||||
|
}
|
||||||
|
```
|
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@snort/worker-relay",
|
"name": "@snort/worker-relay",
|
||||||
"version": "1.0.0",
|
"version": "1.0.1",
|
||||||
"description": "A nostr relay in a service worker",
|
"description": "A nostr relay in a service worker",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"types": "dist/index.d.ts",
|
"types": "dist/index.d.ts",
|
||||||
|
@ -3,15 +3,7 @@
|
|||||||
import { InMemoryRelay } from "./memory-relay";
|
import { InMemoryRelay } from "./memory-relay";
|
||||||
import { WorkQueueItem, barrierQueue, processWorkQueue } from "./queue";
|
import { WorkQueueItem, barrierQueue, processWorkQueue } from "./queue";
|
||||||
import { SqliteRelay } from "./sqlite-relay";
|
import { SqliteRelay } from "./sqlite-relay";
|
||||||
import { NostrEvent, RelayHandler, ReqCommand, ReqFilter, WorkerMessage, eventMatchesFilter, unixNowMs } from "./types";
|
import { NostrEvent, RelayHandler, ReqCommand, ReqFilter, WorkerMessage, unixNowMs } from "./types";
|
||||||
|
|
||||||
interface PortedFilter {
|
|
||||||
filters: Array<ReqFilter>;
|
|
||||||
port: MessagePort;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Active open subscriptions awaiting new events
|
|
||||||
const ActiveSubscriptions = new Map<string, PortedFilter>();
|
|
||||||
|
|
||||||
let relay: RelayHandler | undefined;
|
let relay: RelayHandler | undefined;
|
||||||
|
|
||||||
@ -77,23 +69,6 @@ globalThis.onmessage = async ev => {
|
|||||||
} else {
|
} else {
|
||||||
relay = new InMemoryRelay();
|
relay = new InMemoryRelay();
|
||||||
}
|
}
|
||||||
|
|
||||||
relay.on("event", evs => {
|
|
||||||
for (const pf of ActiveSubscriptions.values()) {
|
|
||||||
const pfSend = [];
|
|
||||||
for (const ev of evs) {
|
|
||||||
for (const fx of pf.filters) {
|
|
||||||
if (eventMatchesFilter(ev, fx)) {
|
|
||||||
pfSend.push(ev);
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (pfSend.length > 0) {
|
|
||||||
pf.port.postMessage(pfSend);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
await relay.init(msg.args as string);
|
await relay.init(msg.args as string);
|
||||||
reply(msg.id, true);
|
reply(msg.id, true);
|
||||||
});
|
});
|
||||||
|
Loading…
Reference in New Issue
Block a user