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.md143
-rw-r--r--02.md24
-rw-r--r--03.md31
-rw-r--r--04.md4
-rw-r--r--05.md6
-rw-r--r--06.md18
-rw-r--r--07.md18
-rw-r--r--08.md2
-rw-r--r--09.md4
-rw-r--r--10.md22
-rw-r--r--11.md183
-rw-r--r--12.md37
-rw-r--r--13.md10
-rw-r--r--14.md10
-rw-r--r--15.md316
-rw-r--r--16.md35
-rw-r--r--18.md2
-rw-r--r--19.md6
-rw-r--r--20.md88
-rw-r--r--21.md2
-rw-r--r--22.md45
-rw-r--r--23.md10
-rw-r--r--24.md42
-rw-r--r--25.md11
-rw-r--r--26.md2
-rw-r--r--27.md2
-rw-r--r--28.md48
-rw-r--r--30.md4
-rw-r--r--31.md2
-rw-r--r--32.md113
-rw-r--r--33.md50
-rw-r--r--36.md28
-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.md191
-rw-r--r--47.md6
-rw-r--r--48.md60
-rw-r--r--50.md4
-rw-r--r--51.md165
-rw-r--r--52.md219
-rw-r--r--53.md51
-rw-r--r--56.md3
-rw-r--r--57.md31
-rw-r--r--58.md16
-rw-r--r--65.md86
-rw-r--r--72.md101
-rw-r--r--75.md85
-rw-r--r--78.md2
-rw-r--r--84.md42
-rw-r--r--89.md101
-rw-r--r--90.md230
-rw-r--r--94.md27
-rw-r--r--96.md302
-rw-r--r--98.md44
-rw-r--r--99.md8
-rw-r--r--README.md286
60 files changed, 2686 insertions, 1218 deletions
diff --git a/01.md b/01.md
index 50e9c9c..c1e3748 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,40 +42,100 @@ 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- No whitespace, line breaks or other unnecessary formatting should be included in the output JSON.
47- No characters except the following should be escaped, and instead should be included verbatim:
48 - A line break, `0x0A`, as `\n`
49 - A double quote, `0x22`, as `\"`
50 - A backslash, `0x5C`, as `\\`
51 - A carriage return, `0x0D`, as `\r`
52 - A tab character, `0x09`, as `\t`
53 - A backspace, `0x08`, as `\b`
54 - A form feed, `0x0C`, as `\f`
55- UTF-8 should be used for encoding.
56
57### Tags
58
59Each tag is an array of strings of arbitrary size, 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`: **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 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`, 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. Relays should manage `<subscription_id>`s independently for each WebSocket connection; even if `<subscription_id>`s are the same string, they should be treated as different subscriptions for different connections. 118`<subscription_id>` is an arbitrary, non-empty string of max length 64 chars. It represents a subscription per connection. Relays MUST manage `<subscription_id>`s independently for each WebSocket connection. `<subscription_id>`s are not guaranteed to be globally unique.
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>,
69 "since": <an integer unix timestamp in seconds, events must be newer than this to pass>, 128 "since": <an integer unix timestamp in seconds, events must be newer than this to pass>,
70 "until": <an integer unix timestamp in seconds, events must be older than this to pass>, 129 "until": <an integer unix timestamp in seconds, events must be older than this to pass>,
71 "limit": <maximum number of events to be returned in the initial query> 130 "limit": <maximum number of events relays SHOULD return 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.
76 135
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. 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.
78 137
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. 138The `ids`, `authors`, `#e` and `#p` filter lists MUST contain exact 64-character lowercase hex values.
80 139
81The `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. 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.
82 141
@@ -84,32 +143,34 @@ All conditions of a filter that are specified must match for an event for it to
84 143
85A `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.
86 145
87The `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 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. 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.
88 147
89### From relay to client: sending events and notices 148### From relay to client: sending events and notices
90 149
91Relays can send 3 types of messages, which must also be JSON arrays, according to the following patterns: 150Relays can send 4 types of messages, which must also be JSON arrays, according to the following patterns:
92 151
93 * `["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.
94 * `["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.
95 * `["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.
96 157
97This 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.
98 159
99`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).
100 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:
101## Basic Event Kinds 162 * `["OK", "b1a649ebe8...", true, ""]`
102 163 * `["OK", "b1a649ebe8...", true, "pow: difficulty 25>=24"]`
103 - `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"]`
104 - `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. 165 * `["OK", "b1a649ebe8...", false, "blocked: you are banned from posting here"]`
105 - `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"]`
106 167 * `["OK", "b1a649ebe8...", false, "rate-limited: slow down there chief"]`
107A 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"]`
108 169 * `["OK", "b1a649ebe8...", false, "pow: difficulty 26 is less than 30"]`
109## Other Notes: 170 * `["OK", "b1a649ebe8...", false, "error: could not connect to the database"]`
110 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:
111- 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"]`
112- The `tags` array can store a case-sensitive tag name 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](10.md) for a detailed description of "e" and "p" tags. 173 * `["CLOSED", "sub1", "unsupported: filter contains unknown elements"]`
113- 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"]`
114- 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"]`
115- When a websocket is closed by the relay with a status code 4000 that means the client shouldn't try to connect again. 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..8b0aee1 100644
--- a/02.md
+++ b/02.md
@@ -1,12 +1,12 @@
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>]`. The `content` can be anything and should be ignored.
12 12
@@ -25,27 +25,29 @@ For example:
25} 25}
26``` 26```
27 27
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. 28Every new following list that gets published overwrites the past ones, so it should contain all entries. Relays and clients SHOULD delete past following lists as soon as they receive a new one.
29
30Whenever new follows are added to an existing list, clients SHOULD append them to the end of the list, so they are stored in chronological order.
29 31
30## Uses 32## Uses
31 33
32### Contact list backup 34### Follow list backup
33 35
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. 36If 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 37
36### Profile discovery and context augmentation 38### Profile discovery and context augmentation
37 39
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. 40A 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 41
40### Relay sharing 42### Relay sharing
41 43
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. 44A 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 45
44### Petname scheme 46### Petname scheme
45 47
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: 48The 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 49
48A user has an internal contact list that says 50A user has an internal follow list that says
49 51
50```json 52```json
51[ 53[
@@ -53,7 +55,7 @@ A user has an internal contact list that says
53] 55]
54``` 56```
55 57
56And receives two contact lists, one from `21df6d143fb96c2ec9d63726bf9edc71` that says 58And receives two follow lists, one from `21df6d143fb96c2ec9d63726bf9edc71` that says
57 59
58```json 60```json
59[ 61[
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..dc232b4 100644
--- a/04.md
+++ b/04.md
@@ -1,10 +1,12 @@
1> __Warning__ `unrecommended`: deprecated in favor of [NIP-44](44.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 56b9156..6437550 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` (`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 `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
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 ee4e372..12ae647 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,24 +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)
23``` 23```
24 24
25### Implementation 25### Implementation
26 26
27- [horse](https://github.com/fiatjaf/horse) (Chrome and derivatives) 27See https://github.com/aljazceru/awesome-nostr#nip-07-browser-extensions.
28- [nos2x](https://github.com/fiatjaf/nos2x) (Chrome and derivatives)
29- [Alby](https://getalby.com) (Chrome and derivatives, Firefox)
30- [Blockcore](https://www.blockcore.net/wallet) (Chrome and derivatives)
31- [nos2x-fox](https://diegogurpegui.com/nos2x-fox/) (Firefox)
32- [Flamingo](https://www.getflamingo.org/) (Chrome and derivatives)
33- [AKA Profiles](https://github.com/neilck/aka-extension) (Chrome, stores multiple keys)
34- [TokenPocket](https://www.tokenpocket.pro/) (Android, IOS, Chrome and derivatives)
35- [Nostrmo](https://github.com/haorendashu/nostrmo_faq#download) (Android, IOS)
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 9dab90f..fbbd6e1 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 and/or NIP-33 `a` tags 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
diff --git a/10.md b/10.md
index 6494796..a434ea0 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,34 @@ 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>]`
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 48
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. 49Those 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 50
51A direct reply to the root of a thread should have a single marked "e" tag of type "root". 51A direct reply to the root of a thread should have a single marked "e" tag of type "root".
52 52
53>This scheme is preferred because it allows events to mention others without confusing them with `<reply-id>` or `<root-id>`. 53>This scheme is preferred because it allows events to mention others without confusing them with `<reply-id>` or `<root-id>`.
54 54
55 55
56## The "p" tag 56## The "p" tag
57Used in a text event contains a list of pubkeys used to record who is involved in a reply thread. 57Used in a text event contains a list of pubkeys used to record who is involved in a reply thread.
58 58
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. 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.
60 60
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`] 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`]
62in no particular order. 62in no particular order.
diff --git a/11.md b/11.md
index ec46b36..45102d7 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-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.
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
135
136- `created_at_upper_limit`: 'created_at' upper limit
131 137
132There may be a cost associated with storing data forever, so relays 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,60 +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### Icon ### 259### Icon
259 260
260A URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape. 261A URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape.
261 262
262```json 263```json
263{ 264{
264...
265 "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg", 265 "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg",
266... 266 ...
267} 267}
268``` 268```
269 269
270### Examples ### 270### Examples
271As of 2 May 2023 the following `curl` command provided these results. 271
272 272As of 2 May 2023 the following command provided these results:
273 >curl -H "Accept: application/nostr+json" https://eden.nostr.land 273
274 274```
275 {"name":"eden.nostr.land", 275~> curl -H "Accept: application/nostr+json" https://eden.nostr.land | jq
276 "description":"Eden Nostr Land - Toronto 1-01", 276
277 "pubkey":"00000000827ffaa94bfea288c3dfce4422c794fbb96625b6b31e9049f729d700", 277{
278 "contact":"me@ricardocabral.io", 278 "description": "nostr.land family of relays (us-or-01)",
279 "supported_nips":[1,2,4,9,11,12,15,16,20,22,26,28,33,40], 279 "name": "nostr.land",
280 "supported_nip_extensions":["11a"], 280 "pubkey": "52b4a076bcbbbdc3a1aefa3735816cf74993b1b8db202b01c883c58be7fad8bd",
281 "software":"git+https://github.com/Cameri/nostream.git", 281 "software": "custom",
282 "version":"1.22.6", 282 "supported_nips": [
283 "limitation":{"max_message_length":1048576, 283 1,
284 "max_subscriptions":10, 284 2,
285 "max_filters":2500, 285 4,
286 "max_limit":5000, 286 9,
287 "max_subid_length":256, 287 11,
288 "min_prefix":4, 288 12,
289 "max_event_tags":2500, 289 16,
290 "max_content_length":65536, 290 20,
291 "min_pow_difficulty":0, 291 22,
292 "auth_required":false, 292 28,
293 "payment_required":true}, 293 33,
294 "payments_url":"https://eden.nostr.land/invoices", 294 40
295 "fees":{"admission":[{"amount":5000000,"unit":"msats"}], 295 ],
296 "publication":[]}}, 296 "version": "1.0.1",
297 "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg" 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 7d1f46e..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. Note that tag names are case-sensitive.
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..53c4d1b 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", "21"]
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 7384394..480c4c5 100644
--- a/14.md
+++ b/14.md
@@ -4,16 +4,18 @@ NIP-14
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 f8df328..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. | [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.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. | [NIP09](https://github.com/nostr-protocol/nips/blob/master/09.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 8ef4af4..0032083 100644
--- a/16.md
+++ b/16.md
@@ -4,37 +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
23If two events have the same timestamp, the event with the lowest id (first in lexical order) SHOULD be retained, and the other discarded.
24
25Ephemeral Events
26----------------
27An *ephemeral event* is defined as an event with a kind `20000 <= n < 30000`.
28Upon an ephemeral event being received, the relay SHOULD send it to all clients with a matching filter, and MUST NOT store it.
29
30Client Behavior
31---------------
32
33Clients 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.
34
35Suggested Use Cases
36-------------------
37
38* States: An application may create a state event that is replaced every time a new state is set (such as statuses)
39* Typing indicators: A chat application may use ephemeral events as a typing indicator.
40* Messaging: Two pubkeys can message over nostr using ephemeral events.
diff --git a/18.md b/18.md
index 75c4100..ba96c89 100644
--- a/18.md
+++ b/18.md
@@ -4,7 +4,7 @@ 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` event that is used to signal to followers 9A repost is a `kind 6` event that is used to signal to followers
10that a `kind 1` text note is worth reading. 10that a `kind 1` text note is worth reading.
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 7a06b0e..382df83 100644
--- a/23.md
+++ b/23.md
@@ -4,9 +4,9 @@ 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". `kind:30024` has the same structure as `kind:30023` and is used to save long form drafts. 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
@@ -20,7 +20,7 @@ The `.content` of these events should be a string text in Markdown syntax. To ma
20 20
21### Metadata 21### Metadata
22 22
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"` 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.
24 24
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: 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:
26 26
@@ -31,11 +31,11 @@ Other metadata fields can be added as tags to the event as necessary. Here we st
31 31
32### Editability 32### Editability
33 33
34These 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.
35 35
36### Linking 36### Linking
37 37
38The 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.
39 39
40### References 40### References
41 41
diff --git a/24.md b/24.md
new file mode 100644
index 0000000..d444a4b
--- /dev/null
+++ b/24.md
@@ -0,0 +1,42 @@
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
20### Deprecated fields
21
22These are fields that should be ignored or removed when found in the wild:
23
24 - `displayName`: use `display_name` instead.
25 - `username`: use `name` instead.
26
27kind 3
28======
29
30These are extra fields not specified in NIP-02 that may be present in the stringified JSON of contacts events:
31
32### Deprecated fields
33
34 - `{<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.
35
36tags
37====
38
39These tags may be present in multiple event kinds. Whenever a different meaning is not specified by some more specific NIP, they have the following meanings:
40
41 - `r`: a web URL the event is referring to in some way
42 - `title`: title of the event
diff --git a/25.md b/25.md
index 86ce763..3b4aa59 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".
@@ -19,7 +19,8 @@ dislikes 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, or [NIP-30](30.md) custom 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----
@@ -33,6 +34,9 @@ The last `e` tag MUST be the `id` of the note that is being reacted to.
33 34
34The last `p` tag MUST be the `pubkey` of the event being reacted to. 35The last `p` tag MUST be the `pubkey` of the event being reacted to.
35 36
37The reaction event MAY include a `k` tag with the stringified kind number
38of the reacted event as its value.
39
36Example code 40Example code
37 41
38```swift 42```swift
@@ -42,6 +46,7 @@ func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> Nost
42 } 46 }
43 tags.append(["e", liked.id]) 47 tags.append(["e", liked.id])
44 tags.append(["p", liked.pubkey]) 48 tags.append(["p", liked.pubkey])
49 tags.append(["k", liked.kind])
45 let ev = NostrEvent(content: "+", pubkey: pubkey, kind: 7, tags: tags) 50 let ev = NostrEvent(content: "+", pubkey: pubkey, kind: 7, tags: tags)
46 ev.calculate_id() 51 ev.calculate_id()
47 ev.sign(privkey: privkey) 52 ev.sign(privkey: privkey)
diff --git a/26.md b/26.md
index 59cf807..86c46e1 100644
--- a/26.md
+++ b/26.md
@@ -4,7 +4,7 @@ NIP-26
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
diff --git a/27.md b/27.md
index 6d76120..efd2c12 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
diff --git a/28.md b/28.md
index 62ab398..2dcf800 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
@@ -27,8 +27,8 @@ In the channel creation `content` field, Client SHOULD include basic channel met
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\"}",
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 33 replaceable events, where the information is used to update the metadata, without modifying the event id for the channel. Only the most recent kind 41 is needed to be stored. 40Clients and relays SHOULD handle kind 41 events similar to kind 33 replaceable events, where the information is used to update the metadata, without modifying the event id for the channel.Only the most recent kind 41 is needed to be stored.
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
@@ -53,9 +53,9 @@ Clients SHOULD use [NIP-10](10.md) marked "e" tags to recommend a relay.
53 53
54```json 54```json
55{ 55{
56 "content": "{\"name\": \"Updated Demo Channel\", \"about\": \"Updating a test channel.\", \"picture\": \"https://placekitten.com/201/201\"}", 56 "content": "{\"name\": \"Updated Demo Channel\", \"about\": \"Updating a test channel.\", \"picture\": \"https://placekitten.com/201/201\"}",
57 "tags": [["e", <channel_create_event_id>, <relay-url>]], 57 "tags": [["e", <channel_create_event_id>, <relay-url>]],
58 ... 58 ...
59} 59}
60``` 60```
61 61
@@ -72,9 +72,9 @@ Root message:
72 72
73```json 73```json
74{ 74{
75 "content": <string>, 75 "content": <string>,
76 "tags": [["e", <kind_40_event_id>, <relay-url>, "root"]], 76 "tags": [["e", <kind_40_event_id>, <relay-url>, "root"]],
77 ... 77 ...
78} 78}
79``` 79```
80 80
@@ -82,14 +82,14 @@ Reply to another message:
82 82
83```json 83```json
84{ 84{
85 "content": <string>, 85 "content": <string>,
86 "tags": [ 86 "tags": [
87 ["e", <kind_40_event_id>, <relay-url>, "root"], 87 ["e", <kind_40_event_id>, <relay-url>, "root"],
88 ["e", <kind_42_event_id>, <relay-url>, "reply"], 88 ["e", <kind_42_event_id>, <relay-url>, "reply"],
89 ["p", <pubkey>, <relay-url>], 89 ["p", <pubkey>, <relay-url>],
90 ... 90 ...
91 ], 91 ],
92 ... 92 ...
93} 93}
94``` 94```
95 95
@@ -108,9 +108,9 @@ Clients MAY hide event 42s for other users other than the user who sent the even
108 108
109```json 109```json
110{ 110{
111 "content": "{\"reason\": \"Dick pic\"}", 111 "content": "{\"reason\": \"Dick pic\"}",
112 "tags": [["e", <kind_42_event_id>]], 112 "tags": [["e", <kind_42_event_id>]],
113 ... 113 ...
114} 114}
115``` 115```
116 116
@@ -126,9 +126,9 @@ Clients MAY hide event 42s for users other than the user who sent the event 44.
126 126
127```json 127```json
128{ 128{
129 "content": "{\"reason\": \"Posting dick pics\"}", 129 "content": "{\"reason\": \"Posting dick pics\"}",
130 "tags": [["p", <pubkey>]], 130 "tags": [["p", <pubkey>]],
131 ... 131 ...
132} 132}
133``` 133```
134 134
diff --git a/30.md b/30.md
index ffc5aeb..c2f8bb0 100644
--- a/30.md
+++ b/30.md
@@ -4,9 +4,9 @@ NIP-30
4Custom Emoji 4Custom Emoji
5------------ 5------------
6 6
7`draft` `optional` `author:alexgleason` 7`draft` `optional`
8 8
9Custom emoji may be added to **kind 0** and **kind 1** events by including one or more `"emoji"` tags, in the form: 9Custom emoji may be added to **kind 0**, **kind 1**, **kind 7** ([NIP-25](25.md)) and **kind 30315** ([NIP-38](38.md)) events by including one or more `"emoji"` tags, in the form:
10 10
11``` 11```
12["emoji", <shortcode>, <image-url>] 12["emoji", <shortcode>, <image-url>]
diff --git a/31.md b/31.md
index e77ae34..ee92052 100644
--- a/31.md
+++ b/31.md
@@ -4,7 +4,7 @@ NIP-31
4Dealing with unknown event kinds 4Dealing with unknown event kinds
5-------------------------------- 5--------------------------------
6 6
7`draft` `optional` `author:pablof7z` `author:fiatjaf` 7`draft` `optional`
8 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. 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 10
diff --git a/32.md b/32.md
index ddd364a..be4e872 100644
--- a/32.md
+++ b/32.md
@@ -4,52 +4,40 @@ NIP-32
4Labeling 4Labeling
5--------- 5---------
6 6
7`draft` `optional` `author:staab` `author:gruruya` `author:s3x-jay` 7`draft` `optional`
8 8
9A label is a `kind 1985` event that is used to label other entities. This supports a number of use cases, from distributed moderation and content recommendations to reviews and ratings. 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.
10 11
11Label Target 12This NIP introduces two new tags:
12----
13 13
14The label event MUST include one or more tags representing the object or objects being 14- `L` denotes a label namespace
15labeled: `e`, `p`, `a`, `r`, or `t` tags. This allows for labeling of events, people, relays, 15- `l` denotes a label
16or topics respectively. As with NIP-01, a relay hint SHOULD be included when using `e` and
17`p` tags.
18 16
19Label Tag 17Label Namespace Tag
20---- 18----
21 19
22This NIP introduces a new tag `l` which denotes a label, and a new `L` tag which denotes a label namespace. 20An `L` tag can be any string, but publishers SHOULD ensure they are unambiguous by using a well-defined namespace
23A label MUST include a mark matching an `L` tag. `L` tags refer to a tag type within nostr, or a nomenclature 21(such as an ISO standard) or reverse domain name notation.
24external to nostr defined either formally or by convention. Any string can be a namespace, but publishers SHOULD
25ensure they are unambiguous by using a well-defined namespace (such as an ISO standard) or reverse domain name notation.
26 22
27Namespaces starting with `#` indicate that the label target should be associated with the label's value. 23`L` tags are REQUIRED in order to support searching by namespace rather than by a specific tag. The special `ugc`
28This is a way of attaching standard nostr tags to events, pubkeys, relays, urls, etc. 24("user generated content") namespace MAY be used when the label content is provided by an end user.
29
30Some examples:
31
32- `["l", "footstr", "#t"]` - the publisher thinks the given entity should have the `footstr` topic applied.
33- `["l", "<pubkey>", "#p"]` - the publisher thinks the given entity is related to `<pubkey>`
34- `["l", "IT-MI", "ISO-3166-2"]` - Milano, Italy using ISO 3166-2.
35- `["l", "VI-hum", "com.example.ontology"]` - Violence toward a human being as defined by ontology.example.com.
36 25
37`L` tags containing the label namespaces MUST be included in order to support searching by 26`L` tags starting with `#` indicate that the label target should be associated with the label's value.
38namespace rather than by a specific tag. The special `ugc` ("user generated content") namespace 27This is a way of attaching standard nostr tags to events, pubkeys, relays, urls, etc.
39MAY be used when the label content is provided by an end user.
40 28
41`l` and `L` tags MAY be added to other event kinds to support self-reporting. For events 29Label Tag
42with a kind other than 1985, labels refer to the event itself. 30----
43 31
44Label Annotations 32An `l` tag's value can be any string. `l` tags MUST include a `mark` matching an `L` tag value in the same event.
45-----
46 33
47A label tag MAY include a 4th positional element detailing extra metadata about the label in question. This string 34Label Target
48should be a json-encoded object. Any key MAY be used, but the following are recommended: 35----
49 36
50- `quality` may have a value of 0 to 1. This allows for an absolute, granular scale that can be represented in any way (5 stars, color scale, etc). 37The label event MUST include one or more tags representing the object or objects being
51- `confidence` may have a value of 0 to 1. This indicates the certainty which the author has about their rating. 38labeled: `e`, `p`, `a`, `r`, or `t` tags. This allows for labeling of events, people, relays,
52- `context` may be an array of urls (including NIP-21 urls) indicating other context that should be considered when interpreting labels. 39or topics respectively. As with NIP-01, a relay hint SHOULD be included when using `e` and
40`p` tags.
53 41
54Content 42Content
55------- 43-------
@@ -57,6 +45,12 @@ Content
57Labels should be short, meaningful strings. Longer discussions, such as for a review, or an 45Labels should be short, meaningful strings. Longer discussions, such as for a review, or an
58explanation of why something was labeled the way it was, should go in the event's `content` field. 46explanation of why something was labeled the way it was, should go in the event's `content` field.
59 47
48Self-Reporting
49-------
50
51`l` and `L` tags MAY be added to other event kinds to support self-reporting. For events
52with a kind other than 1985, labels refer to the event itself.
53
60Example events 54Example events
61-------------- 55--------------
62 56
@@ -71,36 +65,64 @@ A suggestion that multiple pubkeys be associated with the `permies` topic.
71 ["p", <pubkey1>, <relay_url>], 65 ["p", <pubkey1>, <relay_url>],
72 ["p", <pubkey2>, <relay_url>] 66 ["p", <pubkey2>, <relay_url>]
73 ], 67 ],
74 "content": "",
75 ... 68 ...
76} 69}
77``` 70```
78 71
79A review of a relay. 72A report flagging violence toward a human being as defined by ontology.example.com.
80 73
81```json 74```json
82{ 75{
83 "kind": 1985, 76 "kind": 1985,
84 "tags": [ 77 "tags": [
85 ["L", "com.example.ontology"], 78 ["L", "com.example.ontology"],
86 ["l", "relay/review", "com.example.ontology", "{\"quality\": 0.1}"], 79 ["l", "VI-hum", "com.example.ontology"],
87 ["r", <relay_url>] 80 ["p", <pubkey1>, <relay_url>],
81 ["p", <pubkey2>, <relay_url>]
82 ],
83 ...
84}
85```
86
87A moderation suggestion for a chat event.
88
89```json
90{
91 "kind": 1985,
92 "tags": [
93 ["L", "nip28.moderation"],
94 ["l", "approve", "nip28.moderation"],
95 ["e", <kind40_event_id>, <relay_url>]
88 ], 96 ],
89 "content": "This relay is full of mean people.",
90 ... 97 ...
91} 98}
92``` 99```
93 100
94Publishers can self-label by adding `l` tags to their own non-1985 events. 101Assignment of a license to an event.
102
103```json
104{
105 "kind": 1985,
106 "tags": [
107 ["L", "license"],
108 ["l", "MIT", "license"],
109 ["e", <event_id>, <relay_url>]
110 ],
111 ...
112}
113```
114
115Publishers can self-label by adding `l` tags to their own non-1985 events. In this case, the kind 1 event's author
116is labeling their note as being related to Milan, Italy using ISO 3166-2.
95 117
96```json 118```json
97{ 119{
98 "kind": 1, 120 "kind": 1,
99 "tags": [ 121 "tags": [
100 ["L", "com.example.ontology"], 122 ["L", "ISO-3166-2"],
101 ["l", "IL-frd", "com.example.ontology"] 123 ["l", "IT-MI", "ISO-3166-2"]
102 ], 124 ],
103 "content": "Send me 100 sats and I'll send you 200 back", 125 "content": "It's beautiful here in Milan!",
104 ... 126 ...
105} 127}
106``` 128```
@@ -124,3 +146,8 @@ Vocabularies MAY choose to fully qualify all labels within a namespace (for exam
124formal vocabularies that should not be confused with another namespace when querying 146formal vocabularies that should not be confused with another namespace when querying
125without an `L` tag. For these vocabularies, all labels SHOULD include the namespace 147without an `L` tag. For these vocabularies, all labels SHOULD include the namespace
126(rather than mixing qualified and unqualified labels). 148(rather than mixing qualified and unqualified labels).
149
150A good heuristic for whether a use case fits this NIP is whether labels would ever be unique.
151For example, many events might be labeled with a particular place, topic, or pubkey, but labels
152with specific values like "John Doe" or "3.18743" are not labels, they are values, and should
153be handled in some other way.
diff --git a/33.md b/33.md
index 5128bec..337a1f9 100644
--- a/33.md
+++ b/33.md
@@ -4,52 +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 can be any string and 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
21If two events have the same timestamp, the event with the lowest id (first in lexical order) SHOULD be retained, and the other discarded.
22
23A missing or a `d` tag with no value should be interpreted equivalent to a `d` tag with the
24value as an empty string. Events from the same author with any of the following `tags`
25replace each other:
26
27* `"tags":[["d",""]]`
28* `"tags":[]`: implicit `d` tag with empty value
29* `"tags":[["d"]]`: implicit empty value `""`
30* `"tags":[["d",""],["d","not empty"]]`: only first `d` tag is considered
31* `"tags":[["d"],["d","some value"]]`: only first `d` tag is considered
32* `"tags":[["e"]]`: same as no tags
33* `"tags":[["d","","1"]]`: only the first value is considered (`""`)
34
35Clients 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.
36
37Referencing and tagging
38-----------------------
39
40Normally (as per NIP-01, NIP-12) the `"p"` tag is used for referencing public keys and the
41`"e"` tag for referencing event ids and the `note`, `npub`, `nprofile` or `nevent` are their
42equivalents for event tags (i.e. an `nprofile` is generally translated into a tag
43`["p", "<event hex id>", "<relay url>"]`).
44
45To support linking to parameterized replaceable events, the `naddr` code is introduced on
46NIP-19. It includes the public key of the event author and the `d` tag (and relays) such that
47the referenced combination of public key and `d` tag can be found.
48
49The equivalent in `tags` to the `naddr` code is the tag `"a"`, comprised of `["a", "<kind>:<pubkey>:<d-identifier>", "<relay url>"]`.
50
51Client Behavior
52---------------
53
54Clients SHOULD use the `supported_nips` field to learn if a relay supports this NIP.
55Clients 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/36.md b/36.md
index 6d1cf63..b10262c 100644
--- a/36.md
+++ b/36.md
@@ -4,7 +4,7 @@ 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.
@@ -24,18 +24,18 @@ options:
24 24
25```json 25```json
26{ 26{
27 "pubkey": "<pub-key>", 27 "pubkey": "<pub-key>",
28 "created_at": 1000000000, 28 "created_at": 1000000000,
29 "kind": 1, 29 "kind": 1,
30 "tags": [ 30 "tags": [
31 ["t", "hastag"], 31 ["t", "hastag"],
32 ["L", "content-warning"], 32 ["L", "content-warning"],
33 ["l", "reason", "content-warning"], 33 ["l", "reason", "content-warning"],
34 ["L", "social.nos.ontology"], 34 ["L", "social.nos.ontology"],
35 ["l", "NS-nud", "social.nos.ontology"], 35 ["l", "NS-nud", "social.nos.ontology"],
36 ["content-warning", "reason"] /* reason is optional */ 36 ["content-warning", "<optional reason>"]
37 ], 37 ],
38 "content": "sensitive content with #hastag\n", 38 "content": "sensitive content with #hastag\n",
39 "id": "<event-id>" 39 "id": "<event-id>"
40} 40}
41``` 41```
diff --git a/38.md b/38.md
new file mode 100644
index 0000000..911d5b1
--- /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
49# Client behavior
50
51Clients MAY display this next to the username on posts or profiles to provide live user status information.
52
53# Use Cases
54
55* Calendar nostr apps that update your general status when you're in a meeting
56* Nostr Nests that update your general status with a link to the nest when you join
57* Nostr music streaming services that update your music status when you're listening
58* Podcasting apps that update your music status when you're listening to a podcast, with a link for others to listen as well
59* Clients can use the system media player to update playing music status
60
61The `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.
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..05247c5 100644
--- a/46.md
+++ b/46.md
@@ -2,161 +2,98 @@ NIP-46
2====== 2======
3 3
4Nostr Connect 4Nostr Connect
5------------------------ 5-------------
6 6
7`draft` `optional` `author:tiero` `author:giowe` `author:vforvalerio87` 7`draft` `optional`
8 8
9## Rationale 9This NIP describes a method for 2-way communication between a **remote signer** and a normal 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.
10 10
11Private keys should be exposed to as few systems - apps, operating systems, devices - as possible as each system adds to the attack surface. 11## Signer Discovery
12 12
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. 13The client always starts by generating a random key which is used to communicate with the signer, then it one of the methods below is used to allow the client to know what is the signer public key for the session and which relays to use.
14 14
15### Started by the signer (nsecBunker)
15 16
16## Terms 17The remote signer generates a connection token in the form
17
18* **App**: Nostr app on any platform that *requires* to act on behalf of a nostr account.
19* **Signer**: Nostr app that holds the private key of a nostr account and *can sign* on its behalf.
20 18
19```
20<npub1...>#<optional-secret>?relay=wss://...&relay=wss://...
21```
21 22
22## `TL;DR` 23The user copies that token and pastes it in the client UI somehow. Then the client can send events of kind `24133` to the specified relays and wait for responses from the remote signer.
23 24
25### Started by the client
24 26
25**App** and **Signer** sends ephemeral encrypted messages to each other using kind `24133`, using a relay of choice. 27The client generates a QR code in the following form (URL-encoded):
26 28
27App prompts the Signer to do things such as fetching the public key or signing events. 29```
30nostrconnect://<client-key-hex>?relay=wss://...&metadata={"name":"...", "url": "...", "description": "..."}
31```
28 32
29The `content` field must be an encrypted JSONRPC-ish **request** or **response**. 33The signer scans the QR code and sends a `connect` message to the client in the specified relays.
30 34
31## Signer Protocol 35## Event payloads
32 36
33### Messages 37Event payloads are [NIP-04](04.md)-encrypted JSON blobs that look like JSONRPC messages (their format is specified inside the `.content` of the event formats below).
34 38
35#### Request 39Events sent by the client to the remote signer have the following format:
36 40
37```json 41```js
38{ 42{
39 "id": <random_string>, 43 "pubkey": "<client-key-hex>"
40 "method": <one_of_the_methods>, 44 "kind": 24133,
41 "params": [<anything>, <else>] 45 "tags": [
46 ["p", "<signer-key-hex>"]
47 ],
48 "content": "nip04_encrypted_json({id: <random-string>, method: <see-below>, params: [array_of_strings]})",
49 ...
42} 50}
43``` 51```
44 52
45#### Response 53And the events the remote signer sends to the client have the following format:
46 54
47```json 55```js
48{ 56 "pubkey": "<signer-key-hex>"
49 "id": <request_id>, 57 "kind": 24133,
50 "result": <anything>, 58 "tags": [
51 "error": <reason> 59 ["p", "<client-key-hex>"]
52} 60 ],
61 "content": "nip04_encrypted_json({id: <request-id>, result: <string>, error: <reason-string>})",
62 ...
53``` 63```
54 64
55### Methods 65The signer key will always be the key of the user who controls the signer device.
56
57
58#### Mandatory
59 66
60These are mandatory methods the remote signer app MUST implement: 67### Methods
61 68
62- **describe** 69- **connect**
63 - params [] 70 - params: [`pubkey`, `secret`]
64 - result `["describe", "get_public_key", "sign_event", "connect", "disconnect", "delegate", ...]` 71 - result: `"ack"`
65- **get_public_key** 72- **get_public_key**
66 - params [] 73 - params: []
67 - result `pubkey` 74 - result: `pubkey-hex`
68- **sign_event** 75- **sign_event**
69 - params [`event`] 76 - params: [`event`]
70 - result `event_with_signature` 77 - result: `json_string(event_with_pubkey_id_and_signature)`
71
72#### optional
73
74
75- **connect**
76 - params [`pubkey`]
77- **disconnect**
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** 78- **get_relays**
83 - params [] 79 - params: []
84 - result `{ [url: string]: {read: boolean, write: boolean} }` 80 - result: `json_string({[url: string]: {read: boolean, write: boolean}})`
85- **nip04_encrypt** 81- **nip04_encrypt**
86 - params [`pubkey`, `plaintext`] 82 - params: [`third-party-pubkey`, `plaintext`]
87 - result `nip4 ciphertext` 83 - result: `nip04-ciphertext`
88- **nip04_decrypt** 84- **nip04_decrypt**
89 - params [`pubkey`, `nip4 ciphertext`] 85 - params: [`third-party-pubkey`, `nip04-ciphertext`]
90 - result [`plaintext`] 86 - result: `plaintext`
91 87- **nip44_get_key**
92 88 - params: [`third-party-pubkey`]
93NOTICE: `pubkey` and `signature` are hex-encoded strings. 89 - result: `nip44-conversation-key`
94 90- **nip44_encrypt**
95 91 - params: [`third-party-pubkey`, `plaintext`]
96### Nostr Connect URI 92 - result: `nip44-ciphertext`
97 93- **nip44_decrypt**
98**Signer** discovers **App** by scanning a QR code, clicking on a deep link or copy-pasting an URI. 94 - params: [`third-party-pubkey`, `nip44-ciphertext`]
99 95 - result: `plaintext`
100The **App** generates a special URI with prefix `nostrconnect://` and base path the hex-encoded `pubkey` with the following querystring parameters **URL encoded** 96- **ping**
101 97 - params: []
102- `relay` URL of the relay of choice where the **App** is connected and the **Signer** must send and listen for messages. 98 - result: `"pong"`
103- `metadata` metadata JSON of the **App**
104 - `name` human-readable name of the **App**
105 - `url` (optional) URL of the website requesting the connection
106 - `description` (optional) description of the **App**
107 - `icons` (optional) array of URLs for icons of the **App**.
108
109#### JavaScript
110
111```js
112const uri = `nostrconnect://<pubkey>?relay=${encodeURIComponent("wss://relay.damus.io")}&metadata=${encodeURIComponent(JSON.stringify({"name": "Example"}))}`
113```
114
115#### Example
116```sh
117nostrconnect://b889ff5b1513b641e2a139f661a661364979c5beee91842f8f0ef42ab558e9d4?relay=wss%3A%2F%2Frelay.damus.io&metadata=%7B%22name%22%3A%22Example%22%7D
118```
119
120
121
122## Flows
123
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`.
125
126### Connect
127
1281. User clicks on **"Connect"** button on a website or scan it with a QR code
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
133### Disconnect (from App)
134
1351. User clicks on **"Disconnect"** button on the **App**
1362. The **App** will send a message to the **Signer** with a `disconnect` request
1373. The **Signer** will send a message to ACK the `disconnect` request
138
139### Disconnect (from Signer)
140
1411. User clicks on **"Disconnect"** button on the **Signer**
1422. The **Signer** will send a message to the **App** with a `disconnect` request
143
144
145### Get Public Key
146
1471. The **App** will send a message to the **Signer** with a `get_public_key` request
1483. The **Signer** will send back a message with the public key as a response to the `get_public_key` request
149
150### Sign Event
151
1521. The **App** will send a message to the **Signer** with a `sign_event` request along with the **event** to be signed
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
156### Delegate
157
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.
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
162 99
diff --git a/47.md b/47.md
index 4cef610..9033847 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
@@ -403,7 +403,7 @@ Response:
403## Example pay invoice flow 403## Example pay invoice flow
404 404
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. 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.
4061. **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.
4072. **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.
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. 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.
409 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/50.md b/50.md
index 5bda355..9d1a54c 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
@@ -41,7 +41,7 @@ implementation details between relays.
41Clients MAY verify that events returned by a relay match the specified query in a way that suits the 41Clients MAY verify that events returned by a relay match the specified query in a way that suits the
42client's use case, and MAY stop querying relays that have low precision. 42client's use case, and MAY stop querying relays that have low precision.
43 43
44Relays SHOULD exclude spam from search results by default if they supports some form of spam filtering. 44Relays SHOULD exclude spam from search results by default if they support some form of spam filtering.
45 45
46## Extensions 46## Extensions
47 47
diff --git a/51.md b/51.md
index 80cc09e..9a1639f 100644
--- a/51.md
+++ b/51.md
@@ -2,111 +2,114 @@ 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[
32 ["p", "9ec7a778167afb1d30c4833de9322da0c08ba71a69e1911d5578d3144bb56437"],
33 ["p", "8c0da4862130283ff9e67d889df264177a508974e2feb96de139804ea66d6168"]
34]
35```
36 22
37Then the user would create a 'Mute' list event like below: 23| name | kind | description | expected tag items |
24| --- | --- | --- | --- |
25| Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags), `"word"` (lowercase string), `"e"` (threads) |
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| Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) |
33| Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) |
38 34
39```json 35## Sets
40{
41 "kind": 10000,
42 "tags": [
43 ["p", "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"],
44 ["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"],
45 ],
46 "content": "VezuSvWak++ASjFMRqBPWS3mK5pZ0vRLL325iuIL4S+r8n9z+DuMau5vMElz1tGC/UqCDmbzE2kwplafaFo/FnIZMdEj4pdxgptyBV1ifZpH3TEF6OMjEtqbYRRqnxgIXsuOSXaerWgpi0pm+raHQPseoELQI/SZ1cvtFqEUCXdXpa5AYaSd+quEuthAEw7V1jP+5TDRCEC8jiLosBVhCtaPpLcrm8HydMYJ2XB6Ixs=?iv=/rtV49RFm0XyFEwG62Eo9A==",
47 ...other fields
48}
49```
50 36
37Sets 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.
51 38
52## Parameterized Replaceable List Event Example 39For 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.
53 40
54Lets say a user wants to create a 'Categorized People' list of `nostr` people and has keys: 41Aside 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.
55```
56priv: fb505c65d4df950f5d28c9e4d285ee12ffaf315deef1fc24e3c7cd1e7e35f2b1
57pub: b1a5c93edcc8d586566fde53a20bdb50049a97b15483cb763854e57016e0fa3d
58```
59The user wants to publicly include these users:
60 42
61```json 43| name | kind | description | expected tag items |
62["p", "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"], 44| --- | --- | --- | --- |
63["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"] 45| Follow sets | 30000 | categorized groups of users a client may choose to check out in different circumstances | `"p"` (pubkeys) |
64``` 46| Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during various operations | `"relay"` (relay URLs) |
65and privately include these users (below is the JSON that would be encrypted and placed in the event content): 47| 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) |
48| 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) |
49| Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"a"` (kind:34235 videos) |
50| Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) |
51| Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) |
66 52
67```json 53## Deprecated standard lists
68[ 54
69 ["p", "9ec7a778167afb1d30c4833de9322da0c08ba71a69e1911d5578d3144bb56437"], 55Some clients have used these lists in the past, but they should work on transitioning to the [standard formats](#standard-lists) above.
70 ["p", "8c0da4862130283ff9e67d889df264177a508974e2feb96de139804ea66d6168"] 56
71] 57| kind | "d" tag | use instead |
72``` 58| --- | --- | --- |
59| 30000 | `"mute"` | kind 10000 _mute list_ |
60| 30001 | `"pin"` | kind 10001 _pin list_ |
61| 30001 | `"bookmark"` | kind 10003 _bookmarks list_ |
62| 30001 | `"communities"` | kind 10004 _communities list_ |
73 63
74Then the user would create a 'Categorized People' list event like below: 64## Examples
65
66### A _mute list_ with some public items and some encrypted items
75 67
76```json 68```json
77{ 69{
78 "kind": 30000, 70 "id": "a92a316b75e44cfdc19986c634049158d4206fcc0b7b9c7ccbcdabe28beebcd0",
71 "pubkey": "854043ae8f1f97430ca8c1f1a090bdde6488bd5115c7a45307a2a212750ae4cb",
72 "created_at": 1699597889,
73 "kind": 10000,
79 "tags": [ 74 "tags": [
80 ["d", "nostr"], 75 ["p", "07caba282f76441955b695551c3c5c742e5b9202a3784780f8086fdcdc1da3a9"],
81 ["p", "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"], 76 ["p", "a55c15f5e41d5aebd236eca5e0142789c5385703f1a7485aa4b38d94fd18dcc4"]
82 ["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"],
83 ], 77 ],
84 "content": "VezuSvWak++ASjFMRqBPWS3mK5pZ0vRLL325iuIL4S+r8n9z+DuMau5vMElz1tGC/UqCDmbzE2kwplafaFo/FnIZMdEj4pdxgptyBV1ifZpH3TEF6OMjEtqbYRRqnxgIXsuOSXaerWgpi0pm+raHQPseoELQI/SZ1cvtFqEUCXdXpa5AYaSd+quEuthAEw7V1jP+5TDRCEC8jiLosBVhCtaPpLcrm8HydMYJ2XB6Ixs=?iv=/rtV49RFm0XyFEwG62Eo9A==", 78 "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==",
85 ...other fields 79 "sig": "1173822c53261f8cffe7efbf43ba4a97a9198b3e402c2a1df130f42a8985a2d0d3430f4de350db184141e45ca844ab4e5364ea80f11d720e36357e1853dba6ca"
86} 80}
87``` 81```
88 82
89## List Event Kinds 83### A _curation set_ of articles and notes about yaks
90
91| kind | list type |
92| ------ | ----------------------- |
93| 10000 | Mute |
94| 10001 | Pin |
95| 30000 | Categorized People |
96| 30001 | Categorized Bookmarks |
97
98### Mute List
99
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.
101
102### Pin List
103
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.
105 84
106### Categorized People List 85```json
107 86{
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). 87 "id": "567b41fc9060c758c4216fe5f8d3df7c57daad7ae757fa4606f0c39d4dd220ef",
88 "pubkey": "d6dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c",
89 "created_at": 1695327657,
90 "kind": 30004,
91 "tags": [
92 ["d", "jvdy9i4"],
93 ["name", "Yaks"],
94 ["picture", "https://cdn.britannica.com/40/188540-050-9AC748DE/Yak-Himalayas-Nepal.jpg"],
95 ["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."],
96 ["a", "30023:26dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:95ODQzw3ajNoZ8SyMDOzQ"],
97 ["a", "30023:54af95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:1-MYP8dAhramH9J5gJWKx"],
98 ["a", "30023:f8fe95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:D2Tbd38bGrFvU0bIbvSMt"],
99 ["e", "d78ba0d5dce22bfff9db0a9e996c9ef27e2c91051de0c4e1da340e0326b4941e"]
100 ],
101 "content": "",
102 "sig": "a9a4e2192eede77e6c9d24ddfab95ba3ff7c03fbd07ad011fff245abea431fb4d3787c2d04aad001cb039cb8de91d83ce30e9a94f82ac3c5a2372aa1294a96bd"
103}
104```
109 105
110### Categorized Bookmarks List 106## Encryption process pseudocode
111 107
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. 108```scala
109val private_items = [
110 ["p", "07caba282f76441955b695551c3c5c742e5b9202a3784780f8086fdcdc1da3a9"],
111 ["a", "a55c15f5e41d5aebd236eca5e0142789c5385703f1a7485aa4b38d94fd18dcc4"],
112]
113val base64blob = nip04.encrypt(json.encode_to_string(private_items))
114event.content = base64blob
115```
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
index c5f2704..fad2622 100644
--- a/53.md
+++ b/53.md
@@ -4,19 +4,19 @@ NIP-53
4Live Activities 4Live Activities
5--------------- 5---------------
6 6
7`draft` `optional` `author:vitorpamplona` `author:v0l` 7`draft` `optional`
8 8
9## Abstract 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 10
11Service providers want to offer live activities to the Nostr network in such a way that participants can easily logged and queried by clients. This NIP describes a general framework to advertise the involvement of pubkeys in such live activities. 11## Concepts
12 12
13# Live Event 13### Live Event
14 14
15A special event with `kind:30311` "Live Event" is defined as a [NIP-33: Parameterized Replaceable Events](33.md) 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. 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 16
17For example: 17For example:
18 18
19```js 19```json
20{ 20{
21 "kind": 30311, 21 "kind": 30311,
22 "tags": [ 22 "tags": [
@@ -38,52 +38,50 @@ For example:
38 ["relays", "wss://one.com", "wss://two.com", ...] 38 ["relays", "wss://one.com", "wss://two.com", ...]
39 ], 39 ],
40 "content": "", 40 "content": "",
41 ...other fields 41 ...
42} 42}
43``` 43```
44 44
45A distinct `d` tag should be used for each activity. All other tags are optional. 45A distinct `d` tag should be used for each activity. All other tags are optional.
46 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). 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 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. 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 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` 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 52
53The activity MUST be linked to using the NIP-19 naddr code along with the "a" tag (see [NIP-33](33.md) and [NIP-19](19.md)). 53The activity MUST be linked to using the [NIP-19](19.md) `naddr` code along with the `a` tag.
54 54
55## Proof of Agreement to Participate 55### Proof of Agreement to Participate
56 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. 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 58
59Clients MAY only display participants if the proof is available or MAY display participants as "invited" if the proof is not available. 59Clients MAY only display participants if the proof is available or MAY display participants as "invited" if the proof is not available.
60 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. 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 62
63# Live Chat Message 63### Live Chat Message
64 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. 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 66
67```js 67```json
68{ 68{
69 "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>",
70 "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>",
71 "created_at": "<Unix timestamp in seconds>",
72 "kind": 1311, 69 "kind": 1311,
73 "tags": [ 70 "tags": [
74 ["a", "30311:<Community event author pubkey>:<d-identifier of the community>", "<Optional relay url>", "root"], 71 ["a", "30311:<Community event author pubkey>:<d-identifier of the community>", "<Optional relay url>", "root"],
75 ], 72 ],
76 "content": "Zaps to live streams is beautiful." 73 "content": "Zaps to live streams is beautiful.",
77} 74 ...
75}
78``` 76```
79 77
80# Use Cases 78## Use Cases
81 79
82Common use cases include meeting rooms/workshops, watch-together activities, or event spaces, such as [live.snort.social](https://live.snort.social) and [nostrnests.com](https://nostrnests.com). 80Common use cases include meeting rooms/workshops, watch-together activities, or event spaces, such as [live.snort.social](https://live.snort.social) and [nostrnests.com](https://nostrnests.com).
83 81
84# Example 82## Example
85 83
86Live Streaming 84### Live Streaming
87 85
88```json 86```json
89{ 87{
@@ -96,7 +94,7 @@ Live Streaming
96 ["title", "Adult Swim Metalocalypse"], 94 ["title", "Adult Swim Metalocalypse"],
97 ["summary", "Live stream from IPTV-ORG collection"], 95 ["summary", "Live stream from IPTV-ORG collection"],
98 ["streaming", "https://adultswim-vodlive.cdn.turner.com/live/metalocalypse/stream.m3u8"], 96 ["streaming", "https://adultswim-vodlive.cdn.turner.com/live/metalocalypse/stream.m3u8"],
99 ["starts", "1687182672"] 97 ["starts", "1687182672"],
100 ["status", "live"], 98 ["status", "live"],
101 ["t", "animation"], 99 ["t", "animation"],
102 ["t", "iptv"], 100 ["t", "iptv"],
@@ -107,12 +105,12 @@ Live Streaming
107} 105}
108``` 106```
109 107
110Live Streaming chat message 108### Live Streaming chat message
111 109
112```json 110```json
113{ 111{
114 "id": "97aa81798ee6c5637f7b21a411f89e10244e195aa91cb341bf49f718e36c8188", 112 "id": "97aa81798ee6c5637f7b21a411f89e10244e195aa91cb341bf49f718e36c8188",
115 "pubkey": "3f770d65d3a764a9c5cb503ae123e62ec7598ad035d836e2a810f3877a745b24", 113 "pubkey": "3f770d65d3a764a9c5cb503ae123e62ec7598ad035d836e2a810f3877a745b24",
116 "created_at": 1687286726, 114 "created_at": 1687286726,
117 "kind": 1311, 115 "kind": 1311,
118 "tags": [ 116 "tags": [
@@ -122,4 +120,3 @@ Live Streaming chat message
122 "sig": "997f62ddfc0827c121043074d50cfce7a528e978c575722748629a4137c45b75bdbc84170bedc723ef0a5a4c3daebf1fef2e93f5e2ddb98e5d685d022c30b622" 120 "sig": "997f62ddfc0827c121043074d50cfce7a528e978c575722748629a4137c45b75bdbc84170bedc723ef0a5a4c3daebf1fef2e93f5e2ddb98e5d685d022c30b622"
123} 121}
124```` 122````
125
diff --git a/56.md b/56.md
index 259118d..a2861e3 100644
--- a/56.md
+++ b/56.md
@@ -1,11 +1,10 @@
1
2NIP-56 1NIP-56
3====== 2======
4 3
5Reporting 4Reporting
6--------- 5---------
7 6
8`draft` `optional` `author:jb55` 7`draft` `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` note that is used to report other notes for spam,
11illegal and explicit content. 10illegal and explicit content.
diff --git a/57.md b/57.md
index 95dba3b..6d89620 100644
--- a/57.md
+++ b/57.md
@@ -4,7 +4,7 @@ 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
@@ -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"],
@@ -66,7 +66,7 @@ A signed `zap request` event is not published, but is instead sent using a HTTP
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),
@@ -110,7 +110,8 @@ When a client sends a `zap request` event to a server's lnurl-pay callback URL,
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 receipt` to. 1115. There should be a `relays` tag with the relays to send the `zap receipt` to.
1126. If there is an `amount` tag, it MUST be equal to the `amount` query parameter. 1126. If there is an `amount` tag, it MUST be equal to the `amount` query parameter.
1137. If there is an `a` tag, it MUST be a valid 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
@@ -128,7 +129,7 @@ The following should be true of the `zap receipt` event:
128 129
129- The `content` SHOULD be empty. 130- The `content` SHOULD be empty.
130- The `created_at` date SHOULD be set to the invoice `paid_at` date for idempotency. 131- The `created_at` date SHOULD be set to the invoice `paid_at` date for idempotency.
131- `tags` MUST include the `p` tag AND optional `e` tag from the `zap request`. 132- `tags` MUST include the `p` tag (zap recipient) AND optional `e` tag from the `zap request` AND optional `a` tag from the `zap request` AND optional `P` tag from the pubkey of the zap request (zap sender).
132- The `zap receipt` MUST have a `bolt11` tag containing the description hash bolt11 invoice. 133- The `zap receipt` MUST have a `bolt11` tag containing the description hash bolt11 invoice.
133- The `zap receipt` MUST contain a `description` tag which is the JSON-encoded invoice description. 134- The `zap receipt` MUST contain a `description` tag which is the JSON-encoded invoice description.
134- `SHA256(description)` MUST match the description hash in the bolt11 invoice. 135- `SHA256(description)` MUST match the description hash in the bolt11 invoice.
@@ -148,13 +149,13 @@ Example `zap receipt`:
148 "kind": 9735, 149 "kind": 9735,
149 "tags": [ 150 "tags": [
150 ["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"], 151 ["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"],
152 ["P", "97c70a44366a6535c145b333f973ea86dfdc2d7a99da618c40c64705ad98e322"],
151 ["e", "3624762a1274dd9636e0c552b53086d70bc88c165bc4dc0f9e836a1eaf86c3b8"], 153 ["e", "3624762a1274dd9636e0c552b53086d70bc88c165bc4dc0f9e836a1eaf86c3b8"],
152 ["bolt11", "lnbc10u1p3unwfusp5t9r3yymhpfqculx78u027lxspgxcr2n2987mx2j55nnfs95nxnzqpp5jmrh92pfld78spqs78v9euf2385t83uvpwk9ldrlvf6ch7tpascqhp5zvkrmemgth3tufcvflmzjzfvjt023nazlhljz2n9hattj4f8jq8qxqyjw5qcqpjrzjqtc4fc44feggv7065fqe5m4ytjarg3repr5j9el35xhmtfexc42yczarjuqqfzqqqqqqqqlgqqqqqqgq9q9qxpqysgq079nkq507a5tw7xgttmj4u990j7wfggtrasah5gd4ywfr2pjcn29383tphp4t48gquelz9z78p4cq7ml3nrrphw5w6eckhjwmhezhnqpy6gyf0"], 154 ["bolt11", "lnbc10u1p3unwfusp5t9r3yymhpfqculx78u027lxspgxcr2n2987mx2j55nnfs95nxnzqpp5jmrh92pfld78spqs78v9euf2385t83uvpwk9ldrlvf6ch7tpascqhp5zvkrmemgth3tufcvflmzjzfvjt023nazlhljz2n9hattj4f8jq8qxqyjw5qcqpjrzjqtc4fc44feggv7065fqe5m4ytjarg3repr5j9el35xhmtfexc42yczarjuqqfzqqqqqqqqlgqqqqqqgq9q9qxpqysgq079nkq507a5tw7xgttmj4u990j7wfggtrasah5gd4ywfr2pjcn29383tphp4t48gquelz9z78p4cq7ml3nrrphw5w6eckhjwmhezhnqpy6gyf0"],
153 ["description", "{\"pubkey\":\"32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245\",\"content\":\"\",\"id\":\"d9cc14d50fcb8c27539aacf776882942c1a11ea4472f8cdec1dea82fab66279d\",\"created_at\":1674164539,\"sig\":\"77127f636577e9029276be060332ea565deaf89ff215a494ccff16ae3f757065e2bc59b2e8c113dd407917a010b3abd36c8d7ad84c0e3ab7dab3a0b0caa9835d\",\"kind\":9734,\"tags\":[[\"e\",\"3624762a1274dd9636e0c552b53086d70bc88c165bc4dc0f9e836a1eaf86c3b8\"],[\"p\",\"32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245\"],[\"relays\",\"wss://relay.damus.io\",\"wss://nostr-relay.wlvs.space\",\"wss://nostr.fmt.wiz.biz\",\"wss://relay.nostr.bg\",\"wss://nostr.oxtr.dev\",\"wss://nostr.v0l.io\",\"wss://brb.io\",\"wss://nostr.bitcoiner.social\",\"ws://monad.jb55.com:8080\",\"wss://relay.snort.social\"]]}"], 155 ["description", "{\"pubkey\":\"97c70a44366a6535c145b333f973ea86dfdc2d7a99da618c40c64705ad98e322\",\"content\":\"\",\"id\":\"d9cc14d50fcb8c27539aacf776882942c1a11ea4472f8cdec1dea82fab66279d\",\"created_at\":1674164539,\"sig\":\"77127f636577e9029276be060332ea565deaf89ff215a494ccff16ae3f757065e2bc59b2e8c113dd407917a010b3abd36c8d7ad84c0e3ab7dab3a0b0caa9835d\",\"kind\":9734,\"tags\":[[\"e\",\"3624762a1274dd9636e0c552b53086d70bc88c165bc4dc0f9e836a1eaf86c3b8\"],[\"p\",\"32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245\"],[\"relays\",\"wss://relay.damus.io\",\"wss://nostr-relay.wlvs.space\",\"wss://nostr.fmt.wiz.biz\",\"wss://relay.nostr.bg\",\"wss://nostr.oxtr.dev\",\"wss://nostr.v0l.io\",\"wss://brb.io\",\"wss://nostr.bitcoiner.social\",\"ws://monad.jb55.com:8080\",\"wss://relay.snort.social\"]]}"],
154 ["preimage", "5d006d2cf1e73c7148e7519a4c68adc81642ce0e25a432b2434c99f97344c15f"] 156 ["preimage", "5d006d2cf1e73c7148e7519a4c68adc81642ce0e25a432b2434c99f97344c15f"]
155 ], 157 ],
156 "content": "", 158 "content": "",
157 "sig": "b0a3c5c984ceb777ac455b2f659505df51585d5fd97a0ec1fdb5f3347d392080d4b420240434a3afd909207195dac1e2f7e3df26ba862a45afd8bfe101c2b1cc"
158 } 159 }
159``` 160```
160 161
@@ -166,18 +167,22 @@ A client can retrieve `zap receipt`s on events and pubkeys using a NIP-01 filter
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 its 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..0ecef25 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.
diff --git a/65.md b/65.md
index 55f9ff0..4a6f5a1 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 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/72.md b/72.md
new file mode 100644
index 0000000..4bafce0
--- /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 repleceable event; (ii) by tagging the replaceable event as an `a` tag if the moderator authorizes the replaceable event author to make changes without additional approvals and (iii) by tagging the replaceable event with both its `e` and `a` tag which empowers clients to display the original and updated versions of the event, with appropriate remarks in the UI. Since relays are instructed to delete old versions of a replaceable event, the `.content` of an `e`-approval MUST have the specific version of the event or Clients might not be able to find that version of the content anywhere.
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
index 5eee3b8..43d197f 100644
--- a/89.md
+++ b/89.md
@@ -4,15 +4,17 @@ NIP-89
4Recommended Application Handlers 4Recommended Application Handlers
5-------------------------------- 5--------------------------------
6 6
7`draft` `optional` `author:pablof7z` 7`draft` `optional`
8 8
9This NIP describes `kind:31989` and `kind:31990`: a way to discover applications that can handle unknown event-kinds. 9This NIP describes `kind:31989` and `kind:31990`: a way to discover applications that can handle unknown event-kinds.
10 10
11## Rationale 11## Rationale
12
12Nostr's discoverability and transparent event interaction is one of its most interesting/novel mechanics. 13Nostr's discoverability and transparent event interaction is one of its most interesting/novel mechanics.
13This 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. 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.
14 15
15### Parties involved 16### Parties involved
17
16There are three actors to this workflow: 18There are three actors to this workflow:
17 19
18* 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) 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)
@@ -22,18 +24,18 @@ There are three actors to this workflow:
22* user B, who seeks a recommendation for an app that handles a specific event kind 24* user B, who seeks a recommendation for an app that handles a specific event kind
23 * Queries for `kind:31989` and, based on results, queries for `kind:31990` 25 * Queries for `kind:31989` and, based on results, queries for `kind:31990`
24 26
25# Events 27## Events
26 28
27## Recommendation event 29### Recommendation event
28```json 30```json
29{ 31{
30 "kind": 31989, 32 "kind": 31989,
31 "pubkey": <recommender-user-pubkey>, 33 "pubkey": <recommender-user-pubkey>,
32 "tags": [ 34 "tags": [
33 [ "d", <supported-event-kind> ], 35 ["d", <supported-event-kind>],
34 [ "a", "31990:app1-pubkey:<d-identifier>", "wss://relay1", "ios" ], 36 ["a", "31990:app1-pubkey:<d-identifier>", "wss://relay1", "ios"],
35 [ "a", "31990:app2-pubkey:<d-identifier>", "wss://relay2", "web" ] 37 ["a", "31990:app2-pubkey:<d-identifier>", "wss://relay2", "web"]
36 ] 38 ]
37} 39}
38``` 40```
39 41
@@ -47,70 +49,83 @@ The third value of the tag SHOULD be the platform where this recommendation migh
47## Handler information 49## Handler information
48```json 50```json
49{ 51{
50 "kind": 31990, 52 "kind": 31990,
51 "pubkey": <pubkey>, 53 "pubkey": "<application-pubkey>",
52 "content": "<optional-kind:0-style-metadata>", 54 "content": "<optional-kind:0-style-metadata>",
53 "tags": [ 55 "tags": [
54 [ "d", <random-id> ], 56 ["d", <random-id>],
55 [ "k", <supported-event-kind> ], 57 ["k", <supported-event-kind>],
56 [ "web", "https://..../a/<bech32>", "nevent" ], 58 ["web", "https://..../a/<bech32>", "nevent"],
57 [ "web", "https://..../p/<bech32>", "nprofile" ], 59 ["web", "https://..../p/<bech32>", "nprofile"],
58 [ "web", "https://..../e/<bech32>" ], 60 ["web", "https://..../e/<bech32>"],
59 [ "ios", ".../<bech32>" ] 61 ["ios", ".../<bech32>"]
60 ] 62 ]
61} 63}
62``` 64```
63 65
64* `content` is an optional `set_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.) 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.)
65
66* `k` tags' value is the event kind that is supported by this `kind:31990`. 67* `k` tags' value is the event kind that is supported by this `kind:31990`.
67Using a `k` tag(s) (instead of having the kind onf the NIP-33 `d` tag) provides: 68Using a `k` tag(s) (instead of having the kind of the `d` tag) provides:
68 * 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. 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.
69 * The same pubkey can have multiple events with different apps that handle the same event kind. 70 * The same pubkey can have multiple events with different apps that handle the same event kind.
70
71* `bech32` in a URL MUST be replaced by clients with the NIP-19-encoded entity that should be loaded by the application. 71* `bech32` in a URL MUST be replaced by clients with the NIP-19-encoded entity that should be loaded by the application.
72 72
73Multiple tags might be registered by the app, following NIP-19 nomenclature as the second value of the array. 73Multiple tags might be registered by the app, following NIP-19 nomenclature as the second value of the array.
74 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. 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 76
77# User flow 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
78A user A who uses a non-`kind:1`-centric nostr app could choose to announce/recommend a certain kind-handler application. 91A user A who uses a non-`kind:1`-centric nostr app could choose to announce/recommend a certain kind-handler application.
79 92
80When 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). 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).
81 94
82The client MIGHT query for the user's and the user's follows handler. 95The client MIGHT query for the user's and the user's follows handler.
83 96
84# Example 97## Example
85 98
86## User A recommends a `kind:31337`-handler 99### User A recommends a `kind:31337`-handler
87User 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. 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.
88 101
89```json 102```json
90{ 103{
91 "kind": 31989, 104 "kind": 31989,
92 "tags": [ 105 "tags": [
93 [ "d", "31337" ], 106 ["d", "31337"],
94 [ "a", "31990:1743058db7078661b94aaf4286429d97ee5257d14a86d6bfa54cb0482b876fb0:abcd", <relay-url>, "web" ] 107 ["a", "31990:1743058db7078661b94aaf4286429d97ee5257d14a86d6bfa54cb0482b876fb0:abcd", <relay-url>, "web"]
95 ] 108 ],
109 ...
96} 110}
97``` 111```
98 112
99## User B interacts with a `kind:31337`-handler 113### User B interacts with a `kind:31337`-handler
100User B might see in their timeline an event referring to a `kind:31337` event 114User B might see in their timeline an event referring to a `kind:31337` event (e.g. a `kind:1` tagging a `kind:31337`).
101(e.g. a `kind:1` tagging a `kind:31337`).
102 115
103User B's client, not knowing how to handle a `kind:31337` might display the event 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`:
104using its `alt` tag (as described in NIP-31). When the user clicks on the event,
105the application queries for a handler for this `kind`:
106 117
107`["REQ", <id>, '[{ "kinds": [31989], "#d": ["31337"], 'authors': [<user>, <users-contact-list>] }]']` 118```json
119["REQ", <id>, '[{ "kinds": [31989], "#d": ["31337"], 'authors': [<user>, <users-contact-list>] }]']
120```
108 121
109User B, who follows User A, sees that `kind:31989` event and fetches the `a`-tagged event for the app and handler information. 122User B, who follows User A, sees that `kind:31989` event and fetches the `a`-tagged event for the app and handler information.
110 123
111User 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. 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.
112 125
113## Alternative query bypassing `kind:31989` 126### Alternative query bypassing `kind:31989`
114Alternatively, users might choose to query directly for `kind:31990` for an event kind. Clients SHOULD be careful doing this and use spam-prevention mechanisms to avoid directing users to malicious handlers. 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.
115 128
116`["REQ", <id>, '[{ "kinds": [31990], "#k": [<desired-event-kind>], 'authors': [...] }]']` \ No newline at end of file 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..241eb38
--- /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) section.
166* `status` tag: Service Providers SHOULD indicate what this feedback status refers to. [Appendix 1](#appendix-1-job-feedback-status) defines status. Extra human-readable information can be added as an extra argument.
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) 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 cancelled 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/94.md b/94.md
index 24dd346..eb8117a 100644
--- a/94.md
+++ b/94.md
@@ -4,43 +4,48 @@ 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
24 28
25```json 29```json
26{ 30{
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, 31 "kind": 1063,
31 "tags": [ 32 "tags": [
32 ["url",<string with URI of file>], 33 ["url",<string with URI of file>],
33 ["aes-256-gcm",<key>, <iv>],
34 ["m", <MIME type>], 34 ["m", <MIME type>],
35 ["x",<Hash SHA-256>], 35 ["x",<Hash SHA-256>],
36 ["ox",<Hash SHA-256>],
36 ["size", <size of file in bytes>], 37 ["size", <size of file in bytes>],
37 ["dim", <size of file in pixels>], 38 ["dim", <size of file in pixels>],
38 ["magnet",<magnet URI> ], 39 ["magnet",<magnet URI> ],
39 ["i",<torrent infohash>], 40 ["i",<torrent infohash>],
40 ["blurhash", <value>] 41 ["blurhash", <value>],
42 ["thumb", <string with thumbnail URI>],
43 ["image", <string with preview URI>],
44 ["summary", <excerpt>],
45 ["alt", <description>]
41 ], 46 ],
42 "content": <description>, 47 "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> 48 ...
44} 49}
45``` 50```
46 51
diff --git a/96.md b/96.md
new file mode 100644
index 0000000..3ebbef8
--- /dev/null
+++ b/96.md
@@ -0,0 +1,302 @@
1NIP-96
2======
3
4HTTP File Storage Integration
5-----------------------------
6
7`draft` `optional`
8
9## Introduction
10
11This NIP defines a REST API for HTTP file storage servers intended to be used in conjunction with the nostr network.
12The API will enable nostr users to upload files and later reference them by url on nostr notes.
13
14The spec DOES NOT use regular nostr events through websockets for
15storing, requesting nor retrieving data because, for simplicity, the server
16will not have to learn anything about nostr relays.
17
18## Server Adaptation
19
20File storage servers wishing to be accessible by nostr users should opt-in by making available an https route at `/.well-known/nostr/nip96.json` with `api_url`:
21
22```js
23{
24 // Required
25 // File upload and deletion are served from this url
26 // Also downloads if "download_url" field is absent or empty string
27 "api_url": "https://your-file-server.example/custom-api-path",
28 // Optional
29 // If absent, downloads are served from the api_url
30 "download_url": "https://a-cdn.example/a-path",
31 // Optional
32 // Note: This field is not meant to be set by HTTP Servers.
33 // Use this if you are a nostr relay using your /.well-known/nostr/nip96.json
34 // just to redirect to someone else's http file storage server's /.well-known/nostr/nip96.json
35 // In this case, "api_url" field must be an empty string
36 "delegated_to_url": "https://your-file-server.example",
37 // Optional
38 "supported_nips": [60],
39 // Optional
40 "tos_url": "https://your-file-server.example/terms-of-service",
41 // Optional
42 "content_types": ["image/jpeg", "video/webm", "audio/*"],
43 // Optional
44 "plans": {
45 // "free" is the only standardized plan key and
46 // clients may use its presence to learn if server offers free storage
47 "free": {
48 "name": "Free Tier",
49 // Default is true
50 // All plans MUST support NIP-98 uploads
51 // but some plans may also allow uploads without it
52 "is_nip98_required": true,
53 "url": "https://...", // plan's landing page if there is one
54 "max_byte_size": 10485760,
55 // Range in days / 0 for no expiration
56 // [7, 0] means it may vary from 7 days to unlimited persistence,
57 // [0, 0] means it has no expiration
58 // early expiration may be due to low traffic or any other factor
59 "file_expiration": [14, 90],
60 "media_transformations": {
61 "image": [
62 'resizing'
63 ]
64 }
65 }
66 }
67}
68```
69
70### Relay Hints
71
72Note: This section is not meant to be used by HTTP Servers.
73
74A nostr relay MAY redirect to someone else's HTTP file storage server by
75adding a `/.well-known/nostr/nip96.json` with "delegated_to_url" field
76pointing to the url where the server hosts its own
77`/.well-known/nostr/nip96.json`. In this case, the "api_url" field must
78be an empty string and all other fields must be absent.
79
80If the nostr relay is also an HTTP file storage server,
81it must use the "api_url" field instead.
82
83### List of Supporting File Storage Servers
84
85| Name | Domain |
86| ------------- | ------------------------- |
87| nostrcheck.me | https://nostrcheck.me |
88| nostrage | https://nostrage.com |
89| sove | https://sove.rent |
90| nostr.build | https://nostr.build |
91| sovbit | https://files.sovbit.host |
92| void.cat | https://void.cat |
93
94## Upload
95
96A file can be uploaded one at a time to `https://your-file-server.example/custom-api-path` (route from `https://your-file-server.example/.well-known/nostr/nip96.json` "api_url" field) as `multipart/form-data` content type using `POST` method with the file object set to the `file` form data field.
97
98`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).
99If using an html form, use an `Authorization` form data field instead.
100
101These following **optional** form data fields MAY be used by `servers` and SHOULD be sent by `clients`:
102- `expiration`: string of the UNIX timestamp in seconds. Empty string if file should be stored forever. The server isn't required to honor this;
103- `size`: string of the file byte size. This is just a value the server can use to reject early if the file size exceeds the server limits;
104- `alt`: (recommended) strict description text for visibility-impaired users;
105- `caption`: loose description;
106- `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;
107- `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.
108
109
110Others custom form data fields may be used depending on specific `server` support.
111The `server` isn't required to store any metadata sent by `clients`.
112
113Note for `clients`: if using an HTML form, it is important for the `file` form field to be the **last** one, or be re-ordered right before sending or be appended as the last field of XHR2's FormData object.
114
115The `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.
116The hash is enough to uniquely identify a file, that's why it will be used on the "download" and "delete" routes.
117
118The `server` MUST link the user's `pubkey` string (which is embedded in the decoded header value) as the owner of the file so to later allow them to delete the file.
119Note that if a file with the same hash of a previously received file (so the same file) is uploaded by another user, the server doesn't need to store the new file.
120It should just add the new user's `pubkey` to the list of the owners of the already stored file with said hash (if it wants to save space by keeping just one copy of the same file, because multiple uploads of the same file results in the same file hash).
121
122The `server` MAY also store the `Authorization` header/field value (decoded or not) for accountability purpose as this proves that the user with the unique pubkey did ask for the upload of the file with a specific hash. However, storing the pubkey is sufficient to establish ownership.
123
124The `server` MUST reject with 413 Payload Too Large if file size exceeds limits.
125
126The `server` MUST reject with 400 Bad Request status if some fields are invalid.
127
128The `server` MUST reply to the upload with 200 OK status if the `payload` tag value contains an already used SHA-256 hash (if file is already owned by the same pubkey) or reject the upload with 403 Forbidden status if it isn't the same of the received file.
129
130The `server` MAY reject the upload with 402 Payment Required status if the user has a pending payment (Payment flow is not strictly required. Server owners decide if the storage is free or not. Monetization schemes may be added later to correlated NIPs.).
131
132On successful uploads the `server` MUST reply with **201 Created** HTTP status code or **202 Accepted** if a `processing_url` field is added
133to the response so that the `client` can follow the processing status (see [Delayed Processing](#delayed-processing) section).
134
135The upload response is a json object as follows:
136
137```js
138{
139 // "success" if successful or "error" if not
140 status: "success",
141 // Free text success, failure or info message
142 message: "Upload successful.",
143 // Optional. See "Delayed Processing" section
144 processing_url: "...",
145 // This uses the NIP-94 event format but DO NOT need
146 // to fill some fields like "id", "pubkey", "created_at" and "sig"
147 //
148 // This holds the download url ("url"),
149 // the ORIGINAL file hash before server transformations ("ox")
150 // and, optionally, all file metadata the server wants to make available
151 //
152 // nip94_event field is absent if unsuccessful upload
153 nip94_event: {
154 // Required tags: "url" and "ox"
155 tags: [
156 // Can be same from /.well-known/nostr/nip96.json's "download_url" field
157 // (or "api_url" field if "download_url" is absent or empty) with appended
158 // original file hash.
159 //
160 // Note we appended .png file extension to the `ox` value
161 // (it is optional but extremely recommended to add the extension as it will help nostr clients
162 // with detecting the file type by using regular expression)
163 //
164 // Could also be any url to download the file
165 // (using or not using the /.well-known/nostr/nip96.json's "download_url" prefix),
166 // for load balancing purposes for example.
167 ["url", "https://your-file-server.example/custom-api-path/719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b.png"],
168 // SHA-256 hash of the ORIGINAL file, before transformations.
169 // The server MUST store it even though it represents the ORIGINAL file because
170 // users may try to download/delete the transformed file using this value
171 ["ox", "719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b"],
172 // Optional. SHA-256 hash of the saved file after any server transformations.
173 // The server can but does not need to store this value.
174 ["x", "543244319525d9d08dd69cb716a18158a249b7b3b3ec4bbde5435543acb34443"],
175 // Optional. Recommended for helping clients to easily know file type before downloading it.
176 ["m", "image/png"]
177 // Optional. Recommended for helping clients to reserve an adequate UI space to show the file before downloading it.
178 ["dim", "800x600"]
179 // ... other optional NIP-94 tags
180 ],
181 content: ""
182 },
183 // ... other custom fields (please consider adding them to this NIP or to NIP-94 tags)
184}
185```
186
187Note 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.
188
189`Clients` may upload the same file to one or many `servers`.
190After 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.
191
192Alternatively, instead of using NIP-94, the `client` can share or embed on a nostr note just the above url.
193
194### Delayed Processing
195
196Sometimes the server may want to place the uploaded file in a processing queue for deferred file processing.
197
198In 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.
199
200The expected resulting metadata that is known in advance should be returned on the response.
201For example, if the file processing would change a file from "jpg" to "webp",
202use ".webp" extension on the `nip94_event.tags.*.url` field value and set "image/webp" to the `nip94_event.tags.*.m` field.
203If some metadata are unknown before processing ends, omit them from the response.
204
205The upload response MAY include a `processing_url` field informing a temporary url that may be used by clients to check if
206the file processing is done.
207
208If the processing isn't done, the server should reply at the `processing_url` url with **200 OK** and the following JSON:
209
210```
211{
212 // It should be "processing". If "error" it would mean the processing failed.
213 status: "processing",
214 message: "Processing. Please check again later for updated status.",
215 percentage: 15 // Processing percentage. An integer between 0 and 100.
216}
217```
218
219When 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
220that weren't available before processing.
221
222### File compression
223
224File compression and other transformations like metadata stripping can be applied by the server.
225However, for all file actions, such as download and deletion, the **original** file SHA-256 hash is what identifies the file in the url string.
226
227## Download
228
229`Servers` must make available the route `https://your-file-server.example/custom-api-path/<sha256-file-hash>(.ext)` (route taken from `https://your-file-server.example/.well-known/nostr/nip96.json` "api_url" or "download_url" field) with `GET` method for file download.
230
231The primary file download url informed at the upload's response field `nip94_event.tags.*.url`
232can be that or not (it can be any non-standard url the server wants).
233If not, the server still MUST also respond to downloads at the standard url
234mentioned on the previous paragraph, to make it possible for a client
235to try downloading a file on any NIP-96 compatible server by knowing just the SHA-256 file hash.
236
237Note that the "\<sha256-file-hash\>" part is from the **original** file, **not** from the **transformed** file if the uploaded file went through any server transformation.
238
239Supporting ".ext", meaning "file extension", is required for `servers`. It is optional, although recommended, for `clients` to append it to the path.
240When present it may be used by `servers` to know which `Content-Type` header to send (e.g.: "Content-Type": "image/png" for ".png" extension).
241The file extension may be absent because the hash is the only needed string to uniquely identify a file.
242
243Example: `https://your-file-server.example/custom-api-path/719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b.png`
244
245### Media Transformations
246
247`Servers` may respond to some media transformation query parameters and ignore those they don't support by serving
248the original media file without transformations.
249
250#### Image Transformations
251
252##### Resizing
253
254Upon upload, `servers` may create resized image variants, such as thumbnails, respecting the original aspect ratio.
255`Clients` may use the `w` query parameter to request an image version with the desired pixel width.
256`Servers` can then serve the variant with the closest width to the parameter value
257or an image variant generated on the fly.
258
259Example: `https://your-file-server.example/custom-api-path/<sha256-file-hash>.png?w=32`
260
261## Deletion
262
263`Servers` must make available the route `https://deletion.domain/deletion-path/<sha256-file-hash>(.ext)` (route taken from `https://your-file-server.example/.well-known/nostr/nip96.json` "api_url" field) with `DELETE` method for file deletion.
264
265Note that the "\<sha256-file-hash\>" part is from the **original** file, **not** from the **transformed** file if the uploaded file went through any server transformation.
266
267The extension is optional as the file hash is the only needed file identification.
268
269`Clients` should send a `DELETE` request to the server deletion route in the above format. It must include a NIP-98 `Authorization` header.
270
271The `server` should reject deletes from users other than the original uploader. The `pubkey` encoded on the header value identifies the user.
272
273It 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
274in the same file hash).
275
276The successful response is a 200 OK one with just basic JSON fields:
277
278```
279{
280 status: "success",
281 message: "File deleted."
282}
283```
284
285## Selecting a Server
286
287Note: HTTP File Storage Server developers may skip this section. This is meant for client developers.
288
289A File Server Preference event is a kind 10096 replaceable event meant to select one or more servers the user wants
290to upload files to. Servers are listed as `server` tags:
291
292```js
293{
294 // ...
295 "kind": 10096,
296 "content": "",
297 "tags": [
298 ["server", "https://file.server.one"],
299 ["server", "https://file.server.two"]
300 ]
301}
302```
diff --git a/98.md b/98.md
index ecbebc0..ca52304 100644
--- a/98.md
+++ b/98.md
@@ -2,13 +2,13 @@ NIP-98
2====== 2======
3 3
4HTTP Auth 4HTTP Auth
5------------------------- 5---------
6 6
7`draft` `optional` `author:kieran` `author:melvincarvalho` 7`draft` `optional`
8 8
9This NIP defines an ephemerial event used to authorize requests to HTTP servers using nostr events. 9This NIP defines an ephemeral event used to authorize requests to HTTP servers using nostr events.
10 10
11This is useful for HTTP services which are build for Nostr and deal with Nostr user accounts. 11This is useful for HTTP services which are built for Nostr and deal with Nostr user accounts.
12 12
13## Nostr event 13## Nostr event
14 14
@@ -16,7 +16,7 @@ A `kind 27235` (In reference to [RFC 7235](https://www.rfc-editor.org/rfc/rfc723
16 16
17The `content` SHOULD be empty. 17The `content` SHOULD be empty.
18 18
19The following tags are defined as REQUIRED. 19The following tags MUST be included.
20 20
21* `u` - absolute URL 21* `u` - absolute URL
22* `method` - HTTP Request Method 22* `method` - HTTP Request Method
@@ -24,28 +24,22 @@ The following tags are defined as REQUIRED.
24Example event: 24Example event:
25```json 25```json
26{ 26{
27 "id": "fe964e758903360f28d8424d092da8494ed207cba823110be3a57dfe4b578734", 27 "id": "fe964e758903360f28d8424d092da8494ed207cba823110be3a57dfe4b578734",
28 "pubkey": "63fe6318dc58583cfe16810f86dd09e18bfd76aabc24a0081ce2856f330504ed", 28 "pubkey": "63fe6318dc58583cfe16810f86dd09e18bfd76aabc24a0081ce2856f330504ed",
29 "content": "", 29 "content": "",
30 "kind": 27235, 30 "kind": 27235,
31 "created_at": 1682327852, 31 "created_at": 1682327852,
32 "tags": [ 32 "tags": [
33 [ 33 ["u", "https://api.snort.social/api/v1/n5sp/list"],
34 "u", 34 ["method", "GET"]
35 "https://api.snort.social/api/v1/n5sp/list" 35 ],
36 ], 36 "sig": "5ed9d8ec958bc854f997bdc24ac337d005af372324747efe4a00e24f4c30437ff4dd8308684bed467d9d6be3e5a517bb43b1732cc7d33949a3aaf86705c22184"
37 [
38 "method",
39 "GET"
40 ]
41 ],
42 "sig": "5ed9d8ec958bc854f997bdc24ac337d005af372324747efe4a00e24f4c30437ff4dd8308684bed467d9d6be3e5a517bb43b1732cc7d33949a3aaf86705c22184"
43} 37}
44``` 38```
45 39
46Servers MUST perform the following checks in order to validate the event: 40Servers MUST perform the following checks in order to validate the event:
471. The `kind` MUST be `27235`. 411. The `kind` MUST be `27235`.
482. The `created_at` MUST be within a reasonable time window (suggestion 60 seconds). 422. The `created_at` timestamp MUST be within a reasonable time window (suggestion 60 seconds).
493. The `u` tag MUST be exactly the same as the absolute request URL (including query parameters). 433. The `u` tag MUST be exactly the same as the absolute request URL (including query parameters).
504. The `method` tag MUST be the same HTTP method used for the requested resource. 444. The `method` tag MUST be the same HTTP method used for the requested resource.
51 45
@@ -53,11 +47,11 @@ When the request contains a body (as in POST/PUT/PATCH methods) clients SHOULD i
53 47
54If one of the checks was to fail the server SHOULD respond with a 401 Unauthorized response code. 48If one of the checks was to fail the server SHOULD respond with a 401 Unauthorized response code.
55 49
56All other checks which server MAY do are OPTIONAL, and implementation specific. 50Servers MAY perform additional implementation-specific validation checks.
57 51
58## Request Flow 52## Request Flow
59 53
60Using the `Authorization` header, the `kind 27235` event MUST be `base64` encoded and use the Authorization scheme `Nostr` 54Using the `Authorization` HTTP header, the `kind 27235` event MUST be `base64` encoded and use the Authorization scheme `Nostr`
61 55
62Example HTTP Authorization header: 56Example HTTP Authorization header:
63``` 57```
@@ -65,4 +59,4 @@ Authorization: Nostr eyJpZCI6ImZlOTY0ZTc1ODkwMzM2MGYyOGQ4NDI0ZDA5MmRhODQ5NGVkMjA
65``` 59```
66 60
67## Reference Implementations 61## Reference Implementations
68- C# ASP.NET `AuthenticationHandler` [NostrAuth.cs](https://gist.github.com/v0l/74346ae530896115bfe2504c8cd018d3) \ No newline at end of file 62- C# ASP.NET `AuthenticationHandler` [NostrAuth.cs](https://gist.github.com/v0l/74346ae530896115bfe2504c8cd018d3)
diff --git a/99.md b/99.md
index 274e5af..e65920c 100644
--- a/99.md
+++ b/99.md
@@ -1,8 +1,10 @@
1# NIP-99 1NIP-99
2======
2 3
3## Classified Listings 4Classified Listings
5-------------------
4 6
5`draft` `optional` `author:erskingardner` 7`draft` `optional`
6 8
7This 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. 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.
8 10
diff --git a/README.md b/README.md
index 1360190..91179cd 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,20 @@
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)
16- [License](#license) 18- [License](#license)
17 19
18--- 20---
@@ -20,9 +22,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
20## List 22## List
21 23
22- [NIP-01: Basic protocol flow description](01.md) 24- [NIP-01: Basic protocol flow description](01.md)
23- [NIP-02: Contact List and Petnames](02.md) 25- [NIP-02: Follow List](02.md)
24- [NIP-03: OpenTimestamps Attestations for Events](03.md) 26- [NIP-03: OpenTimestamps Attestations for Events](03.md)
25- [NIP-04: Encrypted Direct Message](04.md) 27- [NIP-04: Encrypted Direct Message](04.md) --- **unrecommended**: deprecated in favor of [NIP-44](44.md)
26- [NIP-05: Mapping Nostr keys to DNS-based internet identifiers](05.md) 28- [NIP-05: Mapping Nostr keys to DNS-based internet identifiers](05.md)
27- [NIP-06: Basic key derivation from mnemonic seed phrase](06.md) 29- [NIP-06: Basic key derivation from mnemonic seed phrase](06.md)
28- [NIP-07: `window.nostr` capability for web browsers](07.md) 30- [NIP-07: `window.nostr` capability for web browsers](07.md)
@@ -30,17 +32,14 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
30- [NIP-09: Event Deletion](09.md) 32- [NIP-09: Event Deletion](09.md)
31- [NIP-10: Conventions for clients' use of `e` and `p` tags in text events](10.md) 33- [NIP-10: Conventions for clients' use of `e` and `p` tags in text events](10.md)
32- [NIP-11: Relay Information Document](11.md) 34- [NIP-11: Relay Information Document](11.md)
33- [NIP-12: Generic Tag Queries](12.md)
34- [NIP-13: Proof of Work](13.md) 35- [NIP-13: Proof of Work](13.md)
35- [NIP-14: Subject tag in text events](14.md) 36- [NIP-14: Subject tag in text events](14.md)
36- [NIP-15: Nostr Marketplace (for resilient marketplaces)](15.md) 37- [NIP-15: Nostr Marketplace (for resilient marketplaces)](15.md)
37- [NIP-16: Event Treatment](16.md)
38- [NIP-18: Reposts](18.md) 38- [NIP-18: Reposts](18.md)
39- [NIP-19: bech32-encoded entities](19.md) 39- [NIP-19: bech32-encoded entities](19.md)
40- [NIP-20: Command Results](20.md)
41- [NIP-21: `nostr:` URI scheme](21.md) 40- [NIP-21: `nostr:` URI scheme](21.md)
42- [NIP-22: Event `created_at` Limits](22.md)
43- [NIP-23: Long-form Content](23.md) 41- [NIP-23: Long-form Content](23.md)
42- [NIP-24: Extra metadata fields and tags](24.md)
44- [NIP-25: Reactions](25.md) 43- [NIP-25: Reactions](25.md)
45- [NIP-26: Delegated Event Signing](26.md) 44- [NIP-26: Delegated Event Signing](26.md)
46- [NIP-27: Text Note References](27.md) 45- [NIP-27: Text Note References](27.md)
@@ -48,84 +47,117 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
48- [NIP-30: Custom Emoji](30.md) 47- [NIP-30: Custom Emoji](30.md)
49- [NIP-31: Dealing with Unknown Events](31.md) 48- [NIP-31: Dealing with Unknown Events](31.md)
50- [NIP-32: Labeling](32.md) 49- [NIP-32: Labeling](32.md)
51- [NIP-33: Parameterized Replaceable Events](33.md)
52- [NIP-36: Sensitive Content](36.md) 50- [NIP-36: Sensitive Content](36.md)
51- [NIP-38: User Statuses](38.md)
53- [NIP-39: External Identities in Profiles](39.md) 52- [NIP-39: External Identities in Profiles](39.md)
54- [NIP-40: Expiration Timestamp](40.md) 53- [NIP-40: Expiration Timestamp](40.md)
55- [NIP-42: Authentication of clients to relays](42.md) 54- [NIP-42: Authentication of clients to relays](42.md)
55- [NIP-44: Versioned Encryption](44.md)
56- [NIP-45: Counting results](45.md) 56- [NIP-45: Counting results](45.md)
57- [NIP-46: Nostr Connect](46.md) 57- [NIP-46: Nostr Connect](46.md)
58- [NIP-47: Wallet Connect](47.md) 58- [NIP-47: Wallet Connect](47.md)
59- [NIP-50: Keywords filter](50.md) 59- [NIP-48: Proxy Tags](48.md)
60- [NIP-50: Search Capability](50.md)
60- [NIP-51: Lists](51.md) 61- [NIP-51: Lists](51.md)
62- [NIP-52: Calendar Events](52.md)
61- [NIP-53: Live Activities](53.md) 63- [NIP-53: Live Activities](53.md)
62- [NIP-56: Reporting](56.md) 64- [NIP-56: Reporting](56.md)
63- [NIP-57: Lightning Zaps](57.md) 65- [NIP-57: Lightning Zaps](57.md)
64- [NIP-58: Badges](58.md) 66- [NIP-58: Badges](58.md)
65- [NIP-65: Relay List Metadata](65.md) 67- [NIP-65: Relay List Metadata](65.md)
68- [NIP-72: Moderated Communities](72.md)
69- [NIP-75: Zap Goals](75.md)
66- [NIP-78: Application-specific data](78.md) 70- [NIP-78: Application-specific data](78.md)
71- [NIP-84: Highlights](84.md)
67- [NIP-89: Recommended Application Handlers](89.md) 72- [NIP-89: Recommended Application Handlers](89.md)
73- [NIP-90: Data Vending Machines](90.md)
68- [NIP-94: File Metadata](94.md) 74- [NIP-94: File Metadata](94.md)
75- [NIP-96: HTTP File Storage Integration](96.md)
69- [NIP-98: HTTP Auth](98.md) 76- [NIP-98: HTTP Auth](98.md)
70- [NIP-99: Classified Listings](99.md) 77- [NIP-99: Classified Listings](99.md)
71 78
72## Event Kinds 79## Event Kinds
80| kind | description | NIP |
81| ------------- | -------------------------- | ------------------------ |
82| `0` | Metadata | [01](01.md) |
83| `1` | Short Text Note | [01](01.md) |
84| `2` | Recommend Relay | 01 (deprecated) |
85| `3` | Follows | [02](02.md) |
86| `4` | Encrypted Direct Messages | [04](04.md) |
87| `5` | Event Deletion | [09](09.md) |
88| `6` | Repost | [18](18.md) |
89| `7` | Reaction | [25](25.md) |
90| `8` | Badge Award | [58](58.md) |
91| `16` | Generic Repost | [18](18.md) |
92| `40` | Channel Creation | [28](28.md) |
93| `41` | Channel Metadata | [28](28.md) |
94| `42` | Channel Message | [28](28.md) |
95| `43` | Channel Hide Message | [28](28.md) |
96| `44` | Channel Mute User | [28](28.md) |
97| `1021` | Bid | [15](15.md) |
98| `1022` | Bid confirmation | [15](15.md) |
99| `1040` | OpenTimestamps | [03](03.md) |
100| `1063` | File Metadata | [94](94.md) |
101| `1311` | Live Chat Message | [53](53.md) |
102| `1971` | Problem Tracker | [nostrocket][nostrocket] |
103| `1984` | Reporting | [56](56.md) |
104| `1985` | Label | [32](32.md) |
105| `4550` | Community Post Approval | [72](72.md) |
106| `5000`-`5999` | Job Request | [90](90.md) |
107| `6000`-`6999` | Job Result | [90](90.md) |
108| `7000` | Job Feedback | [90](90.md) |
109| `9041` | Zap Goal | [75](75.md) |
110| `9734` | Zap Request | [57](57.md) |
111| `9735` | Zap | [57](57.md) |
112| `9802` | Highlights | [84](84.md) |
113| `10000` | Mute list | [51](51.md) |
114| `10001` | Pin list | [51](51.md) |
115| `10002` | Relay List Metadata | [65](65.md) |
116| `10003` | Bookmark list | [51](51.md) |
117| `10004` | Communities list | [51](51.md) |
118| `10005` | Public chats list | [51](51.md) |
119| `10006` | Blocked relays list | [51](51.md) |
120| `10007` | Search relays list | [51](51.md) |
121| `10015` | Interests list | [51](51.md) |
122| `10030` | User emoji list | [51](51.md) |
123| `10096` | File storage server list | [96](96.md) |
124| `13194` | Wallet Info | [47](47.md) |
125| `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] |
126| `22242` | Client Authentication | [42](42.md) |
127| `23194` | Wallet Request | [47](47.md) |
128| `23195` | Wallet Response | [47](47.md) |
129| `24133` | Nostr Connect | [46](46.md) |
130| `27235` | HTTP Auth | [98](98.md) |
131| `30000` | Follow sets | [51](51.md) |
132| `30001` | Generic lists | [51](51.md) |
133| `30002` | Relay sets | [51](51.md) |
134| `30003` | Bookmark sets | [51](51.md) |
135| `30004` | Curation sets | [51](51.md) |
136| `30008` | Profile Badges | [58](58.md) |
137| `30009` | Badge Definition | [58](58.md) |
138| `30015` | Interest sets | [51](51.md) |
139| `30017` | Create or update a stall | [15](15.md) |
140| `30018` | Create or update a product | [15](15.md) |
141| `30019` | Marketplace UI/UX | [15](15.md) |
142| `30020` | Product sold as an auction | [15](15.md) |
143| `30023` | Long-form Content | [23](23.md) |
144| `30024` | Draft Long-form Content | [23](23.md) |
145| `30030` | Emoji sets | [51](51.md) |
146| `30078` | Application-specific Data | [78](78.md) |
147| `30311` | Live Event | [53](53.md) |
148| `30315` | User Statuses | [38](38.md) |
149| `30402` | Classified Listing | [99](99.md) |
150| `30403` | Draft Classified Listing | [99](99.md) |
151| `31922` | Date-Based Calendar Event | [52](52.md) |
152| `31923` | Time-Based Calendar Event | [52](52.md) |
153| `31924` | Calendar | [52](52.md) |
154| `31925` | Calendar Event RSVP | [52](52.md) |
155| `31989` | Handler recommendation | [89](89.md) |
156| `31990` | Handler information | [89](89.md) |
157| `34550` | Community Definition | [72](72.md) |
73 158
74| kind | description | NIP | 159[nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md
75| ------- | -------------------------- | ----------- | 160[lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md
76| `0` | Metadata | [1](01.md) |
77| `1` | Short Text Note | [1](01.md) |
78| `2` | Recommend Relay | [1](01.md) |
79| `3` | Contacts | [2](02.md) |
80| `4` | Encrypted Direct Messages | [4](04.md) |
81| `5` | Event Deletion | [9](09.md) |
82| `6` | Repost | [18](18.md) |
83| `7` | Reaction | [25](25.md) |
84| `8` | Badge Award | [58](58.md) |
85| `16` | Generic Repost | [18](18.md) |
86| `40` | Channel Creation | [28](28.md) |
87| `41` | Channel Metadata | [28](28.md) |
88| `42` | Channel Message | [28](28.md) |
89| `43` | Channel Hide Message | [28](28.md) |
90| `44` | Channel Mute User | [28](28.md) |
91| `1063` | File Metadata | [94](94.md) |
92| `1311` | Live Chat Message | [53](53.md) |
93| `1984` | Reporting | [56](56.md) |
94| `1985` | Label | [32](32.md) |
95| `9734` | Zap Request | [57](57.md) |
96| `9735` | Zap | [57](57.md) |
97| `10000` | Mute List | [51](51.md) |
98| `10001` | Pin List | [51](51.md) |
99| `10002` | Relay List Metadata | [65](65.md) |
100| `13194` | Wallet Info | [47](47.md) |
101| `22242` | Client Authentication | [42](42.md) |
102| `23194` | Wallet Request | [47](47.md) |
103| `23195` | Wallet Response | [47](47.md) |
104| `24133` | Nostr Connect | [46](46.md) |
105| `27235` | HTTP Auth | [98](98.md) |
106| `30000` | Categorized People List | [51](51.md) |
107| `30001` | Categorized Bookmark List | [51](51.md) |
108| `30008` | Profile Badges | [58](58.md) |
109| `30009` | Badge Definition | [58](58.md) |
110| `30017` | Create or update a stall | [15](15.md) |
111| `30018` | Create or update a product | [15](15.md) |
112| `30023` | Long-form Content | [23](23.md) |
113| `30024` | Draft Long-form Content | [23](23.md) |
114| `30078` | Application-specific Data | [78](78.md) |
115| `30311` | Live Event | [53](53.md) |
116| `30402` | Classified Listing | [99](99.md) |
117| `30403` | Draft Classified Listing | [99](99.md) |
118| `31989` | Handler recommendation | [89](89.md) |
119| `31990` | Handler information | [89](89.md) |
120
121### Event Kind Ranges
122
123| range | description | NIP |
124| ---------------- | -------------------------------- | ----------- |
125| `1000`--`9999` | Regular Events | [16](16.md) |
126| `10000`--`19999` | Replaceable Events | [16](16.md) |
127| `20000`--`29999` | Ephemeral Events | [16](16.md) |
128| `30000`--`39999` | Parameterized Replaceable Events | [33](33.md) |
129 161
130## Message types 162## Message types
131 163
@@ -133,67 +165,72 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
133 165
134| type | description | NIP | 166| type | description | NIP |
135| ------- | --------------------------------------------------- | ----------- | 167| ------- | --------------------------------------------------- | ----------- |
168| `EVENT` | used to publish events | [01](01.md) |
169| `REQ` | used to request events and subscribe to new updates | [01](01.md) |
170| `CLOSE` | used to stop previous subscriptions | [01](01.md) |
136| `AUTH` | used to send authentication events | [42](42.md) | 171| `AUTH` | used to send authentication events | [42](42.md) |
137| `CLOSE` | used to stop previous subscriptions | [1](01.md) |
138| `COUNT` | used to request event counts | [45](45.md) | 172| `COUNT` | used to request event counts | [45](45.md) |
139| `EVENT` | used to publish events | [1](01.md) |
140| `REQ` | used to request events and subscribe to new updates | [1](01.md) |
141 173
142### Relay to Client 174### Relay to Client
143 175
144| type | description | NIP | 176| type | description | NIP |
145| -------- | ------------------------------------------------------- | ----------- | 177| -------- | ------------------------------------------------------- | ----------- |
178| `EOSE` | used to notify clients all stored events have been sent | [01](01.md) |
179| `EVENT` | used to send events requested to clients | [01](01.md) |
180| `NOTICE` | used to send human-readable messages to clients | [01](01.md) |
181| `OK` | used to notify clients if an EVENT was successful | [01](01.md) |
182| `CLOSED` | used to notify clients that a REQ was ended and why | [01](01.md) |
146| `AUTH` | used to send authentication challenges | [42](42.md) | 183| `AUTH` | used to send authentication challenges | [42](42.md) |
147| `COUNT` | used to send requested event counts to clients | [45](45.md) | 184| `COUNT` | used to send requested event counts to clients | [45](45.md) |
148| `EOSE` | used to notify clients all stored events have been sent | [1](01.md) |
149| `EVENT` | used to send events requested to clients | [1](01.md) |
150| `NOTICE` | used to send human-readable messages to clients | [1](01.md) |
151| `OK` | used to notify clients if an EVENT was successful | [20](20.md) |
152 185
153Please update these lists when proposing NIPs introducing new event kinds. 186Please update these lists when proposing NIPs introducing new event kinds.
154 187
155When experimenting with kinds, keep in mind the classification introduced by [NIP-16](16.md) and [NIP-33](33.md).
156
157## Standardized Tags 188## Standardized Tags
158 189
159| name | value | other parameters | NIP | 190| name | value | other parameters | NIP |
160| ----------------- | ------------------------------------ | -------------------- | ------------------------ | 191| ----------------- | ------------------------------------ | -------------------- | ------------------------------------- |
161| `a` | coordinates to an event | relay URL | [33](33.md), [23](23.md) | 192| `e` | event id (hex) | relay URL, marker | [01](01.md), [10](10.md) |
162| `alt` | Alt tag | -- | [31](31.md) | 193| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) |
163| `d` | identifier | -- | [33](33.md) | 194| `a` | coordinates to an event | relay URL | [01](01.md) |
164| `e` | event id (hex) | relay URL, marker | [1](01.md), [10](10.md) | 195| `d` | identifier | -- | [01](01.md) |
165| `g` | geohash | -- | [12](12.md) | 196| `g` | geohash | -- | [52](52.md) |
166| `i` | identity | proof | [39](39.md) | 197| `i` | identity | proof | [39](39.md) |
167| `k` | kind number (string) | -- | [18](18.md) | 198| `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) |
168| `l` | label, label namespace | annotations | [32](32.md) | 199| `l` | label, label namespace | annotations | [32](32.md) |
169| `L` | label namespace | -- | [32](32.md) | 200| `L` | label namespace | -- | [32](32.md) |
170| `p` | pubkey (hex) | relay URL | [1](01.md) | 201| `m` | MIME type | -- | [94](94.md) |
171| `r` | a reference (URL, etc) | -- | [12](12.md) | 202| `r` | a reference (URL, etc) | petname | |
172| `t` | hashtag | -- | [12](12.md) | 203| `r` | relay url | marker | [65](65.md) |
173| `amount` | millisats | -- | [57](57.md) | 204| `t` | hashtag | -- | |
174| `bolt11` | `bolt11` invoice | -- | [57](57.md) | 205| `alt` | summary | -- | [31](31.md) |
175| `challenge` | challenge string | -- | [42](42.md) | 206| `amount` | millisatoshis, stringified | -- | [57](57.md) |
176| `content-warning` | reason | -- | [36](36.md) | 207| `bolt11` | `bolt11` invoice | -- | [57](57.md) |
177| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | 208| `challenge` | challenge string | -- | [42](42.md) |
178| `description` | badge description | -- | [58](58.md) | 209| `client` | name, address | relay URL | [89](89.md) |
179| `description` | invoice description | -- | [57](57.md) | 210| `content-warning` | reason | -- | [36](36.md) |
180| `emoji` | shortcode, image URL | -- | [30](30.md) | 211| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) |
181| `expiration` | unix timestamp (string) | -- | [40](40.md) | 212| `description` | invoice/badge description | -- | [57](57.md), [58](58.md) |
182| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | 213| `emoji` | shortcode, image URL | -- | [30](30.md) |
183| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | 214| `encrypted` | -- | -- | [90](90.md) |
184| `location` | location string | -- | [99](99.md) | 215| `expiration` | unix timestamp (string) | -- | [40](40.md) |
185| `name` | badge name | -- | [58](58.md) | 216| `goal` | event id (hex) | relay URL | [75](75.md) |
186| `nonce` | random | -- | [13](13.md) | 217| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) |
187| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | 218| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) |
188| `price` | price | currency, frequency | [99](99.md) | 219| `location` | location string | -- | [52](52.md), [99](99.md) |
189| `published_at` | unix timestamp (string) | -- | [23](23.md) | 220| `name` | badge name | -- | [58](58.md) |
190| `relay` | relay url | -- | [42](42.md) | 221| `nonce` | random | -- | [13](13.md) |
191| `relays` | relay list | -- | [57](57.md) | 222| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) |
192| `subject` | subject | -- | [14](14.md) | 223| `price` | price | currency, frequency | [99](99.md) |
193| `summary` | article summary | -- | [23](23.md) | 224| `proxy` | external ID | protocol | [48](48.md) |
194| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | 225| `published_at` | unix timestamp (string) | -- | [23](23.md) |
195| `title` | article title | -- | [23](23.md) | 226| `relay` | relay url | -- | [42](42.md) |
196| `zap` | profile name | type of value | [57](57.md) | 227| `relays` | relay list | -- | [57](57.md) |
228| `server` | file storage server url | -- | [96](96.md) |
229| `subject` | subject | -- | [14](14.md) |
230| `summary` | article summary | -- | [23](23.md) |
231| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) |
232| `title` | article title | -- | [23](23.md) |
233| `zap` | pubkey (hex), relay URL | weight | [57](57.md) |
197 234
198## Criteria for acceptance of NIPs 235## Criteria for acceptance of NIPs
199 236
@@ -203,21 +240,26 @@ When experimenting with kinds, keep in mind the classification introduced by [NI
2034. There should be no more than one way of doing the same thing. 2404. There should be no more than one way of doing the same thing.
2045. Other rules will be made up when necessary. 2415. Other rules will be made up when necessary.
205 242
206## Mailing Lists 243## Is this repository a centralizing factor?
244
245To 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.
246
247It 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.
207 248
208The nostr ecosystem is getting large with many different organizations, relays 249There 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.
209and clients. Following the nips repo on github is becoming more difficult and
210noisy. To coordinate on protocol development outside of github, there are
211mailing lists where you can work on NIPs before submitting them here:
212 250
213* [w3c nostr community group][w3-nostr] - [public-nostr@w3.org][mailto-w3] - requires signup 251## How this repository works
214* [nostr-protocol google group][nostr-google-group] - [nostr-protocol@googlegroups.com][mailto-google] - no signup required
215 252
216[w3-nostr]: https://www.w3.org/community/nostr/ 253Standards 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.
217[mailto-w3]: mailto:public-nostr@w3.org 254
218[nostr-google-group]: https://groups.google.com/g/nostr-protocol 255These 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.
219[mailto-google]: mailto:nostr-protocol@googlegroups.com
220 256
221## License 257## License
222 258
223All NIPs are public domain. 259All NIPs are public domain.
260
261## Contributors
262
263<a align="center" href="https://github.com/nostr-protocol/nips/graphs/contributors">
264 <img src="https://contrib.rocks/image?repo=nostr-protocol/nips" />
265</a>