2023-03-27 09:09:48 +00:00
|
|
|
# `@snort/nostr`
|
|
|
|
|
|
|
|
A strongly-typed nostr client for Node and the browser.
|
|
|
|
|
|
|
|
## NIP support
|
|
|
|
|
|
|
|
### Applicable
|
|
|
|
|
|
|
|
The goal of the project is to have all of the following implemented
|
|
|
|
and tested against a real-world relay implementation.
|
|
|
|
|
2023-03-20 20:23:03 +00:00
|
|
|
_Progress: 8/34 (23%)._
|
2023-03-27 09:09:48 +00:00
|
|
|
|
2023-04-01 12:53:03 +00:00
|
|
|
- [x] NIP-01: Basic protocol flow description
|
|
|
|
- [x] NIP-02: Contact List and Petnames
|
2023-03-27 09:09:48 +00:00
|
|
|
- [ ] NIP-03: OpenTimestamps Attestations for Events
|
2023-04-01 12:53:03 +00:00
|
|
|
- [x] NIP-04: Encrypted Direct Message
|
|
|
|
- [x] NIP-05: Mapping Nostr keys to DNS-based internet identifiers
|
2023-03-27 09:09:48 +00:00
|
|
|
- [ ] NIP-06: Basic key derivation from mnemonic seed phrase
|
|
|
|
- [ ] NIP-07: window.nostr capability for web browsers
|
2023-04-01 14:02:36 +00:00
|
|
|
- [x] NIP-09: Event Deletion
|
2023-03-27 09:09:48 +00:00
|
|
|
- [ ] NIP-10: Conventions for clients' use of `e` and `p` tags in text events
|
|
|
|
- TODO Check if this applies
|
2023-04-01 12:53:03 +00:00
|
|
|
- [x] NIP-11: Relay Information Document
|
|
|
|
- [x] NIP-12: Generic Tag Queries
|
2023-03-27 09:09:48 +00:00
|
|
|
- [ ] NIP-13: Proof of Work
|
|
|
|
- [ ] NIP-14: Subject tag in text events
|
2023-04-01 12:53:03 +00:00
|
|
|
- [x] NIP-15: End of Stored Events Notice
|
2023-03-27 09:09:48 +00:00
|
|
|
- [ ] NIP-19: bech32-encoded entities
|
2023-04-01 12:53:03 +00:00
|
|
|
- [x] `npub`
|
|
|
|
- [x] `nsec`
|
2023-03-27 09:09:48 +00:00
|
|
|
- [ ] `note`, `nprofile`, `nevent`, `nrelay`, `naddr`
|
2023-04-01 12:53:03 +00:00
|
|
|
- [x] NIP-20: Command Results
|
2023-03-27 09:09:48 +00:00
|
|
|
- [ ] NIP-21: `nostr:` URL scheme
|
|
|
|
- [ ] NIP-23: Long-form Content
|
|
|
|
- [ ] NIP-25: Reactions
|
|
|
|
- [ ] NIP-26: Delegated Event Signing
|
2023-03-20 20:23:03 +00:00
|
|
|
- [ ] NIP-27: Text Note References
|
2023-03-27 09:09:48 +00:00
|
|
|
- [ ] NIP-28: Public Chat
|
|
|
|
- [ ] NIP-36: Sensitive Content
|
|
|
|
- [ ] NIP-39: External Identities in Profiles
|
|
|
|
- [ ] NIP-40: Expiration Timestamp
|
|
|
|
- [ ] NIP-42: Authentication of clients to relays
|
|
|
|
- [ ] NIP-46: Nostr Connect
|
|
|
|
- Not sure how much of this applies, but I sure would love to see WalletConnect disappear
|
|
|
|
- [ ] NIP-50: Keywords filter
|
|
|
|
- [ ] NIP-51: Lists
|
|
|
|
- [ ] NIP-56: Reporting
|
|
|
|
- [ ] NIP-57: Lightning Zaps
|
|
|
|
- [ ] NIP-58: Badges
|
|
|
|
- [ ] NIP-65: Relay List Metadata
|
|
|
|
- [ ] NIP-78: Application-specific data
|
2023-04-17 10:57:13 +00:00
|
|
|
- [x] NIP-94: File Header
|
2023-03-27 09:09:48 +00:00
|
|
|
|
|
|
|
### Not Applicable
|
|
|
|
|
|
|
|
These NIPs only apply to relays and have no implications for a generic nostr client.
|
|
|
|
|
|
|
|
- NIP-16: Event Treatment
|
|
|
|
- NIP-22: Event `created_at` Limits
|
|
|
|
- NIP-33: Parameterized Replaceable Events
|
|
|
|
|
|
|
|
### Others
|
|
|
|
|
|
|
|
_If you notice an accepted NIP missing from both lists above, please [open an
|
|
|
|
issue](https://github.com/v0l/snort/issues/new?assignees=&labels=&template=feature_request.md&title=)
|
|
|
|
to let us know_.
|