rx-nostr

rx-nostr is a library that supports high quality and flexible communication with multiple Nostr relays.

documentation / release notes

Description

rx-nostr provides transparent interface to read/write events on Nostr relays. You can exchange data in a very familiar way (as you see NIP-01) with that interface, but it allows for far more robust and flexible communication than you can do by touching WebSocket directly. For example:

• Auto sign/verify
  • Sign/verify events automatically by integrating with rx-nostr-crypto or other arbitrary crypto libraries.
• Auto adaptive reconnection
  • If the subscription is based on a time relative to its start time, consider it when auto reconnecting.
• Auto expiration check
  • Based on NIP-40, ignore expired events.
• REQ queue respecting NIP-11
  • Based on NIP-11, queuing requests if they exceed the limit of subscriptions that can run concurrently.
• Reactive relay pool
  • On updating "default relays", the subscriptions on default relays is reconstructed on new default relays.
• Monitoring WebSocket connection
  • For example, it helps you show relay status to users.
• Lazy connection
  • As default, connection is deferred until it is really needed.
• Idling connection
  • As default, connections that are no longer needed are automatically disconnected temporarily.

Under the hood, rx-nostr makes use of RxJS, but you don't need to touch it directly. Of course, if you are familiar with RxJS, you can integrate with it for easier and more declarative writing.

Quickstart

npm install rx-nostr rx-nostr-crypto

import { createRxNostr, createRxForwardReq } from "rx-nostr";
import { verifier, seckeySigner } from "rx-nostr-crypto";

import WebSocket from "ws";

const rxNostr = createRxNostr({
  signer: seckeySigner("nsec1..."), // If omitted, rx-nostr uses NIP-07.
  verifier,
  websocketCtor: WebSocket, // You need this if `globalThis.WebSocket` doesn't exist (e.g. Node.js runtime).
});

rxNostr.setDefaultRelays(["wss://nostr.example.com"]);

const rxReq = createRxForwardReq();

// Define a listener.
rxNostr.use(rxReq).subscribe(({ event }) => {
  console.log(event);
});

// Emit a filter to start subscription.
rxReq.emit({ kinds: [1] });

For more information

• Documentation: https://penpenpng.github.io/rx-nostr/
• Release notes: https://github.com/penpenpng/rx-nostr/releases

License

MIT