Merge branch 'cameri:main' into main

Author: kushagra0902

.env.example

@@ -0,0 +1,69 @@
+# --- REQUIRED ---
+SECRET=change_me_to_something_long_and_random # Generate: openssl rand -hex 128
+
+# --- POSTGRESQL ---
+DB_HOST=localhost
+DB_PORT=5432
+DB_NAME=nostr_ts_relay
+DB_USER=nostr_ts_relay
+DB_PASSWORD=nostr_ts_relay
+# Alternatively, use a URI:
+# DB_URI=postgresql://nostr_ts_relay:nostr_ts_relay@localhost:5432/nostr_ts_relay
+
+# --- DB POOL TUNING (Optional) ---
+# DB_MIN_POOL_SIZE=0
+# DB_MAX_POOL_SIZE=3
+# DB_ACQUIRE_CONNECTION_TIMEOUT=60000
+
+# --- REDIS (Required for Rate Limiting) ---
+REDIS_HOST=localhost
+REDIS_PORT=6379
+# REDIS_USER=default
+# REDIS_PASSWORD=
+# Alternatively, use a URI:
+# REDIS_URI=redis://localhost:6379
+
+# --- SERVER CONFIG ---
+RELAY_PORT=8008
+WORKER_COUNT=2 # Defaults to CPU count. Use 1 or 2 for local testing.
+# NOSTR_CONFIG_DIR=.nostr # Where settings.yaml lives
+
+# --- DEBUGGING ---
+# Useful namespaces: maintenance-worker, database-client:*, cache-client, etc.
+# DEBUG=maintenance-worker
+
+# --- RELAY PRIVATE KEY (Optional) ---
+# RELAY_PRIVATE_KEY=your_hex_private_key
+
+# --- PAYMENTS (Only if enabled in settings.yaml) ---
+# ZEBEDEE_API_KEY=
+# NODELESS_API_KEY=
+# NODELESS_WEBHOOK_SECRET=
+# OPENNODE_API_KEY=
+# LNBITS_API_KEY=
+
+# --- READ REPLICAS (Optional) ---
+# READ_REPLICA_ENABLED=false
+# READ_REPLICAS=2
+# RR0_DB_HOST=localhost
+# RR0_DB_PORT=5432
+# RR0_DB_NAME=nostr_ts_relay
+# RR0_DB_USER=your_psql_username
+# RR0_DB_PASSWORD=your_psql_password
+# RR0_DB_MIN_POOL_SIZE=0
+# RR0_DB_MAX_POOL_SIZE=3
+# RR0_DB_ACQUIRE_CONNECTION_TIMEOUT=60000
+# RR1_DB_HOST=localhost
+# RR1_DB_PORT=5432
+# RR1_DB_NAME=nostr_ts_relay
+# RR1_DB_USER=your_psql_username
+# RR1_DB_PASSWORD=your_psql_password
+# RR1_DB_MIN_POOL_SIZE=0
+# RR1_DB_MAX_POOL_SIZE=3
+# RR1_DB_ACQUIRE_CONNECTION_TIMEOUT=60000
+
+# --- TOR (Optional) ---
+# TOR_HOST=localhost
+# TOR_CONTROL_PORT=9051
+# TOR_PASSWORD=
+# HIDDEN_SERVICE_PORT=80

.github/workflows/checks.yml

@@ -77,11 +77,12 @@ jobs:
       - name: Run coverage for unit tests
         run: npm run cover:unit
         if: ${{ always() }}
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         name: Upload coverage report for unit tests
         if: ${{ always() }}
         with:
-          path: .coverage/*/lcov.info
+          name: unit-coverage-lcov
+          path: .coverage/unit/lcov.info
       - name: Coveralls
         uses: coverallsapp/github-action@master
         if: ${{ always() }}
@@ -122,29 +123,12 @@ jobs:
           flag-name: Integration
           parallel: true
           github-token: ${{ secrets.GITHUB_TOKEN }}
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         name: Upload coverage report for integration tests
         if: ${{ always() }}
         with:
-          path: .coverage/*/lcov.info
-  sonarcloud:
-    name: Sonarcloud
-    needs: [test-units-and-cover, test-integrations-and-cover]
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - uses: actions/download-artifact@v3
-        name: Download unit & integration coverage reports
-        with:
-          path: .coverage
-      - name: SonarCloud Scan
-        uses: sonarsource/sonarcloud-github-action@master
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          name: integration-coverage-lcov
+          path: .coverage/integration/lcov.info
   post-tests:
     name: Post Tests
     needs: [test-units-and-cover, test-integrations-and-cover]

.gitignore

@@ -25,6 +25,11 @@ node_modules/
 .dccache
 .DS_Store
 
+# Local Setup
+redis.conf
+users.acl
+postgresql.local.conf
+
 # generate output
 dist
 

.nvmrc

@@ -1 +1 @@
-v18.8.0
+v24.14.1

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:18-alpine3.16 AS build
+FROM node:24-alpine AS build
 
 WORKDIR /build
 
@@ -10,7 +10,7 @@ COPY . .
 
 RUN npm run build
 
-FROM node:18-alpine3.16
+FROM node:24-alpine
 
 LABEL org.opencontainers.image.title="Nostream"
 LABEL org.opencontainers.image.source=https://github.com/cameri/nostream

Dockerfile.railwayapp

@@ -1,5 +1,5 @@
 ## Author Saransh Sharma @cynsar foundation
-FROM node:18-alpine3.16 as build
+FROM node:24-alpine as build
 
 ARG PORT
 ARG PGHOST
