README.md

Overview

Primal Server includes caching, membership, discovery and media caching services for Nostr. It connects to the specified set of relays, collects all events in real time, stores them locally, and makes them available to nostr clients through a web socket-based API.

Usage

Setup database server:

nix develop -c sh -c '$setup_postgres $PWD/var/pg $PWD/var/pgdata'

Setup pg_primal (Primal database extension):

nix develop -c sh -c '$setup_pg_primal'

Setup other database extensions:

nix develop -c sh -c '$setup_pg_extensions'

Start database in the background:

nix develop -c sh -c '$start_postgres'

Initialize database schema:

nix develop -c sh -c '$init_postgres_schema'

Running the Primal server:

nix develop -c sh -c '$start_primal_server'

Connect to database:

nix develop -c sh -c '$connect_to_postgres'

API requests

Read app_*.jl for list of all supported arguments.

Examples:

["REQ", "amelx49c18", {"cache": ["net_stats"]}]
["CLOSE", "amelx49c18"]

["REQ", "p0xren2axa", {"cache": ["feed", {"pubkey": "64-hex digits of pubkey id"}]}]

["REQ", "vqvv4vc6us", {"cache": ["thread_view", {"event_id": "64-hex digits of event id"}]}]

["REQ", "ay4if6pykg", {"cache": ["user_infos", {"pubkeys": ["64-hex digits of pubkey id"]}]}]

["REQ", "2t6z17orjp", {"cache": ["events", {"event_ids": ["64-hex digits of event id"]}]}]

["REQ", "1uddc0a2fv", {"cache": ["user_profile", {"pubkey": "64-hex digits of pubkey id"}]}]