verbiricha/snort
1
0
Fork 0
forked from Kieran/snort
Code Pull Requests Activity
c1a022d795
snort/packages/nostr/README.md

67 lines
2.1 KiB
Markdown
Raw Normal View History

`nostr` package: vastly simplify the API (#412) * vastly simplify the api * add missing await * add eose to emitter * add eose to conn * add eose to the client * eose test * improve test suite, add dm tests * demonstrate that nostr-rs-relay auth options don't work * readme files * cleanup * fetch relay info * test readyState * export fetchRelayInfo * cleanup * better async/await linting * use strictEqual in tests * additional eslint rules * allow arbitrary extensions * saner error handling * update README * implement nip-02 --------- Co-authored-by: Kieran <kieran@harkin.me>
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.
nip-05
2023-03-20 20:23:03 +00:00
_Progress: 8/34 (23%)._
`nostr` package: vastly simplify the API (#412) * vastly simplify the api * add missing await * add eose to emitter * add eose to conn * add eose to the client * eose test * improve test suite, add dm tests * demonstrate that nostr-rs-relay auth options don't work * readme files * cleanup * fetch relay info * test readyState * export fetchRelayInfo * cleanup * better async/await linting * use strictEqual in tests * additional eslint rules * allow arbitrary extensions * saner error handling * update README * implement nip-02 --------- Co-authored-by: Kieran <kieran@harkin.me>
2023-03-27 09:09:48 +00:00
formatting
2023-04-01 12:53:03 +00:00
- [x] NIP-01: Basic protocol flow description
- [x] NIP-02: Contact List and Petnames
`nostr` package: vastly simplify the API (#412) * vastly simplify the api * add missing await * add eose to emitter * add eose to conn * add eose to the client * eose test * improve test suite, add dm tests * demonstrate that nostr-rs-relay auth options don't work * readme files * cleanup * fetch relay info * test readyState * export fetchRelayInfo * cleanup * better async/await linting * use strictEqual in tests * additional eslint rules * allow arbitrary extensions * saner error handling * update README * implement nip-02 --------- Co-authored-by: Kieran <kieran@harkin.me>
2023-03-27 09:09:48 +00:00
- [ ] NIP-03: OpenTimestamps Attestations for Events
formatting
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
`nostr` package: vastly simplify the API (#412) * vastly simplify the api * add missing await * add eose to emitter * add eose to conn * add eose to the client * eose test * improve test suite, add dm tests * demonstrate that nostr-rs-relay auth options don't work * readme files * cleanup * fetch relay info * test readyState * export fetchRelayInfo * cleanup * better async/await linting * use strictEqual in tests * additional eslint rules * allow arbitrary extensions * saner error handling * update README * implement nip-02 --------- Co-authored-by: Kieran <kieran@harkin.me>
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
update readme
2023-04-01 14:02:36 +00:00
- [x] NIP-09: Event Deletion
`nostr` package: vastly simplify the API (#412) * vastly simplify the api * add missing await * add eose to emitter * add eose to conn * add eose to the client * eose test * improve test suite, add dm tests * demonstrate that nostr-rs-relay auth options don't work * readme files * cleanup * fetch relay info * test readyState * export fetchRelayInfo * cleanup * better async/await linting * use strictEqual in tests * additional eslint rules * allow arbitrary extensions * saner error handling * update README * implement nip-02 --------- Co-authored-by: Kieran <kieran@harkin.me>
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
formatting
2023-04-01 12:53:03 +00:00
- [x] NIP-11: Relay Information Document
- [x] NIP-12: Generic Tag Queries
`nostr` package: vastly simplify the API (#412) * vastly simplify the api * add missing await * add eose to emitter * add eose to conn * add eose to the client * eose test * improve test suite, add dm tests * demonstrate that nostr-rs-relay auth options don't work * readme files * cleanup * fetch relay info * test readyState * export fetchRelayInfo * cleanup * better async/await linting * use strictEqual in tests * additional eslint rules * allow arbitrary extensions * saner error handling * update README * implement nip-02 --------- Co-authored-by: Kieran <kieran@harkin.me>
2023-03-27 09:09:48 +00:00
- [ ] NIP-13: Proof of Work
- [ ] NIP-14: Subject tag in text events
formatting
2023-04-01 12:53:03 +00:00
- [x] NIP-15: End of Stored Events Notice
`nostr` package: vastly simplify the API (#412) * vastly simplify the api * add missing await * add eose to emitter * add eose to conn * add eose to the client * eose test * improve test suite, add dm tests * demonstrate that nostr-rs-relay auth options don't work * readme files * cleanup * fetch relay info * test readyState * export fetchRelayInfo * cleanup * better async/await linting * use strictEqual in tests * additional eslint rules * allow arbitrary extensions * saner error handling * update README * implement nip-02 --------- Co-authored-by: Kieran <kieran@harkin.me>
2023-03-27 09:09:48 +00:00
- [ ] NIP-19: bech32-encoded entities
formatting
2023-04-01 12:53:03 +00:00
- [x] `npub`
- [x] `nsec`
`nostr` package: vastly simplify the API (#412) * vastly simplify the api * add missing await * add eose to emitter * add eose to conn * add eose to the client * eose test * improve test suite, add dm tests * demonstrate that nostr-rs-relay auth options don't work * readme files * cleanup * fetch relay info * test readyState * export fetchRelayInfo * cleanup * better async/await linting * use strictEqual in tests * additional eslint rules * allow arbitrary extensions * saner error handling * update README * implement nip-02 --------- Co-authored-by: Kieran <kieran@harkin.me>
2023-03-27 09:09:48 +00:00
- [ ] `note`, `nprofile`, `nevent`, `nrelay`, `naddr`
formatting
2023-04-01 12:53:03 +00:00
- [x] NIP-20: Command Results
`nostr` package: vastly simplify the API (#412) * vastly simplify the api * add missing await * add eose to emitter * add eose to conn * add eose to the client * eose test * improve test suite, add dm tests * demonstrate that nostr-rs-relay auth options don't work * readme files * cleanup * fetch relay info * test readyState * export fetchRelayInfo * cleanup * better async/await linting * use strictEqual in tests * additional eslint rules * allow arbitrary extensions * saner error handling * update README * implement nip-02 --------- Co-authored-by: Kieran <kieran@harkin.me>
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
nip-05
2023-03-20 20:23:03 +00:00
- [ ] NIP-27: Text Note References
`nostr` package: vastly simplify the API (#412) * vastly simplify the api * add missing await * add eose to emitter * add eose to conn * add eose to the client * eose test * improve test suite, add dm tests * demonstrate that nostr-rs-relay auth options don't work * readme files * cleanup * fetch relay info * test readyState * export fetchRelayInfo * cleanup * better async/await linting * use strictEqual in tests * additional eslint rules * allow arbitrary extensions * saner error handling * update README * implement nip-02 --------- Co-authored-by: Kieran <kieran@harkin.me>
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
### 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_.
Copy Permalink