nostr package: vastly simplify the API (#412)

* vastly simplify the api

* add missing await

* add eose to emitter

* add eose to conn

* add eose to the client

* eose test

* improve test suite, add dm tests

* demonstrate that nostr-rs-relay auth options don't work

* readme files

* cleanup

* fetch relay info

* test readyState

* export fetchRelayInfo

* cleanup

* better async/await linting

* use strictEqual in tests

* additional eslint rules

* allow arbitrary extensions

* saner error handling

* update README

* implement nip-02

---------

Co-authored-by: Kieran <kieran@harkin.me>

packages/nostr/relay/.dockerignore

@@ -0,0 +1 @@
+node_modules/

packages/nostr/relay/.gitignore

@@ -0,0 +1 @@
+node_modules/

packages/nostr/relay/Dockerfile

@@ -0,0 +1,12 @@
+FROM scsibug/nostr-rs-relay
+
+USER root
+RUN apt-get update && apt-get install -y curl nodejs npm
+RUN npm i -g yarn
+
+EXPOSE 8000
+
+COPY . .
+USER $APP_USER
+RUN yarn
+CMD yarn app /bin/bash -c "rm -rf /usr/src/app/db/* && ./nostr-rs-relay --db /usr/src/app/db --config ./config.toml"

packages/nostr/relay/config.toml

@@ -0,0 +1,11 @@
+[info]
+relay_url = "wss://nostr.example.com/"
+name = "nostr-rs-relay"
+description = "nostr-rs-relay description"
+contact = "mailto:contact@example.com"
+favicon = "favicon.ico"
+
+[authorization]
+nip42_auth = true
+# This seems to have no effect.
+nip42_dms = true

packages/nostr/relay/index.ts

@@ -0,0 +1,26 @@
+/**
+ * Allows the relay to be shut down with an HTTP request, after which
+ * docker-compose will restart it. This allows each test to have a clean
+ * slate. The drawback is that the tests can't run in parallel, so the
+ * test suite is very slow. A better option would be to have this relay
+ * server manage the relay completely: star/stop isolated relay instances
+ * with HTTP requests and allow multiple instances to run at the same
+ * time so that the tests can be parallelized.
+ */
+
+import http from "node:http"
+import { spawn } from "node:child_process"
+
+const child = spawn(process.argv[2], process.argv.slice(3), {
+  stdio: "inherit",
+})
+
+const server = http.createServer((_, res) => {
+  if (!child.kill(9)) {
+    console.error("killing the subprocess failed")
+  }
+  res.end()
+  process.exit(1)
+})
+
+server.listen(8000)

packages/nostr/relay/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "relay",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "scripts": {
+    "app": "ts-node index.ts"
+  },
+  "dependencies": {
+    "@types/node": "^18.15.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.5"
+  }
+}