nostrrelay/README.md
2023-02-16 18:09:48 +02:00

48 lines
1.5 KiB
Markdown

# 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
- [x] **NIP-01**: Basic protocol flow
- [x] **NIP-02**: Contact List and Petnames
- `kind: 3`: delete past contact lists as soon as the relay receives a new one
- [x] **NIP-04**: Encrypted Direct Message
- if `AUTH` enabled: send only to the intended target
- [x] **NIP-09**: Event Deletion
- [x] **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
- [x] **NIP-15**: End of Stored Events Notice
- [ ] **NIP-16**: Event Treatment
- [x] Regular Events
- [ ] Replaceable Events
- [ ] Ephemeral Events
- [x] **NIP-20**: Command Results
- todo: use correct prefixes
- [x] **NIP-22**: Event created_at Limits
- [ ] **NIP-26**: Delegated Event Signing
- not planned
- [x] **NIP-28** Public Chat
- `kind: 41`: handled similar to `kind 0` metadata events
- [ ] **NIP-33**: Parameterized Replaceable Events
- todo
- [ ] **NIP-40**: Expiration Timestamp
- todo
- [x] **NIP-42**: Authentication of clients to relays
- todo: use correct prefix
- [ ] **NIP-50**: Search Capability
- todo
### Development
Create Symbolic Link:
```
ln -s /Users/my-user/git-repos/nostr-relay-extension/ /Users/my-user/git-repos/lnbits/lnbits/extensions/nostrrelay
```