upleb.uk

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

summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--01.md150
-rw-r--r--02.md28
-rw-r--r--03.md31
-rw-r--r--04.md4
-rw-r--r--05.md12
-rw-r--r--06.md18
-rw-r--r--07.md17
-rw-r--r--08.md2
-rw-r--r--09.md7
-rw-r--r--10.md24
-rw-r--r--11.md190
-rw-r--r--12.md37
-rw-r--r--13.md10
-rw-r--r--14.md14
-rw-r--r--15.md316
-rw-r--r--16.md33
-rw-r--r--17.md164
-rw-r--r--18.md24
-rw-r--r--19.md6
-rw-r--r--20.md88
-rw-r--r--21.md2
-rw-r--r--22.md45
-rw-r--r--23.md16
-rw-r--r--24.md43
-rw-r--r--25.md46
-rw-r--r--26.md10
-rw-r--r--27.md4
-rw-r--r--28.md58
-rw-r--r--29.md198
-rw-r--r--30.md56
-rw-r--r--31.md15
-rw-r--r--32.md163
-rw-r--r--33.md48
-rw-r--r--34.md152
-rw-r--r--35.md70
-rw-r--r--36.md29
-rw-r--r--38.md61
-rw-r--r--39.md30
-rw-r--r--40.md26
-rw-r--r--42.md79
-rw-r--r--44.md295
-rw-r--r--45.md35
-rw-r--r--46.md257
-rw-r--r--47.md296
-rw-r--r--48.md60
-rw-r--r--49.md126
-rw-r--r--50.md10
-rw-r--r--51.md185
-rw-r--r--52.md219
-rw-r--r--53.md122
-rw-r--r--54.md117
-rw-r--r--55.md538
-rw-r--r--56.md31
-rw-r--r--57.md73
-rw-r--r--58.md22
-rw-r--r--59.md252
-rw-r--r--65.md86
-rw-r--r--70.md45
-rw-r--r--71.md118
-rw-r--r--72.md101
-rw-r--r--75.md85
-rw-r--r--78.md2
-rw-r--r--84.md42
-rw-r--r--89.md131
-rw-r--r--90.md230
-rw-r--r--92.md45
-rw-r--r--94.md28
-rw-r--r--96.md335
-rw-r--r--98.md63
-rw-r--r--99.md86
-rw-r--r--BREAKING.md54
-rw-r--r--README.md331
72 files changed, 5669 insertions, 1077 deletions
diff --git a/01.md b/01.md
index e36f4f5..c7d7273 100644
--- a/01.md
+++ b/01.md
@@ -4,7 +4,7 @@ NIP-01
4Basic protocol flow description 4Basic protocol flow description
5------------------------------- 5-------------------------------
6 6
7`draft` `mandatory` `author:fiatjaf` `author:distbit` `author:scsibug` `author:kukks` `author:jb55` `author:semisol` 7`draft` `mandatory`
8 8
9This NIP defines the basic protocol that should be implemented by everybody. New NIPs may add new optional (or mandatory) fields and messages and features to the structures and flows described here. 9This NIP defines the basic protocol that should be implemented by everybody. New NIPs may add new optional (or mandatory) fields and messages and features to the structures and flows described here.
10 10
@@ -14,28 +14,27 @@ 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>,
21 "created_at": <unix timestamp in seconds>, 21 "created_at": <unix timestamp in seconds>,
22 "kind": <integer>, 22 "kind": <integer between 0 and 65535>,
23 "tags": [ 23 "tags": [
24 ["e", <32-bytes hex of the id of another event>, <recommended relay URL>], 24 [<arbitrary string>...],
25 ["p", <32-bytes hex of a pubkey>, <recommended relay URL>], 25 // ...
26 ... // other kinds of tags may be included later
27 ], 26 ],
28 "content": <arbitrary string>, 27 "content": <arbitrary string>,
29 "sig": <64-bytes 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>
30} 29}
31``` 30```
32 31
33To 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) 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:
34 33
35```json 34```
36[ 35[
37 0, 36 0,
38 <pubkey, as a (lowercase) hex string>, 37 <pubkey, as a lowercase hex string>,
39 <created_at, as a number>, 38 <created_at, as a number>,
40 <kind, as a number>, 39 <kind, as a number>,
41 <tags, as an array of arrays of non-null strings>, 40 <tags, as an array of arrays of non-null strings>,
@@ -43,70 +42,135 @@ To obtain the `event.id`, we `sha256` the serialized event. The serialization is
43] 42]
44``` 43```
45 44
45To prevent implementation differences from creating a different event ID for the same event, the following rules MUST be followed while serializing:
46- UTF-8 should be used for encoding.
47- Whitespace, line breaks or other unnecessary formatting should not be included in the output JSON.
48- The following characters in the content field must be escaped as shown, and all other characters must be included verbatim:
49 - A line break (`0x0A`), use `\n`
50 - A double quote (`0x22`), use `\"`
51 - A backslash (`0x5C`), use `\\`
52 - A carriage return (`0x0D`), use `\r`
53 - A tab character (`0x09`), use `\t`
54 - A backspace, (`0x08`), use `\b`
55 - A form feed, (`0x0C`), use `\f`
56
57### Tags
58
59Each tag is an array of one or more strings, with some conventions around them. Take a look at the example below:
60
61```jsonc
62{
63 "tags": [
64 ["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://nostr.example.com"],
65 ["p", "f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca"],
66 ["a", "30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"],
67 ["alt", "reply"],
68 // ...
69 ],
70 // ...
71}
72```
73
74The first element of the tag array is referred to as the tag _name_ or _key_ and the second as the tag _value_. So we can safely say that the event above has an `e` tag set to `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"`, an `alt` tag set to `"reply"` and so on. All elements after the second do not have a conventional name.
75
76This NIP defines 3 standard tags that can be used across all event kinds with the same meaning. They are as follows:
77
78- The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, <recommended relay URL, optional>]`
79- The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, <recommended relay URL, optional>]`
80- The `a` tag, used to refer to a (maybe parameterized) replaceable event
81 - for a parameterized replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <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>]`
83
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.
85
86### Kinds
87
88Kinds specify how clients should interpret the meaning of each event and the other fields of each event (e.g. an `"r"` tag may have a meaning in an event of kind 1 and an entirely different meaning in an event of kind 10002). Each NIP may define the meaning of a set of kinds that weren't defined elsewhere. This NIP defines two basic kinds:
89
90- `0`: **user metadata**: the `content` is set to a stringified JSON object `{name: <username>, about: <string>, picture: <url, string>}` describing the user who created the event. [Extra metadata fields](24.md#kind-0) may be set. A relay may delete older events once it gets a new one for the same pubkey.
91- `1`: **text note**: the `content` is set to the **plaintext** content of a note (anything the user wants to say). Content that must be parsed, such as Markdown and HTML, should not be used. Clients should also not parse content as those.
92
93And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation:
94
95- for kind `n` such that `1000 <= n < 10000 || 4 <= n < 45 || n == 1 || n == 2`, events are **regular**, which means they're all expected to be stored by relays.
96- for kind `n` such that `10000 <= n < 20000 || n == 0 || n == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event MUST be stored by relays, older versions MAY be discarded.
97- for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays.
98- for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag's first value, only the latest event MUST be stored by relays, older versions MAY be discarded.
99
100In case of replaceable events with the same timestamp, the event with the lowest id (first in lexical order) should be retained, and the other discarded.
101
102When answering to `REQ` messages for replaceable events such as `{"kinds":[0],"authors":[<hex-key>]}`, even if the relay has more than one version stored, it SHOULD return just the latest one.
103
104These are just conventions and relay implementations may differ.
105
46## Communication between clients and relays 106## Communication between clients and relays
47 107
48Relays expose a websocket endpoint to which clients can connect. 108Relays expose a websocket endpoint to which clients can connect. Clients SHOULD open a single websocket connection to each relay and use it for all their subscriptions. Relays MAY limit number of connections from specific IP/client/etc.
49 109
50### From client to relay: sending events and creating subscriptions 110### From client to relay: sending events and creating subscriptions
51 111
52Clients 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:
53 113
54 * `["EVENT", <event JSON as defined above>]`, used to publish events. 114 * `["EVENT", <event JSON as defined above>]`, used to publish events.
55 * `["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.
56 * `["CLOSE", <subscription_id>]`, used to stop previous subscriptions. 116 * `["CLOSE", <subscription_id>]`, used to stop previous subscriptions.
57 117
58`<subscription_id>` is an arbitrary, non-empty string of max length 64 chars, that should be used to represent a subscription. 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.
59 119
60`<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:
61 121
62```json 122```json
63{ 123{
64 "ids": <a list of event ids or prefixes>, 124 "ids": <a list of event ids>,
65 "authors": <a list of pubkeys or prefixes, 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>,
66 "kinds": <a list of a kind numbers>, 126 "kinds": <a list of a kind numbers>,
67 "#e": <a list of event ids that are referenced in an "e" tag>, 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.>,
68 "#p": <a list of pubkeys that are referenced in a "p" tag>, 128 "since": <an integer unix timestamp in seconds. Events must have a created_at >= to this to pass>,
69 "since": <an integer unix timestamp, events must be newer than this to pass>, 129 "until": <an integer unix timestamp in seconds. Events must have a created_at <= to this to pass>,
70 "until": <an integer unix timestamp, events must be older than this to pass>, 130 "limit": <maximum number of events relays SHOULD return in the initial query>
71 "limit": <maximum number of events to be returned in the initial query>
72} 131}
73``` 132```
74 133
75Upon receiving a `REQ` message, the relay SHOULD query its internal database and return events that match the filter, then store that filter and send again all future events it receives to that same websocket until the websocket is closed. The `CLOSE` event is received with the same `<subscription_id>` or a new `REQ` is sent using the same `<subscription_id>`, in which case it should overwrite the previous subscription. 134Upon receiving a `REQ` message, the relay SHOULD query its internal database and return events that match the filter, then store that filter and send again all future events it receives to that same websocket until the websocket is closed. The `CLOSE` event is received with the same `<subscription_id>` or a new `REQ` is sent using the same `<subscription_id>`, in which case relay MUST overwrite the previous subscription.
135
136Filter attributes containing lists (`ids`, `authors`, `kinds` and tag filters like `#e`) are JSON arrays with one or more values. At least one of the arrays' values must match the relevant field in an event for the condition to be considered a match. For scalar event attributes such as `authors` and `kind`, the attribute from the event must be contained in the filter list. In the case of tag attributes such as `#e`, for which an event may have multiple values, the event and filter condition values must have at least one item in common.
76 137
77Filter attributes containing lists (such as `ids`, `kinds`, or `#e`) are JSON arrays with one or more values. At least one of the array's values must match the relevant field in an event for the condition itself to be considered a match. For scalar event attributes such as `kind`, the attribute from the event must be contained in the filter list. For tag attributes such as `#e`, where an event may have multiple values, the event and filter condition values must have at least one item in common. 138The `ids`, `authors`, `#e` and `#p` filter lists MUST contain exact 64-character lowercase hex values.
78 139
79The `ids` and `authors` lists contain lowercase hexadecimal strings, which may either be an exact 64-character match, or a prefix of the event value. A prefix match is when the filter string is an exact string prefix of the event value. The use of prefixes allows for more compact filters where a large number of values are queried, and can provide some privacy for clients that may not want to disclose the exact authors or events they are searching for. 140The `since` and `until` properties can be used to specify the time range of events returned in the subscription. If a filter includes the `since` property, events with `created_at` greater than or equal to `since` are considered to match the filter. The `until` property is similar except that `created_at` must be less than or equal to `until`. In short, an event matches a filter if `since <= created_at <= until` holds.
80 141
81All conditions of a filter that are specified must match for an event for it to pass the filter, i.e., multiple conditions are interpreted as `&&` conditions. 142All conditions of a filter that are specified must match for an event for it to pass the filter, i.e., multiple conditions are interpreted as `&&` conditions.
82 143
83A `REQ` message may contain multiple filters. In this case, events that match any of the filters are to be returned, i.e., multiple filters are to be interpreted as `||` conditions. 144A `REQ` message may contain multiple filters. In this case, events that match any of the filters are to be returned, i.e., multiple filters are to be interpreted as `||` conditions.
84 145
85The `limit` property of a filter is only valid for the initial query and can be ignored afterward. When `limit: n` is present it is assumed that the events returned in the initial query will be the latest `n` events. It is safe to return less events than `limit` specifies, but it is expected that relays do not return (much) more events than requested so clients don't get unnecessarily overwhelmed by data. 146The `limit` property of a filter is only valid for the initial query and MUST be ignored afterwards. When `limit: n` is present it is assumed that the events returned in the initial query will be the last `n` events ordered by the `created_at`. It is safe to return less events than `limit` specifies, but it is expected that relays do not return (much) more events than requested so clients don't get unnecessarily overwhelmed by data.
86 147
87### From relay to client: sending events and notices 148### From relay to client: sending events and notices
88 149
89Relays can send 3 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:
90 151
91 * `["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.
153 * `["OK", <event_id>, <true|false>, <message>]`, used to indicate acceptance or denial of an `EVENT` message.
92 * `["EOSE", <subscription_id>]`, used to indicate the _end of stored events_ and the beginning of events newly received in real-time. 154 * `["EOSE", <subscription_id>]`, used to indicate the _end of stored events_ and the beginning of events newly received in real-time.
155 * `["CLOSED", <subscription_id>, <message>]`, used to indicate that a subscription was ended on the server side.
93 * `["NOTICE", <message>]`, used to send human-readable error messages or other things to clients. 156 * `["NOTICE", <message>]`, used to send human-readable error messages or other things to clients.
94 157
95This NIP defines no rules for how `NOTICE` messages should be sent or treated. 158This NIP defines no rules for how `NOTICE` messages should be sent or treated.
96 159
97`EVENT` messages MUST be sent only with a subscription ID related to a subscription previously initiated by the client (using the `REQ` message above). 160- `EVENT` messages MUST be sent only with a subscription ID related to a subscription previously initiated by the client (using the `REQ` message above).
98 161- `OK` messages MUST be sent in response to `EVENT` messages received from clients, they must have the 3rd parameter set to `true` when an event has been accepted by the relay, `false` otherwise. The 4th parameter MUST always be present, but MAY be an empty string when the 3rd is `true`, otherwise it MUST be a string formed by a machine-readable single-word prefix followed by a `:` and then a human-readable message. Some examples:
99## Basic Event Kinds 162 * `["OK", "b1a649ebe8...", true, ""]`
100 163 * `["OK", "b1a649ebe8...", true, "pow: difficulty 25>=24"]`
101 - `0`: `set_metadata`: the `content` is set to a stringified JSON object `{name: <username>, about: <string>, picture: <url, string>}` describing the user who created the event. A relay may delete past `set_metadata` events once it gets a new one for the same pubkey. 164 * `["OK", "b1a649ebe8...", true, "duplicate: already have this event"]`
102 - `1`: `text_note`: the `content` is set to the plaintext content of a note (anything the user wants to say). Do not use Markdown! Clients should not have to guess how to interpret content like `[]()`. Use different event kinds for parsable content. 165 * `["OK", "b1a649ebe8...", false, "blocked: you are banned from posting here"]`
103 - `2`: `recommend_server`: the `content` is set to the URL (e.g., `wss://somerelay.com`) of a relay the event creator wants to recommend to its followers. 166 * `["OK", "b1a649ebe8...", false, "blocked: please register your pubkey at https://my-expensive-relay.example.com"]`
104 167 * `["OK", "b1a649ebe8...", false, "rate-limited: slow down there chief"]`
105A relay may choose to treat different message kinds differently, and it may or may not choose to have a default way to handle kinds it doesn't know about. 168 * `["OK", "b1a649ebe8...", false, "invalid: event creation date is too far off from the current time"]`
106 169 * `["OK", "b1a649ebe8...", false, "pow: difficulty 26 is less than 30"]`
107## Other Notes: 170 * `["OK", "b1a649ebe8...", false, "error: could not connect to the database"]`
108 171- `CLOSED` messages MUST be sent in response to a `REQ` when the relay refuses to fulfill it. It can also be sent when a relay decides to kill a subscription on its side before a client has disconnected or sent a `CLOSE`. This message uses the same pattern of `OK` messages with the machine-readable prefix and human-readable message. Some examples:
109- Clients should not open more than one websocket to each relay. One channel can support an unlimited number of subscriptions, so clients should do that. 172 * `["CLOSED", "sub1", "duplicate: sub1 already opened"]`
110- The `tags` array can store a tag identifier as the first element of each subarray, plus arbitrary information afterward (always as strings). This NIP defines `"p"` — meaning "pubkey", which points to a pubkey of someone that is referred to in the event —, and `"e"` — meaning "event", which points to the id of an event this event is quoting, replying to or referring to somehow. See [NIP-10](https://github.com/nostr-protocol/nips/blob/127d5518bfa9a4e4e7510490c0b8d95e342dfa4b/10.md) for a detailed description of "e" and "p" tags. 173 * `["CLOSED", "sub1", "unsupported: filter contains unknown elements"]`
111- The `<recommended relay URL>` item present on the `"e"` and `"p"` tags is an optional (could be set to `""`) URL of a relay the client could attempt to connect to fetch the tagged event or other events from a tagged profile. It MAY be ignored, but it exists to increase censorship resistance and make the spread of relay addresses more seamless across clients. 174 * `["CLOSED", "sub1", "error: could not connect to the database"]`
112- Clients should use the created_at field to judge the age of a metadata event and completely replace older metadata events with newer metadata events regardless of the order in which they arrive. Clients should not merge any filled fields within older metadata events into empty fields of newer metadata events. 175 * `["CLOSED", "sub1", "error: shutting down idle subscription"]`
176- The standardized machine-readable prefixes for `OK` and `CLOSED` are: `duplicate`, `pow`, `blocked`, `rate-limited`, `invalid`, and `error` for when none of that fits.
diff --git a/02.md b/02.md
index 2f19908..4029b22 100644
--- a/02.md
+++ b/02.md
@@ -1,14 +1,16 @@
1NIP-02 1NIP-02
2====== 2======
3 3
4Contact List and Petnames 4Follow List
5------------------------- 5-----------
6 6
7`final` `optional` `author:fiatjaf` `author:arcbtc` 7`final` `optional`
8 8
9A special event with kind `3`, meaning "contact list" is defined as having a list of `p` tags, one for each of the followed/known profiles one is following. 9A special event with kind `3`, meaning "follow list" is defined as having a list of `p` tags, one for each of the followed/known profiles one is following.
10 10
11Each tag entry should contain the key for the profile, a relay URL where events from that key can be found (can be set to an empty string if not needed), and a local name (or "petname") for that profile (can also be set to an empty string or not provided), i.e., `["p", <32-bytes hex key>, <main relay URL>, <petname>]`. The `content` can be anything and should be ignored. 11Each tag entry should contain the key for the profile, a relay URL where events from that key can be found (can be set to an empty string if not needed), and a local name (or "petname") for that profile (can also be set to an empty string or not provided), i.e., `["p", <32-bytes hex key>, <main relay URL>, <petname>]`.
12
13The `.content` is not used.
12 14
13For example: 15For example:
14 16
@@ -25,27 +27,29 @@ For example:
25} 27}
26``` 28```
27 29
28Every new contact list that gets published overwrites the past ones, so it should contain all entries. Relays and clients SHOULD delete past contact lists as soon as they receive a new one. 30Every 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.
31
32Whenever 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.
29 33
30## Uses 34## Uses
31 35
32### Contact list backup 36### Follow list backup
33 37
34If one believes a relay will store their events for sufficient time, they can use this kind-3 event to backup their following list and recover on a different device. 38If one believes a relay will store their events for sufficient time, they can use this kind-3 event to backup their following list and recover on a different device.
35 39
36### Profile discovery and context augmentation 40### Profile discovery and context augmentation
37 41
38A client may rely on the kind-3 event to display a list of followed people by profiles one is browsing; make lists of suggestions on who to follow based on the contact lists of other people one might be following or browsing; or show the data in other contexts. 42A client may rely on the kind-3 event to display a list of followed people by profiles one is browsing; make lists of suggestions on who to follow based on the follow lists of other people one might be following or browsing; or show the data in other contexts.
39 43
40### Relay sharing 44### Relay sharing
41 45
42A client may publish a full list of contacts with good relays for each of their contacts so other clients may use these to update their internal relay lists if needed, increasing censorship-resistance. 46A client may publish a follow list with good relays for each of their follows so other clients may use these to update their internal relay lists if needed, increasing censorship-resistance.
43 47
44### Petname scheme 48### Petname scheme
45 49
46The data from these contact lists can be used by clients to construct local ["petname"](http://www.skyhunter.com/marcs/petnames/IntroPetNames.html) tables derived from other people's contact lists. This alleviates the need for global human-readable names. For example: 50The data from these follow lists can be used by clients to construct local ["petname"](http://www.skyhunter.com/marcs/petnames/IntroPetNames.html) tables derived from other people's follow lists. This alleviates the need for global human-readable names. For example:
47 51
48A user has an internal contact list that says 52A user has an internal follow list that says
49 53
50```json 54```json
51[ 55[
@@ -53,7 +57,7 @@ A user has an internal contact list that says
53] 57]
54``` 58```
55 59
56And receives two contact lists, one from `21df6d143fb96c2ec9d63726bf9edc71` that says 60And receives two follow lists, one from `21df6d143fb96c2ec9d63726bf9edc71` that says
57 61
58```json 62```json
59[ 63[
diff --git a/03.md b/03.md
index 3c5d764..74e010c 100644
--- a/03.md
+++ b/03.md
@@ -4,20 +4,31 @@ NIP-03
4OpenTimestamps Attestations for Events 4OpenTimestamps Attestations for Events
5-------------------------------------- 5--------------------------------------
6 6
7`draft` `optional` `author:fiatjaf` 7`draft` `optional`
8 8
9When there is an OTS available it MAY be included in the existing event body under the `ots` key: 9This NIP defines an event with `kind:1040` that can contain an [OpenTimestamps](https://opentimestamps.org/) proof for any other event:
10 10
11``` 11```json
12{ 12{
13 "id": ..., 13 "kind": 1040
14 "kind": ..., 14 "tags": [
15 ..., 15 ["e", <event-id>, <relay-url>],
16 ..., 16 ["alt", "opentimestamps attestation"]
17 "ots": <base64-encoded OTS file data> 17 ],
18 "content": <base64-encoded OTS file data>
18} 19}
19``` 20```
20 21
21The _event id_ MUST be used as the raw hash to be included in the OpenTimestamps merkle tree. 22- The OpenTimestamps proof MUST prove the referenced `e` event id as its digest.
23- The `content` MUST be the full content of an `.ots` file containing at least one Bitcoin attestation. This file SHOULD contain a **single** Bitcoin attestation (as not more than one valid attestation is necessary and less bytes is better than more) and no reference to "pending" attestations since they are useless in this context.
24
25### Example OpenTimestamps proof verification flow
22 26
23The attestation can be either provided by relays automatically (and the OTS binary contents just appended to the events it receives) or by clients themselves when they first upload the event to relays — and used by clients to show that an event is really "at least as old as [OTS date]". 27Using [`nak`](https://github.com/fiatjaf/nak), [`jq`](https://jqlang.github.io/jq/) and [`ots`](https://github.com/fiatjaf/ots):
28
29```bash
30~> nak req -i e71c6ea722987debdb60f81f9ea4f604b5ac0664120dd64fb9d23abc4ec7c323 wss://nostr-pub.wellorder.net | jq -r .content | ots verify
31> using an esplora server at https://blockstream.info/api
32- sequence ending on block 810391 is valid
33timestamp validated at block [810391]
34```
diff --git a/04.md b/04.md
index 6e45b74..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` `author:arcbtc` 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 a7b42b0..a1d488d 100644
--- a/05.md
+++ b/05.md
@@ -4,13 +4,13 @@ NIP-05
4Mapping Nostr keys to DNS-based internet identifiers 4Mapping Nostr keys to DNS-based internet identifiers
5---------------------------------------------------- 5----------------------------------------------------
6 6
7`final` `optional` `author:fiatjaf` `author:mikedilger` 7`final` `optional`
8 8
9On events of kind `0` (`set_metadata`) one can specify the key `"nip05"` with an [internet identifier](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) (an email-like address) as the value. Although there is a link to a very liberal "internet identifier" specification above, NIP-05 assumes the `<local-part>` part will be restricted to the characters `a-z0-9-_.`, case insensitive. 9On events of kind `0` (`user metadata`) one can specify the key `"nip05"` with an [internet identifier](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) (an email-like address) as the value. Although there is a link to a very liberal "internet identifier" specification above, NIP-05 assumes the `<local-part>` part will be restricted to the characters `a-z0-9-_.`, case-insensitive.
10 10
11Upon seeing that, the client splits the identifier into `<local-part>` and `<domain>` and use these values to make a GET request to `https://<domain>/.well-known/nostr.json?name=<local-part>`. 11Upon seeing that, the client splits the identifier into `<local-part>` and `<domain>` and use these values to make a GET request to `https://<domain>/.well-known/nostr.json?name=<local-part>`.
12 12
13The result should be a JSON document object with a key `"names"` that should then be a mapping of names to hex formatted public keys. If the public key for the given `<name>` matches the `pubkey` from the `set_metadata` event, the client then concludes that the given pubkey can indeed be referenced by its identifier. 13The result should be a JSON document object with a key `"names"` that should then be a mapping of names to hex formatted public keys. If the public key for the given `<name>` matches the `pubkey` from the `user's metadata` event, the client then concludes that the given pubkey can indeed be referenced by its identifier.
14 14
15### Example 15### Example
16 16
@@ -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 that 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
@@ -76,7 +76,7 @@ Clients may treat the identifier `_@domain` as the "root" identifier, and choose
76 76
77### Reasoning for the `/.well-known/nostr.json?name=<local-part>` format 77### Reasoning for the `/.well-known/nostr.json?name=<local-part>` format
78 78
79By adding the `<local-part>` as a query string instead of as part of the path the protocol can support both dynamic servers that can generate JSON on-demand and static servers with a JSON file in it that may contain multiple names. 79By adding the `<local-part>` as a query string instead of as part of the path, the protocol can support both dynamic servers that can generate JSON on-demand and static servers with a JSON file in it that may contain multiple names.
80 80
81### Allowing access from JavaScript apps 81### Allowing access from JavaScript apps
82 82
diff --git a/06.md b/06.md
index 4ae571f..0e50254 100644
--- a/06.md
+++ b/06.md
@@ -4,7 +4,7 @@ NIP-06
4Basic key derivation from mnemonic seed phrase 4Basic key derivation from mnemonic seed phrase
5---------------------------------------------- 5----------------------------------------------
6 6
7`draft` `optional` `author:fiatjaf` 7`draft` `optional`
8 8
9[BIP39](https://bips.xyz/39) is used to generate mnemonic seed words and derive a binary seed from them. 9[BIP39](https://bips.xyz/39) is used to generate mnemonic seed words and derive a binary seed from them.
10 10
@@ -13,3 +13,19 @@ Basic key derivation from mnemonic seed phrase
13A basic client can simply use an `account` of `0` to derive a single key. For more advanced use-cases you can increment `account`, allowing generation of practically infinite keys from the 5-level path with hardened derivation. 13A basic client can simply use an `account` of `0` to derive a single key. For more advanced use-cases you can increment `account`, allowing generation of practically infinite keys from the 5-level path with hardened derivation.
14 14
15Other types of clients can still get fancy and use other derivation paths for their own other purposes. 15Other types of clients can still get fancy and use other derivation paths for their own other purposes.
16
17### Test vectors
18
19mnemonic: leader monkey parrot ring guide accident before fence cannon height naive bean\
20private key (hex): 7f7ff03d123792d6ac594bfa67bf6d0c0ab55b6b1fdb6249303fe861f1ccba9a\
21nsec: nsec10allq0gjx7fddtzef0ax00mdps9t2kmtrldkyjfs8l5xruwvh2dq0lhhkp\
22public key (hex): 17162c921dc4d2518f9a101db33695df1afb56ab82f5ff3e5da6eec3ca5cd917\
23npub: npub1zutzeysacnf9rru6zqwmxd54mud0k44tst6l70ja5mhv8jjumytsd2x7nu
24
25---
26
27mnemonic: what bleak badge arrange retreat wolf trade produce cricket blur garlic valid proud rude strong choose busy staff weather area salt hollow arm fade\
28private key (hex): c15d739894c81a2fcfd3a2df85a0d2c0dbc47a280d092799f144d73d7ae78add\
29nsec: nsec1c9wh8xy5eqdzln7n5t0ctgxjcrdug73gp5yj0x03gntn67h83twssdfhel\
30public key (hex): d41b22899549e1f3d335a31002cfd382174006e166d3e658e3a5eecdb6463573\
31npub: npub16sdj9zv4f8sl85e45vgq9n7nsgt5qphpvmf7vk8r5hhvmdjxx4es8rq74h
diff --git a/07.md b/07.md
index d733d01..9f836d8 100644
--- a/07.md
+++ b/07.md
@@ -4,7 +4,7 @@ NIP-07
4`window.nostr` capability for web browsers 4`window.nostr` capability for web browsers
5------------------------------------------ 5------------------------------------------
6 6
7`draft` `optional` `author:fiatjaf` 7`draft` `optional`
8 8
9The `window.nostr` object may be made available by web browsers or extensions and websites or web-apps may make use of it after checking its availability. 9The `window.nostr` object may be made available by web browsers or extensions and websites or web-apps may make use of it after checking its availability.
10 10
@@ -12,14 +12,16 @@ That object must define the following methods:
12 12
13``` 13```
14async window.nostr.getPublicKey(): string // returns a public key as hex 14async window.nostr.getPublicKey(): string // returns a public key as hex
15async window.nostr.signEvent(event: Event): Event // takes an event object, adds `id`, `pubkey` and `sig` and returns it 15async window.nostr.signEvent(event: { created_at: number, kind: number, tags: string[][], content: string }): Event // takes an event object, adds `id`, `pubkey` and `sig` and returns it
16``` 16```
17 17
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### Recommendation to Extension Authors 27### Recommendation to Extension Authors
@@ -28,9 +30,4 @@ To make sure that the `window.nostr` is available to nostr clients on page load,
28 30
29### Implementation 31### Implementation
30 32
31- [horse](https://github.com/fiatjaf/horse) (Chrome and derivatives) 33See https://github.com/aljazceru/awesome-nostr#nip-07-browser-extensions.
32- [nos2x](https://github.com/fiatjaf/nos2x) (Chrome and derivatives)
33- [Alby](https://getalby.com) (Chrome and derivatives, Firefox, Safari)
34- [Blockcore](https://www.blockcore.net/wallet) (Chrome and derivatives)
35- [nos2x-fox](https://diegogurpegui.com/nos2x-fox/) (Firefox)
36- [Flamingo](https://www.getflamingo.org/) (Chrome and derivatives)
diff --git a/08.md b/08.md
index 6793e0b..f4f4341 100644
--- a/08.md
+++ b/08.md
@@ -6,7 +6,7 @@ NIP-08
6Handling Mentions 6Handling Mentions
7----------------- 7-----------------
8 8
9`final` `unrecommended` `optional` `author:fiatjaf` `author:scsibug` 9`final` `unrecommended` `optional`
10 10
11This document standardizes the treatment given by clients of inline mentions of other events and pubkeys inside the content of `text_note`s. 11This document standardizes the treatment given by clients of inline mentions of other events and pubkeys inside the content of `text_note`s.
12 12
diff --git a/09.md b/09.md
index 89781fb..5e79ac2 100644
--- a/09.md
+++ b/09.md
@@ -4,11 +4,11 @@ NIP-09
4Event Deletion 4Event Deletion
5-------------- 5--------------
6 6
7`draft` `optional` `author:scsibug` 7`draft` `optional`
8 8
9A special event with kind `5`, meaning "deletion" is defined as having a list of one or more `e` tags, each referencing an event the author is requesting to be deleted. 9A special event with kind `5`, meaning "deletion" is defined as having a list of one or more `e` tags, each referencing an event the author is requesting to be deleted.
10 10
11Each tag entry must contain an "e" event id intended for deletion. 11Each tag entry must contain an "e" event id and/or `a` tags intended for deletion.
12 12
13The event's `content` field MAY contain a text note describing the reason for the deletion. 13The event's `content` field MAY contain a text note describing the reason for the deletion.
14 14
@@ -21,6 +21,7 @@ For example:
21 "tags": [ 21 "tags": [
22 ["e", "dcd59..464a2"], 22 ["e", "dcd59..464a2"],
23 ["e", "968c5..ad7a4"], 23 ["e", "968c5..ad7a4"],
24 ["a", "<kind>:<pubkey>:<d-identifier>"]
24 ], 25 ],
25 "content": "these posts were published by accident", 26 "content": "these posts were published by accident",
26 ...other fields 27 ...other fields
@@ -31,6 +32,8 @@ Relays SHOULD delete or stop publishing any referenced events that have an ident
31 32
32Relays SHOULD continue to publish/share the deletion events indefinitely, as clients may already have the event that's intended to be deleted. Additionally, clients SHOULD broadcast deletion events to other relays which don't have it. 33Relays SHOULD continue to publish/share the deletion events indefinitely, as clients may already have the event that's intended to be deleted. Additionally, clients SHOULD broadcast deletion events to other relays which don't have it.
33 34
35When an `a` tag is used, relays SHOULD delete all versions of the replaceable event up to the `created_at` timestamp of the deletion event.
36
34## Client Usage 37## Client Usage
35 38
36Clients MAY choose to fully hide any events that are referenced by valid deletion events. This includes text notes, direct messages, or other yet-to-be defined event kinds. Alternatively, they MAY show the event along with an icon or other indication that the author has "disowned" the event. The `content` field MAY also be used to replace the deleted events' own content, although a user interface should clearly indicate that this is a deletion reason, not the original content. 39Clients MAY choose to fully hide any events that are referenced by valid deletion events. This includes text notes, direct messages, or other yet-to-be defined event kinds. Alternatively, they MAY show the event along with an icon or other indication that the author has "disowned" the event. The `content` field MAY also be used to replace the deleted events' own content, although a user interface should clearly indicate that this is a deletion reason, not the original content.
diff --git a/10.md b/10.md
index 6494796..dfd4cb9 100644
--- a/10.md
+++ b/10.md
@@ -5,7 +5,7 @@ NIP-10
5On "e" and "p" tags in Text Events (kind 1). 5On "e" and "p" tags in Text Events (kind 1).
6-------------------------------------------- 6--------------------------------------------
7 7
8`draft` `optional` `author:unclebobmartin` 8`draft` `optional`
9 9
10## Abstract 10## Abstract
11This NIP describes how to use "e" and "p" tags in text events, especially those that are replies to other text events. It helps clients thread the replies into a tree rooted at the original event. 11This NIP describes how to use "e" and "p" tags in text events, especially those that are replies to other text events. It helps clients thread the replies into a tree rooted at the original event.
@@ -19,7 +19,7 @@ Where:
19 19
20 * `<event-id>` is the id of the event being referenced. 20 * `<event-id>` is the id of the event being referenced.
21 * `<relay-url>` is the URL of a recommended relay associated with the reference. Many clients treat this field as optional. 21 * `<relay-url>` is the URL of a recommended relay associated with the reference. Many clients treat this field as optional.
22 22
23**The positions of the "e" tags within the event denote specific meanings as follows**: 23**The positions of the "e" tags within the event denote specific meanings as follows**:
24 24
25 * No "e" tag: <br> 25 * No "e" tag: <br>
@@ -29,34 +29,36 @@ Where:
29 `["e", <id>]`: The id of the event to which this event is a reply. 29 `["e", <id>]`: The id of the event to which this event is a reply.
30 30
31 * Two "e" tags: `["e", <root-id>]`, `["e", <reply-id>]` <br> 31 * Two "e" tags: `["e", <root-id>]`, `["e", <reply-id>]` <br>
32 `<root-id>` is the id of the event at the root of the reply chain. `<reply-id>` is the id of the article to which this event is a reply. 32 `<root-id>` is the id of the event at the root of the reply chain. `<reply-id>` is the id of the article to which this event is a reply.
33 33
34 * Many "e" tags: `["e", <root-id>]` `["e", <mention-id>]`, ..., `["e", <reply-id>]`<br> 34 * Many "e" tags: `["e", <root-id>]` `["e", <mention-id>]`, ..., `["e", <reply-id>]`<br>
35There may be any number of `<mention-ids>`. These are the ids of events which may, or may not be in the reply chain. 35There may be any number of `<mention-ids>`. These are the ids of events which may, or may not be in the reply chain.
36They are citings from this event. `root-id` and `reply-id` are as above. 36They are citing from this event. `root-id` and `reply-id` are as above.
37 37
38>This scheme is deprecated because it creates ambiguities that are difficult, or impossible to resolve when an event references another but is not a reply. 38>This scheme is deprecated because it creates ambiguities that are difficult, or impossible to resolve when an event references another but is not a reply.
39 39
40## Marked "e" tags (PREFERRED) 40## Marked "e" tags (PREFERRED)
41`["e", <event-id>, <relay-url>, <marker>]` 41`["e", <event-id>, <relay-url>, <marker>, <pubkey>]`
42 42
43Where: 43Where:
44 44
45 * `<event-id>` is the id of the event being referenced. 45 * `<event-id>` is the id of the event being referenced.
46 * `<relay-url>` is the URL of a recommended relay associated with the reference. Clients SHOULD add a valid `<relay-URL>` field, but may instead leave it as `""`. 46 * `<relay-url>` is the URL of a recommended relay associated with the reference. Clients SHOULD add a valid `<relay-URL>` field, but may instead leave it as `""`.
47 * `<marker>` is optional and if present is one of `"reply"`, `"root"`, or `"mention"`. 47 * `<marker>` is optional and if present is one of `"reply"`, `"root"`, or `"mention"`.
48 * `<pubkey>` is optional, SHOULD be the pubkey of the author of the referenced event
48 49
49**The order of marked "e" tags is not relevant.** Those marked with `"reply"` denote the id of the reply event being responded to. Those marked with `"root"` denote the root id of the reply thread being responded to. For top level replies (those replying directly to the root event), only the `"root"` marker should be used. Those marked with `"mention"` denote a quoted or reposted event id. 50Those marked with `"reply"` denote the id of the reply event being responded to. Those marked with `"root"` denote the root id of the reply thread being responded to. For top level replies (those replying directly to the root event), only the `"root"` marker should be used. Those marked with `"mention"` denote a quoted or reposted event id.
50 51
51A direct reply to the root of a thread should have a single marked "e" tag of type "root". 52A direct reply to the root of a thread should have a single marked "e" tag of type "root".
52 53
53>This scheme is preferred because it allows events to mention others without confusing them with `<reply-id>` or `<root-id>`. 54>This scheme is preferred because it allows events to mention others without confusing them with `<reply-id>` or `<root-id>`.
54 55
56`<pubkey>` SHOULD be the pubkey of the author of the `e` tagged event, this is used in the outbox model to search for that event from the authors write relays where relay hints did not resolve the event.
55 57
56## The "p" tag 58## The "p" tag
57Used in a text event contains a list of pubkeys used to record who is involved in a reply thread. 59Used in a text event contains a list of pubkeys used to record who is involved in a reply thread.
58 60
59When replying to a text event E the reply event's "p" tags should contain all of E's "p" tags as well as the `"pubkey"` of the event being replied to. 61When replying to a text event E the reply event's "p" tags should contain all of E's "p" tags as well as the `"pubkey"` of the event being replied to.
60 62
61Example: Given a text event authored by `a1` with "p" tags [`p1`, `p2`, `p3`] then the "p" tags of the reply should be [`a1`, `p1`, `p2`, `p3`] 63Example: Given a text event authored by `a1` with "p" tags [`p1`, `p2`, `p3`] then the "p" tags of the reply should be [`a1`, `p1`, `p2`, `p3`]
62in no particular order. 64in no particular order.
diff --git a/11.md b/11.md
index b0d6003..a50038a 100644
--- a/11.md
+++ b/11.md
@@ -4,7 +4,7 @@ NIP-11
4Relay Information Document 4Relay Information Document
5--------------------------- 5---------------------------
6 6
7`draft` `optional` `author:scsibug` `author:doc-hex` `author:cameri` 7`draft` `optional`
8 8
9Relays may provide server metadata to clients to inform them of capabilities, administrative contacts, and various server attributes. This is made available as a JSON document over HTTP, on the same URI as the relay's websocket. 9Relays may provide server metadata to clients to inform them of capabilities, administrative contacts, and various server attributes. This is made available as a JSON document over HTTP, on the same URI as the relay's websocket.
10 10
@@ -25,42 +25,42 @@ When a relay receives an HTTP(s) request with an `Accept` header of `application
25Any field may be omitted, and clients MUST ignore any additional fields they do not understand. Relays MUST accept CORS requests by sending `Access-Control-Allow-Origin`, `Access-Control-Allow-Headers`, and `Access-Control-Allow-Methods` headers. 25Any field may be omitted, and clients MUST ignore any additional fields they do not understand. Relays MUST accept CORS requests by sending `Access-Control-Allow-Origin`, `Access-Control-Allow-Headers`, and `Access-Control-Allow-Methods` headers.
26 26
27Field Descriptions 27Field Descriptions
28----------------- 28------------------
29 29
30### Name ### 30### Name
31 31
32A relay may select a `name` for use in client software. This is a string, and SHOULD be less than 30 characters to avoid client truncation. 32A relay may select a `name` for use in client software. This is a string, and SHOULD be less than 30 characters to avoid client truncation.
33 33
34### Description ### 34### Description
35 35
36Detailed plain-text information about the relay may be contained in the `description` string. It is recommended that this contain no markup, formatting or line breaks for word wrapping, and simply use double newline characters to separate paragraphs. There are no limitations on length. 36Detailed plain-text information about the relay may be contained in the `description` string. It is recommended that this contain no markup, formatting or line breaks for word wrapping, and simply use double newline characters to separate paragraphs. There are no limitations on length.
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
44### Contact ### 44### Contact
45 45
46An alternative contact may be listed under the `contact` field as well, with the same purpose as `pubkey`. Use of a Nostr public key and direct message SHOULD be preferred over this. Contents of this field SHOULD be a URI, using schemes such as `mailto` or `https` to provide users with a means of contact. 46An alternative contact may be listed under the `contact` field as well, with the same purpose as `pubkey`. Use of a Nostr public key and direct message SHOULD be preferred over this. Contents of this field SHOULD be a URI, using schemes such as `mailto` or `https` to provide users with a means of contact.
47 47
48### Supported NIPs ### 48### Supported NIPs
49 49
50As the Nostr protocol evolves, some functionality may only be available by relays that implement a specific `NIP`. This field is an array of the integer identifiers of `NIP`s that are implemented in the relay. Examples would include `1`, for `"NIP-01"` and `9`, for `"NIP-09"`. Client-side `NIPs` SHOULD NOT be advertised, and can be ignored by clients. 50As the Nostr protocol evolves, some functionality may only be available by relays that implement a specific `NIP`. This field is an array of the integer identifiers of `NIP`s that are implemented in the relay. Examples would include `1`, for `"NIP-01"` and `9`, for `"NIP-09"`. Client-side `NIPs` SHOULD NOT be advertised, and can be ignored by clients.
51 51
52### Software ### 52### Software
53 53
54The relay server implementation MAY be provided in the `software` attribute. If present, this MUST be a URL to the project's homepage. 54The relay server implementation MAY be provided in the `software` attribute. If present, this MUST be a URL to the project's homepage.
55 55
56### Version ### 56### Version
57 57
58The relay MAY choose to publish its software version as a string attribute. The string format is defined by the relay implementation. It is recommended this be a version number or commit identifier. 58The relay MAY choose to publish its software version as a string attribute. The string format is defined by the relay implementation. It is recommended this be a version number or commit identifier.
59 59
60Extra Fields 60Extra Fields
61----------------- 61------------
62 62
63### Server Limitations ### 63### Server Limitations
64 64
65These are limitations imposed by the relay on clients. Your client 65These are limitations imposed by the relay on clients. Your client
66should expect that requests which exceed these *practical* limitations 66should expect that requests which exceed these *practical* limitations
@@ -68,21 +68,22 @@ are rejected or fail immediately.
68 68
69```json 69```json
70{ 70{
71...
72 "limitation": { 71 "limitation": {
73 "max_message_length": 16384, 72 "max_message_length": 16384,
74 "max_subscriptions": 20, 73 "max_subscriptions": 20,
75 "max_filters": 100, 74 "max_filters": 100,
76 "max_limit": 5000, 75 "max_limit": 5000,
77 "max_subid_length": 100, 76 "max_subid_length": 100,
78 "min_prefix": 4, 77 "max_event_tags": 100,
79 "max_event_tags": 100, 78 "max_content_length": 8196,
80 "max_content_length": 8196, 79 "min_pow_difficulty": 30,
81 "min_pow_difficulty": 30, 80 "auth_required": true,
82 "auth_required": true, 81 "payment_required": true,
83 "payment_required": true, 82 "restricted_writes": true,
84 } 83 "created_at_lower_limit": 31536000,
85... 84 "created_at_upper_limit": 3
85 },
86 ...
86} 87}
87``` 88```
88 89
@@ -102,9 +103,6 @@ Must be one or higher.
102 103
103- `max_subid_length`: maximum length of subscription id as a string. 104- `max_subid_length`: maximum length of subscription id as a string.
104 105
105- `min_prefix`: for `authors` and `ids` filters which are to match against
106a hex prefix, you must provide at least this many hex digits in the prefix.
107
108- `max_limit`: the relay server will clamp each filter's `limit` value to this number. 106- `max_limit`: the relay server will clamp each filter's `limit` value to this number.
109This means the client won't be able to get more than this number 107This means the client won't be able to get more than this number
110of events from a single subscription filter. This clamping is typically done silently 108of events from a single subscription filter. This clamping is typically done silently
@@ -118,7 +116,7 @@ field of any event. This is a count of unicode characters. After
118serializing into JSON it may be larger (in bytes), and is still 116serializing into JSON it may be larger (in bytes), and is still
119subject to the `max_message_length`, if defined. 117subject to the `max_message_length`, if defined.
120 118
121- `min_pow_difficulty`: new events will require at least this difficulty of PoW, 119- `min_pow_difficulty`: new events will require at least this difficulty of PoW,
122based on [NIP-13](13.md), or they will be rejected by this server. 120based on [NIP-13](13.md), or they will be rejected by this server.
123 121
124- `auth_required`: this relay requires [NIP-42](42.md) authentication 122- `auth_required`: this relay requires [NIP-42](42.md) authentication
@@ -127,9 +125,19 @@ Even if set to False, authentication may be required for specific actions.
127 125
128- `payment_required`: this relay requires payment before a new connection may perform any action. 126- `payment_required`: this relay requires payment before a new connection may perform any action.
129 127
130### Event Retention ### 128- `restricted_writes`: this relay requires some kind of condition to be fulfilled in order to
129accept events (not necessarily, but including `payment_required` and `min_pow_difficulty`).
130This should only be set to `true` when users are expected to know the relay policy before trying
131to write to it -- like belonging to a special pubkey-based whitelist or writing only events of
132a specific niche kind or content. Normal anti-spam heuristics, for example, do not qualify.
133
134- `created_at_lower_limit`: 'created_at' lower limit
131 135
132There may be a cost associated with storing data forever, so relays 136- `created_at_upper_limit`: 'created_at' upper limit
137
138### Event Retention
139
140There may be a cost associated with storing data forever, so relays
133may wish to state retention times. The values stated here are defaults 141may wish to state retention times. The values stated here are defaults
134for unauthenticated users and visitors. Paid users would likely have 142for unauthenticated users and visitors. Paid users would likely have
135other policies. 143other policies.
@@ -140,18 +148,16 @@ all, and preferably an error will be provided when those are received.
140 148
141```json 149```json
142{ 150{
143...
144 "retention": [ 151 "retention": [
145 { "kinds": [0, 1, [5, 7], [40, 49]], "time": 3600 }, 152 {"kinds": [0, 1, [5, 7], [40, 49]], "time": 3600},
146 { "kinds": [[40000, 49999]], "time": 100 }, 153 {"kinds": [[40000, 49999]], "time": 100},
147 { "kinds": [[30000, 39999]], "count": 1000 }, 154 {"kinds": [[30000, 39999]], "count": 1000},
148 { "time": 3600, "count": 10000 } 155 {"time": 3600, "count": 10000}
149 ] 156 ]
150...
151} 157}
152``` 158```
153 159
154`retention` is a list of specifications: each will apply to either all kinds, or 160`retention` is a list of specifications: each will apply to either all kinds, or
155a subset of kinds. Ranges may be specified for the kind field as a tuple of inclusive 161a subset of kinds. Ranges may be specified for the kind field as a tuple of inclusive
156start and end values. Events of indicated kind (or all) are then limited to a `count` 162start and end values. Events of indicated kind (or all) are then limited to a `count`
157and/or time period. 163and/or time period.
@@ -161,11 +167,9 @@ a specific `kind` number, by giving a retention time of zero for those `kind` va
161While that is unfortunate, it does allow clients to discover servers that will 167While that is unfortunate, it does allow clients to discover servers that will
162support their protocol quickly via a single HTTP fetch. 168support their protocol quickly via a single HTTP fetch.
163 169
164There is no need to specify retention times for _ephemeral events_ as defined 170There is no need to specify retention times for _ephemeral events_ since they are not retained.
165in [NIP-16](16.md) since they are not retained.
166
167 171
168### Content Limitations ### 172### Content Limitations
169 173
170Some relays may be governed by the arbitrary laws of a nation state. This 174Some relays may be governed by the arbitrary laws of a nation state. This
171may limit what content can be stored in cleartext on those relays. All 175may limit what content can be stored in cleartext on those relays. All
@@ -184,9 +188,8 @@ flexibility is up to the client software.
184 188
185```json 189```json
186{ 190{
187...
188 "relay_countries": [ "CA", "US" ], 191 "relay_countries": [ "CA", "US" ],
189... 192 ...
190} 193}
191``` 194```
192 195
@@ -198,7 +201,7 @@ country of the legal entities who own the relay, so it's very
198likely a number of countries are involved. 201likely a number of countries are involved.
199 202
200 203
201### Community Preferences ### 204### Community Preferences
202 205
203For public text notes at least, a relay may try to foster a 206For public text notes at least, a relay may try to foster a
204local community. This would encourage users to follow the global 207local community. This would encourage users to follow the global
@@ -207,11 +210,10 @@ To support this goal, relays MAY specify some of the following values.
207 210
208```json 211```json
209{ 212{
210... 213 "language_tags": ["en", "en-419"],
211 "language_tags": [ "en", "en-419" ], 214 "tags": ["sfw-only", "bitcoin-only", "anime"],
212 "tags": [ "sfw-only", "bitcoin-only", "anime" ],
213 "posting_policy": "https://example.com/posting-policy.html", 215 "posting_policy": "https://example.com/posting-policy.html",
214... 216 ...
215} 217}
216``` 218```
217 219
@@ -238,47 +240,75 @@ detail and legal terms. Use the `tags` field to signify limitations
238on content, or topics to be discussed, which could be machine 240on content, or topics to be discussed, which could be machine
239processed by appropriate client software. 241processed by appropriate client software.
240 242
241### Pay-To-Relay ### 243### Pay-to-Relay
242 244
243Relays that require payments may want to expose their fee schedules. 245Relays that require payments may want to expose their fee schedules.
244 246
245```json 247```json
246{ 248{
247...
248 "payments_url": "https://my-relay/payments", 249 "payments_url": "https://my-relay/payments",
249 "fees": { 250 "fees": {
250 "admission": [{ "amount": 1000000, "unit": "msats" }], 251 "admission": [{ "amount": 1000000, "unit": "msats" }],
251 "subscription": [{ "amount": 5000000, "unit": "msats", "period": 2592000 }], 252 "subscription": [{ "amount": 5000000, "unit": "msats", "period": 2592000 }],
252 "publication": [{ "kinds": [4], "amount": 100, "unit": "msats" }], 253 "publication": [{ "kinds": [4], "amount": 100, "unit": "msats" }],
253 }, 254 },
254... 255 ...
255} 256}
256``` 257```
257 258
258### Examples ### 259### Icon
259As of 2 May 2023 the following `curl` command provided these results. 260
260 261A URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape.
261 >curl -H "Accept: application/nostr+json" https://eden.nostr.land 262
262 263```json
263 {"name":"eden.nostr.land", 264{
264 "description":"Eden Nostr Land - Toronto 1-01", 265 "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg",
265 "pubkey":"00000000827ffaa94bfea288c3dfce4422c794fbb96625b6b31e9049f729d700", 266 ...
266 "contact":"me@ricardocabral.io", 267}
267 "supported_nips":[1,2,4,9,11,12,15,16,20,22,26,28,33,40], 268```
268 "supported_nip_extensions":["11a"], 269
269 "software":"git+https://github.com/Cameri/nostream.git", 270### Examples
270 "version":"1.22.6", 271
271 "limitation":{"max_message_length":1048576, 272As of 2 May 2023 the following command provided these results:
272 "max_subscriptions":10, 273
273 "max_filters":2500, 274```
274 "max_limit":5000, 275~> curl -H "Accept: application/nostr+json" https://eden.nostr.land | jq
275 "max_subid_length":256, 276
276 "min_prefix":4, 277{
277 "max_event_tags":2500, 278 "description": "nostr.land family of relays (us-or-01)",
278 "max_content_length":65536, 279 "name": "nostr.land",
279 "min_pow_difficulty":0, 280 "pubkey": "52b4a076bcbbbdc3a1aefa3735816cf74993b1b8db202b01c883c58be7fad8bd",
280 "auth_required":false, 281 "software": "custom",
281 "payment_required":true}, 282 "supported_nips": [
282 "payments_url":"https://eden.nostr.land/invoices", 283 1,
283 "fees":{"admission":[{"amount":5000000,"unit":"msats"}], 284 2,
284 "publication":[]}} 285 4,
286 9,
287 11,
288 12,
289 16,
290 20,
291 22,
292 28,
293 33,
294 40
295 ],
296 "version": "1.0.1",
297 "limitation": {
298 "payment_required": true,
299 "max_message_length": 65535,
300 "max_event_tags": 2000,
301 "max_subscriptions": 20,
302 "auth_required": false
303 },
304 "payments_url": "https://eden.nostr.land",
305 "fees": {
306 "subscription": [
307 {
308 "amount": 2500000,
309 "unit": "msats",
310 "period": 2592000
311 }
312 ]
313 },
314}
diff --git a/12.md b/12.md
index 74c9d81..bf0eda9 100644
--- a/12.md
+++ b/12.md
@@ -4,39 +4,6 @@ NIP-12
4Generic Tag Queries 4Generic Tag Queries
5------------------- 5-------------------
6 6
7`draft` `optional` `author:scsibug` `author:fiatjaf` 7`final` `mandatory`
8 8
9Relays may support subscriptions over arbitrary tags. `NIP-01` requires relays to respond to queries for `e` and `p` tags. This NIP allows any single-letter tag present in an event to be queried. 9Moved to [NIP-01](01.md).
10
11The `<filters>` object described in `NIP-01` is expanded to contain arbitrary keys with a `#` prefix. Any single-letter key in a filter beginning with `#` is a tag query, and MUST have a value of an array of strings. The filter condition matches if the event has a tag with the same name, and there is at least one tag value in common with the filter and event. The tag name is the letter without the `#`, and the tag value is the second element. Subsequent elements are ignored for the purposes of tag queries.
12
13Example Subscription Filter
14---------------------------
15
16The following provides an example of a filter that matches events of kind `1` with an `r` tag set to either `foo` or `bar`.
17
18```
19{
20 "kinds": [1],
21 "#r": ["foo", "bar"]
22}
23```
24
25Client Behavior
26---------------
27
28Clients SHOULD use the `supported_nips` field to learn if a relay supports generic tag queries. Clients MAY send generic tag queries to any relay, if they are prepared to filter out extraneous responses from relays that do not support this NIP.
29
30Rationale
31---------
32
33The decision to reserve only single-letter tags to be usable in queries allow applications to make use of tags for all sorts of metadata, as it is their main purpose, without worrying that they might be bloating relay indexes. That also makes relays more lightweight, of course. And if some application or user is abusing single-letter tags with the intention of bloating relays that becomes easier to detect as single-letter tags will hardly be confused with some actually meaningful metadata some application really wanted to attach to the event with no spammy intentions.
34
35Suggested Use Cases
36-------------------
37
38Motivating examples for generic tag queries are provided below. This NIP does not promote or standardize the use of any specific tag for any purpose.
39
40* Decentralized Commenting System: clients can comment on arbitrary web pages, and easily search for other comments, by using a `r` ("reference", in this case an URL) tag and value.
41* Location-specific Posts: clients can use a `g` ("geohash") tag to associate a post with a physical location. Clients can search for a set of geohashes of varying precisions near them to find local content.
42* Hashtags: clients can use simple `t` ("hashtag") tags to associate an event with an easily searchable topic name. Since Nostr events themselves are not searchable through the protocol, this provides a mechanism for user-driven search.
diff --git a/13.md b/13.md
index 360bde6..99289c2 100644
--- a/13.md
+++ b/13.md
@@ -4,7 +4,7 @@ NIP-13
4Proof of Work 4Proof of Work
5------------- 5-------------
6 6
7`draft` `optional` `author:jb55` `author:cameri` 7`draft` `optional`
8 8
9This NIP defines a way to generate and interpret Proof of Work for nostr notes. Proof of Work (PoW) is a way to add a proof of computational work to a note. This is a bearer proof that all relays and clients can universally validate with a small amount of code. This proof can be used as a means of spam deterrence. 9This NIP defines a way to generate and interpret Proof of Work for nostr notes. Proof of Work (PoW) is a way to add a proof of computational work to a note. This is a bearer proof that all relays and clients can universally validate with a small amount of code. This proof can be used as a means of spam deterrence.
10 10
@@ -35,11 +35,7 @@ Example mined note
35 "created_at": 1651794653, 35 "created_at": 1651794653,
36 "kind": 1, 36 "kind": 1,
37 "tags": [ 37 "tags": [
38 [ 38 ["nonce", "776797", "20"]
39 "nonce",
40 "776797",
41 "21"
42 ]
43 ], 39 ],
44 "content": "It's just me mining my own business", 40 "content": "It's just me mining my own business",
45 "sig": "284622fc0a3f4f1303455d5175f7ba962a3300d136085b9566801bc2e0699de0c7e31e44c81fb40ad9049173742e904713c3594a1da0fc5d2382a25c11aba977" 41 "sig": "284622fc0a3f4f1303455d5175f7ba962a3300d136085b9566801bc2e0699de0c7e31e44c81fb40ad9049173742e904713c3594a1da0fc5d2382a25c11aba977"
@@ -110,7 +106,7 @@ function countLeadingZeroes(hex) {
110Querying relays for PoW notes 106Querying relays for PoW notes
111----------------------------- 107-----------------------------
112 108
113Since relays allow searching on prefixes, you can use this as a way to filter notes of a certain difficulty: 109If relays allow searching on prefixes, you can use this as a way to filter notes of a certain difficulty:
114 110
115``` 111```
116$ echo '["REQ", "subid", {"ids": ["000000000"]}]' | websocat wss://some-relay.com | jq -c '.[2]' 112$ echo '["REQ", "subid", {"ids": ["000000000"]}]' | websocat wss://some-relay.com | jq -c '.[2]'
diff --git a/14.md b/14.md
index 0b37e8a..480c4c5 100644
--- a/14.md
+++ b/14.md
@@ -1,19 +1,21 @@
1NIP-14 1NIP-14
2====== 2======
3 3
4Subject tag in Text events. 4Subject tag in Text events
5--------------------------- 5--------------------------
6 6
7`draft` `optional` `author:unclebobmartin` 7`draft` `optional`
8 8
9This NIP defines the use of the "subject" tag in text (kind: 1) events. 9This NIP defines the use of the "subject" tag in text (kind: 1) events.
10(implemented in more-speech) 10(implemented in more-speech)
11 11
12`["subject": <string>]` 12```json
13["subject": <string>]
14```
13 15
14Browsers often display threaded lists of messages. The contents of the subject tag can be used in such lists, instead of the more ad hoc approach of using the first few words of the message. This is very similar to the way email browsers display lists of incoming emails by subject rather than by contents. 16Browsers often display threaded lists of messages. The contents of the subject tag can be used in such lists, instead of the more ad hoc approach of using the first few words of the message. This is very similar to the way email browsers display lists of incoming emails by subject rather than by contents.
15 17
16When replying to a message with a subject, clients SHOULD replicate the subject tag. Clients MAY adorn the subject to denote 18When replying to a message with a subject, clients SHOULD replicate the subject tag. Clients MAY adorn the subject to denote
17that it is a reply. e.g. by prepending "Re:". 19that it is a reply. e.g. by prepending "Re:".
18 20
19Subjects should generally be shorter than 80 chars. Long subjects will likely be trimmed by clients. 21Subjects should generally be shorter than 80 chars. Long subjects will likely be trimmed by clients.
diff --git a/15.md b/15.md
index 617c011..55814fb 100644
--- a/15.md
+++ b/15.md
@@ -1,14 +1,14 @@
1NIP-15 1NIP-15
2====== 2======
3 3
4Nostr Marketplace (for resilient marketplaces) 4Nostr Marketplace
5----------------------------------- 5-----------------
6 6
7`draft` `optional` `author:fiatjaf` `author:benarc` `author:motorina0` `author:talvasconcelos` 7`draft` `optional`
8 8
9> Based on https://github.com/lnbits/Diagon-Alley 9Based on https://github.com/lnbits/Diagon-Alley.
10 10
11> Implemented here https://github.com/lnbits/nostrmarket 11Implemented in [NostrMarket](https://github.com/lnbits/nostrmarket) and [Plebeian Market](https://github.com/PlebeianTech/plebeian-market).
12 12
13## Terms 13## Terms
14 14
@@ -33,88 +33,113 @@ The `merchant` admin software can be purely clientside, but for `convenience` an
33## `Merchant` publishing/updating products (event) 33## `Merchant` publishing/updating products (event)
34 34
35A merchant can publish these events: 35A merchant can publish these events:
36| Kind | | Description | NIP | 36| Kind | | Description |
37|---------|------------------|---------------------------------------------------------------------------------------------------------------|-----------------------------------------| 37| --------- | ------------------ | --------------------------------------------------------------------------------------------------------------- |
38| `0 ` | `set_meta` | The merchant description (similar with any `nostr` public key). | [NIP01 ](https://github.com/nostr-protocol/nips/blob/master/01.md) | 38| `0` | `set_meta` | The merchant description (similar with any `nostr` public key). |
39| `30017` | `set_stall` | Create or update a stall. | [NIP33](https://github.com/nostr-protocol/nips/blob/master/33.md) (Parameterized Replaceable Event) | 39| `30017` | `set_stall` | Create or update a stall. |
40| `30018` | `set_product` | Create or update a product. | [NIP33](https://github.com/nostr-protocol/nips/blob/master/33.md) (Parameterized Replaceable Event) | 40| `30018` | `set_product` | Create or update a product. |
41| `4 ` | `direct_message` | Communicate with the customer. The messages can be plain-text or JSON. | [NIP09](https://github.com/nostr-protocol/nips/blob/master/09.md) | 41| `4` | `direct_message` | Communicate with the customer. The messages can be plain-text or JSON. |
42| `5 ` | `delete` | Delete a product or a stall. | [NIP05](https://github.com/nostr-protocol/nips/blob/master/05.md) | 42| `5` | `delete` | Delete a product or a stall. |
43 43
44### Event `30017`: Create or update a stall. 44### Event `30017`: Create or update a stall.
45 45
46**Event Content**: 46**Event Content**
47
47```json 48```json
48{ 49{
49 "id": <String, UUID generated by the merchant. Sequential IDs (`0`, `1`, `2`...) are discouraged>, 50 "id": <string, id generated by the merchant. Sequential IDs (`0`, `1`, `2`...) are discouraged>,
50 "name": <String, stall name>, 51 "name": <string, stall name>,
51 "description": <String (optional), stall description>, 52 "description": <string (optional), stall description>,
52 "currency": <String, currency used>, 53 "currency": <string, currency used>,
53 "shipping": [ 54 "shipping": [
54 { 55 {
55 "id": <String, UUID of the shipping zone, generated by the merchant>, 56 "id": <string, id of the shipping zone, generated by the merchant>,
56 "name": <String (optional), zone name>, 57 "name": <string (optional), zone name>,
57 "cost": <float, 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>,
58 "countries": [<String, countries included in this zone>], 59 "regions": [<string, regions included in this zone>]
59 } 60 }
60 ] 61 ]
61} 62}
62``` 63```
63 64
64Fields that are not self-explanatory: 65Fields that are not self-explanatory:
65 - `shipping`: 66 - `shipping`:
66 - an array with possible shipping zones for this stall. The customer MUST choose exactly one shipping zone. 67 - an array with possible shipping zones for this stall.
68 - the customer MUST choose exactly one of those shipping zones.
67 - shipping to different zones can have different costs. For some goods (digital for example) the cost can be zero. 69 - shipping to different zones can have different costs. For some goods (digital for example) the cost can be zero.
68 - the `id` is an internal value used by the merchant. This value must be sent back as the customer selection. 70 - the `id` is an internal value used by the merchant. This value must be sent back as the customer selection.
71 - each shipping zone contains the base cost for orders made to that shipping zone, but a specific shipping cost per
72 product can also be specified if the shipping cost for that product is higher than what's specified by the base cost.
73
74**Event Tags**
69 75
70**Event Tags**:
71```json 76```json
72 "tags": [["d", <String, id of stall]] 77{
78 "tags": [["d", <string, id of stall]],
79 ...
80}
73``` 81```
74 - the `d` tag is required by [NIP33](https://github.com/nostr-protocol/nips/blob/master/33.md). Its value MUST be the same as the stall `id`. 82 - the `d` tag is required, its value MUST be the same as the stall `id`.
75 83
76### Event `30018`: Create or update a product 84### Event `30018`: Create or update a product
77 85
78**Event Content**: 86**Event Content**
87
79```json 88```json
80{ 89{
81 "id": <String, UUID generated by the merchant.Sequential IDs (`0`, `1`, `2`...) are discouraged>, 90 "id": <string, id generated by the merchant (sequential ids are discouraged)>,
82 "stall_id": <String, UUID of the stall to which this product belong to>, 91 "stall_id": <string, id of the stall to which this product belong to>,
83 "name": <String, product name>, 92 "name": <string, product name>,
84 "description": <String (optional), product description>, 93 "description": <string (optional), product description>,
85 "images": <[String], array of image URLs, optional>, 94 "images": <[string], array of image URLs, optional>,
86 "currency": <String, currency used>, 95 "currency": <string, currency used>,
87 "price": <float, cost of product>, 96 "price": <float, cost of product>,
88 "quantity": <int, available items>, 97 "quantity": <int or null, available items>,
89 "specs": [ 98 "specs": [
90 [ <String, spec key>, <String, spec value>] 99 [<string, spec key>, <string, spec value>]
91 ] 100 ],
101 "shipping": [
102 {
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>
105 }
106 ]
92} 107}
93``` 108```
94 109
95Fields that are not self-explanatory: 110Fields that are not self-explanatory:
111 - `quantity` can be null in the case of items with unlimited availability, like digital items, or services
96 - `specs`: 112 - `specs`:
97 - an array of key pair values. It allows for the Customer UI to present present product specifications in a structure mode. It also allows comparison between products 113 - an optional array of key pair values. It allows for the Customer UI to present product specifications in a structure mode. It also allows comparison between products
98 - eg: `[["operating_system", "Android 12.0"], ["screen_size", "6.4 inches"], ["connector_type", "USB Type C"]]` 114 - eg: `[["operating_system", "Android 12.0"], ["screen_size", "6.4 inches"], ["connector_type", "USB Type C"]]`
99 115
100_Open_: better to move `spec` in the `tags` section of the event? 116 _Open_: better to move `spec` in the `tags` section of the event?
117
118- `shipping`:
119 - an _optional_ array of extra costs to be used per shipping zone, only for products that require special shipping costs to be added to the base shipping cost defined in the stall
120 - the `id` should match the id of the shipping zone, as defined in the `shipping` field of the stall
121 - to calculate the total cost of shipping for an order, the user will choose a shipping option during checkout, and then the client must consider this costs:
122 - the `base cost from the stall` for the chosen shipping option
123 - the result of multiplying the product units by the `shipping costs specified in the product`, if any.
124
125**Event Tags**
101 126
102**Event Tags**:
103```json 127```json
104 "tags": [ 128 "tags": [
105 ["d", <String, id of product], 129 ["d", <string, id of product],
106 ["t", <String (optional), product category], 130 ["t", <string (optional), product category],
107 ["t", <String (optional), product category], 131 ["t", <string (optional), product category],
108 ... 132 ...
109 ] 133 ],
134 ...
110``` 135```
111 136
112 - the `d` tag is required by [NIP33](https://github.com/nostr-protocol/nips/blob/master/33.md). Its value MUST be the same as the product `id`. 137 - the `d` tag is required, its value MUST be the same as the product `id`.
113 - the `t` tag is as searchable tag ([NIP12](https://github.com/nostr-protocol/nips/blob/master/12.md)). It represents different categories that the product can be part of (`food`, `fruits`). Multiple `t` tags can be present. 138 - the `t` tag is as searchable tag, it represents different categories that the product can be part of (`food`, `fruits`). Multiple `t` tags can be present.
114 139
115## Checkout events 140## Checkout events
116 141
117All 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)).
118 143
119The `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:
120 145
@@ -124,41 +149,40 @@ The `merchant` and the `customer` can exchange JSON messages that represent diff
124| 1 | Merchant | Payment Request | 149| 1 | Merchant | Payment Request |
125| 2 | Merchant | Order Status Update | 150| 2 | Merchant | Order Status Update |
126 151
127
128### Step 1: `customer` order (event) 152### Step 1: `customer` order (event)
129The 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).
130 154
131```json 155```json
132{ 156{
133 "id": <String, UUID generated by the customer>, 157 "id": <string, id generated by the customer>,
134 "type": 0, 158 "type": 0,
135 "name": <String (optional), ???>, 159 "name": <string (optional), ???>,
136 "address": <String (optional), for physical goods an address should be provided> 160 "address": <string (optional), for physical goods an address should be provided>,
137 "message": "<String (optional), message for merchant>, 161 "message": "<string (optional), message for merchant>,
138 "contact": { 162 "contact": {
139 "nostr": <32-bytes hex of a pubkey>, 163 "nostr": <32-bytes hex of a pubkey>,
140 "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>,
141 "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>
142 }, 166 },
143 "items": [ 167 "items": [
144 { 168 {
145 "product_id": <String, UUID of the product>, 169 "product_id": <string, id of the product>,
146 "quantity": <int, how many products the customer is ordering> 170 "quantity": <int, how many products the customer is ordering>
147 } 171 }
148 ], 172 ],
149 "shipping_id": <String, UUID of the shipping zone> 173 "shipping_id": <string, id of the shipping zone>
150} 174}
151 175
152``` 176```
153 177
154_Open_: is `contact.nostr` required? 178_Open_: is `contact.nostr` required?
155 179
156 180
157### Step 2: `merchant` request payment (event) 181### Step 2: `merchant` request payment (event)
158 182
159Sent 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.
160 184
161The 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).
162 186
163`payment_options`/`type` include: 187`payment_options`/`type` include:
164 188
@@ -169,46 +193,146 @@ The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/ni
169 193
170```json 194```json
171{ 195{
172 "id": <String, UUID of the order>, 196 "id": <string, id of the order>,
173 "type": 1, 197 "type": 1,
174 "message": <String, message to customer, optional>, 198 "message": <string, message to customer, optional>,
175 "payment_options": [ 199 "payment_options": [
176 { 200 {
177 "type": <String, option type>, 201 "type": <string, option type>,
178 "link": <String, url, btc address, ln invoice, etc> 202 "link": <string, url, btc address, ln invoice, etc>
179 }, 203 },
204 {
205 "type": <string, option type>,
206 "link": <string, url, btc address, ln invoice, etc>
207 },
208 {
209 "type": <string, option type>,
210 "link": <string, url, btc address, ln invoice, etc>
211 }
212 ]
213}
214```
215
216### Step 3: `merchant` verify payment/shipped (event)
217
218Once payment has been received and processed.
219
220The below JSON goes in `content` of [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md).
221
222```json
223{
224 "id": <string, id of the order>,
225 "type": 2,
226 "message": <string, message to customer>,
227 "paid": <bool: has received payment>,
228 "shipped": <bool: has been shipped>,
229}
230```
231
232## Customize Marketplace
233
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.
235
236### Event `30019`: Create or update marketplace UI/UX
237
238**Event Content**
239
240```json
241{
242 "name": <string (optional), market name>,
243 "about": <string (optional), market description>,
244 "ui": {
245 "picture": <string (optional), market logo image URL>,
246 "banner": <string (optional), market logo banner URL>,
247 "theme": <string (optional), market theme>,
248 "darkMode": <bool, true/false>
249 },
250 "merchants": [array of pubkeys (optional)],
251 ...
252}
253```
254
255This event leverages naddr to enable comprehensive customization and sharing of marketplace configurations, fostering a unique and engaging marketplace environment.
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": [
180 { 276 {
181 "type": <String, option type>, 277 "id": <String, UUID of the shipping zone. Must match one of the zones defined for the stall>,
182 "link": <String, url, btc address, ln invoice, etc> 278 "cost": <float, extra cost for shipping. The currency is defined at the stall level>
183 },
184 {
185 "type": <String, option type>,
186 "link": <String, url, btc address, ln invoice, etc>
187 } 279 }
188 ] 280 ]
189} 281}
190``` 282```
191 283
192### Step 3: `merchant` verify payment/shipped (event) 284> [!NOTE]
285> Items sold as an auction are very similar in structure to fixed-price items, with some important differences worth noting.
193 286
194Once payment has been received and processed. 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!
195 304
196The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md). 305### Event `1022`: Bid confirmation
306
307**Event Content**:
197 308
198```json 309```json
199{ 310{
200 "id": <String, UUID of the order>, 311 "status": <String, "accepted" | "rejected" | "pending" | "winner">,
201 "type": 2, 312 "message": <String (optional)>,
202 "message": <String, message to customer>, 313 "duration_extended": <int (optional), number of seconds>
203 "paid": <Bool, true/false has received payment>,
204 "shipped": <Bool, true/false has been shipped>,
205} 314}
206``` 315```
207 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
208## Customer support events 332## Customer support events
209 333
210Customer 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.
211 335
212## Additional 336## Additional
213 337
214Standard data models can be found here <a href="https://raw.githubusercontent.com/lnbits/nostrmarket/main/models.py">here</a> 338Standard data models can be found <a href="https://raw.githubusercontent.com/lnbits/nostrmarket/main/models.py">here</a>
diff --git a/16.md b/16.md
index 4d9481d..0032083 100644
--- a/16.md
+++ b/16.md
@@ -4,35 +4,6 @@ NIP-16
4Event Treatment 4Event Treatment
5--------------- 5---------------
6 6
7`draft` `optional` `author:Semisol` 7`final` `mandatory`
8 8
9Relays may decide to allow replaceable and/or ephemeral events. 9Moved to [NIP-01](01.md).
10
11Regular Events
12------------------
13A *regular event* is defined as an event with a kind `1000 <= n < 10000`.
14Upon a regular event being received, the relay SHOULD send it to all clients with a matching filter, and SHOULD store it. New events of the same kind do not affect previous events in any way.
15
16Replaceable Events
17------------------
18A *replaceable event* is defined as an event with a kind `10000 <= n < 20000`.
19Upon a replaceable event with a newer timestamp than the currently known latest replaceable event with the same kind and author being received, the old event SHOULD be discarded,
20effectively replacing what gets returned when querying for
21`author:kind` tuples.
22
23Ephemeral Events
24----------------
25An *ephemeral event* is defined as an event with a kind `20000 <= n < 30000`.
26Upon an ephemeral event being received, the relay SHOULD send it to all clients with a matching filter, and MUST NOT store it.
27
28Client Behavior
29---------------
30
31Clients SHOULD use the `supported_nips` field to learn if a relay supports this NIP. Clients SHOULD NOT send ephemeral events to relays that do not support this NIP; they will most likely be persisted. Clients MAY send replaceable events to relays that may not support this NIP, and clients querying SHOULD be prepared for the relay to send multiple events and should use the latest one.
32
33Suggested Use Cases
34-------------------
35
36* States: An application may create a state event that is replaced every time a new state is set (such as statuses)
37* Typing indicators: A chat application may use ephemeral events as a typing indicator.
38* Messaging: Two pubkeys can message over nostr using ephemeral events.
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 422ad9c..27c5915 100644
--- a/18.md
+++ b/18.md
@@ -4,13 +4,12 @@ NIP-18
4Reposts 4Reposts
5------- 5-------
6 6
7`draft` `optional` `author:jb55` `author:fiatjaf` `author:arthurfranca` 7`draft` `optional`
8 8
9A repost is a `kind 6` note that is used to signal to followers 9A repost is a `kind 6` event that is used to signal to followers
10that another event is worth reading. 10that a `kind 1` text note is worth reading.
11 11
12The `content` of a repost event is empty. Optionally, it MAY contain 12The `content` of a repost event is _the stringified JSON of the reposted note_. It MAY also be empty, but that is not recommended.
13the stringified JSON of the reposted note event for quick look up.
14 13
15The repost event MUST include an `e` tag with the `id` of the note that is 14The repost event MUST include an `e` tag with the `id` of the note that is
16being reposted. That tag MUST include a relay URL as its third entry 15being reposted. That tag MUST include a relay URL as its third entry
@@ -21,5 +20,16 @@ reposted.
21 20
22## Quote Reposts 21## Quote Reposts
23 22
24Quote reposts are `kind 1` events with an embedded `e` tag (see [NIP-08](08.md) and [NIP-27](27.md)). 23Quote reposts are `kind 1` events with an embedded `q` tag of the note being
25Because a quote repost includes an `e` tag, it may show up along replies to the reposted note. 24quote reposted. The `q` tag ensures quote reposts are not pulled and included
25as replies in threads. It also allows you to easily pull and count all of the
26quotes for a post.
27
28## Generic Reposts
29
30Since `kind 6` reposts are reserved for `kind 1` contents, we use `kind 16`
31as a "generic repost", that can include any kind of event inside other than
32`kind 1`.
33
34`kind 16` reposts SHOULD contain a `k` tag with the stringified kind number
35of the reposted event as its value.
diff --git a/19.md b/19.md
index 6fc4523..ef80887 100644
--- a/19.md
+++ b/19.md
@@ -4,7 +4,7 @@ NIP-19
4bech32-encoded entities 4bech32-encoded entities
5----------------------- 5-----------------------
6 6
7`draft` `optional` `author:jb55` `author:fiatjaf` `author:Semisol` 7`draft` `optional`
8 8
9This NIP standardizes bech32-formatted strings that can be used to display keys, ids and other information in clients. These formats are not meant to be used anywhere in the core protocol, they are only meant for displaying to users, copy-pasting, sharing, rendering QR codes and inputting data. 9This NIP standardizes bech32-formatted strings that can be used to display keys, ids and other information in clients. These formats are not meant to be used anywhere in the core protocol, they are only meant for displaying to users, copy-pasting, sharing, rendering QR codes and inputting data.
10 10
@@ -35,7 +35,7 @@ These are the possible bech32 prefixes with `TLV`:
35 - `nprofile`: a nostr profile 35 - `nprofile`: a nostr profile
36 - `nevent`: a nostr event 36 - `nevent`: a nostr event
37 - `nrelay`: a nostr relay 37 - `nrelay`: a nostr relay
38 - `naddr`: a nostr parameterized replaceable event coordinate (NIP-33) 38 - `naddr`: a nostr _replaceable event_ coordinate
39 39
40These possible standardized `TLV` types are indicated here: 40These possible standardized `TLV` types are indicated here:
41 41
@@ -44,7 +44,7 @@ These possible standardized `TLV` types are indicated here:
44 - for `nprofile` it will be the 32 bytes of the profile public key 44 - for `nprofile` it will be the 32 bytes of the profile public key
45 - for `nevent` it will be the 32 bytes of the event id 45 - for `nevent` it will be the 32 bytes of the event id
46 - for `nrelay`, this is the relay URL 46 - for `nrelay`, this is the relay URL
47 - for `naddr`, it is the identifier (the `"d"` tag) of the event being referenced 47 - for `naddr`, it is the identifier (the `"d"` tag) of the event being referenced. For non-parameterized replaceable events, use an empty string.
48- `1`: `relay` 48- `1`: `relay`
49 - for `nprofile`, `nevent` and `naddr`, _optionally_, a relay in which the entity (profile or event) is more likely to be found, encoded as ascii 49 - for `nprofile`, `nevent` and `naddr`, _optionally_, a relay in which the entity (profile or event) is more likely to be found, encoded as ascii
50 - this may be included multiple times 50 - this may be included multiple times
diff --git a/20.md b/20.md
index 7e97dd9..6feed6a 100644
--- a/20.md
+++ b/20.md
@@ -1,93 +1,9 @@
1NIP-20 1NIP-20
2====== 2======
3 3
4
5Command Results 4Command Results
6--------------- 5---------------
7 6
8`draft` `optional` `author:jb55` 7`final` `mandatory`
9
10When submitting events to relays, clients currently have no way to know if an event was successfully committed to the database. This NIP introduces the concept of command results which are like NOTICE's except provide more information about if an event was accepted or rejected.
11
12A command result is a JSON object with the following structure that is returned when an event is successfully saved to the database or rejected:
13
14 ["OK", <event_id>, <true|false>, <message>]
15
16Relays MUST return `true` when the event is a duplicate and has already been saved. The `message` SHOULD start with `duplicate:` in this case.
17
18Relays MUST return `false` when the event was rejected and not saved.
19
20The `message` SHOULD provide additional information as to why the command succeeded or failed.
21
22The `message` SHOULD start with `blocked:` if the pubkey or network address has been blocked, banned, or is not on a whitelist.
23
24The `message` SHOULD start with `invalid:` if the event is invalid or doesn't meet some specific criteria (created_at is too far off, id is wrong, signature is wrong, etc)
25
26The `message` SHOULD start with `pow:` if the event doesn't meet some proof-of-work difficulty. The client MAY consult the relay metadata at this point to retrieve the required posting difficulty.
27
28The `message` SHOULD start with `rate-limited:` if the event was rejected due to rate limiting techniques.
29
30The `message` SHOULD start with `error:` if the event failed to save due to a server issue.
31
32Ephemeral events are not acknowledged with OK responses, unless there is a failure.
33
34If the event or `EVENT` command is malformed and could not be parsed, a NOTICE message SHOULD be used instead of a command result. This NIP only applies to non-malformed EVENT commands.
35
36
37Examples
38--------
39
40Event successfully written to the database:
41
42 ["OK", "b1a649ebe8b435ec71d3784793f3bbf4b93e64e17568a741aecd4c7ddeafce30", true, ""]
43
44Event successfully written to the database because of a reason:
45
46 ["OK", "b1a649ebe8b435ec71d3784793f3bbf4b93e64e17568a741aecd4c7ddeafce30", true, "pow: difficulty 25>=24"]
47
48Event blocked due to ip filter
49
50 ["OK", "b1a649ebe8...", false, "blocked: tor exit nodes not allowed"]
51
52Event blocked due to pubkey ban
53
54 ["OK", "b1a649ebe8...", false, "blocked: you are banned from posting here"]
55
56Event blocked, pubkey not registered
57
58 ["OK", "b1a649ebe8...", false, "blocked: please register your pubkey at https://my-expensive-relay.example.com"]
59
60Event rejected, rate limited
61
62 ["OK", "b1a649ebe8...", false, "rate-limited: slow down there chief"]
63
64Event rejected, `created_at` too far off
65
66 ["OK", "b1a649ebe8...", false, "invalid: event creation date is too far off from the current time. Is your system clock in sync?"]
67
68Event rejected, insufficient proof-of-work difficulty
69
70 ["OK", "b1a649ebe8...", false, "pow: difficulty 26 is less than 30"]
71
72Event failed to save,
73
74 ["OK", "b1a649ebe8...", false, "error: could not connect to the database"]
75
76
77
78Client Handling
79---------------
80
81`messages` are meant for humans, with `reason:` prefixes so that clients can be slightly more intelligent with what to do with them. For example, with a `rate-limited:` reason the client may not show anything and simply try again with a longer timeout.
82
83For the `pow:` prefix it may query relay metadata to get the updated difficulty requirement and try again in the background.
84
85For the `invalid:` and `blocked:` prefix the client may wish to show these as styled error popups.
86
87The prefixes include a colon so that the message can be cleanly separated from the prefix by taking everything after `:` and trimming it.
88
89
90Future Extensions
91-----------------
92 8
93This proposal SHOULD be extended to support further commands in the future, such as REQ and AUTH. They are left out of this initial version to keep things simpler. 9Moved to [NIP-01](01.md).
diff --git a/21.md b/21.md
index 6246eb4..6ed141a 100644
--- a/21.md
+++ b/21.md
@@ -4,7 +4,7 @@ NIP-21
4`nostr:` URI scheme 4`nostr:` URI scheme
5------------------- 5-------------------
6 6
7`draft` `optional` `author:fiatjaf` 7`draft` `optional`
8 8
9This NIP standardizes the usage of a common URI scheme for maximum interoperability and openness in the network. 9This NIP standardizes the usage of a common URI scheme for maximum interoperability and openness in the network.
10 10
diff --git a/22.md b/22.md
deleted file mode 100644
index 2172519..0000000
--- a/22.md
+++ /dev/null
@@ -1,45 +0,0 @@
1NIP-22
2======
3
4Event `created_at` Limits
5---------------------------
6
7`draft` `optional` `author:jeffthibault` `author:Giszmo`
8
9Relays may define both upper and lower limits within which they will consider an event's `created_at` to be acceptable. Both the upper and lower limits MUST be unix timestamps in seconds as defined in [NIP-01](01.md).
10
11If a relay supports this NIP, the relay SHOULD send the client a [NIP-20](20.md) command result saying the event was not stored for the `created_at` timestamp not being within the permitted limits.
12
13Client Behavior
14---------------
15
16Clients SHOULD use the [NIP-11](11.md) `supported_nips` field to learn if a relay uses event `created_at` time limits as defined by this NIP.
17
18Motivation
19----------
20
21This NIP formalizes restrictions on event timestamps as accepted by a relay and allows clients to be aware of relays that have these restrictions.
22
23The event `created_at` field is just a unix timestamp and can be set to a time in the past or future. Relays accept and share events dated to 20 years ago or 50,000 years in the future. This NIP aims to define a way for relays that do not want to store events with *any* timestamp to set their own restrictions.
24
25[Replaceable events](16.md#replaceable-events) can behave rather unexpectedly if the user wrote them - or tried to write them - with a wrong system clock. Persisting an update with a backdated system now would result in the update not getting persisted without a notification and if they did the last update with a forward dated system, they will again fail to do another update with the now correct time.
26
27A wide adoption of this NIP could create a better user experience as it would decrease the amount of events that appear wildly out of order or even from impossible dates in the distant past or future.
28
29Keep in mind that there is a use case where a user migrates their old posts onto a new relay. If a relay rejects events that were not recently created, it cannot serve this use case.
30
31
32Python (pseudocode) Example
33---------------------------
34
35```python
36import time
37
38TIME = int(time.time())
39LOWER_LIMIT = TIME - (60 * 60 * 24) # Define lower limit as 1 day into the past
40UPPER_LIMIT = TIME + (60 * 15) # Define upper limit as 15 minutes into the future
41
42if event.created_at not in range(LOWER_LIMIT, UPPER_LIMIT):
43 ws.send('["OK", event.id, False, "invalid: the event created_at field is out of the acceptable range (-24h, +15min) for this relay"]')
44```
45Note: These are just example limits, the relay operator can choose whatever limits they want.
diff --git a/23.md b/23.md
index 151a31b..382df83 100644
--- a/23.md
+++ b/23.md
@@ -4,19 +4,23 @@ NIP-23
4Long-form Content 4Long-form Content
5----------------- 5-----------------
6 6
7`draft` `optional` `author:fiatjaf` 7`draft` `optional`
8 8
9This NIP defines `kind:30023` (a parameterized replaceable event according to [NIP-33](33.md)) for long-form text content, generally referred to as "articles" or "blog posts". 9This NIP defines `kind:30023` (a _parameterized replaceable event_) for long-form text content, generally referred to as "articles" or "blog posts". `kind:30024` has the same structure as `kind:30023` and is used to save long form drafts.
10 10
11"Social" clients that deal primarily with `kind:1` notes should not be expected to implement this NIP. 11"Social" clients that deal primarily with `kind:1` notes should not be expected to implement this NIP.
12 12
13### Format 13### Format
14 14
15The `.content` of these events should be a string text in Markdown syntax. 15The `.content` of these events should be a string text in Markdown syntax. To maximize compatibility and readability between different clients and devices, any client that is creating long form notes:
16
17- MUST NOT hard line-break paragraphs of text, such as arbitrary line breaks at 80 column boundaries.
18
19- MUST NOT support adding HTML to Markdown.
16 20
17### Metadata 21### Metadata
18 22
19For the date of the last update the `.created_at` field should be used, for "tags"/"hashtags" (i.e. topics about which the event might be of relevance) the `"t"` event tag should be used, as per NIP-12. 23For the date of the last update the `.created_at` field should be used, for "tags"/"hashtags" (i.e. topics about which the event might be of relevance) the `t` tag should be used, as per NIP-12.
20 24
21Other metadata fields can be added as tags to the event as necessary. Here we standardize 4 that may be useful, although they remain strictly optional: 25Other metadata fields can be added as tags to the event as necessary. Here we standardize 4 that may be useful, although they remain strictly optional:
22 26
@@ -27,11 +31,11 @@ Other metadata fields can be added as tags to the event as necessary. Here we st
27 31
28### Editability 32### Editability
29 33
30These articles are meant to be editable, so they should make use of the replaceability feature of NIP-33 and include a `"d"` tag with an identifier for the article. Clients should take care to only publish and read these events from relays that implement that. If they don't do that they should also take care to hide old versions of the same article they may receive. 34These articles are meant to be editable, so they should make use of the parameterized replaceability feature and include a `d` tag with an identifier for the article. Clients should take care to only publish and read these events from relays that implement that. If they don't do that they should also take care to hide old versions of the same article they may receive.
31 35
32### Linking 36### Linking
33 37
34The article may be linked to using the NIP-19 `naddr` code along with the `"a"` tag (see [NIP-33](33.md) and [NIP-19](19.md)). 38The article may be linked to using the [NIP-19](19.md) `naddr` code along with the `a` tag.
35 39
36### References 40### References
37 41
diff --git a/24.md b/24.md
new file mode 100644
index 0000000..3adec24
--- /dev/null
+++ b/24.md
@@ -0,0 +1,43 @@
1NIP-24
2======
3
4Extra metadata fields and tags
5------------------------------
6
7`draft` `optional`
8
9This NIP defines extra optional fields added to events.
10
11kind 0
12======
13
14These are extra fields not specified in NIP-01 that may be present in the stringified JSON of metadata events:
15
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.
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.
20
21### Deprecated fields
22
23These are fields that should be ignored or removed when found in the wild:
24
25 - `displayName`: use `display_name` instead.
26 - `username`: use `name` instead.
27
28kind 3
29======
30
31These are extra fields not specified in NIP-02 that may be present in the stringified JSON of follow events:
32
33### Deprecated fields
34
35 - `{<relay-url>: {"read": <true|false>, "write": <true|false>}, ...}`: an object of relays used by a user to read/write. [NIP-65](65.md) should be used instead.
36
37tags
38====
39
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:
41
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 f74bcc0..17c203e 100644
--- a/25.md
+++ b/25.md
@@ -5,9 +5,9 @@ NIP-25
5Reactions 5Reactions
6--------- 6---------
7 7
8`draft` `optional` `author:jb55` 8`draft` `optional`
9 9
10A reaction is a `kind 7` note that is used to react to other notes. 10A reaction is a `kind 7` event that is used to react to other events.
11 11
12The generic reaction, represented by the `content` set to a `+` string, SHOULD 12The generic reaction, represented by the `content` set to a `+` string, SHOULD
13be interpreted as a "like" or "upvote". 13be interpreted as a "like" or "upvote".
@@ -18,32 +18,56 @@ downvote or dislike on a post. A client MAY also choose to tally likes against
18dislikes in a reddit-like system of upvotes and downvotes, or display them as 18dislikes in a reddit-like system of upvotes and downvotes, or display them as
19separate tallies. 19separate tallies.
20 20
21The `content` MAY be an emoji, in this case it MAY be interpreted as a "like" or "dislike", 21The `content` MAY be an emoji, or [NIP-30](30.md) custom emoji in this case it MAY be interpreted as a "like" or "dislike",
22or the client MAY display this emoji reaction on the post. 22or the client MAY display this emoji reaction on the post. If the `content` is an empty string then the client should
23consider it a "+".
23 24
24Tags 25Tags
25---- 26----
26 27
27The reaction event SHOULD include `e` and `p` tags from the note the user is 28The reaction event SHOULD include `e` and `p` tags from the note the user is reacting to (and optionally `a` tags if the target is a replaceable event). This allows users to be notified of reactions to posts they were mentioned in. Including the `e` tags enables clients to pull all the reactions associated with individual posts or all the posts in a thread. `a` tags enables clients to seek reactions for all versions of a replaceable event.
28reacting to. This allows users to be notified of reactions to posts they were
29mentioned in. Including the `e` tags enables clients to pull all the reactions
30associated with individual posts or all the posts in a thread.
31 29
32The last `e` tag MUST be the `id` of the note that is being reacted to. 30The last `e` tag MUST be the `id` of the note that is being reacted to.
33 31
34The last `p` tag MUST be the `pubkey` of the event being reacted to. 32The last `p` tag MUST be the `pubkey` of the event being reacted to.
35 33
34The `a` tag MUST contain the coordinates (`kind:pubkey:d-tag`) of the replaceable being reacted to.
35
36The reaction event MAY include a `k` tag with the stringified kind number of the reacted event as its value.
37
36Example code 38Example code
37 39
38```swift 40```swift
39func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> NostrEvent { 41func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> NostrEvent {
40 var tags: [[String]] = liked.tags.filter { 42 var tags: [[String]] = liked.tags.filter {
41 tag in tag.count >= 2 && (tag[0] == "e" || tag[0] == "p") 43 tag in tag.count >= 2 && (tag[0] == "e" || tag[0] == "p")
42 } 44 }
43 tags.append(["e", liked.id]) 45 tags.append(["e", liked.id])
44 tags.append(["p", liked.pubkey]) 46 tags.append(["p", liked.pubkey])
47 tags.append(["k", liked.kind])
45 let ev = NostrEvent(content: "+", pubkey: pubkey, kind: 7, tags: tags) 48 let ev = NostrEvent(content: "+", pubkey: pubkey, kind: 7, tags: tags)
46 ev.calculate_id() 49 ev.calculate_id()
47 ev.sign(privkey: privkey) 50 ev.sign(privkey: privkey)
48 return ev 51 return ev
49} 52}
53```
54
55Custom Emoji Reaction
56---------------------
57
58The client may specify a custom emoji ([NIP-30](30.md)) `:shortcode:` in the
59reaction content. The client should refer to the emoji tag and render the
60content as an emoji if shortcode is specified.
61
62```json
63{
64 "kind": 7,
65 "content": ":soapbox:",
66 "tags": [
67 ["emoji", "soapbox", "https://gleasonator.com/emoji/Gleasonator/soapbox.png"]
68 ],
69 ...other fields
70}
71```
72
73The content can be set only one `:shortcode:`. And emoji tag should be one.
diff --git a/26.md b/26.md
index b8fa902..86c46e1 100644
--- a/26.md
+++ b/26.md
@@ -1,10 +1,10 @@
1NIP: 26 1NIP-26
2======= 2=======
3 3
4Delegated Event Signing 4Delegated Event Signing
5----- 5-----
6 6
7`draft` `optional` `author:markharding` `author:minds` 7`draft` `optional`
8 8
9This NIP defines how events can be delegated so that they can be signed by other keypairs. 9This NIP defines how events can be delegated so that they can be signed by other keypairs.
10 10
@@ -52,7 +52,9 @@ For example, the following condition strings are valid:
52- `kind=0&kind=1&created_at>1675721813` 52- `kind=0&kind=1&created_at>1675721813`
53- `kind=1&created_at>1674777689&created_at<1675721813` 53- `kind=1&created_at>1674777689&created_at<1675721813`
54 54
55For the vast majority of use-cases, it is advisable that query strings should include a `created_at` ***after*** condition reflecting the current time, to prevent the delegatee from publishing historic notes on the delegator's behalf. 55For the vast majority of use-cases, it is advisable that:
561. Query strings should include a `created_at` ***after*** condition reflecting the current time, to prevent the delegatee from publishing historic notes on the delegator's behalf.
572. Query strings should include a `created_at` ***before*** condition that is not empty and is not some extremely distant time in the future. If delegations are not limited in time scope, they expose similar security risks to simply using the root key for authentication.
56 58
57#### Example 59#### Example
58 60
@@ -105,4 +107,4 @@ Clients should display the delegated note as if it was published directly by the
105 107
106Relays should answer requests such as `["REQ", "", {"authors": ["A"]}]` by querying both the `pubkey` and delegation tags `[1]` value. 108Relays should answer requests such as `["REQ", "", {"authors": ["A"]}]` by querying both the `pubkey` and delegation tags `[1]` value.
107 109
108Relays SHOULD allow the delegator (8e0d3d3e) to delete the events published by the delegatee (477318cf). \ No newline at end of file 110Relays SHOULD allow the delegator (8e0d3d3e) to delete the events published by the delegatee (477318cf).
diff --git a/27.md b/27.md
index 6d76120..133f8ef 100644
--- a/27.md
+++ b/27.md
@@ -4,7 +4,7 @@ NIP-27
4Text Note References 4Text Note References
5-------------------- 5--------------------
6 6
7`draft` `optional` `author:arthurfranca` `author:hodlbod` `author:fiatjaf` 7`draft` `optional`
8 8
9This document standardizes the treatment given by clients of inline references of other events and profiles inside the `.content` of any event that has readable text in its `.content` (such as kinds 1 and 30023). 9This document standardizes the treatment given by clients of inline references of other events and profiles inside the `.content` of any event that has readable text in its `.content` (such as kinds 1 and 30023).
10 10
@@ -20,7 +20,7 @@ A reader client that receives an event with such `nostr:...` mentions in its `.c
20 20
21Suppose Bob is writing a note in a client that has search-and-autocomplete functionality for users that is triggered when they write the character `@`. 21Suppose Bob is writing a note in a client that has search-and-autocomplete functionality for users that is triggered when they write the character `@`.
22 22
23As Bob types `"hello @mat"` the client will prompt him to autocomplete with [mattn's profile](https://gateway.nostr.com/p/2c7cc62a697ea3a7826521f3fd34f0cb273693cbe5e9310f35449f43622a5cdc), showing a picture and name. 23As Bob types `"hello @mat"` the client will prompt him to autocomplete with [mattn's profile](https://njump.me/npub1937vv2nf06360qn9y8el6d8sevnndy7tuh5nzre4gj05xc32tnwqauhaj6), showing a picture and name.
24 24
25Bob presses "enter" and now he sees his typed note as `"hello @mattn"`, `@mattn` is highlighted, indicating that it is a mention. Internally, however, the event looks like this: 25Bob presses "enter" and now he sees his typed note as `"hello @mattn"`, `@mattn` is highlighted, indicating that it is a mention. Internally, however, the event looks like this:
26 26
diff --git a/28.md b/28.md
index 169ae4f..1632088 100644
--- a/28.md
+++ b/28.md
@@ -5,7 +5,7 @@ NIP-28
5Public Chat 5Public Chat
6----------- 6-----------
7 7
8`draft` `optional` `author:ChristopherDavid` `author:fiatjaf` `author:jb55` `author:Cameri` 8`draft` `optional`
9 9
10This NIP defines new event kinds for public chat channels, channel messages, and basic client-side moderation. 10This NIP defines new event kinds for public chat channels, channel messages, and basic client-side moderation.
11 11
@@ -23,12 +23,12 @@ 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```
34 34
@@ -37,7 +37,7 @@ In the channel creation `content` field, Client SHOULD include basic channel met
37 37
38Update a channel's public metadata. 38Update a channel's public metadata.
39 39
40Clients and relays SHOULD handle kind 41 events similar to kind 0 `metadata` events. 40Kind 41 is used to update the metadata without modifying the event id for the channel. Only the most recent kind 41 per `e` tag value MAY be available.
41 41
42Clients SHOULD ignore kind 41s from pubkeys other than the kind 40 pubkey. 42Clients SHOULD ignore kind 41s from pubkeys other than the kind 40 pubkey.
43 43
@@ -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,9 +54,9 @@ 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}
60``` 61```
61 62
@@ -72,9 +73,9 @@ Root message:
72 73
73```json 74```json
74{ 75{
75 "content": <string>, 76 "content": <string>,
76 "tags": [["e", <kind_40_event_id>, <relay-url>, "root"]], 77 "tags": [["e", <kind_40_event_id>, <relay-url>, "root"]],
77 ... 78 ...
78} 79}
79``` 80```
80 81
@@ -82,14 +83,14 @@ Reply to another message:
82 83
83```json 84```json
84{ 85{
85 "content": <string>, 86 "content": <string>,
86 "tags": [ 87 "tags": [
87 ["e", <kind_40_event_id>, <relay-url>, "root"], 88 ["e", <kind_40_event_id>, <relay-url>, "root"],
88 ["e", <kind_42_event_id>, <relay-url>, "reply"], 89 ["e", <kind_42_event_id>, <relay-url>, "reply"],
89 ["p", <pubkey>, <relay-url>], 90 ["p", <pubkey>, <relay-url>],
90 ... 91 ...
91 ], 92 ],
92 ... 93 ...
93} 94}
94``` 95```
95 96
@@ -108,9 +109,9 @@ Clients MAY hide event 42s for other users other than the user who sent the even
108 109
109```json 110```json
110{ 111{
111 "content": "{\"reason\": \"Dick pic\"}", 112 "content": "{\"reason\": \"Dick pic\"}",
112 "tags": [["e", <kind_42_event_id>]], 113 "tags": [["e", <kind_42_event_id>]],
113 ... 114 ...
114} 115}
115``` 116```
116 117
@@ -126,18 +127,17 @@ Clients MAY hide event 42s for users other than the user who sent the event 44.
126 127
127```json 128```json
128{ 129{
129 "content": "{\"reason\": \"Posting dick pics\"}", 130 "content": "{\"reason\": \"Posting dick pics\"}",
130 "tags": [["p", <pubkey>]], 131 "tags": [["p", <pubkey>]],
131 ... 132 ...
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..74dfd66
--- /dev/null
+++ b/29.md
@@ -0,0 +1,198 @@
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| 9007 | `create-group` | |
123
124- *group metadata* (`kind:39000`) (optional)
125
126This 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.
127
128If the group is forked and hosted in multiple relays, there will be multiple versions of this event in each different relay and so on.
129
130```js
131{
132 "kind": 39000,
133 "content": "",
134 "tags": [
135 ["d", "<group-id>"],
136 ["name", "Pizza Lovers"],
137 ["picture", "https://pizza.com/pizza.png"],
138 ["about", "a group for people who love pizza"],
139 ["public"], // or ["private"]
140 ["open"] // or ["closed"]
141 ]
142 ...
143}
144```
145
146`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.
147
148- *group admins* (`kind:39001`) (optional)
149
150Similar to the group metadata, this event is supposed to be generated by relays that host the group.
151
152Each 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.
153
154The list of capabilities, as defined by this NIP, for now, is the following:
155
156- `add-user`
157- `edit-metadata`
158- `delete-event`
159- `remove-user`
160- `add-permission`
161- `remove-permission`
162- `edit-group-status`
163
164```js
165{
166 "kind": 39001,
167 "content": "list of admins for the pizza lovers group",
168 "tags": [
169 ["d", "<group-id>"],
170 ["p", "<pubkey1-as-hex>", "ceo", "add-user", "edit-metadata", "delete-event", "remove-user"],
171 ["p", "<pubkey2-as-hex>", "secretary", "add-user", "delete-event"]
172 ]
173 ...
174}
175```
176
177- *group members* (`kind:39002`) (optional)
178
179Similar to *group admins*, this event is supposed to be generated by relays that host the group.
180
181It'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.
182
183```json
184{
185 "kind": 39002,
186 "content": "list of members for the pizza lovers group",
187 "tags": [
188 ["d", "<group-id>"],
189 ["p", "<admin1>"],
190 ["p", "<member-pubkey1>"],
191 ["p", "<member-pubkey2>"],
192 ]
193}
194```
195
196## Storing the list of groups a user belongs to
197
198A 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
new file mode 100644
index 0000000..c2f8bb0
--- /dev/null
+++ b/30.md
@@ -0,0 +1,56 @@
1NIP-30
2======
3
4Custom Emoji
5------------
6
7`draft` `optional`
8
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
11```
12["emoji", <shortcode>, <image-url>]
13```
14
15Where:
16
17- `<shortcode>` is a name given for the emoji, which MUST be comprised of only alphanumeric characters and underscores.
18- `<image-url>` is a URL to the corresponding image file of the emoji.
19
20For each emoji tag, clients should parse emoji shortcodes (aka "emojify") like `:shortcode:` in the event to display custom emoji.
21
22Clients may allow users to add custom emoji to an event by including `:shortcode:` identifier in the event, and adding the relevant `"emoji"` tags.
23
24### Kind 0 events
25
26In kind 0 events, the `name` and `about` fields should be emojified.
27
28```json
29{
30 "kind": 0,
31 "content": "{\"name\":\"Alex Gleason :soapbox:\"}",
32 "tags": [
33 ["emoji", "soapbox", "https://gleasonator.com/emoji/Gleasonator/soapbox.png"]
34 ],
35 "pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6",
36 "created_at": 1682790000
37}
38```
39
40### Kind 1 events
41
42In kind 1 events, the `content` should be emojified.
43
44```json
45{
46 "kind": 1,
47 "content": "Hello :gleasonator: 😂 :ablobcatrainbow: :disputed: yolo",
48 "tags": [
49 ["emoji", "ablobcatrainbow", "https://gleasonator.com/emoji/blobcat/ablobcatrainbow.png"],
50 ["emoji", "disputed", "https://gleasonator.com/emoji/Fun/disputed.png"],
51 ["emoji", "gleasonator", "https://gleasonator.com/emoji/Gleasonator/gleasonator.png"]
52 ],
53 "pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6",
54 "created_at": 1682630000
55}
56```
diff --git a/31.md b/31.md
new file mode 100644
index 0000000..ee92052
--- /dev/null
+++ b/31.md
@@ -0,0 +1,15 @@
1NIP-31
2======
3
4Dealing with unknown event kinds
5--------------------------------
6
7`draft` `optional`
8
9When creating a new custom event kind that is part of a custom protocol and isn't meant to be read as text (like `kind:1`), clients should use an `alt` tag to write a short human-readable plaintext summary of what that event is about.
10
11The intent is that social clients, used to display only `kind:1` notes, can still show something in case a custom event pops up in their timelines. The content of the `alt` tag should provide enough context for a user that doesn't know anything about this event kind to understand what it is.
12
13These clients that only know `kind:1` are not expected to ask relays for events of different kinds, but users could still reference these weird events on their notes, and without proper context these could be nonsensical notes. Having the fallback text makes that situation much better -- even if only for making the user aware that they should try to view that custom event elsewhere.
14
15`kind:1`-centric clients can make interacting with these event kinds more functional by supporting [NIP-89](https://github.com/nostr-protocol/nips/blob/master/89.md).
diff --git a/32.md b/32.md
new file mode 100644
index 0000000..79f5937
--- /dev/null
+++ b/32.md
@@ -0,0 +1,163 @@
1NIP-32
2======
3
4Labeling
5---------
6
7`draft` `optional`
8
9A label is a `kind 1985` event that is used to label other entities. This supports a number of use cases,
10including distributed moderation, collection management, license assignment, and content classification.
11
12This NIP introduces two new tags:
13
14- `L` denotes a label namespace
15- `l` denotes a label
16
17Label Namespace Tag
18----
19
20An `L` tag can be any string, but publishers SHOULD ensure they are unambiguous by using a well-defined namespace
21(such as an ISO standard) or reverse domain name notation.
22
23`L` tags are RECOMMENDED in order to support searching by namespace rather than by a specific tag. The special `ugc`
24("user generated content") namespace MAY be used when the label content is provided by an end user.
25
26`L` tags starting with `#` indicate that the label target should be associated with the label's value.
27This is a way of attaching standard nostr tags to events, pubkeys, relays, urls, etc.
28
29Label Tag
30----
31
32An `l` tag's value can be any string. If using an `L` tag, `l` tags MUST include a mark matching an `L`
33tag value in the same event. If no `L` tag is included, a mark SHOULD still be included. If none is
34included, `ugc` is implied.
35
36Label Target
37----
38
39The label event MUST include one or more tags representing the object or objects being
40labeled: `e`, `p`, `a`, `r`, or `t` tags. This allows for labeling of events, people, relays,
41or topics respectively. As with NIP-01, a relay hint SHOULD be included when using `e` and
42`p` tags.
43
44Content
45-------
46
47Labels should be short, meaningful strings. Longer discussions, such as for an
48explanation of why something was labeled the way it was, should go in the event's `content` field.
49
50Self-Reporting
51-------
52
53`l` and `L` tags MAY be added to other event kinds to support self-reporting. For events
54with a kind other than 1985, labels refer to the event itself.
55
56Example events
57--------------
58
59A suggestion that multiple pubkeys be associated with the `permies` topic.
60
61```json
62{
63 "kind": 1985,
64 "tags": [
65 ["L", "#t"],
66 ["l", "permies", "#t"],
67 ["p", <pubkey1>, <relay_url>],
68 ["p", <pubkey2>, <relay_url>]
69 ],
70 ...
71}
72```
73
74A report flagging violence toward a human being as defined by ontology.example.com.
75
76```json
77{
78 "kind": 1985,
79 "tags": [
80 ["L", "com.example.ontology"],
81 ["l", "VI-hum", "com.example.ontology"],
82 ["p", <pubkey1>, <relay_url>],
83 ["p", <pubkey2>, <relay_url>]
84 ],
85 ...
86}
87```
88
89A moderation suggestion for a chat event.
90
91```json
92{
93 "kind": 1985,
94 "tags": [
95 ["L", "nip28.moderation"],
96 ["l", "approve", "nip28.moderation"],
97 ["e", <kind40_event_id>, <relay_url>]
98 ],
99 ...
100}
101```
102
103Assignment of a license to an event.
104
105```json
106{
107 "kind": 1985,
108 "tags": [
109 ["L", "license"],
110 ["l", "MIT", "license"],
111 ["e", <event_id>, <relay_url>]
112 ],
113 ...
114}
115```
116
117Publishers can self-label by adding `l` tags to their own non-1985 events. In this case, the kind 1 event's author
118is labeling their note as being related to Milan, Italy using ISO 3166-2.
119
120```json
121{
122 "kind": 1,
123 "tags": [
124 ["L", "ISO-3166-2"],
125 ["l", "IT-MI", "ISO-3166-2"]
126 ],
127 "content": "It's beautiful here in Milan!",
128 ...
129}
130```
131
132Other Notes
133-----------
134
135When using this NIP to bulk-label many targets at once, events may be deleted and a replacement
136may be published. We have opted not to use parameterizable/replaceable events for this due to the
137complexity in coming up with a standard `d` tag. In order to avoid ambiguity when querying,
138publishers SHOULD limit labeling events to a single namespace.
139
140Before creating a vocabulary, explore how your use case may have already been designed and
141imitate that design if possible. Reverse domain name notation is encouraged to avoid
142namespace clashes, but for the sake of interoperability all namespaces should be
143considered open for public use, and not proprietary. In other words, if there is a
144namespace that fits your use case, use it even if it points to someone else's domain name.
145
146Vocabularies MAY choose to fully qualify all labels within a namespace (for example,
147`["l", "com.example.vocabulary:my-label"]`. This may be preferred when defining more
148formal vocabularies that should not be confused with another namespace when querying
149without an `L` tag. For these vocabularies, all labels SHOULD include the namespace
150(rather than mixing qualified and unqualified labels).
151
152A good heuristic for whether a use case fits this NIP is whether labels would ever be unique.
153For example, many events might be labeled with a particular place, topic, or pubkey, but labels
154with specific values like "John Doe" or "3.18743" are not labels, they are values, and should
155be handled in some other way.
156
157
158Appendix: Known Ontologies
159-------------------------
160
161Below is a non-exhaustive list of ontologies currently in widespread use.
162
163- [social.ontolo.categories](https://ontolo.social/)
diff --git a/33.md b/33.md
index 10681fa..337a1f9 100644
--- a/33.md
+++ b/33.md
@@ -4,50 +4,6 @@ NIP-33
4Parameterized Replaceable Events 4Parameterized Replaceable Events
5-------------------------------- 5--------------------------------
6 6
7`draft` `optional` `author:Semisol` `author:Kukks` `author:Cameri` `author:Giszmo` 7`final` `mandatory`
8 8
9This NIP adds a new event range that allows for replacement of events that have the same `d` tag and kind unlike NIP-16 which only replaced by kind. 9Moved to [NIP-01](01.md).
10
11Implementation
12--------------
13The value of a tag is defined as the first parameter of a tag after the tag name.
14
15A *parameterized replaceable event* is defined as an event with a kind `30000 <= n < 40000`.
16Upon a parameterized replaceable event with a newer timestamp than the currently known latest
17replaceable event with the same kind, author and first `d` tag value being received, the old event
18SHOULD be discarded, effectively replacing what gets returned when querying for
19`author:kind:d-tag` tuples.
20
21A missing or a `d` tag with no value should be interpreted equivalent to a `d` tag with the
22value as an empty string. Events from the same author with any of the following `tags`
23replace each other:
24
25* `"tags":[["d",""]]`
26* `"tags":[]`: implicit `d` tag with empty value
27* `"tags":[["d"]]`: implicit empty value `""`
28* `"tags":[["d",""],["d","not empty"]]`: only first `d` tag is considered
29* `"tags":[["d"],["d","some value"]]`: only first `d` tag is considered
30* `"tags":[["e"]]`: same as no tags
31* `"tags":[["d","","1"]]`: only the first value is considered (`""`)
32
33Clients SHOULD NOT use `d` tags with multiple values and SHOULD include the `d` tag even if it has no value to allow querying using the `#d` filter.
34
35Referencing and tagging
36-----------------------
37
38Normally (as per NIP-01, NIP-12) the `"p"` tag is used for referencing public keys and the
39`"e"` tag for referencing event ids and the `note`, `npub`, `nprofile` or `nevent` are their
40equivalents for event tags (i.e. an `nprofile` is generally translated into a tag
41`["p", "<event hex id>", "<relay url>"]`).
42
43To support linking to parameterized replaceable events, the `naddr` code is introduced on
44NIP-19. It includes the public key of the event author and the `d` tag (and relays) such that
45the referenced combination of public key and `d` tag can be found.
46
47The equivalent in `tags` to the `naddr` code is the tag `"a"`, comprised of `["a", "<kind>:<pubkey>:<d-identifier>", "<relay url>"]`.
48
49Client Behavior
50---------------
51
52Clients SHOULD use the `supported_nips` field to learn if a relay supports this NIP.
53Clients MAY send parameterized replaceable events to relays that may not support this NIP, and clients querying SHOULD be prepared for the relay to send multiple events and should use the latest one and are recommended to send a `#d` tag filter. Clients should account for the fact that missing `d` tags or ones with no value are not returned in tag filters, and are recommended to always include a `d` tag with a value.
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/35.md b/35.md
new file mode 100644
index 0000000..04cfb46
--- /dev/null
+++ b/35.md
@@ -0,0 +1,70 @@
1NIP-35
2======
3
4Torrents
5-----------
6
7`draft` `optional`
8
9This NIP defined a new `kind 2003` which is a Torrent.
10
11`kind 2003` is a simple torrent index where there is enough information to search for content and construct the magnet link. No torrent files exist on nostr.
12
13## Tags
14- `x`: V1 BitTorrent Info Hash, as seen in the [magnet link](https://www.bittorrent.org/beps/bep_0053.html) `magnet:?xt=urn:btih:HASH`
15- `file`: A file entry inside the torrent, including the full path ie. `info/example.txt`
16- `tracker`: (Optional) A tracker to use for this torrent
17
18In order to make torrents searchable by general category, you SHOULD include a few tags like `movie`, `tv`, `HD`, `UHD` etc.
19
20## Tag prefixes
21
22Tag prefixes are used to label the content with references, ie. `["i", "imdb:1234"]`
23
24- `tcat`: A comma separated text category path, ie. `["i", "tcat:video,movie,4k"]`, this should also match the `newznab` category in a best effort approach.
25- `newznab`: The category ID from [newznab](https://github.com/Prowlarr/Prowlarr/blob/develop/src/NzbDrone.Core/Indexers/NewznabStandardCategory.cs)
26- `tmdb`: [The movie database](https://www.themoviedb.org/) id.
27- `ttvdb`: [TV database](https://thetvdb.com/) id.
28- `imdb`: [IMDB](https://www.imdb.com/) id.
29- `mal`: [MyAnimeList](https://myanimelist.net/) id.
30- `anilist`: [AniList](https://anilist.co/) id.
31
32A second level prefix should be included where the database supports multiple media types.
33- `tmdb:movie:693134` maps to `themoviedb.org/movie/693134`
34- `ttvdb:movie:290272` maps to `thetvdb.com/movies/dune-part-two`
35- `mal:anime:9253` maps to `myanimelist.net/anime/9253`
36- `mal:manga:17517` maps to `myanimelist.net/manga/17517`
37
38In some cases the url mapping isnt direct, mapping the url in general is out of scope for this NIP, the section above is only a guide so that implementers have enough information to succsesfully map the url if they wish.
39
40```jsonc
41{
42 "kind": 2003,
43 "content": "<long-description-pre-formatted>",
44 "tags": [
45 ["title", "<torrent-title>"],
46 ["x", "<bittorrent-info-hash>"],
47 ["file", "<file-name>", "<file-size-in-bytes>"],
48 ["file", "<file-name>", "<file-size-in-bytes>"],
49 ["tracker", "udp://mytacker.com:1337"],
50 ["tracker", "http://1337-tracker.net/announce"],
51 ["i", "tcat:video,movie,4k"],
52 ["i", "newznab:2045"],
53 ["i", "imdb:tt15239678"],
54 ["i", "tmdb:movie:693134"],
55 ["i", "ttvdb:movie:290272"],
56 ["t", "movie"],
57 ["t", "4k"],
58 ]
59}
60```
61
62## Torrent Comments
63
64A torrent comment is a `kind 2004` event which is used to reply to a torrent event.
65
66This event works exactly like a `kind 1` and should follow `NIP-10` for tagging.
67
68## Implementations
691. [dtan.xyz](https://git.v0l.io/Kieran/dtan)
702. [nostrudel.ninja](https://github.com/hzrd149/nostrudel/tree/next/src/views/torrents) \ No newline at end of file
diff --git a/36.md b/36.md
index 1223e53..b10262c 100644
--- a/36.md
+++ b/36.md
@@ -4,31 +4,38 @@ NIP-36
4Sensitive Content / Content Warning 4Sensitive Content / Content Warning
5----------------------------------- 5-----------------------------------
6 6
7`draft` `optional` `author:fernandolguevara` 7`draft` `optional`
8 8
9The `content-warning` tag enables users to specify if the event's content needs to be approved by readers to be shown. 9The `content-warning` tag enables users to specify if the event's content needs to be approved by readers to be shown.
10Clients can hide the content until the user acts on it. 10Clients can hide the content until the user acts on it.
11 11
12`l` and `L` tags MAY be also be used as defined in [NIP-32](32.md) with the `content-warning` or other namespace to support
13further qualification and querying.
14
12#### Spec 15#### Spec
13 16
14``` 17```
15tag: content-warning 18tag: content-warning
16options: 19options:
17 - [reason]: optional 20 - [reason]: optional
18``` 21```
19 22
20#### Example 23#### Example
21 24
22```json 25```json
23{ 26{
24 "pubkey": "<pub-key>", 27 "pubkey": "<pub-key>",
25 "created_at": 1000000000, 28 "created_at": 1000000000,
26 "kind": 1, 29 "kind": 1,
27 "tags": [ 30 "tags": [
28 ["t", "hastag"], 31 ["t", "hastag"],
29 ["content-warning", "reason"] /* reason is optional */ 32 ["L", "content-warning"],
30 ], 33 ["l", "reason", "content-warning"],
31 "content": "sensitive content with #hastag\n", 34 ["L", "social.nos.ontology"],
32 "id": "<event-id>" 35 ["l", "NS-nud", "social.nos.ontology"],
36 ["content-warning", "<optional reason>"]
37 ],
38 "content": "sensitive content with #hastag\n",
39 "id": "<event-id>"
33} 40}
34``` 41```
diff --git a/38.md b/38.md
new file mode 100644
index 0000000..4f2c06d
--- /dev/null
+++ b/38.md
@@ -0,0 +1,61 @@
1
2NIP-38
3======
4
5User Statuses
6--------------
7
8`draft` `optional`
9
10## Abstract
11
12This NIP enables a way for users to share live statuses such as what music they are listening to, as well as what they are currently doing: work, play, out of office, etc.
13
14## Live Statuses
15
16A special event with `kind:30315` "User Status" is defined as an *optionally expiring* _parameterized replaceable event_, where the `d` tag represents the status type:
17
18For example:
19
20```js
21{
22 "kind": 30315,
23 "content": "Sign up for nostrasia!",
24 "tags": [
25 ["d", "general"],
26 ["r", "https://nostr.world"]
27 ],
28}
29
30{
31 "kind": 30315,
32 "content": "Intergalatic - Beastie Boys",
33 "tags": [
34 ["d", "music"],
35 ["r", "spotify:search:Intergalatic%20-%20Beastie%20Boys"],
36 ["expiration", "1692845589"]
37 ],
38}
39```
40
41Two common status types are defined: `general` and `music`. `general` represent general statuses: "Working", "Hiking", etc.
42
43`music` status events are for live streaming what you are currently listening to. The expiry of the `music` status should be when the track will stop playing.
44
45Any other status types can be used but they are not defined by this NIP.
46
47The status MAY include an `r`, `p`, `e` or `a` tag linking to a URL, profile, note, or parameterized replaceable event.
48
49The `content` MAY include emoji(s), or [NIP-30](30.md) custom emoji(s). If the `content` is an empty string then the client should clear the status.
50
51# Client behavior
52
53Clients MAY display this next to the username on posts or profiles to provide live user status information.
54
55# Use Cases
56
57* Calendar nostr apps that update your general status when you're in a meeting
58* Nostr Nests that update your general status with a link to the nest when you join
59* Nostr music streaming services that update your music status when you're listening
60* Podcasting apps that update your music status when you're listening to a podcast, with a link for others to listen as well
61* Clients can use the system media player to update playing music status
diff --git a/39.md b/39.md
index b84603c..c819e43 100644
--- a/39.md
+++ b/39.md
@@ -4,7 +4,7 @@ NIP-39
4External Identities in Profiles 4External Identities in Profiles
5------------------------------- 5-------------------------------
6 6
7`draft` `optional` `author:pseudozach` `author:Semisol` 7`draft` `optional`
8 8
9## Abstract 9## Abstract
10 10
@@ -15,15 +15,13 @@ Nostr protocol users may have other online identities such as usernames, profile
15A new optional `i` tag is introduced for `kind 0` metadata event contents in addition to name, about, picture fields as included in [NIP-01](https://github.com/nostr-protocol/nips/blob/master/01.md): 15A new optional `i` tag is introduced for `kind 0` metadata event contents in addition to name, about, picture fields as included in [NIP-01](https://github.com/nostr-protocol/nips/blob/master/01.md):
16```json 16```json
17{ 17{
18 "id": <id>, 18 "tags": [
19 "pubkey": <pubkey>, 19 ["i", "github:semisol", "9721ce4ee4fceb91c9711ca2a6c9a5ab"],
20 ... 20 ["i", "twitter:semisol_public", "1619358434134196225"],
21 "tags": [ 21 ["i", "mastodon:bitcoinhackers.org/@semisol", "109775066355589974"]
22 ["i", "github:semisol", "9721ce4ee4fceb91c9711ca2a6c9a5ab"], 22 ["i", "telegram:1087295469", "nostrdirectory/770"]
23 ["i", "twitter:semisol_public", "1619358434134196225"], 23 ],
24 ["i", "mastodon:bitcoinhackers.org/@semisol", "109775066355589974"] 24 ...
25 ["i", "telegram:1087295469", "nostrdirectory/770"]
26 ]
27} 25}
28``` 26```
29 27
@@ -31,9 +29,9 @@ An `i` tag will have two parameters, which are defined as the following:
311. `platform:identity`: This is the platform name (for example `github`) and the identity on that platform (for example `semisol`) joined together with `:`. 291. `platform:identity`: This is the platform name (for example `github`) and the identity on that platform (for example `semisol`) joined together with `:`.
322. `proof`: String or object that points to the proof of owning this identity. 302. `proof`: String or object that points to the proof of owning this identity.
33 31
34Clients SHOULD process any `i` tags with more than 2 values for future extensibility. 32Clients SHOULD process any `i` tags with more than 2 values for future extensibility.
35Identity provider names SHOULD only include `a-z`, `0-9` and the characters `._-/` and MUST NOT include `:`. 33Identity provider names SHOULD only include `a-z`, `0-9` and the characters `._-/` and MUST NOT include `:`.
36Identity names SHOULD be normalized if possible by replacing uppercase letters with lowercase letters, and if there are multiple aliases for an entity the primary one should be used. 34Identity names SHOULD be normalized if possible by replacing uppercase letters with lowercase letters, and if there are multiple aliases for an entity the primary one should be used.
37 35
38## Claim types 36## Claim types
39 37
@@ -41,14 +39,14 @@ Identity names SHOULD be normalized if possible by replacing uppercase letters w
41 39
42Identity: A GitHub username. 40Identity: A GitHub username.
43 41
44Proof: A GitHub Gist ID. This Gist should be created by `<identity>` with a single file that has the text `Verifying that I control the following Nostr public key: <npub encoded public key>`. 42Proof: A GitHub Gist ID. This Gist should be created by `<identity>` with a single file that has the text `Verifying that I control the following Nostr public key: <npub encoded public key>`.
45This can be located at `https://gist.github.com/<identity>/<proof>`. 43This can be located at `https://gist.github.com/<identity>/<proof>`.
46 44
47### `twitter` 45### `twitter`
48 46
49Identity: A Twitter username. 47Identity: A Twitter username.
50 48
51Proof: A Tweet ID. The tweet should be posted by `<identity>` and have the text `Verifying my account on nostr My Public Key: "<npub encoded public key>"`. 49Proof: A Tweet ID. The tweet should be posted by `<identity>` and have the text `Verifying my account on nostr My Public Key: "<npub encoded public key>"`.
52This can be located at `https://twitter.com/<identity>/status/<proof>`. 50This can be located at `https://twitter.com/<identity>/status/<proof>`.
53 51
54### `mastodon` 52### `mastodon`
@@ -62,5 +60,5 @@ This can be located at `https://<identity>/<proof>`.
62 60
63Identity: A Telegram user ID. 61Identity: A Telegram user ID.
64 62
65Proof: A string in the format `<ref>/<id>` which points to a message published in the public channel or group with name `<ref>` and message ID `<id>`. This message should be sent by user ID `<identity>` and have the text `Verifying that I control the following Nostr public key: "<npub encoded public key>"`. 63Proof: A string in the format `<ref>/<id>` which points to a message published in the public channel or group with name `<ref>` and message ID `<id>`. This message should be sent by user ID `<identity>` and have the text `Verifying that I control the following Nostr public key: "<npub encoded public key>"`.
66This can be located at `https://t.me/<proof>`. 64This can be located at `https://t.me/<proof>`.
diff --git a/40.md b/40.md
index 32680db..909747f 100644
--- a/40.md
+++ b/40.md
@@ -2,9 +2,9 @@ NIP-40
2====== 2======
3 3
4Expiration Timestamp 4Expiration Timestamp
5----------------------------------- 5--------------------
6 6
7`draft` `optional` `author:0xtlt` 7`draft` `optional`
8 8
9The `expiration` tag enables users to specify a unix timestamp at which the message SHOULD be considered expired (by relays and clients) and SHOULD be deleted by relays. 9The `expiration` tag enables users to specify a unix timestamp at which the message SHOULD be considered expired (by relays and clients) and SHOULD be deleted by relays.
10 10
@@ -20,14 +20,14 @@ values:
20 20
21```json 21```json
22{ 22{
23 "pubkey": "<pub-key>", 23 "pubkey": "<pub-key>",
24 "created_at": 1000000000, 24 "created_at": 1000000000,
25 "kind": 1, 25 "kind": 1,
26 "tags": [ 26 "tags": [
27 ["expiration", "1600000000"] 27 ["expiration", "1600000000"]
28 ], 28 ],
29 "content": "This message will expire at the specified timestamp and be deleted by relays.\n", 29 "content": "This message will expire at the specified timestamp and be deleted by relays.\n",
30 "id": "<event-id>" 30 "id": "<event-id>"
31} 31}
32``` 32```
33 33
@@ -43,9 +43,9 @@ Clients SHOULD ignore events that have expired.
43Relay Behavior 43Relay Behavior
44-------------- 44--------------
45 45
46Relays MAY NOT delete expired messages immediately on expiration and MAY persist them indefinitely. 46Relays MAY NOT delete expired messages immediately on expiration and MAY persist them indefinitely.
47Relays SHOULD NOT send expired events to clients, even if they are stored. 47Relays SHOULD NOT send expired events to clients, even if they are stored.
48Relays SHOULD drop any events that are published to them if they are expired. 48Relays SHOULD drop any events that are published to them if they are expired.
49An expiration timestamp does not affect storage of ephemeral events. 49An expiration timestamp does not affect storage of ephemeral events.
50 50
51Suggested Use Cases 51Suggested Use Cases
diff --git a/42.md b/42.md
index 9b0c45b..8c70de4 100644
--- a/42.md
+++ b/42.md
@@ -4,7 +4,7 @@ NIP-42
4Authentication of clients to relays 4Authentication of clients to relays
5----------------------------------- 5-----------------------------------
6 6
7`draft` `optional` `author:Semisol` `author:fiatjaf` 7`draft` `optional`
8 8
9This NIP defines a way for clients to authenticate to relays by signing an ephemeral event. 9This NIP defines a way for clients to authenticate to relays by signing an ephemeral event.
10 10
@@ -12,69 +12,86 @@ This NIP defines a way for clients to authenticate to relays by signing an ephem
12 12
13A relay may want to require clients to authenticate to access restricted resources. For example, 13A relay may want to require clients to authenticate to access restricted resources. For example,
14 14
15 - A relay may request payment or other forms of whitelisting to publish events -- this can naïvely be achieved by limiting publication 15 - A relay may request payment or other forms of whitelisting to publish events -- this can naïvely be achieved by limiting publication to events signed by the whitelisted key, but with this NIP they may choose to accept any events as long as they are published from an authenticated user;
16 to events signed by the whitelisted key, but with this NIP they may choose to accept any events as long as they are published from an 16 - A relay may limit access to `kind: 4` DMs to only the parties involved in the chat exchange, and for that it may require authentication before clients can query for that kind.
17 authenticated user;
18 - A relay may limit access to `kind: 4` DMs to only the parties involved in the chat exchange, and for that it may require authentication
19 before clients can query for that kind.
20 - A relay may limit subscriptions of any kind to paying users or users whitelisted through any other means, and require authentication. 17 - A relay may limit subscriptions of any kind to paying users or users whitelisted through any other means, and require authentication.
21 18
22## Definitions 19## Definitions
23 20
24This NIP defines a new message, `AUTH`, which relays can send when they support authentication and clients can send to relays when they want 21### New client-relay protocol messages
25to authenticate. When sent by relays, the message is of the following form:
26 22
27``` 23This NIP defines a new message, `AUTH`, which relays CAN send when they support authentication and clients can send to relays when they want to authenticate. When sent by relays the message has the following form:
24
25```json
28["AUTH", <challenge-string>] 26["AUTH", <challenge-string>]
29``` 27```
30 28
31And, when sent by clients, of the following form: 29And, when sent by clients, the following form:
32 30
33``` 31```json
34["AUTH", <signed-event-json>] 32["AUTH", <signed-event-json>]
35``` 33```
36 34
37The signed event is an ephemeral event not meant to be published or queried, it must be of `kind: 22242` and it should have at least two tags, 35`AUTH` messages sent by clients MUST be answered with an `OK` message, like any `EVENT` message.
38one for the relay URL and one for the challenge string as received from the relay. 36
39Relays MUST exclude `kind: 22242` events from being broadcasted to any client. 37### Canonical authentication event
40`created_at` should be the current time. Example: 38
39The signed event is an ephemeral event not meant to be published or queried, it must be of `kind: 22242` and it should have at least two tags, one for the relay URL and one for the challenge string as received from the relay. Relays MUST exclude `kind: 22242` events from being broadcasted to any client. `created_at` should be the current time. Example:
41 40
42```json 41```json
43{ 42{
44 "id": "...",
45 "pubkey": "...",
46 "created_at": 1669695536,
47 "kind": 22242, 43 "kind": 22242,
48 "tags": [ 44 "tags": [
49 ["relay", "wss://relay.example.com/"], 45 ["relay", "wss://relay.example.com/"],
50 ["challenge", "challengestringhere"] 46 ["challenge", "challengestringhere"]
51 ], 47 ],
52 "content": "", 48 ...
53 "sig": "..."
54} 49}
55``` 50```
56 51
52### `OK` and `CLOSED` machine-readable prefixes
53
54This NIP defines two new prefixes that can be used in `OK` (in response to event writes by clients) and `CLOSED` (in response to rejected subscriptions by clients):
55
56- `"auth-required: "` - for when a client has not performed `AUTH` and the relay requires that to fulfill the query or write the event.
57- `"restricted: "` - for when a client has already performed `AUTH` but the key used to perform it is still not allowed by the relay or is exceeding its authorization.
58
57## Protocol flow 59## Protocol flow
58 60
59At any moment the relay may send an `AUTH` message to the client containing a challenge. After receiving that the client may decide to 61At any moment the relay may send an `AUTH` message to the client containing a challenge. The challenge is valid for the duration of the connection or until another challenge is sent by the relay. The client MAY decide to send its `AUTH` event at any point and the authenticated session is valid afterwards for the duration of the connection.
60authenticate itself or not. The challenge is expected to be valid for the duration of the connection or until a next challenge is sent by
61the relay.
62 62
63The client may send an auth message right before performing an action for which it knows authentication will be required -- for example, right 63### `auth-required` in response to a `REQ` message
64before requesting `kind: 4` chat messages --, or it may do right on connection start or at some other moment it deems best. The authentication
65is expected to last for the duration of the WebSocket connection.
66 64
67Upon receiving a message from an unauthenticated user it can't fulfill without authentication, a relay may choose to notify the client. For 65Given that a relay is likely to require clients to perform authentication only for certain jobs, like answering a `REQ` or accepting an `EVENT` write, these are some expected common flows:
68that it can use a `NOTICE` or `OK` message with a standard prefix `"restricted: "` that is readable both by humans and machines, for example:
69 66
70``` 67```
71["NOTICE", "restricted: we can't serve DMs to unauthenticated users, does your client implement NIP-42?"] 68relay: ["AUTH", "<challenge>"]
69client: ["REQ", "sub_1", {"kinds": [4]}]
70relay: ["CLOSED", "sub_1", "auth-required: we can't serve DMs to unauthenticated users"]
71client: ["AUTH", {"id": "abcdef...", ...}]
72relay: ["OK", "abcdef...", true, ""]
73client: ["REQ", "sub_1", {"kinds": [4]}]
74relay: ["EVENT", "sub_1", {...}]
75relay: ["EVENT", "sub_1", {...}]
76relay: ["EVENT", "sub_1", {...}]
77relay: ["EVENT", "sub_1", {...}]
78...
72``` 79```
73 80
74or it can return an `OK` message noting the reason an event was not written using the same prefix: 81In this case, the `AUTH` message from the relay could be sent right as the client connects or it can be sent immediately before the `CLOSED` is sent. The only requirement is that _the client must have a stored challenge associated with that relay_ so it can act upon that in response to the `auth-required` `CLOSED` message.
82
83### `auth-required` in response to an `EVENT` message
84
85The same flow is valid for when a client wants to write an `EVENT` to the relay, except now the relay sends back an `OK` message instead of a `CLOSED` message:
75 86
76``` 87```
77["OK", <event-id>, false, "restricted: we do not accept events from unauthenticated users, please sign up at https://example.com/"] 88relay: ["AUTH", "<challenge>"]
89client: ["EVENT", {"id": "012345...", ...}]
90relay: ["OK", "012345...", false, "auth-required: we only accept events from registered users"]
91client: ["AUTH", {"id": "abcdef...", ...}]
92relay: ["OK", "abcdef...", true, ""]
93client: ["EVENT", {"id": "012345...", ...}]
94relay: ["OK", "012345...", true, ""]
78``` 95```
79 96
80## Signed Event Verification 97## Signed Event Verification
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/45.md b/45.md
index a525391..780dfb6 100644
--- a/45.md
+++ b/45.md
@@ -4,7 +4,7 @@ NIP-45
4Event Counts 4Event Counts
5-------------- 5--------------
6 6
7`draft` `optional` `author:staab` 7`draft` `optional`
8 8
9Relays may support the verb `COUNT`, which provides a mechanism for obtaining event counts. 9Relays may support the verb `COUNT`, which provides a mechanism for obtaining event counts.
10 10
@@ -16,24 +16,45 @@ Some queries a client may want to execute against connected relays are prohibiti
16 16
17This NIP defines the verb `COUNT`, which accepts a subscription id and filters as specified in [NIP 01](01.md) for the verb `REQ`. Multiple filters are OR'd together and aggregated into a single count result. 17This NIP defines the verb `COUNT`, which accepts a subscription id and filters as specified in [NIP 01](01.md) for the verb `REQ`. Multiple filters are OR'd together and aggregated into a single count result.
18 18
19``` 19```json
20["COUNT", <subscription_id>, <filters JSON>...] 20["COUNT", <subscription_id>, <filters JSON>...]
21``` 21```
22 22
23Counts are returned using a `COUNT` response in the form `{"count": <integer>}`. Relays may use probabilistic counts to reduce compute requirements. 23Counts are returned using a `COUNT` response in the form `{"count": <integer>}`. Relays may use probabilistic counts to reduce compute requirements.
24In case a relay uses probabilistic counts, it MAY indicate it in the response with `approximate` key i.e. `{"count": <integer>, "approximate": <true|false>}`.
24 25
25``` 26```json
26["COUNT", <subscription_id>, {"count": <integer>}] 27["COUNT", <subscription_id>, {"count": <integer>}]
27``` 28```
28 29
29Examples: 30Whenever the relay decides to refuse to fulfill the `COUNT` request, it MUST return a `CLOSED` message.
30 31
31``` 32## Examples
32# Followers count 33
34### Followers count
35
36```json
33["COUNT", <subscription_id>, {"kinds": [3], "#p": [<pubkey>]}] 37["COUNT", <subscription_id>, {"kinds": [3], "#p": [<pubkey>]}]
34["COUNT", <subscription_id>, {"count": 238}] 38["COUNT", <subscription_id>, {"count": 238}]
39```
35 40
36# Count posts and reactions 41### Count posts and reactions
42
43```json
37["COUNT", <subscription_id>, {"kinds": [1, 7], "authors": [<pubkey>]}] 44["COUNT", <subscription_id>, {"kinds": [1, 7], "authors": [<pubkey>]}]
38["COUNT", <subscription_id>, {"count": 5}] 45["COUNT", <subscription_id>, {"count": 5}]
39``` 46```
47
48### Count posts approximately
49
50```
51["COUNT", <subscription_id>, {"kinds": [1]}]
52["COUNT", <subscription_id>, {"count": 93412452, "approximate": true}]
53```
54
55### Relay refuses to count
56
57```
58["COUNT", <subscription_id>, {"kinds": [4], "authors": [<pubkey>], "#p": [<pubkey>]}]
59["CLOSED", <subscription_id>, "auth-required: cannot count other people's DMs"]
60```
diff --git a/46.md b/46.md
index 90fa1a0..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` `author:tiero` `author:giowe` `author:vforvalerio87`
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 c884b97..983d2c9 100644
--- a/47.md
+++ b/47.md
@@ -4,7 +4,7 @@ NIP-47
4Nostr Wallet Connect 4Nostr Wallet Connect
5-------------------- 5--------------------
6 6
7`draft` `optional` `author:kiwiidb` `author:bumi` `author:semisol` `author:vitorpamplona` 7`draft` `optional`
8 8
9## Rationale 9## Rationale
10 10
@@ -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
@@ -33,9 +33,10 @@ There are three event kinds:
33- `NIP-47 response`: 23195 33- `NIP-47 response`: 23195
34 34
35The info event should be a replaceable event that is published by the **wallet service** on the relay to indicate which commands it supports. The content should be 35The info event should be a replaceable event that is published by the **wallet service** on the relay to indicate which commands it supports. The content should be
36a plaintext string with the supported commands, space-seperated, 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
@@ -64,8 +65,8 @@ Response:
64``` 65```
65 66
66The `result_type` field MUST contain the name of the method that this event is responding to. 67The `result_type` field MUST contain the name of the method that this event is responding to.
67The `error` field MUST contain a `message` field with a human readable error message and a `code` field with the error code if the command was not succesful. 68The `error` field MUST contain a `message` field with a human readable error message and a `code` field with the error code if the command was not successful.
68If the command was succesful, the `error` field must be null. 69If the command was successful, the `error` field must be null.
69 70
70### Error codes 71### Error codes
71- `RATE_LIMITED`: The client is sending commands too fast. It should retry in a few seconds. 72- `RATE_LIMITED`: The client is sending commands too fast. It should retry in a few seconds.
@@ -80,7 +81,7 @@ If the command was succesful, 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,10 +128,282 @@ 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** 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.
135 409
diff --git a/48.md b/48.md
new file mode 100644
index 0000000..2f03e00
--- /dev/null
+++ b/48.md
@@ -0,0 +1,60 @@
1NIP-48
2======
3
4Proxy Tags
5----------
6
7`draft` `optional`
8
9Nostr events bridged from other protocols such as ActivityPub can link back to the source object by including a `"proxy"` tag, in the form:
10
11```
12["proxy", <id>, <protocol>]
13```
14
15Where:
16
17- `<id>` is the ID of the source object. The ID format varies depending on the protocol. The ID must be universally unique, regardless of the protocol.
18- `<protocol>` is the name of the protocol, e.g. `"activitypub"`.
19
20Clients may use this information to reconcile duplicated content bridged from other protocols, or to display a link to the source object.
21
22Proxy tags may be added to any event kind, and doing so indicates that the event did not originate on the Nostr protocol, and instead originated elsewhere on the web.
23
24### Supported protocols
25
26This list may be extended in the future.
27
28| Protocol | ID format | Example |
29| -------- | --------- | ------- |
30| `activitypub` | URL | `https://gleasonator.com/objects/9f524868-c1a0-4ee7-ad51-aaa23d68b526` |
31| `atproto` | AT URI | `at://did:plc:zhbjlbmir5dganqhueg7y4i3/app.bsky.feed.post/3jt5hlibeol2i` |
32| `rss` | URL with guid fragment | `https://soapbox.pub/rss/feed.xml#https%3A%2F%2Fsoapbox.pub%2Fblog%2Fmostr-fediverse-nostr-bridge` |
33| `web` | URL | `https://twitter.com/jack/status/20` |
34
35### Examples
36
37ActivityPub object:
38
39```json
40{
41 "kind": 1,
42 "content": "I'm vegan btw",
43 "tags": [
44 [
45 "proxy",
46 "https://gleasonator.com/objects/8f6fac53-4f66-4c6e-ac7d-92e5e78c3e79",
47 "activitypub"
48 ]
49 ],
50 "pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6",
51 "created_at": 1691091365,
52 "id": "55920b758b9c7b17854b6e3d44e6a02a83d1cb49e1227e75a30426dea94d4cb2",
53 "sig": "a72f12c08f18e85d98fb92ae89e2fe63e48b8864c5e10fbdd5335f3c9f936397a6b0a7350efe251f8168b1601d7012d4a6d0ee6eec958067cf22a14f5a5ea579"
54}
55```
56
57### See also
58
59- [FEP-fffd: Proxy Objects](https://codeberg.org/fediverse/fep/src/branch/main/fep/fffd/fep-fffd.md)
60- [Mostr bridge](https://mostr.pub/) \ No newline at end of file
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 5bda355..2a31cb1 100644
--- a/50.md
+++ b/50.md
@@ -4,7 +4,7 @@ NIP-50
4Search Capability 4Search Capability
5----------------- 5-----------------
6 6
7`draft` `optional` `author:brugeman` `author:mikedilger` `author:fiatjaf` 7`draft` `optional`
8 8
9## Abstract 9## Abstract
10 10
@@ -26,6 +26,8 @@ Relays SHOULD interpret the query to the best of their ability and return events
26Relays SHOULD perform matching against `content` event field, and MAY perform 26Relays SHOULD perform matching against `content` event field, and MAY perform
27matching against other fields if that makes sense in the context of a specific kind. 27matching against other fields if that makes sense in the context of a specific kind.
28 28
29Results SHOULD be returned in descending order by quality of search result (as defined by the implementation),
30not by the usual `.created_at`. The `limit` filter SHOULD be applied after sorting by matching score.
29A query string may contain `key:value` pairs (two words separated by colon), these are extensions, relays SHOULD ignore 31A query string may contain `key:value` pairs (two words separated by colon), these are extensions, relays SHOULD ignore
30extensions they don't support. 32extensions they don't support.
31 33
@@ -41,9 +43,13 @@ implementation details between relays.
41Clients MAY verify that events returned by a relay match the specified query in a way that suits the 43Clients 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. 44client's use case, and MAY stop querying relays that have low precision.
43 45
44Relays SHOULD exclude spam from search results by default if they supports some form of spam filtering. 46Relays SHOULD exclude spam from search results by default if they support some form of spam filtering.
45 47
46## Extensions 48## Extensions
47 49
48Relay MAY support these extensions: 50Relay MAY support these extensions:
49- `include:spam` - turn off spam filtering, if it was enabled by default 51- `include:spam` - turn off spam filtering, if it was enabled by default
52- `domain:<domain>` - include only events from users whose valid nip05 domain matches the domain
53- `language:<two letter ISO 639-1 language code>` - include only events of a specified language
54- `sentiment:<negative/neutral/positive>` - include only events of a specific sentiment
55- `nsfw:<true/false>` - include or exclude nsfw events (default: true)
diff --git a/51.md b/51.md
index 80cc09e..fb40b26 100644
--- a/51.md
+++ b/51.md
@@ -2,111 +2,142 @@ NIP-51
2====== 2======
3 3
4Lists 4Lists
5------------------------- 5-----
6 6
7`draft` `optional` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema` `depends:33` 7`draft` `optional`
8 8
9A "list" event is defined as having a list of public and/or private tags. Public tags will be listed in the event `tags`. Private tags will be encrypted in the event `content`. Encryption for private tags will use [NIP-04 - Encrypted Direct Message](04.md) encryption, using the list author's private and public key for the shared secret. A distinct event kind should be used for each list type created. 9This NIP defines lists of things that users can create. Lists can contain references to anything, and these references can be **public** or **private**.
10 10
11If a list type should only be defined once per user (like the 'Mute' list), the list type's events should follow the specification for [NIP-16 - Replaceable Events](16.md). These lists may be referred to as 'replaceable lists'. 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
13Otherwise, the list type's events should follow the specification for [NIP-33 - Parameterized Replaceable Events](33.md), where the list name will be used as the 'd' parameter. These lists may be referred to as 'parameterized replaceable lists'. 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 14
15## Replaceable List Event Example 15## Types of lists
16 16
17Lets say a user wants to create a 'Mute' list and has keys: 17## Standard lists
18```
19priv: fb505c65d4df950f5d28c9e4d285ee12ffaf315deef1fc24e3c7cd1e7e35f2b1
20pub: b1a5c93edcc8d586566fde53a20bdb50049a97b15483cb763854e57016e0fa3d
21```
22The user wants to publicly include these users:
23 18
24```json 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.
25["p", "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"],
26["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"]
27```
28and privately include these users (below is the JSON that would be encrypted and placed in the event content):
29 20
30```json 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.
31[ 22
32 ["p", "9ec7a778167afb1d30c4833de9322da0c08ba71a69e1911d5578d3144bb56437"], 23| name | kind | description | expected tag items |
33 ["p", "8c0da4862130283ff9e67d889df264177a508974e2feb96de139804ea66d6168"] 24| --- | --- | --- | --- |
34] 25| Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags), `"word"` (lowercase string), `"e"` (threads) |
35``` 26| Pinned notes | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) |
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) |
28| Communities | 10004 | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) |
29| Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) |
30| Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) |
31| Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) |
32| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group ids + mandatory relay URL) |
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) |
37
38## Sets
39
40Sets are lists with well-defined meaning that can enhance the functionality and the UI of clients that rely on them. Unlike standard lists, users are expected to have more than one set of each kind, therefore each of them must be assigned a different `"d"` identifier.
36 41
37Then the user would create a 'Mute' list event like below: 42For example, _relay sets_ can be displayed in a dropdown UI to give users the option to switch to which relays they will publish an event or from which relays they will read the replies to an event; _curation sets_ can be used by apps to showcase curations made by others tagged to different topics.
43
44Aside from their main identifier, the `"d"` tag, sets can optionally have a `"title"`, an `"image"` and a `"description"` tags that can be used to enhance their UI.
45
46| name | kind | description | expected tag items |
47| --- | --- | --- | --- |
48| Follow sets | 30000 | categorized groups of users a client may choose to check out in different circumstances | `"p"` (pubkeys) |
49| Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during various operations | `"relay"` (relay 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) |
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) |
53| Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) |
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"` |
56
57## Deprecated standard lists
58
59Some clients have used these lists in the past, but they should work on transitioning to the [standard formats](#standard-lists) above.
60
61| kind | "d" tag | use instead |
62| --- | --- | --- |
63| 30000 | `"mute"` | kind 10000 _mute list_ |
64| 30001 | `"pin"` | kind 10001 _pin list_ |
65| 30001 | `"bookmark"` | kind 10003 _bookmarks list_ |
66| 30001 | `"communities"` | kind 10004 _communities list_ |
67
68## Examples
69
70### A _mute list_ with some public items and some encrypted items
38 71
39```json 72```json
40{ 73{
74 "id": "a92a316b75e44cfdc19986c634049158d4206fcc0b7b9c7ccbcdabe28beebcd0",
75 "pubkey": "854043ae8f1f97430ca8c1f1a090bdde6488bd5115c7a45307a2a212750ae4cb",
76 "created_at": 1699597889,
41 "kind": 10000, 77 "kind": 10000,
42 "tags": [ 78 "tags": [
43 ["p", "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"], 79 ["p", "07caba282f76441955b695551c3c5c742e5b9202a3784780f8086fdcdc1da3a9"],
44 ["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"], 80 ["p", "a55c15f5e41d5aebd236eca5e0142789c5385703f1a7485aa4b38d94fd18dcc4"]
45 ], 81 ],
46 "content": "VezuSvWak++ASjFMRqBPWS3mK5pZ0vRLL325iuIL4S+r8n9z+DuMau5vMElz1tGC/UqCDmbzE2kwplafaFo/FnIZMdEj4pdxgptyBV1ifZpH3TEF6OMjEtqbYRRqnxgIXsuOSXaerWgpi0pm+raHQPseoELQI/SZ1cvtFqEUCXdXpa5AYaSd+quEuthAEw7V1jP+5TDRCEC8jiLosBVhCtaPpLcrm8HydMYJ2XB6Ixs=?iv=/rtV49RFm0XyFEwG62Eo9A==", 82 "content": "TJob1dQrf2ndsmdbeGU+05HT5GMnBSx3fx8QdDY/g3NvCa7klfzgaQCmRZuo1d3WQjHDOjzSY1+MgTK5WjewFFumCcOZniWtOMSga9tJk1ky00tLoUUzyLnb1v9x95h/iT/KpkICJyAwUZ+LoJBUzLrK52wNTMt8M5jSLvCkRx8C0BmEwA/00pjOp4eRndy19H4WUUehhjfV2/VV/k4hMAjJ7Bb5Hp9xdmzmCLX9+64+MyeIQQjQAHPj8dkSsRahP7KS3MgMpjaF8nL48Bg5suZMxJayXGVp3BLtgRZx5z5nOk9xyrYk+71e2tnP9IDvSMkiSe76BcMct+m7kGVrRcavDI4n62goNNh25IpghT+a1OjjkpXt9me5wmaL7fxffV1pchdm+A7KJKIUU3kLC7QbUifF22EucRA9xiEyxETusNludBXN24O3llTbOy4vYFsq35BeZl4v1Cse7n2htZicVkItMz3wjzj1q1I1VqbnorNXFgllkRZn4/YXfTG/RMnoK/bDogRapOV+XToZ+IvsN0BqwKSUDx+ydKpci6htDRF2WDRkU+VQMqwM0CoLzy2H6A2cqyMMMD9SLRRzBg==?iv=S3rFeFr1gsYqmQA7bNnNTQ==",
47 ...other fields 83 "sig": "1173822c53261f8cffe7efbf43ba4a97a9198b3e402c2a1df130f42a8985a2d0d3430f4de350db184141e45ca844ab4e5364ea80f11d720e36357e1853dba6ca"
48} 84}
49``` 85```
50 86
51 87### A _curation set_ of articles and notes about yaks
52## Parameterized Replaceable List Event Example
53
54Lets say a user wants to create a 'Categorized People' list of `nostr` people and has keys:
55```
56priv: fb505c65d4df950f5d28c9e4d285ee12ffaf315deef1fc24e3c7cd1e7e35f2b1
57pub: b1a5c93edcc8d586566fde53a20bdb50049a97b15483cb763854e57016e0fa3d
58```
59The user wants to publicly include these users:
60 88
61```json 89```json
62["p", "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"], 90{
63["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"] 91 "id": "567b41fc9060c758c4216fe5f8d3df7c57daad7ae757fa4606f0c39d4dd220ef",
64``` 92 "pubkey": "d6dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c",
65and privately include these users (below is the JSON that would be encrypted and placed in the event content): 93 "created_at": 1695327657,
66 94 "kind": 30004,
67```json 95 "tags": [
68[ 96 ["d", "jvdy9i4"],
69 ["p", "9ec7a778167afb1d30c4833de9322da0c08ba71a69e1911d5578d3144bb56437"], 97 ["name", "Yaks"],
70 ["p", "8c0da4862130283ff9e67d889df264177a508974e2feb96de139804ea66d6168"] 98 ["picture", "https://cdn.britannica.com/40/188540-050-9AC748DE/Yak-Himalayas-Nepal.jpg"],
71] 99 ["about", "The domestic yak, also known as the Tartary ox, grunting ox, or hairy cattle, is a species of long-haired domesticated cattle found throughout the Himalayan region of the Indian subcontinent, the Tibetan Plateau, Gilgit-Baltistan, Tajikistan and as far north as Mongolia and Siberia."],
100 ["a", "30023:26dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:95ODQzw3ajNoZ8SyMDOzQ"],
101 ["a", "30023:54af95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:1-MYP8dAhramH9J5gJWKx"],
102 ["a", "30023:f8fe95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:D2Tbd38bGrFvU0bIbvSMt"],
103 ["e", "d78ba0d5dce22bfff9db0a9e996c9ef27e2c91051de0c4e1da340e0326b4941e"]
104 ],
105 "content": "",
106 "sig": "a9a4e2192eede77e6c9d24ddfab95ba3ff7c03fbd07ad011fff245abea431fb4d3787c2d04aad001cb039cb8de91d83ce30e9a94f82ac3c5a2372aa1294a96bd"
107}
72``` 108```
73 109
74Then the user would create a 'Categorized People' list event like below: 110### A _release artifact set_ of an Example App
75 111
76```json 112```json
77{ 113{
78 "kind": 30000, 114 "id": "567b41fc9060c758c4216fe5f8d3df7c57daad7ae757fa4606f0c39d4dd220ef",
115 "pubkey": "d6dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c",
116 "created_at": 1695327657,
117 "kind": 30063,
79 "tags": [ 118 "tags": [
80 ["d", "nostr"], 119 ["d", "ak8dy3v7"],
81 ["p", "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"], 120 ["i", "com.example.app"],
82 ["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"], 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
83 ], 128 ],
84 "content": "VezuSvWak++ASjFMRqBPWS3mK5pZ0vRLL325iuIL4S+r8n9z+DuMau5vMElz1tGC/UqCDmbzE2kwplafaFo/FnIZMdEj4pdxgptyBV1ifZpH3TEF6OMjEtqbYRRqnxgIXsuOSXaerWgpi0pm+raHQPseoELQI/SZ1cvtFqEUCXdXpa5AYaSd+quEuthAEw7V1jP+5TDRCEC8jiLosBVhCtaPpLcrm8HydMYJ2XB6Ixs=?iv=/rtV49RFm0XyFEwG62Eo9A==", 129 "content": "Example App is a decentralized marketplace for apps",
85 ...other fields 130 "sig": "a9a4e2192eede77e6c9d24ddfab95ba3ff7c03fbd07ad011fff245abea431fb4d3787c2d04aad001cb039cb8de91d83ce30e9a94f82ac3c5a2372aa1294a96bd"
86} 131}
87``` 132```
88 133
89## List Event Kinds 134## Encryption process pseudocode
90
91| kind | list type |
92| ------ | ----------------------- |
93| 10000 | Mute |
94| 10001 | Pin |
95| 30000 | Categorized People |
96| 30001 | Categorized Bookmarks |
97 135
98### Mute List 136```scala
99 137val private_items = [
100An event with kind `10000` is defined as a replaceable list event for listing content a user wants to mute. Any standardized tag can be included in a Mute List. 138 ["p", "07caba282f76441955b695551c3c5c742e5b9202a3784780f8086fdcdc1da3a9"],
101 139 ["a", "a55c15f5e41d5aebd236eca5e0142789c5385703f1a7485aa4b38d94fd18dcc4"],
102### Pin List 140]
103 141val base64blob = nip04.encrypt(json.encode_to_string(private_items))
104An event with kind `10001` is defined as a replaceable list event for listing content a user wants to pin. Any standardized tag can be included in a Pin List. 142event.content = base64blob
105 143```
106### Categorized People List
107
108An event with kind `30000` is defined as a parameterized replaceable list event for categorizing people. The 'd' parameter for this event holds the category name of the list. The tags included in these lists MUST follow the format of kind 3 events as defined in [NIP-02 - Contact List and Petnames](02.md).
109
110### Categorized Bookmarks List
111
112An event with kind `30001` is defined as a parameterized replaceable list event for categorizing bookmarks. The 'd' parameter for this event holds the category name of the list. Any standardized tag can be included in a Categorized Bookmarks List.
diff --git a/52.md b/52.md
new file mode 100644
index 0000000..f35d904
--- /dev/null
+++ b/52.md
@@ -0,0 +1,219 @@
1NIP-52
2======
3
4Calendar Events
5---------------
6
7`draft` `optional`
8
9This specification defines calendar events representing an occurrence at a specific moment or between moments. These calendar events are _parameterized replaceable_ and deletable per [NIP-09](09.md).
10
11Unlike the term `calendar event` specific to this NIP, the term `event` is used broadly in all the NIPs to describe any Nostr event. The distinction is being made here to discern between the two terms.
12
13## Calendar Events
14
15There are two types of calendar events represented by different kinds: date-based and time-based calendar events. Calendar events are not required to be part of a [calendar](#calendar).
16
17### Date-Based Calendar Event
18
19This kind of calendar event starts on a date and ends before a different date in the future. Its use is appropriate for all-day or multi-day events where time and time zone hold no significance. e.g., anniversary, public holidays, vacation days.
20
21#### Format
22
23The format uses a parameterized replaceable event kind `31922`.
24
25The `.content` of these events should be a detailed description of the calendar event. It is required but can be an empty string.
26
27The list of tags are as follows:
28* `d` (required) universally unique identifier (UUID). Generated by the client creating 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.
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, 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
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
36* `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc.
37
38The following tags are deprecated:
39* `name` name of the calendar event. Use only if `title` is not available.
40
41```jsonc
42{
43 "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>,
44 "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
45 "created_at": <Unix timestamp in seconds>,
46 "kind": 31922,
47 "content": "<description of calendar event>",
48 "tags": [
49 ["d", "<UUID>"],
50
51 ["title", "<title of calendar event>"],
52
53 // Dates
54 ["start", "<YYYY-MM-DD>"],
55 ["end", "<YYYY-MM-DD>"],
56
57 // Location
58 ["location", "<location>"],
59 ["g", "<geohash>"],
60
61 // Participants
62 ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"],
63 ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"],
64
65 // Hashtags
66 ["t", "<tag>"],
67 ["t", "<tag>"],
68
69 // Reference links
70 ["r", "<url>"],
71 ["r", "<url>"]
72 ]
73}
74```
75
76### Time-Based Calendar Event
77
78This kind of calendar event spans between a start time and end time.
79
80#### Format
81
82The format uses a parameterized replaceable event kind `31923`.
83
84The `.content` of these events should be a detailed description of the calendar event. It is required but can be an empty string.
85
86The list of tags are as follows:
87* `d` (required) universally unique identifier (UUID). Generated by the client creating the calendar event.
88* `title` (required) title of the calendar event
89* `start` (required) inclusive start Unix timestamp in seconds. Must be less than `end`, if it exists.
90* `end` (optional) exclusive end Unix timestamp in seconds. If omitted, the calendar event ends instantaneously.
91* `start_tzid` (optional) time zone of the start timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica`
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.
93* `location` (optional, repeated) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call
94* `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location
95* `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting
96* `t` (optional, repeated) hashtag to categorize calendar event
97* `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc.
98
99The following tags are deprecated:
100* `name` name of the calendar event. Use only if `title` is not available.
101
102```jsonc
103{
104 "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>,
105 "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
106 "created_at": <Unix timestamp in seconds>,
107 "kind": 31923,
108 "content": "<description of calendar event>",
109 "tags": [
110 ["d", "<UUID>"],
111
112 ["title", "<title of calendar event>"],
113
114 // Timestamps
115 ["start", "<Unix timestamp in seconds>"],
116 ["end", "<Unix timestamp in seconds>"],
117
118 ["start_tzid", "<IANA Time Zone Database identifier>"],
119 ["end_tzid", "<IANA Time Zone Database identifier>"],
120
121 // Location
122 ["location", "<location>"],
123 ["g", "<geohash>"],
124
125 // Participants
126 ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"],
127 ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"],
128
129 // Hashtags
130 ["t", "<tag>"],
131 ["t", "<tag>"],
132
133 // Reference links
134 ["r", "<url>"],
135 ["r", "<url>"]
136 ]
137}
138```
139
140## Calendar
141
142A calendar is a collection of calendar events, represented as a custom replaceable list event using kind `31924`. A user can have multiple calendars. One may create a calendar to segment calendar events for specific purposes. e.g., personal, work, travel, meetups, and conferences.
143
144### Format
145
146The `.content` of these events should be a detailed description of the calendar. It is required but can be an empty string.
147
148The format uses a custom replaceable list of kind `31924` with a list of tags as described below:
149* `d` (required) universally unique identifier. Generated by the client creating the calendar.
150* `title` (required) calendar title
151* `a` (repeated) reference tag to kind `31922` or `31923` calendar event being responded to
152
153```json
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>,
158 "kind": 31924,
159 "content": "<description of calendar>",
160 "tags": [
161 ["d", "<UUID>"],
162 ["title", "<calendar title>"],
163 ["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>"]
165 ]
166}
167```
168
169## Calendar Event RSVP
170
171A calendar event RSVP is a response to a calendar event to indicate a user's attendance intention.
172
173If a calendar event tags a pubkey, that can be interpreted as the calendar event creator inviting that user to attend. Clients MAY choose to prompt the user to RSVP for the calendar event.
174
175Any user may RSVP, even if they were not tagged on the calendar event. Clients MAY choose to prompt the calendar event creator to invite the user who RSVP'd. Clients also MAY choose to ignore these RSVPs.
176
177This NIP is intentionally not defining who is authorized to attend a calendar event if the user who RSVP'd has not been tagged. It is up to the calendar event creator to determine the semantics.
178
179This NIP is also intentionally not defining what happens if a calendar event changes after an RSVP is submitted.
180
181### Format
182
183The format uses a parameterized replaceable event kind `31925`.
184
185The `.content` of these events is optional and should be a free-form note that adds more context to this calendar event response.
186
187The list of tags are as follows:
188* `a` (required) reference tag to kind `31922` or `31923` calendar event being responded to.
189* `d` (required) universally unique identifier. Generated by the client creating the calendar event RSVP.
190* `status` (required) `accepted`, `declined`, or `tentative`. 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`.
192
193```json
194{
195 "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>,
196 "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
197 "created_at": <Unix timestamp in seconds>,
198 "kind": 31925,
199 "content": "<note>",
200 "tags": [
201 ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"],
202 ["d", "<UUID>"],
203 ["status", "<accepted/declined/tentative>"],
204 ["fb", "<free/busy>"],
205 ]
206}
207```
208
209## Unsolved Limitations
210
211* No private events
212
213## Intentionally Unsupported Scenarios
214
215### Recurring Calendar Events
216
217Recurring calendar events come with a lot of complexity, making it difficult for software and humans to deal with. This complexity includes time zone differences between invitees, daylight savings, leap years, multiple calendar systems, one-off changes in schedule or other metadata, etc.
218
219This NIP intentionally omits support for recurring calendar events and pushes that complexity up to clients to manually implement if they desire. i.e., individual calendar events with duplicated metadata represent recurring calendar events.
diff --git a/53.md b/53.md
new file mode 100644
index 0000000..0b1cb81
--- /dev/null
+++ b/53.md
@@ -0,0 +1,122 @@
1NIP-53
2======
3
4Live Activities
5---------------
6
7`draft` `optional`
8
9Service providers want to offer live activities to the Nostr network in such a way that participants can easily log and query by clients. This NIP describes a general framework to advertise the involvement of pubkeys in such live activities.
10
11## Concepts
12
13### Live Event
14
15A special event with `kind:30311` "Live Event" is defined as a _parameterized replaceable event_ of public `p` tags. Each `p` tag SHOULD have a **displayable** marker name for the current role (e.g. `Host`, `Speaker`, `Participant`) of the user in the event and the relay information MAY be empty. This event will be constantly updated as participants join and leave the activity.
16
17For example:
18
19```json
20{
21 "kind": 30311,
22 "tags": [
23 ["d", "<unique identifier>"],
24 ["title", "<name of the event>"],
25 ["summary", "<description>"],
26 ["image", "<preview image url>"],
27 ["t", "hashtag"]
28 ["streaming", "<url>"],
29 ["recording", "<url>"], // used to place the edited video once the activity is over
30 ["starts", "<unix timestamp in seconds>"],
31 ["ends", "<unix timestamp in seconds>"],
32 ["status", "<planned, live, ended>"],
33 ["current_participants", "<number>"],
34 ["total_participants", "<number>"],
35 ["p", "91cf9..4e5ca", "wss://provider1.com/", "Host", "<proof>"],
36 ["p", "14aeb..8dad4", "wss://provider2.com/nostr", "Speaker"],
37 ["p", "612ae..e610f", "ws://provider3.com/ws", "Participant"],
38 ["relays", "wss://one.com", "wss://two.com", ...]
39 ],
40 "content": "",
41 ...
42}
43```
44
45A distinct `d` tag should be used for each activity. All other tags are optional.
46
47Providers SHOULD keep the participant list small (e.g. under 1000 users) and, when limits are reached, Providers SHOULD select which participants get named in the event. Clients should not expect a comprehensive list. Once the activity ends, the event can be deleted or updated to summarize the activity and provide async content (e.g. recording of the event).
48
49Clients are expected to subscribe to `kind:30311` events in general or for given follow lists and statuses. Clients MAY display participants' roles in activities as well as access points to join the activity.
50
51Live Activity management clients are expected to constantly update `kind:30311` during the event. Clients MAY choose to consider `status=live` events after 1hr without any update as `ended`. The `starts` and `ends` timestamp SHOULD be updated when the status changes to and from `live`
52
53The activity MUST be linked to using the [NIP-19](19.md) `naddr` code along with the `a` tag.
54
55### Proof of Agreement to Participate
56
57Event owners can add proof as the 5th term in each `p` tag to clarify the participant's agreement in joining the event. The proof is a signed SHA256 of the complete `a` Tag of the event (`kind:pubkey:dTag`) by each `p`'s private key, encoded in hex.
58
59Clients MAY only display participants if the proof is available or MAY display participants as "invited" if the proof is not available.
60
61This feature is important to avoid malicious event owners adding large account holders to the event, without their knowledge, to lure their followers into the malicious owner's trap.
62
63### Live Chat Message
64
65Event `kind:1311` is live chat's channel message. Clients MUST include the `a` tag of the activity with a `root` marker. Other Kind-1 tags such as `reply` and `mention` can also be used.
66
67```json
68{
69 "kind": 1311,
70 "tags": [
71 ["a", "30311:<Community event author pubkey>:<d-identifier of the community>", "<Optional relay url>", "root"],
72 ],
73 "content": "Zaps to live streams is beautiful.",
74 ...
75}
76```
77
78## Use Cases
79
80Common use cases include meeting rooms/workshops, watch-together activities, or event spaces, such as [zap.stream](https://zap.stream).
81
82## Example
83
84### Live Streaming
85
86```json
87{
88 "id": "57f28dbc264990e2c61e80a883862f7c114019804208b14da0bff81371e484d2",
89 "pubkey": "1597246ac22f7d1375041054f2a4986bd971d8d196d7997e48973263ac9879ec",
90 "created_at": 1687182672,
91 "kind": 30311,
92 "tags": [
93 ["d", "demo-cf-stream"],
94 ["title", "Adult Swim Metalocalypse"],
95 ["summary", "Live stream from IPTV-ORG collection"],
96 ["streaming", "https://adultswim-vodlive.cdn.turner.com/live/metalocalypse/stream.m3u8"],
97 ["starts", "1687182672"],
98 ["status", "live"],
99 ["t", "animation"],
100 ["t", "iptv"],
101 ["image", "https://i.imgur.com/CaKq6Mt.png"]
102 ],
103 "content": "",
104 "sig": "5bc7a60f5688effa5287244a24768cbe0dcd854436090abc3bef172f7f5db1410af4277508dbafc4f70a754a891c90ce3b966a7bc47e7c1eb71ff57640f3d389"
105}
106```
107
108### Live Streaming chat message
109
110```json
111{
112 "id": "97aa81798ee6c5637f7b21a411f89e10244e195aa91cb341bf49f718e36c8188",
113 "pubkey": "3f770d65d3a764a9c5cb503ae123e62ec7598ad035d836e2a810f3877a745b24",
114 "created_at": 1687286726,
115 "kind": 1311,
116 "tags": [
117 ["a", "30311:1597246ac22f7d1375041054f2a4986bd971d8d196d7997e48973263ac9879ec:demo-cf-stream", "", "root"]
118 ],
119 "content": "Zaps to live streams is beautiful.",
120 "sig": "997f62ddfc0827c121043074d50cfce7a528e978c575722748629a4137c45b75bdbc84170bedc723ef0a5a4c3daebf1fef2e93f5e2ddb98e5d685d022c30b622"
121}
122````
diff --git a/54.md b/54.md
new file mode 100644
index 0000000..fe46918
--- /dev/null
+++ b/54.md
@@ -0,0 +1,117 @@
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
39Wikilinks can take these two forms:
40
41 1. `[[Target Page]]` -- in this case it will link to the page `target-page` (according to `d` tag normalization rules above) and be displayed as `Target Page`;
42 2. `[[target page|see this]]` -- in this case it will link to the page `target-page`, but will be displayed as `see this`.
43
44### Merge Requests
45
46Event `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.
47
48[INSERT EVENT EXAMPLE]
49
50### Redirects
51
52Event `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)).
53
54[INSERT EVENT EXAMPLE]
55
56How to decide what article to display
57-------------------------------------
58
59As 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:
60
61### Reactions
62
63[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.
64
65### Relays
66
67[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.
68
69### Contact lists
70
71[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.
72
73### Wiki-related contact lists
74
75[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.
76
77Forks
78---------
79Wiki-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.
80
81Deference
82---------
83Wiki-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.
84
85This is a stronger signal of trust than a `+` reaction.
86
87This 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.
88
89Why Markdown?
90-------------
91
92If 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.
93
94On 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.
95
96# Appendix 1: Merge requests
97Users can request other users to get their entries merged into someone else's entry by creating a `kind:818` event.
98
99```jsonc
100{
101 "content": "I added information about how to make hot ice-creams",
102 "kind": 818,
103 "tags": [
104 [ "a", "30818:<destination-pubkey>:hot-ice-creams", "<relay-url>" ],
105 [ "e", "<version-against-which-the-modification-was-made>", "<relay-url>' ],
106 [ "p", "<destination-pubkey>" ],
107 [ "e", "<version-to-be-merged>", "<relay-url>", "source" ]
108 ]
109}
110```
111
112`.content`: an optional explanation detailing why this merge is being requested.
113`a` tag: tag of the article which should be modified (i.e. the target of this merge request).
114`e` tag: optional version of the article in which this modifications is based
115`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.
116
117The 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/55.md b/55.md
new file mode 100644
index 0000000..4565e8c
--- /dev/null
+++ b/55.md
@@ -0,0 +1,538 @@
1# NIP-55
2
3## Android Signer Application
4
5`draft` `optional`
6
7This NIP describes a method for 2-way communication between an Android signer and any Nostr client on Android. The Android signer is an Android Application and the client can be a web client or an Android application.
8
9# Usage for Android applications
10
11The Android signer uses Intents and Content Resolvers to communicate between applications.
12
13To be able to use the Android signer in your application you should add this to your AndroidManifest.xml:
14
15```xml
16<queries>
17 <intent>
18 <action android:name="android.intent.action.VIEW" />
19 <category android:name="android.intent.category.BROWSABLE" />
20 <data android:scheme="nostrsigner" />
21 </intent>
22</queries>
23```
24
25Then you can use this function to check if there's a signer application installed:
26
27```kotlin
28fun isExternalSignerInstalled(context: Context): Boolean {
29 val intent =
30 Intent().apply {
31 action = Intent.ACTION_VIEW
32 data = Uri.parse("nostrsigner:")
33 }
34 val infos = context.packageManager.queryIntentActivities(intent, 0)
35 return infos.size > 0
36}
37```
38
39## Using Intents
40
41To get the result back from the Signer Application you should use `registerForActivityResult` or `rememberLauncherForActivityResult` in Kotlin. If you are using another framework check the documentation of your framework or a third party library to get the result.
42
43```kotlin
44val launcher = rememberLauncherForActivityResult(
45 contract = ActivityResultContracts.StartActivityForResult(),
46 onResult = { result ->
47 if (result.resultCode != Activity.RESULT_OK) {
48 Toast.makeText(
49 context,
50 "Sign request rejected",
51 Toast.LENGTH_SHORT
52 ).show()
53 } else {
54 val signature = activityResult.data?.getStringExtra("signature")
55 // Do something with signature ...
56 }
57 }
58)
59```
60
61Create the Intent using the **nostrsigner** scheme:
62
63```kotlin
64val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$content"))
65```
66
67Set the Signer package name:
68
69```kotlin
70intent.`package` = "com.example.signer"
71```
72
73Send the Intent:
74
75```kotlin
76launcher.launch(intent)
77```
78
79### Methods
80
81- **get_public_key**
82 - params:
83
84 ```kotlin
85 val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:"))
86 intent.`package` = "com.example.signer"
87 intent.putExtra("type", "get_public_key")
88 // You can send some default permissions for the user to authorize for ever
89 val permissions = listOf(
90 Permission(
91 type = "sign_event",
92 kind = 22242
93 ),
94 Permission(
95 type = "nip44_decrypt"
96 )
97 )
98 intent.putExtra("permissions", permissions.toJson())
99 context.startActivity(intent)
100 ```
101 - result:
102 - If the user approved intent it will return the **npub** in the signature field
103
104 ```kotlin
105 val npub = intent.data?.getStringExtra("signature")
106 // The package name of the signer application
107 val packageName = intent.data?.getStringExtra("package")
108 ```
109
110- **sign_event**
111 - params:
112
113 ```kotlin
114 val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$eventJson"))
115 intent.`package` = "com.example.signer"
116 intent.putExtra("type", "sign_event")
117 // To handle results when not waiting between intents
118 intent.putExtra("id", event.id)
119 // Send the current logged in user npub
120 intent.putExtra("current_user", npub)
121
122 context.startActivity(intent)
123 ```
124 - result:
125 - If the user approved intent it will return the **signature**, **id** and **event** fields
126
127 ```kotlin
128 val signature = intent.data?.getStringExtra("signature")
129 // The id you sent
130 val id = intent.data?.getStringExtra("id")
131 val signedEventJson = intent.data?.getStringExtra("event")
132 ```
133
134- **nip04_encrypt**
135 - params:
136
137 ```kotlin
138 val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$plaintext"))
139 intent.`package` = "com.example.signer"
140 intent.putExtra("type", "nip04_encrypt")
141 // to control the result in your application in case you are not waiting the result before sending another intent
142 intent.putExtra("id", "some_id")
143 // Send the current logged in user npub
144 intent.putExtra("current_user", account.keyPair.pubKey.toNpub())
145 // Send the hex pubKey that will be used for encrypting the data
146 intent.putExtra("pubKey", pubKey)
147
148 context.startActivity(intent)
149 ```
150 - result:
151 - If the user approved intent it will return the **signature** and **id** fields
152
153 ```kotlin
154 val encryptedText = intent.data?.getStringExtra("signature")
155 // the id you sent
156 val id = intent.data?.getStringExtra("id")
157 ```
158
159- **nip44_encrypt**
160 - params:
161
162 ```kotlin
163 val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$plaintext"))
164 intent.`package` = "com.example.signer"
165 intent.putExtra("type", "nip44_encrypt")
166 // to control the result in your application in case you are not waiting the result before sending another intent
167 intent.putExtra("id", "some_id")
168 // Send the current logged in user npub
169 intent.putExtra("current_user", account.keyPair.pubKey.toNpub())
170 // Send the hex pubKey that will be used for encrypting the data
171 intent.putExtra("pubKey", pubKey)
172
173 context.startActivity(intent)
174 ```
175 - result:
176 - If the user approved intent it will return the **signature** and **id** fields
177
178 ```kotlin
179 val encryptedText = intent.data?.getStringExtra("signature")
180 // the id you sent
181 val id = intent.data?.getStringExtra("id")
182 ```
183
184- **nip04_decrypt**
185 - params:
186
187 ```kotlin
188 val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$encryptedText"))
189 intent.`package` = "com.example.signer"
190 intent.putExtra("type", "nip04_decrypt")
191 // to control the result in your application in case you are not waiting the result before sending another intent
192 intent.putExtra("id", "some_id")
193 // Send the current logged in user npub
194 intent.putExtra("current_user", account.keyPair.pubKey.toNpub())
195 // Send the hex pubKey that will be used for decrypting the data
196 intent.putExtra("pubKey", pubKey)
197
198 context.startActivity(intent)
199 ```
200 - result:
201 - If the user approved intent it will return the **signature** and **id** fields
202
203 ```kotlin
204 val plainText = intent.data?.getStringExtra("signature")
205 // the id you sent
206 val id = intent.data?.getStringExtra("id")
207 ```
208
209- **nip44_decrypt**
210 - params:
211
212 ```kotlin
213 val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$encryptedText"))
214 intent.`package` = "com.example.signer"
215 intent.putExtra("type", "nip04_decrypt")
216 // to control the result in your application in case you are not waiting the result before sending another intent
217 intent.putExtra("id", "some_id")
218 // Send the current logged in user npub
219 intent.putExtra("current_user", account.keyPair.pubKey.toNpub())
220 // Send the hex pubKey that will be used for decrypting the data
221 intent.putExtra("pubKey", pubKey)
222
223 context.startActivity(intent)
224 ```
225 - result:
226 - If the user approved intent it will return the **signature** and **id** fields
227
228 ```kotlin
229 val plainText = intent.data?.getStringExtra("signature")
230 // the id you sent
231 val id = intent.data?.getStringExtra("id")
232 ```
233
234- **decrypt_zap_event**
235 - params:
236
237 ```kotlin
238 val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$eventJson"))
239 intent.`package` = "com.example.signer"
240 intent.putExtra("type", "decrypt_zap_event")
241 // to control the result in your application in case you are not waiting the result before sending another intent
242 intent.putExtra("id", "some_id")
243 // Send the current logged in user npub
244 intent.putExtra("current_user", account.keyPair.pubKey.toNpub())
245 context.startActivity(intent)
246 ```
247 - result:
248 - If the user approved intent it will return the **signature** and **id** fields
249
250 ```kotlin
251 val eventJson = intent.data?.getStringExtra("signature")
252 // the id you sent
253 val id = intent.data?.getStringExtra("id")
254 ```
255
256## Using Content Resolver
257
258To get the result back from Signer Application you should use contentResolver.query in Kotlin. If you are using another framework check the documentation of your framework or a third party library to get the result.
259
260If the user did not check the "remember my choice" option, the npub is not in Signer Application or the signer type is not recognized the `contentResolver` will return null
261
262For the SIGN_EVENT type Signer Application returns two columns "signature" and "event". The column event is the signed event json
263
264For the other types Signer Application returns the column "signature"
265
266If the user chose to always reject the event, signer application will return the column "rejected" and you should not open signer application
267
268### Methods
269
270- **get_public_key**
271 - params:
272
273 ```kotlin
274 val result = context.contentResolver.query(
275 Uri.parse("content://com.example.signer.GET_PUBLIC_KEY"),
276 listOf("login"),
277 null,
278 null,
279 null
280 )
281 ```
282 - result:
283 - Will return the **npub** in the signature column
284
285 ```kotlin
286 if (result == null) return
287
288 if (result.moveToFirst()) {
289 val index = it.getColumnIndex("signature")
290 if (index < 0) return
291 val npub = it.getString(index)
292 }
293 ```
294
295- **sign_event**
296 - params:
297
298 ```kotlin
299 val result = context.contentResolver.query(
300 Uri.parse("content://com.example.signer.SIGN_EVENT"),
301 listOf("$eventJson", "", "${logged_in_user_npub}"),
302 null,
303 null,
304 null
305 )
306 ```
307 - result:
308 - Will return the **signature** and the **event** columns
309
310 ```kotlin
311 if (result == null) return
312
313 if (result.moveToFirst()) {
314 val index = it.getColumnIndex("signature")
315 val indexJson = it.getColumnIndex("event")
316 val signature = it.getString(index)
317 val eventJson = it.getString(indexJson)
318 }
319 ```
320
321- **nip04_encrypt**
322 - params:
323
324 ```kotlin
325 val result = context.contentResolver.query(
326 Uri.parse("content://com.example.signer.NIP04_ENCRYPT"),
327 listOf("$plainText", "${hex_pub_key}", "${logged_in_user_npub}"),
328 null,
329 null,
330 null
331 )
332 ```
333 - result:
334 - Will return the **signature** column
335
336 ```kotlin
337 if (result == null) return
338
339 if (result.moveToFirst()) {
340 val index = it.getColumnIndex("signature")
341 val encryptedText = it.getString(index)
342 }
343 ```
344
345- **nip44_encrypt**
346 - params:
347
348 ```kotlin
349 val result = context.contentResolver.query(
350 Uri.parse("content://com.example.signer.NIP44_ENCRYPT"),
351 listOf("$plainText", "${hex_pub_key}", "${logged_in_user_npub}"),
352 null,
353 null,
354 null
355 )
356 ```
357 - result:
358 - Will return the **signature** column
359
360 ```kotlin
361 if (result == null) return
362
363 if (result.moveToFirst()) {
364 val index = it.getColumnIndex("signature")
365 val encryptedText = it.getString(index)
366 }
367 ```
368
369- **nip04_decrypt**
370 - params:
371
372 ```kotlin
373 val result = context.contentResolver.query(
374 Uri.parse("content://com.example.signer.NIP04_DECRYPT"),
375 listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_npub}"),
376 null,
377 null,
378 null
379 )
380 ```
381 - result:
382 - Will return the **signature** column
383
384 ```kotlin
385 if (result == null) return
386
387 if (result.moveToFirst()) {
388 val index = it.getColumnIndex("signature")
389 val encryptedText = it.getString(index)
390 }
391 ```
392
393- **nip44_decrypt**
394 - params:
395
396 ```kotlin
397 val result = context.contentResolver.query(
398 Uri.parse("content://com.example.signer.NIP44_DECRYPT"),
399 listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_npub}"),
400 null,
401 null,
402 null
403 )
404 ```
405 - result:
406 - Will return the **signature** column
407
408 ```kotlin
409 if (result == null) return
410
411 if (result.moveToFirst()) {
412 val index = it.getColumnIndex("signature")
413 val encryptedText = it.getString(index)
414 }
415 ```
416
417- **decrypt_zap_event**
418 - params:
419
420 ```kotlin
421 val result = context.contentResolver.query(
422 Uri.parse("content://com.example.signer.DECRYPT_ZAP_EVENT"),
423 listOf("$eventJson", "", "${logged_in_user_npub}"),
424 null,
425 null,
426 null
427 )
428 ```
429 - result:
430 - Will return the **signature** column
431
432 ```kotlin
433 if (result == null) return
434
435 if (result.moveToFirst()) {
436 val index = it.getColumnIndex("signature")
437 val eventJson = it.getString(index)
438 }
439 ```
440
441# Usage for Web Applications
442
443Since web applications can't receive a result from the intent, you should add a modal to paste the signature or the event json or create a callback url.
444
445If you send the callback url parameter, Signer Application will send the result to the url.
446
447If you don't send a callback url, Signer Application will copy the result to the clipboard.
448
449You can configure the `returnType` to be **signature** or **event**.
450
451Android intents and browser urls have limitations, so if you are using the `returnType` of **event** consider using the parameter **compressionType=gzip** that will return "Signer1" + Base64 gzip encoded event json
452
453## Methods
454
455- **get_public_key**
456 - params:
457
458 ```js
459 window.href = `nostrsigner:?compressionType=none&returnType=signature&type=get_public_key&callbackUrl=https://example.com/?event=`;
460 ```
461
462- **sign_event**
463 - params:
464
465 ```js
466 window.href = `nostrsigner:${eventJson}?compressionType=none&returnType=signature&type=sign_event&callbackUrl=https://example.com/?event=`;
467 ```
468
469- **nip04_encrypt**
470 - params:
471
472 ```js
473 window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_encrypt&callbackUrl=https://example.com/?event=`;
474 ```
475
476- **nip44_encrypt**
477 - params:
478
479 ```js
480 window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_encrypt&callbackUrl=https://example.com/?event=`;
481 ```
482
483- **nip04_decrypt**
484 - params:
485
486 ```js
487 window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_decrypt&callbackUrl=https://example.com/?event=`;
488 ```
489
490- **nip44_decrypt**
491 - params:
492
493 ```js
494 window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_decrypt&callbackUrl=https://example.com/?event=`;
495 ```
496
497- **decrypt_zap_event**
498 - params:
499
500 ```js
501 window.href = `nostrsigner:${eventJson}?compressionType=none&returnType=signature&type=decrypt_zap_event&callbackUrl=https://example.com/?event=`;
502 ```
503
504## Example
505
506```js
507<!DOCTYPE html>
508<html lang="en">
509<head>
510 <meta charset="UTF-8">
511 <meta name="viewport" content="width=device-width, initial-scale=1.0">
512 <title>Document</title>
513</head>
514<body>
515 <h1>Test</h1>
516
517 <script>
518 window.onload = function() {
519 var url = new URL(window.location.href);
520 var params = url.searchParams;
521 if (params) {
522 var param1 = params.get("event");
523 if (param1) alert(param1)
524 }
525 let json = {
526 kind: 1,
527 content: "test"
528 }
529 let encodedJson = encodeURIComponent(JSON.stringify(json))
530 var newAnchor = document.createElement("a");
531 newAnchor.href = `nostrsigner:${encodedJson}?compressionType=none&returnType=signature&type=sign_event&callbackUrl=https://example.com/?event=`;
532 newAnchor.textContent = "Open External Signer";
533 document.body.appendChild(newAnchor)
534 }
535 </script>
536</body>
537</html>
538```
diff --git a/56.md b/56.md
index 55ee1a2..fc8d898 100644
--- a/56.md
+++ b/56.md
@@ -1,16 +1,17 @@
1
2NIP-56 1NIP-56
3====== 2======
4 3
5Reporting 4Reporting
6--------- 5---------
7 6
8`draft` `optional` `author:jb55` 7`optional`
9 8
10A 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
11illegal 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.
12 13
13The content MAY contain additional information submitted by the entity 14The `content` MAY contain additional information submitted by the entity
14reporting the content. 15reporting the content.
15 16
16Tags 17Tags
@@ -25,13 +26,18 @@ A `report type` string MUST be included as the 3rd entry to the `e` or `p` tag
25being reported, which consists of the following report types: 26being reported, which consists of the following report types:
26 27
27- `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.
28- `profanity` - profanity, hateful speech, etc. 30- `profanity` - profanity, hateful speech, etc.
29- `illegal` - something which may be illegal in some jurisdiction 31- `illegal` - something which may be illegal in some jurisdiction
30- `spam` - spam 32- `spam` - spam
31- `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
32 35
33Some report tags only make sense for profile reports, such as `impersonation` 36Some report tags only make sense for profile reports, such as `impersonation`
34 37
38`l` and `L` tags MAY be also be used as defined in [NIP-32](32.md) to support
39further qualification and querying.
40
35Example events 41Example events
36-------------- 42--------------
37 43
@@ -39,7 +45,9 @@ Example events
39{ 45{
40 "kind": 1984, 46 "kind": 1984,
41 "tags": [ 47 "tags": [
42 [ "p", <pubkey>, "nudity"] 48 ["p", <pubkey>, "nudity"],
49 ["L", "social.nos.ontology"],
50 ["l", "NS-nud", "social.nos.ontology"]
43 ], 51 ],
44 "content": "", 52 "content": "",
45 ... 53 ...
@@ -48,8 +56,8 @@ Example events
48{ 56{
49 "kind": 1984, 57 "kind": 1984,
50 "tags": [ 58 "tags": [
51 [ "e", <eventId>, "illegal"], 59 ["e", <eventId>, "illegal"],
52 [ "p", <pubkey>] 60 ["p", <pubkey>]
53 ], 61 ],
54 "content": "He's insulting the king!", 62 "content": "He's insulting the king!",
55 ... 63 ...
@@ -58,10 +66,9 @@ Example events
58{ 66{
59 "kind": 1984, 67 "kind": 1984,
60 "tags": [ 68 "tags": [
61 [ "p", <impersonator pubkey>, "impersonation"], 69 ["p", <impersonator pubkey>, "impersonation"]
62 [ "p", <victim pubkey>]
63 ], 70 ],
64 "content": "Profile is imitating #[1]", 71 "content": "Profile is impersonating nostr:<victim bech32 pubkey>",
65 ... 72 ...
66} 73}
67``` 74```
@@ -70,7 +77,7 @@ Client behavior
70--------------- 77---------------
71 78
72Clients can use reports from friends to make moderation decisions if they 79Clients can use reports from friends to make moderation decisions if they
73choose to. For instance, if 3+ of your friends report a profile as explicit, 80choose to. For instance, if 3+ of your friends report a profile for `nudity`,
74clients can have an option to automatically blur photos from said account. 81clients can have an option to automatically blur photos from said account.
75 82
76 83
diff --git a/57.md b/57.md
index 17042ea..d04eeff 100644
--- a/57.md
+++ b/57.md
@@ -4,23 +4,23 @@ NIP-57
4Lightning Zaps 4Lightning Zaps
5-------------- 5--------------
6 6
7`draft` `optional` `author:jb55` `author:kieran` 7`draft` `optional`
8 8
9This NIP defines two new event types for recording lightning payments between users. `9734` is a `zap request`, representing a payer's request to a recipient's lightning wallet for an invoice. `9735` is a `zap receipt`, representing the confirmation by the recipient's lightning wallet that the invoice issued in response to a zap request has been paid. 9This NIP defines two new event types for recording lightning payments between users. `9734` is a `zap request`, representing a payer's request to a recipient's lightning wallet for an invoice. `9735` is a `zap receipt`, representing the confirmation by the recipient's lightning wallet that the invoice issued in response to a `zap request` has been paid.
10 10
11Having lightning receipts on nostr allows clients to display lightning payments from entities on the network. These can be used for fun or for spam deterrence. 11Having lightning receipts on nostr allows clients to display lightning payments from entities on the network. These can be used for fun or for spam deterrence.
12 12
13## Protocol flow 13## Protocol flow
14 14
151. Client calculates a recipient's lnurl pay request url from the `zap` tag on the event being zapped (see Appendix G), or by decoding their lud06 or lud16 field on their profile according to the [lnurl specifications](https://github.com/lnurl/luds). The client MUST send a GET request to this url and parse the response. If `allowsNostr` exists and it is `true`, and if `nostrPubkey` exists and is a valid BIP 340 public key in hex, the client should associate this information with the user, along with the response's `callback`, `minSendable`, and `maxSendable` values. 151. Client calculates a recipient's lnurl pay request url from the `zap` tag on the event being zapped (see Appendix G), or by decoding their lud06 or lud16 field on their profile according to the [lnurl specifications](https://github.com/lnurl/luds). The client MUST send a GET request to this url and parse the response. If `allowsNostr` exists and it is `true`, and if `nostrPubkey` exists and is a valid BIP 340 public key in hex, the client should associate this information with the user, along with the response's `callback`, `minSendable`, and `maxSendable` values.
162. Clients may choose to display a lightning zap button on each post or on a user's profile. If the user's lnurl pay request endpoint supports nostr, the client SHOULD use this NIP to request a zap receipt rather than a normal lnurl invoice. 162. Clients may choose to display a lightning zap button on each post or on a user's profile. If the user's lnurl pay request endpoint supports nostr, the client SHOULD use this NIP to request a `zap receipt` rather than a normal lnurl invoice.
173. When a user (the "sender") indicates they want to send a zap to another user (the "recipient"), the client should create a `zap request` event as described in Appendix A of this NIP and sign it. 173. When a user (the "sender") indicates they want to send a zap to another user (the "recipient"), the client should create a `zap request` event as described in Appendix A of this NIP and sign it.
184. Instead of publishing the `zap request`, the `9734` event should instead be sent to the `callback` url received from the lnurl pay endpoint for the recipient using a GET request. See Appendix B for details and an example. 184. Instead of publishing the `zap request`, the `9734` event should instead be sent to the `callback` url received from the lnurl pay endpoint for the recipient using a GET request. See Appendix B for details and an example.
195. The recipient's lnurl server will receive this request and validate it. See Appendix C for details on how to properly configure an lnurl server to support zaps, and Appendix D for details on how to validate the `nostr` query parameter. 195. The recipient's lnurl server will receive this `zap request` and validate it. See Appendix C for details on how to properly configure an lnurl server to support zaps, and Appendix D for details on how to validate the `nostr` query parameter.
206. If the request is valid, the server should fetch a description hash invoice where the description is this note and this note only. No additional lnurl metadata is included in the description. This will be returned in the response according to [LUD06](https://github.com/lnurl/luds/blob/luds/06.md). 206. If the `zap request` is valid, the server should fetch a description hash invoice where the description is this `zap request` note and this note only. No additional lnurl metadata is included in the description. This will be returned in the response according to [LUD06](https://github.com/lnurl/luds/blob/luds/06.md).
217. On receiving the invoice, the client MAY pay it or pass it to an app that can pay the invoice. 217. On receiving the invoice, the client MAY pay it or pass it to an app that can pay the invoice.
228. Once the invoice is paid, the recipient's lnurl server MUST generate a `zap receipt` as described in Appendix E, and publish it to the `relays` specified in the `zap request`. 228. Once the invoice is paid, the recipient's lnurl server MUST generate a `zap receipt` as described in Appendix E, and publish it to the `relays` specified in the `zap request`.
239. Clients MAY fetch zap notes on posts and profiles, but MUST authorize their validity as described in Appendix F. If the zap request note contains a non-empty `content`, it may display a zap comment. Generally clients should show users the `zap request` note, and use the `zap note` to show "zap authorized by ..." but this is optional. 239. Clients MAY fetch `zap receipt`s on posts and profiles, but MUST authorize their validity as described in Appendix F. If the `zap request` note contains a non-empty `content`, it may display a zap comment. Generally clients should show users the `zap request` note, and use the `zap receipt` to show "zap authorized by ..." but this is optional.
24 24
25## Reference and examples 25## Reference and examples
26 26
@@ -36,7 +36,7 @@ A `zap request` is an event of kind `9734` that is _not_ published to relays, bu
36In addition, the event MAY include the following tags: 36In addition, the event MAY include the following tags:
37 37
38- `e` is an optional hex-encoded event id. Clients MUST include this if zapping an event rather than a person. 38- `e` is an optional hex-encoded event id. Clients MUST include this if zapping an event rather than a person.
39- `a` is an optional NIP-33 event coordinate that allows tipping parameterized replaceable events such as NIP-23 long-form notes. 39- `a` is an optional event coordinate that allows tipping parameterized replaceable events such as NIP-23 long-form notes.
40 40
41Example: 41Example:
42 42
@@ -45,7 +45,7 @@ Example:
45 "kind": 9734, 45 "kind": 9734,
46 "content": "Zap!", 46 "content": "Zap!",
47 "tags": [ 47 "tags": [
48 ["relays", "wss://nostr-pub.wellorder.com"], 48 ["relays", "wss://nostr-pub.wellorder.com", "wss://anotherrelay.example.com"],
49 ["amount", "21000"], 49 ["amount", "21000"],
50 ["lnurl", "lnurl1dp68gurn8ghj7um5v93kketj9ehx2amn9uh8wetvdskkkmn0wahz7mrww4excup0dajx2mrv92x9xp"], 50 ["lnurl", "lnurl1dp68gurn8ghj7um5v93kketj9ehx2amn9uh8wetvdskkkmn0wahz7mrww4excup0dajx2mrv92x9xp"],
51 ["p", "04c915daefee38317fa734444acee390a8269fe5810b2241e5e6dd343dfbecc9"], 51 ["p", "04c915daefee38317fa734444acee390a8269fe5810b2241e5e6dd343dfbecc9"],
@@ -60,13 +60,13 @@ Example:
60 60
61### Appendix B: Zap Request HTTP Request 61### Appendix B: Zap Request HTTP Request
62 62
63A signed zap request event is not published, but is instead sent using a HTTP GET request to the recipient's `callback` url, which was provided by the recipient's lnurl pay endpoint. This request should have the following query parameters defined: 63A signed `zap request` event is not published, but is instead sent using a HTTP GET request to the recipient's `callback` url, which was provided by the recipient's lnurl pay endpoint. This request should have the following query parameters defined:
64 64
65- `amount` is the amount in _millisats_ the sender intends to pay 65- `amount` is the amount in _millisats_ the sender intends to pay
66- `nostr` is the `9734` zap request event, JSON encoded then URI encoded 66- `nostr` is the `9734` `zap request` event, JSON encoded then URI encoded
67- `lnurl` is the lnurl pay url of the recipient, encoded using bech32 with the prefix `lnurl` 67- `lnurl` is the lnurl pay url of the recipient, encoded using bech32 with the prefix `lnurl`
68 68
69This request should return a JSON response with a `pr` key, which is the invoice the sender must pay to finalize his zap. Here is an example flow: 69This request should return a JSON response with a `pr` key, which is the invoice the sender must pay to finalize his zap. Here is an example flow in javascript:
70 70
71```javascript 71```javascript
72const senderPubkey // The sender's pubkey 72const senderPubkey // The sender's pubkey
@@ -78,7 +78,7 @@ const sats = 21
78const amount = sats * 1000 78const amount = sats * 1000
79const relays = ['wss://nostr-pub.wellorder.net'] 79const relays = ['wss://nostr-pub.wellorder.net']
80const event = encodeURI(JSON.stringify(await signEvent({ 80const event = encodeURI(JSON.stringify(await signEvent({
81 kind: [9734], 81 kind: 9734,
82 content: "", 82 content: "",
83 pubkey: senderPubkey, 83 pubkey: senderPubkey,
84 created_at: Math.round(Date.now() / 1000), 84 created_at: Math.round(Date.now() / 1000),
@@ -97,48 +97,49 @@ const {pr: invoice} = await fetchJson(`${callback}?amount=${amount}&nostr=${even
97 97
98The lnurl server will need some additional pieces of information so that clients can know that zap invoices are supported: 98The lnurl server will need some additional pieces of information so that clients can know that zap invoices are supported:
99 99
1001. Add a `nostrPubkey` to the lnurl-pay static endpoint `/.well-known/lnurlp/<user>`, where `nostrPubkey` is the nostr pubkey your server will use to sign `zap receipt` events. Clients will use this to validate zap receipts. 1001. Add a `nostrPubkey` to the lnurl-pay static endpoint `/.well-known/lnurlp/<user>`, where `nostrPubkey` is the nostr pubkey your server will use to sign `zap receipt` events. Clients will use this to validate `zap receipt`s.
1012. Add an `allowsNostr` field and set it to true. 1012. Add an `allowsNostr` field and set it to true.
102 102
103### Appendix D: LNURL Server Zap Request Validation 103### Appendix D: LNURL Server Zap Request Validation
104 104
105When a client sends a zap request event to a server's lnurl-pay callback URL, there will be a `nostr` query parameter where the contents of the event are URI- and JSON-encoded. If present, the zap request event must be validated in the following ways: 105When a client sends a `zap request` event to a server's lnurl-pay callback URL, there will be a `nostr` query parameter whose value is that event which is URI- and JSON-encoded. If present, the `zap request` event must be validated in the following ways:
106 106
1071. It MUST have a valid nostr signature 1071. It MUST have a valid nostr signature
1082. It MUST have tags 1082. It MUST have tags
1093. It MUST have only one `p` tag 1093. It MUST have only one `p` tag
1104. It MUST have 0 or 1 `e` tags 1104. It MUST have 0 or 1 `e` tags
1115. There should be a `relays` tag with the relays to send the `zap` note 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 NIP-33 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
117### Appendix E: Zap Receipt Event 118### Appendix E: Zap Receipt Event
118 119
119A `zap receipt` is created by a lightning node when an invoice generated by a `zap request` is paid. Zap receipts are only created when the invoice description (committed to the description hash) contains a zap request note. 120A `zap receipt` is created by a lightning node when an invoice generated by a `zap request` is paid. `Zap receipt`s are only created when the invoice description (committed to the description hash) contains a `zap request` note.
120 121
121When receiving a payment, the following steps are executed: 122When receiving a payment, the following steps are executed:
122 123
1231. Get the description for the invoice. This needs to be saved somewhere during the generation of the description hash invoice. It is saved automatically for you with CLN, which is the reference implementation used here. 1241. Get the description for the invoice. This needs to be saved somewhere during the generation of the description hash invoice. It is saved automatically for you with CLN, which is the reference implementation used here.
1242. Parse the bolt11 description as a JSON nostr event. This SHOULD be validated based on the requirements in Appendix D, either when it is received, or before the invoice is paid. 1252. Parse the bolt11 description as a JSON nostr event. This SHOULD be validated based on the requirements in Appendix D, either when it is received, or before the invoice is paid.
1253. Create a nostr event of kind `9735` as described below, and publish it to the `relays` declared in the zap request. 1263. Create a nostr event of kind `9735` as described below, and publish it to the `relays` declared in the `zap request`.
126 127
127The following should be true of the zap receipt event: 128The 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. 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 zap request.
134- `SHA256(description)` MUST match the description hash in the bolt11 invoice. 135- `SHA256(description)` MUST match the description hash in the bolt11 invoice.
135- The zap receipt MAY contain a `preimage` tag to match against the payment hash of the bolt11 invoice. This isn't really a payment proof, there is no real way to prove that the invoice is real or has been paid. You are trusting the author of the zap receipt for the legitimacy of the payment. 136- The `zap receipt` MAY contain a `preimage` tag to match against the payment hash of the bolt11 invoice. This isn't really a payment proof, there is no real way to prove that the invoice is real or has been paid. You are trusting the author of the `zap receipt` for the legitimacy of the payment.
136 137
137The zap receipt is not a proof of payment, all it proves is that some nostr user fetched an invoice. The existence of the zap receipt implies the invoice as paid, but it could be a lie given a rogue implementation. 138The `zap receipt` is not a proof of payment, all it proves is that some nostr user fetched an invoice. The existence of the `zap receipt` implies the invoice as paid, but it could be a lie given a rogue implementation.
138 139
139A reference implementation for a zap-enabled lnurl server can be found [here](https://github.com/jb55/cln-nostr-zapper). 140A reference implementation for a zap-enabled lnurl server can be found [here](https://github.com/jb55/cln-nostr-zapper).
140 141
141Example zap receipt: 142Example `zap receipt`:
142 143
143```json 144```json
144{ 145{
@@ -148,36 +149,40 @@ 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
161### Appendix F: Validating Zap Receipts 162### Appendix F: Validating Zap Receipts
162 163
163A client can retrieve `zap receipts` on events and pubkeys using a NIP-01 filter, for example `{"kinds": [9735], "#e": [...]}`. Zaps MUST be validated using the following steps: 164A client can retrieve `zap receipt`s on events and pubkeys using a NIP-01 filter, for example `{"kinds": [9735], "#e": [...]}`. Zaps MUST be validated using the following steps:
164 165
165- The `zap receipt` event's `pubkey` MUST be the same as the recipient's lnurl provider's `nostrPubkey` (retrieved in step 1 of the protocol flow). 166- The `zap receipt` event's `pubkey` MUST be the same as the recipient's lnurl provider's `nostrPubkey` (retrieved in step 1 of the protocol flow).
166- The `invoiceAmount` contained in the `bolt11` tag of the `zap receipt` MUST equal the `amount` tag of the `zap request` (if present). 167- The `invoiceAmount` contained in the `bolt11` tag of the `zap receipt` MUST equal the `amount` tag of the `zap request` (if present).
167- The `lnurl` tag of the `zap request` (if present) SHOULD equal the recipient's `lnurl`. 168- The `lnurl` tag of the `zap request` (if present) SHOULD equal the recipient's `lnurl`.
168 169
169### Appendix G: `zap` tag on zapped event 170### Appendix G: `zap` tag on other events
170 171
171When an event includes a `zap` tag, clients SHOULD calculate the lnurl pay request based on it's value instead of the profile's field. An optional third argument on the tag specifies the type of value, either `lud06` or `lud16`. 172When an event includes one or more `zap` tags, clients wishing to zap it SHOULD calculate the lnurl pay request based on the tags value instead of the event author's profile field. The tag's second argument is the `hex` string of the receiver's pub key and the third argument is the relay to download the receiver's metadata (Kind-0). An optional fourth parameter specifies the weight (a generalization of a percentage) assigned to the respective receiver. Clients should parse all weights, calculate a sum, and then a percentage to each receiver. If weights are not present, CLIENTS should equally divide the zap amount to all receivers. If weights are only partially present, receivers without a weight should not be zapped (`weight = 0`).
172 173
173```json 174```js
174{ 175{
175 "tags": [ 176 "tags": [
176 [ "zap", "pablo@f7z.io", "lud16" ] 177 [ "zap", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2", "wss://nostr.oxtr.dev", "1" ], // 25%
178 [ "zap", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", "wss://nostr.wine/", "1" ], // 25%
179 [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "wss://nos.lol/", "2" ] // 50%
177 ] 180 ]
178} 181}
179``` 182```
180 183
184Clients MAY display the zap split configuration in the note.
185
181## Future Work 186## Future Work
182 187
183Zaps can be extended to be more private by encrypting zap request notes to the target user, but for simplicity it has been left out of this initial draft. 188Zaps can be extended to be more private by encrypting `zap request` notes to the target user, but for simplicity it has been left out of this initial draft.
diff --git a/58.md b/58.md
index 2fa4406..4a9ed4c 100644
--- a/58.md
+++ b/58.md
@@ -4,20 +4,14 @@ NIP-58
4Badges 4Badges
5------ 5------
6 6
7`draft` `optional` `author:cameri` 7`draft` `optional`
8 8
9Three special events are used to define, award and display badges in 9Three special events are used to define, award and display badges in
10user profiles: 10user profiles:
11 11
121. A "Badge Definition" event is defined as a parameterized replaceable event 121. A "Badge Definition" event is defined as a parameterized replaceable event with kind `30009` having a `d` tag with a value that uniquely identifies the badge (e.g. `bravery`) published by the badge issuer. Badge definitions can be updated.
13with kind `30009` having a `d` tag with a value that uniquely identifies
14the badge (e.g. `bravery`) published by the badge issuer. Badge definitions can
15be updated.
16 13
172. A "Badge Award" event is a kind `8` event with a single `a` tag referencing 142. A "Badge Award" event is a kind `8` event with a single `a` tag referencing a "Badge Definition" event and one or more `p` tags, one for each pubkey the badge issuer wishes to award. Awarded badges are immutable and non-transferrable.
18a "Define Badge" event and one or more `p` tags, one for each pubkey the
19badge issuer wishes to award. The value for the `a` tag MUST follow the format
20defined in [NIP-33](33.md). Awarded badges are immutable and non-transferrable.
21 15
223. A "Profile Badges" event is defined as a parameterized replaceable event 163. A "Profile Badges" event is defined as a parameterized replaceable event
23with kind `30008` with a `d` tag with the value `profile_badges`. 17with kind `30008` with a `d` tag with the value `profile_badges`.
@@ -34,7 +28,7 @@ The following tags MAY be present:
34- A `name` tag with a short name for the badge. 28- A `name` tag with a short name for the badge.
35- `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.
36- 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
37image, the meaning behind the badge, or the reason of it's issuance. 31image, the meaning behind the badge, or the reason of its issuance.
38- 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.
39 33
40### Badge Award event 34### Badge Award event
@@ -68,8 +62,6 @@ Users MAY choose to decorate their profiles with badges for fame, notoriety, rec
68 62
69### Recommendations 63### Recommendations
70 64
71Badge issuers MAY include some Proof of Work as per [NIP-13](13.md) when minting Badge Definitions or Badge Awards to embed them with a combined energy cost, arguably making them more special and valuable for users that wish to collect them.
72
73Clients MAY whitelist badge issuers (pubkeys) for the purpose of ensuring they retain a valuable/special factor for their users. 65Clients MAY whitelist badge issuers (pubkeys) for the purpose of ensuring they retain a valuable/special factor for their users.
74 66
75Badge image recommended aspect ratio is 1:1 with a high-res size of 1024x1024 pixels. 67Badge image recommended aspect ratio is 1:1 with a high-res size of 1024x1024 pixels.
@@ -91,7 +83,7 @@ Clients SHOULD attempt to render the most appropriate badge thumbnail according
91 ["name", "Medal of Bravery"], 83 ["name", "Medal of Bravery"],
92 ["description", "Awarded to users demonstrating bravery"], 84 ["description", "Awarded to users demonstrating bravery"],
93 ["image", "https://nostr.academy/awards/bravery.png", "1024x1024"], 85 ["image", "https://nostr.academy/awards/bravery.png", "1024x1024"],
94 ["thumb", "https://nostr.academy/awards/bravery_256x256.png", "256x256"], 86 ["thumb", "https://nostr.academy/awards/bravery_256x256.png", "256x256"]
95 ], 87 ],
96 ... 88 ...
97} 89}
@@ -107,7 +99,7 @@ Clients SHOULD attempt to render the most appropriate badge thumbnail according
107 "tags": [ 99 "tags": [
108 ["a", "30009:alice:bravery"], 100 ["a", "30009:alice:bravery"],
109 ["p", "bob", "wss://relay"], 101 ["p", "bob", "wss://relay"],
110 ["p", "charlie", "wss://relay"], 102 ["p", "charlie", "wss://relay"]
111 ], 103 ],
112 ... 104 ...
113} 105}
@@ -125,7 +117,7 @@ Honorable Bob The Brave:
125 ["a", "30009:alice:bravery"], 117 ["a", "30009:alice:bravery"],
126 ["e", "<bravery badge award event id>", "wss://nostr.academy"], 118 ["e", "<bravery badge award event id>", "wss://nostr.academy"],
127 ["a", "30009:alice:honor"], 119 ["a", "30009:alice:honor"],
128 ["e", "<honor badge award event id>", "wss://nostr.academy"], 120 ["e", "<honor badge award event id>", "wss://nostr.academy"]
129 ], 121 ],
130 ... 122 ...
131} 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 4c7a6a5..f32c965 100644
--- a/65.md
+++ b/65.md
@@ -4,73 +4,61 @@ NIP-65
4Relay List Metadata 4Relay List Metadata
5------------------- 5-------------------
6 6
7`draft` `optional` `author:mikedilger` 7`draft` `optional`
8 8
9A special replaceable event meaning "Relay List Metadata" is defined as an event with kind `10002` having a list of `r` tags, one for each relay the author uses to either read or write to. 9Defines a replaceable event using `kind:10002` to advertise preferred relays for discovering a user's content and receiving fresh content from others.
10 10
11The primary purpose of this relay list is to advertise to others, not for configuring one's client. 11The event MUST include a list of `r` tags with relay URIs and a `read` or `write` marker. Relays marked as `read` / `write` are called READ / WRITE relays, respectively. If the marker is omitted, the relay is used for both purposes.
12 12
13The content is not used and SHOULD be an empty string. 13The `.content` is not used.
14 14
15The `r` tags can have a second parameter as either `read` or `write`. If it is omitted, it means the author uses the relay for both purposes. 15```json
16 16{
17Clients SHOULD, as with all replaceable events, use only the most recent kind-10002 event they can find. 17 "kind": 10002,
18 18 "tags": [
19### The meaning of read and write 19 ["r", "wss://alicerelay.example.com"],
20 20 ["r", "wss://brando-relay.com"],
21Write relays are for events that are intended for anybody (e.g. your followers). Read relays are for events that address a particular person. 21 ["r", "wss://expensive-relay.example2.com", "write"],
22 ["r", "wss://nostr-relay.example.com", "read"]
23 ],
24 "content": "",
25 ...other fields
26}
27```
22 28
23Clients SHOULD write feed-related events created by their user to their user's write relays. 29This NIP doesn't fully replace relay lists that are designed to configure a client's usage of relays (such as `kind:3` style relay lists). Clients MAY use other relay lists in situations where a `kind:10002` relay list cannot be found.
24 30
25Clients SHOULD read feed-related events created by another from at least some of that other person's write relays. Explicitly, they SHOULD NOT expect them to be available at their user's read relays. It SHOULD NOT be presumed that the user's read relays coincide with the write relays of the people the user follows. 31## When to Use Read and Write Relays
26 32
27Clients SHOULD read events that tag their user from their user's read relays. 33When seeking events **from** a user, Clients SHOULD use the WRITE relays of the user's `kind:10002`.
28 34
29Clients SHOULD write events that tag a person to at least some of that person's read relays. Explicitly, they SHOULD NOT expect that person will pick them up from their user's write relays. It SHOULD NOT be presumed that the user's write relays coincide with the read relays of the person being tagged. 35When seeking events **about** a user, where the user was tagged, Clients SHOULD use the READ relays of the user's `kind:10002`.
30 36
31Clients SHOULD presume that if their user has a pubkey in their ContactList (kind 3) that it is because they wish to see that author's feed-related events. But clients MAY presume otherwise. 37When broadcasting an event, Clients SHOULD:
32 38
33### Motivation 39- Broadcast the event to the WRITE relays of the author
40- Broadcast the event to all READ relays of each tagged user
34 41
35There is a common nostr use case where users wish to follow the content produced by other users. This is evidenced by the implicit meaning of the Contact List in [NIP-02](02.md) 42## Motivation
36 43
37Because users don't often share the same sets of relays, ad-hoc solutions have arisen to get that content, but these solutions negatively impact scalability and decentralization: 44The old model of using a fixed relay list per user centralizes in large relay operators:
38 45
39 - Most people are sending their posts to the same most popular relays in order to be more widely seen 46 - Most users submit their posts to the same highly popular relays, aiming to achieve greater visibility among a broader audience
40 - Many people are pulling from a large number of relays (including many duplicate events) in order to get more data 47 - Many users are pulling events from a large number of relays in order to get more data at the expense of duplication
41 - Events are being copied between relays, oftentimes to many different relays 48 - Events are being copied between relays, oftentimes to many different relays
49
50This NIP allows Clients to connect directly with the most up-to-date relay set from each individual user, eliminating the need of broadcasting events to popular relays.
42 51
43### Purposes 52## Final Considerations
44
45The purpose of this NIP is to help clients find the events of the people they follow, to help tagged events get to the people tagged, and to help nostr scale better.
46 53
47### Suggestions 541. Clients SHOULD guide users to keep `kind:10002` lists small (2-4 relays).
48 55
49It is suggested that people spread their kind `10002` events to many relays, but write their normal feed-related events to a much smaller number of relays (between 2 to 6 relays). It is suggested that clients offer a way for users to spread their kind `10002` events to many more relays than they normally post to. 562. Clients SHOULD spread an author's `kind:10002` event to as many relays as viable.
50 57
51Authors may post events outside of the feed that they wish their followers to follow by posting them to relays outside of those listed in their "Relay List Metadata". For example, an author may want to reply to someone without all of their followers watching. 583. `kind:10002` events should primarily be used to advertise the user's preferred relays to others. A user's own client may use other heuristics for selecting relays for fetching data.
52 59
53It is suggested that relays allow any user to write their own kind `10002` event (optionally with AUTH to verify it is their own) even if they are not otherwise subscribed to the relay because 604. DMs SHOULD only be broadcasted to the author's WRITE relays and to the receiver's READ relays to keep maximum privacy.
54 61
55 - finding where someone posts is rather important 625. If a relay signals support for this NIP in their [NIP-11](11.md) document that means they're willing to accept kind 10002 events from a broad range of users, not only their paying customers or whitelisted group.
56 - these events do not have content that needs management
57 - relays only need to store one replaceable event per pubkey to offer this service
58 63
59### Why not in kind `0` Metadata 646. Clients SHOULD deduplicate connections by normalizing relay URIs according to [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986#section-6).
60
61Even though this is user related metadata, it is a separate event from kind `0` in order to keep it small (as it should be widely spread) and to not have content that may require moderation by relay operators so that it is more acceptable to relays.
62
63### Example
64
65```json
66{
67 "kind": 10002,
68 "tags": [
69 ["r", "wss://alicerelay.example.com"],
70 ["r", "wss://brando-relay.com"],
71 ["r", "wss://expensive-relay.example2.com", "write"],
72 ["r", "wss://nostr-relay.example.com", "read"],
73 ],
74 "content": "",
75 ...other fields
76```
diff --git a/70.md b/70.md
new file mode 100644
index 0000000..219e6a4
--- /dev/null
+++ b/70.md
@@ -0,0 +1,45 @@
1NIP-70
2======
3
4Protected Events
5----------------
6
7`draft` `optional`
8
9When the `"-"` tag is present, that means the event is "protected".
10
11A protected event is an event that can only be published to relays by its author. This is achieved by relays ensuring that the author is [authenticated](42.md) before publishing their own events or by just rejecting events with `["-"]` outright.
12
13The default behavior of a relay MUST be to reject any event that contains `["-"]`.
14
15Relays that want to accept such events MUST first require that the client perform the [NIP-42](https://github.com/nostr-protocol/nips/blob/master/42.md) `AUTH` flow and then check if the authenticated client has the same pubkey as the event being published and only accept the event in that case.
16
17## The tag
18
19The tag is a simple tag with a single item: `["-"]`. It may be added to any event.
20
21## Example flow
22
23- User `79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798` connects to relay `wss://example.com`:
24
25```jsonc
26/* client: */
27["EVENT",{"id":"cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2","pubkey":"79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798","created_at":1707409439,"kind":1,"tags":[["-"]],"content":"hello members of the secret group","sig":"fa163f5cfb75d77d9b6269011872ee22b34fb48d23251e9879bb1e4ccbdd8aaaf4b6dc5f5084a65ef42c52fbcde8f3178bac3ba207de827ec513a6aa39fa684c"}]
28/* relay: */
29["AUTH", "<challenge>"]
30["OK", "cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2", false, "auth-required: this event may only be published by its author"]
31/* client: */
32["AUTH", {}]
33["EVENT",{"id":"cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2","pubkey":"79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798","created_at":1707409439,"kind":1,"tags":[["-"]],"content":"hello members of the secret group","sig":"fa163f5cfb75d77d9b6269011872ee22b34fb48d23251e9879bb1e4ccbdd8aaaf4b6dc5f5084a65ef42c52fbcde8f3178bac3ba207de827ec513a6aa39fa684c"}]
34["OK", "cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2", true, ""]
35```
36
37## Why
38
39There are multiple circumstances in which it would be beneficial to prevent the unlimited spreading of an event through all relays imaginable and restrict some to only a certain demographic or to a semi-closed community relay. Even when the information is public it may make sense to keep it compartimentalized across different relays.
40
41It's also possible to create closed access feeds with this when the publisher has some relationship with the relay and trusts the relay to not release their published events to anyone.
42
43Even though it's ultimately impossible to restrict the spread of information on the internet (for example, one of the members of the closed group may want to take an event intended to be restricted and republish it to other relays), most relays would be happy to not facilitate the acts of these so-called "pirates", in respect to the original decision of the author and therefore gladly reject these republish acts if given the means to.
44
45This NIP gives these authors and relays the means to clearly signal when a given event is not intended to be republished by third parties.
diff --git a/71.md b/71.md
new file mode 100644
index 0000000..a811434
--- /dev/null
+++ b/71.md
@@ -0,0 +1,118 @@
1NIP-71
2======
3
4Video Events
5---------------
6
7`draft` `optional`
8
9This specification defines video events representing a dedicated post of externally hosted content. These video events are _parameterized replaceable_ and deletable per [NIP-09](09.md).
10
11Unlike a `kind 1` event with a video attached, Video Events are meant to contain all additional metadata concerning the subject media and to be surfaced in video-specific clients rather than general micro-blogging clients. The thought is for events of this kind to be referenced in a Netflix, YouTube, or TikTok like nostr client where the video itself is at the center of the experience.
12
13## Video Events
14
15There are two types of video events represented by different kinds: horizontal and vertical video events. This is meant to allow clients to cater to each as the viewing experience for horizontal (landscape) videos is often different than that of vertical (portrait) videos (Stories, Reels, Shorts, etc).
16
17#### Format
18
19The format uses a parameterized replaceable event kind `34235` for horizontal videos and `34236` for vertical videos.
20
21The `.content` of these events is a summary or description on the video content.
22
23The list of tags are as follows:
24* `d` (required) universally unique identifier (UUID). Generated by the client creating the video event.
25* `url` (required) the url to the video file
26* `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.
27* `title` (required) title of the video
28* `"published_at"`, for the timestamp in unix seconds (stringified) of the first time the video was published
29* `x` containing the SHA-256 hexencoded string of the file.
30* `size` (optional) size of file in bytes
31* `dim` (optional) size of file in pixels in the form `<width>x<height>`
32* `duration` (optional) video duration in seconds
33* `magnet` (optional) URI to magnet file
34* `i` (optional) torrent infohash
35* `text-track` (optional, repeated) link to WebVTT file for video, type of supplementary information (captions/subtitles/chapters/metadata), optional language code
36* `thumb` (optional) url of thumbnail with same aspect ratio
37* `image` (optional) url of preview image with same dimensions
38* `content-warning` (optional) warning about content of NSFW video
39* `alt` (optional) description for accessibility
40* `segment` (optional, repeated) start timestamp in format `HH:MM:SS.sss`, end timestamp in format `HH:MM:SS.sss`, chapter/segment title, chapter thumbnail-url
41* `t` (optional, repeated) hashtag to categorize video
42* `p` (optional, repeated) 32-bytes hex pubkey of a participant in the video, optional recommended relay URL
43* `r` (optional, repeated) references / links to web pages
44
45```json
46{
47 "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>,
48 "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
49 "created_at": <Unix timestamp in seconds>,
50 "kind": 34235 | 34236,
51 "content": "<summary / description of video>",
52 "tags": [
53 ["d", "<UUID>"],
54
55 ["title", "<title of video>"],
56 ["thumb", "<thumbnail image for video>"],
57 ["published_at", "<unix timestamp>"],
58 ["alt", <description>],
59
60 // Video Data
61 ["url",<string with URI of file>],
62 ["m", <MIME type>],
63 ["x",<Hash SHA-256>],
64 ["size", <size of file in bytes>],
65 ["duration", <duration of video in seconds>],
66 ["dim", <size of file in pixels>],
67 ["magnet",<magnet URI> ],
68 ["i",<torrent infohash>],
69 ["text-track", "<encoded `kind 6000` event>", "<recommended relay urls>"],
70 ["content-warning", "<reason>"],
71 ["segment", <start>, <end>, "<title>", "<thumbnail URL>"],
72
73 // Participants
74 ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"],
75 ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"],
76
77 // Hashtags
78 ["t", "<tag>"],
79 ["t", "<tag>"],
80
81 // Reference links
82 ["r", "<url>"],
83 ["r", "<url>"]
84 ]
85}
86```
87
88## Video View
89
90A video event view is a response to a video event to track a user's view or progress viewing the video.
91
92### Format
93
94The format uses a parameterized replaceable event kind `34237`.
95
96The `.content` of these events is optional and could be a free-form note that acts like a bookmark for the user.
97
98The list of tags are as follows:
99* `a` (required) reference tag to kind `34235` or `34236` video event being viewed
100* `d` (required) same as `a` reference tag value
101* `viewed` (optional, repeated) timestamp of the user's start time in seconds, timestamp of the user's end time in seconds
102
103
104```json
105{
106 "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>,
107 "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
108 "created_at": <Unix timestamp in seconds>,
109 "kind": 34237,
110 "content": "<note>",
111 "tags": [
112 ["a", "<34235 | 34236>:<video event author pubkey>:<d-identifier of video event>", "<optional relay url>"],
113 ["e", "<event-id", "<relay-url>"]
114 ["d", "<34235 | 34236>:<video event author pubkey>:<d-identifier of video event>"],
115 ["viewed", <start>, <end>],
116 ]
117}
118```
diff --git a/72.md b/72.md
new file mode 100644
index 0000000..5a8be0a
--- /dev/null
+++ b/72.md
@@ -0,0 +1,101 @@
1NIP-72
2======
3
4Moderated Communities (Reddit Style)
5------------------------------------
6
7`draft` `optional`
8
9The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `kind:34550` to define the community and the current list of moderators/administrators. Users that want to post into the community, simply tag any Nostr event with the community's `a` tag. Moderators issue an approval event `kind:4550` that links the community with the new post.
10
11# Community Definition
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.
14
15```jsonc
16{
17 "created_at": <Unix timestamp in seconds>,
18 "kind": 34550,
19 "tags": [
20 ["d", "<community-d-identifier>"],
21 ["description", "<Community description>"],
22 ["image", "<Community image url>", "<Width>x<Height>"],
23
24 //.. other tags relevant to defining the community
25
26 // moderators
27 ["p", "<32-bytes hex of a pubkey1>", "<optional recommended relay URL>", "moderator"],
28 ["p", "<32-bytes hex of a pubkey2>", "<optional recommended relay URL>", "moderator"],
29 ["p", "<32-bytes hex of a pubkey3>", "<optional recommended relay URL>", "moderator"],
30
31 // relays used by the community (w/optional marker)
32 ["relay", "<relay hosting author kind 0>", "author"],
33 ["relay", "<relay where to send and receive requests>", "requests"],
34 ["relay", "<relay where to send and receive approvals>", "approvals"],
35 ["relay", "<relay where to post requests to and fetch approvals from>"]
36 ],
37 ...
38}
39```
40
41# New Post Request
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.
44
45```jsonc
46{
47 "kind": 1,
48 "tags": [
49 ["a", "34550:<community event author pubkey>:<community-d-identifier>", "<optional-relay-url>"],
50 ],
51 "content": "hello world",
52 // ...
53}
54```
55
56Community management clients MAY filter all mentions to a given `kind:34550` event and request moderators to approve each submission. Moderators MAY delete his/her approval of a post at any time using event deletions (See [NIP-09](09.md)).
57
58# Post Approval by moderators
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.
61
62```jsonc
63{
64 "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>",
65 "kind": 4550,
66 "tags": [
67 ["a", "34550:<event-author-pubkey>:<community-d-identifier>", "<optional-relay-url>"],
68 ["e", "<post-id>", "<optional-relay-url>"],
69 ["p", "<port-author-pubkey>", "<optional-relay-url>"],
70 ["k", "<post-request-kind>"]
71 ],
72 "content": "<the full approved event, JSON-encoded>",
73 // ...
74}
75```
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.
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 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
81Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be included in all `34550:*` `a` tags.
82
83# Displaying
84
85Community clients SHOULD display posts that have been approved by at least 1 moderator or by the community owner.
86
87The following filter displays the approved posts.
88
89```json
90[
91 "REQ",
92 "_",
93 {
94 "authors": ["<owner-pubkey>", "<moderator1-pubkey>", "<moderator2-pubkey>", "<moderator3-pubkey>", ...],
95 "kinds": [4550],
96 "#a": ["34550:<Community event author pubkey>:<d-identifier of the community>"],
97 }
98]
99```
100
101Clients MAY hide approvals by blocked moderators at the user's request.
diff --git a/75.md b/75.md
new file mode 100644
index 0000000..c16436a
--- /dev/null
+++ b/75.md
@@ -0,0 +1,85 @@
1NIP-75
2======
3
4Zap Goals
5---------
6
7`draft` `optional`
8
9This NIP defines an event for creating fundraising goals. Users can contribute funds towards the goal by zapping the goal event.
10
11## Nostr Event
12
13A `kind:9041` event is used.
14
15The `.content` contains a human-readable description of the goal.
16
17The following tags are defined as REQUIRED.
18
19- `amount` - target amount in milisats.
20- `relays` - a list of relays the zaps to this goal will be sent to and tallied from.
21
22Example event:
23
24```json
25{
26 "kind": 9041,
27 "tags": [
28 ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", ...],
29 ["amount", "210000"],
30 ],
31 "content": "Nostrasia travel expenses",
32 ...
33```
34
35The following tags are OPTIONAL.
36
37- `closed_at` - timestamp for determining which zaps are included in the tally. Zap receipts published after the `closed_at` timestamp SHOULD NOT count towards the goal progress.
38- `image` - an image for the goal
39- `summary` - a brief description
40
41```json
42{
43 "kind": 9041,
44 "tags": [
45 ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", ...],
46 ["amount", "210000"],
47 ["closed_at", "<unix timestamp in seconds>"],
48 ["image", "<image URL>"],
49 ["summary", "<description of the goal>"],
50 ],
51 "content": "Nostrasia travel expenses",
52 ...
53}
54```
55
56The goal MAY include an `r` or `a` tag linking to a URL or parameterized replaceable event.
57
58The goal MAY include multiple beneficiary pubkeys by specifying [`zap` tags](57.md#appendix-g-zap-tag-on-other-events).
59
60Parameterized replaceable events can link to a goal by using a `goal` tag specifying the event id and an optional relay hint.
61
62```json
63{
64 ...
65 "kind": 3xxxx,
66 "tags": [
67 ...
68 ["goal", "<event id>", "<Relay URL (optional)>"],
69 ],
70 ...
71}
72```
73
74## Client behavior
75
76Clients MAY display funding goals on user profiles.
77
78When zapping a goal event, clients MUST include the relays in the `relays` tag of the goal event in the zap request `relays` tag.
79
80When zapping a parameterized replaceable event with a `goal` tag, clients SHOULD tag the goal event id in the `e` tag of the zap request.
81
82## Use cases
83
84- Fundraising clients
85- Adding funding goals to events such as long form posts, badges or live streams
diff --git a/78.md b/78.md
index 10ff535..0f2fada 100644
--- a/78.md
+++ b/78.md
@@ -4,7 +4,7 @@ NIP-78
4Arbitrary custom app data 4Arbitrary custom app data
5------------------------- 5-------------------------
6 6
7`draft` `optional` `author:sandwich` `author:fiatjaf` 7`draft` `optional`
8 8
9The goal of this NIP is to enable [remoteStorage](https://remotestorage.io/)-like capabilities for custom applications that do not care about interoperability. 9The goal of this NIP is to enable [remoteStorage](https://remotestorage.io/)-like capabilities for custom applications that do not care about interoperability.
10 10
diff --git a/84.md b/84.md
new file mode 100644
index 0000000..d5f54d4
--- /dev/null
+++ b/84.md
@@ -0,0 +1,42 @@
1NIP-84
2======
3
4Highlights
5----------
6
7`draft` `optional`
8
9This NIP defines `kind:9802`, a "highlight" event, to signal content a user finds valuable.
10
11## Format
12The `.content` of these events is the highlighted portion of the text.
13
14`.content` might be empty for highlights of non-text based media (e.g. NIP-94 audio/video).
15
16### References
17Events SHOULD tag the source of the highlight, whether nostr-native or not.
18`a` or `e` tags should be used for nostr events and `r` tags for URLs.
19
20When tagging a URL, clients generating these events SHOULD do a best effort of cleaning the URL from trackers
21or obvious non-useful information from the query string.
22
23### Attribution
24Clients MAY include one or more `p` tags, tagging the original authors of the material being highlighted; this is particularly
25useful when highlighting non-nostr content for which the client might be able to get a nostr pubkey somehow
26(e.g. prompting the user or reading a `<meta name="nostr:nprofile1..." />` tag on the document). A role MAY be included as the
27last value of the tag.
28
29```json
30{
31 "tags": [
32 ["p", "<pubkey-hex>", "<relay-url>", "author"],
33 ["p", "<pubkey-hex>", "<relay-url>", "author"],
34 ["p", "<pubkey-hex>", "<relay-url>", "editor"]
35 ],
36 ...
37}
38```
39
40### Context
41Clients MAY include a `context` tag, useful when the highlight is a subset of a paragraph and displaying the
42surrounding content might be beneficial to give context to the highlight.
diff --git a/89.md b/89.md
new file mode 100644
index 0000000..54aa30b
--- /dev/null
+++ b/89.md
@@ -0,0 +1,131 @@
1NIP-89
2======
3
4Recommended Application Handlers
5--------------------------------
6
7`draft` `optional`
8
9This NIP describes `kind:31989` and `kind:31990`: a way to discover applications that can handle unknown event-kinds.
10
11## Rationale
12
13Nostr's discoverability and transparent event interaction is one of its most interesting/novel mechanics.
14This NIP provides a simple way for clients to discover applications that handle events of a specific kind to ensure smooth cross-client and cross-kind interactions.
15
16### Parties involved
17
18There are three actors to this workflow:
19
20* application that handles a specific event kind (note that an application doesn't necessarily need to be a distinct entity and it could just be the same pubkey as user A)
21 * Publishes `kind:31990`, detailing how apps should redirect to it
22* user A, who recommends an app that handles a specific event kind
23 * Publishes `kind:31989`
24* user B, who seeks a recommendation for an app that handles a specific event kind
25 * Queries for `kind:31989` and, based on results, queries for `kind:31990`
26
27## Events
28
29### Recommendation event
30```json
31{
32 "kind": 31989,
33 "pubkey": <recommender-user-pubkey>,
34 "tags": [
35 ["d", <supported-event-kind>],
36 ["a", "31990:app1-pubkey:<d-identifier>", "wss://relay1", "ios"],
37 ["a", "31990:app2-pubkey:<d-identifier>", "wss://relay2", "web"]
38 ]
39}
40```
41
42The `d` tag in `kind:31989` is the supported event kind this event is recommending.
43
44Multiple `a` tags can appear on the same `kind:31989`.
45
46The second value of the tag SHOULD be a relay hint.
47The third value of the tag SHOULD be the platform where this recommendation might apply.
48
49## Handler information
50```json
51{
52 "kind": 31990,
53 "pubkey": "<application-pubkey>",
54 "content": "<optional-kind:0-style-metadata>",
55 "tags": [
56 ["d", <random-id>],
57 ["k", <supported-event-kind>],
58 ["web", "https://..../a/<bech32>", "nevent"],
59 ["web", "https://..../p/<bech32>", "nprofile"],
60 ["web", "https://..../e/<bech32>"],
61 ["ios", ".../<bech32>"]
62 ]
63}
64```
65
66* `content` is an optional `metadata`-like stringified JSON object, as described in NIP-01. This content is useful when the pubkey creating the `kind:31990` is not an application. If `content` is empty, the `kind:0` of the pubkey should be used to display application information (e.g. name, picture, web, LUD16, etc.)
67* `k` tags' value is the event kind that is supported by this `kind:31990`.
68Using a `k` tag(s) (instead of having the kind of the `d` tag) provides:
69 * Multiple `k` tags can exist in the same event if the application supports more than one event kind and their handler URLs are the same.
70 * The same pubkey can have multiple events with different apps that handle the same event kind.
71* `bech32` in a URL MUST be replaced by clients with the NIP-19-encoded entity that should be loaded by the application.
72
73Multiple tags might be registered by the app, following NIP-19 nomenclature as the second value of the array.
74
75A tag without a second value in the array SHOULD be considered a generic handler for any NIP-19 entity that is not handled by a different tag.
76
77# Client tag
78When publishing events, clients MAY include a `client` tag. Identifying the client that published the note. This tag is a tuple of `name`, `address` identifying a handler event and, a relay `hint` for finding the handler event. This has privacy implications for users, so clients SHOULD allow users to opt-out of using this tag.
79
80```json
81{
82 "kind": 1,
83 "tags": [
84 ["client", "My Client", "31990:app1-pubkey:<d-identifier>", "wss://relay1"]
85 ]
86 ...
87}
88```
89
90## User flow
91A user A who uses a non-`kind:1`-centric nostr app could choose to announce/recommend a certain kind-handler application.
92
93When user B sees an unknown event kind, e.g. in a social-media centric nostr client, the client would allow user B to interact with the unknown-kind event (e.g. tapping on it).
94
95The client MIGHT query for the user's and the user's follows handler.
96
97## Example
98
99### User A recommends a `kind:31337`-handler
100User A might be a user of Zapstr, a `kind:31337`-centric client (tracks). Using Zapstr, user A publishes an event recommending Zapstr as a `kind:31337`-handler.
101
102```json
103{
104 "kind": 31989,
105 "tags": [
106 ["d", "31337"],
107 ["a", "31990:1743058db7078661b94aaf4286429d97ee5257d14a86d6bfa54cb0482b876fb0:abcd", <relay-url>, "web"]
108 ],
109 ...
110}
111```
112
113### User B interacts with a `kind:31337`-handler
114User B might see in their timeline an event referring to a `kind:31337` event (e.g. a `kind:1` tagging a `kind:31337`).
115
116User B's client, not knowing how to handle a `kind:31337` might display the event using its `alt` tag (as described in NIP-31). When the user clicks on the event, the application queries for a handler for this `kind`:
117
118```json
119["REQ", <id>, { "kinds": [31989], "#d": ["31337"], "authors": [<user>, <users-contact-list>] }]
120```
121
122User B, who follows User A, sees that `kind:31989` event and fetches the `a`-tagged event for the app and handler information.
123
124User B's client sees the application's `kind:31990` which includes the information to redirect the user to the relevant URL with the desired entity replaced in the URL.
125
126### Alternative query bypassing `kind:31989`
127Alternatively, users might choose to query directly for `kind:31990` for an event kind. Clients SHOULD be careful doing this and use spam-prevention mechanisms or querying high-quality restricted relays to avoid directing users to malicious handlers.
128
129```json
130["REQ", <id>, { "kinds": [31990], "#k": [<desired-event-kind>], "authors": [...] }]
131```
diff --git a/90.md b/90.md
new file mode 100644
index 0000000..5a15ebb
--- /dev/null
+++ b/90.md
@@ -0,0 +1,230 @@
1NIP-90
2======
3
4Data Vending Machine
5--------------------
6
7`draft` `optional`
8
9This NIP defines the interaction between customers and Service Providers for performing on-demand computation.
10
11Money in, data out.
12
13## Kinds
14This NIP reserves the range `5000-7000` for data vending machine use.
15
16| Kind | Description |
17| ---- | ----------- |
18| 5000-5999 | Job request kinds |
19| 6000-6999 | Job result |
20| 7000 | Job feedback |
21
22Job results always use a kind number that is `1000` higher than the job request kind. (e.g. request: `kind:5001` gets a result: `kind:6001`).
23
24Job request types are defined [separately](https://github.com/nostr-protocol/data-vending-machines/tree/master/kinds).
25
26## Rationale
27Nostr can act as a marketplace for data processing, where users request jobs to be processed in certain ways (e.g., "speech-to-text", "summarization", etc.), but they don't necessarily care about "who" processes the data.
28
29This NIP is not to be confused with a 1:1 marketplace; instead, it describes a flow where a user announces a desired output, willingness to pay, and service providers compete to fulfill the job requirement in the best way possible.
30
31### Actors
32There are two actors in the workflow described in this NIP:
33* Customers (npubs who request a job)
34* Service providers (npubs who fulfill jobs)
35
36## Job request (`kind:5000-5999`)
37A request to process data, published by a customer. This event signals that a customer is interested in receiving the result of some kind of compute.
38
39```json
40{
41 "kind": 5xxx, // kind in 5000-5999 range
42 "content": "",
43 "tags": [
44 [ "i", "<data>", "<input-type>", "<relay>", "<marker>" ],
45 [ "output", "<mime-type>" ],
46 [ "relays", "wss://..." ],
47 [ "bid", "<msat-amount>" ],
48 [ "t", "bitcoin" ]
49 ]
50}
51```
52
53All tags are optional.
54
55* `i` tag: Input data for the job (zero or more inputs)
56 * `<data>`: The argument for the input
57 * `<input-type>`: The way this argument should be interpreted. MUST be one of:
58 * `url`: A URL to be fetched of the data that should be processed.
59 * `event`: A Nostr event ID.
60 * `job`: The output of a previous job with the specified event ID. The dermination of which output to build upon is up to the service provider to decide (e.g. waiting for a signaling from the customer, waiting for a payment, etc.)
61 * `text`: `<data>` is the value of the input, no resolution is needed
62 * `<relay>`: If `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string
63 * `<marker>`: An optional field indicating how this input should be used within the context of the job
64* `output`: Expected output format. Different job request `kind` defines this more precisely.
65* `param`: Optional parameters for the job as key (first argument)/value (second argument). Different job request `kind` defines this more precisely. (e.g. `[ "param", "lang", "es" ]`)
66* `bid`: Customer MAY specify a maximum amount (in millisats) they are willing to pay
67* `relays`: List of relays where Service Providers SHOULD publish responses to
68* `p`: Service Providers the customer is interested in. Other SPs MIGHT still choose to process the job
69
70## Encrypted Params
71
72If the user wants to keep the input parameters a secret, they can encrypt the `i` and `param` tags with the service provider's 'p' tag and add it to the content field. Add a tag `encrypted` as tags. Encryption for private tags will use [NIP-04 - Encrypted Direct Message encryption](https://github.com/nostr-protocol/nips/blob/master/04.md), using the user's private and service provider's public key for the shared secret
73
74```json
75[
76 ["i", "what is the capital of France? ", "text"],
77 ["param", "model", "LLaMA-2"],
78 ["param", "max_tokens", "512"],
79 ["param", "temperature", "0.5"],
80 ["param", "top-k", "50"],
81 ["param", "top-p", "0.7"],
82 ["param", "frequency_penalty", "1"]
83]
84
85```
86
87This param data will be encrypted and added to the `content` field and `p` tag should be present
88
89```json
90{
91 "content": "BE2Y4xvS6HIY7TozIgbEl3sAHkdZoXyLRRkZv4fLPh3R7LtviLKAJM5qpkC7D6VtMbgIt4iNcMpLtpo...",
92 "tags": [
93 ["p", "04f74530a6ede6b24731b976b8e78fb449ea61f40ff10e3d869a3030c4edc91f"],
94 ["encrypted"]
95 ],
96 ...
97}
98```
99
100
101## Job result (`kind:6000-6999`)
102
103Service providers publish job results, providing the output of the job result. They should tag the original job request event id as well as the customer's pubkey.
104
105```json
106{
107 "pubkey": "<service-provider pubkey>",
108 "content": "<payload>",
109 "kind": 6xxx,
110 "tags": [
111 ["request", "<job-request>"],
112 ["e", "<job-request-id>", "<relay-hint>"],
113 ["i", "<input-data>"],
114 ["p", "<customer's-pubkey>"],
115 ["amount", "requested-payment-amount", "<optional-bolt11>"]
116 ],
117 ...
118}
119```
120
121* `request`: The job request event stringified-JSON.
122* `amount`: millisats that the Service Provider is requesting to be paid. An optional third value can be a bolt11 invoice.
123* `i`: The original input(s) specified in the request.
124
125## Encrypted Output
126
127If the request has encrypted params, then output should be encrypted and placed in `content` field. If the output is encrypted, then avoid including `i` tag with input-data as clear text.
128Add a tag encrypted to mark the output content as `encrypted`
129
130```json
131{
132 "pubkey": "<service-provider pubkey>",
133 "content": "<encrypted payload>",
134 "kind": 6xxx,
135 "tags": [
136 ["request", "<job-request>"],
137 ["e", "<job-request-id>", "<relay-hint>"],
138 ["p", "<customer's-pubkey>"],
139 ["amount", "requested-payment-amount", "<optional-bolt11>"],
140 ["encrypted"]
141 ],
142 ...
143}
144```
145
146## Job feedback
147
148Service providers can give feedback about a job back to the customer.
149
150```json
151{
152 "kind": 7000,
153 "content": "<empty-or-payload>",
154 "tags": [
155 ["status", "<status>", "<extra-info>"],
156 ["amount", "requested-payment-amount", "<bolt11>"],
157 ["e", "<job-request-id>", "<relay-hint>"],
158 ["p", "<customer's-pubkey>"],
159 ],
160 ...
161}
162```
163
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-kind6000-6999) section.
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
168* NOTE: If the input params requires input to be encrypted, then `content` field will have encrypted payload with `p` tag as key.
169
170### Job feedback status
171
172| status | description |
173| -------- | ------------- |
174| `payment-required` | Service Provider requires payment before continuing. |
175| `processing` | Service Provider is processing the job. |
176| `error` | Service Provider was unable to process 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. |
179
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
182
183# Protocol Flow
184
185* Customer publishes a job request (e.g. `kind:5000` speech-to-text).
186* Service Providers MAY submit `kind:7000` job-feedback events (e.g. `payment-required`, `processing`, `error`, etc.).
187* Upon completion, the service provider publishes the result of the job with a `kind:6000` job-result event.
188* At any point, if there is an `amount` pending to be paid as instructed by the service provider, the user can pay the included `bolt11` or zap the job result event the service provider has sent to the user
189
190Job feedback (`kind:7000`) and Job Results (`kind:6000-6999`) events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers MUST use the `payment-required` feedback event to signal that a payment is required and no further actions will be performed until the payment is sent.
191
192Customers can always either pay the included `bolt11` invoice or zap the event requesting the payment and service providers should monitor for both if they choose to include a bolt11 invoice.
193
194## Notes about the protocol flow
195The flow is deliberately ambiguous, allowing vast flexibility for the interaction between customers and service providers so that service providers can model their behavior based on their own decisions/perceptions of risk.
196
197Some service providers might choose to submit a `payment-required` as the first reaction before sending a `processing` or before delivering results, some might choose to serve partial results for the job (e.g. a sample), send a `payment-required` to deliver the rest of the results, and some service providers might choose to assess likelihood of payment based on an npub's past behavior and thus serve the job results before requesting payment for the best possible UX.
198
199It's not up to this NIP to define how individual vending machines should choose to run their business.
200
201# Cancellation
202A job request might be canceled by publishing a `kind:5` delete request event tagging the job request event.
203
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.
206
207Service Providers MAY begin processing a subsequent job the moment they see the prior job's result, but they will likely wait for a zap to be published first. This introduces a risk that Service Provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to Service Providers to mitigate or to decide whether the service provider of job #1 tends to have good-enough results so as to not wait for an explicit zap to assume the job was accepted.
208
209This gives a higher level of flexibility to service providers (which sophisticated service providers would take anyway).
210
211# Appendix 2: Service provider discoverability
212Service Providers MAY use NIP-89 announcements to advertise their support for job kinds:
213
214```js
215{
216 "kind": 31990,
217 "pubkey": "<pubkey>",
218 "content": "{
219 \"name\": \"Translating DVM\",
220 \"about\": \"I'm a DVM specialized in translating Bitcoin content.\"
221 }",
222 "tags": [
223 ["k", "5005"], // e.g. translation
224 ["t", "bitcoin"] // e.g. optionally advertises it specializes in bitcoin audio transcription that won't confuse "Drivechains" with "Ridechains"
225 ],
226 ...
227}
228```
229
230Customers can use NIP-89 to see what service providers their follows use.
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 24dd346..e35dfa1 100644
--- a/94.md
+++ b/94.md
@@ -4,43 +4,49 @@ NIP-94
4File Metadata 4File Metadata
5------------- 5-------------
6 6
7`draft` `optional` `author:frbitten` `author:kieran` `author:lovvtide` `author:fiatjaf` `author:staab` 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
13This NIP specifies the use of the `1063` event type, having in `content` a description of the file content, and a list of tags described below: 13This NIP specifies the use of the `1063` event type, having in `content` a description of the file content, and a list of tags described below:
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 format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) 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
22* `i` (optional) torrent infohash 22* `i` (optional) torrent infohash
23* `blurhash`(optional) the [blurhash](https://github.com/woltapp/blurhash) to show while the file is being loaded by the client 23* `blurhash`(optional) the [blurhash](https://github.com/woltapp/blurhash) to show while the file is being loaded by the client
24* `thumb` (optional) url of thumbnail with same aspect ratio
25* `image` (optional) url of preview image with same dimensions
26* `summary` (optional) text excerpt
27* `alt` (optional) description for accessibility
28* `fallback` (optional) zero or more fallback file sources in case `url` fails
24 29
25```json 30```json
26{ 31{
27 "id": <32-bytes lowercase hex-encoded sha256 of the the serialized event data>,
28 "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
29 "created_at": <unix timestamp in seconds>,
30 "kind": 1063, 32 "kind": 1063,
31 "tags": [ 33 "tags": [
32 ["url",<string with URI of file>], 34 ["url",<string with URI of file>],
33 ["aes-256-gcm",<key>, <iv>],
34 ["m", <MIME type>], 35 ["m", <MIME type>],
35 ["x",<Hash SHA-256>], 36 ["x",<Hash SHA-256>],
37 ["ox",<Hash SHA-256>],
36 ["size", <size of file in bytes>], 38 ["size", <size of file in bytes>],
37 ["dim", <size of file in pixels>], 39 ["dim", <size of file in pixels>],
38 ["magnet",<magnet URI> ], 40 ["magnet",<magnet URI> ],
39 ["i",<torrent infohash>], 41 ["i",<torrent infohash>],
40 ["blurhash", <value>] 42 ["blurhash", <value>],
43 ["thumb", <string with thumbnail URI>],
44 ["image", <string with preview URI>],
45 ["summary", <excerpt>],
46 ["alt", <description>]
41 ], 47 ],
42 "content": <description>, 48 "content": "<caption>",
43 "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> 49 ...
44} 50}
45``` 51```
46 52
diff --git a/96.md b/96.md
new file mode 100644
index 0000000..2f25351
--- /dev/null
+++ b/96.md
@@ -0,0 +1,335 @@
1# NIP-96
2
3## HTTP File Storage Integration
4
5`draft` `optional`
6
7## Introduction
8
9This NIP defines a REST API for HTTP file storage servers intended to be used in conjunction with the nostr network.
10The API will enable nostr users to upload files and later reference them by url on nostr notes.
11
12The spec DOES NOT use regular nostr events through websockets for
13storing, requesting nor retrieving data because, for simplicity, the server
14will not have to learn anything about nostr relays.
15
16## Server Adaptation
17
18File 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`:
19
20```js
21{
22 // Required
23 // File upload and deletion are served from this url
24 // Also downloads if "download_url" field is absent or empty string
25 "api_url": "https://your-file-server.example/custom-api-path",
26 // Optional
27 // If absent, downloads are served from the api_url
28 "download_url": "https://a-cdn.example/a-path",
29 // Optional
30 // Note: This field is not meant to be set by HTTP Servers.
31 // Use this if you are a nostr relay using your /.well-known/nostr/nip96.json
32 // just to redirect to someone else's http file storage server's /.well-known/nostr/nip96.json
33 // In this case, "api_url" field must be an empty string
34 "delegated_to_url": "https://your-file-server.example",
35 // Optional
36 "supported_nips": [60],
37 // Optional
38 "tos_url": "https://your-file-server.example/terms-of-service",
39 // Optional
40 "content_types": ["image/jpeg", "video/webm", "audio/*"],
41 // Optional
42 "plans": {
43 // "free" is the only standardized plan key and
44 // clients may use its presence to learn if server offers free storage
45 "free": {
46 "name": "Free Tier",
47 // Default is true
48 // All plans MUST support NIP-98 uploads
49 // but some plans may also allow uploads without it
50 "is_nip98_required": true,
51 "url": "https://...", // plan's landing page if there is one
52 "max_byte_size": 10485760,
53 // Range in days / 0 for no expiration
54 // [7, 0] means it may vary from 7 days to unlimited persistence,
55 // [0, 0] means it has no expiration
56 // early expiration may be due to low traffic or any other factor
57 "file_expiration": [14, 90],
58 "media_transformations": {
59 "image": [
60 'resizing'
61 ]
62 }
63 }
64 }
65}
66```
67
68### Relay Hints
69
70Note: This section is not meant to be used by HTTP Servers.
71
72A nostr relay MAY redirect to someone else's HTTP file storage server by
73adding a `/.well-known/nostr/nip96.json` with "delegated_to_url" field
74pointing to the url where the server hosts its own
75`/.well-known/nostr/nip96.json`. In this case, the "api_url" field must
76be an empty string and all other fields must be absent.
77
78If the nostr relay is also an HTTP file storage server,
79it must use the "api_url" field instead.
80
81### List of Supporting File Storage Servers
82
83See https://github.com/aljazceru/awesome-nostr#nip-96-file-storage-servers.
84
85## Auth
86
87When indicated, `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).
88
89## Upload
90
91`POST $api_url` as `multipart/form-data`.
92
93**AUTH required**
94
95List of form fields:
96
97- `file`: **REQUIRED** the file to upload
98- `caption`: **RECOMMENDED** loose description;
99- `expiration`: UNIX timestamp in seconds. Empty string if file should be stored forever. The server isn't required to honor this.
100- `size`: File byte size. This is just a value the server can use to reject early if the file size exceeds the server limits.
101- `alt`: **RECOMMENDED** strict description text for visibility-impaired users.
102- `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.
103- `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.
104- `no_transform`: "true" asks server not to transform the file and serve the uploaded file as is, may be rejected.
105
106Others custom form data fields may be used depending on specific `server` support.
107The `server` isn't required to store any metadata sent by `clients`.
108
109The `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.
110The hash is enough to uniquely identify a file, that's why it will be used on the `download` and `delete` routes.
111
112The `server` MUST link the user's `pubkey` string as the owner of the file so to later allow them to delete the file.
113
114`no_transform` can be used to replicate a file to multiple servers for redundancy, clients can use the [server list](#selecting-a-server) to find alternative servers which might contain the same file. When uploading a file and requesting `no_transform` clients should check that the hash matches in the response in order to detect if the file was modified.
115
116### Response codes
117
118- `200 OK`: File upload exists, but is successful (Existing hash)
119- `201 Created`: File upload successful (New hash)
120- `202 Accepted`: File upload is awaiting processing, see [Delayed Processing](#delayed-processing) section
121- `413 Payload Too Large`: File size exceeds limit
122- `400 Bad Request`: Form data is invalid or not supported.
123- `403 Forbidden`: User is not allowed to upload or the uploaded file hash didnt match the hash included in the `Authorization` header `payload` tag.
124- `402 Payment Required`: Payment is required by the server, **this flow is undefined**.
125
126The upload response is a json object as follows:
127
128```js
129{
130 // "success" if successful or "error" if not
131 status: "success",
132 // Free text success, failure or info message
133 message: "Upload successful.",
134 // Optional. See "Delayed Processing" section
135 processing_url: "...",
136 // This uses the NIP-94 event format but DO NOT need
137 // to fill some fields like "id", "pubkey", "created_at" and "sig"
138 //
139 // This holds the download url ("url"),
140 // the ORIGINAL file hash before server transformations ("ox")
141 // and, optionally, all file metadata the server wants to make available
142 //
143 // nip94_event field is absent if unsuccessful upload
144 nip94_event: {
145 // Required tags: "url" and "ox"
146 tags: [
147 // Can be same from /.well-known/nostr/nip96.json's "download_url" field
148 // (or "api_url" field if "download_url" is absent or empty) with appended
149 // original file hash.
150 //
151 // Note we appended .png file extension to the `ox` value
152 // (it is optional but extremely recommended to add the extension as it will help nostr clients
153 // with detecting the file type by using regular expression)
154 //
155 // Could also be any url to download the file
156 // (using or not using the /.well-known/nostr/nip96.json's "download_url" prefix),
157 // for load balancing purposes for example.
158 ["url", "https://your-file-server.example/custom-api-path/719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b.png"],
159 // SHA-256 hash of the ORIGINAL file, before transformations.
160 // The server MUST store it even though it represents the ORIGINAL file because
161 // users may try to download/delete the transformed file using this value
162 ["ox", "719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b"],
163 // Optional. SHA-256 hash of the saved file after any server transformations.
164 // The server can but does not need to store this value.
165 ["x", "543244319525d9d08dd69cb716a18158a249b7b3b3ec4bbde5435543acb34443"],
166 // Optional. Recommended for helping clients to easily know file type before downloading it.
167 ["m", "image/png"]
168 // Optional. Recommended for helping clients to reserve an adequate UI space to show the file before downloading it.
169 ["dim", "800x600"]
170 // ... other optional NIP-94 tags
171 ],
172 content: ""
173 },
174 // ... other custom fields (please consider adding them to this NIP or to NIP-94 tags)
175}
176```
177
178Note 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.
179
180`clients` may upload the same file to one or many `servers`.
181After 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.
182
183Alternatively, instead of using NIP-94, the `client` can share or embed on a nostr note just the above url.
184
185`clients` may also use the tags from the `nip94_event` to construct an `imeta` tag
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`GET $api_url/<sha256-hash>(.ext)`
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-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: `$api_url/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: `$api_url/<sha256-hash>.png?w=32`
253
254## Deletion
255
256`DELETE $api_url/<sha256-hash>(.ext)`
257
258**AUTH required**
259
260Note that the `/<sha256-hash>` part is from the **original** file, **not** from the **transformed** file if the uploaded file went through any server transformation.
261
262The extension is optional as the file hash is the only needed file identification.
263
264The `server` should reject deletes from users other than the original uploader with the appropriate http response code (403 Forbidden).
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## Listing files
279
280`GET $api_url?page=x&count=y`
281
282**AUTH required**
283
284Returns a list of files linked to the authenticated users pubkey.
285
286Example Response:
287
288```js
289{
290 "count": 1, // server page size, eg. max(1, min(server_max_page_size, arg_count))
291 "total": 1, // total number of files
292 "page": 0, // the current page number
293 "files": [
294 {
295 "tags": [
296 ["ox": "719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b"],
297 ["x": "5d2899290e0e69bcd809949ee516a4a1597205390878f780c098707a7f18e3df"],
298 ["size", "123456"],
299 ["alt", "a meme that makes you laugh"],
300 ["expiration", "1715691139"],
301 // ...other metadata
302 ]
303 "content": "haha funny meme", // caption
304 "created_at": 1715691130 // upload timestmap
305 },
306 ...
307 ]
308}
309```
310
311`files` contains an array of NIP-94 events
312
313### Query args
314
315- `page` page number (`offset=page*count`)
316- `count` number of items per page
317
318## Selecting a Server
319
320Note: HTTP File Storage Server developers may skip this section. This is meant for client developers.
321
322A File Server Preference event is a kind 10096 replaceable event meant to select one or more servers the user wants
323to upload files to. Servers are listed as `server` tags:
324
325```js
326{
327 // ...
328 "kind": 10096,
329 "content": "",
330 "tags": [
331 ["server", "https://file.server.one"],
332 ["server", "https://file.server.two"]
333 ]
334}
335```
diff --git a/98.md b/98.md
new file mode 100644
index 0000000..be425b2
--- /dev/null
+++ b/98.md
@@ -0,0 +1,63 @@
1NIP-98
2======
3
4HTTP Auth
5---------
6
7`draft` `optional`
8
9This NIP defines an ephemeral event used to authorize requests to HTTP servers using nostr events.
10
11This is useful for HTTP services which are built for Nostr and deal with Nostr user accounts.
12
13## Nostr event
14
15A `kind 27235` (In reference to [RFC 7235](https://www.rfc-editor.org/rfc/rfc7235)) event is used.
16
17The `content` SHOULD be empty.
18
19The following tags MUST be included.
20
21* `u` - absolute URL
22* `method` - HTTP Request Method
23
24Example event:
25```json
26{
27 "id": "fe964e758903360f28d8424d092da8494ed207cba823110be3a57dfe4b578734",
28 "pubkey": "63fe6318dc58583cfe16810f86dd09e18bfd76aabc24a0081ce2856f330504ed",
29 "content": "",
30 "kind": 27235,
31 "created_at": 1682327852,
32 "tags": [
33 ["u", "https://api.snort.social/api/v1/n5sp/list"],
34 ["method", "GET"]
35 ],
36 "sig": "5ed9d8ec958bc854f997bdc24ac337d005af372324747efe4a00e24f4c30437ff4dd8308684bed467d9d6be3e5a517bb43b1732cc7d33949a3aaf86705c22184"
37}
38```
39
40Servers MUST perform the following checks in order to validate the event:
411. The `kind` MUST be `27235`.
422. The `created_at` timestamp MUST be within a reasonable time window (suggestion 60 seconds).
433. The `u` tag MUST be exactly the same as the absolute request URL (including query parameters).
444. The `method` tag MUST be the same HTTP method used for the requested resource.
45
46When the request contains a body (as in POST/PUT/PATCH methods) clients SHOULD include a SHA256 hash of the request body in a `payload` tag as hex (`["payload", "<sha256-hex>"]`), servers MAY check this to validate that the requested payload is authorized.
47
48If one of the checks was to fail the server SHOULD respond with a 401 Unauthorized response code.
49
50Servers MAY perform additional implementation-specific validation checks.
51
52## Request Flow
53
54Using the `Authorization` HTTP header, the `kind 27235` event MUST be `base64` encoded and use the Authorization scheme `Nostr`
55
56Example HTTP Authorization header:
57```
58Authorization: Nostr
59eyJpZCI6ImZlOTY0ZTc1ODkwMzM2MGYyOGQ4NDI0ZDA5MmRhODQ5NGVkMjA3Y2JhODIzMTEwYmUzYTU3ZGZlNGI1Nzg3MzQiLCJwdWJrZXkiOiI2M2ZlNjMxOGRjNTg1ODNjZmUxNjgxMGY4NmRkMDllMThiZmQ3NmFhYmMyNGEwMDgxY2UyODU2ZjMzMDUwNGVkIiwiY29udGVudCI6IiIsImtpbmQiOjI3MjM1LCJjcmVhdGVkX2F0IjoxNjgyMzI3ODUyLCJ0YWdzIjpbWyJ1IiwiaHR0cHM6Ly9hcGkuc25vcnQuc29jaWFsL2FwaS92MS9uNXNwL2xpc3QiXSxbIm1ldGhvZCIsIkdFVCJdXSwic2lnIjoiNWVkOWQ4ZWM5NThiYzg1NGY5OTdiZGMyNGFjMzM3ZDAwNWFmMzcyMzI0NzQ3ZWZlNGEwMGUyNGY0YzMwNDM3ZmY0ZGQ4MzA4Njg0YmVkNDY3ZDlkNmJlM2U1YTUxN2JiNDNiMTczMmNjN2QzMzk0OWEzYWFmODY3MDVjMjIxODQifQ
60```
61
62## Reference Implementations
63- C# ASP.NET `AuthenticationHandler` [NostrAuth.cs](https://gist.github.com/v0l/74346ae530896115bfe2504c8cd018d3)
diff --git a/99.md b/99.md
new file mode 100644
index 0000000..93550d8
--- /dev/null
+++ b/99.md
@@ -0,0 +1,86 @@
1NIP-99
2======
3
4Classified Listings
5-------------------
6
7`draft` `optional`
8
9This NIP defines `kind:30402`: a parameterized replaceable event to describe classified listings that list any arbitrary product, service, or other thing for sale or offer and includes enough structured metadata to make them useful.
10
11The category of classifieds includes a very broad range of physical goods, services, work opportunities, rentals, free giveaways, personals, etc. and is distinct from the more strictly structured marketplaces defined in [NIP-15](https://github.com/nostr-protocol/nips/blob/master/15.md) that often sell many units of specific products through very specific channels.
12
13The structure of these events is very similar to [NIP-23](https://github.com/nostr-protocol/nips/blob/master/23.md) long-form content events.
14
15### Draft / Inactive Listings
16
17`kind:30403` has the same structure as `kind:30402` and is used to save draft or inactive classified listings.
18
19### Content
20
21The `.content` field should be a description of what is being offered and by whom. These events should be a string in Markdown syntax.
22
23### Author
24
25The `.pubkey` field of these events are treated as the party creating the listing.
26
27### Metadata
28
29- For "tags"/"hashtags" (i.e. categories or keywords of relevance for the listing) the `"t"` event tag should be used, as per [NIP-12](https://github.com/nostr-protocol/nips/blob/master/12.md).
30- For images, whether included in the markdown content or not, clients SHOULD use `image` tags as described in [NIP-58](https://github.com/nostr-protocol/nips/blob/master/58.md). This allows clients to display images in carousel format more easily.
31
32The following tags, used for structured metadata, are standardized and SHOULD be included. Other tags may be added as necessary.
33
34- `"title"`, a title for the listing
35- `"summary"`, for short tagline or summary for the listing
36- `"published_at"`, for the timestamp (in unix seconds – converted to string) of the first time the listing was published.
37- `"location"`, for the location.
38- `"price"`, for the price of the thing being listed. This is an array in the format `[ "price", "<number>", "<currency>", "<frequency>" ]`.
39 - `"price"` is the name of the tag
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"`).
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".
44
45#### `price` examples
46
47- $50 one-time payment `["price", "50", "USD"]`
48- €15 per month `["price", "15", "EUR", "month"]`
49- £50,000 per year `["price", "50000", "GBP", "year"]`
50
51Other standard tags that might be useful.
52
53- `"g"`, a geohash for more precise location
54
55## Example Event
56
57```json
58{
59 "kind": 30402,
60 "created_at": 1675642635,
61 // Markdown content
62 "content": "Lorem [ipsum][nostr:nevent1qqst8cujky046negxgwwm5ynqwn53t8aqjr6afd8g59nfqwxpdhylpcpzamhxue69uhhyetvv9ujuetcv9khqmr99e3k7mg8arnc9] dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\n\nRead more at nostr:naddr1qqzkjurnw4ksz9thwden5te0wfjkccte9ehx7um5wghx7un8qgs2d90kkcq3nk2jry62dyf50k0h36rhpdtd594my40w9pkal876jxgrqsqqqa28pccpzu.",
63 "tags": [
64 ["d", "lorem-ipsum"],
65 ["title", "Lorem Ipsum"],
66 ["published_at", "1296962229"],
67 ["t", "electronics"],
68 ["image", "https://url.to.img", "256x256"],
69 ["summary", "More lorem ipsum that is a little more than the title"],
70 ["location", "NYC"],
71 ["price", "100", "USD"],
72 [
73 "e",
74 "b3e392b11f5d4f28321cedd09303a748acfd0487aea5a7450b3481c60b6e4f87",
75 "wss://relay.example.com"
76 ],
77 [
78 "a",
79 "30023:a695f6b60119d9521934a691347d9f78e8770b56da16bb255ee286ddf9fda919:ipsum",
80 "wss://relay.nostr.org"
81 ]
82 ],
83 "pubkey": "...",
84 "id": "..."
85}
86```
diff --git a/BREAKING.md b/BREAKING.md
new file mode 100644
index 0000000..c8255cd
--- /dev/null
+++ b/BREAKING.md
@@ -0,0 +1,54 @@
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-06-06 | [58e94b20](https://github.com/nostr-protocol/nips/commit/58e94b20) | [NIP-25](25.md) | [8073c848](https://github.com/nostr-protocol/nips/commit/8073c848) was reverted |
9| 2024-06-06 | [a6dfc7b5](https://github.com/nostr-protocol/nips/commit/a6dfc7b5) | [NIP-55](55.md) | NIP number was changed |
10| 2024-05-25 | [5d1d1c17](https://github.com/nostr-protocol/nips/commit/5d1d1c17) | [NIP-71](71.md) | 'aes-256-gcm' tag was removed |
11| 2024-05-07 | [8073c848](https://github.com/nostr-protocol/nips/commit/8073c848) | [NIP-25](25.md) | e-tags were changed to not include entire thread |
12| 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) |
13| 2024-02-25 | [4a171cb0](https://github.com/nostr-protocol/nips/commit/4a171cb0) | [NIP-18](18.md) | quote repost should use `q` tag |
14| 2024-02-21 | [c6cd655c](https://github.com/nostr-protocol/nips/commit/c6cd655c) | [NIP-46](46.md) | Params were stringified |
15| 2024-02-16 | [cbec02ab](https://github.com/nostr-protocol/nips/commit/cbec02ab) | [NIP-49](49.md) | Password first normalized to NFKC |
16| 2024-02-15 | [afbb8dd0](https://github.com/nostr-protocol/nips/commit/afbb8dd0) | [NIP-39](39.md) | PGP identity was removed |
17| 2024-02-07 | [d3dad114](https://github.com/nostr-protocol/nips/commit/d3dad114) | [NIP-46](46.md) | Connection token format was changed |
18| 2024-01-30 | [1a2b21b6](https://github.com/nostr-protocol/nips/commit/1a2b21b6) | [NIP-59](59.md) | 'p' tag became optional |
19| 2023-01-27 | [c2f34817](https://github.com/nostr-protocol/nips/commit/c2f34817) | [NIP-47](47.md) | optional expiration tag should be honored |
20| 2024-01-10 | [3d8652ea](https://github.com/nostr-protocol/nips/commit/3d8652ea) | [NIP-02](02.md) | list entries should be chronological |
21| 2024-01-10 | [3d8652ea](https://github.com/nostr-protocol/nips/commit/3d8652ea) | [NIP-51](51.md) | list entries should be chronological |
22| 2023-12-30 | [29869821](https://github.com/nostr-protocol/nips/commit/29869821) | [NIP-52](52.md) | 'name' tag was removed (use 'title' tag instead) |
23| 2023-12-27 | [17c67ef5](https://github.com/nostr-protocol/nips/commit/17c67ef5) | [NIP-94](94.md) | 'aes-256-gcm' tag was removed |
24| 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 |
25| 2023-11-28 | [6de35f9e](https://github.com/nostr-protocol/nips/commit/6de35f9e) | [NIP-89](89.md) | 'client' tag value was changed |
26| 2023-11-20 | [7822a8b1](https://github.com/nostr-protocol/nips/commit/7822a8b1) | [NIP-51](51.md) | `kind: 30000` and `kind: 30001` were deprecated |
27| 2023-11-11 | [cbdca1e9](https://github.com/nostr-protocol/nips/commit/cbdca1e9) | [NIP-84](84.md) | 'range' tag was removed |
28| 2023-11-10 | [c945d8bd](https://github.com/nostr-protocol/nips/commit/c945d8bd) | [NIP-32](32.md) | 'l' tag annotations was removed |
29| 2023-11-07 | [108b7f16](https://github.com/nostr-protocol/nips/commit/108b7f16) | [NIP-01](01.md) | 'OK' message must have 4 items |
30| 2023-10-17 | [cf672b76](https://github.com/nostr-protocol/nips/commit/cf672b76) | [NIP-03](03.md) | 'block' tag was removed |
31| 2023-09-29 | [7dc6385f](https://github.com/nostr-protocol/nips/commit/7dc6385f) | [NIP-57](57.md) | optional 'a' tag was included in `zap receipt` |
32| 2023-08-21 | [89915e02](https://github.com/nostr-protocol/nips/commit/89915e02) | [NIP-11](11.md) | 'min_prefix' was removed |
33| 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 |
34| 2023-08-15 | [88ee873c](https://github.com/nostr-protocol/nips/commit/88ee873c) | [NIP-15](15.md) | 'countries' tag was renamed to 'regions' |
35| 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 |
36| 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 |
37| 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 |
38| 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 |
39| 2023-08-11 | [d87f8617](https://github.com/nostr-protocol/nips/commit/d87f8617) | [NIP-25](25.md) | empty `content` should be considered as "+" |
40| 2023-08-01 | [5d63b157](https://github.com/nostr-protocol/nips/commit/5d63b157) | [NIP-57](57.md) | 'zap' tag was changed |
41| 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` |
42| 2023-07-12 | [a1cd2bd8](https://github.com/nostr-protocol/nips/commit/a1cd2bd8) | [NIP-25](25.md) | custom emoji was supported |
43| 2023-06-18 | [83cbd3e1](https://github.com/nostr-protocol/nips/commit/83cbd3e1) | [NIP-11](11.md) | 'image' was renamed to 'icon' |
44| 2023-04-13 | [bf0a0da6](https://github.com/nostr-protocol/nips/commit/bf0a0da6) | [NIP-15](15.md) | different NIP was re-added as NIP-15 |
45| 2023-04-09 | [fb5b7c73](https://github.com/nostr-protocol/nips/commit/fb5b7c73) | [NIP-15](15.md) | NIP-15 was merged into NIP-01 |
46| 2023-03-15 | [e1004d3d](https://github.com/nostr-protocol/nips/commit/e1004d3d) | [NIP-19](19.md) | `1: relay` was changed to optionally |
47
48Breaking changes prior to 2023-03-01 are not yet documented.
49
50## NOTES
51
52- If it isn't clear that a change is breaking or not, we list it.
53- The date is the date it was merged, not necessarily the date of the commit.
54
diff --git a/README.md b/README.md
index 94e945c..dd2e812 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,21 @@
1# NIPs 1# NIPs
2 2
3NIPs stand for **Nostr Implementation Possibilities**. 3NIPs stand for **Nostr Implementation Possibilities**.
4
4They exist to document what may be implemented by [Nostr](https://github.com/nostr-protocol/nostr)-compatible _relay_ and _client_ software. 5They exist to document what may be implemented by [Nostr](https://github.com/nostr-protocol/nostr)-compatible _relay_ and _client_ software.
5 6
6--- 7---
7 8
8- [List](#list) 9- [List](#list)
9- [Event Kinds](#event-kinds) 10- [Event Kinds](#event-kinds)
10 - [Event Kind Ranges](#event-kind-ranges)
11- [Message Types](#message-types) 11- [Message Types](#message-types)
12 - [Client to Relay](#client-to-relay) 12 - [Client to Relay](#client-to-relay)
13 - [Relay to Client](#relay-to-client) 13 - [Relay to Client](#relay-to-client)
14- [Standardized Tags](#standardized-tags) 14- [Standardized Tags](#standardized-tags)
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)
17- [How this repository works](#how-this-repository-works)
18- [Breaking Changes](#breaking-changes)
16- [License](#license) 19- [License](#license)
17 20
18--- 21---
@@ -20,9 +23,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
20## List 23## List
21 24
22- [NIP-01: Basic protocol flow description](01.md) 25- [NIP-01: Basic protocol flow description](01.md)
23- [NIP-02: Contact List and Petnames](02.md) 26- [NIP-02: Follow List](02.md)
24- [NIP-03: OpenTimestamps Attestations for Events](03.md) 27- [NIP-03: OpenTimestamps Attestations for Events](03.md)
25- [NIP-04: Encrypted Direct Message](04.md) 28- [NIP-04: Encrypted Direct Message](04.md) --- **unrecommended**: deprecated in favor of [NIP-17](17.md)
26- [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)
27- [NIP-06: Basic key derivation from mnemonic seed phrase](06.md) 30- [NIP-06: Basic key derivation from mnemonic seed phrase](06.md)
28- [NIP-07: `window.nostr` capability for web browsers](07.md) 31- [NIP-07: `window.nostr` capability for web browsers](07.md)
@@ -30,85 +33,173 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
30- [NIP-09: Event Deletion](09.md) 33- [NIP-09: Event Deletion](09.md)
31- [NIP-10: Conventions for clients' use of `e` and `p` tags in text events](10.md) 34- [NIP-10: Conventions for clients' use of `e` and `p` tags in text events](10.md)
32- [NIP-11: Relay Information Document](11.md) 35- [NIP-11: Relay Information Document](11.md)
33- [NIP-12: Generic Tag Queries](12.md)
34- [NIP-13: Proof of Work](13.md) 36- [NIP-13: Proof of Work](13.md)
35- [NIP-14: Subject tag in text events.](14.md) 37- [NIP-14: Subject tag in text events](14.md)
36- [NIP-15: Nostr Marketplace (for resilient marketplaces)](15.md) 38- [NIP-15: Nostr Marketplace (for resilient marketplaces)](15.md)
37- [NIP-16: Event Treatment](16.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-20: Command Results](20.md) 42- [NIP-21: `nostr:` URI scheme](21.md)
41- [NIP-21: `nostr:` URL scheme](21.md)
42- [NIP-22: Event `created_at` Limits](22.md)
43- [NIP-23: Long-form Content](23.md) 43- [NIP-23: Long-form Content](23.md)
44- [NIP-24: Extra metadata fields and tags](24.md)
44- [NIP-25: Reactions](25.md) 45- [NIP-25: Reactions](25.md)
45- [NIP-26: Delegated Event Signing](26.md) 46- [NIP-26: Delegated Event Signing](26.md)
46- [NIP-27: Text Note References](27.md) 47- [NIP-27: Text Note References](27.md)
47- [NIP-28: Public Chat](28.md) 48- [NIP-28: Public Chat](28.md)
48- [NIP-33: Parameterized Replaceable Events](33.md) 49- [NIP-29: Relay-based Groups](29.md)
50- [NIP-30: Custom Emoji](30.md)
51- [NIP-31: Dealing with Unknown Events](31.md)
52- [NIP-32: Labeling](32.md)
53- [NIP-34: `git` stuff](34.md)
54- [NIP-35: Torrents](35.md)
49- [NIP-36: Sensitive Content](36.md) 55- [NIP-36: Sensitive Content](36.md)
56- [NIP-38: User Statuses](38.md)
50- [NIP-39: External Identities in Profiles](39.md) 57- [NIP-39: External Identities in Profiles](39.md)
51- [NIP-40: Expiration Timestamp](40.md) 58- [NIP-40: Expiration Timestamp](40.md)
52- [NIP-42: Authentication of clients to relays](42.md) 59- [NIP-42: Authentication of clients to relays](42.md)
60- [NIP-44: Versioned Encryption](44.md)
53- [NIP-45: Counting results](45.md) 61- [NIP-45: Counting results](45.md)
54- [NIP-46: Nostr Connect](46.md) 62- [NIP-46: Nostr Connect](46.md)
55- [NIP-47: Wallet Connect](47.md) 63- [NIP-47: Wallet Connect](47.md)
56- [NIP-50: Keywords filter](50.md) 64- [NIP-48: Proxy Tags](48.md)
65- [NIP-49: Private Key Encryption](49.md)
66- [NIP-50: Search Capability](50.md)
57- [NIP-51: Lists](51.md) 67- [NIP-51: Lists](51.md)
68- [NIP-52: Calendar Events](52.md)
69- [NIP-53: Live Activities](53.md)
70- [NIP-54: Wiki](54.md)
71- [NIP-55: Android Signer Application](55.md)
58- [NIP-56: Reporting](56.md) 72- [NIP-56: Reporting](56.md)
59- [NIP-57: Lightning Zaps](57.md) 73- [NIP-57: Lightning Zaps](57.md)
60- [NIP-58: Badges](58.md) 74- [NIP-58: Badges](58.md)
75- [NIP-59: Gift Wrap](59.md)
61- [NIP-65: Relay List Metadata](65.md) 76- [NIP-65: Relay List Metadata](65.md)
77- [NIP-70: Protected Events](70.md)
78- [NIP-71: Video Events](71.md)
79- [NIP-72: Moderated Communities](72.md)
80- [NIP-75: Zap Goals](75.md)
62- [NIP-78: Application-specific data](78.md) 81- [NIP-78: Application-specific data](78.md)
82- [NIP-84: Highlights](84.md)
83- [NIP-89: Recommended Application Handlers](89.md)
84- [NIP-90: Data Vending Machines](90.md)
85- [NIP-92: Media Attachments](92.md)
63- [NIP-94: File Metadata](94.md) 86- [NIP-94: File Metadata](94.md)
87- [NIP-96: HTTP File Storage Integration](96.md)
88- [NIP-98: HTTP Auth](98.md)
89- [NIP-99: Classified Listings](99.md)
64 90
65## Event Kinds 91## Event Kinds
92| kind | description | NIP |
93| ------------- | -------------------------- | ------------------------ |
94| `0` | User Metadata | [01](01.md) |
95| `1` | Short Text Note | [01](01.md) |
96| `2` | Recommend Relay | 01 (deprecated) |
97| `3` | Follows | [02](02.md) |
98| `4` | Encrypted Direct Messages | [04](04.md) |
99| `5` | Event Deletion | [09](09.md) |
100| `6` | Repost | [18](18.md) |
101| `7` | Reaction | [25](25.md) |
102| `8` | Badge Award | [58](58.md) |
103| `9` | Group Chat Message | [29](29.md) |
104| `10` | Group Chat Threaded Reply | [29](29.md) |
105| `11` | Group Thread | [29](29.md) |
106| `12` | Group Thread Reply | [29](29.md) |
107| `13` | Seal | [59](59.md) |
108| `14` | Direct Message | [17](17.md) |
109| `16` | Generic Repost | [18](18.md) |
110| `40` | Channel Creation | [28](28.md) |
111| `41` | Channel Metadata | [28](28.md) |
112| `42` | Channel Message | [28](28.md) |
113| `43` | Channel Hide Message | [28](28.md) |
114| `44` | Channel Mute User | [28](28.md) |
115| `818` | Merge Requests | [54](54.md) |
116| `1021` | Bid | [15](15.md) |
117| `1022` | Bid confirmation | [15](15.md) |
118| `1040` | OpenTimestamps | [03](03.md) |
119| `1059` | Gift Wrap | [59](59.md) |
120| `1063` | File Metadata | [94](94.md) |
121| `1311` | Live Chat Message | [53](53.md) |
122| `1617` | Patches | [34](34.md) |
123| `1621` | Issues | [34](34.md) |
124| `1622` | Replies | [34](34.md) |
125| `1630`-`1633` | Status | [34](34.md) |
126| `1971` | Problem Tracker | [nostrocket][nostrocket] |
127| `1984` | Reporting | [56](56.md) |
128| `1985` | Label | [32](32.md) |
129| `2003` | Torrent | [35](35.md) |
130| `2004` | Torrent Comment | [35](35.md) |
131| `2022` | Coinjoin Pool | [joinstr][joinstr] |
132| `4550` | Community Post Approval | [72](72.md) |
133| `5000`-`5999` | Job Request | [90](90.md) |
134| `6000`-`6999` | Job Result | [90](90.md) |
135| `7000` | Job Feedback | [90](90.md) |
136| `9000`-`9030` | Group Control Events | [29](29.md) |
137| `9041` | Zap Goal | [75](75.md) |
138| `9734` | Zap Request | [57](57.md) |
139| `9735` | Zap | [57](57.md) |
140| `9802` | Highlights | [84](84.md) |
141| `10000` | Mute list | [51](51.md) |
142| `10001` | Pin list | [51](51.md) |
143| `10002` | Relay List Metadata | [65](65.md) |
144| `10003` | Bookmark list | [51](51.md) |
145| `10004` | Communities list | [51](51.md) |
146| `10005` | Public chats list | [51](51.md) |
147| `10006` | Blocked relays list | [51](51.md) |
148| `10007` | Search relays list | [51](51.md) |
149| `10009` | User groups | [51](51.md), [29](29.md) |
150| `10015` | Interests list | [51](51.md) |
151| `10030` | User emoji list | [51](51.md) |
152| `10050` | Relay list to receive DMs | [17](17.md) |
153| `10096` | File storage server list | [96](96.md) |
154| `13194` | Wallet Info | [47](47.md) |
155| `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] |
156| `22242` | Client Authentication | [42](42.md) |
157| `23194` | Wallet Request | [47](47.md) |
158| `23195` | Wallet Response | [47](47.md) |
159| `24133` | Nostr Connect | [46](46.md) |
160| `27235` | HTTP Auth | [98](98.md) |
161| `30000` | Follow sets | [51](51.md) |
162| `30001` | Generic lists | [51](51.md) |
163| `30002` | Relay sets | [51](51.md) |
164| `30003` | Bookmark sets | [51](51.md) |
165| `30004` | Curation sets | [51](51.md) |
166| `30005` | Video sets | [51](51.md) |
167| `30008` | Profile Badges | [58](58.md) |
168| `30009` | Badge Definition | [58](58.md) |
169| `30015` | Interest sets | [51](51.md) |
170| `30017` | Create or update a stall | [15](15.md) |
171| `30018` | Create or update a product | [15](15.md) |
172| `30019` | Marketplace UI/UX | [15](15.md) |
173| `30020` | Product sold as an auction | [15](15.md) |
174| `30023` | Long-form Content | [23](23.md) |
175| `30024` | Draft Long-form Content | [23](23.md) |
176| `30030` | Emoji sets | [51](51.md) |
177| `30063` | Release artifact sets | [51](51.md) |
178| `30078` | Application-specific Data | [78](78.md) |
179| `30311` | Live Event | [53](53.md) |
180| `30315` | User Statuses | [38](38.md) |
181| `30402` | Classified Listing | [99](99.md) |
182| `30403` | Draft Classified Listing | [99](99.md) |
183| `30617` | Repository announcements | [34](34.md) |
184| `30818` | Wiki article | [54](54.md) |
185| `30819` | Redirects | [54](54.md) |
186| `31890` | Feed | [NUD: Custom Feeds](https://wikifreedia.xyz/cip-01/97c70a44366a6535c1) |
187| `31922` | Date-Based Calendar Event | [52](52.md) |
188| `31923` | Time-Based Calendar Event | [52](52.md) |
189| `31924` | Calendar | [52](52.md) |
190| `31925` | Calendar Event RSVP | [52](52.md) |
191| `31989` | Handler recommendation | [89](89.md) |
192| `31990` | Handler information | [89](89.md) |
193| `34235` | Video Event | [71](71.md) |
194| `34236` | Short-form Portrait Video Event | [71](71.md) |
195| `34237` | Video View Event | [71](71.md) |
196| `34550` | Community Definition | [72](72.md) |
197| `39000-9` | Group metadata events | [29](29.md) |
66 198
67| kind | description | NIP | 199[NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/97c70a44366a6535c1
68| ------- | -------------------------- | ----------- | 200[nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md
69| `0` | Metadata | [1](01.md) | 201[lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md
70| `1` | Short Text Note | [1](01.md) | 202[joinstr]: https://gitlab.com/1440000bytes/joinstr/-/blob/main/NIP.md
71| `2` | Recommend Relay | [1](01.md) |
72| `3` | Contacts | [2](02.md) |
73| `4` | Encrypted Direct Messages | [4](04.md) |
74| `5` | Event Deletion | [9](09.md) |
75| `6` | Reposts | [18](18.md) |
76| `7` | Reaction | [25](25.md) |
77| `8` | Badge Award | [58](58.md) |
78| `40` | Channel Creation | [28](28.md) |
79| `41` | Channel Metadata | [28](28.md) |
80| `42` | Channel Message | [28](28.md) |
81| `43` | Channel Hide Message | [28](28.md) |
82| `44` | Channel Mute User | [28](28.md) |
83| `1063` | File Metadata | [94](94.md) |
84| `1984` | Reporting | [56](56.md) |
85| `9734` | Zap Request | [57](57.md) |
86| `9735` | Zap | [57](57.md) |
87| `10000` | Mute List | [51](51.md) |
88| `10001` | Pin List | [51](51.md) |
89| `10002` | Relay List Metadata | [65](65.md) |
90| `13194` | Wallet Info | [47](47.md) |
91| `22242` | Client Authentication | [42](42.md) |
92| `23194` | Wallet Request | [47](47.md) |
93| `23195` | Wallet Response | [47](47.md) |
94| `24133` | Nostr Connect | [46](46.md) |
95| `30000` | Categorized People List | [51](51.md) |
96| `30001` | Categorized Bookmark List | [51](51.md) |
97| `30008` | Profile Badges | [58](58.md) |
98| `30009` | Badge Definition | [58](58.md) |
99| `30017` | Create or update a stall | [15](15.md) |
100| `30018` | Create or update a product | [15](15.md) |
101| `30023` | Long-form Content | [23](23.md) |
102| `30078` | Application-specific Data | [78](78.md) |
103
104### Event Kind Ranges
105
106| range | description | NIP |
107| ---------------- | -------------------------------- | ----------- |
108| `1000`--`9999` | Regular Events | [16](16.md) |
109| `10000`--`19999` | Replaceable Events | [16](16.md) |
110| `20000`--`29999` | Ephemeral Events | [16](16.md) |
111| `30000`--`39999` | Parameterized Replaceable Events | [33](33.md) |
112 203
113## Message types 204## Message types
114 205
@@ -116,69 +207,111 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
116 207
117| type | description | NIP | 208| type | description | NIP |
118| ------- | --------------------------------------------------- | ----------- | 209| ------- | --------------------------------------------------- | ----------- |
210| `EVENT` | used to publish events | [01](01.md) |
211| `REQ` | used to request events and subscribe to new updates | [01](01.md) |
212| `CLOSE` | used to stop previous subscriptions | [01](01.md) |
119| `AUTH` | used to send authentication events | [42](42.md) | 213| `AUTH` | used to send authentication events | [42](42.md) |
120| `CLOSE` | used to stop previous subscriptions | [1](01.md) |
121| `COUNT` | used to request event counts | [45](45.md) | 214| `COUNT` | used to request event counts | [45](45.md) |
122| `EVENT` | used to publish events | [1](01.md) |
123| `REQ` | used to request events and subscribe to new updates | [1](01.md) |
124 215
125### Relay to Client 216### Relay to Client
126 217
127| type | description | NIP | 218| type | description | NIP |
128| -------- | ------------------------------------------------------- | ----------- | 219| -------- | ------------------------------------------------------- | ----------- |
220| `EOSE` | used to notify clients all stored events have been sent | [01](01.md) |
221| `EVENT` | used to send events requested to clients | [01](01.md) |
222| `NOTICE` | used to send human-readable messages to clients | [01](01.md) |
223| `OK` | used to notify clients if an EVENT was successful | [01](01.md) |
224| `CLOSED` | used to notify clients that a REQ was ended and why | [01](01.md) |
129| `AUTH` | used to send authentication challenges | [42](42.md) | 225| `AUTH` | used to send authentication challenges | [42](42.md) |
130| `COUNT` | used to send requested event counts to clients | [45](45.md) | 226| `COUNT` | used to send requested event counts to clients | [45](45.md) |
131| `EOSE` | used to notify clients all stored events have been sent | [1](01.md) |
132| `EVENT` | used to send events requested to clients | [1](01.md) |
133| `NOTICE` | used to send human-readable messages to clients | [1](01.md) |
134| `OK` | used to notify clients if an EVENT was successful | [20](20.md) |
135
136Please update these lists when proposing NIPs introducing new event kinds.
137
138When experimenting with kinds, keep in mind the classification introduced by [NIP-16](16.md) and [NIP-33](33.md).
139 227
140## Standardized Tags 228## Standardized Tags
141 229
142| name | value | other parameters | NIP | 230| name | value | other parameters | NIP |
143| ----------------- | ------------------------------------ | -------------------- | ------------------------ | 231| ----------------- | ------------------------------------ | ------------------------------- | ------------------------------------- |
144| `a` | coordinates to an event | relay URL | [33](33.md), [23](23.md) | 232| `e` | event id (hex) | relay URL, marker, pubkey (hex) | [01](01.md), [10](10.md) |
145| `d` | identifier | -- | [33](33.md) | 233| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) |
146| `e` | event id (hex) | relay URL, marker | [1](01.md), [10](10.md) | 234| `a` | coordinates to an event | relay URL | [01](01.md) |
147| `g` | geohash | -- | [12](12.md) | 235| `d` | identifier | -- | [01](01.md) |
148| `i` | identity | proof | [39](39.md) | 236| `-` | -- | -- | [70](70.md) |
149| `p` | pubkey (hex) | relay URL | [1](01.md) | 237| `g` | geohash | -- | [52](52.md) |
150| `r` | a reference (URL, etc) | -- | [12](12.md) | 238| `h` | group id | -- | [29](29.md) |
151| `t` | hashtag | -- | [12](12.md) | 239| `i` | identity | proof | [39](39.md) |
152| `amount` | millisats | -- | [57](57.md) | 240| `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) |
153| `bolt11` | `bolt11` invoice | -- | [57](57.md) | 241| `l` | label, label namespace | -- | [32](32.md) |
154| `challenge` | challenge string | -- | [42](42.md) | 242| `L` | label namespace | -- | [32](32.md) |
155| `content-warning` | reason | -- | [36](36.md) | 243| `m` | MIME type | -- | [94](94.md) |
156| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | 244| `q` | event id (hex) | relay URL | [18](18.md) |
157| `description` | badge description | -- | [58](58.md) | 245| `r` | a reference (URL, etc) | petname | [24](24.md) |
158| `description` | invoice description | -- | [57](57.md) | 246| `r` | relay url | marker | [65](65.md) |
159| `expiration` | unix timestamp (string) | -- | [40](40.md) | 247| `t` | hashtag | -- | |
160| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | 248| `alt` | summary | -- | [31](31.md) |
161| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | 249| `amount` | millisatoshis, stringified | -- | [57](57.md) |
162| `name` | badge name | -- | [58](58.md) | 250| `bolt11` | `bolt11` invoice | -- | [57](57.md) |
163| `nonce` | random | -- | [13](13.md) | 251| `challenge` | challenge string | -- | [42](42.md) |
164| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | 252| `client` | name, address | relay URL | [89](89.md) |
165| `published_at` | unix timestamp (string) | -- | [23](23.md) | 253| `clone` | git clone URL | -- | [34](34.md) |
166| `relay` | relay url | -- | [42](42.md) | 254| `content-warning` | reason | -- | [36](36.md) |
167| `relays` | relay list | -- | [57](57.md) | 255| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) |
168| `subject` | subject | -- | [14](14.md) | 256| `description` | description | -- | [34](34.md), [57](57.md), [58](58.md) |
169| `summary` | article summary | -- | [23](23.md) | 257| `emoji` | shortcode, image URL | -- | [30](30.md) |
170| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | 258| `encrypted` | -- | -- | [90](90.md) |
171| `title` | article title | -- | [23](23.md) | 259| `expiration` | unix timestamp (string) | -- | [40](40.md) |
172| `zap` | profile name | type of value | [57](57.md) | 260| `goal` | event id (hex) | relay URL | [75](75.md) |
261| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) |
262| `imeta` | inline metadata | -- | [92](92.md) |
263| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) |
264| `location` | location string | -- | [52](52.md), [99](99.md) |
265| `name` | name | -- | [34](34.md), [58](58.md) |
266| `nonce` | random | difficulty | [13](13.md) |
267| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) |
268| `price` | price | currency, frequency | [99](99.md) |
269| `proxy` | external ID | protocol | [48](48.md) |
270| `published_at` | unix timestamp (string) | -- | [23](23.md) |
271| `relay` | relay url | -- | [42](42.md), [17](17.md) |
272| `relays` | relay list | -- | [57](57.md) |
273| `server` | file storage server url | -- | [96](96.md) |
274| `subject` | subject | -- | [14](14.md), [17](17.md) |
275| `summary` | article summary | -- | [23](23.md) |
276| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) |
277| `title` | article title | -- | [23](23.md) |
278| `web` | webpage URL | -- | [34](34.md) |
279| `zap` | pubkey (hex), relay URL | weight | [57](57.md) |
280
281Please update these lists when proposing new NIPs.
173 282
174## Criteria for acceptance of NIPs 283## Criteria for acceptance of NIPs
175 284
1761. They should be implemented in at least two clients and one relay -- when applicable. 2851. They should be fully implemented in at least two clients and one relay -- when applicable.
1772. They should make sense. 2862. They should make sense.
1783. They should be optional and backwards-compatible: care must be taken such that clients and relays that choose to not implement them do not stop working when interacting with the ones that choose to. 2873. They should be optional and backwards-compatible: care must be taken such that clients and relays that choose to not implement them do not stop working when interacting with the ones that choose to.
1794. There should be no more than one way of doing the same thing. 2884. There should be no more than one way of doing the same thing.
1805. Other rules will be made up when necessary. 2895. Other rules will be made up when necessary.
181 290
291## Is this repository a centralizing factor?
292
293To promote interoperability, we standards that everybody can follow, and we need them to define a **single way of doing each thing** without ever hurting **backwards-compatibility**, and for that purpose there is no way around getting everybody to agree on the same thing and keep a centralized index of these standards. However the fact that such index exists doesn't hurt the decentralization of Nostr. _At any point the central index can be challenged if it is failing to fulfill the needs of the protocol_ and it can migrate to other places and be maintained by other people.
294
295It can even fork into multiple and then some clients would go one way, others would go another way, and some clients would adhere to both competing standards. This would hurt the simplicity, openness and interoperability of Nostr a little, but everything would still work in the short term.
296
297There is a list of notable Nostr software developers who have commit access to this repository, but that exists mostly for practical reasons, as by the nature of the thing we're dealing with the repository owner can revoke membership and rewrite history as they want -- and if these actions are unjustified or perceived as bad or evil the community must react.
298
299## How this repository works
300
301Standards may emerge in two ways: the first way is that someone starts doing something, then others copy it; the second way is that someone has an idea of a new standard that could benefit multiple clients and the protocol in general without breaking **backwards-compatibility** and the principle of having **a single way of doing things**, then they write that idea and submit it to this repository, other interested parties read it and give their feedback, then once most people reasonably agree we codify that in a NIP which client and relay developers that are interested in the feature can proceed to implement.
302
303These 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.
304
305## Breaking Changes
306
307[Breaking Changes](BREAKING.md)
308
182## License 309## License
183 310
184All NIPs are public domain. 311All NIPs are public domain.
312
313## Contributors
314
315<a align="center" href="https://github.com/nostr-protocol/nips/graphs/contributors">
316 <img src="https://contrib.rocks/image?repo=nostr-protocol/nips" />
317</a>