feat: add wot#1 config (#623)

* docs(changeset): new user-facing config field

* feat: config schema for wot

* fix: uncovered test

---------

Co-authored-by: Ricardo Cabral <me@ricardocabral.io>

Author: saniddhyaDubey

.changeset/lemon-views-know.md

@@ -0,0 +1,5 @@
+---
+"nostream": minor
+---
+
+new user-facing config field

resources/default-settings.yaml

@@ -62,6 +62,17 @@ nip05:
   domainBlacklist: []
 nip45:
   enabled: true
+wot:
+  # Web of Trust filtering. When enabled, only events from pubkeys within
+  # the relay owner's 2-hop follow graph are accepted.
+  enabled: false
+  # The relay owner's pubkey in hex. This is the root of the trust graph.
+  # Required when enabled is true.
+  seedPubkey: ""
+  # A pubkey must be followed by at least this many 1-hop accounts to be trusted.
+  minimumFollowers: 1
+  # Hours between full trust graph rebuilds.
+  refreshIntervalHours: 24
 network:
   maxPayloadSize: 524288
   # Uncomment only when using a trusted reverse proxy and configuring trustedProxies.

src/@types/settings.ts

@@ -266,6 +266,25 @@ export interface Nip05Settings {
   domainBlacklist?: string[]
 }
 
+export interface WoTSettings {
+  enabled: boolean
+  /**
+   * The relay owner's pubkey (hex). The trust graph is rooted here.
+   * Required when enabled is true.
+   */
+  seedPubkey: Pubkey
+  /**
+   * Minimum number of 1-hop follows a pubkey must have to enter the trust filter.
+   * Defaults to 1.
+   */
+  minimumFollowers: number
+  /**
+   * How many hours between full trust graph rebuilds.
+   * Defaults to 24.
+   */
+  refreshIntervalHours: number
+}
+
 export interface Settings {
   info: Info
   payments?: Payments
@@ -276,4 +295,5 @@ export interface Settings {
   mirroring?: Mirroring
   nip05?: Nip05Settings
   nip45?: Nip45Settings
+  wot?: WoTSettings
 }

test/unit/utils/settings.spec.ts

@@ -2,6 +2,8 @@ import { expect } from 'chai'
 import fs from 'fs'
 import { join } from 'path'
 import Sinon from 'sinon'
+import { mergeDeepRight } from 'ramda'
+import { Settings } from '../../../src/@types/settings'
 
 import { SettingsFileTypes, SettingsStatic } from '../../../src/utils/settings'
 
@@ -258,4 +260,29 @@ describe('SettingsStatic', () => {
       )
     })
   })
+
+  describe('WoT settings defaults', () => {
+    it('default-settings.yaml contains a wot block with enabled: false', () => {
+      const defaults = SettingsStatic.loadAndParseYamlFile(
+        SettingsStatic.getDefaultSettingsFilePath()
+      )
+      expect(defaults).to.have.nested.property('wot.enabled', false)
+      expect(defaults).to.have.nested.property('wot.seedPubkey', '')
+      expect(defaults).to.have.nested.property('wot.minimumFollowers', 1)
+      expect(defaults).to.have.nested.property('wot.refreshIntervalHours', 24)
+    })
+
+    it('user config wot block overrides defaults', () => {
+      const defaults = SettingsStatic.loadAndParseYamlFile(
+        SettingsStatic.getDefaultSettingsFilePath()
+      )
+      const userConfig = { wot: { enabled: true, seedPubkey: 'abc123', minimumFollowers: 3 } }
+      const merged = mergeDeepRight(defaults, userConfig) as Settings
+      expect(merged.wot?.enabled).to.equal(true)
+      expect(merged.wot?.seedPubkey).to.equal('abc123')
+      expect(merged.wot?.minimumFollowers).to.equal(3)
+      // non-overridden fields stay as defaults
+      expect(merged.wot?.refreshIntervalHours).to.equal(24)
+    })
+  })
 })