README.md

nostr-kt-relay

Overview

nostr-kt-relay is a Kotlin-based relay server for the Nostr protocol, focused on scalability and efficient traffic management.

🚧 It's in active development and may be unstable.

NIPs

• NIP-01: Basic protocol flow description
• NIP-02: Follow List
• NIP-04: Encrypted Direct Message
• NIP-09: Event Deletion
• NIP-11: Relay Information Document
• NIP-12: Generic Tag Queries
• NIP-15: Nostr Marketplace
• NIP-28: Public Chat
• NIP-40: Expiration Timestamp
• NIP-42: Authentication of clients to relays
• NIP-45: Event Counts
• NIP-50: Search Capability

Building and Running

Build a fat JAR

./gradlew buildFatJar

Run a fat JAR

DB_URL=${DB_URL} DB_USER=${DB_USER} DB_PASSWORD=${DB_PASSWORD} ./gradlew runFatJar