Skip to content

README.md

Latest commit

 

History

History
71 lines (50 loc) · 1.74 KB

README.md

File metadata and controls

71 lines (50 loc) · 1.74 KB

Trusted Relays

A tool for computing and publishing trust scores for Nostr relays using Trusted Relay Assertions (kind 30385 events).

Installation

bun install

Quick Start

# Probe a relay and see its scores
bun run src/index.ts probe wss://relay.damus.io

# Start the web dashboard
bun run src/index.ts api --port 3000

# Run as a continuous service (Recommended)
bun run src/index.ts daemon

Commands

probe [relay...]          Probe relay(s) and compute scores
watch [--interval N]      Continuous probing
list                      List known relays
stats [relay...]          Show relay statistics

discover                  Find NIP-66 monitors
ingest                    Ingest NIP-66 metrics
reports ingest            Ingest user reports (kind 1985)

publish [--force]         Publish assertions (kind 30385)
keygen                    Generate signing keypair

api [--port N]            Start web dashboard & API
daemon [--config path]    Run production service

help                      Show all commands

Environment Variables

Variable Description
NOSTR_PRIVATE_KEY Private key for signing (nsec or hex)
NOSTR_PUBLISH_RELAYS Comma-separated publish relays

Deployment

Docker:

docker-compose up -d

Systemd:

sudo cp trustedrelays.service /etc/systemd/system/
sudo systemctl enable --now trustedrelays

See ARCHITECTURE.md for detailed deployment instructions.

Documentation