Relays

Nostrify provides a relay and a pool with a simple interface.

for await (const msg of relay.req([{ kinds: [1, 6] }])) {
  if (msg[0] === 'EVENT') console.log(msg[2]);
  if (msg[0] === 'EOSE') break;
}

Relays on Nostrify are actually just another type of storage. They implement NRelay (which is based on NStore). As a result, relays and storages are interchangeable in most cases.

// Normal `NStore` methods work on relays, too!

await relay.event(event); // Insert an event
const events = await relay.query({ kinds: [0] }); // Get events

Usage

Most Nostr libraries use callbacks to stream data from relays. Nostrify uses AsyncGenerators instead, which are more powerful and easier to use.

Messages are streamed in a for-loop when calling .req(). This method returns an async generator that yields NIP-01 messages from the relay. Breaking out of the loop closes the subscription automatically.

for await (const msg of relay.req([{ kinds: [0] }])) {
  console.log(msg);
  break; // <- This sends a `CLOSE` message to the relay automatically!
}

You can also cancel a subscription with an AbortSignal.

const controller = new AbortController();
const signal = controller.signal;

const subscription = relay.req([{ kinds: [0] }], { signal });

// Later...

controller.abort(); // <- This sends a `CLOSE` message to the relay

TIP

You should pass a signal into relay methods, or they will be allowed to run forever. All relay methods accept a signal in the second argument.

Implementations

• NRelay1 - Manages a connection to a single relay, automatically reconnecting if the connection is lost.

• NPool - Manages a pool of relays, designed with the Outbox model in mind.

Custom Relays

You can create your own relay by implementing the NRelay interface. This allows you to connect to a relay however you choose.

import { NostrEvent, NostrFilter, NostrRelayMsg, NRelay } from '@nostrify/nostrify';

class MyRelay implements NRelay {
  async *req(filters: NostrFilter[], { signal }: { signal?: AbortSignal } = {}): AsyncIterable<NostrRelayMsg> {
    // Stream messages from the relay.
  }

  async event(event: NostrEvent): Promise<void> {
    // Insert an event.
  }

  async query(filters: NostrFilter[]): Promise<NostrEvent[]> {
    // Query events.
  }
}