upleb.uk

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

summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSemisol <45574030+Semisol@users.noreply.github.com>2023-11-19 01:45:41 +0100
committerGitHub <noreply@github.com>2023-11-19 01:45:41 +0100
commitda19c078ab892b578a5c35968443205c9e8ac27f (patch)
tree17a9f4f3105acdae234d3bc67e42571aed261fa2
parent4d709d1804de45bab3739ce814d4b0c0b211c273 (diff)
parent5dcfe85306434f21ecb1e7a47edd92b2e3e64f9a (diff)
Merge branch 'master' into clarify-json-serialization
-rw-r--r--01.md124
-rw-r--r--02.md2
-rw-r--r--03.md31
-rw-r--r--04.md2
-rw-r--r--05.md6
-rw-r--r--06.md18
-rw-r--r--07.md7
-rw-r--r--08.md2
-rw-r--r--09.md2
-rw-r--r--10.md20
-rw-r--r--11.md176
-rw-r--r--12.md37
-rw-r--r--13.md10
-rw-r--r--14.md14
-rw-r--r--15.md232
-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.md8
-rw-r--r--23.md16
-rw-r--r--24.md41
-rw-r--r--25.md35
-rw-r--r--26.md2
-rw-r--r--27.md2
-rw-r--r--28.md48
-rw-r--r--30.md2
-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.md16
-rw-r--r--45.md26
-rw-r--r--46.md2
-rw-r--r--47.md2
-rw-r--r--48.md60
-rw-r--r--50.md2
-rw-r--r--51.md53
-rw-r--r--52.md209
-rw-r--r--53.md122
-rw-r--r--56.md16
-rw-r--r--57.md24
-rw-r--r--58.md12
-rw-r--r--65.md86
-rw-r--r--72.md101
-rw-r--r--75.md81
-rw-r--r--78.md2
-rw-r--r--84.md42
-rw-r--r--89.md99
-rw-r--r--90.md230
-rw-r--r--94.md21
-rw-r--r--98.md44
-rw-r--r--99.md85
-rw-r--r--README.md247
58 files changed, 1990 insertions, 872 deletions
diff --git a/01.md b/01.md
index 0840f2e..e6505f5 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
@@ -19,23 +19,22 @@ The only object type that exists is the `event`, which has the following format
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 (which is described below) 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>,
@@ -55,9 +54,63 @@ To prevent implementation differences from creating a different event ID for the
55 - A form feed, `0x0C`, as `\f` 54 - A form feed, `0x0C`, as `\f`
56- UTF-8 should be used for encoding. 55- UTF-8 should be used for encoding.
57 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```json
62{
63 ...,
64 "tags": [
65 ["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://nostr.example.com"],
66 ["p", "f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca"],
67 ["a", "30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"],
68 ["alt", "reply"],
69 ...
70 ],
71 ...
72}
73```
74
75The 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.
76
77This NIP defines 3 standard tags that can be used across all event kinds with the same meaning. They are as follows:
78
79- The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, <recommended relay URL, optional>]`
80- The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, <recommended relay URL, optional>]`
81- The `a` tag, used to refer to a (maybe parameterized) replaceable event
82 - for a parameterized replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]`
83 - for a non-parameterized replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:, <recommended relay URL, optional>]`
84
85As 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.
86
87### Kinds
88
89Kinds 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:
90
91- `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.
92- `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.
93
94And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation:
95
96- for kind `n` such that `1000 <= n < 10000`, events are **regular**, which means they're all expected to be stored by relays.
97- 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.
98- for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays.
99- 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.
100
101In 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.
102
103When 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.
104
105These are just conventions and relay implementations may differ.
106
58## Communication between clients and relays 107## Communication between clients and relays
59 108
60Relays expose a websocket endpoint to which clients can connect. 109Relays 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.
110
111### Meaning of WebSocket status codes
112
113- When a websocket is closed by the relay with a status code `4000` that means the client shouldn't try to connect again.
61 114
62### From client to relay: sending events and creating subscriptions 115### From client to relay: sending events and creating subscriptions
63 116
@@ -67,59 +120,56 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th
67 * `["REQ", <subscription_id>, <filters JSON>...]`, used to request events and subscribe to new updates. 120 * `["REQ", <subscription_id>, <filters JSON>...]`, used to request events and subscribe to new updates.
68 * `["CLOSE", <subscription_id>]`, used to stop previous subscriptions. 121 * `["CLOSE", <subscription_id>]`, used to stop previous subscriptions.
69 122
70`<subscription_id>` is an arbitrary, non-empty string of max length 64 chars, that should be used to represent a subscription. 123`<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.
71 124
72`<filters>` is a JSON object that determines what events will be sent in that subscription, it can have the following attributes: 125`<filters>` is a JSON object that determines what events will be sent in that subscription, it can have the following attributes:
73 126
74```json 127```json
75{ 128{
76 "ids": <a list of event ids or prefixes>, 129 "ids": <a list of event ids>,
77 "authors": <a list of pubkeys or prefixes, the pubkey of an event must be one of these>, 130 "authors": <a list of lowercase pubkeys, the pubkey of an event must be one of these>,
78 "kinds": <a list of a kind numbers>, 131 "kinds": <a list of a kind numbers>,
79 "#e": <a list of event ids that are referenced in an "e" tag>, 132 "#<single-letter (a-zA-Z)>": <a list of tag values, for #e — a list of event ids, for #p — a list of event pubkeys etc>,
80 "#p": <a list of pubkeys that are referenced in a "p" tag>,
81 "since": <an integer unix timestamp in seconds, events must be newer than this to pass>, 133 "since": <an integer unix timestamp in seconds, events must be newer than this to pass>,
82 "until": <an integer unix timestamp in seconds, events must be older than this to pass>, 134 "until": <an integer unix timestamp in seconds, events must be older than this to pass>,
83 "limit": <maximum number of events to be returned in the initial query> 135 "limit": <maximum number of events relays SHOULD return in the initial query>
84} 136}
85``` 137```
86 138
87Upon 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. 139Upon 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.
140
141Filter 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.
88 142
89Filter 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. 143The `ids`, `authors`, `#e` and `#p` filter lists MUST contain exact 64-character lowercase hex values.
90 144
91The `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. 145The `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.
92 146
93All conditions of a filter that are specified must match for an event for it to pass the filter, i.e., multiple conditions are interpreted as `&&` conditions. 147All conditions of a filter that are specified must match for an event for it to pass the filter, i.e., multiple conditions are interpreted as `&&` conditions.
94 148
95A `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. 149A `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.
96 150
97The `limit` property of a filter is only valid for the initial query and can be ignored afterward. When `limit: n` is present it is assumed that the events returned in the initial query will be the latest `n` events. It is safe to return less events than `limit` specifies, but it is expected that relays do not return (much) more events than requested so clients don't get unnecessarily overwhelmed by data. 151The `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.
98 152
99### From relay to client: sending events and notices 153### From relay to client: sending events and notices
100 154
101Relays can send 3 types of messages, which must also be JSON arrays, according to the following patterns: 155Relays can send 4 types of messages, which must also be JSON arrays, according to the following patterns:
102 156
103 * `["EVENT", <subscription_id>, <event JSON as defined above>]`, used to send events requested by clients. 157 * `["EVENT", <subscription_id>, <event JSON as defined above>]`, used to send events requested by clients.
158 * `["OK", <event_id>, <true|false>, <message>]`, used to indicate acceptance or denial of an `EVENT` message.
104 * `["EOSE", <subscription_id>]`, used to indicate the _end of stored events_ and the beginning of events newly received in real-time. 159 * `["EOSE", <subscription_id>]`, used to indicate the _end of stored events_ and the beginning of events newly received in real-time.
105 * `["NOTICE", <message>]`, used to send human-readable error messages or other things to clients. 160 * `["NOTICE", <message>]`, used to send human-readable error messages or other things to clients.
106 161
107This NIP defines no rules for how `NOTICE` messages should be sent or treated. 162This NIP defines no rules for how `NOTICE` messages should be sent or treated.
108 163
109`EVENT` messages MUST be sent only with a subscription ID related to a subscription previously initiated by the client (using the `REQ` message above). 164- `EVENT` messages MUST be sent only with a subscription ID related to a subscription previously initiated by the client (using the `REQ` message above).
110 165- `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. The standardized machine-readable prefixes are: `duplicate`, `pow`, `blocked`, `rate-limited`, `invalid`, and `error` for when none of that fits. Some examples:
111## Basic Event Kinds 166
112 167 * `["OK", "b1a649ebe8...", true, ""]`
113 - `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. 168 * `["OK", "b1a649ebe8...", true, "pow: difficulty 25>=24"]`
114 - `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. 169 * `["OK", "b1a649ebe8...", true, "duplicate: already have this event"]`
115 - `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. 170 * `["OK", "b1a649ebe8...", false, "blocked: you are banned from posting here"]`
116 171 * `["OK", "b1a649ebe8...", false, "blocked: please register your pubkey at https://my-expensive-relay.example.com"]`
117A 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. 172 * `["OK", "b1a649ebe8...", false, "rate-limited: slow down there chief"]`
118 173 * `["OK", "b1a649ebe8...", false, "invalid: event creation date is too far off from the current time. Is your system clock in sync?"]`
119## Other Notes: 174 * `["OK", "b1a649ebe8...", false, "pow: difficulty 26 is less than 30"]`
120 175 * `["OK", "b1a649ebe8...", false, "error: could not connect to the database"]`
121- 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.
122- The `tags` array can store a tag identifier as the first element of each subarray, plus arbitrary information afterward (always as strings). This NIP defines `"p"` — meaning "pubkey", which points to a pubkey of someone that is referred to in the event —, and `"e"` — meaning "event", which points to the id of an event this event is quoting, replying to or referring to somehow. See [NIP-10](10.md) for a detailed description of "e" and "p" tags.
123- 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.
124- 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.
125- When a websocket is closed by the relay with a status code 4000 that means the client shouldn't try to connect again.
diff --git a/02.md b/02.md
index 2f19908..0653d06 100644
--- a/02.md
+++ b/02.md
@@ -4,7 +4,7 @@ NIP-02
4Contact List and Petnames 4Contact List and Petnames
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 "contact list" is defined as having a list of `p` tags, one for each of the followed/known profiles one is following.
10 10
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..bf6767b 100644
--- a/04.md
+++ b/04.md
@@ -4,7 +4,7 @@ NIP-04
4Encrypted Direct Message 4Encrypted Direct Message
5------------------------ 5------------------------
6 6
7`final` `optional` `author:arcbtc` 7`final` `optional`
8 8
9A special event with kind `4`, meaning "encrypted direct message". It is supposed to have the following attributes: 9A special event with kind `4`, meaning "encrypted direct message". It is supposed to have the following attributes:
10 10
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..01af6f4 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,7 +12,7 @@ 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:
@@ -33,3 +33,6 @@ async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext
33- [AKA Profiles](https://github.com/neilck/aka-extension) (Chrome, stores multiple keys) 33- [AKA Profiles](https://github.com/neilck/aka-extension) (Chrome, stores multiple keys)
34- [TokenPocket](https://www.tokenpocket.pro/) (Android, IOS, Chrome and derivatives) 34- [TokenPocket](https://www.tokenpocket.pro/) (Android, IOS, Chrome and derivatives)
35- [Nostrmo](https://github.com/haorendashu/nostrmo_faq#download) (Android, IOS) 35- [Nostrmo](https://github.com/haorendashu/nostrmo_faq#download) (Android, IOS)
36- [Spring Browser](https://spring.site) (Android)
37- [nodestr](https://github.com/lightning-digital-entertainment/nodestr) (NodeJS polyfill)
38- [Nostore](https://apps.apple.com/us/app/nostore/id1666553677) (Safari on iOS/MacOS)
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..f92410f 100644
--- a/09.md
+++ b/09.md
@@ -4,7 +4,7 @@ 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
diff --git a/10.md b/10.md
index 6494796..5b19fbd 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 citings 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..ab05f31 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,21 @@ 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 "created_at_lower_limit": 31536000,
84 } 83 "created_at_upper_limit": 3
85... 84 },
85 ...
86} 86}
87``` 87```
88 88
@@ -102,9 +102,6 @@ Must be one or higher.
102 102
103- `max_subid_length`: maximum length of subscription id as a string. 103- `max_subid_length`: maximum length of subscription id as a string.
104 104
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. 105- `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 106This 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 107of events from a single subscription filter. This clamping is typically done silently
@@ -118,7 +115,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 115serializing into JSON it may be larger (in bytes), and is still
119subject to the `max_message_length`, if defined. 116subject to the `max_message_length`, if defined.
120 117
121- `min_pow_difficulty`: new events will require at least this difficulty of PoW, 118- `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. 119based on [NIP-13](13.md), or they will be rejected by this server.
123 120
124- `auth_required`: this relay requires [NIP-42](42.md) authentication 121- `auth_required`: this relay requires [NIP-42](42.md) authentication
@@ -127,9 +124,13 @@ Even if set to False, authentication may be required for specific actions.
127 124
128- `payment_required`: this relay requires payment before a new connection may perform any action. 125- `payment_required`: this relay requires payment before a new connection may perform any action.
129 126
130### Event Retention ### 127- `created_at_lower_limit`: 'created_at' lower limit as defined in [NIP-22](22.md)
128
129- `created_at_upper_limit`: 'created_at' upper limit as defined in [NIP-22](22.md)
130
131### Event Retention
131 132
132There may be a cost associated with storing data forever, so relays 133There may be a cost associated with storing data forever, so relays
133may wish to state retention times. The values stated here are defaults 134may wish to state retention times. The values stated here are defaults
134for unauthenticated users and visitors. Paid users would likely have 135for unauthenticated users and visitors. Paid users would likely have
135other policies. 136other policies.
@@ -140,18 +141,16 @@ all, and preferably an error will be provided when those are received.
140 141
141```json 142```json
142{ 143{
143...
144 "retention": [ 144 "retention": [
145 { "kinds": [0, 1, [5, 7], [40, 49]], "time": 3600 }, 145 {"kinds": [0, 1, [5, 7], [40, 49]], "time": 3600},
146 { "kinds": [[40000, 49999]], "time": 100 }, 146 {"kinds": [[40000, 49999]], "time": 100},
147 { "kinds": [[30000, 39999]], "count": 1000 }, 147 {"kinds": [[30000, 39999]], "count": 1000},
148 { "time": 3600, "count": 10000 } 148 {"time": 3600, "count": 10000}
149 ] 149 ]
150...
151} 150}
152``` 151```
153 152
154`retention` is a list of specifications: each will apply to either all kinds, or 153`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 154a 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` 155start and end values. Events of indicated kind (or all) are then limited to a `count`
157and/or time period. 156and/or time period.
@@ -161,11 +160,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 160While that is unfortunate, it does allow clients to discover servers that will
162support their protocol quickly via a single HTTP fetch. 161support their protocol quickly via a single HTTP fetch.
163 162
164There is no need to specify retention times for _ephemeral events_ as defined 163There 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 164
167 165### Content Limitations
168### Content Limitations ###
169 166
170Some relays may be governed by the arbitrary laws of a nation state. This 167Some 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 168may limit what content can be stored in cleartext on those relays. All
@@ -184,9 +181,8 @@ flexibility is up to the client software.
184 181
185```json 182```json
186{ 183{
187...
188 "relay_countries": [ "CA", "US" ], 184 "relay_countries": [ "CA", "US" ],
189... 185 ...
190} 186}
191``` 187```
192 188
@@ -198,7 +194,7 @@ country of the legal entities who own the relay, so it's very
198likely a number of countries are involved. 194likely a number of countries are involved.
199 195
200 196
201### Community Preferences ### 197### Community Preferences
202 198
203For public text notes at least, a relay may try to foster a 199For public text notes at least, a relay may try to foster a
204local community. This would encourage users to follow the global 200local community. This would encourage users to follow the global
@@ -207,11 +203,10 @@ To support this goal, relays MAY specify some of the following values.
207 203
208```json 204```json
209{ 205{
210... 206 "language_tags": ["en", "en-419"],
211 "language_tags": [ "en", "en-419" ], 207 "tags": ["sfw-only", "bitcoin-only", "anime"],
212 "tags": [ "sfw-only", "bitcoin-only", "anime" ],
213 "posting_policy": "https://example.com/posting-policy.html", 208 "posting_policy": "https://example.com/posting-policy.html",
214... 209 ...
215} 210}
216``` 211```
217 212
@@ -238,60 +233,75 @@ detail and legal terms. Use the `tags` field to signify limitations
238on content, or topics to be discussed, which could be machine 233on content, or topics to be discussed, which could be machine
239processed by appropriate client software. 234processed by appropriate client software.
240 235
241### Pay-To-Relay ### 236### Pay-to-Relay
242 237
243Relays that require payments may want to expose their fee schedules. 238Relays that require payments may want to expose their fee schedules.
244 239
245```json 240```json
246{ 241{
247...
248 "payments_url": "https://my-relay/payments", 242 "payments_url": "https://my-relay/payments",
249 "fees": { 243 "fees": {
250 "admission": [{ "amount": 1000000, "unit": "msats" }], 244 "admission": [{ "amount": 1000000, "unit": "msats" }],
251 "subscription": [{ "amount": 5000000, "unit": "msats", "period": 2592000 }], 245 "subscription": [{ "amount": 5000000, "unit": "msats", "period": 2592000 }],
252 "publication": [{ "kinds": [4], "amount": 100, "unit": "msats" }], 246 "publication": [{ "kinds": [4], "amount": 100, "unit": "msats" }],
253 }, 247 },
254... 248 ...
255} 249}
256``` 250```
257 251
258### Icon ### 252### Icon
259 253
260A URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape. 254A URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape.
261 255
262```json 256```json
263{ 257{
264...
265 "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg", 258 "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg",
266... 259 ...
267} 260}
268``` 261```
269 262
270### Examples ### 263### Examples
271As of 2 May 2023 the following `curl` command provided these results. 264
272 265As of 2 May 2023 the following command provided these results:
273 >curl -H "Accept: application/nostr+json" https://eden.nostr.land 266
274 267```
275 {"name":"eden.nostr.land", 268~> curl -H "Accept: application/nostr+json" https://eden.nostr.land | jq
276 "description":"Eden Nostr Land - Toronto 1-01", 269
277 "pubkey":"00000000827ffaa94bfea288c3dfce4422c794fbb96625b6b31e9049f729d700", 270{
278 "contact":"me@ricardocabral.io", 271 "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], 272 "name": "nostr.land",
280 "supported_nip_extensions":["11a"], 273 "pubkey": "52b4a076bcbbbdc3a1aefa3735816cf74993b1b8db202b01c883c58be7fad8bd",
281 "software":"git+https://github.com/Cameri/nostream.git", 274 "software": "custom",
282 "version":"1.22.6", 275 "supported_nips": [
283 "limitation":{"max_message_length":1048576, 276 1,
284 "max_subscriptions":10, 277 2,
285 "max_filters":2500, 278 4,
286 "max_limit":5000, 279 9,
287 "max_subid_length":256, 280 11,
288 "min_prefix":4, 281 12,
289 "max_event_tags":2500, 282 16,
290 "max_content_length":65536, 283 20,
291 "min_pow_difficulty":0, 284 22,
292 "auth_required":false, 285 28,
293 "payment_required":true}, 286 33,
294 "payments_url":"https://eden.nostr.land/invoices", 287 40
295 "fees":{"admission":[{"amount":5000000,"unit":"msats"}], 288 ],
296 "publication":[]}}, 289 "version": "1.0.1",
297 "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg" 290 "limitation": {
291 "payment_required": true,
292 "max_message_length": 65535,
293 "max_event_tags": 2000,
294 "max_subscriptions": 20,
295 "auth_required": false
296 },
297 "payments_url": "https://eden.nostr.land",
298 "fees": {
299 "subscription": [
300 {
301 "amount": 2500000,
302 "unit": "msats",
303 "period": 2592000
304 }
305 ]
306 },
307}
diff --git a/12.md b/12.md
index 74c9d81..bf0eda9 100644
--- a/12.md
+++ b/12.md
@@ -4,39 +4,6 @@ NIP-12
4Generic Tag Queries 4Generic Tag Queries
5------------------- 5-------------------
6 6
7`draft` `optional` `author:scsibug` `author:fiatjaf` 7`final` `mandatory`
8 8
9Relays may support subscriptions over arbitrary tags. `NIP-01` requires relays to respond to queries for `e` and `p` tags. This NIP allows any single-letter tag present in an event to be queried. 9Moved to [NIP-01](01.md).
10
11The `<filters>` object described in `NIP-01` is expanded to contain arbitrary keys with a `#` prefix. Any single-letter key in a filter beginning with `#` is a tag query, and MUST have a value of an array of strings. The filter condition matches if the event has a tag with the same name, and there is at least one tag value in common with the filter and event. The tag name is the letter without the `#`, and the tag value is the second element. Subsequent elements are ignored for the purposes of tag queries.
12
13Example Subscription Filter
14---------------------------
15
16The following provides an example of a filter that matches events of kind `1` with an `r` tag set to either `foo` or `bar`.
17
18```
19{
20 "kinds": [1],
21 "#r": ["foo", "bar"]
22}
23```
24
25Client Behavior
26---------------
27
28Clients SHOULD use the `supported_nips` field to learn if a relay supports generic tag queries. Clients MAY send generic tag queries to any relay, if they are prepared to filter out extraneous responses from relays that do not support this NIP.
29
30Rationale
31---------
32
33The decision to reserve only single-letter tags to be usable in queries allow applications to make use of tags for all sorts of metadata, as it is their main purpose, without worrying that they might be bloating relay indexes. That also makes relays more lightweight, of course. And if some application or user is abusing single-letter tags with the intention of bloating relays that becomes easier to detect as single-letter tags will hardly be confused with some actually meaningful metadata some application really wanted to attach to the event with no spammy intentions.
34
35Suggested Use Cases
36-------------------
37
38Motivating examples for generic tag queries are provided below. This NIP does not promote or standardize the use of any specific tag for any purpose.
39
40* Decentralized Commenting System: clients can comment on arbitrary web pages, and easily search for other comments, by using a `r` ("reference", in this case an URL) tag and value.
41* Location-specific Posts: clients can use a `g` ("geohash") tag to associate a post with a physical location. Clients can search for a set of geohashes of varying precisions near them to find local content.
42* Hashtags: clients can use simple `t` ("hashtag") tags to associate an event with an easily searchable topic name. Since Nostr events themselves are not searchable through the protocol, this provides a mechanism for user-driven search.
diff --git a/13.md b/13.md
index 360bde6..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 0b37e8a..480c4c5 100644
--- a/14.md
+++ b/14.md
@@ -1,19 +1,21 @@
1NIP-14 1NIP-14
2====== 2======
3 3
4Subject tag in Text events. 4Subject tag in Text events
5--------------------------- 5--------------------------
6 6
7`draft` `optional` `author:unclebobmartin` 7`draft` `optional`
8 8
9This NIP defines the use of the "subject" tag in text (kind: 1) events. 9This NIP defines the use of the "subject" tag in text (kind: 1) events.
10(implemented in more-speech) 10(implemented in more-speech)
11 11
12`["subject": <string>]` 12```json
13["subject": <string>]
14```
13 15
14Browsers often display threaded lists of messages. The contents of the subject tag can be used in such lists, instead of the more ad hoc approach of using the first few words of the message. This is very similar to the way email browsers display lists of incoming emails by subject rather than by contents. 16Browsers often display threaded lists of messages. The contents of the subject tag can be used in such lists, instead of the more ad hoc approach of using the first few words of the message. This is very similar to the way email browsers display lists of incoming emails by subject rather than by contents.
15 17
16When replying to a message with a subject, clients SHOULD replicate the subject tag. Clients MAY adorn the subject to denote 18When replying to a message with a subject, clients SHOULD replicate the subject tag. Clients MAY adorn the subject to denote
17that it is a reply. e.g. by prepending "Re:". 19that it is a reply. e.g. by prepending "Re:".
18 20
19Subjects should generally be shorter than 80 chars. Long subjects will likely be trimmed by clients. 21Subjects should generally be shorter than 80 chars. Long subjects will likely be trimmed by clients.
diff --git a/15.md b/15.md
index f8df328..51b7792 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,84 +33,109 @@ 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 abailability, 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
@@ -130,29 +155,29 @@ The below json goes in content of [NIP04](https://github.com/nostr-protocol/nips
130 155
131```json 156```json
132{ 157{
133 "id": <String, UUID generated by the customer>, 158 "id": <string, id generated by the customer>,
134 "type": 0, 159 "type": 0,
135 "name": <String (optional), ???>, 160 "name": <string (optional), ???>,
136 "address": <String (optional), for physical goods an address should be provided> 161 "address": <string (optional), for physical goods an address should be provided>
137 "message": "<String (optional), message for merchant>, 162 "message": "<string (optional), message for merchant>,
138 "contact": { 163 "contact": {
139 "nostr": <32-bytes hex of a pubkey>, 164 "nostr": <32-bytes hex of a pubkey>,
140 "phone": <String (optional), if the customer wants to be contacted by phone>, 165 "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>, 166 "email": <string (optional), if the customer wants to be contacted by email>,
142 }, 167 },
143 "items": [ 168 "items": [
144 { 169 {
145 "product_id": <String, UUID of the product>, 170 "product_id": <string, id of the product>,
146 "quantity": <int, how many products the customer is ordering> 171 "quantity": <int, how many products the customer is ordering>
147 } 172 }
148 ], 173 ],
149 "shipping_id": <String, UUID of the shipping zone> 174 "shipping_id": <string, id of the shipping zone>
150} 175}
151 176
152``` 177```
153 178
154_Open_: is `contact.nostr` required? 179_Open_: is `contact.nostr` required?
155 180
156 181
157### Step 2: `merchant` request payment (event) 182### Step 2: `merchant` request payment (event)
158 183
@@ -169,23 +194,23 @@ The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/ni
169 194
170```json 195```json
171{ 196{
172 "id": <String, UUID of the order>, 197 "id": <string, id of the order>,
173 "type": 1, 198 "type": 1,
174 "message": <String, message to customer, optional>, 199 "message": <string, message to customer, optional>,
175 "payment_options": [ 200 "payment_options": [
176 { 201 {
177 "type": <String, option type>, 202 "type": <string, option type>,
178 "link": <String, url, btc address, ln invoice, etc> 203 "link": <string, url, btc address, ln invoice, etc>
179 }, 204 },
180 { 205 {
181 "type": <String, option type>, 206 "type": <string, option type>,
182 "link": <String, url, btc address, ln invoice, etc> 207 "link": <string, url, btc address, ln invoice, etc>
183 }, 208 },
184 { 209 {
185 "type": <String, option type>, 210 "type": <string, option type>,
186 "link": <String, url, btc address, ln invoice, etc> 211 "link": <string, url, btc address, ln invoice, etc>
187 } 212 }
188 ] 213 ]
189} 214}
190``` 215```
191 216
@@ -197,13 +222,36 @@ The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/ni
197 222
198```json 223```json
199{ 224{
200 "id": <String, UUID of the order>, 225 "id": <string, id of the order>,
201 "type": 2, 226 "type": 2,
202 "message": <String, message to customer>, 227 "message": <string, message to customer>,
203 "paid": <Bool, true/false has received payment>, 228 "paid": <bool: has received payment>,
204 "shipped": <Bool, true/false has been shipped>, 229 "shipped": <bool: has been shipped>,
205} 230}
206``` 231```
232## Customize Marketplace
233Create a customized user experience using the `naddr` from [NIP-19](https://github.com/nostr-protocol/nips/blob/master/19.md#shareable-identifiers-with-extra-metadata). The use of `naddr` enables easy sharing of marketplace events while incorporating a rich set of metadata. This metadata can include relays, merchant profiles, and more. Subsequently, it allows merchants to be grouped into a market, empowering the market creator to configure the marketplace's user interface and user experience, and share that marketplace. This customization can encompass elements such as market name, description, logo, banner, themes, and even color schemes, offering a tailored and unique marketplace experience.
234
235### Event `30019`: Create or update marketplace UI/UX
236
237**Event Content**
238
239```json
240{
241 "name": <string (optional), market name>,
242 "about": <string (optional), market description>,
243 "ui": {
244 "picture": <string (optional), market logo image URL>,
245 "banner": <string (optional), market logo banner URL>,
246 "theme": <string (optional), market theme>,
247 "darkMode": <bool, true/false>
248 },
249 "merchants": [array of pubkeys (optional)],
250 ...
251}
252```
253
254This event leverages naddr to enable comprehensive customization and sharing of marketplace configurations, fostering a unique and engaging marketplace environment.
207 255
208## Customer support events 256## Customer support events
209 257
@@ -211,4 +259,4 @@ Customer support is handled over whatever communication method was specified. If
211 259
212## Additional 260## Additional
213 261
214Standard data models can be found here <a href="https://raw.githubusercontent.com/lnbits/nostrmarket/main/models.py">here</a> 262Standard 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
index 2172519..06af493 100644
--- a/22.md
+++ b/22.md
@@ -2,13 +2,13 @@ NIP-22
2====== 2======
3 3
4Event `created_at` Limits 4Event `created_at` Limits
5--------------------------- 5-------------------------
6 6
7`draft` `optional` `author:jeffthibault` `author:Giszmo` 7`draft` `optional`
8 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). 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 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. 11If a relay supports this NIP, the relay SHOULD send the client an `OK` result saying the event was not stored for the `created_at` timestamp not being within the permitted limits.
12 12
13Client Behavior 13Client Behavior
14--------------- 14---------------
@@ -22,7 +22,7 @@ This NIP formalizes restrictions on event timestamps as accepted by a relay and
22 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. 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 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. 25_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 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. 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 28
diff --git a/23.md b/23.md
index 4291228..382df83 100644
--- a/23.md
+++ b/23.md
@@ -4,19 +4,23 @@ NIP-23
4Long-form Content 4Long-form Content
5----------------- 5-----------------
6 6
7`draft` `optional` `author:fiatjaf` 7`draft` `optional`
8 8
9This NIP defines `kind:30023` (a parameterized replaceable event according to [NIP-33](33.md)) for long-form text content, generally referred to as "articles" or "blog posts". `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
13### Format 13### Format
14 14
15The `.content` of these events should be a string text in Markdown syntax. 15The `.content` of these events should be a string text in Markdown syntax. To maximize compatibility and readability between different clients and devices, any client that is creating long form notes:
16
17- MUST NOT hard line-break paragraphs of text, such as arbitrary line breaks at 80 column boundaries.
18
19- MUST NOT support adding HTML to Markdown.
16 20
17### Metadata 21### Metadata
18 22
19For the date of the last update the `.created_at` field should be used, for "tags"/"hashtags" (i.e. topics about which the event might be of relevance) the `"t"` event tag should be used, as per NIP-12. 23For the date of the last update the `.created_at` field should be used, for "tags"/"hashtags" (i.e. topics about which the event might be of relevance) the `t` tag should be used, as per NIP-12.
20 24
21Other metadata fields can be added as tags to the event as necessary. Here we standardize 4 that may be useful, although they remain strictly optional: 25Other metadata fields can be added as tags to the event as necessary. Here we standardize 4 that may be useful, although they remain strictly optional:
22 26
@@ -27,11 +31,11 @@ Other metadata fields can be added as tags to the event as necessary. Here we st
27 31
28### Editability 32### Editability
29 33
30These articles are meant to be editable, so they should make use of the replaceability feature of NIP-33 and include a `"d"` tag with an identifier for the article. Clients should take care to only publish and read these events from relays that implement that. If they don't do that they should also take care to hide old versions of the same article they may receive. 34These articles are meant to be editable, so they should make use of the parameterized replaceability feature and include a `d` tag with an identifier for the article. Clients should take care to only publish and read these events from relays that implement that. If they don't do that they should also take care to hide old versions of the same article they may receive.
31 35
32### Linking 36### Linking
33 37
34The article may be linked to using the NIP-19 `naddr` code along with the `"a"` tag (see [NIP-33](33.md) and [NIP-19](19.md)). 38The article may be linked to using the [NIP-19](19.md) `naddr` code along with the `a` tag.
35 39
36### References 40### References
37 41
diff --git a/24.md b/24.md
new file mode 100644
index 0000000..f830b68
--- /dev/null
+++ b/24.md
@@ -0,0 +1,41 @@
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
diff --git a/25.md b/25.md
index f74bcc0..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".
@@ -18,8 +18,9 @@ downvote or dislike on a post. A client MAY also choose to tally likes against
18dislikes in a reddit-like system of upvotes and downvotes, or display them as 18dislikes in a reddit-like system of upvotes and downvotes, or display them as
19separate tallies. 19separate tallies.
20 20
21The `content` MAY be an emoji, in this case it MAY be interpreted as a "like" or "dislike", 21The `content` MAY be an emoji, or [NIP-30](30.md) custom emoji in this case it MAY be interpreted as a "like" or "dislike",
22or the client MAY display this emoji reaction on the post. 22or the client MAY display this emoji reaction on the post. If the `content` is an empty string then the client should
23consider it a "+".
23 24
24Tags 25Tags
25---- 26----
@@ -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,8 +46,31 @@ 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)
48 return ev 53 return ev
49} 54}
55```
56
57Custom Emoji Reaction
58---------------------
59
60The client may specify a custom emoji ([NIP-30](30.md)) `:shortcode:` in the
61reaction content. The client should refer to the emoji tag and render the
62content as an emoji if shortcode is specified.
63
64```json
65{
66 "kind": 7,
67 "content": ":soapbox:",
68 "tags": [
69 ["emoji", "soapbox", "https://gleasonator.com/emoji/Gleasonator/soapbox.png"]
70 ],
71 "pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6",
72 "created_at": 1682790000
73}
74```
75
76The content can be set only one `:shortcode:`. And emoji tag should be one.
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..5a6f84d 100644
--- a/30.md
+++ b/30.md
@@ -4,7 +4,7 @@ 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** and **kind 1** events by including one or more `"emoji"` tags, in the form:
10 10
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..e380e89 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
@@ -24,13 +24,13 @@ A relay may want to require clients to authenticate to access restricted resourc
24This NIP defines a new message, `AUTH`, which relays can send when they support authentication and clients can send to relays when they want 24This NIP defines a new message, `AUTH`, which relays can send when they support authentication and clients can send to relays when they want
25to authenticate. When sent by relays, the message is of the following form: 25to authenticate. When sent by relays, the message is of the following form:
26 26
27``` 27```json
28["AUTH", <challenge-string>] 28["AUTH", <challenge-string>]
29``` 29```
30 30
31And, when sent by clients, of the following form: 31And, when sent by clients, of the following form:
32 32
33``` 33```json
34["AUTH", <signed-event-json>] 34["AUTH", <signed-event-json>]
35``` 35```
36 36
@@ -41,16 +41,12 @@ Relays MUST exclude `kind: 22242` events from being broadcasted to any client.
41 41
42```json 42```json
43{ 43{
44 "id": "...",
45 "pubkey": "...",
46 "created_at": 1669695536,
47 "kind": 22242, 44 "kind": 22242,
48 "tags": [ 45 "tags": [
49 ["relay", "wss://relay.example.com/"], 46 ["relay", "wss://relay.example.com/"],
50 ["challenge", "challengestringhere"] 47 ["challenge", "challengestringhere"]
51 ], 48 ],
52 "content": "", 49 ...
53 "sig": "..."
54} 50}
55``` 51```
56 52
@@ -67,13 +63,13 @@ is expected to last for the duration of the WebSocket connection.
67Upon receiving a message from an unauthenticated user it can't fulfill without authentication, a relay may choose to notify the client. For 63Upon receiving a message from an unauthenticated user it can't fulfill without authentication, a relay may choose to notify the client. For
68that it can use a `NOTICE` or `OK` message with a standard prefix `"restricted: "` that is readable both by humans and machines, for example: 64that it can use a `NOTICE` or `OK` message with a standard prefix `"restricted: "` that is readable both by humans and machines, for example:
69 65
70``` 66```json
71["NOTICE", "restricted: we can't serve DMs to unauthenticated users, does your client implement NIP-42?"] 67["NOTICE", "restricted: we can't serve DMs to unauthenticated users, does your client implement NIP-42?"]
72``` 68```
73 69
74or it can return an `OK` message noting the reason an event was not written using the same prefix: 70or it can return an `OK` message noting the reason an event was not written using the same prefix:
75 71
76``` 72```json
77["OK", <event-id>, false, "restricted: we do not accept events from unauthenticated users, please sign up at https://example.com/"] 73["OK", <event-id>, false, "restricted: we do not accept events from unauthenticated users, please sign up at https://example.com/"]
78``` 74```
79 75
diff --git a/45.md b/45.md
index a525391..998b952 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,36 @@ 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: 30## Examples:
30 31
31``` 32### Followers count
32# Followers count 33
34```json
33["COUNT", <subscription_id>, {"kinds": [3], "#p": [<pubkey>]}] 35["COUNT", <subscription_id>, {"kinds": [3], "#p": [<pubkey>]}]
34["COUNT", <subscription_id>, {"count": 238}] 36["COUNT", <subscription_id>, {"count": 238}]
37```
35 38
36# Count posts and reactions 39### Count posts and reactions
40
41```json
37["COUNT", <subscription_id>, {"kinds": [1, 7], "authors": [<pubkey>]}] 42["COUNT", <subscription_id>, {"kinds": [1, 7], "authors": [<pubkey>]}]
38["COUNT", <subscription_id>, {"count": 5}] 43["COUNT", <subscription_id>, {"count": 5}]
39``` 44```
45
46### Count posts approximately
47
48```
49["COUNT", <subscription_id>, {"kinds": [1]}]
50["COUNT", <subscription_id>, {"count": 93412452, "approximate": true}]
51```
diff --git a/46.md b/46.md
index 90fa1a0..5318541 100644
--- a/46.md
+++ b/46.md
@@ -4,7 +4,7 @@ NIP-46
4Nostr Connect 4Nostr Connect
5------------------------ 5------------------------
6 6
7`draft` `optional` `author:tiero` `author:giowe` `author:vforvalerio87` 7`draft` `optional`
8 8
9## Rationale 9## Rationale
10 10
diff --git a/47.md b/47.md
index b6a4f2b..d4b7c1f 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
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..2bdf1ff 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
diff --git a/51.md b/51.md
index 80cc09e..a8a8e95 100644
--- a/51.md
+++ b/51.md
@@ -2,15 +2,13 @@ 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. 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.
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'. 11If a list should only be defined once per user (like the "mute" list) the list is declared as a _replaceable event_. These lists may be referred to as "replaceable lists". Otherwise, the list is a _parameterized replaceable event_ and the list name will be used as the `d` tag. These lists may be referred to as "parameterized replaceable lists".
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'.
14 12
15## Replaceable List Event Example 13## Replaceable List Event Example
16 14
@@ -86,6 +84,43 @@ Then the user would create a 'Categorized People' list event like below:
86} 84}
87``` 85```
88 86
87Lets say a user wants to create a 'Categorized Bookmarks' list of `bookmarks` and has keys:
88```
89priv: fb505c65d4df950f5d28c9e4d285ee12ffaf315deef1fc24e3c7cd1e7e35f2b1
90pub: b1a5c93edcc8d586566fde53a20bdb50049a97b15483cb763854e57016e0fa3d
91```
92The user wants to publicly include these bookmarks:
93
94```json
95["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://nostr.example.com"],
96["a", "30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"],
97["r", "https://github.com/nostr-protocol/nostr", "Nostr repository"],
98```
99and privately include these bookmarks (below is the JSON that would be encrypted and placed in the event content):
100
101```json
102[
103 ["r", "https://my-private.bookmark", "My private bookmark"],
104 ["a", "30001:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"],
105]
106```
107
108Then the user would create a 'Categorized Bookmarks' list event like below:
109
110```json
111{
112 "kind": 30001,
113 "tags": [
114 ["d", "bookmarks"],
115 ["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://nostr.example.com"],
116 ["a", "30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"],
117 ["r", "https://github.com/nostr-protocol/nostr", "Nostr repository"],
118 ],
119 "content": "y3AyaLJfnmYr9x9Od9o4aYrmL9+Ynmsim5y2ONrU0urOTq+V81CyAthQ2mUOWE9xwGgrizhY7ILdQwWhy6FK0sA33GHtC0egUJw1zIdknPe7BZjznD570yk/8RXYgGyDKdexME+RMYykrnYFxq1+y/h00kmJg4u+Gpn+ZjmVhNYxl9b+TiBOAXG9UxnK/H0AmUqDpcldn6+j1/AiStwYZhD1UZ3jzDIk2qcCDy7MlGnYhSP+kNmG+2b0T/D1L0Z7?iv=PGJJfPE84gacAh7T0e6duQ==",
120 ...other fields
121}
122```
123
89## List Event Kinds 124## List Event Kinds
90 125
91| kind | list type | 126| kind | list type |
@@ -94,6 +129,8 @@ Then the user would create a 'Categorized People' list event like below:
94| 10001 | Pin | 129| 10001 | Pin |
95| 30000 | Categorized People | 130| 30000 | Categorized People |
96| 30001 | Categorized Bookmarks | 131| 30001 | Categorized Bookmarks |
132| 30002 | Categorized Relay Sets |
133
97 134
98### Mute List 135### Mute List
99 136
@@ -109,4 +146,8 @@ An event with kind `30000` is defined as a parameterized replaceable list event
109 146
110### Categorized Bookmarks List 147### Categorized Bookmarks List
111 148
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. 149An event of 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. The bookmark lists may contain metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md). Any standardized tag can be included in a Categorized Bookmark List.
150
151### Categorized Relay Set
152
153An event of kind `30002` is defined as a parameterized replaceable list event for categorizing relays. The 'd' parameter for this event holds the category name of the list. The relays lists may contain metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md). These sets can be used by clients in order to determine which relays to query in different scenarios.
diff --git a/52.md b/52.md
new file mode 100644
index 0000000..15cc8fc
--- /dev/null
+++ b/52.md
@@ -0,0 +1,209 @@
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 is optional and should be a detailed description of the calendar event.
26
27The list of tags are as follows:
28* `d` (required) universally unique identifier (UUID). Generated by the client creating the calendar event.
29* `name` (required) name 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) 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
38```json
39{
40 "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>,
41 "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
42 "created_at": <Unix timestamp in seconds>,
43 "kind": 31922,
44 "content": "<description of calendar event>",
45 "tags": [
46 ["d", "<UUID>"],
47
48 ["name", "<name of calendar event>"],
49
50 // Dates
51 ["start", "<YYYY-MM-DD>"],
52 ["end", "<YYYY-MM-DD>"],
53
54 // Location
55 ["location", "<location>"],
56 ["g", "<geohash>"],
57
58 // Participants
59 ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"],
60 ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"],
61
62 // Hashtags
63 ["t", "<tag>"],
64 ["t", "<tag>"],
65
66 // Reference links
67 ["r", "<url>"],
68 ["r", "<url>"]
69 ]
70}
71```
72
73### Time-Based Calendar Event
74
75This kind of calendar event spans between a start time and end time.
76
77#### Format
78
79The format uses a parameterized replaceable event kind `31923`.
80
81The `.content` of these events is optional and should be a detailed description of the calendar event.
82
83The list of tags are as follows:
84* `d` (required) universally unique identifier (UUID). Generated by the client creating the calendar event.
85* `name` (required) name of the calendar event
86* `start` (required) inclusive start Unix timestamp in seconds. Must be less than `end`, if it exists.
87* `end` (optional) exclusive end Unix timestamp in seconds. If omitted, the calendar event ends instantaneously.
88* `start_tzid` (optional) time zone of the start timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica`
89* `end_tzid` (optional) time zone of the end timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica`. If omitted and `start_tzid` is provided, the time zone of the end timestamp is the same as the start timestamp.
90* `location` (optional) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call
91* `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location
92* `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting
93* `t` (optional, repeated) hashtag to categorize calendar event
94* `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc.
95
96```json
97{
98 "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>,
99 "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
100 "created_at": <Unix timestamp in seconds>,
101 "kind": 31923,
102 "content": "<description of calendar event>",
103 "tags": [
104 ["d", "<UUID>"],
105
106 ["name", "<name of calendar event>"],
107
108 // Timestamps
109 ["start", "<Unix timestamp in seconds>"],
110 ["end", "<Unix timestamp in seconds>"],
111
112 ["start_tzid", "<IANA Time Zone Database identifier>"],
113 ["end_tzid", "<IANA Time Zone Database identifier>"],
114
115 // Location
116 ["location", "<location>"],
117 ["g", "<geohash>"],
118
119 // Participants
120 ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"],
121 ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"],
122
123 // Hashtags
124 ["t", "<tag>"],
125 ["t", "<tag>"],
126
127 // Reference links
128 ["r", "<url>"],
129 ["r", "<url>"]
130 ]
131}
132```
133
134## Calendar
135
136A 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.
137
138### Format
139
140The format uses a custom replaceable list of kind `31924` with a list of tags as described below:
141* `d` (required) calendar name
142* `a` (repeated) reference tag to kind `31922` or `31923` calendar event being responded to
143
144```json
145{
146 "kind": 31924,
147 "tags": [
148 ["d", "<calendar name>"],
149 ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"],
150 ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"]
151 ]
152}
153```
154
155## Calendar Event RSVP
156
157A calendar event RSVP is a response to a calendar event to indicate a user's attendance intention.
158
159If 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.
160
161Any 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.
162
163This 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.
164
165This NIP is also intentionally not defining what happens if a calendar event changes after an RSVP is submitted.
166
167### Format
168
169The format uses a parameterized replaceable event kind `31925`.
170
171The `.content` of these events is optional and should be a free-form note that adds more context to this calendar event response.
172
173The list of tags are as follows:
174* `a` (required) reference tag to kind `31922` or `31923` calendar event being responded to.
175* `d` (required) universally unique identifier. Generated by the client creating the calendar event RSVP.
176* `L` (required) label namespace of `status` per [NIP-32](32.md)
177* `l` (required) label of `accepted`, `declined`, or `tentative` under the label namespace of `status` per [NIP-32](32.md). Determines attendance status to the referenced calendar event.
178* `L` (optional) label namespace of `freebusy` per [NIP-32](32.md). Exists if and only if corresponding `l` tag under the same label namespace exists.
179* `l` (optional) label of `free` or `busy` under the label namespace of `freebusy` per [NIP-32](32.md). Determines if the user would be free or busy for the duration of the calendar event. This tag must be omitted or ignored if the `status` label is set to `declined`. Exists if and only if corresponding `l` tag under the same label namespace exists.
180
181```json
182{
183 "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>,
184 "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
185 "created_at": <Unix timestamp in seconds>,
186 "kind": 31925,
187 "content": "<note>",
188 "tags": [
189 ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"],
190 ["d", "<UUID>"],
191 ["L", "status"],
192 ["l", "<accepted/declined/tentative>", "status"],
193 ["L", "freebusy"],
194 ["l", "<free/busy>", "freebusy"]
195 ]
196}
197```
198
199## Unsolved Limitations
200
201* No private events
202
203## Intentionally Unsupported Scenarios
204
205### Recurring Calendar Events
206
207Recurring 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.
208
209This NIP intentionally omits support for recurring calendar events and pushes that complexity up to clients to manually implement if they desire. i.e., individual calendar events with duplicated metadata represent recurring calendar events.
diff --git a/53.md b/53.md
new file mode 100644
index 0000000..d3cc0af
--- /dev/null
+++ b/53.md
@@ -0,0 +1,122 @@
1NIP-53
2======
3
4Live Activities
5---------------
6
7`draft` `optional`
8
9Service providers want to offer live activities to the Nostr network in such a way that participants can easily logged and queried by clients. This NIP describes a general framework to advertise the involvement of pubkeys in such live activities.
10
11## Concepts
12
13### Live Event
14
15A special event with `kind:30311` "Live Event" is defined as a _parameterized replaceable event_ of public `p` tags. Each `p` tag SHOULD have a **displayable** marker name for the current role (e.g. `Host`, `Speaker`, `Participant`) of the user in the event and the relay information MAY be empty. This event will be constantly updated as participants join and leave the activity.
16
17For example:
18
19```json
20{
21 "kind": 30311,
22 "tags": [
23 ["d", "<unique identifier>"],
24 ["title", "<name of the event>"],
25 ["summary", "<description>"],
26 ["image", "<preview image url>"],
27 ["t", "hashtag"]
28 ["streaming", "<url>"],
29 ["recording", "<url>"], // used to place the edited video once the activity is over
30 ["starts", "<unix timestamp in seconds>"],
31 ["ends", "<unix timestamp in seconds>"],
32 ["status", "<planned, live, ended>"],
33 ["current_participants", "<number>"],
34 ["total_participants", "<number>"],
35 ["p", "91cf9..4e5ca", "wss://provider1.com/", "Host", "<proof>"],
36 ["p", "14aeb..8dad4", "wss://provider2.com/nostr", "Speaker"],
37 ["p", "612ae..e610f", "ws://provider3.com/ws", "Participant"],
38 ["relays", "wss://one.com", "wss://two.com", ...]
39 ],
40 "content": "",
41 ...
42}
43```
44
45A distinct `d` tag should be used for each activity. All other tags are optional.
46
47Providers SHOULD keep the participant list small (e.g. under 1000 users) and, when limits are reached, Providers SHOULD select which participants get named in the event. Clients should not expect a comprehensive list. Once the activity ends, the event can be deleted or updated to summarize the activity and provide async content (e.g. recording of the event).
48
49Clients are expected to subscribe to `kind:30311` events in general or for given follow lists and statuses. Clients MAY display participants' roles in activities as well as access points to join the activity.
50
51Live Activity management clients are expected to constantly update `kind:30311` during the event. Clients MAY choose to consider `status=live` events after 1hr without any update as `ended`. The `starts` and `ends` timestamp SHOULD be updated when the status changes to and from `live`
52
53The activity MUST be linked to using the [NIP-19](19.md) `naddr` code along with the `a` tag.
54
55### Proof of Agreement to Participate
56
57Event owners can add proof as the 5th term in each `p` tag to clarify the participant's agreement in joining the event. The proof is a signed SHA256 of the complete `a` Tag of the event (`kind:pubkey:dTag`) by each `p`'s private key, encoded in hex.
58
59Clients MAY only display participants if the proof is available or MAY display participants as "invited" if the proof is not available.
60
61This feature is important to avoid malicious event owners adding large account holders to the event, without their knowledge, to lure their followers into the malicious owner's trap.
62
63### Live Chat Message
64
65Event `kind:1311` is live chat's channel message. Clients MUST include the `a` tag of the activity with a `root` marker. Other Kind-1 tags such as `reply` and `mention` can also be used.
66
67```json
68{
69 "kind": 1311,
70 "tags": [
71 ["a", "30311:<Community event author pubkey>:<d-identifier of the community>", "<Optional relay url>", "root"],
72 ],
73 "content": "Zaps to live streams is beautiful.",
74 ...
75}
76```
77
78## Use Cases
79
80Common use cases include meeting rooms/workshops, watch-together activities, or event spaces, such as [live.snort.social](https://live.snort.social) and [nostrnests.com](https://nostrnests.com).
81
82## Example
83
84### Live Streaming
85
86```json
87{
88 "id": "57f28dbc264990e2c61e80a883862f7c114019804208b14da0bff81371e484d2",
89 "pubkey": "1597246ac22f7d1375041054f2a4986bd971d8d196d7997e48973263ac9879ec",
90 "created_at": 1687182672,
91 "kind": 30311,
92 "tags": [
93 ["d", "demo-cf-stream"],
94 ["title", "Adult Swim Metalocalypse"],
95 ["summary", "Live stream from IPTV-ORG collection"],
96 ["streaming", "https://adultswim-vodlive.cdn.turner.com/live/metalocalypse/stream.m3u8"],
97 ["starts", "1687182672"]
98 ["status", "live"],
99 ["t", "animation"],
100 ["t", "iptv"],
101 ["image", "https://i.imgur.com/CaKq6Mt.png"]
102 ],
103 "content": "",
104 "sig": "5bc7a60f5688effa5287244a24768cbe0dcd854436090abc3bef172f7f5db1410af4277508dbafc4f70a754a891c90ce3b966a7bc47e7c1eb71ff57640f3d389"
105}
106```
107
108### Live Streaming chat message
109
110```json
111{
112 "id": "97aa81798ee6c5637f7b21a411f89e10244e195aa91cb341bf49f718e36c8188",
113 "pubkey": "3f770d65d3a764a9c5cb503ae123e62ec7598ad035d836e2a810f3877a745b24",
114 "created_at": 1687286726,
115 "kind": 1311,
116 "tags": [
117 ["a", "30311:1597246ac22f7d1375041054f2a4986bd971d8d196d7997e48973263ac9879ec:demo-cf-stream", "", "root"]
118 ],
119 "content": "Zaps to live streams is beautiful.",
120 "sig": "997f62ddfc0827c121043074d50cfce7a528e978c575722748629a4137c45b75bdbc84170bedc723ef0a5a4c3daebf1fef2e93f5e2ddb98e5d685d022c30b622"
121}
122````
diff --git a/56.md b/56.md
index 42174fb..a2861e3 100644
--- a/56.md
+++ b/56.md
@@ -1,16 +1,15 @@
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.
12 11
13The content MAY contain additional information submitted by the entity 12The `content` MAY contain additional information submitted by the entity
14reporting the content. 13reporting the content.
15 14
16Tags 15Tags
@@ -42,9 +41,9 @@ Example events
42{ 41{
43 "kind": 1984, 42 "kind": 1984,
44 "tags": [ 43 "tags": [
45 ["p", <pubkey>, "nudity"] 44 ["p", <pubkey>, "nudity"],
46 ["L", "social.nos.ontology"], 45 ["L", "social.nos.ontology"],
47 ["l", "NS-nud", "social.nos.ontology"], 46 ["l", "NS-nud", "social.nos.ontology"]
48 ], 47 ],
49 "content": "", 48 "content": "",
50 ... 49 ...
@@ -63,10 +62,9 @@ Example events
63{ 62{
64 "kind": 1984, 63 "kind": 1984,
65 "tags": [ 64 "tags": [
66 ["p", <impersonator pubkey>, "impersonation"], 65 ["p", <impersonator pubkey>, "impersonation"]
67 ["p", <victim pubkey>]
68 ], 66 ],
69 "content": "Profile is imitating #[1]", 67 "content": "Profile is impersonating nostr:<victim bech32 pubkey>",
70 ... 68 ...
71} 69}
72``` 70```
@@ -75,7 +73,7 @@ Client behavior
75--------------- 73---------------
76 74
77Clients can use reports from friends to make moderation decisions if they 75Clients can use reports from friends to make moderation decisions if they
78choose to. For instance, if 3+ of your friends report a profile as explicit, 76choose to. For instance, if 3+ of your friends report a profile for `nudity`,
79clients can have an option to automatically blur photos from said account. 77clients can have an option to automatically blur photos from said account.
80 78
81 79
diff --git a/57.md b/57.md
index 438a0f8..2b2c97b 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
@@ -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),
@@ -126,9 +126,9 @@ When receiving a payment, the following steps are executed:
126 126
127The following should be true of the `zap receipt` event: 127The following should be true of the `zap receipt` event:
128 128
129- The content SHOULD be empty. 129- The `content` SHOULD be empty.
130- The `created_at` date SHOULD be set to the invoice `paid_at` date for idempotency. 130- 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`. 131- `tags` MUST include the `p` tag AND optional `e` tag from the `zap request` AND optional `a` tag from the `zap request`.
132- The `zap receipt` MUST have a `bolt11` tag containing the description hash bolt11 invoice. 132- 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. 133- 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. 134- `SHA256(description)` MUST match the description hash in the bolt11 invoice.
@@ -166,18 +166,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). 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 `lnurl` tag of the `zap request` (if present) SHOULD equal the recipient's `lnurl`. 167- The `lnurl` tag of the `zap request` (if present) SHOULD equal the recipient's `lnurl`.
168 168
169### Appendix G: `zap` tag on zapped event 169### Appendix G: `zap` tag on other events
170 170
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`. 171When 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 172
173```json 173```js
174{ 174{
175 "tags": [ 175 "tags": [
176 [ "zap", "pablo@f7z.io", "lud16" ] 176 [ "zap", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2", "wss://nostr.oxtr.dev", "1" ], // 25%
177 [ "zap", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", "wss://nostr.wine/", "1" ], // 25%
178 [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "wss://nos.lol/", "2" ] // 50%
177 ] 179 ]
178} 180}
179``` 181```
180 182
183Clients MAY display the zap split configuration in the note.
184
181## Future Work 185## Future Work
182 186
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. 187Zaps 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..9725c82 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`.
diff --git a/65.md b/65.md
index 4c7a6a5..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..c0fffff
--- /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```json
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```json
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```json
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..f3cf5d0
--- /dev/null
+++ b/75.md
@@ -0,0 +1,81 @@
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
39```json
40{
41 "kind": 9041,
42 "tags": [
43 ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", ...],
44 ["amount", "210000"],
45 ["closed_at", "<unix timestamp in seconds>"],
46 ],
47 "content": "Nostrasia travel expenses",
48 ...
49}
50```
51
52The goal MAY include an `r` or `a` tag linking to a URL or parameterized replaceable event.
53
54The goal MAY include multiple beneficiary pubkeys by specifying [`zap` tags](57.md#appendix-g-zap-tag-on-other-events).
55
56Parameterized replaceable events can link to a goal by using a `goal` tag specifying the event id and an optional relay hint.
57
58```json
59{
60 ...
61 "kind": 3xxxx,
62 "tags": [
63 ...
64 ["goal", "<event id>", "<Relay URL (optional)>"],
65 ],
66 ...
67}
68```
69
70## Client behavior
71
72Clients MAY display funding goals on user profiles.
73
74When zapping a goal event, clients MUST include the relays in the `relays` tag of the goal event in the zap request `relays` tag.
75
76When zapping a parameterized replaceable event with a `goal` tag, clients SHOULD tag the goal event id in the `e` tag of the zap request.
77
78## Use cases
79
80- Fundraising clients
81- 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..be3d075 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 onf the NIP-33 `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 in the same format as the recommendation event's `a` tags. 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", "31990:app1-pubkey:<d-identifier>", "wss://relay1", "ios"]
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..6017c98
--- /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 an 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..95b6a3b 100644
--- a/94.md
+++ b/94.md
@@ -4,7 +4,7 @@ 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
@@ -13,7 +13,7 @@ The purpose of this NIP is to allow an organization and classification of shared
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 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. 18* `x` containing the SHA-256 hexencoded string of the file.
19* `size` (optional) size of file in bytes 19* `size` (optional) size of file in bytes
@@ -21,12 +21,13 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr
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>],
@@ -37,10 +38,14 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr
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/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
new file mode 100644
index 0000000..e65920c
--- /dev/null
+++ b/99.md
@@ -0,0 +1,85 @@
1NIP-99
2======
3
4Classified Listings
5-------------------
6
7`draft` `optional`
8
9This NIP defines `kind:30402`: a parameterized replaceable event to describe classified listings that list any arbitrary product, service, or other thing for sale or offer and includes enough structured metadata to make them useful.
10
11The category of classifieds includes a very broad range of physical goods, services, work opportunities, rentals, free giveaways, personals, etc. and is distinct from the more strictly structured marketplaces defined in [NIP-15](https://github.com/nostr-protocol/nips/blob/master/15.md) that often sell many units of specific products through very specific channels.
12
13The structure of these events is very similar to [NIP-23](https://github.com/nostr-protocol/nips/blob/master/23.md) long-form content events.
14
15### Draft / Inactive Listings
16
17`kind:30403` has the same structure as `kind:30402` and is used to save draft or inactive classified listings.
18
19### Content
20
21The `.content` field should be a description of what is being offered and by whom. These events should be a string in Markdown syntax.
22
23### Author
24
25The `.pubkey` field of these events are treated as the party creating the listing.
26
27### Metadata
28
29- For "tags"/"hashtags" (i.e. categories or keywords of relevance for the listing) the `"t"` event tag should be used, as per [NIP-12](https://github.com/nostr-protocol/nips/blob/master/12.md).
30- For images, whether included in the markdown content or not, clients SHOULD use `image` tags as described in [NIP-58](https://github.com/nostr-protocol/nips/blob/master/58.md). This allows clients to display images in carousel format more easily.
31
32The following tags, used for structured metadata, are standardized and SHOULD be included. Other tags may be added as necessary.
33
34- `"title"`, a title for the listing
35- `"summary"`, for short tagline or summary for the listing
36- `"published_at"`, for the timestamp (in unix seconds – converted to string) of the first time the listing was published.
37- `"location"`, for the location.
38- `"price"`, for the price of the thing being listed. This is an array in the format `[ "price", "<number>", "<currency>", "<frequency>" ]`.
39 - `"price"` is the name of the tag
40 - `"<number>"` is the amount in numeric format (but included in the tag as a string)
41 - `"<currency>"` is the currency unit in 3-character ISO 4217 format or ISO 4217-like currency code (e.g. `"btc"`, `"eth"`).
42 - `"<frequency>"` is optional and can be used to describe recurring payments. SHOULD be in noun format (hour, day, week, month, year, etc.)
43
44#### `price` examples
45
46- $50 one-time payment `["price", "50", "USD"]`
47- €15 per month `["price", "15", "EUR", "month"]`
48- £50,000 per year `["price", "50000", "GBP", "year"]`
49
50Other standard tags that might be useful.
51
52- `"g"`, a geohash for more precise location
53
54## Example Event
55
56```json
57{
58 "kind": 30402,
59 "created_at": 1675642635,
60 // Markdown content
61 "content": "Lorem [ipsum][nostr:nevent1qqst8cujky046negxgwwm5ynqwn53t8aqjr6afd8g59nfqwxpdhylpcpzamhxue69uhhyetvv9ujuetcv9khqmr99e3k7mg8arnc9] dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\n\nRead more at nostr:naddr1qqzkjurnw4ksz9thwden5te0wfjkccte9ehx7um5wghx7un8qgs2d90kkcq3nk2jry62dyf50k0h36rhpdtd594my40w9pkal876jxgrqsqqqa28pccpzu.",
62 "tags": [
63 ["d", "lorem-ipsum"],
64 ["title", "Lorem Ipsum"],
65 ["published_at", "1296962229"],
66 ["t", "electronics"],
67 ["image", "https://url.to.img", "256x256"],
68 ["summary", "More lorem ipsum that is a little more than the title"],
69 ["location", "NYC"],
70 ["price", "100", "USD"],
71 [
72 "e",
73 "b3e392b11f5d4f28321cedd09303a748acfd0487aea5a7450b3481c60b6e4f87",
74 "wss://relay.example.com"
75 ],
76 [
77 "a",
78 "30023:a695f6b60119d9521934a691347d9f78e8770b56da16bb255ee286ddf9fda919:ipsum",
79 "wss://relay.nostr.org"
80 ]
81 ],
82 "pubkey": "...",
83 "id": "..."
84}
85```
diff --git a/README.md b/README.md
index 9893ffc..8e970ea 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---
@@ -30,17 +32,15 @@ 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) 40- [NIP-21: `nostr:` URI scheme](21.md)
41- [NIP-21: `nostr:` URL scheme](21.md)
42- [NIP-22: Event `created_at` Limits](22.md) 41- [NIP-22: Event `created_at` Limits](22.md)
43- [NIP-23: Long-form Content](23.md) 42- [NIP-23: Long-form Content](23.md)
43- [NIP-24: Extra metadata fields and tags](24.md)
44- [NIP-25: Reactions](25.md) 44- [NIP-25: Reactions](25.md)
45- [NIP-26: Delegated Event Signing](26.md) 45- [NIP-26: Delegated Event Signing](26.md)
46- [NIP-27: Text Note References](27.md) 46- [NIP-27: Text Note References](27.md)
@@ -48,77 +48,94 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
48- [NIP-30: Custom Emoji](30.md) 48- [NIP-30: Custom Emoji](30.md)
49- [NIP-31: Dealing with Unknown Events](31.md) 49- [NIP-31: Dealing with Unknown Events](31.md)
50- [NIP-32: Labeling](32.md) 50- [NIP-32: Labeling](32.md)
51- [NIP-33: Parameterized Replaceable Events](33.md)
52- [NIP-36: Sensitive Content](36.md) 51- [NIP-36: Sensitive Content](36.md)
52- [NIP-38: User Statuses](38.md)
53- [NIP-39: External Identities in Profiles](39.md) 53- [NIP-39: External Identities in Profiles](39.md)
54- [NIP-40: Expiration Timestamp](40.md) 54- [NIP-40: Expiration Timestamp](40.md)
55- [NIP-42: Authentication of clients to relays](42.md) 55- [NIP-42: Authentication of clients to relays](42.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)
63- [NIP-53: Live Activities](53.md)
61- [NIP-56: Reporting](56.md) 64- [NIP-56: Reporting](56.md)
62- [NIP-57: Lightning Zaps](57.md) 65- [NIP-57: Lightning Zaps](57.md)
63- [NIP-58: Badges](58.md) 66- [NIP-58: Badges](58.md)
64- [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)
65- [NIP-78: Application-specific data](78.md) 70- [NIP-78: Application-specific data](78.md)
71- [NIP-84: Highlights](84.md)
66- [NIP-89: Recommended Application Handlers](89.md) 72- [NIP-89: Recommended Application Handlers](89.md)
73- [NIP-90: Data Vending Machines](90.md)
67- [NIP-94: File Metadata](94.md) 74- [NIP-94: File Metadata](94.md)
68- [NIP-98: HTTP Auth](98.md) 75- [NIP-98: HTTP Auth](98.md)
76- [NIP-99: Classified Listings](99.md)
69 77
70## Event Kinds 78## Event Kinds
71 79| kind | description | NIP |
72| kind | description | NIP | 80| ------------- | -------------------------- | ----------- |
73| ------- | -------------------------- | ----------- | 81| `0` | Metadata | [1](01.md) |
74| `0` | Metadata | [1](01.md) | 82| `1` | Short Text Note | [1](01.md) |
75| `1` | Short Text Note | [1](01.md) | 83| `2` | Recommend Relay | |
76| `2` | Recommend Relay | [1](01.md) | 84| `3` | Contacts | [2](02.md) |
77| `3` | Contacts | [2](02.md) | 85| `4` | Encrypted Direct Messages | [4](04.md) |
78| `4` | Encrypted Direct Messages | [4](04.md) | 86| `5` | Event Deletion | [9](09.md) |
79| `5` | Event Deletion | [9](09.md) | 87| `6` | Repost | [18](18.md) |
80| `6` | Repost | [18](18.md) | 88| `7` | Reaction | [25](25.md) |
81| `7` | Reaction | [25](25.md) | 89| `8` | Badge Award | [58](58.md) |
82| `8` | Badge Award | [58](58.md) | 90| `16` | Generic Repost | [18](18.md) |
83| `16` | Generic Repost | [18](18.md) | 91| `40` | Channel Creation | [28](28.md) |
84| `40` | Channel Creation | [28](28.md) | 92| `41` | Channel Metadata | [28](28.md) |
85| `41` | Channel Metadata | [28](28.md) | 93| `42` | Channel Message | [28](28.md) |
86| `42` | Channel Message | [28](28.md) | 94| `43` | Channel Hide Message | [28](28.md) |
87| `43` | Channel Hide Message | [28](28.md) | 95| `44` | Channel Mute User | [28](28.md) |
88| `44` | Channel Mute User | [28](28.md) | 96| `1063` | File Metadata | [94](94.md) |
89| `1063` | File Metadata | [94](94.md) | 97| `1311` | Live Chat Message | [53](53.md) |
90| `1984` | Reporting | [56](56.md) | 98| `1040` | OpenTimestamps | [03](03.md) |
91| `1985` | Label | [32](32.md) | 99| `1971` | Problem Tracker | [1971](https://github.com/nostrocket/NIPS/blob/main/Problems.md) |
92| `9734` | Zap Request | [57](57.md) | 100| `1984` | Reporting | [56](56.md) |
93| `9735` | Zap | [57](57.md) | 101| `1985` | Label | [32](32.md) |
94| `10000` | Mute List | [51](51.md) | 102| `4550` | Community Post Approval | [72](72.md) |
95| `10001` | Pin List | [51](51.md) | 103| `5000`-`5999` | Job Request | [90](90.md) |
96| `10002` | Relay List Metadata | [65](65.md) | 104| `6000`-`6999` | Job Result | [90](90.md) |
97| `13194` | Wallet Info | [47](47.md) | 105| `7000` | Job Feedback | [90](90.md) |
98| `22242` | Client Authentication | [42](42.md) | 106| `9041` | Zap Goal | [75](75.md) |
99| `23194` | Wallet Request | [47](47.md) | 107| `9734` | Zap Request | [57](57.md) |
100| `23195` | Wallet Response | [47](47.md) | 108| `9735` | Zap | [57](57.md) |
101| `24133` | Nostr Connect | [46](46.md) | 109| `9802` | Highlights | [84](84.md) |
102| `27235` | HTTP Auth | [98](98.md) | 110| `10000` | Mute List | [51](51.md) |
103| `30000` | Categorized People List | [51](51.md) | 111| `10001` | Pin List | [51](51.md) |
104| `30001` | Categorized Bookmark List | [51](51.md) | 112| `10002` | Relay List Metadata | [65](65.md) |
105| `30008` | Profile Badges | [58](58.md) | 113| `13194` | Wallet Info | [47](47.md) |
106| `30009` | Badge Definition | [58](58.md) | 114| `22242` | Client Authentication | [42](42.md) |
107| `30017` | Create or update a stall | [15](15.md) | 115| `23194` | Wallet Request | [47](47.md) |
108| `30018` | Create or update a product | [15](15.md) | 116| `23195` | Wallet Response | [47](47.md) |
109| `30023` | Long-form Content | [23](23.md) | 117| `24133` | Nostr Connect | [46](46.md) |
110| `30078` | Application-specific Data | [78](78.md) | 118| `27235` | HTTP Auth | [98](98.md) |
111| `31989` | Handler recommendation | [89](89.md) | 119| `30000` | Categorized People List | [51](51.md) |
112| `31990` | Handler information | [89](89.md) | 120| `30001` | Categorized Bookmark List | [51](51.md) |
113 121| `30008` | Profile Badges | [58](58.md) |
114### Event Kind Ranges 122| `30009` | Badge Definition | [58](58.md) |
115 123| `30017` | Create or update a stall | [15](15.md) |
116| range | description | NIP | 124| `30018` | Create or update a product | [15](15.md) |
117| ---------------- | -------------------------------- | ----------- | 125| `30023` | Long-form Content | [23](23.md) |
118| `1000`--`9999` | Regular Events | [16](16.md) | 126| `30024` | Draft Long-form Content | [23](23.md) |
119| `10000`--`19999` | Replaceable Events | [16](16.md) | 127| `30078` | Application-specific Data | [78](78.md) |
120| `20000`--`29999` | Ephemeral Events | [16](16.md) | 128| `30311` | Live Event | [53](53.md) |
121| `30000`--`39999` | Parameterized Replaceable Events | [33](33.md) | 129| `30315` | User Statuses | [38](38.md) |
130| `30402` | Classified Listing | [99](99.md) |
131| `30403` | Draft Classified Listing | [99](99.md) |
132| `31922` | Date-Based Calendar Event | [52](52.md) |
133| `31923` | Time-Based Calendar Event | [52](52.md) |
134| `31924` | Calendar | [52](52.md) |
135| `31925` | Calendar Event RSVP | [52](52.md) |
136| `31989` | Handler recommendation | [89](89.md) |
137| `31990` | Handler information | [89](89.md) |
138| `34550` | Community Definition | [72](72.md) |
122 139
123## Message types 140## Message types
124 141
@@ -126,64 +143,68 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
126 143
127| type | description | NIP | 144| type | description | NIP |
128| ------- | --------------------------------------------------- | ----------- | 145| ------- | --------------------------------------------------- | ----------- |
146| `EVENT` | used to publish events | [01](01.md) |
147| `REQ` | used to request events and subscribe to new updates | [01](01.md) |
148| `CLOSE` | used to stop previous subscriptions | [01](01.md) |
129| `AUTH` | used to send authentication events | [42](42.md) | 149| `AUTH` | used to send authentication events | [42](42.md) |
130| `CLOSE` | used to stop previous subscriptions | [1](01.md) |
131| `COUNT` | used to request event counts | [45](45.md) | 150| `COUNT` | used to request event counts | [45](45.md) |
132| `EVENT` | used to publish events | [1](01.md) |
133| `REQ` | used to request events and subscribe to new updates | [1](01.md) |
134 151
135### Relay to Client 152### Relay to Client
136 153
137| type | description | NIP | 154| type | description | NIP |
138| -------- | ------------------------------------------------------- | ----------- | 155| -------- | ------------------------------------------------------- | ----------- |
156| `EOSE` | used to notify clients all stored events have been sent | [01](01.md) |
157| `EVENT` | used to send events requested to clients | [01](01.md) |
158| `NOTICE` | used to send human-readable messages to clients | [01](01.md) |
159| `OK` | used to notify clients if an EVENT was successful | [01](01.md) |
139| `AUTH` | used to send authentication challenges | [42](42.md) | 160| `AUTH` | used to send authentication challenges | [42](42.md) |
140| `COUNT` | used to send requested event counts to clients | [45](45.md) | 161| `COUNT` | used to send requested event counts to clients | [45](45.md) |
141| `EOSE` | used to notify clients all stored events have been sent | [1](01.md) |
142| `EVENT` | used to send events requested to clients | [1](01.md) |
143| `NOTICE` | used to send human-readable messages to clients | [1](01.md) |
144| `OK` | used to notify clients if an EVENT was successful | [20](20.md) |
145 162
146Please update these lists when proposing NIPs introducing new event kinds. 163Please update these lists when proposing NIPs introducing new event kinds.
147 164
148When experimenting with kinds, keep in mind the classification introduced by [NIP-16](16.md) and [NIP-33](33.md).
149
150## Standardized Tags 165## Standardized Tags
151 166
152| name | value | other parameters | NIP | 167| name | value | other parameters | NIP |
153| ----------------- | ------------------------------------ | -------------------- | ------------------------ | 168| ----------------- | ------------------------------------ | -------------------- | ------------------------------------- |
154| `a` | coordinates to an event | relay URL | [33](33.md), [23](23.md) | 169| `e` | event id (hex) | relay URL, marker | [01](01.md), [10](10.md) |
155| `alt` | Alt tag | -- | [31](31.md) | 170| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) |
156| `d` | identifier | -- | [33](33.md) | 171| `a` | coordinates to an event | relay URL | [01](01.md) |
157| `e` | event id (hex) | relay URL, marker | [1](01.md), [10](10.md) | 172| `d` | identifier | -- | [01](01.md) |
158| `g` | geohash | -- | [12](12.md) | 173| `alt` | summary | -- | [31](31.md) |
159| `i` | identity | proof | [39](39.md) | 174| `g` | geohash | -- | [52](52.md) |
160| `l` | label, label namespace | annotations | [32](32.md) | 175| `i` | identity | proof | [39](39.md) |
161| `L` | label namespace | -- | [32](32.md) | 176| `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) |
162| `p` | pubkey (hex) | relay URL | [1](01.md) | 177| `l` | label, label namespace | annotations | [32](32.md) |
163| `r` | a reference (URL, etc) | -- | [12](12.md) | 178| `L` | label namespace | -- | [32](32.md) |
164| `t` | hashtag | -- | [12](12.md) | 179| `m` | MIME type | -- | [94](94.md) |
165| `amount` | millisats | -- | [57](57.md) | 180| `r` | a reference (URL, etc) | petname | |
166| `bolt11` | `bolt11` invoice | -- | [57](57.md) | 181| `r` | relay url | marker | [65](65.md) |
167| `challenge` | challenge string | -- | [42](42.md) | 182| `t` | hashtag | -- | |
168| `content-warning` | reason | -- | [36](36.md) | 183| `amount` | millisatoshis, stringified | -- | [57](57.md) |
169| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | 184| `bolt11` | `bolt11` invoice | -- | [57](57.md) |
170| `description` | badge description | -- | [58](58.md) | 185| `challenge` | challenge string | -- | [42](42.md) |
171| `description` | invoice description | -- | [57](57.md) | 186| `content-warning` | reason | -- | [36](36.md) |
172| `emoji` | shortcode | image URL | [30](30.md) | 187| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) |
173| `expiration` | unix timestamp (string) | -- | [40](40.md) | 188| `description` | invoice/badge description | -- | [57](57.md), [58](58.md) |
174| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | 189| `emoji` | shortcode, image URL | -- | [30](30.md) |
175| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | 190| `expiration` | unix timestamp (string) | -- | [40](40.md) |
176| `name` | badge name | -- | [58](58.md) | 191| `goal` | event id (hex) | relay URL | [75](75.md) |
177| `nonce` | random | -- | [13](13.md) | 192| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) |
178| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | 193| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) |
179| `published_at` | unix timestamp (string) | -- | [23](23.md) | 194| `location` | location string | -- | [52](52.md), [99](99.md) |
180| `relay` | relay url | -- | [42](42.md) | 195| `name` | badge name | -- | [58](58.md) |
181| `relays` | relay list | -- | [57](57.md) | 196| `nonce` | random | -- | [13](13.md) |
182| `subject` | subject | -- | [14](14.md) | 197| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) |
183| `summary` | article summary | -- | [23](23.md) | 198| `price` | price | currency, frequency | [99](99.md) |
184| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | 199| `proxy` | external ID | protocol | [48](48.md) |
185| `title` | article title | -- | [23](23.md) | 200| `published_at` | unix timestamp (string) | -- | [23](23.md) |
186| `zap` | profile name | type of value | [57](57.md) | 201| `relay` | relay url | -- | [42](42.md) |
202| `relays` | relay list | -- | [57](57.md) |
203| `subject` | subject | -- | [14](14.md) |
204| `summary` | article summary | -- | [23](23.md) |
205| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) |
206| `title` | article title | -- | [23](23.md) |
207| `zap` | pubkey (hex), relay URL | weight | [57](57.md) |
187 208
188## Criteria for acceptance of NIPs 209## Criteria for acceptance of NIPs
189 210
@@ -193,6 +214,26 @@ When experimenting with kinds, keep in mind the classification introduced by [NI
1934. There should be no more than one way of doing the same thing. 2144. There should be no more than one way of doing the same thing.
1945. Other rules will be made up when necessary. 2155. Other rules will be made up when necessary.
195 216
217## Is this repository a centralizing factor?
218
219To 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.
220
221It 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.
222
223There 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.
224
225## How this repository works
226
227Standards 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.
228
229These 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.
230
196## License 231## License
197 232
198All NIPs are public domain. 233All NIPs are public domain.
234
235## Contributors
236
237<a align="center" href="https://github.com/nostr-protocol/nips/graphs/contributors">
238 <img src="https://contrib.rocks/image?repo=nostr-protocol/nips" />
239</a>