avlo/superconductor

Nostr Relay - Java/Spring/WebSocketSession Implementation

███████╗██╗   ██╗██████╗ ███████╗██████╗  ██████╗ ██████╗ ███╗   ██╗██████╗ ██╗   ██╗ ██████╗████████╗ ██████╗ ██████╗
██╔════╝██║   ██║██╔══██╗██╔════╝██╔══██╗██╔════╝██╔═══██╗████╗  ██║██╔══██╗██║   ██║██╔════╝╚══██╔══╝██╔═══██╗██╔══██╗
███████╗██║   ██║██████╔╝█████╗  ██████╔╝██║     ██║   ██║██╔██╗ ██║██║  ██║██║   ██║██║        ██║   ██║   ██║██████╔╝
╚════██║██║   ██║██╔═══╝ ██╔══╝  ██╔══██╗██║     ██║   ██║██║╚██╗██║██║  ██║██║   ██║██║        ██║   ██║   ██║██╔══██╗
███████║╚██████╔╝██║     ███████╗██║  ██║╚██████╗╚██████╔╝██║ ╚████║██████╔╝╚██████╔╝╚██████╗   ██║   ╚██████╔╝██║  ██║
╚══════╝ ╚═════╝ ╚═╝     ╚══════╝╚═╝  ╚═╝ ╚═════╝ ╚═════╝ ╚═╝  ╚═══╝╚═════╝  ╚═════╝  ╚═════╝   ╚═╝    ╚═════╝ ╚═╝  ╚═╝

Java Nostr-Relay Framework & Web Application

Supported Nips

• NIP-01 (Basic protocol & Standard Tags)
• NIP-02 (Contact List and Petnames)
• NIP-10 (Marked "e" tags)
• NIP-11 (Relay Information Document)
• NIP-12 (Generic Tag Queries)
• NIP-14 (Subject tag in Text events)
• NIP-16 (Event treatment)
• NIP-19 (Bech-32 encoded entities)
• NIP-20 (Command Results)
• NIP-21 (URI scheme)
• NIP-22 (Event "created_at" limits)
• NIP-31 (Unknown event kinds)
• NIP-33 (Parameterized Replaceable Events)
• NIP-57 (Lightning Zaps)
• NIP-99 (Classified Listings)
• used by Barchetta Smart-Contract Negotiation Protocol (in progress) atop Bitcoin Lightning-Network RGB

In-Progress

• NIP-15 (Nostr Marketplace)
  • used by Barchetta Smart-Contract Negotiation Protocol (in progress) atop Bitcoin Lightning-Network RGB

---

Normal/Production Mode (for most users) Instructions:

Confirm minimal docker requirements

$ docker --version

Docker version 27.0.3

$ docker compose version

Docker Compose version v2.28.1

(Download links for the above)

• Docker 27.0.3
• Docker Compose v2.28.1

---

Download Superconductor Docker Image from hub.docker

$ docker pull avlo/superconductor-app:1.7.0

---

Download Docker-Compose configuration file:

docker-compose.yml

---

Run SuperConductor

$ docker compose -f /<path>/<to>/docker-compose.yml up -d

Superconductor is now ready to use.

---

Stop docker containers

$ docker compose -f docker-compose.yml stop superconductor-app superconductor-db

Remove docker containers

$ docker compose -f docker-compose.yml down --remove-orphans

---

Development Mode Instructions