@toon-protocol/relay

@toon-protocol/relay

A Nostr relay app: free NIP-01 WebSocket reads plus an HTTP POST /write surface for storing events.

The relay contains no ILP, connector, settlement, or pricing logic. Payment is enforced entirely upstream by an external terminator — by the time a write reaches this process it is already proven paid, so the relay simply stores the event and serves reads.

Install

npm install @toon-protocol/relay

Run (CLI)

NOSTR_SECRET_KEY=<64-char-hex> npx @toon-protocol/relay
# reads:  ws://localhost:7100
# writes: http://localhost:3100/write
# health: http://localhost:3100/health

Run (programmatic)

import { startRelay } from '@toon-protocol/relay';

const relay = await startRelay({ secretKey });
// ... POST /write on 3100, read NIP-01 on 7100 ...
await relay.stop();

HTTP surface

WebSocket Relay Server

NIP-01 compliant WebSocket server that stores and serves Nostr events in TOON format.

import { NostrRelayServer, SqliteEventStore } from '@toon-protocol/relay';

const eventStore = new SqliteEventStore('./events.db');
const relay = new NostrRelayServer({ port: 7100 }, eventStore);

await relay.start();
relay.broadcastEvent(event); // push to matching subscriptions
await relay.stop();

Event Storage

import { InMemoryEventStore, SqliteEventStore } from '@toon-protocol/relay';

const memStore = new InMemoryEventStore();      // ephemeral
const sqlStore = new SqliteEventStore('./events.db'); // persistent

memStore.store(event);
const found = memStore.get(event.id);
const results = memStore.query([{ kinds: [1], limit: 10 }]);

TOON Codec

Re-exported from @toon-protocol/core for convenience.

import { encodeEventToToon, decodeEventFromToon } from '@toon-protocol/relay';

Full API

License

MIT