cameri · Feb 2, 2023 · Jan 11, 2023 · Jan 11, 2023 · Jan 11, 2023 · Jan 11, 2023
diff --git a/.nostr.local/settings.json b/.nostr.local/settings.json
@@ -2,18 +2,69 @@
   "info": {
     "relay_url": "wss://nostream.localtest.me",
     "name": "nostream.localtest.me",
-    "description": "A nostr relay written in TypeScript.",
-    "pubkey": "replace-with-your-pubkey",
+    "description": "A nostr relay written in Typescript.",
+    "pubkey": "00000000827ffaa94bfea288c3dfce4422c794fbb96625b6b31e9049f729d700",
     "contact": "operator@your-domain.com"
   },
   "network": {
-    "max_payload_size": 131072,
-    "remote_ip_header": "x-forwarded-for"
+    "maxPayloadSize": 131072,
+    "remoteIpHeader": "x-forwarded-for",
+    "idleTimeout": 60
+  },
+  "payments": {
+    "enabled": true,
+    "processor": "zebedee",
+    "feeSchedules": {
+      "admission": [{
+        "enabled": true,
+        "descripton": "Admission fee in msats (1000 msats = 1 satoshi)",
+        "amount": 1000000,
+        "whitelists": {
+          "pubkeys": ["replace-with-your-pubkey"]
+        }
+      }],
+      "publication": [
+        {
+          "enabled": true,
+          "description": "Publication fee in msats (1000 msats = 1 satoshi)",
+          "amount": 100,
+          "whitelists": {
+            "pubkeys": ["replace-with-your-pubkey"]
+          }
+        }
+      ]
+    }
+  },
+  "paymentProcessors": {
+    "zebedee": {
+      "baseURL": "https://api.zebedee.io/",
+      "callbackBaseURL": "https://nostream.localtest.me/callbacks/zebedee"
+    }
   },
   "workers": {
     "count": 0
   },
   "limits": {
+    "connection": {
+      "rateLimits": [
+        {
+          "period": 60000,
+          "rate": 12
+        },
+        {
+          "period": 3600000,
+          "rate": 360
+        },
+        {
+          "period": 86400000,
+          "rate": 2880
+        }
+      ],
+      "ipWhitelist": [
+        "::1",
+        "::ffff:10.10.10.1"
+      ]
+    },
     "event": {
       "eventId": {
         "minLeadingZeroBits": 0
@@ -31,45 +82,62 @@
         "maxPositiveDelta": 900,
         "maxNegativeDelta": 0
       },
-      "content": {
-        "maxLength": 1048576
-      },
+      "content": [
+        {
+          "description": "64 KB for event kind ranges 0-10 and 40-49",
+          "kinds": [[0, 10], [40, 49]],
+          "maxLength": 65536
+        },
+        {
+          "description": "96 KB for event kind ranges 11-39 and 50-max",
+          "kinds": [[11, 39], [50, 9007199254740991]],
+          "maxLength": 98304
+        }
+      ],
       "rateLimits": [
         {
+          "description": "6 events/min for event kinds 0, 3, 40 and 41",
           "kinds": [0, 3, 40, 41],
           "period": 60000,
           "rate": 6
         },
         {
+          "description": "12 events/min for event kinds 1, 2, 4 and 42",
           "kinds": [1, 2, 4, 42],
           "period": 60000,
           "rate": 12
         },
         {
+          "description": "360 events/hour for event kinds 1, 2, 4 and 42",
           "kinds": [1, 2, 4, 42],
           "period": 3600000,
           "rate": 360
         },
         {
+          "description": "30 events/min for event kind ranges 5-7 and 43-49",
           "kinds": [[5, 7], [43, 49]],
           "period": 60000,
           "rate": 30
         },
         {
+          "description": "24 events/min for replaceable events and parameterized replaceable events",
           "kinds": [[10000, 19999], [30000, 39999]],
           "period": 60000,
           "rate": 24
         },
         {
+          "description": "60 events/min for ephemeral events",
           "kinds": [[20000, 29999]],
           "period": 60000,
           "rate": 60
         },
         {
+          "description": "720 events/hour for all events",
           "period": 3600000,
           "rate": 720
         },
         {
+          "description": "2880 events/day for all events",
           "period": 86400000,
           "rate": 2880
         }
@@ -91,14 +159,29 @@
     "message": {
       "rateLimits": [
         {
+          "description": "60 subscriptions/min",
+          "types": ["REQ"],
+          "period": 60000,
+          "rate": 60
+        },
+        {
+          "description": "2880 subscriptions/hour",
+          "types": ["REQ"],
+          "period": 3600000,
+          "rate": 2880
+        },
+        {
+          "description": "120 raw messages/min",
           "period": 60000,
           "rate": 120
         },
         {
+          "description": "3600 raw messages/hour",
           "period": 3600000,
           "rate": 3600
         },
         {
+          "description": "86400 raw messages/day",
           "period": 86400000,
           "rate": 86400
         }

diff --git a/CONFIGURATION.md b/CONFIGURATION.md
@@ -7,6 +7,7 @@ The following environment variables can be set:
 | Name                             | Description                    | Default                |
 |----------------------------------|--------------------------------|------------------------|
 | RELAY_PORT                       | Relay's server port            | 8008                   |
+| RELAY_PRIVATE_KEY                | Relay's private key in hex     | (auto-generated)       |
 | WORKER_COUNT                     | Number of workers override     | No. of available CPUs  |
 | DB_HOST                          | PostgresSQL Hostname           |                        |
 | DB_PORT                          | PostgreSQL Port                | 5432                   |
@@ -38,7 +39,7 @@ The following environment variables can be set:
 
 # Settings
 
-Running `nostream` for the first time creates the settings file in `<project_root>/.nostr/settings.json`. If the file is not created and an error is thrown ensure that the `<project_root>/.nostr` folder exists. The configuration directory can be changed by setting the `NOSTR_CONFIG_DIR` environment variable.
+Running `nostream` for the first time creates the settings file in `<project_root>/.nostr/settings.yaml`. If the file is not created and an error is thrown ensure that the `<project_root>/.nostr` folder exists. The configuration directory can be changed by setting the `NOSTR_CONFIG_DIR` environment variable.
 
 | Name                                        | Description                                                                   |
 |---------------------------------------------|-------------------------------------------------------------------------------|
@@ -47,8 +48,11 @@ Running `nostream` for the first time creates the settings file in `<project_roo
 | info.description                            | Public description of your relay. (e.g. Toronto Bitcoin Group Public Relay) |
 | info.pubkey                                 | Relay operator's Nostr pubkey in hex format. |
 | info.contact                                | Relay operator's contact. (e.g. mailto:operator@relay-your-domain.com) |
-| network.max_payload_size                    | Maximum number of bytes accepted per WebSocket frame |
-| network.remote_ip_header                    | HTTP header from proxy containing IP address from client. |
+| network.maxPayloadSize                      | Maximum number of bytes accepted per WebSocket frame |
+| network.remoteIpHeader                      | HTTP header from proxy containing IP address from client. |
+| mirroring.static[].address                  | Address of mirrored relay. (e.g. ws://100.100.100.100:8008) |
+| mirroring.static[].filters                  | Subscription filters used to mirror. |
+| mirroring.static[].secret                   | Secret to pass to relays. Nostream relays only. Optional. |
 | workers.count                               | Number of workers to spin up to handle incoming connections. |
 |                                             | Spin workers as many CPUs are available when set to zero. Defaults to zero. |
 | limits.event.eventId.minLeadingZeroBits     | Leading zero bits required on every incoming event for proof of work. |
@@ -61,7 +65,8 @@ Running `nostream` for the first time creates the settings file in `<project_roo
 | limits.event.pubkey.blacklist               | List of public keys to always reject. Public keys in this list will not be able to post to this relay. |
 | limits.event.createdAt.maxPositiveDelta     | Maximum number of seconds an event's `created_at` can be in the future. Defaults to 900 (15 minutes). Disabled when set to zero. |
 | limits.event.createdAt.minNegativeDelta     | Maximum number of secodns an event's `created_at` can be in the past.  Defaults to zero. Disabled when set to zero. |
-| limits.event.content.maxLength              | Maximum length of `content`. Defaults to 1 MB. Disabled when set to zero. |
+| limits.event.content[].kinds                | List of event kinds to apply limit. Use `[min, max]` for ranges. Optional. |
+| limits.event.content[].maxLength            | Maximum length of `content`. Defaults to 1 MB. Disabled when set to zero. |
 | limits.event.rateLimits[].kinds             | List of event kinds rate limited. Use `[min, max]` for ranges. Optional. |
 | limits.event.rateLimits[].period            | Rate limiting period in milliseconds. |
 | limits.event.rateLimits[].rate              | Maximum number of events during period. |

diff --git a/Caddyfile.local b/Caddyfile.local
@@ -5,5 +5,5 @@
 nostream.localtest.me {
 	tls /root/certs/nostream.localtest.me.pem /root/certs/nostream.localtest.me-key.pem
 
-	reverse_proxy nostr-ts-relay:8008
+	reverse_proxy nostream:8008
 }
diff --git a/Dockerfile b/Dockerfile
@@ -18,16 +18,11 @@ LABEL org.opencontainers.image.description="nostream"
 LABEL org.opencontainers.image.authors="Ricardo Arturo Cabral Mejía"
 LABEL org.opencontainers.image.licenses=MIT
 
-
-ENV DB_HOST=localhost
-ENV DB_PORT=5432
-ENV DB_NAME=nostr-ts-relay
-ENV DB_USER=nostr-ts-relay
-ENV DB_PASSWORD=nostr-ts-relay
-
 WORKDIR /app
 RUN apk add --no-cache --update git
 
+ADD resources /app/resources
+
 COPY --from=build /build/dist .
 
 RUN npm install --omit=dev --quiet

diff --git a/Dockerfile.railwayapp b/Dockerfile.railwayapp
@@ -21,7 +21,7 @@ COPY ["package.json", "package-lock.json","knexfile.js","./"]
 
 ADD migrations /build/migrations
 
-RUN npm install -g knex@2.3.0 && npm install --quiet
+RUN npm install -g knex@2.4.0 && npm install --quiet
 
 RUN npm run db:migrate
 

diff --git a/Dockerfile.test b/Dockerfile.test
@@ -1,16 +1,4 @@
-FROM node:18-alpine3.16
-
-ENV DB_HOST=db-test
-ENV DB_PORT=5432
-ENV DB_NAME=postgres
-ENV DB_USER=postgres
-ENV DB_PASSWORD=postgres
-ENV DB_MIN_POOL_SIZE=1
-ENV DB_MAX_POOL_SIZE=2
-ENV REDIS_HOST=cache-test
-ENV REDIS_PORT=6379
-ENV REDIS_USER=default
-ENV REDIS_PASSWORD=nostr_ts_relay_test
+FROM node:18.8-alpine3.16
 
 WORKDIR /code
 

diff --git a/README.md b/README.md
@@ -354,8 +354,7 @@ You can change the default folder by setting the `NOSTR_CONFIG_DIR` environment
 Run nostream using one of the quick-start guides at least once and `nostream/.nostr/settings.json` will be created.
 Any changes made to the settings file will be read on the next start.
 
-A sample settings file is included at the project root under the name `settings.sample.json`. Feel free to copy it to `nostream/.nostr/settings.json`
-if you would like to have a settings file before running the relay first.
+Default settings can be found under `resources/default-settings.yaml`. Feel free to copy it to `nostream/.nostr/settings.yaml` if you would like to have a settings file before running the relay first.
 
 See [CONFIGURATION.md](CONFIGURATION.md) for a detailed explanation of each environment variable and setting.
 ## Dev Channel

diff --git a/docker-compose.local.yml b/docker-compose.local.yml
@@ -1,7 +1,7 @@
 services:
-  relay:
+  nostream:
     volumes:
-      - ${PWD}/.nostr.local:/home/node/
+      - ${PWD}/.nostr.local:/home/node
   caddy:
     image: caddy:2.6.2-alpine
     container_name: caddy

diff --git a/docker-compose.tor.yml b/docker-compose.tor.yml
@@ -4,7 +4,7 @@ services:
     container_name: tor
     user: toruser
     depends_on:
-      - relay
+      - nostream
     volumes:
       - ${PWD}/tor/torrc:/etc/tor/torrc
       - ${PWD}/.nostr/tor/data:/var/lib/tor