From ec8eb9af0b43e42e974877f539940894e84f4847 Mon Sep 17 00:00:00 2001
From: arthurfranca <arthur.a.franca@gmail.com>
Date: Thu, 7 Nov 2024 10:41:00 -0300
Subject: NIP-22 - Comment (#1233)

Co-authored-by: dluvian <133484344+dluvian@users.noreply.github.com>
Co-authored-by: Vitor Pamplona <vitor@vitorpamplona.com>
---
 22.md | 184 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 184 insertions(+)
 create mode 100644 22.md

(limited to '22.md')

diff --git a/22.md b/22.md
new file mode 100644
index 0000000..3706aec
--- /dev/null
+++ b/22.md
@@ -0,0 +1,184 @@
+NIP-22
+======
+
+Comment
+-------
+
+`draft` `optional`
+
+A comment is a threading note always scoped to a root event or an `I`-tag.
+
+It uses `kind:1111` with plaintext `.content` (no HTML, Markdown, or other formatting).
+
+Comments MUST point to the root scope using uppercase tag names (e.g. `K`, `E`, `A` or `I`)
+and MUST point to the parent item with lowercase ones (e.g. `k`, `e`, `a` or `i`).
+
+```js
+{
+  kind: 1111,
+  content: '<comment>',
+  tags: [
+    // root scope: event addresses, event ids, or I-tags.
+    ["<A, E, I>", "<address, id or I-value>", "<relay or web page hint>", "<root event's pubkey, if an E tag>"],
+    // the root item kind
+    ["K", "<root kind>"],
+
+    // parent item: event addresses, event ids, or i-tags.
+    ["<a, e, i>", "<address, id or i-value>", "<relay or web page hint>", "<parent event's pubkey, if an e tag>"],
+    // parent item kind
+    ["k", "<parent comment kind>"]
+  ]
+  // other fields
+}
+```
+
+Tags `K` and `k` MUST be present to define the event kind of the root and the parent items.
+
+`I` and `i` tags create scopes for hashtags, geohashes, URLs, and other external identifiers.
+
+The possible values for `i` tags – and `k` tags, when related to an extenal identity – are listed on [NIP-73](73.md).
+Their uppercase versions use the same type of values but relate to the root item instead of the parent one.
+
+`q` tags MAY be used when citing events in the `.content` with [NIP-21](21.md).
+
+```json
+["q", "<event-id> or <event-address>", "<relay-url>", "<pubkey-if-a-regular-event>"]
+```
+
+`p` tags SHOULD be used when mentioning pubkeys in the `.content` with [NIP-21](21.md).
+If the parent item is an event, a `p` tag set to the parent event's author SHOULD be added.
+
+```json
+["p", "<pubkey>", "<relay-url>"]
+```
+
+## Examples
+
+A comment on a blog post looks like this:
+
+```js
+{
+  kind: 1111,
+  content: 'Great blog post!',
+  tags: [
+    // top-level comments scope to event addresses or ids
+    ["A", "30023:3c9849383bdea883b0bd16fece1ed36d37e37cdde3ce43b17ea4e9192ec11289:f9347ca7", "wss://example.relay"],
+    // the root kind
+    ["K", "30023"],
+
+    // the parent event address (same as root for top-level comments)
+    ["a", "30023:3c9849383bdea883b0bd16fece1ed36d37e37cdde3ce43b17ea4e9192ec11289:f9347ca7", "wss://example.relay"],
+    // when the parent event is replaceable or addressable, also include an `e` tag referencing its id
+    ["e", "5b4fc7fed15672fefe65d2426f67197b71ccc82aa0cc8a9e94f683eb78e07651", "wss://example.relay"],
+    // the parent event kind
+    ["k", "30023"]
+  ]
+  // other fields
+}
+```
+
+A comment on a [NIP-94](94.md) file looks like this:
+
+```js
+{
+  kind: 1111,
+  content: 'Great file!',
+  tags: [
+    // top-level comments have the same scope and reply to addresses or ids
+    ["E", "768ac8720cdeb59227cf95e98b66560ef03d8bc9a90d721779e76e68fb42f5e6", "wss://example.relay", "3721e07b079525289877c366ccab47112bdff3d1b44758ca333feb2dbbbbe5bb"],
+    // the root kind
+    ["K", "1063"],
+
+    // the parent event id (same as root for top-level comments)
+    ["e", "768ac8720cdeb59227cf95e98b66560ef03d8bc9a90d721779e76e68fb42f5e6", "wss://example.relay", "3721e07b079525289877c366ccab47112bdff3d1b44758ca333feb2dbbbbe5bb"],
+    // the parent kind
+    ["k", "1063"]
+  ]
+  // other fields
+}
+```
+
+A reply to a comment looks like this:
+
+```js
+{
+  kind: 1111,
+  content: 'This is a reply to "Great file!"',
+  tags: [
+    // nip-94 file event id
+    ["E", "768ac8720cdeb59227cf95e98b66560ef03d8bc9a90d721779e76e68fb42f5e6", "wss://example.relay", "fd913cd6fa9edb8405750cd02a8bbe16e158b8676c0e69fdc27436cc4a54cc9a"],
+    // the root kind
+    ["K", "1063"],
+
+    // the parent event
+    ["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://example.relay", "93ef2ebaaf9554661f33e79949007900bbc535d239a4c801c33a4d67d3e7f546"],
+    // the parent kind
+    ["k", "1111"]
+  ]
+  // other fields
+}
+```
+
+A comment on a website's url looks like this:
+
+```js
+{
+  kind: 1111,
+  content: 'Nice article!',
+  tags: [
+    // referencing the root url
+    ["I", "https://abc.com/articles/1"],
+    // the root "kind": for an url, the kind is its domain
+    ["K", "https://abc.com"],
+
+    // the parent reference (same as root for top-level comments)
+    ["i", "https://abc.com/articles/1"],
+    // the parent "kind": for an url, the kind is its domain
+    ["k", "https://abc.com"]
+  ]
+  // other fields
+}
+```
+
+A podcast comment example:
+
+```js
+{
+  id: "80c48d992a38f9c445b943a9c9f1010b396676013443765750431a9004bdac05",
+  pubkey: "252f10c83610ebca1a059c0bae8255eba2f95be4d1d7bcfa89d7248a82d9f111",
+  kind: 1111,
+  content: "This was a great episode!",
+  tags: [
+    // podcast episode reference
+    ["I", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f", "https://fountain.fm/episode/z1y9TMQRuqXl2awyrQxg"],
+    // podcast episode type
+    ["K", "podcast:item:guid"],
+
+    // same value as "I" tag above, because it is a top-level comment (not a reply to a comment)
+    ["i", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f", "https://fountain.fm/episode/z1y9TMQRuqXl2awyrQxg"],
+    ["k", "podcast:item:guid"]
+  ]
+  // other fields
+}
+```
+
+A reply to a podcast comment:
+
+```js
+{
+  kind: 1111,
+  content: "I'm replying to the above comment.",
+  tags: [
+    // podcast episode reference
+    ["I", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f", "https://fountain.fm/episode/z1y9TMQRuqXl2awyrQxg"],
+    // podcast episode type
+    ["K", "podcast:item:guid"],
+
+    // this is a reference to the above comment
+    ["e", "80c48d992a38f9c445b943a9c9f1010b396676013443765750431a9004bdac05", "wss://example.relay", "252f10c83610ebca1a059c0bae8255eba2f95be4d1d7bcfa89d7248a82d9f111"],
+    // the parent comment kind
+    ["k", "1111"]
+  ]
+  // other fields
+}
+```
-- 
cgit v1.2.3


From f3244a0903b1fedbd8aa89596c658c9529e19ea6 Mon Sep 17 00:00:00 2001
From: hakkadaikon <hakkadaikon@yahoo.co.jp>
Date: Mon, 18 Nov 2024 02:33:29 +0900
Subject: js,json -> jsonc

---
 11.md |  4 ++--
 17.md |  2 +-
 22.md | 14 +++++++-------
 29.md |  2 +-
 46.md |  8 ++++----
 96.md |  4 ++--
 6 files changed, 17 insertions(+), 17 deletions(-)

(limited to '22.md')

diff --git a/11.md b/11.md
index 8efd0f0..8af4f31 100644
--- a/11.md
+++ b/11.md
@@ -262,7 +262,7 @@ processed by appropriate client software.
 
 Relays that require payments may want to expose their fee schedules.
 
-```json
+```jsonc
 {
   "payments_url": "https://my-relay/payments",
   "fees": {
@@ -270,7 +270,7 @@ Relays that require payments may want to expose their fee schedules.
     "subscription": [{ "amount": 5000000, "unit": "msats", "period": 2592000 }],
     "publication": [{ "kinds": [4], "amount": 100, "unit": "msats" }],
   },
-  ...
+  // other fields...
 }
 ```
 
diff --git a/17.md b/17.md
index 4b96bce..72f40c4 100644
--- a/17.md
+++ b/17.md
@@ -47,7 +47,7 @@ An optional `subject` tag defines the current name/topic of the conversation. An
 
 Following [NIP-59](59.md), the **unsigned** `kind:14` chat message must be sealed (`kind:13`) and then gift-wrapped (`kind:1059`) to each receiver and the sender individually.
 
-```js
+```jsonc
 {
   "id": "<usual hash>",
   "pubkey": randomPublicKey,
diff --git a/22.md b/22.md
index 3706aec..f11925f 100644
--- a/22.md
+++ b/22.md
@@ -13,7 +13,7 @@ It uses `kind:1111` with plaintext `.content` (no HTML, Markdown, or other forma
 Comments MUST point to the root scope using uppercase tag names (e.g. `K`, `E`, `A` or `I`)
 and MUST point to the parent item with lowercase ones (e.g. `k`, `e`, `a` or `i`).
 
-```js
+```jsonc
 {
   kind: 1111,
   content: '<comment>',
@@ -56,7 +56,7 @@ If the parent item is an event, a `p` tag set to the parent event's author SHOUL
 
 A comment on a blog post looks like this:
 
-```js
+```jsonc
 {
   kind: 1111,
   content: 'Great blog post!',
@@ -79,7 +79,7 @@ A comment on a blog post looks like this:
 
 A comment on a [NIP-94](94.md) file looks like this:
 
-```js
+```jsonc
 {
   kind: 1111,
   content: 'Great file!',
@@ -100,7 +100,7 @@ A comment on a [NIP-94](94.md) file looks like this:
 
 A reply to a comment looks like this:
 
-```js
+```jsonc
 {
   kind: 1111,
   content: 'This is a reply to "Great file!"',
@@ -121,7 +121,7 @@ A reply to a comment looks like this:
 
 A comment on a website's url looks like this:
 
-```js
+```jsonc
 {
   kind: 1111,
   content: 'Nice article!',
@@ -142,7 +142,7 @@ A comment on a website's url looks like this:
 
 A podcast comment example:
 
-```js
+```jsonc
 {
   id: "80c48d992a38f9c445b943a9c9f1010b396676013443765750431a9004bdac05",
   pubkey: "252f10c83610ebca1a059c0bae8255eba2f95be4d1d7bcfa89d7248a82d9f111",
@@ -164,7 +164,7 @@ A podcast comment example:
 
 A reply to a podcast comment:
 
-```js
+```jsonc
 {
   kind: 1111,
   content: "I'm replying to the above comment.",
diff --git a/29.md b/29.md
index f0ba8ab..a116433 100644
--- a/29.md
+++ b/29.md
@@ -141,7 +141,7 @@ These are events expected to be sent by the relay master key or by group admins
 
 Clients 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`).
 
