nostr
/
nips
mirror of https://github.com/nostr-protocol/nips.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Nostr Implementation Possibilities
622 Commits 49 Branches 0 Tags 9.9 MiB
Markdown 100%
Go to file
Pablo Fernandez 7ad40d5159 Recurring Subscriptions 2023-11-05 13:14:43 +02:00
01.md nip-01: clarify that whitespace is allowed inside the strings. 2023-11-02 19:46:37 -03:00
02.md Update 02.md 2023-03-06 16:37:42 -03:00
03.md remove useless "block" tag on OTS. 2023-10-17 07:38:53 -03:00
04.md fix grammar and typos 2023-04-07 11:45:06 -03:00
05.md Reword set_metadata to metadata (#741) 2023-08-25 11:17:05 -03:00
06.md Nip 06 test vectors (#819) 2023-10-12 10:31:58 -03:00
07.md Adding Nostore to NIP-07 extension list. 2023-11-01 12:53:43 -03:00
08.md Update 08.md 2023-04-19 22:32:08 +09:00
09.md NIP-09: Add `a` tag deletion (#600) 2023-06-15 20:23:40 -03:00
10.md remove harmful remark from nip-10. 2023-08-17 08:17:24 -03:00
11.md add NIP-22 created_at limits to Server-Limitations 2023-09-01 07:48:32 -03:00
12.md merge nips 12, 16, 20 and 33 into nip 01 (#703) 2023-08-13 13:47:45 -03:00
13.md merge nips 12, 16, 20 and 33 into nip 01 (#703) 2023-08-13 13:47:45 -03:00
14.md Adjust NIP-14 title to other NIPs 2023-07-12 07:28:49 -03:00
15.md Unlimited quantity possible in NIP-15. 2023-10-31 15:54:25 -03:00
16.md merge nips 12, 16, 20 and 33 into nip 01 (#703) 2023-08-13 13:47:45 -03:00
18.md typo on nip 18. 2023-06-18 11:36:23 -03:00
19.md Define how to encode a non-parameterized replaceable event as a naddr 2023-08-25 08:27:24 -03:00
20.md merge nips 12, 16, 20 and 33 into nip 01 (#703) 2023-08-13 13:47:45 -03:00
21.md Change NIP-21 URL->URI 2023-05-01 15:16:30 -03:00
22.md merge nips 12, 16, 20 and 33 into nip 01 (#703) 2023-08-13 13:47:45 -03:00
23.md merge nips 12, 16, 20 and 33 into nip 01 (#703) 2023-08-13 13:47:45 -03:00
24.md less aggressive wording for kind3 relay list deprecation. 2023-09-28 08:07:30 -03:00
25.md Change wording to imply that reactions can target any event (#815) 2023-10-11 08:55:27 -03:00
26.md Fix typo "NIP: 26" to "NIP-26" 2023-06-12 12:45:52 +09:00
27.md Add links to NIP-21 2023-04-11 00:16:12 -03:00
28.md More explicit 2023-05-13 13:30:42 -03:00
30.md allow underscores in an emoji shortcode 2023-05-17 12:38:16 -03:00
31.md update NIP to use alt tag 2023-06-08 22:27:00 +02:00
32.md Remove some examples from nip 32 to keep things concise 2023-06-17 09:07:08 -07:00
33.md merge nips 12, 16, 20 and 33 into nip 01 (#703) 2023-08-13 13:47:45 -03:00
36.md Add labeling to nip 56 as well 2023-06-13 09:31:15 -07:00
38.md update 38.md 2023-08-28 21:10:07 +09:00
39.md NIP-39: minor readability changes 2023-03-13 04:43:17 +03:00
40.md fix grammar and typos 2023-04-07 11:45:06 -03:00
42.md Update 42.md 2023-01-11 00:05:15 -03:00
45.md Allow relays indicate whether probabilistic count was used in NIP-45 2023-08-27 15:34:55 +02:00
46.md Update 46.md 2023-03-15 19:40:40 -03:00
47.md fixed typos 2023-06-26 14:55:24 -03:00
48.md NIP-48: Proxy Tags 2023-08-03 14:40:45 -05:00
50.md Fix NIP-50 typo 2023-02-01 07:06:25 -03:00
51.md fix typos 2023-08-17 16:21:21 +02:00
52.md 52: fix kinds (as ints). 2023-11-04 16:55:28 -03:00
53.md merge nips 12, 16, 20 and 33 into nip 01 (#703) 2023-08-13 13:47:45 -03:00
56.md Minor JSON fix 2023-07-25 12:33:16 +09:00
57.md Update 57.md (#808) 2023-10-10 21:57:12 -07:00
58.md Micro-typo nip-58 2023-09-05 18:15:14 +02:00
65.md Better RFC reference 2023-10-02 15:34:24 -07:00
72.md merge nips 12, 16, 20 and 33 into nip 01 (#703) 2023-08-13 13:47:45 -03:00
75.md NIP-75: Zap Goals (#757) 2023-09-01 15:07:52 +02:00
78.md fix grammar and typos 2023-04-07 11:45:06 -03:00
88.md Recurring Subscriptions 2023-11-05 13:14:43 +02:00
89.md Reword set_metadata to metadata (#741) 2023-08-25 11:17:05 -03:00
90.md NIP-90: consistency changes 2023-10-31 00:21:53 +03:00
94.md Remove ox tag 2023-09-27 12:59:33 -03:00
98.md Spelling and clarifcations 2023-09-08 07:10:36 -03:00
99.md Update title 2023-07-18 22:52:18 +02:00
README.md Recurring Subscriptions 2023-11-05 13:14:43 +02:00

README.md

NIPs

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

List

Event Kinds

kind description NIP
0 Metadata 1
1 Short Text Note 1
2 Recommend Relay
3 Contacts 2
4 Encrypted Direct Messages 4
5 Event Deletion 9
6 Repost 18
7 Reaction 25
8 Badge Award 58
16 Generic Repost 18
40 Channel Creation 28
41 Channel Metadata 28
42 Channel Message 28
43 Channel Hide Message 28
44 Channel Mute User 28
1063 File Metadata 94
1311 Live Chat Message 53
1040 OpenTimestamps 03
1984 Reporting 56
1985 Label 32
4550 Community Post Approval 72
7000 Job Feedback 90
7001 Recurring Subscription 88
7002 Recurring Subscription Tier 88
9041 Zap Goal 75
9734 Zap Request 57
9735 Zap 57
10000 Mute List 51
10001 Pin List 51
10002 Relay List Metadata 65
13194 Wallet Info 47
22242 Client Authentication 42
23194 Wallet Request 47
23195 Wallet Response 47
24133 Nostr Connect 46
27235 HTTP Auth 98
30000 Categorized People List 51
30001 Categorized Bookmark List 51
30008 Profile Badges 58
30009 Badge Definition 58
30017 Create or update a stall 15
30018 Create or update a product 15
30023 Long-form Content 23
30024 Draft Long-form Content 23
30078 Application-specific Data 78
30311 Live Event 53
30315 User Statuses 38
30402 Classified Listing 99
30403 Draft Classified Listing 99
31922 Date-Based Calendar Event 52
31923 Time-Based Calendar Event 52
31924 Calendar 52
31925 Calendar Event RSVP 52
31989 Handler recommendation 89
31990 Handler information 89
34550 Community Definition 72

Message types

Client to Relay

type description NIP
EVENT used to publish events 01
REQ used to request events and subscribe to new updates 01
CLOSE used to stop previous subscriptions 01
AUTH used to send authentication events 42
COUNT used to request event counts 45

Relay to Client

type description NIP
EOSE used to notify clients all stored events have been sent 01
EVENT used to send events requested to clients 01
NOTICE used to send human-readable messages to clients 01
OK used to notify clients if an EVENT was successful 01
AUTH used to send authentication challenges 42
COUNT used to send requested event counts to clients 45

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

Standardized Tags

name value other parameters NIP
e event id (hex) relay URL, marker 01, 10
p pubkey (hex) relay URL, petname 01, 02
a coordinates to an event relay URL 01
d identifier -- 01
alt summary -- 31
g geohash -- 52
i identity proof 39
k kind number (string) -- 18, 25, 72
l label, label namespace annotations 32
L label namespace -- 32
m MIME type -- 94
r a reference (URL, etc) petname
r relay url marker 65
t hashtag --
amount millisatoshis, stringified -- 57
bolt11 bolt11 invoice -- 57
challenge challenge string -- 42
content-warning reason -- 36
delegation pubkey, conditions, delegation token -- 26
description invoice/badge description -- 57, 58
emoji shortcode, image URL -- 30
expiration unix timestamp (string) -- 40
goal event id (hex) relay URL 75
image image URL dimensions in pixels 23, 58
lnurl bech32 encoded lnurl -- 57
location location string -- 52, 99
name badge name -- 58
nonce random -- 13
preimage hash of bolt11 invoice -- 57
price price currency, frequency 99
proxy external ID protocol 48
published_at unix timestamp (string) -- 23
relay relay url -- 42
relays relay list -- 57
subject subject -- 14
summary article summary -- 23
thumb badge thumbnail dimensions in pixels 58
title article title -- 23
zap pubkey (hex), relay URL weight 57

Criteria for acceptance of NIPs

  1. They should be implemented in at least two clients 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. There should be no more than one way of doing the same thing.
  5. Other rules will be made up when necessary.

Mailing Lists

The nostr ecosystem is getting large with many different organizations, relays and clients. Following the nips repo on github is becoming more difficult and noisy. To coordinate on protocol development outside of github, there are mailing lists where you can work on NIPs before submitting them here:

License

All NIPs are public domain.