You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

428 lines
14 KiB

/**
* NIP-66 relay monitor cron. Runs on the server; nsec stays in env, never sent to client.
* - On startup: publish kind 10166 (monitor announcement) once.
* - Every INTERVAL_MS: for each relay in the resolved monitor list, fetch NIP-11, build & publish 30166.
*
* Which relays are monitored:
* 1) If RELAYS_TO_MONITOR is set: use that comma-separated list only (operator override).
* 2) Else (default): merge built-in DEFAULT_RELAYS_TO_MONITOR with the monitor account’s kind 10002
* (`r` tags), deduped (defaults first, then 10002-only URLs). If no 10002 is found or it has no `r`
* URLs, use defaults only.
* Set RELAY_LIST_SKIP_KIND10002=1 to skip fetching 10002 and use defaults only.
*
* nostr.watch (and similar) only show relays that received a 30166. Relays whose NIP-11 HTTPS fetch
* fails from this container are skipped — check logs for "NIP-11 fetch failed" / "Skipping relay".
*
* Env:
* NIP66_MONITOR_NSEC - required; nsec for signing 30166/10166 (also used to find kind 10002 author)
* RELAYS_TO_MONITOR - optional; if set, replaces merged list (static URLs only)
* RELAY_LIST_SKIP_KIND10002 - optional; "1"/"true" = do not fetch kind 10002; defaults only
* PUBLISH_RELAYS - optional; comma-separated relays to publish/query / REQ 10002
* MAX_RELAYS_TO_MONITOR - optional; cap after merge (default 500)
* INTERVAL_MS - optional; ms between full monitor runs (default 900000 = 15m)
*/
import { finalizeEvent, getPublicKey, nip19 } from 'nostr-tools'
import WebSocket from 'ws'
const RELAY_DISCOVERY_KIND = 30166
const RELAY_MONITOR_ANNOUNCEMENT_KIND = 10166
/**
* Default URLs to run NIP-11 checks against (30166); always merged with the monitor’s kind 10002 unless overridden.
* Union of relay presets in src/constants.ts: DEFAULT_FAVORITE_RELAYS, FAST_READ_RELAY_URLS,
* NIP66_DISCOVERY_RELAY_URLS, BOOKSTR_RELAY_URLS, READ_ONLY_RELAY_URLS, SOCIAL_KIND_BLOCKED_RELAY_URLS,
* FAST_READ_RELAY_URLS, FAST_WRITE_RELAY_URLS, GIF_RELAY_URLS, SEARCHABLE_RELAY_URLS,
* PROFILE_RELAY_URLS, DEFAULT_NOSTRCONNECT_RELAY — deduped, sorted.
*/
// Deduplicated list of default relays to monitor (normalized URLs, first occurrence preserved)
const DEFAULT_RELAYS_TO_MONITOR = [
'wss://theforest.nostr1.com',
'wss://orly-relay.imwald.eu',
'wss://nostr.land',
'wss://thecitadel.nostr1.com',
'wss://relay.nostr.watch',
'wss://relaypag.es',
'wss://hist.nostr.land',
'wss://profiles.nostr1.com',
'wss://purplepag.es',
'wss://nostr.wine',
'wss://nostr21.com',
'wss://aggr.nostr.land',
'wss://relay.damus.io',
'wss://relay.primal.net',
'wss://nos.lol',
'wss://relay.gifbuddy.lol',
'wss://freelay.sovbit.host',
'wss://search.nos.today',
'wss://relay.snort.social',
'wss://nostr.mom',
'wss://relay.noswhere.com',
'wss://relay.wikifreedia.xyz',
'wss://nostr.einundzwanzig.space',
'wss://nostrelites.org',
'wss://relay.nsec.app',
'wss://bucket.coracle.social',
'wss://spatia-arcana.com',
'wss://nostr-pub.wellorder.net',
'wss://pyramid.fiatjaf.com/',
'wss://nostr.lopp.social/',
'wss://relay.dergigi.com/'
]
/** Relays to publish 30166/10166 and to REQ kind 10002 from; broad enough for Imwald + NIP-66 discovery. */
const DEFAULT_PUBLISH_RELAYS = [
'wss://nos.lol',
'wss://orly-relay.imwald.eu',
'wss://relay.damus.io',
'wss://relay.nostr.watch',
'wss://relay.primal.net',
'wss://relaypag.es',
'wss://thecitadel.nostr1.com'
]
/** Default 15 minutes; kind 10166 `frequency` tag uses the same interval in seconds. */
const INTERVAL_MS = Number(process.env.INTERVAL_MS) || 900000
const MAX_RELAYS_TO_MONITOR = Math.min(
2000,
Math.max(1, Number(process.env.MAX_RELAYS_TO_MONITOR) || 500)
)
function log (msg, data = {}) {
const ts = new Date().toISOString()
console.log(ts, '[nip66-cron]', msg, Object.keys(data).length ? JSON.stringify(data) : '')
}
function normalizeRelayUrl (url) {
try {
const u = url.replace(/^ws:\/\//, 'wss://')
const p = new URL(u.startsWith('wss://') ? u : `wss://${u}`)
p.pathname = p.pathname.replace(/\/+/g, '/').replace(/\/$/, '') || '/'
return p.toString()
} catch {
return url
}
}
/** Returns decoded secret key from env. Never log or expose process.env.NIP66_MONITOR_NSEC. */
function getSecretKey () {
const raw = process.env.NIP66_MONITOR_NSEC
if (!raw || typeof raw !== 'string') return null
try {
const { type, data } = nip19.decode(raw)
if (type !== 'nsec') return null
return data
} catch {
return null
}
}
async function fetchNip11 (relayUrl) {
const httpUrl = relayUrl.replace(/^wss:\/\//, 'https://').replace(/^ws:\/\//, 'http://')
try {
const res = await fetch(httpUrl, { headers: { Accept: 'application/nostr+json' } })
if (!res.ok) return null
return await res.json()
} catch (err) {
log('NIP-11 fetch failed', { url: relayUrl, err: err.message })
return null
}
}
function build30166 (relayUrl, nip11, sk) {
const d = normalizeRelayUrl(relayUrl)
const tags = [['d', d]]
const nips = nip11?.supported_nips
if (Array.isArray(nips)) {
for (const n of nips) tags.push(['N', String(n)])
}
const lim = nip11?.limitation
tags.push(['R', lim?.auth_required ? 'auth' : '!auth'])
tags.push(['R', lim?.payment_required ? 'payment' : '!payment'])
const draft = {
kind: RELAY_DISCOVERY_KIND,
created_at: Math.floor(Date.now() / 1000),
content: '',
tags
}
return finalizeEvent(draft, sk)
}
function build10166 (sk) {
const freqSec = Math.max(60, Math.round(INTERVAL_MS / 1000))
const draft = {
kind: RELAY_MONITOR_ANNOUNCEMENT_KIND,
created_at: Math.floor(Date.now() / 1000),
content: '',
tags: [['frequency', String(freqSec)], ['c', 'nip11'], ['c', 'ws']]
}
return finalizeEvent(draft, sk)
}
function parseListEnv (envVar, defaultList) {
const raw = process.env[envVar]
if (!raw || typeof raw !== 'string') return defaultList
return raw.split(',').map(s => s.trim()).filter(Boolean)
}
/**
* REQ kind 10002 from `authorPubkey` on first relay that returns events; return deduped wss URLs from `r` tags.
*/
async function fetchRelayUrlsFromKind10002 (authorPubkey, queryRelayUrls) {
const pk = (authorPubkey || '').trim().toLowerCase()
if (!/^[0-9a-f]{64}$/.test(pk)) {
log('Invalid pubkey for kind 10002 fetch (expected 64 hex chars)')
return []
}
const subId = 'nip66rl' + Math.random().toString(36).slice(2, 10)
const filter = { kinds: [10002], authors: [pk], limit: 30 }
for (const relayUrl of queryRelayUrls) {
let ws
try {
ws = new WebSocket(relayUrl, { handshakeTimeout: 12000 })
await new Promise((resolve, reject) => {
let timeoutId
let resolved = false
const cleanup = () => {
if (resolved) return
resolved = true
clearTimeout(timeoutId)
ws.removeListener('open', onOpen)
ws.removeListener('error', onError)
}
const onOpen = () => {
cleanup()
resolve()
}
const onError = (err) => {
cleanup()
reject(err)
}
timeoutId = setTimeout(() => {
cleanup()
reject(new Error('open timeout'))
}, 15000)
ws.once('open', onOpen)
ws.on('error', onError)
})
ws.send(JSON.stringify(['REQ', subId, filter]))
const events = await new Promise((resolve) => {
const acc = []
const t = setTimeout(() => {
cleanup()
resolve(acc)
}, 20000)
function cleanup () {
clearTimeout(t)
ws.removeListener('message', onMessage)
}
function onMessage (data) {
let msg
try {
msg = JSON.parse(data.toString())
} catch {
return
}
if (msg[0] === 'EVENT' && msg[1] === subId && msg[2]) acc.push(msg[2])
if (msg[0] === 'EOSE' && msg[1] === subId) {
cleanup()
resolve(acc)
}
}
ws.on('message', onMessage)
})
try {
ws.close()
} catch (_) {}
if (!events.length) continue
events.sort((a, b) => (b.created_at || 0) - (a.created_at || 0))
const ev = events[0]
const urls = new Set()
for (const t of ev.tags || []) {
if (t[0] !== 'r' || !t[1] || typeof t[1] !== 'string') continue
const u = t[1].trim()
if (u.startsWith('wss://') || u.startsWith('ws://')) urls.add(normalizeRelayUrl(u))
}
const list = [...urls]
log('Fetched kind 10002 relay list', { relay: relayUrl, author: pk.slice(0, 12), count: list.length })
return list
} catch (err) {
log('Kind 10002 fetch relay error', { relay: relayUrl, err: err.message })
try {
ws?.close()
} catch (_) {}
}
}
log('No kind 10002 found for author on query relays', { author: pk.slice(0, 12) })
return []
}
/** Concatenate lists, normalize, dedupe by URL string; order preserved (first list wins position). */
function mergeRelayUrlLists (...lists) {
const seen = new Set()
const out = []
for (const list of lists) {
for (const raw of list) {
if (!raw || typeof raw !== 'string') continue
const n = normalizeRelayUrl(raw.trim())
if (!n.startsWith('wss://') && !n.startsWith('ws://')) continue
if (seen.has(n)) continue
seen.add(n)
out.push(n)
}
}
return out
}
/**
* Resolve monitor URL list for this run.
*/
async function resolveRelaysToMonitor (sk, publishRelays) {
const rawEnv = process.env.RELAYS_TO_MONITOR
if (rawEnv && typeof rawEnv === 'string' && rawEnv.trim()) {
const list = rawEnv.split(',').map(s => normalizeRelayUrl(s.trim())).filter(Boolean)
log('Using RELAYS_TO_MONITOR override', { count: list.length })
return list.slice(0, MAX_RELAYS_TO_MONITOR)
}
const defaults = DEFAULT_RELAYS_TO_MONITOR.map((u) => normalizeRelayUrl(u))
const skip10002 =
process.env.RELAY_LIST_SKIP_KIND10002 === '1' ||
process.env.RELAY_LIST_SKIP_KIND10002 === 'true' ||
process.env.RELAY_LIST_SKIP_KIND10002 === 'yes'
if (skip10002) {
log('RELAY_LIST_SKIP_KIND10002 set; using default relay list only', { count: defaults.length })
return defaults.slice(0, MAX_RELAYS_TO_MONITOR)
}
const monitorPubkey = getPublicKey(sk)
const from10002 = await fetchRelayUrlsFromKind10002(monitorPubkey, publishRelays)
if (from10002.length === 0) {
log('No kind 10002 relays merged; using default list only', {
monitorPubkey: monitorPubkey.slice(0, 12),
defaultCount: defaults.length
})
return defaults.slice(0, MAX_RELAYS_TO_MONITOR)
}
const merged = mergeRelayUrlLists(defaults, from10002)
log('Merged default relays with monitor kind 10002', {
monitorPubkey: monitorPubkey.slice(0, 12),
defaultCount: defaults.length,
kind10002Count: from10002.length,
mergedCount: merged.length
})
return merged.slice(0, MAX_RELAYS_TO_MONITOR)
}
async function publishEvent (relayUrls, event) {
const msg = JSON.stringify(['EVENT', event])
let ok = 0
const conns = []
for (const url of relayUrls) {
try {
const ws = new WebSocket(url, { handshakeTimeout: 8000 })
await new Promise((resolve, reject) => {
let timeoutId
let resolved = false
const cleanup = () => {
if (resolved) return
resolved = true
clearTimeout(timeoutId)
ws.removeListener('open', onOpen)
ws.removeListener('error', onError)
}
const onOpen = () => {
cleanup()
resolve()
}
const onError = (err) => {
cleanup()
reject(err)
}
timeoutId = setTimeout(() => {
cleanup()
reject(new Error('open timeout'))
}, 10000)
ws.once('open', onOpen)
ws.on('error', onError)
})
conns.push(ws)
ws.send(msg)
await new Promise((resolve) => {
const onResp = (data) => {
try {
const j = JSON.parse(data.toString())
if (j[0] === 'OK' && j[1] === event.id) {
ok++
if (j[2] === true) { /* accepted */ } else { log('Relay rejected event', { url, reason: j[2] }) }
}
} finally {
resolve()
}
}
ws.once('message', onResp)
setTimeout(resolve, 3000)
})
} catch (err) {
log('Publish relay error', { url, err: err.message })
}
}
for (const ws of conns) {
try { ws.close() } catch (_) {}
}
return ok
}
async function run10166 (sk, publishRelays) {
const event = build10166(sk)
log('Publishing 10166 (monitor announcement)')
const count = await publishEvent(publishRelays, event)
log('Published 10166', { successCount: count })
}
async function run30166Round (sk, relaysToMonitor, publishRelays) {
log('30166 round start', { relayCount: relaysToMonitor.length })
for (const relayUrl of relaysToMonitor) {
const nip11 = await fetchNip11(relayUrl)
if (!nip11) {
log('Skipping relay (no NIP-11)', { url: relayUrl })
continue
}
const event = build30166(relayUrl, nip11, sk)
const count = await publishEvent(publishRelays, event)
log('Published 30166', { url: relayUrl, successCount: count })
}
}
async function main () {
const sk = getSecretKey()
if (!sk) {
log('No NIP66_MONITOR_NSEC set; exiting')
process.exit(0)
}
log('NIP-66 monitor cron started (nsec configured)')
const publishRelays = parseListEnv('PUBLISH_RELAYS', DEFAULT_PUBLISH_RELAYS)
await run10166(sk, publishRelays)
const run = async () => {
const relaysToMonitor = await resolveRelaysToMonitor(sk, publishRelays)
await run30166Round(sk, relaysToMonitor, publishRelays)
}
await run()
setInterval(run, INTERVAL_MS)
}
main().catch((err) => {
console.error('[nip66-cron]', err)
process.exit(1)
})