upleb.uk

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

summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrancisco Calderón <fjcalderon@gmail.com>2024-11-04 15:39:21 -0300
committerGitHub <noreply@github.com>2024-11-04 15:39:21 -0300
commit03f3bc39678262ecbd5d870c9da44723023557ff (patch)
treee75ecf32d3bc906a8b26314488a1ae90996169c1
parentf72a2f69ed93cf442e83bf9e7e16f6c06da40384 (diff)
parent6bcd89c097e97e65dbc95e7c6b7b8348e8dd6b5c (diff)
Merge branch 'master' into p2p-nip
-rw-r--r--01.md19
-rw-r--r--02.md4
-rw-r--r--05.md21
-rw-r--r--07.md4
-rw-r--r--09.md36
-rw-r--r--10.md6
-rw-r--r--11.md32
-rw-r--r--13.md57
-rw-r--r--15.md35
-rw-r--r--17.md12
-rw-r--r--18.md8
-rw-r--r--19.md5
-rw-r--r--21.md2
-rw-r--r--23.md6
-rw-r--r--24.md6
-rw-r--r--25.md24
-rw-r--r--26.md2
-rw-r--r--27.md2
-rw-r--r--28.md26
-rw-r--r--29.md183
-rw-r--r--30.md16
-rw-r--r--32.md47
-rw-r--r--33.md2
-rw-r--r--34.md46
-rw-r--r--35.md4
-rw-r--r--38.md10
-rw-r--r--39.md9
-rw-r--r--42.md8
-rw-r--r--44.md4
-rw-r--r--45.md10
-rw-r--r--46.md97
-rw-r--r--47.md12
-rw-r--r--50.md4
-rw-r--r--51.md6
-rw-r--r--52.md29
-rw-r--r--53.md14
-rw-r--r--54.md34
-rw-r--r--55.md213
-rw-r--r--56.md12
-rw-r--r--57.md6
-rw-r--r--58.md17
-rw-r--r--59.md6
-rw-r--r--60.md205
-rw-r--r--61.md132
-rw-r--r--64.md146
-rw-r--r--65.md10
-rw-r--r--70.md45
-rw-r--r--71.md125
-rw-r--r--72.md51
-rw-r--r--73.md60
-rw-r--r--75.md26
-rw-r--r--78.md2
-rw-r--r--84.md4
-rw-r--r--89.md22
-rw-r--r--90.md26
-rw-r--r--94.md17
-rw-r--r--96.md61
-rw-r--r--99.md12
-rw-r--r--BREAKING.md9
-rw-r--r--README.md348
60 files changed, 1668 insertions, 729 deletions
diff --git a/01.md b/01.md
index c11a095..d62f317 100644
--- a/01.md
+++ b/01.md
@@ -77,11 +77,11 @@ This NIP defines 3 standard tags that can be used across all event kinds with th
77 77
78- The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, <recommended relay URL, optional>]` 78- The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, <recommended relay URL, optional>]`
79- The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, <recommended relay URL, optional>]` 79- The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, <recommended relay URL, optional>]`
80- The `a` tag, used to refer to a (maybe parameterized) replaceable event 80- The `a` tag, used to refer to an addressable or replaceable event
81 - for a parameterized replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]` 81 - for an addressable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]`
82 - for a non-parameterized replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:, <recommended relay URL, optional>]` 82 - for a normal replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:, <recommended relay URL, optional>]`
83 83
84As a convention, all single-letter (only english alphabet letters: a-z, A-Z) key tags are expected to be indexed by relays, such that it is possible, for example, to query or subscribe to events that reference the event `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"` by using the `{"#e": ["5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"]}` filter. 84As a convention, all single-letter (only english alphabet letters: a-z, A-Z) key tags are expected to be indexed by relays, such that it is possible, for example, to query or subscribe to events that reference the event `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"` by using the `{"#e": ["5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"]}` filter. Only the first value in any given tag is indexed.
85 85
86### Kinds 86### Kinds
87 87
@@ -95,7 +95,7 @@ And also a convention for kind ranges that allow for easier experimentation and
95- for kind `n` such that `1000 <= n < 10000 || 4 <= n < 45 || n == 1 || n == 2`, events are **regular**, which means they're all expected to be stored by relays. 95- for kind `n` such that `1000 <= n < 10000 || 4 <= n < 45 || n == 1 || n == 2`, events are **regular**, which means they're all expected to be stored by relays.
96- for kind `n` such that `10000 <= n < 20000 || n == 0 || n == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event MUST be stored by relays, older versions MAY be discarded. 96- for kind `n` such that `10000 <= n < 20000 || n == 0 || n == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event MUST be stored by relays, older versions MAY be discarded.
97- for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. 97- for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays.
98- for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag's first value, only the latest event MUST be stored by relays, older versions MAY be discarded. 98- for kind `n` such that `30000 <= n < 40000`, events are **addressable** by their `kind`, `pubkey` and `d` tag value -- which means that, for each combination of `kind`, `pubkey` and the `d` tag value, only the latest event MUST be stored by relays, older versions MAY be discarded.
99 99
100In case of replaceable events with the same timestamp, the event with the lowest id (first in lexical order) should be retained, and the other discarded. 100In case of replaceable events with the same timestamp, the event with the lowest id (first in lexical order) should be retained, and the other discarded.
101 101
@@ -125,13 +125,13 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th
125 "authors": <a list of lowercase pubkeys, the pubkey of an event must be one of these>, 125 "authors": <a list of lowercase pubkeys, the pubkey of an event must be one of these>,
126 "kinds": <a list of a kind numbers>, 126 "kinds": <a list of a kind numbers>,
127 "#<single-letter (a-zA-Z)>": <a list of tag values, for #e — a list of event ids, for #p — a list of pubkeys, etc.>, 127 "#<single-letter (a-zA-Z)>": <a list of tag values, for #e — a list of event ids, for #p — a list of pubkeys, etc.>,
128 "since": <an integer unix timestamp in seconds, events must be newer than this to pass>, 128 "since": <an integer unix timestamp in seconds. Events must have a created_at >= to this to pass>,
129 "until": <an integer unix timestamp in seconds, events must be older than this to pass>, 129 "until": <an integer unix timestamp in seconds. Events must have a created_at <= to this to pass>,
130 "limit": <maximum number of events relays SHOULD return in the initial query> 130 "limit": <maximum number of events relays SHOULD return in the initial query>
131} 131}
132``` 132```
133 133
134Upon receiving a `REQ` message, the relay SHOULD query its internal database and return events that match the filter, then store that filter and send again all future events it receives to that same websocket until the websocket is closed. The `CLOSE` event is received with the same `<subscription_id>` or a new `REQ` is sent using the same `<subscription_id>`, in which case relay MUST overwrite the previous subscription. 134Upon receiving a `REQ` message, the relay SHOULD return events that match the filter. Any new events it receives SHOULD be sent to that same websocket until the connection is closed, a `CLOSE` event is received with the same `<subscription_id>`, or a new `REQ` is sent using the same `<subscription_id>` (in which case a new subscription is created, replacing the old one).
135 135
136Filter attributes containing lists (`ids`, `authors`, `kinds` and tag filters like `#e`) are JSON arrays with one or more values. At least one of the arrays' values must match the relevant field in an event for the condition to be considered a match. For scalar event attributes such as `authors` and `kind`, the attribute from the event must be contained in the filter list. In the case of tag attributes such as `#e`, for which an event may have multiple values, the event and filter condition values must have at least one item in common. 136Filter attributes containing lists (`ids`, `authors`, `kinds` and tag filters like `#e`) are JSON arrays with one or more values. At least one of the arrays' values must match the relevant field in an event for the condition to be considered a match. For scalar event attributes such as `authors` and `kind`, the attribute from the event must be contained in the filter list. In the case of tag attributes such as `#e`, for which an event may have multiple values, the event and filter condition values must have at least one item in common.
137 137
@@ -143,7 +143,7 @@ All conditions of a filter that are specified must match for an event for it to
143 143
144A `REQ` message may contain multiple filters. In this case, events that match any of the filters are to be returned, i.e., multiple filters are to be interpreted as `||` conditions. 144A `REQ` message may contain multiple filters. In this case, events that match any of the filters are to be returned, i.e., multiple filters are to be interpreted as `||` conditions.
145 145
146The `limit` property of a filter is only valid for the initial query and MUST be ignored afterwards. When `limit: n` is present it is assumed that the events returned in the initial query will be the last `n` events ordered by the `created_at`. It is safe to return less events than `limit` specifies, but it is expected that relays do not return (much) more events than requested so clients don't get unnecessarily overwhelmed by data. 146The `limit` property of a filter is only valid for the initial query and MUST be ignored afterwards. When `limit: n` is present it is assumed that the events returned in the initial query will be the last `n` events ordered by the `created_at`. Newer events should appear first, and in the case of ties the event with the lowest id (first in lexical order) should be first. 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.
147 147
148### From relay to client: sending events and notices 148### From relay to client: sending events and notices
149 149
@@ -169,7 +169,6 @@ This NIP defines no rules for how `NOTICE` messages should be sent or treated.
169 * `["OK", "b1a649ebe8...", false, "pow: difficulty 26 is less than 30"]` 169 * `["OK", "b1a649ebe8...", false, "pow: difficulty 26 is less than 30"]`
170 * `["OK", "b1a649ebe8...", false, "error: could not connect to the database"]` 170 * `["OK", "b1a649ebe8...", false, "error: could not connect to the database"]`
171- `CLOSED` messages MUST be sent in response to a `REQ` when the relay refuses to fulfill it. It can also be sent when a relay decides to kill a subscription on its side before a client has disconnected or sent a `CLOSE`. This message uses the same pattern of `OK` messages with the machine-readable prefix and human-readable message. Some examples: 171- `CLOSED` messages MUST be sent in response to a `REQ` when the relay refuses to fulfill it. It can also be sent when a relay decides to kill a subscription on its side before a client has disconnected or sent a `CLOSE`. This message uses the same pattern of `OK` messages with the machine-readable prefix and human-readable message. Some examples:
172 * `["CLOSED", "sub1", "duplicate: sub1 already opened"]`
173 * `["CLOSED", "sub1", "unsupported: filter contains unknown elements"]` 172 * `["CLOSED", "sub1", "unsupported: filter contains unknown elements"]`
174 * `["CLOSED", "sub1", "error: could not connect to the database"]` 173 * `["CLOSED", "sub1", "error: could not connect to the database"]`
175 * `["CLOSED", "sub1", "error: shutting down idle subscription"]` 174 * `["CLOSED", "sub1", "error: shutting down idle subscription"]`
diff --git a/02.md b/02.md
index 4029b22..8354bf0 100644
--- a/02.md
+++ b/02.md
@@ -14,7 +14,7 @@ The `.content` is not used.
14 14
15For example: 15For example:
16 16
17```json 17```jsonc
18{ 18{
19 "kind": 3, 19 "kind": 3,
20 "tags": [ 20 "tags": [
@@ -23,7 +23,7 @@ For example:
23 ["p", "612ae..e610f", "ws://carolrelay.com/ws", "carol"] 23 ["p", "612ae..e610f", "ws://carolrelay.com/ws", "carol"]
24 ], 24 ],
25 "content": "", 25 "content": "",
26 ...other fields 26 // other fields...
27} 27}
28``` 28```
29 29
diff --git a/05.md b/05.md
index a1d488d..b914344 100644
--- a/05.md
+++ b/05.md
@@ -16,12 +16,12 @@ The result should be a JSON document object with a key `"names"` that should the
16 16
17If a client sees an event like this: 17If a client sees an event like this:
18 18
19```json 19```jsonc
20{ 20{
21 "pubkey": "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9", 21 "pubkey": "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9",
22 "kind": 0, 22 "kind": 0,
23 "content": "{\"name\": \"bob\", \"nip05\": \"bob@example.com\"}" 23 "content": "{\"name\": \"bob\", \"nip05\": \"bob@example.com\"}"
24 ... 24 // other fields...
25} 25}
26``` 26```
27 27
@@ -33,7 +33,7 @@ It will make a GET request to `https://example.com/.well-known/nostr.json?name=b
33 "bob": "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9" 33 "bob": "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9"
34 } 34 }
35} 35}
36```` 36```
37 37
38or with the **recommended** `"relays"` attribute: 38or with the **recommended** `"relays"` attribute:
39 39
@@ -46,7 +46,7 @@ or with the **recommended** `"relays"` attribute:
46 "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9": [ "wss://relay.example.com", "wss://relay2.example.com" ] 46 "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9": [ "wss://relay.example.com", "wss://relay2.example.com" ]
47 } 47 }
48} 48}
49```` 49```
50 50
51If the pubkey matches the one given in `"names"` (as in the example above) that means the association is right and the `"nip05"` identifier is valid and can be displayed. 51If the pubkey matches the one given in `"names"` (as in the example above) that means the association is right and the `"nip05"` identifier is valid and can be displayed.
52 52
@@ -58,6 +58,15 @@ A client may implement support for finding users' public keys from _internet ide
58 58
59## Notes 59## Notes
60 60
61### Identification, not verification
62
63The NIP-05 is not intended to _verify_ a user, but only to _identify_ them, for the purpose of facilitating the exchange of a contact or their search.
64Exceptions are people who own (e.g., a company) or are connected (e.g., a project) to a well-known domain, who can exploit NIP-05 as an attestation of their relationship with it, and thus to the organization behind it, thereby gaining an element of trust.
65
66### User discovery implementation suggestion
67
68A client can use this to allow users to search other profiles. If a client has a search box or something like that, a user may be able to type "bob@example.com" there and the client would recognize that and do the proper queries to obtain a pubkey and suggest that to the user.
69
61### Clients must always follow public keys, not NIP-05 addresses 70### Clients must always follow public keys, not NIP-05 addresses
62 71
63For example, if after finding that `bob@bob.com` has the public key `abc...def`, the user clicks a button to follow that profile, the client must keep a primary reference to `abc...def`, not `bob@bob.com`. If, for any reason, the address `https://bob.com/.well-known/nostr.json?name=bob` starts returning the public key `1d2...e3f` at any time in the future, the client must not replace `abc...def` in his list of followed profiles for the user (but it should stop displaying "bob@bob.com" for that user, as that will have become an invalid `"nip05"` property). 72For example, if after finding that `bob@bob.com` has the public key `abc...def`, the user clicks a button to follow that profile, the client must keep a primary reference to `abc...def`, not `bob@bob.com`. If, for any reason, the address `https://bob.com/.well-known/nostr.json?name=bob` starts returning the public key `1d2...e3f` at any time in the future, the client must not replace `abc...def` in his list of followed profiles for the user (but it should stop displaying "bob@bob.com" for that user, as that will have become an invalid `"nip05"` property).
@@ -66,10 +75,6 @@ For example, if after finding that `bob@bob.com` has the public key `abc...def`,
66 75
67Keys must be returned in hex format. Keys in NIP-19 `npub` format are only meant to be used for display in client UIs, not in this NIP. 76Keys must be returned in hex format. Keys in NIP-19 `npub` format are only meant to be used for display in client UIs, not in this NIP.
68 77
69### User Discovery implementation suggestion
70
71A client can also use this to allow users to search other profiles. If a client has a search box or something like that, a user may be able to type "bob@example.com" there and the client would recognize that and do the proper queries to obtain a pubkey and suggest that to the user.
72
73### Showing just the domain as an identifier 78### Showing just the domain as an identifier
74 79
75Clients may treat the identifier `_@domain` as the "root" identifier, and choose to display it as just the `<domain>`. For example, if Bob owns `bob.com`, he may not want an identifier like `bob@bob.com` as that is redundant. Instead, Bob can use the identifier `_@bob.com` and expect Nostr clients to show and treat that as just `bob.com` for all purposes. 80Clients may treat the identifier `_@domain` as the "root" identifier, and choose to display it as just the `<domain>`. For example, if Bob owns `bob.com`, he may not want an identifier like `bob@bob.com` as that is redundant. Instead, Bob can use the identifier `_@bob.com` and expect Nostr clients to show and treat that as just `bob.com` for all purposes.
diff --git a/07.md b/07.md
index 6c66322..9f836d8 100644
--- a/07.md
+++ b/07.md
@@ -24,6 +24,10 @@ async window.nostr.nip44.encrypt(pubkey, plaintext): string // returns ciphertex
24async window.nostr.nip44.decrypt(pubkey, ciphertext): string // takes ciphertext as specified in nip-44 24async window.nostr.nip44.decrypt(pubkey, ciphertext): string // takes ciphertext as specified in nip-44
25``` 25```
26 26
27### Recommendation to Extension Authors
28To make sure that the `window.nostr` is available to nostr clients on page load, the authors who create Chromium and Firefox extensions should load their scripts by specifying `"run_at": "document_end"` in the extension's manifest.
29
30
27### Implementation 31### Implementation
28 32
29See https://github.com/aljazceru/awesome-nostr#nip-07-browser-extensions. 33See https://github.com/aljazceru/awesome-nostr#nip-07-browser-extensions.
diff --git a/09.md b/09.md
index 5e79ac2..23ffeab 100644
--- a/09.md
+++ b/09.md
@@ -1,51 +1,53 @@
1NIP-09 1NIP-09
2====== 2======
3 3
4Event Deletion 4Event Deletion Request
5-------------- 5----------------------
6 6
7`draft` `optional` 7`draft` `optional`
8 8
9A special event with kind `5`, meaning "deletion" is defined as having a list of one or more `e` tags, each referencing an event the author is requesting to be deleted. 9A special event with kind `5`, meaning "deletion request" is defined as having a list of one or more `e` or `a` tags, each referencing an event the author is requesting to be deleted. Deletion requests SHOULD include a `k` tag for the kind of each event being requested for deletion.
10 10
11Each tag entry must contain an "e" event id and/or `a` tags intended for deletion. 11The event's `content` field MAY contain a text note describing the reason for the deletion request.
12
13The event's `content` field MAY contain a text note describing the reason for the deletion.
14 12
15For example: 13For example:
16 14
17``` 15```jsonc
18{ 16{
19 "kind": 5, 17 "kind": 5,
20 "pubkey": <32-bytes hex-encoded public key of the event creator>, 18 "pubkey": <32-bytes hex-encoded public key of the event creator>,
21 "tags": [ 19 "tags": [
22 ["e", "dcd59..464a2"], 20 ["e", "dcd59..464a2"],
23 ["e", "968c5..ad7a4"], 21 ["e", "968c5..ad7a4"],
24 ["a", "<kind>:<pubkey>:<d-identifier>"] 22 ["a", "<kind>:<pubkey>:<d-identifier>"],
23 ["k", "1"],
24 ["k", "30023"]
25 ], 25 ],
26 "content": "these posts were published by accident", 26 "content": "these posts were published by accident",
27 ...other fields 27 // other fields...
28} 28}
29``` 29```
30 30
31Relays SHOULD delete or stop publishing any referenced events that have an identical `pubkey` as the deletion request. Clients SHOULD hide or otherwise indicate a deletion status for referenced events. 31Relays SHOULD delete or stop publishing any referenced events that have an identical `pubkey` as the deletion request. Clients SHOULD hide or otherwise indicate a deletion request status for referenced events.
32 32
33Relays SHOULD continue to publish/share the deletion events indefinitely, as clients may already have the event that's intended to be deleted. Additionally, clients SHOULD broadcast deletion events to other relays which don't have it. 33Relays SHOULD continue to publish/share the deletion request events indefinitely, as clients may already have the event that's intended to be deleted. Additionally, clients SHOULD broadcast deletion request events to other relays which don't have it.
34 34
35When an `a` tag is used, relays SHOULD delete all versions of the replaceable event up to the `created_at` timestamp of the deletion event. 35When an `a` tag is used, relays SHOULD delete all versions of the replaceable event up to the `created_at` timestamp of the deletion request event.
36 36
37## Client Usage 37## Client Usage
38 38
39Clients MAY choose to fully hide any events that are referenced by valid deletion events. This includes text notes, direct messages, or other yet-to-be defined event kinds. Alternatively, they MAY show the event along with an icon or other indication that the author has "disowned" the event. The `content` field MAY also be used to replace the deleted events' own content, although a user interface should clearly indicate that this is a deletion reason, not the original content. 39Clients MAY choose to fully hide any events that are referenced by valid deletion request events. This includes text notes, direct messages, or other yet-to-be defined event kinds. Alternatively, they MAY show the event along with an icon or other indication that the author has "disowned" the event. The `content` field MAY also be used to replace the deleted events' own content, although a user interface should clearly indicate that this is a deletion request reason, not the original content.
40 40
41A client MUST validate that each event `pubkey` referenced in the `e` tag of the deletion request is identical to the deletion request `pubkey`, before hiding or deleting any event. Relays can not, in general, perform this validation and should not be treated as authoritative. 41A client MUST validate that each event `pubkey` referenced in the `e` tag of the deletion request is identical to the deletion request `pubkey`, before hiding or deleting any event. Relays can not, in general, perform this validation and should not be treated as authoritative.
42 42
43Clients display the deletion event itself in any way they choose, e.g., not at all, or with a prominent notice. 43Clients display the deletion request event itself in any way they choose, e.g., not at all, or with a prominent notice.
44
45Clients MAY choose to inform the user that their request for deletion does not guarantee deletion because it is impossible to delete events from all relays and clients.
44 46
45## Relay Usage 47## Relay Usage
46 48
47Relays MAY validate that a deletion event only references events that have the same `pubkey` as the deletion itself, however this is not required since relays may not have knowledge of all referenced events. 49Relays MAY validate that a deletion request event only references events that have the same `pubkey` as the deletion request itself, however this is not required since relays may not have knowledge of all referenced events.
48 50
49## Deleting a Deletion 51## Deletion Request of a Deletion Request
50 52
51Publishing a deletion event against a deletion has no effect. Clients and relays are not obliged to support "undelete" functionality. 53Publishing a deletion request event against a deletion request has no effect. Clients and relays are not obliged to support "unrequest deletion" functionality.
diff --git a/10.md b/10.md
index dfd4cb9..94db4fa 100644
--- a/10.md
+++ b/10.md
@@ -2,8 +2,8 @@ NIP-10
2====== 2======
3 3
4 4
5On "e" and "p" tags in Text Events (kind 1). 5On "e" and "p" tags in Text Events (kind 1)
6-------------------------------------------- 6-------------------------------------------
7 7
8`draft` `optional` 8`draft` `optional`
9 9
@@ -43,7 +43,7 @@ They are citing from this event. `root-id` and `reply-id` are as above.
43Where: 43Where:
44 44
45 * `<event-id>` is the id of the event being referenced. 45 * `<event-id>` is the id of the event being referenced.
46 * `<relay-url>` is the URL of a recommended relay associated with the reference. Clients SHOULD add a valid `<relay-URL>` field, but may instead leave it as `""`. 46 * `<relay-url>` is the URL of a recommended relay associated with the reference. Clients SHOULD add a valid `<relay-url>` field, but may instead leave it as `""`.
47 * `<marker>` is optional and if present is one of `"reply"`, `"root"`, or `"mention"`. 47 * `<marker>` is optional and if present is one of `"reply"`, `"root"`, or `"mention"`.
48 * `<pubkey>` is optional, SHOULD be the pubkey of the author of the referenced event 48 * `<pubkey>` is optional, SHOULD be the pubkey of the author of the referenced event
49 49
diff --git a/11.md b/11.md
index a50038a..0ca5870 100644
--- a/11.md
+++ b/11.md
@@ -2,7 +2,7 @@ NIP-11
2====== 2======
3 3
4Relay Information Document 4Relay Information Document
5--------------------------- 5--------------------------
6 6
7`draft` `optional` 7`draft` `optional`
8 8
@@ -66,7 +66,7 @@ These are limitations imposed by the relay on clients. Your client
66should expect that requests which exceed these *practical* limitations 66should expect that requests which exceed these *practical* limitations
67are rejected or fail immediately. 67are rejected or fail immediately.
68 68
69```json 69```jsonc
70{ 70{
71 "limitation": { 71 "limitation": {
72 "max_message_length": 16384, 72 "max_message_length": 16384,
@@ -83,7 +83,7 @@ are rejected or fail immediately.
83 "created_at_lower_limit": 31536000, 83 "created_at_lower_limit": 31536000,
84 "created_at_upper_limit": 3 84 "created_at_upper_limit": 3
85 }, 85 },
86 ... 86 // other fields...
87} 87}
88``` 88```
89 89
@@ -146,14 +146,15 @@ Retention times are given in seconds, with `null` indicating infinity.
146If zero is provided, this means the event will not be stored at 146If zero is provided, this means the event will not be stored at
147all, and preferably an error will be provided when those are received. 147all, and preferably an error will be provided when those are received.
148 148
149```json 149```jsonc
150{ 150{
151 "retention": [ 151 "retention": [
152 {"kinds": [0, 1, [5, 7], [40, 49]], "time": 3600}, 152 {"kinds": [0, 1, [5, 7], [40, 49]], "time": 3600},
153 {"kinds": [[40000, 49999]], "time": 100}, 153 {"kinds": [[40000, 49999]], "time": 100},
154 {"kinds": [[30000, 39999]], "count": 1000}, 154 {"kinds": [[30000, 39999]], "count": 1000},
155 {"time": 3600, "count": 10000} 155 {"time": 3600, "count": 10000}
156 ] 156 ],
157 // other fields...
157} 158}
158``` 159```
159 160
@@ -172,7 +173,7 @@ There is no need to specify retention times for _ephemeral events_ since they ar
172### Content Limitations 173### Content Limitations
173 174
174Some relays may be governed by the arbitrary laws of a nation state. This 175Some relays may be governed by the arbitrary laws of a nation state. This
175may limit what content can be stored in cleartext on those relays. All 176may limit what content can be stored in clear-text on those relays. All
176clients are encouraged to use encryption to work around this limitation. 177clients are encouraged to use encryption to work around this limitation.
177 178
178It is not possible to describe the limitations of each country's laws 179It is not possible to describe the limitations of each country's laws
@@ -183,13 +184,13 @@ countries' laws might end up being enforced on them, and then
183indirectly on their users' content. 184indirectly on their users' content.
184 185
185Users should be able to avoid relays in countries they don't like, 186Users should be able to avoid relays in countries they don't like,
186and/or select relays in more favourable zones. Exposing this 187and/or select relays in more favorable zones. Exposing this
187flexibility is up to the client software. 188flexibility is up to the client software.
188 189
189```json 190```jsonc
190{ 191{
191 "relay_countries": [ "CA", "US" ], 192 "relay_countries": [ "CA", "US" ],
192 ... 193 // other fields...
193} 194}
194``` 195```
195 196
@@ -208,12 +209,12 @@ local community. This would encourage users to follow the global
208feed on that relay, in addition to their usual individual follows. 209feed on that relay, in addition to their usual individual follows.
209To support this goal, relays MAY specify some of the following values. 210To support this goal, relays MAY specify some of the following values.
210 211
211```json 212```jsonc
212{ 213{
213 "language_tags": ["en", "en-419"], 214 "language_tags": ["en", "en-419"],
214 "tags": ["sfw-only", "bitcoin-only", "anime"], 215 "tags": ["sfw-only", "bitcoin-only", "anime"],
215 "posting_policy": "https://example.com/posting-policy.html", 216 "posting_policy": "https://example.com/posting-policy.html",
216 ... 217 // other fields...
217} 218}
218``` 219```
219 220
@@ -260,10 +261,10 @@ Relays that require payments may want to expose their fee schedules.
260 261
261A URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape. 262A URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape.
262 263
263```json 264```jsonc
264{ 265{
265 "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg", 266 "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg",
266 ... 267 // other fields...
267} 268}
268``` 269```
269 270
@@ -271,9 +272,11 @@ A URL pointing to an image to be used as an icon for the relay. Recommended to b
271 272
272As of 2 May 2023 the following command provided these results: 273As of 2 May 2023 the following command provided these results:
273 274
275```bash
276$ curl -H "Accept: application/nostr+json" https://eden.nostr.land | jq
274``` 277```
275~> curl -H "Accept: application/nostr+json" https://eden.nostr.land | jq
276 278
279```json
277{ 280{
278 "description": "nostr.land family of relays (us-or-01)", 281 "description": "nostr.land family of relays (us-or-01)",
279 "name": "nostr.land", 282 "name": "nostr.land",
@@ -312,3 +315,4 @@ As of 2 May 2023 the following command provided these results:
312 ] 315 ]
313 }, 316 },
314} 317}
318```
diff --git a/13.md b/13.md
index 99289c2..cf5b1ac 100644
--- a/13.md
+++ b/13.md
@@ -48,37 +48,30 @@ Validating
48Here is some reference C code for calculating the difficulty (aka number of leading zero bits) in a nostr event id: 48Here is some reference C code for calculating the difficulty (aka number of leading zero bits) in a nostr event id:
49 49
50```c 50```c
51#include <stdio.h> 51int zero_bits(unsigned char b)
52#include <stdlib.h> 52{
53#include <string.h> 53 int n = 0;
54
55int countLeadingZeroes(const char *hex) {
56 int count = 0;
57
58 for (int i = 0; i < strlen(hex); i++) {
59 int nibble = (int)strtol((char[]){hex[i], '\0'}, NULL, 16);
60 if (nibble == 0) {
61 count += 4;
62 } else {
63 count += __builtin_clz(nibble) - 28;
64 break;
65 }
66 }
67 54
68 return count; 55 if (b == 0)
69} 56 return 8;
70 57
71int main(int argc, char *argv[]) { 58 while (b >>= 1)
72 if (argc != 2) { 59 n++;
73 fprintf(stderr, "Usage: %s <hex_string>\n", argv[0]);
74 return 1;
75 }
76 60
77 const char *hex_string = argv[1]; 61 return 7-n;
78 int result = countLeadingZeroes(hex_string); 62}
79 printf("Leading zeroes in hex string %s: %d\n", hex_string, result);
80 63
81 return 0; 64/* find the number of leading zero bits in a hash */
65int count_leading_zero_bits(unsigned char *hash)
66{
67 int bits, total, i;
68 for (i = 0, total = 0; i < 32; i++) {
69 bits = zero_bits(hash[i]);
70 total += bits;
71 if (bits != 8)
72 break;
73 }
74 return total;
82} 75}
83``` 76```
84 77
@@ -103,16 +96,6 @@ function countLeadingZeroes(hex) {
103} 96}
104``` 97```
105 98
106Querying relays for PoW notes
107-----------------------------
108
109If relays allow searching on prefixes, you can use this as a way to filter notes of a certain difficulty:
110
111```
112$ echo '["REQ", "subid", {"ids": ["000000000"]}]' | websocat wss://some-relay.com | jq -c '.[2]'
113{"id":"000000000121637feeb68a06c8fa7abd25774bdedfa9b6ef648386fb3b70c387", ...}
114```
115
116Delegated Proof of Work 99Delegated Proof of Work
117----------------------- 100-----------------------
118 101
diff --git a/15.md b/15.md
index 55814fb..b55b444 100644
--- a/15.md
+++ b/15.md
@@ -6,7 +6,7 @@ Nostr Marketplace
6 6
7`draft` `optional` 7`draft` `optional`
8 8
9Based on https://github.com/lnbits/Diagon-Alley. 9Based on [Diagon-Alley](https://github.com/lnbits/Diagon-Alley).
10 10
11Implemented in [NostrMarket](https://github.com/lnbits/nostrmarket) and [Plebeian Market](https://github.com/PlebeianTech/plebeian-market). 11Implemented in [NostrMarket](https://github.com/lnbits/nostrmarket) and [Plebeian Market](https://github.com/PlebeianTech/plebeian-market).
12 12
@@ -73,10 +73,10 @@ Fields that are not self-explanatory:
73 73
74**Event Tags** 74**Event Tags**
75 75
76```json 76```jsonc
77{ 77{
78 "tags": [["d", <string, id of stall]], 78 "tags": [["d", <string, id of stall]],
79 ... 79 // other fields...
80} 80}
81``` 81```
82 - the `d` tag is required, its value MUST be the same as the stall `id`. 82 - the `d` tag is required, its value MUST be the same as the stall `id`.
@@ -124,12 +124,12 @@ Fields that are not self-explanatory:
124 124
125**Event Tags** 125**Event Tags**
126 126
127```json 127```jsonc
128 "tags": [ 128 "tags": [
129 ["d", <string, id of product], 129 ["d", <string, id of product],
130 ["t", <string (optional), product category], 130 ["t", <string (optional), product category],
131 ["t", <string (optional), product category], 131 ["t", <string (optional), product category],
132 ... 132 // other fields...
133 ], 133 ],
134 ... 134 ...
135``` 135```
@@ -139,7 +139,7 @@ Fields that are not self-explanatory:
139 139
140## Checkout events 140## Checkout events
141 141
142All checkout events are sent as JSON strings using ([NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md)). 142All checkout events are sent as JSON strings using [NIP-04](04.md).
143 143
144The `merchant` and the `customer` can exchange JSON messages that represent different actions. Each `JSON` message `MUST` have a `type` field indicating the what the JSON represents. Possible types: 144The `merchant` and the `customer` can exchange JSON messages that represent different actions. Each `JSON` message `MUST` have a `type` field indicating the what the JSON represents. Possible types:
145 145
@@ -150,7 +150,7 @@ The `merchant` and the `customer` can exchange JSON messages that represent diff
150| 2 | Merchant | Order Status Update | 150| 2 | Merchant | Order Status Update |
151 151
152### Step 1: `customer` order (event) 152### Step 1: `customer` order (event)
153The below JSON goes in content of [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md). 153The below JSON goes in content of [NIP-04](04.md).
154 154
155```json 155```json
156{ 156{
@@ -158,7 +158,7 @@ The below JSON goes in content of [NIP-04](https://github.com/nostr-protocol/nip
158 "type": 0, 158 "type": 0,
159 "name": <string (optional), ???>, 159 "name": <string (optional), ???>,
160 "address": <string (optional), for physical goods an address should be provided>, 160 "address": <string (optional), for physical goods an address should be provided>,
161 "message": "<string (optional), message for merchant>, 161 "message": <string (optional), message for merchant>,
162 "contact": { 162 "contact": {
163 "nostr": <32-bytes hex of a pubkey>, 163 "nostr": <32-bytes hex of a pubkey>,
164 "phone": <string (optional), if the customer wants to be contacted by phone>, 164 "phone": <string (optional), if the customer wants to be contacted by phone>,
@@ -182,7 +182,7 @@ _Open_: is `contact.nostr` required?
182 182
183Sent back from the merchant for payment. Any payment option is valid that the merchant can check. 183Sent back from the merchant for payment. Any payment option is valid that the merchant can check.
184 184
185The below JSON goes in `content` of [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md). 185The below JSON goes in `content` of [NIP-04](04.md).
186 186
187`payment_options`/`type` include: 187`payment_options`/`type` include:
188 188
@@ -217,7 +217,7 @@ The below JSON goes in `content` of [NIP-04](https://github.com/nostr-protocol/n
217 217
218Once payment has been received and processed. 218Once payment has been received and processed.
219 219
220The below JSON goes in `content` of [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md). 220The below JSON goes in `content` of [NIP-04](04.md).
221 221
222```json 222```json
223{ 223{
@@ -231,13 +231,13 @@ The below JSON goes in `content` of [NIP-04](https://github.com/nostr-protocol/n
231 231
232## Customize Marketplace 232## Customize Marketplace
233 233
234Create a customized user experience using the `naddr` from [NIP-19](https://github.com/nostr-protocol/nips/blob/master/19.md#shareable-identifiers-with-extra-metadata). The use of `naddr` enables easy sharing of marketplace events while incorporating a rich set of metadata. This metadata can include relays, merchant profiles, and more. Subsequently, it allows merchants to be grouped into a market, empowering the market creator to configure the marketplace's user interface and user experience, and share that marketplace. This customization can encompass elements such as market name, description, logo, banner, themes, and even color schemes, offering a tailored and unique marketplace experience. 234Create a customized user experience using the `naddr` from [NIP-19](19.md#shareable-identifiers-with-extra-metadata). The use of `naddr` enables easy sharing of marketplace events while incorporating a rich set of metadata. This metadata can include relays, merchant profiles, and more. Subsequently, it allows merchants to be grouped into a market, empowering the market creator to configure the marketplace's user interface and user experience, and share that marketplace. This customization can encompass elements such as market name, description, logo, banner, themes, and even color schemes, offering a tailored and unique marketplace experience.
235 235
236### Event `30019`: Create or update marketplace UI/UX 236### Event `30019`: Create or update marketplace UI/UX
237 237
238**Event Content** 238**Event Content**
239 239
240```json 240```jsonc
241{ 241{
242 "name": <string (optional), market name>, 242 "name": <string (optional), market name>,
243 "about": <string (optional), market description>, 243 "about": <string (optional), market description>,
@@ -248,7 +248,7 @@ Create a customized user experience using the `naddr` from [NIP-19](https://gith
248 "darkMode": <bool, true/false> 248 "darkMode": <bool, true/false>
249 }, 249 },
250 "merchants": [array of pubkeys (optional)], 250 "merchants": [array of pubkeys (optional)],
251 ... 251 // other fields...
252} 252}
253``` 253```
254 254
@@ -290,17 +290,18 @@ This event leverages naddr to enable comprehensive customization and sharing of
290 290
291### Event `1021`: Bid 291### Event `1021`: Bid
292 292
293```json 293```jsonc
294{ 294{
295 "content": <int, amount of sats>, 295 "content": <int, amount of sats>,
296 "tags": [["e", <event ID of the auction to bid on>]], 296 "tags": [["e", <event ID of the auction to bid on>]],
297 // other fields...
297} 298}
298``` 299```
299 300
300Bids are simply events of kind `1021` with a `content` field specifying the amount, in the currency of the auction. Bids must reference an auction. 301Bids are simply events of kind `1021` with a `content` field specifying the amount, in the currency of the auction. Bids must reference an auction.
301 302
302> [!NOTE] 303> [!NOTE]
303> Auctions can be edited as many times as desired (they are "parameterized replaceable events") by the author - even after the start_date, but they cannot be edited after they have received the first bid! This is enforced by the fact that bids reference the event ID of the auction (rather than the product UUID), which changes with every new version of the auctioned product. So a bid is always attached to one "version". Editing the auction after a bid would result in the new product losing the bid! 304> Auctions can be edited as many times as desired (they are "addressable events") by the author - even after the start_date, but they cannot be edited after they have received the first bid! This is enforced by the fact that bids reference the event ID of the auction (rather than the product UUID), which changes with every new version of the auctioned product. So a bid is always attached to one "version". Editing the auction after a bid would result in the new product losing the bid!
304 305
305### Event `1022`: Bid confirmation 306### Event `1022`: Bid confirmation
306 307
@@ -331,8 +332,8 @@ Another thing that can happen is - if bids happen very close to the end date of
331 332
332## Customer support events 333## Customer support events
333 334
334Customer support is handled over whatever communication method was specified. If communicating via nostr, NIP-04 is used https://github.com/nostr-protocol/nips/blob/master/04.md. 335Customer support is handled over whatever communication method was specified. If communicating via nostr, [NIP-04](04.md) is used.
335 336
336## Additional 337## Additional
337 338
338Standard data models can be found <a href="https://raw.githubusercontent.com/lnbits/nostrmarket/main/models.py">here</a> 339Standard data models can be found [here](https://raw.githubusercontent.com/lnbits/nostrmarket/main/models.py)
diff --git a/17.md b/17.md
index 0f51367..4b96bce 100644
--- a/17.md
+++ b/17.md
@@ -12,18 +12,18 @@ This NIP defines an encrypted direct messaging scheme using [NIP-44](44.md) encr
12 12
13Kind `14` is a chat message. `p` tags identify one or more receivers of the message. 13Kind `14` is a chat message. `p` tags identify one or more receivers of the message.
14 14
15```js 15```jsonc
16{ 16{
17 "id": "<usual hash>", 17 "id": "<usual hash>",
18  "pubkey": "<sender-pubkey>", 18  "pubkey": "<sender-pubkey>",
19 "created_at": now(), 19 "created_at": "<current-time>",
20  "kind": 14, 20  "kind": 14,
21  "tags": [ 21  "tags": [
22    ["p", "<receiver-1-pubkey>", "<relay-url>"], 22    ["p", "<receiver-1-pubkey>", "<relay-url>"],
23    ["p", "<receiver-2-pubkey>", "<relay-url>"], 23    ["p", "<receiver-2-pubkey>", "<relay-url>"],
24    ["e", "<kind-14-id>", "<relay-url>", "reply"] // if this is a reply 24    ["e", "<kind-14-id>", "<relay-url>", "reply"] // if this is a reply
25 ["subject", "<conversation-title>"], 25 ["subject", "<conversation-title>"],
26    ... 26    // rest of tags...
27  ], 27  ],
28  "content": "<message-in-plain-text>", 28  "content": "<message-in-plain-text>",
29} 29}
@@ -86,7 +86,7 @@ Clients CAN offer disappearing messages by setting an `expiration` tag in the gi
86 86
87Kind `10050` indicates the user's preferred relays to receive DMs. The event MUST include a list of `relay` tags with relay URIs. 87Kind `10050` indicates the user's preferred relays to receive DMs. The event MUST include a list of `relay` tags with relay URIs.
88 88
89```js 89```jsonc
90{ 90{
91 "kind": 10050, 91 "kind": 10050,
92 "tags": [ 92 "tags": [
@@ -94,7 +94,7 @@ Kind `10050` indicates the user's preferred relays to receive DMs. The event MUS
94 ["relay", "wss://myrelay.nostr1.com"], 94 ["relay", "wss://myrelay.nostr1.com"],
95 ], 95 ],
96 "content": "", 96 "content": "",
97 //...other fields 97 // other fields...
98} 98}
99``` 99```
100 100
@@ -102,7 +102,7 @@ Clients SHOULD publish kind `14` events to the `10050`-listed relays. If that is
102 102
103## Relays 103## Relays
104 104
105It's advisable that relays do not serve `kind:14` to clients other than the ones tagged in them. 105It's advisable that relays do not serve `kind:1059` to clients other than the ones tagged in them.
106 106
107It's advisable that users choose relays that conform to these practices. 107It's advisable that users choose relays that conform to these practices.
108 108
diff --git a/18.md b/18.md
index 27c5915..41c9442 100644
--- a/18.md
+++ b/18.md
@@ -25,6 +25,14 @@ quote reposted. The `q` tag ensures quote reposts are not pulled and included
25as replies in threads. It also allows you to easily pull and count all of the 25as replies in threads. It also allows you to easily pull and count all of the
26quotes for a post. 26quotes for a post.
27 27
28`q` tags should follow the same conventions as NIP 10 `e` tags, with the exception
29of the `mark` argument.
30
31`["q", <event-id>, <relay-url>, <pubkey>]`
32
33Quote reposts MUST include the [NIP-21](21.md) `nevent`, `note`, or `naddr` of the
34event in the content.
35
28## Generic Reposts 36## Generic Reposts
29 37
30Since `kind 6` reposts are reserved for `kind 1` contents, we use `kind 16` 38Since `kind 6` reposts are reserved for `kind 1` contents, we use `kind 16`
diff --git a/19.md b/19.md
index ef80887..3ea8e11 100644
--- a/19.md
+++ b/19.md
@@ -34,8 +34,8 @@ These are the possible bech32 prefixes with `TLV`:
34 34
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
38 - `naddr`: a nostr _replaceable event_ coordinate 37 - `naddr`: a nostr _replaceable event_ coordinate
38 - `nrelay`: a nostr relay (deprecated)
39 39
40These possible standardized `TLV` types are indicated here: 40These possible standardized `TLV` types are indicated here:
41 41
@@ -43,8 +43,7 @@ These possible standardized `TLV` types are indicated here:
43 - depends on the bech32 prefix: 43 - depends on the bech32 prefix:
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 `naddr`, it is the identifier (the `"d"` tag) of the event being referenced. For normal replaceable events use an empty string.
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` 47- `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 48 - 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 49 - this may be included multiple times
diff --git a/21.md b/21.md
index 6ed141a..988485d 100644
--- a/21.md
+++ b/21.md
@@ -10,7 +10,7 @@ This NIP standardizes the usage of a common URI scheme for maximum interoperabil
10 10
11The scheme is `nostr:`. 11The scheme is `nostr:`.
12 12
13The identifiers that come after are expected to be the same as those defined in [NIP-19](https://github.com/nostr-protocol/nips/blob/master/19.md) (except `nsec`). 13The identifiers that come after are expected to be the same as those defined in [NIP-19](19.md) (except `nsec`).
14 14
15## Examples 15## Examples
16 16
diff --git a/23.md b/23.md
index 382df83..e5e85ff 100644
--- a/23.md
+++ b/23.md
@@ -6,7 +6,7 @@ Long-form Content
6 6
7`draft` `optional` 7`draft` `optional`
8 8
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. 9This NIP defines `kind:30023` (an _addressable 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` 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.
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,7 +31,7 @@ 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 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. 34These articles are meant to be editable, so they should 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
diff --git a/24.md b/24.md
index 3adec24..1afa7c7 100644
--- a/24.md
+++ b/24.md
@@ -39,5 +39,7 @@ tags
39 39
40These tags may be present in multiple event kinds. Whenever a different meaning is not specified by some more specific NIP, they have the following meanings: 40These tags may be present in multiple event kinds. Whenever a different meaning is not specified by some more specific NIP, they have the following meanings:
41 41
42 - `r`: a web URL the event is referring to in some way 42 - `r`: a web URL the event is referring to in some way.
43 - `title`: name of [NIP-51](51.md) sets, [NIP-52](52.md) calendar event, [NIP-53](53.md) live event or [NIP-99](99.md) listing 43 - `i`: an external id the event is referring to in some way - see [NIP-73](73.md).
44 - `title`: name of [NIP-51](51.md) sets, [NIP-52](52.md) calendar event, [NIP-53](53.md) live event or [NIP-99](99.md) listing.
45 - `t`: a hashtag. The value MUST be a lowercase string.
diff --git a/25.md b/25.md
index 17c203e..671c55f 100644
--- a/25.md
+++ b/25.md
@@ -52,6 +52,26 @@ func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> Nost
52} 52}
53``` 53```
54 54
55Reactions to a website
56---------------------
57
58If the target of the reaction is a website, the reaction MUST be a `kind 17` event and MUST include an `r` tag with the website's URL.
59
60```jsonc
61{
62 "kind": 17,
63 "content": "⭐",
64 "tags": [
65 ["r", "https://example.com/"]
66 ],
67 // other fields...
68}
69```
70
71URLs SHOULD be [normalized](https://datatracker.ietf.org/doc/html/rfc3986#section-6), so that reactions to the same website are not omitted from queries.
72A fragment MAY be attached to the URL, to react to a section of the page.
73It should be noted that a URL with a fragment is not considered to be the same URL as the original.
74
55Custom Emoji Reaction 75Custom Emoji Reaction
56--------------------- 76---------------------
57 77
@@ -59,14 +79,14 @@ The client may specify a custom emoji ([NIP-30](30.md)) `:shortcode:` in the
59reaction content. The client should refer to the emoji tag and render the 79reaction content. The client should refer to the emoji tag and render the
60content as an emoji if shortcode is specified. 80content as an emoji if shortcode is specified.
61 81
62```json 82```jsonc
63{ 83{
64 "kind": 7, 84 "kind": 7,
65 "content": ":soapbox:", 85 "content": ":soapbox:",
66 "tags": [ 86 "tags": [
67 ["emoji", "soapbox", "https://gleasonator.com/emoji/Gleasonator/soapbox.png"] 87 ["emoji", "soapbox", "https://gleasonator.com/emoji/Gleasonator/soapbox.png"]
68 ], 88 ],
69 ...other fields 89 // other fields...
70} 90}
71``` 91```
72 92
diff --git a/26.md b/26.md
index 86c46e1..445dd54 100644
--- a/26.md
+++ b/26.md
@@ -2,7 +2,7 @@ NIP-26
2======= 2=======
3 3
4Delegated Event Signing 4Delegated Event Signing
5----- 5-----------------------
6 6
7`draft` `optional` 7`draft` `optional`
8 8
diff --git a/27.md b/27.md
index efd2c12..133f8ef 100644
--- a/27.md
+++ b/27.md
@@ -20,7 +20,7 @@ A reader client that receives an event with such `nostr:...` mentions in its `.c
20 20
21Suppose Bob is writing a note in a client that has search-and-autocomplete functionality for users that is triggered when they write the character `@`. 21Suppose Bob is writing a note in a client that has search-and-autocomplete functionality for users that is triggered when they write the character `@`.
22 22
23As Bob types `"hello @mat"` the client will prompt him to autocomplete with [mattn's profile](https://gateway.nostr.com/p/2c7cc62a697ea3a7826521f3fd34f0cb273693cbe5e9310f35449f43622a5cdc), showing a picture and name. 23As Bob types `"hello @mat"` the client will prompt him to autocomplete with [mattn's profile](https://njump.me/npub1937vv2nf06360qn9y8el6d8sevnndy7tuh5nzre4gj05xc32tnwqauhaj6), showing a picture and name.
24 24
25Bob presses "enter" and now he sees his typed note as `"hello @mattn"`, `@mattn` is highlighted, indicating that it is a mention. Internally, however, the event looks like this: 25Bob presses "enter" and now he sees his typed note as `"hello @mattn"`, `@mattn` is highlighted, indicating that it is a mention. Internally, however, the event looks like this:
26 26
diff --git a/28.md b/28.md
index 1632088..73c76b2 100644
--- a/28.md
+++ b/28.md
@@ -25,10 +25,10 @@ Create a public chat channel.
25 25
26In the channel creation `content` field, Client SHOULD include basic channel metadata (`name`, `about`, `picture` and `relays` as specified in kind 41). 26In the channel creation `content` field, Client SHOULD include basic channel metadata (`name`, `about`, `picture` and `relays` as specified in kind 41).
27 27
28```json 28```jsonc
29{ 29{
30 "content": "{\"name\": \"Demo Channel\", \"about\": \"A test channel.\", \"picture\": \"https://placekitten.com/200/200\", \"relays\": [\"wss://nos.lol\", \"wss://nostr.mom\"]}", 30 "content": "{\"name\": \"Demo Channel\", \"about\": \"A test channel.\", \"picture\": \"https://placekitten.com/200/200\", \"relays\": [\"wss://nos.lol\", \"wss://nostr.mom\"]}",
31 ... 31 // other fields...
32} 32}
33``` 33```
34 34
@@ -52,11 +52,11 @@ Clients MAY add additional metadata fields.
52 52
53Clients SHOULD use [NIP-10](10.md) marked "e" tags to recommend a relay. 53Clients SHOULD use [NIP-10](10.md) marked "e" tags to recommend a relay.
54 54
55```json 55```jsonc
56{ 56{
57 "content": "{\"name\": \"Updated Demo Channel\", \"about\": \"Updating a test channel.\", \"picture\": \"https://placekitten.com/201/201\", \"relays\": [\"wss://nos.lol\", \"wss://nostr.mom\"]}", 57 "content": "{\"name\": \"Updated Demo Channel\", \"about\": \"Updating a test channel.\", \"picture\": \"https://placekitten.com/201/201\", \"relays\": [\"wss://nos.lol\", \"wss://nostr.mom\"]}",
58 "tags": [["e", <channel_create_event_id>, <relay-url>]], 58 "tags": [["e", <channel_create_event_id>, <relay-url>]],
59 ... 59 // other fields...
60} 60}
61``` 61```
62 62
@@ -71,26 +71,26 @@ Clients SHOULD append [NIP-10](10.md) "p" tags to replies.
71 71
72Root message: 72Root message:
73 73
74```json 74```jsonc
75{ 75{
76 "content": <string>, 76 "content": <string>,
77 "tags": [["e", <kind_40_event_id>, <relay-url>, "root"]], 77 "tags": [["e", <kind_40_event_id>, <relay-url>, "root"]],
78 ... 78 // other fields...
79} 79}
80``` 80```
81 81
82Reply to another message: 82Reply to another message:
83 83
84```json 84```jsonc
85{ 85{
86 "content": <string>, 86 "content": <string>,
87 "tags": [ 87 "tags": [
88 ["e", <kind_40_event_id>, <relay-url>, "root"], 88 ["e", <kind_40_event_id>, <relay-url>, "root"],
89 ["e", <kind_42_event_id>, <relay-url>, "reply"], 89 ["e", <kind_42_event_id>, <relay-url>, "reply"],
90 ["p", <pubkey>, <relay-url>], 90 ["p", <pubkey>, <relay-url>],
91 ... 91 // rest of tags...
92 ], 92 ],
93 ... 93 // other fields...
94} 94}
95``` 95```
96 96
@@ -107,11 +107,11 @@ Clients MAY hide event 42s for other users other than the user who sent the even
107 107
108(For example, if three users 'hide' an event giving a reason that includes the word 'pornography', a Nostr client that is an iOS app may choose to hide that message for all iOS clients.) 108(For example, if three users 'hide' an event giving a reason that includes the word 'pornography', a Nostr client that is an iOS app may choose to hide that message for all iOS clients.)
109 109
110```json 110```jsonc
111{ 111{
112 "content": "{\"reason\": \"Dick pic\"}", 112 "content": "{\"reason\": \"Dick pic\"}",
113 "tags": [["e", <kind_42_event_id>]], 113 "tags": [["e", <kind_42_event_id>]],
114 ... 114 // other fields...
115} 115}
116``` 116```
117 117
@@ -125,11 +125,11 @@ Clients SHOULD hide event 42s shown to a given user, if there is an event 44 fro
125 125
126Clients MAY hide event 42s for users other than the user who sent the event 44. 126Clients MAY hide event 42s for users other than the user who sent the event 44.
127 127
128```json 128```jsonc
129{ 129{
130 "content": "{\"reason\": \"Posting dick pics\"}", 130 "content": "{\"reason\": \"Posting dick pics\"}",
131 "tags": [["p", <pubkey>]], 131 "tags": [["p", <pubkey>]],
132 ... 132 // other fields...
133} 133}
134``` 134```
135 135
diff --git a/29.md b/29.md
index 0f4a579..80e0f96 100644
--- a/29.md
+++ b/29.md
@@ -16,12 +16,18 @@ Normally a group will originally belong to one specific relay, but the community
16 16
17## Relay-generated events 17## Relay-generated events
18 18
19Relays are supposed to generate the events that describe group metadata and group admins. These are parameterized replaceable events signed by the relay keypair directly, with the group _id_ as the `d` tag. 19Relays are supposed to generate the events that describe group metadata and group admins. These are _addressable_ events signed by the relay keypair directly, with the group _id_ as the `d` tag.
20 20
21## Group identifier 21## Group identifier
22 22
23A group may be identified by a string in the format `<host>'<group-id>`. For example, a group with _id_ `abcdef` hosted at the relay `wss://groups.nostr.com` would be identified by the string `groups.nostr.com'abcdef`. 23A group may be identified by a string in the format `<host>'<group-id>`. For example, a group with _id_ `abcdef` hosted at the relay `wss://groups.nostr.com` would be identified by the string `groups.nostr.com'abcdef`.
24 24
25Group identifiers must be strings restricted to the characters `a-z0-9-_`.
26
27When encountering just the `<host>` without the `'<group-id>`, clients can choose to connect to the group with id `_`, which is a special top-level group dedicated to relay-local discussions.
28
29Group identifiers in most cases should be random or pseudo-random, as that mitigates message replay confusiong and ensures they can be migrated or forked to other relays easily without risking conflicting with other groups using the same id in these new relays. This isn't a hard rule, as, for example, in `unmanaged` and/or ephemeral relays groups might not want to migrate ever, so they might not care about this. Notably, the `_` relay-local group isn't expected to be migrated ever.
30
25## The `h` tag 31## The `h` tag
26 32
27Events sent by users to groups (chat messages, text notes, moderation events etc) must have an `h` tag with the value set to the group _id_. 33Events sent by users to groups (chat messages, text notes, moderation events etc) must have an `h` tag with the value set to the group _id_.
@@ -36,20 +42,42 @@ This is a hack to prevent messages from being broadcasted to external relays tha
36 42
37Relays should prevent late publication (messages published now with a timestamp from days or even hours ago) unless they are open to receive a group forked or moved from another relay. 43Relays should prevent late publication (messages published now with a timestamp from days or even hours ago) unless they are open to receive a group forked or moved from another relay.
38 44
45## Group management
46
47Groups can have any number of users with elevated access. These users are identified by role labels which are arbitrarily defined by the relays (see also the description of `kind:39003`). What each role is capable of not defined in this NIP either, it's a relay policy that can vary. Roles can be assigned by other users (as long as they have the capability to add roles) by publishing a `kind:9000` event with that user's pubkey in a `p` tag and the roles afterwards (even if the user is already a group member a `kind:9000` can be issued and the user roles must just be updated).
48
49The roles supported by the group as to having some special privilege assigned to them should be accessible on the event `kind:39003`, but the relay may also accept other role names, arbitrarily defined by clients, and just not do anything with them.
50
51Users with any roles that have any privilege can be considered _admins_ in a broad sense and be returned in the `kind:39001` event for a group.
52
53## Unmanaged groups
54
55Unmanaged groups are impromptu groups that can be used in any public relay unaware of NIP-29 specifics. They piggyback on relays' natural white/blacklists (or lack of) but aside from that are not actively managed and won't have any admins, group state or metadata events.
56
57In `unmanaged` groups, everybody is considered to be a member.
58
59Unmanaged groups can transition to managed groups, in that case the relay master key just has to publish moderation events setting the state of all groups and start enforcing the rules they choose to.
60
39## Event definitions 61## Event definitions
40 62
63These are the events expected to be found in NIP-29 groups.
64
65### Normal user-created events
66
67These events generally can be sent by all members of a group and they require the `h` tag to be present so they're attached to a specific group.
68
41- *text root note* (`kind:11`) 69- *text root note* (`kind:11`)
42 70
43This is the basic unit of a "microblog" root text note sent to a group. 71This is the basic unit of a "microblog" root text note sent to a group.
44 72
45```js 73```jsonc
46 "kind": 11, 74 "kind": 11,
47 "content": "hello my friends lovers of pizza", 75 "content": "hello my friends lovers of pizza",
48 "tags": [ 76 "tags": [
49 ["h", "<group-id>"], 77 ["h", "<group-id>"],
50 ["previous", "<event-id-first-chars>", "<event-id-first-chars>", ...] 78 ["previous", "<event-id-first-chars>", "<event-id-first-chars>", /*...*/]
51 ] 79 ]
52 ... 80 // other fields...
53``` 81```
54 82
55- *threaded text reply* (`kind:12`) 83- *threaded text reply* (`kind:12`)
@@ -63,14 +91,14 @@ This is the basic unit of a "microblog" reply note sent to a group. It's the sam
63 91
64This is the basic unit of a _chat message_ sent to a group. 92This is the basic unit of a _chat message_ sent to a group.
65 93
66```js 94```jsonc
67 "kind": 9, 95 "kind": 9,
68 "content": "hello my friends lovers of pizza", 96 "content": "hello my friends lovers of pizza",
69 "tags": [ 97 "tags": [
70 ["h", "<group-id>"], 98 ["h", "<group-id>"],
71 ["previous", "<event-id-first-chars>", "<event-id-first-chars>", ...] 99 ["previous", "<event-id-first-chars>", "<event-id-first-chars>", /*...*/]
72 ] 100 ]
73 ... 101 // other fields...
74``` 102```
75 103
76- *chat message threaded reply* (`kind:10`) 104- *chat message threaded reply* (`kind:10`)
@@ -79,46 +107,80 @@ Similar to `kind:12`, this is the basic unit of a chat message sent to a group.
79 107
80`kind:10` SHOULD use NIP-10 markers, just like `kind:12`. 108`kind:10` SHOULD use NIP-10 markers, just like `kind:12`.
81 109
110- other events:
111
112Groups may also accept other events, like long-form articles, calendar, livestream, market announcements and so on. These should be as defined in their respective NIPs, with the addition of the `h` tag.
113
114### User-related group management events
115
116These are events that can be sent by users to manage their situation in a group, they also require the `h` tag.
117
82- *join request* (`kind:9021`) 118- *join request* (`kind:9021`)
83 119
84Any user can send one of these events to the relay in order to be automatically or manually added to the group. If the group is `open` the relay will automatically issue a `kind:9000` in response adding this user. Otherwise group admins may choose to query for these requests and act upon them. 120Any user can send one of these events to the relay in order to be automatically or manually added to the group. If the group is `open` the relay will automatically issue a `kind:9000` in response adding this user. Otherwise group admins may choose to query for these requests and act upon them.
85 121
86```js 122```json
87{ 123{
88 "kind": 9021, 124 "kind": 9021,
89 "content": "optional reason", 125 "content": "optional reason",
90 "tags": [ 126 "tags": [
127 ["h", "<group-id>"],
128 ["code", "<optional-invite-code>"]
129 ]
130}
131```
132
133The optional `code` tag may be used by the relay to preauthorize acceptances in `closed` groups, together with the `kind:9009` `create-invite` moderation event.
134
135- *leave request* (`kind:9022`)
136
137Any user can send one of these events to the relay in order to be automatically removed from the group. The relay will automatically issue a `kind:9001` in response removing this user.
138
139```json
140{
141 "kind": 9022,
142 "content": "optional reason",
143 "tags": [
91 ["h", "<group-id>"] 144 ["h", "<group-id>"]
92 ] 145 ]
93} 146}
94``` 147```
95 148
149### Group state -- or moderation
150
151These are events expected to be sent by the relay master key or by group admins -- and relays should reject them if they don't come from an authorized admin. They also require the `h` tag.
152
96- *moderation events* (`kinds:9000-9020`) (optional) 153- *moderation events* (`kinds:9000-9020`) (optional)
97 154
98Clients can send these events to a relay in order to accomplish a moderation action. Relays must check if the pubkey sending the event is capable of performing the given action. The relay may discard the event after taking action or keep it as a moderation log. 155Clients can send these events to a relay in order to accomplish a moderation action. Relays must check if the pubkey sending the event is capable of performing the given action based on its role and the relay's internal policy (see also the description of `kind:39003`).
99 156
100```js 157```json
101{ 158{
102 "kind": 90xx, 159 "kind": 90xx,
103 "content": "optional reason", 160 "content": "optional reason",
104 "tags": [ 161 "tags": [
105 ["h", "<group-id>"], 162 ["h", "<group-id>"],
106 ["previous", ...] 163 ["previous", /*...*/]
107 ] 164 ]
108} 165}
109``` 166```
110 167
111Each moderation action uses a different kind and requires different arguments, which are given as tags. These are defined in the following table: 168Each moderation action uses a different kind and requires different arguments, which are given as tags. These are defined in the following table:
112 169
113| kind | name | tags | 170| kind | name | tags |
114| --- | --- | --- | 171| --- | --- | --- |
115| 9000 | `add-user` | `p` (pubkey hex) | 172| 9000 | `add-user` | `p` with pubkey hex and optional roles |
116| 9001 | `remove-user` | `p` (pubkey hex) | 173| 9001 | `remove-user` | `p` with pubkey hex |
117| 9002 | `edit-metadata` | `name`, `about`, `picture` (string) | 174| 9002 | `edit-metadata` | fields from `kind:39000` to be modified |
118| 9003 | `add-permission` | `p` (pubkey), `permission` (name) | 175| 9005 | `delete-event` | |
119| 9004 | `remove-permission` | `p` (pubkey), `permission` (name) | 176| 9007 | `create-group` | |
120| 9005 | `delete-event` | `e` (id hex) | 177| 9008 | `delete-group` | |
121| 9006 | `edit-group-status` | `public` or `private`, `open` or `closed` | 178
179It's expected that the group state (of who is an allowed member or not, who is an admin and with which permission or not, what are the group name and picture etc) can be fully reconstructed from the canonical sequence of these events.
180
181### Group metadata events
182
183These events contain the group id in a `d` tag instead of the `h` tag. They MUST be created by the relay master key only and a single instance of each (or none) should exist at all times for each group. They are merely informative but should reflect the latest group state (as it was changed by moderation events over time).
122 184
123- *group metadata* (`kind:39000`) (optional) 185- *group metadata* (`kind:39000`) (optional)
124 186
@@ -126,7 +188,9 @@ This event defines the metadata for the group -- basically how clients should di
126 188
127If the group is forked and hosted in multiple relays, there will be multiple versions of this event in each different relay and so on. 189If the group is forked and hosted in multiple relays, there will be multiple versions of this event in each different relay and so on.
128 190
129```js 191When this event is not found, clients may still connect to the group, but treat it as having a different status, `unmanaged`,
192
193```jsonc
130{ 194{
131 "kind": 39000, 195 "kind": 39000,
132 "content": "", 196 "content": "",
@@ -138,7 +202,7 @@ If the group is forked and hosted in multiple relays, there will be multiple ver
138 ["public"], // or ["private"] 202 ["public"], // or ["private"]
139 ["open"] // or ["closed"] 203 ["open"] // or ["closed"]
140 ] 204 ]
141 ... 205 // other fields...
142} 206}
143``` 207```
144 208
@@ -146,40 +210,29 @@ If the group is forked and hosted in multiple relays, there will be multiple ver
146 210
147- *group admins* (`kind:39001`) (optional) 211- *group admins* (`kind:39001`) (optional)
148 212
149Similar to the group metadata, this event is supposed to be generated by relays that host the group. 213Each admin is listed along with one or more roles. These roles SHOULD have a correspondence with the roles supported by the relay, as advertised by the `kind:39003` event.
150
151Each admin gets a label that is only used for display purposes, and a list of permissions it has are listed afterwards. These permissions can inform client building UI, but ultimately are evaluated by the relay in order to become effective.
152 214
153The list of capabilities, as defined by this NIP, for now, is the following: 215```jsonc
154
155- `add-user`
156- `edit-metadata`
157- `delete-event`
158- `remove-user`
159- `add-permission`
160- `remove-permission`
161- `edit-group-status`
162
163```js
164{ 216{
165 "kind": 39001, 217 "kind": 39001,
166 "content": "list of admins for the pizza lovers group", 218 "content": "list of admins for the pizza lovers group",
167 "tags": [ 219 "tags": [
168 ["d", "<group-id>"], 220 ["d", "<group-id>"],
169 ["p", "<pubkey1-as-hex>", "ceo", "add-user", "edit-metadata", "delete-event", "remove-user"], 221 ["p", "<pubkey1-as-hex>", "ceo"],
170 ["p", "<pubkey2-as-hex>", "secretary", "add-user", "delete-event"] 222 ["p", "<pubkey2-as-hex>", "secretary", "gardener"],
171 ] 223 // other pubkeys...
172 ... 224 ],
225 // other fields...
173} 226}
174``` 227```
175 228
176- *group members* (`kind:39002`) (optional) 229- *group members* (`kind:39002`) (optional)
177 230
178Similar to *group admins*, this event is supposed to be generated by relays that host the group. 231It's a list of pubkeys that are members of the group. Relays might choose to not to publish this information, to restrict what pubkeys can fetch it or to only display a subset of the members in it.
179 232
180It's a NIP-51-like list of pubkeys that are members of the group. Relays might choose to not to publish this information or to restrict what pubkeys can fetch it. 233Clients should not assume this will always be present or that it will contain a full list of members.
181 234
182```json 235```jsonc
183{ 236{
184 "kind": 39002, 237 "kind": 39002,
185 "content": "list of members for the pizza lovers group", 238 "content": "list of members for the pizza lovers group",
@@ -188,10 +241,48 @@ It's a NIP-51-like list of pubkeys that are members of the group. Relays might c
188 ["p", "<admin1>"], 241 ["p", "<admin1>"],
189 ["p", "<member-pubkey1>"], 242 ["p", "<member-pubkey1>"],
190 ["p", "<member-pubkey2>"], 243 ["p", "<member-pubkey2>"],
191 ] 244 // other pubkeys...
245 ],
246 // other fields...
247}
248```
249
250- *group roles* (`kind:39003`) (optional)
251
252This is an event that MAY be published by the relay informing users and clients about what are the roles supported by this relay according to its internal logic.
253
254For example, a relay may choose to support the roles `"admin"` and `"moderator"`, in which the `"admin"` will be allowed to edit the group metadata, delete messages and remove users from the group, while the `"moderator"` can only delete messages (or the relay may choose to call these roles `"ceo"` and `"secretary"` instead, the exact role name is not relevant).
255
256The process through which the relay decides what roles to support and how to handle moderation events internally based on them is specific to each relay and not specified here.
257
258```jsonc
259{
260 "kind": 39003,
261 "content": "list of roles supported by this group",
262 "tags": [
263 ["d", "<group-id>"],
264 ["role", "<role-name>", "<optional-description>"],
265 ["role", "<role-name>", "<optional-description>"],
266 // other roles...
267 ],
268 // other fields...
192} 269}
193``` 270```
194 271
195## Storing the list of groups a user belongs to 272## Implementation quirks
273
274### Checking your own membership in a group
275
276The latest of either `kind:9000` or `kind:9001` events present in a group should tell a user that they are currently members of the group or if they were removed. In case none of these exist the user is assumed to not be a member of the group -- unless the group is `unmanaged`, in which case the user is assumed to be a member.
277
278### Adding yourself to a group
279
280When a group is `open`, anyone can send a `kind:9021` event to it in order to be added, then expect a `kind:9000` event to be emitted confirming that the user was added. The same happens with `closed` groups, except in that case a user may only send a `kind:9021` if it has an invite code.
281
282### Storing your list of groups
283
284A definition for `kind:10009` was included in [NIP-51](51.md) that allows clients to store the list of groups a user wants to remember being in.
285
286### Using `unmanaged` relays
196 287
197A definition for kind `10009` was included in [NIP-51](51.md) that allows clients to store the list of groups a user wants to remember being in. 288To prevent event leakage, replay and confusion, when using `unmanaged` relays, clients should include the [NIP-70](70.md) `-` tag, as just the `previous` tag won't be checked by other `unmanaged` relays.
diff --git a/30.md b/30.md
index c2f8bb0..54a8b37 100644
--- a/30.md
+++ b/30.md
@@ -54,3 +54,19 @@ In kind 1 events, the `content` should be emojified.
54 "created_at": 1682630000 54 "created_at": 1682630000
55} 55}
56``` 56```
57
58### Kind 7 events
59
60In kind 7 events, the `content` should be emojified.
61
62```json
63{
64 "kind": 7,
65 "content": ":dezh:",
66 "tags": [
67 ["emoji", "dezh", "https://raw.githubusercontent.com/dezh-tech/brand-assets/main/dezh/logo/black-normal.svg"]
68 ],
69 "pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6",
70 "created_at": 1682630000
71}
72```
diff --git a/32.md b/32.md
index 79f5937..a99e52a 100644
--- a/32.md
+++ b/32.md
@@ -2,14 +2,13 @@ NIP-32
2====== 2======
3 3
4Labeling 4Labeling
5--------- 5--------
6 6
7`draft` `optional` 7`draft` `optional`
8 8
9A label is a `kind 1985` event that is used to label other entities. This supports a number of use cases, 9This NIP defines two new indexable tags to label events and a new event kind (`kind:1985`) to attach those labels to existing events. This supports several use cases, including distributed moderation, collection management, license assignment, and content classification.
10including distributed moderation, collection management, license assignment, and content classification.
11 10
12This NIP introduces two new tags: 11New Tags:
13 12
14- `L` denotes a label namespace 13- `L` denotes a label namespace
15- `l` denotes a label 14- `l` denotes a label
@@ -58,7 +57,7 @@ Example events
58 57
59A suggestion that multiple pubkeys be associated with the `permies` topic. 58A suggestion that multiple pubkeys be associated with the `permies` topic.
60 59
61```json 60```jsonc
62{ 61{
63 "kind": 1985, 62 "kind": 1985,
64 "tags": [ 63 "tags": [
@@ -67,13 +66,13 @@ A suggestion that multiple pubkeys be associated with the `permies` topic.
67 ["p", <pubkey1>, <relay_url>], 66 ["p", <pubkey1>, <relay_url>],
68 ["p", <pubkey2>, <relay_url>] 67 ["p", <pubkey2>, <relay_url>]
69 ], 68 ],
70 ... 69 // other fields...
71} 70}
72``` 71```
73 72
74A report flagging violence toward a human being as defined by ontology.example.com. 73A report flagging violence toward a human being as defined by ontology.example.com.
75 74
76```json 75```jsonc
77{ 76{
78 "kind": 1985, 77 "kind": 1985,
79 "tags": [ 78 "tags": [
@@ -82,13 +81,13 @@ A report flagging violence toward a human being as defined by ontology.example.c
82 ["p", <pubkey1>, <relay_url>], 81 ["p", <pubkey1>, <relay_url>],
83 ["p", <pubkey2>, <relay_url>] 82 ["p", <pubkey2>, <relay_url>]
84 ], 83 ],
85 ... 84 // other fields...
86} 85}
87``` 86```
88 87
89A moderation suggestion for a chat event. 88A moderation suggestion for a chat event.
90 89
91```json 90```jsonc
92{ 91{
93 "kind": 1985, 92 "kind": 1985,
94 "tags": [ 93 "tags": [
@@ -96,13 +95,13 @@ A moderation suggestion for a chat event.
96 ["l", "approve", "nip28.moderation"], 95 ["l", "approve", "nip28.moderation"],
97 ["e", <kind40_event_id>, <relay_url>] 96 ["e", <kind40_event_id>, <relay_url>]
98 ], 97 ],
99 ... 98 // other fields...
100} 99}
101``` 100```
102 101
103Assignment of a license to an event. 102Assignment of a license to an event.
104 103
105```json 104```jsonc
106{ 105{
107 "kind": 1985, 106 "kind": 1985,
108 "tags": [ 107 "tags": [
@@ -110,14 +109,14 @@ Assignment of a license to an event.
110 ["l", "MIT", "license"], 109 ["l", "MIT", "license"],
111 ["e", <event_id>, <relay_url>] 110 ["e", <event_id>, <relay_url>]
112 ], 111 ],
113 ... 112 // other fields...
114} 113}
115``` 114```
116 115
117Publishers can self-label by adding `l` tags to their own non-1985 events. In this case, the kind 1 event's author 116Publishers can self-label by adding `l` tags to their own non-1985 events. In this case, the kind 1 event's author
118is labeling their note as being related to Milan, Italy using ISO 3166-2. 117is labeling their note as being related to Milan, Italy using ISO 3166-2.
119 118
120```json 119```jsonc
121{ 120{
122 "kind": 1, 121 "kind": 1,
123 "tags": [ 122 "tags": [
@@ -125,15 +124,29 @@ is labeling their note as being related to Milan, Italy using ISO 3166-2.
125 ["l", "IT-MI", "ISO-3166-2"] 124 ["l", "IT-MI", "ISO-3166-2"]
126 ], 125 ],
127 "content": "It's beautiful here in Milan!", 126 "content": "It's beautiful here in Milan!",
128 ... 127 // other fields...
128}
129```
130
131Author is labeling their note language as English using ISO-639-1.
132
133```jsonc
134{
135 "kind": 1,
136 "tags": [
137 ["L", "ISO-639-1"],
138 ["l", "en", "ISO-639-1"]
139 ],
140 "content": "English text",
141 // other fields...
129} 142}
130``` 143```
131 144
132Other Notes 145Other Notes
133----------- 146-----------
134 147
135When using this NIP to bulk-label many targets at once, events may be deleted and a replacement 148When using this NIP to bulk-label many targets at once, events may be requested for deletion using [NIP-09](09.md) and a replacement
136may be published. We have opted not to use parameterizable/replaceable events for this due to the 149may be published. We have opted not to use addressable/replaceable events for this due to the
137complexity in coming up with a standard `d` tag. In order to avoid ambiguity when querying, 150complexity in coming up with a standard `d` tag. In order to avoid ambiguity when querying,
138publishers SHOULD limit labeling events to a single namespace. 151publishers SHOULD limit labeling events to a single namespace.
139 152
@@ -156,7 +169,7 @@ be handled in some other way.
156 169
157 170
158Appendix: Known Ontologies 171Appendix: Known Ontologies
159------------------------- 172--------------------------
160 173
161Below is a non-exhaustive list of ontologies currently in widespread use. 174Below is a non-exhaustive list of ontologies currently in widespread use.
162 175
diff --git a/33.md b/33.md
index 337a1f9..9c00d42 100644
--- a/33.md
+++ b/33.md
@@ -6,4 +6,4 @@ Parameterized Replaceable Events
6 6
7`final` `mandatory` 7`final` `mandatory`
8 8
9Moved to [NIP-01](01.md). 9Renamed to "Addressable events" and moved to [NIP-01](01.md).
diff --git a/34.md b/34.md
index fcc2cec..35bc1be 100644
--- a/34.md
+++ b/34.md
@@ -35,6 +35,36 @@ The `r` tag annotated with the `"euc"` marker should be the commit ID of the ear
35 35
36Except `d`, all tags are optional. 36Except `d`, all tags are optional.
37 37
38## Repository state announcements
39
40An optional source of truth for the state of branches and tags in a repository.
41
42```jsonc
43{
44 "kind": 30618,
45 "content": "",
46 "tags": [
47 ["d", "<repo-id>"], // matches the identifier in the coresponding repository announcement
48 ["refs/<heads|tags>/<branch-or-tag-name>","<commit-id>"]
49 ["HEAD", "ref: refs/heads/<branch-name>"]
50 ]
51}
52```
53
54The `refs` tag may appear multiple times, or none.
55
56If no `refs` tags are present, the author is no longer tracking repository state using this event. This approach enables the author to restart tracking state at a later time unlike [NIP-09](09.md) deletion requests.
57
58The `refs` tag can be optionally extended to enable clients to identify how many commits ahead a ref is:
59
60```jsonc
61{
62 "tags": [
63 ["refs/<heads|tags>/<branch-or-tag-name>", "<commit-id>", "<shorthand-parent-commit-id>", "<shorthand-grandparent>", ...],
64 ]
65}
66```
67
38## Patches 68## Patches
39 69
40Patches can be sent by anyone to any repository. Patches to a specific repository SHOULD be sent to the relays specified in that repository's announcement event's `"relays"` tag. Patch events SHOULD include an `a` tag pointing to that repository's announcement address. 70Patches can be sent by anyone to any repository. Patches to a specific repository SHOULD be sent to the relays specified in that repository's announcement event's `"relays"` tag. Patch events SHOULD include an `a` tag pointing to that repository's announcement address.
@@ -53,7 +83,7 @@ The first patch revision in a patch revision SHOULD include a NIP-10 `e` `reply`
53 ["p", "<repository-owner>"], 83 ["p", "<repository-owner>"],
54 ["p", "<other-user>"], // optionally send the patch to another user to bring it to their attention 84 ["p", "<other-user>"], // optionally send the patch to another user to bring it to their attention
55 85
56 ["t", "root"], // ommited for additional patches in a series 86 ["t", "root"], // omitted for additional patches in a series
57 // for the first patch in a revision 87 // for the first patch in a revision
58 ["t", "root-revision"], 88 ["t", "root-revision"],
59 89
@@ -74,15 +104,20 @@ The first patch in a series MAY be a cover letter in the format produced by `git
74 104
75## Issues 105## Issues
76 106
77Issues are Markdown text that is just human-readable conversational threads related to the repository: bug reports, feature requests, questions or comments of any kind. Like patches, these SHOULD be sent to the relays specified in that repository's announcement event's `"relays"` tag. 107Issues are Markdown text that is just human-readable conversational threads related to the repository: bug reports, feature requests, questions or comments of any kind. Like patches, these SHOULD be sent to the relays specified in that repository's announcement event's `"relays"` tag.
78 108
79```jsonc 109Issues may have a `subject` tag, which clients can utilize to display a header. Additionally, one or more `t` tags may be included to provide labels for the issue.
110
111```json
80{ 112{
81 "kind": 1621, 113 "kind": 1621,
82 "content": "<markdown text>", 114 "content": "<markdown text>",
83 "tags": [ 115 "tags": [
84 ["a", "30617:<base-repo-owner-pubkey>:<base-repo-id>"], 116 ["a", "30617:<base-repo-owner-pubkey>:<base-repo-id>"],
85 ["p", "<repository-owner>"] 117 ["p", "<repository-owner>"]
118 ["subject", "<issue-subject>"]
119 ["t", "<issue-label>"]
120 ["t", "<another-issue-label>"]
86 ] 121 ]
87} 122}
88``` 123```
@@ -102,8 +137,9 @@ Replies are also Markdown text. The difference is that they MUST be issued as re
102 // other "e" and "p" tags should be applied here when necessary, following the threading rules of NIP-10 137 // other "e" and "p" tags should be applied here when necessary, following the threading rules of NIP-10
103 ["p", "<patch-author-pubkey-hex>", "", "mention"], 138 ["p", "<patch-author-pubkey-hex>", "", "mention"],
104 ["e", "<previous-reply-id-hex>", "", "reply"], 139 ["e", "<previous-reply-id-hex>", "", "reply"],
105 // ... 140 // rest of tags...
106 ] 141 ],
142 // other fields...
107} 143}
108``` 144```
109 145
diff --git a/35.md b/35.md
index 04cfb46..3891f6f 100644
--- a/35.md
+++ b/35.md
@@ -2,7 +2,7 @@ NIP-35
2====== 2======
3 3
4Torrents 4Torrents
5----------- 5--------
6 6
7`draft` `optional` 7`draft` `optional`
8 8
@@ -37,7 +37,7 @@ A second level prefix should be included where the database supports multiple me
37 37
38In some cases the url mapping isnt direct, mapping the url in general is out of scope for this NIP, the section above is only a guide so that implementers have enough information to succsesfully map the url if they wish. 38In some cases the url mapping isnt direct, mapping the url in general is out of scope for this NIP, the section above is only a guide so that implementers have enough information to succsesfully map the url if they wish.
39 39
40```jsonc 40```json
41{ 41{
42 "kind": 2003, 42 "kind": 2003,
43 "content": "<long-description-pre-formatted>", 43 "content": "<long-description-pre-formatted>",
diff --git a/38.md b/38.md
index 4f2c06d..ece5e5f 100644
--- a/38.md
+++ b/38.md
@@ -3,7 +3,7 @@ NIP-38
3====== 3======
4 4
5User Statuses 5User Statuses
6-------------- 6-------------
7 7
8`draft` `optional` 8`draft` `optional`
9 9
@@ -13,11 +13,11 @@ This NIP enables a way for users to share live statuses such as what music they
13 13
14## Live Statuses 14## Live Statuses
15 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: 16A special event with `kind:30315` "User Status" is defined as an *optionally expiring* _addressable event_, where the `d` tag represents the status type:
17 17
18For example: 18For example:
19 19
20```js 20```json
21{ 21{
22 "kind": 30315, 22 "kind": 30315,
23 "content": "Sign up for nostrasia!", 23 "content": "Sign up for nostrasia!",
@@ -26,7 +26,9 @@ For example:
26 ["r", "https://nostr.world"] 26 ["r", "https://nostr.world"]
27 ], 27 ],
28} 28}
29```
29 30
31```json
30{ 32{
31 "kind": 30315, 33 "kind": 30315,
32 "content": "Intergalatic - Beastie Boys", 34 "content": "Intergalatic - Beastie Boys",
@@ -44,7 +46,7 @@ Two common status types are defined: `general` and `music`. `general` represent
44 46
45Any other status types can be used but they are not defined by this NIP. 47Any other status types can be used but they are not defined by this NIP.
46 48
47The status MAY include an `r`, `p`, `e` or `a` tag linking to a URL, profile, note, or parameterized replaceable event. 49The status MAY include an `r`, `p`, `e` or `a` tag linking to a URL, profile, note, or addressable event.
48 50
49The `content` MAY include emoji(s), or [NIP-30](30.md) custom emoji(s). If the `content` is an empty string then the client should clear the status. 51The `content` MAY include emoji(s), or [NIP-30](30.md) custom emoji(s). If the `content` is an empty string then the client should clear the status.
50 52
diff --git a/39.md b/39.md
index c819e43..3777ac5 100644
--- a/39.md
+++ b/39.md
@@ -12,16 +12,19 @@ Nostr protocol users may have other online identities such as usernames, profile
12 12
13## `i` tag on a metadata event 13## `i` tag on a metadata event
14 14
15A new optional `i` tag is introduced for `kind 0` metadata event contents in addition to name, about, picture fields as included in [NIP-01](https://github.com/nostr-protocol/nips/blob/master/01.md): 15A new optional `i` tag is introduced for `kind 0` metadata event defined in [NIP-01](01.md):
16```json 16
17```jsonc
17{ 18{
19 "id": <id>,
20 "pubkey": <pubkey>,
18 "tags": [ 21 "tags": [
19 ["i", "github:semisol", "9721ce4ee4fceb91c9711ca2a6c9a5ab"], 22 ["i", "github:semisol", "9721ce4ee4fceb91c9711ca2a6c9a5ab"],
20 ["i", "twitter:semisol_public", "1619358434134196225"], 23 ["i", "twitter:semisol_public", "1619358434134196225"],
21 ["i", "mastodon:bitcoinhackers.org/@semisol", "109775066355589974"] 24 ["i", "mastodon:bitcoinhackers.org/@semisol", "109775066355589974"]
22 ["i", "telegram:1087295469", "nostrdirectory/770"] 25 ["i", "telegram:1087295469", "nostrdirectory/770"]
23 ], 26 ],
24 ... 27 // other fields...
25} 28}
26``` 29```
27 30
diff --git a/42.md b/42.md
index 8c70de4..fdc5d10 100644
--- a/42.md
+++ b/42.md
@@ -22,13 +22,13 @@ A relay may want to require clients to authenticate to access restricted resourc
22 22
23This NIP defines a new message, `AUTH`, which relays CAN send when they support authentication and clients can send to relays when they want to authenticate. When sent by relays the message has the following form: 23This NIP defines a new message, `AUTH`, which relays CAN send when they support authentication and clients can send to relays when they want to authenticate. When sent by relays the message has the following form:
24 24
25```json 25```
26["AUTH", <challenge-string>] 26["AUTH", <challenge-string>]
27``` 27```
28 28
29And, when sent by clients, the following form: 29And, when sent by clients, the following form:
30 30
31```json 31```
32["AUTH", <signed-event-json>] 32["AUTH", <signed-event-json>]
33``` 33```
34 34
@@ -38,14 +38,14 @@ And, when sent by clients, the following form:
38 38
39The signed event is an ephemeral event not meant to be published or queried, it must be of `kind: 22242` and it should have at least two tags, one for the relay URL and one for the challenge string as received from the relay. Relays MUST exclude `kind: 22242` events from being broadcasted to any client. `created_at` should be the current time. Example: 39The signed event is an ephemeral event not meant to be published or queried, it must be of `kind: 22242` and it should have at least two tags, one for the relay URL and one for the challenge string as received from the relay. Relays MUST exclude `kind: 22242` events from being broadcasted to any client. `created_at` should be the current time. Example:
40 40
41```json 41```jsonc
42{ 42{
43 "kind": 22242, 43 "kind": 22242,
44 "tags": [ 44 "tags": [
45 ["relay", "wss://relay.example.com/"], 45 ["relay", "wss://relay.example.com/"],
46 ["challenge", "challengestringhere"] 46 ["challenge", "challengestringhere"]
47 ], 47 ],
48 ... 48 // other fields...
49} 49}
50``` 50```
51 51
diff --git a/44.md b/44.md
index f3071ea..8f781b8 100644
--- a/44.md
+++ b/44.md
@@ -1,5 +1,5 @@
1NIP-44 1NIP-44
2===== 2======
3 3
4Encrypted Payloads (Versioned) 4Encrypted Payloads (Versioned)
5------------------------------ 5------------------------------
@@ -142,6 +142,8 @@ validation rules, refer to BIP-340.
142 The operation produces a shared point, and we encode the shared point's 32-byte x coordinate, using method 142 The operation produces a shared point, and we encode the shared point's 32-byte x coordinate, using method
143 `bytes(P)` from BIP340. Private and public keys must be validated as per BIP340: pubkey must be a valid, 143 `bytes(P)` from BIP340. Private and public keys must be validated as per BIP340: pubkey must be a valid,
144 on-curve point, and private key must be a scalar in range `[1, secp256k1_order - 1]`. 144 on-curve point, and private key must be a scalar in range `[1, secp256k1_order - 1]`.
145 NIP44 doesn't do hashing of the output: keep this in mind, because some libraries hash it using sha256.
146 As an example, in libsecp256k1, unhashed version is available in `secp256k1_ec_pubkey_tweak_mul`
145- Operators 147- Operators
146 - `x[i:j]`, where `x` is a byte array and `i, j <= 0` returns a `(j - i)`-byte array with a copy of the 148 - `x[i:j]`, where `x` is a byte array and `i, j <= 0` returns a `(j - i)`-byte array with a copy of the
147 `i`-th byte (inclusive) to the `j`-th byte (exclusive) of `x`. 149 `i`-th byte (inclusive) to the `j`-th byte (exclusive) of `x`.
diff --git a/45.md b/45.md
index 780dfb6..219368e 100644
--- a/45.md
+++ b/45.md
@@ -2,7 +2,7 @@ NIP-45
2====== 2======
3 3
4Event Counts 4Event Counts
5-------------- 5------------
6 6
7`draft` `optional` 7`draft` `optional`
8 8
@@ -16,14 +16,14 @@ Some queries a client may want to execute against connected relays are prohibiti
16 16
17This NIP defines the verb `COUNT`, which accepts a subscription id and filters as specified in [NIP 01](01.md) for the verb `REQ`. Multiple filters are OR'd together and aggregated into a single count result. 17This NIP defines the verb `COUNT`, which accepts a subscription id and filters as specified in [NIP 01](01.md) for the verb `REQ`. Multiple filters are OR'd together and aggregated into a single count result.
18 18
19```json 19```
20["COUNT", <subscription_id>, <filters JSON>...] 20["COUNT", <subscription_id>, <filters JSON>...]
21``` 21```
22 22
23Counts are returned using a `COUNT` response in the form `{"count": <integer>}`. Relays may use probabilistic counts to reduce compute requirements. 23Counts are returned using a `COUNT` response in the form `{"count": <integer>}`. Relays may use probabilistic counts to reduce compute requirements.
24In case a relay uses probabilistic counts, it MAY indicate it in the response with `approximate` key i.e. `{"count": <integer>, "approximate": <true|false>}`. 24In case a relay uses probabilistic counts, it MAY indicate it in the response with `approximate` key i.e. `{"count": <integer>, "approximate": <true|false>}`.
25 25
26```json 26```
27["COUNT", <subscription_id>, {"count": <integer>}] 27["COUNT", <subscription_id>, {"count": <integer>}]
28``` 28```
29 29
@@ -33,14 +33,14 @@ Whenever the relay decides to refuse to fulfill the `COUNT` request, it MUST ret
33 33
34### Followers count 34### Followers count
35 35
36```json 36```
37["COUNT", <subscription_id>, {"kinds": [3], "#p": [<pubkey>]}] 37["COUNT", <subscription_id>, {"kinds": [3], "#p": [<pubkey>]}]
38["COUNT", <subscription_id>, {"count": 238}] 38["COUNT", <subscription_id>, {"count": 238}]
39``` 39```
40 40
41### Count posts and reactions 41### Count posts and reactions
42 42
43```json 43```
44["COUNT", <subscription_id>, {"kinds": [1, 7], "authors": [<pubkey>]}] 44["COUNT", <subscription_id>, {"kinds": [1, 7], "authors": [<pubkey>]}]
45["COUNT", <subscription_id>, {"count": 5}] 45["COUNT", <subscription_id>, {"count": 5}]
46``` 46```
diff --git a/46.md b/46.md
index 1528116..c356a9c 100644
--- a/46.md
+++ b/46.md
@@ -1,4 +1,12 @@
1# NIP-46 - Nostr Remote Signing 1NIP-46
2======
3
4Nostr Remote Signing
5--------------------
6
7## Changes
8
9`remote-signer-key` is introduced, passed in bunker url, clients must differentiate between `remote-signer-pubkey` and `user-pubkey`, must call `get_public_key` after connect.
2 10
3## Rationale 11## Rationale
4 12
@@ -8,51 +16,53 @@ This NIP describes a method for 2-way communication between a remote signer and
8 16
9## Terminology 17## Terminology
10 18
11- **Local keypair**: A local public and private key-pair used to encrypt content and communicate with the remote signer. Usually created by the client application. 19- **user**: A person that is trying to use Nostr.
12- **Remote user pubkey**: The public key that the user wants to sign as. The remote signer has control of the private key that matches this public key. 20- **client**: A user-facing application that _user_ is looking at and clicking buttons in. This application will send requests to _remote-signer_.
13- **Remote signer pubkey**: This is the public key of the remote signer itself. This is needed in both `create_account` command because you don't yet have a remote user pubkey. 21- **remote-signer**: A daemon or server running somewhere that will answer requests from _client_, also known as "bunker".
22- **client-keypair/pubkey**: The keys generated by _client_. Used to encrypt content and communicate with _remote-signer_.
23- **remote-signer-keypair/pubkey**: The keys used by _remote-signer_ to encrypt content and communicate with _client_. This keypair MAY be same as _user-keypair_, but not necessarily.
24- **user-keypair/pubkey**: The actual keys representing _user_ (that will be used to sign events in response to `sign_event` requests, for example). The _remote-signer_ generally has control over these keys.
14 25
15All pubkeys specified in this NIP are in hex format. 26All pubkeys specified in this NIP are in hex format.
16 27
17## Initiating a connection 28## Initiating a connection
18 29
19To initiate a connection between a client and a remote signer there are a few different options. 30There are two ways to initiate a connection:
20 31
21### Direct connection initiated by remote signer 32### Direct connection initiated by _remote-signer_
22 33
23This is most common in a situation where you have your own nsecbunker or other type of remote signer and want to connect through a client that supports remote signing. 34_remote-signer_ provides connection token in the form:
24
25The remote signer would provide a connection token in the form:
26 35
27``` 36```
28bunker://<remote-user-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value> 37bunker://<remote-signer-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value>
29``` 38```
30 39
31This token is pasted into the client by the user and the client then uses the details to connect to the remote signer via the specified relay(s). 40_user_ pastes this token on _client_, which then uses the details to connect to _remote-signer_ via the specified relays. Optional secret can be used for single successfully established connection only, _remote-signer_ SHOULD ignore new attempts to establish connection with old optional secret.
32 41
33### Direct connection initiated by the client 42### Direct connection initiated by the client
34 43
35In this case, basically the opposite direction of the first case, the client provides a connection token (or encodes the token in a QR code) and the signer initiates a connection to the client via the specified relay(s). 44In this case, basically the opposite direction of the first case, _client_ provides a connection token (or encodes the token in a QR code) and _remote-signer_ initiates a connection via the specified relays.
36 45
37``` 46```
38nostrconnect://<local-keypair-pubkey>?relay=<wss://relay-to-connect-on>&metadata=<json metadata in the form: {"name":"...", "url": "...", "description": "..."}> 47nostrconnect://<client-pubkey>?relay=<wss://relay-to-connect-on>&metadata=<json metadata in the form: {"name":"...", "url": "...", "description": "..."}>
39``` 48```
40 49
41## The flow 50## The flow
42 51
431. Client creates a local keypair. This keypair doesn't need to be communicated to the user since it's largely disposable (i.e. the user doesn't need to see this pubkey). Clients might choose to store it locally and they should delete it when the user logs out. 521. _client_ generates `client-keypair`. This keypair doesn't need to be communicated to _user_ since it's largely disposable. _client_ might choose to store it locally and they should delete it on logout;
442. Client gets the remote user pubkey (either via a `bunker://` connection string or a NIP-05 login-flow; shown below) 532. _client_ gets `remote-signer-pubkey` (either via a `bunker://` connection string or a NIP-05 login-flow; shown below);
453. Clients use the local keypair to send requests to the remote signer by `p`-tagging and encrypting to the remote user pubkey. 543. _client_ use `client-keypair` to send requests to _remote-signer_ by `p`-tagging and encrypting to `remote-signer-pubkey`;
464. The remote signer responds to the client by `p`-tagging and encrypting to the local keypair pubkey. 554. _remote-signer_ responds to _client_ by `p`-tagging and encrypting to the `client-pubkey`.
47 56
48### Example flow for signing an event 57### Example flow for signing an event
49 58
50- Remote user pubkey (e.g. signing as) `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52` 59- `remote-signer-pubkey` is `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52`
51- Local pubkey is `eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86` 60- `user-pubkey` is also `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52`
61- `client-pubkey` is `eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86`
52 62
53#### Signature request 63#### Signature request
54 64
55```json 65```js
56{ 66{
57 "kind": 24133, 67 "kind": 24133,
58 "pubkey": "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86", 68 "pubkey": "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86",
@@ -66,13 +76,13 @@ nostrconnect://<local-keypair-pubkey>?relay=<wss://relay-to-connect-on>&metadata
66 created_at: 1714078911 76 created_at: 1714078911
67 }>)] 77 }>)]
68 }), 78 }),
69 "tags": [["p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"]], // p-tags the remote user pubkey 79 "tags": [["p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"]], // p-tags the remote-signer-pubkey
70} 80}
71``` 81```
72 82
73#### Response event 83#### Response event
74 84
75```json 85```js
76{ 86{
77 "kind": 24133, 87 "kind": 24133,
78 "pubkey": "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", 88 "pubkey": "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52",
@@ -80,7 +90,7 @@ nostrconnect://<local-keypair-pubkey>?relay=<wss://relay-to-connect-on>&metadata
80 "id": <random_string>, 90 "id": <random_string>,
81 "result": json_stringified(<signed-event>) 91 "result": json_stringified(<signed-event>)
82 }), 92 }),
83 "tags": [["p", "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86"]], // p-tags the local keypair pubkey 93 "tags": [["p", "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86"]], // p-tags the client-pubkey
84} 94}
85``` 95```
86 96
@@ -90,20 +100,18 @@ nostrconnect://<local-keypair-pubkey>?relay=<wss://relay-to-connect-on>&metadata
90 100
91## Request Events `kind: 24133` 101## Request Events `kind: 24133`
92 102
93```json 103```js
94{ 104{
95 "id": <id>,
96 "kind": 24133, 105 "kind": 24133,
97 "pubkey": <local_keypair_pubkey>, 106 "pubkey": <local_keypair_pubkey>,
98 "content": <nip04(<request>)>, 107 "content": <nip04(<request>)>,
99 "tags": [["p", <remote_user_pubkey>]], // NB: in the `create_account` event, the remote signer pubkey should be `p` tagged. 108 "tags": [["p", <remote-signer-pubkey>]],
100 "created_at": <unix timestamp in seconds>
101} 109}
102``` 110```
103 111
104The `content` field is a JSON-RPC-like message that is [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md) encrypted and has the following structure: 112The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted and has the following structure:
105 113
106```json 114```jsonc
107{ 115{
108 "id": <random_string>, 116 "id": <random_string>,
109 "method": <method_name>, 117 "method": <method_name>,
@@ -121,15 +129,16 @@ Each of the following are methods that the client sends to the remote signer.
121 129
122| Command | Params | Result | 130| Command | Params | Result |
123| ------------------------ | ------------------------------------------------- | ---------------------------------------------------------------------- | 131| ------------------------ | ------------------------------------------------- | ---------------------------------------------------------------------- |
124| `connect` | `[<remote_user_pubkey>, <optional_secret>, <optional_requested_permissions>]` | "ack" | 132| `connect` | `[<user_pubkey>, <optional_secret>, <optional_requested_permissions>]` | "ack" |
125| `sign_event` | `[<{kind, content, tags, created_at}>]` | `json_stringified(<signed_event>)` | 133| `sign_event` | `[<{kind, content, tags, created_at}>]` | `json_stringified(<signed_event>)` |
126| `ping` | `[]` | "pong" | 134| `ping` | `[]` | "pong" |
127| `get_relays` | `[]` | `json_stringified({<relay_url>: {read: <boolean>, write: <boolean>}})` | 135| `get_relays` | `[]` | `json_stringified({<relay_url>: {read: <boolean>, write: <boolean>}})` |
128| `get_public_key` | `[]` | `<hex-pubkey>` | 136| `get_public_key` | `[]` | `<user-pubkey>` |
129| `nip04_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip04_ciphertext>` | 137| `nip04_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip04_ciphertext>` |
130| `nip04_decrypt` | `[<third_party_pubkey>, <nip04_ciphertext_to_decrypt>]` | `<plaintext>` | 138| `nip04_decrypt` | `[<third_party_pubkey>, <nip04_ciphertext_to_decrypt>]` | `<plaintext>` |
131| `nip44_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip44_ciphertext>` | 139| `nip44_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip44_ciphertext>` |
132| `nip44_decrypt` | `[<third_party_pubkey>, <nip44_ciphertext_to_decrypt>]` | `<plaintext>` | 140| `nip44_decrypt` | `[<third_party_pubkey>, <nip44_ciphertext_to_decrypt>]` | `<plaintext>` |
141| `create_account` | `[<username>, <domain>, <optional_email>, <optional_requested_permissions>]` | `<newly_created_user_pubkey>` |
133 142
134### Requested permissions 143### Requested permissions
135 144
@@ -141,14 +150,14 @@ The `connect` method may be provided with `optional_requested_permissions` for u
141{ 150{
142 "id": <id>, 151 "id": <id>,
143 "kind": 24133, 152 "kind": 24133,
144 "pubkey": <remote_signer_pubkey>, 153 "pubkey": <remote-signer-pubkey>,
145 "content": <nip04(<response>)>, 154 "content": <nip04(<response>)>,
146 "tags": [["p", <local_keypair_pubkey>]], 155 "tags": [["p", <client-pubkey>]],
147 "created_at": <unix timestamp in seconds> 156 "created_at": <unix timestamp in seconds>
148} 157}
149``` 158```
150 159
151The `content` field is a JSON-RPC-like message that is [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md) encrypted and has the following structure: 160The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted and has the following structure:
152 161
153```json 162```json
154{ 163{
@@ -180,18 +189,6 @@ Clients should display (in a popup or new tab) the URL from the `error` field an
180 189
181![signing-example-with-auth-challenge](https://i.nostr.build/W3aj.png) 190![signing-example-with-auth-challenge](https://i.nostr.build/W3aj.png)
182 191
183## Remote Signer Commands
184
185Remote signers might support additional commands when communicating directly with it. These commands follow the same flow as noted above, the only difference is that when the client sends a request event, the `p`-tag is the pubkey of the remote signer itself and the `content` payload is encrypted to the same remote signer pubkey.
186
187### Methods/Commands
188
189Each of the following are methods that the client sends to the remote signer.
190
191| Command | Params | Result |
192| ---------------- | ------------------------------------------ | ------------------------------------ |
193| `create_account` | `[<username>, <domain>, <optional_email>, <optional_requested_permissions>]` | `<newly_created_remote_user_pubkey>` |
194
195## Appendix 192## Appendix
196 193
197### NIP-05 Login Flow 194### NIP-05 Login Flow
@@ -200,7 +197,7 @@ Clients might choose to present a more familiar login flow, so users can type a
200 197
201When the user types a NIP-05 the client: 198When the user types a NIP-05 the client:
202 199
203- Queries the `/.well-known/nostr.json` file from the domain for the NIP-05 address provided to get the user's pubkey (this is the **remote user pubkey**) 200- Queries the `/.well-known/nostr.json` file from the domain for the NIP-05 address provided to get the user's pubkey (this is the `user-pubkey`)
204- In the same `/.well-known/nostr.json` file, queries for the `nip46` key to get the relays that the remote signer will be listening on. 201- In the same `/.well-known/nostr.json` file, queries for the `nip46` key to get the relays that the remote signer will be listening on.
205- Now the client has enough information to send commands to the remote signer on behalf of the user. 202- Now the client has enough information to send commands to the remote signer on behalf of the user.
206 203
@@ -212,9 +209,9 @@ In this last case, most often used to facilitate an OAuth-like signin flow, the
212 209
213First the client will query for `kind: 31990` events that have a `k` tag of `24133`. 210First the client will query for `kind: 31990` events that have a `k` tag of `24133`.
214 211
215These are generally shown to a user, and once the user selects which remote signer to use and provides the remote user pubkey they want to use (via npub, pubkey, or nip-05 value), the client can initiate a connection. Note that it's on the user to select the remote signer that is actually managing the remote key that they would like to use in this case. If the remote user pubkey is managed on another remote signer, the connection will fail. 212These are generally shown to a user, and once the user selects which remote signer to use and provides the `user-pubkey` they want to use (via npub, pubkey, or nip-05 value), the client can initiate a connection. Note that it's on the user to select the _remote-signer_ that is actually managing the `user-keypair` that they would like to use in this case. If the `user-pubkey` is managed on another _remote-signer_ the connection will fail.
216 213
217In addition, it's important that clients validate that the pubkey of the announced remote signer matches the pubkey of the `_` entry in the `/.well-known/nostr.json` file of the remote signer's announced domain. 214In addition, it's important that clients validate that the pubkey of the announced _remote-signer_ matches the pubkey of the `_` entry in the `/.well-known/nostr.json` file of the remote signer's announced domain.
218 215
219Clients that allow users to create new accounts should also consider validating the availability of a given username in the namespace of remote signer's domain by checking the `/.well-known/nostr.json` file for existing usernames. Clients can then show users feedback in the UI before sending a `create_account` event to the remote signer and receiving an error in return. Ideally, remote signers would also respond with understandable error messages if a client tries to create an account with an existing username. 216Clients that allow users to create new accounts should also consider validating the availability of a given username in the namespace of remote signer's domain by checking the `/.well-known/nostr.json` file for existing usernames. Clients can then show users feedback in the UI before sending a `create_account` event to the remote signer and receiving an error in return. Ideally, remote signers would also respond with understandable error messages if a client tries to create an account with an existing username.
220 217
@@ -224,4 +221,4 @@ Coming soon...
224 221
225## References 222## References
226 223
227- [NIP-04 - Encryption](https://github.com/nostr-protocol/nips/blob/master/04.md) 224- [NIP-04 - Encryption](04.md)
diff --git a/47.md b/47.md
index 983d2c9..a19230f 100644
--- a/47.md
+++ b/47.md
@@ -38,7 +38,7 @@ a plaintext string with the supported commands, space-separated, eg. `pay_invoic
38Both the request and response events SHOULD contain one `p` tag, containing the public key of the **wallet service** if this is a request, and the public key of the **user** if this is a response. The response event SHOULD contain an `e` tag with the id of the request event it is responding to. 38Both the request and response events SHOULD contain one `p` tag, containing the public key of the **wallet service** if this is a request, and the public key of the **user** if this is a response. The response event SHOULD contain an `e` tag with the id of the request event it is responding to.
39Optionally, a request can have an `expiration` tag that has a unix timestamp in seconds. If the request is received after this timestamp, it should be ignored. 39Optionally, a request can have an `expiration` tag that has a unix timestamp in seconds. If the request is received after this timestamp, it should be ignored.
40 40
41The content of requests and responses is encrypted with [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md), and is a JSON-RPCish object with a semi-fixed structure: 41The content of requests and responses is encrypted with [NIP04](04.md), and is a JSON-RPCish object with a semi-fixed structure:
42 42
43Request: 43Request:
44```jsonc 44```jsonc
@@ -173,7 +173,7 @@ Request:
173 "amount": 123, // invoice amount in msats, required 173 "amount": 123, // invoice amount in msats, required
174 "pubkey": "03...", // payee pubkey, required 174 "pubkey": "03...", // payee pubkey, required
175 "preimage": "0123456789abcdef...", // preimage of the payment, optional 175 "preimage": "0123456789abcdef...", // preimage of the payment, optional
176 "tlv_records: [ // tlv records, optional 176 "tlv_records": [ // tlv records, optional
177 { 177 {
178 "type": 5482373484, // tlv type 178 "type": 5482373484, // tlv type
179 "value": "0123456789abcdef" // hex encoded tlv value 179 "value": "0123456789abcdef" // hex encoded tlv value
@@ -208,7 +208,7 @@ Request:
208 "method": "multi_pay_keysend", 208 "method": "multi_pay_keysend",
209 "params": { 209 "params": {
210 "keysends": [ 210 "keysends": [
211 {"id": "4c5b24a351", pubkey": "03...", "amount": 123}, 211 {"id": "4c5b24a351", "pubkey": "03...", "amount": 123},
212 {"id": "3da52c32a1", "pubkey": "02...", "amount": 567, "preimage": "abc123..", "tlv_records": [{"type": 696969, "value": "77616c5f6872444873305242454d353736"}]}, 212 {"id": "3da52c32a1", "pubkey": "02...", "amount": 567, "preimage": "abc123..", "tlv_records": [{"type": 696969, "value": "77616c5f6872444873305242454d353736"}]},
213 ], 213 ],
214 } 214 }
@@ -358,8 +358,7 @@ Request:
358```jsonc 358```jsonc
359{ 359{
360 "method": "get_balance", 360 "method": "get_balance",
361 "params": { 361 "params": {}
362 }
363} 362}
364``` 363```
365 364
@@ -379,8 +378,7 @@ Request:
379```jsonc 378```jsonc
380{ 379{
381 "method": "get_info", 380 "method": "get_info",
382 "params": { 381 "params": {}
383 }
384} 382}
385``` 383```
386 384
diff --git a/50.md b/50.md
index 2a31cb1..9eea1f8 100644
--- a/50.md
+++ b/50.md
@@ -15,9 +15,9 @@ extensible framework for performing such queries.
15## `search` filter field 15## `search` filter field
16 16
17A new `search` field is introduced for `REQ` messages from clients: 17A new `search` field is introduced for `REQ` messages from clients:
18```json 18```jsonc
19{ 19{
20 ... 20 // other fields on filter object...
21 "search": <string> 21 "search": <string>
22} 22}
23``` 23```
diff --git a/51.md b/51.md
index fb40b26..3792d7f 100644
--- a/51.md
+++ b/51.md
@@ -16,7 +16,7 @@ When new items are added to an existing list, clients SHOULD append them to the
16 16
17## Standard lists 17## Standard lists
18 18
19Standard lists use non-parameterized replaceable events, meaning users may only have a single list of each kind. They have special meaning and clients may rely on them to augment a user's profile or browsing experience. 19Standard lists use normal replaceable events, meaning users may only have a single list of each kind. They have special meaning and clients may rely on them to augment a user's profile or browsing experience.
20 20
21For example, _mute list_ can contain the public keys of spammers and bad actors users don't want to see in their feeds or receive annoying notifications from. 21For example, _mute list_ can contain the public keys of spammers and bad actors users don't want to see in their feeds or receive annoying notifications from.
22 22
@@ -32,6 +32,7 @@ For example, _mute list_ can contain the public keys of spammers and bad actors
32| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group ids + mandatory relay URL) | 32| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group ids + mandatory relay URL) |
33| Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) | 33| Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) |
34| Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | 34| Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) |
35| DM relays | 10050 | Where to receive [NIP-17](17.md) direct messages | `"relay"` (see [NIP-17](17.md)) |
35| Good wiki authors | 10101 | [NIP-54](54.md) user recommended wiki authors | `"p"` (pubkeys) | 36| Good wiki authors | 10101 | [NIP-54](54.md) user recommended wiki authors | `"p"` (pubkeys) |
36| Good wiki relays | 10102 | [NIP-54](54.md) relays deemed to only host useful articles | `"relay"` (relay URLs) | 37| Good wiki relays | 10102 | [NIP-54](54.md) relays deemed to only host useful articles | `"relay"` (relay URLs) |
37 38
@@ -50,6 +51,7 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti
50| Bookmark sets | 30003 | user-defined bookmarks categories , for when bookmarks must be in labeled separate groups | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) | 51| Bookmark sets | 30003 | user-defined bookmarks categories , for when bookmarks must be in labeled separate groups | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) |
51| Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) | 52| Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) |
52| Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"a"` (kind:34235 videos) | 53| Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"a"` (kind:34235 videos) |
54| Kind mute sets | 30007 | mute pubkeys by kinds<br>`"d"` tag MUST be the kind string | `"p"` (pubkeys) |
53| Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) | 55| Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) |
54| Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | 56| Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) |
55| Release artifact sets | 30063 | groups of files of a software release | `"e"` (kind:1063 [file metadata](94.md) events), `"i"` (application identifier, typically reverse domain notation), `"version"` | 57| Release artifact sets | 30063 | groups of files of a software release | `"e"` (kind:1063 [file metadata](94.md) events), `"i"` (application identifier, typically reverse domain notation), `"version"` |
@@ -109,7 +111,7 @@ Some clients have used these lists in the past, but they should work on transiti
109 111
110### A _release artifact set_ of an Example App 112### A _release artifact set_ of an Example App
111 113
112```json 114```jsonc
113{ 115{
114 "id": "567b41fc9060c758c4216fe5f8d3df7c57daad7ae757fa4606f0c39d4dd220ef", 116 "id": "567b41fc9060c758c4216fe5f8d3df7c57daad7ae757fa4606f0c39d4dd220ef",
115 "pubkey": "d6dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c", 117 "pubkey": "d6dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c",
diff --git a/52.md b/52.md
index f35d904..cc2625a 100644
--- a/52.md
+++ b/52.md
@@ -6,7 +6,7 @@ Calendar Events
6 6
7`draft` `optional` 7`draft` `optional`
8 8
9This specification defines calendar events representing an occurrence at a specific moment or between moments. These calendar events are _parameterized replaceable_ and deletable per [NIP-09](09.md). 9This specification defines calendar events representing an occurrence at a specific moment or between moments. These calendar events are _addressable_ 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
@@ -20,7 +20,7 @@ This kind of calendar event starts on a date and ends before a different date in
20 20
21#### Format 21#### Format
22 22
23The format uses a parameterized replaceable event kind `31922`. 23The format uses an _addressable event_ of `kind:31922`.
24 24
25The `.content` of these events should be a detailed description of the calendar event. It is required but can be an empty string. 25The `.content` of these events should be a detailed description of the calendar event. It is required but can be an empty string.
26 26
@@ -79,7 +79,7 @@ This kind of calendar event spans between a start time and end time.
79 79
80#### Format 80#### Format
81 81
82The format uses a parameterized replaceable event kind `31923`. 82The format uses an _addressable event_ kind `31923`.
83 83
84The `.content` of these events should be a detailed description of the calendar event. It is required but can be an empty string. 84The `.content` of these events should be a detailed description of the calendar event. It is required but can be an empty string.
85 85
@@ -90,9 +90,12 @@ The list of tags are as follows:
90* `end` (optional) exclusive end Unix timestamp in seconds. If omitted, the calendar event ends instantaneously. 90* `end` (optional) exclusive end Unix timestamp in seconds. If omitted, the calendar event ends instantaneously.
91* `start_tzid` (optional) time zone of the start timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica` 91* `start_tzid` (optional) time zone of the start timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica`
92* `end_tzid` (optional) time zone of the end timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica`. If omitted and `start_tzid` is provided, the time zone of the end timestamp is the same as the start timestamp. 92* `end_tzid` (optional) time zone of the end timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica`. If omitted and `start_tzid` is provided, the time zone of the end timestamp is the same as the start timestamp.
93* `summary` (optional) brief description of the calendar event
94* `image` (optional) url of an image to use for the event
93* `location` (optional, repeated) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call 95* `location` (optional, repeated) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call
94* `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location 96* `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location
95* `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting 97* `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting
98* `l` (optional, repeated) label to categorize calendar event. e.g. `audiospace` to denote a scheduled event from a live audio space implementation such as cornychat.com
96* `t` (optional, repeated) hashtag to categorize calendar event 99* `t` (optional, repeated) hashtag to categorize calendar event
97* `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. 100* `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc.
98 101
@@ -110,6 +113,8 @@ The following tags are deprecated:
110 ["d", "<UUID>"], 113 ["d", "<UUID>"],
111 114
112 ["title", "<title of calendar event>"], 115 ["title", "<title of calendar event>"],
116 ["summary", "<brief description of the calendar event>"],
117 ["image", "<string with image URI>"],
113 118
114 // Timestamps 119 // Timestamps
115 ["start", "<Unix timestamp in seconds>"], 120 ["start", "<Unix timestamp in seconds>"],
@@ -126,6 +131,10 @@ The following tags are deprecated:
126 ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"], 131 ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"],
127 ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"], 132 ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"],
128 133
134 // Labels (example using com.cornychat namespace denoting the event as an audiospace)
135 ["L", "com.cornychat"],
136 ["l", "audiospace", "com.cornychat"],
137
129 // Hashtags 138 // Hashtags
130 ["t", "<tag>"], 139 ["t", "<tag>"],
131 ["t", "<tag>"], 140 ["t", "<tag>"],
@@ -178,17 +187,23 @@ This NIP is intentionally not defining who is authorized to attend a calendar ev
178 187
179This NIP is also intentionally not defining what happens if a calendar event changes after an RSVP is submitted. 188This NIP is also intentionally not defining what happens if a calendar event changes after an RSVP is submitted.
180 189
190The RSVP MUST have an `a` tag of the event coordinates to the calendar event, and optionally an `e` tag of the id of the specific calendar event revision. If an `e` tag is present, clients SHOULD interpret it as an indication that the RSVP is a response to that revision of the calendar event, and MAY interpret it to not necessarily apply to other revisions of the calendar event.
191
192The RSVP MAY tag the author of the calendar event it is in response to using a `p` tag so that clients can easily query all RSVPs that pertain to the author.
193
181### Format 194### Format
182 195
183The format uses a parameterized replaceable event kind `31925`. 196The format uses an _addressable event_ kind `31925`.
184 197
185The `.content` of these events is optional and should be a free-form note that adds more context to this calendar event response. 198The `.content` of these events is optional and should be a free-form note that adds more context to this calendar event response.
186 199
187The list of tags are as follows: 200The list of tags are as follows:
188* `a` (required) reference tag to kind `31922` or `31923` calendar event being responded to. 201* `a` (required) coordinates to a kind `31922` or `31923` calendar event being responded to.
202* `e` (optional) event id of a kind `31922` or `31923` calendar event being responded to.
189* `d` (required) universally unique identifier. Generated by the client creating the calendar event RSVP. 203* `d` (required) universally unique identifier. Generated by the client creating the calendar event RSVP.
190* `status` (required) `accepted`, `declined`, or `tentative`. Determines attendance status to the referenced calendar event. 204* `status` (required) `accepted`, `declined`, or `tentative`. Determines attendance status to the referenced calendar event.
191* `fb` (optional) `free` or `busy`. Determines if the user would be free or busy for the duration of the calendar event. This tag must be omitted or ignored if the `status` label is set to `declined`. 205* `fb` (optional) `free` or `busy`. Determines if the user would be free or busy for the duration of the calendar event. This tag must be omitted or ignored if the `status` label is set to `declined`.
206* `p` (optional) pubkey of the author of the calendar event being responded to.
192 207
193```json 208```json
194{ 209{
@@ -198,10 +213,12 @@ The list of tags are as follows:
198 "kind": 31925, 213 "kind": 31925,
199 "content": "<note>", 214 "content": "<note>",
200 "tags": [ 215 "tags": [
201 ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"], 216 ["e", "<kind 31922 or 31923 event id", "<optional recommended relay URL>"]
217 ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional recommended relay URL>"],
202 ["d", "<UUID>"], 218 ["d", "<UUID>"],
203 ["status", "<accepted/declined/tentative>"], 219 ["status", "<accepted/declined/tentative>"],
204 ["fb", "<free/busy>"], 220 ["fb", "<free/busy>"],
221 ["p", "<hex pubkey of kind 31922 or 31923 event>", "<optional recommended relay URL>"]
205 ] 222 ]
206} 223}
207``` 224```
diff --git a/53.md b/53.md
index 0b1cb81..c3f15ea 100644
--- a/53.md
+++ b/53.md
@@ -12,11 +12,11 @@ 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 _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. 15A special event with `kind:30311` "Live Event" is defined as an _addressable event_ of public `p` tags. Each `p` tag SHOULD have a **displayable** marker name for the current role (e.g. `Host`, `Speaker`, `Participant`) of the user in the event and the relay information MAY be empty. This event will be constantly updated as participants join and leave the activity.
16 16
17For example: 17For example:
18 18
19```json 19```jsonc
20{ 20{
21 "kind": 30311, 21 "kind": 30311,
22 "tags": [ 22 "tags": [
@@ -35,10 +35,10 @@ For example:
35 ["p", "91cf9..4e5ca", "wss://provider1.com/", "Host", "<proof>"], 35 ["p", "91cf9..4e5ca", "wss://provider1.com/", "Host", "<proof>"],
36 ["p", "14aeb..8dad4", "wss://provider2.com/nostr", "Speaker"], 36 ["p", "14aeb..8dad4", "wss://provider2.com/nostr", "Speaker"],
37 ["p", "612ae..e610f", "ws://provider3.com/ws", "Participant"], 37 ["p", "612ae..e610f", "ws://provider3.com/ws", "Participant"],
38 ["relays", "wss://one.com", "wss://two.com", ...] 38 ["relays", "wss://one.com", "wss://two.com", /*...*/]
39 ], 39 ],
40 "content": "", 40 "content": "",
41 ... 41 // other fields...
42} 42}
43``` 43```
44 44
@@ -64,14 +64,14 @@ This feature is important to avoid malicious event owners adding large account h
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```json 67```jsonc
68{ 68{
69 "kind": 1311, 69 "kind": 1311,
70 "tags": [ 70 "tags": [
71 ["a", "30311:<Community event author pubkey>:<d-identifier of the community>", "<Optional relay url>", "root"], 71 ["a", "30311:<Community event author pubkey>:<d-identifier of the community>", "<Optional relay url>", "root"],
72 ], 72 ],
73 "content": "Zaps to live streams is beautiful.", 73 "content": "Zaps to live streams is beautiful.",
74 ... 74 // other fields...
75} 75}
76``` 76```
77 77
@@ -119,4 +119,4 @@ Common use cases include meeting rooms/workshops, watch-together activities, or
119 "content": "Zaps to live streams is beautiful.", 119 "content": "Zaps to live streams is beautiful.",
120 "sig": "997f62ddfc0827c121043074d50cfce7a528e978c575722748629a4137c45b75bdbc84170bedc723ef0a5a4c3daebf1fef2e93f5e2ddb98e5d685d022c30b622" 120 "sig": "997f62ddfc0827c121043074d50cfce7a528e978c575722748629a4137c45b75bdbc84170bedc723ef0a5a4c3daebf1fef2e93f5e2ddb98e5d685d022c30b622"
121} 121}
122```` 122```
diff --git a/54.md b/54.md
index fe46918..3a02150 100644
--- a/54.md
+++ b/54.md
@@ -6,12 +6,12 @@ Wiki
6 6
7`draft` `optional` 7`draft` `optional`
8 8
9This NIP defines `kind:30818` (a _parameterized replaceable event_) for long-form text content similar to [NIP-23](23.md), but with one important difference: articles are meant to be descriptions, or encyclopedia entries, of particular subjects, and it's expected that multiple people will write articles about the exact same subjects, with either small variations or completely independent content. 9This NIP defines `kind:30818` (an _addressable event_) for descriptions (or encyclopedia entries) of particular subjects, and it's expected that multiple people will write articles about the exact same subjects, with either small variations or completely independent content.
10 10
11Articles are identified by lowercase, normalized ascii `d` tags. 11Articles are identified by lowercase, normalized ascii `d` tags.
12 12
13### Articles 13### Articles
14```jsonc 14```json
15{ 15{
16 "content": "A wiki is a hypertext publication collaboratively edited and managed by its own audience.", 16 "content": "A wiki is a hypertext publication collaboratively edited and managed by its own audience.",
17 "tags": [ 17 "tags": [
@@ -26,21 +26,25 @@ Articles are identified by lowercase, normalized ascii `d` tags.
26- Any non-letter character MUST be converted to a `-`. 26- Any non-letter character MUST be converted to a `-`.
27- All letters MUST be converted to lowercase. 27- All letters MUST be converted to lowercase.
28 28
29### Content rules 29### Content
30 30
31The content should be Markdown, following the same rules as of [NIP-23](23.md), although it takes some extra (optional) metadata tags: 31The `content` should be Asciidoc with two extra functionalities: **wikilinks** and **nostr:...** links.
32 32
33 - `title`: for when the display title should be different from the `d` tag. 33Unlike normal Asciidoc links `http://example.com[]` that link to external webpages, wikilinks `[[]]` link to other articles in the wiki. In this case, the wiki is the entirety of Nostr. Clicking on a wikilink should cause the client to ask relays for events with `d` tags equal to the target of that wikilink.
34 - `summary`: for display in lists.
35 - `a` and `e`: for referencing the original event a wiki article was forked from.
36
37One extra functionality is added: **wikilinks**. Unlike normal Markdown links `[]()` that link to webpages, wikilinks `[[]]` link to other articles in the wiki. In this case, the wiki is the entirety of Nostr. Clicking on a wikilink should cause the client to ask relays for events with `d` tags equal to the target of that wikilink.
38 34
39Wikilinks can take these two forms: 35Wikilinks can take these two forms:
40 36
41 1. `[[Target Page]]` -- in this case it will link to the page `target-page` (according to `d` tag normalization rules above) and be displayed as `Target Page`; 37 1. `[[Target Page]]` -- in this case it will link to the page `target-page` (according to `d` tag normalization rules above) and be displayed as `Target Page`;
42 2. `[[target page|see this]]` -- in this case it will link to the page `target-page`, but will be displayed as `see this`. 38 2. `[[target page|see this]]` -- in this case it will link to the page `target-page`, but will be displayed as `see this`.
43 39
40`nostr:...` links, as per [NIP-21](21.md), should link to profiles or arbitrary Nostr events. Although it is not recommended to link to specific versions of articles -- instead the _wikilink_ syntax should be preferred, since it should be left to the reader and their client to decide what version of any given article they want to read.
41
42### Optional extra tags
43
44 - `title`: for when the display title should be different from the `d` tag.
45 - `summary`: for display in lists.
46 - `a` and `e`: for referencing the original event a wiki article was forked from.
47
44### Merge Requests 48### Merge Requests
45 49
46Event `kind:818` represents a request to merge from a forked article into the source. It is directed to a pubkey and references the original article and the modified event. 50Event `kind:818` represents a request to merge from a forked article into the source. It is directed to a pubkey and references the original article and the modified event.
@@ -86,23 +90,23 @@ This is a stronger signal of trust than a `+` reaction.
86 90
87This marker is useful when a user edits someone else's entry; if the original author includes the editor's changes and the editor doesn't want to keep/maintain an independent version, the `link` tag could effectively be a considered a "deletion" of the editor's version and putting that pubkey's WoT weight behind the original author's version. 91This marker is useful when a user edits someone else's entry; if the original author includes the editor's changes and the editor doesn't want to keep/maintain an independent version, the `link` tag could effectively be a considered a "deletion" of the editor's version and putting that pubkey's WoT weight behind the original author's version.
88 92
89Why Markdown? 93Why Asciidoc?
90------------- 94-------------
91 95
92If the idea is to make a wiki then the most obvious text format to use is probably the mediawiki/wikitext format used by Wikipedia since it's widely deployed in all mediawiki installations and used for decades with great success. However, it turns out that format is very bloated and convoluted, has way too many features and probably because of that it doesn't have many alternative implementations out there, and the ones that exist are not complete and don't look very trustworthy. Also it is very much a centralized format that can probably be changed at the whims of the Wikipedia owners. 96Wikitext is [garbage](nostr:nevent1qqsqt0gcggry60n72uglhuhypdlmr2dm6swjj69jex5v530gcpazlzsprpmhxue69uhhyetvv9ujumn0wdmksetjv5hxxmmdqy28wumn8ghj7un9d3shjtnyv9kh2uewd9hsygpm7rrrljungc6q0tuh5hj7ue863q73qlheu4vywtzwhx42a7j9n5ueneex) and Markdown is not powerful enough (besides being too freeform and unspecified and prone to generate incompatibilities in the future).
93 97
94On the other hand, Markdown has proven to work well for small scale wikis and one of the biggest wikis in the planet (which is not very often thought of as a wiki), [StackOverflow](https://stackoverflow.com) and its child sites, and also one of the biggest "personal wiki" software, [Obsidian](https://obsidian.md/). Markdown can probably deliver 95% of the functionality of wikitext. When augmented with tables, diagram generators and MathJax (which are common extensions that exist in the wild and can be included in this NIP) that rate probably goes to 99%, and its simplicity is a huge benefit that can't be overlooked. Wikitext format can also be transpíled into Markdown using Pandoc. Given all that, I think it's a reasonable suspicion that mediawiki is not inherently better than Markdown, the success of Wikipedia probably cannot be predicated on the syntax language choice. 98Asciidoc has a strict spec, multiple implementations in many languages, and support for features that are very much necessary in a wiki article, like _sidebars_, _tables_ (with rich markup inside cells), many levels of _headings_, _footnotes_, _superscript_ and _subscript_ markup and _description lists_. It is also arguably easier to read in its plaintext format than Markdown (and certainly much better than Wikitext).
95 99
96# Appendix 1: Merge requests 100# Appendix 1: Merge requests
97Users can request other users to get their entries merged into someone else's entry by creating a `kind:818` event. 101Users can request other users to get their entries merged into someone else's entry by creating a `kind:818` event.
98 102
99```jsonc 103```json
100{ 104{
101 "content": "I added information about how to make hot ice-creams", 105 "content": "I added information about how to make hot ice-creams",
102 "kind": 818, 106 "kind": 818,
103 "tags": [ 107 "tags": [
104 [ "a", "30818:<destination-pubkey>:hot-ice-creams", "<relay-url>" ], 108 [ "a", "30818:<destination-pubkey>:hot-ice-creams", "<relay-url>" ],
105 [ "e", "<version-against-which-the-modification-was-made>", "<relay-url>' ], 109 [ "e", "<version-against-which-the-modification-was-made>", "<relay-url>" ],
106 [ "p", "<destination-pubkey>" ], 110 [ "p", "<destination-pubkey>" ],
107 [ "e", "<version-to-be-merged>", "<relay-url>", "source" ] 111 [ "e", "<version-to-be-merged>", "<relay-url>", "source" ]
108 ] 112 ]
@@ -114,4 +118,4 @@ Users can request other users to get their entries merged into someone else's en
114`e` tag: optional version of the article in which this modifications is based 118`e` tag: optional version of the article in which this modifications is based
115`e` tag with `source` marker: the ID of the event that should be merged. This event id MUST be of a `kind:30818` as defined in this NIP. 119`e` tag with `source` marker: the ID of the event that should be merged. This event id MUST be of a `kind:30818` as defined in this NIP.
116 120
117The destination-pubkey (the pubkey being requested to merge something into their article can create [[NIP-25]] reactions that tag the `kind:818` event with `+` or `-` 121The destination-pubkey is the pubkey being requested to merge something into their article can create [[NIP-25]] reactions that tag the `kind:818` event with `+` or `-`
diff --git a/55.md b/55.md
index 4565e8c..afca0aa 100644
--- a/55.md
+++ b/55.md
@@ -1,6 +1,8 @@
1# NIP-55 1NIP-55
2======
2 3
3## Android Signer Application 4Android Signer Application
5--------------------------
4 6
5`draft` `optional` 7`draft` `optional`
6 8
@@ -51,8 +53,8 @@ val launcher = rememberLauncherForActivityResult(
51 Toast.LENGTH_SHORT 53 Toast.LENGTH_SHORT
52 ).show() 54 ).show()
53 } else { 55 } else {
54 val signature = activityResult.data?.getStringExtra("signature") 56 val result = activityResult.data?.getStringExtra("result")
55 // Do something with signature ... 57 // Do something with result ...
56 } 58 }
57 } 59 }
58) 60)
@@ -70,6 +72,35 @@ Set the Signer package name:
70intent.`package` = "com.example.signer" 72intent.`package` = "com.example.signer"
71``` 73```
72 74
75If you are sending multiple intents without awaiting you can add some intent flags to sign all events without opening multiple times the signer
76
77```kotlin
78intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP or Intent.FLAG_ACTIVITY_CLEAR_TOP)
79```
80
81If you are developing a signer application them you need to add this to your AndroidManifest.xml so clients can use the intent flags above
82
83```kotlin
84android:launchMode="singleTop"
85```
86
87Signer MUST answer multiple permissions with an array of results
88
89```kotlin
90
91val results = listOf(
92 Result(
93 package = signerPackageName,
94 result = eventSignture,
95 id = intentId
96 )
97)
98
99val json = results.toJson()
100
101intent.putExtra("results", json)
102```
103
73Send the Intent: 104Send the Intent:
74 105
75```kotlin 106```kotlin
@@ -99,10 +130,10 @@ launcher.launch(intent)
99 context.startActivity(intent) 130 context.startActivity(intent)
100 ``` 131 ```
101 - result: 132 - result:
102 - If the user approved intent it will return the **npub** in the signature field 133 - If the user approved intent it will return the **pubkey** in the result field
103 134
104 ```kotlin 135 ```kotlin
105 val npub = intent.data?.getStringExtra("signature") 136 val pubkey = intent.data?.getStringExtra("result")
106 // The package name of the signer application 137 // The package name of the signer application
107 val packageName = intent.data?.getStringExtra("package") 138 val packageName = intent.data?.getStringExtra("package")
108 ``` 139 ```
@@ -116,16 +147,16 @@ launcher.launch(intent)
116 intent.putExtra("type", "sign_event") 147 intent.putExtra("type", "sign_event")
117 // To handle results when not waiting between intents 148 // To handle results when not waiting between intents
118 intent.putExtra("id", event.id) 149 intent.putExtra("id", event.id)
119 // Send the current logged in user npub 150 // Send the current logged in user pubkey
120 intent.putExtra("current_user", npub) 151 intent.putExtra("current_user", pubkey)
121 152
122 context.startActivity(intent) 153 context.startActivity(intent)
123 ``` 154 ```
124 - result: 155 - result:
125 - If the user approved intent it will return the **signature**, **id** and **event** fields 156 - If the user approved intent it will return the **result**, **id** and **event** fields
126 157
127 ```kotlin 158 ```kotlin
128 val signature = intent.data?.getStringExtra("signature") 159 val signature = intent.data?.getStringExtra("result")
129 // The id you sent 160 // The id you sent
130 val id = intent.data?.getStringExtra("id") 161 val id = intent.data?.getStringExtra("id")
131 val signedEventJson = intent.data?.getStringExtra("event") 162 val signedEventJson = intent.data?.getStringExtra("event")
@@ -140,18 +171,18 @@ launcher.launch(intent)
140 intent.putExtra("type", "nip04_encrypt") 171 intent.putExtra("type", "nip04_encrypt")
141 // to control the result in your application in case you are not waiting the result before sending another intent 172 // to control the result in your application in case you are not waiting the result before sending another intent
142 intent.putExtra("id", "some_id") 173 intent.putExtra("id", "some_id")
143 // Send the current logged in user npub 174 // Send the current logged in user pubkey
144 intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) 175 intent.putExtra("current_user", account.keyPair.pubkey)
145 // Send the hex pubKey that will be used for encrypting the data 176 // Send the hex pubkey that will be used for encrypting the data
146 intent.putExtra("pubKey", pubKey) 177 intent.putExtra("pubkey", pubkey)
147 178
148 context.startActivity(intent) 179 context.startActivity(intent)
149 ``` 180 ```
150 - result: 181 - result:
151 - If the user approved intent it will return the **signature** and **id** fields 182 - If the user approved intent it will return the **result** and **id** fields
152 183
153 ```kotlin 184 ```kotlin
154 val encryptedText = intent.data?.getStringExtra("signature") 185 val encryptedText = intent.data?.getStringExtra("result")
155 // the id you sent 186 // the id you sent
156 val id = intent.data?.getStringExtra("id") 187 val id = intent.data?.getStringExtra("id")
157 ``` 188 ```
@@ -165,10 +196,10 @@ launcher.launch(intent)
165 intent.putExtra("type", "nip44_encrypt") 196 intent.putExtra("type", "nip44_encrypt")
166 // to control the result in your application in case you are not waiting the result before sending another intent 197 // to control the result in your application in case you are not waiting the result before sending another intent
167 intent.putExtra("id", "some_id") 198 intent.putExtra("id", "some_id")
168 // Send the current logged in user npub 199 // Send the current logged in user pubkey
169 intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) 200 intent.putExtra("current_user", account.keyPair.pubkey)
170 // Send the hex pubKey that will be used for encrypting the data 201 // Send the hex pubkey that will be used for encrypting the data
171 intent.putExtra("pubKey", pubKey) 202 intent.putExtra("pubkey", pubkey)
172 203
173 context.startActivity(intent) 204 context.startActivity(intent)
174 ``` 205 ```
@@ -190,18 +221,18 @@ launcher.launch(intent)
190 intent.putExtra("type", "nip04_decrypt") 221 intent.putExtra("type", "nip04_decrypt")
191 // to control the result in your application in case you are not waiting the result before sending another intent 222 // to control the result in your application in case you are not waiting the result before sending another intent
192 intent.putExtra("id", "some_id") 223 intent.putExtra("id", "some_id")
193 // Send the current logged in user npub 224 // Send the current logged in user pubkey
194 intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) 225 intent.putExtra("current_user", account.keyPair.pubkey)
195 // Send the hex pubKey that will be used for decrypting the data 226 // Send the hex pubkey that will be used for decrypting the data
196 intent.putExtra("pubKey", pubKey) 227 intent.putExtra("pubkey", pubkey)
197 228
198 context.startActivity(intent) 229 context.startActivity(intent)
199 ``` 230 ```
200 - result: 231 - result:
201 - If the user approved intent it will return the **signature** and **id** fields 232 - If the user approved intent it will return the **result** and **id** fields
202 233
203 ```kotlin 234 ```kotlin
204 val plainText = intent.data?.getStringExtra("signature") 235 val plainText = intent.data?.getStringExtra("result")
205 // the id you sent 236 // the id you sent
206 val id = intent.data?.getStringExtra("id") 237 val id = intent.data?.getStringExtra("id")
207 ``` 238 ```
@@ -215,18 +246,41 @@ launcher.launch(intent)
215 intent.putExtra("type", "nip04_decrypt") 246 intent.putExtra("type", "nip04_decrypt")
216 // to control the result in your application in case you are not waiting the result before sending another intent 247 // to control the result in your application in case you are not waiting the result before sending another intent
217 intent.putExtra("id", "some_id") 248 intent.putExtra("id", "some_id")
218 // Send the current logged in user npub 249 // Send the current logged in user pubkey
219 intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) 250 intent.putExtra("current_user", account.keyPair.pubkey)
220 // Send the hex pubKey that will be used for decrypting the data 251 // Send the hex pubkey that will be used for decrypting the data
221 intent.putExtra("pubKey", pubKey) 252 intent.putExtra("pubkey", pubkey)
222 253
223 context.startActivity(intent) 254 context.startActivity(intent)
224 ``` 255 ```
225 - result: 256 - result:
226 - If the user approved intent it will return the **signature** and **id** fields 257 - If the user approved intent it will return the **result** and **id** fields
227 258
228 ```kotlin 259 ```kotlin
229 val plainText = intent.data?.getStringExtra("signature") 260 val plainText = intent.data?.getStringExtra("result")
261 // the id you sent
262 val id = intent.data?.getStringExtra("id")
263 ```
264
265- **get_relays**
266 - params:
267
268 ```kotlin
269 val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:"))
270 intent.`package` = "com.example.signer"
271 intent.putExtra("type", "get_relays")
272 // to control the result in your application in case you are not waiting the result before sending another intent
273 intent.putExtra("id", "some_id")
274 // Send the current logged in user pubkey
275 intent.putExtra("current_user", account.keyPair.pubkey)
276
277 context.startActivity(intent)
278 ```
279 - result:
280 - If the user approved intent it will return the **result** and **id** fields
281
282 ```kotlin
283 val relayJsonText = intent.data?.getStringExtra("result")
230 // the id you sent 284 // the id you sent
231 val id = intent.data?.getStringExtra("id") 285 val id = intent.data?.getStringExtra("id")
232 ``` 286 ```
@@ -240,15 +294,15 @@ launcher.launch(intent)
240 intent.putExtra("type", "decrypt_zap_event") 294 intent.putExtra("type", "decrypt_zap_event")
241 // to control the result in your application in case you are not waiting the result before sending another intent 295 // to control the result in your application in case you are not waiting the result before sending another intent
242 intent.putExtra("id", "some_id") 296 intent.putExtra("id", "some_id")
243 // Send the current logged in user npub 297 // Send the current logged in user pubkey
244 intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) 298 intent.putExtra("current_user", account.keyPair.pubkey)
245 context.startActivity(intent) 299 context.startActivity(intent)
246 ``` 300 ```
247 - result: 301 - result:
248 - If the user approved intent it will return the **signature** and **id** fields 302 - If the user approved intent it will return the **result** and **id** fields
249 303
250 ```kotlin 304 ```kotlin
251 val eventJson = intent.data?.getStringExtra("signature") 305 val eventJson = intent.data?.getStringExtra("result")
252 // the id you sent 306 // the id you sent
253 val id = intent.data?.getStringExtra("id") 307 val id = intent.data?.getStringExtra("id")
254 ``` 308 ```
@@ -257,11 +311,11 @@ launcher.launch(intent)
257 311
258To get the result back from Signer Application you should use contentResolver.query in Kotlin. If you are using another framework check the documentation of your framework or a third party library to get the result. 312To get the result back from Signer Application you should use contentResolver.query in Kotlin. If you are using another framework check the documentation of your framework or a third party library to get the result.
259 313
260If the user did not check the "remember my choice" option, the npub is not in Signer Application or the signer type is not recognized the `contentResolver` will return null 314If the user did not check the "remember my choice" option, the pubkey is not in Signer Application or the signer type is not recognized the `contentResolver` will return null
261 315
262For the SIGN_EVENT type Signer Application returns two columns "signature" and "event". The column event is the signed event json 316For the SIGN_EVENT type Signer Application returns two columns "result" and "event". The column event is the signed event json
263 317
264For the other types Signer Application returns the column "signature" 318For the other types Signer Application returns the column "result"
265 319
266If the user chose to always reject the event, signer application will return the column "rejected" and you should not open signer application 320If the user chose to always reject the event, signer application will return the column "rejected" and you should not open signer application
267 321
@@ -280,15 +334,15 @@ If the user chose to always reject the event, signer application will return the
280 ) 334 )
281 ``` 335 ```
282 - result: 336 - result:
283 - Will return the **npub** in the signature column 337 - Will return the **pubkey** in the result column
284 338
285 ```kotlin 339 ```kotlin
286 if (result == null) return 340 if (result == null) return
287 341
288 if (result.moveToFirst()) { 342 if (result.moveToFirst()) {
289 val index = it.getColumnIndex("signature") 343 val index = it.getColumnIndex("result")
290 if (index < 0) return 344 if (index < 0) return
291 val npub = it.getString(index) 345 val pubkey = it.getString(index)
292 } 346 }
293 ``` 347 ```
294 348
@@ -298,20 +352,20 @@ If the user chose to always reject the event, signer application will return the
298 ```kotlin 352 ```kotlin
299 val result = context.contentResolver.query( 353 val result = context.contentResolver.query(
300 Uri.parse("content://com.example.signer.SIGN_EVENT"), 354 Uri.parse("content://com.example.signer.SIGN_EVENT"),
301 listOf("$eventJson", "", "${logged_in_user_npub}"), 355 listOf("$eventJson", "", "${logged_in_user_pubkey}"),
302 null, 356 null,
303 null, 357 null,
304 null 358 null
305 ) 359 )
306 ``` 360 ```
307 - result: 361 - result:
308 - Will return the **signature** and the **event** columns 362 - Will return the **result** and the **event** columns
309 363
310 ```kotlin 364 ```kotlin
311 if (result == null) return 365 if (result == null) return
312 366
313 if (result.moveToFirst()) { 367 if (result.moveToFirst()) {
314 val index = it.getColumnIndex("signature") 368 val index = it.getColumnIndex("result")
315 val indexJson = it.getColumnIndex("event") 369 val indexJson = it.getColumnIndex("event")
316 val signature = it.getString(index) 370 val signature = it.getString(index)
317 val eventJson = it.getString(indexJson) 371 val eventJson = it.getString(indexJson)
@@ -324,20 +378,20 @@ If the user chose to always reject the event, signer application will return the
324 ```kotlin 378 ```kotlin
325 val result = context.contentResolver.query( 379 val result = context.contentResolver.query(
326 Uri.parse("content://com.example.signer.NIP04_ENCRYPT"), 380 Uri.parse("content://com.example.signer.NIP04_ENCRYPT"),
327 listOf("$plainText", "${hex_pub_key}", "${logged_in_user_npub}"), 381 listOf("$plainText", "${hex_pub_key}", "${logged_in_user_pubkey}"),
328 null, 382 null,
329 null, 383 null,
330 null 384 null
331 ) 385 )
332 ``` 386 ```
333 - result: 387 - result:
334 - Will return the **signature** column 388 - Will return the **result** column
335 389
336 ```kotlin 390 ```kotlin
337 if (result == null) return 391 if (result == null) return
338 392
339 if (result.moveToFirst()) { 393 if (result.moveToFirst()) {
340 val index = it.getColumnIndex("signature") 394 val index = it.getColumnIndex("result")
341 val encryptedText = it.getString(index) 395 val encryptedText = it.getString(index)
342 } 396 }
343 ``` 397 ```
@@ -348,20 +402,20 @@ If the user chose to always reject the event, signer application will return the
348 ```kotlin 402 ```kotlin
349 val result = context.contentResolver.query( 403 val result = context.contentResolver.query(
350 Uri.parse("content://com.example.signer.NIP44_ENCRYPT"), 404 Uri.parse("content://com.example.signer.NIP44_ENCRYPT"),
351 listOf("$plainText", "${hex_pub_key}", "${logged_in_user_npub}"), 405 listOf("$plainText", "${hex_pub_key}", "${logged_in_user_pubkey}"),
352 null, 406 null,
353 null, 407 null,
354 null 408 null
355 ) 409 )
356 ``` 410 ```
357 - result: 411 - result:
358 - Will return the **signature** column 412 - Will return the **result** column
359 413
360 ```kotlin 414 ```kotlin
361 if (result == null) return 415 if (result == null) return
362 416
363 if (result.moveToFirst()) { 417 if (result.moveToFirst()) {
364 val index = it.getColumnIndex("signature") 418 val index = it.getColumnIndex("result")
365 val encryptedText = it.getString(index) 419 val encryptedText = it.getString(index)
366 } 420 }
367 ``` 421 ```
@@ -372,20 +426,20 @@ If the user chose to always reject the event, signer application will return the
372 ```kotlin 426 ```kotlin
373 val result = context.contentResolver.query( 427 val result = context.contentResolver.query(
374 Uri.parse("content://com.example.signer.NIP04_DECRYPT"), 428 Uri.parse("content://com.example.signer.NIP04_DECRYPT"),
375 listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_npub}"), 429 listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_pubkey}"),
376 null, 430 null,
377 null, 431 null,
378 null 432 null
379 ) 433 )
380 ``` 434 ```
381 - result: 435 - result:
382 - Will return the **signature** column 436 - Will return the **result** column
383 437
384 ```kotlin 438 ```kotlin
385 if (result == null) return 439 if (result == null) return
386 440
387 if (result.moveToFirst()) { 441 if (result.moveToFirst()) {
388 val index = it.getColumnIndex("signature") 442 val index = it.getColumnIndex("result")
389 val encryptedText = it.getString(index) 443 val encryptedText = it.getString(index)
390 } 444 }
391 ``` 445 ```
@@ -396,44 +450,68 @@ If the user chose to always reject the event, signer application will return the
396 ```kotlin 450 ```kotlin
397 val result = context.contentResolver.query( 451 val result = context.contentResolver.query(
398 Uri.parse("content://com.example.signer.NIP44_DECRYPT"), 452 Uri.parse("content://com.example.signer.NIP44_DECRYPT"),
399 listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_npub}"), 453 listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_pubkey}"),
400 null, 454 null,
401 null, 455 null,
402 null 456 null
403 ) 457 )
404 ``` 458 ```
405 - result: 459 - result:
406 - Will return the **signature** column 460 - Will return the **result** column
407 461
408 ```kotlin 462 ```kotlin
409 if (result == null) return 463 if (result == null) return
410 464
411 if (result.moveToFirst()) { 465 if (result.moveToFirst()) {
412 val index = it.getColumnIndex("signature") 466 val index = it.getColumnIndex("result")
413 val encryptedText = it.getString(index) 467 val encryptedText = it.getString(index)
414 } 468 }
415 ``` 469 ```
416 470
471- **get_relays**
472 - params:
473
474 ```kotlin
475 val result = context.contentResolver.query(
476 Uri.parse("content://com.example.signer.GET_RELAYS"),
477 listOf("${logged_in_user_pubkey}"),
478 null,
479 null,
480 null
481 )
482 ```
483 - result:
484 - Will return the **result** column
485
486 ```kotlin
487 if (result == null) return
488
489 if (result.moveToFirst()) {
490 val index = it.getColumnIndex("result")
491 val relayJsonText = it.getString(index)
492 }
493 ```
494
417- **decrypt_zap_event** 495- **decrypt_zap_event**
418 - params: 496 - params:
419 497
420 ```kotlin 498 ```kotlin
421 val result = context.contentResolver.query( 499 val result = context.contentResolver.query(
422 Uri.parse("content://com.example.signer.DECRYPT_ZAP_EVENT"), 500 Uri.parse("content://com.example.signer.DECRYPT_ZAP_EVENT"),
423 listOf("$eventJson", "", "${logged_in_user_npub}"), 501 listOf("$eventJson", "", "${logged_in_user_pubkey}"),
424 null, 502 null,
425 null, 503 null,
426 null 504 null
427 ) 505 )
428 ``` 506 ```
429 - result: 507 - result:
430 - Will return the **signature** column 508 - Will return the **result** column
431 509
432 ```kotlin 510 ```kotlin
433 if (result == null) return 511 if (result == null) return
434 512
435 if (result.moveToFirst()) { 513 if (result.moveToFirst()) {
436 val index = it.getColumnIndex("signature") 514 val index = it.getColumnIndex("result")
437 val eventJson = it.getString(index) 515 val eventJson = it.getString(index)
438 } 516 }
439 ``` 517 ```
@@ -470,28 +548,35 @@ Android intents and browser urls have limitations, so if you are using the `retu
470 - params: 548 - params:
471 549
472 ```js 550 ```js
473 window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_encrypt&callbackUrl=https://example.com/?event=`; 551 window.href = `nostrsigner:${plainText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_encrypt&callbackUrl=https://example.com/?event=`;
474 ``` 552 ```
475 553
476- **nip44_encrypt** 554- **nip44_encrypt**
477 - params: 555 - params:
478 556
479 ```js 557 ```js
480 window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_encrypt&callbackUrl=https://example.com/?event=`; 558 window.href = `nostrsigner:${plainText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_encrypt&callbackUrl=https://example.com/?event=`;
481 ``` 559 ```
482 560
483- **nip04_decrypt** 561- **nip04_decrypt**
484 - params: 562 - params:
485 563
486 ```js 564 ```js
487 window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_decrypt&callbackUrl=https://example.com/?event=`; 565 window.href = `nostrsigner:${encryptedText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_decrypt&callbackUrl=https://example.com/?event=`;
488 ``` 566 ```
489 567
490- **nip44_decrypt** 568- **nip44_decrypt**
491 - params: 569 - params:
492 570
493 ```js 571 ```js
494 window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_decrypt&callbackUrl=https://example.com/?event=`; 572 window.href = `nostrsigner:${encryptedText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_decrypt&callbackUrl=https://example.com/?event=`;
573 ```
574
575- **get_relays**
576 - params:
577
578 ```js
579 window.href = `nostrsigner:?compressionType=none&returnType=signature&type=get_relays&callbackUrl=https://example.com/?event=`;
495 ``` 580 ```
496 581
497- **decrypt_zap_event** 582- **decrypt_zap_event**
diff --git a/56.md b/56.md
index fc8d898..f7b1b1a 100644
--- a/56.md
+++ b/56.md
@@ -41,7 +41,7 @@ further qualification and querying.
41Example events 41Example events
42-------------- 42--------------
43 43
44```json 44```jsonc
45{ 45{
46 "kind": 1984, 46 "kind": 1984,
47 "tags": [ 47 "tags": [
@@ -50,9 +50,11 @@ Example events
50 ["l", "NS-nud", "social.nos.ontology"] 50 ["l", "NS-nud", "social.nos.ontology"]
51 ], 51 ],
52 "content": "", 52 "content": "",
53 ... 53 // other fields...
54} 54}
55```
55 56
57```jsonc
56{ 58{
57 "kind": 1984, 59 "kind": 1984,
58 "tags": [ 60 "tags": [
@@ -60,16 +62,18 @@ Example events
60 ["p", <pubkey>] 62 ["p", <pubkey>]
61 ], 63 ],
62 "content": "He's insulting the king!", 64 "content": "He's insulting the king!",
63 ... 65 // other fields...
64} 66}
67```
65 68
69```jsonc
66{ 70{
67 "kind": 1984, 71 "kind": 1984,
68 "tags": [ 72 "tags": [
69 ["p", <impersonator pubkey>, "impersonation"] 73 ["p", <impersonator pubkey>, "impersonation"]
70 ], 74 ],
71 "content": "Profile is impersonating nostr:<victim bech32 pubkey>", 75 "content": "Profile is impersonating nostr:<victim bech32 pubkey>",
72 ... 76 // other fields...
73} 77}
74``` 78```
75 79
diff --git a/57.md b/57.md
index d04eeff..3f55e57 100644
--- a/57.md
+++ b/57.md
@@ -36,7 +36,7 @@ A `zap request` is an event of kind `9734` that is _not_ published to relays, bu
36In addition, the event MAY include the following tags: 36In addition, the event MAY include the following tags:
37 37
38- `e` is an optional hex-encoded event id. Clients MUST include this if zapping an event rather than a person. 38- `e` is an optional hex-encoded event id. Clients MUST include this if zapping an event rather than a person.
39- `a` is an optional event coordinate that allows tipping parameterized replaceable events such as NIP-23 long-form notes. 39- `a` is an optional event coordinate that allows tipping addressable events such as NIP-23 long-form notes.
40 40
41Example: 41Example:
42 42
@@ -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 in javascript: 69This request should return a JSON response with a `pr` key, which is the invoice the sender must pay to finalize their 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
@@ -171,7 +171,7 @@ A client can retrieve `zap receipt`s on events and pubkeys using a NIP-01 filter
171 171
172When an event includes one or more `zap` tags, clients wishing to zap it SHOULD calculate the lnurl pay request based on the tags value instead of the event author's profile field. The tag's second argument is the `hex` string of the receiver's pub key and the third argument is the relay to download the receiver's metadata (Kind-0). An optional fourth parameter specifies the weight (a generalization of a percentage) assigned to the respective receiver. Clients should parse all weights, calculate a sum, and then a percentage to each receiver. If weights are not present, CLIENTS should equally divide the zap amount to all receivers. If weights are only partially present, receivers without a weight should not be zapped (`weight = 0`). 172When an event includes one or more `zap` tags, clients wishing to zap it SHOULD calculate the lnurl pay request based on the tags value instead of the event author's profile field. The tag's second argument is the `hex` string of the receiver's pub key and the third argument is the relay to download the receiver's metadata (Kind-0). An optional fourth parameter specifies the weight (a generalization of a percentage) assigned to the respective receiver. Clients should parse all weights, calculate a sum, and then a percentage to each receiver. If weights are not present, CLIENTS should equally divide the zap amount to all receivers. If weights are only partially present, receivers without a weight should not be zapped (`weight = 0`).
173 173
174```js 174```jsonc
175{ 175{
176 "tags": [ 176 "tags": [
177 [ "zap", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2", "wss://nostr.oxtr.dev", "1" ], // 25% 177 [ "zap", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2", "wss://nostr.oxtr.dev", "1" ], // 25%
diff --git a/58.md b/58.md
index 4a9ed4c..23921bd 100644
--- a/58.md
+++ b/58.md
@@ -9,12 +9,11 @@ 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 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. 121. A "Badge Definition" event is defined as an addressable 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.
13 13
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. 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.
15 15
163. A "Profile Badges" event is defined as a parameterized replaceable event 163. A "Profile Badges" event is defined as an _addressable event_ with kind `30008` with a `d` tag with the value `profile_badges`.
17with kind `30008` with a `d` tag with the value `profile_badges`.
18Profile badges contain an ordered list of pairs of `a` and `e` tags referencing a `Badge Definition` and a `Badge Award` for each badge to be displayed. 17Profile badges contain an ordered list of pairs of `a` and `e` tags referencing a `Badge Definition` and a `Badge Award` for each badge to be displayed.
19 18
20### Badge Definition event 19### Badge Definition event
@@ -74,7 +73,7 @@ Clients SHOULD attempt to render the most appropriate badge thumbnail according
74 73
75### Example of a Badge Definition event 74### Example of a Badge Definition event
76 75
77```json 76```jsonc
78{ 77{
79 "pubkey": "alice", 78 "pubkey": "alice",
80 "kind": 30009, 79 "kind": 30009,
@@ -85,13 +84,13 @@ Clients SHOULD attempt to render the most appropriate badge thumbnail according
85 ["image", "https://nostr.academy/awards/bravery.png", "1024x1024"], 84 ["image", "https://nostr.academy/awards/bravery.png", "1024x1024"],
86 ["thumb", "https://nostr.academy/awards/bravery_256x256.png", "256x256"] 85 ["thumb", "https://nostr.academy/awards/bravery_256x256.png", "256x256"]
87 ], 86 ],
88 ... 87 // other fields...
89} 88}
90``` 89```
91 90
92### Example of Badge Award event 91### Example of Badge Award event
93 92
94```json 93```jsonc
95{ 94{
96 "id": "<badge award event id>", 95 "id": "<badge award event id>",
97 "kind": 8, 96 "kind": 8,
@@ -101,14 +100,14 @@ Clients SHOULD attempt to render the most appropriate badge thumbnail according
101 ["p", "bob", "wss://relay"], 100 ["p", "bob", "wss://relay"],
102 ["p", "charlie", "wss://relay"] 101 ["p", "charlie", "wss://relay"]
103 ], 102 ],
104 ... 103 // other fields...
105} 104}
106``` 105```
107 106
108### Example of a Profile Badges event 107### Example of a Profile Badges event
109 108
110Honorable Bob The Brave: 109Honorable Bob The Brave:
111```json 110```jsonc
112{ 111{
113 "kind": 30008, 112 "kind": 30008,
114 "pubkey": "bob", 113 "pubkey": "bob",
@@ -119,6 +118,6 @@ Honorable Bob The Brave:
119 ["a", "30009:alice:honor"], 118 ["a", "30009:alice:honor"],
120 ["e", "<honor badge award event id>", "wss://nostr.academy"] 119 ["e", "<honor badge award event id>", "wss://nostr.academy"]
121 ], 120 ],
122 ... 121 // other fields...
123} 122}
124``` 123```
diff --git a/59.md b/59.md
index 4dc857f..9bb5845 100644
--- a/59.md
+++ b/59.md
@@ -41,7 +41,7 @@ A `seal` is a `kind:13` event that wraps a `rumor` with the sender's regular key
41to a receiver's pubkey but there is no `p` tag pointing to the receiver. There is no way to know who the rumor is for 41to a receiver's pubkey but there is no `p` tag pointing to the receiver. There is no way to know who the rumor is for
42without the receiver's or the sender's private key. The only public information in this event is who is signing it. 42without the receiver's or the sender's private key. The only public information in this event is who is signing it.
43 43
44```js 44```json
45{ 45{
46 "id": "<id>", 46 "id": "<id>",
47 "pubkey": "<real author's pubkey>", 47 "pubkey": "<real author's pubkey>",
@@ -60,7 +60,7 @@ Tags MUST must always be empty in a `kind:13`. The inner event MUST always be un
60A `gift wrap` event is a `kind:1059` event that wraps any other event. `tags` SHOULD include any information 60A `gift wrap` event is a `kind:1059` event that wraps any other event. `tags` SHOULD include any information
61needed to route the event to its intended recipient, including the recipient's `p` tag or [NIP-13](13.md) proof of work. 61needed to route the event to its intended recipient, including the recipient's `p` tag or [NIP-13](13.md) proof of work.
62 62
63```js 63```json
64{ 64{
65 "id": "<id>", 65 "id": "<id>",
66 "pubkey": "<random, one-time-use pubkey>", 66 "pubkey": "<random, one-time-use pubkey>",
@@ -245,7 +245,7 @@ const rumor = createRumor(
245const seal = createSeal(rumor, senderPrivateKey, recipientPublicKey) 245const seal = createSeal(rumor, senderPrivateKey, recipientPublicKey)
246const wrap = createWrap(seal, recipientPublicKey) 246const wrap = createWrap(seal, recipientPublicKey)
247 247
248// Recipient unwraps with his/her private key. 248// Recipient unwraps with their private key.
249 249
250const unwrappedSeal = nip44Decrypt(wrap, recipientPrivateKey) 250const unwrappedSeal = nip44Decrypt(wrap, recipientPrivateKey)
251const unsealedRumor = nip44Decrypt(unwrappedSeal, recipientPrivateKey) 251const unsealedRumor = nip44Decrypt(unwrappedSeal, recipientPrivateKey)
diff --git a/60.md b/60.md
new file mode 100644
index 0000000..64cd282
--- /dev/null
+++ b/60.md
@@ -0,0 +1,205 @@
1# NIP-60
2## Cashu Wallet
3`draft` `optional`
4
5This NIP defines the operations of a cashu-based wallet.
6
7A cashu wallet is a wallet which information is stored in relays to make it accessible across applications.
8
9The purpose of this NIP is:
10* ease-of-use: new users immediately are able to receive funds without creating accounts with other services.
11* interoperability: users' wallets follows them across applications.
12
13This NIP doesn't deal with users' *receiving* money from someone else, it's just to keep state of the user's wallet.
14
15# High-level flow
161. A user has a `kind:37375` event that represents a wallet.
172. A user has `kind:7375` events that represent the unspent proofs of the wallet. -- The proofs are encrypted with the user's private key.
183. A user has `kind:7376` events that represent the spending history of the wallet -- This history is for informational purposes only and is completely optional.
19
20## Wallet Event
21```jsonc
22{
23 "kind": 37375,
24 "content": nip44_encrypt([
25 [ "balance", "100", "sat" ],
26 [ "privkey", "hexkey" ] // explained in NIP-61
27 ]),
28 "tags": [
29 [ "d", "my-wallet" ],
30 [ "mint", "https://mint1" ],
31 [ "mint", "https://mint2" ],
32 [ "mint", "https://mint3" ],
33 [ "name", "my shitposting wallet" ],
34 [ "unit", "sat" ],
35 [ "description", "a wallet for my day-to-day shitposting" ],
36 [ "relay", "wss://relay1" ],
37 [ "relay", "wss://relay2" ],
38 ]
39}
40```
41
42The wallet event is a parameterized replaceable event `kind:37375`.
43
44Tags:
45* `d` - wallet ID.
46* `mint` - Mint(s) this wallet uses -- there MUST be one or more mint tags.
47* `relay` - Relays where the wallet and related events can be found. -- one ore more relays SHOULD be specified. If missing, clients should follow [[NIP-65]].
48* `unit` - Base unit of the wallet (e.g. "sat", "usd", etc).
49* `name` - Optional human-readable name for the wallet.
50* `description` - Optional human-readable description of the wallet.
51* `balance` - Optional best-effort balance of the wallet that can serve as a placeholder while an accurate balance is computed from fetching all unspent proofs.
52* `privkey` - Private key used to unlock P2PK ecash. MUST be stored encrypted in the `.content` field. **This is a different private key exclusively used for the wallet, not associated in any way to the user's nostr private key** -- This is only used when receiving funds from others, described in NIP-61.
53
54Any tag, other than the `d` tag, can be [[NIP-44]] encrypted into the `.content` field.
55
56### Deleting a wallet event
57Due to PRE being hard to delete, if a user wants to delete a wallet, they should empty the event and keep just the `d` identifier and add a `deleted` tag.
58
59## Token Event
60Token events are used to record the unspent proofs that come from the mint.
61
62There can be multiple `kind:7375` events for the same mint, and multiple proofs inside each `kind:7375` event.
63
64```jsonc
65{
66 "kind": 7375,
67 "content": nip44_encrypt({
68 "mint": "https://stablenut.umint.cash",
69 "proofs": [
70 {
71 "id": "005c2502034d4f12",
72 "amount": 1,
73 "secret": "z+zyxAVLRqN9lEjxuNPSyRJzEstbl69Jc1vtimvtkPg=",
74 "C": "0241d98a8197ef238a192d47edf191a9de78b657308937b4f7dd0aa53beae72c46"
75 }
76 ]
77 }),
78 "tags": [
79 [ "a", "37375:<pubkey>:my-wallet" ]
80 ]
81}
82```
83
84`.content` is a [[NIP-44]] encrypted payload storing the mint and the unencoded proofs.
85* `a` an optional tag linking the token to a specific wallet.
86
87### Spending proofs
88When one or more proofs of a token are spent, the token event should be [[NIP-09]]-deleted and, if some proofs are unspent from the same token event, a new token event should be created rolling over the unspent proofs and adding any change outputs to the new token event.
89
90## Spending History Event
91Clients SHOULD publish `kind:7376` events to create a transaction history when their balance changes.
92
93```jsonc
94{
95 "kind": 7376,
96 "content": nip44_encrypt([
97 [ "direction", "in" ], // in = received, out = sent
98 [ "amount", "1", "sat" ],
99 [ "e", "<event-id-of-spent-token>", "<relay-hint>", "created" ],
100 ]),
101 "tags": [
102 [ "a", "37375:<pubkey>:my-wallet" ],
103 ]
104}
105```
106
107* `direction` - The direction of the transaction; `in` for received funds, `out` for sent funds.
108* `a` - The wallet the transaction is related to.
109
110Clients MUST add `e` tags to create references of destroyed and created token events along with the marker of the meaning of the tag:
111* `created` - A new token event was created.
112* `destroyed` - A token event was destroyed.
113* `redeemed` - A [[NIP-61]] nutzap was redeemed.
114
115All tags can be [[NIP-44]] encrypted. Clients SHOULD leave `e` tags with a `redeemed` marker unencrypted.
116
117Multiple `e` tags can be added to a `kind:7376` event.
118
119# Flow
120A client that wants to check for user's wallets information starts by fetching `kind:10019` events from the user's relays, if no event is found, it should fall back to using the user's [[NIP-65]] relays.
121
122## Fetch wallet and token list
123From those relays, the client should fetch wallet and token events.
124
125`"kinds": [37375, 7375], "authors": ["<my-pubkey>"]`
126
127## Fetch proofs
128While the client is fetching (and perhaps validating) proofs it can use the optional `balance` tag of the wallet event to display a estimate of the balance of the wallet.
129
130## Spending token
131If Alice spends 4 sats from this token event
132```jsonconc
133{
134 "kind": 7375,
135 "id": "event-id-1",
136 "content": nip44_encrypt({
137 "mint": "https://stablenut.umint.cash",
138 "proofs": [
139 { "id": "1", "amount": 1 },
140 { "id": "2", "amount": 2 },
141 { "id": "3", "amount": 4 },
142 { "id": "4", "amount": 8 },
143 ]
144 }),
145 "tags": [
146 [ "a", "37375:<pubkey>:my-wallet" ]
147 ]
148}
149```
150
151Her client:
152* MUST roll over the unspent proofs:
153```jsonconc
154{
155 "kind": 7375,
156 "id": "event-id-2",
157 "content": nip44_encrypt({
158 "mint": "https://stablenut.umint.cash",
159 "proofs": [
160 { "id": "1", "amount": 1 },
161 { "id": "2", "amount": 2 },
162 { "id": "4", "amount": 8 },
163 ]
164 }),
165 "tags": [
166 [ "a", "37375:<pubkey>:my-wallet" ]
167 ]
168}
169```
170* MUST delete event `event-id-1`
171* SHOULD create a `kind:7376` event to record the spend
172```jsonconc
173{
174 "kind": 7376,
175 "content": nip44_encrypt([
176 [ "direction", "out" ],
177 [ "amount", "4", "sats" ],
178 [ "e", "<event-id-1>", "<relay-hint>", "destroyed" ],
179 [ "e", "<event-id-2>", "<relay-hint>", "created" ],
180 ]),
181 "tags": [
182 [ "a", "37375:<pubkey>:my-wallet" ],
183 ]
184}
185```
186
187## Redeeming a quote (optional)
188When creating a quote at a mint, an event can be used to keep the state of the quote ID, which will be used to check when the quote has been paid. These events should be created with an expiration tag [[NIP-40]] matching the expiration of the bolt11 received from the mint; this signals to relays when they can safely discard these events.
189
190Application developers are encouraged to use local state when possible and only publish this event when it makes sense in the context of their application.
191
192```jsonc
193{
194 "kind": 7374,
195 "content": nip44_encrypt("quote-id"),
196 "tags": [
197 [ "expiration", "<expiration-timestamp>" ],
198 [ "mint", "<mint-url>" ],
199 [ "a", "37375:<pubkey>:my-wallet" ]
200 ]
201}
202```
203
204## Appendix 1: Validating proofs
205Clients can optionally validate proofs to make sure they are not working from an old state; this logic is left up to particular implementations to decide when and why to do it, but if some proofs are checked and deemed to have been spent, the client should delete the token and roll over any unspent proof.
diff --git a/61.md b/61.md
new file mode 100644
index 0000000..33442a3
--- /dev/null
+++ b/61.md
@@ -0,0 +1,132 @@
1# NIP-61:
2## Nut Zaps
3
4A Nut Zap is a P2PK cashu token where the payment itself is the receipt.
5
6# High-level flow
7Alice wants to nutzap 1 sat to Bob because of an event `event-id-1` she liked.
8
9## Alice nutzaps Bob
101. Alice fetches event `kind:10019` from Bob to see the mints Bob trusts.
112. She mints a token at that mint (or swaps some tokens she already had in that mint) p2pk-locked to the pubkey Bob has listed in his `kind:10019`.
123. She publishes a `kind:9321` event to the relays Bob indicated with the proofs she minted.
13
14## Bob receives the nutzap
151. At some point, Bob's client fetches `kind:9321` events p-tagging him from his relays.
162. Bob's client swaps the token into his wallet.
17
18# Nutzap informational event
19```jsonc
20{
21 "kind": 10019,
22 "tags": [
23 [ "relay", "wss://relay1" ],
24 [ "relay", "wss://relay2" ],
25 [ "mint", "https://mint1", "usd", "sat" ],
26 [ "mint", "https://mint2", "sat" ],
27 [ "pubkey", "<p2pk-pubkey>" ]
28 ]
29}
30```
31
32`kind:10019` is an event that is useful for others to know how to send money to the user.
33
34* `relay` - Relays where the user will be reading token events from. If a user wants to send money to the user, they should write to these relays.
35* `mint` - Mints the user is explicitly agreeing to use to receive funds on. Clients SHOULD not send money on mints not listed here or risk burning their money. Additional markers can be used to list the supported base units of the mint.
36* `pubkey` - Pubkey that SHOULD be used to P2PK-lock receiving nutzaps. If not present, clients SHOULD use the pubkey of the recipient. This is explained in Appendix 1.
37
38## Nutzap event
39Event `kind:9321` is a nutzap event published by the sender, p-tagging the recipient. The outputs are P2PK-locked to the pubkey the recipient indicated in their `kind:10019` event or to the recipient pubkey if the `kind:10019` event doesn't have a explicit pubkey.
40
41Clients MUST prefix the pubkey they p2pk-lock with `"02"` (for nostr<>cashu pubkey compatibility).
42
43```jsonc
44{
45 kind: 9321,
46 content: "Thanks for this great idea.",
47 pubkey: "sender-pubkey",
48 tags: [
49 [ "amount", "1" ],
50 [ "unit", "sat" ],
51 [ "proof", "{\"amount\":1,\"C\":\"02277c66191736eb72fce9d975d08e3191f8f96afb73ab1eec37e4465683066d3f\",\"id\":\"000a93d6f8a1d2c4\",\"secret\":\"[\\\"P2PK\\\",{\\\"nonce\\\":\\\"b00bdd0467b0090a25bdf2d2f0d45ac4e355c482c1418350f273a04fedaaee83\\\",\\\"data\\\":\\\"02eaee8939e3565e48cc62967e2fde9d8e2a4b3ec0081f29eceff5c64ef10ac1ed\\\"}]\"}" ],
52 [ "u", "https://stablenut.umint.cash", ],
53 [ "e", "<zapped-event-id>", "<relay-hint>" ],
54 [ "p", "e9fbced3a42dcf551486650cc752ab354347dd413b307484e4fd1818ab53f991" ], // recipient of nut zap
55 ]
56}
57```
58
59* `.content` is an optional comment for the nutzap
60* `amount` is a shorthand for the combined amount of all outputs. -- Clients SHOULD validate that the sum of the amounts in the outputs matches.
61* `unit` is the base unit of the amount.
62* `proof` is one ore more proofs p2pk-locked to the pubkey the recipient specified in their `kind:10019` event.
63* `u` is the mint the URL of the mint EXACTLY as specified by the recipient's `kind:10019`.
64* `e` zero or one event that is being nutzapped.
65* `p` exactly one pubkey, specifying the recipient of the nutzap.
66
67WIP: Clients SHOULD embed a DLEQ proof in the nutzap event to make it possible to verify nutzaps without talking to the mint.
68
69# Sending a nutzap
70
71* The sender fetches the recipient's `kind:10019`.
72* The sender mints/swaps ecash on one of the recipient's listed mints.
73* The sender p2pk locks to the recipient's specified pubkey in their
74
75# Receiving nutzaps
76
77Clients should REQ for nut zaps:
78* Filtering with `#u` for mints they expect to receive ecash from.
79 * this is to prevent even interacting with mints the user hasn't explicitly signaled.
80* Filtering with `since` of the most recent `kind:7376` event the same user has created.
81 * this can be used as a marker of the nut zaps that have already been swaped by the user -- clients might choose to use other kinds of markers, including internal state -- this is just a guidance of one possible approach.
82
83Clients MIGHT choose to use some kind of filtering (e.g. WoT) to ignore spam.
84
85`{ "kinds": [9321], "#p": "my-pubkey", "#u": [ "<mint-1>", "<mint-2>"], "since": <latest-created_at-of-kind-7376> }`.
86
87Upon receiving a new nut zap, the client should swap the tokens into a wallet the user controls, either a [[NIP-60]] wallet, their own LN wallet or anything else.
88
89## Updating nutzap-redemption history
90When claiming a token the client SHOULD create a `kind:7376` event and `e` tag the original nut zap event. This is to record that this token has already been claimed (and shouldn't be attempted again) and as signaling to the recipient that the ecash has been redeemed.
91
92Multiple `kind:9321` events can be tagged in the same `kind:7376` event.
93
94```jsonc
95{
96 "kind": 7376,
97 "content": nip44_encrypt([
98 [ "direction", "in" ], // in = received, out = sent
99 [ "amount", "1", "sat" ],
100 [ "e", "<7375-event-id>", "relay-hint", "created" ] // new token event that was created
101 ]),
102 "tags": [
103 [ "a", "37375:<pubkey>:my-wallet" ], // an optional wallet tag
104 [ "e", "<9321-event-id>", "relay-hint", "redeemed" ], // nutzap event that has been redeemed
105 [ "p", "sender-pubkey" ] // pubkey of the author of the 9321 event (nutzap sender)
106 ]
107}
108```
109
110Events that redeem a nutzap SHOULD be published to the sender's [[NIP-65]] relays.
111
112## Verifying a Cashu Zap
113* Clients SHOULD check that the receiving user has issued a `kind:10019` tagging the mint where the cashu has been minted.
114* Clients SHOULD check that the token is locked to the pubkey the user has listed in their `kind:10019`.
115
116## Final Considerations
117
1181. Clients SHOULD guide their users to use NUT-11 (P2PK) compatible-mints in their `kind:10019` event to avoid receiving nut zaps anyone can spend
119
1202. Clients SHOULD normalize and deduplicate mint URLs as described in NIP-65.
121
1223. A nut zap MUST be sent to a mint the recipient has listed in their `kind:10019` event or to the NIP-65 relays of the recipient, failure to do so may result in the recipient donating the tokens to the mint since the recipient might never see the event.
123
124## Appendix 1: Alternative P2PK pubkey
125Clients might not have access to the user's private key (i.e. NIP-07, NIP-46 signing) and, as such, the private key to sign cashu spends might not be available, which would make spending the P2PK incoming nutzaps impossible.
126
127For this scenarios clients can:
128
129* add a `pubkey` tag to the `kind:10019` (indicating which pubkey senders should P2PK to)
130* store the private key in the `kind:37375` event in the nip44-encrypted `content` field.
131
132This is to avoid depending on NIP-07/46 adaptations to sign cashu payloads. \ No newline at end of file
diff --git a/64.md b/64.md
new file mode 100644
index 0000000..616c5d6
--- /dev/null
+++ b/64.md
@@ -0,0 +1,146 @@
1NIP-64
2======
3
4Chess (Portable Game Notation)
5------------------------------
6
7`draft` `optional`
8
9This NIP defines `kind:64` notes representing chess games in [PGN][pgn_specification] format, which can be read by humans and is also supported by most chess software.
10
11## Note
12
13### Content
14
15The `.content` of these notes is a string representing a [PGN-database][pgn_formal_syntax].
16
17### Notes
18
19```jsonc
20{
21 "kind": 64,
22 "content": "1. e4 *",
23 // other fields...
24}
25```
26
27```jsonc
28{
29 "kind": 64,
30 "tags": [
31 ["alt", "Fischer vs. Spassky in Belgrade on 1992-11-04 (F/S Return Match, Round 29)"],
32 // rest of tags...
33 ],
34 "content": "[Event \"F/S Return Match\"]\n[Site \"Belgrade, Serbia JUG\"]\n[Date \"1992.11.04\"]\n[Round \"29\"]\n[White \"Fischer, Robert J.\"]\n[Black \"Spassky, Boris V.\"]\n[Result \"1/2-1/2\"]\n\n1. e4 e5 2. Nf3 Nc6 3. Bb5 {This opening is called the Ruy Lopez.} 3... a6\n4. Ba4 Nf6 5. O-O Be7 6. Re1 b5 7. Bb3 d6 8. c3 O-O 9. h3 Nb8 10. d4 Nbd7\n11. c4 c6 12. cxb5 axb5 13. Nc3 Bb7 14. Bg5 b4 15. Nb1 h6 16. Bh4 c5 17. dxe5\nNxe4 18. Bxe7 Qxe7 19. exd6 Qf6 20. Nbd2 Nxd6 21. Nc4 Nxc4 22. Bxc4 Nb6\n23. Ne5 Rae8 24. Bxf7+ Rxf7 25. Nxf7 Rxe1+ 26. Qxe1 Kxf7 27. Qe3 Qg5 28. Qxg5\nhxg5 29. b3 Ke6 30. a3 Kd6 31. axb4 cxb4 32. Ra5 Nd5 33. f3 Bc8 34. Kf2 Bf5\n35. Ra7 g6 36. Ra6+ Kc5 37. Ke1 Nf4 38. g3 Nxh3 39. Kd2 Kb5 40. Rd6 Kc5 41. Ra6\nNf2 42. g4 Bd3 43. Re6 1/2-1/2",
35 // other fields...
36}
37```
38
39## Client Behavior
40
41Clients SHOULD display the content represented as chessboard.
42
43Clients SHOULD publish PGN notes in ["export format"][pgn_export_format] ("strict mode", i.e. created by machines) but expect incoming notes to be in ["import format"][pgn_import_format] ("lax mode", i.e. created by humans).
44
45Clients SHOULD check whether the formatting is valid and all moves comply with chess rules.
46
47Clients MAY include additional tags (e.g. like [`"alt"`](https://github.com/nostr-protocol/nips/blob/master/31.md)) in order to represent the note to users of non-supporting clients.
48
49## Relay Behavior
50
51Relays MAY validate PGN contents and reject invalid notes.
52
53
54## Examples
55
56```pgn
57// A game where nothing is known. Game still in progress, game abandoned, or result otherwise unknown.
58// Maybe players died before a move has been made.
59*
60```
61
62```pgn
631. e4 *
64```
65
66```pgn
67[White "Fischer, Robert J."]
68[Black "Spassky, Boris V."]
69
701. e4 e5 2. Nf3 Nc6 3. Bb5 {This opening is called the Ruy Lopez.} *
71```
72
73```pgn
74[Event "F/S Return Match"]
75[Site "Belgrade, Serbia JUG"]
76[Date "1992.11.04"]
77[Round "29"]
78[White "Fischer, Robert J."]
79[Black "Spassky, Boris V."]
80[Result "1/2-1/2"]
81
821. e4 e5 2. Nf3 Nc6 3. Bb5 {This opening is called the Ruy Lopez.} 3... a6
834. Ba4 Nf6 5. O-O Be7 6. Re1 b5 7. Bb3 d6 8. c3 O-O 9. h3 Nb8 10. d4 Nbd7
8411. c4 c6 12. cxb5 axb5 13. Nc3 Bb7 14. Bg5 b4 15. Nb1 h6 16. Bh4 c5 17. dxe5
85Nxe4 18. Bxe7 Qxe7 19. exd6 Qf6 20. Nbd2 Nxd6 21. Nc4 Nxc4 22. Bxc4 Nb6
8623. Ne5 Rae8 24. Bxf7+ Rxf7 25. Nxf7 Rxe1+ 26. Qxe1 Kxf7 27. Qe3 Qg5 28. Qxg5
87hxg5 29. b3 Ke6 30. a3 Kd6 31. axb4 cxb4 32. Ra5 Nd5 33. f3 Bc8 34. Kf2 Bf5
8835. Ra7 g6 36. Ra6+ Kc5 37. Ke1 Nf4 38. g3 Nxh3 39. Kd2 Kb5 40. Rd6 Kc5 41. Ra6
89Nf2 42. g4 Bd3 43. Re6 1/2-1/2
90```
91
92```pgn
93[Event "Hourly HyperBullet Arena"]
94[Site "https://lichess.org/wxx4GldJ"]
95[Date "2017.04.01"]
96[White "T_LUKE"]
97[Black "decidement"]
98[Result "1-0"]
99[UTCDate "2017.04.01"]
100[UTCTime "11:56:14"]
101[WhiteElo "2047"]
102[BlackElo "1984"]
103[WhiteRatingDiff "+10"]
104[BlackRatingDiff "-7"]
105[Variant "Standard"]
106[TimeControl "30+0"]
107[ECO "B00"]
108[Termination "Abandoned"]
109
1101. e4 1-0
111
112
113[Event "Hourly HyperBullet Arena"]
114[Site "https://lichess.org/rospUdSk"]
115[Date "2017.04.01"]
116[White "Bastel"]
117[Black "oslochess"]
118[Result "1-0"]
119[UTCDate "2017.04.01"]
120[UTCTime "11:55:56"]
121[WhiteElo "2212"]
122[BlackElo "2000"]
123[WhiteRatingDiff "+6"]
124[BlackRatingDiff "-4"]
125[Variant "Standard"]
126[TimeControl "30+0"]
127[ECO "A01"]
128[Termination "Normal"]
129
1301. b3 d5 2. Bb2 c6 3. Nc3 Bf5 4. d4 Nf6 5. e3 Nbd7 6. f4 Bg6 7. Nf3 Bh5 8. Bd3 e6 9. O-O Be7 10. Qe1 O-O 11. Ne5 Bg6 12. Nxg6 hxg6 13. e4 dxe4 14. Nxe4 Nxe4 15. Bxe4 Nf6 16. c4 Bd6 17. Bc2 Qc7 18. f5 Be7 19. fxe6 fxe6 20. Qxe6+ Kh8 21. Qh3+ Kg8 22. Bxg6 Qd7 23. Qe3 Bd6 24. Bf5 Qe7 25. Be6+ Kh8 26. Qh3+ Nh7 27. Bf5 Rf6 28. Qxh7# 1-0
131```
132
133## Resources
134- [PGN Specification][pgn_specification]: PGN (Portable Game Notation) specification
135- [PGN Specification Supplement](https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-spec-supplement.md): Addition for adding graphical elements, clock values, eval, ...
136- [PGN Formal Syntax][pgn_formal_syntax]
137- [PGN Seven Tag Roster][pgn_seven_tag_roster]
138- [PGN Import Format][pgn_import_format]
139- [PGN Export Format][pgn_export_format]
140- [lichess / pgn-viewer (GitHub)](https://github.com/lichess-org/pgn-viewer): PGN viewer widget, designed to be embedded in content pages
141
142[pgn_specification]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md
143[pgn_formal_syntax]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md#18-formal-syntax
144[pgn_seven_tag_roster]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md#811-seven-tag-roster
145[pgn_import_format]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md#31-import-format-allows-for-manually-prepared-data
146[pgn_export_format]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md#32-export-format-used-for-program-generated-output
diff --git a/65.md b/65.md
index 1a2d7e8..df06de0 100644
--- a/65.md
+++ b/65.md
@@ -12,7 +12,7 @@ The event MUST include a list of `r` tags with relay URIs and a `read` or `write
12 12
13The `.content` is not used. 13The `.content` is not used.
14 14
15```json 15```jsonc
16{ 16{
17 "kind": 10002, 17 "kind": 10002,
18 "tags": [ 18 "tags": [
@@ -22,7 +22,7 @@ The `.content` is not used.
22 ["r", "wss://nostr-relay.example.com", "read"] 22 ["r", "wss://nostr-relay.example.com", "read"]
23 ], 23 ],
24 "content": "", 24 "content": "",
25 ...other fields 25 // other fields...
26} 26}
27``` 27```
28 28
@@ -37,7 +37,7 @@ When seeking events **about** a user, where the user was tagged, Clients SHOULD
37When broadcasting an event, Clients SHOULD: 37When broadcasting an event, Clients SHOULD:
38 38
39- Broadcast the event to the WRITE relays of the author 39- Broadcast the event to the WRITE relays of the author
40- Broadcast the event all READ relays of each tagged user 40- Broadcast the event to all READ relays of each tagged user
41 41
42## Motivation 42## Motivation
43 43
@@ -62,3 +62,7 @@ This NIP allows Clients to connect directly with the most up-to-date relay set f
625. If a relay signals support for this NIP in their [NIP-11](11.md) document that means they're willing to accept kind 10002 events from a broad range of users, not only their paying customers or whitelisted group. 625. If a relay signals support for this NIP in their [NIP-11](11.md) document that means they're willing to accept kind 10002 events from a broad range of users, not only their paying customers or whitelisted group.
63 63
646. Clients SHOULD deduplicate connections by normalizing relay URIs according to [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986#section-6). 646. Clients SHOULD deduplicate connections by normalizing relay URIs according to [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986#section-6).
65
66## Related articles
67- [Outbox model](https://mikedilger.com/gossip-model/)
68- [What is the Outbox Model?](https://habla.news/u/hodlbod@coracle.social/8YjqXm4SKY-TauwjOfLXS)
diff --git a/70.md b/70.md
new file mode 100644
index 0000000..043d5fb
--- /dev/null
+++ b/70.md
@@ -0,0 +1,45 @@
1NIP-70
2======
3
4Protected Events
5----------------
6
7`draft` `optional`
8
9When the `"-"` tag is present, that means the event is "protected".
10
11A protected event is an event that can only be published to relays by its author. This is achieved by relays ensuring that the author is [authenticated](42.md) before publishing their own events or by just rejecting events with `["-"]` outright.
12
13The default behavior of a relay MUST be to reject any event that contains `["-"]`.
14
15Relays that want to accept such events MUST first require that the client perform the [NIP-42](42.md) `AUTH` flow and then check if the authenticated client has the same pubkey as the event being published and only accept the event in that case.
16
17## The tag
18
19The tag is a simple tag with a single item: `["-"]`. It may be added to any event.
20
21## Example flow
22
23- User `79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798` connects to relay `wss://example.com`:
24
25```jsonc
26/* client: */
27["EVENT",{"id":"cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2","pubkey":"79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798","created_at":1707409439,"kind":1,"tags":[["-"]],"content":"hello members of the secret group","sig":"fa163f5cfb75d77d9b6269011872ee22b34fb48d23251e9879bb1e4ccbdd8aaaf4b6dc5f5084a65ef42c52fbcde8f3178bac3ba207de827ec513a6aa39fa684c"}]
28/* relay: */
29["AUTH", "<challenge>"]
30["OK", "cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2", false, "auth-required: this event may only be published by its author"]
31/* client: */
32["AUTH", {}]
33["EVENT",{"id":"cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2","pubkey":"79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798","created_at":1707409439,"kind":1,"tags":[["-"]],"content":"hello members of the secret group","sig":"fa163f5cfb75d77d9b6269011872ee22b34fb48d23251e9879bb1e4ccbdd8aaaf4b6dc5f5084a65ef42c52fbcde8f3178bac3ba207de827ec513a6aa39fa684c"}]
34["OK", "cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2", true, ""]
35```
36
37## Why
38
39There are multiple circumstances in which it would be beneficial to prevent the unlimited spreading of an event through all relays imaginable and restrict some to only a certain demographic or to a semi-closed community relay. Even when the information is public it may make sense to keep it compartimentalized across different relays.
40
41It's also possible to create closed access feeds with this when the publisher has some relationship with the relay and trusts the relay to not release their published events to anyone.
42
43Even though it's ultimately impossible to restrict the spread of information on the internet (for example, one of the members of the closed group may want to take an event intended to be restricted and republish it to other relays), most relays would be happy to not facilitate the acts of these so-called "pirates", in respect to the original decision of the author and therefore gladly reject these republish acts if given the means to.
44
45This NIP gives these authors and relays the means to clearly signal when a given event is not intended to be republished by third parties.
diff --git a/71.md b/71.md
index a811434..5edd7c6 100644
--- a/71.md
+++ b/71.md
@@ -2,11 +2,11 @@ NIP-71
2====== 2======
3 3
4Video Events 4Video Events
5--------------- 5------------
6 6
7`draft` `optional` 7`draft` `optional`
8 8
9This specification defines video events representing a dedicated post of externally hosted content. These video events are _parameterized replaceable_ and deletable per [NIP-09](09.md). 9This specification defines video events representing a dedicated post of externally hosted content. These video events are _addressable_ and delete-requestable per [NIP-09](09.md).
10 10
11Unlike a `kind 1` event with a video attached, Video Events are meant to contain all additional metadata concerning the subject media and to be surfaced in video-specific clients rather than general micro-blogging clients. The thought is for events of this kind to be referenced in a Netflix, YouTube, or TikTok like nostr client where the video itself is at the center of the experience. 11Unlike a `kind 1` event with a video attached, Video Events are meant to contain all additional metadata concerning the subject media and to be surfaced in video-specific clients rather than general micro-blogging clients. The thought is for events of this kind to be referenced in a Netflix, YouTube, or TikTok like nostr client where the video itself is at the center of the experience.
12 12
@@ -16,25 +16,64 @@ There are two types of video events represented by different kinds: horizontal a
16 16
17#### Format 17#### Format
18 18
19The format uses a parameterized replaceable event kind `34235` for horizontal videos and `34236` for vertical videos. 19The format uses an _addressable event_ kind `34235` for horizontal videos and `34236` for vertical videos.
20 20
21The `.content` of these events is a summary or description on the video content. 21The `.content` of these events is a summary or description on the video content.
22 22
23The list of tags are as follows: 23The primary source of video information is the `imeta` tags which is defined in [NIP-92](92.md)
24* `d` (required) universally unique identifier (UUID). Generated by the client creating the video event. 24
25* `url` (required) the url to the video file 25Each `imeta` tag can be used to specify a variant of the video by the `dim` & `m` properties.
26* `m` a string indicating the data type of the file. The [MIME types](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) format must be used, and they should be lowercase. 26
27Example:
28```json
29[
30 ["imeta",
31 "dim 1920x1080",
32 "url https://myvideo.com/1080/12345.mp4",
33 "x 3093509d1e0bc604ff60cb9286f4cd7c781553bc8991937befaacfdc28ec5cdc",
34 "m video/mp4",
35 "image https://myvideo.com/1080/12345.jpg",
36 "image https://myotherserver.com/1080/12345.jpg",
37 "fallback https://myotherserver.com/1080/12345.mp4",
38 "fallback https://andanotherserver.com/1080/12345.mp4",
39 "service nip96",
40 ],
41 ["imeta",
42 "dim 1280x720",
43 "url https://myvideo.com/720/12345.mp4",
44 "x e1d4f808dae475ed32fb23ce52ef8ac82e3cc760702fca10d62d382d2da3697d",
45 "m video/mp4",
46 "image https://myvideo.com/720/12345.jpg",
47 "image https://myotherserver.com/720/12345.jpg",
48 "fallback https://myotherserver.com/720/12345.mp4",
49 "fallback https://andanotherserver.com/720/12345.mp4",
50 "service nip96",
51 ],
52 ["imeta",
53 "dim 1280x720",
54 "url https://myvideo.com/720/12345.m3u8",
55 "x 704e720af2697f5d6a198ad377789d462054b6e8d790f8a3903afbc1e044014f",
56 "m application/x-mpegURL",
57 "image https://myvideo.com/720/12345.jpg",
58 "image https://myotherserver.com/720/12345.jpg",
59 "fallback https://myotherserver.com/720/12345.m3u8",
60 "fallback https://andanotherserver.com/720/12345.m3u8",
61 "service nip96",
62 ],
63]
64```
65
66Where `url` is the primary server url and `fallback` are other servers hosting the same file, both `url` and `fallback` should be weighted equally and clients are recommended to use any of the provided video urls.
67
68The `image` tag contains a preview image (at the same resolution). Multiple `image` tags may be used to specify fallback copies in the same way `fallback` is used for `url`.
69
70Additionally `service nip96` may be included to allow clients to search the authors NIP-96 server list to find the file using the hash.
71
72### Other tags:
27* `title` (required) title of the video 73* `title` (required) title of the video
28* `"published_at"`, for the timestamp in unix seconds (stringified) of the first time the video was published 74* `published_at`, for the timestamp in unix seconds (stringified) of the first time the video was published
29* `x` containing the SHA-256 hexencoded string of the file.
30* `size` (optional) size of file in bytes
31* `dim` (optional) size of file in pixels in the form `<width>x<height>`
32* `duration` (optional) video duration in seconds 75* `duration` (optional) video duration in seconds
33* `magnet` (optional) URI to magnet file
34* `i` (optional) torrent infohash
35* `text-track` (optional, repeated) link to WebVTT file for video, type of supplementary information (captions/subtitles/chapters/metadata), optional language code 76* `text-track` (optional, repeated) link to WebVTT file for video, type of supplementary information (captions/subtitles/chapters/metadata), optional language code
36* `thumb` (optional) url of thumbnail with same aspect ratio
37* `image` (optional) url of preview image with same dimensions
38* `content-warning` (optional) warning about content of NSFW video 77* `content-warning` (optional) warning about content of NSFW video
39* `alt` (optional) description for accessibility 78* `alt` (optional) description for accessibility
40* `segment` (optional, repeated) start timestamp in format `HH:MM:SS.sss`, end timestamp in format `HH:MM:SS.sss`, chapter/segment title, chapter thumbnail-url 79* `segment` (optional, repeated) start timestamp in format `HH:MM:SS.sss`, end timestamp in format `HH:MM:SS.sss`, chapter/segment title, chapter thumbnail-url
@@ -42,7 +81,7 @@ The list of tags are as follows:
42* `p` (optional, repeated) 32-bytes hex pubkey of a participant in the video, optional recommended relay URL 81* `p` (optional, repeated) 32-bytes hex pubkey of a participant in the video, optional recommended relay URL
43* `r` (optional, repeated) references / links to web pages 82* `r` (optional, repeated) references / links to web pages
44 83
45```json 84```jsonc
46{ 85{
47 "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, 86 "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>,
48 "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, 87 "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
@@ -53,19 +92,23 @@ The list of tags are as follows:
53 ["d", "<UUID>"], 92 ["d", "<UUID>"],
54 93
55 ["title", "<title of video>"], 94 ["title", "<title of video>"],
56 ["thumb", "<thumbnail image for video>"],
57 ["published_at", "<unix timestamp>"], 95 ["published_at", "<unix timestamp>"],
58 ["alt", <description>], 96 ["alt", <description>],
59 97
60 // Video Data 98 // Video Data
61 ["url",<string with URI of file>], 99 ["imeta",
62 ["m", <MIME type>], 100 "dim 1920x1080",
63 ["x",<Hash SHA-256>], 101 "url https://myvideo.com/1080/12345.mp4",
64 ["size", <size of file in bytes>], 102 "x 3093509d1e0bc604ff60cb9286f4cd7c781553bc8991937befaacfdc28ec5cdc",
103 "m video/mp4",
104 "image https://myvideo.com/1080/12345.jpg",
105 "image https://myotherserver.com/1080/12345.jpg",
106 "fallback https://myotherserver.com/1080/12345.mp4",
107 "fallback https://andanotherserver.com/1080/12345.mp4",
108 "service nip96",
109 ],
110
65 ["duration", <duration of video in seconds>], 111 ["duration", <duration of video in seconds>],
66 ["dim", <size of file in pixels>],
67 ["magnet",<magnet URI> ],
68 ["i",<torrent infohash>],
69 ["text-track", "<encoded `kind 6000` event>", "<recommended relay urls>"], 112 ["text-track", "<encoded `kind 6000` event>", "<recommended relay urls>"],
70 ["content-warning", "<reason>"], 113 ["content-warning", "<reason>"],
71 ["segment", <start>, <end>, "<title>", "<thumbnail URL>"], 114 ["segment", <start>, <end>, "<title>", "<thumbnail URL>"],
@@ -83,36 +126,4 @@ The list of tags are as follows:
83 ["r", "<url>"] 126 ["r", "<url>"]
84 ] 127 ]
85} 128}
86``` 129``` \ No newline at end of file
87
88## Video View
89
90A video event view is a response to a video event to track a user's view or progress viewing the video.
91
92### Format
93
94The format uses a parameterized replaceable event kind `34237`.
95
96The `.content` of these events is optional and could be a free-form note that acts like a bookmark for the user.
97
98The list of tags are as follows:
99* `a` (required) reference tag to kind `34235` or `34236` video event being viewed
100* `d` (required) same as `a` reference tag value
101* `viewed` (optional, repeated) timestamp of the user's start time in seconds, timestamp of the user's end time in seconds
102
103
104```json
105{
106 "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>,
107 "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>,
108 "created_at": <Unix timestamp in seconds>,
109 "kind": 34237,
110 "content": "<note>",
111 "tags": [
112 ["a", "<34235 | 34236>:<video event author pubkey>:<d-identifier of video event>", "<optional relay url>"],
113 ["e", "<event-id", "<relay-url>"]
114 ["d", "<34235 | 34236>:<video event author pubkey>:<d-identifier of video event>"],
115 ["viewed", <start>, <end>],
116 ]
117}
118```
diff --git a/72.md b/72.md
index 5a8be0a..582410a 100644
--- a/72.md
+++ b/72.md
@@ -6,11 +6,11 @@ Moderated Communities (Reddit Style)
6 6
7`draft` `optional` 7`draft` `optional`
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. Moderators issue an approval event `kind:4550` that links the community with the new post. 9The goal of this NIP is to enable public communities. 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 may issue an approval event `kind:4550`.
10 10
11# Community Definition 11# Community Definition
12 12
13`kind:34550` SHOULD include any field that helps define the community and the set of moderators. `relay` tags MAY be used to describe the preferred relay to download requests and approvals. 13`Kind:34550` SHOULD include any field that helps define the community and the set of moderators. `relay` tags MAY be used to describe the preferred relay to download requests and approvals. A community definition event's `d` tag MAY double as its name, but if a `name` tag is provided, it SHOULD be displayed instead of the `d` tag.
14 14
15```jsonc 15```jsonc
16{ 16{
@@ -18,6 +18,7 @@ The goal of this NIP is to create moderator-approved public communities around a
18 "kind": 34550, 18 "kind": 34550,
19 "tags": [ 19 "tags": [
20 ["d", "<community-d-identifier>"], 20 ["d", "<community-d-identifier>"],
21 ["name", "<Community name>"],
21 ["description", "<Community description>"], 22 ["description", "<Community description>"],
22 ["image", "<Community image url>", "<Width>x<Height>"], 23 ["image", "<Community image url>", "<Width>x<Height>"],
23 24
@@ -34,13 +35,13 @@ The goal of this NIP is to create moderator-approved public communities around a
34 ["relay", "<relay where to send and receive approvals>", "approvals"], 35 ["relay", "<relay where to send and receive approvals>", "approvals"],
35 ["relay", "<relay where to post requests to and fetch approvals from>"] 36 ["relay", "<relay where to post requests to and fetch approvals from>"]
36 ], 37 ],
37 ... 38 // other fields...
38} 39}
39``` 40```
40 41
41# New Post Request 42# Posting to a community
42 43
43Any Nostr event can be submitted to a community by anyone for approval. Clients MUST add the community's `a` tag to the new post event in order to be presented for the moderator's approval. 44Any Nostr event can be posted to a community. Clients MUST add one or more community `a` tags, each with a recommended relay.
44 45
45```jsonc 46```jsonc
46{ 47{
@@ -49,15 +50,19 @@ Any Nostr event can be submitted to a community by anyone for approval. Clients
49 ["a", "34550:<community event author pubkey>:<community-d-identifier>", "<optional-relay-url>"], 50 ["a", "34550:<community event author pubkey>:<community-d-identifier>", "<optional-relay-url>"],
50 ], 51 ],
51 "content": "hello world", 52 "content": "hello world",
52 // ... 53 // other fields...
53} 54}
54``` 55```
55 56
56Community management clients MAY filter all mentions to a given `kind:34550` event and request moderators to approve each submission. Moderators MAY delete his/her approval of a post at any time using event deletions (See [NIP-09](09.md)). 57# Moderation
57 58
58# Post Approval by moderators 59Anyone may issue an approval event to express their opinion that a post is appropriate for a community. Clients MAY choose which approval events to honor, but SHOULD at least use ones published by the group's defined moderators.
59 60
60The post-approval event MUST include `a` tags of the communities the moderator is posting into (one or more), the `e` tag of the post and `p` tag of the author of the post (for approval notifications). The event SHOULD also include the stringified `post request` event inside the `.content` ([NIP-18-style](18.md)) and a `k` tag with the original post's event kind to allow filtering of approved posts by kind. 61An approval event MUST include one or more community `a` tags, an `e` or `a` tag pointing to the post, and the `p` tag of the author of the post (for approval notifications). `a` tag prefixes can be used to disambiguate between community and replaceable event pointers (community `a` tags always begin with `34550`).
62
63The event SHOULD also include the JSON-stringified `post request` event inside the `.content`, and a `k` tag with the original post's event kind to allow filtering of approved posts by kind.
64
65Moderators MAY request deletion of their approval of a post at any time using [NIP-09 event deletion requests](09.md).
61 66
62```jsonc 67```jsonc
63{ 68{
@@ -70,32 +75,22 @@ The post-approval event MUST include `a` tags of the communities the moderator i
70 ["k", "<post-request-kind>"] 75 ["k", "<post-request-kind>"]
71 ], 76 ],
72 "content": "<the full approved event, JSON-encoded>", 77 "content": "<the full approved event, JSON-encoded>",
73 // ... 78 // other fields...
74} 79}
75``` 80```
76 81
77It's recommended that multiple moderators approve posts to avoid deleting them from the community when a moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copy and re-sign of each moderator's approval events to make sure posts don't disappear with moderators. 82It's recommended that multiple moderators approve posts to avoid deleting them from the community when a moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copy and re-sign of each moderator's approval events to make sure posts don't disappear with moderators.
78 83
79Post Approvals of replaceable events can be created in three ways: (i) by tagging the replaceable event as an `e` tag if moderators want to approve each individual change to the replaceable event; (ii) by tagging the replaceable event as an `a` tag if the moderator authorizes the replaceable event author to make changes without additional approvals and (iii) by tagging the replaceable event with both its `e` and `a` tag which empowers clients to display the original and updated versions of the event, with appropriate remarks in the UI. Since relays are instructed to delete old versions of a replaceable event, the `.content` of an `e`-approval MUST have the specific version of the event or Clients might not be able to find that version of the content anywhere. 84Approvals of replaceable events can be created in three ways:
80 85
81Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be included in all `34550:*` `a` tags. 861. By tagging the replaceable event as an `e` tag if moderators want to approve each individual change to the replaceable event
872. By tagging the replaceable event as an `a` tag if the moderator authorizes the replaceable event author to make changes without additional approvals and
883. 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.
82 89
83# Displaying 90Since relays are instructed to delete old versions of a replaceable event, the `content` of an approval using an `e` tag MUST have the specific version of the event or clients might not be able to find that version of the content anywhere.
84 91
85Community clients SHOULD display posts that have been approved by at least 1 moderator or by the community owner. 92Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be approved for all `34550:*` `a` tags.
86 93
87The following filter displays the approved posts. 94# Cross-posting
88
89```json
90[
91 "REQ",
92 "_",
93 {
94 "authors": ["<owner-pubkey>", "<moderator1-pubkey>", "<moderator2-pubkey>", "<moderator3-pubkey>", ...],
95 "kinds": [4550],
96 "#a": ["34550:<Community event author pubkey>:<d-identifier of the community>"],
97 }
98]
99```
100 95
101Clients MAY hide approvals by blocked moderators at the user's request. 96Clients MAY support cross-posting between communities by posting a NIP 18 `kind 6` or `kind 16` repost to one or more communities using `a` tags as described above. The `content` of the repost MUST be the original event, not the approval event.
diff --git a/73.md b/73.md
new file mode 100644
index 0000000..afed8d1
--- /dev/null
+++ b/73.md
@@ -0,0 +1,60 @@
1NIP-73
2======
3
4External Content IDs
5--------------------
6
7`draft` `optional`
8
9There are certain established global content identifiers such as [Book ISBNs](https://en.wikipedia.org/wiki/ISBN), [Podcast GUIDs](https://podcastnamespace.org/tag/guid), and [Movie ISANs](https://en.wikipedia.org/wiki/International_Standard_Audiovisual_Number) that are useful to reference in nostr events so that clients can query all the events assosiated with these ids.
10
11
12`i` tags are used for referencing these external content ids, with `k` tags representing the external content id kind so that clients can query all the events for a specific kind.
13
14## Supported IDs
15
16| Type | `i` tag | `k` tag |
17|- | - | - |
18| URLs | "`<URL, normalized, no fragment>`" | "`<scheme-host, normalized>`" |
19| Hashtags | "#`<topic, lowercase>`" | "#" |
20| Geohashes| "geo:`<geohash, lowercase>`" | "geo" |
21| Books | "isbn:`<id, without hyphens>`" | "isbn" |
22| Podcast Feeds | "podcast:guid:`<guid>`" | "podcast:guid" |
23| Podcast Episodes | "podcast:item:guid:`<guid>`" | "podcast:item:guid" |
24| Podcast Publishers | "podcast:publisher:guid:`<guid>`" | "podcast:publisher:guid" |
25| Movies | "isan:`<id, without version part>`" | "isan" |
26| Papers | "doi:`<id, lowercase>`" | "doi" |
27
28---
29
30## Examples
31
32### Books:
33
34- Book ISBN: `["i", "isbn:9780765382030"]` - https://isbnsearch.org/isbn/9780765382030
35
36Book ISBNs MUST be referenced _**without hyphens**_ as many book search APIs return the ISBNs without hyphens. Removing hypens from ISBNs is trivial, whereas adding the hyphens back in is non-trivial requiring a library.
37
38### Podcasts:
39
40- Podcast RSS Feed GUID: `["i", "podcast:guid:c90e609a-df1e-596a-bd5e-57bcc8aad6cc"]` - https://podcastindex.org/podcast/c90e609a-df1e-596a-bd5e-57bcc8aad6cc
41- Podcast RSS Item GUID: `["i", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f"]`
42- Podcast RSS Publisher GUID: `["i", "podcast:publisher:guid:18bcbf10-6701-4ffb-b255-bc057390d738"]`
43
44### Movies:
45
46- Movie ISAN: `["i", "isan:0000-0000-401A-0000-7"]` - https://web.isan.org/public/en/isan/0000-0000-401A-0000-7
47
48Movie ISANs SHOULD be referenced _**without the version part**_ as the versions / edits of movies are not relevant. More info on ISAN parts here - https://support.isan.org/hc/en-us/articles/360002783131-Records-relations-and-hierarchies-in-the-ISAN-Registry
49
50---
51
52### Optional URL Hints
53
54Each `i` tag MAY have a url hint as the second argument to redirect people to a website if the client isn't opinionated about how to interpret the id:
55
56`["i", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f", https://fountain.fm/episode/z1y9TMQRuqXl2awyrQxg]`
57
58`["i", "isan:0000-0000-401A-0000-7", https://www.imdb.com/title/tt0120737]`
59
60
diff --git a/75.md b/75.md
index c16436a..ad933d5 100644
--- a/75.md
+++ b/75.md
@@ -21,15 +21,16 @@ The following tags are defined as REQUIRED.
21 21
22Example event: 22Example event:
23 23
24```json 24```jsonc
25{ 25{
26 "kind": 9041, 26 "kind": 9041,
27 "tags": [ 27 "tags": [
28 ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", ...], 28 ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", /*...*/],
29 ["amount", "210000"], 29 ["amount", "210000"],
30 ], 30 ],
31 "content": "Nostrasia travel expenses", 31 "content": "Nostrasia travel expenses",
32 ... 32 // other fields...
33}
33``` 34```
34 35
35The following tags are OPTIONAL. 36The following tags are OPTIONAL.
@@ -38,36 +39,35 @@ The following tags are OPTIONAL.
38- `image` - an image for the goal 39- `image` - an image for the goal
39- `summary` - a brief description 40- `summary` - a brief description
40 41
41```json 42```jsonc
42{ 43{
43 "kind": 9041, 44 "kind": 9041,
44 "tags": [ 45 "tags": [
45 ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", ...], 46 ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", /*...*/],
46 ["amount", "210000"], 47 ["amount", "210000"],
47 ["closed_at", "<unix timestamp in seconds>"], 48 ["closed_at", "<unix timestamp in seconds>"],
48 ["image", "<image URL>"], 49 ["image", "<image URL>"],
49 ["summary", "<description of the goal>"], 50 ["summary", "<description of the goal>"],
50 ], 51 ],
51 "content": "Nostrasia travel expenses", 52 "content": "Nostrasia travel expenses",
52 ... 53 // other fields...
53} 54}
54``` 55```
55 56
56The goal MAY include an `r` or `a` tag linking to a URL or parameterized replaceable event. 57The goal MAY include an `r` or `a` tag linking to a URL or addressable event.
57 58
58The goal MAY include multiple beneficiary pubkeys by specifying [`zap` tags](57.md#appendix-g-zap-tag-on-other-events). 59The goal MAY include multiple beneficiary pubkeys by specifying [`zap` tags](57.md#appendix-g-zap-tag-on-other-events).
59 60
60Parameterized replaceable events can link to a goal by using a `goal` tag specifying the event id and an optional relay hint. 61Addressable events can link to a goal by using a `goal` tag specifying the event id and an optional relay hint.
61 62
62```json 63```jsonc
63{ 64{
64 ...
65 "kind": 3xxxx, 65 "kind": 3xxxx,
66 "tags": [ 66 "tags": [
67 ...
68 ["goal", "<event id>", "<Relay URL (optional)>"], 67 ["goal", "<event id>", "<Relay URL (optional)>"],
68 // rest of tags...
69 ], 69 ],
70 ... 70 // other fields...
71} 71}
72``` 72```
73 73
@@ -77,7 +77,7 @@ Clients MAY display funding goals on user profiles.
77 77
78When zapping a goal event, clients MUST include the relays in the `relays` tag of the goal event in the zap request `relays` tag. 78When zapping a goal event, clients MUST include the relays in the `relays` tag of the goal event in the zap request `relays` tag.
79 79
80When zapping a parameterized replaceable event with a `goal` tag, clients SHOULD tag the goal event id in the `e` tag of the zap request. 80When zapping an addressable event with a `goal` tag, clients SHOULD tag the goal event id in the `e` tag of the zap request.
81 81
82## Use cases 82## Use cases
83 83
diff --git a/78.md b/78.md
index 0f2fada..abdd1b2 100644
--- a/78.md
+++ b/78.md
@@ -12,7 +12,7 @@ Even though interoperability is great, some apps do not want or do not need inte
12 12
13## Nostr event 13## Nostr event
14 14
15This NIP specifies the use of event kind `30078` (parameterized replaceable event) with a `d` tag containing some reference to the app name and context -- or any other arbitrary string. `content` and other `tags` can be anything or in any format. 15This NIP specifies the use of event kind `30078` (an _addressable_ event) with a `d` tag containing some reference to the app name and context -- or any other arbitrary string. `content` and other `tags` can be anything or in any format.
16 16
17## Some use cases 17## Some use cases
18 18
diff --git a/84.md b/84.md
index d5f54d4..e3063c2 100644
--- a/84.md
+++ b/84.md
@@ -26,14 +26,14 @@ useful when highlighting non-nostr content for which the client might be able to
26(e.g. prompting the user or reading a `<meta name="nostr:nprofile1..." />` tag on the document). A role MAY be included as the 26(e.g. prompting the user or reading a `<meta name="nostr:nprofile1..." />` tag on the document). A role MAY be included as the
27last value of the tag. 27last value of the tag.
28 28
29```json 29```jsonc
30{ 30{
31 "tags": [ 31 "tags": [
32 ["p", "<pubkey-hex>", "<relay-url>", "author"], 32 ["p", "<pubkey-hex>", "<relay-url>", "author"],
33 ["p", "<pubkey-hex>", "<relay-url>", "author"], 33 ["p", "<pubkey-hex>", "<relay-url>", "author"],
34 ["p", "<pubkey-hex>", "<relay-url>", "editor"] 34 ["p", "<pubkey-hex>", "<relay-url>", "editor"]
35 ], 35 ],
36 ... 36 // other fields...
37} 37}
38``` 38```
39 39
diff --git a/89.md b/89.md
index 54aa30b..24aa3c5 100644
--- a/89.md
+++ b/89.md
@@ -27,7 +27,7 @@ There are three actors to this workflow:
27## Events 27## Events
28 28
29### Recommendation event 29### Recommendation event
30```json 30```jsonc
31{ 31{
32 "kind": 31989, 32 "kind": 31989,
33 "pubkey": <recommender-user-pubkey>, 33 "pubkey": <recommender-user-pubkey>,
@@ -35,7 +35,8 @@ There are three actors to this workflow:
35 ["d", <supported-event-kind>], 35 ["d", <supported-event-kind>],
36 ["a", "31990:app1-pubkey:<d-identifier>", "wss://relay1", "ios"], 36 ["a", "31990:app1-pubkey:<d-identifier>", "wss://relay1", "ios"],
37 ["a", "31990:app2-pubkey:<d-identifier>", "wss://relay2", "web"] 37 ["a", "31990:app2-pubkey:<d-identifier>", "wss://relay2", "web"]
38 ] 38 ],
39 // other fields...
39} 40}
40``` 41```
41 42
@@ -47,7 +48,7 @@ The second value of the tag SHOULD be a relay hint.
47The third value of the tag SHOULD be the platform where this recommendation might apply. 48The third value of the tag SHOULD be the platform where this recommendation might apply.
48 49
49## Handler information 50## Handler information
50```json 51```jsonc
51{ 52{
52 "kind": 31990, 53 "kind": 31990,
53 "pubkey": "<application-pubkey>", 54 "pubkey": "<application-pubkey>",
@@ -59,7 +60,8 @@ The third value of the tag SHOULD be the platform where this recommendation migh
59 ["web", "https://..../p/<bech32>", "nprofile"], 60 ["web", "https://..../p/<bech32>", "nprofile"],
60 ["web", "https://..../e/<bech32>"], 61 ["web", "https://..../e/<bech32>"],
61 ["ios", ".../<bech32>"] 62 ["ios", ".../<bech32>"]
62 ] 63 ],
64 // other fields...
63} 65}
64``` 66```
65 67
@@ -77,13 +79,13 @@ A tag without a second value in the array SHOULD be considered a generic handler
77# Client tag 79# Client tag
78When publishing events, clients MAY include a `client` tag. Identifying the client that published the note. This tag is a tuple of `name`, `address` identifying a handler event and, a relay `hint` for finding the handler event. This has privacy implications for users, so clients SHOULD allow users to opt-out of using this tag. 80When publishing events, clients MAY include a `client` tag. Identifying the client that published the note. This tag is a tuple of `name`, `address` identifying a handler event and, a relay `hint` for finding the handler event. This has privacy implications for users, so clients SHOULD allow users to opt-out of using this tag.
79 81
80```json 82```jsonc
81{ 83{
82 "kind": 1, 84 "kind": 1,
83 "tags": [ 85 "tags": [
84 ["client", "My Client", "31990:app1-pubkey:<d-identifier>", "wss://relay1"] 86 ["client", "My Client", "31990:app1-pubkey:<d-identifier>", "wss://relay1"]
85 ] 87 ]
86 ... 88 // other fields...
87} 89}
88``` 90```
89 91
@@ -99,14 +101,14 @@ The client MIGHT query for the user's and the user's follows handler.
99### User A recommends a `kind:31337`-handler 101### User A recommends a `kind:31337`-handler
100User A might be a user of Zapstr, a `kind:31337`-centric client (tracks). Using Zapstr, user A publishes an event recommending Zapstr as a `kind:31337`-handler. 102User A might be a user of Zapstr, a `kind:31337`-centric client (tracks). Using Zapstr, user A publishes an event recommending Zapstr as a `kind:31337`-handler.
101 103
102```json 104```jsonc
103{ 105{
104 "kind": 31989, 106 "kind": 31989,
105 "tags": [ 107 "tags": [
106 ["d", "31337"], 108 ["d", "31337"],
107 ["a", "31990:1743058db7078661b94aaf4286429d97ee5257d14a86d6bfa54cb0482b876fb0:abcd", <relay-url>, "web"] 109 ["a", "31990:1743058db7078661b94aaf4286429d97ee5257d14a86d6bfa54cb0482b876fb0:abcd", <relay-url>, "web"]
108 ], 110 ],
109 ... 111 // other fields...
110} 112}
111``` 113```
112 114
@@ -115,7 +117,7 @@ User B might see in their timeline an event referring to a `kind:31337` event (e
115 117
116User B's client, not knowing how to handle a `kind:31337` might display the event using its `alt` tag (as described in NIP-31). When the user clicks on the event, the application queries for a handler for this `kind`: 118User B's client, not knowing how to handle a `kind:31337` might display the event using its `alt` tag (as described in NIP-31). When the user clicks on the event, the application queries for a handler for this `kind`:
117 119
118```json 120```
119["REQ", <id>, { "kinds": [31989], "#d": ["31337"], "authors": [<user>, <users-contact-list>] }] 121["REQ", <id>, { "kinds": [31989], "#d": ["31337"], "authors": [<user>, <users-contact-list>] }]
120``` 122```
121 123
@@ -126,6 +128,6 @@ User B's client sees the application's `kind:31990` which includes the informati
126### Alternative query bypassing `kind:31989` 128### Alternative query bypassing `kind:31989`
127Alternatively, users might choose to query directly for `kind:31990` for an event kind. Clients SHOULD be careful doing this and use spam-prevention mechanisms or querying high-quality restricted relays to avoid directing users to malicious handlers. 129Alternatively, users might choose to query directly for `kind:31990` for an event kind. Clients SHOULD be careful doing this and use spam-prevention mechanisms or querying high-quality restricted relays to avoid directing users to malicious handlers.
128 130
129```json 131```
130["REQ", <id>, { "kinds": [31990], "#k": [<desired-event-kind>], "authors": [...] }] 132["REQ", <id>, { "kinds": [31990], "#k": [<desired-event-kind>], "authors": [...] }]
131``` 133```
diff --git a/90.md b/90.md
index 5a15ebb..696ebd5 100644
--- a/90.md
+++ b/90.md
@@ -36,7 +36,7 @@ There are two actors in the workflow described in this NIP:
36## Job request (`kind:5000-5999`) 36## Job request (`kind:5000-5999`)
37A request to process data, published by a customer. This event signals that a customer is interested in receiving the result of some kind of compute. 37A request to process data, published by a customer. This event signals that a customer is interested in receiving the result of some kind of compute.
38 38
39```json 39```jsonc
40{ 40{
41 "kind": 5xxx, // kind in 5000-5999 range 41 "kind": 5xxx, // kind in 5000-5999 range
42 "content": "", 42 "content": "",
@@ -46,7 +46,8 @@ A request to process data, published by a customer. This event signals that a cu
46 [ "relays", "wss://..." ], 46 [ "relays", "wss://..." ],
47 [ "bid", "<msat-amount>" ], 47 [ "bid", "<msat-amount>" ],
48 [ "t", "bitcoin" ] 48 [ "t", "bitcoin" ]
49 ] 49 ],
50 // other fields...
50} 51}
51``` 52```
52 53
@@ -81,19 +82,18 @@ If the user wants to keep the input parameters a secret, they can encrypt the `i
81 ["param", "top-p", "0.7"], 82 ["param", "top-p", "0.7"],
82 ["param", "frequency_penalty", "1"] 83 ["param", "frequency_penalty", "1"]
83] 84]
84
85``` 85```
86 86
87This param data will be encrypted and added to the `content` field and `p` tag should be present 87This param data will be encrypted and added to the `content` field and `p` tag should be present
88 88
89```json 89```jsonc
90{ 90{
91 "content": "BE2Y4xvS6HIY7TozIgbEl3sAHkdZoXyLRRkZv4fLPh3R7LtviLKAJM5qpkC7D6VtMbgIt4iNcMpLtpo...", 91 "content": "BE2Y4xvS6HIY7TozIgbEl3sAHkdZoXyLRRkZv4fLPh3R7LtviLKAJM5qpkC7D6VtMbgIt4iNcMpLtpo...",
92 "tags": [ 92 "tags": [
93 ["p", "04f74530a6ede6b24731b976b8e78fb449ea61f40ff10e3d869a3030c4edc91f"], 93 ["p", "04f74530a6ede6b24731b976b8e78fb449ea61f40ff10e3d869a3030c4edc91f"],
94 ["encrypted"] 94 ["encrypted"]
95 ], 95 ],
96 ... 96 // other fields...
97} 97}
98``` 98```
99 99
@@ -102,7 +102,7 @@ This param data will be encrypted and added to the `content` field and `p` tag s
102 102
103Service providers publish job results, providing the output of the job result. They should tag the original job request event id as well as the customer's pubkey. 103Service providers publish job results, providing the output of the job result. They should tag the original job request event id as well as the customer's pubkey.
104 104
105```json 105```jsonc
106{ 106{
107 "pubkey": "<service-provider pubkey>", 107 "pubkey": "<service-provider pubkey>",
108 "content": "<payload>", 108 "content": "<payload>",
@@ -114,7 +114,7 @@ Service providers publish job results, providing the output of the job result. T
114 ["p", "<customer's-pubkey>"], 114 ["p", "<customer's-pubkey>"],
115 ["amount", "requested-payment-amount", "<optional-bolt11>"] 115 ["amount", "requested-payment-amount", "<optional-bolt11>"]
116 ], 116 ],
117 ... 117 // other fields...
118} 118}
119``` 119```
120 120
@@ -127,7 +127,7 @@ Service providers publish job results, providing the output of the job result. T
127If the request has encrypted params, then output should be encrypted and placed in `content` field. If the output is encrypted, then avoid including `i` tag with input-data as clear text. 127If the request has encrypted params, then output should be encrypted and placed in `content` field. If the output is encrypted, then avoid including `i` tag with input-data as clear text.
128Add a tag encrypted to mark the output content as `encrypted` 128Add a tag encrypted to mark the output content as `encrypted`
129 129
130```json 130```jsonc
131{ 131{
132 "pubkey": "<service-provider pubkey>", 132 "pubkey": "<service-provider pubkey>",
133 "content": "<encrypted payload>", 133 "content": "<encrypted payload>",
@@ -139,7 +139,7 @@ Add a tag encrypted to mark the output content as `encrypted`
139 ["amount", "requested-payment-amount", "<optional-bolt11>"], 139 ["amount", "requested-payment-amount", "<optional-bolt11>"],
140 ["encrypted"] 140 ["encrypted"]
141 ], 141 ],
142 ... 142 // other fields...
143} 143}
144``` 144```
145 145
@@ -147,7 +147,7 @@ Add a tag encrypted to mark the output content as `encrypted`
147 147
148Service providers can give feedback about a job back to the customer. 148Service providers can give feedback about a job back to the customer.
149 149
150```json 150```jsonc
151{ 151{
152 "kind": 7000, 152 "kind": 7000,
153 "content": "<empty-or-payload>", 153 "content": "<empty-or-payload>",
@@ -157,7 +157,7 @@ Service providers can give feedback about a job back to the customer.
157 ["e", "<job-request-id>", "<relay-hint>"], 157 ["e", "<job-request-id>", "<relay-hint>"],
158 ["p", "<customer's-pubkey>"], 158 ["p", "<customer's-pubkey>"],
159 ], 159 ],
160 ... 160 // other fields...
161} 161}
162``` 162```
163 163
@@ -211,7 +211,7 @@ This gives a higher level of flexibility to service providers (which sophisticat
211# Appendix 2: Service provider discoverability 211# Appendix 2: Service provider discoverability
212Service Providers MAY use NIP-89 announcements to advertise their support for job kinds: 212Service Providers MAY use NIP-89 announcements to advertise their support for job kinds:
213 213
214```js 214```jsonc
215{ 215{
216 "kind": 31990, 216 "kind": 31990,
217 "pubkey": "<pubkey>", 217 "pubkey": "<pubkey>",
@@ -223,7 +223,7 @@ Service Providers MAY use NIP-89 announcements to advertise their support for jo
223 ["k", "5005"], // e.g. translation 223 ["k", "5005"], // e.g. translation
224 ["t", "bitcoin"] // e.g. optionally advertises it specializes in bitcoin audio transcription that won't confuse "Drivechains" with "Ridechains" 224 ["t", "bitcoin"] // e.g. optionally advertises it specializes in bitcoin audio transcription that won't confuse "Drivechains" with "Ridechains"
225 ], 225 ],
226 ... 226 // other fields...
227} 227}
228``` 228```
229 229
diff --git a/94.md b/94.md
index e35dfa1..021cc4c 100644
--- a/94.md
+++ b/94.md
@@ -26,27 +26,28 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr
26* `summary` (optional) text excerpt 26* `summary` (optional) text excerpt
27* `alt` (optional) description for accessibility 27* `alt` (optional) description for accessibility
28* `fallback` (optional) zero or more fallback file sources in case `url` fails 28* `fallback` (optional) zero or more fallback file sources in case `url` fails
29* `service` (optional) service type which is serving the file (eg. [NIP-96](96.md))
29 30
30```json 31```jsonc
31{ 32{
32 "kind": 1063, 33 "kind": 1063,
33 "tags": [ 34 "tags": [
34 ["url",<string with URI of file>], 35 ["url",<string with URI of file>],
35 ["m", <MIME type>], 36 ["m", <MIME type>],
36 ["x",<Hash SHA-256>], 37 ["x", <Hash SHA-256>],
37 ["ox",<Hash SHA-256>], 38 ["ox", <Hash SHA-256>],
38 ["size", <size of file in bytes>], 39 ["size", <size of file in bytes>],
39 ["dim", <size of file in pixels>], 40 ["dim", <size of file in pixels>],
40 ["magnet",<magnet URI> ], 41 ["magnet", <magnet URI> ],
41 ["i",<torrent infohash>], 42 ["i", <torrent infohash>],
42 ["blurhash", <value>], 43 ["blurhash", <value>],
43 ["thumb", <string with thumbnail URI>], 44 ["thumb", <string with thumbnail URI>, <Hash SHA-256>],
44 ["image", <string with preview URI>], 45 ["image", <string with preview URI>, <Hash SHA-256>],
45 ["summary", <excerpt>], 46 ["summary", <excerpt>],
46 ["alt", <description>] 47 ["alt", <description>]
47 ], 48 ],
48 "content": "<caption>", 49 "content": "<caption>",
49 ... 50 // other fields...
50} 51}
51``` 52```
52 53
diff --git a/96.md b/96.md
index 2f25351..05c1b18 100644
--- a/96.md
+++ b/96.md
@@ -1,6 +1,8 @@
1# NIP-96 1NIP-96
2======
2 3
3## HTTP File Storage Integration 4HTTP File Storage Integration
5-----------------------------
4 6
5`draft` `optional` 7`draft` `optional`
6 8
@@ -17,7 +19,7 @@ will not have to learn anything about nostr relays.
17 19
18File storage servers wishing to be accessible by nostr users should opt-in by making available an https route at `/.well-known/nostr/nip96.json` with `api_url`: 20File storage servers wishing to be accessible by nostr users should opt-in by making available an https route at `/.well-known/nostr/nip96.json` with `api_url`:
19 21
20```js 22```jsonc
21{ 23{
22 // Required 24 // Required
23 // File upload and deletion are served from this url 25 // File upload and deletion are served from this url
@@ -57,7 +59,7 @@ File storage servers wishing to be accessible by nostr users should opt-in by ma
57 "file_expiration": [14, 90], 59 "file_expiration": [14, 90],
58 "media_transformations": { 60 "media_transformations": {
59 "image": [ 61 "image": [
60 'resizing' 62 "resizing"
61 ] 63 ]
62 } 64 }
63 } 65 }
@@ -125,14 +127,14 @@ The `server` MUST link the user's `pubkey` string as the owner of the file so to
125 127
126The upload response is a json object as follows: 128The upload response is a json object as follows:
127 129
128```js 130```jsonc
129{ 131{
130 // "success" if successful or "error" if not 132 // "success" if successful or "error" if not
131 status: "success", 133 "status": "success",
132 // Free text success, failure or info message 134 // Free text success, failure or info message
133 message: "Upload successful.", 135 "message": "Upload successful.",
134 // Optional. See "Delayed Processing" section 136 // Optional. See "Delayed Processing" section
135 processing_url: "...", 137 "processing_url": "...",
136 // This uses the NIP-94 event format but DO NOT need 138 // This uses the NIP-94 event format but DO NOT need
137 // to fill some fields like "id", "pubkey", "created_at" and "sig" 139 // to fill some fields like "id", "pubkey", "created_at" and "sig"
138 // 140 //
@@ -141,9 +143,9 @@ The upload response is a json object as follows:
141 // and, optionally, all file metadata the server wants to make available 143 // and, optionally, all file metadata the server wants to make available
142 // 144 //
143 // nip94_event field is absent if unsuccessful upload 145 // nip94_event field is absent if unsuccessful upload
144 nip94_event: { 146 "nip94_event": {
145 // Required tags: "url" and "ox" 147 // Required tags: "url" and "ox"
146 tags: [ 148 "tags": [
147 // Can be same from /.well-known/nostr/nip96.json's "download_url" field 149 // Can be same from /.well-known/nostr/nip96.json's "download_url" field
148 // (or "api_url" field if "download_url" is absent or empty) with appended 150 // (or "api_url" field if "download_url" is absent or empty) with appended
149 // original file hash. 151 // original file hash.
@@ -164,12 +166,12 @@ The upload response is a json object as follows:
164 // The server can but does not need to store this value. 166 // The server can but does not need to store this value.
165 ["x", "543244319525d9d08dd69cb716a18158a249b7b3b3ec4bbde5435543acb34443"], 167 ["x", "543244319525d9d08dd69cb716a18158a249b7b3b3ec4bbde5435543acb34443"],
166 // Optional. Recommended for helping clients to easily know file type before downloading it. 168 // Optional. Recommended for helping clients to easily know file type before downloading it.
167 ["m", "image/png"] 169 ["m", "image/png"],
168 // Optional. Recommended for helping clients to reserve an adequate UI space to show the file before downloading it. 170 // Optional. Recommended for helping clients to reserve an adequate UI space to show the file before downloading it.
169 ["dim", "800x600"] 171 ["dim", "800x600"]
170 // ... other optional NIP-94 tags 172 // ... other optional NIP-94 tags
171 ], 173 ],
172 content: "" 174 "content": ""
173 }, 175 },
174 // ... other custom fields (please consider adding them to this NIP or to NIP-94 tags) 176 // ... other custom fields (please consider adding them to this NIP or to NIP-94 tags)
175} 177}
@@ -200,12 +202,12 @@ the file processing is done.
200 202
201If the processing isn't done, the server should reply at the `processing_url` url with **200 OK** and the following JSON: 203If the processing isn't done, the server should reply at the `processing_url` url with **200 OK** and the following JSON:
202 204
203``` 205```jsonc
204{ 206{
205 // It should be "processing". If "error" it would mean the processing failed. 207 // It should be "processing". If "error" it would mean the processing failed.
206 status: "processing", 208 "status": "processing",
207 message: "Processing. Please check again later for updated status.", 209 "message": "Processing. Please check again later for updated status.",
208 percentage: 15 // Processing percentage. An integer between 0 and 100. 210 "percentage": 15 // Processing percentage. An integer between 0 and 100.
209} 211}
210``` 212```
211 213
@@ -268,10 +270,10 @@ in the same file hash).
268 270
269The successful response is a 200 OK one with just basic JSON fields: 271The successful response is a 200 OK one with just basic JSON fields:
270 272
271``` 273```json
272{ 274{
273 status: "success", 275 "status": "success",
274 message: "File deleted." 276 "message": "File deleted."
275} 277}
276``` 278```
277 279
@@ -285,7 +287,7 @@ Returns a list of files linked to the authenticated users pubkey.
285 287
286Example Response: 288Example Response:
287 289
288```js 290```jsonc
289{ 291{
290 "count": 1, // server page size, eg. max(1, min(server_max_page_size, arg_count)) 292 "count": 1, // server page size, eg. max(1, min(server_max_page_size, arg_count))
291 "total": 1, // total number of files 293 "total": 1, // total number of files
@@ -293,17 +295,16 @@ Example Response:
293 "files": [ 295 "files": [
294 { 296 {
295 "tags": [ 297 "tags": [
296 ["ox": "719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b"], 298 ["ox", "719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b"],
297 ["x": "5d2899290e0e69bcd809949ee516a4a1597205390878f780c098707a7f18e3df"], 299 ["x", "5d2899290e0e69bcd809949ee516a4a1597205390878f780c098707a7f18e3df"],
298 ["size", "123456"], 300 ["size", "123456"],
299 ["alt", "a meme that makes you laugh"], 301 ["alt", "a meme that makes you laugh"],
300 ["expiration", "1715691139"], 302 ["expiration", "1715691139"],
301 // ...other metadata 303 // ...other metadata
302 ] 304 ],
303 "content": "haha funny meme", // caption 305 "content": "haha funny meme", // caption
304 "created_at": 1715691130 // upload timestmap 306 "created_at": 1715691130 // upload timestamp
305 }, 307 }
306 ...
307 ] 308 ]
308} 309}
309``` 310```
@@ -322,14 +323,14 @@ Note: HTTP File Storage Server developers may skip this section. This is meant f
322A File Server Preference event is a kind 10096 replaceable event meant to select one or more servers the user wants 323A File Server Preference event is a kind 10096 replaceable event meant to select one or more servers the user wants
323to upload files to. Servers are listed as `server` tags: 324to upload files to. Servers are listed as `server` tags:
324 325
325```js 326```json
326{ 327{.
327 // ...
328 "kind": 10096, 328 "kind": 10096,
329 "content": "", 329 "content": "",
330 "tags": [ 330 "tags": [
331 ["server", "https://file.server.one"], 331 ["server", "https://file.server.one"],
332 ["server", "https://file.server.two"] 332 ["server", "https://file.server.two"]
333 ] 333 ],
334 // other fields...
334} 335}
335``` 336```
diff --git a/99.md b/99.md
index 93550d8..724ce5f 100644
--- a/99.md
+++ b/99.md
@@ -6,11 +6,11 @@ Classified Listings
6 6
7`draft` `optional` 7`draft` `optional`
8 8
9This NIP defines `kind:30402`: a parameterized replaceable event to describe classified listings that list any arbitrary product, service, or other thing for sale or offer and includes enough structured metadata to make them useful. 9This NIP defines `kind:30402`: an addressable event to describe classified listings that list any arbitrary product, service, or other thing for sale or offer and includes enough structured metadata to make them useful.
10 10
11The category of classifieds includes a very broad range of physical goods, services, work opportunities, rentals, free giveaways, personals, etc. and is distinct from the more strictly structured marketplaces defined in [NIP-15](https://github.com/nostr-protocol/nips/blob/master/15.md) that often sell many units of specific products through very specific channels. 11The category of classifieds includes a very broad range of physical goods, services, work opportunities, rentals, free giveaways, personals, etc. and is distinct from the more strictly structured marketplaces defined in [NIP-15](15.md) that often sell many units of specific products through very specific channels.
12 12
13The structure of these events is very similar to [NIP-23](https://github.com/nostr-protocol/nips/blob/master/23.md) long-form content events. 13The structure of these events is very similar to [NIP-23](23.md) long-form content events.
14 14
15### Draft / Inactive Listings 15### Draft / Inactive Listings
16 16
@@ -26,8 +26,8 @@ The `.pubkey` field of these events are treated as the party creating the listin
26 26
27### Metadata 27### Metadata
28 28
29- For "tags"/"hashtags" (i.e. categories or keywords of relevance for the listing) the `"t"` event tag should be used, as per [NIP-12](https://github.com/nostr-protocol/nips/blob/master/12.md). 29- For "tags"/"hashtags" (i.e. categories or keywords of relevance for the listing) the `"t"` event tag should be used.
30- For images, whether included in the markdown content or not, clients SHOULD use `image` tags as described in [NIP-58](https://github.com/nostr-protocol/nips/blob/master/58.md). This allows clients to display images in carousel format more easily. 30- For images, whether included in the markdown content or not, clients SHOULD use `image` tags as described in [NIP-58](58.md). This allows clients to display images in carousel format more easily.
31 31
32The following tags, used for structured metadata, are standardized and SHOULD be included. Other tags may be added as necessary. 32The following tags, used for structured metadata, are standardized and SHOULD be included. Other tags may be added as necessary.
33 33
@@ -54,7 +54,7 @@ Other standard tags that might be useful.
54 54
55## Example Event 55## Example Event
56 56
57```json 57```jsonc
58{ 58{
59 "kind": 30402, 59 "kind": 30402,
60 "created_at": 1675642635, 60 "created_at": 1675642635,
diff --git a/BREAKING.md b/BREAKING.md
index c8255cd..b4bd53d 100644
--- a/BREAKING.md
+++ b/BREAKING.md
@@ -5,6 +5,14 @@ reverse chronological order.
5 5
6| Date | Commit | NIP | Change | 6| Date | Commit | NIP | Change |
7| ----------- | --------- | -------- | ------ | 7| ----------- | --------- | -------- | ------ |
8| 2024-10-15 | [1cda2dcc](https://github.com/nostr-protocol/nips/commit/1cda2dcc) | [NIP-71](71.md) | some tags were replaced with `imeta` tag |
9| 2024-10-15 | [1cda2dcc](https://github.com/nostr-protocol/nips/commit/1cda2dcc) | [NIP-71](71.md) | `kind: 34237` was dropped |
10| 2024-10-07 | [7bb8997b](https://github.com/nostr-protocol/nips/commit/7bb8997b) | [NIP-55](55.md) | some fields and passing data were changed |
11| 2024-08-18 | [3aff37bd](https://github.com/nostr-protocol/nips/commit/3aff37bd) | [NIP-54](54.md) | content should be Asciidoc |
12| 2024-07-31 | [3ea2f1a4](https://github.com/nostr-protocol/nips/commit/3ea2f1a4) | [NIP-45](45.md) | [444ad28d](https://github.com/nostr-protocol/nips/commit/444ad28d) was reverted |
13| 2024-07-30 | [444ad28d](https://github.com/nostr-protocol/nips/commit/444ad28d) | [NIP-45](45.md) | NIP-45 was deprecated |
14| 2024-07-26 | [ecee40df](https://github.com/nostr-protocol/nips/commit/ecee40df) | [NIP-19](19.md) | `nrelay` was deprecated |
15| 2024-07-23 | [0227a2cd](https://github.com/nostr-protocol/nips/commit/0227a2cd) | [NIP-01](01.md) | events should be sorted by id after created_at |
8| 2024-06-06 | [58e94b20](https://github.com/nostr-protocol/nips/commit/58e94b20) | [NIP-25](25.md) | [8073c848](https://github.com/nostr-protocol/nips/commit/8073c848) was reverted | 16| 2024-06-06 | [58e94b20](https://github.com/nostr-protocol/nips/commit/58e94b20) | [NIP-25](25.md) | [8073c848](https://github.com/nostr-protocol/nips/commit/8073c848) was reverted |
9| 2024-06-06 | [a6dfc7b5](https://github.com/nostr-protocol/nips/commit/a6dfc7b5) | [NIP-55](55.md) | NIP number was changed | 17| 2024-06-06 | [a6dfc7b5](https://github.com/nostr-protocol/nips/commit/a6dfc7b5) | [NIP-55](55.md) | NIP number was changed |
10| 2024-05-25 | [5d1d1c17](https://github.com/nostr-protocol/nips/commit/5d1d1c17) | [NIP-71](71.md) | 'aes-256-gcm' tag was removed | 18| 2024-05-25 | [5d1d1c17](https://github.com/nostr-protocol/nips/commit/5d1d1c17) | [NIP-71](71.md) | 'aes-256-gcm' tag was removed |
@@ -43,6 +51,7 @@ reverse chronological order.
43| 2023-06-18 | [83cbd3e1](https://github.com/nostr-protocol/nips/commit/83cbd3e1) | [NIP-11](11.md) | 'image' was renamed to 'icon' | 51| 2023-06-18 | [83cbd3e1](https://github.com/nostr-protocol/nips/commit/83cbd3e1) | [NIP-11](11.md) | 'image' was renamed to 'icon' |
44| 2023-04-13 | [bf0a0da6](https://github.com/nostr-protocol/nips/commit/bf0a0da6) | [NIP-15](15.md) | different NIP was re-added as NIP-15 | 52| 2023-04-13 | [bf0a0da6](https://github.com/nostr-protocol/nips/commit/bf0a0da6) | [NIP-15](15.md) | different NIP was re-added as NIP-15 |
45| 2023-04-09 | [fb5b7c73](https://github.com/nostr-protocol/nips/commit/fb5b7c73) | [NIP-15](15.md) | NIP-15 was merged into NIP-01 | 53| 2023-04-09 | [fb5b7c73](https://github.com/nostr-protocol/nips/commit/fb5b7c73) | [NIP-15](15.md) | NIP-15 was merged into NIP-01 |
54| 2023-03-29 | [599e1313](https://github.com/nostr-protocol/nips/commit/599e1313) | [NIP-18](18.md) | NIP-18 was bring back |
46| 2023-03-15 | [e1004d3d](https://github.com/nostr-protocol/nips/commit/e1004d3d) | [NIP-19](19.md) | `1: relay` was changed to optionally | 55| 2023-03-15 | [e1004d3d](https://github.com/nostr-protocol/nips/commit/e1004d3d) | [NIP-19](19.md) | `1: relay` was changed to optionally |
47 56
48Breaking changes prior to 2023-03-01 are not yet documented. 57Breaking changes prior to 2023-03-01 are not yet documented.
diff --git a/README.md b/README.md
index 2d7f71f..7c19bd5 100644
--- a/README.md
+++ b/README.md
@@ -30,7 +30,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
30- [NIP-06: Basic key derivation from mnemonic seed phrase](06.md) 30- [NIP-06: Basic key derivation from mnemonic seed phrase](06.md)
31- [NIP-07: `window.nostr` capability for web browsers](07.md) 31- [NIP-07: `window.nostr` capability for web browsers](07.md)
32- [NIP-08: Handling Mentions](08.md) --- **unrecommended**: deprecated in favor of [NIP-27](27.md) 32- [NIP-08: Handling Mentions](08.md) --- **unrecommended**: deprecated in favor of [NIP-27](27.md)
33- [NIP-09: Event Deletion](09.md) 33- [NIP-09: Event Deletion Request](09.md)
34- [NIP-10: Conventions for clients' use of `e` and `p` tags in text events](10.md) 34- [NIP-10: Conventions for clients' use of `e` and `p` tags in text events](10.md)
35- [NIP-11: Relay Information Document](11.md) 35- [NIP-11: Relay Information Document](11.md)
36- [NIP-13: Proof of Work](13.md) 36- [NIP-13: Proof of Work](13.md)
@@ -73,9 +73,14 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
73- [NIP-57: Lightning Zaps](57.md) 73- [NIP-57: Lightning Zaps](57.md)
74- [NIP-58: Badges](58.md) 74- [NIP-58: Badges](58.md)
75- [NIP-59: Gift Wrap](59.md) 75- [NIP-59: Gift Wrap](59.md)
76- [NIP-60: Cashu Wallet](60.md)
77- [NIP-61: Nutzaps](61.md)
78- [NIP-64: Chess (PGN)](64.md)
76- [NIP-65: Relay List Metadata](65.md) 79- [NIP-65: Relay List Metadata](65.md)
80- [NIP-70: Protected Events](70.md)
77- [NIP-71: Video Events](71.md) 81- [NIP-71: Video Events](71.md)
78- [NIP-72: Moderated Communities](72.md) 82- [NIP-72: Moderated Communities](72.md)
83- [NIP-73: External Content IDs](73.md)
79- [NIP-75: Zap Goals](75.md) 84- [NIP-75: Zap Goals](75.md)
80- [NIP-78: Application-specific data](78.md) 85- [NIP-78: Application-specific data](78.md)
81- [NIP-84: Highlights](84.md) 86- [NIP-84: Highlights](84.md)
@@ -89,118 +94,143 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
89- [NIP-100: Peer-to-peer Order events](100.md) 94- [NIP-100: Peer-to-peer Order events](100.md)
90 95
91## Event Kinds 96## Event Kinds
92| kind | description | NIP | 97
93| ------------- | -------------------------- | ------------------------ | 98| kind | description | NIP |
94| `0` | User Metadata | [01](01.md) | 99| ------------- | ------------------------------- | -------------------------------------- |
95| `1` | Short Text Note | [01](01.md) | 100| `0` | User Metadata | [01](01.md) |
96| `2` | Recommend Relay | 01 (deprecated) | 101| `1` | Short Text Note | [01](01.md) |
97| `3` | Follows | [02](02.md) | 102| `2` | Recommend Relay | 01 (deprecated) |
98| `4` | Encrypted Direct Messages | [04](04.md) | 103| `3` | Follows | [02](02.md) |
99| `5` | Event Deletion | [09](09.md) | 104| `4` | Encrypted Direct Messages | [04](04.md) |
100| `6` | Repost | [18](18.md) | 105| `5` | Event Deletion Request | [09](09.md) |
101| `7` | Reaction | [25](25.md) | 106| `6` | Repost | [18](18.md) |
102| `8` | Badge Award | [58](58.md) | 107| `7` | Reaction | [25](25.md) |
103| `9` | Group Chat Message | [29](29.md) | 108| `8` | Badge Award | [58](58.md) |
104| `10` | Group Chat Threaded Reply | [29](29.md) | 109| `9` | Group Chat Message | [29](29.md) |
105| `11` | Group Thread | [29](29.md) | 110| `10` | Group Chat Threaded Reply | [29](29.md) |
106| `12` | Group Thread Reply | [29](29.md) | 111| `11` | Group Thread | [29](29.md) |
107| `13` | Seal | [59](59.md) | 112| `12` | Group Thread Reply | [29](29.md) |
108| `14` | Direct Message | [17](17.md) | 113| `13` | Seal | [59](59.md) |
109| `16` | Generic Repost | [18](18.md) | 114| `14` | Direct Message | [17](17.md) |
110| `40` | Channel Creation | [28](28.md) | 115| `16` | Generic Repost | [18](18.md) |
111| `41` | Channel Metadata | [28](28.md) | 116| `17` | Reaction to a website | [25](25.md) |
112| `42` | Channel Message | [28](28.md) | 117| `40` | Channel Creation | [28](28.md) |
113| `43` | Channel Hide Message | [28](28.md) | 118| `41` | Channel Metadata | [28](28.md) |
114| `44` | Channel Mute User | [28](28.md) | 119| `42` | Channel Message | [28](28.md) |
115| `818` | Merge Requests | [54](54.md) | 120| `43` | Channel Hide Message | [28](28.md) |
116| `1021` | Bid | [15](15.md) | 121| `44` | Channel Mute User | [28](28.md) |
117| `1022` | Bid confirmation | [15](15.md) | 122| `64` | Chess (PGN) | [64](64.md) |
118| `1040` | OpenTimestamps | [03](03.md) | 123| `818` | Merge Requests | [54](54.md) |
119| `1059` | Gift Wrap | [59](59.md) | 124| `1021` | Bid | [15](15.md) |
120| `1063` | File Metadata | [94](94.md) | 125| `1022` | Bid confirmation | [15](15.md) |
121| `1311` | Live Chat Message | [53](53.md) | 126| `1040` | OpenTimestamps | [03](03.md) |
122| `1617` | Patches | [34](34.md) | 127| `1059` | Gift Wrap | [59](59.md) |
123| `1621` | Issues | [34](34.md) | 128| `1063` | File Metadata | [94](94.md) |
124| `1622` | Replies | [34](34.md) | 129| `1311` | Live Chat Message | [53](53.md) |
125| `1630`-`1633` | Status | [34](34.md) | 130| `1617` | Patches | [34](34.md) |
126| `1971` | Problem Tracker | [nostrocket][nostrocket] | 131| `1621` | Issues | [34](34.md) |
127| `1984` | Reporting | [56](56.md) | 132| `1622` | Replies | [34](34.md) |
128| `1985` | Label | [32](32.md) | 133| `1630`-`1633` | Status | [34](34.md) |
129| `2003` | Torrent | [35](35.md) | 134| `1971` | Problem Tracker | [nostrocket][nostrocket] |
130| `2004` | Torrent Comment | [35](35.md) | 135| `1984` | Reporting | [56](56.md) |
131| `2022` | Coinjoin Pool | [joinstr][joinstr] | 136| `1985` | Label | [32](32.md) |
132| `4550` | Community Post Approval | [72](72.md) | 137| `1986` | Relay reviews | |
133| `5000`-`5999` | Job Request | [90](90.md) | 138| `1987` | AI Embeddings / Vector lists | [NKBIP-02] |
134| `6000`-`6999` | Job Result | [90](90.md) | 139| `2003` | Torrent | [35](35.md) |
135| `7000` | Job Feedback | [90](90.md) | 140| `2004` | Torrent Comment | [35](35.md) |
136| `9000`-`9030` | Group Control Events | [29](29.md) | 141| `2022` | Coinjoin Pool | [joinstr][joinstr] |
137| `9041` | Zap Goal | [75](75.md) | 142| `4550` | Community Post Approval | [72](72.md) |
138| `9734` | Zap Request | [57](57.md) | 143| `5000`-`5999` | Job Request | [90](90.md) |
139| `9735` | Zap | [57](57.md) | 144| `6000`-`6999` | Job Result | [90](90.md) |
140| `9802` | Highlights | [84](84.md) | 145| `7000` | Job Feedback | [90](90.md) |
141| `10000` | Mute list | [51](51.md) | 146| `7374` | Reserved Cashu Wallet Tokens | [60](60.md) |
142| `10001` | Pin list | [51](51.md) | 147| `7375` | Cashu Wallet Tokens | [60](60.md) |
143| `10002` | Relay List Metadata | [65](65.md) | 148| `7376` | Cashu Wallet History | [60](60.md) |
144| `10003` | Bookmark list | [51](51.md) | 149| `9000`-`9030` | Group Control Events | [29](29.md) |
145| `10004` | Communities list | [51](51.md) | 150| `9041` | Zap Goal | [75](75.md) |
146| `10005` | Public chats list | [51](51.md) | 151| `9321` | Nutzap | [61](61.md) |
147| `10006` | Blocked relays list | [51](51.md) | 152| `9467` | Tidal login | [Tidal-nostr] |
148| `10007` | Search relays list | [51](51.md) | 153| `9734` | Zap Request | [57](57.md) |
149| `10009` | User groups | [51](51.md), [29](29.md) | 154| `9735` | Zap | [57](57.md) |
150| `10015` | Interests list | [51](51.md) | 155| `9802` | Highlights | [84](84.md) |
151| `10030` | User emoji list | [51](51.md) | 156| `10000` | Mute list | [51](51.md) |
152| `10050` | Relay list to receive DMs | [17](17.md) | 157| `10001` | Pin list | [51](51.md) |
153| `10096` | File storage server list | [96](96.md) | 158| `10002` | Relay List Metadata | [65](65.md) |
154| `13194` | Wallet Info | [47](47.md) | 159| `10003` | Bookmark list | [51](51.md) |
155| `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | 160| `10004` | Communities list | [51](51.md) |
156| `22242` | Client Authentication | [42](42.md) | 161| `10005` | Public chats list | [51](51.md) |
157| `23194` | Wallet Request | [47](47.md) | 162| `10006` | Blocked relays list | [51](51.md) |
158| `23195` | Wallet Response | [47](47.md) | 163| `10007` | Search relays list | [51](51.md) |
159| `24133` | Nostr Connect | [46](46.md) | 164| `10009` | User groups | [51](51.md), [29](29.md) |
160| `27235` | HTTP Auth | [98](98.md) | 165| `10015` | Interests list | [51](51.md) |
161| `30000` | Follow sets | [51](51.md) | 166| `10019` | Nutzap Mint Recommendation | [61](61.md) |
162| `30001` | Generic lists | [51](51.md) | 167| `10030` | User emoji list | [51](51.md) |
163| `30002` | Relay sets | [51](51.md) | 168| `10050` | Relay list to receive DMs | [51](51.md), [17](17.md) |
164| `30003` | Bookmark sets | [51](51.md) | 169| `10063` | User server list | [Blossom][blossom] |
165| `30004` | Curation sets | [51](51.md) | 170| `10096` | File storage server list | [96](96.md) |
166| `30005` | Video sets | [51](51.md) | 171| `13194` | Wallet Info | [47](47.md) |
167| `30008` | Profile Badges | [58](58.md) | 172| `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] |
168| `30009` | Badge Definition | [58](58.md) | 173| `22242` | Client Authentication | [42](42.md) |
169| `30015` | Interest sets | [51](51.md) | 174| `23194` | Wallet Request | [47](47.md) |
170| `30017` | Create or update a stall | [15](15.md) | 175| `23195` | Wallet Response | [47](47.md) |
171| `30018` | Create or update a product | [15](15.md) | 176| `24133` | Nostr Connect | [46](46.md) |
172| `30019` | Marketplace UI/UX | [15](15.md) | 177| `24242` | Blobs stored on mediaservers | [Blossom][blossom] |
173| `30020` | Product sold as an auction | [15](15.md) | 178| `27235` | HTTP Auth | [98](98.md) |
174| `30023` | Long-form Content | [23](23.md) | 179| `30000` | Follow sets | [51](51.md) |
175| `30024` | Draft Long-form Content | [23](23.md) | 180| `30001` | Generic lists | [51](51.md) |
176| `30030` | Emoji sets | [51](51.md) | 181| `30002` | Relay sets | [51](51.md) |
177| `30063` | Release artifact sets | [51](51.md) | 182| `30003` | Bookmark sets | [51](51.md) |
178| `30078` | Application-specific Data | [78](78.md) | 183| `30004` | Curation sets | [51](51.md) |
179| `30311` | Live Event | [53](53.md) | 184| `30005` | Video sets | [51](51.md) |
180| `30315` | User Statuses | [38](38.md) | 185| `30007` | Kind mute sets | [51](51.md) |
181| `30402` | Classified Listing | [99](99.md) | 186| `30008` | Profile Badges | [58](58.md) |
182| `30403` | Draft Classified Listing | [99](99.md) | 187| `30009` | Badge Definition | [58](58.md) |
183| `30617` | Repository announcements | [34](34.md) | 188| `30015` | Interest sets | [51](51.md) |
184| `30818` | Wiki article | [54](54.md) | 189| `30017` | Create or update a stall | [15](15.md) |
185| `30819` | Redirects | [54](54.md) | 190| `30018` | Create or update a product | [15](15.md) |
186| `31890` | Feed | [NUD: Custom Feeds](https://wikifreedia.xyz/cip-01/97c70a44366a6535c1) | 191| `30019` | Marketplace UI/UX | [15](15.md) |
187| `31922` | Date-Based Calendar Event | [52](52.md) | 192| `30020` | Product sold as an auction | [15](15.md) |
188| `31923` | Time-Based Calendar Event | [52](52.md) | 193| `30023` | Long-form Content | [23](23.md) |
189| `31924` | Calendar | [52](52.md) | 194| `30024` | Draft Long-form Content | [23](23.md) |
190| `31925` | Calendar Event RSVP | [52](52.md) | 195| `30030` | Emoji sets | [51](51.md) |
191| `31989` | Handler recommendation | [89](89.md) | 196| `30040` | Modular Article Header | [NKBIP-01] |
192| `31990` | Handler information | [89](89.md) | 197| `30041` | Modular Article Content | [NKBIP-01] |
193| `34235` | Video Event | [71](71.md) | 198| `30063` | Release artifact sets | [51](51.md) |
194| `34236` | Short-form Portrait Video Event | [71](71.md) | 199| `30078` | Application-specific Data | [78](78.md) |
195| `34237` | Video View Event | [71](71.md) | 200| `30311` | Live Event | [53](53.md) |
196| `34550` | Community Definition | [72](72.md) | 201| `30315` | User Statuses | [38](38.md) |
197| `38383` | Peer-to-peer Order events | [100](100.md) | 202| `30388` | Slide Set | [Corny Chat][cornychat-slideset] |
198| `39000-9` | Group metadata events | [29](29.md) | 203| `30402` | Classified Listing | [99](99.md) |
199 204| `30403` | Draft Classified Listing | [99](99.md) |
200[NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/97c70a44366a6535c1 205| `30617` | Repository announcements | [34](34.md) |
206| `30618` | Repository state announcements | [34](34.md) |
207| `30818` | Wiki article | [54](54.md) |
208| `30819` | Redirects | [54](54.md) |
209| `31388` | Link Set | [Corny Chat][cornychat-linkset] |
210| `31890` | Feed | [NUD: Custom Feeds][NUD: Custom Feeds] |
211| `31922` | Date-Based Calendar Event | [52](52.md) |
212| `31923` | Time-Based Calendar Event | [52](52.md) |
213| `31924` | Calendar | [52](52.md) |
214| `31925` | Calendar Event RSVP | [52](52.md) |
215| `31989` | Handler recommendation | [89](89.md) |
216| `31990` | Handler information | [89](89.md) |
217| `34235` | Video Event | [71](71.md) |
218| `34236` | Short-form Portrait Video Event | [71](71.md) |
219| `34550` | Community Definition | [72](72.md) |
220| `37375` | Cashu Wallet Event | [60](60.md) |
221| `38383` | Peer-to-peer Order events | [100](100.md) |
222| `39000-9` | Group metadata events | [29](29.md) |
223
224[NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/
201[nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md 225[nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md
202[lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md 226[lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md
227[cornychat-slideset]: https://cornychat.com/datatypes#kind30388slideset
228[cornychat-linkset]: https://cornychat.com/datatypes#kind31388linkset
203[joinstr]: https://gitlab.com/1440000bytes/joinstr/-/blob/main/NIP.md 229[joinstr]: https://gitlab.com/1440000bytes/joinstr/-/blob/main/NIP.md
230[NKBIP-01]: https://wikistr.com/nkbip-01
231[NKBIP-02]: https://wikistr.com/nkbip-02
232[blossom]: https://github.com/hzrd149/blossom
233[Tidal-nostr]: https://wikistr.com/tidal-nostr
204 234
205## Message types 235## Message types
206 236
@@ -228,54 +258,56 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
228 258
229## Standardized Tags 259## Standardized Tags
230 260
231| name | value | other parameters | NIP | 261| name | value | other parameters | NIP |
232| ----------------- | ------------------------------------ | ------------------------------- | ------------------------------------- | 262| ----------------- | ------------------------------------ | ------------------------------- | -------------------------------------------------- |
233| `e` | event id (hex) | relay URL, marker, pubkey (hex) | [01](01.md), [10](10.md) | 263| `e` | event id (hex) | relay URL, marker, pubkey (hex) | [01](01.md), [10](10.md) |
234| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | 264| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) |
235| `a` | coordinates to an event | relay URL | [01](01.md) | 265| `a` | coordinates to an event | relay URL | [01](01.md) |
236| `d` | identifier | -- | [01](01.md) | 266| `d` | identifier | -- | [01](01.md) |
237| `g` | geohash | -- | [52](52.md) | 267| `-` | -- | -- | [70](70.md) |
238| `i` | identity | proof | [39](39.md) | 268| `g` | geohash | -- | [52](52.md) |
239| `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) | 269| `h` | group id | -- | [29](29.md) |
240| `l` | label, label namespace | -- | [32](32.md) | 270| `i` | external identity | proof, url hint | [39](39.md), [73](73.md) |
241| `L` | label namespace | -- | [32](32.md) | 271| `k` | kind | -- | [18](18.md), [25](25.md), [72](72.md), [73](73.md) |
242| `m` | MIME type | -- | [94](94.md) | 272| `l` | label, label namespace | -- | [32](32.md) |
243| `q` | event id (hex) | relay URL | [18](18.md) | 273| `L` | label namespace | -- | [32](32.md) |
244| `r` | a reference (URL, etc) | petname | [24](24.md) | 274| `m` | MIME type | -- | [94](94.md) |
245| `r` | relay url | marker | [65](65.md) | 275| `q` | event id (hex) | relay URL, pubkey (hex) | [18](18.md) |
246| `t` | hashtag | -- | | 276| `r` | a reference (URL, etc) | -- | [24](24.md), [25](25.md) |
247| `alt` | summary | -- | [31](31.md) | 277| `r` | relay url | marker | [65](65.md) |
248| `amount` | millisatoshis, stringified | -- | [57](57.md) | 278| `t` | hashtag | -- | [24](24.md), [34](34.md) |
249| `bolt11` | `bolt11` invoice | -- | [57](57.md) | 279| `alt` | summary | -- | [31](31.md) |
250| `challenge` | challenge string | -- | [42](42.md) | 280| `amount` | millisatoshis, stringified | -- | [57](57.md) |
251| `client` | name, address | relay URL | [89](89.md) | 281| `bolt11` | `bolt11` invoice | -- | [57](57.md) |
252| `clone` | git clone URL | -- | [34](34.md) | 282| `challenge` | challenge string | -- | [42](42.md) |
253| `content-warning` | reason | -- | [36](36.md) | 283| `client` | name, address | relay URL | [89](89.md) |
254| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | 284| `clone` | git clone URL | -- | [34](34.md) |
255| `description` | description | -- | [34](34.md), [57](57.md), [58](58.md) | 285| `content-warning` | reason | -- | [36](36.md) |
256| `emoji` | shortcode, image URL | -- | [30](30.md) | 286| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) |
257| `encrypted` | -- | -- | [90](90.md) | 287| `description` | description | -- | [34](34.md), [57](57.md), [58](58.md) |
258| `expiration` | unix timestamp (string) | -- | [40](40.md) | 288| `emoji` | shortcode, image URL | -- | [30](30.md) |
259| `goal` | event id (hex) | relay URL | [75](75.md) | 289| `encrypted` | -- | -- | [90](90.md) |
260| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | 290| `expiration` | unix timestamp (string) | -- | [40](40.md) |
261| `imeta` | inline metadata | -- | [92](92.md) | 291| `goal` | event id (hex) | relay URL | [75](75.md) |
262| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | 292| `image` | image URL | dimensions in pixels | [23](23.md), [52](52.md), [58](58.md) |
263| `location` | location string | -- | [52](52.md), [99](99.md) | 293| `imeta` | inline metadata | -- | [92](92.md) |
264| `name` | name | -- | [34](34.md), [58](58.md) | 294| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) |
265| `nonce` | random | difficulty | [13](13.md) | 295| `location` | location string | -- | [52](52.md), [99](99.md) |
266| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | 296| `name` | name | -- | [34](34.md), [58](58.md), [72](72.md) |
267| `price` | price | currency, frequency | [99](99.md) | 297| `nonce` | random | difficulty | [13](13.md) |
268| `proxy` | external ID | protocol | [48](48.md) | 298| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) |
269| `published_at` | unix timestamp (string) | -- | [23](23.md) | 299| `price` | price | currency, frequency | [99](99.md) |
270| `relay` | relay url | -- | [42](42.md), [17](17.md) | 300| `proxy` | external ID | protocol | [48](48.md) |
271| `relays` | relay list | -- | [57](57.md) | 301| `published_at` | unix timestamp (string) | -- | [23](23.md) |
272| `server` | file storage server url | -- | [96](96.md) | 302| `relay` | relay url | -- | [42](42.md), [17](17.md) |
273| `subject` | subject | -- | [14](14.md), [17](17.md) | 303| `relays` | relay list | -- | [57](57.md) |
274| `summary` | article summary | -- | [23](23.md) | 304| `server` | file storage server url | -- | [96](96.md) |
275| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | 305| `subject` | subject | -- | [14](14.md), [17](17.md), [34](34.md) |
276| `title` | article title | -- | [23](23.md) | 306| `summary` | summary | -- | [23](23.md), [52](52.md) |
277| `web` | webpage URL | -- | [34](34.md) | 307| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) |
278| `zap` | pubkey (hex), relay URL | weight | [57](57.md) | 308| `title` | article title | -- | [23](23.md) |
309| `web` | webpage URL | -- | [34](34.md) |
310| `zap` | pubkey (hex), relay URL | weight | [57](57.md) |
279 311
280Please update these lists when proposing new NIPs. 312Please update these lists when proposing new NIPs.
281 313