Merge branch 'main' into bugfix/nip11-relay-url-path

Author: cameri

.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

@@ -129,24 +129,6 @@ jobs:
         with:
           name: integration-coverage-lcov
           path: .coverage/integration/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@v4
-        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 }}
   post-tests:
     name: Post Tests
     needs: [test-units-and-cover, test-integrations-and-cover]

README.md

@@ -230,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.

package.json

@@ -31,6 +31,7 @@
     "lint": "eslint --ext .ts ./src ./test",
     "lint:report": "eslint -o .lint-reports/eslint.json -f json --ext .ts ./src ./test",
     "lint:fix": "npm run lint -- --fix",
+    "import": "node -r ts-node/register src/import-events.ts",
     "db:migrate": "knex migrate:latest",
     "db:migrate:rollback": "knex migrate:rollback",
     "db:seed": "knex seed:run",

src/@types/repositories.ts

@@ -14,9 +14,13 @@ export interface IQueryResult<T> extends Pick<Promise<T>, keyof Promise<T> & Exp
 
 export interface IEventRepository {
   create(event: Event): Promise<number>
+  createMany(events: Event[]): Promise<number>
   upsert(event: Event): Promise<number>
+  upsertMany(events: Event[]): Promise<number>
   findByFilters(filters: SubscriptionFilter[]): IQueryResult<DBEvent[]>
   deleteByPubkeyAndIds(pubkey: Pubkey, ids: EventId[]): Promise<number>
+  deleteByPubkeyExceptKinds(pubkey: Pubkey, excludedKinds: number[]): Promise<number>
+  hasActiveRequestToVanish(pubkey: Pubkey): Promise<boolean>
 }
 
 export interface IInvoiceRepository {

src/constants/base.ts

@@ -7,6 +7,7 @@ export enum EventKinds {
   DELETE = 5,
   REPOST = 6,
   REACTION = 7,
+  REQUEST_TO_VANISH = 62,
   // Channels
   CHANNEL_CREATION = 40,
   CHANNEL_METADATA = 41,
@@ -36,12 +37,15 @@ export enum EventKinds {
 export enum EventTags {
   Event = 'e',
   Pubkey = 'p',
+  Relay = 'r',
   //  Multicast = 'm',
   Deduplication = 'd',
   Expiration = 'expiration',
   Invoice = 'bolt11',
 }
 
+export const ALL_RELAYS = 'ALL_RELAYS'
+
 export enum PaymentsProcessors {
   LNURL = 'lnurl',
   ZEBEDEE = 'zebedee',

src/factories/event-strategy-factory.ts

@@ -1,4 +1,4 @@
-import { isDeleteEvent, isEphemeralEvent, isParameterizedReplaceableEvent, isReplaceableEvent } from '../utils/event'
+import { isDeleteEvent, isEphemeralEvent, isParameterizedReplaceableEvent, isReplaceableEvent, isRequestToVanishEvent } from '../utils/event'
 import { DefaultEventStrategy } from '../handlers/event-strategies/default-event-strategy'
 import { DeleteEventStrategy } from '../handlers/event-strategies/delete-event-strategy'
 import { EphemeralEventStrategy } from '../handlers/event-strategies/ephemeral-event-strategy'
@@ -9,12 +9,15 @@ import { IEventStrategy } from '../@types/message-handlers'
 import { IWebSocketAdapter } from '../@types/adapters'
 import { ParameterizedReplaceableEventStrategy } from '../handlers/event-strategies/parameterized-replaceable-event-strategy'
 import { ReplaceableEventStrategy } from '../handlers/event-strategies/replaceable-event-strategy'
+import { VanishEventStrategy } from '../handlers/event-strategies/vanish-event-strategy'
 
 export const eventStrategyFactory = (
   eventRepository: IEventRepository,
 ): Factory<IEventStrategy<Event, Promise<void>>, [Event, IWebSocketAdapter]> =>
   ([event, adapter]: [Event, IWebSocketAdapter]) => {
-    if (isReplaceableEvent(event)) {
+    if (isRequestToVanishEvent(event)) {
+      return new VanishEventStrategy(adapter, eventRepository)
+    } else if (isReplaceableEvent(event)) {
       return new ReplaceableEventStrategy(adapter, eventRepository)
     } else if (isEphemeralEvent(event)) {
       return new EphemeralEventStrategy(adapter)

src/factories/message-handler-factory.ts

@@ -18,6 +18,7 @@ export const messageHandlerFactory = (
         return new EventMessageHandler(
           adapter,
           eventStrategyFactory(eventRepository),
+          eventRepository,
           userRepository,
           createSettings,
           slidingWindowRateLimiterFactory,

src/handlers/event-message-handler.ts

@@ -1,15 +1,25 @@
-import { Event, ExpiringEvent  } from '../@types/event'
+import { ContextMetadataKey, EventExpirationTimeMetadataKey, EventKinds } from '../constants/base'
+import { Event, ExpiringEvent } from '../@types/event'
 import { EventRateLimit, FeeSchedule, Settings } from '../@types/settings'
-import { getEventExpiration, getEventProofOfWork, getPubkeyProofOfWork, getPublicKey, getRelayPrivateKey, isEventIdValid, isEventKindOrRangeMatch, isEventSignatureValid, isExpiredEvent } from '../utils/event'
+import {
+  getEventExpiration,
+  getEventProofOfWork,
+  getPubkeyProofOfWork,
+  getPublicKey,
+  getRelayPrivateKey,
+  isEventIdValid,
+  isEventKindOrRangeMatch,
+  isEventSignatureValid,
+  isExpiredEvent,
+  isRequestToVanishEvent,
+} from '../utils/event'
+import { IEventRepository, IUserRepository } from '../@types/repositories'
 import { IEventStrategy, IMessageHandler } from '../@types/message-handlers'
-import { ContextMetadataKey } from '../constants/base'
 import { createCommandResult } from '../utils/messages'
 import { createLogger } from '../factories/logger-factory'
-import { EventExpirationTimeMetadataKey } from '../constants/base'
 import { Factory } from '../@types/base'
 import { IncomingEventMessage } from '../@types/messages'
 import { IRateLimiter } from '../@types/utils'
-import { IUserRepository } from '../@types/repositories'
 import { IWebSocketAdapter } from '../@types/adapters'
 import { WebSocketAdapterEvent } from '../constants/adapter'
 
@@ -19,6 +29,7 @@ export class EventMessageHandler implements IMessageHandler {
   public constructor(
     protected readonly webSocket: IWebSocketAdapter,
     protected readonly strategyFactory: Factory<IEventStrategy<Event, Promise<void>>, [Event, IWebSocketAdapter]>,
+    protected readonly eventRepository: IEventRepository,
     protected readonly userRepository: IUserRepository,
     private readonly settings: () => Settings,
     private readonly slidingWindowRateLimiter: Factory<IRateLimiter>,
@@ -57,6 +68,13 @@ export class EventMessageHandler implements IMessageHandler {
       return
     }
 
+    reason = await this.isBlockedByRequestToVanish(event)
+    if (reason) {
+      debug('event %s rejected: %s', event.id, reason)
+      this.webSocket.emit(WebSocketAdapterEvent.Message, createCommandResult(event.id, false, reason))
+      return
+    }
+
     reason = await this.isUserAdmitted(event)
     if (reason) {
       debug('event %s rejected: %s', event.id, reason)
@@ -190,6 +208,26 @@ export class EventMessageHandler implements IMessageHandler {
     if (!await isEventSignatureValid(event)) {
       return 'invalid: event signature verification failed'
     }
+
+    if (event.kind === EventKinds.REQUEST_TO_VANISH && !isRequestToVanishEvent(event, this.settings().info.relay_url)) {
+      return 'invalid: request to vanish relay tag invalid'
+    }
+  }
+
+  protected async isBlockedByRequestToVanish(event: Event): Promise<string | undefined> {
+    if (isRequestToVanishEvent(event)) {
+      return
+    }
+
+    const relayPubkey = this.getRelayPublicKey()
+    if (relayPubkey === event.pubkey) {
+      return
+    }
+
+    const existingVanishRequest = await this.eventRepository.hasActiveRequestToVanish(event.pubkey)
+    if (existingVanishRequest) {
+      return 'blocked: request to vanish active for pubkey'
+    }
   }
 
   protected async isRateLimited(event: Event): Promise<boolean> {

src/handlers/event-strategies/vanish-event-strategy.ts

@@ -0,0 +1,33 @@
+import { createCommandResult } from '../../utils/messages'
+import { createLogger } from '../../factories/logger-factory'
+import { Event } from '../../@types/event'
+import { EventKinds } from '../../constants/base'
+import { IEventRepository } from '../../@types/repositories'
+import { IEventStrategy } from '../../@types/message-handlers'
+import { IWebSocketAdapter } from '../../@types/adapters'
+import { WebSocketAdapterEvent } from '../../constants/adapter'
+
+const debug = createLogger('vanish-event-strategy')
+
+export class VanishEventStrategy implements IEventStrategy<Event, Promise<void>> {
+  public constructor(
+    private readonly webSocket: IWebSocketAdapter,
+    private readonly eventRepository: IEventRepository,
+  ) {}
+
+  public async execute(event: Event): Promise<void> {
+    debug('received request to vanish event: %o', event)
+
+    await this.eventRepository.deleteByPubkeyExceptKinds(
+      event.pubkey,
+      [EventKinds.REQUEST_TO_VANISH],
+    )
+
+    const count = await this.eventRepository.create(event)
+
+    this.webSocket.emit(
+      WebSocketAdapterEvent.Message,
+      createCommandResult(event.id, true, count ? '' : 'duplicate:')
+    )
+  }
+}