upleb.uk

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

summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOscar Merry <MerryOscar@users.noreply.github.com>2024-05-20 11:12:03 +0100
committerGitHub <noreply@github.com>2024-05-20 11:12:03 +0100
commit32004283da0f0893d7b697c9a0b1a1f8611e9929 (patch)
treec9d13b72167c51968ee934e0f5af4e4a9419b70b
parentd33b223c6afe2be3d197d2cdb4686961a6fb2b29 (diff)
parentd85c3478137c3a17d7a1bdfce4c3cc9ddf7431e3 (diff)
Merge branch 'master' into external-content-ids
-rw-r--r--01.md2
-rw-r--r--04.md2
-rw-r--r--11.md2
-rw-r--r--17.md164
-rw-r--r--24.md2
-rw-r--r--25.md17
-rw-r--r--32.md8
-rw-r--r--34.md13
-rw-r--r--46.md35
-rw-r--r--47.md6
-rw-r--r--51.md26
-rw-r--r--54.md112
-rw-r--r--56.md1
-rw-r--r--59.md2
-rw-r--r--72.md2
-rw-r--r--90.md8
-rw-r--r--BREAKING.md3
-rw-r--r--README.md14
18 files changed, 358 insertions, 61 deletions
diff --git a/01.md b/01.md
index a91febc..8be85bc 100644
--- a/01.md
+++ b/01.md
@@ -56,7 +56,7 @@ To prevent implementation differences from creating a different event ID for the
56 56
57### Tags 57### Tags
58 58
59Each tag is an array of strings of arbitrary size, with some conventions around them. Take a look at the example below: 59Each tag is an array of one or more strings, with some conventions around them. Take a look at the example below:
60 60
61```jsonc 61```jsonc
62{ 62{
diff --git a/04.md b/04.md
index dc232b4..a561a2f 100644
--- a/04.md
+++ b/04.md
@@ -1,4 +1,4 @@
1> __Warning__ `unrecommended`: deprecated in favor of [NIP-44](44.md) 1> __Warning__ `unrecommended`: deprecated in favor of [NIP-17](17.md)
2 2
3NIP-04 3NIP-04
4====== 4======
diff --git a/11.md b/11.md
index 45102d7..a50038a 100644
--- a/11.md
+++ b/11.md
@@ -37,7 +37,7 @@ Detailed plain-text information about the relay may be contained in the `descrip
37 37
38### Pubkey 38### Pubkey
39 39
40An administrative contact may be listed with a `pubkey`, in the same format as Nostr events (32-byte hex for a `secp256k1` public key). If a contact is listed, this provides clients with a recommended address to send encrypted direct messages (See `NIP-04`) to a system administrator. Expected uses of this address are to report abuse or illegal content, file bug reports, or request other technical assistance. 40An administrative contact may be listed with a `pubkey`, in the same format as Nostr events (32-byte hex for a `secp256k1` public key). If a contact is listed, this provides clients with a recommended address to send encrypted direct messages (See [NIP-17](17.md)) to a system administrator. Expected uses of this address are to report abuse or illegal content, file bug reports, or request other technical assistance.
41 41
42Relay operators have no obligation to respond to direct messages. 42Relay operators have no obligation to respond to direct messages.
43 43
diff --git a/17.md b/17.md
new file mode 100644
index 0000000..0f51367
--- /dev/null
+++ b/17.md
@@ -0,0 +1,164 @@
1NIP-17
2======
3
4Private Direct Messages
5-----------------------
6
7`draft` `optional`
8
9This NIP defines an encrypted direct messaging scheme using [NIP-44](44.md) encryption and [NIP-59](59.md) seals and gift wraps.
10
11## Direct Message Kind
12
13Kind `14` is a chat message. `p` tags identify one or more receivers of the message.
14
15```js
16{
17 "id": "<usual hash>",
18  "pubkey": "<sender-pubkey>",
19 "created_at": now(),
20  "kind": 14,
21  "tags": [
22    ["p", "<receiver-1-pubkey>", "<relay-url>"],
23    ["p", "<receiver-2-pubkey>", "<relay-url>"],
24    ["e", "<kind-14-id>", "<relay-url>", "reply"] // if this is a reply
25 ["subject", "<conversation-title>"],
26    ...
27  ],
28  "content": "<message-in-plain-text>",
29}
30```
31
32`.content` MUST be plain text. Fields `id` and `created_at` are required.
33
34Tags that mention, quote and assemble threading structures MUST follow [NIP-10](10.md).
35
36Kind `14`s MUST never be signed. If it is signed, the message might leak to relays and become **fully public**.
37
38## Chat Rooms
39
40The set of `pubkey` + `p` tags defines a chat room. If a new `p` tag is added or a current one is removed, a new room is created with clean message history.
41
42Clients SHOULD render messages of the same room in a continuous thread.
43
44An optional `subject` tag defines the current name/topic of the conversation. Any member can change the topic by simply submitting a new `subject` to an existing `pubkey` + `p`-tags room. There is no need to send `subject` in every message. The newest `subject` in the thread is the subject of the conversation.
45
46## Encrypting
47
48Following [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.
49
50```js
51{
52 "id": "<usual hash>",
53  "pubkey": randomPublicKey,
54  "created_at": randomTimeUpTo2DaysInThePast(),
55 "kind": 1059, // gift wrap
56  "tags": [
57    ["p", receiverPublicKey, "<relay-url>"] // receiver
58  ],
59  "content": nip44Encrypt(
60    {
61 "id": "<usual hash>",
62      "pubkey": senderPublicKey,
63      "created_at": randomTimeUpTo2DaysInThePast(),
64      "kind": 13, // seal
65      "tags": [], // no tags
66      "content": nip44Encrypt(unsignedKind14, senderPrivateKey, receiverPublicKey),
67      "sig": "<signed by senderPrivateKey>"
68    },
69    randomPrivateKey, receiverPublicKey
70  ),
71  "sig": "<signed by randomPrivateKey>"
72}
73```
74
75The encryption algorithm MUST use the latest version of [NIP-44](44.md).
76
77Clients MUST verify if pubkey of the `kind:13` is the same pubkey on the `kind:14`, otherwise any sender can impersonate others by simply changing the pubkey on `kind:14`.
78
79Clients SHOULD randomize `created_at` in up to two days in the past in both the seal and the gift wrap to make sure grouping by `created_at` doesn't reveal any metadata.
80
81The gift wrap's `p`-tag can be the receiver's main pubkey or an alias key created to receive DMs without exposing the receiver's identity.
82
83Clients CAN offer disappearing messages by setting an `expiration` tag in the gift wrap of each receiver or by not generating a gift wrap to the sender's public key
84
85## Publishing
86
87Kind `10050` indicates the user's preferred relays to receive DMs. The event MUST include a list of `relay` tags with relay URIs.
88
89```js
90{
91 "kind": 10050,
92 "tags": [
93 ["relay", "wss://inbox.nostr.wine"],
94 ["relay", "wss://myrelay.nostr1.com"],
95 ],
96 "content": "",
97 //...other fields
98}
99```
100
101Clients SHOULD publish kind `14` events to the `10050`-listed relays. If that is not found that indicates the user is not ready to receive messages under this NIP and clients shouldn't try.
102
103## Relays
104
105It's advisable that relays do not serve `kind:14` to clients other than the ones tagged in them.
106
107It's advisable that users choose relays that conform to these practices.
108
109Clients SHOULD guide users to keep `kind:10050` lists small (1-3 relays) and SHOULD spread it to as many relays as viable.
110
111## Benefits & Limitations
112
113This NIP offers the following privacy and security features:
114
1151. **No Metadata Leak**: Participant identities, each message's real date and time, event kinds, and other event tags are all hidden from the public. Senders and receivers cannot be linked with public information alone.
1162. **No Public Group Identifiers**: There is no public central queue, channel or otherwise converging identifier to correlate or count all messages in the same group.
1173. **No Moderation**: There are no group admins: no invitations or bans.
1184. **No Shared Secrets**: No secret must be known to all members that can leak or be mistakenly shared
1195. **Fully Recoverable**: Messages can be fully recoverable by any client with the user's private key
1206. **Optional Forward Secrecy**: Users and clients can opt-in for "disappearing messages".
1217. **Uses Public Relays**: Messages can flow through public relays without loss of privacy. Private relays can increase privacy further, but they are not required.
1228. **Cold Storage**: Users can unilaterally opt-in to sharing their messages with a separate key that is exclusive for DM backup and recovery.
123
124The main limitation of this approach is having to send a separate encrypted event to each receiver. Group chats with more than 100 participants should find a more suitable messaging scheme.
125
126## Implementation
127
128Clients implementing this NIP should by default only connect to the set of relays found in their `kind:10050` list. From that they should be able to load all messages both sent and received as well as get new live updates, making it for a very simple and lightweight implementation that should be fast.
129
130When sending a message to anyone, clients must then connect to the relays in the receiver's `kind:10050` and send the events there, but can disconnect right after unless more messages are expected to be sent (e.g. the chat tab is still selected). Clients should also send a copy of their outgoing messages to their own `kind:10050` relay set.
131
132## Examples
133
134This example sends the message `Hola, que tal?` from `nsec1w8udu59ydjvedgs3yv5qccshcj8k05fh3l60k9x57asjrqdpa00qkmr89m` to `nsec12ywtkplvyq5t6twdqwwygavp5lm4fhuang89c943nf2z92eez43szvn4dt`.
135
136The two final GiftWraps, one to the receiver and the other to the sender, are:
137
138```json
139{
140 "id":"2886780f7349afc1344047524540ee716f7bdc1b64191699855662330bf235d8",
141 "pubkey":"8f8a7ec43b77d25799281207e1a47f7a654755055788f7482653f9c9661c6d51",
142 "created_at":1703128320,
143 "kind":1059,
144 "tags":[
145 [ "p", "918e2da906df4ccd12c8ac672d8335add131a4cf9d27ce42b3bb3625755f0788"]
146 ],
147 "content":"AsqzdlMsG304G8h08bE67dhAR1gFTzTckUUyuvndZ8LrGCvwI4pgC3d6hyAK0Wo9gtkLqSr2rT2RyHlE5wRqbCOlQ8WvJEKwqwIJwT5PO3l2RxvGCHDbd1b1o40ZgIVwwLCfOWJ86I5upXe8K5AgpxYTOM1BD+SbgI5jOMA8tgpRoitJedVSvBZsmwAxXM7o7sbOON4MXHzOqOZpALpS2zgBDXSAaYAsTdEM4qqFeik+zTk3+L6NYuftGidqVluicwSGS2viYWr5OiJ1zrj1ERhYSGLpQnPKrqDaDi7R1KrHGFGyLgkJveY/45y0rv9aVIw9IWF11u53cf2CP7akACel2WvZdl1htEwFu/v9cFXD06fNVZjfx3OssKM/uHPE9XvZttQboAvP5UoK6lv9o3d+0GM4/3zP+yO3C0NExz1ZgFmbGFz703YJzM+zpKCOXaZyzPjADXp8qBBeVc5lmJqiCL4solZpxA1865yPigPAZcc9acSUlg23J1dptFK4n3Tl5HfSHP+oZ/QS/SHWbVFCtq7ZMQSRxLgEitfglTNz9P1CnpMwmW/Y4Gm5zdkv0JrdUVrn2UO9ARdHlPsW5ARgDmzaxnJypkfoHXNfxGGXWRk0sKLbz/ipnaQP/eFJv/ibNuSfqL6E4BnN/tHJSHYEaTQ/PdrA2i9laG3vJti3kAl5Ih87ct0w/tzYfp4SRPhEF1zzue9G/16eJEMzwmhQ5Ec7jJVcVGa4RltqnuF8unUu3iSRTQ+/MNNUkK6Mk+YuaJJs6Fjw6tRHuWi57SdKKv7GGkr0zlBUU2Dyo1MwpAqzsCcCTeQSv+8qt4wLf4uhU9Br7F/L0ZY9bFgh6iLDCdB+4iABXyZwT7Ufn762195hrSHcU4Okt0Zns9EeiBOFxnmpXEslYkYBpXw70GmymQfJlFOfoEp93QKCMS2DAEVeI51dJV1e+6t3pCSsQN69Vg6jUCsm1TMxSs2VX4BRbq562+VffchvW2BB4gMjsvHVUSRl8i5/ZSDlfzSPXcSGALLHBRzy+gn0oXXJ/447VHYZJDL3Ig8+QW5oFMgnWYhuwI5QSLEyflUrfSz+Pdwn/5eyjybXKJftePBD9Q+8NQ8zulU5sqvsMeIx/bBUx0fmOXsS3vjqCXW5IjkmSUV7q54GewZqTQBlcx+90xh/LSUxXex7UwZwRnifvyCbZ+zwNTHNb12chYeNjMV7kAIr3cGQv8vlOMM8ajyaZ5KVy7HpSXQjz4PGT2/nXbL5jKt8Lx0erGXsSsazkdoYDG3U",
148 "sig":"a3c6ce632b145c0869423c1afaff4a6d764a9b64dedaf15f170b944ead67227518a72e455567ca1c2a0d187832cecbde7ed478395ec4c95dd3e71749ed66c480"
149}
150```
151
152```json
153{
154 "id":"162b0611a1911cfcb30f8a5502792b346e535a45658b3a31ae5c178465509721",
155 "pubkey":"626be2af274b29ea4816ad672ee452b7cf96bbb4836815a55699ae402183f512",
156 "created_at":1702711587,
157 "kind":1059,
158 "tags":[
159 [ "p", "44900586091b284416a0c001f677f9c49f7639a55c3f1e2ec130a8e1a7998e1b"]
160 ],
161 "content":"AsTClTzr0gzXXji7uye5UB6LYrx3HDjWGdkNaBS6BAX9CpHa+Vvtt5oI2xJrmWLen+Fo2NBOFazvl285Gb3HSM82gVycrzx1HUAaQDUG6HI7XBEGqBhQMUNwNMiN2dnilBMFC3Yc8ehCJT/gkbiNKOpwd2rFibMFRMDKai2mq2lBtPJF18oszKOjA+XlOJV8JRbmcAanTbEK5nA/GnG3eGUiUzhiYBoHomj3vztYYxc0QYHOx0WxiHY8dsC6jPsXC7f6k4P+Hv5ZiyTfzvjkSJOckel1lZuE5SfeZ0nduqTlxREGeBJ8amOykgEIKdH2VZBZB+qtOMc7ez9dz4wffGwBDA7912NFS2dPBr6txHNxBUkDZKFbuD5wijvonZDvfWq43tZspO4NutSokZB99uEiRH8NAUdGTiNb25m9JcDhVfdmABqTg5fIwwTwlem5aXIy8b66lmqqz2LBzJtnJDu36bDwkILph3kmvaKPD8qJXmPQ4yGpxIbYSTCohgt2/I0TKJNmqNvSN+IVoUuC7ZOfUV9lOV8Ri0AMfSr2YsdZ9ofV5o82ClZWlWiSWZwy6ypa7CuT1PEGHzywB4CZ5ucpO60Z7hnBQxHLiAQIO/QhiBp1rmrdQZFN6PUEjFDloykoeHe345Yqy9Ke95HIKUCS9yJurD+nZjjgOxZjoFCsB1hQAwINTIS3FbYOibZnQwv8PXvcSOqVZxC9U0+WuagK7IwxzhGZY3vLRrX01oujiRrevB4xbW7Oxi/Agp7CQGlJXCgmRE8Rhm+Vj2s+wc/4VLNZRHDcwtfejogjrjdi8p6nfUyqoQRRPARzRGUnnCbh+LqhigT6gQf3sVilnydMRScEc0/YYNLWnaw9nbyBa7wFBAiGbJwO40k39wj+xT6HTSbSUgFZzopxroO3f/o4+ubx2+IL3fkev22mEN38+dFmYF3zE+hpE7jVxrJpC3EP9PLoFgFPKCuctMnjXmeHoiGs756N5r1Mm1ffZu4H19MSuALJlxQR7VXE/LzxRXDuaB2u9days/6muP6gbGX1ASxbJd/ou8+viHmSC/ioHzNjItVCPaJjDyc6bv+gs1NPCt0qZ69G+JmgHW/PsMMeL4n5bh74g0fJSHqiI9ewEmOG/8bedSREv2XXtKV39STxPweceIOh0k23s3N6+wvuSUAJE7u1LkDo14cobtZ/MCw/QhimYPd1u5HnEJvRhPxz0nVPz0QqL/YQeOkAYk7uzgeb2yPzJ6DBtnTnGDkglekhVzQBFRJdk740LEj6swkJ",
162 "sig":"c94e74533b482aa8eeeb54ae72a5303e0b21f62909ca43c8ef06b0357412d6f8a92f96e1a205102753777fd25321a58fba3fb384eee114bd53ce6c06a1c22bab"
163}
164```
diff --git a/24.md b/24.md
index a17b334..99fcedf 100644
--- a/24.md
+++ b/24.md
@@ -41,4 +41,4 @@ These tags may be present in multiple event kinds. Whenever a different meaning
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 - `i`: an external id the event is referring to in some way - see [NIP-XX](XX.md) 43 - `i`: an external id the event is referring to in some way - see [NIP-XX](XX.md)
44 - `title`: title of the event 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
diff --git a/25.md b/25.md
index 3b4aa59..7cc96b5 100644
--- a/25.md
+++ b/25.md
@@ -25,14 +25,16 @@ consider it a "+".
25Tags 25Tags
26---- 26----
27 27
28The reaction event SHOULD include `e` and `p` tags from the note the user is 28The reaction event SHOULD include `a`, `e` and `p` tags pointing to the note the user is
29reacting to. This allows users to be notified of reactions to posts they were 29reacting to. The `p` tag allows authors to be notified. The `e` tags enables clients
30mentioned in. Including the `e` tags enables clients to pull all the reactions 30to pull all the reactions to individual events and `a` tags enables clients to seek reactions
31associated with individual posts or all the posts in a thread. 31for all versions of a replaceable event.
32 32
33The last `e` tag MUST be the `id` of the note that is being reacted to. 33The `e` tag MUST be the `id` of the note that is being reacted to.
34 34
35The last `p` tag MUST be the `pubkey` of the event being reacted to. 35The `a` tag MUST contain the coordinates (`kind:pubkey:d-tag`) of the replaceable being reacted to.
36
37The `p` tag MUST be the `pubkey` of the event being reacted to.
36 38
37The reaction event MAY include a `k` tag with the stringified kind number 39The reaction event MAY include a `k` tag with the stringified kind number
38of the reacted event as its value. 40of the reacted event as its value.
@@ -41,9 +43,6 @@ Example code
41 43
42```swift 44```swift
43func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> NostrEvent { 45func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> NostrEvent {
44 var tags: [[String]] = liked.tags.filter {
45 tag in tag.count >= 2 && (tag[0] == "e" || tag[0] == "p")
46 }
47 tags.append(["e", liked.id]) 46 tags.append(["e", liked.id])
48 tags.append(["p", liked.pubkey]) 47 tags.append(["p", liked.pubkey])
49 tags.append(["k", liked.kind]) 48 tags.append(["k", liked.kind])
diff --git a/32.md b/32.md
index be4e872..92497a6 100644
--- a/32.md
+++ b/32.md
@@ -151,3 +151,11 @@ A good heuristic for whether a use case fits this NIP is whether labels would ev
151For example, many events might be labeled with a particular place, topic, or pubkey, but labels 151For example, many events might be labeled with a particular place, topic, or pubkey, but labels
152with specific values like "John Doe" or "3.18743" are not labels, they are values, and should 152with specific values like "John Doe" or "3.18743" are not labels, they are values, and should
153be handled in some other way. 153be handled in some other way.
154
155
156Appendix: Known Ontologies
157-------------------------
158
159Below is a non-exhaustive list of ontologies currently in widespread use.
160
161- (social.ontolo.categories)[https://ontolo.social/]
diff --git a/34.md b/34.md
index f72fcf2..fcc2cec 100644
--- a/34.md
+++ b/34.md
@@ -23,8 +23,7 @@ Git repositories are hosted in Git-enabled servers, but their existence can be a
23 ["web", "<url for browsing>", ...], // a webpage url, if the git server being used provides such a thing 23 ["web", "<url for browsing>", ...], // a webpage url, if the git server being used provides such a thing
24 ["clone", "<url for git-cloning>", ...], // a url to be given to `git clone` so anyone can clone it 24 ["clone", "<url for git-cloning>", ...], // a url to be given to `git clone` so anyone can clone it
25 ["relays", "<relay-url>", ...] // relays that this repository will monitor for patches and issues 25 ["relays", "<relay-url>", ...] // relays that this repository will monitor for patches and issues
26 ["earliest-unique-commit", "<commit-id>"] // usually root commit but a recent commit for forks 26 ["r", "<earliest-unique-commit-id>", "euc"]
27 ["r", "<earliest-unique-commit-id>"] // so clients can subscribe to all events related to a local git repo
28 ["maintainers", "<other-recognized-maintainer>", ...] 27 ["maintainers", "<other-recognized-maintainer>", ...]
29 ] 28 ]
30} 29}
@@ -32,13 +31,15 @@ Git repositories are hosted in Git-enabled servers, but their existence can be a
32 31
33The tags `web`, `clone`, `relays`, `maintainers` can have multiple values. 32The tags `web`, `clone`, `relays`, `maintainers` can have multiple values.
34 33
34The `r` tag annotated with the `"euc"` marker should be the commit ID of the earliest unique commit of this repo, made to identify it among forks and group it with other repositories hosted elsewhere that may represent essentially the same project. In most cases it will be the root commit of a repository. In case of a permanent fork between two projects, then the first commit after the fork should be used.
35
35Except `d`, all tags are optional. 36Except `d`, all tags are optional.
36 37
37## Patches 38## Patches
38 39
39Patches 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. 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.
40 41
41Patches in a patch set SHOULD include a NIP-10 `e` `reply` tag pointing to the previous patch. 42Patches in a patch set SHOULD include a NIP-10 `e` `reply` tag pointing to the previous patch.
42 43
43The first patch revision in a patch revision SHOULD include a NIP-10 `e` `reply` to the original root patch. 44The first patch revision in a patch revision SHOULD include a NIP-10 `e` `reply` to the original root patch.
44 45
@@ -124,7 +125,7 @@ Root Patches and Issues have a Status that defaults to 'Open' and can be set by
124 ["p", "<root-event-author>"], 125 ["p", "<root-event-author>"],
125 ["p", "<revision-author>"], 126 ["p", "<revision-author>"],
126 127
127 // optional for improved subscription filter efficency 128 // optional for improved subscription filter efficiency
128 ["a", "30617:<base-repo-owner-pubkey>:<base-repo-id>", "<relay-url>"], 129 ["a", "30617:<base-repo-owner-pubkey>:<base-repo-id>", "<relay-url>"],
129 ["r", "<earliest-unique-commit-id-of-repo>"] 130 ["r", "<earliest-unique-commit-id-of-repo>"]
130 131
@@ -132,7 +133,7 @@ Root Patches and Issues have a Status that defaults to 'Open' and can be set by
132 ["e", "<applied-or-merged-patch-event-id>", "", "mention"], // for each 133 ["e", "<applied-or-merged-patch-event-id>", "", "mention"], // for each
133 // when merged 134 // when merged
134 ["merge-commit", "<merge-commit-id>"] 135 ["merge-commit", "<merge-commit-id>"]
135 ["r", "<merge-commit-id>"] 136 ["r", "<merge-commit-id>"]
136 // when applied 137 // when applied
137 ["applied-as-commits", "<commit-id-in-master-branch>", ...] 138 ["applied-as-commits", "<commit-id-in-master-branch>", ...]
138 ["r", "<applied-commit-id>"] // for each 139 ["r", "<applied-commit-id>"] // for each
@@ -142,7 +143,7 @@ Root Patches and Issues have a Status that defaults to 'Open' and can be set by
142 143
143The Status event with the largest created_at date is valid. 144The Status event with the largest created_at date is valid.
144 145
145The Status of a patch-revision defaults to either that of the root-patch, or `1632` (Closed) if the root-patch's Status is `1631` and the patch-revision isn't tagged in the `1631` event. 146The Status of a patch-revision defaults to either that of the root-patch, or `1632` (Closed) if the root-patch's Status is `1631` and the patch-revision isn't tagged in the `1631` event.
146 147
147 148
148## Possible things to be added later 149## Possible things to be added later
diff --git a/46.md b/46.md
index 56b8402..1528116 100644
--- a/46.md
+++ b/46.md
@@ -61,8 +61,9 @@ nostrconnect://<local-keypair-pubkey>?relay=<wss://relay-to-connect-on>&metadata
61 "method": "sign_event", 61 "method": "sign_event",
62 "params": [json_stringified(<{ 62 "params": [json_stringified(<{
63 content: "Hello, I'm signing remotely", 63 content: "Hello, I'm signing remotely",
64 pubkey: "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", 64 kind: 1,
65 // ...the rest of the event data 65 tags: [],
66 created_at: 1714078911
66 }>)] 67 }>)]
67 }), 68 }),
68 "tags": [["p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"]], // p-tags the remote user pubkey 69 "tags": [["p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"]], // p-tags the remote user pubkey
@@ -118,21 +119,21 @@ The `content` field is a JSON-RPC-like message that is [NIP-04](https://github.c
118 119
119Each of the following are methods that the client sends to the remote signer. 120Each of the following are methods that the client sends to the remote signer.
120 121
121| Command | Params | Result | 122| Command | Params | Result |
122| ------------------------ | ------------------------------------------------- | ---------------------------------------------------------------------- | 123| ------------------------ | ------------------------------------------------- | ---------------------------------------------------------------------- |
123| `connect` | `[<remote_user_pubkey>, <optional_secret>, <optional_requested_permissions>]` | "ack" | 124| `connect` | `[<remote_user_pubkey>, <optional_secret>, <optional_requested_permissions>]` | "ack" |
124| `sign_event` | `[<json_stringified_event_to_sign>]` | `json_stringified(<signed_event>)` | 125| `sign_event` | `[<{kind, content, tags, created_at}>]` | `json_stringified(<signed_event>)` |
125| `ping` | `[]` | "pong" | 126| `ping` | `[]` | "pong" |
126| `get_relays` | `[]` | `json_stringified({<relay_url>: {read: <boolean>, write: <boolean>}})` | 127| `get_relays` | `[]` | `json_stringified({<relay_url>: {read: <boolean>, write: <boolean>}})` |
127| `get_public_key` | `[]` | `<hex-pubkey>` | 128| `get_public_key` | `[]` | `<hex-pubkey>` |
128| `nip04_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip04_ciphertext>` | 129| `nip04_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip04_ciphertext>` |
129| `nip04_decrypt` | `[<third_party_pubkey>, <nip04_ciphertext_to_decrypt>]` | `<plaintext>` | 130| `nip04_decrypt` | `[<third_party_pubkey>, <nip04_ciphertext_to_decrypt>]` | `<plaintext>` |
130| `nip44_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip44_ciphertext>` | 131| `nip44_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip44_ciphertext>` |
131| `nip44_decrypt` | `[<third_party_pubkey>, <nip44_ciphertext_to_decrypt>]` | `<plaintext>` | 132| `nip44_decrypt` | `[<third_party_pubkey>, <nip44_ciphertext_to_decrypt>]` | `<plaintext>` |
132 133
133### Requested permissions 134### Requested permissions
134 135
135The `connect` method may be provided with `optional_requested_permissions` for user convenience. The permissions are a comma-separated list of `method[:params]`, i.e. `nip04_encrypt,sign_event:4` meaning permissions to call `nip04_encrypt` and to call `sign_event` with `kind:4`. Optional parameter for `sign_event` is the kind number, parameters for other methods are to be defined later. 136The `connect` method may be provided with `optional_requested_permissions` for user convenience. The permissions are a comma-separated list of `method[:params]`, i.e. `nip04_encrypt,sign_event:4` meaning permissions to call `nip04_encrypt` and to call `sign_event` with `kind:4`. Optional parameter for `sign_event` is the kind number, parameters for other methods are to be defined later.
136 137
137## Response Events `kind:24133` 138## Response Events `kind:24133`
138 139
@@ -153,13 +154,13 @@ The `content` field is a JSON-RPC-like message that is [NIP-04](https://github.c
153{ 154{
154 "id": <request_id>, 155 "id": <request_id>,
155 "result": <results_string>, 156 "result": <results_string>,
156 "error": <error_string> 157 "error": <optional_error_string>
157} 158}
158``` 159```
159 160
160- `id` is the request ID that this response is for. 161- `id` is the request ID that this response is for.
161- `results` is a string of the result of the call (this can be either a string or a JSON stringified object) 162- `results` is a string of the result of the call (this can be either a string or a JSON stringified object)
162- `error` is an error in string form. 163- `error`, _optionally_, it is an error in string form, if any. Its presence indicates an error with the request.
163 164
164### Auth Challenges 165### Auth Challenges
165 166
@@ -207,7 +208,7 @@ When the user types a NIP-05 the client:
207 208
208#### Remote signer discovery via NIP-89 209#### Remote signer discovery via NIP-89
209 210
210In this last case, most often used to fascilitate an OAuth-like signin flow, the client first looks for remote signers that have announced themselves via NIP-89 application handler events. 211In this last case, most often used to facilitate an OAuth-like signin flow, the client first looks for remote signers that have announced themselves via NIP-89 application handler events.
211 212
212First the client will query for `kind: 31990` events that have a `k` tag of `24133`. 213First the client will query for `kind: 31990` events that have a `k` tag of `24133`.
213 214
diff --git a/47.md b/47.md
index 9033847..983d2c9 100644
--- a/47.md
+++ b/47.md
@@ -81,7 +81,7 @@ If the command was successful, the `error` field must be null.
81## Nostr Wallet Connect URI 81## Nostr Wallet Connect URI
82**client** discovers **wallet service** by scanning a QR code, handling a deeplink or pasting in a URI. 82**client** discovers **wallet service** by scanning a QR code, handling a deeplink or pasting in a URI.
83 83
84The **wallet service** generates this connection URI with protocol `nostr+walletconnect:` and base path it's hex-encoded `pubkey` with the following query string parameters: 84The **wallet service** generates this connection URI with protocol `nostr+walletconnect://` and base path it's hex-encoded `pubkey` with the following query string parameters:
85 85
86- `relay` Required. URL of the relay where the **wallet service** is connected and will be listening for events. May be more than one. 86- `relay` Required. URL of the relay where the **wallet service** is connected and will be listening for events. May be more than one.
87- `secret` Required. 32-byte randomly generated hex encoded string. The **client** MUST use this to sign events and encrypt payloads when communicating with the **wallet service**. 87- `secret` Required. 32-byte randomly generated hex encoded string. The **client** MUST use this to sign events and encrypt payloads when communicating with the **wallet service**.
@@ -95,7 +95,7 @@ The **client** should then store this connection and use it when the user wants
95 95
96### Example connection string 96### Example connection string
97```sh 97```sh
98nostr+walletconnect:b889ff5b1513b641e2a139f661a661364979c5beee91842f8f0ef42ab558e9d4?relay=wss%3A%2F%2Frelay.damus.io&secret=71a8c14c1407c113601079c4302dab36460f0ccd0ad506f1f2dc73b5100e4f3c 98nostr+walletconnect://b889ff5b1513b641e2a139f661a661364979c5beee91842f8f0ef42ab558e9d4?relay=wss%3A%2F%2Frelay.damus.io&secret=71a8c14c1407c113601079c4302dab36460f0ccd0ad506f1f2dc73b5100e4f3c
99``` 99```
100 100
101## Commands 101## Commands
@@ -402,7 +402,7 @@ Response:
402 402
403## Example pay invoice flow 403## Example pay invoice flow
404 404
4050. The user scans the QR code generated by the **wallet service** with their **client** application, they follow a `nostr+walletconnect:` deeplink or configure the connection details manually. 4050. The user scans the QR code generated by the **wallet service** with their **client** application, they follow a `nostr+walletconnect://` deeplink or configure the connection details manually.
4061. **client** sends an event to the **wallet service** with kind `23194`. The content is a `pay_invoice` request. The private key is the secret from the connection string above. 4061. **client** sends an event to the **wallet service** with kind `23194`. The content is a `pay_invoice` request. The private key is the secret from the connection string above.
4072. **wallet service** verifies that the author's key is authorized to perform the payment, decrypts the payload and sends the payment. 4072. **wallet service** verifies that the author's key is authorized to perform the payment, decrypts the payload and sends the payment.
4083. **wallet service** responds to the event by sending an event with kind `23195` and content being a response either containing an error message or a preimage. 4083. **wallet service** responds to the event by sending an event with kind `23195` and content being a response either containing an error message or a preimage.
diff --git a/51.md b/51.md
index 95acbc8..fb40b26 100644
--- a/51.md
+++ b/51.md
@@ -20,18 +20,20 @@ Standard lists use non-parameterized replaceable events, meaning users may only
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
23| name | kind | description | expected tag items | 23| name | kind | description | expected tag items |
24| --- | --- | --- | --- | 24| --- | --- | --- | --- |
25| Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags), `"word"` (lowercase string), `"e"` (threads) | 25| Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags), `"word"` (lowercase string), `"e"` (threads) |
26| Pinned notes | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | 26| Pinned notes | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) |
27| Bookmarks | 10003 | uncategorized, "global" list of things a user wants to save | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) | 27| Bookmarks | 10003 | uncategorized, "global" list of things a user wants to save | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) |
28| Communities | 10004 | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) | 28| Communities | 10004 | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) |
29| Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) | 29| Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) |
30| Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) | 30| Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) |
31| Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) | 31| Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) |
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| 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) |
35 37
36## Sets 38## Sets
37 39
diff --git a/54.md b/54.md
new file mode 100644
index 0000000..8823af9
--- /dev/null
+++ b/54.md
@@ -0,0 +1,112 @@
1NIP-54
2======
3
4Wiki
5----
6
7`draft` `optional`
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.
10
11Articles are identified by lowercase, normalized ascii `d` tags.
12
13### Articles
14```jsonc
15{
16 "content": "A wiki is a hypertext publication collaboratively edited and managed by its own audience.",
17 "tags": [
18 ["d", "wiki"],
19 ["title", "Wiki"],
20 ]
21}
22```
23
24### `d` tag normalization rules
25
26- Any non-letter character MUST be converted to a `-`.
27- All letters MUST be converted to lowercase.
28
29### Content rules
30
31The content should be Markdown, following the same rules as of [NIP-23](23.md), although it takes some extra (optional) metadata tags:
32
33 - `title`: for when the display title should be different from the `d` tag.
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
39### Merge Requests
40
41Event `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.
42
43[INSERT EVENT EXAMPLE]
44
45### Redirects
46
47Event `kind:30819` is also defined to stand for "wiki redirects", i.e. if one thinks `Shell structure` should redirect to `Thin-shell structure` they can issue one of these events instead of replicating the content. These events can be used for automatically redirecting between articles on a client, but also for generating crowdsourced "disambiguation" pages ([common in Wikipedia](https://en.wikipedia.org/wiki/Help:Disambiguation)).
48
49[INSERT EVENT EXAMPLE]
50
51How to decide what article to display
52-------------------------------------
53
54As there could be many articles for each given name, some kind of prioritization must be done by clients. Criteria for this should vary between users and clients, but some means that can be used are described below:
55
56### Reactions
57
58[NIP-25](25.md) reactions are very simple and can be used to create a simple web-of-trust between wiki article writers and their content. While just counting a raw number of "likes" is unproductive, reacting to any wiki article event with a `+` can be interpreted as a recommendation for that article specifically and a partial recommendation of the author of that article. When 2 or 3-level deep recommendations are followed, suddenly a big part of all the articles may have some form of tagging.
59
60### Relays
61
62[NIP-51](51.md) lists of relays can be created with the kind 10102 and then used by wiki clients in order to determine where to query articles first and to rank these differently in relation to other events fetched from other relays.
63
64### Contact lists
65
66[NIP-02](02.md) contact lists can form the basis of a recommendation system that is then expanded with relay lists and reaction lists through nested queries. These lists form a good starting point only because they are so widespread.
67
68### Wiki-related contact lists
69
70[NIP-51](51.md) lists can also be used to create a list of users that are trusted only in the context of wiki authorship or wiki curationship.
71
72Forks
73---------
74Wiki-events can tag other wiki-events with a `fork` marker to specify that this event came from a different version. Both `a` and `e` tags SHOULD be used and have the `fork` marker applied, to identify the exact version it was forked from.
75
76Deference
77---------
78Wiki-events can tag other wiki-events with a `defer` marker to indicate that it considers someone else's entry as a "better" version of itself. If using a `defer` marker both `a` and `e` tags SHOULD be used.
79
80This is a stronger signal of trust than a `+` reaction.
81
82This 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.
83
84Why Markdown?
85-------------
86
87If 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.
88
89On 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.
90
91# Appendix 1: Merge requests
92Users can request other users to get their entries merged into someone else's entry by creating a `kind:818` event.
93
94```jsonc
95{
96 "content": "I added information about how to make hot ice-creams",
97 "kind": 818,
98 "tags": [
99 [ "a", "30818:<destination-pubkey>:hot-ice-creams", "<relay-url>" ],
100 [ "e", "<version-against-which-the-modification-was-made>", "<relay-url>' ],
101 [ "p", "<destination-pubkey>" ],
102 [ "e", "<version-to-be-merged>", "<relay-url>", "source" ]
103 ]
104}
105```
106
107`.content`: an optional explanation detailing why this merge is being requested.
108`a` tag: tag of the article which should be modified (i.e. the target of this merge request).
109`e` tag: optional version of the article in which this modifications is based
110`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.
111
112The 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 `-`
diff --git a/56.md b/56.md
index 3209b80..fc8d898 100644
--- a/56.md
+++ b/56.md
@@ -26,6 +26,7 @@ A `report type` string MUST be included as the 3rd entry to the `e` or `p` tag
26being reported, which consists of the following report types: 26being reported, which consists of the following report types:
27 27
28- `nudity` - depictions of nudity, porn, etc. 28- `nudity` - depictions of nudity, porn, etc.
29- `malware` - virus, trojan horse, worm, robot, spyware, adware, back door, ransomware, rootkit, kidnapper, etc.
29- `profanity` - profanity, hateful speech, etc. 30- `profanity` - profanity, hateful speech, etc.
30- `illegal` - something which may be illegal in some jurisdiction 31- `illegal` - something which may be illegal in some jurisdiction
31- `spam` - spam 32- `spam` - spam
diff --git a/59.md b/59.md
index 7eff2b8..4dc857f 100644
--- a/59.md
+++ b/59.md
@@ -155,7 +155,7 @@ Sign the `gift wrap` using the random key generated in the previous step.
155 "created_at": 1703021488, 155 "created_at": 1703021488,
156 "pubkey": "18b1a75918f1f2c90c23da616bce317d36e348bcf5f7ba55e75949319210c87c", 156 "pubkey": "18b1a75918f1f2c90c23da616bce317d36e348bcf5f7ba55e75949319210c87c",
157 "id": "5c005f3ccf01950aa8d131203248544fb1e41a0d698e846bd419cec3890903ac", 157 "id": "5c005f3ccf01950aa8d131203248544fb1e41a0d698e846bd419cec3890903ac",
158 "sig": "35fabdae4634eb630880a1896a886e40fd6ea8a60958e30b89b33a93e6235df750097b04f9e13053764251b8bc5dd7e8e0794a3426a90b6bcc7e5ff660f54259" 158 "sig": "35fabdae4634eb630880a1896a886e40fd6ea8a60958e30b89b33a93e6235df750097b04f9e13053764251b8bc5dd7e8e0794a3426a90b6bcc7e5ff660f54259",
159 "tags": [["p", "166bf3765ebd1fc55decfe395beff2ea3b2a4e0a8946e7eb578512b555737c99"]], 159 "tags": [["p", "166bf3765ebd1fc55decfe395beff2ea3b2a4e0a8946e7eb578512b555737c99"]],
160} 160}
161``` 161```
diff --git a/72.md b/72.md
index 4bafce0..5a8be0a 100644
--- a/72.md
+++ b/72.md
@@ -76,7 +76,7 @@ The post-approval event MUST include `a` tags of the communities the moderator i
76 76
77It's recommended that multiple moderators approve posts to avoid deleting them from the community when a moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copy and re-sign of each moderator's approval events to make sure posts don't disappear with moderators. 77It's recommended that multiple moderators approve posts to avoid deleting them from the community when a moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copy and re-sign of each moderator's approval events to make sure posts don't disappear with moderators.
78 78
79Post Approvals of replaceable events can be created in three ways: (i) by tagging the replaceable event as an `e` tag if moderators want to approve each individual change to the repleceable event; (ii) by tagging the replaceable event as an `a` tag if the moderator authorizes the replaceable event author to make changes without additional approvals and (iii) by tagging the replaceable event with both its `e` and `a` tag which empowers clients to display the original and updated versions of the event, with appropriate remarks in the UI. Since relays are instructed to delete old versions of a replaceable event, the `.content` of an `e`-approval MUST have the specific version of the event or Clients might not be able to find that version of the content anywhere. 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.
80 80
81Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be included in all `34550:*` `a` tags. 81Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be included in all `34550:*` `a` tags.
82 82
diff --git a/90.md b/90.md
index 241eb38..5a15ebb 100644
--- a/90.md
+++ b/90.md
@@ -162,8 +162,8 @@ Service providers can give feedback about a job back to the customer.
162``` 162```
163 163
164* `content`: Either empty or a job-result (e.g. for partial-result samples) 164* `content`: Either empty or a job-result (e.g. for partial-result samples)
165* `amount` tag: as defined in the [Job Result](#job-result) section. 165* `amount` tag: as defined in the [Job Result](#job-result-kind6000-6999) section.
166* `status` tag: Service Providers SHOULD indicate what this feedback status refers to. [Appendix 1](#appendix-1-job-feedback-status) defines status. Extra human-readable information can be added as an extra argument. 166* `status` tag: Service Providers SHOULD indicate what this feedback status refers to. [Job Feedback Status](#job-feedback-status) defines status. Extra human-readable information can be added as an extra argument.
167 167
168* NOTE: If the input params requires input to be encrypted, then `content` field will have encrypted payload with `p` tag as key. 168* NOTE: If the input params requires input to be encrypted, then `content` field will have encrypted payload with `p` tag as key.
169 169
@@ -177,7 +177,7 @@ Service providers can give feedback about a job back to the customer.
177| `success` | Service Provider successfully processed the job. | 177| `success` | Service Provider successfully processed the job. |
178| `partial` | Service Provider partially processed the job. The `.content` might include a sample of the partial results. | 178| `partial` | Service Provider partially processed the job. The `.content` might include a sample of the partial results. |
179 179
180Any job feedback event MIGHT include results in the `.content` field, as described in the [Job Result](#job-result) section. This is useful for service providers to provide a sample of the results that have been processed so far. 180Any job feedback event MIGHT include results in the `.content` field, as described in the [Job Result](#job-result-kind6000-6999) section. This is useful for service providers to provide a sample of the results that have been processed so far.
181 181
182 182
183# Protocol Flow 183# Protocol Flow
@@ -199,7 +199,7 @@ Some service providers might choose to submit a `payment-required` as the first
199It's not up to this NIP to define how individual vending machines should choose to run their business. 199It's not up to this NIP to define how individual vending machines should choose to run their business.
200 200
201# Cancellation 201# Cancellation
202A job request might be cancelled by publishing a `kind:5` delete request event tagging the job request event. 202A job request might be canceled by publishing a `kind:5` delete request event tagging the job request event.
203 203
204# Appendix 1: Job chaining 204# Appendix 1: Job chaining
205A Customer MAY request multiple jobs to be processed as a chain, where the output of a job is the input of another job. (e.g. podcast transcription -> summarization of the transcription). This is done by specifying as input an event id of a different job with the `job` type. 205A Customer MAY request multiple jobs to be processed as a chain, where the output of a job is the input of another job. (e.g. podcast transcription -> summarization of the transcription). This is done by specifying as input an event id of a different job with the `job` type.
diff --git a/BREAKING.md b/BREAKING.md
index 8024814..7b48ee0 100644
--- a/BREAKING.md
+++ b/BREAKING.md
@@ -5,8 +5,9 @@ reverse chronological order.
5 5
6| Date | Commit | NIP | Change | 6| Date | Commit | NIP | Change |
7| ----------- | --------- | -------- | ------ | 7| ----------- | --------- | -------- | ------ |
8| 2024-04-30 | [bad88262](https://github.com/nostr-protocol/nips/commit/bad88262) | [NIP-34](34.md) | 'earliest-unique-commit' tag was removed (use 'r' tag instead) |
8| 2024-02-25 | [4a171cb0](https://github.com/nostr-protocol/nips/commit/4a171cb0) | [NIP-18](18.md) | quote repost should use `q` tag | 9| 2024-02-25 | [4a171cb0](https://github.com/nostr-protocol/nips/commit/4a171cb0) | [NIP-18](18.md) | quote repost should use `q` tag |
9| 2024-02-10 | [c6cd655c](https://github.com/nostr-protocol/nips/commit/c6cd655c) | [NIP-46](46.md) | Params were stringified | 10| 2024-02-21 | [c6cd655c](https://github.com/nostr-protocol/nips/commit/c6cd655c) | [NIP-46](46.md) | Params were stringified |
10| 2024-02-16 | [cbec02ab](https://github.com/nostr-protocol/nips/commit/cbec02ab) | [NIP-49](49.md) | Password first normalized to NFKC | 11| 2024-02-16 | [cbec02ab](https://github.com/nostr-protocol/nips/commit/cbec02ab) | [NIP-49](49.md) | Password first normalized to NFKC |
11| 2024-02-15 | [afbb8dd0](https://github.com/nostr-protocol/nips/commit/afbb8dd0) | [NIP-39](39.md) | PGP identity was removed | 12| 2024-02-15 | [afbb8dd0](https://github.com/nostr-protocol/nips/commit/afbb8dd0) | [NIP-39](39.md) | PGP identity was removed |
12| 2024-02-07 | [d3dad114](https://github.com/nostr-protocol/nips/commit/d3dad114) | [NIP-46](46.md) | Connection token format was changed | 13| 2024-02-07 | [d3dad114](https://github.com/nostr-protocol/nips/commit/d3dad114) | [NIP-46](46.md) | Connection token format was changed |
diff --git a/README.md b/README.md
index c3c5ef0..3209df9 100644
--- a/README.md
+++ b/README.md
@@ -25,7 +25,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
25- [NIP-01: Basic protocol flow description](01.md) 25- [NIP-01: Basic protocol flow description](01.md)
26- [NIP-02: Follow List](02.md) 26- [NIP-02: Follow List](02.md)
27- [NIP-03: OpenTimestamps Attestations for Events](03.md) 27- [NIP-03: OpenTimestamps Attestations for Events](03.md)
28- [NIP-04: Encrypted Direct Message](04.md) --- **unrecommended**: deprecated in favor of [NIP-44](44.md) 28- [NIP-04: Encrypted Direct Message](04.md) --- **unrecommended**: deprecated in favor of [NIP-17](17.md)
29- [NIP-05: Mapping Nostr keys to DNS-based internet identifiers](05.md) 29- [NIP-05: Mapping Nostr keys to DNS-based internet identifiers](05.md)
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)
@@ -36,6 +36,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
36- [NIP-13: Proof of Work](13.md) 36- [NIP-13: Proof of Work](13.md)
37- [NIP-14: Subject tag in text events](14.md) 37- [NIP-14: Subject tag in text events](14.md)
38- [NIP-15: Nostr Marketplace (for resilient marketplaces)](15.md) 38- [NIP-15: Nostr Marketplace (for resilient marketplaces)](15.md)
39- [NIP-17: Private Direct Messages](17.md)
39- [NIP-18: Reposts](18.md) 40- [NIP-18: Reposts](18.md)
40- [NIP-19: bech32-encoded entities](19.md) 41- [NIP-19: bech32-encoded entities](19.md)
41- [NIP-21: `nostr:` URI scheme](21.md) 42- [NIP-21: `nostr:` URI scheme](21.md)
@@ -65,6 +66,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
65- [NIP-51: Lists](51.md) 66- [NIP-51: Lists](51.md)
66- [NIP-52: Calendar Events](52.md) 67- [NIP-52: Calendar Events](52.md)
67- [NIP-53: Live Activities](53.md) 68- [NIP-53: Live Activities](53.md)
69- [NIP-54: Wiki](54.md)
68- [NIP-56: Reporting](56.md) 70- [NIP-56: Reporting](56.md)
69- [NIP-57: Lightning Zaps](57.md) 71- [NIP-57: Lightning Zaps](57.md)
70- [NIP-58: Badges](58.md) 72- [NIP-58: Badges](58.md)
@@ -99,12 +101,14 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
99| `11` | Group Thread | [29](29.md) | 101| `11` | Group Thread | [29](29.md) |
100| `12` | Group Thread Reply | [29](29.md) | 102| `12` | Group Thread Reply | [29](29.md) |
101| `13` | Seal | [59](59.md) | 103| `13` | Seal | [59](59.md) |
104| `14` | Direct Message | [17](17.md) |
102| `16` | Generic Repost | [18](18.md) | 105| `16` | Generic Repost | [18](18.md) |
103| `40` | Channel Creation | [28](28.md) | 106| `40` | Channel Creation | [28](28.md) |
104| `41` | Channel Metadata | [28](28.md) | 107| `41` | Channel Metadata | [28](28.md) |
105| `42` | Channel Message | [28](28.md) | 108| `42` | Channel Message | [28](28.md) |
106| `43` | Channel Hide Message | [28](28.md) | 109| `43` | Channel Hide Message | [28](28.md) |
107| `44` | Channel Mute User | [28](28.md) | 110| `44` | Channel Mute User | [28](28.md) |
111| `818` | Merge Requests | [54](54.md) |
108| `1021` | Bid | [15](15.md) | 112| `1021` | Bid | [15](15.md) |
109| `1022` | Bid confirmation | [15](15.md) | 113| `1022` | Bid confirmation | [15](15.md) |
110| `1040` | OpenTimestamps | [03](03.md) | 114| `1040` | OpenTimestamps | [03](03.md) |
@@ -114,6 +118,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
114| `1617` | Patches | [34](34.md) | 118| `1617` | Patches | [34](34.md) |
115| `1621` | Issues | [34](34.md) | 119| `1621` | Issues | [34](34.md) |
116| `1622` | Replies | [34](34.md) | 120| `1622` | Replies | [34](34.md) |
121| `1630`-`1633` | Status | [34](34.md) |
117| `1971` | Problem Tracker | [nostrocket][nostrocket] | 122| `1971` | Problem Tracker | [nostrocket][nostrocket] |
118| `1984` | Reporting | [56](56.md) | 123| `1984` | Reporting | [56](56.md) |
119| `1985` | Label | [32](32.md) | 124| `1985` | Label | [32](32.md) |
@@ -137,6 +142,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
137| `10009` | User groups | [51](51.md), [29](29.md) | 142| `10009` | User groups | [51](51.md), [29](29.md) |
138| `10015` | Interests list | [51](51.md) | 143| `10015` | Interests list | [51](51.md) |
139| `10030` | User emoji list | [51](51.md) | 144| `10030` | User emoji list | [51](51.md) |
145| `10050` | Relay list to receive DMs | [17](17.md) |
140| `10096` | File storage server list | [96](96.md) | 146| `10096` | File storage server list | [96](96.md) |
141| `13194` | Wallet Info | [47](47.md) | 147| `13194` | Wallet Info | [47](47.md) |
142| `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | 148| `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] |
@@ -167,6 +173,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
167| `30402` | Classified Listing | [99](99.md) | 173| `30402` | Classified Listing | [99](99.md) |
168| `30403` | Draft Classified Listing | [99](99.md) | 174| `30403` | Draft Classified Listing | [99](99.md) |
169| `30617` | Repository announcements | [34](34.md) | 175| `30617` | Repository announcements | [34](34.md) |
176| `30818` | Wiki article | [54](54.md) |
177| `30819` | Redirects | [54](54.md) |
170| `31922` | Date-Based Calendar Event | [52](52.md) | 178| `31922` | Date-Based Calendar Event | [52](52.md) |
171| `31923` | Time-Based Calendar Event | [52](52.md) | 179| `31923` | Time-Based Calendar Event | [52](52.md) |
172| `31924` | Calendar | [52](52.md) | 180| `31924` | Calendar | [52](52.md) |
@@ -246,10 +254,10 @@ Please update these lists when proposing NIPs introducing new event kinds.
246| `price` | price | currency, frequency | [99](99.md) | 254| `price` | price | currency, frequency | [99](99.md) |
247| `proxy` | external ID | protocol | [48](48.md) | 255| `proxy` | external ID | protocol | [48](48.md) |
248| `published_at` | unix timestamp (string) | -- | [23](23.md) | 256| `published_at` | unix timestamp (string) | -- | [23](23.md) |
249| `relay` | relay url | -- | [42](42.md) | 257| `relay` | relay url | -- | [42](42.md), [17](17.md) |
250| `relays` | relay list | -- | [57](57.md) | 258| `relays` | relay list | -- | [57](57.md) |
251| `server` | file storage server url | -- | [96](96.md) | 259| `server` | file storage server url | -- | [96](96.md) |
252| `subject` | subject | -- | [14](14.md) | 260| `subject` | subject | -- | [14](14.md), [17](17.md) |
253| `summary` | article summary | -- | [23](23.md) | 261| `summary` | article summary | -- | [23](23.md) |
254| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | 262| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) |
255| `title` | article title | -- | [23](23.md) | 263| `title` | article title | -- | [23](23.md) |