upleb.uk

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

summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--01.md39
-rw-r--r--02.md2
-rw-r--r--04.md4
-rw-r--r--05.md4
-rw-r--r--07.md20
-rw-r--r--11.md2
-rw-r--r--15.md94
-rw-r--r--17.md164
-rw-r--r--18.md7
-rw-r--r--24.md2
-rw-r--r--25.md17
-rw-r--r--28.md14
-rw-r--r--29.md197
-rw-r--r--30.md2
-rw-r--r--32.md8
-rw-r--r--34.md152
-rw-r--r--44.md295
-rw-r--r--46.md257
-rw-r--r--47.md286
-rw-r--r--49.md126
-rw-r--r--50.md6
-rw-r--r--51.md61
-rw-r--r--52.md50
-rw-r--r--53.md2
-rw-r--r--54.md112
-rw-r--r--56.md10
-rw-r--r--57.md7
-rw-r--r--58.md8
-rw-r--r--59.md252
-rw-r--r--65.md2
-rw-r--r--72.md12
-rw-r--r--90.md8
-rw-r--r--92.md45
-rw-r--r--94.md7
-rw-r--r--96.md295
-rw-r--r--99.md1
-rw-r--r--BREAKING.md48
-rw-r--r--README.md68
38 files changed, 2449 insertions, 237 deletions
diff --git a/01.md b/01.md
index 99c991a..8be85bc 100644
--- a/01.md
+++ b/01.md
@@ -14,7 +14,7 @@ Each user has a keypair. Signatures, public key, and encodings are done accordin
14 14
15The only object type that exists is the `event`, which has the following format on the wire: 15The only object type that exists is the `event`, which has the following format on the wire:
16 16
17```json 17```jsonc
18{ 18{
19 "id": <32-bytes lowercase hex-encoded sha256 of the serialized event data>, 19 "id": <32-bytes lowercase hex-encoded sha256 of the serialized event data>,
20 "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, 20 "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
@@ -22,14 +22,14 @@ The only object type that exists is the `event`, which has the following format
22 "kind": <integer between 0 and 65535>, 22 "kind": <integer between 0 and 65535>,
23 "tags": [ 23 "tags": [
24 [<arbitrary string>...], 24 [<arbitrary string>...],
25 ... 25 // ...
26 ], 26 ],
27 "content": <arbitrary string>, 27 "content": <arbitrary string>,
28 "sig": <64-bytes lowercase hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> 28 "sig": <64-bytes lowercase hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field>
29} 29}
30``` 30```
31 31
32To obtain the `event.id`, we `sha256` the serialized event. The serialization is done over the UTF-8 JSON-serialized string (with no white space or line breaks between the fields) of the following structure: 32To obtain the `event.id`, we `sha256` the serialized event. The serialization is done over the UTF-8 JSON-serialized string (which is described below) of the following structure:
33 33
34``` 34```
35[ 35[
@@ -42,21 +42,32 @@ To obtain the `event.id`, we `sha256` the serialized event. The serialization is
42] 42]
43``` 43```
44 44
45To prevent implementation differences from creating a different event ID for the same event, the following rules MUST be followed while serializing:
46- No whitespace, line breaks or other unnecessary formatting should be included in the output JSON.
47- No characters except the following should be escaped, and instead should be included verbatim:
48 - A line break, `0x0A`, as `\n`
49 - A double quote, `0x22`, as `\"`
50 - A backslash, `0x5C`, as `\\`
51 - A carriage return, `0x0D`, as `\r`
52 - A tab character, `0x09`, as `\t`
53 - A backspace, `0x08`, as `\b`
54 - A form feed, `0x0C`, as `\f`
55- UTF-8 should be used for encoding.
56
45### Tags 57### Tags
46 58
47Each tag is an array of strings of arbitrary size, with some conventions around them. Take a look at the example below: 59Each tag is an array of one or more strings, with some conventions around them. Take a look at the example below:
48 60
49```json 61```jsonc
50{ 62{
51 ...,
52 "tags": [ 63 "tags": [
53 ["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://nostr.example.com"], 64 ["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://nostr.example.com"],
54 ["p", "f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca"], 65 ["p", "f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca"],
55 ["a", "30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"], 66 ["a", "30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"],
56 ["alt", "reply"], 67 ["alt", "reply"],
57 ... 68 // ...
58 ], 69 ],
59 ... 70 // ...
60} 71}
61``` 72```
62 73
@@ -70,7 +81,7 @@ This NIP defines 3 standard tags that can be used across all event kinds with th
70 - for a parameterized replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]` 81 - for a parameterized replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]`
71 - for a non-parameterized replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:, <recommended relay URL, optional>]` 82 - for a non-parameterized replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:, <recommended relay URL, optional>]`
72 83
73As a convention, all single-letter (only english alphabet letters: a-z, A-Z) key tags are expected to be indexed by relays, such that it is possible, for example, to query or subscribe to events that reference the event `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"` by using the `{"#e": "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"}` filter. 84As a convention, all single-letter (only english alphabet letters: a-z, A-Z) key tags are expected to be indexed by relays, such that it is possible, for example, to query or subscribe to events that reference the event `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"` by using the `{"#e": ["5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"]}` filter.
74 85
75### Kinds 86### Kinds
76 87
@@ -101,19 +112,19 @@ Relays expose a websocket endpoint to which clients can connect. Clients SHOULD
101Clients can send 3 types of messages, which must be JSON arrays, according to the following patterns: 112Clients can send 3 types of messages, which must be JSON arrays, according to the following patterns:
102 113
103 * `["EVENT", <event JSON as defined above>]`, used to publish events. 114 * `["EVENT", <event JSON as defined above>]`, used to publish events.
104 * `["REQ", <subscription_id>, <filters JSON>...]`, used to request events and subscribe to new updates. 115 * `["REQ", <subscription_id>, <filters1>, <filters2>, ...]`, used to request events and subscribe to new updates.
105 * `["CLOSE", <subscription_id>]`, used to stop previous subscriptions. 116 * `["CLOSE", <subscription_id>]`, used to stop previous subscriptions.
106 117
107`<subscription_id>` is an arbitrary, non-empty string of max length 64 chars, that should be used to represent a subscription. Relays should manage `<subscription_id>`s independently for each WebSocket connection; even if `<subscription_id>`s are the same string, they should be treated as different subscriptions for different connections. 118`<subscription_id>` is an arbitrary, non-empty string of max length 64 chars. It represents a subscription per connection. Relays MUST manage `<subscription_id>`s independently for each WebSocket connection. `<subscription_id>`s are not guaranteed to be globally unique.
108 119
109`<filters>` is a JSON object that determines what events will be sent in that subscription, it can have the following attributes: 120`<filtersX>` is a JSON object that determines what events will be sent in that subscription, it can have the following attributes:
110 121
111```json 122```json
112{ 123{
113 "ids": <a list of event ids>, 124 "ids": <a list of event ids>,
114 "authors": <a list of lowercase pubkeys, the pubkey of an event must be one of these>, 125 "authors": <a list of lowercase pubkeys, the pubkey of an event must be one of these>,
115 "kinds": <a list of a kind numbers>, 126 "kinds": <a list of a kind numbers>,
116 "#<single-letter (a-zA-Z)>": <a list of tag values, for #e — a list of event ids, for #p — a list of event pubkeys etc>, 127 "#<single-letter (a-zA-Z)>": <a list of tag values, for #e — a list of event ids, for #p — a list of pubkeys, etc.>,
117 "since": <an integer unix timestamp in seconds, events must be newer than this to pass>, 128 "since": <an integer unix timestamp in seconds, events must be newer than this to pass>,
118 "until": <an integer unix timestamp in seconds, events must be older than this to pass>, 129 "until": <an integer unix timestamp in seconds, events must be older than this to pass>,
119 "limit": <maximum number of events relays SHOULD return in the initial query> 130 "limit": <maximum number of events relays SHOULD return in the initial query>
@@ -136,7 +147,7 @@ The `limit` property of a filter is only valid for the initial query and MUST be
136 147
137### From relay to client: sending events and notices 148### From relay to client: sending events and notices
138 149
139Relays can send 4 types of messages, which must also be JSON arrays, according to the following patterns: 150Relays can send 5 types of messages, which must also be JSON arrays, according to the following patterns:
140 151
141 * `["EVENT", <subscription_id>, <event JSON as defined above>]`, used to send events requested by clients. 152 * `["EVENT", <subscription_id>, <event JSON as defined above>]`, used to send events requested by clients.
142 * `["OK", <event_id>, <true|false>, <message>]`, used to indicate acceptance or denial of an `EVENT` message. 153 * `["OK", <event_id>, <true|false>, <message>]`, used to indicate acceptance or denial of an `EVENT` message.
diff --git a/02.md b/02.md
index 8c47a5f..8b0aee1 100644
--- a/02.md
+++ b/02.md
@@ -27,6 +27,8 @@ For example:
27 27
28Every new following list that gets published overwrites the past ones, so it should contain all entries. Relays and clients SHOULD delete past following lists as soon as they receive a new one. 28Every new following list that gets published overwrites the past ones, so it should contain all entries. Relays and clients SHOULD delete past following lists as soon as they receive a new one.
29 29
30Whenever new follows are added to an existing list, clients SHOULD append them to the end of the list, so they are stored in chronological order.
31
30## Uses 32## Uses
31 33
32### Follow list backup 34### Follow list backup
diff --git a/04.md b/04.md
index bf6767b..a561a2f 100644
--- a/04.md
+++ b/04.md
@@ -1,10 +1,12 @@
1> __Warning__ `unrecommended`: deprecated in favor of [NIP-17](17.md)
2
1NIP-04 3NIP-04
2====== 4======
3 5
4Encrypted Direct Message 6Encrypted Direct Message
5------------------------ 7------------------------
6 8
7`final` `optional` 9`final` `unrecommended` `optional`
8 10
9A special event with kind `4`, meaning "encrypted direct message". It is supposed to have the following attributes: 11A special event with kind `4`, meaning "encrypted direct message". It is supposed to have the following attributes:
10 12
diff --git a/05.md b/05.md
index 6437550..405078a 100644
--- a/05.md
+++ b/05.md
@@ -35,7 +35,7 @@ It will make a GET request to `https://example.com/.well-known/nostr.json?name=b
35} 35}
36```` 36````
37 37
38or with the **optional** `"relays"` attribute: 38or with the **recommended** `"relays"` attribute:
39 39
40```json 40```json
41{ 41{
@@ -50,7 +50,7 @@ or with the **optional** `"relays"` attribute:
50 50
51If the pubkey matches the one given in `"names"` (as in the example above) that means the association is right and the `"nip05"` identifier is valid and can be displayed. 51If the pubkey matches the one given in `"names"` (as in the example above) that means the association is right and the `"nip05"` identifier is valid and can be displayed.
52 52
53The optional `"relays"` attribute may contain an object with public keys as properties and arrays of relay URLs as values. When present, that can be used to help clients learn in which relays the specific user may be found. Web servers which serve `/.well-known/nostr.json` files dynamically based on the query string SHOULD also serve the relays data for any name they serve in the same reply when that is available. 53The recommended `"relays"` attribute may contain an object with public keys as properties and arrays of relay URLs as values. When present, that can be used to help clients learn in which relays the specific user may be found. Web servers which serve `/.well-known/nostr.json` files dynamically based on the query string SHOULD also serve the relays data for any name they serve in the same reply when that is available.
54 54
55## Finding users from their NIP-05 identifier 55## Finding users from their NIP-05 identifier
56 56
diff --git a/07.md b/07.md
index aa0a5f4..6c66322 100644
--- a/07.md
+++ b/07.md
@@ -18,22 +18,12 @@ async window.nostr.signEvent(event: { created_at: number, kind: number, tags: st
18Aside from these two basic above, the following functions can also be implemented optionally: 18Aside from these two basic above, the following functions can also be implemented optionally:
19``` 19```
20async window.nostr.getRelays(): { [url: string]: {read: boolean, write: boolean} } // returns a basic map of relay urls to relay policies 20async window.nostr.getRelays(): { [url: string]: {read: boolean, write: boolean} } // returns a basic map of relay urls to relay policies
21async window.nostr.nip04.encrypt(pubkey, plaintext): string // returns ciphertext and iv as specified in nip-04 21async window.nostr.nip04.encrypt(pubkey, plaintext): string // returns ciphertext and iv as specified in nip-04 (deprecated)
22async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext and iv as specified in nip-04 22async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext and iv as specified in nip-04 (deprecated)
23async window.nostr.nip44.encrypt(pubkey, plaintext): string // returns ciphertext as specified in nip-44
24async window.nostr.nip44.decrypt(pubkey, ciphertext): string // takes ciphertext as specified in nip-44
23``` 25```
24 26
25### Implementation 27### Implementation
26 28
27- [horse](https://github.com/fiatjaf/horse) (Chrome and derivatives) 29See https://github.com/aljazceru/awesome-nostr#nip-07-browser-extensions.
28- [nos2x](https://github.com/fiatjaf/nos2x) (Chrome and derivatives)
29- [Alby](https://getalby.com) (Chrome and derivatives, Firefox)
30- [Blockcore](https://www.blockcore.net/wallet) (Chrome and derivatives)
31- [nos2x-fox](https://diegogurpegui.com/nos2x-fox/) (Firefox)
32- [Flamingo](https://www.getflamingo.org/) (Chrome and derivatives)
33- [AKA Profiles](https://github.com/neilck/aka-extension) (Chrome, stores multiple keys)
34- [TokenPocket](https://www.tokenpocket.pro/) (Android, IOS, Chrome and derivatives)
35- [Nostrmo](https://github.com/haorendashu/nostrmo_faq#download) (Android, IOS)
36- [Spring Browser](https://spring.site) (Android)
37- [nodestr](https://github.com/lightning-digital-entertainment/nodestr) (NodeJS polyfill)
38- [Nostore](https://apps.apple.com/us/app/nostore/id1666553677) (Safari on iOS/MacOS)
39- [OneKey](https://onekey.so/) (Android, IOS, Chrome and derivatives)
diff --git a/11.md b/11.md
index 45102d7..a50038a 100644
--- a/11.md
+++ b/11.md
@@ -37,7 +37,7 @@ Detailed plain-text information about the relay may be contained in the `descrip
37 37
38### Pubkey 38### Pubkey
39 39
40An administrative contact may be listed with a `pubkey`, in the same format as Nostr events (32-byte hex for a `secp256k1` public key). If a contact is listed, this provides clients with a recommended address to send encrypted direct messages (See `NIP-04`) to a system administrator. Expected uses of this address are to report abuse or illegal content, file bug reports, or request other technical assistance. 40An administrative contact may be listed with a `pubkey`, in the same format as Nostr events (32-byte hex for a `secp256k1` public key). If a contact is listed, this provides clients with a recommended address to send encrypted direct messages (See [NIP-17](17.md)) to a system administrator. Expected uses of this address are to report abuse or illegal content, file bug reports, or request other technical assistance.
41 41
42Relay operators have no obligation to respond to direct messages. 42Relay operators have no obligation to respond to direct messages.
43 43
diff --git a/15.md b/15.md
index 1c3154a..55814fb 100644
--- a/15.md
+++ b/15.md
@@ -56,7 +56,7 @@ A merchant can publish these events:
56 "id": <string, id of the shipping zone, generated by the merchant>, 56 "id": <string, id of the shipping zone, generated by the merchant>,
57 "name": <string (optional), zone name>, 57 "name": <string (optional), zone name>,
58 "cost": <float, base cost for shipping. The currency is defined at the stall level>, 58 "cost": <float, base cost for shipping. The currency is defined at the stall level>,
59 "regions": [<string, regions included in this zone>], 59 "regions": [<string, regions included in this zone>]
60 } 60 }
61 ] 61 ]
62} 62}
@@ -101,7 +101,7 @@ Fields that are not self-explanatory:
101 "shipping": [ 101 "shipping": [
102 { 102 {
103 "id": <string, id of the shipping zone (must match one of the zones defined for the stall)>, 103 "id": <string, id of the shipping zone (must match one of the zones defined for the stall)>,
104 "cost": <float, extra cost for shipping. The currency is defined at the stall level>, 104 "cost": <float, extra cost for shipping. The currency is defined at the stall level>
105 } 105 }
106 ] 106 ]
107} 107}
@@ -139,7 +139,7 @@ Fields that are not self-explanatory:
139 139
140## Checkout events 140## Checkout events
141 141
142All checkout events are sent as JSON strings using ([NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md)). 142All checkout events are sent as JSON strings using ([NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md)).
143 143
144The `merchant` and the `customer` can exchange JSON messages that represent different actions. Each `JSON` message `MUST` have a `type` field indicating the what the JSON represents. Possible types: 144The `merchant` and the `customer` can exchange JSON messages that represent different actions. Each `JSON` message `MUST` have a `type` field indicating the what the JSON represents. Possible types:
145 145
@@ -149,21 +149,20 @@ The `merchant` and the `customer` can exchange JSON messages that represent diff
149| 1 | Merchant | Payment Request | 149| 1 | Merchant | Payment Request |
150| 2 | Merchant | Order Status Update | 150| 2 | Merchant | Order Status Update |
151 151
152
153### Step 1: `customer` order (event) 152### Step 1: `customer` order (event)
154The below json goes in content of [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md). 153The below JSON goes in content of [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md).
155 154
156```json 155```json
157{ 156{
158 "id": <string, id generated by the customer>, 157 "id": <string, id generated by the customer>,
159 "type": 0, 158 "type": 0,
160 "name": <string (optional), ???>, 159 "name": <string (optional), ???>,
161 "address": <string (optional), for physical goods an address should be provided> 160 "address": <string (optional), for physical goods an address should be provided>,
162 "message": "<string (optional), message for merchant>, 161 "message": "<string (optional), message for merchant>,
163 "contact": { 162 "contact": {
164 "nostr": <32-bytes hex of a pubkey>, 163 "nostr": <32-bytes hex of a pubkey>,
165 "phone": <string (optional), if the customer wants to be contacted by phone>, 164 "phone": <string (optional), if the customer wants to be contacted by phone>,
166 "email": <string (optional), if the customer wants to be contacted by email>, 165 "email": <string (optional), if the customer wants to be contacted by email>
167 }, 166 },
168 "items": [ 167 "items": [
169 { 168 {
@@ -183,7 +182,7 @@ _Open_: is `contact.nostr` required?
183 182
184Sent back from the merchant for payment. Any payment option is valid that the merchant can check. 183Sent back from the merchant for payment. Any payment option is valid that the merchant can check.
185 184
186The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md). 185The below JSON goes in `content` of [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md).
187 186
188`payment_options`/`type` include: 187`payment_options`/`type` include:
189 188
@@ -218,7 +217,7 @@ The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/ni
218 217
219Once payment has been received and processed. 218Once payment has been received and processed.
220 219
221The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md). 220The below JSON goes in `content` of [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md).
222 221
223```json 222```json
224{ 223{
@@ -229,7 +228,9 @@ The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/ni
229 "shipped": <bool: has been shipped>, 228 "shipped": <bool: has been shipped>,
230} 229}
231``` 230```
231
232## Customize Marketplace 232## Customize Marketplace
233
233Create a customized user experience using the `naddr` from [NIP-19](https://github.com/nostr-protocol/nips/blob/master/19.md#shareable-identifiers-with-extra-metadata). The use of `naddr` enables easy sharing of marketplace events while incorporating a rich set of metadata. This metadata can include relays, merchant profiles, and more. Subsequently, it allows merchants to be grouped into a market, empowering the market creator to configure the marketplace's user interface and user experience, and share that marketplace. This customization can encompass elements such as market name, description, logo, banner, themes, and even color schemes, offering a tailored and unique marketplace experience. 234Create a customized user experience using the `naddr` from [NIP-19](https://github.com/nostr-protocol/nips/blob/master/19.md#shareable-identifiers-with-extra-metadata). The use of `naddr` enables easy sharing of marketplace events while incorporating a rich set of metadata. This metadata can include relays, merchant profiles, and more. Subsequently, it allows merchants to be grouped into a market, empowering the market creator to configure the marketplace's user interface and user experience, and share that marketplace. This customization can encompass elements such as market name, description, logo, banner, themes, and even color schemes, offering a tailored and unique marketplace experience.
234 235
235### Event `30019`: Create or update marketplace UI/UX 236### Event `30019`: Create or update marketplace UI/UX
@@ -253,6 +254,81 @@ Create a customized user experience using the `naddr` from [NIP-19](https://gith
253 254
254This event leverages naddr to enable comprehensive customization and sharing of marketplace configurations, fostering a unique and engaging marketplace environment. 255This event leverages naddr to enable comprehensive customization and sharing of marketplace configurations, fostering a unique and engaging marketplace environment.
255 256
257## Auctions
258
259### Event `30020`: Create or update a product sold as an auction
260
261**Event Content**:
262```json
263{
264 "id": <String, UUID generated by the merchant. Sequential IDs (`0`, `1`, `2`...) are discouraged>,
265 "stall_id": <String, UUID of the stall to which this product belong to>,
266 "name": <String, product name>,
267 "description": <String (optional), product description>,
268 "images": <[String], array of image URLs, optional>,
269 "starting_bid": <int>,
270 "start_date": <int (optional) UNIX timestamp, date the auction started / will start>,
271 "duration": <int, number of seconds the auction will run for, excluding eventual time extensions that might happen>,
272 "specs": [
273 [<String, spec key>, <String, spec value>]
274 ],
275 "shipping": [
276 {
277 "id": <String, UUID of the shipping zone. Must match one of the zones defined for the stall>,
278 "cost": <float, extra cost for shipping. The currency is defined at the stall level>
279 }
280 ]
281}
282```
283
284> [!NOTE]
285> Items sold as an auction are very similar in structure to fixed-price items, with some important differences worth noting.
286
287* The `start_date` can be set to a date in the future if the auction is scheduled to start on that date, or can be omitted if the start date is unknown/hidden. If the start date is not specified, the auction will have to be edited later to set an actual date.
288
289* The auction runs for an initial number of seconds after the `start_date`, specified by `duration`.
290
291### Event `1021`: Bid
292
293```json
294{
295 "content": <int, amount of sats>,
296 "tags": [["e", <event ID of the auction to bid on>]],
297}
298```
299
300Bids are simply events of kind `1021` with a `content` field specifying the amount, in the currency of the auction. Bids must reference an auction.
301
302> [!NOTE]
303> Auctions can be edited as many times as desired (they are "parameterized replaceable events") by the author - even after the start_date, but they cannot be edited after they have received the first bid! This is enforced by the fact that bids reference the event ID of the auction (rather than the product UUID), which changes with every new version of the auctioned product. So a bid is always attached to one "version". Editing the auction after a bid would result in the new product losing the bid!
304
305### Event `1022`: Bid confirmation
306
307**Event Content**:
308
309```json
310{
311 "status": <String, "accepted" | "rejected" | "pending" | "winner">,
312 "message": <String (optional)>,
313 "duration_extended": <int (optional), number of seconds>
314}
315```
316
317**Event Tags**:
318```json
319 "tags": [["e" <event ID of the bid being confirmed>], ["e", <event ID of the auction>]],
320```
321
322Bids should be confirmed by the merchant before being considered as valid by other clients. So clients should subscribe to *bid confirmation* events (kind `1022`) for every auction that they follow, in addition to the actual bids and should check that the pubkey of the bid confirmation matches the pubkey of the merchant (in addition to checking the signature).
323
324The `content` field is a JSON which includes *at least* a `status`. `winner` is how the *winning bid* is replied to after the auction ends and the winning bid is picked by the merchant.
325
326The reasons for which a bid can be marked as `rejected` or `pending` are up to the merchant's implementation and configuration - they could be anything from basic validation errors (amount too low) to the bidder being blacklisted or to the bidder lacking sufficient *trust*, which could lead to the bid being marked as `pending` until sufficient verification is performed. The difference between the two is that `pending` bids *might* get approved after additional steps are taken by the bidder, whereas `rejected` bids can not be later approved.
327
328An additional `message` field can appear in the `content` JSON to give further context as of why a bid is `rejected` or `pending`.
329
330Another thing that can happen is - if bids happen very close to the end date of the auction - for the merchant to decide to extend the auction duration for a few more minutes. This is done by passing a `duration_extended` field as part of a bid confirmation, which would contain a number of seconds by which the initial duration is extended. So the actual end date of an auction is always `start_date + duration + (SUM(c.duration_extended) FOR c in all confirmations`.
331
256## Customer support events 332## Customer support events
257 333
258Customer support is handled over whatever communication method was specified. If communicating via nostr, NIP-04 is used https://github.com/nostr-protocol/nips/blob/master/04.md. 334Customer support is handled over whatever communication method was specified. If communicating via nostr, NIP-04 is used https://github.com/nostr-protocol/nips/blob/master/04.md.
diff --git a/17.md b/17.md
new file mode 100644
index 0000000..0f51367
--- /dev/null
+++ b/17.md
@@ -0,0 +1,164 @@
1NIP-17
2======
3
4Private Direct Messages
5-----------------------
6
7`draft` `optional`
8
9This NIP defines an encrypted direct messaging scheme using [NIP-44](44.md) encryption and [NIP-59](59.md) seals and gift wraps.
10
11## Direct Message Kind
12
13Kind `14` is a chat message. `p` tags identify one or more receivers of the message.
14
15```js
16{
17 "id": "<usual hash>",
18  "pubkey": "<sender-pubkey>",
19 "created_at": now(),
20  "kind": 14,
21  "tags": [
22    ["p", "<receiver-1-pubkey>", "<relay-url>"],
23    ["p", "<receiver-2-pubkey>", "<relay-url>"],
24    ["e", "<kind-14-id>", "<relay-url>", "reply"] // if this is a reply
25 ["subject", "<conversation-title>"],
26    ...
27  ],
28  "content": "<message-in-plain-text>",
29}
30```
31
32`.content` MUST be plain text. Fields `id` and `created_at` are required.
33
34Tags that mention, quote and assemble threading structures MUST follow [NIP-10](10.md).
35
36Kind `14`s MUST never be signed. If it is signed, the message might leak to relays and become **fully public**.
37
38## Chat Rooms
39
40The set of `pubkey` + `p` tags defines a chat room. If a new `p` tag is added or a current one is removed, a new room is created with clean message history.
41
42Clients SHOULD render messages of the same room in a continuous thread.
43
44An optional `subject` tag defines the current name/topic of the conversation. Any member can change the topic by simply submitting a new `subject` to an existing `pubkey` + `p`-tags room. There is no need to send `subject` in every message. The newest `subject` in the thread is the subject of the conversation.
45
46## Encrypting
47
48Following [NIP-59](59.md), the **unsigned** `kind:14` chat message must be sealed (`kind:13`) and then gift-wrapped (`kind:1059`) to each receiver and the sender individually.
49
50```js
51{
52 "id": "<usual hash>",
53  "pubkey": randomPublicKey,
54  "created_at": randomTimeUpTo2DaysInThePast(),
55 "kind": 1059, // gift wrap
56  "tags": [
57    ["p", receiverPublicKey, "<relay-url>"] // receiver
58  ],
59  "content": nip44Encrypt(
60    {
61 "id": "<usual hash>",
62      "pubkey": senderPublicKey,
63      "created_at": randomTimeUpTo2DaysInThePast(),
64      "kind": 13, // seal
65      "tags": [], // no tags
66      "content": nip44Encrypt(unsignedKind14, senderPrivateKey, receiverPublicKey),
67      "sig": "<signed by senderPrivateKey>"
68    },
69    randomPrivateKey, receiverPublicKey
70  ),
71  "sig": "<signed by randomPrivateKey>"
72}
73```
74
75The encryption algorithm MUST use the latest version of [NIP-44](44.md).
76
77Clients MUST verify if pubkey of the `kind:13` is the same pubkey on the `kind:14`, otherwise any sender can impersonate others by simply changing the pubkey on `kind:14`.
78
79Clients SHOULD randomize `created_at` in up to two days in the past in both the seal and the gift wrap to make sure grouping by `created_at` doesn't reveal any metadata.
80
81The gift wrap's `p`-tag can be the receiver's main pubkey or an alias key created to receive DMs without exposing the receiver's identity.
82
83Clients CAN offer disappearing messages by setting an `expiration` tag in the gift wrap of each receiver or by not generating a gift wrap to the sender's public key
84
85## Publishing
86
87Kind `10050` indicates the user's preferred relays to receive DMs. The event MUST include a list of `relay` tags with relay URIs.
88
89```js
90{
91 "kind": 10050,
92 "tags": [
93 ["relay", "wss://inbox.nostr.wine"],
94 ["relay", "wss://myrelay.nostr1.com"],
95 ],
96 "content": "",
97 //...other fields
98}
99```
100
101Clients SHOULD publish kind `14` events to the `10050`-listed relays. If that is not found that indicates the user is not ready to receive messages under this NIP and clients shouldn't try.
102
103## Relays
104
105It's advisable that relays do not serve `kind:14` to clients other than the ones tagged in them.
106
107It's advisable that users choose relays that conform to these practices.
108
109Clients SHOULD guide users to keep `kind:10050` lists small (1-3 relays) and SHOULD spread it to as many relays as viable.
110
111## Benefits & Limitations
112
113This NIP offers the following privacy and security features:
114
1151. **No Metadata Leak**: Participant identities, each message's real date and time, event kinds, and other event tags are all hidden from the public. Senders and receivers cannot be linked with public information alone.
1162. **No Public Group Identifiers**: There is no public central queue, channel or otherwise converging identifier to correlate or count all messages in the same group.
1173. **No Moderation**: There are no group admins: no invitations or bans.
1184. **No Shared Secrets**: No secret must be known to all members that can leak or be mistakenly shared
1195. **Fully Recoverable**: Messages can be fully recoverable by any client with the user's private key
1206. **Optional Forward Secrecy**: Users and clients can opt-in for "disappearing messages".
1217. **Uses Public Relays**: Messages can flow through public relays without loss of privacy. Private relays can increase privacy further, but they are not required.
1228. **Cold Storage**: Users can unilaterally opt-in to sharing their messages with a separate key that is exclusive for DM backup and recovery.
123
124The main limitation of this approach is having to send a separate encrypted event to each receiver. Group chats with more than 100 participants should find a more suitable messaging scheme.
125
126## Implementation
127
128Clients implementing this NIP should by default only connect to the set of relays found in their `kind:10050` list. From that they should be able to load all messages both sent and received as well as get new live updates, making it for a very simple and lightweight implementation that should be fast.
129
130When sending a message to anyone, clients must then connect to the relays in the receiver's `kind:10050` and send the events there, but can disconnect right after unless more messages are expected to be sent (e.g. the chat tab is still selected). Clients should also send a copy of their outgoing messages to their own `kind:10050` relay set.
131
132## Examples
133
134This example sends the message `Hola, que tal?` from `nsec1w8udu59ydjvedgs3yv5qccshcj8k05fh3l60k9x57asjrqdpa00qkmr89m` to `nsec12ywtkplvyq5t6twdqwwygavp5lm4fhuang89c943nf2z92eez43szvn4dt`.
135
136The two final GiftWraps, one to the receiver and the other to the sender, are:
137
138```json
139{
140 "id":"2886780f7349afc1344047524540ee716f7bdc1b64191699855662330bf235d8",
141 "pubkey":"8f8a7ec43b77d25799281207e1a47f7a654755055788f7482653f9c9661c6d51",
142 "created_at":1703128320,
143 "kind":1059,
144 "tags":[
145 [ "p", "918e2da906df4ccd12c8ac672d8335add131a4cf9d27ce42b3bb3625755f0788"]
146 ],
147 "content":"AsqzdlMsG304G8h08bE67dhAR1gFTzTckUUyuvndZ8LrGCvwI4pgC3d6hyAK0Wo9gtkLqSr2rT2RyHlE5wRqbCOlQ8WvJEKwqwIJwT5PO3l2RxvGCHDbd1b1o40ZgIVwwLCfOWJ86I5upXe8K5AgpxYTOM1BD+SbgI5jOMA8tgpRoitJedVSvBZsmwAxXM7o7sbOON4MXHzOqOZpALpS2zgBDXSAaYAsTdEM4qqFeik+zTk3+L6NYuftGidqVluicwSGS2viYWr5OiJ1zrj1ERhYSGLpQnPKrqDaDi7R1KrHGFGyLgkJveY/45y0rv9aVIw9IWF11u53cf2CP7akACel2WvZdl1htEwFu/v9cFXD06fNVZjfx3OssKM/uHPE9XvZttQboAvP5UoK6lv9o3d+0GM4/3zP+yO3C0NExz1ZgFmbGFz703YJzM+zpKCOXaZyzPjADXp8qBBeVc5lmJqiCL4solZpxA1865yPigPAZcc9acSUlg23J1dptFK4n3Tl5HfSHP+oZ/QS/SHWbVFCtq7ZMQSRxLgEitfglTNz9P1CnpMwmW/Y4Gm5zdkv0JrdUVrn2UO9ARdHlPsW5ARgDmzaxnJypkfoHXNfxGGXWRk0sKLbz/ipnaQP/eFJv/ibNuSfqL6E4BnN/tHJSHYEaTQ/PdrA2i9laG3vJti3kAl5Ih87ct0w/tzYfp4SRPhEF1zzue9G/16eJEMzwmhQ5Ec7jJVcVGa4RltqnuF8unUu3iSRTQ+/MNNUkK6Mk+YuaJJs6Fjw6tRHuWi57SdKKv7GGkr0zlBUU2Dyo1MwpAqzsCcCTeQSv+8qt4wLf4uhU9Br7F/L0ZY9bFgh6iLDCdB+4iABXyZwT7Ufn762195hrSHcU4Okt0Zns9EeiBOFxnmpXEslYkYBpXw70GmymQfJlFOfoEp93QKCMS2DAEVeI51dJV1e+6t3pCSsQN69Vg6jUCsm1TMxSs2VX4BRbq562+VffchvW2BB4gMjsvHVUSRl8i5/ZSDlfzSPXcSGALLHBRzy+gn0oXXJ/447VHYZJDL3Ig8+QW5oFMgnWYhuwI5QSLEyflUrfSz+Pdwn/5eyjybXKJftePBD9Q+8NQ8zulU5sqvsMeIx/bBUx0fmOXsS3vjqCXW5IjkmSUV7q54GewZqTQBlcx+90xh/LSUxXex7UwZwRnifvyCbZ+zwNTHNb12chYeNjMV7kAIr3cGQv8vlOMM8ajyaZ5KVy7HpSXQjz4PGT2/nXbL5jKt8Lx0erGXsSsazkdoYDG3U",
148 "sig":"a3c6ce632b145c0869423c1afaff4a6d764a9b64dedaf15f170b944ead67227518a72e455567ca1c2a0d187832cecbde7ed478395ec4c95dd3e71749ed66c480"
149}
150```
151
152```json
153{
154 "id":"162b0611a1911cfcb30f8a5502792b346e535a45658b3a31ae5c178465509721",
155 "pubkey":"626be2af274b29ea4816ad672ee452b7cf96bbb4836815a55699ae402183f512",
156 "created_at":1702711587,
157 "kind":1059,
158 "tags":[
159 [ "p", "44900586091b284416a0c001f677f9c49f7639a55c3f1e2ec130a8e1a7998e1b"]
160 ],
161 "content":"AsTClTzr0gzXXji7uye5UB6LYrx3HDjWGdkNaBS6BAX9CpHa+Vvtt5oI2xJrmWLen+Fo2NBOFazvl285Gb3HSM82gVycrzx1HUAaQDUG6HI7XBEGqBhQMUNwNMiN2dnilBMFC3Yc8ehCJT/gkbiNKOpwd2rFibMFRMDKai2mq2lBtPJF18oszKOjA+XlOJV8JRbmcAanTbEK5nA/GnG3eGUiUzhiYBoHomj3vztYYxc0QYHOx0WxiHY8dsC6jPsXC7f6k4P+Hv5ZiyTfzvjkSJOckel1lZuE5SfeZ0nduqTlxREGeBJ8amOykgEIKdH2VZBZB+qtOMc7ez9dz4wffGwBDA7912NFS2dPBr6txHNxBUkDZKFbuD5wijvonZDvfWq43tZspO4NutSokZB99uEiRH8NAUdGTiNb25m9JcDhVfdmABqTg5fIwwTwlem5aXIy8b66lmqqz2LBzJtnJDu36bDwkILph3kmvaKPD8qJXmPQ4yGpxIbYSTCohgt2/I0TKJNmqNvSN+IVoUuC7ZOfUV9lOV8Ri0AMfSr2YsdZ9ofV5o82ClZWlWiSWZwy6ypa7CuT1PEGHzywB4CZ5ucpO60Z7hnBQxHLiAQIO/QhiBp1rmrdQZFN6PUEjFDloykoeHe345Yqy9Ke95HIKUCS9yJurD+nZjjgOxZjoFCsB1hQAwINTIS3FbYOibZnQwv8PXvcSOqVZxC9U0+WuagK7IwxzhGZY3vLRrX01oujiRrevB4xbW7Oxi/Agp7CQGlJXCgmRE8Rhm+Vj2s+wc/4VLNZRHDcwtfejogjrjdi8p6nfUyqoQRRPARzRGUnnCbh+LqhigT6gQf3sVilnydMRScEc0/YYNLWnaw9nbyBa7wFBAiGbJwO40k39wj+xT6HTSbSUgFZzopxroO3f/o4+ubx2+IL3fkev22mEN38+dFmYF3zE+hpE7jVxrJpC3EP9PLoFgFPKCuctMnjXmeHoiGs756N5r1Mm1ffZu4H19MSuALJlxQR7VXE/LzxRXDuaB2u9days/6muP6gbGX1ASxbJd/ou8+viHmSC/ioHzNjItVCPaJjDyc6bv+gs1NPCt0qZ69G+JmgHW/PsMMeL4n5bh74g0fJSHqiI9ewEmOG/8bedSREv2XXtKV39STxPweceIOh0k23s3N6+wvuSUAJE7u1LkDo14cobtZ/MCw/QhimYPd1u5HnEJvRhPxz0nVPz0QqL/YQeOkAYk7uzgeb2yPzJ6DBtnTnGDkglekhVzQBFRJdk740LEj6swkJ",
162 "sig":"c94e74533b482aa8eeeb54ae72a5303e0b21f62909ca43c8ef06b0357412d6f8a92f96e1a205102753777fd25321a58fba3fb384eee114bd53ce6c06a1c22bab"
163}
164```
diff --git a/18.md b/18.md
index ba96c89..27c5915 100644
--- a/18.md
+++ b/18.md
@@ -20,9 +20,10 @@ reposted.
20 20
21## Quote Reposts 21## Quote Reposts
22 22
23Quote reposts are `kind 1` events with an embedded `e` tag 23Quote reposts are `kind 1` events with an embedded `q` tag of the note being
24(see [NIP-08](08.md) and [NIP-27](27.md)). Because a quote repost includes 24quote reposted. The `q` tag ensures quote reposts are not pulled and included
25an `e` tag, it may show up along replies to the reposted note. 25as replies in threads. It also allows you to easily pull and count all of the
26quotes for a post.
26 27
27## Generic Reposts 28## Generic Reposts
28 29
diff --git a/24.md b/24.md
index f830b68..b21f48e 100644
--- a/24.md
+++ b/24.md
@@ -16,6 +16,7 @@ These are extra fields not specified in NIP-01 that may be present in the string
16 - `display_name`: an alternative, bigger name with richer characters than `name`. `name` should always be set regardless of the presence of `display_name` in the metadata. 16 - `display_name`: an alternative, bigger name with richer characters than `name`. `name` should always be set regardless of the presence of `display_name` in the metadata.
17 - `website`: a web URL related in any way to the event author. 17 - `website`: a web URL related in any way to the event author.
18 - `banner`: an URL to a wide (~1024x768) picture to be optionally displayed in the background of a profile screen. 18 - `banner`: an URL to a wide (~1024x768) picture to be optionally displayed in the background of a profile screen.
19 - `bot`: a boolean to clarify that the content is entirely or partially the result of automation, such as with chatbots or newsfeeds.
19 20
20### Deprecated fields 21### Deprecated fields
21 22
@@ -39,3 +40,4 @@ tags
39These tags may be present in multiple event kinds. Whenever a different meaning is not specified by some more specific NIP, they have the following meanings: 40These tags may be present in multiple event kinds. Whenever a different meaning is not specified by some more specific NIP, they have the following meanings:
40 41
41 - `r`: a web URL the event is referring to in some way 42 - `r`: a web URL the event is referring to in some way
43 - `title`: name of [NIP-51](51.md) sets, [NIP-52](52.md) calendar event, [NIP-53](53.md) live event or [NIP-99](99.md) listing
diff --git a/25.md b/25.md
index 3b4aa59..7cc96b5 100644
--- a/25.md
+++ b/25.md
@@ -25,14 +25,16 @@ consider it a "+".
25Tags 25Tags
26---- 26----
27 27
28The reaction event SHOULD include `e` and `p` tags from the note the user is 28The reaction event SHOULD include `a`, `e` and `p` tags pointing to the note the user is
29reacting to. This allows users to be notified of reactions to posts they were 29reacting to. The `p` tag allows authors to be notified. The `e` tags enables clients
30mentioned in. Including the `e` tags enables clients to pull all the reactions 30to pull all the reactions to individual events and `a` tags enables clients to seek reactions
31associated with individual posts or all the posts in a thread. 31for all versions of a replaceable event.
32 32
33The last `e` tag MUST be the `id` of the note that is being reacted to. 33The `e` tag MUST be the `id` of the note that is being reacted to.
34 34
35The last `p` tag MUST be the `pubkey` of the event being reacted to. 35The `a` tag MUST contain the coordinates (`kind:pubkey:d-tag`) of the replaceable being reacted to.
36
37The `p` tag MUST be the `pubkey` of the event being reacted to.
36 38
37The reaction event MAY include a `k` tag with the stringified kind number 39The reaction event MAY include a `k` tag with the stringified kind number
38of the reacted event as its value. 40of the reacted event as its value.
@@ -41,9 +43,6 @@ Example code
41 43
42```swift 44```swift
43func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> NostrEvent { 45func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> NostrEvent {
44 var tags: [[String]] = liked.tags.filter {
45 tag in tag.count >= 2 && (tag[0] == "e" || tag[0] == "p")
46 }
47 tags.append(["e", liked.id]) 46 tags.append(["e", liked.id])
48 tags.append(["p", liked.pubkey]) 47 tags.append(["p", liked.pubkey])
49 tags.append(["k", liked.kind]) 48 tags.append(["k", liked.kind])
diff --git a/28.md b/28.md
index 2dcf800..65ebb3f 100644
--- a/28.md
+++ b/28.md
@@ -23,11 +23,11 @@ Client-centric moderation gives client developers discretion over what types of
23 23
24Create a public chat channel. 24Create a public chat channel.
25 25
26In the channel creation `content` field, Client SHOULD include basic channel metadata (`name`, `about`, `picture` as specified in kind 41). 26In the channel creation `content` field, Client SHOULD include basic channel metadata (`name`, `about`, `picture` and `relays` as specified in kind 41).
27 27
28```json 28```json
29{ 29{
30 "content": "{\"name\": \"Demo Channel\", \"about\": \"A test channel.\", \"picture\": \"https://placekitten.com/200/200\"}", 30 "content": "{\"name\": \"Demo Channel\", \"about\": \"A test channel.\", \"picture\": \"https://placekitten.com/200/200\", \"relays\": [\"wss://nos.lol\", \"wss://nostr.mom\"]}",
31 ... 31 ...
32} 32}
33``` 33```
@@ -46,6 +46,7 @@ Clients SHOULD support basic metadata fields:
46- `name` - string - Channel name 46- `name` - string - Channel name
47- `about` - string - Channel description 47- `about` - string - Channel description
48- `picture` - string - URL of channel picture 48- `picture` - string - URL of channel picture
49- `relays` - array - List of relays to download and broadcast events to
49 50
50Clients MAY add additional metadata fields. 51Clients MAY add additional metadata fields.
51 52
@@ -53,7 +54,7 @@ Clients SHOULD use [NIP-10](10.md) marked "e" tags to recommend a relay.
53 54
54```json 55```json
55{ 56{
56 "content": "{\"name\": \"Updated Demo Channel\", \"about\": \"Updating a test channel.\", \"picture\": \"https://placekitten.com/201/201\"}", 57 "content": "{\"name\": \"Updated Demo Channel\", \"about\": \"Updating a test channel.\", \"picture\": \"https://placekitten.com/201/201\", \"relays\": [\"wss://nos.lol\", \"wss://nostr.mom\"]}",
57 "tags": [["e", <channel_create_event_id>, <relay-url>]], 58 "tags": [["e", <channel_create_event_id>, <relay-url>]],
58 ... 59 ...
59} 60}
@@ -132,12 +133,11 @@ Clients MAY hide event 42s for users other than the user who sent the event 44.
132} 133}
133``` 134```
134 135
135## NIP-10 relay recommendations 136## Relay recommendations
136 137
137For [NIP-10](10.md) relay recommendations, clients generally SHOULD use the relay URL of the original (oldest) kind 40 event. 138Clients SHOULD use the relay URLs of the metadata events.
138
139Clients MAY recommend any relay URL. For example, if a relay hosting the original kind 40 event for a channel goes offline, clients could instead fetch channel data from a backup relay, or a relay that clients trust more than the original relay.
140 139
140Clients MAY use any relay URL. For example, if a relay hosting the original kind 40 event for a channel goes offline, clients could instead fetch channel data from a backup relay, or a relay that clients trust more than the original relay.
141 141
142Motivation 142Motivation
143---------- 143----------
diff --git a/29.md b/29.md
new file mode 100644
index 0000000..0f4a579
--- /dev/null
+++ b/29.md
@@ -0,0 +1,197 @@
1NIP-29
2======
3
4Relay-based Groups
5------------------
6
7`draft` `optional`
8
9This NIP defines a standard for groups that are only writable by a closed set of users. They can be public for reading by external users or not.
10
11Groups are identified by a random string of any length that serves as an _id_.
12
13There is no way to create a group, what happens is just that relays (most likely when asked by users) will create rules around some specific ids so these ids can serve as an actual group, henceforth messages sent to that group will be subject to these rules.
14
15Normally a group will originally belong to one specific relay, but the community may choose to move the group to other relays or even fork the group so it exists in different forms -- still using the same _id_ -- across different relays.
16
17## Relay-generated events
18
19Relays are supposed to generate the events that describe group metadata and group admins. These are parameterized replaceable events signed by the relay keypair directly, with the group _id_ as the `d` tag.
20
21## Group identifier
22
23A group may be identified by a string in the format `<host>'<group-id>`. For example, a group with _id_ `abcdef` hosted at the relay `wss://groups.nostr.com` would be identified by the string `groups.nostr.com'abcdef`.
24
25## The `h` tag
26
27Events sent by users to groups (chat messages, text notes, moderation events etc) must have an `h` tag with the value set to the group _id_.
28
29## Timeline references
30
31In order to not be used out of context, events sent to these groups may contain references to previous events seen from the same relay in the `previous` tag. The choice of which previous events to pick belongs to the clients. The references are to be made using the first 8 characters (4 bytes) of any event in the last 50 events seen by the user in the relay, excluding events by themselves. There can be any number of references (including zero), but it's recommended that clients include at least 3 and that relays enforce this.
32
33This is a hack to prevent messages from being broadcasted to external relays that have forks of one group out of context. Relays are expected to reject any events that contain timeline references to events not found in their own database. Clients should also check these to keep relays honest about them.
34
35## Late publication
36
37Relays should prevent late publication (messages published now with a timestamp from days or even hours ago) unless they are open to receive a group forked or moved from another relay.
38
39## Event definitions
40
41- *text root note* (`kind:11`)
42
43This is the basic unit of a "microblog" root text note sent to a group.
44
45```js
46 "kind": 11,
47 "content": "hello my friends lovers of pizza",
48 "tags": [
49 ["h", "<group-id>"],
50 ["previous", "<event-id-first-chars>", "<event-id-first-chars>", ...]
51 ]
52 ...
53```
54
55- *threaded text reply* (`kind:12`)
56
57This is the basic unit of a "microblog" reply note sent to a group. It's the same as `kind:11`, except for the fact that it must be used whenever it's in reply to some other note (either in reply to a `kind:11` or a `kind:12`). `kind:12` events SHOULD use NIP-10 markers, leaving an empty relay url:
58
59* `["e", "<kind-11-root-id>", "", "root"]`
60* `["e", "<kind-12-event-id>", "", "reply"]`
61
62- *chat message* (`kind:9`)
63
64This is the basic unit of a _chat message_ sent to a group.
65
66```js
67 "kind": 9,
68 "content": "hello my friends lovers of pizza",
69 "tags": [
70 ["h", "<group-id>"],
71 ["previous", "<event-id-first-chars>", "<event-id-first-chars>", ...]
72 ]
73 ...
74```
75
76- *chat message threaded reply* (`kind:10`)
77
78Similar to `kind:12`, this is the basic unit of a chat message sent to a group. This is intended for in-chat threads that may be hidden by default. Not all in-chat replies MUST use `kind:10`, only when the intention is to create a hidden thread that isn't part of the normal flow of the chat (although clients are free to display those by default too).
79
80`kind:10` SHOULD use NIP-10 markers, just like `kind:12`.
81
82- *join request* (`kind:9021`)
83
84Any user can send one of these events to the relay in order to be automatically or manually added to the group. If the group is `open` the relay will automatically issue a `kind:9000` in response adding this user. Otherwise group admins may choose to query for these requests and act upon them.
85
86```js
87{
88 "kind": 9021,
89 "content": "optional reason",
90 "tags": [
91 ["h", "<group-id>"]
92 ]
93}
94```
95
96- *moderation events* (`kinds:9000-9020`) (optional)
97
98Clients can send these events to a relay in order to accomplish a moderation action. Relays must check if the pubkey sending the event is capable of performing the given action. The relay may discard the event after taking action or keep it as a moderation log.
99
100```js
101{
102 "kind": 90xx,
103 "content": "optional reason",
104 "tags": [
105 ["h", "<group-id>"],
106 ["previous", ...]
107 ]
108}
109```
110
111Each moderation action uses a different kind and requires different arguments, which are given as tags. These are defined in the following table:
112
113| kind | name | tags |
114| --- | --- | --- |
115| 9000 | `add-user` | `p` (pubkey hex) |
116| 9001 | `remove-user` | `p` (pubkey hex) |
117| 9002 | `edit-metadata` | `name`, `about`, `picture` (string) |
118| 9003 | `add-permission` | `p` (pubkey), `permission` (name) |
119| 9004 | `remove-permission` | `p` (pubkey), `permission` (name) |
120| 9005 | `delete-event` | `e` (id hex) |
121| 9006 | `edit-group-status` | `public` or `private`, `open` or `closed` |
122
123- *group metadata* (`kind:39000`) (optional)
124
125This event defines the metadata for the group -- basically how clients should display it. It must be generated and signed by the relay in which is found. Relays shouldn't accept these events if they're signed by anyone else.
126
127If the group is forked and hosted in multiple relays, there will be multiple versions of this event in each different relay and so on.
128
129```js
130{
131 "kind": 39000,
132 "content": "",
133 "tags": [
134 ["d", "<group-id>"],
135 ["name", "Pizza Lovers"],
136 ["picture", "https://pizza.com/pizza.png"],
137 ["about", "a group for people who love pizza"],
138 ["public"], // or ["private"]
139 ["open"] // or ["closed"]
140 ]
141 ...
142}
143```
144
145`name`, `picture` and `about` are basic metadata for the group for display purposes. `public` signals the group can be _read_ by anyone, while `private` signals that only AUTHed users can read. `open` signals that anyone can request to join and the request will be automatically granted, while `closed` signals that members must be pre-approved or that requests to join will be manually handled.
146
147- *group admins* (`kind:39001`) (optional)
148
149Similar to the group metadata, this event is supposed to be generated by relays that host the group.
150
151Each admin gets a label that is only used for display purposes, and a list of permissions it has are listed afterwards. These permissions can inform client building UI, but ultimately are evaluated by the relay in order to become effective.
152
153The list of capabilities, as defined by this NIP, for now, is the following:
154
155- `add-user`
156- `edit-metadata`
157- `delete-event`
158- `remove-user`
159- `add-permission`
160- `remove-permission`
161- `edit-group-status`
162
163```js
164{
165 "kind": 39001,
166 "content": "list of admins for the pizza lovers group",
167 "tags": [
168 ["d", "<group-id>"],
169 ["p", "<pubkey1-as-hex>", "ceo", "add-user", "edit-metadata", "delete-event", "remove-user"],
170 ["p", "<pubkey2-as-hex>", "secretary", "add-user", "delete-event"]
171 ]
172 ...
173}
174```
175
176- *group members* (`kind:39002`) (optional)
177
178Similar to *group admins*, this event is supposed to be generated by relays that host the group.
179
180It's a NIP-51-like list of pubkeys that are members of the group. Relays might choose to not to publish this information or to restrict what pubkeys can fetch it.
181
182```json
183{
184 "kind": 39002,
185 "content": "list of members for the pizza lovers group",
186 "tags": [
187 ["d", "<group-id>"],
188 ["p", "<admin1>"],
189 ["p", "<member-pubkey1>"],
190 ["p", "<member-pubkey2>"],
191 ]
192}
193```
194
195## Storing the list of groups a user belongs to
196
197A definition for kind `10009` was included in [NIP-51](51.md) that allows clients to store the list of groups a user wants to remember being in.
diff --git a/30.md b/30.md
index 5a6f84d..c2f8bb0 100644
--- a/30.md
+++ b/30.md
@@ -6,7 +6,7 @@ Custom Emoji
6 6
7`draft` `optional` 7`draft` `optional`
8 8
9Custom emoji may be added to **kind 0** and **kind 1** events by including one or more `"emoji"` tags, in the form: 9Custom emoji may be added to **kind 0**, **kind 1**, **kind 7** ([NIP-25](25.md)) and **kind 30315** ([NIP-38](38.md)) events by including one or more `"emoji"` tags, in the form:
10 10
11``` 11```
12["emoji", <shortcode>, <image-url>] 12["emoji", <shortcode>, <image-url>]
diff --git a/32.md b/32.md
index be4e872..92497a6 100644
--- a/32.md
+++ b/32.md
@@ -151,3 +151,11 @@ A good heuristic for whether a use case fits this NIP is whether labels would ev
151For example, many events might be labeled with a particular place, topic, or pubkey, but labels 151For example, many events might be labeled with a particular place, topic, or pubkey, but labels
152with specific values like "John Doe" or "3.18743" are not labels, they are values, and should 152with specific values like "John Doe" or "3.18743" are not labels, they are values, and should
153be handled in some other way. 153be handled in some other way.
154
155
156Appendix: Known Ontologies
157-------------------------
158
159Below is a non-exhaustive list of ontologies currently in widespread use.
160
161- (social.ontolo.categories)[https://ontolo.social/]
diff --git a/34.md b/34.md
new file mode 100644
index 0000000..fcc2cec
--- /dev/null
+++ b/34.md
@@ -0,0 +1,152 @@
1NIP-34
2======
3
4`git` stuff
5-----------
6
7`draft` `optional`
8
9This NIP defines all the ways code collaboration using and adjacent to [`git`](https://git-scm.com/) can be done using Nostr.
10
11## Repository announcements
12
13Git repositories are hosted in Git-enabled servers, but their existence can be announced using Nostr events, as well as their willingness to receive patches, bug reports and comments in general.
14
15```jsonc
16{
17 "kind": 30617,
18 "content": "",
19 "tags": [
20 ["d", "<repo-id>"], // usually kebab-case short name
21 ["name", "<human-readable project name>"],
22 ["description", "brief human-readable project description>"],
23 ["web", "<url for browsing>", ...], // a webpage url, if the git server being used provides such a thing
24 ["clone", "<url for git-cloning>", ...], // a url to be given to `git clone` so anyone can clone it
25 ["relays", "<relay-url>", ...] // relays that this repository will monitor for patches and issues
26 ["r", "<earliest-unique-commit-id>", "euc"]
27 ["maintainers", "<other-recognized-maintainer>", ...]
28 ]
29}
30```
31
32The tags `web`, `clone`, `relays`, `maintainers` can have multiple values.
33
34The `r` tag annotated with the `"euc"` marker should be the commit ID of the earliest unique commit of this repo, made to identify it among forks and group it with other repositories hosted elsewhere that may represent essentially the same project. In most cases it will be the root commit of a repository. In case of a permanent fork between two projects, then the first commit after the fork should be used.
35
36Except `d`, all tags are optional.
37
38## Patches
39
40Patches can be sent by anyone to any repository. Patches to a specific repository SHOULD be sent to the relays specified in that repository's announcement event's `"relays"` tag. Patch events SHOULD include an `a` tag pointing to that repository's announcement address.
41
42Patches in a patch set SHOULD include a NIP-10 `e` `reply` tag pointing to the previous patch.
43
44The first patch revision in a patch revision SHOULD include a NIP-10 `e` `reply` to the original root patch.
45
46```jsonc
47{
48 "kind": 1617,
49 "content": "<patch>", // contents of <git format-patch>
50 "tags": [
51 ["a", "30617:<base-repo-owner-pubkey>:<base-repo-id>"],
52 ["r", "<earliest-unique-commit-id-of-repo>"] // so clients can subscribe to all patches sent to a local git repo
53 ["p", "<repository-owner>"],
54 ["p", "<other-user>"], // optionally send the patch to another user to bring it to their attention
55
56 ["t", "root"], // ommited for additional patches in a series
57 // for the first patch in a revision
58 ["t", "root-revision"],
59
60 // optional tags for when it is desirable that the merged patch has a stable commit id
61 // these fields are necessary for ensuring that the commit resulting from applying a patch
62 // has the same id as it had in the proposer's machine -- all these tags can be omitted
63 // if the maintainer doesn't care about these things
64 ["commit", "<current-commit-id>"],
65 ["r", "<current-commit-id>"] // so clients can find existing patches for a specific commit
66 ["parent-commit", "<parent-commit-id>"],
67 ["commit-pgp-sig", "-----BEGIN PGP SIGNATURE-----..."], // empty string for unsigned commit
68 ["committer", "<name>", "<email>", "<timestamp>", "<timezone offset in minutes>"],
69 ]
70}
71```
72
73The first patch in a series MAY be a cover letter in the format produced by `git format-patch`.
74
75## Issues
76
77Issues are Markdown text that is just human-readable conversational threads related to the repository: bug reports, feature requests, questions or comments of any kind. Like patches, these SHOULD be sent to the relays specified in that repository's announcement event's `"relays"` tag.
78
79```jsonc
80{
81 "kind": 1621,
82 "content": "<markdown text>",
83 "tags": [
84 ["a", "30617:<base-repo-owner-pubkey>:<base-repo-id>"],
85 ["p", "<repository-owner>"]
86 ]
87}
88```
89
90## Replies
91
92Replies are also Markdown text. The difference is that they MUST be issued as replies to either a `kind:1621` _issue_ or a `kind:1617` _patch_ event. The threading of replies and patches should follow NIP-10 rules.
93
94```jsonc
95{
96 "kind": 1622,
97 "content": "<markdown text>",
98 "tags": [
99 ["a", "30617:<base-repo-owner-pubkey>:<base-repo-id>", "<relay-url>"],
100 ["e", "<issue-or-patch-id-hex>", "", "root"],
101
102 // other "e" and "p" tags should be applied here when necessary, following the threading rules of NIP-10
103 ["p", "<patch-author-pubkey-hex>", "", "mention"],
104 ["e", "<previous-reply-id-hex>", "", "reply"],
105 // ...
106 ]
107}
108```
109
110## Status
111
112Root Patches and Issues have a Status that defaults to 'Open' and can be set by issuing Status events.
113
114```jsonc
115{
116 "kind": 1630, // Open
117 "kind": 1631, // Applied / Merged for Patches; Resolved for Issues
118 "kind": 1632, // Closed
119 "kind": 1633, // Draft
120 "content": "<markdown text>",
121 "tags": [
122 ["e", "<issue-or-original-root-patch-id-hex>", "", "root"],
123 ["e", "<accepted-revision-root-id-hex>", "", "reply"], // for when revisions applied
124 ["p", "<repository-owner>"],
125 ["p", "<root-event-author>"],
126 ["p", "<revision-author>"],
127
128 // optional for improved subscription filter efficiency
129 ["a", "30617:<base-repo-owner-pubkey>:<base-repo-id>", "<relay-url>"],
130 ["r", "<earliest-unique-commit-id-of-repo>"]
131
132 // optional for `1631` status
133 ["e", "<applied-or-merged-patch-event-id>", "", "mention"], // for each
134 // when merged
135 ["merge-commit", "<merge-commit-id>"]
136 ["r", "<merge-commit-id>"]
137 // when applied
138 ["applied-as-commits", "<commit-id-in-master-branch>", ...]
139 ["r", "<applied-commit-id>"] // for each
140 ]
141}
142```
143
144The Status event with the largest created_at date is valid.
145
146The Status of a patch-revision defaults to either that of the root-patch, or `1632` (Closed) if the root-patch's Status is `1631` and the patch-revision isn't tagged in the `1631` event.
147
148
149## Possible things to be added later
150
151- "branch merge" kind (specifying a URL from where to fetch the branch to be merged)
152- inline file comments kind (we probably need one for patches and a different one for merged files)
diff --git a/44.md b/44.md
new file mode 100644
index 0000000..f3071ea
--- /dev/null
+++ b/44.md
@@ -0,0 +1,295 @@
1NIP-44
2=====
3
4Encrypted Payloads (Versioned)
5------------------------------
6
7`optional`
8
9The NIP introduces a new data format for keypair-based encryption. This NIP is versioned
10to allow multiple algorithm choices to exist simultaneously. This format may be used for
11many things, but MUST be used in the context of a signed event as described in NIP 01.
12
13*Note*: this format DOES NOT define any `kind`s related to a new direct messaging standard,
14only the encryption required to define one. It SHOULD NOT be used as a drop-in replacement
15for NIP 04 payloads.
16
17## Versions
18
19Currently defined encryption algorithms:
20
21- `0x00` - Reserved
22- `0x01` - Deprecated and undefined
23- `0x02` - secp256k1 ECDH, HKDF, padding, ChaCha20, HMAC-SHA256, base64
24
25## Limitations
26
27Every nostr user has their own public key, which solves key distribution problems present
28in other solutions. However, nostr's relay-based architecture makes it difficult to implement
29more robust private messaging protocols with things like metadata hiding, forward secrecy,
30and post compromise secrecy.
31
32The goal of this NIP is to have a _simple_ way to encrypt payloads used in the context of a signed
33event. When applying this NIP to any use case, it's important to keep in mind your users' threat
34model and this NIP's limitations. For high-risk situations, users should chat in specialized E2EE
35messaging software and limit use of nostr to exchanging contacts.
36
37On its own, messages sent using this scheme have a number of important shortcomings:
38
39- No deniability: it is possible to prove an event was signed by a particular key
40- No forward secrecy: when a key is compromised, it is possible to decrypt all previous conversations
41- No post-compromise security: when a key is compromised, it is possible to decrypt all future conversations
42- No post-quantum security: a powerful quantum computer would be able to decrypt the messages
43- IP address leak: user IP may be seen by relays and all intermediaries between user and relay
44- Date leak: `created_at` is public, since it is a part of NIP 01 event
45- Limited message size leak: padding only partially obscures true message length
46- No attachments: they are not supported
47
48Lack of forward secrecy may be partially mitigated by only sending messages to trusted relays, and asking
49relays to delete stored messages after a certain duration has elapsed.
50
51## Version 2
52
53NIP-44 version 2 has the following design characteristics:
54
55- Payloads are authenticated using a MAC before signing rather than afterwards because events are assumed
56 to be signed as specified in NIP-01. The outer signature serves to authenticate the full payload, and MUST
57 be validated before decrypting.
58- ChaCha is used instead of AES because it's faster and has
59 [better security against multi-key attacks](https://datatracker.ietf.org/doc/draft-irtf-cfrg-aead-limits/).
60- ChaCha is used instead of XChaCha because XChaCha has not been standardized. Also, xChaCha's improved collision
61 resistance of nonces isn't necessary since every message has a new (key, nonce) pair.
62- HMAC-SHA256 is used instead of Poly1305 because polynomial MACs are much easier to forge.
63- SHA256 is used instead of SHA3 or BLAKE because it is already used in nostr. Also BLAKE's speed advantage
64 is smaller in non-parallel environments.
65- A custom padding scheme is used instead of padmé because it provides better leakage reduction for small messages.
66- Base64 encoding is used instead of another compression algorithm because it is widely available, and is already used in nostr.
67
68### Encryption
69
701. Calculate a conversation key
71 - Execute ECDH (scalar multiplication) of public key B by private key A
72 Output `shared_x` must be unhashed, 32-byte encoded x coordinate of the shared point
73 - Use HKDF-extract with sha256, `IKM=shared_x` and `salt=utf8_encode('nip44-v2')`
74 - HKDF output will be a `conversation_key` between two users.
75 - It is always the same, when key roles are swapped: `conv(a, B) == conv(b, A)`
762. Generate a random 32-byte nonce
77 - Always use [CSPRNG](https://en.wikipedia.org/wiki/Cryptographically_secure_pseudorandom_number_generator)
78 - Don't generate a nonce from message content
79 - Don't re-use the same nonce between messages: doing so would make them decryptable,
80 but won't leak the long-term key
813. Calculate message keys
82 - The keys are generated from `conversation_key` and `nonce`. Validate that both are 32 bytes long
83 - Use HKDF-expand, with sha256, `PRK=conversation_key`, `info=nonce` and `L=76`
84 - Slice 76-byte HKDF output into: `chacha_key` (bytes 0..32), `chacha_nonce` (bytes 32..44), `hmac_key` (bytes 44..76)
854. Add padding
86 - Content must be encoded from UTF-8 into byte array
87 - Validate plaintext length. Minimum is 1 byte, maximum is 65535 bytes
88 - Padding format is: `[plaintext_length: u16][plaintext][zero_bytes]`
89 - Padding algorithm is related to powers-of-two, with min padded msg size of 32
90 - Plaintext length is encoded in big-endian as first 2 bytes of the padded blob
915. Encrypt padded content
92 - Use ChaCha20, with key and nonce from step 3
936. Calculate MAC (message authentication code)
94 - AAD (additional authenticated data) is used - instead of calculating MAC on ciphertext,
95 it's calculated over a concatenation of `nonce` and `ciphertext`
96 - Validate that AAD (nonce) is 32 bytes
977. Base64-encode (with padding) params using `concat(version, nonce, ciphertext, mac)`
98
99Encrypted payloads MUST be included in an event's payload, hashed, and signed as defined in NIP 01, using schnorr
100signature scheme over secp256k1.
101
102### Decryption
103
104Before decryption, the event's pubkey and signature MUST be validated as defined in NIP 01. The public key MUST be
105a valid non-zero secp256k1 curve point, and the signature must be valid secp256k1 schnorr signature. For exact
106validation rules, refer to BIP-340.
107
1081. Check if first payload's character is `#`
109 - `#` is an optional future-proof flag that means non-base64 encoding is used
110 - The `#` is not present in base64 alphabet, but, instead of throwing `base64 is invalid`,
111 implementations MUST indicate that the encryption version is not yet supported
1122. Decode base64
113 - Base64 is decoded into `version, nonce, ciphertext, mac`
114 - If the version is unknown, implementations must indicate that the encryption version is not supported
115 - Validate length of base64 message to prevent DoS on base64 decoder: it can be in range from 132 to 87472 chars
116 - Validate length of decoded message to verify output of the decoder: it can be in range from 99 to 65603 bytes
1173. Calculate conversation key
118 - See step 1 of [encryption](#Encryption)
1194. Calculate message keys
120 - See step 3 of [encryption](#Encryption)
1215. Calculate MAC (message authentication code) with AAD and compare
122 - Stop and throw an error if MAC doesn't match the decoded one from step 2
123 - Use constant-time comparison algorithm
1246. Decrypt ciphertext
125 - Use ChaCha20 with key and nonce from step 3
1267. Remove padding
127 - Read the first two BE bytes of plaintext that correspond to plaintext length
128 - Verify that the length of sliced plaintext matches the value of the two BE bytes
129 - Verify that calculated padding from step 3 of the [encryption](#Encryption) process matches the actual padding
130
131### Details
132
133- Cryptographic methods
134 - `secure_random_bytes(length)` fetches randomness from CSPRNG.
135 - `hkdf(IKM, salt, info, L)` represents HKDF [(RFC 5869)](https://datatracker.ietf.org/doc/html/rfc5869)
136 with SHA256 hash function comprised of methods `hkdf_extract(IKM, salt)` and `hkdf_expand(OKM, info, L)`.
137 - `chacha20(key, nonce, data)` is ChaCha20 [(RFC 8439)](https://datatracker.ietf.org/doc/html/rfc8439) with
138 starting counter set to 0.
139 - `hmac_sha256(key, message)` is HMAC [(RFC 2104)](https://datatracker.ietf.org/doc/html/rfc2104).
140 - `secp256k1_ecdh(priv_a, pub_b)` is multiplication of point B by scalar a (`a ⋅ B`), defined in
141 [BIP340](https://github.com/bitcoin/bips/blob/e918b50731397872ad2922a1b08a5a4cd1d6d546/bip-0340.mediawiki).
142 The operation produces a shared point, and we encode the shared point's 32-byte x coordinate, using method
143 `bytes(P)` from BIP340. Private and public keys must be validated as per BIP340: pubkey must be a valid,
144 on-curve point, and private key must be a scalar in range `[1, secp256k1_order - 1]`.
145- Operators
146 - `x[i:j]`, where `x` is a byte array and `i, j <= 0` returns a `(j - i)`-byte array with a copy of the
147 `i`-th byte (inclusive) to the `j`-th byte (exclusive) of `x`.
148- Constants `c`:
149 - `min_plaintext_size` is 1. 1b msg is padded to 32b.
150 - `max_plaintext_size` is 65535 (64kb - 1). It is padded to 65536.
151- Functions
152 - `base64_encode(string)` and `base64_decode(bytes)` are Base64 ([RFC 4648](https://datatracker.ietf.org/doc/html/rfc4648), with padding)
153 - `concat` refers to byte array concatenation
154 - `is_equal_ct(a, b)` is constant-time equality check of 2 byte arrays
155 - `utf8_encode(string)` and `utf8_decode(bytes)` transform string to byte array and back
156 - `write_u8(number)` restricts number to values 0..255 and encodes into Big-Endian uint8 byte array
157 - `write_u16_be(number)` restricts number to values 0..65535 and encodes into Big-Endian uint16 byte array
158 - `zeros(length)` creates byte array of length `length >= 0`, filled with zeros
159 - `floor(number)` and `log2(number)` are well-known mathematical methods
160
161### Implementation pseudocode
162
163The following is a collection of python-like pseudocode functions which implement the above primitives,
164intended to guide implementers. A collection of implementations in different languages is available at https://github.com/paulmillr/nip44.
165
166```py
167# Calculates length of the padded byte array.
168def calc_padded_len(unpadded_len):
169 next_power = 1 << (floor(log2(unpadded_len - 1))) + 1
170 if next_power <= 256:
171 chunk = 32
172 else:
173 chunk = next_power / 8
174 if unpadded_len <= 32:
175 return 32
176 else:
177 return chunk * (floor((len - 1) / chunk) + 1)
178
179# Converts unpadded plaintext to padded bytearray
180def pad(plaintext):
181 unpadded = utf8_encode(plaintext)
182 unpadded_len = len(plaintext)
183 if (unpadded_len < c.min_plaintext_size or
184 unpadded_len > c.max_plaintext_size): raise Exception('invalid plaintext length')
185 prefix = write_u16_be(unpadded_len)
186 suffix = zeros(calc_padded_len(unpadded_len) - unpadded_len)
187 return concat(prefix, unpadded, suffix)
188
189# Converts padded bytearray to unpadded plaintext
190def unpad(padded):
191 unpadded_len = read_uint16_be(padded[0:2])
192 unpadded = padded[2:2+unpadded_len]
193 if (unpadded_len == 0 or
194 len(unpadded) != unpadded_len or
195 len(padded) != 2 + calc_padded_len(unpadded_len)): raise Exception('invalid padding')
196 return utf8_decode(unpadded)
197
198# metadata: always 65b (version: 1b, nonce: 32b, max: 32b)
199# plaintext: 1b to 0xffff
200# padded plaintext: 32b to 0xffff
201# ciphertext: 32b+2 to 0xffff+2
202# raw payload: 99 (65+32+2) to 65603 (65+0xffff+2)
203# compressed payload (base64): 132b to 87472b
204def decode_payload(payload):
205 plen = len(payload)
206 if plen == 0 or payload[0] == '#': raise Exception('unknown version')
207 if plen < 132 or plen > 87472: raise Exception('invalid payload size')
208 data = base64_decode(payload)
209 dlen = len(d)
210 if dlen < 99 or dlen > 65603: raise Exception('invalid data size');
211 vers = data[0]
212 if vers != 2: raise Exception('unknown version ' + vers)
213 nonce = data[1:33]
214 ciphertext = data[33:dlen - 32]
215 mac = data[dlen - 32:dlen]
216 return (nonce, ciphertext, mac)
217
218def hmac_aad(key, message, aad):
219 if len(aad) != 32: raise Exception('AAD associated data must be 32 bytes');
220 return hmac(sha256, key, concat(aad, message));
221
222# Calculates long-term key between users A and B: `get_key(Apriv, Bpub) == get_key(Bpriv, Apub)`
223def get_conversation_key(private_key_a, public_key_b):
224 shared_x = secp256k1_ecdh(private_key_a, public_key_b)
225 return hkdf_extract(IKM=shared_x, salt=utf8_encode('nip44-v2'))
226
227# Calculates unique per-message key
228def get_message_keys(conversation_key, nonce):
229 if len(conversation_key) != 32: raise Exception('invalid conversation_key length')
230 if len(nonce) != 32: raise Exception('invalid nonce length')
231 keys = hkdf_expand(OKM=conversation_key, info=nonce, L=76)
232 chacha_key = keys[0:32]
233 chacha_nonce = keys[32:44]
234 hmac_key = keys[44:76]
235 return (chacha_key, chacha_nonce, hmac_key)
236
237def encrypt(plaintext, conversation_key, nonce):
238 (chacha_key, chacha_nonce, hmac_key) = get_message_keys(conversation_key, nonce)
239 padded = pad(plaintext)
240 ciphertext = chacha20(key=chacha_key, nonce=chacha_nonce, data=padded)
241 mac = hmac_aad(key=hmac_key, message=ciphertext, aad=nonce)
242 return base64_encode(concat(write_u8(2), nonce, ciphertext, mac))
243
244def decrypt(payload, conversation_key):
245 (nonce, ciphertext, mac) = decode_payload(payload)
246 (chacha_key, chacha_nonce, hmac_key) = get_message_keys(conversation_key, nonce)
247 calculated_mac = hmac_aad(key=hmac_key, message=ciphertext, aad=nonce)
248 if not is_equal_ct(calculated_mac, mac): raise Exception('invalid MAC')
249 padded_plaintext = chacha20(key=chacha_key, nonce=chacha_nonce, data=ciphertext)
250 return unpad(padded_plaintext)
251
252# Usage:
253# conversation_key = get_conversation_key(sender_privkey, recipient_pubkey)
254# nonce = secure_random_bytes(32)
255# payload = encrypt('hello world', conversation_key, nonce)
256# 'hello world' == decrypt(payload, conversation_key)
257```
258
259### Audit
260
261The v2 of the standard was audited by [Cure53](https://cure53.de) in December 2023.
262Check out [audit-2023.12.pdf](https://github.com/paulmillr/nip44/blob/ce63c2eaf345e9f7f93b48f829e6bdeb7e7d7964/audit-2023.12.pdf)
263and [auditor's website](https://cure53.de/audit-report_nip44-implementations.pdf).
264
265### Tests and code
266
267A collection of implementations in different languages is available at https://github.com/paulmillr/nip44.
268
269We publish extensive test vectors. Instead of having it in the document directly, a sha256 checksum of vectors is provided:
270
271 269ed0f69e4c192512cc779e78c555090cebc7c785b609e338a62afc3ce25040 nip44.vectors.json
272
273Example of a test vector from the file:
274
275```json
276{
277 "sec1": "0000000000000000000000000000000000000000000000000000000000000001",
278 "sec2": "0000000000000000000000000000000000000000000000000000000000000002",
279 "conversation_key": "c41c775356fd92eadc63ff5a0dc1da211b268cbea22316767095b2871ea1412d",
280 "nonce": "0000000000000000000000000000000000000000000000000000000000000001",
281 "plaintext": "a",
282 "payload": "AgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABee0G5VSK0/9YypIObAtDKfYEAjD35uVkHyB0F4DwrcNaCXlCWZKaArsGrY6M9wnuTMxWfp1RTN9Xga8no+kF5Vsb"
283}
284```
285
286The file also contains intermediate values. A quick guidance with regards to its usage:
287
288- `valid.get_conversation_key`: calculate conversation_key from secret key sec1 and public key pub2
289- `valid.get_message_keys`: calculate chacha_key, chacha_nonce, hmac_key from conversation_key and nonce
290- `valid.calc_padded_len`: take unpadded length (first value), calculate padded length (second value)
291- `valid.encrypt_decrypt`: emulate real conversation. Calculate pub2 from sec2, verify conversation_key from (sec1, pub2), encrypt, verify payload, then calculate pub1 from sec1, verify conversation_key from (sec2, pub1), decrypt, verify plaintext.
292- `valid.encrypt_decrypt_long_msg`: same as previous step, but instead of a full plaintext and payload, their checksum is provided.
293- `invalid.encrypt_msg_lengths`
294- `invalid.get_conversation_key`: calculating conversation_key must throw an error
295- `invalid.decrypt`: decrypting message content must throw an error
diff --git a/46.md b/46.md
index 5318541..1528116 100644
--- a/46.md
+++ b/46.md
@@ -1,162 +1,227 @@
1NIP-46 1# NIP-46 - Nostr Remote Signing
2======
3
4Nostr Connect
5------------------------
6
7`draft` `optional`
8 2
9## Rationale 3## Rationale
10 4
11Private keys should be exposed to as few systems - apps, operating systems, devices - as possible as each system adds to the attack surface. 5Private keys should be exposed to as few systems - apps, operating systems, devices - as possible as each system adds to the attack surface.
12 6
13Entering private keys can also be annoying and requires exposing them to even more systems such as the operating system's clipboard that might be monitored by malicious apps. 7This NIP describes a method for 2-way communication between a remote signer and a Nostr client. The remote signer could be, for example, a hardware device dedicated to signing Nostr events, while the client is a normal Nostr client.
8
9## Terminology
10
11- **Local keypair**: A local public and private key-pair used to encrypt content and communicate with the remote signer. Usually created by the client application.
12- **Remote user pubkey**: The public key that the user wants to sign as. The remote signer has control of the private key that matches this public key.
13- **Remote signer pubkey**: This is the public key of the remote signer itself. This is needed in both `create_account` command because you don't yet have a remote user pubkey.
14
15All pubkeys specified in this NIP are in hex format.
14 16
17## Initiating a connection
15 18
16## Terms 19To initiate a connection between a client and a remote signer there are a few different options.
17 20
18* **App**: Nostr app on any platform that *requires* to act on behalf of a nostr account. 21### Direct connection initiated by remote signer
19* **Signer**: Nostr app that holds the private key of a nostr account and *can sign* on its behalf. 22
23This is most common in a situation where you have your own nsecbunker or other type of remote signer and want to connect through a client that supports remote signing.
24
25The remote signer would provide a connection token in the form:
26
27```
28bunker://<remote-user-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value>
29```
20 30
31This token is pasted into the client by the user and the client then uses the details to connect to the remote signer via the specified relay(s).
21 32
22## `TL;DR` 33### Direct connection initiated by the client
23 34
35In this case, basically the opposite direction of the first case, the client provides a connection token (or encodes the token in a QR code) and the signer initiates a connection to the client via the specified relay(s).
24 36
25**App** and **Signer** sends ephemeral encrypted messages to each other using kind `24133`, using a relay of choice. 37```
38nostrconnect://<local-keypair-pubkey>?relay=<wss://relay-to-connect-on>&metadata=<json metadata in the form: {"name":"...", "url": "...", "description": "..."}>
39```
26 40
27App prompts the Signer to do things such as fetching the public key or signing events. 41## The flow
28 42
29The `content` field must be an encrypted JSONRPC-ish **request** or **response**. 431. Client creates a local keypair. This keypair doesn't need to be communicated to the user since it's largely disposable (i.e. the user doesn't need to see this pubkey). Clients might choose to store it locally and they should delete it when the user logs out.
442. Client gets the remote user pubkey (either via a `bunker://` connection string or a NIP-05 login-flow; shown below)
453. Clients use the local keypair to send requests to the remote signer by `p`-tagging and encrypting to the remote user pubkey.
464. The remote signer responds to the client by `p`-tagging and encrypting to the local keypair pubkey.
30 47
31## Signer Protocol 48### Example flow for signing an event
32 49
33### Messages 50- Remote user pubkey (e.g. signing as) `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52`
51- Local pubkey is `eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86`
34 52
35#### Request 53#### Signature request
36 54
37```json 55```json
38{ 56{
39 "id": <random_string>, 57 "kind": 24133,
40 "method": <one_of_the_methods>, 58 "pubkey": "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86",
41 "params": [<anything>, <else>] 59 "content": nip04({
60 "id": <random_string>,
61 "method": "sign_event",
62 "params": [json_stringified(<{
63 content: "Hello, I'm signing remotely",
64 kind: 1,
65 tags: [],
66 created_at: 1714078911
67 }>)]
68 }),
69 "tags": [["p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"]], // p-tags the remote user pubkey
42} 70}
43``` 71```
44 72
45#### Response 73#### Response event
46 74
47```json 75```json
48{ 76{
49 "id": <request_id>, 77 "kind": 24133,
50 "result": <anything>, 78 "pubkey": "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52",
51 "error": <reason> 79 "content": nip04({
80 "id": <random_string>,
81 "result": json_stringified(<signed-event>)
82 }),
83 "tags": [["p", "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86"]], // p-tags the local keypair pubkey
52} 84}
53``` 85```
54 86
55### Methods 87#### Diagram
56
57 88
58#### Mandatory 89![signing-example](https://i.nostr.build/P3gW.png)
59 90
60These are mandatory methods the remote signer app MUST implement: 91## Request Events `kind: 24133`
61 92
62- **describe** 93```json
63 - params [] 94{
64 - result `["describe", "get_public_key", "sign_event", "connect", "disconnect", "delegate", ...]` 95 "id": <id>,
65- **get_public_key** 96 "kind": 24133,
66 - params [] 97 "pubkey": <local_keypair_pubkey>,
67 - result `pubkey` 98 "content": <nip04(<request>)>,
68- **sign_event** 99 "tags": [["p", <remote_user_pubkey>]], // NB: in the `create_account` event, the remote signer pubkey should be `p` tagged.
69 - params [`event`] 100 "created_at": <unix timestamp in seconds>
70 - result `event_with_signature` 101}
102```
71 103
72#### optional 104The `content` field is a JSON-RPC-like message that is [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md) encrypted and has the following structure:
73 105
106```json
107{
108 "id": <random_string>,
109 "method": <method_name>,
110 "params": [array_of_strings]
111}
112```
74 113
75- **connect** 114- `id` is a random string that is a request ID. This same ID will be sent back in the response payload.
76 - params [`pubkey`] 115- `method` is the name of the method/command (detailed below).
77- **disconnect** 116- `params` is a positional array of string parameters.
78 - params []
79- **delegate**
80 - params [`delegatee`, `{ kind: number, since: number, until: number }`]
81 - result `{ from: string, to: string, cond: string, sig: string }`
82- **get_relays**
83 - params []
84 - result `{ [url: string]: {read: boolean, write: boolean} }`
85- **nip04_encrypt**
86 - params [`pubkey`, `plaintext`]
87 - result `nip4 ciphertext`
88- **nip04_decrypt**
89 - params [`pubkey`, `nip4 ciphertext`]
90 - result [`plaintext`]
91 117
118### Methods/Commands
92 119
93NOTICE: `pubkey` and `signature` are hex-encoded strings. 120Each of the following are methods that the client sends to the remote signer.
94 121
122| Command | Params | Result |
123| ------------------------ | ------------------------------------------------- | ---------------------------------------------------------------------- |
124| `connect` | `[<remote_user_pubkey>, <optional_secret>, <optional_requested_permissions>]` | "ack" |
125| `sign_event` | `[<{kind, content, tags, created_at}>]` | `json_stringified(<signed_event>)` |
126| `ping` | `[]` | "pong" |
127| `get_relays` | `[]` | `json_stringified({<relay_url>: {read: <boolean>, write: <boolean>}})` |
128| `get_public_key` | `[]` | `<hex-pubkey>` |
129| `nip04_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip04_ciphertext>` |
130| `nip04_decrypt` | `[<third_party_pubkey>, <nip04_ciphertext_to_decrypt>]` | `<plaintext>` |
131| `nip44_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip44_ciphertext>` |
132| `nip44_decrypt` | `[<third_party_pubkey>, <nip44_ciphertext_to_decrypt>]` | `<plaintext>` |
95 133
96### Nostr Connect URI 134### Requested permissions
97 135
98**Signer** discovers **App** by scanning a QR code, clicking on a deep link or copy-pasting an URI. 136The `connect` method may be provided with `optional_requested_permissions` for user convenience. The permissions are a comma-separated list of `method[:params]`, i.e. `nip04_encrypt,sign_event:4` meaning permissions to call `nip04_encrypt` and to call `sign_event` with `kind:4`. Optional parameter for `sign_event` is the kind number, parameters for other methods are to be defined later.
99 137
100The **App** generates a special URI with prefix `nostrconnect://` and base path the hex-encoded `pubkey` with the following querystring parameters **URL encoded** 138## Response Events `kind:24133`
101 139
102- `relay` URL of the relay of choice where the **App** is connected and the **Signer** must send and listen for messages. 140```json
103- `metadata` metadata JSON of the **App** 141{
104 - `name` human-readable name of the **App** 142 "id": <id>,
105 - `url` (optional) URL of the website requesting the connection 143 "kind": 24133,
106 - `description` (optional) description of the **App** 144 "pubkey": <remote_signer_pubkey>,
107 - `icons` (optional) array of URLs for icons of the **App**. 145 "content": <nip04(<response>)>,
146 "tags": [["p", <local_keypair_pubkey>]],
147 "created_at": <unix timestamp in seconds>
148}
149```
108 150
109#### JavaScript 151The `content` field is a JSON-RPC-like message that is [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md) encrypted and has the following structure:
110 152
111```js 153```json
112const uri = `nostrconnect://<pubkey>?relay=${encodeURIComponent("wss://relay.damus.io")}&metadata=${encodeURIComponent(JSON.stringify({"name": "Example"}))}` 154{
155 "id": <request_id>,
156 "result": <results_string>,
157 "error": <optional_error_string>
158}
113``` 159```
114 160
115#### Example 161- `id` is the request ID that this response is for.
116```sh 162- `results` is a string of the result of the call (this can be either a string or a JSON stringified object)
117nostrconnect://b889ff5b1513b641e2a139f661a661364979c5beee91842f8f0ef42ab558e9d4?relay=wss%3A%2F%2Frelay.damus.io&metadata=%7B%22name%22%3A%22Example%22%7D 163- `error`, _optionally_, it is an error in string form, if any. Its presence indicates an error with the request.
164
165### Auth Challenges
166
167An Auth Challenge is a response that a remote signer can send back when it needs the user to authenticate via other means. This is currently used in the OAuth-like flow enabled by signers like [Nsecbunker](https://github.com/kind-0/nsecbunkerd/). The response `content` object will take the following form:
168
169```json
170{
171 "id": <request_id>,
172 "result": "auth_url",
173 "error": <URL_to_display_to_end_user>
174}
118``` 175```
119 176
177Clients should display (in a popup or new tab) the URL from the `error` field and then subscribe/listen for another response from the remote signer (reusing the same request ID). This event will be sent once the user authenticates in the other window (or will never arrive if the user doesn't authenticate). It's also possible to add a `redirect_uri` url parameter to the auth_url, which is helpful in situations when a client cannot open a new window or tab to display the auth challenge.
178
179#### Example event signing request with auth challenge
180
181![signing-example-with-auth-challenge](https://i.nostr.build/W3aj.png)
182
183## Remote Signer Commands
184
185Remote signers might support additional commands when communicating directly with it. These commands follow the same flow as noted above, the only difference is that when the client sends a request event, the `p`-tag is the pubkey of the remote signer itself and the `content` payload is encrypted to the same remote signer pubkey.
186
187### Methods/Commands
120 188
189Each of the following are methods that the client sends to the remote signer.
121 190
122## Flows 191| Command | Params | Result |
192| ---------------- | ------------------------------------------ | ------------------------------------ |
193| `create_account` | `[<username>, <domain>, <optional_email>, <optional_requested_permissions>]` | `<newly_created_remote_user_pubkey>` |
123 194
124The `content` field contains encrypted message as specified by [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md). The `kind` chosen is `24133`. 195## Appendix
125 196
126### Connect 197### NIP-05 Login Flow
127 198
1281. User clicks on **"Connect"** button on a website or scan it with a QR code 199Clients might choose to present a more familiar login flow, so users can type a NIP-05 address instead of a `bunker://` string.
1292. It will show an URI to open a "nostr connect" enabled **Signer**
1303. In the URI there is a pubkey of the **App** ie. `nostrconnect://<pubkey>&relay=<relay>&metadata=<metadata>`
1314. The **Signer** will send a message to ACK the `connect` request, along with his public key
132 200
133### Disconnect (from App) 201When the user types a NIP-05 the client:
134 202
1351. User clicks on **"Disconnect"** button on the **App** 203- Queries the `/.well-known/nostr.json` file from the domain for the NIP-05 address provided to get the user's pubkey (this is the **remote user pubkey**)
1362. The **App** will send a message to the **Signer** with a `disconnect` request 204- In the same `/.well-known/nostr.json` file, queries for the `nip46` key to get the relays that the remote signer will be listening on.
1373. The **Signer** will send a message to ACK the `disconnect` request 205- Now the client has enough information to send commands to the remote signer on behalf of the user.
138 206
139### Disconnect (from Signer) 207### OAuth-like Flow
140 208
1411. User clicks on **"Disconnect"** button on the **Signer** 209#### Remote signer discovery via NIP-89
1422. The **Signer** will send a message to the **App** with a `disconnect` request
143 210
211In this last case, most often used to facilitate an OAuth-like signin flow, the client first looks for remote signers that have announced themselves via NIP-89 application handler events.
144 212
145### Get Public Key 213First the client will query for `kind: 31990` events that have a `k` tag of `24133`.
146 214
1471. The **App** will send a message to the **Signer** with a `get_public_key` request 215These are generally shown to a user, and once the user selects which remote signer to use and provides the remote user pubkey they want to use (via npub, pubkey, or nip-05 value), the client can initiate a connection. Note that it's on the user to select the remote signer that is actually managing the remote key that they would like to use in this case. If the remote user pubkey is managed on another remote signer, the connection will fail.
1483. The **Signer** will send back a message with the public key as a response to the `get_public_key` request
149 216
150### Sign Event 217In addition, it's important that clients validate that the pubkey of the announced remote signer matches the pubkey of the `_` entry in the `/.well-known/nostr.json` file of the remote signer's announced domain.
151 218
1521. The **App** will send a message to the **Signer** with a `sign_event` request along with the **event** to be signed 219Clients that allow users to create new accounts should also consider validating the availability of a given username in the namespace of remote signer's domain by checking the `/.well-known/nostr.json` file for existing usernames. Clients can then show users feedback in the UI before sending a `create_account` event to the remote signer and receiving an error in return. Ideally, remote signers would also respond with understandable error messages if a client tries to create an account with an existing username.
1532. The **Signer** will show a popup to the user to inspect the event and sign it
1543. The **Signer** will send back a message with the event including the `id` and the schnorr `signature` as a response to the `sign_event` request
155 220
156### Delegate 221#### Example Oauth-like flow to create a new user account with Nsecbunker
157 222
1581. The **App** will send a message with metadata to the **Signer** with a `delegate` request along with the **conditions** query string and the **pubkey** of the **App** to be delegated. 223Coming soon...
1592. The **Signer** will show a popup to the user to delegate the **App** to sign on his behalf
1603. The **Signer** will send back a message with the signed [NIP-26 delegation token](https://github.com/nostr-protocol/nips/blob/master/26.md) or reject it
161 224
225## References
162 226
227- [NIP-04 - Encryption](https://github.com/nostr-protocol/nips/blob/master/04.md)
diff --git a/47.md b/47.md
index c6540d5..983d2c9 100644
--- a/47.md
+++ b/47.md
@@ -17,7 +17,7 @@ This NIP describes a way for clients to access a remote Lightning wallet through
17* **wallet service**: Nostr app that typically runs on an always-on computer (eg. in the cloud or on a Raspberry Pi). This app has access to the APIs of the wallets it serves. 17* **wallet service**: Nostr app that typically runs on an always-on computer (eg. in the cloud or on a Raspberry Pi). This app has access to the APIs of the wallets it serves.
18 18
19## Theory of Operation 19## Theory of Operation
20 1. **Users** who which to use this NIP to send lightning payments to other nostr users must first acquire a special "connection" URI from their NIP-47 compliant wallet application. The wallet application may provide this URI using a QR screen, or a pasteable string, or some other means. 20 1. **Users** who wish to use this NIP to send lightning payments to other nostr users must first acquire a special "connection" URI from their NIP-47 compliant wallet application. The wallet application may provide this URI using a QR screen, or a pasteable string, or some other means.
21 21
22 2. The **user** should then copy this URI into their **client(s)** by pasting, or scanning the QR, etc. The **client(s)** should save this URI and use it later whenever the **user** makes a payment. The **client** should then request an `info` (13194) event from the relay(s) specified in the URI. The **wallet service** will have sent that event to those relays earlier, and the relays will hold it as a replaceable event. 22 2. The **user** should then copy this URI into their **client(s)** by pasting, or scanning the QR, etc. The **client(s)** should save this URI and use it later whenever the **user** makes a payment. The **client** should then request an `info` (13194) event from the relay(s) specified in the URI. The **wallet service** will have sent that event to those relays earlier, and the relays will hold it as a replaceable event.
23 23
@@ -36,6 +36,7 @@ The info event should be a replaceable event that is published by the **wallet s
36a plaintext string with the supported commands, space-separated, eg. `pay_invoice get_balance`. Only the `pay_invoice` command is described in this NIP, but other commands might be defined in different NIPs. 36a plaintext string with the supported commands, space-separated, eg. `pay_invoice get_balance`. Only the `pay_invoice` command is described in this NIP, but other commands might be defined in different NIPs.
37 37
38Both the request and response events SHOULD contain one `p` tag, containing the public key of the **wallet service** if this is a request, and the public key of the **user** if this is a response. The response event SHOULD contain an `e` tag with the id of the request event it is responding to. 38Both the request and response events SHOULD contain one `p` tag, containing the public key of the **wallet service** if this is a request, and the public key of the **user** if this is a response. The response event SHOULD contain an `e` tag with the id of the request event it is responding to.
39Optionally, a request can have an `expiration` tag that has a unix timestamp in seconds. If the request is received after this timestamp, it should be ignored.
39 40
40The content of requests and responses is encrypted with [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md), and is a JSON-RPCish object with a semi-fixed structure: 41The content of requests and responses is encrypted with [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md), and is a JSON-RPCish object with a semi-fixed structure:
41 42
@@ -80,7 +81,7 @@ If the command was successful, the `error` field must be null.
80## Nostr Wallet Connect URI 81## Nostr Wallet Connect URI
81**client** discovers **wallet service** by scanning a QR code, handling a deeplink or pasting in a URI. 82**client** discovers **wallet service** by scanning a QR code, handling a deeplink or pasting in a URI.
82 83
83The **wallet service** generates this connection URI with protocol `nostr+walletconnect:` and base path it's hex-encoded `pubkey` with the following query string parameters: 84The **wallet service** generates this connection URI with protocol `nostr+walletconnect://` and base path it's hex-encoded `pubkey` with the following query string parameters:
84 85
85- `relay` Required. URL of the relay where the **wallet service** is connected and will be listening for events. May be more than one. 86- `relay` Required. URL of the relay where the **wallet service** is connected and will be listening for events. May be more than one.
86- `secret` Required. 32-byte randomly generated hex encoded string. The **client** MUST use this to sign events and encrypt payloads when communicating with the **wallet service**. 87- `secret` Required. 32-byte randomly generated hex encoded string. The **client** MUST use this to sign events and encrypt payloads when communicating with the **wallet service**.
@@ -94,7 +95,7 @@ The **client** should then store this connection and use it when the user wants
94 95
95### Example connection string 96### Example connection string
96```sh 97```sh
97nostr+walletconnect:b889ff5b1513b641e2a139f661a661364979c5beee91842f8f0ef42ab558e9d4?relay=wss%3A%2F%2Frelay.damus.io&secret=71a8c14c1407c113601079c4302dab36460f0ccd0ad506f1f2dc73b5100e4f3c 98nostr+walletconnect://b889ff5b1513b641e2a139f661a661364979c5beee91842f8f0ef42ab558e9d4?relay=wss%3A%2F%2Frelay.damus.io&secret=71a8c14c1407c113601079c4302dab36460f0ccd0ad506f1f2dc73b5100e4f3c
98``` 99```
99 100
100## Commands 101## Commands
@@ -108,7 +109,8 @@ Request:
108{ 109{
109 "method": "pay_invoice", 110 "method": "pay_invoice",
110 "params": { 111 "params": {
111 "invoice": "lnbc50n1..." // bolt11 invoice 112 "invoice": "lnbc50n1...", // bolt11 invoice
113 "amount": 123, // invoice amount in msats, optional
112 } 114 }
113} 115}
114``` 116```
@@ -117,7 +119,7 @@ Response:
117```jsonc 119```jsonc
118{ 120{
119 "result_type": "pay_invoice", 121 "result_type": "pay_invoice",
120 "result": { 122 "result": {
121 "preimage": "0123456789abcdef..." // preimage of the payment 123 "preimage": "0123456789abcdef..." // preimage of the payment
122 } 124 }
123} 125}
@@ -126,9 +128,281 @@ Response:
126Errors: 128Errors:
127- `PAYMENT_FAILED`: The payment failed. This may be due to a timeout, exhausting all routes, insufficient capacity or similar. 129- `PAYMENT_FAILED`: The payment failed. This may be due to a timeout, exhausting all routes, insufficient capacity or similar.
128 130
131### `multi_pay_invoice`
132
133Description: Requests payment of multiple invoices.
134
135Request:
136```jsonc
137{
138 "method": "multi_pay_invoice",
139 "params": {
140 "invoices": [
141 {"id":"4da52c32a1", "invoice": "lnbc1...", "amount": 123}, // bolt11 invoice and amount in msats, amount is optional
142 {"id":"3da52c32a1", "invoice": "lnbc50n1..."},
143 ],
144 }
145}
146```
147
148Response:
149
150For every invoice in the request, a separate response event is sent. To differentiate between the responses, each
151response event contains an `d` tag with the id of the invoice it is responding to, if no id was given, then the
152payment hash of the invoice should be used.
153
154```jsonc
155{
156 "result_type": "multi_pay_invoice",
157 "result": {
158 "preimage": "0123456789abcdef..." // preimage of the payment
159 }
160}
161```
162
163Errors:
164- `PAYMENT_FAILED`: The payment failed. This may be due to a timeout, exhausting all routes, insufficient capacity or similar.
165
166### `pay_keysend`
167
168Request:
169```jsonc
170{
171 "method": "pay_keysend",
172 "params": {
173 "amount": 123, // invoice amount in msats, required
174 "pubkey": "03...", // payee pubkey, required
175 "preimage": "0123456789abcdef...", // preimage of the payment, optional
176 "tlv_records: [ // tlv records, optional
177 {
178 "type": 5482373484, // tlv type
179 "value": "0123456789abcdef" // hex encoded tlv value
180 }
181 ]
182 }
183}
184```
185
186Response:
187```jsonc
188{
189 "result_type": "pay_keysend",
190 "result": {
191 "preimage": "0123456789abcdef...", // preimage of the payment
192 }
193}
194```
195
196Errors:
197- `PAYMENT_FAILED`: The payment failed. This may be due to a timeout, exhausting all routes, insufficient capacity or similar.
198
199### `multi_pay_keysend`
200
201Description: Requests multiple keysend payments.
202
203Has an array of keysends, these follow the same semantics as `pay_keysend`, just done in a batch
204
205Request:
206```jsonc
207{
208 "method": "multi_pay_keysend",
209 "params": {
210 "keysends": [
211 {"id": "4c5b24a351", pubkey": "03...", "amount": 123},
212 {"id": "3da52c32a1", "pubkey": "02...", "amount": 567, "preimage": "abc123..", "tlv_records": [{"type": 696969, "value": "77616c5f6872444873305242454d353736"}]},
213 ],
214 }
215}
216```
217
218Response:
219
220For every keysend in the request, a separate response event is sent. To differentiate between the responses, each
221response event contains an `d` tag with the id of the keysend it is responding to, if no id was given, then the
222pubkey should be used.
223
224```jsonc
225{
226 "result_type": "multi_pay_keysend",
227 "result": {
228 "preimage": "0123456789abcdef..." // preimage of the payment
229 }
230}
231```
232
233Errors:
234- `PAYMENT_FAILED`: The payment failed. This may be due to a timeout, exhausting all routes, insufficient capacity or similar.
235
236### `make_invoice`
237
238Request:
239```jsonc
240{
241 "method": "make_invoice",
242 "params": {
243 "amount": 123, // value in msats
244 "description": "string", // invoice's description, optional
245 "description_hash": "string", // invoice's description hash, optional
246 "expiry": 213 // expiry in seconds from time invoice is created, optional
247 }
248}
249```
250
251Response:
252```jsonc
253{
254 "result_type": "make_invoice",
255 "result": {
256 "type": "incoming", // "incoming" for invoices, "outgoing" for payments
257 "invoice": "string", // encoded invoice, optional
258 "description": "string", // invoice's description, optional
259 "description_hash": "string", // invoice's description hash, optional
260 "preimage": "string", // payment's preimage, optional if unpaid
261 "payment_hash": "string", // Payment hash for the payment
262 "amount": 123, // value in msats
263 "fees_paid": 123, // value in msats
264 "created_at": unixtimestamp, // invoice/payment creation time
265 "expires_at": unixtimestamp, // invoice expiration time, optional if not applicable
266 "metadata": {} // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc.
267 }
268}
269```
270
271### `lookup_invoice`
272
273Request:
274```jsonc
275{
276 "method": "lookup_invoice",
277 "params": {
278 "payment_hash": "31afdf1..", // payment hash of the invoice, one of payment_hash or invoice is required
279 "invoice": "lnbc50n1..." // invoice to lookup
280 }
281}
282```
283
284Response:
285```jsonc
286{
287 "result_type": "lookup_invoice",
288 "result": {
289 "type": "incoming", // "incoming" for invoices, "outgoing" for payments
290 "invoice": "string", // encoded invoice, optional
291 "description": "string", // invoice's description, optional
292 "description_hash": "string", // invoice's description hash, optional
293 "preimage": "string", // payment's preimage, optional if unpaid
294 "payment_hash": "string", // Payment hash for the payment
295 "amount": 123, // value in msats
296 "fees_paid": 123, // value in msats
297 "created_at": unixtimestamp, // invoice/payment creation time
298 "expires_at": unixtimestamp, // invoice expiration time, optional if not applicable
299 "settled_at": unixtimestamp, // invoice/payment settlement time, optional if unpaid
300 "metadata": {} // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc.
301 }
302}
303```
304
305Errors:
306- `NOT_FOUND`: The invoice could not be found by the given parameters.
307
308### `list_transactions`
309
310Lists invoices and payments. If `type` is not specified, both invoices and payments are returned.
311The `from` and `until` parameters are timestamps in seconds since epoch. If `from` is not specified, it defaults to 0.
312If `until` is not specified, it defaults to the current time. Transactions are returned in descending order of creation
313time.
314
315Request:
316```jsonc
317{
318 "method": "list_transactions",
319 "params": {
320 "from": 1693876973, // starting timestamp in seconds since epoch (inclusive), optional
321 "until": 1703225078, // ending timestamp in seconds since epoch (inclusive), optional
322 "limit": 10, // maximum number of invoices to return, optional
323 "offset": 0, // offset of the first invoice to return, optional
324 "unpaid": true, // include unpaid invoices, optional, default false
325 "type": "incoming", // "incoming" for invoices, "outgoing" for payments, undefined for both
326 }
327}
328```
329
330Response:
331```jsonc
332{
333 "result_type": "list_transactions",
334 "result": {
335 "transactions": [
336 {
337 "type": "incoming", // "incoming" for invoices, "outgoing" for payments
338 "invoice": "string", // encoded invoice, optional
339 "description": "string", // invoice's description, optional
340 "description_hash": "string", // invoice's description hash, optional
341 "preimage": "string", // payment's preimage, optional if unpaid
342 "payment_hash": "string", // Payment hash for the payment
343 "amount": 123, // value in msats
344 "fees_paid": 123, // value in msats
345 "created_at": unixtimestamp, // invoice/payment creation time
346 "expires_at": unixtimestamp, // invoice expiration time, optional if not applicable
347 "settled_at": unixtimestamp, // invoice/payment settlement time, optional if unpaid
348 "metadata": {} // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc.
349 }
350 ],
351 },
352}
353```
354
355### `get_balance`
356
357Request:
358```jsonc
359{
360 "method": "get_balance",
361 "params": {
362 }
363}
364```
365
366Response:
367```jsonc
368{
369 "result_type": "get_balance",
370 "result": {
371 "balance": 10000, // user's balance in msats
372 }
373}
374```
375
376### `get_info`
377
378Request:
379```jsonc
380{
381 "method": "get_info",
382 "params": {
383 }
384}
385```
386
387Response:
388```jsonc
389{
390 "result_type": "get_info",
391 "result": {
392 "alias": "string",
393 "color": "hex string",
394 "pubkey": "hex string",
395 "network": "string", // mainnet, testnet, signet, or regtest
396 "block_height": 1,
397 "block_hash": "hex string",
398 "methods": ["pay_invoice", "get_balance", "make_invoice", "lookup_invoice", "list_transactions", "get_info"], // list of supported methods for this connection
399 }
400}
401```
402
129## Example pay invoice flow 403## Example pay invoice flow
130 404
1310. The user scans the QR code generated by the **wallet service** with their **client** application, they follow a `nostr+walletconnect:` deeplink or configure the connection details manually. 4050. The user scans the QR code generated by the **wallet service** with their **client** application, they follow a `nostr+walletconnect://` deeplink or configure the connection details manually.
1321. **client** sends an event to the **wallet service** with kind `23194`. The content is a `pay_invoice` request. The private key is the secret from the connection string above. 4061. **client** sends an event to the **wallet service** with kind `23194`. The content is a `pay_invoice` request. The private key is the secret from the connection string above.
1332. **wallet service** verifies that the author's key is authorized to perform the payment, decrypts the payload and sends the payment. 4072. **wallet service** verifies that the author's key is authorized to perform the payment, decrypts the payload and sends the payment.
1343. **wallet service** responds to the event by sending an event with kind `23195` and content being a response either containing an error message or a preimage. 4083. **wallet service** responds to the event by sending an event with kind `23195` and content being a response either containing an error message or a preimage.
diff --git a/49.md b/49.md
new file mode 100644
index 0000000..731f132
--- /dev/null
+++ b/49.md
@@ -0,0 +1,126 @@
1
2NIP-49
3======
4
5Private Key Encryption
6----------------------
7
8`draft` `optional`
9
10This NIP defines a method by which clients can encrypt (and decrypt) a user's private key with a password.
11
12Symmetric Encryption Key derivation
13-----------------------------------
14
15PASSWORD = Read from the user. The password should be unicode normalized to NFKC format to ensure that the password can be entered identically on other computers/clients.
16
17LOG\_N = Let the user or implementer choose one byte representing a power of 2 (e.g. 18 represents 262,144) which is used as the number of rounds for scrypt. Larger numbers take more time and more memory, and offer better protection:
18
19 | LOG_N | MEMORY REQUIRED | APPROX TIME ON FAST COMPUTER |
20 |-------|-----------------|----------------------------- |
21 | 16 | 64 MiB | 100 ms |
22 | 18 | 256 MiB | |
23 | 20 | 1 GiB | 2 seconds |
24 | 21 | 2 GiB | |
25 | 22 | 4 GiB | |
26
27SALT = 16 random bytes
28
29SYMMETRIC_KEY = scrypt(password=PASSWORD, salt=SALT, log\_n=LOG\_N, r=8, p=1)
30
31The symmetric key should be 32 bytes long.
32
33This symmetric encryption key is temporary and should be zeroed and discarded after use and not stored or reused for any other purpose.
34
35
36Encrypting a private key
37------------------------
38
39The private key encryption process is as follows:
40
41PRIVATE\_KEY = User's private (secret) secp256k1 key as 32 raw bytes (not hex or bech32 encoded!)
42
43KEY\_SECURITY\_BYTE = one of:
44
45* 0x00 - if the key has been known to have been handled insecurely (stored unencrypted, cut and paste unencrypted, etc)
46* 0x01 - if the key has NOT been known to have been handled insecurely (stored unencrypted, cut and paste unencrypted, etc)
47 * 0x02 - if the client does not track this data
48
49ASSOCIATED\_DATA = KEY\_SECURITY\_BYTE
50
51NONCE = 24 byte random nonce
52
53CIPHERTEXT = XChaCha20-Poly1305(
54 plaintext=PRIVATE\_KEY,
55 associated_data=ASSOCIATED\_DATA,
56 nonce=NONCE,
57 key=SYMMETRIC\_KEY
58)
59
60VERSION\_NUMBER = 0x02
61
62CIPHERTEXT_CONCATENATION = concat(
63 VERSION\_NUMBER,
64 LOG\_N,
65 SALT,
66 NONCE,
67 ASSOCIATED\_DATA,
68 CIPHERTEXT
69)
70
71ENCRYPTED\_PRIVATE\_KEY = bech32_encode('ncryptsec', CIPHERTEXT\_CONCATENATION)
72
73The output prior to bech32 encoding should be 91 bytes long.
74
75The decryption process operates in the reverse.
76
77
78Test Data
79---------
80
81## Password Unicode Normalization
82
83The following password input: "ÅΩẛ̣"
84- Unicode Codepoints: U+212B U+2126 U+1E9B U+0323
85- UTF-8 bytes: [0xE2, 0x84, 0xAB, 0xE2, 0x84, 0xA6, 0xE1, 0xBA, 0x9B, 0xCC, 0xA3]
86
87Should be converted into the unicode normalized NFKC format prior to use in scrypt: "ÅΩẛ̣"
88- Unicode Codepoints: U+00C5 U+03A9 U+1E69
89- UTF-8 bytes: [0xC3, 0x85, 0xCE, 0xA9, 0xE1, 0xB9, 0xA9]
90
91## Encryption
92
93The encryption process is non-deterministic due to the random nonce.
94
95## Decryption
96
97The following encrypted private key:
98
99`ncryptsec1qgg9947rlpvqu76pj5ecreduf9jxhselq2nae2kghhvd5g7dgjtcxfqtd67p9m0w57lspw8gsq6yphnm8623nsl8xn9j4jdzz84zm3frztj3z7s35vpzmqf6ksu8r89qk5z2zxfmu5gv8th8wclt0h4p`
100
101When decrypted with password='nostr' and log_n=16 yields the following hex-encoded private key:
102
103`3501454135014541350145413501453fefb02227e449e57cf4d3a3ce05378683`
104
105Discussion
106----------
107
108### On Key Derivation
109
110Passwords make poor cryptographic keys. Prior to use as a cryptographic key, two things need to happen:
111
1121. An encryption key needs to be deterministically created from the password such that is has a uniform functionally random distribution of bits, such that the symmetric encryption algorithm's assumptions are valid, and
1132. A slow irreversible algorithm should be injected into the process, so that brute-force attempts to decrypt by trying many passwords are severely hampered.
114
115These are achieved using a password-based key derivation function. We use scrypt, which has been proven to be maximally memory hard and which several cryptographers have indicated to the author is better than argon2 even though argon2 won a competition in 2015.
116
117### On the symmetric encryption algorithm
118
119XChaCha20-Poly1305 is typically favored by cryptographers over AES and is less associated with the U.S. government. It (or it's earlier variant without the 'X') is gaining wide usage, is used in TLS and OpenSSH, and is available in most modern crypto libraries.
120
121Recommendations
122---------
123
124It is not recommended that users publish these encrypted private keys to nostr, as cracking a key may become easier when an attacker can amass many encrypted private keys.
125
126It is recommended that clients zero out the memory of passwords and private keys before freeing that memory.
diff --git a/50.md b/50.md
index 2bdf1ff..a6e02be 100644
--- a/50.md
+++ b/50.md
@@ -41,9 +41,13 @@ implementation details between relays.
41Clients MAY verify that events returned by a relay match the specified query in a way that suits the 41Clients MAY verify that events returned by a relay match the specified query in a way that suits the
42client's use case, and MAY stop querying relays that have low precision. 42client's use case, and MAY stop querying relays that have low precision.
43 43
44Relays SHOULD exclude spam from search results by default if they supports some form of spam filtering. 44Relays SHOULD exclude spam from search results by default if they support some form of spam filtering.
45 45
46## Extensions 46## Extensions
47 47
48Relay MAY support these extensions: 48Relay MAY support these extensions:
49- `include:spam` - turn off spam filtering, if it was enabled by default 49- `include:spam` - turn off spam filtering, if it was enabled by default
50- `domain:<domain>` - include only events from users whose valid nip05 domain matches the domain
51- `language:<two letter ISO 639-1 language code>` - include only events of a specified language
52- `sentiment:<negative/neutral/positive>` - include only events of a specific sentiment
53- `nsfw:<true/false>` - include or exclude nsfw events (default: true)
diff --git a/51.md b/51.md
index f5a9a74..fb40b26 100644
--- a/51.md
+++ b/51.md
@@ -10,25 +10,30 @@ This NIP defines lists of things that users can create. Lists can contain refere
10 10
11Public items in a list are specified in the event `tags` array, while private items are specified in a JSON array that mimics the structure of the event `tags` array, but stringified and encrypted using the same scheme from [NIP-04](04.md) (the shared key is computed using the author's public and private key) and stored in the `.content`. 11Public items in a list are specified in the event `tags` array, while private items are specified in a JSON array that mimics the structure of the event `tags` array, but stringified and encrypted using the same scheme from [NIP-04](04.md) (the shared key is computed using the author's public and private key) and stored in the `.content`.
12 12
13When new items are added to an existing list, clients SHOULD append them to the end of the list, so they are stored in chronological order.
14
13## Types of lists 15## Types of lists
14 16
15## Standard lists 17## Standard lists
16 18
17Standard lists use non-parameterized replaceable events, meaning users may only have a single list of each kind. They have special meaning and clients may rely on them to augment a user's profile or browsing experience. 19Standard lists use non-parameterized replaceable events, meaning users may only have a single list of each kind. They have special meaning and clients may rely on them to augment a user's profile or browsing experience.
18 20
19For example, _mute lists_ can contain the public keys of spammers and bad actors users don't want to see in their feeds or receive annoying notifications from. 21For example, _mute list_ can contain the public keys of spammers and bad actors users don't want to see in their feeds or receive annoying notifications from.
20 22
21| name | kind | description | expected tag items | 23| name | kind | description | expected tag items |
22| --- | --- | --- | --- | 24| --- | --- | --- | --- |
23| Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags), `"word"` (lowercase string), `"e"` (threads) | 25| Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags), `"word"` (lowercase string), `"e"` (threads) |
24| Pinned notes | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | 26| Pinned notes | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) |
25| Bookmarks | 10003 | uncategorized, "global" list of things a user wants to save | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r" (URLs)` | 27| Bookmarks | 10003 | uncategorized, "global" list of things a user wants to save | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) |
26| Communities | 10004 | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) | 28| Communities | 10004 | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) |
27| Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) | 29| Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) |
28| Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) | 30| Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) |
29| Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) | 31| Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) |
30| Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a" (kind:30015 interest set)` | 32| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group ids + mandatory relay URL) |
31| Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | 33| Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) |
34| Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) |
35| Good wiki authors | 10101 | [NIP-54](54.md) user recommended wiki authors | `"p"` (pubkeys) |
36| Good wiki relays | 10102 | [NIP-54](54.md) relays deemed to only host useful articles | `"relay"` (relay URLs) |
32 37
33## Sets 38## Sets
34 39
@@ -42,10 +47,12 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti
42| --- | --- | --- | --- | 47| --- | --- | --- | --- |
43| Follow sets | 30000 | categorized groups of users a client may choose to check out in different circumstances | `"p"` (pubkeys) | 48| Follow sets | 30000 | categorized groups of users a client may choose to check out in different circumstances | `"p"` (pubkeys) |
44| Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during various operations | `"relay"` (relay URLs) | 49| Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during various operations | `"relay"` (relay URLs) |
45| Bookmark sets | 30003 | user-defined bookmarks categories , for when bookmarks must be in labeled separate groups | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r" (URLs)` | 50| Bookmark sets | 30003 | user-defined bookmarks categories , for when bookmarks must be in labeled separate groups | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) |
46| Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) | 51| Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) |
52| Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"a"` (kind:34235 videos) |
47| Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) | 53| Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) |
48| Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | 54| Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) |
55| Release artifact sets | 30063 | groups of files of a software release | `"e"` (kind:1063 [file metadata](94.md) events), `"i"` (application identifier, typically reverse domain notation), `"version"` |
49 56
50## Deprecated standard lists 57## Deprecated standard lists
51 58
@@ -79,7 +86,7 @@ Some clients have used these lists in the past, but they should work on transiti
79 86
80### A _curation set_ of articles and notes about yaks 87### A _curation set_ of articles and notes about yaks
81 88
82``` 89```json
83{ 90{
84 "id": "567b41fc9060c758c4216fe5f8d3df7c57daad7ae757fa4606f0c39d4dd220ef", 91 "id": "567b41fc9060c758c4216fe5f8d3df7c57daad7ae757fa4606f0c39d4dd220ef",
85 "pubkey": "d6dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c", 92 "pubkey": "d6dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c",
@@ -100,6 +107,30 @@ Some clients have used these lists in the past, but they should work on transiti
100} 107}
101``` 108```
102 109
110### A _release artifact set_ of an Example App
111
112```json
113{
114 "id": "567b41fc9060c758c4216fe5f8d3df7c57daad7ae757fa4606f0c39d4dd220ef",
115 "pubkey": "d6dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c",
116 "created_at": 1695327657,
117 "kind": 30063,
118 "tags": [
119 ["d", "ak8dy3v7"],
120 ["i", "com.example.app"],
121 ["version", "0.0.1"],
122 ["title", "Example App"],
123 ["image", "http://cdn.site/p/com.example.app/icon.png"],
124 ["e", "d78ba0d5dce22bfff9db0a9e996c9ef27e2c91051de0c4e1da340e0326b4941e"], // Windows exe
125 ["e", "f27e2c91051de0c4e1da0d5dce22bfff9db0a9340e0326b4941ed78bae996c9e"], // MacOS dmg
126 ["e", "9d24ddfab95ba3ff7c03fbd07ad011fff245abea431fb4d3787c2d04aad02332"], // Linux AppImage
127 ["e", "340e0326b340e0326b4941ed78ba340e0326b4941ed78ba340e0326b49ed78ba"] // PWA
128 ],
129 "content": "Example App is a decentralized marketplace for apps",
130 "sig": "a9a4e2192eede77e6c9d24ddfab95ba3ff7c03fbd07ad011fff245abea431fb4d3787c2d04aad001cb039cb8de91d83ce30e9a94f82ac3c5a2372aa1294a96bd"
131}
132```
133
103## Encryption process pseudocode 134## Encryption process pseudocode
104 135
105```scala 136```scala
diff --git a/52.md b/52.md
index 15cc8fc..f35d904 100644
--- a/52.md
+++ b/52.md
@@ -22,20 +22,23 @@ This kind of calendar event starts on a date and ends before a different date in
22 22
23The format uses a parameterized replaceable event kind `31922`. 23The format uses a parameterized replaceable event kind `31922`.
24 24
25The `.content` of these events is optional and should be a detailed description of the calendar event. 25The `.content` of these events should be a detailed description of the calendar event. It is required but can be an empty string.
26 26
27The list of tags are as follows: 27The list of tags are as follows:
28* `d` (required) universally unique identifier (UUID). Generated by the client creating the calendar event. 28* `d` (required) universally unique identifier (UUID). Generated by the client creating the calendar event.
29* `name` (required) name of the calendar event 29* `title` (required) title of the calendar event
30* `start` (required) inclusive start date in ISO 8601 format (YYYY-MM-DD). Must be less than `end`, if it exists. 30* `start` (required) inclusive start date in ISO 8601 format (YYYY-MM-DD). Must be less than `end`, if it exists.
31* `end` (optional) exclusive end date in ISO 8601 format (YYYY-MM-DD). If omitted, the calendar event ends on the same date as `start`. 31* `end` (optional) exclusive end date in ISO 8601 format (YYYY-MM-DD). If omitted, the calendar event ends on the same date as `start`.
32* `location` (optional) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call 32* `location` (optional, repeated) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call
33* `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location 33* `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location
34* `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting 34* `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting
35* `t` (optional, repeated) hashtag to categorize calendar event 35* `t` (optional, repeated) hashtag to categorize calendar event
36* `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. 36* `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc.
37 37
38```json 38The following tags are deprecated:
39* `name` name of the calendar event. Use only if `title` is not available.
40
41```jsonc
39{ 42{
40 "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, 43 "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>,
41 "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, 44 "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
@@ -45,7 +48,7 @@ The list of tags are as follows:
45 "tags": [ 48 "tags": [
46 ["d", "<UUID>"], 49 ["d", "<UUID>"],
47 50
48 ["name", "<name of calendar event>"], 51 ["title", "<title of calendar event>"],
49 52
50 // Dates 53 // Dates
51 ["start", "<YYYY-MM-DD>"], 54 ["start", "<YYYY-MM-DD>"],
@@ -78,22 +81,25 @@ This kind of calendar event spans between a start time and end time.
78 81
79The format uses a parameterized replaceable event kind `31923`. 82The format uses a parameterized replaceable event kind `31923`.
80 83
81The `.content` of these events is optional and should be a detailed description of the calendar event. 84The `.content` of these events should be a detailed description of the calendar event. It is required but can be an empty string.
82 85
83The list of tags are as follows: 86The list of tags are as follows:
84* `d` (required) universally unique identifier (UUID). Generated by the client creating the calendar event. 87* `d` (required) universally unique identifier (UUID). Generated by the client creating the calendar event.
85* `name` (required) name of the calendar event 88* `title` (required) title of the calendar event
86* `start` (required) inclusive start Unix timestamp in seconds. Must be less than `end`, if it exists. 89* `start` (required) inclusive start Unix timestamp in seconds. Must be less than `end`, if it exists.
87* `end` (optional) exclusive end Unix timestamp in seconds. If omitted, the calendar event ends instantaneously. 90* `end` (optional) exclusive end Unix timestamp in seconds. If omitted, the calendar event ends instantaneously.
88* `start_tzid` (optional) time zone of the start timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica` 91* `start_tzid` (optional) time zone of the start timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica`
89* `end_tzid` (optional) time zone of the end timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica`. If omitted and `start_tzid` is provided, the time zone of the end timestamp is the same as the start timestamp. 92* `end_tzid` (optional) time zone of the end timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica`. If omitted and `start_tzid` is provided, the time zone of the end timestamp is the same as the start timestamp.
90* `location` (optional) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call 93* `location` (optional, repeated) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call
91* `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location 94* `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location
92* `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting 95* `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting
93* `t` (optional, repeated) hashtag to categorize calendar event 96* `t` (optional, repeated) hashtag to categorize calendar event
94* `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. 97* `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc.
95 98
96```json 99The following tags are deprecated:
100* `name` name of the calendar event. Use only if `title` is not available.
101
102```jsonc
97{ 103{
98 "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, 104 "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>,
99 "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, 105 "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
@@ -103,7 +109,7 @@ The list of tags are as follows:
103 "tags": [ 109 "tags": [
104 ["d", "<UUID>"], 110 ["d", "<UUID>"],
105 111
106 ["name", "<name of calendar event>"], 112 ["title", "<title of calendar event>"],
107 113
108 // Timestamps 114 // Timestamps
109 ["start", "<Unix timestamp in seconds>"], 115 ["start", "<Unix timestamp in seconds>"],
@@ -137,15 +143,23 @@ A calendar is a collection of calendar events, represented as a custom replaceab
137 143
138### Format 144### Format
139 145
146The `.content` of these events should be a detailed description of the calendar. It is required but can be an empty string.
147
140The format uses a custom replaceable list of kind `31924` with a list of tags as described below: 148The format uses a custom replaceable list of kind `31924` with a list of tags as described below:
141* `d` (required) calendar name 149* `d` (required) universally unique identifier. Generated by the client creating the calendar.
150* `title` (required) calendar title
142* `a` (repeated) reference tag to kind `31922` or `31923` calendar event being responded to 151* `a` (repeated) reference tag to kind `31922` or `31923` calendar event being responded to
143 152
144```json 153```json
145{ 154{
155 "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>,
156 "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
157 "created_at": <Unix timestamp in seconds>,
146 "kind": 31924, 158 "kind": 31924,
159 "content": "<description of calendar>",
147 "tags": [ 160 "tags": [
148 ["d", "<calendar name>"], 161 ["d", "<UUID>"],
162 ["title", "<calendar title>"],
149 ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"], 163 ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"],
150 ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"] 164 ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"]
151 ] 165 ]
@@ -173,10 +187,8 @@ The `.content` of these events is optional and should be a free-form note that a
173The list of tags are as follows: 187The list of tags are as follows:
174* `a` (required) reference tag to kind `31922` or `31923` calendar event being responded to. 188* `a` (required) reference tag to kind `31922` or `31923` calendar event being responded to.
175* `d` (required) universally unique identifier. Generated by the client creating the calendar event RSVP. 189* `d` (required) universally unique identifier. Generated by the client creating the calendar event RSVP.
176* `L` (required) label namespace of `status` per [NIP-32](32.md) 190* `status` (required) `accepted`, `declined`, or `tentative`. Determines attendance status to the referenced calendar event.
177* `l` (required) label of `accepted`, `declined`, or `tentative` under the label namespace of `status` per [NIP-32](32.md). Determines attendance status to the referenced calendar event. 191* `fb` (optional) `free` or `busy`. Determines if the user would be free or busy for the duration of the calendar event. This tag must be omitted or ignored if the `status` label is set to `declined`.
178* `L` (optional) label namespace of `freebusy` per [NIP-32](32.md). Exists if and only if corresponding `l` tag under the same label namespace exists.
179* `l` (optional) label of `free` or `busy` under the label namespace of `freebusy` per [NIP-32](32.md). Determines if the user would be free or busy for the duration of the calendar event. This tag must be omitted or ignored if the `status` label is set to `declined`. Exists if and only if corresponding `l` tag under the same label namespace exists.
180 192
181```json 193```json
182{ 194{
@@ -188,10 +200,8 @@ The list of tags are as follows:
188 "tags": [ 200 "tags": [
189 ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"], 201 ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"],
190 ["d", "<UUID>"], 202 ["d", "<UUID>"],
191 ["L", "status"], 203 ["status", "<accepted/declined/tentative>"],
192 ["l", "<accepted/declined/tentative>", "status"], 204 ["fb", "<free/busy>"],
193 ["L", "freebusy"],
194 ["l", "<free/busy>", "freebusy"]
195 ] 205 ]
196} 206}
197``` 207```
diff --git a/53.md b/53.md
index e17f965..fad2622 100644
--- a/53.md
+++ b/53.md
@@ -94,7 +94,7 @@ Common use cases include meeting rooms/workshops, watch-together activities, or
94 ["title", "Adult Swim Metalocalypse"], 94 ["title", "Adult Swim Metalocalypse"],
95 ["summary", "Live stream from IPTV-ORG collection"], 95 ["summary", "Live stream from IPTV-ORG collection"],
96 ["streaming", "https://adultswim-vodlive.cdn.turner.com/live/metalocalypse/stream.m3u8"], 96 ["streaming", "https://adultswim-vodlive.cdn.turner.com/live/metalocalypse/stream.m3u8"],
97 ["starts", "1687182672"] 97 ["starts", "1687182672"],
98 ["status", "live"], 98 ["status", "live"],
99 ["t", "animation"], 99 ["t", "animation"],
100 ["t", "iptv"], 100 ["t", "iptv"],
diff --git a/54.md b/54.md
new file mode 100644
index 0000000..8823af9
--- /dev/null
+++ b/54.md
@@ -0,0 +1,112 @@
1NIP-54
2======
3
4Wiki
5----
6
7`draft` `optional`
8
9This NIP defines `kind:30818` (a _parameterized replaceable event_) for long-form text content similar to [NIP-23](23.md), but with one important difference: articles are meant to be descriptions, or encyclopedia entries, of particular subjects, and it's expected that multiple people will write articles about the exact same subjects, with either small variations or completely independent content.
10
11Articles are identified by lowercase, normalized ascii `d` tags.
12
13### Articles
14```jsonc
15{
16 "content": "A wiki is a hypertext publication collaboratively edited and managed by its own audience.",
17 "tags": [
18 ["d", "wiki"],
19 ["title", "Wiki"],
20 ]
21}
22```
23
24### `d` tag normalization rules
25
26- Any non-letter character MUST be converted to a `-`.
27- All letters MUST be converted to lowercase.
28
29### Content rules
30
31The content should be Markdown, following the same rules as of [NIP-23](23.md), although it takes some extra (optional) metadata tags:
32
33 - `title`: for when the display title should be different from the `d` tag.
34 - `summary`: for display in lists.
35 - `a` and `e`: for referencing the original event a wiki article was forked from.
36
37One extra functionality is added: **wikilinks**. Unlike normal Markdown links `[]()` that link to webpages, wikilinks `[[]]` link to other articles in the wiki. In this case, the wiki is the entirety of Nostr. Clicking on a wikilink should cause the client to ask relays for events with `d` tags equal to the target of that wikilink.
38
39### Merge Requests
40
41Event `kind:818` represents a request to merge from a forked article into the source. It is directed to a pubkey and references the original article and the modified event.
42
43[INSERT EVENT EXAMPLE]
44
45### Redirects
46
47Event `kind:30819` is also defined to stand for "wiki redirects", i.e. if one thinks `Shell structure` should redirect to `Thin-shell structure` they can issue one of these events instead of replicating the content. These events can be used for automatically redirecting between articles on a client, but also for generating crowdsourced "disambiguation" pages ([common in Wikipedia](https://en.wikipedia.org/wiki/Help:Disambiguation)).
48
49[INSERT EVENT EXAMPLE]
50
51How to decide what article to display
52-------------------------------------
53
54As there could be many articles for each given name, some kind of prioritization must be done by clients. Criteria for this should vary between users and clients, but some means that can be used are described below:
55
56### Reactions
57
58[NIP-25](25.md) reactions are very simple and can be used to create a simple web-of-trust between wiki article writers and their content. While just counting a raw number of "likes" is unproductive, reacting to any wiki article event with a `+` can be interpreted as a recommendation for that article specifically and a partial recommendation of the author of that article. When 2 or 3-level deep recommendations are followed, suddenly a big part of all the articles may have some form of tagging.
59
60### Relays
61
62[NIP-51](51.md) lists of relays can be created with the kind 10102 and then used by wiki clients in order to determine where to query articles first and to rank these differently in relation to other events fetched from other relays.
63
64### Contact lists
65
66[NIP-02](02.md) contact lists can form the basis of a recommendation system that is then expanded with relay lists and reaction lists through nested queries. These lists form a good starting point only because they are so widespread.
67
68### Wiki-related contact lists
69
70[NIP-51](51.md) lists can also be used to create a list of users that are trusted only in the context of wiki authorship or wiki curationship.
71
72Forks
73---------
74Wiki-events can tag other wiki-events with a `fork` marker to specify that this event came from a different version. Both `a` and `e` tags SHOULD be used and have the `fork` marker applied, to identify the exact version it was forked from.
75
76Deference
77---------
78Wiki-events can tag other wiki-events with a `defer` marker to indicate that it considers someone else's entry as a "better" version of itself. If using a `defer` marker both `a` and `e` tags SHOULD be used.
79
80This is a stronger signal of trust than a `+` reaction.
81
82This marker is useful when a user edits someone else's entry; if the original author includes the editor's changes and the editor doesn't want to keep/maintain an independent version, the `link` tag could effectively be a considered a "deletion" of the editor's version and putting that pubkey's WoT weight behind the original author's version.
83
84Why Markdown?
85-------------
86
87If the idea is to make a wiki then the most obvious text format to use is probably the mediawiki/wikitext format used by Wikipedia since it's widely deployed in all mediawiki installations and used for decades with great success. However, it turns out that format is very bloated and convoluted, has way too many features and probably because of that it doesn't have many alternative implementations out there, and the ones that exist are not complete and don't look very trustworthy. Also it is very much a centralized format that can probably be changed at the whims of the Wikipedia owners.
88
89On the other hand, Markdown has proven to work well for small scale wikis and one of the biggest wikis in the planet (which is not very often thought of as a wiki), [StackOverflow](https://stackoverflow.com) and its child sites, and also one of the biggest "personal wiki" software, [Obsidian](https://obsidian.md/). Markdown can probably deliver 95% of the functionality of wikitext. When augmented with tables, diagram generators and MathJax (which are common extensions that exist in the wild and can be included in this NIP) that rate probably goes to 99%, and its simplicity is a huge benefit that can't be overlooked. Wikitext format can also be transpíled into Markdown using Pandoc. Given all that, I think it's a reasonable suspicion that mediawiki is not inherently better than Markdown, the success of Wikipedia probably cannot be predicated on the syntax language choice.
90
91# Appendix 1: Merge requests
92Users can request other users to get their entries merged into someone else's entry by creating a `kind:818` event.
93
94```jsonc
95{
96 "content": "I added information about how to make hot ice-creams",
97 "kind": 818,
98 "tags": [
99 [ "a", "30818:<destination-pubkey>:hot-ice-creams", "<relay-url>" ],
100 [ "e", "<version-against-which-the-modification-was-made>", "<relay-url>' ],
101 [ "p", "<destination-pubkey>" ],
102 [ "e", "<version-to-be-merged>", "<relay-url>", "source" ]
103 ]
104}
105```
106
107`.content`: an optional explanation detailing why this merge is being requested.
108`a` tag: tag of the article which should be modified (i.e. the target of this merge request).
109`e` tag: optional version of the article in which this modifications is based
110`e` tag with `source` marker: the ID of the event that should be merged. This event id MUST be of a `kind:30818` as defined in this NIP.
111
112The destination-pubkey (the pubkey being requested to merge something into their article can create [[NIP-25]] reactions that tag the `kind:818` event with `+` or `-`
diff --git a/56.md b/56.md
index a2861e3..fc8d898 100644
--- a/56.md
+++ b/56.md
@@ -4,10 +4,12 @@ NIP-56
4Reporting 4Reporting
5--------- 5---------
6 6
7`draft` `optional` 7`optional`
8 8
9A report is a `kind 1984` note that is used to report other notes for spam, 9A report is a `kind 1984` event that signals to users and relays that
10illegal and explicit content. 10some referenced content is objectionable. The definition of objectionable is
11obviously subjective and all agents on the network (users, apps, relays, etc.)
12may consume and take action on them as they see fit.
11 13
12The `content` MAY contain additional information submitted by the entity 14The `content` MAY contain additional information submitted by the entity
13reporting the content. 15reporting the content.
@@ -24,10 +26,12 @@ A `report type` string MUST be included as the 3rd entry to the `e` or `p` tag
24being reported, which consists of the following report types: 26being reported, which consists of the following report types:
25 27
26- `nudity` - depictions of nudity, porn, etc. 28- `nudity` - depictions of nudity, porn, etc.
29- `malware` - virus, trojan horse, worm, robot, spyware, adware, back door, ransomware, rootkit, kidnapper, etc.
27- `profanity` - profanity, hateful speech, etc. 30- `profanity` - profanity, hateful speech, etc.
28- `illegal` - something which may be illegal in some jurisdiction 31- `illegal` - something which may be illegal in some jurisdiction
29- `spam` - spam 32- `spam` - spam
30- `impersonation` - someone pretending to be someone else 33- `impersonation` - someone pretending to be someone else
34- `other` - for reports that don't fit in the above categories
31 35
32Some report tags only make sense for profile reports, such as `impersonation` 36Some report tags only make sense for profile reports, such as `impersonation`
33 37
diff --git a/57.md b/57.md
index 759e203..6d89620 100644
--- a/57.md
+++ b/57.md
@@ -111,6 +111,7 @@ When a client sends a `zap request` event to a server's lnurl-pay callback URL,
1115. There should be a `relays` tag with the relays to send the `zap receipt` to. 1115. There should be a `relays` tag with the relays to send the `zap receipt` to.
1126. If there is an `amount` tag, it MUST be equal to the `amount` query parameter. 1126. If there is an `amount` tag, it MUST be equal to the `amount` query parameter.
1137. If there is an `a` tag, it MUST be a valid event coordinate 1137. If there is an `a` tag, it MUST be a valid event coordinate
1148. There MUST be 0 or 1 `P` tags. If there is one, it MUST be equal to the `zap receipt`'s `pubkey`.
114 115
115The event MUST then be stored for use later, when the invoice is paid. 116The event MUST then be stored for use later, when the invoice is paid.
116 117
@@ -128,7 +129,7 @@ The following should be true of the `zap receipt` event:
128 129
129- The `content` SHOULD be empty. 130- The `content` SHOULD be empty.
130- The `created_at` date SHOULD be set to the invoice `paid_at` date for idempotency. 131- The `created_at` date SHOULD be set to the invoice `paid_at` date for idempotency.
131- `tags` MUST include the `p` tag AND optional `e` tag from the `zap request` AND optional `a` tag from the `zap request`. 132- `tags` MUST include the `p` tag (zap recipient) AND optional `e` tag from the `zap request` AND optional `a` tag from the `zap request` AND optional `P` tag from the pubkey of the zap request (zap sender).
132- The `zap receipt` MUST have a `bolt11` tag containing the description hash bolt11 invoice. 133- The `zap receipt` MUST have a `bolt11` tag containing the description hash bolt11 invoice.
133- The `zap receipt` MUST contain a `description` tag which is the JSON-encoded invoice description. 134- The `zap receipt` MUST contain a `description` tag which is the JSON-encoded invoice description.
134- `SHA256(description)` MUST match the description hash in the bolt11 invoice. 135- `SHA256(description)` MUST match the description hash in the bolt11 invoice.
@@ -148,13 +149,13 @@ Example `zap receipt`:
148 "kind": 9735, 149 "kind": 9735,
149 "tags": [ 150 "tags": [
150 ["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"], 151 ["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"],
152 ["P", "97c70a44366a6535c145b333f973ea86dfdc2d7a99da618c40c64705ad98e322"],
151 ["e", "3624762a1274dd9636e0c552b53086d70bc88c165bc4dc0f9e836a1eaf86c3b8"], 153 ["e", "3624762a1274dd9636e0c552b53086d70bc88c165bc4dc0f9e836a1eaf86c3b8"],
152 ["bolt11", "lnbc10u1p3unwfusp5t9r3yymhpfqculx78u027lxspgxcr2n2987mx2j55nnfs95nxnzqpp5jmrh92pfld78spqs78v9euf2385t83uvpwk9ldrlvf6ch7tpascqhp5zvkrmemgth3tufcvflmzjzfvjt023nazlhljz2n9hattj4f8jq8qxqyjw5qcqpjrzjqtc4fc44feggv7065fqe5m4ytjarg3repr5j9el35xhmtfexc42yczarjuqqfzqqqqqqqqlgqqqqqqgq9q9qxpqysgq079nkq507a5tw7xgttmj4u990j7wfggtrasah5gd4ywfr2pjcn29383tphp4t48gquelz9z78p4cq7ml3nrrphw5w6eckhjwmhezhnqpy6gyf0"], 154 ["bolt11", "lnbc10u1p3unwfusp5t9r3yymhpfqculx78u027lxspgxcr2n2987mx2j55nnfs95nxnzqpp5jmrh92pfld78spqs78v9euf2385t83uvpwk9ldrlvf6ch7tpascqhp5zvkrmemgth3tufcvflmzjzfvjt023nazlhljz2n9hattj4f8jq8qxqyjw5qcqpjrzjqtc4fc44feggv7065fqe5m4ytjarg3repr5j9el35xhmtfexc42yczarjuqqfzqqqqqqqqlgqqqqqqgq9q9qxpqysgq079nkq507a5tw7xgttmj4u990j7wfggtrasah5gd4ywfr2pjcn29383tphp4t48gquelz9z78p4cq7ml3nrrphw5w6eckhjwmhezhnqpy6gyf0"],
153 ["description", "{\"pubkey\":\"32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245\",\"content\":\"\",\"id\":\"d9cc14d50fcb8c27539aacf776882942c1a11ea4472f8cdec1dea82fab66279d\",\"created_at\":1674164539,\"sig\":\"77127f636577e9029276be060332ea565deaf89ff215a494ccff16ae3f757065e2bc59b2e8c113dd407917a010b3abd36c8d7ad84c0e3ab7dab3a0b0caa9835d\",\"kind\":9734,\"tags\":[[\"e\",\"3624762a1274dd9636e0c552b53086d70bc88c165bc4dc0f9e836a1eaf86c3b8\"],[\"p\",\"32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245\"],[\"relays\",\"wss://relay.damus.io\",\"wss://nostr-relay.wlvs.space\",\"wss://nostr.fmt.wiz.biz\",\"wss://relay.nostr.bg\",\"wss://nostr.oxtr.dev\",\"wss://nostr.v0l.io\",\"wss://brb.io\",\"wss://nostr.bitcoiner.social\",\"ws://monad.jb55.com:8080\",\"wss://relay.snort.social\"]]}"], 155 ["description", "{\"pubkey\":\"97c70a44366a6535c145b333f973ea86dfdc2d7a99da618c40c64705ad98e322\",\"content\":\"\",\"id\":\"d9cc14d50fcb8c27539aacf776882942c1a11ea4472f8cdec1dea82fab66279d\",\"created_at\":1674164539,\"sig\":\"77127f636577e9029276be060332ea565deaf89ff215a494ccff16ae3f757065e2bc59b2e8c113dd407917a010b3abd36c8d7ad84c0e3ab7dab3a0b0caa9835d\",\"kind\":9734,\"tags\":[[\"e\",\"3624762a1274dd9636e0c552b53086d70bc88c165bc4dc0f9e836a1eaf86c3b8\"],[\"p\",\"32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245\"],[\"relays\",\"wss://relay.damus.io\",\"wss://nostr-relay.wlvs.space\",\"wss://nostr.fmt.wiz.biz\",\"wss://relay.nostr.bg\",\"wss://nostr.oxtr.dev\",\"wss://nostr.v0l.io\",\"wss://brb.io\",\"wss://nostr.bitcoiner.social\",\"ws://monad.jb55.com:8080\",\"wss://relay.snort.social\"]]}"],
154 ["preimage", "5d006d2cf1e73c7148e7519a4c68adc81642ce0e25a432b2434c99f97344c15f"] 156 ["preimage", "5d006d2cf1e73c7148e7519a4c68adc81642ce0e25a432b2434c99f97344c15f"]
155 ], 157 ],
156 "content": "", 158 "content": "",
157 "sig": "b0a3c5c984ceb777ac455b2f659505df51585d5fd97a0ec1fdb5f3347d392080d4b420240434a3afd909207195dac1e2f7e3df26ba862a45afd8bfe101c2b1cc"
158 } 159 }
159``` 160```
160 161
diff --git a/58.md b/58.md
index e2a9f20..4a9ed4c 100644
--- a/58.md
+++ b/58.md
@@ -28,7 +28,7 @@ The following tags MAY be present:
28- A `name` tag with a short name for the badge. 28- A `name` tag with a short name for the badge.
29- `image` tag whose value is the URL of a high-resolution image representing the badge. The second value optionally specifies the dimensions of the image as `width`x`height` in pixels. Badge recommended dimensions is 1024x1024 pixels. 29- `image` tag whose value is the URL of a high-resolution image representing the badge. The second value optionally specifies the dimensions of the image as `width`x`height` in pixels. Badge recommended dimensions is 1024x1024 pixels.
30- A `description` tag whose value MAY contain a textual representation of the 30- A `description` tag whose value MAY contain a textual representation of the
31image, the meaning behind the badge, or the reason of it's issuance. 31image, the meaning behind the badge, or the reason of its issuance.
32- One or more `thumb` tags whose first value is an URL pointing to a thumbnail version of the image referenced in the `image` tag. The second value optionally specifies the dimensions of the thumbnail as `width`x`height` in pixels. 32- One or more `thumb` tags whose first value is an URL pointing to a thumbnail version of the image referenced in the `image` tag. The second value optionally specifies the dimensions of the thumbnail as `width`x`height` in pixels.
33 33
34### Badge Award event 34### Badge Award event
@@ -83,7 +83,7 @@ Clients SHOULD attempt to render the most appropriate badge thumbnail according
83 ["name", "Medal of Bravery"], 83 ["name", "Medal of Bravery"],
84 ["description", "Awarded to users demonstrating bravery"], 84 ["description", "Awarded to users demonstrating bravery"],
85 ["image", "https://nostr.academy/awards/bravery.png", "1024x1024"], 85 ["image", "https://nostr.academy/awards/bravery.png", "1024x1024"],
86 ["thumb", "https://nostr.academy/awards/bravery_256x256.png", "256x256"], 86 ["thumb", "https://nostr.academy/awards/bravery_256x256.png", "256x256"]
87 ], 87 ],
88 ... 88 ...
89} 89}
@@ -99,7 +99,7 @@ Clients SHOULD attempt to render the most appropriate badge thumbnail according
99 "tags": [ 99 "tags": [
100 ["a", "30009:alice:bravery"], 100 ["a", "30009:alice:bravery"],
101 ["p", "bob", "wss://relay"], 101 ["p", "bob", "wss://relay"],
102 ["p", "charlie", "wss://relay"], 102 ["p", "charlie", "wss://relay"]
103 ], 103 ],
104 ... 104 ...
105} 105}
@@ -117,7 +117,7 @@ Honorable Bob The Brave:
117 ["a", "30009:alice:bravery"], 117 ["a", "30009:alice:bravery"],
118 ["e", "<bravery badge award event id>", "wss://nostr.academy"], 118 ["e", "<bravery badge award event id>", "wss://nostr.academy"],
119 ["a", "30009:alice:honor"], 119 ["a", "30009:alice:honor"],
120 ["e", "<honor badge award event id>", "wss://nostr.academy"], 120 ["e", "<honor badge award event id>", "wss://nostr.academy"]
121 ], 121 ],
122 ... 122 ...
123} 123}
diff --git a/59.md b/59.md
new file mode 100644
index 0000000..4dc857f
--- /dev/null
+++ b/59.md
@@ -0,0 +1,252 @@
1NIP-59
2======
3
4Gift Wrap
5---------
6
7`optional`
8
9This NIP defines a protocol for encapsulating any nostr event. This makes it possible to obscure most metadata
10for a given event, perform collaborative signing, and more.
11
12This NIP *does not* define any messaging protocol. Applications of this NIP should be defined separately.
13
14This NIP relies on [NIP-44](./44.md)'s versioned encryption algorithms.
15
16# Overview
17
18This protocol uses three main concepts to protect the transmission of a target event: `rumor`s, `seal`s, and `gift wrap`s.
19
20- A `rumor` is a regular nostr event, but is **not signed**. This means that if it is leaked, it cannot be verified.
21- A `rumor` is serialized to JSON, encrypted, and placed in the `content` field of a `seal`. The `seal` is then
22 signed by the author of the note. The only information publicly available on a `seal` is who signed it, but not what was said.
23- A `seal` is serialized to JSON, encrypted, and placed in the `content` field of a `gift wrap`.
24
25This allows the isolation of concerns across layers:
26
27- A rumor carries the content but is unsigned, which means if leaked it will be rejected by relays and clients,
28 and can't be authenticated. This provides a measure of deniability.
29- A seal identifies the author without revealing the content or the recipient.
30- A gift wrap can add metadata (recipient, tags, a different author) without revealing the true author.
31
32# Protocol Description
33
34## 1. The Rumor Event Kind
35
36A `rumor` is the same thing as an unsigned event. Any event kind can be made a `rumor` by removing the signature.
37
38## 2. The Seal Event Kind
39
40A `seal` is a `kind:13` event that wraps a `rumor` with the sender's regular key. The `seal` is **always** encrypted
41to a receiver's pubkey but there is no `p` tag pointing to the receiver. There is no way to know who the rumor is for
42without the receiver's or the sender's private key. The only public information in this event is who is signing it.
43
44```js
45{
46 "id": "<id>",
47 "pubkey": "<real author's pubkey>",
48 "content": "<encrypted rumor>",
49 "kind": 13,
50 "created_at": 1686840217,
51 "tags": [],
52 "sig": "<real author's pubkey signature>"
53}
54```
55
56Tags MUST must always be empty in a `kind:13`. The inner event MUST always be unsigned.
57
58## 3. Gift Wrap Event Kind
59
60A `gift wrap` event is a `kind:1059` event that wraps any other event. `tags` SHOULD include any information
61needed to route the event to its intended recipient, including the recipient's `p` tag or [NIP-13](13.md) proof of work.
62
63```js
64{
65 "id": "<id>",
66 "pubkey": "<random, one-time-use pubkey>",
67 "content": "<encrypted kind 13>",
68 "kind": 1059,
69 "created_at": 1686840217,
70 "tags": [["p", "<recipient pubkey>"]],
71 "sig": "<random, one-time-use pubkey signature>"
72}
73```
74
75# Encrypting Payloads
76
77Encryption is done following [NIP-44](44.md) on the JSON-encoded event. Place the encryption payload in the `.content`
78of the wrapper event (either a `seal` or a `gift wrap`).
79
80# Other Considerations
81
82If a `rumor` is intended for more than one party, or if the author wants to retain an encrypted copy, a single
83`rumor` may be wrapped and addressed for each recipient individually.
84
85The canonical `created_at` time belongs to the `rumor`. All other timestamps SHOULD be tweaked to thwart
86time-analysis attacks. Note that some relays don't serve events dated in the future, so all timestamps
87SHOULD be in the past.
88
89Relays may choose not to store gift wrapped events due to them not being publicly useful. Clients MAY choose
90to attach a certain amount of proof-of-work to the wrapper event per [NIP-13](13.md) in a bid to demonstrate that
91the event is not spam or a denial-of-service attack.
92
93To protect recipient metadata, relays SHOULD guard access to `kind 1059` events based on user AUTH. When
94possible, clients should only send wrapped events to relays that offer this protection.
95
96To protect recipient metadata, relays SHOULD only serve `kind 1059` events intended for the marked recipient.
97When possible, clients should only send wrapped events to `read` relays for the recipient that implement
98AUTH, and refuse to serve wrapped events to non-recipients.
99
100# An Example
101
102Let's send a wrapped `kind 1` message between two parties asking "Are you going to the party tonight?"
103
104- Author private key: `0beebd062ec8735f4243466049d7747ef5d6594ee838de147f8aab842b15e273`
105- Recipient private key: `e108399bd8424357a710b606ae0c13166d853d327e47a6e5e038197346bdbf45`
106- Ephemeral wrapper key: `4f02eac59266002db5801adc5270700ca69d5b8f761d8732fab2fbf233c90cbd`
107
108Note that this messaging protocol should not be used in practice, this is just an example. Refer to other
109NIPs for concrete messaging protocols that depend on gift wraps.
110
111## 1. Create an event
112
113Create a `kind 1` event with the message, the receivers, and any other tags you want, signed by the author.
114Do not sign the event.
115
116```json
117{
118 "created_at": 1691518405,
119 "content": "Are you going to the party tonight?",
120 "tags": [],
121 "kind": 1,
122 "pubkey": "611df01bfcf85c26ae65453b772d8f1dfd25c264621c0277e1fc1518686faef9",
123 "id": "9dd003c6d3b73b74a85a9ab099469ce251653a7af76f523671ab828acd2a0ef9"
124}
125```
126
127## 2. Seal the rumor
128
129Encrypt the JSON-encoded `rumor` with a conversation key derived using the author's private key and
130the recipient's public key. Place the result in the `content` field of a `kind 13` `seal` event. Sign
131it with the author's key.
132
133```json
134{
135 "content": "AqBCdwoS7/tPK+QGkPCadJTn8FxGkd24iApo3BR9/M0uw6n4RFAFSPAKKMgkzVMoRyR3ZS/aqATDFvoZJOkE9cPG/TAzmyZvr/WUIS8kLmuI1dCA+itFF6+ULZqbkWS0YcVU0j6UDvMBvVlGTzHz+UHzWYJLUq2LnlynJtFap5k8560+tBGtxi9Gx2NIycKgbOUv0gEqhfVzAwvg1IhTltfSwOeZXvDvd40rozONRxwq8hjKy+4DbfrO0iRtlT7G/eVEO9aJJnqagomFSkqCscttf/o6VeT2+A9JhcSxLmjcKFG3FEK3Try/WkarJa1jM3lMRQqVOZrzHAaLFW/5sXano6DqqC5ERD6CcVVsrny0tYN4iHHB8BHJ9zvjff0NjLGG/v5Wsy31+BwZA8cUlfAZ0f5EYRo9/vKSd8TV0wRb9DQ=",
136 "kind": 13,
137 "created_at": 1703015180,
138 "pubkey": "611df01bfcf85c26ae65453b772d8f1dfd25c264621c0277e1fc1518686faef9",
139 "tags": [],
140 "id": "28a87d7c074d94a58e9e89bb3e9e4e813e2189f285d797b1c56069d36f59eaa7",
141 "sig": "02fc3facf6621196c32912b1ef53bac8f8bfe9db51c0e7102c073103586b0d29c3f39bdaa1e62856c20e90b6c7cc5dc34ca8bb6a528872cf6e65e6284519ad73"
142}
143```
144
145## 3. Wrap the seal
146
147Encrypt the JSON-encoded `kind 13` event with your ephemeral, single-use random key. Place the result
148in the `content` field of a `kind 1059`. Add a single `p` tag containing the recipient's public key.
149Sign the `gift wrap` using the random key generated in the previous step.
150
151```json
152{
153 "content": "AhC3Qj/QsKJFWuf6xroiYip+2yK95qPwJjVvFujhzSguJWb/6TlPpBW0CGFwfufCs2Zyb0JeuLmZhNlnqecAAalC4ZCugB+I9ViA5pxLyFfQjs1lcE6KdX3euCHBLAnE9GL/+IzdV9vZnfJH6atVjvBkNPNzxU+OLCHO/DAPmzmMVx0SR63frRTCz6Cuth40D+VzluKu1/Fg2Q1LSst65DE7o2efTtZ4Z9j15rQAOZfE9jwMCQZt27rBBK3yVwqVEriFpg2mHXc1DDwHhDADO8eiyOTWF1ghDds/DxhMcjkIi/o+FS3gG1dG7gJHu3KkGK5UXpmgyFKt+421m5o++RMD/BylS3iazS1S93IzTLeGfMCk+7IKxuSCO06k1+DaasJJe8RE4/rmismUvwrHu/HDutZWkvOAhd4z4khZo7bJLtiCzZCZ74lZcjOB4CYtuAX2ZGpc4I1iOKkvwTuQy9BWYpkzGg3ZoSWRD6ty7U+KN+fTTmIS4CelhBTT15QVqD02JxfLF7nA6sg3UlYgtiGw61oH68lSbx16P3vwSeQQpEB5JbhofW7t9TLZIbIW/ODnI4hpwj8didtk7IMBI3Ra3uUP7ya6vptkd9TwQkd/7cOFaSJmU+BIsLpOXbirJACMn+URoDXhuEtiO6xirNtrPN8jYqpwvMUm5lMMVzGT3kMMVNBqgbj8Ln8VmqouK0DR+gRyNb8fHT0BFPwsHxDskFk5yhe5c/2VUUoKCGe0kfCcX/EsHbJLUUtlHXmTqaOJpmQnW1tZ/siPwKRl6oEsIJWTUYxPQmrM2fUpYZCuAo/29lTLHiHMlTbarFOd6J/ybIbICy2gRRH/LFSryty3Cnf6aae+A9uizFBUdCwTwffc3vCBae802+R92OL78bbqHKPbSZOXNC+6ybqziezwG+OPWHx1Qk39RYaF0aFsM4uZWrFic97WwVrH5i+/Nsf/OtwWiuH0gV/SqvN1hnkxCTF/+XNn/laWKmS3e7wFzBsG8+qwqwmO9aVbDVMhOmeUXRMkxcj4QreQkHxLkCx97euZpC7xhvYnCHarHTDeD6nVK+xzbPNtzeGzNpYoiMqxZ9bBJwMaHnEoI944Vxoodf51cMIIwpTmmRvAzI1QgrfnOLOUS7uUjQ/IZ1Qa3lY08Nqm9MAGxZ2Ou6R0/Z5z30ha/Q71q6meAs3uHQcpSuRaQeV29IASmye2A2Nif+lmbhV7w8hjFYoaLCRsdchiVyNjOEM4VmxUhX4VEvw6KoCAZ/XvO2eBF/SyNU3Of4SO",
154 "kind": 1059,
155 "created_at": 1703021488,
156 "pubkey": "18b1a75918f1f2c90c23da616bce317d36e348bcf5f7ba55e75949319210c87c",
157 "id": "5c005f3ccf01950aa8d131203248544fb1e41a0d698e846bd419cec3890903ac",
158 "sig": "35fabdae4634eb630880a1896a886e40fd6ea8a60958e30b89b33a93e6235df750097b04f9e13053764251b8bc5dd7e8e0794a3426a90b6bcc7e5ff660f54259",
159 "tags": [["p", "166bf3765ebd1fc55decfe395beff2ea3b2a4e0a8946e7eb578512b555737c99"]],
160}
161```
162
163## 4. Broadcast Selectively
164
165Broadcast the `kind 1059` event to the recipient's relays only. Delete all the other events.
166
167# Code Samples
168
169## JavaScript
170
171```javascript
172import {bytesToHex} from "@noble/hashes/utils"
173import type {EventTemplate, UnsignedEvent, Event} from "nostr-tools"
174import {getPublicKey, getEventHash, nip19, nip44, finalizeEvent, generateSecretKey} from "nostr-tools"
175
176type Rumor = UnsignedEvent & {id: string}
177
178const TWO_DAYS = 2 * 24 * 60 * 60
179
180const now = () => Math.round(Date.now() / 1000)
181const randomNow = () => Math.round(now() - (Math.random() * TWO_DAYS))
182
183const nip44ConversationKey = (privateKey: Uint8Array, publicKey: string) =>
184 nip44.v2.utils.getConversationKey(bytesToHex(privateKey), publicKey)
185
186const nip44Encrypt = (data: EventTemplate, privateKey: Uint8Array, publicKey: string) =>
187 nip44.v2.encrypt(JSON.stringify(data), nip44ConversationKey(privateKey, publicKey))
188
189const nip44Decrypt = (data: Event, privateKey: Uint8Array) =>
190 JSON.parse(nip44.v2.decrypt(data.content, nip44ConversationKey(privateKey, data.pubkey)))
191
192const createRumor = (event: Partial<UnsignedEvent>, privateKey: Uint8Array) => {
193 const rumor = {
194 created_at: now(),
195 content: "",
196 tags: [],
197 ...event,
198 pubkey: getPublicKey(privateKey),
199 } as any
200
201 rumor.id = getEventHash(rumor)
202
203 return rumor as Rumor
204}
205
206const createSeal = (rumor: Rumor, privateKey: Uint8Array, recipientPublicKey: string) => {
207 return finalizeEvent(
208 {
209 kind: 13,
210 content: nip44Encrypt(rumor, privateKey, recipientPublicKey),
211 created_at: randomNow(),
212 tags: [],
213 },
214 privateKey
215 ) as Event
216}
217
218const createWrap = (event: Event, recipientPublicKey: string) => {
219 const randomKey = generateSecretKey()
220
221 return finalizeEvent(
222 {
223 kind: 1059,
224 content: nip44Encrypt(event, randomKey, recipientPublicKey),
225 created_at: randomNow(),
226 tags: [["p", recipientPublicKey]],
227 },
228 randomKey
229 ) as Event
230}
231
232// Test case using the above example
233const senderPrivateKey = nip19.decode(`nsec1p0ht6p3wepe47sjrgesyn4m50m6avk2waqudu9rl324cg2c4ufesyp6rdg`).data
234const recipientPrivateKey = nip19.decode(`nsec1uyyrnx7cgfp40fcskcr2urqnzekc20fj0er6de0q8qvhx34ahazsvs9p36`).data
235const recipientPublicKey = getPublicKey(recipientPrivateKey)
236
237const rumor = createRumor(
238 {
239 kind: 1,
240 content: "Are you going to the party tonight?",
241 },
242 senderPrivateKey
243)
244
245const seal = createSeal(rumor, senderPrivateKey, recipientPublicKey)
246const wrap = createWrap(seal, recipientPublicKey)
247
248// Recipient unwraps with his/her private key.
249
250const unwrappedSeal = nip44Decrypt(wrap, recipientPrivateKey)
251const unsealedRumor = nip44Decrypt(unwrappedSeal, recipientPrivateKey)
252```
diff --git a/65.md b/65.md
index 4a6f5a1..1a2d7e8 100644
--- a/65.md
+++ b/65.md
@@ -19,7 +19,7 @@ The `.content` is not used.
19 ["r", "wss://alicerelay.example.com"], 19 ["r", "wss://alicerelay.example.com"],
20 ["r", "wss://brando-relay.com"], 20 ["r", "wss://brando-relay.com"],
21 ["r", "wss://expensive-relay.example2.com", "write"], 21 ["r", "wss://expensive-relay.example2.com", "write"],
22 ["r", "wss://nostr-relay.example.com", "read"], 22 ["r", "wss://nostr-relay.example.com", "read"]
23 ], 23 ],
24 "content": "", 24 "content": "",
25 ...other fields 25 ...other fields
diff --git a/72.md b/72.md
index c0fffff..5a8be0a 100644
--- a/72.md
+++ b/72.md
@@ -12,7 +12,7 @@ The goal of this NIP is to create moderator-approved public communities around a
12 12
13`kind:34550` SHOULD include any field that helps define the community and the set of moderators. `relay` tags MAY be used to describe the preferred relay to download requests and approvals. 13`kind:34550` SHOULD include any field that helps define the community and the set of moderators. `relay` tags MAY be used to describe the preferred relay to download requests and approvals.
14 14
15```json 15```jsonc
16{ 16{
17 "created_at": <Unix timestamp in seconds>, 17 "created_at": <Unix timestamp in seconds>,
18 "kind": 34550, 18 "kind": 34550,
@@ -42,14 +42,14 @@ The goal of this NIP is to create moderator-approved public communities around a
42 42
43Any Nostr event can be submitted to a community by anyone for approval. Clients MUST add the community's `a` tag to the new post event in order to be presented for the moderator's approval. 43Any Nostr event can be submitted to a community by anyone for approval. Clients MUST add the community's `a` tag to the new post event in order to be presented for the moderator's approval.
44 44
45```json 45```jsonc
46{ 46{
47 "kind": 1, 47 "kind": 1,
48 "tags": [ 48 "tags": [
49 ["a", "34550:<community event author pubkey>:<community-d-identifier>", "<optional-relay-url>"], 49 ["a", "34550:<community event author pubkey>:<community-d-identifier>", "<optional-relay-url>"],
50 ], 50 ],
51 "content": "hello world", 51 "content": "hello world",
52 ... 52 // ...
53} 53}
54``` 54```
55 55
@@ -59,7 +59,7 @@ Community management clients MAY filter all mentions to a given `kind:34550` eve
59 59
60The post-approval event MUST include `a` tags of the communities the moderator is posting into (one or more), the `e` tag of the post and `p` tag of the author of the post (for approval notifications). The event SHOULD also include the stringified `post request` event inside the `.content` ([NIP-18-style](18.md)) and a `k` tag with the original post's event kind to allow filtering of approved posts by kind. 60The post-approval event MUST include `a` tags of the communities the moderator is posting into (one or more), the `e` tag of the post and `p` tag of the author of the post (for approval notifications). The event SHOULD also include the stringified `post request` event inside the `.content` ([NIP-18-style](18.md)) and a `k` tag with the original post's event kind to allow filtering of approved posts by kind.
61 61
62```json 62```jsonc
63{ 63{
64 "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", 64 "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>",
65 "kind": 4550, 65 "kind": 4550,
@@ -70,13 +70,13 @@ The post-approval event MUST include `a` tags of the communities the moderator i
70 ["k", "<post-request-kind>"] 70 ["k", "<post-request-kind>"]
71 ], 71 ],
72 "content": "<the full approved event, JSON-encoded>", 72 "content": "<the full approved event, JSON-encoded>",
73 ... 73 // ...
74} 74}
75``` 75```
76 76
77It's recommended that multiple moderators approve posts to avoid deleting them from the community when a moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copy and re-sign of each moderator's approval events to make sure posts don't disappear with moderators. 77It's recommended that multiple moderators approve posts to avoid deleting them from the community when a moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copy and re-sign of each moderator's approval events to make sure posts don't disappear with moderators.
78 78
79Post Approvals of replaceable events can be created in three ways: (i) by tagging the replaceable event as an `e` tag if moderators want to approve each individual change to the repleceable event; (ii) by tagging the replaceable event as an `a` tag if the moderator authorizes the replaceable event author to make changes without additional approvals and (iii) by tagging the replaceable event with both its `e` and `a` tag which empowers clients to display the original and updated versions of the event, with appropriate remarks in the UI. Since relays are instructed to delete old versions of a replaceable event, the `.content` of an `e`-approval MUST have the specific version of the event or Clients might not be able to find that version of the content anywhere. 79Post Approvals of replaceable events can be created in three ways: (i) by tagging the replaceable event as an `e` tag if moderators want to approve each individual change to the replaceable event; (ii) by tagging the replaceable event as an `a` tag if the moderator authorizes the replaceable event author to make changes without additional approvals and (iii) by tagging the replaceable event with both its `e` and `a` tag which empowers clients to display the original and updated versions of the event, with appropriate remarks in the UI. Since relays are instructed to delete old versions of a replaceable event, the `.content` of an `e`-approval MUST have the specific version of the event or Clients might not be able to find that version of the content anywhere.
80 80
81Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be included in all `34550:*` `a` tags. 81Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be included in all `34550:*` `a` tags.
82 82
diff --git a/90.md b/90.md
index 241eb38..5a15ebb 100644
--- a/90.md
+++ b/90.md
@@ -162,8 +162,8 @@ Service providers can give feedback about a job back to the customer.
162``` 162```
163 163
164* `content`: Either empty or a job-result (e.g. for partial-result samples) 164* `content`: Either empty or a job-result (e.g. for partial-result samples)
165* `amount` tag: as defined in the [Job Result](#job-result) section. 165* `amount` tag: as defined in the [Job Result](#job-result-kind6000-6999) section.
166* `status` tag: Service Providers SHOULD indicate what this feedback status refers to. [Appendix 1](#appendix-1-job-feedback-status) defines status. Extra human-readable information can be added as an extra argument. 166* `status` tag: Service Providers SHOULD indicate what this feedback status refers to. [Job Feedback Status](#job-feedback-status) defines status. Extra human-readable information can be added as an extra argument.
167 167
168* NOTE: If the input params requires input to be encrypted, then `content` field will have encrypted payload with `p` tag as key. 168* NOTE: If the input params requires input to be encrypted, then `content` field will have encrypted payload with `p` tag as key.
169 169
@@ -177,7 +177,7 @@ Service providers can give feedback about a job back to the customer.
177| `success` | Service Provider successfully processed the job. | 177| `success` | Service Provider successfully processed the job. |
178| `partial` | Service Provider partially processed the job. The `.content` might include a sample of the partial results. | 178| `partial` | Service Provider partially processed the job. The `.content` might include a sample of the partial results. |
179 179
180Any job feedback event MIGHT include results in the `.content` field, as described in the [Job Result](#job-result) section. This is useful for service providers to provide a sample of the results that have been processed so far. 180Any job feedback event MIGHT include results in the `.content` field, as described in the [Job Result](#job-result-kind6000-6999) section. This is useful for service providers to provide a sample of the results that have been processed so far.
181 181
182 182
183# Protocol Flow 183# Protocol Flow
@@ -199,7 +199,7 @@ Some service providers might choose to submit a `payment-required` as the first
199It's not up to this NIP to define how individual vending machines should choose to run their business. 199It's not up to this NIP to define how individual vending machines should choose to run their business.
200 200
201# Cancellation 201# Cancellation
202A job request might be cancelled by publishing a `kind:5` delete request event tagging the job request event. 202A job request might be canceled by publishing a `kind:5` delete request event tagging the job request event.
203 203
204# Appendix 1: Job chaining 204# Appendix 1: Job chaining
205A Customer MAY request multiple jobs to be processed as a chain, where the output of a job is the input of another job. (e.g. podcast transcription -> summarization of the transcription). This is done by specifying as input an event id of a different job with the `job` type. 205A Customer MAY request multiple jobs to be processed as a chain, where the output of a job is the input of another job. (e.g. podcast transcription -> summarization of the transcription). This is done by specifying as input an event id of a different job with the `job` type.
diff --git a/92.md b/92.md
new file mode 100644
index 0000000..b332d21
--- /dev/null
+++ b/92.md
@@ -0,0 +1,45 @@
1NIP-92
2======
3
4Media Attachments
5-----------------
6
7Media attachments (images, videos, and other files) may be added to events by including a URL in the event content, along with a matching `imeta` tag.
8
9`imeta` ("inline metadata") tags add information about media URLs in the event's content. Each `imeta` tag SHOULD match a URL in the event content. Clients may replace imeta URLs with rich previews.
10
11The `imeta` tag is variadic, and each entry is a space-delimited key/value pair.
12Each `imeta` tag MUST have a `url`, and at least one other field. `imeta` may include
13any field specified by [NIP 94](./94.md). There SHOULD be only one `imeta` tag per URL.
14
15## Example
16
17```json
18{
19 "content": "More image metadata tests don’t mind me https://nostr.build/i/my-image.jpg",
20 "kind": 1,
21 "tags": [
22 [
23 "imeta",
24 "url https://nostr.build/i/my-image.jpg",
25 "m image/jpeg",
26 "blurhash eVF$^OI:${M{o#*0-nNFxakD-?xVM}WEWB%iNKxvR-oetmo#R-aen$",
27 "dim 3024x4032",
28 "alt A scenic photo overlooking the coast of Costa Rica",
29 "x <sha256 hash as specified in NIP 94>",
30 "fallback https://nostrcheck.me/alt1.jpg",
31 "fallback https://void.cat/alt1.jpg"
32 ]
33 ]
34}
35```
36
37## Recommended client behavior
38
39When uploading files during a new post, clients MAY include this metadata
40after the file is uploaded and included in the post.
41
42When pasting URLs during post composition, the client MAY download the file
43and add this metadata before the post is sent.
44
45The client MAY ignore `imeta` tags that do not match the URL in the event content.
diff --git a/94.md b/94.md
index 95b6a3b..e35dfa1 100644
--- a/94.md
+++ b/94.md
@@ -6,7 +6,7 @@ File Metadata
6 6
7`draft` `optional` 7`draft` `optional`
8 8
9The purpose of this NIP is to allow an organization and classification of shared files. So that relays can filter and organize in any way that is of interest. With that, multiple types of filesharing clients can be created. NIP-94 support is not expected to be implemented by "social" clients that deal with kind:1 notes or by longform clients that deal with kind:30023 articles. 9The purpose of this NIP is to allow an organization and classification of shared files. So that relays can filter and organize in any way that is of interest. With that, multiple types of filesharing clients can be created. NIP-94 support is not expected to be implemented by "social" clients that deal with `kind:1` notes or by longform clients that deal with `kind:30023` articles.
10 10
11## Event format 11## Event format
12 12
@@ -14,8 +14,8 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr
14 14
15* `url` the url to download the file 15* `url` the url to download the file
16* `m` a string indicating the data type of the file. The [MIME types](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) format must be used, and they should be lowercase. 16* `m` a string indicating the data type of the file. The [MIME types](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) format must be used, and they should be lowercase.
17* `"aes-256-gcm"` (optional) key and nonce for AES-GCM encryption with tagSize always 128bits
18* `x` containing the SHA-256 hexencoded string of the file. 17* `x` containing the SHA-256 hexencoded string of the file.
18* `ox` containing the SHA-256 hexencoded string of the original file, before any transformations done by the upload server
19* `size` (optional) size of file in bytes 19* `size` (optional) size of file in bytes
20* `dim` (optional) size of file in pixels in the form `<width>x<height>` 20* `dim` (optional) size of file in pixels in the form `<width>x<height>`
21* `magnet` (optional) URI to magnet file 21* `magnet` (optional) URI to magnet file
@@ -25,15 +25,16 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr
25* `image` (optional) url of preview image with same dimensions 25* `image` (optional) url of preview image with same dimensions
26* `summary` (optional) text excerpt 26* `summary` (optional) text excerpt
27* `alt` (optional) description for accessibility 27* `alt` (optional) description for accessibility
28* `fallback` (optional) zero or more fallback file sources in case `url` fails
28 29
29```json 30```json
30{ 31{
31 "kind": 1063, 32 "kind": 1063,
32 "tags": [ 33 "tags": [
33 ["url",<string with URI of file>], 34 ["url",<string with URI of file>],
34 ["aes-256-gcm",<key>, <iv>],
35 ["m", <MIME type>], 35 ["m", <MIME type>],
36 ["x",<Hash SHA-256>], 36 ["x",<Hash SHA-256>],
37 ["ox",<Hash SHA-256>],
37 ["size", <size of file in bytes>], 38 ["size", <size of file in bytes>],
38 ["dim", <size of file in pixels>], 39 ["dim", <size of file in pixels>],
39 ["magnet",<magnet URI> ], 40 ["magnet",<magnet URI> ],
diff --git a/96.md b/96.md
new file mode 100644
index 0000000..f7d901f
--- /dev/null
+++ b/96.md
@@ -0,0 +1,295 @@
1NIP-96
2======
3
4HTTP File Storage Integration
5-----------------------------
6
7`draft` `optional`
8
9## Introduction
10
11This NIP defines a REST API for HTTP file storage servers intended to be used in conjunction with the nostr network.
12The API will enable nostr users to upload files and later reference them by url on nostr notes.
13
14The spec DOES NOT use regular nostr events through websockets for
15storing, requesting nor retrieving data because, for simplicity, the server
16will not have to learn anything about nostr relays.
17
18## Server Adaptation
19
20File storage servers wishing to be accessible by nostr users should opt-in by making available an https route at `/.well-known/nostr/nip96.json` with `api_url`:
21
22```js
23{
24 // Required
25 // File upload and deletion are served from this url
26 // Also downloads if "download_url" field is absent or empty string
27 "api_url": "https://your-file-server.example/custom-api-path",
28 // Optional
29 // If absent, downloads are served from the api_url
30 "download_url": "https://a-cdn.example/a-path",
31 // Optional
32 // Note: This field is not meant to be set by HTTP Servers.
33 // Use this if you are a nostr relay using your /.well-known/nostr/nip96.json
34 // just to redirect to someone else's http file storage server's /.well-known/nostr/nip96.json
35 // In this case, "api_url" field must be an empty string
36 "delegated_to_url": "https://your-file-server.example",
37 // Optional
38 "supported_nips": [60],
39 // Optional
40 "tos_url": "https://your-file-server.example/terms-of-service",
41 // Optional
42 "content_types": ["image/jpeg", "video/webm", "audio/*"],
43 // Optional
44 "plans": {
45 // "free" is the only standardized plan key and
46 // clients may use its presence to learn if server offers free storage
47 "free": {
48 "name": "Free Tier",
49 // Default is true
50 // All plans MUST support NIP-98 uploads
51 // but some plans may also allow uploads without it
52 "is_nip98_required": true,
53 "url": "https://...", // plan's landing page if there is one
54 "max_byte_size": 10485760,
55 // Range in days / 0 for no expiration
56 // [7, 0] means it may vary from 7 days to unlimited persistence,
57 // [0, 0] means it has no expiration
58 // early expiration may be due to low traffic or any other factor
59 "file_expiration": [14, 90],
60 "media_transformations": {
61 "image": [
62 'resizing'
63 ]
64 }
65 }
66 }
67}
68```
69
70### Relay Hints
71
72Note: This section is not meant to be used by HTTP Servers.
73
74A nostr relay MAY redirect to someone else's HTTP file storage server by
75adding a `/.well-known/nostr/nip96.json` with "delegated_to_url" field
76pointing to the url where the server hosts its own
77`/.well-known/nostr/nip96.json`. In this case, the "api_url" field must
78be an empty string and all other fields must be absent.
79
80If the nostr relay is also an HTTP file storage server,
81it must use the "api_url" field instead.
82
83### List of Supporting File Storage Servers
84
85See https://github.com/aljazceru/awesome-nostr#nip-96-file-storage-servers.
86
87## Upload
88
89A file can be uploaded one at a time to `https://your-file-server.example/custom-api-path` (route from `https://your-file-server.example/.well-known/nostr/nip96.json` "api_url" field) as `multipart/form-data` content type using `POST` method with the file object set to the `file` form data field.
90
91`Clients` must add an [NIP-98](98.md) `Authorization` header (**optionally** with the encoded `payload` tag set to the base64-encoded 256-bit SHA-256 hash of the file - not the hash of the whole request body).
92If using an html form, use an `Authorization` form data field instead.
93
94These following **optional** form data fields MAY be used by `servers` and SHOULD be sent by `clients`:
95- `expiration`: string of the UNIX timestamp in seconds. Empty string if file should be stored forever. The server isn't required to honor this;
96- `size`: string of the file byte size. This is just a value the server can use to reject early if the file size exceeds the server limits;
97- `alt`: (recommended) strict description text for visibility-impaired users;
98- `caption`: loose description;
99- `media_type`: "avatar" or "banner". Informs the server if the file will be used as an avatar or banner. If absent, the server will interpret it as a normal upload, without special treatment;
100- `content_type`: mime type such as "image/jpeg". This is just a value the server can use to reject early if the mime type isn't supported.
101
102
103Others custom form data fields may be used depending on specific `server` support.
104The `server` isn't required to store any metadata sent by `clients`.
105
106Note for `clients`: if using an HTML form, it is important for the `file` form field to be the **last** one, or be re-ordered right before sending or be appended as the last field of XHR2's FormData object.
107
108The `filename` embedded in the file may not be honored by the `server`, which could internally store just the SHA-256 hash value as the file name, ignoring extra metadata.
109The hash is enough to uniquely identify a file, that's why it will be used on the "download" and "delete" routes.
110
111The `server` MUST link the user's `pubkey` string (which is embedded in the decoded header value) as the owner of the file so to later allow them to delete the file.
112Note that if a file with the same hash of a previously received file (so the same file) is uploaded by another user, the server doesn't need to store the new file.
113It should just add the new user's `pubkey` to the list of the owners of the already stored file with said hash (if it wants to save space by keeping just one copy of the same file, because multiple uploads of the same file results in the same file hash).
114
115The `server` MAY also store the `Authorization` header/field value (decoded or not) for accountability purpose as this proves that the user with the unique pubkey did ask for the upload of the file with a specific hash. However, storing the pubkey is sufficient to establish ownership.
116
117The `server` MUST reject with 413 Payload Too Large if file size exceeds limits.
118
119The `server` MUST reject with 400 Bad Request status if some fields are invalid.
120
121The `server` MUST reply to the upload with 200 OK status if the `payload` tag value contains an already used SHA-256 hash (if file is already owned by the same pubkey) or reject the upload with 403 Forbidden status if it isn't the same of the received file.
122
123The `server` MAY reject the upload with 402 Payment Required status if the user has a pending payment (Payment flow is not strictly required. Server owners decide if the storage is free or not. Monetization schemes may be added later to correlated NIPs.).
124
125On successful uploads the `server` MUST reply with **201 Created** HTTP status code or **202 Accepted** if a `processing_url` field is added
126to the response so that the `client` can follow the processing status (see [Delayed Processing](#delayed-processing) section).
127
128The upload response is a json object as follows:
129
130```js
131{
132 // "success" if successful or "error" if not
133 status: "success",
134 // Free text success, failure or info message
135 message: "Upload successful.",
136 // Optional. See "Delayed Processing" section
137 processing_url: "...",
138 // This uses the NIP-94 event format but DO NOT need
139 // to fill some fields like "id", "pubkey", "created_at" and "sig"
140 //
141 // This holds the download url ("url"),
142 // the ORIGINAL file hash before server transformations ("ox")
143 // and, optionally, all file metadata the server wants to make available
144 //
145 // nip94_event field is absent if unsuccessful upload
146 nip94_event: {
147 // Required tags: "url" and "ox"
148 tags: [
149 // Can be same from /.well-known/nostr/nip96.json's "download_url" field
150 // (or "api_url" field if "download_url" is absent or empty) with appended
151 // original file hash.
152 //
153 // Note we appended .png file extension to the `ox` value
154 // (it is optional but extremely recommended to add the extension as it will help nostr clients
155 // with detecting the file type by using regular expression)
156 //
157 // Could also be any url to download the file
158 // (using or not using the /.well-known/nostr/nip96.json's "download_url" prefix),
159 // for load balancing purposes for example.
160 ["url", "https://your-file-server.example/custom-api-path/719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b.png"],
161 // SHA-256 hash of the ORIGINAL file, before transformations.
162 // The server MUST store it even though it represents the ORIGINAL file because
163 // users may try to download/delete the transformed file using this value
164 ["ox", "719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b"],
165 // Optional. SHA-256 hash of the saved file after any server transformations.
166 // The server can but does not need to store this value.
167 ["x", "543244319525d9d08dd69cb716a18158a249b7b3b3ec4bbde5435543acb34443"],
168 // Optional. Recommended for helping clients to easily know file type before downloading it.
169 ["m", "image/png"]
170 // Optional. Recommended for helping clients to reserve an adequate UI space to show the file before downloading it.
171 ["dim", "800x600"]
172 // ... other optional NIP-94 tags
173 ],
174 content: ""
175 },
176 // ... other custom fields (please consider adding them to this NIP or to NIP-94 tags)
177}
178```
179
180Note that if the server didn't apply any transformation to the received file, both `nip94_event.tags.*.ox` and `nip94_event.tags.*.x` fields will have the same value. The server MUST link the saved file to the SHA-256 hash of the **original** file before any server transformations (the `nip94_event.tags.*.ox` tag value). The **original** file's SHA-256 hash will be used to identify the saved file when downloading or deleting it.
181
182`Clients` may upload the same file to one or many `servers`.
183After successful upload, the `client` may optionally generate and send to any set of nostr `relays` a [NIP-94](94.md) event by including the missing fields.
184
185Alternatively, instead of using NIP-94, the `client` can share or embed on a nostr note just the above url.
186
187### Delayed Processing
188
189Sometimes the server may want to place the uploaded file in a processing queue for deferred file processing.
190
191In that case, the server MUST serve the original file while the processing isn't done, then swap the original file for the processed one when the processing is over. The upload response is the same as usual but some optional metadata like `nip94_event.tags.*.x` and `nip94_event.tags.*.size` won't be available.
192
193The expected resulting metadata that is known in advance should be returned on the response.
194For example, if the file processing would change a file from "jpg" to "webp",
195use ".webp" extension on the `nip94_event.tags.*.url` field value and set "image/webp" to the `nip94_event.tags.*.m` field.
196If some metadata are unknown before processing ends, omit them from the response.
197
198The upload response MAY include a `processing_url` field informing a temporary url that may be used by clients to check if
199the file processing is done.
200
201If the processing isn't done, the server should reply at the `processing_url` url with **200 OK** and the following JSON:
202
203```
204{
205 // It should be "processing". If "error" it would mean the processing failed.
206 status: "processing",
207 message: "Processing. Please check again later for updated status.",
208 percentage: 15 // Processing percentage. An integer between 0 and 100.
209}
210```
211
212When the processing is over, the server replies at the `processing_url` url with **201 Created** status and a regular successful JSON response already mentioned before (now **without** a `processing_url` field), possibly including optional metadata at `nip94_event.tags.*` fields
213that weren't available before processing.
214
215### File compression
216
217File compression and other transformations like metadata stripping can be applied by the server.
218However, for all file actions, such as download and deletion, the **original** file SHA-256 hash is what identifies the file in the url string.
219
220## Download
221
222`Servers` must make available the route `https://your-file-server.example/custom-api-path/<sha256-file-hash>(.ext)` (route taken from `https://your-file-server.example/.well-known/nostr/nip96.json` "api_url" or "download_url" field) with `GET` method for file download.
223
224The primary file download url informed at the upload's response field `nip94_event.tags.*.url`
225can be that or not (it can be any non-standard url the server wants).
226If not, the server still MUST also respond to downloads at the standard url
227mentioned on the previous paragraph, to make it possible for a client
228to try downloading a file on any NIP-96 compatible server by knowing just the SHA-256 file hash.
229
230Note that the "\<sha256-file-hash\>" part is from the **original** file, **not** from the **transformed** file if the uploaded file went through any server transformation.
231
232Supporting ".ext", meaning "file extension", is required for `servers`. It is optional, although recommended, for `clients` to append it to the path.
233When present it may be used by `servers` to know which `Content-Type` header to send (e.g.: "Content-Type": "image/png" for ".png" extension).
234The file extension may be absent because the hash is the only needed string to uniquely identify a file.
235
236Example: `https://your-file-server.example/custom-api-path/719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b.png`
237
238### Media Transformations
239
240`Servers` may respond to some media transformation query parameters and ignore those they don't support by serving
241the original media file without transformations.
242
243#### Image Transformations
244
245##### Resizing
246
247Upon upload, `servers` may create resized image variants, such as thumbnails, respecting the original aspect ratio.
248`Clients` may use the `w` query parameter to request an image version with the desired pixel width.
249`Servers` can then serve the variant with the closest width to the parameter value
250or an image variant generated on the fly.
251
252Example: `https://your-file-server.example/custom-api-path/<sha256-file-hash>.png?w=32`
253
254## Deletion
255
256`Servers` must make available the route `https://deletion.domain/deletion-path/<sha256-file-hash>(.ext)` (route taken from `https://your-file-server.example/.well-known/nostr/nip96.json` "api_url" field) with `DELETE` method for file deletion.
257
258Note that the "\<sha256-file-hash\>" part is from the **original** file, **not** from the **transformed** file if the uploaded file went through any server transformation.
259
260The extension is optional as the file hash is the only needed file identification.
261
262`Clients` should send a `DELETE` request to the server deletion route in the above format. It must include a NIP-98 `Authorization` header.
263
264The `server` should reject deletes from users other than the original uploader. The `pubkey` encoded on the header value identifies the user.
265
266It should be noted that more than one user may have uploaded the same file (with the same hash). In this case, a delete must not really delete the file but just remove the user's `pubkey` from the file owners list (considering the server keeps just one copy of the same file, because multiple uploads of the same file results
267in the same file hash).
268
269The successful response is a 200 OK one with just basic JSON fields:
270
271```
272{
273 status: "success",
274 message: "File deleted."
275}
276```
277
278## Selecting a Server
279
280Note: HTTP File Storage Server developers may skip this section. This is meant for client developers.
281
282A File Server Preference event is a kind 10096 replaceable event meant to select one or more servers the user wants
283to upload files to. Servers are listed as `server` tags:
284
285```js
286{
287 // ...
288 "kind": 10096,
289 "content": "",
290 "tags": [
291 ["server", "https://file.server.one"],
292 ["server", "https://file.server.two"]
293 ]
294}
295```
diff --git a/99.md b/99.md
index e65920c..93550d8 100644
--- a/99.md
+++ b/99.md
@@ -40,6 +40,7 @@ The following tags, used for structured metadata, are standardized and SHOULD be
40 - `"<number>"` is the amount in numeric format (but included in the tag as a string) 40 - `"<number>"` is the amount in numeric format (but included in the tag as a string)
41 - `"<currency>"` is the currency unit in 3-character ISO 4217 format or ISO 4217-like currency code (e.g. `"btc"`, `"eth"`). 41 - `"<currency>"` is the currency unit in 3-character ISO 4217 format or ISO 4217-like currency code (e.g. `"btc"`, `"eth"`).
42 - `"<frequency>"` is optional and can be used to describe recurring payments. SHOULD be in noun format (hour, day, week, month, year, etc.) 42 - `"<frequency>"` is optional and can be used to describe recurring payments. SHOULD be in noun format (hour, day, week, month, year, etc.)
43- - `"status"` (optional), the status of the listing. SHOULD be either "active" or "sold".
43 44
44#### `price` examples 45#### `price` examples
45 46
diff --git a/BREAKING.md b/BREAKING.md
new file mode 100644
index 0000000..7b48ee0
--- /dev/null
+++ b/BREAKING.md
@@ -0,0 +1,48 @@
1# Breaking Changes
2
3This is a history of NIP changes that potentially break pre-existing implementations, in
4reverse chronological order.
5
6| Date | Commit | NIP | Change |
7| ----------- | --------- | -------- | ------ |
8| 2024-04-30 | [bad88262](https://github.com/nostr-protocol/nips/commit/bad88262) | [NIP-34](34.md) | 'earliest-unique-commit' tag was removed (use 'r' tag instead) |
9| 2024-02-25 | [4a171cb0](https://github.com/nostr-protocol/nips/commit/4a171cb0) | [NIP-18](18.md) | quote repost should use `q` tag |
10| 2024-02-21 | [c6cd655c](https://github.com/nostr-protocol/nips/commit/c6cd655c) | [NIP-46](46.md) | Params were stringified |
11| 2024-02-16 | [cbec02ab](https://github.com/nostr-protocol/nips/commit/cbec02ab) | [NIP-49](49.md) | Password first normalized to NFKC |
12| 2024-02-15 | [afbb8dd0](https://github.com/nostr-protocol/nips/commit/afbb8dd0) | [NIP-39](39.md) | PGP identity was removed |
13| 2024-02-07 | [d3dad114](https://github.com/nostr-protocol/nips/commit/d3dad114) | [NIP-46](46.md) | Connection token format was changed |
14| 2024-01-30 | [1a2b21b6](https://github.com/nostr-protocol/nips/commit/1a2b21b6) | [NIP-59](59.md) | 'p' tag became optional |
15| 2023-01-27 | [c2f34817](https://github.com/nostr-protocol/nips/commit/c2f34817) | [NIP-47](47.md) | optional expiration tag should be honored |
16| 2024-01-10 | [3d8652ea](https://github.com/nostr-protocol/nips/commit/3d8652ea) | [NIP-02](02.md) | list entries should be chronological |
17| 2024-01-10 | [3d8652ea](https://github.com/nostr-protocol/nips/commit/3d8652ea) | [NIP-51](51.md) | list entries should be chronological |
18| 2023-12-30 | [29869821](https://github.com/nostr-protocol/nips/commit/29869821) | [NIP-52](52.md) | 'name' tag was removed (use 'title' tag instead) |
19| 2023-12-27 | [17c67ef5](https://github.com/nostr-protocol/nips/commit/17c67ef5) | [NIP-94](94.md) | 'aes-256-gcm' tag was removed |
20| 2023-12-03 | [0ba45895](https://github.com/nostr-protocol/nips/commit/0ba45895) | [NIP-01](01.md) | WebSocket status code `4000` was replaced by 'CLOSED' message |
21| 2023-11-28 | [6de35f9e](https://github.com/nostr-protocol/nips/commit/6de35f9e) | [NIP-89](89.md) | 'client' tag value was changed |
22| 2023-11-20 | [7822a8b1](https://github.com/nostr-protocol/nips/commit/7822a8b1) | [NIP-51](51.md) | `kind: 30000` and `kind: 30001` were deprecated |
23| 2023-11-11 | [cbdca1e9](https://github.com/nostr-protocol/nips/commit/cbdca1e9) | [NIP-84](84.md) | 'range' tag was removed |
24| 2023-11-07 | [108b7f16](https://github.com/nostr-protocol/nips/commit/108b7f16) | [NIP-01](01.md) | 'OK' message must have 4 items |
25| 2023-10-17 | [cf672b76](https://github.com/nostr-protocol/nips/commit/cf672b76) | [NIP-03](03.md) | 'block' tag was removed |
26| 2023-09-29 | [7dc6385f](https://github.com/nostr-protocol/nips/commit/7dc6385f) | [NIP-57](57.md) | optional 'a' tag was included in `zap receipt` |
27| 2023-08-21 | [89915e02](https://github.com/nostr-protocol/nips/commit/89915e02) | [NIP-11](11.md) | 'min_prefix' was removed |
28| 2023-08-20 | [37c4375e](https://github.com/nostr-protocol/nips/commit/37c4375e) | [NIP-01](01.md) | replaceable events with same timestamp should be retained event with lowest id |
29| 2023-08-15 | [88ee873c](https://github.com/nostr-protocol/nips/commit/88ee873c) | [NIP-15](15.md) | 'countries' tag was renamed to 'regions' |
30| 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [NIP-12](12.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 |
31| 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [NIP-16](16.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 |
32| 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [NIP-20](20.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 |
33| 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [NIP-33](33.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 |
34| 2023-08-11 | [d87f8617](https://github.com/nostr-protocol/nips/commit/d87f8617) | [NIP-25](25.md) | empty `content` should be considered as "+" |
35| 2023-08-01 | [5d63b157](https://github.com/nostr-protocol/nips/commit/5d63b157) | [NIP-57](57.md) | 'zap' tag was changed |
36| 2023-07-15 | [d1814405](https://github.com/nostr-protocol/nips/commit/d1814405) | [NIP-01](01.md) | `since` and `until` filters should be `since <= created_at <= until` |
37| 2023-07-12 | [a1cd2bd8](https://github.com/nostr-protocol/nips/commit/a1cd2bd8) | [NIP-25](25.md) | custom emoji was supported |
38| 2023-06-18 | [83cbd3e1](https://github.com/nostr-protocol/nips/commit/83cbd3e1) | [NIP-11](11.md) | 'image' was renamed to 'icon' |
39| 2023-04-13 | [bf0a0da6](https://github.com/nostr-protocol/nips/commit/bf0a0da6) | [NIP-15](15.md) | different NIP was re-added as NIP-15 |
40| 2023-04-09 | [fb5b7c73](https://github.com/nostr-protocol/nips/commit/fb5b7c73) | [NIP-15](15.md) | NIP-15 was merged into NIP-01 |
41| 2023-03-15 | [e1004d3d](https://github.com/nostr-protocol/nips/commit/e1004d3d) | [NIP-19](19.md) | `1: relay` was changed to optionally |
42
43Breaking changes prior to 2023-03-01 are not yet documented.
44
45## NOTES
46
47- If it isn't clear that a change is breaking or not, we list it.
48- The date is the date it was merged, not necessarily the date of the commit.
diff --git a/README.md b/README.md
index 1c2f806..3e44b85 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
15- [Criteria for acceptance of NIPs](#criteria-for-acceptance-of-nips) 15- [Criteria for acceptance of NIPs](#criteria-for-acceptance-of-nips)
16- [Is this repository a centralizing factor?](#is-this-repository-a-centralizing-factor) 16- [Is this repository a centralizing factor?](#is-this-repository-a-centralizing-factor)
17- [How this repository works](#how-this-repository-works) 17- [How this repository works](#how-this-repository-works)
18- [Breaking Changes](#breaking-changes)
18- [License](#license) 19- [License](#license)
19 20
20--- 21---
@@ -24,7 +25,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
24- [NIP-01: Basic protocol flow description](01.md) 25- [NIP-01: Basic protocol flow description](01.md)
25- [NIP-02: Follow List](02.md) 26- [NIP-02: Follow List](02.md)
26- [NIP-03: OpenTimestamps Attestations for Events](03.md) 27- [NIP-03: OpenTimestamps Attestations for Events](03.md)
27- [NIP-04: Encrypted Direct Message](04.md) 28- [NIP-04: Encrypted Direct Message](04.md) --- **unrecommended**: deprecated in favor of [NIP-17](17.md)
28- [NIP-05: Mapping Nostr keys to DNS-based internet identifiers](05.md) 29- [NIP-05: Mapping Nostr keys to DNS-based internet identifiers](05.md)
29- [NIP-06: Basic key derivation from mnemonic seed phrase](06.md) 30- [NIP-06: Basic key derivation from mnemonic seed phrase](06.md)
30- [NIP-07: `window.nostr` capability for web browsers](07.md) 31- [NIP-07: `window.nostr` capability for web browsers](07.md)
@@ -35,6 +36,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
35- [NIP-13: Proof of Work](13.md) 36- [NIP-13: Proof of Work](13.md)
36- [NIP-14: Subject tag in text events](14.md) 37- [NIP-14: Subject tag in text events](14.md)
37- [NIP-15: Nostr Marketplace (for resilient marketplaces)](15.md) 38- [NIP-15: Nostr Marketplace (for resilient marketplaces)](15.md)
39- [NIP-17: Private Direct Messages](17.md)
38- [NIP-18: Reposts](18.md) 40- [NIP-18: Reposts](18.md)
39- [NIP-19: bech32-encoded entities](19.md) 41- [NIP-19: bech32-encoded entities](19.md)
40- [NIP-21: `nostr:` URI scheme](21.md) 42- [NIP-21: `nostr:` URI scheme](21.md)
@@ -44,25 +46,31 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
44- [NIP-26: Delegated Event Signing](26.md) 46- [NIP-26: Delegated Event Signing](26.md)
45- [NIP-27: Text Note References](27.md) 47- [NIP-27: Text Note References](27.md)
46- [NIP-28: Public Chat](28.md) 48- [NIP-28: Public Chat](28.md)
49- [NIP-29: Relay-based Groups](29.md)
47- [NIP-30: Custom Emoji](30.md) 50- [NIP-30: Custom Emoji](30.md)
48- [NIP-31: Dealing with Unknown Events](31.md) 51- [NIP-31: Dealing with Unknown Events](31.md)
49- [NIP-32: Labeling](32.md) 52- [NIP-32: Labeling](32.md)
53- [NIP-34: `git` stuff](34.md)
50- [NIP-36: Sensitive Content](36.md) 54- [NIP-36: Sensitive Content](36.md)
51- [NIP-38: User Statuses](38.md) 55- [NIP-38: User Statuses](38.md)
52- [NIP-39: External Identities in Profiles](39.md) 56- [NIP-39: External Identities in Profiles](39.md)
53- [NIP-40: Expiration Timestamp](40.md) 57- [NIP-40: Expiration Timestamp](40.md)
54- [NIP-42: Authentication of clients to relays](42.md) 58- [NIP-42: Authentication of clients to relays](42.md)
59- [NIP-44: Versioned Encryption](44.md)
55- [NIP-45: Counting results](45.md) 60- [NIP-45: Counting results](45.md)
56- [NIP-46: Nostr Connect](46.md) 61- [NIP-46: Nostr Connect](46.md)
57- [NIP-47: Wallet Connect](47.md) 62- [NIP-47: Wallet Connect](47.md)
58- [NIP-48: Proxy Tags](48.md) 63- [NIP-48: Proxy Tags](48.md)
64- [NIP-49: Private Key Encryption](49.md)
59- [NIP-50: Search Capability](50.md) 65- [NIP-50: Search Capability](50.md)
60- [NIP-51: Lists](51.md) 66- [NIP-51: Lists](51.md)
61- [NIP-52: Calendar Events](52.md) 67- [NIP-52: Calendar Events](52.md)
62- [NIP-53: Live Activities](53.md) 68- [NIP-53: Live Activities](53.md)
69- [NIP-54: Wiki](54.md)
63- [NIP-56: Reporting](56.md) 70- [NIP-56: Reporting](56.md)
64- [NIP-57: Lightning Zaps](57.md) 71- [NIP-57: Lightning Zaps](57.md)
65- [NIP-58: Badges](58.md) 72- [NIP-58: Badges](58.md)
73- [NIP-59: Gift Wrap](59.md)
66- [NIP-65: Relay List Metadata](65.md) 74- [NIP-65: Relay List Metadata](65.md)
67- [NIP-71: Video Events](71.md) 75- [NIP-71: Video Events](71.md)
68- [NIP-72: Moderated Communities](72.md) 76- [NIP-72: Moderated Communities](72.md)
@@ -71,31 +79,47 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
71- [NIP-84: Highlights](84.md) 79- [NIP-84: Highlights](84.md)
72- [NIP-89: Recommended Application Handlers](89.md) 80- [NIP-89: Recommended Application Handlers](89.md)
73- [NIP-90: Data Vending Machines](90.md) 81- [NIP-90: Data Vending Machines](90.md)
82- [NIP-92: Media Attachments](92.md)
74- [NIP-94: File Metadata](94.md) 83- [NIP-94: File Metadata](94.md)
84- [NIP-96: HTTP File Storage Integration](96.md)
75- [NIP-98: HTTP Auth](98.md) 85- [NIP-98: HTTP Auth](98.md)
76- [NIP-99: Classified Listings](99.md) 86- [NIP-99: Classified Listings](99.md)
77 87
78## Event Kinds 88## Event Kinds
79| kind | description | NIP | 89| kind | description | NIP |
80| ------------- | -------------------------- | ----------- | 90| ------------- | -------------------------- | ------------------------ |
81| `0` | Metadata | [1](01.md) | 91| `0` | Metadata | [01](01.md) |
82| `1` | Short Text Note | [1](01.md) | 92| `1` | Short Text Note | [01](01.md) |
83| `2` | Recommend Relay | | 93| `2` | Recommend Relay | 01 (deprecated) |
84| `3` | Follows | [2](02.md) | 94| `3` | Follows | [02](02.md) |
85| `4` | Encrypted Direct Messages | [4](04.md) | 95| `4` | Encrypted Direct Messages | [04](04.md) |
86| `5` | Event Deletion | [9](09.md) | 96| `5` | Event Deletion | [09](09.md) |
87| `6` | Repost | [18](18.md) | 97| `6` | Repost | [18](18.md) |
88| `7` | Reaction | [25](25.md) | 98| `7` | Reaction | [25](25.md) |
89| `8` | Badge Award | [58](58.md) | 99| `8` | Badge Award | [58](58.md) |
100| `9` | Group Chat Message | [29](29.md) |
101| `10` | Group Chat Threaded Reply | [29](29.md) |
102| `11` | Group Thread | [29](29.md) |
103| `12` | Group Thread Reply | [29](29.md) |
104| `13` | Seal | [59](59.md) |
105| `14` | Direct Message | [17](17.md) |
90| `16` | Generic Repost | [18](18.md) | 106| `16` | Generic Repost | [18](18.md) |
91| `40` | Channel Creation | [28](28.md) | 107| `40` | Channel Creation | [28](28.md) |
92| `41` | Channel Metadata | [28](28.md) | 108| `41` | Channel Metadata | [28](28.md) |
93| `42` | Channel Message | [28](28.md) | 109| `42` | Channel Message | [28](28.md) |
94| `43` | Channel Hide Message | [28](28.md) | 110| `43` | Channel Hide Message | [28](28.md) |
95| `44` | Channel Mute User | [28](28.md) | 111| `44` | Channel Mute User | [28](28.md) |
112| `818` | Merge Requests | [54](54.md) |
113| `1021` | Bid | [15](15.md) |
114| `1022` | Bid confirmation | [15](15.md) |
96| `1040` | OpenTimestamps | [03](03.md) | 115| `1040` | OpenTimestamps | [03](03.md) |
116| `1059` | Gift Wrap | [59](59.md) |
97| `1063` | File Metadata | [94](94.md) | 117| `1063` | File Metadata | [94](94.md) |
98| `1311` | Live Chat Message | [53](53.md) | 118| `1311` | Live Chat Message | [53](53.md) |
119| `1617` | Patches | [34](34.md) |
120| `1621` | Issues | [34](34.md) |
121| `1622` | Replies | [34](34.md) |
122| `1630`-`1633` | Status | [34](34.md) |
99| `1971` | Problem Tracker | [nostrocket][nostrocket] | 123| `1971` | Problem Tracker | [nostrocket][nostrocket] |
100| `1984` | Reporting | [56](56.md) | 124| `1984` | Reporting | [56](56.md) |
101| `1985` | Label | [32](32.md) | 125| `1985` | Label | [32](32.md) |
@@ -103,6 +127,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
103| `5000`-`5999` | Job Request | [90](90.md) | 127| `5000`-`5999` | Job Request | [90](90.md) |
104| `6000`-`6999` | Job Result | [90](90.md) | 128| `6000`-`6999` | Job Result | [90](90.md) |
105| `7000` | Job Feedback | [90](90.md) | 129| `7000` | Job Feedback | [90](90.md) |
130| `9000`-`9030` | Group Control Events | [29](29.md) |
106| `9041` | Zap Goal | [75](75.md) | 131| `9041` | Zap Goal | [75](75.md) |
107| `9734` | Zap Request | [57](57.md) | 132| `9734` | Zap Request | [57](57.md) |
108| `9735` | Zap | [57](57.md) | 133| `9735` | Zap | [57](57.md) |
@@ -115,8 +140,11 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
115| `10005` | Public chats list | [51](51.md) | 140| `10005` | Public chats list | [51](51.md) |
116| `10006` | Blocked relays list | [51](51.md) | 141| `10006` | Blocked relays list | [51](51.md) |
117| `10007` | Search relays list | [51](51.md) | 142| `10007` | Search relays list | [51](51.md) |
143| `10009` | User groups | [51](51.md), [29](29.md) |
118| `10015` | Interests list | [51](51.md) | 144| `10015` | Interests list | [51](51.md) |
119| `10030` | User emoji list | [51](51.md) | 145| `10030` | User emoji list | [51](51.md) |
146| `10050` | Relay list to receive DMs | [17](17.md) |
147| `10096` | File storage server list | [96](96.md) |
120| `13194` | Wallet Info | [47](47.md) | 148| `13194` | Wallet Info | [47](47.md) |
121| `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | 149| `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] |
122| `22242` | Client Authentication | [42](42.md) | 150| `22242` | Client Authentication | [42](42.md) |
@@ -135,14 +163,20 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
135| `30015` | Interest sets | [51](51.md) | 163| `30015` | Interest sets | [51](51.md) |
136| `30017` | Create or update a stall | [15](15.md) | 164| `30017` | Create or update a stall | [15](15.md) |
137| `30018` | Create or update a product | [15](15.md) | 165| `30018` | Create or update a product | [15](15.md) |
166| `30019` | Marketplace UI/UX | [15](15.md) |
167| `30020` | Product sold as an auction | [15](15.md) |
138| `30023` | Long-form Content | [23](23.md) | 168| `30023` | Long-form Content | [23](23.md) |
139| `30024` | Draft Long-form Content | [23](23.md) | 169| `30024` | Draft Long-form Content | [23](23.md) |
140| `30030` | Emoji sets | [51](51.md) | 170| `30030` | Emoji sets | [51](51.md) |
171| `30063` | Release artifact sets | [51](51.md) |
141| `30078` | Application-specific Data | [78](78.md) | 172| `30078` | Application-specific Data | [78](78.md) |
142| `30311` | Live Event | [53](53.md) | 173| `30311` | Live Event | [53](53.md) |
143| `30315` | User Statuses | [38](38.md) | 174| `30315` | User Statuses | [38](38.md) |
144| `30402` | Classified Listing | [99](99.md) | 175| `30402` | Classified Listing | [99](99.md) |
145| `30403` | Draft Classified Listing | [99](99.md) | 176| `30403` | Draft Classified Listing | [99](99.md) |
177| `30617` | Repository announcements | [34](34.md) |
178| `30818` | Wiki article | [54](54.md) |
179| `30819` | Redirects | [54](54.md) |
146| `31922` | Date-Based Calendar Event | [52](52.md) | 180| `31922` | Date-Based Calendar Event | [52](52.md) |
147| `31923` | Time-Based Calendar Event | [52](52.md) | 181| `31923` | Time-Based Calendar Event | [52](52.md) |
148| `31924` | Calendar | [52](52.md) | 182| `31924` | Calendar | [52](52.md) |
@@ -153,6 +187,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
153| `34236` | Short-form Portrait Video Event | [71](71.md) | 187| `34236` | Short-form Portrait Video Event | [71](71.md) |
154| `34237` | Video View Event | [71](71.md) | 188| `34237` | Video View Event | [71](71.md) |
155| `34550` | Community Definition | [72](72.md) | 189| `34550` | Community Definition | [72](72.md) |
190| `39000-9` | Group metadata events | [29](29.md) |
156 191
157[nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md 192[nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md
158[lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md 193[lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md
@@ -197,6 +232,7 @@ Please update these lists when proposing NIPs introducing new event kinds.
197| `l` | label, label namespace | annotations | [32](32.md) | 232| `l` | label, label namespace | annotations | [32](32.md) |
198| `L` | label namespace | -- | [32](32.md) | 233| `L` | label namespace | -- | [32](32.md) |
199| `m` | MIME type | -- | [94](94.md) | 234| `m` | MIME type | -- | [94](94.md) |
235| `q` | event id (hex) | relay URL | [18](18.md) |
200| `r` | a reference (URL, etc) | petname | | 236| `r` | a reference (URL, etc) | petname | |
201| `r` | relay url | marker | [65](65.md) | 237| `r` | relay url | marker | [65](65.md) |
202| `t` | hashtag | -- | | 238| `t` | hashtag | -- | |
@@ -205,28 +241,32 @@ Please update these lists when proposing NIPs introducing new event kinds.
205| `bolt11` | `bolt11` invoice | -- | [57](57.md) | 241| `bolt11` | `bolt11` invoice | -- | [57](57.md) |
206| `challenge` | challenge string | -- | [42](42.md) | 242| `challenge` | challenge string | -- | [42](42.md) |
207| `client` | name, address | relay URL | [89](89.md) | 243| `client` | name, address | relay URL | [89](89.md) |
244| `clone` | git clone URL | -- | [34](34.md) |
208| `content-warning` | reason | -- | [36](36.md) | 245| `content-warning` | reason | -- | [36](36.md) |
209| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | 246| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) |
210| `description` | invoice/badge description | -- | [57](57.md), [58](58.md) | 247| `description` | description | -- | [34](34.md), [57](57.md), [58](58.md) |
211| `emoji` | shortcode, image URL | -- | [30](30.md) | 248| `emoji` | shortcode, image URL | -- | [30](30.md) |
212| `encrypted` | -- | -- | [90](90.md) | 249| `encrypted` | -- | -- | [90](90.md) |
213| `expiration` | unix timestamp (string) | -- | [40](40.md) | 250| `expiration` | unix timestamp (string) | -- | [40](40.md) |
214| `goal` | event id (hex) | relay URL | [75](75.md) | 251| `goal` | event id (hex) | relay URL | [75](75.md) |
215| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | 252| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) |
253| `imeta` | inline metadata | -- | [92](92.md) |
216| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | 254| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) |
217| `location` | location string | -- | [52](52.md), [99](99.md) | 255| `location` | location string | -- | [52](52.md), [99](99.md) |
218| `name` | badge name | -- | [58](58.md) | 256| `name` | name | -- | [34](34.md), [58](58.md) |
219| `nonce` | random | -- | [13](13.md) | 257| `nonce` | random | -- | [13](13.md) |
220| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | 258| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) |
221| `price` | price | currency, frequency | [99](99.md) | 259| `price` | price | currency, frequency | [99](99.md) |
222| `proxy` | external ID | protocol | [48](48.md) | 260| `proxy` | external ID | protocol | [48](48.md) |
223| `published_at` | unix timestamp (string) | -- | [23](23.md) | 261| `published_at` | unix timestamp (string) | -- | [23](23.md) |
224| `relay` | relay url | -- | [42](42.md) | 262| `relay` | relay url | -- | [42](42.md), [17](17.md) |
225| `relays` | relay list | -- | [57](57.md) | 263| `relays` | relay list | -- | [57](57.md) |
226| `subject` | subject | -- | [14](14.md) | 264| `server` | file storage server url | -- | [96](96.md) |
265| `subject` | subject | -- | [14](14.md), [17](17.md) |
227| `summary` | article summary | -- | [23](23.md) | 266| `summary` | article summary | -- | [23](23.md) |
228| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | 267| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) |
229| `title` | article title | -- | [23](23.md) | 268| `title` | article title | -- | [23](23.md) |
269| `web` | webpage URL | -- | [34](34.md) |
230| `zap` | pubkey (hex), relay URL | weight | [57](57.md) | 270| `zap` | pubkey (hex), relay URL | weight | [57](57.md) |
231 271
232## Criteria for acceptance of NIPs 272## Criteria for acceptance of NIPs
@@ -251,6 +291,10 @@ Standards may emerge in two ways: the first way is that someone starts doing som
251 291
252These two ways of standardizing things are supported by this repository. Although the second is preferred, an effort will be made to codify standards emerged outside this repository into NIPs that can be later referenced and easily understood and implemented by others -- but obviously as in any human system discretion may be applied when standards are considered harmful. 292These two ways of standardizing things are supported by this repository. Although the second is preferred, an effort will be made to codify standards emerged outside this repository into NIPs that can be later referenced and easily understood and implemented by others -- but obviously as in any human system discretion may be applied when standards are considered harmful.
253 293
294## Breaking Changes
295
296[Breaking Changes](BREAKING.md)
297
254## License 298## License
255 299
256All NIPs are public domain. 300All NIPs are public domain.
generated by cgit v1.2.3 (git 2.39.1) at 2026-08-22 17:58:59 +0000