upleb.uk

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

summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--01.md104
-rw-r--r--11.md13
-rw-r--r--12.md37
-rw-r--r--13.md2
-rw-r--r--15.md24
-rw-r--r--16.md35
-rw-r--r--19.md2
-rw-r--r--20.md88
-rw-r--r--22.md6
-rw-r--r--23.md8
-rw-r--r--33.md50
-rw-r--r--51.md8
-rw-r--r--52.md6
-rw-r--r--53.md19
-rw-r--r--58.md12
-rw-r--r--72.md2
-rw-r--r--README.md47
17 files changed, 143 insertions, 320 deletions
diff --git a/01.md b/01.md
index 50e9c9c..4b33975 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` `author:fiatjaf` `author:distbit` `author:scsibug` `author:kukks` `author:jb55` `author:semisol` `author:cameri` `author:Giszmo`
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,11 +19,10 @@ 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 hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field>
@@ -43,9 +42,57 @@ To obtain the `event.id`, we `sha256` the serialized event. The serialization is
43] 42]
44``` 43```
45 44
45### Tags
46
47Each tag is an array of strings of arbitrary size, with some conventions around them. Take a look at the example below:
48
49```json
50{
51 ...,
52 "tags": [
53 ["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://nostr.example.com"],
54 ["p", "f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca"],
55 ["a", "30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"],
56 ["alt", "reply"],
57 ...
58 ],
59 ...
60}
61```
62
63The 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.
64
65This NIP defines 3 standard tags that can be used accross all event kinds with the same meaning. They are as follows:
66
67- The `e` tag, used to refer to an event: `["e", <32-bytes hex of the id of another event>, <recommended relay URL, optional>]`
68- The `p` tag, used to refer to another user: `["p", <32-bytes hex of a pubkey>, <recommended relay URL, optional>]`
69- The `a` tag, used to refer to a parameterized replaceable event: `["a", <kind integer>:<32-bytes hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]`
70
71As a convention, all single-letter 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.
72
73### Kinds
74
75Kinds 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:
76
77- `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.
78- `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.
79
80And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation:
81
82- for kind `n` such that `1000 <= n < 10000`, events are **regular**, which means they're all expected to be stored by relays.
83- for kind `n` such that `10000 <= n < 20000`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to be stored by relays, older versions are expected to be discarded.
84- for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays.
85- 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, only the latest event is expected to be stored by relays, older versions are expected to be discarded.
86
87These are just conventions and relay implementations may differ.
88
46## Communication between clients and relays 89## Communication between clients and relays
47 90
48Relays expose a websocket endpoint to which clients can connect. 91Relays 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.
92
93### Meaning of WebSocket status codes
94
95- When a websocket is closed by the relay with a status code `4000` that means the client shouldn't try to connect again.
49 96
50### From client to relay: sending events and creating subscriptions 97### From client to relay: sending events and creating subscriptions
51 98
@@ -61,11 +108,10 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th
61 108
62```json 109```json
63{ 110{
64 "ids": <a list of event ids or prefixes>, 111 "ids": <a list of event ids>,
65 "authors": <a list of pubkeys or prefixes, the pubkey of an event must be one of these>, 112 "authors": <a list of lowercase pubkeys, the pubkey of an event must be one of these>,
66 "kinds": <a list of a kind numbers>, 113 "kinds": <a list of a kind numbers>,
67 "#e": <a list of event ids that are referenced in an "e" tag>, 114 "#<single-letter>": <a list of event ids that are referenced in the tag specified by the single letter>,
68 "#p": <a list of pubkeys that are referenced in a "p" tag>,
69 "since": <an integer unix timestamp in seconds, events must be newer than this to pass>, 115 "since": <an integer unix timestamp in seconds, events must be newer than this to pass>,
70 "until": <an integer unix timestamp in seconds, events must be older than this to pass>, 116 "until": <an integer unix timestamp in seconds, events must be older than this to pass>,
71 "limit": <maximum number of events to be returned in the initial query> 117 "limit": <maximum number of events to be returned in the initial query>
@@ -74,9 +120,9 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th
74 120
75Upon receiving a `REQ` message, the relay SHOULD query its internal database and return events that match the filter, then store that filter and send again all future events it receives to that same websocket until the websocket is closed. The `CLOSE` event is received with the same `<subscription_id>` or a new `REQ` is sent using the same `<subscription_id>`, in which case it should overwrite the previous subscription. 121Upon 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.
76 122
77Filter attributes containing lists (such as `ids`, `kinds`, or `#e`) are JSON arrays with one or more values. At least one of the array's values must match the relevant field in an event for the condition itself to be considered a match. For scalar event attributes such as `kind`, the attribute from the event must be contained in the filter list. For tag attributes such as `#e`, where an event may have multiple values, the event and filter condition values must have at least one item in common. 123Filter attributes containing lists (`ids`, `authors`, `kinds` and tag filters like `#e`) are JSON arrays with one or more values. At least one of the arrays' values must match the relevant field in an event for the condition to be considered a match. For scalar event attributes such as `authors` and `kind`, the attribute from the event must be contained in the filter list. In the case of tag attributes such as `#e`, for which an event may have multiple values, the event and filter condition values must have at least one item in common.
78 124
79The `ids` and `authors` lists contain lowercase hexadecimal strings, which may either be an exact 64-character match, or a prefix of the event value. A prefix match is when the filter string is an exact string prefix of the event value. The use of prefixes allows for more compact filters where a large number of values are queried, and can provide some privacy for clients that may not want to disclose the exact authors or events they are searching for. 125The `ids`, `authors`, `#e` and `#p` filter lists MUST contain exact 64-character lowercase hex values.
80 126
81The `since` and `until` properties can be used to specify the time range of events returned in the subscription. If a filter includes the `since` property, events with `created_at` greater than or equal to `since` are considered to match the filter. The `until` property is similar except that `created_at` must be less than or equal to `until`. In short, an event matches a filter if `since <= created_at <= until` holds. 127The `since` and `until` properties can be used to specify the time range of events returned in the subscription. If a filter includes the `since` property, events with `created_at` greater than or equal to `since` are considered to match the filter. The `until` property is similar except that `created_at` must be less than or equal to `until`. In short, an event matches a filter if `since <= created_at <= until` holds.
82 128
@@ -84,32 +130,28 @@ All conditions of a filter that are specified must match for an event for it to
84 130
85A `REQ` message may contain multiple filters. In this case, events that match any of the filters are to be returned, i.e., multiple filters are to be interpreted as `||` conditions. 131A `REQ` message may contain multiple filters. In this case, events that match any of the filters are to be returned, i.e., multiple filters are to be interpreted as `||` conditions.
86 132
87The `limit` property of a filter is only valid for the initial query and can be ignored afterward. When `limit: n` is present it is assumed that the events returned in the initial query will be the last `n` events ordered by the `created_at`. It is safe to return less events than `limit` specifies, but it is expected that relays do not return (much) more events than requested so clients don't get unnecessarily overwhelmed by data. 133The `limit` property of a filter is only valid for the initial query and MUST be ignored afterwards. When `limit: n` is present it is assumed that the events returned in the initial query will be the last `n` events ordered by the `created_at`. It is safe to return less events than `limit` specifies, but it is expected that relays do not return (much) more events than requested so clients don't get unnecessarily overwhelmed by data.
88 134
89### From relay to client: sending events and notices 135### From relay to client: sending events and notices
90 136
91Relays can send 3 types of messages, which must also be JSON arrays, according to the following patterns: 137Relays can send 4 types of messages, which must also be JSON arrays, according to the following patterns:
92 138
93 * `["EVENT", <subscription_id>, <event JSON as defined above>]`, used to send events requested by clients. 139 * `["EVENT", <subscription_id>, <event JSON as defined above>]`, used to send events requested by clients.
140 * `["OK", <event_id>, <true|false>, <message>]`, used to indicate acceptance or denial of an `EVENT` message.
94 * `["EOSE", <subscription_id>]`, used to indicate the _end of stored events_ and the beginning of events newly received in real-time. 141 * `["EOSE", <subscription_id>]`, used to indicate the _end of stored events_ and the beginning of events newly received in real-time.
95 * `["NOTICE", <message>]`, used to send human-readable error messages or other things to clients. 142 * `["NOTICE", <message>]`, used to send human-readable error messages or other things to clients.
96 143
97This NIP defines no rules for how `NOTICE` messages should be sent or treated. 144This NIP defines no rules for how `NOTICE` messages should be sent or treated.
98 145
99`EVENT` messages MUST be sent only with a subscription ID related to a subscription previously initiated by the client (using the `REQ` message above). 146- `EVENT` messages MUST be sent only with a subscription ID related to a subscription previously initiated by the client (using the `REQ` message above).
100 147- `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 MAY be empty when the 3rd is `true`, otherwise it MUST be a string containing 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:
101## Basic Event Kinds 148
102 149 * `["OK", "b1a649ebe8...", true, ""]`
103 - `0`: `set_metadata`: the `content` is set to a stringified JSON object `{name: <username>, about: <string>, picture: <url, string>}` describing the user who created the event. A relay may delete past `set_metadata` events once it gets a new one for the same pubkey. 150 * `["OK", "b1a649ebe8...", true, "pow: difficulty 25>=24"]`
104 - `1`: `text_note`: the `content` is set to the **plaintext** content of a note (anything the user wants to say). Content that must be parsed, such as Markdown and HTML, should not be used. Clients should also not parse content as those. 151 * `["OK", "b1a649ebe8...", true, "duplicate: already have this event"]`
105 - `2`: `recommend_server`: the `content` is set to the URL (e.g., `wss://somerelay.com`) of a relay the event creator wants to recommend to its followers. 152 * `["OK", "b1a649ebe8...", false, "blocked: you are banned from posting here"]`
106 153 * `["OK", "b1a649ebe8...", false, "blocked: please register your pubkey at https://my-expensive-relay.example.com"]`
107A relay may choose to treat different message kinds differently, and it may or may not choose to have a default way to handle kinds it doesn't know about. 154 * `["OK", "b1a649ebe8...", false, "rate-limited: slow down there chief"]`
108 155 * `["OK", "b1a649ebe8...", false, "invalid: event creation date is too far off from the current time. Is your system clock in sync?"]`
109## Other Notes: 156 * `["OK", "b1a649ebe8...", false, "pow: difficulty 26 is less than 30"]`
110 157 * `["OK", "b1a649ebe8...", false, "error: could not connect to the database"]`
111- Clients should not open more than one websocket to each relay. One channel can support an unlimited number of subscriptions, so clients should do that.
112- The `tags` array can store a case-sensitive tag name as the first element of each subarray, plus arbitrary information afterward (always as strings). This NIP defines `"p"` — meaning "pubkey", which points to a pubkey of someone that is referred to in the event —, and `"e"` — meaning "event", which points to the id of an event this event is quoting, replying to or referring to somehow. See [NIP-10](10.md) for a detailed description of "e" and "p" tags.
113- The `<recommended relay URL>` item present on the `"e"` and `"p"` tags is an optional (could be set to `""`) URL of a relay the client could attempt to connect to fetch the tagged event or other events from a tagged profile. It MAY be ignored, but it exists to increase censorship resistance and make the spread of relay addresses more seamless across clients.
114- Clients should use the created_at field to judge the age of a metadata event and completely replace older metadata events with newer metadata events regardless of the order in which they arrive. Clients should not merge any filled fields within older metadata events into empty fields of newer metadata events.
115- 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/11.md b/11.md
index ec46b36..c71f89e 100644
--- a/11.md
+++ b/11.md
@@ -118,7 +118,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 118serializing into JSON it may be larger (in bytes), and is still
119subject to the `max_message_length`, if defined. 119subject to the `max_message_length`, if defined.
120 120
121- `min_pow_difficulty`: new events will require at least this difficulty of PoW, 121- `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. 122based on [NIP-13](13.md), or they will be rejected by this server.
123 123
124- `auth_required`: this relay requires [NIP-42](42.md) authentication 124- `auth_required`: this relay requires [NIP-42](42.md) authentication
@@ -129,7 +129,7 @@ Even if set to False, authentication may be required for specific actions.
129 129
130### Event Retention ### 130### Event Retention ###
131 131
132There may be a cost associated with storing data forever, so relays 132There may be a cost associated with storing data forever, so relays
133may wish to state retention times. The values stated here are defaults 133may wish to state retention times. The values stated here are defaults
134for unauthenticated users and visitors. Paid users would likely have 134for unauthenticated users and visitors. Paid users would likely have
135other policies. 135other policies.
@@ -151,7 +151,7 @@ all, and preferably an error will be provided when those are received.
151} 151}
152``` 152```
153 153
154`retention` is a list of specifications: each will apply to either all kinds, or 154`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 155a 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` 156start and end values. Events of indicated kind (or all) are then limited to a `count`
157and/or time period. 157and/or time period.
@@ -161,8 +161,7 @@ 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 161While that is unfortunate, it does allow clients to discover servers that will
162support their protocol quickly via a single HTTP fetch. 162support their protocol quickly via a single HTTP fetch.
163 163
164There is no need to specify retention times for _ephemeral events_ as defined 164There 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 165
167 166
168### Content Limitations ### 167### Content Limitations ###
@@ -271,7 +270,7 @@ A URL pointing to an image to be used as an icon for the relay. Recommended to b
271As of 2 May 2023 the following `curl` command provided these results. 270As of 2 May 2023 the following `curl` command provided these results.
272 271
273 >curl -H "Accept: application/nostr+json" https://eden.nostr.land 272 >curl -H "Accept: application/nostr+json" https://eden.nostr.land
274 273
275 {"name":"eden.nostr.land", 274 {"name":"eden.nostr.land",
276 "description":"Eden Nostr Land - Toronto 1-01", 275 "description":"Eden Nostr Land - Toronto 1-01",
277 "pubkey":"00000000827ffaa94bfea288c3dfce4422c794fbb96625b6b31e9049f729d700", 276 "pubkey":"00000000827ffaa94bfea288c3dfce4422c794fbb96625b6b31e9049f729d700",
@@ -293,5 +292,5 @@ As of 2 May 2023 the following `curl` command provided these results.
293 "payment_required":true}, 292 "payment_required":true},
294 "payments_url":"https://eden.nostr.land/invoices", 293 "payments_url":"https://eden.nostr.land/invoices",
295 "fees":{"admission":[{"amount":5000000,"unit":"msats"}], 294 "fees":{"admission":[{"amount":5000000,"unit":"msats"}],
296 "publication":[]}}, 295 "publication":[]}},
297 "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg" 296 "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg"
diff --git a/12.md b/12.md
index 7d1f46e..9357977 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` `author:scsibug` `author:fiatjaf`
8 8
9Relays may support subscriptions over arbitrary tags. `NIP-01` requires relays to respond to queries for `e` and `p` tags. This NIP allows any single-letter tag present in an event to be queried. 9Moved to [NIP-01](01.md).
10
11The `<filters>` object described in `NIP-01` is expanded to contain arbitrary keys with a `#` prefix. Any single-letter key in a filter beginning with `#` is a tag query, and MUST have a value of an array of strings. The filter condition matches if the event has a tag with the same name, and there is at least one tag value in common with the filter and event. The tag name is the letter without the `#`, and the tag value is the second element. Subsequent elements are ignored for the purposes of tag queries. Note that tag names are case-sensitive.
12
13Example Subscription Filter
14---------------------------
15
16The following provides an example of a filter that matches events of kind `1` with an `r` tag set to either `foo` or `bar`.
17
18```
19{
20 "kinds": [1],
21 "#r": ["foo", "bar"]
22}
23```
24
25Client Behavior
26---------------
27
28Clients SHOULD use the `supported_nips` field to learn if a relay supports generic tag queries. Clients MAY send generic tag queries to any relay, if they are prepared to filter out extraneous responses from relays that do not support this NIP.
29
30Rationale
31---------
32
33The decision to reserve only single-letter tags to be usable in queries allow applications to make use of tags for all sorts of metadata, as it is their main purpose, without worrying that they might be bloating relay indexes. That also makes relays more lightweight, of course. And if some application or user is abusing single-letter tags with the intention of bloating relays that becomes easier to detect as single-letter tags will hardly be confused with some actually meaningful metadata some application really wanted to attach to the event with no spammy intentions.
34
35Suggested Use Cases
36-------------------
37
38Motivating examples for generic tag queries are provided below. This NIP does not promote or standardize the use of any specific tag for any purpose.
39
40* Decentralized Commenting System: clients can comment on arbitrary web pages, and easily search for other comments, by using a `r` ("reference", in this case an URL) tag and value.
41* Location-specific Posts: clients can use a `g` ("geohash") tag to associate a post with a physical location. Clients can search for a set of geohashes of varying precisions near them to find local content.
42* Hashtags: clients can use simple `t` ("hashtag") tags to associate an event with an easily searchable topic name. Since Nostr events themselves are not searchable through the protocol, this provides a mechanism for user-driven search.
diff --git a/13.md b/13.md
index 360bde6..0178733 100644
--- a/13.md
+++ b/13.md
@@ -110,7 +110,7 @@ function countLeadingZeroes(hex) {
110Querying relays for PoW notes 110Querying relays for PoW notes
111----------------------------- 111-----------------------------
112 112
113Since relays allow searching on prefixes, you can use this as a way to filter notes of a certain difficulty: 113If relays allow searching on prefixes, you can use this as a way to filter notes of a certain difficulty:
114 114
115``` 115```
116$ echo '["REQ", "subid", {"ids": ["000000000"]}]' | websocat wss://some-relay.com | jq -c '.[2]' 116$ echo '["REQ", "subid", {"ids": ["000000000"]}]' | websocat wss://some-relay.com | jq -c '.[2]'
diff --git a/15.md b/15.md
index f8df328..f9e4b79 100644
--- a/15.md
+++ b/15.md
@@ -4,7 +4,7 @@ NIP-15
4Nostr Marketplace (for resilient marketplaces) 4Nostr Marketplace (for resilient marketplaces)
5----------------------------------- 5-----------------------------------
6 6
7`draft` `optional` `author:fiatjaf` `author:benarc` `author:motorina0` `author:talvasconcelos` 7`draft` `optional` `author:fiatjaf` `author:benarc` `author:motorina0` `author:talvasconcelos`
8 8
9> Based on https://github.com/lnbits/Diagon-Alley 9> Based on https://github.com/lnbits/Diagon-Alley
10 10
@@ -33,13 +33,13 @@ 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
@@ -71,7 +71,7 @@ Fields that are not self-explanatory:
71```json 71```json
72 "tags": [["d", <String, id of stall]] 72 "tags": [["d", <String, id of stall]]
73``` 73```
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`. 74 - the `d` tag is required, its value MUST be the same as the stall `id`.
75 75
76### Event `30018`: Create or update a product 76### Event `30018`: Create or update a product
77 77
@@ -109,8 +109,8 @@ _Open_: better to move `spec` in the `tags` section of the event?
109 ] 109 ]
110``` 110```
111 111
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`. 112 - 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. 113 - 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 114
115## Checkout events 115## Checkout events
116 116
@@ -152,7 +152,7 @@ The below json goes in content of [NIP04](https://github.com/nostr-protocol/nips
152``` 152```
153 153
154_Open_: is `contact.nostr` required? 154_Open_: is `contact.nostr` required?
155 155
156 156
157### Step 2: `merchant` request payment (event) 157### Step 2: `merchant` request payment (event)
158 158
diff --git a/16.md b/16.md
index 8ef4af4..78ec708 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` `author:Semisol`
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/19.md b/19.md
index 6fc4523..6b08742 100644
--- a/19.md
+++ b/19.md
@@ -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 _parameterized replaceable event_ coordinate
39 39
40These possible standardized `TLV` types are indicated here: 40These possible standardized `TLV` types are indicated here:
41 41
diff --git a/20.md b/20.md
index 7e97dd9..ec6127a 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` `author:jb55`
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/22.md b/22.md
index 2172519..f595ebf 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` `author:jeffthibault` `author:Giszmo`
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 7a06b0e..76c0a69 100644
--- a/23.md
+++ b/23.md
@@ -6,7 +6,7 @@ Long-form Content
6 6
7`draft` `optional` `author:fiatjaf` 7`draft` `optional` `author:fiatjaf`
8 8
9This NIP defines `kind:30023` (a parameterized replaceable event according to [NIP-33](33.md)) for long-form text content, generally referred to as "articles" or "blog posts". `kind:30024` has the same structure as `kind:30023` and is used to save long form drafts. 9This NIP defines `kind:30023` (a _parameterized replaceable event_) for long-form text content, generally referred to as "articles" or "blog posts". `kind:30024` has the same structure as `kind:30023` and is used to save long form drafts.
10 10
11"Social" clients that deal primarily with `kind:1` notes should not be expected to implement this NIP. 11"Social" clients that deal primarily with `kind:1` notes should not be expected to implement this NIP.
12 12
@@ -20,7 +20,7 @@ The `.content` of these events should be a string text in Markdown syntax. To ma
20 20
21### Metadata 21### Metadata
22 22
23For the date of the last update the `.created_at` field should be used, for "tags"/"hashtags" (i.e. topics about which the event might be of relevance) the `"t"` event tag should be used, as per NIP-12. 23For the date of the last update the `.created_at` field should be used, for "tags"/"hashtags" (i.e. topics about which the event might be of relevance) the `t` tag should be used, as per NIP-12.
24 24
25Other metadata fields can be added as tags to the event as necessary. Here we standardize 4 that may be useful, although they remain strictly optional: 25Other metadata fields can be added as tags to the event as necessary. Here we standardize 4 that may be useful, although they remain strictly optional:
26 26
@@ -31,11 +31,11 @@ Other metadata fields can be added as tags to the event as necessary. Here we st
31 31
32### Editability 32### Editability
33 33
34These articles are meant to be editable, so they should make use of the replaceability feature of NIP-33 and include a `"d"` tag with an identifier for the article. Clients should take care to only publish and read these events from relays that implement that. If they don't do that they should also take care to hide old versions of the same article they may receive. 34These articles are meant to be editable, so they should make use of the parameterized replaceability feature and include a `d` tag with an identifier for the article. Clients should take care to only publish and read these events from relays that implement that. If they don't do that they should also take care to hide old versions of the same article they may receive.
35 35
36### Linking 36### Linking
37 37
38The article may be linked to using the NIP-19 `naddr` code along with the `"a"` tag (see [NIP-33](33.md) and [NIP-19](19.md)). 38The article may be linked to using the [NIP-19](19.md) `naddr` code along with the `a` tag.
39 39
40### References 40### References
41 41
diff --git a/33.md b/33.md
index 5128bec..1e7a9fc 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` `author:Semisol` `author:Kukks` `author:Cameri` `author:Giszmo`
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/51.md b/51.md
index 80cc09e..b7229aa 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` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema`
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
diff --git a/52.md b/52.md
index c601412..846fbf4 100644
--- a/52.md
+++ b/52.md
@@ -6,7 +6,7 @@ Calendar Events
6 6
7`draft` `optional` `author:tyiu` 7`draft` `optional` `author:tyiu`
8 8
9This specification defines calendar events representing an occurrence at a specific moment or between moments. These calendar events are replaceable and referenceable per [NIP-33](33.md) and deletable per [NIP-09](09.md). 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 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. 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 12
@@ -139,7 +139,7 @@ A calendar is a collection of calendar events, represented as a custom replaceab
139 139
140The format uses a custom replaceable list of kind `31924` with a list of tags as described below: 140The format uses a custom replaceable list of kind `31924` with a list of tags as described below:
141* `d` (required) calendar name 141* `d` (required) calendar name
142* `a` (repeated) reference tag to kind `31922` or `31923` calendar event being responded to per [NIP-33](33.md) 142* `a` (repeated) reference tag to kind `31922` or `31923` calendar event being responded to
143 143
144```json 144```json
145{ 145{
@@ -171,7 +171,7 @@ The format uses a parameterized replaceable event kind `31925`.
171The `.content` of these events is optional and should be a free-form note that adds more context to this calendar event response. 171The `.content` of these events is optional and should be a free-form note that adds more context to this calendar event response.
172 172
173The list of tags are as follows: 173The list of tags are as follows:
174* `a` (required) reference tag to kind `31922` or `31923` calendar event being responded to per [NIP-33](33.md) 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. 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) 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. 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.
diff --git a/53.md b/53.md
index c5f2704..b3d416b 100644
--- a/53.md
+++ b/53.md
@@ -12,7 +12,7 @@ Service providers want to offer live activities to the Nostr network in such a w
12 12
13# Live Event 13# Live Event
14 14
15A special event with `kind:30311` "Live Event" is defined as a [NIP-33: Parameterized Replaceable Events](33.md) of public `p` tags. Each `p` tag SHOULD have a **displayable** marker name for the current role (e.g. `Host`, `Speaker`, `Participant`) of the user in the event and the relay information MAY be empty. This event will be constantly updated as participants join and leave the activity. 15A special event with `kind:30311` "Live Event" is defined as a _parameterized replaceable event_ of public `p` tags. Each `p` tag SHOULD have a **displayable** marker name for the current role (e.g. `Host`, `Speaker`, `Participant`) of the user in the event and the relay information MAY be empty. This event will be constantly updated as participants join and leave the activity.
16 16
17For example: 17For example:
18 18
@@ -44,13 +44,13 @@ For example:
44 44
45A distinct `d` tag should be used for each activity. All other tags are optional. 45A distinct `d` tag should be used for each activity. All other tags are optional.
46 46
47Providers SHOULD keep the participant list small (e.g. under 1000 users) and, when limits are reached, Providers SHOULD select which participants get named in the event. Clients should not expect a comprehensive list. Once the activity ends, the event can be deleted or updated to summarize the activity and provide async content (e.g. recording of the event). 47Providers SHOULD keep the participant list small (e.g. under 1000 users) and, when limits are reached, Providers SHOULD select which participants get named in the event. Clients should not expect a comprehensive list. Once the activity ends, the event can be deleted or updated to summarize the activity and provide async content (e.g. recording of the event).
48 48
49Clients are expected to subscribe to `kind:30311` events in general or for given follow lists and statuses. Clients MAY display participants' roles in activities as well as access points to join the activity. 49Clients are expected to subscribe to `kind:30311` events in general or for given follow lists and statuses. Clients MAY display participants' roles in activities as well as access points to join the activity.
50 50
51Live Activity management clients are expected to constantly update `kind:30311` during the event. Clients MAY choose to consider `status=live` events after 1hr without any update as `ended`. The `starts` and `ends` timestamp SHOULD be updated when the status changes to and from `live` 51Live Activity management clients are expected to constantly update `kind:30311` during the event. Clients MAY choose to consider `status=live` events after 1hr without any update as `ended`. The `starts` and `ends` timestamp SHOULD be updated when the status changes to and from `live`
52 52
53The activity MUST be linked to using the NIP-19 naddr code along with the "a" tag (see [NIP-33](33.md) and [NIP-19](19.md)). 53The activity MUST be linked to using the [NIP-19](19.md) `naddr` code along with the `a` tag.
54 54
55## Proof of Agreement to Participate 55## Proof of Agreement to Participate
56 56
@@ -58,11 +58,11 @@ Event owners can add proof as the 5th term in each `p` tag to clarify the partic
58 58
59Clients MAY only display participants if the proof is available or MAY display participants as "invited" if the proof is not available. 59Clients MAY only display participants if the proof is available or MAY display participants as "invited" if the proof is not available.
60 60
61This feature is important to avoid malicious event owners adding large account holders to the event, without their knowledge, to lure their followers into the malicious owner's trap. 61This feature is important to avoid malicious event owners adding large account holders to the event, without their knowledge, to lure their followers into the malicious owner's trap.
62 62
63# Live Chat Message 63# Live Chat Message
64 64
65Event `kind:1311` is live chat's channel message. Clients MUST include the `a` tag of the activity with a `root` marker. Other Kind-1 tags such as `reply` and `mention` can also be used. 65Event `kind:1311` is live chat's channel message. Clients MUST include the `a` tag of the activity with a `root` marker. Other Kind-1 tags such as `reply` and `mention` can also be used.
66 66
67```js 67```js
68{ 68{
@@ -74,7 +74,7 @@ Event `kind:1311` is live chat's channel message. Clients MUST include the `a` t
74 ["a", "30311:<Community event author pubkey>:<d-identifier of the community>", "<Optional relay url>", "root"], 74 ["a", "30311:<Community event author pubkey>:<d-identifier of the community>", "<Optional relay url>", "root"],
75 ], 75 ],
76 "content": "Zaps to live streams is beautiful." 76 "content": "Zaps to live streams is beautiful."
77} 77}
78``` 78```
79 79
80# Use Cases 80# Use Cases
@@ -83,7 +83,7 @@ Common use cases include meeting rooms/workshops, watch-together activities, or
83 83
84# Example 84# Example
85 85
86Live Streaming 86Live Streaming
87 87
88```json 88```json
89{ 89{
@@ -112,7 +112,7 @@ Live Streaming chat message
112```json 112```json
113{ 113{
114 "id": "97aa81798ee6c5637f7b21a411f89e10244e195aa91cb341bf49f718e36c8188", 114 "id": "97aa81798ee6c5637f7b21a411f89e10244e195aa91cb341bf49f718e36c8188",
115 "pubkey": "3f770d65d3a764a9c5cb503ae123e62ec7598ad035d836e2a810f3877a745b24", 115 "pubkey": "3f770d65d3a764a9c5cb503ae123e62ec7598ad035d836e2a810f3877a745b24",
116 "created_at": 1687286726, 116 "created_at": 1687286726,
117 "kind": 1311, 117 "kind": 1311,
118 "tags": [ 118 "tags": [
@@ -122,4 +122,3 @@ Live Streaming chat message
122 "sig": "997f62ddfc0827c121043074d50cfce7a528e978c575722748629a4137c45b75bdbc84170bedc723ef0a5a4c3daebf1fef2e93f5e2ddb98e5d685d022c30b622" 122 "sig": "997f62ddfc0827c121043074d50cfce7a528e978c575722748629a4137c45b75bdbc84170bedc723ef0a5a4c3daebf1fef2e93f5e2ddb98e5d685d022c30b622"
123} 123}
124```` 124````
125
diff --git a/58.md b/58.md
index 2fa4406..d6bb27d 100644
--- a/58.md
+++ b/58.md
@@ -9,15 +9,9 @@ Badges
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 13
14the badge (e.g. `bravery`) published by the badge issuer. Badge definitions can 142. A "Badge Award" event is a kind `8` event with a single `a` tag referencing a "Define Badge" event and one or more `p` tags, one for each pubkey the badge issuer wishes to award. Awarded badges are immutable and non-transferrable.
15be updated.
16
172. A "Badge Award" event is a kind `8` event with a single `a` tag referencing
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/72.md b/72.md
index f4bebf4..599a4c4 100644
--- a/72.md
+++ b/72.md
@@ -6,7 +6,7 @@ Moderated Communities (Reddit Style)
6 6
7`draft` `optional` `author:vitorpamplona` `author:arthurfranca` 7`draft` `optional` `author:vitorpamplona` `author:arthurfranca`
8 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 (See [NIP-33](33.md)). Moderators issue an approval event `kind:4550` that links the community with the new post. 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 10
11# Community Definition 11# Community Definition
12 12
diff --git a/README.md b/README.md
index 3c35ef3..f2603cf 100644
--- a/README.md
+++ b/README.md
@@ -30,14 +30,11 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
30- [NIP-09: Event Deletion](09.md) 30- [NIP-09: Event Deletion](09.md)
31- [NIP-10: Conventions for clients' use of `e` and `p` tags in text events](10.md) 31- [NIP-10: Conventions for clients' use of `e` and `p` tags in text events](10.md)
32- [NIP-11: Relay Information Document](11.md) 32- [NIP-11: Relay Information Document](11.md)
33- [NIP-12: Generic Tag Queries](12.md)
34- [NIP-13: Proof of Work](13.md) 33- [NIP-13: Proof of Work](13.md)
35- [NIP-14: Subject tag in text events](14.md) 34- [NIP-14: Subject tag in text events](14.md)
36- [NIP-15: Nostr Marketplace (for resilient marketplaces)](15.md) 35- [NIP-15: Nostr Marketplace (for resilient marketplaces)](15.md)
37- [NIP-16: Event Treatment](16.md)
38- [NIP-18: Reposts](18.md) 36- [NIP-18: Reposts](18.md)
39- [NIP-19: bech32-encoded entities](19.md) 37- [NIP-19: bech32-encoded entities](19.md)
40- [NIP-20: Command Results](20.md)
41- [NIP-21: `nostr:` URI scheme](21.md) 38- [NIP-21: `nostr:` URI scheme](21.md)
42- [NIP-22: Event `created_at` Limits](22.md) 39- [NIP-22: Event `created_at` Limits](22.md)
43- [NIP-23: Long-form Content](23.md) 40- [NIP-23: Long-form Content](23.md)
@@ -48,7 +45,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
48- [NIP-30: Custom Emoji](30.md) 45- [NIP-30: Custom Emoji](30.md)
49- [NIP-31: Dealing with Unknown Events](31.md) 46- [NIP-31: Dealing with Unknown Events](31.md)
50- [NIP-32: Labeling](32.md) 47- [NIP-32: Labeling](32.md)
51- [NIP-33: Parameterized Replaceable Events](33.md)
52- [NIP-36: Sensitive Content](36.md) 48- [NIP-36: Sensitive Content](36.md)
53- [NIP-39: External Identities in Profiles](39.md) 49- [NIP-39: External Identities in Profiles](39.md)
54- [NIP-40: Expiration Timestamp](40.md) 50- [NIP-40: Expiration Timestamp](40.md)
@@ -78,7 +74,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
78| ------- | -------------------------- | ----------- | 74| ------- | -------------------------- | ----------- |
79| `0` | Metadata | [1](01.md) | 75| `0` | Metadata | [1](01.md) |
80| `1` | Short Text Note | [1](01.md) | 76| `1` | Short Text Note | [1](01.md) |
81| `2` | Recommend Relay | [1](01.md) | 77| `2` | Recommend Relay | |
82| `3` | Contacts | [2](02.md) | 78| `3` | Contacts | [2](02.md) |
83| `4` | Encrypted Direct Messages | [4](04.md) | 79| `4` | Encrypted Direct Messages | [4](04.md) |
84| `5` | Event Deletion | [9](09.md) | 80| `5` | Event Deletion | [9](09.md) |
@@ -128,59 +124,48 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
128| `34550` | Community Definition | [72](72.md) | 124| `34550` | Community Definition | [72](72.md) |
129 125
130 126
131### Event Kind Ranges
132
133| range | description | NIP |
134| ---------------- | -------------------------------- | ----------- |
135| `1000`--`9999` | Regular Events | [16](16.md) |
136| `10000`--`19999` | Replaceable Events | [16](16.md) |
137| `20000`--`29999` | Ephemeral Events | [16](16.md) |
138| `30000`--`39999` | Parameterized Replaceable Events | [33](33.md) |
139
140## Message types 127## Message types
141 128
142### Client to Relay 129### Client to Relay
143 130
144| type | description | NIP | 131| type | description | NIP |
145| ------- | --------------------------------------------------- | ----------- | 132| ------- | --------------------------------------------------- | ----------- |
133| `EVENT` | used to publish events | [01](01.md) |
134| `REQ` | used to request events and subscribe to new updates | [01](01.md) |
135| `CLOSE` | used to stop previous subscriptions | [01](01.md) |
146| `AUTH` | used to send authentication events | [42](42.md) | 136| `AUTH` | used to send authentication events | [42](42.md) |
147| `CLOSE` | used to stop previous subscriptions | [1](01.md) |
148| `COUNT` | used to request event counts | [45](45.md) | 137| `COUNT` | used to request event counts | [45](45.md) |
149| `EVENT` | used to publish events | [1](01.md) |
150| `REQ` | used to request events and subscribe to new updates | [1](01.md) |
151 138
152### Relay to Client 139### Relay to Client
153 140
154| type | description | NIP | 141| type | description | NIP |
155| -------- | ------------------------------------------------------- | ----------- | 142| -------- | ------------------------------------------------------- | ----------- |
143| `EOSE` | used to notify clients all stored events have been sent | [01](01.md) |
144| `EVENT` | used to send events requested to clients | [01](01.md) |
145| `NOTICE` | used to send human-readable messages to clients | [01](01.md) |
146| `OK` | used to notify clients if an EVENT was successful | [01](01.md) |
156| `AUTH` | used to send authentication challenges | [42](42.md) | 147| `AUTH` | used to send authentication challenges | [42](42.md) |
157| `COUNT` | used to send requested event counts to clients | [45](45.md) | 148| `COUNT` | used to send requested event counts to clients | [45](45.md) |
158| `EOSE` | used to notify clients all stored events have been sent | [1](01.md) |
159| `EVENT` | used to send events requested to clients | [1](01.md) |
160| `NOTICE` | used to send human-readable messages to clients | [1](01.md) |
161| `OK` | used to notify clients if an EVENT was successful | [20](20.md) |
162 149
163Please update these lists when proposing NIPs introducing new event kinds. 150Please update these lists when proposing NIPs introducing new event kinds.
164 151
165When experimenting with kinds, keep in mind the classification introduced by [NIP-16](16.md) and [NIP-33](33.md).
166
167## Standardized Tags 152## Standardized Tags
168 153
169| name | value | other parameters | NIP | 154| name | value | other parameters | NIP |
170| ----------------- | ------------------------------------ | -------------------- | ------------------------ | 155| ----------------- | ------------------------------------ | -------------------- | ------------------------ |
171| `a` | coordinates to an event | relay URL | [33](33.md), [23](23.md) | 156| `e` | event id (hex) | relay URL, marker | [01](01.md), [10](10.md) |
157| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) |
158| `a` | coordinates to an event | relay URL | [01](01.md) |
159| `d` | identifier | -- | [01](01.md) |
172| `alt` | Alt tag | -- | [31](31.md) | 160| `alt` | Alt tag | -- | [31](31.md) |
173| `d` | identifier | -- | [33](33.md) | 161| `g` | geohash | -- | [52](52.md) |
174| `e` | event id (hex) | relay URL, marker | [1](01.md), [10](10.md) |
175| `g` | geohash | -- | [12](12.md), [52](52.md) |
176| `i` | identity | proof | [39](39.md) | 162| `i` | identity | proof | [39](39.md) |
177| `k` | kind number (string) | -- | [18](18.md), [72](72.md) | 163| `k` | kind number (string) | -- | [18](18.md), [72](72.md) |
178| `l` | label, label namespace | annotations | [32](32.md) | 164| `l` | label, label namespace | annotations | [32](32.md) |
179| `L` | label namespace | -- | [32](32.md) | 165| `L` | label namespace | -- | [32](32.md) |
180| `p` | pubkey (hex) | relay URL | [1](01.md) | 166| `r` | a reference (URL, etc) | -- | |
181| `r` | a reference (URL, etc) | -- | [12](12.md) | 167| `t` | hashtag | -- | |
182| `t` | hashtag | -- | [12](12.md) | 168| `amount` | millisatoshis, stringified | -- | [57](57.md) |
183| `amount` | millisats | -- | [57](57.md) |
184| `bolt11` | `bolt11` invoice | -- | [57](57.md) | 169| `bolt11` | `bolt11` invoice | -- | [57](57.md) |
185| `challenge` | challenge string | -- | [42](42.md) | 170| `challenge` | challenge string | -- | [42](42.md) |
186| `content-warning` | reason | -- | [36](36.md) | 171| `content-warning` | reason | -- | [36](36.md) |