nips/README.md

50 lines
2.0 KiB
Markdown
Raw Normal View History

2022-05-01 10:48:57 +00:00
# NIPs
NIPs stand for **Nostr Implementation Possibilities**. They exist to document what MUST, what SHOULD and what MAY be implemented by [Nostr](https://github.com/fiatjaf/nostr)-compatible _relay_ and _client_ software.
2022-05-01 11:02:54 +00:00
- [NIP-01: Basic protocol flow description](01.md)
- [NIP-02: Contact List and Petnames](02.md)
- [NIP-03: OpenTimestamps Attestations for Events](03.md)
- [NIP-04: Encrypted Direct Message](04.md)
- [NIP-05: Mapping Nostr keys to DNS-based internet identifiers](05.md)
- [NIP-06: Basic key derivation from mnemonic seed phrase](06.md)
2022-05-06 23:54:45 +00:00
- [NIP-07: `window.nostr` capability for web browsers](07.md)
2022-05-01 11:02:54 +00:00
- [NIP-08: Handling Mentions](08.md)
- [NIP-09: Event Deletion](09.md)
2022-05-05 16:07:49 +00:00
- [NIP-10: Conventions for clients' use of `e` and `p` tags in text events.](10.md)
2022-05-01 11:02:54 +00:00
- [NIP-11: Relay Information Document](11.md)
- [NIP-12: Generic Tag Queries](12.md)
- [NIP-13: Proof of Work](13.md)
- [NIP-14: Subject tag in text events.](14.md)
- [NIP-15: End of Stored Events Notice](15.md)
- [NIP-16: Event Treatment](16.md)
- [NIP-25: Reactions](25.md)
2022-08-14 13:02:37 +00:00
- [NIP-23: Relays List](23.md)
2022-05-01 10:48:57 +00:00
## Event Kinds
2022-08-14 10:51:55 +00:00
| kind | description | NIP |
| ------ | --------------------------- | ------ |
| 0 | Metadata | 1, 5 |
| 1 | Text | 1 |
| 2 | Recommend Relay | 1 |
| 3 | Contacts | 2 |
| 4 | Encrypted Direct Messages | 4 |
| 5 | Event Deletion | 9 |
| 7 | Reaction | 25 |
2022-08-14 13:02:37 +00:00
| 10001 | Relays List | 23 |
2022-05-01 10:48:57 +00:00
Please update this list when proposing NIPs introducing new event kinds.
2022-05-02 12:30:30 +00:00
2022-07-11 18:40:58 +00:00
When experimenting with kinds, keep in mind the classification introduced by [NIP-16](16.md).
2022-05-02 12:30:30 +00:00
## Criteria for acceptance of NIPs
1. They should be implemented somewhere at least as a prototype somewhere.
2. They should make sense.
3. Other rules will be made up when necessary.
## License
All NIPs are public domain.