nostrrelay/README.md

Nostr Relay

One click and spin up your own Nostr relay. Share with the world, or use privately.

Usage

Install this extension into your LNbits instance. ....

Supported NIPs

• NIP-01: Basic protocol flow
• NIP-02: Contact List and Petnames
  • kind: 3: delete past contact lists as soon as the relay receives a new one
• NIP-04: Encrypted Direct Message
  • if AUTH enabled: send only to the intended target
• NIP-09: Event Deletion
• NIP-11: Relay Information Document

  • Note

    : the endpoint is NOT on the root level of the domain. It also includes a path (eg https://lnbits.link/nostrrelay/)

• NIP-12: Generic Tag Queries
  • todo
• NIP-15: End of Stored Events Notice
• NIP-16: Event Treatment
  • Regular Events
  • Replaceable Events
  • Ephemeral Events
• NIP-20: Command Results
  • todo: use correct prefixes
• NIP-22: Event created_at Limits
• NIP-26: Delegated Event Signing
  • not planned
• NIP-28 Public Chat
  • kind: 41: handled similar to kind 0 metadata events
• NIP-33: Parameterized Replaceable Events
  • todo
• NIP-40: Expiration Timestamp
  • todo
• NIP-42: Authentication of clients to relays
  • todo: use correct prefix
• NIP-50: Search Capability
  • todo

Usage

Create Relay

Creating a new relay is straightforward. Just click New Relay then enter the Relay Info.

Note

The relay can be activated/deactivated.

Configure Relay

Development

Create Symbolic Link:

ln -s /Users/my-user/git-repos/nostr-relay-extension/ /Users/my-user/git-repos/lnbits/lnbits/extensions/nostrrelay