upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md144
1 files changed, 81 insertions, 63 deletions
diff --git a/README.md b/README.md
index 8e970ea..6b83490 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
22## List 22## List
23 23
24- [NIP-01: Basic protocol flow description](01.md) 24- [NIP-01: Basic protocol flow description](01.md)
25- [NIP-02: Contact List and Petnames](02.md) 25- [NIP-02: Follow List](02.md)
26- [NIP-03: OpenTimestamps Attestations for Events](03.md) 26- [NIP-03: OpenTimestamps Attestations for Events](03.md)
27- [NIP-04: Encrypted Direct Message](04.md) 27- [NIP-04: Encrypted Direct Message](04.md)
28- [NIP-05: Mapping Nostr keys to DNS-based internet identifiers](05.md) 28- [NIP-05: Mapping Nostr keys to DNS-based internet identifiers](05.md)
@@ -38,7 +38,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
38- [NIP-18: Reposts](18.md) 38- [NIP-18: Reposts](18.md)
39- [NIP-19: bech32-encoded entities](19.md) 39- [NIP-19: bech32-encoded entities](19.md)
40- [NIP-21: `nostr:` URI scheme](21.md) 40- [NIP-21: `nostr:` URI scheme](21.md)
41- [NIP-22: Event `created_at` Limits](22.md)
42- [NIP-23: Long-form Content](23.md) 41- [NIP-23: Long-form Content](23.md)
43- [NIP-24: Extra metadata fields and tags](24.md) 42- [NIP-24: Extra metadata fields and tags](24.md)
44- [NIP-25: Reactions](25.md) 43- [NIP-25: Reactions](25.md)
@@ -76,66 +75,82 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
76- [NIP-99: Classified Listings](99.md) 75- [NIP-99: Classified Listings](99.md)
77 76
78## Event Kinds 77## Event Kinds
79| kind | description | NIP | 78| kind | description | NIP |
80| ------------- | -------------------------- | ----------- | 79| ------------- | -------------------------- | ----------- |
81| `0` | Metadata | [1](01.md) | 80| `0` | Metadata | [1](01.md) |
82| `1` | Short Text Note | [1](01.md) | 81| `1` | Short Text Note | [1](01.md) |
83| `2` | Recommend Relay | | 82| `2` | Recommend Relay | |
84| `3` | Contacts | [2](02.md) | 83| `3` | Follows | [2](02.md) |
85| `4` | Encrypted Direct Messages | [4](04.md) | 84| `4` | Encrypted Direct Messages | [4](04.md) |
86| `5` | Event Deletion | [9](09.md) | 85| `5` | Event Deletion | [9](09.md) |
87| `6` | Repost | [18](18.md) | 86| `6` | Repost | [18](18.md) |
88| `7` | Reaction | [25](25.md) | 87| `7` | Reaction | [25](25.md) |
89| `8` | Badge Award | [58](58.md) | 88| `8` | Badge Award | [58](58.md) |
90| `16` | Generic Repost | [18](18.md) | 89| `16` | Generic Repost | [18](18.md) |
91| `40` | Channel Creation | [28](28.md) | 90| `40` | Channel Creation | [28](28.md) |
92| `41` | Channel Metadata | [28](28.md) | 91| `41` | Channel Metadata | [28](28.md) |
93| `42` | Channel Message | [28](28.md) | 92| `42` | Channel Message | [28](28.md) |
94| `43` | Channel Hide Message | [28](28.md) | 93| `43` | Channel Hide Message | [28](28.md) |
95| `44` | Channel Mute User | [28](28.md) | 94| `44` | Channel Mute User | [28](28.md) |
96| `1063` | File Metadata | [94](94.md) | 95| `1040` | OpenTimestamps | [03](03.md) |
97| `1311` | Live Chat Message | [53](53.md) | 96| `1063` | File Metadata | [94](94.md) |
98| `1040` | OpenTimestamps | [03](03.md) | 97| `1311` | Live Chat Message | [53](53.md) |
99| `1971` | Problem Tracker | [1971](https://github.com/nostrocket/NIPS/blob/main/Problems.md) | 98| `1971` | Problem Tracker | [nostrocket][nostrocket] |
100| `1984` | Reporting | [56](56.md) | 99| `1984` | Reporting | [56](56.md) |
101| `1985` | Label | [32](32.md) | 100| `1985` | Label | [32](32.md) |
102| `4550` | Community Post Approval | [72](72.md) | 101| `4550` | Community Post Approval | [72](72.md) |
103| `5000`-`5999` | Job Request | [90](90.md) | 102| `5000`-`5999` | Job Request | [90](90.md) |
104| `6000`-`6999` | Job Result | [90](90.md) | 103| `6000`-`6999` | Job Result | [90](90.md) |
105| `7000` | Job Feedback | [90](90.md) | 104| `7000` | Job Feedback | [90](90.md) |
106| `9041` | Zap Goal | [75](75.md) | 105| `9041` | Zap Goal | [75](75.md) |
107| `9734` | Zap Request | [57](57.md) | 106| `9734` | Zap Request | [57](57.md) |
108| `9735` | Zap | [57](57.md) | 107| `9735` | Zap | [57](57.md) |
109| `9802` | Highlights | [84](84.md) | 108| `9802` | Highlights | [84](84.md) |
110| `10000` | Mute List | [51](51.md) | 109| `10000` | Mute list | [51](51.md) |
111| `10001` | Pin List | [51](51.md) | 110| `10001` | Pin list | [51](51.md) |
112| `10002` | Relay List Metadata | [65](65.md) | 111| `10002` | Relay List Metadata | [65](65.md) |
113| `13194` | Wallet Info | [47](47.md) | 112| `10003` | Bookmark list | [51](51.md) |
114| `22242` | Client Authentication | [42](42.md) | 113| `10004` | Communities list | [51](51.md) |
115| `23194` | Wallet Request | [47](47.md) | 114| `10005` | Public chats list | [51](51.md) |
116| `23195` | Wallet Response | [47](47.md) | 115| `10006` | Blocked relays list | [51](51.md) |
117| `24133` | Nostr Connect | [46](46.md) | 116| `10007` | Search relays list | [51](51.md) |
118| `27235` | HTTP Auth | [98](98.md) | 117| `10015` | Interests list | [51](51.md) |
119| `30000` | Categorized People List | [51](51.md) | 118| `10030` | User emoji list | [51](51.md) |
120| `30001` | Categorized Bookmark List | [51](51.md) | 119| `13194` | Wallet Info | [47](47.md) |
121| `30008` | Profile Badges | [58](58.md) | 120| `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] |
122| `30009` | Badge Definition | [58](58.md) | 121| `22242` | Client Authentication | [42](42.md) |
123| `30017` | Create or update a stall | [15](15.md) | 122| `23194` | Wallet Request | [47](47.md) |
124| `30018` | Create or update a product | [15](15.md) | 123| `23195` | Wallet Response | [47](47.md) |
125| `30023` | Long-form Content | [23](23.md) | 124| `24133` | Nostr Connect | [46](46.md) |
126| `30024` | Draft Long-form Content | [23](23.md) | 125| `27235` | HTTP Auth | [98](98.md) |
127| `30078` | Application-specific Data | [78](78.md) | 126| `30000` | Follow sets | [51](51.md) |
128| `30311` | Live Event | [53](53.md) | 127| `30001` | Generic lists | [51](51.md) |
129| `30315` | User Statuses | [38](38.md) | 128| `30002` | Relay sets | [51](51.md) |
130| `30402` | Classified Listing | [99](99.md) | 129| `30003` | Bookmark sets | [51](51.md) |
131| `30403` | Draft Classified Listing | [99](99.md) | 130| `30004` | Curation sets | [51](51.md) |
132| `31922` | Date-Based Calendar Event | [52](52.md) | 131| `30008` | Profile Badges | [58](58.md) |
133| `31923` | Time-Based Calendar Event | [52](52.md) | 132| `30009` | Badge Definition | [58](58.md) |
134| `31924` | Calendar | [52](52.md) | 133| `30015` | Interest sets | [51](51.md) |
135| `31925` | Calendar Event RSVP | [52](52.md) | 134| `30017` | Create or update a stall | [15](15.md) |
136| `31989` | Handler recommendation | [89](89.md) | 135| `30018` | Create or update a product | [15](15.md) |
137| `31990` | Handler information | [89](89.md) | 136| `30023` | Long-form Content | [23](23.md) |
138| `34550` | Community Definition | [72](72.md) | 137| `30024` | Draft Long-form Content | [23](23.md) |
138| `30030` | Emoji sets | [51](51.md) |
139| `30078` | Application-specific Data | [78](78.md) |
140| `30311` | Live Event | [53](53.md) |
141| `30315` | User Statuses | [38](38.md) |
142| `30402` | Classified Listing | [99](99.md) |
143| `30403` | Draft Classified Listing | [99](99.md) |
144| `31922` | Date-Based Calendar Event | [52](52.md) |
145| `31923` | Time-Based Calendar Event | [52](52.md) |
146| `31924` | Calendar | [52](52.md) |
147| `31925` | Calendar Event RSVP | [52](52.md) |
148| `31989` | Handler recommendation | [89](89.md) |
149| `31990` | Handler information | [89](89.md) |
150| `34550` | Community Definition | [72](72.md) |
151
152[nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md
153[lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md
139 154
140## Message types 155## Message types
141 156
@@ -157,6 +172,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
157| `EVENT` | used to send events requested to clients | [01](01.md) | 172| `EVENT` | used to send events requested to clients | [01](01.md) |
158| `NOTICE` | used to send human-readable messages to clients | [01](01.md) | 173| `NOTICE` | used to send human-readable messages to clients | [01](01.md) |
159| `OK` | used to notify clients if an EVENT was successful | [01](01.md) | 174| `OK` | used to notify clients if an EVENT was successful | [01](01.md) |
175| `CLOSED` | used to notify clients that a REQ was ended and why | [01](01.md) |
160| `AUTH` | used to send authentication challenges | [42](42.md) | 176| `AUTH` | used to send authentication challenges | [42](42.md) |
161| `COUNT` | used to send requested event counts to clients | [45](45.md) | 177| `COUNT` | used to send requested event counts to clients | [45](45.md) |
162 178
@@ -170,7 +186,6 @@ Please update these lists when proposing NIPs introducing new event kinds.
170| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | 186| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) |
171| `a` | coordinates to an event | relay URL | [01](01.md) | 187| `a` | coordinates to an event | relay URL | [01](01.md) |
172| `d` | identifier | -- | [01](01.md) | 188| `d` | identifier | -- | [01](01.md) |
173| `alt` | summary | -- | [31](31.md) |
174| `g` | geohash | -- | [52](52.md) | 189| `g` | geohash | -- | [52](52.md) |
175| `i` | identity | proof | [39](39.md) | 190| `i` | identity | proof | [39](39.md) |
176| `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) | 191| `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) |
@@ -180,13 +195,16 @@ Please update these lists when proposing NIPs introducing new event kinds.
180| `r` | a reference (URL, etc) | petname | | 195| `r` | a reference (URL, etc) | petname | |
181| `r` | relay url | marker | [65](65.md) | 196| `r` | relay url | marker | [65](65.md) |
182| `t` | hashtag | -- | | 197| `t` | hashtag | -- | |
198| `alt` | summary | -- | [31](31.md) |
183| `amount` | millisatoshis, stringified | -- | [57](57.md) | 199| `amount` | millisatoshis, stringified | -- | [57](57.md) |
184| `bolt11` | `bolt11` invoice | -- | [57](57.md) | 200| `bolt11` | `bolt11` invoice | -- | [57](57.md) |
185| `challenge` | challenge string | -- | [42](42.md) | 201| `challenge` | challenge string | -- | [42](42.md) |
202| `client` | name, address | relay URL | [89](89.md) |
186| `content-warning` | reason | -- | [36](36.md) | 203| `content-warning` | reason | -- | [36](36.md) |
187| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | 204| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) |
188| `description` | invoice/badge description | -- | [57](57.md), [58](58.md) | 205| `description` | invoice/badge description | -- | [57](57.md), [58](58.md) |
189| `emoji` | shortcode, image URL | -- | [30](30.md) | 206| `emoji` | shortcode, image URL | -- | [30](30.md) |
207| `encrypted` | -- | -- | [90](90.md) |
190| `expiration` | unix timestamp (string) | -- | [40](40.md) | 208| `expiration` | unix timestamp (string) | -- | [40](40.md) |
191| `goal` | event id (hex) | relay URL | [75](75.md) | 209| `goal` | event id (hex) | relay URL | [75](75.md) |
192| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | 210| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) |
generated by cgit v1.2.3 (git 2.39.1) at 2026-08-22 21:35:38 +0000