First commit

Author: dcadenas

.gitignore

@@ -0,0 +1 @@
+/strfry/db/

Dockerfile

@@ -0,0 +1,36 @@
+FROM ubuntu:jammy as build
+
+WORKDIR /build
+RUN apt update && apt install -y --no-install-recommends \
+    git g++ make pkg-config libtool ca-certificates \
+    libyaml-perl libtemplate-perl libregexp-grammars-perl libssl-dev zlib1g-dev \
+    liblmdb-dev libflatbuffers-dev libsecp256k1-dev \
+    libzstd-dev
+
+RUN git clone --branch 0.9.6 https://github.com/hoytech/strfry.git && cd strfry/ \
+    && git submodule update --init \
+    && make setup-golpe \
+    && make clean \
+    && make -j4
+
+FROM ubuntu:jammy as runner
+
+EXPOSE 7777
+
+RUN curl -fsSL https://deno.land/install.sh | sh
+RUN apt-get update && apt-get install -y --no-install-recommends  \
+    vim \
+    liblmdb0 libflatbuffers1 libsecp256k1-0 libb2-1 libzstd1 \
+    && rm -rf /var/lib/apt/lists/*
+
+COPY ./strfry/config/strfry.conf /etc/strfry.conf
+
+RUN mkdir -p /app/strfry-db
+COPY ./strfry/plugins/ /app/plugins/
+
+RUN chmod +x /app/plugins/allowed_rules.js
+
+WORKDIR /app
+COPY --from=build /build/strfry/strfry strfry
+
+ENTRYPOINT ["/app/strfry", "relay"]

README.md

@@ -0,0 +1 @@
+# nosrelay

strfry/config/strfry.conf

@@ -0,0 +1,137 @@
+##
+## Default strfry config for relayable/strfry Docker
+##
+
+# Directory that contains the strfry LMDB database (restart required)
+db = "./strfry-db/"
+
+dbParams {
+    # Maximum number of threads/processes that can simultaneously have LMDB transactions open (restart required)
+    maxreaders = 2024
+
+    # Size of mmap() to use when loading LMDB (default is 10TB, does *not* correspond to disk-space used) (restart required)
+    mapsize = 10995116277760
+}
+
+relay {
+    # Interface to listen on. Use 0.0.0.0 to listen on all interfaces (restart required)
+    bind = "0.0.0.0"
+
+    # Port to open for the nostr websocket protocol (restart required)
+    port = 7777
+
+    # Set OS-limit on maximum number of open files/sockets (if 0, don't attempt to set) (restart required)
+    nofiles = 1000000
+
+    # HTTP header that contains the client's real IP, before reverse proxying (ie x-real-ip) (MUST be all lower-case)
+    realIpHeader = "x-forwarded-for"
+
+    info {
+        # NIP-11: Name of this server. Short/descriptive (< 30 characters)
+        name = "nos.social strfry relay"
+
+        # NIP-11: Detailed information about relay, free-form
+        description = "This is a strfry instance handled by nos.social"
+
+        # NIP-11: Administrative nostr pubkey, for contact purposes
+        pubkey = "89ef92b9ebe6dc1e4ea398f6477f227e95429627b0a33dc89b640e137b256be5"
+
+        # NIP-11: Alternative administrative contact (email, website, etc)
+        contact = "https://nos.social"
+    }
+
+    # Maximum accepted incoming websocket frame size (should be larger than max event and yesstr msg) (restart required)
+    maxWebsocketPayloadSize = 131072
+
+    # Websocket-level PING message frequency (should be less than any reverse proxy idle timeouts) (restart required)
+    autoPingSeconds = 55
+
+    # If TCP keep-alive should be enabled (detect dropped connections to upstream reverse proxy)
+    enableTcpKeepalive = true
+
+    # How much uninterrupted CPU time a REQ query should get during its DB scan
+    queryTimesliceBudgetMicroseconds = 10000
+
+    # Maximum records that can be returned per filter
+    maxFilterLimit = 500
+
+    # Maximum number of subscriptions (concurrent REQs) a connection can have open at any time
+    maxSubsPerConnection = 100
+
+    writePolicy {
+        # If non-empty, path to an executable script that implements the writePolicy plugin logic
+        plugin = "/app/plugins/allowed_rules.js"
+
+        # Number of seconds to search backwards for lookback events when starting the writePolicy plugin (0 for no lookback)
+        lookbackSeconds = 0
+    }
+
+    compression {
+        # Use permessage-deflate compression if supported by client. Reduces bandwidth, but slight increase in CPU (restart required)
+        enabled = true
+
+        # Maintain a sliding window buffer for each connection. Improves compression, but uses more memory (restart required)
+        slidingWindow = true
+    }
+
+    logging {
+        # Dump all incoming messages
+        dumpInAll = false
+
+        # Dump all incoming EVENT messages
+        dumpInEvents = false
+
+        # Dump all incoming REQ/CLOSE messages
+        dumpInReqs = false
+
+        # Log performance metrics for initial REQ database scans
+        dbScanPerf = false
+    }
+
+    numThreads {
+        # Ingester threads: route incoming requests, validate events/sigs (restart required)
+        ingester = 5
+
+        # reqWorker threads: Handle initial DB scan for events (restart required)
+        reqWorker = 5
+
+        # reqMonitor threads: Handle filtering of new events (restart required)
+        reqMonitor = 3
+
+        # yesstr threads: Experimental yesstr protocol (restart required)
+        yesstr = 1
+    }
+
+    negentropy {
+        # Support negentropy protocol messages
+        enabled = false
+
+        # Maximum records that sync will process before returning an error
+        maxSyncEvents = 1000000
+    }
+}
+
+events {
+    # Maximum size of normalised JSON, in bytes
+    maxEventSize = 65536
+
+    # Events newer than this will be rejected
+    rejectEventsNewerThanSeconds = 900
+
+    # Events older than this will be rejected
+    rejectEventsOlderThanSeconds = 94608000
+
+    # Ephemeral events older than this will be rejected
+    rejectEphemeralEventsOlderThanSeconds = 60
+
+    # Ephemeral events will be deleted from the DB when older than this
+    ephemeralEventsLifetimeSeconds = 300
+
+    # Maximum number of tags allowed
+    maxNumTags = 2000
+
+    # Maximum size for tag values, in bytes
+    maxTagValSize = 1024
+}
+
+

strfry/plugins/allowed_rules.js

@@ -0,0 +1,44 @@
+#!/usr/bin/env -S deno run
+
+const WHITELIST = {
+  pubs: {
+    "56d4b3d6310fadb7294b7f041aab469c5ffc8991b1b1b331981b96a246f6ae65": true, // Tagr
+  },
+  eventKinds: [
+    0, // Metadata
+    3, // Contacts
+    1059, // Gift wrap messages
+    10002, // Relay list metadata
+  ],
+};
+
+import { stdin, stdout } from "node:process";
+import { createInterface } from "node:readline";
+
+const rl = createInterface({
+  input: stdin,
+  output: stdout,
+  terminal: false,
+});
+
+rl.on("line", (line) => {
+  let req = JSON.parse(line);
+
+  if (req.type !== "new") {
+    return;
+  }
+
+  let res = { id: req.event.id }; // must echo the event's id
+
+  const isAllowedPub = ALLOWED.pubs.hasOwnProperty(req.event.pubkey);
+  const isAllowedEventKind = ALLOWED.eventKinds.includes(req.event.kind);
+
+  if (isAllowedPub || isAllowedEventKind) {
+    res.action = "accept";
+  } else {
+    res.action = "reject";
+    res.msg = "blocked: not on white-list";
+  }
+
+  console.log(JSON.stringify(res));
+});