snort/packages/nostr
Kieran 350588680f
Yarn 3 upgrade
2023-08-17 20:35:42 +01:00
..
docker get tests passing in the browser 2023-04-08 21:01:14 +02:00
src tmp 2023-07-22 19:37:46 +01:00
test delete legacy code from nostr pkg 2023-05-30 14:50:30 +01:00
.eslintrc.cjs add event deletion 2023-04-04 22:07:13 +02:00
.gitignore workspace with decoupled nostr package 2023-02-14 14:27:40 +01:00
.prettierignore formatting 2023-04-04 22:01:26 +02:00
README.md chore: replace github link 2023-04-27 11:35:30 +01:00
docker-compose.yaml get tests passing in the browser 2023-04-08 21:01:14 +02:00
package.json Yarn 3 upgrade 2023-08-17 20:35:42 +01:00
tsconfig.json get tests passing in the browser 2023-04-08 21:01:14 +02:00
webpack.config.js tmp 2023-07-22 19:37:46 +01:00

README.md

@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.

Progress: 8/34 (23%).

  • NIP-01: Basic protocol flow description
  • NIP-02: Contact List and Petnames
  • NIP-03: OpenTimestamps Attestations for Events
  • NIP-04: Encrypted Direct Message
  • NIP-05: Mapping Nostr keys to DNS-based internet identifiers
  • NIP-06: Basic key derivation from mnemonic seed phrase
  • NIP-07: window.nostr capability for web browsers
  • NIP-09: Event Deletion
  • NIP-10: Conventions for clients' use of e and p tags in text events
    • TODO Check if this applies
  • NIP-11: Relay Information Document
  • NIP-12: Generic Tag Queries
  • NIP-13: Proof of Work
  • NIP-14: Subject tag in text events
  • NIP-15: End of Stored Events Notice
  • NIP-19: bech32-encoded entities
    • npub
    • nsec
    • note, nprofile, nevent, nrelay, naddr
  • NIP-20: Command Results
  • NIP-21: nostr: URL scheme
  • NIP-23: Long-form Content
  • NIP-25: Reactions
  • NIP-26: Delegated Event Signing
  • NIP-27: Text Note References
  • 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
  • NIP-94: File Header

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 to let us know.