You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Blake Jakopovic 329cd8d8a1 Update 19.md 2 years ago
01.md Minor grammar fixes 2 years ago
02.md finalize some NIPs we will not going to change anymore. 2 years ago
03.md migrate nips from main nostr repo. 3 years ago
04.md finalize some NIPs we will not going to change anymore. 2 years ago
05.md clarify nip19 purpose. 2 years ago
06.md migrate nips from main nostr repo. 3 years ago
07.md add blockcore to nip-07 and mark extra methods as optional. 2 years ago
08.md finalize some NIPs we will not going to change anymore. 2 years ago
09.md stronger wording for relay deletion behavior 2 years ago
10.md Update e-tag type for direct reply 2 years ago
11.md Improve Case Consistency 2 years ago
12.md change NIP-12 so only single-letter tags are indexed. 2 years ago
13.md Minor grammar fixes 2 years ago
14.md Nip-14 for subject tag 2 years ago
15.md finalize some NIPs we will not going to change anymore. 2 years ago
16.md Clarify use of kind 1 and kind 1000-10000 2 years ago
19.md Update 19.md 2 years ago
20.md Minor grammar fixes 2 years ago
22.md Note on nip-22 about moving old posts to a new relay 2 years ago
25.md nip25: fix code example 2 years ago
26.md Changes based on feedback 2 years ago
28.md NIP-28: Public Chat (#38) 2 years ago
35.md Note about serving from a dynamic webserver 2 years ago
36.md NIP-36 - sensitive content / content-warning (#82) 2 years ago
40.md Update 40.md 2 years ago
README.md Add NIP-19 and 40 to README 2 years ago

README.md

NIPs

NIPs stand for Nostr Implementation Possibilities. They exist to document what MUST, what SHOULD and what MAY be implemented by Nostr-compatible relay and client software.

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
10000-19999 Replaceable Events Reserved 16
20000-29999 Ephemeral Events Reserved 16

Message types

Client to Relay

type description NIP
EVENT used to publish events 1
REQ used to request events and subscribe to new updates 1
CLOSE used to stop previous subscriptions 1

Relay to Client

type description NIP
EVENT used to send events requested to clients 1
NOTICE used to send human-readable messages to clients 1
EOSE used to notify clients all stored events have been sent 15
OK used to notify clients if an EVENT was successuful 20

Please update these lists when proposing NIPs introducing new event kinds.

When experimenting with kinds, keep in mind the classification introduced by NIP-16.

Criteria for acceptance of NIPs

  1. They should be implemented in at least one client and one relay -- when applicable.
  2. They should make sense.
  3. They should be optional and backwards-compatible: care must be taken such that clients and relays that choose to not implement them do not stop working when interacting with the ones that choose to.
  4. Other rules will be made up when necessary.

License

All NIPs are public domain.