-```json
+```jsonc
 {
   "kind": 90xx,
   "content": "optional reason",
diff --git a/46.md b/46.md
index 60850aa..ce6764d 100644
--- a/46.md
+++ b/46.md
@@ -58,7 +58,7 @@ _user_ passes this token to _remote-signer_, which then sends `connect` *respons
 
 ## Request Events `kind: 24133`
 
-```js
+```jsonc
 {
     "kind": 24133,
     "pubkey": <local_keypair_pubkey>,
@@ -136,7 +136,7 @@ The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted
 
 ### Signature request
 
-```js
+```jsonc
 {
     "kind": 24133,
     "pubkey": "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86",
@@ -156,7 +156,7 @@ The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted
 
 ### Response event
 
-```js
+```jsonc
 {
     "kind": 24133,
     "pubkey": "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52",
@@ -196,7 +196,7 @@ _client_ should display (in a popup or new tab) the URL from the `error` field a
 ### Announcing _remote-signer_ metadata
 
 _remote-signer_ MAY publish it's metadata by using [NIP-05](05.md) and [NIP-89](89.md). With NIP-05, a request to `<remote-signer>/.well-known/nostr.json?name=_` MAY return this:
-```
+```jsonc
 {
     "names":{
         "_": <remote-signer-app-pubkey>,
diff --git a/96.md b/96.md
index 05c1b18..3828e76 100644
--- a/96.md
+++ b/96.md
@@ -323,8 +323,8 @@ Note: HTTP File Storage Server developers may skip this section. This is meant f
 A File Server Preference event is a kind 10096 replaceable event meant to select one or more servers the user wants
 to upload files to. Servers are listed as `server` tags:
 
-```json
-{.
+```jsonc
+{
   "kind": 10096,
   "content": "",
   "tags": [
-- 
cgit v1.2.3