upleb.uk

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

summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPablo Fernandez <p@f7z.io>2023-10-15 21:30:42 +0300
committerGitHub <noreply@github.com>2023-10-15 21:30:42 +0300
commita482f47ae4c36d38062cd0fd3ee6235e57691673 (patch)
treea16f57208cd3c3ef74237dafcef277f16d70e688
parentd9400e1e7b08225aedb6c78b522c5ad07b5198b4 (diff)
parent202e18f2b256646148805880ed58731c1c8b2b9b (diff)
Merge branch 'master' into vending-machine
-rw-r--r--01.md118
-rw-r--r--03.md33
-rw-r--r--05.md4
-rw-r--r--06.md16
-rw-r--r--07.md1
-rw-r--r--10.md18
-rw-r--r--11.md24
-rw-r--r--12.md37
-rw-r--r--13.md2
-rw-r--r--15.md80
-rw-r--r--16.md35
-rw-r--r--19.md4
-rw-r--r--20.md88
-rw-r--r--22.md6
-rw-r--r--23.md8
-rw-r--r--24.md41
-rw-r--r--25.md9
-rw-r--r--33.md50
-rw-r--r--38.md61
-rw-r--r--45.md5
-rw-r--r--51.md48
-rw-r--r--52.md10
-rw-r--r--53.md19
-rw-r--r--57.md8
-rw-r--r--58.md12
-rw-r--r--65.md85
-rw-r--r--72.md6
-rw-r--r--75.md76
-rw-r--r--89.md2
-rw-r--r--94.md14
-rw-r--r--98.md14
-rw-r--r--README.md120
32 files changed, 590 insertions, 464 deletions
diff --git a/01.md b/01.md
index 50e9c9c..2b28f23 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,14 +19,13 @@ 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
@@ -35,7 +34,7 @@ To obtain the `event.id`, we `sha256` the serialized event. The serialization is
35```json 34```json
36[ 35[
37 0, 36 0,
38 <pubkey, as a (lowercase) hex string>, 37 <pubkey, as a lowercase hex string>,
39 <created_at, as a number>, 38 <created_at, as a number>,
40 <kind, as a number>, 39 <kind, as a number>,
41 <tags, as an array of arrays of non-null strings>, 40 <tags, as an array of arrays of non-null strings>,
@@ -43,9 +42,63 @@ 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 across 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 lowercase hex of the id of another event>, <recommended relay URL, optional>]`
68- The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, <recommended relay URL, optional>]`
69- The `a` tag, used to refer to a (maybe parameterized) replaceable event
70 - for a parameterized replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]`
71 - for a non-parameterized replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:, <recommended relay URL, optional>]`
72
73As a convention, all single-letter (only english alphabet letters: a-z, A-Z) key tags are expected to be indexed by relays, such that it is possible, for example, to query or subscribe to events that reference the event `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"` by using the `{"#e": "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"}` filter.
74
75### Kinds
76
77Kinds 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:
78
79- `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.
80- `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.
81
82And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation:
83
84- for kind `n` such that `1000 <= n < 10000`, events are **regular**, which means they're all expected to be stored by relays.
85- 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.
86- for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays.
87- 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.
88
89In 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.
90
91When 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.
92
93These are just conventions and relay implementations may differ.
94
46## Communication between clients and relays 95## Communication between clients and relays
47 96
48Relays expose a websocket endpoint to which clients can connect. 97Relays 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.
98
99### Meaning of WebSocket status codes
100
101- When a websocket is closed by the relay with a status code `4000` that means the client shouldn't try to connect again.
49 102
50### From client to relay: sending events and creating subscriptions 103### From client to relay: sending events and creating subscriptions
51 104
@@ -61,22 +114,21 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th
61 114
62```json 115```json
63{ 116{
64 "ids": <a list of event ids or prefixes>, 117 "ids": <a list of event ids>,
65 "authors": <a list of pubkeys or prefixes, the pubkey of an event must be one of these>, 118 "authors": <a list of lowercase pubkeys, the pubkey of an event must be one of these>,
66 "kinds": <a list of a kind numbers>, 119 "kinds": <a list of a kind numbers>,
67 "#e": <a list of event ids that are referenced in an "e" tag>, 120 "#<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>,
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>, 121 "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>, 122 "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> 123 "limit": <maximum number of events relays SHOULD return in the initial query>
72} 124}
73``` 125```
74 126
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. 127Upon receiving a `REQ` message, the relay SHOULD query its internal database and return events that match the filter, then store that filter and send again all future events it receives to that same websocket until the websocket is closed. The `CLOSE` event is received with the same `<subscription_id>` or a new `REQ` is sent using the same `<subscription_id>`, in which case relay MUST overwrite the previous subscription.
76 128
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. 129Filter 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 130
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. 131The `ids`, `authors`, `#e` and `#p` filter lists MUST contain exact 64-character lowercase hex values.
80 132
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. 133The `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 134
@@ -84,32 +136,28 @@ All conditions of a filter that are specified must match for an event for it to
84 136
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. 137A `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 138
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. 139The `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 140
89### From relay to client: sending events and notices 141### From relay to client: sending events and notices
90 142
91Relays can send 3 types of messages, which must also be JSON arrays, according to the following patterns: 143Relays can send 4 types of messages, which must also be JSON arrays, according to the following patterns:
92 144
93 * `["EVENT", <subscription_id>, <event JSON as defined above>]`, used to send events requested by clients. 145 * `["EVENT", <subscription_id>, <event JSON as defined above>]`, used to send events requested by clients.
146 * `["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. 147 * `["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. 148 * `["NOTICE", <message>]`, used to send human-readable error messages or other things to clients.
96 149
97This NIP defines no rules for how `NOTICE` messages should be sent or treated. 150This NIP defines no rules for how `NOTICE` messages should be sent or treated.
98 151
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). 152- `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 153- `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 154
102 155 * `["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. 156 * `["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. 157 * `["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. 158 * `["OK", "b1a649ebe8...", false, "blocked: you are banned from posting here"]`
106 159 * `["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. 160 * `["OK", "b1a649ebe8...", false, "rate-limited: slow down there chief"]`
108 161 * `["OK", "b1a649ebe8...", false, "invalid: event creation date is too far off from the current time. Is your system clock in sync?"]`
109## Other Notes: 162 * `["OK", "b1a649ebe8...", false, "pow: difficulty 26 is less than 30"]`
110 163 * `["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/03.md b/03.md
index 3c5d764..4faf3f1 100644
--- a/03.md
+++ b/03.md
@@ -4,20 +4,33 @@ NIP-03
4OpenTimestamps Attestations for Events 4OpenTimestamps Attestations for Events
5-------------------------------------- 5--------------------------------------
6 6
7`draft` `optional` `author:fiatjaf` 7`draft` `optional` `author:fiatjaf` `author:constant`
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 ["block", <block-height-as-string>, <block-hash>],
17 "ots": <base64-encoded OTS file data> 17 ["alt", "opentimestamps attestation"]
18 ],
19 "content": <base64-encoded OTS file data>
18} 20}
19``` 21```
20 22
21The _event id_ MUST be used as the raw hash to be included in the OpenTimestamps merkle tree. 23- The OpenTimestamps proof MUST prove the referenced `e` event id as its digest.
24- The `block` tag is optional, it exists to establish a minimum date since which the given event has existed.
25- 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 and no reference to "pending" attestations since they are useless in this context.
26
27### Example OpenTimestamps proof verification flow
22 28
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]". 29Using [`nak`](https://github.com/fiatjaf/nak), [`jq`](https://jqlang.github.io/jq/) and [`ots`](https://github.com/fiatjaf/ots):
30
31```bash
32~> nak req -i e71c6ea722987debdb60f81f9ea4f604b5ac0664120dd64fb9d23abc4ec7c323 wss://nostr-pub.wellorder.net | jq -r .content | ots verify
33> using an esplora server at https://blockstream.info/api
34- sequence ending on block 810391 is valid
35timestamp validated at block [810391]
36```
diff --git a/05.md b/05.md
index 56b9156..00d69af 100644
--- a/05.md
+++ b/05.md
@@ -6,11 +6,11 @@ Mapping Nostr keys to DNS-based internet identifiers
6 6
7`final` `optional` `author:fiatjaf` `author:mikedilger` 7`final` `optional` `author:fiatjaf` `author:mikedilger`
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..a0b4a01 100644
--- a/06.md
+++ b/06.md
@@ -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..0c8c402 100644
--- a/07.md
+++ b/07.md
@@ -33,3 +33,4 @@ 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)
diff --git a/10.md b/10.md
index 6494796..9c79b4a 100644
--- a/10.md
+++ b/10.md
@@ -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..deb6f19 100644
--- a/11.md
+++ b/11.md
@@ -75,12 +75,13 @@ are rejected or fail immediately.
75 "max_filters": 100, 75 "max_filters": 100,
76 "max_limit": 5000, 76 "max_limit": 5000,
77 "max_subid_length": 100, 77 "max_subid_length": 100,
78 "min_prefix": 4,
79 "max_event_tags": 100, 78 "max_event_tags": 100,
80 "max_content_length": 8196, 79 "max_content_length": 8196,
81 "min_pow_difficulty": 30, 80 "min_pow_difficulty": 30,
82 "auth_required": true, 81 "auth_required": true,
83 "payment_required": true, 82 "payment_required": true,
83 "created_at_lower_limit":31536000,
84 "created_at_upper_limit":3,
84 } 85 }
85... 86...
86} 87}
@@ -102,9 +103,6 @@ Must be one or higher.
102 103
103- `max_subid_length`: maximum length of subscription id as a string. 104- `max_subid_length`: maximum length of subscription id as a string.
104 105
105- `min_prefix`: for `authors` and `ids` filters which are to match against
106a hex prefix, you must provide at least this many hex digits in the prefix.
107
108- `max_limit`: the relay server will clamp each filter's `limit` value to this number. 106- `max_limit`: the relay server will clamp each filter's `limit` value to this number.
109This means the client won't be able to get more than this number 107This means the client won't be able to get more than this number
110of events from a single subscription filter. This clamping is typically done silently 108of events from a single subscription filter. This clamping is typically done silently
@@ -118,7 +116,7 @@ field of any event. This is a count of unicode characters. After
118serializing into JSON it may be larger (in bytes), and is still 116serializing into JSON it may be larger (in bytes), and is still
119subject to the `max_message_length`, if defined. 117subject to the `max_message_length`, if defined.
120 118
121- `min_pow_difficulty`: new events will require at least this difficulty of PoW, 119- `min_pow_difficulty`: new events will require at least this difficulty of PoW,
122based on [NIP-13](13.md), or they will be rejected by this server. 120based on [NIP-13](13.md), or they will be rejected by this server.
123 121
124- `auth_required`: this relay requires [NIP-42](42.md) authentication 122- `auth_required`: this relay requires [NIP-42](42.md) authentication
@@ -127,9 +125,13 @@ Even if set to False, authentication may be required for specific actions.
127 125
128- `payment_required`: this relay requires payment before a new connection may perform any action. 126- `payment_required`: this relay requires payment before a new connection may perform any action.
129 127
128- `created_at_lower_limit`: 'created_at' lower limit as defined in [NIP-22](22.md)
129
130- `created_at_upper_limit`: 'created_at' upper limit as defined in [NIP-22](22.md)
131
130### Event Retention ### 132### Event Retention ###
131 133
132There may be a cost associated with storing data forever, so relays 134There may be a cost associated with storing data forever, so relays
133may wish to state retention times. The values stated here are defaults 135may wish to state retention times. The values stated here are defaults
134for unauthenticated users and visitors. Paid users would likely have 136for unauthenticated users and visitors. Paid users would likely have
135other policies. 137other policies.
@@ -151,7 +153,7 @@ all, and preferably an error will be provided when those are received.
151} 153}
152``` 154```
153 155
154`retention` is a list of specifications: each will apply to either all kinds, or 156`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 157a 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` 158start and end values. Events of indicated kind (or all) are then limited to a `count`
157and/or time period. 159and/or time period.
@@ -161,8 +163,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 163While that is unfortunate, it does allow clients to discover servers that will
162support their protocol quickly via a single HTTP fetch. 164support their protocol quickly via a single HTTP fetch.
163 165
164There is no need to specify retention times for _ephemeral events_ as defined 166There is no need to specify retention times for _ephemeral events_ since they are not retained.
165in [NIP-16](16.md) since they are not retained.
166 167
167 168
168### Content Limitations ### 169### Content Limitations ###
@@ -271,7 +272,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. 272As of 2 May 2023 the following `curl` command provided these results.
272 273
273 >curl -H "Accept: application/nostr+json" https://eden.nostr.land 274 >curl -H "Accept: application/nostr+json" https://eden.nostr.land
274 275
275 {"name":"eden.nostr.land", 276 {"name":"eden.nostr.land",
276 "description":"Eden Nostr Land - Toronto 1-01", 277 "description":"Eden Nostr Land - Toronto 1-01",
277 "pubkey":"00000000827ffaa94bfea288c3dfce4422c794fbb96625b6b31e9049f729d700", 278 "pubkey":"00000000827ffaa94bfea288c3dfce4422c794fbb96625b6b31e9049f729d700",
@@ -285,7 +286,6 @@ As of 2 May 2023 the following `curl` command provided these results.
285 "max_filters":2500, 286 "max_filters":2500,
286 "max_limit":5000, 287 "max_limit":5000,
287 "max_subid_length":256, 288 "max_subid_length":256,
288 "min_prefix":4,
289 "max_event_tags":2500, 289 "max_event_tags":2500,
290 "max_content_length":65536, 290 "max_content_length":65536,
291 "min_pow_difficulty":0, 291 "min_pow_difficulty":0,
@@ -293,5 +293,5 @@ As of 2 May 2023 the following `curl` command provided these results.
293 "payment_required":true}, 293 "payment_required":true},
294 "payments_url":"https://eden.nostr.land/invoices", 294 "payments_url":"https://eden.nostr.land/invoices",
295 "fees":{"admission":[{"amount":5000000,"unit":"msats"}], 295 "fees":{"admission":[{"amount":5000000,"unit":"msats"}],
296 "publication":[]}}, 296 "publication":[]}},
297 "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg" 297 "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..edece81 100644
--- a/15.md
+++ b/15.md
@@ -4,11 +4,11 @@ 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
11> Implemented here https://github.com/lnbits/nostrmarket 11> Implemented 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,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
@@ -54,8 +54,8 @@ A merchant can publish these events:
54 { 54 {
55 "id": <String, UUID of the shipping zone, generated by the merchant>, 55 "id": <String, UUID of the shipping zone, generated by the merchant>,
56 "name": <String (optional), zone name>, 56 "name": <String (optional), zone name>,
57 "cost": <float, cost for shipping. The currency is defined at the stall level>, 57 "cost": <float, base cost for shipping. The currency is defined at the stall level>,
58 "countries": [<String, countries included in this zone>], 58 "regions": [<String, regions included in this zone>],
59 } 59 }
60 ] 60 ]
61} 61}
@@ -63,15 +63,18 @@ A merchant can publish these events:
63 63
64Fields that are not self-explanatory: 64Fields that are not self-explanatory:
65 - `shipping`: 65 - `shipping`:
66 - an array with possible shipping zones for this stall. The customer MUST choose exactly one shipping zone. 66 - an array with possible shipping zones for this stall.
67 - 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. 68 - 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. 69 - the `id` is an internal value used by the merchant. This value must be sent back as the customer selection.
70 - each shipping zone contains the base cost for orders made to that shipping zone, but a specific shipping cost per
71 product can also be specified if the shipping cost for that product is higher than what's specified by the base cost.
69 72
70**Event Tags**: 73**Event Tags**:
71```json 74```json
72 "tags": [["d", <String, id of stall]] 75 "tags": [["d", <String, id of stall]]
73``` 76```
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`. 77 - the `d` tag is required, its value MUST be the same as the stall `id`.
75 78
76### Event `30018`: Create or update a product 79### Event `30018`: Create or update a product
77 80
@@ -87,17 +90,30 @@ Fields that are not self-explanatory:
87 "price": <float, cost of product>, 90 "price": <float, cost of product>,
88 "quantity": <int, available items>, 91 "quantity": <int, available items>,
89 "specs": [ 92 "specs": [
90 [ <String, spec key>, <String, spec value>] 93 [<String, spec key>, <String, spec value>]
91 ] 94 ],
95 "shipping": [
96 {
97 "id": <String, UUID of the shipping zone. Must match one of the zones defined for the stall>,
98 "cost": <float, extra cost for shipping. The currency is defined at the stall level>,
99 }
100 ]
92} 101}
93``` 102```
94 103
95Fields that are not self-explanatory: 104Fields that are not self-explanatory:
96 - `specs`: 105 - `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 106 - 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"]]` 107 - eg: `[["operating_system", "Android 12.0"], ["screen_size", "6.4 inches"], ["connector_type", "USB Type C"]]`
99 108
100_Open_: better to move `spec` in the `tags` section of the event? 109 _Open_: better to move `spec` in the `tags` section of the event?
110
111- `shipping`:
112 - 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
113 - the `id` should match the id of the shipping zone, as defined in the `shipping` field of the stall
114 - 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:
115 - the `base cost from the stall` for the chosen shipping option
116 - the result of multiplying the product units by the `shipping costs specified in the product`, if any.
101 117
102**Event Tags**: 118**Event Tags**:
103```json 119```json
@@ -109,8 +125,8 @@ _Open_: better to move `spec` in the `tags` section of the event?
109 ] 125 ]
110``` 126```
111 127
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`. 128 - 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. 129 - 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 130
115## Checkout events 131## Checkout events
116 132
@@ -152,7 +168,7 @@ The below json goes in content of [NIP04](https://github.com/nostr-protocol/nips
152``` 168```
153 169
154_Open_: is `contact.nostr` required? 170_Open_: is `contact.nostr` required?
155 171
156 172
157### Step 2: `merchant` request payment (event) 173### Step 2: `merchant` request payment (event)
158 174
@@ -204,6 +220,28 @@ The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/ni
204 "shipped": <Bool, true/false has been shipped>, 220 "shipped": <Bool, true/false has been shipped>,
205} 221}
206``` 222```
223## Customize Marketplace
224Create 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.
225
226### Event `30019`: Create or update marketplace UI/UX
227
228**Event Content**:
229```json
230{
231 "name": <String (optional), market name>,
232 "about": <String (optional), market description>,
233 "ui": {
234 "picture": <String (optional), market logo image URL>,
235 "banner": <String (optional), market logo banner URL>,
236 "theme": <String (optional), market theme>,
237 "darkMode": <Bool, true/false>
238 },
239 "merchants": <[String] (optional), array of pubkeys>,
240 ...
241}
242```
243
244This event leverages naddr to enable comprehensive customization and sharing of marketplace configurations, fostering a unique and engaging marketplace environment.
207 245
208## Customer support events 246## Customer support events
209 247
@@ -211,4 +249,4 @@ Customer support is handled over whatever communication method was specified. If
211 249
212## Additional 250## Additional
213 251
214Standard data models can be found here <a href="https://raw.githubusercontent.com/lnbits/nostrmarket/main/models.py">here</a> 252Standard 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..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..cd989e2 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 _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..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/24.md b/24.md
new file mode 100644
index 0000000..dee9daa
--- /dev/null
+++ b/24.md
@@ -0,0 +1,41 @@
1NIP-24
2======
3
4Extra metadata fields and tags
5------------------------------
6
7`draft` `optional` `author:fiatjaf`
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`: a bigger name with richer characters than `name`. Implementations should fallback to `name` when this is not available.
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 86ce763..7b29140 100644
--- a/25.md
+++ b/25.md
@@ -7,7 +7,7 @@ Reactions
7 7
8`draft` `optional` `author:jb55` 8`draft` `optional` `author:jb55`
9 9
10A reaction is a `kind 7` note that is used to react to other notes. 10A reaction is a `kind 7` event that is used to react to other events.
11 11
12The generic reaction, represented by the `content` set to a `+` string, SHOULD 12The generic reaction, represented by the `content` set to a `+` string, SHOULD
13be interpreted as a "like" or "upvote". 13be interpreted as a "like" or "upvote".
@@ -19,7 +19,8 @@ dislikes in a reddit-like system of upvotes and downvotes, or display them as
19separate tallies. 19separate tallies.
20 20
21The `content` MAY be an emoji, or [NIP-30](30.md) custom emoji in this case it MAY be interpreted as a "like" or "dislike", 21The `content` MAY be an emoji, or [NIP-30](30.md) custom emoji in this case it MAY be interpreted as a "like" or "dislike",
22or the client MAY display this emoji reaction on the post. 22or the client MAY display this emoji reaction on the post. If the `content` is an empty string then the client should
23consider it a "+".
23 24
24Tags 25Tags
25---- 26----
@@ -33,6 +34,9 @@ The last `e` tag MUST be the `id` of the note that is being reacted to.
33 34
34The last `p` tag MUST be the `pubkey` of the event being reacted to. 35The last `p` tag MUST be the `pubkey` of the event being reacted to.
35 36
37The reaction event MAY include a `k` tag with the stringified kind number
38of the reacted event as its value.
39
36Example code 40Example code
37 41
38```swift 42```swift
@@ -42,6 +46,7 @@ func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> Nost
42 } 46 }
43 tags.append(["e", liked.id]) 47 tags.append(["e", liked.id])
44 tags.append(["p", liked.pubkey]) 48 tags.append(["p", liked.pubkey])
49 tags.append(["k", liked.kind])
45 let ev = NostrEvent(content: "+", pubkey: pubkey, kind: 7, tags: tags) 50 let ev = NostrEvent(content: "+", pubkey: pubkey, kind: 7, tags: tags)
46 ev.calculate_id() 51 ev.calculate_id()
47 ev.sign(privkey: privkey) 52 ev.sign(privkey: privkey)
diff --git a/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/38.md b/38.md
new file mode 100644
index 0000000..f1eddcd
--- /dev/null
+++ b/38.md
@@ -0,0 +1,61 @@
1
2NIP-38
3======
4
5User Statuses
6--------------
7
8`draft` `optional` `author:jb55`
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/45.md b/45.md
index a525391..7b11950 100644
--- a/45.md
+++ b/45.md
@@ -21,6 +21,7 @@ This NIP defines the verb `COUNT`, which accepts a subscription id and filters a
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```
26["COUNT", <subscription_id>, {"count": <integer>}] 27["COUNT", <subscription_id>, {"count": <integer>}]
@@ -36,4 +37,8 @@ Examples:
36# Count posts and reactions 37# Count posts and reactions
37["COUNT", <subscription_id>, {"kinds": [1, 7], "authors": [<pubkey>]}] 38["COUNT", <subscription_id>, {"kinds": [1, 7], "authors": [<pubkey>]}]
38["COUNT", <subscription_id>, {"count": 5}] 39["COUNT", <subscription_id>, {"count": 5}]
40
41# Count posts approximately
42["COUNT", <subscription_id>, {"kinds": [1]}]
43["COUNT", <subscription_id>, {"count": 93412452, "approximate": true}]
39``` 44```
diff --git a/51.md b/51.md
index 80cc09e..cbd6be1 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` `author:gzuuus`
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 |
@@ -95,6 +130,7 @@ Then the user would create a 'Categorized People' list event like below:
95| 30000 | Categorized People | 130| 30000 | Categorized People |
96| 30001 | Categorized Bookmarks | 131| 30001 | Categorized Bookmarks |
97 132
133
98### Mute List 134### Mute List
99 135
100An event with kind `10000` is defined as a replaceable list event for listing content a user wants to mute. Any standardized tag can be included in a Mute List. 136An event with kind `10000` is defined as a replaceable list event for listing content a user wants to mute. Any standardized tag can be included in a Mute List.
@@ -109,4 +145,4 @@ An event with kind `30000` is defined as a parameterized replaceable list event
109 145
110### Categorized Bookmarks List 146### Categorized Bookmarks List
111 147
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. 148An 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. \ No newline at end of file
diff --git a/52.md b/52.md
index c601412..f5bd0ad 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
@@ -30,7 +30,7 @@ The list of tags are as follows:
30* `start` (required) inclusive start date in ISO 8601 format (YYYY-MM-DD). Must be less than `end`, if it exists. 30* `start` (required) inclusive start date in ISO 8601 format (YYYY-MM-DD). Must be less than `end`, if it exists.
31* `end` (optional) exclusive end date in ISO 8601 format (YYYY-MM-DD). If omitted, the calendar event ends on the same date as `start`. 31* `end` (optional) exclusive end date in ISO 8601 format (YYYY-MM-DD). If omitted, the calendar event ends on the same date as `start`.
32* `location` (optional) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call 32* `location` (optional) 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 as suggested as an example by [NIP-12](12.md) 33* `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location
34* `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting 34* `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting
35* `t` (optional, repeated) hashtag to categorize calendar event 35* `t` (optional, repeated) hashtag to categorize calendar event
36* `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. 36* `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc.
@@ -88,7 +88,7 @@ The list of tags are as follows:
88* `start_tzid` (optional) time zone of the start timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica` 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. 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 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 as suggested as an example by [NIP-12](12.md) 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 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 93* `t` (optional, repeated) hashtag to categorize calendar event
94* `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. 94* `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc.
@@ -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/57.md b/57.md
index ace4a03..849c869 100644
--- a/57.md
+++ b/57.md
@@ -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),
@@ -128,7 +128,7 @@ The 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.
diff --git a/58.md b/58.md
index 2fa4406..ccabc7b 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 "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.
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/65.md b/65.md
index 55f9ff0..b676029 100644
--- a/65.md
+++ b/65.md
@@ -4,73 +4,60 @@ NIP-65
4Relay List Metadata 4Relay List Metadata
5------------------- 5-------------------
6 6
7`draft` `optional` `author:mikedilger` 7`draft` `optional` `author:mikedilger` `author:vitorpamplona`
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. 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```
22 27
23Clients SHOULD write feed-related events created by their user to their user's write relays. 28This 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 29
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. 30## When to Use Read and Write
26 31
27Clients SHOULD read events that tag their user from their user's read relays. 32When seeking events **from** a user, Clients SHOULD use the WRITE relays of the user's `kind:10002`
28 33
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. 34When seeking events **about** a user, where the user was tagged, Clients SHOULD use the READ relays of the user's `kind:10002`
30 35
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. 36When broadcasting an event, Clients SHOULD:
32 37
33### Motivation 38- Broadcast the event to the WRITE relays of the author
39- Broadcast the event all READ relays of each tagged user.
34 40
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) 41## Motivation
36 42
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: 43The old model of using a fixed relay list per user centralizes in large relay operators:
38 44
39 - Most people are sending their posts to the same most popular relays in order to be more widely seen 45 - 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 46 - 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 47 - Events are being copied between relays, oftentimes to many different relays
48
49This 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 50
43### Purposes 51## 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 52
47### Suggestions 531. Clients SHOULD guide users to keep `kind:10002` lists small (2-4 relays).
48 54
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. 552. Clients SHOULD spread an author's `kind:10002` events to as many relays as viable.
50 56
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. 573. `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 58
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 594. DMs SHOULD only be broadcasted to the author's WRITE relays and to the receiver's READ relays to keep maximum privacy.
54 60
55 - finding where someone posts is rather important 615. 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 62
59### Why not in kind `0` Metadata 636. 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
index 750b076..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
@@ -60,7 +60,7 @@ Community management clients MAY filter all mentions to a given `kind:34550` eve
60 60
61# Post Approval by moderators 61# Post Approval by moderators
62 62
63The 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 notificaitons). 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. 63The 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.
64 64
65```json 65```json
66{ 66{
@@ -78,7 +78,7 @@ The post-approval event MUST include `a` tags of the communities the moderator i
78} 78}
79``` 79```
80 80
81It'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 dissapear with moderators. 81It'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.
82 82
83Post 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. 83Post 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.
84 84
diff --git a/75.md b/75.md
new file mode 100644
index 0000000..6c8cb7b
--- /dev/null
+++ b/75.md
@@ -0,0 +1,76 @@
1# NIP-75
2
3## Zap Goals
4
5`draft` `optional` `author:verbiricha`
6
7This NIP defines an event for creating fundraising goals. Users can contribute funds towards the goal by zapping the goal event.
8
9## Nostr Event
10
11A `kind:9041` event is used.
12
13The `.content` contains a human-readable description of the goal.
14
15The following tags are defined as REQUIRED.
16
17- `amount` - target amount in milisats.
18- `relays` - a list of relays the zaps to this goal will be sent to and tallied from.
19
20Example event:
21
22```json
23{
24 "kind": 9041,
25 "tags": [
26 ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", ...],
27 ["amount", "210000"],
28 ],
29 "content": "Nostrasia travel expenses",
30 ...other fields
31```
32
33The following tags are OPTIONAL.
34
35- `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.
36
37```json
38{
39 "kind": 9041,
40 "tags": [
41 ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", ...],
42 ["amount", "210000"],
43 ["closed_at", "<unix timestamp in seconds>"],
44 ],
45 "content": "Nostrasia travel expenses",
46 ...other fields
47```
48
49The goal MAY include an `r` or `a` tag linking to a URL or parameterized replaceable event.
50
51The goal MAY include multiple beneficiary pubkeys by specifying [`zap` tags](57.md#appendix-g-zap-tag-on-other-events).
52
53Parameterized replaceable events can link to a goal by using a `goal` tag specifying the event id and an optional relay hint.
54
55```json
56{
57 "kind": 3XXXX,
58 "tags": [
59 ...
60 ["goal", "<event id>", "<Relay URL (optional)>"],
61 ],
62 ...other fields
63```
64
65## Client behavior
66
67Clients MAY display funding goals on user profiles.
68
69When zapping a goal event, clients MUST include the relays in the `relays` tag of the goal event in the zap request `relays` tag.
70
71When zapping a parameterized replaceable event with a `goal` tag, clients SHOULD tag the goal event id in the `e` tag of the zap request.
72
73## Use cases
74
75- Fundraising clients
76- Adding funding goals to events such as long form posts, badges or live streams
diff --git a/89.md b/89.md
index 5eee3b8..4503ecf 100644
--- a/89.md
+++ b/89.md
@@ -61,7 +61,7 @@ The third value of the tag SHOULD be the platform where this recommendation migh
61} 61}
62``` 62```
63 63
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.) 64* `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 65
66* `k` tags' value is the event kind that is supported by this `kind:31990`. 66* `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: 67Using a `k` tag(s) (instead of having the kind onf the NIP-33 `d` tag) provides:
diff --git a/94.md b/94.md
index 24dd346..c5e0f18 100644
--- a/94.md
+++ b/94.md
@@ -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,6 +21,10 @@ 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{
@@ -37,9 +41,13 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr
37 ["dim", <size of file in pixels>], 41 ["dim", <size of file in pixels>],
38 ["magnet",<magnet URI> ], 42 ["magnet",<magnet URI> ],
39 ["i",<torrent infohash>], 43 ["i",<torrent infohash>],
40 ["blurhash", <value>] 44 ["blurhash", <value>],
45 ["thumb", <string with thumbnail URI>],
46 ["image", <string with preview URI>],
47 ["summary", <excerpt>],
48 ["alt", <description>]
41 ], 49 ],
42 "content": <description>, 50 "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> 51 "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field>
44} 52}
45``` 53```
diff --git a/98.md b/98.md
index ecbebc0..c8cba0f 100644
--- a/98.md
+++ b/98.md
@@ -6,9 +6,9 @@ HTTP Auth
6 6
7`draft` `optional` `author:kieran` `author:melvincarvalho` 7`draft` `optional` `author:kieran` `author:melvincarvalho`
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
@@ -45,7 +45,7 @@ Example event:
45 45
46Servers MUST perform the following checks in order to validate the event: 46Servers MUST perform the following checks in order to validate the event:
471. The `kind` MUST be `27235`. 471. The `kind` MUST be `27235`.
482. The `created_at` MUST be within a reasonable time window (suggestion 60 seconds). 482. 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). 493. 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. 504. The `method` tag MUST be the same HTTP method used for the requested resource.
51 51
@@ -53,11 +53,11 @@ When the request contains a body (as in POST/PUT/PATCH methods) clients SHOULD i
53 53
54If one of the checks was to fail the server SHOULD respond with a 401 Unauthorized response code. 54If one of the checks was to fail the server SHOULD respond with a 401 Unauthorized response code.
55 55
56All other checks which server MAY do are OPTIONAL, and implementation specific. 56Servers MAY perform additional implementation-specific validation checks.
57 57
58## Request Flow 58## Request Flow
59 59
60Using the `Authorization` header, the `kind 27235` event MUST be `base64` encoded and use the Authorization scheme `Nostr` 60Using the `Authorization` HTTP header, the `kind 27235` event MUST be `base64` encoded and use the Authorization scheme `Nostr`
61 61
62Example HTTP Authorization header: 62Example HTTP Authorization header:
63``` 63```
@@ -65,4 +65,4 @@ Authorization: Nostr eyJpZCI6ImZlOTY0ZTc1ODkwMzM2MGYyOGQ4NDI0ZDA5MmRhODQ5NGVkMjA
65``` 65```
66 66
67## Reference Implementations 67## Reference Implementations
68- C# ASP.NET `AuthenticationHandler` [NostrAuth.cs](https://gist.github.com/v0l/74346ae530896115bfe2504c8cd018d3) \ No newline at end of file 68- C# ASP.NET `AuthenticationHandler` [NostrAuth.cs](https://gist.github.com/v0l/74346ae530896115bfe2504c8cd018d3)
diff --git a/README.md b/README.md
index a3e19f5..6f9cb03 100644
--- a/README.md
+++ b/README.md
@@ -30,17 +30,15 @@ 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)
41- [NIP-24: Extra metadata fields and tags](24.md)
44- [NIP-25: Reactions](25.md) 42- [NIP-25: Reactions](25.md)
45- [NIP-26: Delegated Event Signing](26.md) 43- [NIP-26: Delegated Event Signing](26.md)
46- [NIP-27: Text Note References](27.md) 44- [NIP-27: Text Note References](27.md)
@@ -48,8 +46,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
48- [NIP-30: Custom Emoji](30.md) 46- [NIP-30: Custom Emoji](30.md)
49- [NIP-31: Dealing with Unknown Events](31.md) 47- [NIP-31: Dealing with Unknown Events](31.md)
50- [NIP-32: Labeling](32.md) 48- [NIP-32: Labeling](32.md)
51- [NIP-33: Parameterized Replaceable Events](33.md)
52- [NIP-36: Sensitive Content](36.md) 49- [NIP-36: Sensitive Content](36.md)
50- [NIP-38: User Statuses](38.md)
53- [NIP-39: External Identities in Profiles](39.md) 51- [NIP-39: External Identities in Profiles](39.md)
54- [NIP-40: Expiration Timestamp](40.md) 52- [NIP-40: Expiration Timestamp](40.md)
55- [NIP-42: Authentication of clients to relays](42.md) 53- [NIP-42: Authentication of clients to relays](42.md)
@@ -57,7 +55,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
57- [NIP-46: Nostr Connect](46.md) 55- [NIP-46: Nostr Connect](46.md)
58- [NIP-47: Wallet Connect](47.md) 56- [NIP-47: Wallet Connect](47.md)
59- [NIP-48: Proxy Tags](48.md) 57- [NIP-48: Proxy Tags](48.md)
60- [NIP-50: Keywords filter](50.md) 58- [NIP-50: Search Capability](50.md)
61- [NIP-51: Lists](51.md) 59- [NIP-51: Lists](51.md)
62- [NIP-52: Calendar Events](52.md) 60- [NIP-52: Calendar Events](52.md)
63- [NIP-53: Live Activities](53.md) 61- [NIP-53: Live Activities](53.md)
@@ -66,6 +64,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
66- [NIP-58: Badges](58.md) 64- [NIP-58: Badges](58.md)
67- [NIP-65: Relay List Metadata](65.md) 65- [NIP-65: Relay List Metadata](65.md)
68- [NIP-72: Moderated Communities](72.md) 66- [NIP-72: Moderated Communities](72.md)
67- [NIP-75: Zap Goals](75.md)
69- [NIP-78: Application-specific data](78.md) 68- [NIP-78: Application-specific data](78.md)
70- [NIP-89: Recommended Application Handlers](89.md) 69- [NIP-89: Recommended Application Handlers](89.md)
71- [NIP-90: Data Vending Machines](90.md) 70- [NIP-90: Data Vending Machines](90.md)
@@ -79,7 +78,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
79| ------- | -------------------------- | ----------- | 78| ------- | -------------------------- | ----------- |
80| `0` | Metadata | [1](01.md) | 79| `0` | Metadata | [1](01.md) |
81| `1` | Short Text Note | [1](01.md) | 80| `1` | Short Text Note | [1](01.md) |
82| `2` | Recommend Relay | [1](01.md) | 81| `2` | Recommend Relay | |
83| `3` | Contacts | [2](02.md) | 82| `3` | Contacts | [2](02.md) |
84| `4` | Encrypted Direct Messages | [4](04.md) | 83| `4` | Encrypted Direct Messages | [4](04.md) |
85| `5` | Event Deletion | [9](09.md) | 84| `5` | Event Deletion | [9](09.md) |
@@ -94,9 +93,11 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
94| `44` | Channel Mute User | [28](28.md) | 93| `44` | Channel Mute User | [28](28.md) |
95| `1063` | File Metadata | [94](94.md) | 94| `1063` | File Metadata | [94](94.md) |
96| `1311` | Live Chat Message | [53](53.md) | 95| `1311` | Live Chat Message | [53](53.md) |
96| `1040` | OpenTimestamps | [03](03.md) |
97| `1984` | Reporting | [56](56.md) | 97| `1984` | Reporting | [56](56.md) |
98| `1985` | Label | [32](32.md) | 98| `1985` | Label | [32](32.md) |
99| `4550` | Community Post Approval | [72](72.md) | 99| `4550` | Community Post Approval | [72](72.md) |
100| `9041` | Zap Goal | [75](75.md) |
100| `9734` | Zap Request | [57](57.md) | 101| `9734` | Zap Request | [57](57.md) |
101| `9735` | Zap | [57](57.md) | 102| `9735` | Zap | [57](57.md) |
102| `10000` | Mute List | [51](51.md) | 103| `10000` | Mute List | [51](51.md) |
@@ -118,6 +119,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
118| `30024` | Draft Long-form Content | [23](23.md) | 119| `30024` | Draft Long-form Content | [23](23.md) |
119| `30078` | Application-specific Data | [78](78.md) | 120| `30078` | Application-specific Data | [78](78.md) |
120| `30311` | Live Event | [53](53.md) | 121| `30311` | Live Event | [53](53.md) |
122| `30315` | User Statuses | [38](38.md) |
121| `30402` | Classified Listing | [99](99.md) | 123| `30402` | Classified Listing | [99](99.md) |
122| `30403` | Draft Classified Listing | [99](99.md) | 124| `30403` | Draft Classified Listing | [99](99.md) |
123| `31922` | Date-Based Calendar Event | [52](52.md) | 125| `31922` | Date-Based Calendar Event | [52](52.md) |
@@ -130,84 +132,74 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
130| `65000` | Job Feedback | [90](90.md) | 132| `65000` | Job Feedback | [90](90.md) |
131| `65001` | Job Result | [90](90.md) | 133| `65001` | Job Result | [90](90.md) |
132 134
133### Event Kind Ranges
134
135| range | description | NIP |
136| ---------------- | -------------------------------- | ----------- |
137| `1000`--`9999` | Regular Events | [16](16.md) |
138| `10000`--`19999` | Replaceable Events | [16](16.md) |
139| `20000`--`29999` | Ephemeral Events | [16](16.md) |
140| `30000`--`39999` | Parameterized Replaceable Events | [33](33.md) |
141| `65002`--`66000` | Job Requests | [90](90.md) |
142
143## Message types 135## Message types
144 136
145### Client to Relay 137### Client to Relay
146 138
147| type | description | NIP | 139| type | description | NIP |
148| ------- | --------------------------------------------------- | ----------- | 140| ------- | --------------------------------------------------- | ----------- |
141| `EVENT` | used to publish events | [01](01.md) |
142| `REQ` | used to request events and subscribe to new updates | [01](01.md) |
143| `CLOSE` | used to stop previous subscriptions | [01](01.md) |
149| `AUTH` | used to send authentication events | [42](42.md) | 144| `AUTH` | used to send authentication events | [42](42.md) |
150| `CLOSE` | used to stop previous subscriptions | [1](01.md) |
151| `COUNT` | used to request event counts | [45](45.md) | 145| `COUNT` | used to request event counts | [45](45.md) |
152| `EVENT` | used to publish events | [1](01.md) |
153| `REQ` | used to request events and subscribe to new updates | [1](01.md) |
154 146
155### Relay to Client 147### Relay to Client
156 148
157| type | description | NIP | 149| type | description | NIP |
158| -------- | ------------------------------------------------------- | ----------- | 150| -------- | ------------------------------------------------------- | ----------- |
151| `EOSE` | used to notify clients all stored events have been sent | [01](01.md) |
152| `EVENT` | used to send events requested to clients | [01](01.md) |
153| `NOTICE` | used to send human-readable messages to clients | [01](01.md) |
154| `OK` | used to notify clients if an EVENT was successful | [01](01.md) |
159| `AUTH` | used to send authentication challenges | [42](42.md) | 155| `AUTH` | used to send authentication challenges | [42](42.md) |
160| `COUNT` | used to send requested event counts to clients | [45](45.md) | 156| `COUNT` | used to send requested event counts to clients | [45](45.md) |
161| `EOSE` | used to notify clients all stored events have been sent | [1](01.md) |
162| `EVENT` | used to send events requested to clients | [1](01.md) |
163| `NOTICE` | used to send human-readable messages to clients | [1](01.md) |
164| `OK` | used to notify clients if an EVENT was successful | [20](20.md) |
165 157
166Please update these lists when proposing NIPs introducing new event kinds. 158Please update these lists when proposing NIPs introducing new event kinds.
167 159
168When experimenting with kinds, keep in mind the classification introduced by [NIP-16](16.md) and [NIP-33](33.md).
169
170## Standardized Tags 160## Standardized Tags
171 161
172| name | value | other parameters | NIP | 162| name | value | other parameters | NIP |
173| ----------------- | ------------------------------------ | -------------------- | ------------------------ | 163| ----------------- | ------------------------------------ | -------------------- | ------------------------------------- |
174| `a` | coordinates to an event | relay URL | [33](33.md), [23](23.md) | 164| `e` | event id (hex) | relay URL, marker | [01](01.md), [10](10.md) |
175| `alt` | Alt tag | -- | [31](31.md) | 165| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) |
176| `d` | identifier | -- | [33](33.md) | 166| `a` | coordinates to an event | relay URL | [01](01.md) |
177| `e` | event id (hex) | relay URL, marker | [1](01.md), [10](10.md) | 167| `d` | identifier | -- | [01](01.md) |
178| `g` | geohash | -- | [12](12.md), [52](52.md) | 168| `alt` | summary | -- | [31](31.md) |
179| `i` | identity | proof | [39](39.md) | 169| `g` | geohash | -- | [52](52.md) |
180| `k` | kind number (string) | -- | [18](18.md), [72](72.md) | 170| `i` | identity | proof | [39](39.md) |
181| `l` | label, label namespace | annotations | [32](32.md) | 171| `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) |
182| `L` | label namespace | -- | [32](32.md) | 172| `l` | label, label namespace | annotations | [32](32.md) |
183| `p` | pubkey (hex) | relay URL | [1](01.md) | 173| `L` | label namespace | -- | [32](32.md) |
184| `r` | a reference (URL, etc) | -- | [12](12.md) | 174| `m` | MIME type | -- | [94](94.md) |
185| `t` | hashtag | -- | [12](12.md) | 175| `r` | a reference (URL, etc) | petname | |
186| `amount` | millisats | -- | [57](57.md) | 176| `r` | relay url | marker | [65](65.md) |
187| `bolt11` | `bolt11` invoice | -- | [57](57.md) | 177| `t` | hashtag | -- | |
188| `challenge` | challenge string | -- | [42](42.md) | 178| `amount` | millisatoshis, stringified | -- | [57](57.md) |
189| `content-warning` | reason | -- | [36](36.md) | 179| `bolt11` | `bolt11` invoice | -- | [57](57.md) |
190| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | 180| `challenge` | challenge string | -- | [42](42.md) |
191| `description` | badge description | -- | [58](58.md) | 181| `content-warning` | reason | -- | [36](36.md) |
192| `description` | invoice description | -- | [57](57.md) | 182| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) |
193| `emoji` | shortcode, image URL | -- | [30](30.md) | 183| `description` | invoice/badge description | -- | [57](57.md), [58](58.md) |
194| `expiration` | unix timestamp (string) | -- | [40](40.md) | 184| `emoji` | shortcode, image URL | -- | [30](30.md) |
195| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | 185| `expiration` | unix timestamp (string) | -- | [40](40.md) |
196| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | 186| `goal` | event id (hex) | relay URL | [75](75.md) |
197| `location` | location string | -- | [52](52.md), [99](99.md) | 187| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) |
198| `name` | badge name | -- | [58](58.md) | 188| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) |
199| `nonce` | random | -- | [13](13.md) | 189| `location` | location string | -- | [52](52.md), [99](99.md) |
200| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | 190| `name` | badge name | -- | [58](58.md) |
201| `price` | price | currency, frequency | [99](99.md) | 191| `nonce` | random | -- | [13](13.md) |
202| `proxy` | external ID | protocol | [48](48.md) | 192| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) |
203| `published_at` | unix timestamp (string) | -- | [23](23.md) | 193| `price` | price | currency, frequency | [99](99.md) |
204| `relay` | relay url | -- | [42](42.md) | 194| `proxy` | external ID | protocol | [48](48.md) |
205| `relays` | relay list | -- | [57](57.md) | 195| `published_at` | unix timestamp (string) | -- | [23](23.md) |
206| `subject` | subject | -- | [14](14.md) | 196| `relay` | relay url | -- | [42](42.md) |
207| `summary` | article summary | -- | [23](23.md) | 197| `relays` | relay list | -- | [57](57.md) |
208| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | 198| `subject` | subject | -- | [14](14.md) |
209| `title` | article title | -- | [23](23.md) | 199| `summary` | article summary | -- | [23](23.md) |
210| `zap` | profile name | type of value | [57](57.md) | 200| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) |
201| `title` | article title | -- | [23](23.md) |
202| `zap` | pubkey (hex), relay URL | weight | [57](57.md) |
211 203
212## Criteria for acceptance of NIPs 204## Criteria for acceptance of NIPs
213 205