nips/README.md

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

- [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)
- [NIP-07: `window.nostr` capability for web browsers](07.md)
- [NIP-08: Handling Mentions](08.md)
- [NIP-09: Event Deletion](09.md)
- [NIP-10: Conventions for clients' use of `e` and `p` tags in text events.](10.md)
- [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-22: Event created_at Limits](22.md)
- [NIP-25: Reactions](25.md)
- [NIP-28: Public Chat](28.md)

## Event Kinds

| 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   |
| 40   | Channel Creation          | 28   |
| 41   | Channel Metadata          | 28   |
| 42   | Channel Message           | 28   |
| 43   | Channel Hide Message      | 28   |
| 44   | Channel Mute User         | 28   |
| 45-49 | Public Chat Reserved     | 28   |


Please update this list when proposing NIPs introducing new event kinds.

When experimenting with kinds, keep in mind the classification introduced by [NIP-16](16.md).

## 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.
migrate nips from main nostr repo. 2022-05-01 06:48:57 -04: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.`

fix links. 2022-05-01 07:02:54 -04: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)`
publish NIP-07: window.nostr. 2022-05-06 19:54:45 -04:00			- [NIP-07: `window.nostr` capability for web browsers](07.md)
fix links. 2022-05-01 07:02:54 -04:00			`- [NIP-08: Handling Mentions](08.md)`
			`- [NIP-09: Event Deletion](09.md)`
make NIP-10 a link in the README 2022-05-05 12:07:49 -04:00			- [NIP-10: Conventions for clients' use of `e` and `p` tags in text events.](10.md)
fix links. 2022-05-01 07:02:54 -04:00			`- [NIP-11: Relay Information Document](11.md)`
			`- [NIP-12: Generic Tag Queries](12.md)`
Proof of Work Thanks-to: Cameri and scsibug for the initial idea of using the id for PoW Thanks-to: David A. Harding for the difficulty commitment idea Signed-off-by: William Casarin <jb55@jb55.com> 2022-05-05 13:45:27 -04:00			`- [NIP-13: Proof of Work](13.md)`
update readme to include NIPs 14, 15, and 16 2022-05-29 09:58:34 -04:00			`- [NIP-14: Subject tag in text events.](14.md)`
			`- [NIP-15: End of Stored Events Notice](15.md)`
			`- [NIP-16: Event Treatment](16.md)`
add nip link to readme 2022-08-13 13:54:28 -04:00			`- [NIP-22: Event created_at Limits](22.md)`
NIP-25: Reactions Signed-off-by: William Casarin <jb55@jb55.com> 2022-07-30 12:34:04 -04:00			`- [NIP-25: Reactions](25.md)`
add NIP-28 link in README 2022-09-10 20:52:09 -04:00			`- [NIP-28: Public Chat](28.md)`
migrate nips from main nostr repo. 2022-05-01 06:48:57 -04:00
			`## Event Kinds`

note kind 0 is on nip 1 too. 2022-06-20 13:51:21 -04: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 \|`
NIP-25: Reactions Signed-off-by: William Casarin <jb55@jb55.com> 2022-07-30 12:34:04 -04:00			`\| 7 \| Reaction \| 25 \|`
add kinds reserved by NIP-28 2022-09-10 22:27:20 -04:00			`\| 40 \| Channel Creation \| 28 \|`
			`\| 41 \| Channel Metadata \| 28 \|`
			`\| 42 \| Channel Message \| 28 \|`
			`\| 43 \| Channel Hide Message \| 28 \|`
			`\| 44 \| Channel Mute User \| 28 \|`
			`\| 45-49 \| Public Chat Reserved \| 28 \|`

migrate nips from main nostr repo. 2022-05-01 06:48:57 -04:00
			`Please update this list when proposing NIPs introducing new event kinds.`
add criteria for acceptance. 2022-05-02 08:30:30 -04:00
note NIP-16. 2022-07-11 14:40:58 -04:00			`When experimenting with kinds, keep in mind the classification introduced by [NIP-16](16.md).`

add criteria for acceptance. 2022-05-02 08:30:30 -04: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.`