@@ -29,7 +29,7 @@ COPY . .
 
 RUN npm run build
 
-FROM node:18-alpine3.16
+FROM node:24-alpine
 
 ARG PORT
 ARG PGHOST

Dockerfile.test

@@ -1,4 +1,4 @@
-FROM node:18-alpine3.16
+FROM node:24-alpine
 
 WORKDIR /code
 

README.md

@@ -67,7 +67,7 @@ NIPs with a relay-specific implementation are listed here.
 ### Standalone setup
 - PostgreSQL 14.0
 - Redis
-- Node v18
+- Node v24
 - Typescript
 
 ### Docker setups
@@ -210,6 +210,16 @@ Start:
   ./scripts/start_with_tor
   ```
 
+**Windows / WSL2 users:** Docker bind-mounts can cause PostgreSQL permission errors on Windows. Use the dedicated override file instead:
+  ```
+  docker compose -f docker-compose.yml -f docker-compose.windows.yml up --build
+  ```
+  Or add this to your `.env` file so you don't have to type it every time:
+  ```
+  COMPOSE_FILE=docker-compose.yml:docker-compose.windows.yml
+  ```
+  > **Note:** If you previously ran Nostream on Linux/Mac and are switching to Windows, your existing data lives at `.nostr/data/` on the host. You'll need to copy it into the Docker named volume manually or it won't be visible to the new setup.
+
 Stop the server with:
   ```
   ./scripts/stop
@@ -220,6 +230,29 @@ Print the Tor hostname:
   ./scripts/print_tor_hostname
   ```
 
+### Importing events from JSON Lines
+
+You can import NIP-01 events from a `.jsonl` file directly into the relay database.
+
+Basic import:
+  ```
+  npm run import -- ./events.jsonl
+  ```
+
+Set a custom batch size (default: `1000`):
+  ```
+  npm run import -- ./events.jsonl --batch-size 500
+  ```
+
+The importer:
+
+- Processes the file line-by-line to keep memory usage bounded.
+- Validates NIP-01 schema, event id hash, and Schnorr signature before insertion.
+- Inserts in database transactions per batch.
+- Skips duplicates without failing the whole import.
+- Prints progress in the format:
+  `[Processed: 50,000 | Inserted: 45,000 | Skipped: 5,000 | Errors: 0]`
+
 ### Running as a Service
 
 By default this server will run continuously until you stop it with Ctrl+C or until the system restarts.
@@ -263,6 +296,60 @@ The logs can be viewed with:
   journalctl -u nostream
   ```
 
+## Troubleshooting
+
+### Linux: Docker DNS resolution failures (`EAI_AGAIN`)
+
+On some Linux environments (especially rolling-release distros or setups using
+`systemd-resolved`), `docker compose` builds can fail with DNS errors such as:
+
+- `getaddrinfo EAI_AGAIN registry.npmjs.org`
+- `Temporary failure in name resolution`
+
+To fix this, configure Docker daemon DNS in `/etc/docker/daemon.json`.
+
+1. Create or update `/etc/docker/daemon.json`:
+
+  ```
+  sudo mkdir -p /etc/docker
+  sudo nano /etc/docker/daemon.json
+  ```
+
+  Add or update the file with:
+
+  ```
+  {
+    "dns": ["1.1.1.1", "8.8.8.8"]
+  }
+  ```
+
+  If this file already exists, merge the `dns` key into the existing JSON
+  instead of replacing the entire file.
+
+  If your environment does not allow public resolvers, replace `1.1.1.1` and
+  `8.8.8.8` with DNS servers approved by your network.
+
+2. Restart Docker:
+
+  ```
+  sudo systemctl restart docker
+  ```
+
+3. Verify DNS works inside containers:
+
+  ```
+  docker run --rm busybox nslookup registry.npmjs.org
+  ```
+
+4. Retry starting nostream:
+
+  ```
+  ./scripts/start
+  ```
+
+Note: avoid `127.0.0.53` in Docker DNS settings because it points to the host's
+local resolver stub and is often unreachable from containers.
+
 ## Quick Start (Standalone)
 
 Set the following environment variables:
@@ -372,7 +459,7 @@ Clone repository and enter directory:
 
 Start:
   ```
-  ./scripts/start_local
+  ./scripts/start
   ```
 
   This will run in the foreground of the terminal until you stop it with Ctrl+C.

docker-compose.windows.yml

@@ -0,0 +1,28 @@
+# docker-compose.windows.yml
+#
+# Windows / WSL2 override for Nostream.
+#
+# On Windows (including WSL2), Docker bind-mounts to host paths can cause
+# PostgreSQL permission errors. This override replaces the bind-mount for
+# PostgreSQL data with a named Docker volume, which is managed entirely
+# by the Docker engine and avoids those issues.
+#
+# Usage:
+#   docker compose -f docker-compose.yml -f docker-compose.windows.yml up --build
+#
+# Or set COMPOSE_FILE in your .env:
+#   COMPOSE_FILE=docker-compose.yml:docker-compose.windows.yml
+#
+# WARNING: If you previously ran Nostream with the default docker-compose.yml
+# your data is in .nostr/data/ on the host. Before switching to this file,
+# migrate your data or it will not be accessible from the named volume.
+
+services:
+  nostream-db:
+    volumes:
+      - nostream-db-data:/var/lib/postgresql/data
+      - ${PWD}/.nostr/db-logs:/var/log/postgresql
+      - ${PWD}/postgresql.conf:/postgresql.conf
+
+volumes:
+  nostream-db-data: