From b8f2e14e6dc6b688605e55c86e68ac17b53338f0 Mon Sep 17 00:00:00 2001 From: Vivek Ganesan Date: Thu, 11 May 2023 20:39:40 +0530 Subject: [PATCH 001/587] Add user experience recommendation about NIP-07 Invoking NIP-07 methods as a part of page-load event listener creates intermittent issues due to race conditions between the browser's extension script and the client's page scripts. --- 07.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/07.md b/07.md index 3b7a1d29..0fe81217 100644 --- a/07.md +++ b/07.md @@ -22,6 +22,11 @@ async window.nostr.nip04.encrypt(pubkey, plaintext): string // returns ciphertex async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext and iv as specified in nip-04 ``` +### User experience recommendation +Due to the way browsers load the extensions, it may take some time for `window.nostr` object will be fully ready to accept requests. Hence, it is a good idea to run the first `window.nostr` interaction on a user action on the web page (like a button click), and not during the page load. + +Calling the `window.nostr` based methods during the page load runs the risk of intermittent issues due to race conditions between the client page's script and the extension's script + ### Implementation - [horse](https://github.com/fiatjaf/horse) (Chrome and derivatives) From 9bf8bb0054f236533c8bc04f6a2966970c7d5bd9 Mon Sep 17 00:00:00 2001 From: Vivek Ganesan Date: Tue, 16 May 2023 04:05:24 +0530 Subject: [PATCH 002/587] Update 07.md Implemented review inputs --- 07.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/07.md b/07.md index 0fe81217..b350d0c0 100644 --- a/07.md +++ b/07.md @@ -22,8 +22,8 @@ async window.nostr.nip04.encrypt(pubkey, plaintext): string // returns ciphertex async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext and iv as specified in nip-04 ``` -### User experience recommendation -Due to the way browsers load the extensions, it may take some time for `window.nostr` object will be fully ready to accept requests. Hence, it is a good idea to run the first `window.nostr` interaction on a user action on the web page (like a button click), and not during the page load. +### Recommendation to Implementers +When `window.nostr` is injected by a browser extension, it may not be fully available until a certain point in the page's lifecycle. Hence, it is a good idea to invoke the first `window.nostr` based functionality after a user-action on the web page (like a button click), and not during the page load. Calling the `window.nostr` based methods during the page load runs the risk of intermittent issues due to race conditions between the client page's script and the extension's script From 86e44b75eb166b600affdc5248e0fe246a6ebe9b Mon Sep 17 00:00:00 2001 From: greenart7c3 Date: Wed, 8 Nov 2023 10:22:43 -0300 Subject: [PATCH 003/587] Android Signer Application nip --- 100.md | 495 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 495 insertions(+) create mode 100644 100.md diff --git a/100.md b/100.md new file mode 100644 index 00000000..3b8bc8ee --- /dev/null +++ b/100.md @@ -0,0 +1,495 @@ +# NIP-100 + +## Android Signer Application + +`draft` `optional` `author:greenart7c3` + +This NIP describes a method for 2-way communication between a android signer and any Nostr client on Android. The Android signer is an Android Application and the Client can be a Web Client or an Android Application. + +# Usage for Android applications + +The Android signer uses Intents and Content Resolvers to communicate between applications. + +To be able to use The Android signer in your application you should add the package name of the signer to your AndroidManifest.xml: + +```xml + + + +``` + +## Using Intents + +To get the result back from the Signer Appication you should use registerForActivityResult or rememberLauncherForActivityResult in Kotlin. If you are using another framework check the documentation of your framework or a third party library to get the result. + +Create the Intent using the **nostrsigner** scheme: + +```kotlin +val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$content")) +``` + +* Set the Signer package name + +```kotlin +intent.`package` = "com.example.signer" +``` + +### Methods + +- **get_public_key** + - params: + + ```kotlin + val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:")) + intent.`package` = "com.example.signer" + intent.putExtra("type", "get_public_key") + context.startActivity(intent) + ``` + - result: + - If the user approved intent it will return the **npub** in the signature field + + ```kotlin + val npub = intent.data?.getStringExtra("signature") + ``` + +- **sign_event** + - params: + + ```kotlin + val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$eventJson")) + intent.`package` = "com.example.signer" + intent.putExtra("type", "sign_event") + // to control the result in your application in case you are not waiting the result before sending another intent + intent.putExtra("id", event.id) + // Send the current logged in user npub + intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) + + context.startActivity(intent) + ``` + - result: + - If the user approved intent it will return the **signature**, **id** and **event** fields + + ```kotlin + val signature = intent.data?.getStringExtra("signature") + // the id you sent + val id = intent.data?.getStringExtra("id") + val signedEventJson = intent.data?.getStringExtra("event") + ``` + +- **nip04_encrypt** + - params: + + ```kotlin + val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$plaintext")) + intent.`package` = "com.example.signer" + intent.putExtra("type", "nip04_encrypt") + // to control the result in your application in case you are not waiting the result before sending another intent + intent.putExtra("id", "some_id") + // Send the current logged in user npub + intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) + // Send the hex pubKey that will be used for encrypting the data + intent.putExtra("pubKey", pubKey) + + context.startActivity(intent) + ``` + - result: + - If the user approved intent it will return the **signature** and **id** fields + + ```kotlin + val encryptedText = intent.data?.getStringExtra("signature") + // the id you sent + val id = intent.data?.getStringExtra("id") + ``` + +- **nip44_encrypt** + - params: + + ```kotlin + val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$plaintext")) + intent.`package` = "com.example.signer" + intent.putExtra("type", "nip44_encrypt") + // to control the result in your application in case you are not waiting the result before sending another intent + intent.putExtra("id", "some_id") + // Send the current logged in user npub + intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) + // Send the hex pubKey that will be used for encrypting the data + intent.putExtra("pubKey", pubKey) + + context.startActivity(intent) + ``` + - result: + - If the user approved intent it will return the **signature** and **id** fields + + ```kotlin + val encryptedText = intent.data?.getStringExtra("signature") + // the id you sent + val id = intent.data?.getStringExtra("id") + ``` + +- **nip04_decrypt** + - params: + + ```kotlin + val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$encryptedText")) + intent.`package` = "com.example.signer" + intent.putExtra("type", "nip04_decrypt") + // to control the result in your application in case you are not waiting the result before sending another intent + intent.putExtra("id", "some_id") + // Send the current logged in user npub + intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) + // Send the hex pubKey that will be used for decrypting the data + intent.putExtra("pubKey", pubKey) + + context.startActivity(intent) + ``` + - result: + - If the user approved intent it will return the **signature** and **id** fields + + ```kotlin + val plainText = intent.data?.getStringExtra("signature") + // the id you sent + val id = intent.data?.getStringExtra("id") + ``` + +- **nip44_decrypt** + - params: + + ```kotlin + val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$encryptedText")) + intent.`package` = "com.example.signer" + intent.putExtra("type", "nip04_decrypt") + // to control the result in your application in case you are not waiting the result before sending another intent + intent.putExtra("id", "some_id") + // Send the current logged in user npub + intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) + // Send the hex pubKey that will be used for decrypting the data + intent.putExtra("pubKey", pubKey) + + context.startActivity(intent) + ``` + - result: + - If the user approved intent it will return the **signature** and **id** fields + + ```kotlin + val plainText = intent.data?.getStringExtra("signature") + // the id you sent + val id = intent.data?.getStringExtra("id") + ``` + +- **decrypt_zap_event** + - params: + + ```kotlin + val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$eventJson")) + intent.`package` = "com.example.signer" + intent.putExtra("type", "decrypt_zap_event") + // to control the result in your application in case you are not waiting the result before sending another intent + intent.putExtra("id", "some_id") + // Send the current logged in user npub + intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) + context.startActivity(intent) + ``` + - result: + - If the user approved intent it will return the **signature** and **id** fields + + ```kotlin + val eventJson = intent.data?.getStringExtra("signature") + // the id you sent + val id = intent.data?.getStringExtra("id") + ``` + +## Using Content Resolver + +To 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. + +If 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 + +For the SIGN_EVENT type Signer Application returns two columns "signature" and "event". The column event is the signed event json + +For the other types Signer Application returns the column "signature" + +### Methods + +- **get_public_key** + - params: + + ```kotlin + val result = context.contentResolver.query( + Uri.parse("content://com.example.signer.GET_PUBLIC_KEY"), + listOf("login"), + null, + null, + null + ) + ``` + - result: + - Will return the **npub** in the signature column + + ```kotlin + if (result == null) return + + if (result.moveToFirst()) { + val index = it.getColumnIndex("signature") + if (index < 0) return + val npub = it.getString(index) + } + ``` + +- **sign_event** + - params: + + ```kotlin + val result = context.contentResolver.query( + Uri.parse("content://com.example.signer.SIGN_EVENT"), + listOf("$eventJson", "", "${logged_in_user_npub}"), + null, + null, + null + ) + ``` + - result: + - Will return the **signature** and the **event** columns + + ```kotlin + if (result == null) return + + if (result.moveToFirst()) { + val index = it.getColumnIndex("signature") + val indexJson = it.getColumnIndex("event") + val signature = it.getString(index) + val eventJson = it.getString(indexJson) + } + ``` + +- **nip04_encrypt** + - params: + + ```kotlin + val result = context.contentResolver.query( + Uri.parse("content://com.example.signer.NIP04_ENCRYPT"), + listOf("$plainText", "${hex_pub_key}", "${logged_in_user_npub}"), + null, + null, + null + ) + ``` + - result: + - Will return the **signature** column + + ```kotlin + if (result == null) return + + if (result.moveToFirst()) { + val index = it.getColumnIndex("signature") + val encryptedText = it.getString(index) + } + ``` + +- **nip44_encrypt** + - params: + + ```kotlin + val result = context.contentResolver.query( + Uri.parse("content://com.example.signer.NIP44_ENCRYPT"), + listOf("$plainText", "${hex_pub_key}", "${logged_in_user_npub}"), + null, + null, + null + ) + ``` + - result: + - Will return the **signature** column + + ```kotlin + if (result == null) return + + if (result.moveToFirst()) { + val index = it.getColumnIndex("signature") + val encryptedText = it.getString(index) + } + ``` + +- **nip04_decrypt** + - params: + + ```kotlin + val result = context.contentResolver.query( + Uri.parse("content://com.example.signer.NIP04_DECRYPT"), + listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_npub}"), + null, + null, + null + ) + ``` + - result: + - Will return the **signature** column + + ```kotlin + if (result == null) return + + if (result.moveToFirst()) { + val index = it.getColumnIndex("signature") + val encryptedText = it.getString(index) + } + ``` + +- **nip44_decrypt** + - params: + + ```kotlin + val result = context.contentResolver.query( + Uri.parse("content://com.example.signer.NIP44_DECRYPT"), + listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_npub}"), + null, + null, + null + ) + ``` + - result: + - Will return the **signature** column + + ```kotlin + if (result == null) return + + if (result.moveToFirst()) { + val index = it.getColumnIndex("signature") + val encryptedText = it.getString(index) + } + ``` + +- **decrypt_zap_event** + - params: + + ```kotlin + val result = context.contentResolver.query( + Uri.parse("content://com.example.signer.DECRYPT_ZAP_EVENT"), + listOf("$eventJson", "", "${logged_in_user_npub}"), + null, + null, + null + ) + ``` + - result: + - Will return the **signature** column + + ```kotlin + if (result == null) return + + if (result.moveToFirst()) { + val index = it.getColumnIndex("signature") + val eventJson = it.getString(index) + } + ``` + +# Usage for Web Applications + +Since web applications can't receive a result from the intent you should add a modal to paste the signature or the event json or create a callback url. + +If you send the callback url parameter Signer Application will send the result to the url. + +If you don't send a callback url Signer Application will copy the result to the clipboard. + +You can configure the returnType to be **signature** or **event**. + +Android intents and browsers url has limitations, so if you are using the returnType of **event** consider using the parameter **compressionType=gzip** that will return "Signer1" + Base 64 gzip encoded event json + +## Methods + +- **get_public_key** + - params: + + ```js + const intent = `intent:#Intent;scheme=nostrsigner;S.compressionType=none;S.returnType=signature;S.type=get_public_key;S.callbackUrl=https://example.com/?event=;end`; + + window.href = intent; + ``` + +- **sign_event** + - params: + + ```js + const intent = `intent:${eventJson}#Intent;scheme=nostrsigner;S.compressionType=none;S.returnType=signature;S.type=sign_event;S.callbackUrl=https://example.com/?event=;end`; + + window.href = intent; + ``` + +- **nip04_encrypt** + - params: + + ```js + const intent = `intent:${plainText}#Intent;scheme=nostrsigner;S.pubKey=${hex_pub_key};S.compressionType=none;S.returnType=signature;S.type=nip04_encrypt;S.callbackUrl=https://example.com/?event=;end`; + + window.href = intent; + ``` + +- **nip44_encrypt** + - params: + + ```js + const intent = `intent:${plainText}#Intent;scheme=nostrsigner;S.pubKey=${hex_pub_key};S.compressionType=none;S.returnType=signature;S.type=nip44_encrypt;S.callbackUrl=https://example.com/?event=;end`; + + window.href = intent; + ``` + +- **nip04_decrypt** + - params: + + ```js + const intent = `intent:${encryptedText}#Intent;scheme=nostrsigner;S.pubKey=${hex_pub_key};S.compressionType=none;S.returnType=signature;S.type=nip44_encrypt;S.callbackUrl=https://example.com/?event=;end`; + + window.href = intent; + ``` + +- **nip44_decrypt** + - params: + + ```js + const intent = `intent:${encryptedText}#Intent;scheme=nostrsigner;S.pubKey=${hex_pub_key};S.compressionType=none;S.returnType=signature;S.type=nip44_decrypt;S.callbackUrl=https://example.com/?event=;end`; + + window.href = intent; + ``` + +- **decrypt_zap_event** + - params: + + ```js + const intent = `intent:${eventJson}#Intent;scheme=nostrsigner;S.compressionType=none;S.returnType=signature;S.type=decrypt_zap_event;S.callbackUrl=https://example.com/?event=;end`; + + window.href = intent; + ``` + +## Example + +```js + + + + + + Document + + +

Test

+ + + + +``` \ No newline at end of file From 70a722b5d6526bf871a06290df8833492ac77b92 Mon Sep 17 00:00:00 2001 From: greenart7c3 Date: Wed, 29 Nov 2023 11:22:26 -0300 Subject: [PATCH 004/587] add permissions --- 100.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/100.md b/100.md index 3b8bc8ee..56b8a91c 100644 --- a/100.md +++ b/100.md @@ -43,6 +43,17 @@ intent.`package` = "com.example.signer" val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:")) intent.`package` = "com.example.signer" intent.putExtra("type", "get_public_key") + // You can send some default permissions for the user authorize for ever + val permissions = listOf( + Permission( + "sign_event", + 22242 + ), + Permission( + "nip44_decrypt" + ) + ) + intent.putExtra("permissions", permissions.toJson()) context.startActivity(intent) ``` - result: From e050386b849d0d293903a46646c89233bf19f489 Mon Sep 17 00:00:00 2001 From: greenart7c3 Date: Wed, 29 Nov 2023 11:23:14 -0300 Subject: [PATCH 005/587] signer can return the application package name when sign in --- 100.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/100.md b/100.md index 56b8a91c..2c7b8f96 100644 --- a/100.md +++ b/100.md @@ -61,6 +61,8 @@ intent.`package` = "com.example.signer" ```kotlin val npub = intent.data?.getStringExtra("signature") + // The package name of the signer application + val packageName = intent.data?.getStringExtra("package") ``` - **sign_event** From 7646386956927cea8be78747b1dda4fead8b1f32 Mon Sep 17 00:00:00 2001 From: zmeyer44 <54515037+zmeyer44@users.noreply.github.com> Date: Thu, 7 Dec 2023 20:09:08 -0500 Subject: [PATCH 006/587] Create NIP 44 for Video Events Nip for video events to enable dedicated video clients (e.g. Netflix, YouTube) to be built on nostr. --- 44.md | 98 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 98 insertions(+) create mode 100644 44.md diff --git a/44.md b/44.md new file mode 100644 index 00000000..c070c286 --- /dev/null +++ b/44.md @@ -0,0 +1,98 @@ +NIP-44 +====== + +Video Events +--------------- + +`draft` `optional` + +This 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). + +Unlike a `kind 1` event with a video attached, Video Events are meant to contain all necessary metadata concerning the media and to be surfaced in media specific clients rather than general micro-blogging clients. The thought is for events of this kind to be referenced in a YouTube like nostr client where the video itself is at the center of the experience. + +## Video Events + +#### Format + +The format uses a parameterized replaceable event kind `34235`. + +The `.content` of these events is optional and should be a summary of the video's contents. + +The list of tags are as follows: +* `d` (required) universally unique identifier (UUID). Generated by the client creating the video event. +* `title` (required) title of the video +* `src` (required) a link to the video data +* `m` (optional) the MIME type of the video data in the `src` tag +* `summary` (optional) summary/description of the video (same as content) +* `image` (optional) thumbnail or preview image for the video +* `text-track` (optional, repeated) link to WebVTT file for video, type of supplementary information (captions/subtitles/chapters/metadata), optional language code +* `content-warning` (optional) warning about content of NSFW video +* `t` (optional, repeated) hashtag to categorize video +* `p` (optional, repeated) 32-bytes hex pubkey of a participant in the video, optional recommended relay URL +* `r` (optional, repeated) references / links to web pages. + +```json +{ + "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": , + "kind": 34235, + "content": "", + "tags": [ + ["d", ""], + + ["title", ""], + ["summary", "<summary of video>"], + ["image", "<thumbnail image for video>"], + + // Video Data + ["src", "<url>"], + ["m", "<MIME type>"], + ["text-track", "<url>", "<text track type>", "<optional language>"], + ["content-warning", "<reason>"], + + // Participants + ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], + ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], + + // Hashtags + ["t", "<tag>"], + ["t", "<tag>"], + + // Reference links + ["r", "<url>"], + ["r", "<url>"] + ] +} +``` + +## Video View + +A video event view is a response to a video event to track a user's view or progress viewing the video. + +### Format + +The format uses a parameterized replaceable event kind `34236`. + +The `.content` of these events is optional and could be a free-form note that acts like a bookmark for the user. + +The list of tags are as follows: +* `a` (required) reference tag to kind `34235` video event being viewed +* `d` (required) universally unique identifier. Generated by the client creating the video event view +* `progress` (optional) timestamp of the user's progress in format `HH:MM:SS.sss` + + +```json +{ + "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": <Unix timestamp in seconds>, + "kind": 34236, + "content": "<note>", + "tags": [ + ["a", "<34235>:<calendar event author pubkey>:<d-identifier of video event>", "<optional relay url>"], + ["d", "<UUID>"], + ["progress", "00:08:31.520"], + ] +} +``` From 01035dadf450085259b4b8a8728cba7a6b4e0cef Mon Sep 17 00:00:00 2001 From: zmeyer44 <54515037+zmeyer44@users.noreply.github.com> Date: Fri, 8 Dec 2023 07:22:32 -0500 Subject: [PATCH 007/587] Update 44.md fixing spelling error --- 44.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/44.md b/44.md index c070c286..0411ec4e 100644 --- a/44.md +++ b/44.md @@ -90,7 +90,7 @@ The list of tags are as follows: "kind": 34236, "content": "<note>", "tags": [ - ["a", "<34235>:<calendar event author pubkey>:<d-identifier of video event>", "<optional relay url>"], + ["a", "<34235>:<video event author pubkey>:<d-identifier of video event>", "<optional relay url>"], ["d", "<UUID>"], ["progress", "00:08:31.520"], ] From a2914eed6d34d2e40ad2e361519bcd52300ef25e Mon Sep 17 00:00:00 2001 From: zmeyer44 <54515037+zmeyer44@users.noreply.github.com> Date: Fri, 8 Dec 2023 09:06:14 -0500 Subject: [PATCH 008/587] Update 44.md Adding some of Vitor's suggestions, differentiating between horizontal and vertical video kinds, changing how views are kept track of, and changing some tag names. --- 44.md | 36 ++++++++++++++++++++++-------------- 1 file changed, 22 insertions(+), 14 deletions(-) diff --git a/44.md b/44.md index 0411ec4e..1c857c86 100644 --- a/44.md +++ b/44.md @@ -12,21 +12,26 @@ Unlike a `kind 1` event with a video attached, Video Events are meant to contain ## Video Events +There are two types of video events represented by different kinds: horizontal and vertical video events. This is meant to allow clients to cater to each as the viewing experience for horizontal (landscape) videos is often different than that of vertical (portrait) videos (Stories, Reels, Shorts, etc). + #### Format -The format uses a parameterized replaceable event kind `34235`. +The format uses a parameterized replaceable event kind `34235` for horizontal videos and `34236` for vertical videos. The `.content` of these events is optional and should be a summary of the video's contents. The list of tags are as follows: * `d` (required) universally unique identifier (UUID). Generated by the client creating the video event. * `title` (required) title of the video -* `src` (required) a link to the video data +* `url` (required) a link to the video data * `m` (optional) the MIME type of the video data in the `src` tag * `summary` (optional) summary/description of the video (same as content) -* `image` (optional) thumbnail or preview image for the video +* `image` (optional) url of preview image with same dimensions +* `thumb` (optional) url of thumbnail with same aspect ratio +* `dim` (optional) size of file in pixels in the form <width>x<height> * `text-track` (optional, repeated) link to WebVTT file for video, type of supplementary information (captions/subtitles/chapters/metadata), optional language code * `content-warning` (optional) warning about content of NSFW video +* `alt` (optional) description for accessibility * `t` (optional, repeated) hashtag to categorize video * `p` (optional, repeated) 32-bytes hex pubkey of a participant in the video, optional recommended relay URL * `r` (optional, repeated) references / links to web pages. @@ -36,20 +41,23 @@ The list of tags are as follows: "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, "created_at": <Unix timestamp in seconds>, - "kind": 34235, + "kind": 34235 | 34236, "content": "<summary of video>", "tags": [ ["d", "<UUID>"], ["title", "<title of video>"], ["summary", "<summary of video>"], - ["image", "<thumbnail image for video>"], + ["thumb", "<thumbnail image for video>"], + ["image", "<preview image for video>"], + ["alt", <description>], // Video Data - ["src", "<url>"], + ["url", "<url>"], ["m", "<MIME type>"], ["text-track", "<url>", "<text track type>", "<optional language>"], ["content-warning", "<reason>"], + ["dim", <size of video in pixels>], // Participants ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], @@ -72,14 +80,14 @@ A video event view is a response to a video event to track a user's view or prog ### Format -The format uses a parameterized replaceable event kind `34236`. +The format uses a parameterized replaceable event kind `34237`. The `.content` of these events is optional and could be a free-form note that acts like a bookmark for the user. The list of tags are as follows: -* `a` (required) reference tag to kind `34235` video event being viewed -* `d` (required) universally unique identifier. Generated by the client creating the video event view -* `progress` (optional) timestamp of the user's progress in format `HH:MM:SS.sss` +* `a` (required) reference tag to kind `34235` or `34236` video event being viewed +* `d` (required) same as `a` reference tag value +* `viewed` (optional, repeated) timestamp of the user's start time in `HH:MM:SS.sss`, timestamp of the user's end time in `HH:MM:SS.sss` ```json @@ -87,12 +95,12 @@ The list of tags are as follows: "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, "created_at": <Unix timestamp in seconds>, - "kind": 34236, + "kind": 34237, "content": "<note>", "tags": [ - ["a", "<34235>:<video event author pubkey>:<d-identifier of video event>", "<optional relay url>"], - ["d", "<UUID>"], - ["progress", "00:08:31.520"], + ["a", "<34235 | 34236>:<video event author pubkey>:<d-identifier of video event>", "<optional relay url>"], + ["d", "<34235 | 34236>:<video event author pubkey>:<d-identifier of video event>"], + ["viewed", <start>, <end>], ] } ``` From ae0fd96907d0767f07fb54ca1de9f197c600cb27 Mon Sep 17 00:00:00 2001 From: Daniel Cadenas <dcadenas@gmail.com> Date: Fri, 8 Dec 2023 13:19:54 -0300 Subject: [PATCH 009/587] Fix Authorization header string The previous auth header was for an event in which the tag is `url` instead of `u` so it was not matching the event provided as an example --- 98.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/98.md b/98.md index ca523042..be425b28 100644 --- a/98.md +++ b/98.md @@ -55,7 +55,8 @@ Using the `Authorization` HTTP header, the `kind 27235` event MUST be `base64` e Example HTTP Authorization header: ``` -Authorization: Nostr eyJpZCI6ImZlOTY0ZTc1ODkwMzM2MGYyOGQ4NDI0ZDA5MmRhODQ5NGVkMjA3Y2JhODIzMTEwYmUzYTU3ZGZlNGI1Nzg3MzQiLCJwdWJrZXkiOiI2M2ZlNjMxOGRjNTg1ODNjZmUxNjgxMGY4NmRkMDllMThiZmQ3NmFhYmMyNGEwMDgxY2UyODU2ZjMzMDUwNGVkIiwiY29udGVudCI6IiIsImtpbmQiOjI3MjM1LCJjcmVhdGVkX2F0IjoxNjgyMzI3ODUyLCJ0YWdzIjpbWyJ1cmwiLCJodHRwczovL2FwaS5zbm9ydC5zb2NpYWwvYXBpL3YxL241c3AvbGlzdCJdLFsibWV0aG9kIiwiR0VUIl1dLCJzaWciOiI1ZWQ5ZDhlYzk1OGJjODU0Zjk5N2JkYzI0YWMzMzdkMDA1YWYzNzIzMjQ3NDdlZmU0YTAwZTI0ZjRjMzA0MzdmZjRkZDgzMDg2ODRiZWQ0NjdkOWQ2YmUzZTVhNTE3YmI0M2IxNzMyY2M3ZDMzOTQ5YTNhYWY4NjcwNWMyMjE4NCJ9 +Authorization: Nostr +eyJpZCI6ImZlOTY0ZTc1ODkwMzM2MGYyOGQ4NDI0ZDA5MmRhODQ5NGVkMjA3Y2JhODIzMTEwYmUzYTU3ZGZlNGI1Nzg3MzQiLCJwdWJrZXkiOiI2M2ZlNjMxOGRjNTg1ODNjZmUxNjgxMGY4NmRkMDllMThiZmQ3NmFhYmMyNGEwMDgxY2UyODU2ZjMzMDUwNGVkIiwiY29udGVudCI6IiIsImtpbmQiOjI3MjM1LCJjcmVhdGVkX2F0IjoxNjgyMzI3ODUyLCJ0YWdzIjpbWyJ1IiwiaHR0cHM6Ly9hcGkuc25vcnQuc29jaWFsL2FwaS92MS9uNXNwL2xpc3QiXSxbIm1ldGhvZCIsIkdFVCJdXSwic2lnIjoiNWVkOWQ4ZWM5NThiYzg1NGY5OTdiZGMyNGFjMzM3ZDAwNWFmMzcyMzI0NzQ3ZWZlNGEwMGUyNGY0YzMwNDM3ZmY0ZGQ4MzA4Njg0YmVkNDY3ZDlkNmJlM2U1YTUxN2JiNDNiMTczMmNjN2QzMzk0OWEzYWFmODY3MDVjMjIxODQifQ ``` ## Reference Implementations From cec99e7b13a823d08527790bd46297d545ddb881 Mon Sep 17 00:00:00 2001 From: zmeyer44 <54515037+zmeyer44@users.noreply.github.com> Date: Sat, 9 Dec 2023 12:55:25 -0500 Subject: [PATCH 010/587] Update 44.md Updating to reference NIP-94 file metadata event --- 44.md | 26 ++++++++++---------------- 1 file changed, 10 insertions(+), 16 deletions(-) diff --git a/44.md b/44.md index 1c857c86..4a80c63e 100644 --- a/44.md +++ b/44.md @@ -6,9 +6,9 @@ Video Events `draft` `optional` -This 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). +This 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). The content of a video event is the stringified JSON of a `kind 1063` File metadata event as described in [NIP-94](94.md). -Unlike a `kind 1` event with a video attached, Video Events are meant to contain all necessary metadata concerning the media and to be surfaced in media specific clients rather than general micro-blogging clients. The thought is for events of this kind to be referenced in a YouTube like nostr client where the video itself is at the center of the experience. +Unlike 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. ## Video Events @@ -18,23 +18,20 @@ There are two types of video events represented by different kinds: horizontal a The format uses a parameterized replaceable event kind `34235` for horizontal videos and `34236` for vertical videos. -The `.content` of these events is optional and should be a summary of the video's contents. +The `.content` of these events is the stringified JSON of a `kind 1063` file metadata event. The list of tags are as follows: * `d` (required) universally unique identifier (UUID). Generated by the client creating the video event. +* `e` (required, repeated) reference tag to kind 1063 file metadata event being posted, optional relay information for the file metadata event, optional quality value (low|medium|high) * `title` (required) title of the video -* `url` (required) a link to the video data -* `m` (optional) the MIME type of the video data in the `src` tag * `summary` (optional) summary/description of the video (same as content) -* `image` (optional) url of preview image with same dimensions -* `thumb` (optional) url of thumbnail with same aspect ratio -* `dim` (optional) size of file in pixels in the form <width>x<height> +* `url` (optional) a default link to the video data * `text-track` (optional, repeated) link to WebVTT file for video, type of supplementary information (captions/subtitles/chapters/metadata), optional language code +* `thumb` (optional) url of thumbnail with same aspect ratio * `content-warning` (optional) warning about content of NSFW video -* `alt` (optional) description for accessibility * `t` (optional, repeated) hashtag to categorize video * `p` (optional, repeated) 32-bytes hex pubkey of a participant in the video, optional recommended relay URL -* `r` (optional, repeated) references / links to web pages. +* `r` (optional, repeated) references / links to web pages ```json { @@ -42,22 +39,19 @@ The list of tags are as follows: "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, "created_at": <Unix timestamp in seconds>, "kind": 34235 | 34236, - "content": "<summary of video>", + "content": "<stringified JSON of kind 1063 event>", "tags": [ ["d", "<UUID>"], + ["e", "<hex-id>", "<relay-url>", "<optional quality value>"], ["title", "<title of video>"], ["summary", "<summary of video>"], ["thumb", "<thumbnail image for video>"], - ["image", "<preview image for video>"], - ["alt", <description>], // Video Data - ["url", "<url>"], - ["m", "<MIME type>"], + ["url", "<optional recommended url>"] ["text-track", "<url>", "<text track type>", "<optional language>"], ["content-warning", "<reason>"], - ["dim", <size of video in pixels>], // Participants ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], From 7afd1049d98a82aa7754f80de80d97dd686cf40e Mon Sep 17 00:00:00 2001 From: zmeyer44 <54515037+zmeyer44@users.noreply.github.com> Date: Sat, 9 Dec 2023 17:46:53 -0500 Subject: [PATCH 011/587] Update and rename 44.md to 71.md Changing to NIP-71 --- 44.md => 71.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename 44.md => 71.md (99%) diff --git a/44.md b/71.md similarity index 99% rename from 44.md rename to 71.md index 4a80c63e..39d6cc80 100644 --- a/44.md +++ b/71.md @@ -1,4 +1,4 @@ -NIP-44 +NIP-71 ====== Video Events From c84d40f4a6dc39b1d420cdbaf75882ec0b78d478 Mon Sep 17 00:00:00 2001 From: zmeyer44 <54515037+zmeyer44@users.noreply.github.com> Date: Tue, 12 Dec 2023 11:19:57 -0500 Subject: [PATCH 012/587] Update 71.md Co-authored-by: Pablo Fernandez <pfer@me.com> --- 71.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/71.md b/71.md index 39d6cc80..a18f2774 100644 --- a/71.md +++ b/71.md @@ -24,7 +24,7 @@ The list of tags are as follows: * `d` (required) universally unique identifier (UUID). Generated by the client creating the video event. * `e` (required, repeated) reference tag to kind 1063 file metadata event being posted, optional relay information for the file metadata event, optional quality value (low|medium|high) * `title` (required) title of the video -* `summary` (optional) summary/description of the video (same as content) +* `summary` (optional) summary/description of the video * `url` (optional) a default link to the video data * `text-track` (optional, repeated) link to WebVTT file for video, type of supplementary information (captions/subtitles/chapters/metadata), optional language code * `thumb` (optional) url of thumbnail with same aspect ratio From d53f6fba1510db7ad7440ca0c93429a88f1c6fa9 Mon Sep 17 00:00:00 2001 From: zmeyer44 <54515037+zmeyer44@users.noreply.github.com> Date: Tue, 12 Dec 2023 13:56:28 -0500 Subject: [PATCH 013/587] Update 71.md After discussing with Pablo, we decided to move away from relying on kind 1063 events and instead use the majority of the same tags for video events. The main motivations behind this are to allow for parameterized replaceable events for video events, prevent excessive `REQ` requests, not stringify event JSON in the `.content` section, ease of filtering by kind number, as well as some others. Happy to discuss this further. --- 71.md | 37 ++++++++++++++++++++++++++++--------- 1 file changed, 28 insertions(+), 9 deletions(-) diff --git a/71.md b/71.md index a18f2774..6d6775a4 100644 --- a/71.md +++ b/71.md @@ -6,7 +6,7 @@ Video Events `draft` `optional` -This 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). The content of a video event is the stringified JSON of a `kind 1063` File metadata event as described in [NIP-94](94.md). +This 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). Unlike 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. @@ -18,17 +18,27 @@ There are two types of video events represented by different kinds: horizontal a The format uses a parameterized replaceable event kind `34235` for horizontal videos and `34236` for vertical videos. -The `.content` of these events is the stringified JSON of a `kind 1063` file metadata event. +The `.content` of these events is a summary or description on the video content. The list of tags are as follows: * `d` (required) universally unique identifier (UUID). Generated by the client creating the video event. -* `e` (required, repeated) reference tag to kind 1063 file metadata event being posted, optional relay information for the file metadata event, optional quality value (low|medium|high) +* `url` (required) the url to the video file +* `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. * `title` (required) title of the video -* `summary` (optional) summary/description of the video -* `url` (optional) a default link to the video data +* `"published_at"`, for the timestamp in unix seconds (stringified) of the first time the video was published +* `summary` (optional) summary/description of the video (same as `.content`) +* `"aes-256-gcm"` (optional) key and nonce for AES-GCM encryption with tagSize always 128bits +* `x` containing the SHA-256 hexencoded string of the file. +* `size` (optional) size of file in bytes +* `dim` (optional) size of file in pixels in the form `<width>x<height>` +* `duration` (optional) video duration in seconds +* `magnet` (optional) URI to magnet file +* `i` (optional) torrent infohash * `text-track` (optional, repeated) link to WebVTT file for video, type of supplementary information (captions/subtitles/chapters/metadata), optional language code * `thumb` (optional) url of thumbnail with same aspect ratio +* `image` (optional) url of preview image with same dimensions * `content-warning` (optional) warning about content of NSFW video +* `alt` (optional) description for accessibility * `t` (optional, repeated) hashtag to categorize video * `p` (optional, repeated) 32-bytes hex pubkey of a participant in the video, optional recommended relay URL * `r` (optional, repeated) references / links to web pages @@ -39,18 +49,27 @@ The list of tags are as follows: "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, "created_at": <Unix timestamp in seconds>, "kind": 34235 | 34236, - "content": "<stringified JSON of kind 1063 event>", + "content": "<summary / description of video>", "tags": [ ["d", "<UUID>"], - ["e", "<hex-id>", "<relay-url>", "<optional quality value>"], ["title", "<title of video>"], ["summary", "<summary of video>"], ["thumb", "<thumbnail image for video>"], + ["published_at", "<unix timestamp>"], + ["alt", <description>], // Video Data - ["url", "<optional recommended url>"] - ["text-track", "<url>", "<text track type>", "<optional language>"], + ["url",<string with URI of file>], + ["m", <MIME type>], + ["x",<Hash SHA-256>], + ["aes-256-gcm",<key>, <iv>], + ["size", <size of file in bytes>], + ["duration", <duration of video in seconds>], + ["dim", <size of file in pixels>], + ["magnet",<magnet URI> ], + ["i",<torrent infohash>], + ["text-track", "<encoded `kind 6000` event>", "<recommended relay urls>"], ["content-warning", "<reason>"], // Participants From 2bd3c7400293c7e142fc68bc8d58176cecb9ab2d Mon Sep 17 00:00:00 2001 From: zmeyer44 <54515037+zmeyer44@users.noreply.github.com> Date: Tue, 12 Dec 2023 14:01:51 -0500 Subject: [PATCH 014/587] Update 71.md Adding segments --- 71.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/71.md b/71.md index 6d6775a4..0a60d61f 100644 --- a/71.md +++ b/71.md @@ -39,6 +39,7 @@ The list of tags are as follows: * `image` (optional) url of preview image with same dimensions * `content-warning` (optional) warning about content of NSFW video * `alt` (optional) description for accessibility +* `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 * `t` (optional, repeated) hashtag to categorize video * `p` (optional, repeated) 32-bytes hex pubkey of a participant in the video, optional recommended relay URL * `r` (optional, repeated) references / links to web pages @@ -71,6 +72,7 @@ The list of tags are as follows: ["i",<torrent infohash>], ["text-track", "<encoded `kind 6000` event>", "<recommended relay urls>"], ["content-warning", "<reason>"], + ["segment", <start>, <end>, "<title>", "<thumbnail URL>"], // Participants ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], From 46a81d9c25874aac0af4b26fa6641bcca9a70053 Mon Sep 17 00:00:00 2001 From: Sandwich <299465+dskvr@users.noreply.github.com> Date: Tue, 19 Dec 2023 13:31:13 +0100 Subject: [PATCH 015/587] Clarify summarization language The initial language is misleading as it is not clear the tags are to be used on any event outside of the kind it defines until the bottom of the NIP. --- 32.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/32.md b/32.md index be4e8724..60e108e7 100644 --- a/32.md +++ b/32.md @@ -6,8 +6,7 @@ Labeling `draft` `optional` -A label is a `kind 1985` event that is used to label other entities. This supports a number of use cases, -including distributed moderation, collection management, license assignment, and content classification. +A label uses two new indexable tags to label events. Additionally, it adds a new event kind, `kind 1985`, that is used to label other entities. This supports a number of use cases, including distributed moderation, collection management, license assignment, and content classification. This NIP introduces two new tags: From 81fd5deff652fe0c70a8b654d947fe05aa0a1f72 Mon Sep 17 00:00:00 2001 From: Sandwich <299465+dskvr@users.noreply.github.com> Date: Wed, 27 Dec 2023 13:24:20 +0100 Subject: [PATCH 016/587] Update language --- 32.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/32.md b/32.md index 60e108e7..eafb06ff 100644 --- a/32.md +++ b/32.md @@ -6,7 +6,7 @@ Labeling `draft` `optional` -A label uses two new indexable tags to label events. Additionally, it adds a new event kind, `kind 1985`, that is used to label other entities. This supports a number of use cases, including distributed moderation, collection management, license assignment, and content classification. +This 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. This NIP introduces two new tags: From c3fbda5ee0002629791d6e29a721e03e6b06f605 Mon Sep 17 00:00:00 2001 From: Sandwich <299465+dskvr@users.noreply.github.com> Date: Wed, 27 Dec 2023 13:25:02 +0100 Subject: [PATCH 017/587] Remove redundant language --- 32.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/32.md b/32.md index eafb06ff..e4f6aa28 100644 --- a/32.md +++ b/32.md @@ -8,7 +8,7 @@ Labeling This 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. -This NIP introduces two new tags: +New Tags: - `L` denotes a label namespace - `l` denotes a label From 8136be6eab526de8bdb22436431ea75831846395 Mon Sep 17 00:00:00 2001 From: zmeyer44 <54515037+zmeyer44@users.noreply.github.com> Date: Wed, 27 Dec 2023 08:26:15 -0600 Subject: [PATCH 018/587] Update 71.md Changed view start and end time to seconds --- 71.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/71.md b/71.md index 0a60d61f..1daee7b7 100644 --- a/71.md +++ b/71.md @@ -102,7 +102,7 @@ The `.content` of these events is optional and could be a free-form note that ac The list of tags are as follows: * `a` (required) reference tag to kind `34235` or `34236` video event being viewed * `d` (required) same as `a` reference tag value -* `viewed` (optional, repeated) timestamp of the user's start time in `HH:MM:SS.sss`, timestamp of the user's end time in `HH:MM:SS.sss` +* `viewed` (optional, repeated) timestamp of the user's start time in seconds, timestamp of the user's end time in seconds ```json From 71061e9e83cbd06b775c8e27eab38dc831f078a3 Mon Sep 17 00:00:00 2001 From: Sandwich <299465+dskvr@users.noreply.github.com> Date: Fri, 29 Dec 2023 21:03:53 +0100 Subject: [PATCH 019/587] Commit suggestion Co-authored-by: hodlbod <jstaab@protonmail.com> --- 32.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/32.md b/32.md index e4f6aa28..bff3b801 100644 --- a/32.md +++ b/32.md @@ -6,7 +6,7 @@ Labeling `draft` `optional` -This 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. +This 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. New Tags: From f316b219f4389021addbca02f1cb383eb8cb36d2 Mon Sep 17 00:00:00 2001 From: zmeyer44 <54515037+zmeyer44@users.noreply.github.com> Date: Fri, 29 Dec 2023 14:15:42 -0600 Subject: [PATCH 020/587] Update 71.md Co-authored-by: Pablo Fernandez <pfer@me.com> --- 71.md | 1 + 1 file changed, 1 insertion(+) diff --git a/71.md b/71.md index 1daee7b7..6b3fc0f1 100644 --- a/71.md +++ b/71.md @@ -114,6 +114,7 @@ The list of tags are as follows: "content": "<note>", "tags": [ ["a", "<34235 | 34236>:<video event author pubkey>:<d-identifier of video event>", "<optional relay url>"], + ["e", "<event-id", "<relay-url>"] ["d", "<34235 | 34236>:<video event author pubkey>:<d-identifier of video event>"], ["viewed", <start>, <end>], ] From 54328d8979e5883922549293406bd77558fb34a7 Mon Sep 17 00:00:00 2001 From: zmeyer44 <54515037+zmeyer44@users.noreply.github.com> Date: Fri, 29 Dec 2023 17:25:13 -0600 Subject: [PATCH 021/587] Removing "summary" tag Content in the summary tag is duplicated in the .content field --- 71.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/71.md b/71.md index 6b3fc0f1..3b8efcad 100644 --- a/71.md +++ b/71.md @@ -26,7 +26,6 @@ The list of tags are as follows: * `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. * `title` (required) title of the video * `"published_at"`, for the timestamp in unix seconds (stringified) of the first time the video was published -* `summary` (optional) summary/description of the video (same as `.content`) * `"aes-256-gcm"` (optional) key and nonce for AES-GCM encryption with tagSize always 128bits * `x` containing the SHA-256 hexencoded string of the file. * `size` (optional) size of file in bytes @@ -55,7 +54,6 @@ The list of tags are as follows: ["d", "<UUID>"], ["title", "<title of video>"], - ["summary", "<summary of video>"], ["thumb", "<thumbnail image for video>"], ["published_at", "<unix timestamp>"], ["alt", <description>], From c55678b30740c1aa4aa968239fb21fb05c38a92c Mon Sep 17 00:00:00 2001 From: greenart7c3 <greenart7c3@proton.me> Date: Mon, 22 Jan 2024 11:25:25 -0300 Subject: [PATCH 022/587] change androidmanifest.xml, add rejected collumn if user chose to always reject some event kind --- 100.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/100.md b/100.md index 2c7b8f96..cddb8066 100644 --- a/100.md +++ b/100.md @@ -10,14 +10,32 @@ This NIP describes a method for 2-way communication between a android signer and The Android signer uses Intents and Content Resolvers to communicate between applications. -To be able to use The Android signer in your application you should add the package name of the signer to your AndroidManifest.xml: +To be able to use The Android signer in your application you should this to your AndroidManifest.xml: ```xml <queries> - <package android:name="com.example.signer"/> + <intent> + <action android:name="android.intent.action.VIEW" /> + <category android:name="android.intent.category.BROWSABLE" /> + <data android:scheme="nostrsigner" /> + </intent> </queries> ``` +Then you can use this function to check if there's a signer application installed: + +```kotlin +fun isExternalSignerInstalled(context: Context): Boolean { + val intent = + Intent().apply { + action = Intent.ACTION_VIEW + data = Uri.parse("nostrsigner:") + } + val infos = context.packageManager.queryIntentActivities(intent, 0) + return infos.size > 0 +} +``` + ## Using Intents To get the result back from the Signer Appication you should use registerForActivityResult or rememberLauncherForActivityResult in Kotlin. If you are using another framework check the documentation of your framework or a third party library to get the result. @@ -221,6 +239,8 @@ For the SIGN_EVENT type Signer Application returns two columns "signature" and " For the other types Signer Application returns the column "signature" +If the user chose to always reject the event signer application will return the column "rejected" and you should not open signer application + ### Methods - **get_public_key** From f549b66f67dffea317efbe192631503dfdac2e9d Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Thu, 26 Oct 2023 10:06:29 -0700 Subject: [PATCH 023/587] Deprecate nip 45 --- 45.md | 2 ++ README.md | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/45.md b/45.md index 780dfb6b..56d0f101 100644 --- a/45.md +++ b/45.md @@ -1,3 +1,5 @@ +> __Warning__ `unrecommended`: deprecated + NIP-45 ====== diff --git a/README.md b/README.md index 10b1dfb7..0862723d 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-40: Expiration Timestamp](40.md) - [NIP-42: Authentication of clients to relays](42.md) - [NIP-44: Versioned Encryption](44.md) -- [NIP-45: Counting results](45.md) +- [NIP-45: Counting results](45.md) --- **unrecommended**: deprecated - [NIP-46: Nostr Connect](46.md) - [NIP-47: Wallet Connect](47.md) - [NIP-48: Proxy Tags](48.md) From 49c9f37229c470b2072f3336a5e1927f0243f41d Mon Sep 17 00:00:00 2001 From: zmeyer44 <zmmeyer44@gmail.com> Date: Thu, 1 Feb 2024 11:12:47 +0000 Subject: [PATCH 024/587] updated read me --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 6b83490c..0d4805c2 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-57: Lightning Zaps](57.md) - [NIP-58: Badges](58.md) - [NIP-65: Relay List Metadata](65.md) +- [NIP-71: Video Events](71.md) - [NIP-72: Moderated Communities](72.md) - [NIP-75: Zap Goals](75.md) - [NIP-78: Application-specific data](78.md) @@ -128,6 +129,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30002` | Relay sets | [51](51.md) | | `30003` | Bookmark sets | [51](51.md) | | `30004` | Curation sets | [51](51.md) | +| `30005` | Video sets | [51](51.md) | | `30008` | Profile Badges | [58](58.md) | | `30009` | Badge Definition | [58](58.md) | | `30015` | Interest sets | [51](51.md) | @@ -147,6 +149,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `31925` | Calendar Event RSVP | [52](52.md) | | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | +| `34235` | Video Event | [71](71.md) | +| `34236` | Short-form Portrait Video Event | [71](71.md) | +| `34237` | Video View Event | [71](71.md) | | `34550` | Community Definition | [72](72.md) | [nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md From cc6ac4f0b6d1779929dd7346536807699c21d6b2 Mon Sep 17 00:00:00 2001 From: zmeyer44 <zmmeyer44@gmail.com> Date: Thu, 1 Feb 2024 11:14:59 +0000 Subject: [PATCH 025/587] making the format a bit nicer --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0d4805c2..1c2f806a 100644 --- a/README.md +++ b/README.md @@ -149,9 +149,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `31925` | Calendar Event RSVP | [52](52.md) | | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | -| `34235` | Video Event | [71](71.md) | -| `34236` | Short-form Portrait Video Event | [71](71.md) | -| `34237` | Video View Event | [71](71.md) | +| `34235` | Video Event | [71](71.md) | +| `34236` | Short-form Portrait Video Event | [71](71.md) | +| `34237` | Video View Event | [71](71.md) | | `34550` | Community Definition | [72](72.md) | [nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md From ded4c1659ce838625705f86bb563df7507d52503 Mon Sep 17 00:00:00 2001 From: greenart7c3 <greenart7c3@proton.me> Date: Wed, 14 Feb 2024 14:37:42 -0300 Subject: [PATCH 026/587] fix typo --- 100.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/100.md b/100.md index cddb8066..ee5149ae 100644 --- a/100.md +++ b/100.md @@ -468,7 +468,7 @@ Android intents and browsers url has limitations, so if you are using the return - params: ```js - const intent = `intent:${encryptedText}#Intent;scheme=nostrsigner;S.pubKey=${hex_pub_key};S.compressionType=none;S.returnType=signature;S.type=nip44_encrypt;S.callbackUrl=https://example.com/?event=;end`; + const intent = `intent:${encryptedText}#Intent;scheme=nostrsigner;S.pubKey=${hex_pub_key};S.compressionType=none;S.returnType=signature;S.type=nip04_decrypt;S.callbackUrl=https://example.com/?event=;end`; window.href = intent; ``` From 5b2461eb01f784d546f77cfc21af26bf7e4b6670 Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Wed, 28 Feb 2024 11:50:54 -0300 Subject: [PATCH 027/587] NIP-29: Simple Groups (#566) * NIP-29: Simple Group Chat. * split hostname and subgroup path into two different tag items. * add and remove permissions actions. * fix kind number for moderation event. * add missing / to "flavors" in example. * some new ideas + making this universal and not only applicable to chat. * fix delete-message => delete-event. * flesh out the entire thing. * saner approach with multiple kinds for moderation. * delete-event as kind 9005. * update meta events description. * `public` and `open` tags and join request event. * edit-group-status permission. * add kinds to README. * add kind:12 * add nip-10 note * add optional list of members * admins prefixed by "p". * remove "alt" from event templates for brevity. * add kind 10009 for public list of simple groups. * update "previous" stuff. * remove naddr stuff, use a different identifier format. * remove reference to trimmed signatures until that is more developed. * add kind:10 threaded chat replies. --------- Co-authored-by: Pablo Fernandez <p@f7z.io> --- 29.md | 197 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 51.md | 1 + README.md | 8 +++ 3 files changed, 206 insertions(+) create mode 100644 29.md diff --git a/29.md b/29.md new file mode 100644 index 00000000..0f4a5796 --- /dev/null +++ b/29.md @@ -0,0 +1,197 @@ +NIP-29 +====== + +Relay-based Groups +------------------ + +`draft` `optional` + +This NIP defines a standard for groups that are only writable by a closed set of users. They can be public for reading by external users or not. + +Groups are identified by a random string of any length that serves as an _id_. + +There is no way to create a group, what happens is just that relays (most likely when asked by users) will create rules around some specific ids so these ids can serve as an actual group, henceforth messages sent to that group will be subject to these rules. + +Normally a group will originally belong to one specific relay, but the community may choose to move the group to other relays or even fork the group so it exists in different forms -- still using the same _id_ -- across different relays. + +## Relay-generated events + +Relays 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. + +## Group identifier + +A 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`. + +## The `h` tag + +Events 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_. + +## Timeline references + +In order to not be used out of context, events sent to these groups may contain references to previous events seen from the same relay in the `previous` tag. The choice of which previous events to pick belongs to the clients. The references are to be made using the first 8 characters (4 bytes) of any event in the last 50 events seen by the user in the relay, excluding events by themselves. There can be any number of references (including zero), but it's recommended that clients include at least 3 and that relays enforce this. + +This is a hack to prevent messages from being broadcasted to external relays that have forks of one group out of context. Relays are expected to reject any events that contain timeline references to events not found in their own database. Clients should also check these to keep relays honest about them. + +## Late publication + +Relays 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. + +## Event definitions + +- *text root note* (`kind:11`) + +This is the basic unit of a "microblog" root text note sent to a group. + +```js + "kind": 11, + "content": "hello my friends lovers of pizza", + "tags": [ + ["h", "<group-id>"], + ["previous", "<event-id-first-chars>", "<event-id-first-chars>", ...] + ] + ... +``` + +- *threaded text reply* (`kind:12`) + +This is the basic unit of a "microblog" reply note sent to a group. It's the same as `kind:11`, except for the fact that it must be used whenever it's in reply to some other note (either in reply to a `kind:11` or a `kind:12`). `kind:12` events SHOULD use NIP-10 markers, leaving an empty relay url: + +* `["e", "<kind-11-root-id>", "", "root"]` +* `["e", "<kind-12-event-id>", "", "reply"]` + +- *chat message* (`kind:9`) + +This is the basic unit of a _chat message_ sent to a group. + +```js + "kind": 9, + "content": "hello my friends lovers of pizza", + "tags": [ + ["h", "<group-id>"], + ["previous", "<event-id-first-chars>", "<event-id-first-chars>", ...] + ] + ... +``` + +- *chat message threaded reply* (`kind:10`) + +Similar to `kind:12`, this is the basic unit of a chat message sent to a group. This is intended for in-chat threads that may be hidden by default. Not all in-chat replies MUST use `kind:10`, only when the intention is to create a hidden thread that isn't part of the normal flow of the chat (although clients are free to display those by default too). + +`kind:10` SHOULD use NIP-10 markers, just like `kind:12`. + +- *join request* (`kind:9021`) + +Any 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. + +```js +{ + "kind": 9021, + "content": "optional reason", + "tags": [ + ["h", "<group-id>"] + ] +} +``` + +- *moderation events* (`kinds:9000-9020`) (optional) + +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. The relay may discard the event after taking action or keep it as a moderation log. + +```js +{ + "kind": 90xx, + "content": "optional reason", + "tags": [ + ["h", "<group-id>"], + ["previous", ...] + ] +} +``` + +Each moderation action uses a different kind and requires different arguments, which are given as tags. These are defined in the following table: + +| kind | name | tags | +| --- | --- | --- | +| 9000 | `add-user` | `p` (pubkey hex) | +| 9001 | `remove-user` | `p` (pubkey hex) | +| 9002 | `edit-metadata` | `name`, `about`, `picture` (string) | +| 9003 | `add-permission` | `p` (pubkey), `permission` (name) | +| 9004 | `remove-permission` | `p` (pubkey), `permission` (name) | +| 9005 | `delete-event` | `e` (id hex) | +| 9006 | `edit-group-status` | `public` or `private`, `open` or `closed` | + +- *group metadata* (`kind:39000`) (optional) + +This event defines the metadata for the group -- basically how clients should display it. It must be generated and signed by the relay in which is found. Relays shouldn't accept these events if they're signed by anyone else. + +If the group is forked and hosted in multiple relays, there will be multiple versions of this event in each different relay and so on. + +```js +{ + "kind": 39000, + "content": "", + "tags": [ + ["d", "<group-id>"], + ["name", "Pizza Lovers"], + ["picture", "https://pizza.com/pizza.png"], + ["about", "a group for people who love pizza"], + ["public"], // or ["private"] + ["open"] // or ["closed"] + ] + ... +} +``` + +`name`, `picture` and `about` are basic metadata for the group for display purposes. `public` signals the group can be _read_ by anyone, while `private` signals that only AUTHed users can read. `open` signals that anyone can request to join and the request will be automatically granted, while `closed` signals that members must be pre-approved or that requests to join will be manually handled. + +- *group admins* (`kind:39001`) (optional) + +Similar to the group metadata, this event is supposed to be generated by relays that host the group. + +Each 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. + +The list of capabilities, as defined by this NIP, for now, is the following: + +- `add-user` +- `edit-metadata` +- `delete-event` +- `remove-user` +- `add-permission` +- `remove-permission` +- `edit-group-status` + +```js +{ + "kind": 39001, + "content": "list of admins for the pizza lovers group", + "tags": [ + ["d", "<group-id>"], + ["p", "<pubkey1-as-hex>", "ceo", "add-user", "edit-metadata", "delete-event", "remove-user"], + ["p", "<pubkey2-as-hex>", "secretary", "add-user", "delete-event"] + ] + ... +} +``` + +- *group members* (`kind:39002`) (optional) + +Similar to *group admins*, this event is supposed to be generated by relays that host the group. + +It'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. + +```json +{ + "kind": 39002, + "content": "list of members for the pizza lovers group", + "tags": [ + ["d", "<group-id>"], + ["p", "<admin1>"], + ["p", "<member-pubkey1>"], + ["p", "<member-pubkey2>"], + ] +} +``` + +## Storing the list of groups a user belongs to + +A 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. diff --git a/51.md b/51.md index c58d37a6..95acbc81 100644 --- a/51.md +++ b/51.md @@ -29,6 +29,7 @@ For example, _mute list_ can contain the public keys of spammers and bad actors | Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) | | Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) | | Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) | +| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group ids + mandatory relay URL) | | Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) | | Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | diff --git a/README.md b/README.md index 3273ab06..505e3e03 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-26: Delegated Event Signing](26.md) - [NIP-27: Text Note References](27.md) - [NIP-28: Public Chat](28.md) +- [NIP-29: Relay-based Groups](29.md) - [NIP-30: Custom Emoji](30.md) - [NIP-31: Dealing with Unknown Events](31.md) - [NIP-32: Labeling](32.md) @@ -92,6 +93,10 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `6` | Repost | [18](18.md) | | `7` | Reaction | [25](25.md) | | `8` | Badge Award | [58](58.md) | +| `9` | Group Chat Message | [29](29.md) | +| `10` | Group Chat Threaded Reply | [29](29.md) | +| `11` | Group Thread | [29](29.md) | +| `12` | Group Thread Reply | [29](29.md) | | `13` | Seal | [59](59.md) | | `16` | Generic Repost | [18](18.md) | | `40` | Channel Creation | [28](28.md) | @@ -112,6 +117,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `5000`-`5999` | Job Request | [90](90.md) | | `6000`-`6999` | Job Result | [90](90.md) | | `7000` | Job Feedback | [90](90.md) | +| `9000`-`9030` | Group Control Events | [29](29.md) | | `9041` | Zap Goal | [75](75.md) | | `9734` | Zap Request | [57](57.md) | | `9735` | Zap | [57](57.md) | @@ -124,6 +130,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10005` | Public chats list | [51](51.md) | | `10006` | Blocked relays list | [51](51.md) | | `10007` | Search relays list | [51](51.md) | +| `10009` | User groups | [51](51.md), [29](29.md) | | `10015` | Interests list | [51](51.md) | | `10030` | User emoji list | [51](51.md) | | `10096` | File storage server list | [96](96.md) | @@ -161,6 +168,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `31925` | Calendar Event RSVP | [52](52.md) | | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | +| `39000-9` | Group metadata events | [29](29.md) | | `34550` | Community Definition | [72](72.md) | [nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md From ac1221fa5d855fd838e29d71c636897feae6c3a2 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Tue, 5 Mar 2024 10:34:01 +0900 Subject: [PATCH 028/587] BREAKING.md: add NIP-18 change --- BREAKING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/BREAKING.md b/BREAKING.md index cd8c03d3..3693c345 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -5,6 +5,7 @@ reverse chronological order. | Date | Commit | NIP | Change | | ----------- | --------- | -------- | ------ | +| 2024-02-25 | [4a171cb0](https://github.com/nostr-protocol/nips/commit/4a171cb0) | [NIP-18](18.md) | quote repost should use `q` tag | | 2024-02-16 | [cbec02ab](https://github.com/nostr-protocol/nips/commit/cbec02ab) | [NIP-49](49.md) | Password first normalized to NFKC | | 2024-02-15 | [afbb8dd0](https://github.com/nostr-protocol/nips/commit/afbb8dd0) | [NIP-39](39.md) | PGP identity was removed | | 2024-02-07 | [d3dad114](https://github.com/nostr-protocol/nips/commit/d3dad114) | [NIP-46](46.md) | Connection token format was changed | From 9a283796ce95261c960d1b9ffc13e8f278079956 Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Tue, 5 Mar 2024 08:57:59 -0300 Subject: [PATCH 029/587] NIP-34: git stuff (#997) * NIP-34: git stuff. * repository head. * threads/issues and replies. * add "p" optional tags to events. * add list of things to do later in the end. * multiple values in some tags instead of multiple tags. * replace "patches", "issues" tags and replace that with "relays". * bring in tags that allow for a commit id to be stable. * edit "reply" kind to say it should follow normal NIP-10 threading rules. * update "things to be added later". * add commit time to "committer" tag. * remove "head" tag. * mention the possibility of mentioning others users in patches. Co-authored-by: DanConwayDev <114834599+DanConwayDev@users.noreply.github.com> * clarify commit-pgp-sig. * clarify requirements and threading of replies. * add t=root tag. --------- Co-authored-by: DanConwayDev <114834599+DanConwayDev@users.noreply.github.com> --- 34.md | 102 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 102 insertions(+) create mode 100644 34.md diff --git a/34.md b/34.md new file mode 100644 index 00000000..651407d2 --- /dev/null +++ b/34.md @@ -0,0 +1,102 @@ +NIP-34 +====== + +`git` stuff +----------- + +`draft` `optional` + +This NIP defines all the ways code collaboration using and adjacent to [`git`](https://git-scm.com/) can be done using Nostr. + +## Repository announcements + +Git repositories are hosted in Git-enabled servers, but their existence can be announced using Nostr events, as well as their willingness to receive patches, bug reports and comments in general. + +```jsonc +{ + "kind": 30617, + "content": "", + "tags": [ + ["d", "<repo-id>"], + ["name", "<human-readable project name>"], + ["description", "brief human-readable project description>"], + ["web", "<url for browsing>", ...], // a webpage url, if the git server being used provides such a thing + ["clone", "<url for git-cloning>", ...], // a url to be given to `git clone` so anyone can clone it + ["relays", "<relay-url>", ...] // relays that this repository will monitor for patches and issues + ] +} +``` + +The tags `web`, `clone`, `relays` can have multiple values. + +Except `d`, all tags are optional. + +## Patches + +Patches 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. + +```jsonc +{ + "kind": 1617, + "content": "<patch>", // contents of <git format-patch> + "tags": [ + ["a", "30617:<base-repo-owner-pubkey>:<base-repo-id>"], + ["p", "<repository-owner>"], + ["p", "<other-user>"], // optionally send the patch to another user to bring it to their attention + + // for the first patch in a thread or series + ["t", "root"], + + // optional tags for when it is desirable that the merged patch has a stable commit id + // these fields are necessary for ensuring that the commit resulting from applying a patch + // has the same id as it had in the proposer's machine -- all these tags can be omitted + // if the maintainer doesn't care about these things + ["commit", "<current-commit-id>"], + ["parent-commit", "<parent-commit-id>"], + ["commit-pgp-sig", "-----BEGIN PGP SIGNATURE-----..."], // empty string for unsigned commit + ["committer", "<name>", "<email>", "<timestamp>", "<timezone offset in minutes>"], + ] +} +``` + +## Issues + +Issues 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. + +```jsonc +{ + "kind": 1621, + "content": "<markdown text>", + "tags": [ + ["a", "30617:<base-repo-owner-pubkey>:<base-repo-id>"], + ["p", "<repository-owner>"] + ] +} +``` + +## Replies + +Replies are also Markdown text. The difference is that they MUST be issued as replies to either a `kind:1621` _issue_ or a `kind:1617` _patch_ event. The threading of replies and patches should follow NIP-10 rules. + +```jsonc +{ + "kind": 1622, + "content": "<markdown text>", + "tags": [ + ["a", "30617:<base-repo-owner-pubkey>:<base-repo-id>", "<relay-url>"], + ["e", "<issue-or-patch-id-hex>", "", "root"], + + // other "e" and "p" tags should be applied here when necessary, following the threading rules of NIP-10 + ["p", "<patch-author-pubkey-hex>", "", "mention"], + ["e", "<previous-reply-id-hex>", "", "reply"], + // ... + ] +} +``` + +## Possible things to be added later + +- "status" kind (for letting people know a patch was merged or an issue was fixed or won't be fixed) +- "branch merge" kind (specifying a URL from where to fetch the branch to be merged) +- "cover letter" kind (to which multiple patches can refer and serve as a unifying layer to them) +- inline file comments kind (we probably need one for patches and a different one for merged files) From 808569e562e774c17bd0caccf28b6ac95bc0641a Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Wed, 6 Mar 2024 12:35:59 +0900 Subject: [PATCH 030/587] README: add NIP-34 --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 505e3e03..5d163fd4 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-30: Custom Emoji](30.md) - [NIP-31: Dealing with Unknown Events](31.md) - [NIP-32: Labeling](32.md) +- [NIP-34: `git` stuff](34.md) - [NIP-36: Sensitive Content](36.md) - [NIP-38: User Statuses](38.md) - [NIP-39: External Identities in Profiles](39.md) From 1166fb9fb5e359a023de613417861ae2cb23e6a7 Mon Sep 17 00:00:00 2001 From: Alex Gleason <alex@alexgleason.me> Date: Wed, 6 Mar 2024 13:59:36 -0600 Subject: [PATCH 031/587] NIP-50: search by nip05 domain --- 50.md | 1 + 1 file changed, 1 insertion(+) diff --git a/50.md b/50.md index 9d1a54c3..66033037 100644 --- a/50.md +++ b/50.md @@ -47,3 +47,4 @@ Relays SHOULD exclude spam from search results by default if they support some f Relay MAY support these extensions: - `include:spam` - turn off spam filtering, if it was enabled by default +- `domain:<domain>` - include events from users whose valid nip05 domain matches the domain From 6871b3b334c3ae6ec23266b42d238859805a1ebe Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Thu, 7 Mar 2024 06:45:35 +0900 Subject: [PATCH 032/587] README: add kinds and tags for NIP-34 --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5d163fd4..90a63949 100644 --- a/README.md +++ b/README.md @@ -111,6 +111,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `1059` | Gift Wrap | [59](59.md) | | `1063` | File Metadata | [94](94.md) | | `1311` | Live Chat Message | [53](53.md) | +| `1617` | Patches | [34](34.md) | +| `1621` | Issues | [34](34.md) | +| `1622` | Replies | [34](34.md) | | `1971` | Problem Tracker | [nostrocket][nostrocket] | | `1984` | Reporting | [56](56.md) | | `1985` | Label | [32](32.md) | @@ -163,6 +166,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30315` | User Statuses | [38](38.md) | | `30402` | Classified Listing | [99](99.md) | | `30403` | Draft Classified Listing | [99](99.md) | +| `30617` | Repository announcements | [34](34.md) | | `31922` | Date-Based Calendar Event | [52](52.md) | | `31923` | Time-Based Calendar Event | [52](52.md) | | `31924` | Calendar | [52](52.md) | @@ -224,9 +228,10 @@ Please update these lists when proposing NIPs introducing new event kinds. | `bolt11` | `bolt11` invoice | -- | [57](57.md) | | `challenge` | challenge string | -- | [42](42.md) | | `client` | name, address | relay URL | [89](89.md) | +| `clone` | git clone URL | -- | [34](34.md) | | `content-warning` | reason | -- | [36](36.md) | | `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | -| `description` | invoice/badge description | -- | [57](57.md), [58](58.md) | +| `description` | description | -- | [34](34.md), [57](57.md), [58](58.md) | | `emoji` | shortcode, image URL | -- | [30](30.md) | | `encrypted` | -- | -- | [90](90.md) | | `expiration` | unix timestamp (string) | -- | [40](40.md) | @@ -235,7 +240,7 @@ Please update these lists when proposing NIPs introducing new event kinds. | `imeta` | inline metadata | -- | [92](92.md) | | `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | | `location` | location string | -- | [52](52.md), [99](99.md) | -| `name` | badge name | -- | [58](58.md) | +| `name` | name | -- | [34](34.md), [58](58.md) | | `nonce` | random | -- | [13](13.md) | | `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | | `price` | price | currency, frequency | [99](99.md) | @@ -248,6 +253,7 @@ Please update these lists when proposing NIPs introducing new event kinds. | `summary` | article summary | -- | [23](23.md) | | `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | | `title` | article title | -- | [23](23.md) | +| `web` | webpage URL | -- | [34](34.md) | | `zap` | pubkey (hex), relay URL | weight | [57](57.md) | ## Criteria for acceptance of NIPs From bf7294b22362539eda549d8a7fd0d85261f40b3f Mon Sep 17 00:00:00 2001 From: greenart7c3 <greenart7c3@proton.me> Date: Fri, 8 Mar 2024 07:59:54 -0300 Subject: [PATCH 033/587] Removed author --- 100.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/100.md b/100.md index ee5149ae..bf773962 100644 --- a/100.md +++ b/100.md @@ -2,7 +2,7 @@ ## Android Signer Application -`draft` `optional` `author:greenart7c3` +`draft` `optional` This NIP describes a method for 2-way communication between a android signer and any Nostr client on Android. The Android signer is an Android Application and the Client can be a Web Client or an Android Application. From 07074d8ba2615609fb702030151e191edcc91909 Mon Sep 17 00:00:00 2001 From: greenart7c3 <115044884+greenart7c3@users.noreply.github.com> Date: Fri, 8 Mar 2024 09:20:19 -0300 Subject: [PATCH 034/587] Apply suggestions from code review Co-authored-by: dluvian <133484344+dluvian@users.noreply.github.com> --- 100.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/100.md b/100.md index bf773962..06d6b355 100644 --- a/100.md +++ b/100.md @@ -4,13 +4,13 @@ `draft` `optional` -This NIP describes a method for 2-way communication between a android signer and any Nostr client on Android. The Android signer is an Android Application and the Client can be a Web Client or an Android Application. +This NIP describes a method for 2-way communication between an Android signer and any Nostr client on Android. The Android signer is an Android Application and the client can be a web client or an Android application. # Usage for Android applications The Android signer uses Intents and Content Resolvers to communicate between applications. -To be able to use The Android signer in your application you should this to your AndroidManifest.xml: +To be able to use the Android signer in your application you should add this to your AndroidManifest.xml: ```xml <queries> @@ -38,7 +38,7 @@ fun isExternalSignerInstalled(context: Context): Boolean { ## Using Intents -To get the result back from the Signer Appication you should use registerForActivityResult or rememberLauncherForActivityResult in Kotlin. If you are using another framework check the documentation of your framework or a third party library to get the result. +To get the result back from the Signer Application you should use `registerForActivityResult` or `rememberLauncherForActivityResult` in Kotlin. If you are using another framework check the documentation of your framework or a third party library to get the result. Create the Intent using the **nostrsigner** scheme: From d11f50bd0ad6663eb53e1da495f8a8b91bb194f5 Mon Sep 17 00:00:00 2001 From: "nostr.wine" <124309146+nostr-wine@users.noreply.github.com> Date: Fri, 8 Mar 2024 11:23:22 -0500 Subject: [PATCH 035/587] NIP-50: add event classification extensions --- 50.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/50.md b/50.md index 66033037..a3fcf87e 100644 --- a/50.md +++ b/50.md @@ -47,4 +47,8 @@ Relays SHOULD exclude spam from search results by default if they support some f Relay MAY support these extensions: - `include:spam` - turn off spam filtering, if it was enabled by default -- `domain:<domain>` - include events from users whose valid nip05 domain matches the domain +- `domain:<domain>` - include only events from users whose valid nip05 domain matches the domain +- `topic:<topic>` - include only events within a classified topic (short string, one to two words) +- `language:<two letter ISO 639-1 language code>` - include only events of a specified language +- `sentiment:<negative/neutral/positive>` - include only events of a specific sentiment +- `nsfw:<true/false>` - include or exclude nsfw events (default: true) From 0438236268194cfec1e0e02579e29e75bd52b173 Mon Sep 17 00:00:00 2001 From: "nostr.wine" <124309146+nostr-wine@users.noreply.github.com> Date: Fri, 8 Mar 2024 12:05:49 -0500 Subject: [PATCH 036/587] Update 50.md --- 50.md | 1 - 1 file changed, 1 deletion(-) diff --git a/50.md b/50.md index a3fcf87e..a6e02be9 100644 --- a/50.md +++ b/50.md @@ -48,7 +48,6 @@ Relays SHOULD exclude spam from search results by default if they support some f Relay MAY support these extensions: - `include:spam` - turn off spam filtering, if it was enabled by default - `domain:<domain>` - include only events from users whose valid nip05 domain matches the domain -- `topic:<topic>` - include only events within a classified topic (short string, one to two words) - `language:<two letter ISO 639-1 language code>` - include only events of a specified language - `sentiment:<negative/neutral/positive>` - include only events of a specific sentiment - `nsfw:<true/false>` - include or exclude nsfw events (default: true) From de71f998289a829ac4b2c0b0e601b02a2bf755b6 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Wed, 13 Mar 2024 12:46:16 +0900 Subject: [PATCH 037/587] NIP-96: simplify server list --- 96.md | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/96.md b/96.md index 3ebbef83..f7d901fd 100644 --- a/96.md +++ b/96.md @@ -82,14 +82,7 @@ it must use the "api_url" field instead. ### List of Supporting File Storage Servers -| Name | Domain | -| ------------- | ------------------------- | -| nostrcheck.me | https://nostrcheck.me | -| nostrage | https://nostrage.com | -| sove | https://sove.rent | -| nostr.build | https://nostr.build | -| sovbit | https://files.sovbit.host | -| void.cat | https://void.cat | +See https://github.com/aljazceru/awesome-nostr#nip-96-file-storage-servers. ## Upload From 2f2dead4cc08671b761f5e40f9a38cc32bcb26c5 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Thu, 14 Mar 2024 08:38:37 -0400 Subject: [PATCH 038/587] Adds draft event. --- 35.md | 25 +++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 27 insertions(+) create mode 100644 35.md diff --git a/35.md b/35.md new file mode 100644 index 00000000..ba2c7869 --- /dev/null +++ b/35.md @@ -0,0 +1,25 @@ +NIP-35 +====== + +Draft Events +------------ + +`draft` `optional` + +This NIP defines kind `31234` as a private draft event for any other event kind. + +The draft event is JSON-stringified, [NIP44-encrypted](44.md) to the owner's public key and placed inside the `.content` of the event. + +An additional `k` tag identifies the kind of the draft event. + +```js +{ + "kind": 31234, + "tags": [ + ["d", "<identifier>"], + ["k", "<kind of the draft event>"], + ], + "content": nip44Encrypt(JSON.stringify(draft_event)), + // other fields +} +``` \ No newline at end of file diff --git a/README.md b/README.md index 90a63949..dce4aaf2 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-31: Dealing with Unknown Events](31.md) - [NIP-32: Labeling](32.md) - [NIP-34: `git` stuff](34.md) +- [NIP-35: Draft Events](35.md) - [NIP-36: Sensitive Content](36.md) - [NIP-38: User Statuses](38.md) - [NIP-39: External Identities in Profiles](39.md) @@ -167,6 +168,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30402` | Classified Listing | [99](99.md) | | `30403` | Draft Classified Listing | [99](99.md) | | `30617` | Repository announcements | [34](34.md) | +| `31234` | Draft Event | [35](35.md) | | `31922` | Date-Based Calendar Event | [52](52.md) | | `31923` | Time-Based Calendar Event | [52](52.md) | | `31924` | Calendar | [52](52.md) | From f96ccc6e351be0b42d8b8395cc5b2de72f7f8e75 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Thu, 14 Mar 2024 08:52:58 -0400 Subject: [PATCH 039/587] Improved wording. --- 35.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/35.md b/35.md index ba2c7869..beff6754 100644 --- a/35.md +++ b/35.md @@ -6,9 +6,9 @@ Draft Events `draft` `optional` -This NIP defines kind `31234` as a private draft event for any other event kind. +This NIP defines kind `31234` as a private wrap for drafts of any other event kind. -The draft event is JSON-stringified, [NIP44-encrypted](44.md) to the owner's public key and placed inside the `.content` of the event. +The draft event is JSON-stringified, [NIP44-encrypted](44.md) to the signer's public key and placed inside the `.content` of the event. An additional `k` tag identifies the kind of the draft event. From f7f060303d25f081b1250761aff7522560270ddb Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Thu, 14 Mar 2024 14:07:23 -0400 Subject: [PATCH 040/587] Adds anchor events. --- 35.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/35.md b/35.md index beff6754..476ae36d 100644 --- a/35.md +++ b/35.md @@ -18,8 +18,12 @@ An additional `k` tag identifies the kind of the draft event. "tags": [ ["d", "<identifier>"], ["k", "<kind of the draft event>"], + ["e", "<anchor event event id>", "<relay-url>"], + ["a", "<anchor event address>", "<relay-url>"], ], "content": nip44Encrypt(JSON.stringify(draft_event)), // other fields } -``` \ No newline at end of file +``` + +Tags `e` and `a` identify one or more anchor events, such as parent events on replies. From 4f33dbc2b86684f9bf26dd1b0fc9789e3cbf2165 Mon Sep 17 00:00:00 2001 From: silberengel <silberengel7@protonmail.com> Date: Mon, 18 Mar 2024 08:01:06 +0100 Subject: [PATCH 041/587] Added bot field to denote automated npubs --- 24.md | 1 + 1 file changed, 1 insertion(+) diff --git a/24.md b/24.md index d444a4bc..449101af 100644 --- a/24.md +++ b/24.md @@ -16,6 +16,7 @@ These are extra fields not specified in NIP-01 that may be present in the string - `display_name`: an alternative, bigger name with richer characters than `name`. `name` should always be set regardless of the presence of `display_name` in the metadata. - `website`: a web URL related in any way to the event author. - `banner`: an URL to a wide (~1024x768) picture to be optionally displayed in the background of a profile screen. + - `bot`: a boolean to clarify that the content is entirely or partially the result of automation, such as with chatbots or newsfeeds. ### Deprecated fields From 4842f8612f55d9c11ef228338f6ef6f658e788a1 Mon Sep 17 00:00:00 2001 From: greenart7c3 <115044884+greenart7c3@users.noreply.github.com> Date: Mon, 18 Mar 2024 15:00:30 -0300 Subject: [PATCH 042/587] Apply suggestions from code review Co-authored-by: dluvian <133484344+dluvian@users.noreply.github.com> --- 100.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/100.md b/100.md index 06d6b355..386ec802 100644 --- a/100.md +++ b/100.md @@ -46,7 +46,7 @@ Create the Intent using the **nostrsigner** scheme: val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$content")) ``` -* Set the Signer package name +Set the Signer package name: ```kotlin intent.`package` = "com.example.signer" @@ -61,14 +61,14 @@ intent.`package` = "com.example.signer" val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:")) intent.`package` = "com.example.signer" intent.putExtra("type", "get_public_key") - // You can send some default permissions for the user authorize for ever + // You can send some default permissions for the user to authorize for ever val permissions = listOf( Permission( - "sign_event", - 22242 + type = "sign_event", // Is it type? + kind = 22242 // Is it kind? ), Permission( - "nip44_decrypt" + type = "nip44_decrypt" ) ) intent.putExtra("permissions", permissions.toJson()) @@ -90,10 +90,10 @@ intent.`package` = "com.example.signer" val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$eventJson")) intent.`package` = "com.example.signer" intent.putExtra("type", "sign_event") - // to control the result in your application in case you are not waiting the result before sending another intent + // To handle results when not waiting between intents intent.putExtra("id", event.id) // Send the current logged in user npub - intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) + intent.putExtra("current_user", npub) context.startActivity(intent) ``` @@ -102,7 +102,7 @@ intent.`package` = "com.example.signer" ```kotlin val signature = intent.data?.getStringExtra("signature") - // the id you sent + // The id you sent val id = intent.data?.getStringExtra("id") val signedEventJson = intent.data?.getStringExtra("event") ``` @@ -233,13 +233,13 @@ intent.`package` = "com.example.signer" To 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. -If 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 +If 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 For the SIGN_EVENT type Signer Application returns two columns "signature" and "event". The column event is the signed event json For the other types Signer Application returns the column "signature" -If the user chose to always reject the event signer application will return the column "rejected" and you should not open signer application +If the user chose to always reject the event, signer application will return the column "rejected" and you should not open signer application ### Methods @@ -416,15 +416,15 @@ If the user chose to always reject the event signer application will return the # Usage for Web Applications -Since web applications can't receive a result from the intent you should add a modal to paste the signature or the event json or create a callback url. +Since web applications can't receive a result from the intent, you should add a modal to paste the signature or the event json or create a callback url. -If you send the callback url parameter Signer Application will send the result to the url. +If you send the callback url parameter, Signer Application will send the result to the url. -If you don't send a callback url Signer Application will copy the result to the clipboard. +If you don't send a callback url, Signer Application will copy the result to the clipboard. -You can configure the returnType to be **signature** or **event**. +You can configure the `returnType` to be **signature** or **event**. -Android intents and browsers url has limitations, so if you are using the returnType of **event** consider using the parameter **compressionType=gzip** that will return "Signer1" + Base 64 gzip encoded event json +Android intents and browser urls have limitations, so if you are using the `returnType` of **event** consider using the parameter **compressionType=gzip** that will return "Signer1" + Base64 gzip encoded event json ## Methods From 6b26ebe6c5c9834549aa9adec0d066bc5c6aae88 Mon Sep 17 00:00:00 2001 From: greenart7c3 <115044884+greenart7c3@users.noreply.github.com> Date: Mon, 18 Mar 2024 15:01:03 -0300 Subject: [PATCH 043/587] Update 100.md --- 100.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/100.md b/100.md index 386ec802..79ced802 100644 --- a/100.md +++ b/100.md @@ -64,8 +64,8 @@ intent.`package` = "com.example.signer" // You can send some default permissions for the user to authorize for ever val permissions = listOf( Permission( - type = "sign_event", // Is it type? - kind = 22242 // Is it kind? + type = "sign_event", + kind = 22242 ), Permission( type = "nip44_decrypt" @@ -525,4 +525,4 @@ Android intents and browser urls have limitations, so if you are using the `retu </script> </body> </html> -``` \ No newline at end of file +``` From a2aaa3c00b18e2e11dceae9400cd6fc429562622 Mon Sep 17 00:00:00 2001 From: greenart7c3 <115044884+greenart7c3@users.noreply.github.com> Date: Mon, 18 Mar 2024 15:10:25 -0300 Subject: [PATCH 044/587] add example of rememberLauncherForActivityResult --- 100.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/100.md b/100.md index 79ced802..24bf09f1 100644 --- a/100.md +++ b/100.md @@ -40,6 +40,24 @@ fun isExternalSignerInstalled(context: Context): Boolean { To get the result back from the Signer Application you should use `registerForActivityResult` or `rememberLauncherForActivityResult` in Kotlin. If you are using another framework check the documentation of your framework or a third party library to get the result. +```kotlin +val launcher = rememberLauncherForActivityResult( + contract = ActivityResultContracts.StartActivityForResult(), + onResult = { result -> + if (result.resultCode != Activity.RESULT_OK) { + Toast.makeText( + context, + "Sign request rejected", + Toast.LENGTH_SHORT + ).show() + } else { + val signature = activityResult.data?.getStringExtra("signature") + // Do something with signature ... + } + } +) +``` + Create the Intent using the **nostrsigner** scheme: ```kotlin @@ -52,6 +70,12 @@ Set the Signer package name: intent.`package` = "com.example.signer" ``` +Send the Intent: + +```kotlin +launcher.launch(intent) +``` + ### Methods - **get_public_key** From 527f62d0106e6cfee10fe5e58ee54f0f99a57fac Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Tue, 19 Mar 2024 05:59:29 -0700 Subject: [PATCH 045/587] relax requirements for NIP 32 L tags --- 32.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/32.md b/32.md index be4e8724..46414736 100644 --- a/32.md +++ b/32.md @@ -20,7 +20,7 @@ Label Namespace Tag An `L` tag can be any string, but publishers SHOULD ensure they are unambiguous by using a well-defined namespace (such as an ISO standard) or reverse domain name notation. -`L` tags are REQUIRED in order to support searching by namespace rather than by a specific tag. The special `ugc` +`L` tags are RECOMMENDED in order to support searching by namespace rather than by a specific tag. The special `ugc` ("user generated content") namespace MAY be used when the label content is provided by an end user. `L` tags starting with `#` indicate that the label target should be associated with the label's value. @@ -29,7 +29,7 @@ This is a way of attaching standard nostr tags to events, pubkeys, relays, urls, Label Tag ---- -An `l` tag's value can be any string. `l` tags MUST include a `mark` matching an `L` tag value in the same event. +An `l` tag's value can be any string. If using an `L` tag, `l` tags MUST include a `mark` matching an `L` tag value in the same event. Label Target ---- @@ -42,7 +42,7 @@ or topics respectively. As with NIP-01, a relay hint SHOULD be included when usi Content ------- -Labels should be short, meaningful strings. Longer discussions, such as for a review, or an +Labels should be short, meaningful strings. Longer discussions, such as for an explanation of why something was labeled the way it was, should go in the event's `content` field. Self-Reporting From 46a6bf331ae823dad079a9740f37d57e58b92358 Mon Sep 17 00:00:00 2001 From: utxo <github@utxo.one> Date: Thu, 21 Mar 2024 10:15:02 -0400 Subject: [PATCH 046/587] Make relay attribute recommended in NIP-05 --- 05.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/05.md b/05.md index 64375506..a4b804cc 100644 --- a/05.md +++ b/05.md @@ -1,8 +1,6 @@ -NIP-05 -====== +# NIP-05 -Mapping Nostr keys to DNS-based internet identifiers ----------------------------------------------------- +## Mapping Nostr keys to DNS-based internet identifiers `final` `optional` @@ -33,9 +31,9 @@ It will make a GET request to `https://example.com/.well-known/nostr.json?name=b "bob": "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9" } } -```` +``` -or with the **optional** `"relays"` attribute: +or with the **recommended** `"relays"` attribute: ```json { @@ -43,14 +41,17 @@ or with the **optional** `"relays"` attribute: "bob": "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9" }, "relays": { - "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9": [ "wss://relay.example.com", "wss://relay2.example.com" ] + "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9": [ + "wss://relay.example.com", + "wss://relay2.example.com" + ] } } -```` +``` If 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. -The optional `"relays"` attribute may contain an object with public keys as properties and arrays of relay URLs as values. When present, that can be used to help clients learn in which relays the specific user may be found. Web servers which serve `/.well-known/nostr.json` files dynamically based on the query string SHOULD also serve the relays data for any name they serve in the same reply when that is available. +The recommended `"relays"` attribute may contain an object with public keys as properties and arrays of relay URLs as values. When present, that can be used to help clients learn in which relays the specific user may be found. Web servers which serve `/.well-known/nostr.json` files dynamically based on the query string SHOULD also serve the relays data for any name they serve in the same reply when that is available. ## Finding users from their NIP-05 identifier From 965eb45b30b6000da976addcf3163858abadcf07 Mon Sep 17 00:00:00 2001 From: utxo <github@utxo.one> Date: Thu, 21 Mar 2024 10:18:42 -0400 Subject: [PATCH 047/587] remove prettier formatting --- 05.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/05.md b/05.md index a4b804cc..405078a4 100644 --- a/05.md +++ b/05.md @@ -1,6 +1,8 @@ -# NIP-05 +NIP-05 +====== -## Mapping Nostr keys to DNS-based internet identifiers +Mapping Nostr keys to DNS-based internet identifiers +---------------------------------------------------- `final` `optional` @@ -31,7 +33,7 @@ It will make a GET request to `https://example.com/.well-known/nostr.json?name=b "bob": "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9" } } -``` +```` or with the **recommended** `"relays"` attribute: @@ -41,13 +43,10 @@ or with the **recommended** `"relays"` attribute: "bob": "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9" }, "relays": { - "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9": [ - "wss://relay.example.com", - "wss://relay2.example.com" - ] + "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9": [ "wss://relay.example.com", "wss://relay2.example.com" ] } } -``` +```` If 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. From 4b79bc67c471f77061d62704538e5fdd6ac28ae8 Mon Sep 17 00:00:00 2001 From: "Nostr.Band" <124499563+nostrband@users.noreply.github.com> Date: Fri, 22 Mar 2024 08:01:37 +0100 Subject: [PATCH 048/587] Add optional_requested_permissions This is implemented in nsec.app, nostr.band, Coracle and Nostrudel, so maybe it's time to update the NIP. --- 46.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/46.md b/46.md index eb964942..8ba65d96 100644 --- a/46.md +++ b/46.md @@ -120,7 +120,7 @@ Each of the following are methods that the client sends to the remote signer. | Command | Params | Result | | ------------------------ | ------------------------------------------------- | ---------------------------------------------------------------------- | -| `connect` | `[<remote_user_pubkey>, <optional_secret>]` | "ack" | +| `connect` | `[<remote_user_pubkey>, <optional_secret>, <optional_requested_permissions>]` | "ack" | | `sign_event` | `[<json_stringified_event_to_sign>]` | `json_stringified(<signed_event>)` | | `ping` | `[]` | "pong" | | `get_relays` | `[]` | `json_stringified({<relay_url>: {read: <boolean>, write: <boolean>}})` | @@ -130,6 +130,10 @@ Each of the following are methods that the client sends to the remote signer. | `nip44_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip44_ciphertext>` | | `nip44_decrypt` | `[<third_party_pubkey>, <nip44_ciphertext_to_decrypt>]` | `<plaintext>` | +### Requested permissions + +The `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. + ## Response Events `kind:24133` ```json @@ -185,7 +189,7 @@ Each of the following are methods that the client sends to the remote signer. | Command | Params | Result | | ---------------- | ------------------------------------------ | ------------------------------------ | -| `create_account` | `[<username>, <domain>, <optional_email>]` | `<newly_created_remote_user_pubkey>` | +| `create_account` | `[<username>, <domain>, <optional_email>, <optional_requested_permissions>]` | `<newly_created_remote_user_pubkey>` | ## Appendix From 769432efc42b69e5f23956a98d944238bba8d461 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Fri, 29 Mar 2024 08:06:00 +0900 Subject: [PATCH 049/587] README: fix order of kinds --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 90a63949..c3c5ef09 100644 --- a/README.md +++ b/README.md @@ -173,8 +173,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `31925` | Calendar Event RSVP | [52](52.md) | | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | -| `39000-9` | Group metadata events | [29](29.md) | | `34550` | Community Definition | [72](72.md) | +| `39000-9` | Group metadata events | [29](29.md) | [nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md [lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md From 881780186077154f35abef89fe60c6d28343c8fd Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Thu, 28 Mar 2024 16:57:00 -0400 Subject: [PATCH 050/587] Clarifies relays to be used for NIP-28 --- 28.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/28.md b/28.md index 2dcf8003..65ebb3ff 100644 --- a/28.md +++ b/28.md @@ -23,11 +23,11 @@ Client-centric moderation gives client developers discretion over what types of Create a public chat channel. -In the channel creation `content` field, Client SHOULD include basic channel metadata (`name`, `about`, `picture` as specified in kind 41). +In the channel creation `content` field, Client SHOULD include basic channel metadata (`name`, `about`, `picture` and `relays` as specified in kind 41). ```json { - "content": "{\"name\": \"Demo Channel\", \"about\": \"A test channel.\", \"picture\": \"https://placekitten.com/200/200\"}", + "content": "{\"name\": \"Demo Channel\", \"about\": \"A test channel.\", \"picture\": \"https://placekitten.com/200/200\", \"relays\": [\"wss://nos.lol\", \"wss://nostr.mom\"]}", ... } ``` @@ -46,6 +46,7 @@ Clients SHOULD support basic metadata fields: - `name` - string - Channel name - `about` - string - Channel description - `picture` - string - URL of channel picture +- `relays` - array - List of relays to download and broadcast events to Clients MAY add additional metadata fields. @@ -53,7 +54,7 @@ Clients SHOULD use [NIP-10](10.md) marked "e" tags to recommend a relay. ```json { - "content": "{\"name\": \"Updated Demo Channel\", \"about\": \"Updating a test channel.\", \"picture\": \"https://placekitten.com/201/201\"}", + "content": "{\"name\": \"Updated Demo Channel\", \"about\": \"Updating a test channel.\", \"picture\": \"https://placekitten.com/201/201\", \"relays\": [\"wss://nos.lol\", \"wss://nostr.mom\"]}", "tags": [["e", <channel_create_event_id>, <relay-url>]], ... } @@ -132,12 +133,11 @@ Clients MAY hide event 42s for users other than the user who sent the event 44. } ``` -## NIP-10 relay recommendations +## Relay recommendations -For [NIP-10](10.md) relay recommendations, clients generally SHOULD use the relay URL of the original (oldest) kind 40 event. - -Clients MAY recommend any relay URL. For example, if a relay hosting the original kind 40 event for a channel goes offline, clients could instead fetch channel data from a backup relay, or a relay that clients trust more than the original relay. +Clients SHOULD use the relay URLs of the metadata events. +Clients MAY use any relay URL. For example, if a relay hosting the original kind 40 event for a channel goes offline, clients could instead fetch channel data from a backup relay, or a relay that clients trust more than the original relay. Motivation ---------- From 0ed2f63f223f03a171d1aa5c31dbec6bd68ffb6b Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Fri, 29 Mar 2024 11:39:19 -0400 Subject: [PATCH 051/587] Getting drafts to be deleted even without relays supporting deletion events. --- 35.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/35.md b/35.md index 476ae36d..4bec44be 100644 --- a/35.md +++ b/35.md @@ -26,4 +26,6 @@ An additional `k` tag identifies the kind of the draft event. } ``` +A blanked `.content` means this draft has been deleted by a client but relays still have the event. + Tags `e` and `a` identify one or more anchor events, such as parent events on replies. From 9971db355164815c986251f8f89d1c7c70ec9e53 Mon Sep 17 00:00:00 2001 From: arthurfranca <arthur.a.franca@gmail.com> Date: Sat, 30 Mar 2024 22:33:24 -0300 Subject: [PATCH 052/587] Minor fix to nip01 --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 905e45f7..a91febc5 100644 --- a/01.md +++ b/01.md @@ -81,7 +81,7 @@ This NIP defines 3 standard tags that can be used across all event kinds with th - for a parameterized replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]` - for a non-parameterized replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:, <recommended relay URL, optional>]` -As 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. +As 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. ### Kinds From af5d4074886916877c350dbdfec61e62a9875255 Mon Sep 17 00:00:00 2001 From: Alex Gleason <alex@alexgleason.me> Date: Tue, 2 Apr 2024 10:00:07 -0500 Subject: [PATCH 053/587] Update BREAKING.md for NIP-46 (stringified params) --- BREAKING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/BREAKING.md b/BREAKING.md index 3693c345..80248142 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -6,6 +6,7 @@ reverse chronological order. | Date | Commit | NIP | Change | | ----------- | --------- | -------- | ------ | | 2024-02-25 | [4a171cb0](https://github.com/nostr-protocol/nips/commit/4a171cb0) | [NIP-18](18.md) | quote repost should use `q` tag | +| 2024-02-10 | [c6cd655c](https://github.com/nostr-protocol/nips/commit/c6cd655c) | [NIP-46](46.md) | Params were stringified | | 2024-02-16 | [cbec02ab](https://github.com/nostr-protocol/nips/commit/cbec02ab) | [NIP-49](49.md) | Password first normalized to NFKC | | 2024-02-15 | [afbb8dd0](https://github.com/nostr-protocol/nips/commit/afbb8dd0) | [NIP-39](39.md) | PGP identity was removed | | 2024-02-07 | [d3dad114](https://github.com/nostr-protocol/nips/commit/d3dad114) | [NIP-46](46.md) | Connection token format was changed | From ca97490cdf4d499752bee2fa589514e2a474419b Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Wed, 3 Apr 2024 13:09:22 +0900 Subject: [PATCH 054/587] NIP-58: minor JSON fix --- 58.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/58.md b/58.md index 0ecef257..4a9ed4c4 100644 --- a/58.md +++ b/58.md @@ -83,7 +83,7 @@ Clients SHOULD attempt to render the most appropriate badge thumbnail according ["name", "Medal of Bravery"], ["description", "Awarded to users demonstrating bravery"], ["image", "https://nostr.academy/awards/bravery.png", "1024x1024"], - ["thumb", "https://nostr.academy/awards/bravery_256x256.png", "256x256"], + ["thumb", "https://nostr.academy/awards/bravery_256x256.png", "256x256"] ], ... } @@ -99,7 +99,7 @@ Clients SHOULD attempt to render the most appropriate badge thumbnail according "tags": [ ["a", "30009:alice:bravery"], ["p", "bob", "wss://relay"], - ["p", "charlie", "wss://relay"], + ["p", "charlie", "wss://relay"] ], ... } @@ -117,7 +117,7 @@ Honorable Bob The Brave: ["a", "30009:alice:bravery"], ["e", "<bravery badge award event id>", "wss://nostr.academy"], ["a", "30009:alice:honor"], - ["e", "<honor badge award event id>", "wss://nostr.academy"], + ["e", "<honor badge award event id>", "wss://nostr.academy"] ], ... } From 3c75180fb7947c133a063ba475067a3b8f42d619 Mon Sep 17 00:00:00 2001 From: Matthew Lorentz <matt@lorentz.is> Date: Wed, 3 Apr 2024 10:50:02 -0400 Subject: [PATCH 055/587] Add category to reports --- 56.md | 1 + 1 file changed, 1 insertion(+) diff --git a/56.md b/56.md index a2861e35..d6978c23 100644 --- a/56.md +++ b/56.md @@ -28,6 +28,7 @@ being reported, which consists of the following report types: - `illegal` - something which may be illegal in some jurisdiction - `spam` - spam - `impersonation` - someone pretending to be someone else +- `other` - for reports that don't fit in the above categories Some report tags only make sense for profile reports, such as `impersonation` From b224f6d05d5b208b632e8e1f5ac489b7f27079ae Mon Sep 17 00:00:00 2001 From: Matthew Lorentz <matt@lorentz.is> Date: Wed, 3 Apr 2024 10:59:37 -0400 Subject: [PATCH 056/587] Update description of NIP-56 --- 56.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/56.md b/56.md index d6978c23..3209b80d 100644 --- a/56.md +++ b/56.md @@ -4,10 +4,12 @@ NIP-56 Reporting --------- -`draft` `optional` +`optional` -A report is a `kind 1984` note that is used to report other notes for spam, -illegal and explicit content. +A report is a `kind 1984` event that signals to users and relays that +some referenced content is objectionable. The definition of objectionable is +obviously subjective and all agents on the network (users, apps, relays, etc.) +may consume and take action on them as they see fit. The `content` MAY contain additional information submitted by the entity reporting the content. From b765b3c0301958d46115b834872bbd0c8bac588c Mon Sep 17 00:00:00 2001 From: kuiperanon <164939804+kuiperanon@users.noreply.github.com> Date: Tue, 9 Apr 2024 11:25:05 -0500 Subject: [PATCH 057/587] Clarify use of ambiguous terminology in spec of bunker token It's very confusing as to whether it refers to remote user pubkey vs remote signer pubkey. This is complicated further by the typo in the explanation of "remote signer pubkey". --- 46.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/46.md b/46.md index 8ba65d96..56b84022 100644 --- a/46.md +++ b/46.md @@ -25,7 +25,7 @@ This is most common in a situation where you have your own nsecbunker or other t The remote signer would provide a connection token in the form: ``` -bunker://<remote-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value> +bunker://<remote-user-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value> ``` This 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). From e97df1410391dd04fdbf9695932275a9d763940c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=9B=AA=E7=8C=AB?= <SnowCait@users.noreply.github.com> Date: Sat, 13 Apr 2024 12:39:24 +0900 Subject: [PATCH 058/587] Kind mute sets --- 51.md | 1 + 1 file changed, 1 insertion(+) diff --git a/51.md b/51.md index 95acbc81..b151facd 100644 --- a/51.md +++ b/51.md @@ -48,6 +48,7 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti | 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) | | 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) | | Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"a"` (kind:34235 videos) | +| Kind mute sets | 30007 | mute pubkeys by kinds<br>`"d"` tag MUST be the kind string | `"p"` (pubkeys) | | Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) | | Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | | 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"` | From d607a288b5db72a84f3d6cc8fd42304d31e1f66b Mon Sep 17 00:00:00 2001 From: DanConwayDev <DanConwayDev@protonmail.com> Date: Thu, 7 Mar 2024 07:59:16 +0000 Subject: [PATCH 059/587] NIP-34: clarify nip10 thread application for consistancy and so that the intended order of patches is easier to ascertain enables additional patches to be appended to a patch set, supporting a PR-like workflow alongside patch-over-email-like workflow --- 34.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/34.md b/34.md index 651407d2..2a7f489f 100644 --- a/34.md +++ b/34.md @@ -35,6 +35,10 @@ Except `d`, all tags are optional. Patches 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. +Patches in a patch set SHOULD include a NIP-10 `e` `reply` tag pointing to the previous patch. + +The first patch revision in a patch revision SHOULD include a NIP-10 `e` `reply` to the original root patch. + ```jsonc { "kind": 1617, From 46ea8dcf9cedd1f64e9444b70ac0ed24e40bbe1a Mon Sep 17 00:00:00 2001 From: DanConwayDev <DanConwayDev@protonmail.com> Date: Thu, 7 Mar 2024 08:03:48 +0000 Subject: [PATCH 060/587] NIP-34: add repo-id standard suggested guidance for repo-id --- 34.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/34.md b/34.md index 2a7f489f..7eea92b8 100644 --- a/34.md +++ b/34.md @@ -17,7 +17,7 @@ Git repositories are hosted in Git-enabled servers, but their existence can be a "kind": 30617, "content": "", "tags": [ - ["d", "<repo-id>"], + ["d", "<repo-id>"], // usually kebab-case short name ["name", "<human-readable project name>"], ["description", "brief human-readable project description>"], ["web", "<url for browsing>", ...], // a webpage url, if the git server being used provides such a thing From cb0d35a5f9f1b88a270f7fbbfbdb97e095e28d56 Mon Sep 17 00:00:00 2001 From: DanConwayDev <DanConwayDev@protonmail.com> Date: Thu, 7 Mar 2024 08:25:49 +0000 Subject: [PATCH 061/587] NIP-34: optional additional repo maintainers can be used by clients to tag multiple maintainers in patches helps clients identify whether multiple repo events for the same repository are complementary or in competion --- 34.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/34.md b/34.md index 7eea92b8..bb7e3eec 100644 --- a/34.md +++ b/34.md @@ -23,11 +23,12 @@ Git repositories are hosted in Git-enabled servers, but their existence can be a ["web", "<url for browsing>", ...], // a webpage url, if the git server being used provides such a thing ["clone", "<url for git-cloning>", ...], // a url to be given to `git clone` so anyone can clone it ["relays", "<relay-url>", ...] // relays that this repository will monitor for patches and issues + ["maintainers", "<other-recognized-maintainer>", ...] ] } ``` -The tags `web`, `clone`, `relays` can have multiple values. +The tags `web`, `clone`, `relays`, `maintainers` can have multiple values. Except `d`, all tags are optional. From 8225a018c72c4d11b575ed4e57fa587d08c09027 Mon Sep 17 00:00:00 2001 From: DanConwayDev <DanConwayDev@protonmail.com> Date: Thu, 7 Mar 2024 09:01:19 +0000 Subject: [PATCH 062/587] NIP-34: optional tags to improve discoverability earliest-unique-commit r tag enables clients to: - retrieve all repo events refering to a local git repo - group repo events with different identifers that refer to same repo - retrieve all patches for a local repo, irespective of the tagged repo event current-commit-id r tag enables clients to prevent accidental submission of a patch, which has already been proposed root-revision tag enables clients to filter out proposal revisions from a list of proposals --- 34.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/34.md b/34.md index bb7e3eec..fefc7af5 100644 --- a/34.md +++ b/34.md @@ -23,6 +23,8 @@ Git repositories are hosted in Git-enabled servers, but their existence can be a ["web", "<url for browsing>", ...], // a webpage url, if the git server being used provides such a thing ["clone", "<url for git-cloning>", ...], // a url to be given to `git clone` so anyone can clone it ["relays", "<relay-url>", ...] // relays that this repository will monitor for patches and issues + ["earliest-unique-commit", "<commit-id>"] // usually root commit but a recent commit for forks + ["r", "<earliest-unique-commit-id>"] // so clients can subscribe to all events related to a local git repo ["maintainers", "<other-recognized-maintainer>", ...] ] } @@ -46,17 +48,20 @@ The first patch revision in a patch revision SHOULD include a NIP-10 `e` `reply` "content": "<patch>", // contents of <git format-patch> "tags": [ ["a", "30617:<base-repo-owner-pubkey>:<base-repo-id>"], + ["r", "<earliest-unique-commit-id-of-repo>"] // so clients can subscribe to all patches sent to a local git repo ["p", "<repository-owner>"], ["p", "<other-user>"], // optionally send the patch to another user to bring it to their attention - // for the first patch in a thread or series - ["t", "root"], + ["t", "root"], // ommited for additional patches in a series + // for the first patch in a revision + ["t", "root-revision"], // optional tags for when it is desirable that the merged patch has a stable commit id // these fields are necessary for ensuring that the commit resulting from applying a patch // has the same id as it had in the proposer's machine -- all these tags can be omitted // if the maintainer doesn't care about these things ["commit", "<current-commit-id>"], + ["r", "<current-commit-id>"] // so clients can find existing patches for a specific commit ["parent-commit", "<parent-commit-id>"], ["commit-pgp-sig", "-----BEGIN PGP SIGNATURE-----..."], // empty string for unsigned commit ["committer", "<name>", "<email>", "<timestamp>", "<timezone offset in minutes>"], From 0b62729e318497922822c39471ab31a869563ba5 Mon Sep 17 00:00:00 2001 From: DanConwayDev <DanConwayDev@protonmail.com> Date: Thu, 7 Mar 2024 09:20:25 +0000 Subject: [PATCH 063/587] NIP-34: clarify cover letters remove cover letters from 'possible things to be added later' and add a clarification that can they can be added through patches --- 34.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/34.md b/34.md index fefc7af5..c6e72257 100644 --- a/34.md +++ b/34.md @@ -69,6 +69,8 @@ The first patch revision in a patch revision SHOULD include a NIP-10 `e` `reply` } ``` +The first patch in a series MAY be a cover letter in the format produced by `git format-patch`. + ## Issues Issues 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. @@ -108,5 +110,4 @@ Replies are also Markdown text. The difference is that they MUST be issued as re - "status" kind (for letting people know a patch was merged or an issue was fixed or won't be fixed) - "branch merge" kind (specifying a URL from where to fetch the branch to be merged) -- "cover letter" kind (to which multiple patches can refer and serve as a unifying layer to them) - inline file comments kind (we probably need one for patches and a different one for merged files) From 403b5199a490b6a148063003e00924f5e79ba36c Mon Sep 17 00:00:00 2001 From: DanConwayDev <DanConwayDev@protonmail.com> Date: Thu, 7 Mar 2024 10:21:06 +0000 Subject: [PATCH 064/587] NIP-34: add status events merge-commit and applied-commit-id tags enable discussion of patches to be mapped to lines of code accepted into the master branch --- 34.md | 40 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) diff --git a/34.md b/34.md index c6e72257..f72fcf28 100644 --- a/34.md +++ b/34.md @@ -106,8 +106,46 @@ Replies are also Markdown text. The difference is that they MUST be issued as re } ``` +## Status + +Root Patches and Issues have a Status that defaults to 'Open' and can be set by issuing Status events. + +```jsonc +{ + "kind": 1630, // Open + "kind": 1631, // Applied / Merged for Patches; Resolved for Issues + "kind": 1632, // Closed + "kind": 1633, // Draft + "content": "<markdown text>", + "tags": [ + ["e", "<issue-or-original-root-patch-id-hex>", "", "root"], + ["e", "<accepted-revision-root-id-hex>", "", "reply"], // for when revisions applied + ["p", "<repository-owner>"], + ["p", "<root-event-author>"], + ["p", "<revision-author>"], + + // optional for improved subscription filter efficency + ["a", "30617:<base-repo-owner-pubkey>:<base-repo-id>", "<relay-url>"], + ["r", "<earliest-unique-commit-id-of-repo>"] + + // optional for `1631` status + ["e", "<applied-or-merged-patch-event-id>", "", "mention"], // for each + // when merged + ["merge-commit", "<merge-commit-id>"] + ["r", "<merge-commit-id>"] + // when applied + ["applied-as-commits", "<commit-id-in-master-branch>", ...] + ["r", "<applied-commit-id>"] // for each + ] +} +``` + +The Status event with the largest created_at date is valid. + +The 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. + + ## Possible things to be added later -- "status" kind (for letting people know a patch was merged or an issue was fixed or won't be fixed) - "branch merge" kind (specifying a URL from where to fetch the branch to be merged) - inline file comments kind (we probably need one for patches and a different one for merged files) From 280eb498e0ac56b8f9356c1b7a88cc8b31579801 Mon Sep 17 00:00:00 2001 From: Oscar Merry <oscardmerry@gmail.com> Date: Fri, 19 Apr 2024 14:30:45 +0100 Subject: [PATCH 065/587] Draft External Content IDs --- 24.md | 1 + XX.md | 31 +++++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 XX.md diff --git a/24.md b/24.md index 449101af..a17b334c 100644 --- a/24.md +++ b/24.md @@ -40,4 +40,5 @@ tags These 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: - `r`: a web URL the event is referring to in some way + - `i`: an external id the event is referring to in some way - see [NIP-XX](XX.md) - `title`: title of the event diff --git a/XX.md b/XX.md new file mode 100644 index 00000000..8751d947 --- /dev/null +++ b/XX.md @@ -0,0 +1,31 @@ +NIP-XX +====== + +External Content IDs +------------------------- + +`draft` `optional` + +There are certain established global content identifiers that would be useful to reference in nostr events so that clients can query all events assosiated with these ids. + +- Book [ISBNs](https://en.wikipedia.org/wiki/ISBN) +- Podcast [GUIDs](https://podcastnamespace.org/tag/guid) +- Movie [EIDRs](https://www.eidr.org) + +Since the `i` tag is already used for similar references in kind-0 metadata events it makes sense to use it for these content ids as well. + + +## Supported IDs + +### Books: + +- Book ISBN: `["i", "book:isbn:123"]` + +### Podcasts: + +- Podcast Feed GUID: `["i", "podcast:guid:123"]` +- Podcast Item GUID: `["i", "podcast:item:guid:123"]` + +### Movies: + +- Movie EIDR: `["i", "movie:eidr:123"]` \ No newline at end of file From eb3a857288fe99d99b73e07dfa28ac548fc10efb Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Mon, 22 Apr 2024 12:35:48 +0900 Subject: [PATCH 066/587] README: add status kinds of NIP-34 --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index c3c5ef09..5fcdaf76 100644 --- a/README.md +++ b/README.md @@ -114,6 +114,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `1617` | Patches | [34](34.md) | | `1621` | Issues | [34](34.md) | | `1622` | Replies | [34](34.md) | +| `1630`-`1633` | Status | [34](34.md) | | `1971` | Problem Tracker | [nostrocket][nostrocket] | | `1984` | Reporting | [56](56.md) | | `1985` | Label | [32](32.md) | From df30012430c88d49fb5b124992b04d5c61b6338b Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Wed, 24 Apr 2024 15:31:45 -0400 Subject: [PATCH 067/587] NIP-17 (old 24) Sealed Gift-Wrapped Messages for Private DMs and Small Group Chats (#686) --- 04.md | 2 +- 11.md | 2 +- 17.md | 154 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 9 ++-- 4 files changed, 162 insertions(+), 5 deletions(-) create mode 100644 17.md diff --git a/04.md b/04.md index dc232b40..a561a2f8 100644 --- a/04.md +++ b/04.md @@ -1,4 +1,4 @@ -> __Warning__ `unrecommended`: deprecated in favor of [NIP-44](44.md) +> __Warning__ `unrecommended`: deprecated in favor of [NIP-17](17.md) NIP-04 ====== diff --git a/11.md b/11.md index 45102d7e..a50038a0 100644 --- a/11.md +++ b/11.md @@ -37,7 +37,7 @@ Detailed plain-text information about the relay may be contained in the `descrip ### Pubkey -An 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. +An 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. Relay operators have no obligation to respond to direct messages. diff --git a/17.md b/17.md new file mode 100644 index 00000000..cc04a888 --- /dev/null +++ b/17.md @@ -0,0 +1,154 @@ +NIP-17 +====== + +Private Direct Messages +----------------------- + +`draft` `optional` + +This NIP defines an encrypted direct messaging scheme using [NIP-44](44.md) encryption and [NIP-59](59.md) seals and gift wraps. + +## Direct Message Kind + +Kind `14` is a chat message. `p` tags identify one or more receivers of the message. + +```js +{ + "id": "<usual hash>", +  "pubkey": "<sender-pubkey>", + "created_at": now(), +  "kind": 14, +  "tags": [ +    ["p", "<receiver-1-pubkey>", "<relay-url>"], +    ["p", "<receiver-2-pubkey>", "<relay-url>"], +    ["e", "<kind-14-id>", "<relay-url>", "reply"] // if this is a reply + ["subject", "<conversation-title>"], +    ... +  ], +  "content": "<message-in-plain-text>", +} +``` + +`.content` MUST be plain text. Fields `id` and `created_at` are required. + +Tags that mention, quote and assemble threading structures MUST follow [NIP-10](10.md). + +Kind `14`s MUST never be signed. If it is signed, the message might leak to relays and become **fully public**. + +## Chat Rooms + +The 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. + +Clients SHOULD render messages of the same room in a continuous thread. + +An 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. + +## Encrypting + +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 +{ + "id": "<usual hash>", +  "pubkey": randomPublicKey, +  "created_at": randomTimeUpTo2DaysInThePast(), + "kind": 1059, // gift wrap +  "tags": [ +    ["p", receiverPublicKey, "<relay-url>"] // receiver +  ], +  "content": nip44Encrypt( +    { + "id": "<usual hash>", +      "pubkey": senderPublicKey, +      "created_at": randomTimeUpTo2DaysInThePast(), +      "kind": 13, // seal +      "tags": [], // no tags +      "content": nip44Encrypt(unsignedKind14, senderPrivateKey, receiverPublicKey), +      "sig": "<signed by senderPrivateKey>" +    }, +    randomPrivateKey, receiverPublicKey +  ), +  "sig": "<signed by randomPrivateKey>" +} +``` + +The encryption algorithm MUST use the latest version of [NIP-44](44.md). + +Clients 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`. + +Clients 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. + +The 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. + +Clients 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 + +## Publishing + +Kind `10050` indicates the user's preferred relays to receive DMs. The event MUST include a list of `relay` tags with relay URIs. + +```js +{ + "kind": 10050, + "tags": [ + ["relay", "wss://inbox.nostr.wine"], + ["relay", "wss://myrelay.nostr1.com"], + ], + "content": "", + //...other fields +} +``` + +Clients SHOULD publish kind `14` events to the `10050`-listed relays, falling back to `read` relays of [NIP-65](65.md) if `kind:10050` is not available. + +Clients SHOULD guide users to keep `kind:10050` lists small (1-3 relays) and SHOULD spread it to as many relays as viable. + +## Benefits & Limitations + +This NIP offers the following privacy and security features: + +1. **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. +2. **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. +3. **No Moderation**: There are no group admins: no invitations or bans. +4. **No Shared Secrets**: No secret must be known to all members that can leak or be mistakenly shared +5. **Fully Recoverable**: Messages can be fully recoverable by any client with the user's private key +6. **Optional Forward Secrecy**: Users and clients can opt-in for "disappearing messages". +7. **Uses Public Relays**: Messages can flow through public relays without loss of privacy. Private relays can increase privacy further, but they are not required. +8. **Cold Storage**: Users can unilaterally opt-in to sharing their messages with a separate key that is exclusive for DM backup and recovery. + +The 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. + +---- + +## Examples + +This example sends the message `Hola, que tal?` from `nsec1w8udu59ydjvedgs3yv5qccshcj8k05fh3l60k9x57asjrqdpa00qkmr89m` to `nsec12ywtkplvyq5t6twdqwwygavp5lm4fhuang89c943nf2z92eez43szvn4dt`. + +The two final GiftWraps, one to the receiver and the other to the sender, are: + +```json +{ + "id":"2886780f7349afc1344047524540ee716f7bdc1b64191699855662330bf235d8", + "pubkey":"8f8a7ec43b77d25799281207e1a47f7a654755055788f7482653f9c9661c6d51", + "created_at":1703128320, + "kind":1059, + "tags":[ + [ "p", "918e2da906df4ccd12c8ac672d8335add131a4cf9d27ce42b3bb3625755f0788"] + ], + "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", + "sig":"a3c6ce632b145c0869423c1afaff4a6d764a9b64dedaf15f170b944ead67227518a72e455567ca1c2a0d187832cecbde7ed478395ec4c95dd3e71749ed66c480" +} +``` + +```json +{ + "id":"162b0611a1911cfcb30f8a5502792b346e535a45658b3a31ae5c178465509721", + "pubkey":"626be2af274b29ea4816ad672ee452b7cf96bbb4836815a55699ae402183f512", + "created_at":1702711587, + "kind":1059, + "tags":[ + [ "p", "44900586091b284416a0c001f677f9c49f7639a55c3f1e2ec130a8e1a7998e1b"] + ], + "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", + "sig":"c94e74533b482aa8eeeb54ae72a5303e0b21f62909ca43c8ef06b0357412d6f8a92f96e1a205102753777fd25321a58fba3fb384eee114bd53ce6c06a1c22bab" +} +``` diff --git a/README.md b/README.md index 5fcdaf76..619c9846 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 - [NIP-01: Basic protocol flow description](01.md) - [NIP-02: Follow List](02.md) - [NIP-03: OpenTimestamps Attestations for Events](03.md) -- [NIP-04: Encrypted Direct Message](04.md) --- **unrecommended**: deprecated in favor of [NIP-44](44.md) +- [NIP-04: Encrypted Direct Message](04.md) --- **unrecommended**: deprecated in favor of [NIP-17](17.md) - [NIP-05: Mapping Nostr keys to DNS-based internet identifiers](05.md) - [NIP-06: Basic key derivation from mnemonic seed phrase](06.md) - [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 - [NIP-13: Proof of Work](13.md) - [NIP-14: Subject tag in text events](14.md) - [NIP-15: Nostr Marketplace (for resilient marketplaces)](15.md) +- [NIP-17: Private Direct Messages](17.md) - [NIP-18: Reposts](18.md) - [NIP-19: bech32-encoded entities](19.md) - [NIP-21: `nostr:` URI scheme](21.md) @@ -99,6 +100,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `11` | Group Thread | [29](29.md) | | `12` | Group Thread Reply | [29](29.md) | | `13` | Seal | [59](59.md) | +| `14` | Direct Message | [17](17.md) | | `16` | Generic Repost | [18](18.md) | | `40` | Channel Creation | [28](28.md) | | `41` | Channel Metadata | [28](28.md) | @@ -138,6 +140,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10009` | User groups | [51](51.md), [29](29.md) | | `10015` | Interests list | [51](51.md) | | `10030` | User emoji list | [51](51.md) | +| `10050` | Relay list to receive DMs | [17](17.md) | | `10096` | File storage server list | [96](96.md) | | `13194` | Wallet Info | [47](47.md) | | `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | @@ -247,10 +250,10 @@ Please update these lists when proposing NIPs introducing new event kinds. | `price` | price | currency, frequency | [99](99.md) | | `proxy` | external ID | protocol | [48](48.md) | | `published_at` | unix timestamp (string) | -- | [23](23.md) | -| `relay` | relay url | -- | [42](42.md) | +| `relay` | relay url | -- | [42](42.md), [17](17.md) | | `relays` | relay list | -- | [57](57.md) | | `server` | file storage server url | -- | [96](96.md) | -| `subject` | subject | -- | [14](14.md) | +| `subject` | subject | -- | [14](14.md), [17](17.md) | | `summary` | article summary | -- | [23](23.md) | | `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | | `title` | article title | -- | [23](23.md) | From 7dfb11b435a903c703bc38216eca805cefa494d4 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Wed, 24 Apr 2024 17:20:45 -0300 Subject: [PATCH 068/587] nip17: relay considerations and implementation details. --- 17.md | 52 +++++++++++++++++++++++++++++++--------------------- 1 file changed, 31 insertions(+), 21 deletions(-) diff --git a/17.md b/17.md index cc04a888..0f51367a 100644 --- a/17.md +++ b/17.md @@ -6,7 +6,7 @@ Private Direct Messages `draft` `optional` -This NIP defines an encrypted direct messaging scheme using [NIP-44](44.md) encryption and [NIP-59](59.md) seals and gift wraps. +This NIP defines an encrypted direct messaging scheme using [NIP-44](44.md) encryption and [NIP-59](59.md) seals and gift wraps. ## Direct Message Kind @@ -18,7 +18,7 @@ Kind `14` is a chat message. `p` tags identify one or more receivers of the mess   "pubkey": "<sender-pubkey>", "created_at": now(),   "kind": 14, -  "tags": [ +  "tags": [     ["p", "<receiver-1-pubkey>", "<relay-url>"],     ["p", "<receiver-2-pubkey>", "<relay-url>"],     ["e", "<kind-14-id>", "<relay-url>", "reply"] // if this is a reply @@ -29,19 +29,19 @@ Kind `14` is a chat message. `p` tags identify one or more receivers of the mess } ``` -`.content` MUST be plain text. Fields `id` and `created_at` are required. +`.content` MUST be plain text. Fields `id` and `created_at` are required. -Tags that mention, quote and assemble threading structures MUST follow [NIP-10](10.md). +Tags that mention, quote and assemble threading structures MUST follow [NIP-10](10.md). Kind `14`s MUST never be signed. If it is signed, the message might leak to relays and become **fully public**. ## Chat Rooms -The 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. +The 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. -Clients SHOULD render messages of the same room in a continuous thread. +Clients SHOULD render messages of the same room in a continuous thread. -An 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. +An 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. ## Encrypting @@ -51,7 +51,7 @@ Following [NIP-59](59.md), the **unsigned** `kind:14` chat message must be seale { "id": "<usual hash>",   "pubkey": randomPublicKey, -  "created_at": randomTimeUpTo2DaysInThePast(), +  "created_at": randomTimeUpTo2DaysInThePast(), "kind": 1059, // gift wrap   "tags": [     ["p", receiverPublicKey, "<relay-url>"] // receiver @@ -60,7 +60,7 @@ Following [NIP-59](59.md), the **unsigned** `kind:14` chat message must be seale     { "id": "<usual hash>",       "pubkey": senderPublicKey, -      "created_at": randomTimeUpTo2DaysInThePast(), +      "created_at": randomTimeUpTo2DaysInThePast(),       "kind": 13, // seal       "tags": [], // no tags       "content": nip44Encrypt(unsignedKind14, senderPrivateKey, receiverPublicKey), @@ -72,17 +72,17 @@ Following [NIP-59](59.md), the **unsigned** `kind:14` chat message must be seale } ``` -The encryption algorithm MUST use the latest version of [NIP-44](44.md). +The encryption algorithm MUST use the latest version of [NIP-44](44.md). Clients 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`. -Clients 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. +Clients 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. The 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. Clients 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 -## Publishing +## Publishing Kind `10050` indicates the user's preferred relays to receive DMs. The event MUST include a list of `relay` tags with relay URIs. @@ -98,16 +98,22 @@ Kind `10050` indicates the user's preferred relays to receive DMs. The event MUS } ``` -Clients SHOULD publish kind `14` events to the `10050`-listed relays, falling back to `read` relays of [NIP-65](65.md) if `kind:10050` is not available. +Clients 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. -Clients SHOULD guide users to keep `kind:10050` lists small (1-3 relays) and SHOULD spread it to as many relays as viable. +## Relays + +It's advisable that relays do not serve `kind:14` to clients other than the ones tagged in them. + +It's advisable that users choose relays that conform to these practices. + +Clients SHOULD guide users to keep `kind:10050` lists small (1-3 relays) and SHOULD spread it to as many relays as viable. ## Benefits & Limitations -This NIP offers the following privacy and security features: +This NIP offers the following privacy and security features: 1. **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. -2. **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. +2. **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. 3. **No Moderation**: There are no group admins: no invitations or bans. 4. **No Shared Secrets**: No secret must be known to all members that can leak or be mistakenly shared 5. **Fully Recoverable**: Messages can be fully recoverable by any client with the user's private key @@ -115,13 +121,17 @@ This NIP offers the following privacy and security features: 7. **Uses Public Relays**: Messages can flow through public relays without loss of privacy. Private relays can increase privacy further, but they are not required. 8. **Cold Storage**: Users can unilaterally opt-in to sharing their messages with a separate key that is exclusive for DM backup and recovery. -The 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. +The 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. ----- +## Implementation + +Clients 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. + +When 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. ## Examples -This example sends the message `Hola, que tal?` from `nsec1w8udu59ydjvedgs3yv5qccshcj8k05fh3l60k9x57asjrqdpa00qkmr89m` to `nsec12ywtkplvyq5t6twdqwwygavp5lm4fhuang89c943nf2z92eez43szvn4dt`. +This example sends the message `Hola, que tal?` from `nsec1w8udu59ydjvedgs3yv5qccshcj8k05fh3l60k9x57asjrqdpa00qkmr89m` to `nsec12ywtkplvyq5t6twdqwwygavp5lm4fhuang89c943nf2z92eez43szvn4dt`. The two final GiftWraps, one to the receiver and the other to the sender, are: @@ -138,7 +148,7 @@ The two final GiftWraps, one to the receiver and the other to the sender, are: "sig":"a3c6ce632b145c0869423c1afaff4a6d764a9b64dedaf15f170b944ead67227518a72e455567ca1c2a0d187832cecbde7ed478395ec4c95dd3e71749ed66c480" } ``` - + ```json { "id":"162b0611a1911cfcb30f8a5502792b346e535a45658b3a31ae5c178465509721", @@ -151,4 +161,4 @@ The two final GiftWraps, one to the receiver and the other to the sender, are: "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", "sig":"c94e74533b482aa8eeeb54ae72a5303e0b21f62909ca43c8ef06b0357412d6f8a92f96e1a205102753777fd25321a58fba3fb384eee114bd53ce6c06a1c22bab" } -``` +``` From 6071f3489eabe50eea748a2585a73c02a23d96cf Mon Sep 17 00:00:00 2001 From: Alex Gleason <alex@alexgleason.me> Date: Thu, 25 Apr 2024 06:38:36 -0500 Subject: [PATCH 069/587] NIP-46: "error" property of response is optional (#1195) * NIP-46: clarify "error" property of response * NIP-46: It's -> Its * optionally Co-authored-by: Asai Toshiya <to.asai.60@gmail.com> --------- Co-authored-by: fiatjaf_ <fiatjaf@gmail.com> Co-authored-by: Asai Toshiya <to.asai.60@gmail.com> --- 46.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/46.md b/46.md index 56b84022..d4b5728b 100644 --- a/46.md +++ b/46.md @@ -153,13 +153,13 @@ The `content` field is a JSON-RPC-like message that is [NIP-04](https://github.c { "id": <request_id>, "result": <results_string>, - "error": <error_string> + "error": <optional_error_string> } ``` - `id` is the request ID that this response is for. - `results` is a string of the result of the call (this can be either a string or a JSON stringified object) -- `error` is an error in string form. +- `error`, _optionally_, it is an error in string form, if any. Its presence indicates an error with the request. ### Auth Challenges From 243b2865826edff22eebe5ec6e893c711802c7e5 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Thu, 25 Apr 2024 18:03:38 -0300 Subject: [PATCH 070/587] nip46: signer should fill in pubkey, id and sig on sign_event. --- 46.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/46.md b/46.md index d4b5728b..e0a5b2ec 100644 --- a/46.md +++ b/46.md @@ -61,8 +61,9 @@ nostrconnect://<local-keypair-pubkey>?relay=<wss://relay-to-connect-on>&metadata "method": "sign_event", "params": [json_stringified(<{ content: "Hello, I'm signing remotely", - pubkey: "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", - // ...the rest of the event data + kind: 1, + tags: [], + created_at: 1714078911 }>)] }), "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 Each of the following are methods that the client sends to the remote signer. -| Command | Params | Result | -| ------------------------ | ------------------------------------------------- | ---------------------------------------------------------------------- | -| `connect` | `[<remote_user_pubkey>, <optional_secret>, <optional_requested_permissions>]` | "ack" | -| `sign_event` | `[<json_stringified_event_to_sign>]` | `json_stringified(<signed_event>)` | -| `ping` | `[]` | "pong" | -| `get_relays` | `[]` | `json_stringified({<relay_url>: {read: <boolean>, write: <boolean>}})` | -| `get_public_key` | `[]` | `<hex-pubkey>` | -| `nip04_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip04_ciphertext>` | -| `nip04_decrypt` | `[<third_party_pubkey>, <nip04_ciphertext_to_decrypt>]` | `<plaintext>` | -| `nip44_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip44_ciphertext>` | -| `nip44_decrypt` | `[<third_party_pubkey>, <nip44_ciphertext_to_decrypt>]` | `<plaintext>` | +| Command | Params | Result | +| ------------------------ | ------------------------------------------------- | ---------------------------------------------------------------------- | +| `connect` | `[<remote_user_pubkey>, <optional_secret>, <optional_requested_permissions>]` | "ack" | +| `sign_event` | `[<{kind, content, tags, created_at}>]` | `json_stringified(<signed_event>)` | +| `ping` | `[]` | "pong" | +| `get_relays` | `[]` | `json_stringified({<relay_url>: {read: <boolean>, write: <boolean>}})` | +| `get_public_key` | `[]` | `<hex-pubkey>` | +| `nip04_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip04_ciphertext>` | +| `nip04_decrypt` | `[<third_party_pubkey>, <nip04_ciphertext_to_decrypt>]` | `<plaintext>` | +| `nip44_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip44_ciphertext>` | +| `nip44_decrypt` | `[<third_party_pubkey>, <nip44_ciphertext_to_decrypt>]` | `<plaintext>` | ### Requested permissions -The `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. +The `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. ## Response Events `kind:24133` From b21e996a89a9fe2acb09136792c75b1dd8eb59f8 Mon Sep 17 00:00:00 2001 From: greenart7c3 <greenart7c3@proton.me> Date: Mon, 29 Apr 2024 08:55:55 -0300 Subject: [PATCH 071/587] Change web app methods do use nostrsigner: instead of intent: --- 100.md | 30 ++++++++---------------------- 1 file changed, 8 insertions(+), 22 deletions(-) diff --git a/100.md b/100.md index 06d6b355..99feebf0 100644 --- a/100.md +++ b/100.md @@ -432,63 +432,49 @@ Android intents and browsers url has limitations, so if you are using the return - params: ```js - const intent = `intent:#Intent;scheme=nostrsigner;S.compressionType=none;S.returnType=signature;S.type=get_public_key;S.callbackUrl=https://example.com/?event=;end`; - - window.href = intent; + window.href = `nostrsigner:?compressionType=none;returnType=signature;type=get_public_key;callbackUrl=https://example.com/?event=`; ``` - **sign_event** - params: ```js - const intent = `intent:${eventJson}#Intent;scheme=nostrsigner;S.compressionType=none;S.returnType=signature;S.type=sign_event;S.callbackUrl=https://example.com/?event=;end`; - - window.href = intent; + window.href = `nostrsigner:${eventJson}?compressionType=none;returnType=signature;type=sign_event;callbackUrl=https://example.com/?event=`; ``` - **nip04_encrypt** - params: ```js - const intent = `intent:${plainText}#Intent;scheme=nostrsigner;S.pubKey=${hex_pub_key};S.compressionType=none;S.returnType=signature;S.type=nip04_encrypt;S.callbackUrl=https://example.com/?event=;end`; - - window.href = intent; + window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key};compressionType=none;returnType=signature;type=nip04_encrypt;callbackUrl=https://example.com/?event=`; ``` - **nip44_encrypt** - params: ```js - const intent = `intent:${plainText}#Intent;scheme=nostrsigner;S.pubKey=${hex_pub_key};S.compressionType=none;S.returnType=signature;S.type=nip44_encrypt;S.callbackUrl=https://example.com/?event=;end`; - - window.href = intent; + window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key};compressionType=none;returnType=signature;type=nip44_encrypt;callbackUrl=https://example.com/?event=`; ``` - **nip04_decrypt** - params: ```js - const intent = `intent:${encryptedText}#Intent;scheme=nostrsigner;S.pubKey=${hex_pub_key};S.compressionType=none;S.returnType=signature;S.type=nip04_decrypt;S.callbackUrl=https://example.com/?event=;end`; - - window.href = intent; + window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key};compressionType=none;returnType=signature;type=nip04_decrypt;callbackUrl=https://example.com/?event=`; ``` - **nip44_decrypt** - params: ```js - const intent = `intent:${encryptedText}#Intent;scheme=nostrsigner;S.pubKey=${hex_pub_key};S.compressionType=none;S.returnType=signature;S.type=nip44_decrypt;S.callbackUrl=https://example.com/?event=;end`; - - window.href = intent; + window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key};compressionType=none;returnType=signature;type=nip44_decrypt;callbackUrl=https://example.com/?event=`; ``` - **decrypt_zap_event** - params: ```js - const intent = `intent:${eventJson}#Intent;scheme=nostrsigner;S.compressionType=none;S.returnType=signature;S.type=decrypt_zap_event;S.callbackUrl=https://example.com/?event=;end`; - - window.href = intent; + window.href = `nostrsigner:${eventJson}?compressionType=none;returnType=signature;type=decrypt_zap_event;callbackUrl=https://example.com/?event=`; ``` ## Example @@ -518,7 +504,7 @@ Android intents and browsers url has limitations, so if you are using the return } let encodedJson = encodeURIComponent(JSON.stringify(json)) var newAnchor = document.createElement("a"); - newAnchor.href = `intent:${encodedJson}#Intent;scheme=nostrsigner;S.compressionType=none;S.returnType=signature;S.type=sign_event;S.callbackUrl=https://example.com/?event=;end`; + newAnchor.href = `nostrsigner:${encodedJson}?compressionType=none;returnType=signature;type=sign_event;callbackUrl=https://example.com/?event=`; newAnchor.textContent = "Open External Signer"; document.body.appendChild(newAnchor) } From ff24a56355471761d89399167a75a74e3bbb5677 Mon Sep 17 00:00:00 2001 From: greenart7c3 <greenart7c3@proton.me> Date: Mon, 29 Apr 2024 09:25:04 -0300 Subject: [PATCH 072/587] ; -> & --- 100.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/100.md b/100.md index 571d1eb2..4a304c3a 100644 --- a/100.md +++ b/100.md @@ -456,49 +456,49 @@ Android intents and browser urls have limitations, so if you are using the `retu - params: ```js - window.href = `nostrsigner:?compressionType=none;returnType=signature;type=get_public_key;callbackUrl=https://example.com/?event=`; + window.href = `nostrsigner:?compressionType=none&returnType=signature&type=get_public_key&callbackUrl=https://example.com/?event=`; ``` - **sign_event** - params: ```js - window.href = `nostrsigner:${eventJson}?compressionType=none;returnType=signature;type=sign_event;callbackUrl=https://example.com/?event=`; + window.href = `nostrsigner:${eventJson}?compressionType=none&returnType=signature&type=sign_event&callbackUrl=https://example.com/?event=`; ``` - **nip04_encrypt** - params: ```js - window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key};compressionType=none;returnType=signature;type=nip04_encrypt;callbackUrl=https://example.com/?event=`; + window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_encrypt&callbackUrl=https://example.com/?event=`; ``` - **nip44_encrypt** - params: ```js - window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key};compressionType=none;returnType=signature;type=nip44_encrypt;callbackUrl=https://example.com/?event=`; + window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_encrypt&callbackUrl=https://example.com/?event=`; ``` - **nip04_decrypt** - params: ```js - window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key};compressionType=none;returnType=signature;type=nip04_decrypt;callbackUrl=https://example.com/?event=`; + window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_decrypt&callbackUrl=https://example.com/?event=`; ``` - **nip44_decrypt** - params: ```js - window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key};compressionType=none;returnType=signature;type=nip44_decrypt;callbackUrl=https://example.com/?event=`; + window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_decrypt&callbackUrl=https://example.com/?event=`; ``` - **decrypt_zap_event** - params: ```js - window.href = `nostrsigner:${eventJson}?compressionType=none;returnType=signature;type=decrypt_zap_event;callbackUrl=https://example.com/?event=`; + window.href = `nostrsigner:${eventJson}?compressionType=none&returnType=signature&type=decrypt_zap_event&callbackUrl=https://example.com/?event=`; ``` ## Example @@ -528,7 +528,7 @@ Android intents and browser urls have limitations, so if you are using the `retu } let encodedJson = encodeURIComponent(JSON.stringify(json)) var newAnchor = document.createElement("a"); - newAnchor.href = `nostrsigner:${encodedJson}?compressionType=none;returnType=signature;type=sign_event;callbackUrl=https://example.com/?event=`; + newAnchor.href = `nostrsigner:${encodedJson}?compressionType=none&returnType=signature&type=sign_event&callbackUrl=https://example.com/?event=`; newAnchor.textContent = "Open External Signer"; document.body.appendChild(newAnchor) } From bad8826211ca2eb8660e4bd68b292d14616d3669 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Wed, 24 Apr 2024 18:44:36 -0300 Subject: [PATCH 073/587] nip34: simplify `r` tag for earliest unique commit. --- 34.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/34.md b/34.md index f72fcf28..03ee0391 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 ["web", "<url for browsing>", ...], // a webpage url, if the git server being used provides such a thing ["clone", "<url for git-cloning>", ...], // a url to be given to `git clone` so anyone can clone it ["relays", "<relay-url>", ...] // relays that this repository will monitor for patches and issues - ["earliest-unique-commit", "<commit-id>"] // usually root commit but a recent commit for forks - ["r", "<earliest-unique-commit-id>"] // so clients can subscribe to all events related to a local git repo + ["r", "<earliest-unique-commit-id>", "euc"] ["maintainers", "<other-recognized-maintainer>", ...] ] } @@ -32,13 +31,15 @@ Git repositories are hosted in Git-enabled servers, but their existence can be a The tags `web`, `clone`, `relays`, `maintainers` can have multiple values. +The `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. + Except `d`, all tags are optional. ## Patches Patches 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. -Patches in a patch set SHOULD include a NIP-10 `e` `reply` tag pointing to the previous patch. +Patches in a patch set SHOULD include a NIP-10 `e` `reply` tag pointing to the previous patch. The first patch revision in a patch revision SHOULD include a NIP-10 `e` `reply` to the original root patch. @@ -132,7 +133,7 @@ Root Patches and Issues have a Status that defaults to 'Open' and can be set by ["e", "<applied-or-merged-patch-event-id>", "", "mention"], // for each // when merged ["merge-commit", "<merge-commit-id>"] - ["r", "<merge-commit-id>"] + ["r", "<merge-commit-id>"] // when applied ["applied-as-commits", "<commit-id-in-master-branch>", ...] ["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 The Status event with the largest created_at date is valid. -The 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. +The 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. ## Possible things to be added later From 88246c27414d11983dced414462b2be2d010fad8 Mon Sep 17 00:00:00 2001 From: Leo Wandersleb <leo@leowandersleb.de> Date: Wed, 24 Apr 2024 12:18:27 -0400 Subject: [PATCH 074/587] Require tags to have at least one string fixes #1193 --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index a91febc5..8be85bc8 100644 --- a/01.md +++ b/01.md @@ -56,7 +56,7 @@ To prevent implementation differences from creating a different event ID for the ### Tags -Each tag is an array of strings of arbitrary size, with some conventions around them. Take a look at the example below: +Each tag is an array of one or more strings, with some conventions around them. Take a look at the example below: ```jsonc { From ef5eacd48904a5cee0b4e51c4b7d46a9606a7351 Mon Sep 17 00:00:00 2001 From: Lucas Nuic <165694895+lucasnuic@users.noreply.github.com> Date: Wed, 1 May 2024 22:48:11 -0300 Subject: [PATCH 075/587] =?UTF-8?q?=E2=80=9Cdecentralized=20reporting=20of?= =?UTF-8?q?=20digital=20threats=20such=20as=20malware=E2=80=9D=20in=20nost?= =?UTF-8?q?r?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit I added new tags for reporting bad things like malware --- 56.md | 1 + 1 file changed, 1 insertion(+) diff --git a/56.md b/56.md index 3209b80d..190e0b45 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 being reported, which consists of the following report types: - `nudity` - depictions of nudity, porn, etc. +- `malware` - depictions of malware, virus, Trojan Horse, worm, robot, spyware, adware, back door, ransomware, rootkit, kidnapper, etc. - `profanity` - profanity, hateful speech, etc. - `illegal` - something which may be illegal in some jurisdiction - `spam` - spam From 2b490b168e4b51e1c441d985ca89e5e1f426a610 Mon Sep 17 00:00:00 2001 From: Lucas Nuic <165694895+lucasnuic@users.noreply.github.com> Date: Wed, 1 May 2024 23:29:14 -0300 Subject: [PATCH 076/587] fixed typo --- 56.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/56.md b/56.md index 190e0b45..fc8d8985 100644 --- a/56.md +++ b/56.md @@ -26,7 +26,7 @@ A `report type` string MUST be included as the 3rd entry to the `e` or `p` tag being reported, which consists of the following report types: - `nudity` - depictions of nudity, porn, etc. -- `malware` - depictions of malware, virus, Trojan Horse, worm, robot, spyware, adware, back door, ransomware, rootkit, kidnapper, etc. +- `malware` - virus, trojan horse, worm, robot, spyware, adware, back door, ransomware, rootkit, kidnapper, etc. - `profanity` - profanity, hateful speech, etc. - `illegal` - something which may be illegal in some jurisdiction - `spam` - spam From 218fbb1cc7ac900fd256f666cb6add590cabb24a Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Thu, 2 May 2024 11:04:55 -0300 Subject: [PATCH 077/587] NIP-54: decentralized wikis (#787) * draft of NIP-34: decentralized wikis. * add merge requests. * add merge request flow * update nip number --------- Co-authored-by: Pablo Fernandez <p@f7z.io> --- 51.md | 26 +++++++------- 54.md | 106 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 ++ 3 files changed, 122 insertions(+), 12 deletions(-) create mode 100644 54.md diff --git a/51.md b/51.md index 95acbc81..fb40b26e 100644 --- a/51.md +++ b/51.md @@ -20,18 +20,20 @@ Standard lists use non-parameterized replaceable events, meaning users may only For 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. -| name | kind | description | expected tag items | -| --- | --- | --- | --- | -| Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags), `"word"` (lowercase string), `"e"` (threads) | -| Pinned notes | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | -| Bookmarks | 10003 | uncategorized, "global" list of things a user wants to save | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) | -| Communities | 10004 | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) | -| Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) | -| Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) | -| Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) | -| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group ids + mandatory relay URL) | -| Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) | -| Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | +| name | kind | description | expected tag items | +| --- | --- | --- | --- | +| Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags), `"word"` (lowercase string), `"e"` (threads) | +| Pinned notes | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | +| Bookmarks | 10003 | uncategorized, "global" list of things a user wants to save | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) | +| Communities | 10004 | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) | +| Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) | +| Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) | +| Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) | +| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group ids + mandatory relay URL) | +| Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) | +| Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | +| Good wiki authors | 10101 | [NIP-54](54.md) user recommended wiki authors | `"p"` (pubkeys) | +| Good wiki relays | 10102 | [NIP-54](54.md) relays deemed to only host useful articles | `"relay"` (relay URLs) | ## Sets diff --git a/54.md b/54.md new file mode 100644 index 00000000..9063ca95 --- /dev/null +++ b/54.md @@ -0,0 +1,106 @@ +NIP-54 +====== + +Wiki +---- +`draft` `optional` + +This 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. + +Articles are identified by lowercase, normalized ascii `d` tags. + +### Articles +```js +{ + "content": "A wiki is a hypertext publication collaboratively edited and managed by its own audience.", + "tags": [ + [ "d", "wiki" ], + [ "title", "Wiki" ], + ] +} +``` + +[INSERT NORMALIZATION EXAMPLES] + +The content should be Markdown, following the same rules as of [NIP-23](23.md), although it takes some extra (optional) metadata tags: + + - `title`: for when the display title should be different from the `d` tag. + - `summary`: for display in lists. + - `a` and `e`: for referencing the original event a wiki article was forked from. + +One 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. + +### Merge Requests + +Event `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. + +[INSERT EVENT EXAMPLE] + +### Redirects + +Event `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)). + +[INSERT EVENT EXAMPLE] + +How to decide what article to display +------------------------------------- + +As 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: + +### Reactions + +[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. + +### Relays + +[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. + +### Contact lists + +[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. + +### Wiki-related contact lists + +[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. + +Forks +--------- +Wiki-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. + +Deference +--------- +Wiki-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. + +This is a stronger signal of trust than a `+` reaction. + +This 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 indepedent 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. + +Why Markdown? +------------- + +If 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. + +On 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. + +# Appendix 1: Merge requests +Users can request other users to get their entries merged into someone else's entry by creating a `kind:818` event. + +```js +{ + "content": "I added information about how to make hot ice-creams", + "kind": 818, + "tags": [ + [ "a", "30818:<destination-pubkey>:hot-ice-creams", "<relay-url>" ], + [ "e", "<version-against-which-the-modification-was-made>", "<relay-url>' ], + [ "p", "<destination-pubkey>" ], + [ "e", "<version-to-be-merged>", "<relay-url>", "source" ] + ] +} +``` + +`.content`: an optional explanation detailing why this merge is being requested. +`a` tag: tag of the article which should be modified (i.e. the target of this merge request). +`e` tag: optional version of the article in which this modifications is based +`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. + +The 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/README.md b/README.md index 619c9846..b3736ea4 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-51: Lists](51.md) - [NIP-52: Calendar Events](52.md) - [NIP-53: Live Activities](53.md) +- [NIP-54: Wiki](54.md) - [NIP-56: Reporting](56.md) - [NIP-57: Lightning Zaps](57.md) - [NIP-58: Badges](58.md) @@ -171,6 +172,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30402` | Classified Listing | [99](99.md) | | `30403` | Draft Classified Listing | [99](99.md) | | `30617` | Repository announcements | [34](34.md) | +| `30818` | Wiki article | [54](54.md) | | `31922` | Date-Based Calendar Event | [52](52.md) | | `31923` | Time-Based Calendar Event | [52](52.md) | | `31924` | Calendar | [52](52.md) | From dcb5d0f18d6b0c60bda9abc79c6cca99a4d86177 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Thu, 2 May 2024 11:32:58 -0300 Subject: [PATCH 078/587] small fixes on nip 54. --- 54.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/54.md b/54.md index 9063ca95..78703303 100644 --- a/54.md +++ b/54.md @@ -3,6 +3,7 @@ NIP-54 Wiki ---- + `draft` `optional` This 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,7 +11,7 @@ This NIP defines `kind:30818` (a _parameterized replaceable event_) for long-for Articles are identified by lowercase, normalized ascii `d` tags. ### Articles -```js +```jsonc { "content": "A wiki is a hypertext publication collaboratively edited and managed by its own audience.", "tags": [ @@ -85,7 +86,7 @@ On the other hand, Markdown has proven to work well for small scale wikis and on # Appendix 1: Merge requests Users can request other users to get their entries merged into someone else's entry by creating a `kind:818` event. -```js +```jsonc { "content": "I added information about how to make hot ice-creams", "kind": 818, From 3834c6b60474a677b53847743212df27710e64ec Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Sat, 4 May 2024 16:10:13 -0400 Subject: [PATCH 079/587] Simplifying reactions --- 25.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/25.md b/25.md index 3b4aa590..bdee0666 100644 --- a/25.md +++ b/25.md @@ -25,14 +25,13 @@ consider it a "+". Tags ---- -The reaction event SHOULD include `e` and `p` tags from the note the user is -reacting to. This allows users to be notified of reactions to posts they were -mentioned in. Including the `e` tags enables clients to pull all the reactions -associated with individual posts or all the posts in a thread. +The reaction event SHOULD include `e` and `p` tags pointing to the note the user is +reacting to. The `p` tag allows authors to be notified. The `e` tags enables clients +to pull all the reactions to individual posts. -The last `e` tag MUST be the `id` of the note that is being reacted to. +The `e` tag MUST be the `id` of the note that is being reacted to. -The last `p` tag MUST be the `pubkey` of the event being reacted to. +The `p` tag MUST be the `pubkey` of the event being reacted to. The reaction event MAY include a `k` tag with the stringified kind number of the reacted event as its value. @@ -41,9 +40,6 @@ Example code ```swift func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> NostrEvent { - var tags: [[String]] = liked.tags.filter { - tag in tag.count >= 2 && (tag[0] == "e" || tag[0] == "p") - } tags.append(["e", liked.id]) tags.append(["p", liked.pubkey]) tags.append(["k", liked.kind]) From 4bcf91944a9e53680cc928424e7af145242b1a39 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Sat, 4 May 2024 16:35:39 -0400 Subject: [PATCH 080/587] adds a tags. --- 25.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/25.md b/25.md index bdee0666..7cc96b5f 100644 --- a/25.md +++ b/25.md @@ -25,12 +25,15 @@ consider it a "+". Tags ---- -The reaction event SHOULD include `e` and `p` tags pointing to the note the user is +The reaction event SHOULD include `a`, `e` and `p` tags pointing to the note the user is reacting to. The `p` tag allows authors to be notified. The `e` tags enables clients -to pull all the reactions to individual posts. +to pull all the reactions to individual events and `a` tags enables clients to seek reactions +for all versions of a replaceable event. The `e` tag MUST be the `id` of the note that is being reacted to. +The `a` tag MUST contain the coordinates (`kind:pubkey:d-tag`) of the replaceable being reacted to. + The `p` tag MUST be the `pubkey` of the event being reacted to. The reaction event MAY include a `k` tag with the stringified kind number From c1360c4f0b111143747bad6226df6f00499f5cfe Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Sat, 4 May 2024 23:34:37 -0300 Subject: [PATCH 081/587] nip54: add normalization rules. --- 54.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/54.md b/54.md index 78703303..c481eb63 100644 --- a/54.md +++ b/54.md @@ -21,7 +21,12 @@ Articles are identified by lowercase, normalized ascii `d` tags. } ``` -[INSERT NORMALIZATION EXAMPLES] +### `d` tag normalization rules + +- Any non-letter character MUST be converted to a `-`. +- All letters MUST be converted to lowercase. + +### Content rules The content should be Markdown, following the same rules as of [NIP-23](23.md), although it takes some extra (optional) metadata tags: From 4fa65b81cede9eaf8375d4f92bc80cf298190e0c Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Sat, 4 May 2024 23:36:48 -0300 Subject: [PATCH 082/587] nip54: fix json indentation. --- 54.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/54.md b/54.md index c481eb63..2090182d 100644 --- a/54.md +++ b/54.md @@ -13,11 +13,11 @@ Articles are identified by lowercase, normalized ascii `d` tags. ### Articles ```jsonc { - "content": "A wiki is a hypertext publication collaboratively edited and managed by its own audience.", - "tags": [ - [ "d", "wiki" ], - [ "title", "Wiki" ], - ] + "content": "A wiki is a hypertext publication collaboratively edited and managed by its own audience.", + "tags": [ + ["d", "wiki"], + ["title", "Wiki"], + ] } ``` @@ -93,14 +93,14 @@ Users can request other users to get their entries merged into someone else's en ```jsonc { - "content": "I added information about how to make hot ice-creams", - "kind": 818, - "tags": [ - [ "a", "30818:<destination-pubkey>:hot-ice-creams", "<relay-url>" ], - [ "e", "<version-against-which-the-modification-was-made>", "<relay-url>' ], - [ "p", "<destination-pubkey>" ], - [ "e", "<version-to-be-merged>", "<relay-url>", "source" ] - ] + "content": "I added information about how to make hot ice-creams", + "kind": 818, + "tags": [ + [ "a", "30818:<destination-pubkey>:hot-ice-creams", "<relay-url>" ], + [ "e", "<version-against-which-the-modification-was-made>", "<relay-url>' ], + [ "p", "<destination-pubkey>" ], + [ "e", "<version-to-be-merged>", "<relay-url>", "source" ] + ] } ``` From b7bb46ac038bc5411f55bfa7646259da203c13c3 Mon Sep 17 00:00:00 2001 From: Oscar Merry <oscardmerry@gmail.com> Date: Thu, 9 May 2024 12:27:43 +0100 Subject: [PATCH 083/587] Use ISANs for Movies, Include Actual Examples --- XX.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/XX.md b/XX.md index 8751d947..eebaeedb 100644 --- a/XX.md +++ b/XX.md @@ -10,7 +10,7 @@ There are certain established global content identifiers that would be useful to - Book [ISBNs](https://en.wikipedia.org/wiki/ISBN) - Podcast [GUIDs](https://podcastnamespace.org/tag/guid) -- Movie [EIDRs](https://www.eidr.org) +- Movie [ISANs](https://en.wikipedia.org/wiki/International_Standard_Audiovisual_Number) Since the `i` tag is already used for similar references in kind-0 metadata events it makes sense to use it for these content ids as well. @@ -19,13 +19,17 @@ Since the `i` tag is already used for similar references in kind-0 metadata even ### Books: -- Book ISBN: `["i", "book:isbn:123"]` +- Book ISBN: `["i", "book:isbn:9780765382030"]` - https://isbnsearch.org/isbn/9780765382030 + +Book 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. ### Podcasts: -- Podcast Feed GUID: `["i", "podcast:guid:123"]` -- Podcast Item GUID: `["i", "podcast:item:guid:123"]` +- Podcast RSS Feed GUID: `["i", "podcast:guid:c90e609a-df1e-596a-bd5e-57bcc8aad6cc"]` - https://podcastindex.org/podcast/c90e609a-df1e-596a-bd5e-57bcc8aad6cc +- Podcast RSS Item GUID: `["i", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f"]` ### Movies: -- Movie EIDR: `["i", "movie:eidr:123"]` \ No newline at end of file +- Movie ISAN: `["i", "movie:isan:0000-0000-401A-0000-7"]` - https://web.isan.org/public/en/isan/0000-0000-401A-0000-7 + +Movie 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 \ No newline at end of file From cb9bddb8dfd11972286215d9bdee7434764ccf7b Mon Sep 17 00:00:00 2001 From: Adam Shannon <adamkshannon@gmail.com> Date: Sat, 11 May 2024 11:52:32 -0500 Subject: [PATCH 084/587] all: minor spelling fixes --- 34.md | 2 +- 46.md | 2 +- 54.md | 2 +- 72.md | 2 +- 90.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/34.md b/34.md index 03ee0391..fcc2cece 100644 --- a/34.md +++ b/34.md @@ -125,7 +125,7 @@ Root Patches and Issues have a Status that defaults to 'Open' and can be set by ["p", "<root-event-author>"], ["p", "<revision-author>"], - // optional for improved subscription filter efficency + // optional for improved subscription filter efficiency ["a", "30617:<base-repo-owner-pubkey>:<base-repo-id>", "<relay-url>"], ["r", "<earliest-unique-commit-id-of-repo>"] diff --git a/46.md b/46.md index e0a5b2ec..15281162 100644 --- a/46.md +++ b/46.md @@ -208,7 +208,7 @@ When the user types a NIP-05 the client: #### Remote signer discovery via NIP-89 -In 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. +In 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. First the client will query for `kind: 31990` events that have a `k` tag of `24133`. diff --git a/54.md b/54.md index 2090182d..8823af9a 100644 --- a/54.md +++ b/54.md @@ -79,7 +79,7 @@ Wiki-events can tag other wiki-events with a `defer` marker to indicate that it This is a stronger signal of trust than a `+` reaction. -This 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 indepedent 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. +This 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. Why Markdown? ------------- diff --git a/72.md b/72.md index 4bafce06..5a8be0a5 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 It'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. -Post 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. +Post 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. Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be included in all `34550:*` `a` tags. diff --git a/90.md b/90.md index 241eb38f..2b499a85 100644 --- a/90.md +++ b/90.md @@ -199,7 +199,7 @@ Some service providers might choose to submit a `payment-required` as the first It's not up to this NIP to define how individual vending machines should choose to run their business. # Cancellation -A job request might be cancelled by publishing a `kind:5` delete request event tagging the job request event. +A job request might be canceled by publishing a `kind:5` delete request event tagging the job request event. # Appendix 1: Job chaining A 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. From c2d9b40d5bcf2d04cd04c19b42065e5158ecbab8 Mon Sep 17 00:00:00 2001 From: Adam Shannon <adamkshannon@gmail.com> Date: Sat, 11 May 2024 12:38:01 -0500 Subject: [PATCH 085/587] nip90: fix links --- 90.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/90.md b/90.md index 2b499a85..5a15ebb6 100644 --- a/90.md +++ b/90.md @@ -162,8 +162,8 @@ Service providers can give feedback about a job back to the customer. ``` * `content`: Either empty or a job-result (e.g. for partial-result samples) -* `amount` tag: as defined in the [Job Result](#job-result) section. -* `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. +* `amount` tag: as defined in the [Job Result](#job-result-kind6000-6999) section. +* `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. * NOTE: If the input params requires input to be encrypted, then `content` field will have encrypted payload with `p` tag as key. @@ -177,7 +177,7 @@ Service providers can give feedback about a job back to the customer. | `success` | Service Provider successfully processed the job. | | `partial` | Service Provider partially processed the job. The `.content` might include a sample of the partial results. | -Any 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. +Any 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. # Protocol Flow From 9f13e76f022317a915386c1053dc8bac0a1a0dd3 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Mon, 13 May 2024 21:11:30 +0900 Subject: [PATCH 086/587] BREAKING.md: add NIP-34 change --- BREAKING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/BREAKING.md b/BREAKING.md index 80248142..b59bc8b2 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -5,6 +5,7 @@ reverse chronological order. | Date | Commit | NIP | Change | | ----------- | --------- | -------- | ------ | +| 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) | | 2024-02-25 | [4a171cb0](https://github.com/nostr-protocol/nips/commit/4a171cb0) | [NIP-18](18.md) | quote repost should use `q` tag | | 2024-02-10 | [c6cd655c](https://github.com/nostr-protocol/nips/commit/c6cd655c) | [NIP-46](46.md) | Params were stringified | | 2024-02-16 | [cbec02ab](https://github.com/nostr-protocol/nips/commit/cbec02ab) | [NIP-49](49.md) | Password first normalized to NFKC | From 38ee6511dc3ac9fb1b5b91920963844e2a9a0ada Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Tue, 14 May 2024 01:17:46 +0900 Subject: [PATCH 087/587] BREAKING.md: fix date --- BREAKING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/BREAKING.md b/BREAKING.md index b59bc8b2..7b48ee0d 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -7,7 +7,7 @@ reverse chronological order. | ----------- | --------- | -------- | ------ | | 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) | | 2024-02-25 | [4a171cb0](https://github.com/nostr-protocol/nips/commit/4a171cb0) | [NIP-18](18.md) | quote repost should use `q` tag | -| 2024-02-10 | [c6cd655c](https://github.com/nostr-protocol/nips/commit/c6cd655c) | [NIP-46](46.md) | Params were stringified | +| 2024-02-21 | [c6cd655c](https://github.com/nostr-protocol/nips/commit/c6cd655c) | [NIP-46](46.md) | Params were stringified | | 2024-02-16 | [cbec02ab](https://github.com/nostr-protocol/nips/commit/cbec02ab) | [NIP-49](49.md) | Password first normalized to NFKC | | 2024-02-15 | [afbb8dd0](https://github.com/nostr-protocol/nips/commit/afbb8dd0) | [NIP-39](39.md) | PGP identity was removed | | 2024-02-07 | [d3dad114](https://github.com/nostr-protocol/nips/commit/d3dad114) | [NIP-46](46.md) | Connection token format was changed | From 824d0b7eacceed0dd4ae3d3a4225f6c9722d05c2 Mon Sep 17 00:00:00 2001 From: kieran <kieran@harkin.me> Date: Sun, 14 Apr 2024 18:22:01 +0100 Subject: [PATCH 088/587] torrents --- 35.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 35.md diff --git a/35.md b/35.md new file mode 100644 index 00000000..878e9357 --- /dev/null +++ b/35.md @@ -0,0 +1,61 @@ +NIP-35 +====== + +Torrents +----------- + +`draft` `optional` + +This NIP defined a new `kind 2003` which is Torrent. + +`kind 2003` is a simple torrent index where there is enough information to search for content and construct the magnet link. No torrent files exist on nostr. + +## Tags +- `btih`: V1 BitTorrent Info Hash, as seen in the [magnet link](https://www.bittorrent.org/beps/bep_0053.html) `magnet:?xt=urn:btih:HASH` +- `file`: A file entry inside the torrent, including the full path ie. `info/example.txt` + +In order to make torrents searchable by general category, you SHOULD include a few tags like `movie`, `tv`, `HD`, `UHD` etc. + +## Tag prefixes + +Tag prefixes are used to label the content with references, ie. `["t", "imdb:1234"]` + +- `tcat`: A comma separated text category path, ie. `["t", "tcat:video,movie,4k"]`, this should also match the `newznab` category in a best effort approach. +- `newznab`: The category ID from [newznab](https://github.com/Prowlarr/Prowlarr/blob/develop/src/NzbDrone.Core/Indexers/NewznabStandardCategory.cs) +- `tmdb`: [The movie database](https://www.themoviedb.org/) id. +- `ttvdb`: [TV database](https://thetvdb.com/) id. +- `imdb`: [IMDB](https://www.imdb.com/) id. +- `mal`: [MyAnimeList](https://myanimelist.net/) id. +- `anilist`: [AniList](https://anilist.co/) id. + +A second level prefix should be included where the database supports multiple media types. +- `tmdb:movie:693134` maps to `themoviedb.org/movie/693134` +- `ttvdb:movie:290272` maps to `thetvdb.com/movies/dune-part-two` +- `mal:anime:9253` maps to `myanimelist.net/anime/9253` +- `mal:manga:17517` maps to `myanimelist.net/manga/17517` + +In 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. + +```json +{ + "kind": 2003,› + "content": "<long-description-pre-formatted>", + "tags": [ + ["title", "<torrent-title>"], + ["btih", "<bittorrent-info-hash>"], + ["file", "<file-name>", "<file-size-in-bytes>"], + ["file", "<file-name>", "<file-size-in-bytes>"], + ["t", "tcat:video,movie,4k"], + ["t", "newznab:2045"], + ["t", "imdb:tt15239678"], + ["t", "tmdb:movie:693134"], + ["t", "ttvdb:movie:290272"], + ["t", "movie"], + ["t", "4k"], + ] +} +``` + +## Implementations +1. [dtan.xyz](https://git.v0l.io/Kieran/dtan) +2. [nostrudel.ninja](https://github.com/hzrd149/nostrudel/tree/next/src/views/torrents) \ No newline at end of file From 021a8f5bc7fd64ce701f7b57e9a79ee5d1387834 Mon Sep 17 00:00:00 2001 From: kieran <kieran@harkin.me> Date: Sun, 14 Apr 2024 18:23:41 +0100 Subject: [PATCH 089/587] remove weird char --- 35.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/35.md b/35.md index 878e9357..33ed2beb 100644 --- a/35.md +++ b/35.md @@ -38,7 +38,7 @@ In some cases the url mapping isnt direct, mapping the url in general is out of ```json { - "kind": 2003,› + "kind": 2003, "content": "<long-description-pre-formatted>", "tags": [ ["title", "<torrent-title>"], From 33d173b1c9122a26c36c1d0671e3008906966c20 Mon Sep 17 00:00:00 2001 From: kieran <kieran@harkin.me> Date: Thu, 18 Apr 2024 09:40:20 +0100 Subject: [PATCH 090/587] Add comments / make infohash indexed like NIP94 --- 35.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/35.md b/35.md index 33ed2beb..4e80e3e5 100644 --- a/35.md +++ b/35.md @@ -6,13 +6,14 @@ Torrents `draft` `optional` -This NIP defined a new `kind 2003` which is Torrent. +This NIP defined a new `kind 2003` which is a Torrent. `kind 2003` is a simple torrent index where there is enough information to search for content and construct the magnet link. No torrent files exist on nostr. ## Tags -- `btih`: V1 BitTorrent Info Hash, as seen in the [magnet link](https://www.bittorrent.org/beps/bep_0053.html) `magnet:?xt=urn:btih:HASH` +- `i`: V1 BitTorrent Info Hash, as seen in the [magnet link](https://www.bittorrent.org/beps/bep_0053.html) `magnet:?xt=urn:btih:HASH` - `file`: A file entry inside the torrent, including the full path ie. `info/example.txt` +- `tracker`: (Optional) A tracker to use for this torrent In order to make torrents searchable by general category, you SHOULD include a few tags like `movie`, `tv`, `HD`, `UHD` etc. @@ -36,15 +37,17 @@ A second level prefix should be included where the database supports multiple me In 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. -```json +```jsonc { "kind": 2003, "content": "<long-description-pre-formatted>", "tags": [ ["title", "<torrent-title>"], - ["btih", "<bittorrent-info-hash>"], + ["i", "<bittorrent-info-hash>"], ["file", "<file-name>", "<file-size-in-bytes>"], ["file", "<file-name>", "<file-size-in-bytes>"], + ["tracker", "udp://mytacker.com:1337"], + ["tracker", "http://1337-tracker.net/announce"], ["t", "tcat:video,movie,4k"], ["t", "newznab:2045"], ["t", "imdb:tt15239678"], @@ -56,6 +59,12 @@ In some cases the url mapping isnt direct, mapping the url in general is out of } ``` +## Torrent Comments + +A torrent comment is a `kind 2004` event which is used to reply to a torrent event. + +This event works exactly like a `kind 1` and should follow `NIP-10` for tagging. + ## Implementations 1. [dtan.xyz](https://git.v0l.io/Kieran/dtan) 2. [nostrudel.ninja](https://github.com/hzrd149/nostrudel/tree/next/src/views/torrents) \ No newline at end of file From f59df9c24fb0c3f3e494f26a13cef7f48bd3851d Mon Sep 17 00:00:00 2001 From: kieran <kieran@harkin.me> Date: Thu, 16 May 2024 15:28:04 +0100 Subject: [PATCH 091/587] update tag keys --- 35.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/35.md b/35.md index 4e80e3e5..04cfb46d 100644 --- a/35.md +++ b/35.md @@ -11,7 +11,7 @@ This NIP defined a new `kind 2003` which is a Torrent. `kind 2003` is a simple torrent index where there is enough information to search for content and construct the magnet link. No torrent files exist on nostr. ## Tags -- `i`: V1 BitTorrent Info Hash, as seen in the [magnet link](https://www.bittorrent.org/beps/bep_0053.html) `magnet:?xt=urn:btih:HASH` +- `x`: V1 BitTorrent Info Hash, as seen in the [magnet link](https://www.bittorrent.org/beps/bep_0053.html) `magnet:?xt=urn:btih:HASH` - `file`: A file entry inside the torrent, including the full path ie. `info/example.txt` - `tracker`: (Optional) A tracker to use for this torrent @@ -19,9 +19,9 @@ In order to make torrents searchable by general category, you SHOULD include a f ## Tag prefixes -Tag prefixes are used to label the content with references, ie. `["t", "imdb:1234"]` +Tag prefixes are used to label the content with references, ie. `["i", "imdb:1234"]` -- `tcat`: A comma separated text category path, ie. `["t", "tcat:video,movie,4k"]`, this should also match the `newznab` category in a best effort approach. +- `tcat`: A comma separated text category path, ie. `["i", "tcat:video,movie,4k"]`, this should also match the `newznab` category in a best effort approach. - `newznab`: The category ID from [newznab](https://github.com/Prowlarr/Prowlarr/blob/develop/src/NzbDrone.Core/Indexers/NewznabStandardCategory.cs) - `tmdb`: [The movie database](https://www.themoviedb.org/) id. - `ttvdb`: [TV database](https://thetvdb.com/) id. @@ -43,16 +43,16 @@ In some cases the url mapping isnt direct, mapping the url in general is out of "content": "<long-description-pre-formatted>", "tags": [ ["title", "<torrent-title>"], - ["i", "<bittorrent-info-hash>"], + ["x", "<bittorrent-info-hash>"], ["file", "<file-name>", "<file-size-in-bytes>"], ["file", "<file-name>", "<file-size-in-bytes>"], ["tracker", "udp://mytacker.com:1337"], ["tracker", "http://1337-tracker.net/announce"], - ["t", "tcat:video,movie,4k"], - ["t", "newznab:2045"], - ["t", "imdb:tt15239678"], - ["t", "tmdb:movie:693134"], - ["t", "ttvdb:movie:290272"], + ["i", "tcat:video,movie,4k"], + ["i", "newznab:2045"], + ["i", "imdb:tt15239678"], + ["i", "tmdb:movie:693134"], + ["i", "ttvdb:movie:290272"], ["t", "movie"], ["t", "4k"], ] From dda408f48774eb41f116aad8024a84e73ab894ac Mon Sep 17 00:00:00 2001 From: kieran <kieran@harkin.me> Date: Thu, 16 May 2024 15:29:09 +0100 Subject: [PATCH 092/587] update readme --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index b3736ea4..8847888a 100644 --- a/README.md +++ b/README.md @@ -121,6 +121,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `1971` | Problem Tracker | [nostrocket][nostrocket] | | `1984` | Reporting | [56](56.md) | | `1985` | Label | [32](32.md) | +| `2003` | Torrent | [35](35.md) | +| `2004` | Torrent Comment | [35](35.md) | | `4550` | Community Post Approval | [72](72.md) | | `5000`-`5999` | Job Request | [90](90.md) | | `6000`-`6999` | Job Result | [90](90.md) | From b1f771302a6a1a94c888b619e08a9c302df85fc2 Mon Sep 17 00:00:00 2001 From: Sam Samskies <samsamskies@gmail.com> Date: Sat, 11 May 2024 14:58:40 -0500 Subject: [PATCH 093/587] fix NWC connection string example --- 47.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/47.md b/47.md index 90338477..0f93b205 100644 --- a/47.md +++ b/47.md @@ -95,7 +95,7 @@ The **client** should then store this connection and use it when the user wants ### Example connection string ```sh -nostr+walletconnect:b889ff5b1513b641e2a139f661a661364979c5beee91842f8f0ef42ab558e9d4?relay=wss%3A%2F%2Frelay.damus.io&secret=71a8c14c1407c113601079c4302dab36460f0ccd0ad506f1f2dc73b5100e4f3c +nostr+walletconnect://b889ff5b1513b641e2a139f661a661364979c5beee91842f8f0ef42ab558e9d4?relay=wss%3A%2F%2Frelay.damus.io&secret=71a8c14c1407c113601079c4302dab36460f0ccd0ad506f1f2dc73b5100e4f3c ``` ## Commands From 734f379a2a2f225f76f87cdcf074c997a0d40d35 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Tue, 23 Apr 2024 11:34:17 -0700 Subject: [PATCH 094/587] Add ontolo to nip 32 --- 32.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/32.md b/32.md index be4e8724..92497a61 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 For example, many events might be labeled with a particular place, topic, or pubkey, but labels with specific values like "John Doe" or "3.18743" are not labels, they are values, and should be handled in some other way. + + +Appendix: Known Ontologies +------------------------- + +Below is a non-exhaustive list of ontologies currently in widespread use. + +- (social.ontolo.categories)[https://ontolo.social/] From d33b223c6afe2be3d197d2cdb4686961a6fb2b29 Mon Sep 17 00:00:00 2001 From: Oscar Merry <oscardmerry@gmail.com> Date: Thu, 16 May 2024 20:44:45 +0100 Subject: [PATCH 095/587] Remove Media Type Prefix --- XX.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/XX.md b/XX.md index eebaeedb..4b51c67f 100644 --- a/XX.md +++ b/XX.md @@ -19,7 +19,7 @@ Since the `i` tag is already used for similar references in kind-0 metadata even ### Books: -- Book ISBN: `["i", "book:isbn:9780765382030"]` - https://isbnsearch.org/isbn/9780765382030 +- Book ISBN: `["i", "isbn:9780765382030"]` - https://isbnsearch.org/isbn/9780765382030 Book 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. @@ -30,6 +30,6 @@ Book ISBNs MUST be referenced _**without hyphens**_ as many book search APIs ret ### Movies: -- Movie ISAN: `["i", "movie:isan:0000-0000-401A-0000-7"]` - https://web.isan.org/public/en/isan/0000-0000-401A-0000-7 +- Movie ISAN: `["i", "isan:0000-0000-401A-0000-7"]` - https://web.isan.org/public/en/isan/0000-0000-401A-0000-7 Movie 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 \ No newline at end of file From caee48316f811f928d92c44892ea173d990b2ebc Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Fri, 17 May 2024 19:45:27 +0900 Subject: [PATCH 096/587] NIP-24: clarify meaning of "event" for title --- 24.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/24.md b/24.md index 449101af..b21f48e9 100644 --- a/24.md +++ b/24.md @@ -40,4 +40,4 @@ tags These 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: - `r`: a web URL the event is referring to in some way - - `title`: title of the event + - `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 From 1da44a5b712363da6ed2aa149f498da08d087782 Mon Sep 17 00:00:00 2001 From: Terry Yiu <963907+tyiu@users.noreply.github.com> Date: Fri, 17 May 2024 08:13:02 -0400 Subject: [PATCH 097/587] Add missing comma in the example gift wrap JSON for NIP-59 --- 59.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/59.md b/59.md index 7eff2b82..4dc857f6 100644 --- a/59.md +++ b/59.md @@ -155,7 +155,7 @@ Sign the `gift wrap` using the random key generated in the previous step. "created_at": 1703021488, "pubkey": "18b1a75918f1f2c90c23da616bce317d36e348bcf5f7ba55e75949319210c87c", "id": "5c005f3ccf01950aa8d131203248544fb1e41a0d698e846bd419cec3890903ac", - "sig": "35fabdae4634eb630880a1896a886e40fd6ea8a60958e30b89b33a93e6235df750097b04f9e13053764251b8bc5dd7e8e0794a3426a90b6bcc7e5ff660f54259" + "sig": "35fabdae4634eb630880a1896a886e40fd6ea8a60958e30b89b33a93e6235df750097b04f9e13053764251b8bc5dd7e8e0794a3426a90b6bcc7e5ff660f54259", "tags": [["p", "166bf3765ebd1fc55decfe395beff2ea3b2a4e0a8946e7eb578512b555737c99"]], } ``` From a59ce8970ae8fb9c05bcd9e716e95187e9db6c17 Mon Sep 17 00:00:00 2001 From: Braydon Fuller <courier@braydon.com> Date: Fri, 17 May 2024 12:02:21 -0700 Subject: [PATCH 098/587] Fix connection string protocol description. (#1243) * Fix connection string protocol description. * Update `nostr+walletconnect` reference. --- 47.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/47.md b/47.md index 0f93b205..983d2c95 100644 --- a/47.md +++ b/47.md @@ -81,7 +81,7 @@ If the command was successful, the `error` field must be null. ## Nostr Wallet Connect URI **client** discovers **wallet service** by scanning a QR code, handling a deeplink or pasting in a URI. -The **wallet service** generates this connection URI with protocol `nostr+walletconnect:` and base path it's hex-encoded `pubkey` with the following query string parameters: +The **wallet service** generates this connection URI with protocol `nostr+walletconnect://` and base path it's hex-encoded `pubkey` with the following query string parameters: - `relay` Required. URL of the relay where the **wallet service** is connected and will be listening for events. May be more than one. - `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**. @@ -402,7 +402,7 @@ Response: ## Example pay invoice flow -0. 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. +0. 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. 1. **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. 2. **wallet service** verifies that the author's key is authorized to perform the payment, decrypts the payload and sends the payment. 3. **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. From b151a28fe38e1fa7858a42b43b352f9a1ec89588 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Sat, 18 May 2024 22:02:14 +0900 Subject: [PATCH 099/587] README: add missing kinds of NIP-54 --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index b3736ea4..3209df99 100644 --- a/README.md +++ b/README.md @@ -108,6 +108,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `42` | Channel Message | [28](28.md) | | `43` | Channel Hide Message | [28](28.md) | | `44` | Channel Mute User | [28](28.md) | +| `818` | Merge Requests | [54](54.md) | | `1021` | Bid | [15](15.md) | | `1022` | Bid confirmation | [15](15.md) | | `1040` | OpenTimestamps | [03](03.md) | @@ -173,6 +174,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30403` | Draft Classified Listing | [99](99.md) | | `30617` | Repository announcements | [34](34.md) | | `30818` | Wiki article | [54](54.md) | +| `30819` | Redirects | [54](54.md) | | `31922` | Date-Based Calendar Event | [52](52.md) | | `31923` | Time-Based Calendar Event | [52](52.md) | | `31924` | Calendar | [52](52.md) | From d68899881c647bc031c4e62fd0501323e8bad7f8 Mon Sep 17 00:00:00 2001 From: kieran <kieran@harkin.me> Date: Fri, 12 Apr 2024 10:50:47 +0100 Subject: [PATCH 100/587] pubkey on e tags --- 10.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/10.md b/10.md index a434ea05..dfd4cb9e 100644 --- a/10.md +++ b/10.md @@ -38,13 +38,14 @@ They are citing from this event. `root-id` and `reply-id` are as above. >This scheme is deprecated because it creates ambiguities that are difficult, or impossible to resolve when an event references another but is not a reply. ## Marked "e" tags (PREFERRED) -`["e", <event-id>, <relay-url>, <marker>]` +`["e", <event-id>, <relay-url>, <marker>, <pubkey>]` Where: * `<event-id>` is the id of the event being referenced. * `<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 `""`. * `<marker>` is optional and if present is one of `"reply"`, `"root"`, or `"mention"`. + * `<pubkey>` is optional, SHOULD be the pubkey of the author of the referenced event Those marked with `"reply"` denote the id of the reply event being responded to. Those marked with `"root"` denote the root id of the reply thread being responded to. For top level replies (those replying directly to the root event), only the `"root"` marker should be used. Those marked with `"mention"` denote a quoted or reposted event id. @@ -52,6 +53,7 @@ A direct reply to the root of a thread should have a single marked "e" tag of ty >This scheme is preferred because it allows events to mention others without confusing them with `<reply-id>` or `<root-id>`. +`<pubkey>` SHOULD be the pubkey of the author of the `e` tagged event, this is used in the outbox model to search for that event from the authors write relays where relay hints did not resolve the event. ## The "p" tag Used in a text event contains a list of pubkeys used to record who is involved in a reply thread. From 8d6d58871542dfcbb3f9d5d610a13a1e17358e58 Mon Sep 17 00:00:00 2001 From: kieran <kieran@harkin.me> Date: Tue, 14 May 2024 13:59:59 +0100 Subject: [PATCH 101/587] nip96 list uploads --- 96.md | 108 ++++++++++++++++++++++++++++++++++++---------------------- 1 file changed, 68 insertions(+), 40 deletions(-) diff --git a/96.md b/96.md index f7d901fd..4203b63e 100644 --- a/96.md +++ b/96.md @@ -84,46 +84,43 @@ it must use the "api_url" field instead. See https://github.com/aljazceru/awesome-nostr#nip-96-file-storage-servers. + +## Auth + +When indicated, `clients` must add an [NIP-98](98.md) `Authorization` header (**optionally** with the encoded `payload` tag set to the base64-encoded 256-bit SHA-256 hash of the file - not the hash of the whole request body). + ## Upload -A file can be uploaded one at a time to `https://your-file-server.example/custom-api-path` (route from `https://your-file-server.example/.well-known/nostr/nip96.json` "api_url" field) as `multipart/form-data` content type using `POST` method with the file object set to the `file` form data field. +`POST $api_url` as `multipart/form-data`. -`Clients` must add an [NIP-98](98.md) `Authorization` header (**optionally** with the encoded `payload` tag set to the base64-encoded 256-bit SHA-256 hash of the file - not the hash of the whole request body). -If using an html form, use an `Authorization` form data field instead. +**AUTH required** -These following **optional** form data fields MAY be used by `servers` and SHOULD be sent by `clients`: -- `expiration`: string of the UNIX timestamp in seconds. Empty string if file should be stored forever. The server isn't required to honor this; -- `size`: string of the file byte size. This is just a value the server can use to reject early if the file size exceeds the server limits; -- `alt`: (recommended) strict description text for visibility-impaired users; -- `caption`: loose description; -- `media_type`: "avatar" or "banner". Informs the server if the file will be used as an avatar or banner. If absent, the server will interpret it as a normal upload, without special treatment; +List of form fields: +- `file`: **REQUIRED** the file to upload +- `caption`: **RECOMMENDED** loose description; +- `expiration`: UNIX timestamp in seconds. Empty string if file should be stored forever. The server isn't required to honor this. +- `size`: File byte size. This is just a value the server can use to reject early if the file size exceeds the server limits. +- `alt`: **RECOMMENDED** strict description text for visibility-impaired users. +- `media_type`: "avatar" or "banner". Informs the server if the file will be used as an avatar or banner. If absent, the server will interpret it as a normal upload, without special treatment. - `content_type`: mime type such as "image/jpeg". This is just a value the server can use to reject early if the mime type isn't supported. - Others custom form data fields may be used depending on specific `server` support. The `server` isn't required to store any metadata sent by `clients`. -Note for `clients`: if using an HTML form, it is important for the `file` form field to be the **last** one, or be re-ordered right before sending or be appended as the last field of XHR2's FormData object. - The `filename` embedded in the file may not be honored by the `server`, which could internally store just the SHA-256 hash value as the file name, ignoring extra metadata. -The hash is enough to uniquely identify a file, that's why it will be used on the "download" and "delete" routes. +The hash is enough to uniquely identify a file, that's why it will be used on the `download` and `delete` routes. -The `server` MUST link the user's `pubkey` string (which is embedded in the decoded header value) as the owner of the file so to later allow them to delete the file. -Note that if a file with the same hash of a previously received file (so the same file) is uploaded by another user, the server doesn't need to store the new file. -It should just add the new user's `pubkey` to the list of the owners of the already stored file with said hash (if it wants to save space by keeping just one copy of the same file, because multiple uploads of the same file results in the same file hash). +The `server` MUST link the user's `pubkey` string as the owner of the file so to later allow them to delete the file. -The `server` MAY also store the `Authorization` header/field value (decoded or not) for accountability purpose as this proves that the user with the unique pubkey did ask for the upload of the file with a specific hash. However, storing the pubkey is sufficient to establish ownership. +### Response codes -The `server` MUST reject with 413 Payload Too Large if file size exceeds limits. - -The `server` MUST reject with 400 Bad Request status if some fields are invalid. - -The `server` MUST reply to the upload with 200 OK status if the `payload` tag value contains an already used SHA-256 hash (if file is already owned by the same pubkey) or reject the upload with 403 Forbidden status if it isn't the same of the received file. - -The `server` MAY reject the upload with 402 Payment Required status if the user has a pending payment (Payment flow is not strictly required. Server owners decide if the storage is free or not. Monetization schemes may be added later to correlated NIPs.). - -On successful uploads the `server` MUST reply with **201 Created** HTTP status code or **202 Accepted** if a `processing_url` field is added -to the response so that the `client` can follow the processing status (see [Delayed Processing](#delayed-processing) section). +- `200 OK`: File upload exists, but is successful (Existing hash) +- `201 Created`: File upload successful (New hash) +- `202 Accepted`: File upload is awaiting processing, see [Delayed Processing](#delayed-processing) section +- `413 Payload Too Large`: File size exceeds limit +- `400 Bad Request`: Form data is invalid or not supported. +- `403 Forbidden`: User is not allowed to upload or the uploaded file hash didnt match the hash included in the `Authorization` header `payload` tag. +- `402 Payment Required`: Payment is required by the server, **this flow is undefined**. The upload response is a json object as follows: @@ -179,11 +176,13 @@ The upload response is a json object as follows: Note that if the server didn't apply any transformation to the received file, both `nip94_event.tags.*.ox` and `nip94_event.tags.*.x` fields will have the same value. The server MUST link the saved file to the SHA-256 hash of the **original** file before any server transformations (the `nip94_event.tags.*.ox` tag value). The **original** file's SHA-256 hash will be used to identify the saved file when downloading or deleting it. -`Clients` may upload the same file to one or many `servers`. +`clients` may upload the same file to one or many `servers`. After successful upload, the `client` may optionally generate and send to any set of nostr `relays` a [NIP-94](94.md) event by including the missing fields. Alternatively, instead of using NIP-94, the `client` can share or embed on a nostr note just the above url. +`clients` may also use the tags from the `nip94_event` to construct an `imeta` tag + ### Delayed Processing Sometimes the server may want to place the uploaded file in a processing queue for deferred file processing. @@ -219,7 +218,7 @@ However, for all file actions, such as download and deletion, the **original** f ## Download -`Servers` must make available the route `https://your-file-server.example/custom-api-path/<sha256-file-hash>(.ext)` (route taken from `https://your-file-server.example/.well-known/nostr/nip96.json` "api_url" or "download_url" field) with `GET` method for file download. +`GET $api_url/<sha256-hash>(.ext)` The primary file download url informed at the upload's response field `nip94_event.tags.*.url` can be that or not (it can be any non-standard url the server wants). @@ -227,17 +226,17 @@ If not, the server still MUST also respond to downloads at the standard url mentioned on the previous paragraph, to make it possible for a client to try downloading a file on any NIP-96 compatible server by knowing just the SHA-256 file hash. -Note that the "\<sha256-file-hash\>" part is from the **original** file, **not** from the **transformed** file if the uploaded file went through any server transformation. +Note that the "\<sha256-hash\>" part is from the **original** file, **not** from the **transformed** file if the uploaded file went through any server transformation. Supporting ".ext", meaning "file extension", is required for `servers`. It is optional, although recommended, for `clients` to append it to the path. When present it may be used by `servers` to know which `Content-Type` header to send (e.g.: "Content-Type": "image/png" for ".png" extension). The file extension may be absent because the hash is the only needed string to uniquely identify a file. -Example: `https://your-file-server.example/custom-api-path/719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b.png` +Example: `$api_url/719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b.png` ### Media Transformations -`Servers` may respond to some media transformation query parameters and ignore those they don't support by serving +`servers` may respond to some media transformation query parameters and ignore those they don't support by serving the original media file without transformations. #### Image Transformations @@ -245,23 +244,23 @@ the original media file without transformations. ##### Resizing Upon upload, `servers` may create resized image variants, such as thumbnails, respecting the original aspect ratio. -`Clients` may use the `w` query parameter to request an image version with the desired pixel width. -`Servers` can then serve the variant with the closest width to the parameter value +`clients` may use the `w` query parameter to request an image version with the desired pixel width. +`servers` can then serve the variant with the closest width to the parameter value or an image variant generated on the fly. -Example: `https://your-file-server.example/custom-api-path/<sha256-file-hash>.png?w=32` +Example: `$api_url/<sha256-hash>.png?w=32` ## Deletion -`Servers` must make available the route `https://deletion.domain/deletion-path/<sha256-file-hash>(.ext)` (route taken from `https://your-file-server.example/.well-known/nostr/nip96.json` "api_url" field) with `DELETE` method for file deletion. +`DELETE $api_url/<sha256-hash>(.ext)` -Note that the "\<sha256-file-hash\>" part is from the **original** file, **not** from the **transformed** file if the uploaded file went through any server transformation. +**AUTH required** + +Note that the `/<sha256-hash>` part is from the **original** file, **not** from the **transformed** file if the uploaded file went through any server transformation. The extension is optional as the file hash is the only needed file identification. -`Clients` should send a `DELETE` request to the server deletion route in the above format. It must include a NIP-98 `Authorization` header. - -The `server` should reject deletes from users other than the original uploader. The `pubkey` encoded on the header value identifies the user. +The `server` should reject deletes from users other than the original uploader with the appropriate http response code (403 Forbidden). It should be noted that more than one user may have uploaded the same file (with the same hash). In this case, a delete must not really delete the file but just remove the user's `pubkey` from the file owners list (considering the server keeps just one copy of the same file, because multiple uploads of the same file results in the same file hash). @@ -275,6 +274,35 @@ The successful response is a 200 OK one with just basic JSON fields: } ``` +## Listing files + +`GET $api_url` + +**AUTH required** + +Returns a list of files linked to the authenticated users pubkey. + +Example Response: +```js +[ + { + "id": "<sha256-hash>", + "nip94_event": {...}, + "expires": 1715691139, // unix timestamp + "size": 123456, + "alt": "a meme that makes you laugh", + "caption": "haha funny meme" + }, + ... +] +``` + +`<sha256-hash>` is the **original hash**, ie. `ox` + +`nip94_event` is the same as in the upload result. + +`alt` / `caption` are optional. + ## Selecting a Server Note: HTTP File Storage Server developers may skip this section. This is meant for client developers. From bd9c7a1b8e372b3c8e518861b1f4ea5c92ef1888 Mon Sep 17 00:00:00 2001 From: kieran <kieran@harkin.me> Date: Mon, 20 May 2024 21:38:36 +0100 Subject: [PATCH 102/587] add pagination / drop duplicate fields --- 96.md | 34 ++++++++++++++++++++-------------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/96.md b/96.md index 4203b63e..e882870e 100644 --- a/96.md +++ b/96.md @@ -1,8 +1,6 @@ -NIP-96 -====== +# NIP-96 -HTTP File Storage Integration ------------------------------ +## HTTP File Storage Integration `draft` `optional` @@ -84,8 +82,7 @@ it must use the "api_url" field instead. See https://github.com/aljazceru/awesome-nostr#nip-96-file-storage-servers. - -## Auth +## Auth When indicated, `clients` must add an [NIP-98](98.md) `Authorization` header (**optionally** with the encoded `payload` tag set to the base64-encoded 256-bit SHA-256 hash of the file - not the hash of the whole request body). @@ -96,6 +93,7 @@ When indicated, `clients` must add an [NIP-98](98.md) `Authorization` header (** **AUTH required** List of form fields: + - `file`: **REQUIRED** the file to upload - `caption`: **RECOMMENDED** loose description; - `expiration`: UNIX timestamp in seconds. Empty string if file should be stored forever. The server isn't required to honor this. @@ -276,22 +274,27 @@ The successful response is a 200 OK one with just basic JSON fields: ## Listing files -`GET $api_url` +`GET $api_url?page=x&count=y` **AUTH required** Returns a list of files linked to the authenticated users pubkey. Example Response: + ```js [ - { + { "id": "<sha256-hash>", - "nip94_event": {...}, - "expires": 1715691139, // unix timestamp - "size": 123456, - "alt": "a meme that makes you laugh", - "caption": "haha funny meme" + "nip94_event": { + "tags": [ + ["size", "123456"], + ["alt", "a meme that makes you laugh"], + ["expiration", "1715691139"] + // ...other metadata + ] + "content": "haha funny meme" // caption + } }, ... ] @@ -301,7 +304,10 @@ Example Response: `nip94_event` is the same as in the upload result. -`alt` / `caption` are optional. +### Query args + +- `page` page number (`offset=page*count`) +- `count` number of items per page ## Selecting a Server From 744b788427ce56d1cde99c5ccf4739bcaa8c75fb Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Wed, 22 May 2024 21:21:44 +0900 Subject: [PATCH 103/587] README: add NIP-35 and `e` tag pubkey --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d45a42b4..d93469fd 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-31: Dealing with Unknown Events](31.md) - [NIP-32: Labeling](32.md) - [NIP-34: `git` stuff](34.md) +- [NIP-35: Torrents](35.md) - [NIP-36: Sensitive Content](36.md) - [NIP-38: User Statuses](38.md) - [NIP-39: External Identities in Profiles](39.md) @@ -224,7 +225,7 @@ Please update these lists when proposing NIPs introducing new event kinds. | name | value | other parameters | NIP | | ----------------- | ------------------------------------ | -------------------- | ------------------------------------- | -| `e` | event id (hex) | relay URL, marker | [01](01.md), [10](10.md) | +| `e` | event id (hex) | relay URL, marker, pubkey (hex) | [01](01.md), [10](10.md) | | `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | | `a` | coordinates to an event | relay URL | [01](01.md) | | `d` | identifier | -- | [01](01.md) | From 12655c739c489beab33cb264c8f6298aadddd955 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Wed, 22 May 2024 21:28:00 +0900 Subject: [PATCH 104/587] Format tags table --- README.md | 96 +++++++++++++++++++++++++++---------------------------- 1 file changed, 48 insertions(+), 48 deletions(-) diff --git a/README.md b/README.md index d93469fd..e430f130 100644 --- a/README.md +++ b/README.md @@ -223,54 +223,54 @@ Please update these lists when proposing NIPs introducing new event kinds. ## Standardized Tags -| name | value | other parameters | NIP | -| ----------------- | ------------------------------------ | -------------------- | ------------------------------------- | -| `e` | event id (hex) | relay URL, marker, pubkey (hex) | [01](01.md), [10](10.md) | -| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | -| `a` | coordinates to an event | relay URL | [01](01.md) | -| `d` | identifier | -- | [01](01.md) | -| `g` | geohash | -- | [52](52.md) | -| `i` | identity | proof | [39](39.md) | -| `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) | -| `l` | label, label namespace | annotations | [32](32.md) | -| `L` | label namespace | -- | [32](32.md) | -| `m` | MIME type | -- | [94](94.md) | -| `q` | event id (hex) | relay URL | [18](18.md) | -| `r` | a reference (URL, etc) | petname | | -| `r` | relay url | marker | [65](65.md) | -| `t` | hashtag | -- | | -| `alt` | summary | -- | [31](31.md) | -| `amount` | millisatoshis, stringified | -- | [57](57.md) | -| `bolt11` | `bolt11` invoice | -- | [57](57.md) | -| `challenge` | challenge string | -- | [42](42.md) | -| `client` | name, address | relay URL | [89](89.md) | -| `clone` | git clone URL | -- | [34](34.md) | -| `content-warning` | reason | -- | [36](36.md) | -| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | -| `description` | description | -- | [34](34.md), [57](57.md), [58](58.md) | -| `emoji` | shortcode, image URL | -- | [30](30.md) | -| `encrypted` | -- | -- | [90](90.md) | -| `expiration` | unix timestamp (string) | -- | [40](40.md) | -| `goal` | event id (hex) | relay URL | [75](75.md) | -| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | -| `imeta` | inline metadata | -- | [92](92.md) | -| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | -| `location` | location string | -- | [52](52.md), [99](99.md) | -| `name` | name | -- | [34](34.md), [58](58.md) | -| `nonce` | random | -- | [13](13.md) | -| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | -| `price` | price | currency, frequency | [99](99.md) | -| `proxy` | external ID | protocol | [48](48.md) | -| `published_at` | unix timestamp (string) | -- | [23](23.md) | -| `relay` | relay url | -- | [42](42.md), [17](17.md) | -| `relays` | relay list | -- | [57](57.md) | -| `server` | file storage server url | -- | [96](96.md) | -| `subject` | subject | -- | [14](14.md), [17](17.md) | -| `summary` | article summary | -- | [23](23.md) | -| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | -| `title` | article title | -- | [23](23.md) | -| `web` | webpage URL | -- | [34](34.md) | -| `zap` | pubkey (hex), relay URL | weight | [57](57.md) | +| name | value | other parameters | NIP | +| ----------------- | ------------------------------------ | ------------------------------- | ------------------------------------- | +| `e` | event id (hex) | relay URL, marker, pubkey (hex) | [01](01.md), [10](10.md) | +| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | +| `a` | coordinates to an event | relay URL | [01](01.md) | +| `d` | identifier | -- | [01](01.md) | +| `g` | geohash | -- | [52](52.md) | +| `i` | identity | proof | [39](39.md) | +| `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) | +| `l` | label, label namespace | annotations | [32](32.md) | +| `L` | label namespace | -- | [32](32.md) | +| `m` | MIME type | -- | [94](94.md) | +| `q` | event id (hex) | relay URL | [18](18.md) | +| `r` | a reference (URL, etc) | petname | | +| `r` | relay url | marker | [65](65.md) | +| `t` | hashtag | -- | | +| `alt` | summary | -- | [31](31.md) | +| `amount` | millisatoshis, stringified | -- | [57](57.md) | +| `bolt11` | `bolt11` invoice | -- | [57](57.md) | +| `challenge` | challenge string | -- | [42](42.md) | +| `client` | name, address | relay URL | [89](89.md) | +| `clone` | git clone URL | -- | [34](34.md) | +| `content-warning` | reason | -- | [36](36.md) | +| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | +| `description` | description | -- | [34](34.md), [57](57.md), [58](58.md) | +| `emoji` | shortcode, image URL | -- | [30](30.md) | +| `encrypted` | -- | -- | [90](90.md) | +| `expiration` | unix timestamp (string) | -- | [40](40.md) | +| `goal` | event id (hex) | relay URL | [75](75.md) | +| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | +| `imeta` | inline metadata | -- | [92](92.md) | +| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | +| `location` | location string | -- | [52](52.md), [99](99.md) | +| `name` | name | -- | [34](34.md), [58](58.md) | +| `nonce` | random | -- | [13](13.md) | +| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | +| `price` | price | currency, frequency | [99](99.md) | +| `proxy` | external ID | protocol | [48](48.md) | +| `published_at` | unix timestamp (string) | -- | [23](23.md) | +| `relay` | relay url | -- | [42](42.md), [17](17.md) | +| `relays` | relay list | -- | [57](57.md) | +| `server` | file storage server url | -- | [96](96.md) | +| `subject` | subject | -- | [14](14.md), [17](17.md) | +| `summary` | article summary | -- | [23](23.md) | +| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | +| `title` | article title | -- | [23](23.md) | +| `web` | webpage URL | -- | [34](34.md) | +| `zap` | pubkey (hex), relay URL | weight | [57](57.md) | ## Criteria for acceptance of NIPs From 0cb9b605190cb3a821b8d24d27e495bbfe92c09d Mon Sep 17 00:00:00 2001 From: hodlbod <jstaab@protonmail.com> Date: Thu, 23 May 2024 20:31:36 -0700 Subject: [PATCH 105/587] Add CIP-01 (#1251) * Add CIP-01 * Rename cip to nud --------- Co-authored-by: Jon Staab <shtaab@gmail.com> --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index e430f130..d5b6219f 100644 --- a/README.md +++ b/README.md @@ -180,6 +180,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30617` | Repository announcements | [34](34.md) | | `30818` | Wiki article | [54](54.md) | | `30819` | Redirects | [54](54.md) | +| `31890` | Feed | [NUD: Custom Feeds](https://wikifreedia.xyz/cip-01/97c70a44366a6535c1) | | `31922` | Date-Based Calendar Event | [52](52.md) | | `31923` | Time-Based Calendar Event | [52](52.md) | | `31924` | Calendar | [52](52.md) | @@ -192,6 +193,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `34550` | Community Definition | [72](72.md) | | `39000-9` | Group metadata events | [29](29.md) | +[NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/97c70a44366a6535c1 [nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md [lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md From f5be59b052e48f9f0352b6207c2c08a85e7d0308 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=A1clav=20Navr=C3=A1til?= <vaclav@navratil.vn> Date: Fri, 24 May 2024 16:20:25 +0200 Subject: [PATCH 106/587] Fix of otherwise unverifiable event I'm reverting a change made by @arkin0x in commit: https://github.com/nostr-protocol/nips/commit/6fb9e54f7b4886272f7464aba2f0971543d8df40#diff-cb504c91ef546f76741fb8fd4c13b1f97e4b5ce2a9d78afa545fb6ec799e06c2L39 which renders the example event unverifiable because of a changed hash. --- 13.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/13.md b/13.md index 53c4d1b6..99289c2a 100644 --- a/13.md +++ b/13.md @@ -35,7 +35,7 @@ Example mined note "created_at": 1651794653, "kind": 1, "tags": [ - ["nonce", "776797", "21"] + ["nonce", "776797", "20"] ], "content": "It's just me mining my own business", "sig": "284622fc0a3f4f1303455d5175f7ba962a3300d136085b9566801bc2e0699de0c7e31e44c81fb40ad9049173742e904713c3594a1da0fc5d2382a25c11aba977" From ca6dddde808be705785aa84dbe1fbe93adf9462c Mon Sep 17 00:00:00 2001 From: "P. Reis" <76563803+patrickReiis@users.noreply.github.com> Date: Fri, 24 May 2024 15:04:45 -0300 Subject: [PATCH 107/587] nip01: mention extra metadata fields may be set --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 8be85bc8..6b6f13b5 100644 --- a/01.md +++ b/01.md @@ -87,7 +87,7 @@ As a convention, all single-letter (only english alphabet letters: a-z, A-Z) key Kinds specify how clients should interpret the meaning of each event and the other fields of each event (e.g. an `"r"` tag may have a meaning in an event of kind 1 and an entirely different meaning in an event of kind 10002). Each NIP may define the meaning of a set of kinds that weren't defined elsewhere. This NIP defines two basic kinds: -- `0`: **metadata**: the `content` is set to a stringified JSON object `{name: <username>, about: <string>, picture: <url, string>}` describing the user who created the event. A relay may delete older events once it gets a new one for the same pubkey. +- `0`: **metadata**: the `content` is set to a stringified JSON object `{name: <username>, about: <string>, picture: <url, string>}` describing the user who created the event. [Extra metadata fields](24.md) may be set. A relay may delete older events once it gets a new one for the same pubkey. - `1`: **text note**: the `content` is set to the **plaintext** content of a note (anything the user wants to say). Content that must be parsed, such as Markdown and HTML, should not be used. Clients should also not parse content as those. And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: From 092da0a4635523c0888b59c2229baa9c2e951115 Mon Sep 17 00:00:00 2001 From: hodlbod <jstaab@protonmail.com> Date: Fri, 24 May 2024 13:19:31 -0700 Subject: [PATCH 108/587] Update 01.md Co-authored-by: Asai Toshiya <to.asai.60@gmail.com> --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 6b6f13b5..b51fdf0e 100644 --- a/01.md +++ b/01.md @@ -87,7 +87,7 @@ As a convention, all single-letter (only english alphabet letters: a-z, A-Z) key Kinds specify how clients should interpret the meaning of each event and the other fields of each event (e.g. an `"r"` tag may have a meaning in an event of kind 1 and an entirely different meaning in an event of kind 10002). Each NIP may define the meaning of a set of kinds that weren't defined elsewhere. This NIP defines two basic kinds: -- `0`: **metadata**: the `content` is set to a stringified JSON object `{name: <username>, about: <string>, picture: <url, string>}` describing the user who created the event. [Extra metadata fields](24.md) may be set. A relay may delete older events once it gets a new one for the same pubkey. +- `0`: **metadata**: the `content` is set to a stringified JSON object `{name: <username>, about: <string>, picture: <url, string>}` describing the user who created the event. [Extra metadata fields](24.md#kind-0) may be set. A relay may delete older events once it gets a new one for the same pubkey. - `1`: **text note**: the `content` is set to the **plaintext** content of a note (anything the user wants to say). Content that must be parsed, such as Markdown and HTML, should not be used. Clients should also not parse content as those. And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: From 5d1d1c178ec1761bac4867f69ae1c59bc7c0ca37 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Sat, 25 May 2024 01:41:15 +0900 Subject: [PATCH 109/587] NIP-71: remove `aes-256-gcm` tag --- 71.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/71.md b/71.md index 3b8efcad..a811434c 100644 --- a/71.md +++ b/71.md @@ -26,7 +26,6 @@ The list of tags are as follows: * `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. * `title` (required) title of the video * `"published_at"`, for the timestamp in unix seconds (stringified) of the first time the video was published -* `"aes-256-gcm"` (optional) key and nonce for AES-GCM encryption with tagSize always 128bits * `x` containing the SHA-256 hexencoded string of the file. * `size` (optional) size of file in bytes * `dim` (optional) size of file in pixels in the form `<width>x<height>` @@ -62,7 +61,6 @@ The list of tags are as follows: ["url",<string with URI of file>], ["m", <MIME type>], ["x",<Hash SHA-256>], - ["aes-256-gcm",<key>, <iv>], ["size", <size of file in bytes>], ["duration", <duration of video in seconds>], ["dim", <size of file in pixels>], From 92d5837b0cf474503b9ebdf2676ba266fc265bdd Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Sat, 25 May 2024 09:46:46 -0300 Subject: [PATCH 110/587] nip54: clarify wikilink format. --- 54.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/54.md b/54.md index 8823af9a..fe469185 100644 --- a/54.md +++ b/54.md @@ -36,6 +36,11 @@ The content should be Markdown, following the same rules as of [NIP-23](23.md), One 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. +Wikilinks can take these two forms: + + 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`; + 2. `[[target page|see this]]` -- in this case it will link to the page `target-page`, but will be displayed as `see this`. + ### Merge Requests Event `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. From 765c7313979af899cbc3b6b582b415a41e71904d Mon Sep 17 00:00:00 2001 From: /dev/fd0 <147166694+1440000bytes@users.noreply.github.com> Date: Sun, 26 May 2024 10:58:14 +0000 Subject: [PATCH 111/587] add joinstr event kind in README (#1257) * add joinstr event kind * remove extra spaces * change kind number Co-authored-by: fiatjaf_ <fiatjaf@gmail.com> --------- Co-authored-by: fiatjaf_ <fiatjaf@gmail.com> --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index d5b6219f..b0589521 100644 --- a/README.md +++ b/README.md @@ -192,10 +192,12 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `34237` | Video View Event | [71](71.md) | | `34550` | Community Definition | [72](72.md) | | `39000-9` | Group metadata events | [29](29.md) | +| `2022` | Coinjoin Pool | [joinstr][joinstr] | [NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/97c70a44366a6535c1 [nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md [lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md +[joinstr]: https://gitlab.com/1440000bytes/joinstr/-/blob/main/NIP.md ## Message types From a649a75e5a7dbd958a3066f914af8854d022440a Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Sun, 26 May 2024 23:57:05 +0900 Subject: [PATCH 112/587] README: fix order of kinds --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b0589521..0709a481 100644 --- a/README.md +++ b/README.md @@ -126,6 +126,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `1985` | Label | [32](32.md) | | `2003` | Torrent | [35](35.md) | | `2004` | Torrent Comment | [35](35.md) | +| `2022` | Coinjoin Pool | [joinstr][joinstr] | | `4550` | Community Post Approval | [72](72.md) | | `5000`-`5999` | Job Request | [90](90.md) | | `6000`-`6999` | Job Result | [90](90.md) | @@ -192,7 +193,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `34237` | Video View Event | [71](71.md) | | `34550` | Community Definition | [72](72.md) | | `39000-9` | Group metadata events | [29](29.md) | -| `2022` | Coinjoin Pool | [joinstr][joinstr] | [NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/97c70a44366a6535c1 [nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md From deb00734930f18e5d9440a6a459ead28f639cbd2 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Mon, 27 May 2024 12:40:01 +0900 Subject: [PATCH 113/587] README: add `nonce` tag difficulty --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0709a481..f0af4f06 100644 --- a/README.md +++ b/README.md @@ -261,7 +261,7 @@ Please update these lists when proposing NIPs introducing new event kinds. | `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | | `location` | location string | -- | [52](52.md), [99](99.md) | | `name` | name | -- | [34](34.md), [58](58.md) | -| `nonce` | random | -- | [13](13.md) | +| `nonce` | random | difficulty | [13](13.md) | | `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | | `price` | price | currency, frequency | [99](99.md) | | `proxy` | external ID | protocol | [48](48.md) | From 53afaaece61f02e92b5ef9c3e9c32945c7ebf522 Mon Sep 17 00:00:00 2001 From: kieran <kieran@harkin.me> Date: Mon, 27 May 2024 12:18:27 +0100 Subject: [PATCH 114/587] nip71 imeta --- 71.md | 117 ++++++++++++++++++++++++++++++++-------------------------- 94.md | 13 ++++--- 2 files changed, 71 insertions(+), 59 deletions(-) diff --git a/71.md b/71.md index a811434c..fa8faa96 100644 --- a/71.md +++ b/71.md @@ -20,21 +20,60 @@ The format uses a parameterized replaceable event kind `34235` for horizontal vi The `.content` of these events is a summary or description on the video content. -The list of tags are as follows: -* `d` (required) universally unique identifier (UUID). Generated by the client creating the video event. -* `url` (required) the url to the video file -* `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. +The primary source of video information is the `imeta` tags which is defined in [NIP-92](92.md) + +Each `imeta` tag can be used to specify a variant of the video by the `dim` & `m` properties. + +Example: +```json +[ + ["imeta", + "dim 1920x1080", + "url https://myvideo.com/1080/12345.mp4", + "x 3093509d1e0bc604ff60cb9286f4cd7c781553bc8991937befaacfdc28ec5cdc", + "m video/mp4", + "image https://myvideo.com/1080/12345.jpg", + "image https://myotherserver.com/1080/12345.jpg", + "fallback https://myotherserver.com/1080/12345.mp4", + "fallback https://andanotherserver.com/1080/12345.mp4", + "service nip96", + ], + ["imeta", + "dim 1280x720", + "url https://myvideo.com/720/12345.mp4", + "x e1d4f808dae475ed32fb23ce52ef8ac82e3cc760702fca10d62d382d2da3697d", + "m video/mp4", + "image https://myvideo.com/720/12345.jpg", + "image https://myotherserver.com/720/12345.jpg", + "fallback https://myotherserver.com/720/12345.mp4", + "fallback https://andanotherserver.com/720/12345.mp4", + "service nip96", + ], + ["imeta", + "dim 1280x720", + "url https://myvideo.com/720/12345.m3u8", + "x 704e720af2697f5d6a198ad377789d462054b6e8d790f8a3903afbc1e044014f", + "m application/x-mpegURL", + "image https://myvideo.com/720/12345.jpg", + "image https://myotherserver.com/720/12345.jpg", + "fallback https://myotherserver.com/720/12345.m3u8", + "fallback https://andanotherserver.com/720/12345.m3u8", + "service nip96", + ], +] +``` + +Where `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. + +The `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`. + +Additionally `service nip96` may be included to allow clients to search the authors NIP-96 server list to find the file using the hash. + +### Other tags: * `title` (required) title of the video -* `"published_at"`, for the timestamp in unix seconds (stringified) of the first time the video was published -* `x` containing the SHA-256 hexencoded string of the file. -* `size` (optional) size of file in bytes -* `dim` (optional) size of file in pixels in the form `<width>x<height>` +* `published_at`, for the timestamp in unix seconds (stringified) of the first time the video was published * `duration` (optional) video duration in seconds -* `magnet` (optional) URI to magnet file -* `i` (optional) torrent infohash * `text-track` (optional, repeated) link to WebVTT file for video, type of supplementary information (captions/subtitles/chapters/metadata), optional language code -* `thumb` (optional) url of thumbnail with same aspect ratio -* `image` (optional) url of preview image with same dimensions * `content-warning` (optional) warning about content of NSFW video * `alt` (optional) description for accessibility * `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 @@ -53,19 +92,23 @@ The list of tags are as follows: ["d", "<UUID>"], ["title", "<title of video>"], - ["thumb", "<thumbnail image for video>"], ["published_at", "<unix timestamp>"], ["alt", <description>], // Video Data - ["url",<string with URI of file>], - ["m", <MIME type>], - ["x",<Hash SHA-256>], - ["size", <size of file in bytes>], + ["imeta", + "dim 1920x1080", + "url https://myvideo.com/1080/12345.mp4", + "x 3093509d1e0bc604ff60cb9286f4cd7c781553bc8991937befaacfdc28ec5cdc", + "m video/mp4", + "image https://myvideo.com/1080/12345.jpg", + "image https://myotherserver.com/1080/12345.jpg", + "fallback https://myotherserver.com/1080/12345.mp4", + "fallback https://andanotherserver.com/1080/12345.mp4", + "service nip96", + ], + ["duration", <duration of video in seconds>], - ["dim", <size of file in pixels>], - ["magnet",<magnet URI> ], - ["i",<torrent infohash>], ["text-track", "<encoded `kind 6000` event>", "<recommended relay urls>"], ["content-warning", "<reason>"], ["segment", <start>, <end>, "<title>", "<thumbnail URL>"], @@ -83,36 +126,4 @@ The list of tags are as follows: ["r", "<url>"] ] } -``` - -## Video View - -A video event view is a response to a video event to track a user's view or progress viewing the video. - -### Format - -The format uses a parameterized replaceable event kind `34237`. - -The `.content` of these events is optional and could be a free-form note that acts like a bookmark for the user. - -The list of tags are as follows: -* `a` (required) reference tag to kind `34235` or `34236` video event being viewed -* `d` (required) same as `a` reference tag value -* `viewed` (optional, repeated) timestamp of the user's start time in seconds, timestamp of the user's end time in seconds - - -```json -{ - "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, - "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, - "created_at": <Unix timestamp in seconds>, - "kind": 34237, - "content": "<note>", - "tags": [ - ["a", "<34235 | 34236>:<video event author pubkey>:<d-identifier of video event>", "<optional relay url>"], - ["e", "<event-id", "<relay-url>"] - ["d", "<34235 | 34236>:<video event author pubkey>:<d-identifier of video event>"], - ["viewed", <start>, <end>], - ] -} -``` +``` \ No newline at end of file diff --git a/94.md b/94.md index e35dfa1c..eb22393f 100644 --- a/94.md +++ b/94.md @@ -26,6 +26,7 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `summary` (optional) text excerpt * `alt` (optional) description for accessibility * `fallback` (optional) zero or more fallback file sources in case `url` fails +* `service` (optional) service type which is serving the file (eg. [NIP-96](96.md)) ```json { @@ -33,15 +34,15 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr "tags": [ ["url",<string with URI of file>], ["m", <MIME type>], - ["x",<Hash SHA-256>], - ["ox",<Hash SHA-256>], + ["x", <Hash SHA-256>], + ["ox", <Hash SHA-256>], ["size", <size of file in bytes>], ["dim", <size of file in pixels>], - ["magnet",<magnet URI> ], - ["i",<torrent infohash>], + ["magnet", <magnet URI> ], + ["i", <torrent infohash>], ["blurhash", <value>], - ["thumb", <string with thumbnail URI>], - ["image", <string with preview URI>], + ["thumb", <string with thumbnail URI>, <Hash SHA-256>], + ["image", <string with preview URI>, <Hash SHA-256>], ["summary", <excerpt>], ["alt", <description>] ], From 17593a41ab7ca51305db07cbfe1866f88e790206 Mon Sep 17 00:00:00 2001 From: Kieran <kieran@harkin.me> Date: Mon, 27 May 2024 14:52:49 +0100 Subject: [PATCH 115/587] NIP-96: no transform (#1262) * no_transform * Update 96.md Co-authored-by: Santos <34815293+sant0s12@users.noreply.github.com> --------- Co-authored-by: Santos <34815293+sant0s12@users.noreply.github.com> --- 96.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/96.md b/96.md index e882870e..c8b3170b 100644 --- a/96.md +++ b/96.md @@ -101,6 +101,7 @@ List of form fields: - `alt`: **RECOMMENDED** strict description text for visibility-impaired users. - `media_type`: "avatar" or "banner". Informs the server if the file will be used as an avatar or banner. If absent, the server will interpret it as a normal upload, without special treatment. - `content_type`: mime type such as "image/jpeg". This is just a value the server can use to reject early if the mime type isn't supported. +- `no_transform`: "true" asks server not to transform the file and serve the uploaded file as is, may be rejected. Others custom form data fields may be used depending on specific `server` support. The `server` isn't required to store any metadata sent by `clients`. @@ -110,6 +111,8 @@ The hash is enough to uniquely identify a file, that's why it will be used on th The `server` MUST link the user's `pubkey` string as the owner of the file so to later allow them to delete the file. +`no_transform` can be used to replicate a file to multiple servers for redundancy, clients can use the [server list](#selecting-a-server) to find alternative servers which might contain the same file. When uploading a file and requesting `no_transform` clients should check that the hash matches in the response in order to detect if the file was modified. + ### Response codes - `200 OK`: File upload exists, but is successful (Existing hash) From 8199b795716a253655db5f7cce7463202e0d47d0 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Mon, 27 May 2024 08:31:29 -0700 Subject: [PATCH 116/587] Raise bar for NIP implementation --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f0af4f06..ffa6393e 100644 --- a/README.md +++ b/README.md @@ -278,7 +278,7 @@ Please update these lists when proposing NIPs introducing new event kinds. ## Criteria for acceptance of NIPs -1. They should be implemented in at least two clients and one relay -- when applicable. +1. They should be fully implemented in at least two clients and one relay -- when applicable. 2. They should make sense. 3. They should be optional and backwards-compatible: care must be taken such that clients and relays that choose to not implement them do not stop working when interacting with the ones that choose to. 4. There should be no more than one way of doing the same thing. From 244666ed0d6cb13b7459e9710ad3ab67bec61b4c Mon Sep 17 00:00:00 2001 From: Basanta Goswami <36882714+basantagoswami@users.noreply.github.com> Date: Sun, 25 Feb 2024 02:43:07 +0530 Subject: [PATCH 117/587] small nitpicks --- 02.md | 4 +++- 25.md | 3 +-- 53.md | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/02.md b/02.md index 8b0aee15..4029b222 100644 --- a/02.md +++ b/02.md @@ -8,7 +8,9 @@ Follow List A special event with kind `3`, meaning "follow list" is defined as having a list of `p` tags, one for each of the followed/known profiles one is following. -Each tag entry should contain the key for the profile, a relay URL where events from that key can be found (can be set to an empty string if not needed), and a local name (or "petname") for that profile (can also be set to an empty string or not provided), i.e., `["p", <32-bytes hex key>, <main relay URL>, <petname>]`. The `content` can be anything and should be ignored. +Each tag entry should contain the key for the profile, a relay URL where events from that key can be found (can be set to an empty string if not needed), and a local name (or "petname") for that profile (can also be set to an empty string or not provided), i.e., `["p", <32-bytes hex key>, <main relay URL>, <petname>]`. + +The `.content` is not used. For example: diff --git a/25.md b/25.md index 7cc96b5f..698f3fb0 100644 --- a/25.md +++ b/25.md @@ -67,8 +67,7 @@ content as an emoji if shortcode is specified. "tags": [ ["emoji", "soapbox", "https://gleasonator.com/emoji/Gleasonator/soapbox.png"] ], - "pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6", - "created_at": 1682790000 + ...other fields } ``` diff --git a/53.md b/53.md index fad2622f..0b1cb813 100644 --- a/53.md +++ b/53.md @@ -77,7 +77,7 @@ Event `kind:1311` is live chat's channel message. Clients MUST include the `a` t ## Use Cases -Common use cases include meeting rooms/workshops, watch-together activities, or event spaces, such as [live.snort.social](https://live.snort.social) and [nostrnests.com](https://nostrnests.com). +Common use cases include meeting rooms/workshops, watch-together activities, or event spaces, such as [zap.stream](https://zap.stream). ## Example From 5c796c19fd6330628a0b328bfcf5270cb2bc3aff Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Wed, 29 May 2024 13:08:31 +0900 Subject: [PATCH 118/587] NIP-38: move description of content to Live Statuses section --- 38.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/38.md b/38.md index 911d5b18..4f2c06d2 100644 --- a/38.md +++ b/38.md @@ -46,6 +46,8 @@ Any other status types can be used but they are not defined by this NIP. The status MAY include an `r`, `p`, `e` or `a` tag linking to a URL, profile, note, or parameterized replaceable event. +The `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. + # Client behavior Clients MAY display this next to the username on posts or profiles to provide live user status information. @@ -57,5 +59,3 @@ Clients MAY display this next to the username on posts or profiles to provide li * Nostr music streaming services that update your music status when you're listening * Podcasting apps that update your music status when you're listening to a podcast, with a link for others to listen as well * Clients can use the system media player to update playing music status - -The `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. From 7bf5e327f7c0fef06173b10c3300767acd20d884 Mon Sep 17 00:00:00 2001 From: kieran <kieran@harkin.me> Date: Wed, 29 May 2024 14:26:00 +0100 Subject: [PATCH 119/587] update list response --- 96.md | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/96.md b/96.md index c8b3170b..2f253516 100644 --- a/96.md +++ b/96.md @@ -286,26 +286,29 @@ Returns a list of files linked to the authenticated users pubkey. Example Response: ```js -[ - { - "id": "<sha256-hash>", - "nip94_event": { +{ + "count": 1, // server page size, eg. max(1, min(server_max_page_size, arg_count)) + "total": 1, // total number of files + "page": 0, // the current page number + "files": [ + { "tags": [ + ["ox": "719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b"], + ["x": "5d2899290e0e69bcd809949ee516a4a1597205390878f780c098707a7f18e3df"], ["size", "123456"], ["alt", "a meme that makes you laugh"], - ["expiration", "1715691139"] + ["expiration", "1715691139"], // ...other metadata ] - "content": "haha funny meme" // caption - } - }, - ... -] + "content": "haha funny meme", // caption + "created_at": 1715691130 // upload timestmap + }, + ... + ] +} ``` -`<sha256-hash>` is the **original hash**, ie. `ox` - -`nip94_event` is the same as in the upload result. +`files` contains an array of NIP-94 events ### Query args From 0ff2fa3212ca66e3f7177da431084d4fde9386cd Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Mon, 8 Jan 2024 09:53:23 -0800 Subject: [PATCH 120/587] Add title to NIP 72, mention cross-posting and clarify moderation options --- 72.md | 29 ++++++++++++++++++++--------- 1 file changed, 20 insertions(+), 9 deletions(-) diff --git a/72.md b/72.md index 4bafce06..968a9eda 100644 --- a/72.md +++ b/72.md @@ -10,7 +10,7 @@ The goal of this NIP is to create moderator-approved public communities around a # Community Definition -`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. +`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. ```jsonc { @@ -18,6 +18,7 @@ The goal of this NIP is to create moderator-approved public communities around a "kind": 34550, "tags": [ ["d", "<community-d-identifier>"], + ["name", "<Community name>"], ["description", "<Community description>"], ["image", "<Community image url>", "<Width>x<Height>"], @@ -38,9 +39,9 @@ The goal of this NIP is to create moderator-approved public communities around a } ``` -# New Post Request +# Community Posts -Any 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. +Any Nostr event can be posted to a community. Clients MUST add one or more community `a` tags, each with a recommended relay. ```jsonc { @@ -53,11 +54,13 @@ Any Nostr event can be submitted to a community by anyone for approval. Clients } ``` -Community 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)). +# Moderation -# Post Approval by moderators +An 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`). -The 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. +The 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. + +Moderators MAY delete their approval of a post at any time using NIP 09 event deletions. ```jsonc { @@ -76,13 +79,21 @@ The post-approval event MUST include `a` tags of the communities the moderator i It'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. -Post 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. +Approvals of replaceable events can be created in three ways: -Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be included in all `34550:*` `a` tags. +1. By tagging the replaceable event as an `e` tag if moderators want to approve each individual change to the replaceable event +2. By tagging the replaceable event as an `a` tag if the moderator authorizes the replaceable event author to make changes without additional approvals and +3. 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 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. + +# Cross-posting + +Clients 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. # Displaying -Community clients SHOULD display posts that have been approved by at least 1 moderator or by the community owner. +Clients SHOULD display posts that have been approved by at least 1 moderator or by the community owner. Clients MAY disregard moderation and fetch community posts directly. The following filter displays the approved posts. From 42932deb0a9265de0b668e3f34a418177c1b8d2f Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Mon, 5 Feb 2024 09:26:14 -0800 Subject: [PATCH 121/587] Do more to clarify moderation --- 72.md | 26 ++++---------------------- 1 file changed, 4 insertions(+), 22 deletions(-) diff --git a/72.md b/72.md index 968a9eda..cb1db227 100644 --- a/72.md +++ b/72.md @@ -6,7 +6,7 @@ Moderated Communities (Reddit Style) `draft` `optional` -The 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. +The 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`. # Community Definition @@ -39,7 +39,7 @@ The goal of this NIP is to create moderator-approved public communities around a } ``` -# Community Posts +# Posting to a community Any Nostr event can be posted to a community. Clients MUST add one or more community `a` tags, each with a recommended relay. @@ -56,6 +56,8 @@ Any Nostr event can be posted to a community. Clients MUST add one or more commu # Moderation +Anyone 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. + An 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`). The 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. @@ -90,23 +92,3 @@ Since relays are instructed to delete old versions of a replaceable event, the ` # Cross-posting Clients 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. - -# Displaying - -Clients SHOULD display posts that have been approved by at least 1 moderator or by the community owner. Clients MAY disregard moderation and fetch community posts directly. - -The following filter displays the approved posts. - -```json -[ - "REQ", - "_", - { - "authors": ["<owner-pubkey>", "<moderator1-pubkey>", "<moderator2-pubkey>", "<moderator3-pubkey>", ...], - "kinds": [4550], - "#a": ["34550:<Community event author pubkey>:<d-identifier of the community>"], - } -] -``` - -Clients MAY hide approvals by blocked moderators at the user's request. From 1dc8d1857172d74e81097f34f1f5c58bcc29ac51 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Thu, 30 May 2024 12:24:58 -0700 Subject: [PATCH 122/587] Fix conflicts --- 72.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/72.md b/72.md index cb1db227..d19b80b4 100644 --- a/72.md +++ b/72.md @@ -89,6 +89,8 @@ Approvals of replaceable events can be created in three ways: Since 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. +Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be approved for all `34550:*` `a` tags. + # Cross-posting Clients 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. From 00b2e0a5cb819f9b2e8135f08d29ee94607d83b6 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Thu, 30 May 2024 15:27:59 -0400 Subject: [PATCH 123/587] Adds private outbox relays. --- 35.md | 19 +++++++++++++++++++ README.md | 1 + 2 files changed, 20 insertions(+) diff --git a/35.md b/35.md index 4bec44be..45663dd8 100644 --- a/35.md +++ b/35.md @@ -29,3 +29,22 @@ An additional `k` tag identifies the kind of the draft event. A blanked `.content` means this draft has been deleted by a client but relays still have the event. Tags `e` and `a` identify one or more anchor events, such as parent events on replies. + +## Relay List for Private Content + +Kind `10013` indicates the user's preferred relays to store private events like Drafts. The event MUST include a list of `relay` URLs in private tags. Private tags are JSON Stringified, NIP-44-encrypted to the signer's keys and placed inside the .content of the event. + +```js +{ + "kind": 10013, + "tags": [], + "content": nip44Encrypt(JSON.stringify([ + ["relay", "wss://myrelay.mydomain.com"] + ])) + //...other fields +} +``` + +Relays listed in this event SHOULD be authed and only allow downloads to events signed by the authed user. + +Clients SHOULD publish kind `10013` events to the author's [NIP-65](65.md) `write` relays. diff --git a/README.md b/README.md index dce4aaf2..6cd47788 100644 --- a/README.md +++ b/README.md @@ -136,6 +136,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10006` | Blocked relays list | [51](51.md) | | `10007` | Search relays list | [51](51.md) | | `10009` | User groups | [51](51.md), [29](29.md) | +| `10013` | Private Relays | [35](35.md) | `10015` | Interests list | [51](51.md) | | `10030` | User emoji list | [51](51.md) | | `10096` | File storage server list | [96](96.md) | From 48674e563865b1cb7bb3c5c7869d20055446f408 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Thu, 30 May 2024 15:31:33 -0400 Subject: [PATCH 124/587] moves from NIP-35 to NIP-37 --- 35.md => 37.md | 2 +- README.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) rename 35.md => 37.md (99%) diff --git a/35.md b/37.md similarity index 99% rename from 35.md rename to 37.md index 45663dd8..1ade59d8 100644 --- a/35.md +++ b/37.md @@ -1,4 +1,4 @@ -NIP-35 +NIP-37 ====== Draft Events diff --git a/README.md b/README.md index 6cd47788..b4626aaf 100644 --- a/README.md +++ b/README.md @@ -50,8 +50,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-31: Dealing with Unknown Events](31.md) - [NIP-32: Labeling](32.md) - [NIP-34: `git` stuff](34.md) -- [NIP-35: Draft Events](35.md) - [NIP-36: Sensitive Content](36.md) +- [NIP-37: Draft Events](37.md) - [NIP-38: User Statuses](38.md) - [NIP-39: External Identities in Profiles](39.md) - [NIP-40: Expiration Timestamp](40.md) @@ -136,7 +136,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10006` | Blocked relays list | [51](51.md) | | `10007` | Search relays list | [51](51.md) | | `10009` | User groups | [51](51.md), [29](29.md) | -| `10013` | Private Relays | [35](35.md) +| `10013` | Private Relays | [35](37.md) | | `10015` | Interests list | [51](51.md) | | `10030` | User emoji list | [51](51.md) | | `10096` | File storage server list | [96](96.md) | @@ -169,7 +169,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30402` | Classified Listing | [99](99.md) | | `30403` | Draft Classified Listing | [99](99.md) | | `30617` | Repository announcements | [34](34.md) | -| `31234` | Draft Event | [35](35.md) | +| `31234` | Draft Event | [35](37.md) | | `31922` | Date-Based Calendar Event | [52](52.md) | | `31923` | Time-Based Calendar Event | [52](52.md) | | `31924` | Calendar | [52](52.md) | From 30a5723f88f3c6e001bdd453de38144ba2f8f0b4 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Fri, 31 May 2024 12:43:13 +0900 Subject: [PATCH 125/587] BREAKING.md: add NIP-71 change --- BREAKING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/BREAKING.md b/BREAKING.md index 7b48ee0d..720d27b1 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -5,6 +5,7 @@ reverse chronological order. | Date | Commit | NIP | Change | | ----------- | --------- | -------- | ------ | +| 2024-05-25 | [5d1d1c17](https://github.com/nostr-protocol/nips/commit/5d1d1c17) | [NIP-71](71.md) | 'aes-256-gcm' tag was removed | | 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) | | 2024-02-25 | [4a171cb0](https://github.com/nostr-protocol/nips/commit/4a171cb0) | [NIP-18](18.md) | quote repost should use `q` tag | | 2024-02-21 | [c6cd655c](https://github.com/nostr-protocol/nips/commit/c6cd655c) | [NIP-46](46.md) | Params were stringified | From fcc1b0baf653d70402b2f379eeb5d881885aae00 Mon Sep 17 00:00:00 2001 From: Alex Gleason <alex@alexgleason.me> Date: Sun, 2 Jun 2024 16:38:01 -0500 Subject: [PATCH 126/587] Link `r` tag in the README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ffa6393e..c9368afb 100644 --- a/README.md +++ b/README.md @@ -240,7 +240,7 @@ Please update these lists when proposing NIPs introducing new event kinds. | `L` | label namespace | -- | [32](32.md) | | `m` | MIME type | -- | [94](94.md) | | `q` | event id (hex) | relay URL | [18](18.md) | -| `r` | a reference (URL, etc) | petname | | +| `r` | a reference (URL, etc) | petname | [24](24.md) | | `r` | relay url | marker | [65](65.md) | | `t` | hashtag | -- | | | `alt` | summary | -- | [31](31.md) | From fd2b5d2bfbb5dd95df4d8e3535845d6b77658da0 Mon Sep 17 00:00:00 2001 From: Alex Gleason <alex@alexgleason.me> Date: Sun, 2 Jun 2024 18:19:42 -0500 Subject: [PATCH 127/587] NIP-32: fix markdown link --- 32.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/32.md b/32.md index 92497a61..32358b50 100644 --- a/32.md +++ b/32.md @@ -158,4 +158,4 @@ Appendix: Known Ontologies Below is a non-exhaustive list of ontologies currently in widespread use. -- (social.ontolo.categories)[https://ontolo.social/] +- [social.ontolo.categories](https://ontolo.social/) From 23d605140bdbe6ccc43c6ebbcd2412a05ff262fa Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Tue, 4 Jun 2024 10:57:24 +0900 Subject: [PATCH 128/587] README: add NIP-100 to list --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index c9368afb..bd787847 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-96: HTTP File Storage Integration](96.md) - [NIP-98: HTTP Auth](98.md) - [NIP-99: Classified Listings](99.md) +- [NIP-100: Android Signer Application](100.md) ## Event Kinds | kind | description | NIP | From a6dfc7b5e513ea3070abcded3608b28e4d4a1512 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Wed, 5 Jun 2024 15:24:43 -0300 Subject: [PATCH 129/587] fix broken nip number. --- 100.md => 55.md | 42 +++++++++++++++++++++--------------------- README.md | 2 +- 2 files changed, 22 insertions(+), 22 deletions(-) rename 100.md => 55.md (98%) diff --git a/100.md b/55.md similarity index 98% rename from 100.md rename to 55.md index 4a304c3a..4565e8c3 100644 --- a/100.md +++ b/55.md @@ -1,4 +1,4 @@ -# NIP-100 +# NIP-55 ## Android Signer Application @@ -118,7 +118,7 @@ launcher.launch(intent) intent.putExtra("id", event.id) // Send the current logged in user npub intent.putExtra("current_user", npub) - + context.startActivity(intent) ``` - result: @@ -144,7 +144,7 @@ launcher.launch(intent) intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) // Send the hex pubKey that will be used for encrypting the data intent.putExtra("pubKey", pubKey) - + context.startActivity(intent) ``` - result: @@ -169,7 +169,7 @@ launcher.launch(intent) intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) // Send the hex pubKey that will be used for encrypting the data intent.putExtra("pubKey", pubKey) - + context.startActivity(intent) ``` - result: @@ -179,7 +179,7 @@ launcher.launch(intent) val encryptedText = intent.data?.getStringExtra("signature") // the id you sent val id = intent.data?.getStringExtra("id") - ``` + ``` - **nip04_decrypt** - params: @@ -194,7 +194,7 @@ launcher.launch(intent) intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) // Send the hex pubKey that will be used for decrypting the data intent.putExtra("pubKey", pubKey) - + context.startActivity(intent) ``` - result: @@ -204,7 +204,7 @@ launcher.launch(intent) val plainText = intent.data?.getStringExtra("signature") // the id you sent val id = intent.data?.getStringExtra("id") - ``` + ``` - **nip44_decrypt** - params: @@ -219,7 +219,7 @@ launcher.launch(intent) intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) // Send the hex pubKey that will be used for decrypting the data intent.putExtra("pubKey", pubKey) - + context.startActivity(intent) ``` - result: @@ -229,7 +229,7 @@ launcher.launch(intent) val plainText = intent.data?.getStringExtra("signature") // the id you sent val id = intent.data?.getStringExtra("id") - ``` + ``` - **decrypt_zap_event** - params: @@ -251,7 +251,7 @@ launcher.launch(intent) val eventJson = intent.data?.getStringExtra("signature") // the id you sent val id = intent.data?.getStringExtra("id") - ``` + ``` ## Using Content Resolver @@ -364,7 +364,7 @@ If the user chose to always reject the event, signer application will return the val index = it.getColumnIndex("signature") val encryptedText = it.getString(index) } - ``` + ``` - **nip04_decrypt** - params: @@ -388,7 +388,7 @@ If the user chose to always reject the event, signer application will return the val index = it.getColumnIndex("signature") val encryptedText = it.getString(index) } - ``` + ``` - **nip44_decrypt** - params: @@ -412,7 +412,7 @@ If the user chose to always reject the event, signer application will return the val index = it.getColumnIndex("signature") val encryptedText = it.getString(index) } - ``` + ``` - **decrypt_zap_event** - params: @@ -436,7 +436,7 @@ If the user chose to always reject the event, signer application will return the val index = it.getColumnIndex("signature") val eventJson = it.getString(index) } - ``` + ``` # Usage for Web Applications @@ -464,42 +464,42 @@ Android intents and browser urls have limitations, so if you are using the `retu ```js window.href = `nostrsigner:${eventJson}?compressionType=none&returnType=signature&type=sign_event&callbackUrl=https://example.com/?event=`; - ``` + ``` - **nip04_encrypt** - params: ```js window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_encrypt&callbackUrl=https://example.com/?event=`; - ``` + ``` - **nip44_encrypt** - params: ```js window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_encrypt&callbackUrl=https://example.com/?event=`; - ``` + ``` - **nip04_decrypt** - params: ```js window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_decrypt&callbackUrl=https://example.com/?event=`; - ``` + ``` - **nip44_decrypt** - params: ```js window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_decrypt&callbackUrl=https://example.com/?event=`; - ``` + ``` - **decrypt_zap_event** - params: ```js window.href = `nostrsigner:${eventJson}?compressionType=none&returnType=signature&type=decrypt_zap_event&callbackUrl=https://example.com/?event=`; - ``` + ``` ## Example @@ -513,7 +513,7 @@ Android intents and browser urls have limitations, so if you are using the `retu </head> <body> <h1>Test</h1> - + <script> window.onload = function() { var url = new URL(window.location.href); diff --git a/README.md b/README.md index bd787847..de85654e 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-52: Calendar Events](52.md) - [NIP-53: Live Activities](53.md) - [NIP-54: Wiki](54.md) +- [NIP-55: Android Signer Application](100.md) - [NIP-56: Reporting](56.md) - [NIP-57: Lightning Zaps](57.md) - [NIP-58: Badges](58.md) @@ -85,7 +86,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-96: HTTP File Storage Integration](96.md) - [NIP-98: HTTP Auth](98.md) - [NIP-99: Classified Listings](99.md) -- [NIP-100: Android Signer Application](100.md) ## Event Kinds | kind | description | NIP | From ffe8c6699b2070589d3b677dfe94b83f7714354d Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Thu, 6 Jun 2024 09:57:54 +0900 Subject: [PATCH 130/587] README: update remark --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index de85654e..18fae533 100644 --- a/README.md +++ b/README.md @@ -224,8 +224,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `AUTH` | used to send authentication challenges | [42](42.md) | | `COUNT` | used to send requested event counts to clients | [45](45.md) | -Please update these lists when proposing NIPs introducing new event kinds. - ## Standardized Tags | name | value | other parameters | NIP | @@ -277,6 +275,8 @@ Please update these lists when proposing NIPs introducing new event kinds. | `web` | webpage URL | -- | [34](34.md) | | `zap` | pubkey (hex), relay URL | weight | [57](57.md) | +Please update these lists when proposing new NIPs. + ## Criteria for acceptance of NIPs 1. They should be fully implemented in at least two clients and one relay -- when applicable. From 58e94b20ceb59326901415e2bdd678c51fab262b Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Thu, 6 Jun 2024 08:57:35 -0300 Subject: [PATCH 131/587] Revert "Simplifying reactions" This reverts commit 3834c6b60474a677b53847743212df27710e64ec. see https://github.com/nostrability/nostrability/issues/48 --- 25.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/25.md b/25.md index 698f3fb0..17c203e1 100644 --- a/25.md +++ b/25.md @@ -25,24 +25,23 @@ consider it a "+". Tags ---- -The reaction event SHOULD include `a`, `e` and `p` tags pointing to the note the user is -reacting to. The `p` tag allows authors to be notified. The `e` tags enables clients -to pull all the reactions to individual events and `a` tags enables clients to seek reactions -for all versions of a replaceable event. +The reaction event SHOULD include `e` and `p` tags from the note the user is reacting to (and optionally `a` tags if the target is a replaceable event). This allows users to be notified of reactions to posts they were mentioned in. Including the `e` tags enables clients to pull all the reactions associated with individual posts or all the posts in a thread. `a` tags enables clients to seek reactions for all versions of a replaceable event. -The `e` tag MUST be the `id` of the note that is being reacted to. +The last `e` tag MUST be the `id` of the note that is being reacted to. -The `a` tag MUST contain the coordinates (`kind:pubkey:d-tag`) of the replaceable being reacted to. +The last `p` tag MUST be the `pubkey` of the event being reacted to. -The `p` tag MUST be the `pubkey` of the event being reacted to. +The `a` tag MUST contain the coordinates (`kind:pubkey:d-tag`) of the replaceable being reacted to. -The reaction event MAY include a `k` tag with the stringified kind number -of the reacted event as its value. +The reaction event MAY include a `k` tag with the stringified kind number of the reacted event as its value. Example code ```swift func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> NostrEvent { + var tags: [[String]] = liked.tags.filter { + tag in tag.count >= 2 && (tag[0] == "e" || tag[0] == "p") + } tags.append(["e", liked.id]) tags.append(["p", liked.pubkey]) tags.append(["k", liked.kind]) From e49f1349913d657ad5177282ba20f570d55dc16a Mon Sep 17 00:00:00 2001 From: Satochip <Toporin@users.noreply.github.com> Date: Thu, 6 Jun 2024 15:11:52 +0200 Subject: [PATCH 132/587] Update README.md Correct wrng link for NIP-55 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 18fae533..87c5cb35 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-52: Calendar Events](52.md) - [NIP-53: Live Activities](53.md) - [NIP-54: Wiki](54.md) -- [NIP-55: Android Signer Application](100.md) +- [NIP-55: Android Signer Application](55.md) - [NIP-56: Reporting](56.md) - [NIP-57: Lightning Zaps](57.md) - [NIP-58: Badges](58.md) From cfcc2e48cd3555e9e458a32f816e0d1ea4994a40 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Fri, 7 Jun 2024 10:47:58 -0400 Subject: [PATCH 133/587] Defines the order of the results for NIP-50 --- 50.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/50.md b/50.md index a6e02be9..f2b7b191 100644 --- a/50.md +++ b/50.md @@ -26,6 +26,9 @@ Relays SHOULD interpret the query to the best of their ability and return events Relays SHOULD perform matching against `content` event field, and MAY perform matching against other fields if that makes sense in the context of a specific kind. +Results SHOULD be returned in the order of their matching score, not by the usual `.created_at`. +The `limit` filter SHOULD be applied after sorting by matching score. + A query string may contain `key:value` pairs (two words separated by colon), these are extensions, relays SHOULD ignore extensions they don't support. From 61ed2716a812abda1c46ff59035b69099b7078b3 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Fri, 7 Jun 2024 11:53:06 -0400 Subject: [PATCH 134/587] Update 50.md Co-authored-by: hodlbod <jstaab@protonmail.com> --- 50.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/50.md b/50.md index f2b7b191..2a31cb11 100644 --- a/50.md +++ b/50.md @@ -26,9 +26,8 @@ Relays SHOULD interpret the query to the best of their ability and return events Relays SHOULD perform matching against `content` event field, and MAY perform matching against other fields if that makes sense in the context of a specific kind. -Results SHOULD be returned in the order of their matching score, not by the usual `.created_at`. -The `limit` filter SHOULD be applied after sorting by matching score. - +Results SHOULD be returned in descending order by quality of search result (as defined by the implementation), +not by the usual `.created_at`. The `limit` filter SHOULD be applied after sorting by matching score. A query string may contain `key:value` pairs (two words separated by colon), these are extensions, relays SHOULD ignore extensions they don't support. From 9361b1817e6d81fa98d7c61ed0e778fc97ce25cf Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Fri, 7 Jun 2024 09:34:20 -0700 Subject: [PATCH 135/587] Strongly encourage marks on labels --- 32.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/32.md b/32.md index 46414736..6e6bf707 100644 --- a/32.md +++ b/32.md @@ -29,7 +29,9 @@ This is a way of attaching standard nostr tags to events, pubkeys, relays, urls, Label Tag ---- -An `l` tag's value can be any string. If using an `L` tag, `l` tags MUST include a `mark` matching an `L` tag value in the same event. +An `l` tag's value can be any string. If using an `L` tag, `l` tags MUST include a mark matching an `L` +tag value in the same event. If no `L` tag is included, a mark SHOULD still be included. If none is +included, `ugc` is implied. Label Target ---- From 9e223f3bffd720f882a65ddc96a2c85739b5f252 Mon Sep 17 00:00:00 2001 From: Alex Gleason <alex@alexgleason.me> Date: Fri, 7 Jun 2024 12:37:29 -0500 Subject: [PATCH 136/587] NIP-09: clarify "a" tag deletions --- 09.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/09.md b/09.md index fbbd6e13..5e79ac23 100644 --- a/09.md +++ b/09.md @@ -32,6 +32,8 @@ Relays SHOULD delete or stop publishing any referenced events that have an ident Relays 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. +When an `a` tag is used, relays SHOULD delete all versions of the replaceable event up to the `created_at` timestamp of the deletion event. + ## Client Usage Clients 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. From c30971ff0c79da57dd011df9906ae0a4ad487aca Mon Sep 17 00:00:00 2001 From: "P. Reis" <patrickpereirareal1@gmail.com> Date: Fri, 7 Jun 2024 18:44:33 -0300 Subject: [PATCH 137/587] NIP-57: Clarify description tag --- 57.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/57.md b/57.md index 6d896206..d04eeff1 100644 --- a/57.md +++ b/57.md @@ -131,7 +131,7 @@ The following should be true of the `zap receipt` event: - The `created_at` date SHOULD be set to the invoice `paid_at` date for idempotency. - `tags` MUST include the `p` tag (zap recipient) AND optional `e` tag from the `zap request` AND optional `a` tag from the `zap request` AND optional `P` tag from the pubkey of the zap request (zap sender). - The `zap receipt` MUST have a `bolt11` tag containing the description hash bolt11 invoice. -- The `zap receipt` MUST contain a `description` tag which is the JSON-encoded invoice description. +- The `zap receipt` MUST contain a `description` tag which is the JSON-encoded zap request. - `SHA256(description)` MUST match the description hash in the bolt11 invoice. - The `zap receipt` MAY contain a `preimage` tag to match against the payment hash of the bolt11 invoice. This isn't really a payment proof, there is no real way to prove that the invoice is real or has been paid. You are trusting the author of the `zap receipt` for the legitimacy of the payment. From ee114a1dacf85133f80ffd54f68eae46cd95e67d Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Sat, 8 Jun 2024 23:05:18 +0900 Subject: [PATCH 138/587] README: remove `l` tag annotations --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 87c5cb35..99c42453 100644 --- a/README.md +++ b/README.md @@ -235,7 +235,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `g` | geohash | -- | [52](52.md) | | `i` | identity | proof | [39](39.md) | | `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) | -| `l` | label, label namespace | annotations | [32](32.md) | +| `l` | label, label namespace | -- | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | | `m` | MIME type | -- | [94](94.md) | | `q` | event id (hex) | relay URL | [18](18.md) | From df05c19980f6d1639918132ae2095bdc8aa4c524 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Sun, 9 Jun 2024 23:19:04 +0900 Subject: [PATCH 139/587] BREAKING.md: add changes --- BREAKING.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/BREAKING.md b/BREAKING.md index 720d27b1..c8255cdc 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -5,7 +5,10 @@ reverse chronological order. | Date | Commit | NIP | Change | | ----------- | --------- | -------- | ------ | +| 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 | +| 2024-06-06 | [a6dfc7b5](https://github.com/nostr-protocol/nips/commit/a6dfc7b5) | [NIP-55](55.md) | NIP number was changed | | 2024-05-25 | [5d1d1c17](https://github.com/nostr-protocol/nips/commit/5d1d1c17) | [NIP-71](71.md) | 'aes-256-gcm' tag was removed | +| 2024-05-07 | [8073c848](https://github.com/nostr-protocol/nips/commit/8073c848) | [NIP-25](25.md) | e-tags were changed to not include entire thread | | 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) | | 2024-02-25 | [4a171cb0](https://github.com/nostr-protocol/nips/commit/4a171cb0) | [NIP-18](18.md) | quote repost should use `q` tag | | 2024-02-21 | [c6cd655c](https://github.com/nostr-protocol/nips/commit/c6cd655c) | [NIP-46](46.md) | Params were stringified | @@ -20,8 +23,9 @@ reverse chronological order. | 2023-12-27 | [17c67ef5](https://github.com/nostr-protocol/nips/commit/17c67ef5) | [NIP-94](94.md) | 'aes-256-gcm' tag was removed | | 2023-12-03 | [0ba45895](https://github.com/nostr-protocol/nips/commit/0ba45895) | [NIP-01](01.md) | WebSocket status code `4000` was replaced by 'CLOSED' message | | 2023-11-28 | [6de35f9e](https://github.com/nostr-protocol/nips/commit/6de35f9e) | [NIP-89](89.md) | 'client' tag value was changed | -| 2023-11-20 | [7822a8b1](https://github.com/nostr-protocol/nips/commit/7822a8b1) | [NIP-51](51.md) | `kind: 30000` and `kind: 30001` were deprecated | +| 2023-11-20 | [7822a8b1](https://github.com/nostr-protocol/nips/commit/7822a8b1) | [NIP-51](51.md) | `kind: 30000` and `kind: 30001` were deprecated | | 2023-11-11 | [cbdca1e9](https://github.com/nostr-protocol/nips/commit/cbdca1e9) | [NIP-84](84.md) | 'range' tag was removed | +| 2023-11-10 | [c945d8bd](https://github.com/nostr-protocol/nips/commit/c945d8bd) | [NIP-32](32.md) | 'l' tag annotations was removed | | 2023-11-07 | [108b7f16](https://github.com/nostr-protocol/nips/commit/108b7f16) | [NIP-01](01.md) | 'OK' message must have 4 items | | 2023-10-17 | [cf672b76](https://github.com/nostr-protocol/nips/commit/cf672b76) | [NIP-03](03.md) | 'block' tag was removed | | 2023-09-29 | [7dc6385f](https://github.com/nostr-protocol/nips/commit/7dc6385f) | [NIP-57](57.md) | optional 'a' tag was included in `zap receipt` | @@ -34,10 +38,10 @@ reverse chronological order. | 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [NIP-33](33.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | | 2023-08-11 | [d87f8617](https://github.com/nostr-protocol/nips/commit/d87f8617) | [NIP-25](25.md) | empty `content` should be considered as "+" | | 2023-08-01 | [5d63b157](https://github.com/nostr-protocol/nips/commit/5d63b157) | [NIP-57](57.md) | 'zap' tag was changed | -| 2023-07-15 | [d1814405](https://github.com/nostr-protocol/nips/commit/d1814405) | [NIP-01](01.md) | `since` and `until` filters should be `since <= created_at <= until` | +| 2023-07-15 | [d1814405](https://github.com/nostr-protocol/nips/commit/d1814405) | [NIP-01](01.md) | `since` and `until` filters should be `since <= created_at <= until` | | 2023-07-12 | [a1cd2bd8](https://github.com/nostr-protocol/nips/commit/a1cd2bd8) | [NIP-25](25.md) | custom emoji was supported | | 2023-06-18 | [83cbd3e1](https://github.com/nostr-protocol/nips/commit/83cbd3e1) | [NIP-11](11.md) | 'image' was renamed to 'icon' | -| 2023-04-13 | [bf0a0da6](https://github.com/nostr-protocol/nips/commit/bf0a0da6) | [NIP-15](15.md) | different NIP was re-added as NIP-15 | +| 2023-04-13 | [bf0a0da6](https://github.com/nostr-protocol/nips/commit/bf0a0da6) | [NIP-15](15.md) | different NIP was re-added as NIP-15 | | 2023-04-09 | [fb5b7c73](https://github.com/nostr-protocol/nips/commit/fb5b7c73) | [NIP-15](15.md) | NIP-15 was merged into NIP-01 | | 2023-03-15 | [e1004d3d](https://github.com/nostr-protocol/nips/commit/e1004d3d) | [NIP-19](19.md) | `1: relay` was changed to optionally | @@ -47,3 +51,4 @@ Breaking changes prior to 2023-03-01 are not yet documented. - If it isn't clear that a change is breaking or not, we list it. - The date is the date it was merged, not necessarily the date of the commit. + From 326ad34690c707b983a28524d85d8da3441ca7b3 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Thu, 13 Jun 2024 21:02:35 +0900 Subject: [PATCH 140/587] NIP-24: fix missing rename --- 24.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/24.md b/24.md index b21f48e9..3adec243 100644 --- a/24.md +++ b/24.md @@ -28,7 +28,7 @@ These are fields that should be ignored or removed when found in the wild: kind 3 ====== -These are extra fields not specified in NIP-02 that may be present in the stringified JSON of contacts events: +These are extra fields not specified in NIP-02 that may be present in the stringified JSON of follow events: ### Deprecated fields From 2a8597b32dccd9b57f4a698b479e808a0625f69e Mon Sep 17 00:00:00 2001 From: Arman The Parman <77603167+ArmanTheParman@users.noreply.github.com> Date: Sat, 15 Jun 2024 19:34:47 +1000 Subject: [PATCH 141/587] Update 01.md Small grammatical change for easier reading --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index b51fdf0e..cdd8b908 100644 --- a/01.md +++ b/01.md @@ -43,7 +43,7 @@ To obtain the `event.id`, we `sha256` the serialized event. The serialization is ``` To prevent implementation differences from creating a different event ID for the same event, the following rules MUST be followed while serializing: -- No whitespace, line breaks or other unnecessary formatting should be included in the output JSON. +- Whitespace, line breaks or other unnecessary formatting should not be included in the output JSON. - No characters except the following should be escaped, and instead should be included verbatim: - A line break, `0x0A`, as `\n` - A double quote, `0x22`, as `\"` From a52d170c8cc5c99cf658d184922dcfe4e8177660 Mon Sep 17 00:00:00 2001 From: Arman The Parman <77603167+ArmanTheParman@users.noreply.github.com> Date: Sun, 16 Jun 2024 19:20:00 +1000 Subject: [PATCH 142/587] Update 01.md This is not a correction but a suggestion... When I first read it, it wasn't clear that metadata is specifically for a user and not inclusive of other things (eg not metadata about a photo). Adding this one extra word here would have helped me understand that immediately. --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index cdd8b908..d47c2619 100644 --- a/01.md +++ b/01.md @@ -87,7 +87,7 @@ As a convention, all single-letter (only english alphabet letters: a-z, A-Z) key Kinds specify how clients should interpret the meaning of each event and the other fields of each event (e.g. an `"r"` tag may have a meaning in an event of kind 1 and an entirely different meaning in an event of kind 10002). Each NIP may define the meaning of a set of kinds that weren't defined elsewhere. This NIP defines two basic kinds: -- `0`: **metadata**: the `content` is set to a stringified JSON object `{name: <username>, about: <string>, picture: <url, string>}` describing the user who created the event. [Extra metadata fields](24.md#kind-0) may be set. A relay may delete older events once it gets a new one for the same pubkey. +- `0`: **user's metadata**: the `content` is set to a stringified JSON object `{name: <username>, about: <string>, picture: <url, string>}` describing the user who created the event. [Extra metadata fields](24.md#kind-0) may be set. A relay may delete older events once it gets a new one for the same pubkey. - `1`: **text note**: the `content` is set to the **plaintext** content of a note (anything the user wants to say). Content that must be parsed, such as Markdown and HTML, should not be used. Clients should also not parse content as those. And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: From 9d8be011c75e8efc7f8a255b9a503571c63f576a Mon Sep 17 00:00:00 2001 From: Arman The Parman <77603167+ArmanTheParman@users.noreply.github.com> Date: Sun, 16 Jun 2024 23:38:14 +1000 Subject: [PATCH 143/587] Update README.md Changed Metadata to User's Metadata, to reduce ambiguity. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 99c42453..067c4367 100644 --- a/README.md +++ b/README.md @@ -90,7 +90,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos ## Event Kinds | kind | description | NIP | | ------------- | -------------------------- | ------------------------ | -| `0` | Metadata | [01](01.md) | +| `0` | User's Metadata | [01](01.md) | | `1` | Short Text Note | [01](01.md) | | `2` | Recommend Relay | 01 (deprecated) | | `3` | Follows | [02](02.md) | From 4f787adcd1cf23ec4d395b26c3a54cd1188fef49 Mon Sep 17 00:00:00 2001 From: Arman The Parman <77603167+ArmanTheParman@users.noreply.github.com> Date: Sun, 16 Jun 2024 23:42:45 +1000 Subject: [PATCH 144/587] Update 05.md Changed metadata to user's metadata --- 05.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/05.md b/05.md index 405078a4..f3a051c7 100644 --- a/05.md +++ b/05.md @@ -6,11 +6,11 @@ Mapping Nostr keys to DNS-based internet identifiers `final` `optional` -On events of kind `0` (`metadata`) one can specify the key `"nip05"` with an [internet identifier](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) (an email-like address) as the value. Although there is a link to a very liberal "internet identifier" specification above, NIP-05 assumes the `<local-part>` part will be restricted to the characters `a-z0-9-_.`, case-insensitive. +On events of kind `0` (`user's metadata`) one can specify the key `"nip05"` with an [internet identifier](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) (an email-like address) as the value. Although there is a link to a very liberal "internet identifier" specification above, NIP-05 assumes the `<local-part>` part will be restricted to the characters `a-z0-9-_.`, case-insensitive. Upon seeing that, the client splits the identifier into `<local-part>` and `<domain>` and use these values to make a GET request to `https://<domain>/.well-known/nostr.json?name=<local-part>`. -The result should be a JSON document object with a key `"names"` that should then be a mapping of names to hex formatted public keys. If the public key for the given `<name>` matches the `pubkey` from the `metadata` event, the client then concludes that the given pubkey can indeed be referenced by its identifier. +The result should be a JSON document object with a key `"names"` that should then be a mapping of names to hex formatted public keys. If the public key for the given `<name>` matches the `pubkey` from the `user's metadata` event, the client then concludes that the given pubkey can indeed be referenced by its identifier. ### Example From c576737ba42772a561c6ebfd9faf0baae6d19b17 Mon Sep 17 00:00:00 2001 From: Arman The Parman <77603167+ArmanTheParman@users.noreply.github.com> Date: Mon, 17 Jun 2024 05:33:49 +1000 Subject: [PATCH 145/587] parentheses > commas (#1308) * Update 01.md A few small changes that can potentially help a broader audience (non-developers) follow the meaning. * monospace hex Co-authored-by: Asai Toshiya <to.asai.60@gmail.com> --------- Co-authored-by: fiatjaf_ <fiatjaf@gmail.com> Co-authored-by: Asai Toshiya <to.asai.60@gmail.com> --- 01.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/01.md b/01.md index cdd8b908..aa7fda29 100644 --- a/01.md +++ b/01.md @@ -43,16 +43,16 @@ To obtain the `event.id`, we `sha256` the serialized event. The serialization is ``` To prevent implementation differences from creating a different event ID for the same event, the following rules MUST be followed while serializing: -- Whitespace, line breaks or other unnecessary formatting should not be included in the output JSON. -- No characters except the following should be escaped, and instead should be included verbatim: - - A line break, `0x0A`, as `\n` - - A double quote, `0x22`, as `\"` - - A backslash, `0x5C`, as `\\` - - A carriage return, `0x0D`, as `\r` - - A tab character, `0x09`, as `\t` - - A backspace, `0x08`, as `\b` - - A form feed, `0x0C`, as `\f` - UTF-8 should be used for encoding. +- Whitespace, line breaks or other unnecessary formatting should not be included in the output JSON. +- The following characters in the content field must be escaped as shown, and all other characters must be included verbatim: + - A line break (`0x0A`), use `\n` + - A double quote (`0x22`), use `\"` + - A backslash (`0x5C`), use `\\` + - A carriage return (`0x0D`), use `\r` + - A tab character (`0x09`), use `\t` + - A backspace, (`0x08`), use `\b` + - A form feed, (`0x0C`), use `\f` ### Tags From 13b830d228b122b29f9d96a3bf10601406ddd646 Mon Sep 17 00:00:00 2001 From: Oscar Merry <oscardmerry@gmail.com> Date: Mon, 17 Jun 2024 13:45:06 +0100 Subject: [PATCH 146/587] Add Optional URL Hints --- XX.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/XX.md b/XX.md index 4b51c67f..636629d9 100644 --- a/XX.md +++ b/XX.md @@ -32,4 +32,16 @@ Book ISBNs MUST be referenced _**without hyphens**_ as many book search APIs ret - Movie ISAN: `["i", "isan:0000-0000-401A-0000-7"]` - https://web.isan.org/public/en/isan/0000-0000-401A-0000-7 -Movie 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 \ No newline at end of file +Movie 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 + +--- + +### Optional URL Hints + +Each `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: + +`["i", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f", https://fountain.fm/episode/z1y9TMQRuqXl2awyrQxg]` + +`["i", "isan:0000-0000-401A-0000-7", https://www.imdb.com/title/tt0120737]` + + From 1728f93d17fe399fa6e0911e7bb69d2e159ca572 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Mon, 17 Jun 2024 12:38:57 -0300 Subject: [PATCH 147/587] "user metadata" and fix table on readme. --- 01.md | 2 +- 05.md | 2 +- README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/01.md b/01.md index 94db77a6..60d97853 100644 --- a/01.md +++ b/01.md @@ -87,7 +87,7 @@ As a convention, all single-letter (only english alphabet letters: a-z, A-Z) key Kinds specify how clients should interpret the meaning of each event and the other fields of each event (e.g. an `"r"` tag may have a meaning in an event of kind 1 and an entirely different meaning in an event of kind 10002). Each NIP may define the meaning of a set of kinds that weren't defined elsewhere. This NIP defines two basic kinds: -- `0`: **user's metadata**: the `content` is set to a stringified JSON object `{name: <username>, about: <string>, picture: <url, string>}` describing the user who created the event. [Extra metadata fields](24.md#kind-0) may be set. A relay may delete older events once it gets a new one for the same pubkey. +- `0`: **user metadata**: the `content` is set to a stringified JSON object `{name: <username>, about: <string>, picture: <url, string>}` describing the user who created the event. [Extra metadata fields](24.md#kind-0) may be set. A relay may delete older events once it gets a new one for the same pubkey. - `1`: **text note**: the `content` is set to the **plaintext** content of a note (anything the user wants to say). Content that must be parsed, such as Markdown and HTML, should not be used. Clients should also not parse content as those. And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: diff --git a/05.md b/05.md index f3a051c7..a1d488df 100644 --- a/05.md +++ b/05.md @@ -6,7 +6,7 @@ Mapping Nostr keys to DNS-based internet identifiers `final` `optional` -On events of kind `0` (`user's metadata`) one can specify the key `"nip05"` with an [internet identifier](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) (an email-like address) as the value. Although there is a link to a very liberal "internet identifier" specification above, NIP-05 assumes the `<local-part>` part will be restricted to the characters `a-z0-9-_.`, case-insensitive. +On events of kind `0` (`user metadata`) one can specify the key `"nip05"` with an [internet identifier](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) (an email-like address) as the value. Although there is a link to a very liberal "internet identifier" specification above, NIP-05 assumes the `<local-part>` part will be restricted to the characters `a-z0-9-_.`, case-insensitive. Upon seeing that, the client splits the identifier into `<local-part>` and `<domain>` and use these values to make a GET request to `https://<domain>/.well-known/nostr.json?name=<local-part>`. diff --git a/README.md b/README.md index 067c4367..02773a5d 100644 --- a/README.md +++ b/README.md @@ -90,7 +90,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos ## Event Kinds | kind | description | NIP | | ------------- | -------------------------- | ------------------------ | -| `0` | User's Metadata | [01](01.md) | +| `0` | User Metadata | [01](01.md) | | `1` | Short Text Note | [01](01.md) | | `2` | Recommend Relay | 01 (deprecated) | | `3` | Follows | [02](02.md) | From 08657b3bc17b2ce0076905d07eea9b214060e222 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Fri, 21 Jun 2024 12:52:26 +0900 Subject: [PATCH 148/587] NIP-28: simplify and fix kind 41 --- 28.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/28.md b/28.md index 65ebb3ff..16320880 100644 --- a/28.md +++ b/28.md @@ -37,7 +37,7 @@ In the channel creation `content` field, Client SHOULD include basic channel met Update a channel's public metadata. -Clients and relays SHOULD handle kind 41 events similar to kind 33 replaceable events, where the information is used to update the metadata, without modifying the event id for the channel.Only the most recent kind 41 is needed to be stored. +Kind 41 is used to update the metadata without modifying the event id for the channel. Only the most recent kind 41 per `e` tag value MAY be available. Clients SHOULD ignore kind 41s from pubkeys other than the kind 40 pubkey. From 32b9f3f40f2b7842fbcad08a041d9a2205b23de8 Mon Sep 17 00:00:00 2001 From: Roland Bewick <roland.bewick@gmail.com> Date: Fri, 21 Jun 2024 17:22:32 +0700 Subject: [PATCH 149/587] feat: NIP-47 notifications --- 47.md | 128 ++++++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 116 insertions(+), 12 deletions(-) diff --git a/47.md b/47.md index 90338477..97b06ab3 100644 --- a/47.md +++ b/47.md @@ -8,32 +8,42 @@ Nostr Wallet Connect ## Rationale -This NIP describes a way for clients to access a remote Lightning wallet through a standardized protocol. Custodians may implement this, or the user may run a bridge that bridges their wallet/node and the Nostr Wallet Connect protocol. +This NIP describes a way for clients to access a remote lightning wallet through a standardized protocol. Custodians may implement this, or the user may run a bridge that bridges their wallet/node and the Nostr Wallet Connect protocol. ## Terms -* **client**: Nostr app on any platform that wants to pay Lightning invoices. -* **user**: The person using the **client**, and want's to connect their wallet app to their **client**. +* **client**: Nostr app on any platform that wants to interact with a lightning wallet. +* **user**: The person using the **client**, and wants to connect their wallet to their **client**. * **wallet service**: Nostr app that typically runs on an always-on computer (eg. in the cloud or on a Raspberry Pi). This app has access to the APIs of the wallets it serves. ## Theory of Operation - 1. **Users** who wish to use this NIP to send lightning payments to other nostr users must first acquire a special "connection" URI from their NIP-47 compliant wallet application. The wallet application may provide this URI using a QR screen, or a pasteable string, or some other means. + 1. **Users** who wish to use this NIP to allow **client(s)** to interact with their wallet must first acquire a special "connection" URI from their NIP-47 compliant wallet application. The wallet application may provide this URI using a QR screen, or a pasteable string, or some other means. - 2. The **user** should then copy this URI into their **client(s)** by pasting, or scanning the QR, etc. The **client(s)** should save this URI and use it later whenever the **user** makes a payment. The **client** should then request an `info` (13194) event from the relay(s) specified in the URI. The **wallet service** will have sent that event to those relays earlier, and the relays will hold it as a replaceable event. + 2. The **user** should then copy this URI into their **client(s)** by pasting, or scanning the QR, etc. The **client(s)** should save this URI and use it later whenever the **user** (or the **client** on the user's behalf) wants to interact with the wallet. The **client** should then request an `info` (13194) event from the relay(s) specified in the URI. The **wallet service** will have sent that event to those relays earlier, and the relays will hold it as a replaceable event. 3. When the **user** initiates a payment their nostr **client** create a `pay_invoice` request, encrypts it using a token from the URI, and sends it (kind 23194) to the relay(s) specified in the connection URI. The **wallet service** will be listening on those relays and will decrypt the request and then contact the **user's** wallet application to send the payment. The **wallet service** will know how to talk to the wallet application because the connection URI specified relay(s) that have access to the wallet app API. - 4. Once the payment is complete the **wallet service** will send an encrypted `response` (kind 23195) to the **user** over the relay(s) in the URI. + 4. Once the payment is complete the **wallet service** will send an encrypted `response` (kind 23195) to the **user** over the relay(s) in the URI. + + 5. The **wallet service** may send encrypted notifications (kind 23196) of wallet events (such as a received payment) to the **client**. ## Events -There are three event kinds: +There are four event kinds: - `NIP-47 info event`: 13194 - `NIP-47 request`: 23194 - `NIP-47 response`: 23195 +- `NIP-47 notification event`: 23196 -The info event should be a replaceable event that is published by the **wallet service** on the relay to indicate which commands it supports. The content should be -a plaintext string with the supported commands, space-separated, eg. `pay_invoice get_balance`. Only the `pay_invoice` command is described in this NIP, but other commands might be defined in different NIPs. +### Info Event + +The info event should be a replaceable event that is published by the **wallet service** on the relay to indicate which capabilities it supports. + +The content should be a plaintext string with the supported capabilities space-separated, eg. `pay_invoice get_balance notifications`. + +If the **wallet service** supports notifications, the info event SHOULD contain a `notifications` tag with the supported notification types space-separated, eg. `payment_received payment_sent`. + +### Request and Response Events Both 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. Optionally, 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. @@ -68,6 +78,22 @@ The `result_type` field MUST contain the name of the method that this event is r The `error` field MUST contain a `message` field with a human readable error message and a `code` field with the error code if the command was not successful. If the command was successful, the `error` field must be null. +### Notification Events + +The notification event SHOULD contain one `p` tag, the public key of the **user**. + +The content of notifications 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: + +```jsonc +{ + "notification_type": "payment_received", //indicates the structure of the notification field + "notification": { + "payment_hash": "0123456789abcdef..." // notification-related data + } +} +``` + + ### Error codes - `RATE_LIMITED`: The client is sending commands too fast. It should retry in a few seconds. - `NOT_IMPLEMENTED`: The command is not known or is intentionally not implemented. @@ -120,7 +146,8 @@ Response: { "result_type": "pay_invoice", "result": { - "preimage": "0123456789abcdef..." // preimage of the payment + "preimage": "0123456789abcdef...", // preimage of the payment + "fees_paid": 123, // value in msats, optional } } ``` @@ -155,7 +182,8 @@ payment hash of the invoice should be used. { "result_type": "multi_pay_invoice", "result": { - "preimage": "0123456789abcdef..." // preimage of the payment + "preimage": "0123456789abcdef...", // preimage of the payment + "fees_paid": 123, // value in msats, optional } } ``` @@ -189,6 +217,7 @@ Response: "result_type": "pay_keysend", "result": { "preimage": "0123456789abcdef...", // preimage of the payment + "fees_paid": 123, // value in msats, optional } } ``` @@ -225,7 +254,8 @@ pubkey should be used. { "result_type": "multi_pay_keysend", "result": { - "preimage": "0123456789abcdef..." // preimage of the payment + "preimage": "0123456789abcdef...", // preimage of the payment + "fees_paid": 123, // value in msats, optional } } ``` @@ -396,6 +426,59 @@ Response: "block_height": 1, "block_hash": "hex string", "methods": ["pay_invoice", "get_balance", "make_invoice", "lookup_invoice", "list_transactions", "get_info"], // list of supported methods for this connection + "notifications": ["payment_received", "payment_sent"], // list of supported notifications for this connection, optional. + } +} +``` + +## Notifications + +### `payment_received` + +Description: A payment was successfully received by the wallet. + +Notification: +```jsonc +{ + "notification_type": "payment_received", + "notification": { + "type": "incoming", + "invoice": "string", // encoded invoice + "description": "string", // invoice's description, optional + "description_hash": "string", // invoice's description hash, optional + "preimage": "string", // payment's preimage + "payment_hash": "string", // Payment hash for the payment + "amount": 123, // value in msats + "fees_paid": 123, // value in msats + "created_at": unixtimestamp, // invoice/payment creation time + "expires_at": unixtimestamp, // invoice expiration time, optional if not applicable + "settled_at": unixtimestamp, // invoice/payment settlement time + "metadata": {} // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc. + } +} +``` + +### `payment_sent` + +Description: A payment was successfully sent by the wallet. + +Notification: +```jsonc +{ + "notification_type": "payment_sent", + "notification": { + "type": "outgoing", + "invoice": "string", // encoded invoice + "description": "string", // invoice's description, optional + "description_hash": "string", // invoice's description hash, optional + "preimage": "string", // payment's preimage + "payment_hash": "string", // Payment hash for the payment + "amount": 123, // value in msats + "fees_paid": 123, // value in msats + "created_at": unixtimestamp, // invoice/payment creation time + "expires_at": unixtimestamp, // invoice expiration time, optional if not applicable + "settled_at": unixtimestamp, // invoice/payment settlement time + "metadata": {} // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc. } } ``` @@ -409,3 +492,24 @@ Response: ## Using a dedicated relay This NIP does not specify any requirements on the type of relays used. However, if the user is using a custodial service it might make sense to use a relay that is hosted by the custodial service. The relay may then enforce authentication to prevent metadata leaks. Not depending on a 3rd party relay would also improve reliability in this case. + +## Appendix + +### Example NIP-47 info event + +```jsonc +{ + "id": "df467db0a9f9ec77ffe6f561811714ccaa2e26051c20f58f33c3d66d6c2b4d1c", + "pubkey": "c04ccd5c82fc1ea3499b9c6a5c0a7ab627fbe00a0116110d4c750faeaecba1e2", + "created_at": 1713883677, + "kind": 13194, + "tags": [ + [ + "notifications", + "payment_received payment_sent" + ] + ], + "content": "pay_invoice pay_keysend get_balance get_info make_invoice lookup_invoice list_transactions multi_pay_invoice multi_pay_keysend sign_message notifications", + "sig": "31f57b369459b5306a5353aa9e03be7fbde169bc881c3233625605dd12f53548179def16b9fe1137e6465d7e4d5bb27ce81fd6e75908c46b06269f4233c845d8" +} +``` From 4aa18e329a8858ed46727b970c28652c5a0f7b43 Mon Sep 17 00:00:00 2001 From: Arjen Stens <18398758+ArjenStens@users.noreply.github.com> Date: Sun, 23 Jun 2024 02:40:57 +0200 Subject: [PATCH 150/587] Clarify which kinds have lifetime of 'regular' (#1315) * Clarify which kinds have lifetime of 'regular' * Missed space * Document kind 41 as replaceable * Revert "Document kind 41 as replaceable" This reverts commit eead2f5a749cfee6de131944e0e73350759e28b4. --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 60d97853..c11a0954 100644 --- a/01.md +++ b/01.md @@ -92,7 +92,7 @@ Kinds specify how clients should interpret the meaning of each event and the oth And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: -- for kind `n` such that `1000 <= n < 10000`, events are **regular**, which means they're all expected to be stored by relays. +- 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. - 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. - for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. - 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. From 70f1be5866a69768e4cc63447e2268a15e70ad3f Mon Sep 17 00:00:00 2001 From: abhay-raizada <toabhayraizada@gmail.com> Date: Tue, 25 Jun 2024 14:08:23 +0530 Subject: [PATCH 151/587] Polls On Nostr --- 118.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 118.md diff --git a/118.md b/118.md new file mode 100644 index 00000000..86201c6d --- /dev/null +++ b/118.md @@ -0,0 +1,36 @@ +# NIP-118 + +## Polls + +`draft` `optional` + +The purpose of this nip is to create a mechanism for polling on nostr. +The NIP aims to have the following properties. + +1. Provide a method for gauging eligibility. Only eligible votes should be counted. +2. Provide a method for maintaining anonymity. Participants should be able to not reveal their identities to everyone, yet their votes should be counted. +3. Provide a mechanism for verifiability. Participants should be able to verify that their votes have been counted, under an eligibility criteria. + +## Events + +### Poll Content + +The poll event is defined as a `kind:1068` event. This event carries over the `name` , `description` and `field` tags as defined in [nip-101](https://github.com/nostr-protocol/nips/pull/1190/files). +This event has no other tags and completely defines the poll content, which is uneditable. + +### Responses + +The response event is the same as the one on [nip-101](https://github.com/nostr-protocol/nips/pull/1190/files) + +### Eligibilty + +Eligibility to a vote is determined by another `kind:30180` event that can be created by anyone and is essentially a reference to a list of pubkeys, the author of the eligibility event is interested in. The eligibility event MUST contain an "e" tag to the poll event, and +"list" tags which references either a `kind:3` (contact list) or a `kind:30000`(follow sets) containing a list of "p" tags. + +### Counting Results. + +Results can be counted for different eligibility events, by querying for `kind:1069` events only authored by the pubkeys mentioned in the eligibility event. + +### Anonymous Voting + +For people that wish to maintain anonymity, while still having their votes counted can do so by signing the response event with a random private key and sending over the corresponding pubkey to the author of a `kind:30180` eligibility event. The author of the eligibility event may demand "proofs of eligibility" before adding the pubkey in any of the lists. From a551c5b69337021f83f7886ecfd211915737a771 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Wed, 26 Jun 2024 00:12:58 +0900 Subject: [PATCH 152/587] NIP-89: fix `REQ` examples --- 89.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/89.md b/89.md index 43d197fc..54aa30bc 100644 --- a/89.md +++ b/89.md @@ -116,7 +116,7 @@ User B might see in their timeline an event referring to a `kind:31337` event (e User 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`: ```json -["REQ", <id>, '[{ "kinds": [31989], "#d": ["31337"], 'authors': [<user>, <users-contact-list>] }]'] +["REQ", <id>, { "kinds": [31989], "#d": ["31337"], "authors": [<user>, <users-contact-list>] }] ``` User B, who follows User A, sees that `kind:31989` event and fetches the `a`-tagged event for the app and handler information. @@ -127,5 +127,5 @@ User B's client sees the application's `kind:31990` which includes the informati Alternatively, 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. ```json -["REQ", <id>, '[{ "kinds": [31990], "#k": [<desired-event-kind>], 'authors': [...] }]'] +["REQ", <id>, { "kinds": [31990], "#k": [<desired-event-kind>], "authors": [...] }] ``` From f57d559dc08bf4b59ddefe9416f7569f751f75dd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20Calder=C3=B3n?= <fjcalderon@gmail.com> Date: Thu, 27 Jun 2024 11:31:34 -0300 Subject: [PATCH 153/587] Proposal of a very simple spec for p2p events --- xx.md | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 xx.md diff --git a/xx.md b/xx.md new file mode 100644 index 00000000..2ab8fc4e --- /dev/null +++ b/xx.md @@ -0,0 +1,77 @@ +# NIP-XX + +## Peer-to-peer messages + +`draft` `optional` + +## Abstract + +Peer-to-peer (P2P) platforms have seen an upturn in recent years, while having more and more options is positive, in the specific case of p2p, having several options contributes to the liquidity split, meaning sometimes there's not enough assets available for trading. If we combine all these individual solutions into one big pool of orders, it will make them much more competitive compared to centralized systems, where a single authority controls the liquidity. + +This NIP defines a simple standard for peer-to-peer messages, which enables the creation of a big liquidity pool for all p2p platforms participating. + +## The event + +Events are [Parameterized Replaceable Events](https://github.com/nostr-protocol/nips/blob/master/01.md#kinds) and use `38383` as event kind, a p2p event look like this: + +```json +[ + "EVENT", + "RAND", + { + "id": "84fad0d29cb3529d789faeff2033e88fe157a48e071c6a5d1619928289420e31", + "pubkey": "dbe0b1be7aafd3cfba92d7463edbd4e33b2969f61bd554d37ac56f032e13355a", + "created_at": 1702548701, + "kind": 38383, + "tags": [ + ["d", "ede61c96-4c13-4519-bf3a-dcf7f1e9d842"], + ["k", "sell"], + ["f", "VES"], + ["s", "pending"], + ["amt", "0"], + ["fa", "100"], + ["pm", "face to face"], + ["premium", "1"], + [ + "rating", + "{\"total_reviews\":1,\"total_rating\":3.0,\"last_rating\":3,\"max_rate\":5,\"min_rate\":1}" + ], + ["network", "lightning"], + ["expiration", "1719391096"], + ["y", "mostrop2p"], + ["z", "order"] + ], + "content": "", + "sig": "7e8fe1eb644f33ff51d8805c02a0e1a6d034e6234eac50ef7a7e0dac68a0414f7910366204fa8217086f90eddaa37ded71e61f736d1838e37c0b73f6a16c4af2" + } +] +``` + +## Tags + +- `d` Order ID: A unique identifier for the order. +- `k` Order type: `sell` or `buy`. +- `f` Currency: The asset being traded, using the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) standard. +- `s` Status: `pending`, `canceled`, `in-progress`, `success`. +- `amt` Amount: The amount of Bitcoin to be traded, the amount is defined in satoshis, if `0` means that the amount of satoshis will be obtained from a public API after the taker accepts the order. +- `fa` Fiat amount: The fiat amount being traded, for range orders two values are expected, the minimum and maximum amount. +- `pm` Payment method: The payment method used for the trade. +- `premium` Premium: The percentage of the premium the maker is willing to pay. +- `rating` Rating: The rating of the maker, this document does not define how the rating is calculated, it's up to the platform to define it. +- `n` Network: The network used for the trade, it can be `lightning`, `liquid`, `onchain`, etc. +- `expiration` Expiration: The expiration date of the order ([NIP-40](https://github.com/nostr-protocol/nips/blob/master/40.md)). +- `y` Platform: The platform that created the order. +- `z` Order type: `order`. + +## Implementations + +Currently implemented on the following platforms: + +- [Mostro](https://github.com/MostroP2P/mostro) +- [@lnp2pBot](https://github.com/lnp2pBot/bot) + +## References + +- [Mostro messages specification](https://mostro.network/messages/) +- [Messages specification for peer 2 peer NIP proposal](https://github.com/nostr-protocol/nips/blob/8250274a22f4882f621510df0054fd6167c10c9e/31001.md) +- [n3xB](https://github.com/nobu-maeda/n3xb) From df977f3874a98783633968ddd9e783b81e3c0ec1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20Calder=C3=B3n?= <fjcalderon@gmail.com> Date: Thu, 27 Jun 2024 11:40:56 -0300 Subject: [PATCH 154/587] Add source tag --- xx.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/xx.md b/xx.md index 2ab8fc4e..16a08934 100644 --- a/xx.md +++ b/xx.md @@ -36,9 +36,10 @@ Events are [Parameterized Replaceable Events](https://github.com/nostr-protocol/ "rating", "{\"total_reviews\":1,\"total_rating\":3.0,\"last_rating\":3,\"max_rate\":5,\"min_rate\":1}" ], + ["source", "https://t.me/p2plightning/xxxxxxx"], ["network", "lightning"], ["expiration", "1719391096"], - ["y", "mostrop2p"], + ["y", "lnp2pbot"], ["z", "order"] ], "content": "", @@ -57,6 +58,7 @@ Events are [Parameterized Replaceable Events](https://github.com/nostr-protocol/ - `fa` Fiat amount: The fiat amount being traded, for range orders two values are expected, the minimum and maximum amount. - `pm` Payment method: The payment method used for the trade. - `premium` Premium: The percentage of the premium the maker is willing to pay. +- `source` Source: The source of the order, it can be a URL that redirects to the order. - `rating` Rating: The rating of the maker, this document does not define how the rating is calculated, it's up to the platform to define it. - `n` Network: The network used for the trade, it can be `lightning`, `liquid`, `onchain`, etc. - `expiration` Expiration: The expiration date of the order ([NIP-40](https://github.com/nostr-protocol/nips/blob/master/40.md)). From f6b08429a270fbae71f0ae1689a5adf8fa91c543 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Thu, 27 Jun 2024 17:00:16 -0700 Subject: [PATCH 155/587] Clarify what happens when a duplicate subscription is sent, remove CLOSED on duplicate subscription --- 01.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/01.md b/01.md index c11a0954..d298046b 100644 --- a/01.md +++ b/01.md @@ -131,7 +131,7 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th } ``` -Upon 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. +Upon 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). Filter 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. @@ -169,7 +169,6 @@ This NIP defines no rules for how `NOTICE` messages should be sent or treated. * `["OK", "b1a649ebe8...", false, "pow: difficulty 26 is less than 30"]` * `["OK", "b1a649ebe8...", false, "error: could not connect to the database"]` - `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: - * `["CLOSED", "sub1", "duplicate: sub1 already opened"]` * `["CLOSED", "sub1", "unsupported: filter contains unknown elements"]` * `["CLOSED", "sub1", "error: could not connect to the database"]` * `["CLOSED", "sub1", "error: shutting down idle subscription"]` From 346ecd11140d05dcc68c9c0b69846a9d1ce1a9b0 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Fri, 28 Jun 2024 19:01:52 +0900 Subject: [PATCH 156/587] README: add `h` tag --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 02773a5d..34e0b0d7 100644 --- a/README.md +++ b/README.md @@ -233,6 +233,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `a` | coordinates to an event | relay URL | [01](01.md) | | `d` | identifier | -- | [01](01.md) | | `g` | geohash | -- | [52](52.md) | +| `h` | group id | -- | [29](29.md) | | `i` | identity | proof | [39](39.md) | | `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) | | `l` | label, label namespace | -- | [32](32.md) | From cc4a7a4e494e8d655fcf97ed03760f725f566ef2 Mon Sep 17 00:00:00 2001 From: "P. Reis" <patrickpereirareal1@gmail.com> Date: Wed, 3 Jul 2024 14:43:53 -0300 Subject: [PATCH 157/587] NIP-27: fix broken link, use njump --- 27.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/27.md b/27.md index efd2c122..133f8ef0 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 Suppose Bob is writing a note in a client that has search-and-autocomplete functionality for users that is triggered when they write the character `@`. -As 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. +As Bob types `"hello @mat"` the client will prompt him to autocomplete with [mattn's profile](https://njump.me/npub1937vv2nf06360qn9y8el6d8sevnndy7tuh5nzre4gj05xc32tnwqauhaj6), showing a picture and name. Bob 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: From c60ca888efbdc9b8fa4bbfbace372409d0b2161a Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Thu, 4 Jul 2024 09:57:40 -0300 Subject: [PATCH 158/587] nip29: create-group event kind. --- 29.md | 1 + 1 file changed, 1 insertion(+) diff --git a/29.md b/29.md index 0f4a5796..74dfd666 100644 --- a/29.md +++ b/29.md @@ -119,6 +119,7 @@ Each moderation action uses a different kind and requires different arguments, w | 9004 | `remove-permission` | `p` (pubkey), `permission` (name) | | 9005 | `delete-event` | `e` (id hex) | | 9006 | `edit-group-status` | `public` or `private`, `open` or `closed` | +| 9007 | `create-group` | | - *group metadata* (`kind:39000`) (optional) From d546936073db03e2187e3a0d1eb68e563d82201a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20Calder=C3=B3n?= <fjcalderon@gmail.com> Date: Thu, 4 Jul 2024 12:07:59 -0300 Subject: [PATCH 159/587] Add more optional tags and small fixes --- xx.md | 46 ++++++++++++++++++++++++++++------------------ 1 file changed, 28 insertions(+), 18 deletions(-) diff --git a/xx.md b/xx.md index 16a08934..0543e682 100644 --- a/xx.md +++ b/xx.md @@ -1,6 +1,6 @@ # NIP-XX -## Peer-to-peer messages +## Peer-to-peer Order events `draft` `optional` @@ -8,7 +8,7 @@ Peer-to-peer (P2P) platforms have seen an upturn in recent years, while having more and more options is positive, in the specific case of p2p, having several options contributes to the liquidity split, meaning sometimes there's not enough assets available for trading. If we combine all these individual solutions into one big pool of orders, it will make them much more competitive compared to centralized systems, where a single authority controls the liquidity. -This NIP defines a simple standard for peer-to-peer messages, which enables the creation of a big liquidity pool for all p2p platforms participating. +This NIP defines a simple standard for peer-to-peer order events, which enables the creation of a big liquidity pool for all p2p platforms participating. ## The event @@ -30,14 +30,18 @@ Events are [Parameterized Replaceable Events](https://github.com/nostr-protocol/ ["s", "pending"], ["amt", "0"], ["fa", "100"], - ["pm", "face to face"], + ["pm", "face to face", "bank transfer"], ["premium", "1"], [ "rating", "{\"total_reviews\":1,\"total_rating\":3.0,\"last_rating\":3,\"max_rate\":5,\"min_rate\":1}" ], ["source", "https://t.me/p2plightning/xxxxxxx"], - ["network", "lightning"], + ["network", "mainnet"], + ["layer", "lightning"], + ["name", "Nakamoto"], + ["g", "<geohash>"], + ["bond", "0"], ["expiration", "1719391096"], ["y", "lnp2pbot"], ["z", "order"] @@ -50,20 +54,26 @@ Events are [Parameterized Replaceable Events](https://github.com/nostr-protocol/ ## Tags -- `d` Order ID: A unique identifier for the order. -- `k` Order type: `sell` or `buy`. -- `f` Currency: The asset being traded, using the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) standard. -- `s` Status: `pending`, `canceled`, `in-progress`, `success`. -- `amt` Amount: The amount of Bitcoin to be traded, the amount is defined in satoshis, if `0` means that the amount of satoshis will be obtained from a public API after the taker accepts the order. -- `fa` Fiat amount: The fiat amount being traded, for range orders two values are expected, the minimum and maximum amount. -- `pm` Payment method: The payment method used for the trade. -- `premium` Premium: The percentage of the premium the maker is willing to pay. -- `source` Source: The source of the order, it can be a URL that redirects to the order. -- `rating` Rating: The rating of the maker, this document does not define how the rating is calculated, it's up to the platform to define it. -- `n` Network: The network used for the trade, it can be `lightning`, `liquid`, `onchain`, etc. -- `expiration` Expiration: The expiration date of the order ([NIP-40](https://github.com/nostr-protocol/nips/blob/master/40.md)). -- `y` Platform: The platform that created the order. -- `z` Order type: `order`. +- `d` < Order ID >: A unique identifier for the order. +- `k` < Order type >: `sell` or `buy`. +- `f` < Currency >: The asset being traded, using the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) standard. +- `s` < Status >: `pending`, `canceled`, `in-progress`, `success`. +- `amt` < Amount >: The amount of Bitcoin to be traded, the amount is defined in satoshis, if `0` means that the amount of satoshis will be obtained from a public API after the taker accepts the order. +- `fa` < Fiat amount >: The fiat amount being traded, for range orders two values are expected, the minimum and maximum amount. +- `pm` < Payment method >: The payment method used for the trade, if the order has multiple payment methods, they should be separated by a comma. +- `premium` < Premium >: The percentage of the premium the maker is willing to pay. +- `source` [Source]: The source of the order, it can be a URL that redirects to the order. +- `rating` [Rating]: The rating of the maker, this document does not define how the rating is calculated, it's up to the platform to define it. +- `network` < Network >: The network used for the trade, it can be `mainnet`, `testnet`, `signet`, etc. +- `layer` < Layer >: The layer used for the trade, it can be `onchain`, `lightning`, `liquid`, etc. +- `name` [Name]: The name of the maker. +- `g` [Geohash]: The geohash of the operation, it can be useful in a face to face trade. +- `bond` [Bond]: The bond amount, the bond is a security deposit that both parties must pay. +- `expiration` < Expiration\>: The expiration date of the order ([NIP-40](https://github.com/nostr-protocol/nips/blob/master/40.md)). +- `y` < Platform >: The platform that created the order. +- `z` < Document >: `order`. + +Mandatory tags are enclosed with `<tag>`, optional tags are enclosed with `[tag]`. ## Implementations From 21587e236785616b6c0ca796c03a29a3ad5e69ea Mon Sep 17 00:00:00 2001 From: abhay-raizada <toabhayraizada@gmail.com> Date: Fri, 5 Jul 2024 08:07:13 +0530 Subject: [PATCH 160/587] Finalize Draft --- 118.md | 83 +++++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 68 insertions(+), 15 deletions(-) diff --git a/118.md b/118.md index 86201c6d..15bc730e 100644 --- a/118.md +++ b/118.md @@ -4,33 +4,86 @@ `draft` `optional` -The purpose of this nip is to create a mechanism for polling on nostr. -The NIP aims to have the following properties. +This NIP defines the event scheme that describe Polls on nostr. -1. Provide a method for gauging eligibility. Only eligible votes should be counted. -2. Provide a method for maintaining anonymity. Participants should be able to not reveal their identities to everyone, yet their votes should be counted. -3. Provide a mechanism for verifiability. Participants should be able to verify that their votes have been counted, under an eligibility criteria. +The NIP makes the following tradeoffs. + +1. All votes are public. +2. All responses are editable (latest by timestamp considered last response) ## Events ### Poll Content -The poll event is defined as a `kind:1068` event. This event carries over the `name` , `description` and `field` tags as defined in [nip-101](https://github.com/nostr-protocol/nips/pull/1190/files). -This event has no other tags and completely defines the poll content, which is uneditable. +The poll event is defined as a `kind:1068` event. Major tags in the poll event are: + +- **label**: The accompanying text of the poll. +- **option**: The option tags contain an OptionId(any alphanumeric) field, followed by an option label field. +- **relays**: Set of relays that the poll is expecting respondents to respond on. +- **settings**: A JSON stringified object that may hold poll level configs and client specific configs. + +Example Event + +```json +{ + "content": "", + "created_at": 1719888496, + "id": "9d1b6b9562e66f2ecf35eb0a3c2decc736c47fddb13d6fb8f87185a153ea3634", + "kind": 1068, + "pubkey": "dee45a23c4f1d93f3a2043650c5081e4ac14a778e0acbef03de3768e4f81ac7b", + "sig": "7fa93bf3c430eaef784b0dacc217d3cd5eff1c520e7ef5d961381bc0f014dde6286618048d924808e54d1be03f2f2c2f0f8b5c9c2082a4480caf45a565ca9797", + "tags": [ + ["label", "Pineapple on Pizza"], + ["option", "qj518h583", "Yay"], + ["option", "gga6cdnqj", "Nay"], + ["relays", "<relay1 url>", "<relay 2 url>"], + ["settings", "{\"PollType\": \"singlechoice\" }"] + ] +} +``` ### Responses -The response event is the same as the one on [nip-101](https://github.com/nostr-protocol/nips/pull/1190/files) +The response event is a `kind:1018` event. It contains an e tag referencing the poll event it is referencing, followed by one or more response tags. -### Eligibilty +- **response** : The tag contains "response" as it's first positional argument followed by the option Id selected. -Eligibility to a vote is determined by another `kind:30180` event that can be created by anyone and is essentially a reference to a list of pubkeys, the author of the eligibility event is interested in. The eligibility event MUST contain an "e" tag to the poll event, and -"list" tags which references either a `kind:3` (contact list) or a `kind:30000`(follow sets) containing a list of "p" tags. +Example Response Event -### Counting Results. +```json +{ + "content": "", + "created_at": 1720097117, + "id": "60a005e32e9596c3f544a841a9bc4e46d3020ca3650d6a739c95c1568e33f6d8", + "kind": 1018, + "pubkey": "1bc70a0148b3f316da33fe7e89f23e3e71ac4ff998027ec712b905cd24f6a411", + "sig": "30071a633c65db8f3a075c7a8de757fbd8ce65e3607f4ba287fe6d7fbf839a380f94ff4e826fbba593f6faaa13683b7ea9114ade140720ecf4927010ebf3e44f", + "tags": [ + ["e", "1fc80cf813f1af33d5a435862b7ef7fb96b47e68a48f1abcadf8081f5a545550"], + ["response", "gga6cdnqj"] + ] +} +``` -Results can be counted for different eligibility events, by querying for `kind:1069` events only authored by the pubkeys mentioned in the eligibility event. +### Poll Types -### Anonymous Voting +Poll Types can be configured in the settings object of the poll, the setting dictates how multiple response tags are handled in the `kind:1018` event. -For people that wish to maintain anonymity, while still having their votes counted can do so by signing the response event with a random private key and sending over the corresponding pubkey to the author of a `kind:30180` eligibility event. The author of the eligibility event may demand "proofs of eligibility" before adding the pubkey in any of the lists. +- **PollType: singlechoice**: The first response tag is to be considered the actual response. +- **PollType: multiplechoice**: The first response tag pointing to each id is considered the actual response, without considering the order. +- **PollType: rankedchoice**: The first response tag pointing to each id is the considered the actual response, while also taking into account the order of the response tags. + +### Counting Results + +Results can be queried by fetching `kind:1018` events from the relays specified in the poll. +The results displayed should only be 1 vote per pubkey. +In case of multiple events for a pubkey, the event with the largest timestamp should be considered. + +### Curation + +The clients may configure fetching results by specific people. This can be achieved by creating `kind:30000` follow sets, and fetching results only from the follow set. +Clients can also employ other curation algorithms, like Proof Of Work and Web of Trust scores for result curations. + +### Private Polls + +This nip does not cover private polling, Clients may follow [forms nip](https://github.com/nostr-protocol/nips/pull/1190) for private polling. From 8c47577ecb6b3ae6ad840e5b4d187a3f3a6b97c8 Mon Sep 17 00:00:00 2001 From: Cody Casterline <cody.casterline@gmail.com> Date: Fri, 5 Jul 2024 09:31:23 -0700 Subject: [PATCH 161/587] More precisely document since/until bounds. (#1284) * More precisely document since/until bounds. Lower in this document, this is expressed as "since <= created_at <= until". But the English description said that these values had to be "newer than" or "older than". These two were in conflict. I assume the inclusive behavior is the intended one, since that documentation was added later to clarify. This just makes both cases match. * Update 01.md Co-authored-by: Alex Gleason <alex@alexgleason.me> * Update 01.md Co-authored-by: Alex Gleason <alex@alexgleason.me> --------- Co-authored-by: Alex Gleason <alex@alexgleason.me> --- 01.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/01.md b/01.md index c11a0954..c7d7273f 100644 --- a/01.md +++ b/01.md @@ -125,8 +125,8 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th "authors": <a list of lowercase pubkeys, the pubkey of an event must be one of these>, "kinds": <a list of a kind numbers>, "#<single-letter (a-zA-Z)>": <a list of tag values, for #e — a list of event ids, for #p — a list of pubkeys, etc.>, - "since": <an integer unix timestamp in seconds, events must be newer than this to pass>, - "until": <an integer unix timestamp in seconds, events must be older than this to pass>, + "since": <an integer unix timestamp in seconds. Events must have a created_at >= to this to pass>, + "until": <an integer unix timestamp in seconds. Events must have a created_at <= to this to pass>, "limit": <maximum number of events relays SHOULD return in the initial query> } ``` From ae1906ec7943a6bd756f05d2cd2fb2a041398921 Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Wed, 10 Jul 2024 09:00:26 -0300 Subject: [PATCH 162/587] relay-based event access-control with the `["-"]` tag (#1030) * `["protected"]` tag. * add note about default case for most relays. * rename tag to ["-"] and reword spec. * something Co-authored-by: monlovesmango <96307647+monlovesmango@users.noreply.github.com> * mention NIP-42 Co-authored-by: monlovesmango <96307647+monlovesmango@users.noreply.github.com> * user -> client Co-authored-by: monlovesmango <96307647+monlovesmango@users.noreply.github.com> * simplify text. --------- Co-authored-by: monlovesmango <96307647+monlovesmango@users.noreply.github.com> --- 70.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 70.md diff --git a/70.md b/70.md new file mode 100644 index 00000000..219e6a4f --- /dev/null +++ b/70.md @@ -0,0 +1,45 @@ +NIP-70 +====== + +Protected Events +---------------- + +`draft` `optional` + +When the `"-"` tag is present, that means the event is "protected". + +A 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. + +The default behavior of a relay MUST be to reject any event that contains `["-"]`. + +Relays that want to accept such events MUST first require that the client perform the [NIP-42](https://github.com/nostr-protocol/nips/blob/master/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. + +## The tag + +The tag is a simple tag with a single item: `["-"]`. It may be added to any event. + +## Example flow + +- User `79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798` connects to relay `wss://example.com`: + +```jsonc +/* client: */ +["EVENT",{"id":"cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2","pubkey":"79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798","created_at":1707409439,"kind":1,"tags":[["-"]],"content":"hello members of the secret group","sig":"fa163f5cfb75d77d9b6269011872ee22b34fb48d23251e9879bb1e4ccbdd8aaaf4b6dc5f5084a65ef42c52fbcde8f3178bac3ba207de827ec513a6aa39fa684c"}] +/* relay: */ +["AUTH", "<challenge>"] +["OK", "cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2", false, "auth-required: this event may only be published by its author"] +/* client: */ +["AUTH", {}] +["EVENT",{"id":"cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2","pubkey":"79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798","created_at":1707409439,"kind":1,"tags":[["-"]],"content":"hello members of the secret group","sig":"fa163f5cfb75d77d9b6269011872ee22b34fb48d23251e9879bb1e4ccbdd8aaaf4b6dc5f5084a65ef42c52fbcde8f3178bac3ba207de827ec513a6aa39fa684c"}] +["OK", "cb8feca582979d91fe90455867b34dbf4d65e4b86e86b3c68c368ca9f9eef6f2", true, ""] +``` + +## Why + +There 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. + +It'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. + +Even 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. + +This NIP gives these authors and relays the means to clearly signal when a given event is not intended to be republished by third parties. From 7c988b6de156f041e7584561ea611c7d1a50eb1a Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Wed, 10 Jul 2024 22:40:44 +0900 Subject: [PATCH 163/587] README: add NIP-70 and `"-"` tag --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 34e0b0d7..dd2e812a 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-58: Badges](58.md) - [NIP-59: Gift Wrap](59.md) - [NIP-65: Relay List Metadata](65.md) +- [NIP-70: Protected Events](70.md) - [NIP-71: Video Events](71.md) - [NIP-72: Moderated Communities](72.md) - [NIP-75: Zap Goals](75.md) @@ -232,6 +233,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | | `a` | coordinates to an event | relay URL | [01](01.md) | | `d` | identifier | -- | [01](01.md) | +| `-` | -- | -- | [70](70.md) | | `g` | geohash | -- | [52](52.md) | | `h` | group id | -- | [29](29.md) | | `i` | identity | proof | [39](39.md) | From 35ba0092ac2b75891b49173cafce750236bb43bb Mon Sep 17 00:00:00 2001 From: "P. Reis" <patrickpereirareal1@gmail.com> Date: Thu, 11 Jul 2024 18:35:12 -0300 Subject: [PATCH 164/587] NIP-65: fix typo --- 65.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/65.md b/65.md index 1a2d7e81..f32c9653 100644 --- a/65.md +++ b/65.md @@ -37,7 +37,7 @@ When seeking events **about** a user, where the user was tagged, Clients SHOULD When broadcasting an event, Clients SHOULD: - Broadcast the event to the WRITE relays of the author -- Broadcast the event all READ relays of each tagged user +- Broadcast the event to all READ relays of each tagged user ## Motivation From dedc22e1ea792796cfb0f0445d72afd13c4166ee Mon Sep 17 00:00:00 2001 From: Shusui MOYATANI <syusui.s@gmail.com> Date: Mon, 15 Jul 2024 10:53:20 +0900 Subject: [PATCH 165/587] NIP-39: clarify that i tag should be in tags --- 39.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/39.md b/39.md index c819e43b..f5ebe351 100644 --- a/39.md +++ b/39.md @@ -12,9 +12,11 @@ Nostr protocol users may have other online identities such as usernames, profile ## `i` tag on a metadata event -A 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): +A new optional `i` tag is introduced for `kind 0` metadata event defined in [NIP-01](https://github.com/nostr-protocol/nips/blob/master/01.md): ```json { + "id": <id>, + "pubkey": <pubkey>, "tags": [ ["i", "github:semisol", "9721ce4ee4fceb91c9711ca2a6c9a5ab"], ["i", "twitter:semisol_public", "1619358434134196225"], From 68c9e484ea1fdfa48e7a62da4a1e0b1e4a29a937 Mon Sep 17 00:00:00 2001 From: Vivek Ganesan <vivek@vivekganesan.com> Date: Mon, 15 Jul 2024 20:41:56 +0530 Subject: [PATCH 166/587] add suggestion to extension authors Wrote a note to extension authors --- 07.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/07.md b/07.md index b350d0c0..d733d010 100644 --- a/07.md +++ b/07.md @@ -22,10 +22,9 @@ async window.nostr.nip04.encrypt(pubkey, plaintext): string // returns ciphertex async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext and iv as specified in nip-04 ``` -### Recommendation to Implementers -When `window.nostr` is injected by a browser extension, it may not be fully available until a certain point in the page's lifecycle. Hence, it is a good idea to invoke the first `window.nostr` based functionality after a user-action on the web page (like a button click), and not during the page load. +### Recommendation to Extension Authors +To 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. -Calling the `window.nostr` based methods during the page load runs the risk of intermittent issues due to race conditions between the client page's script and the extension's script ### Implementation From c258875395bfdc22c4e74669c5a7b0bde567a9d4 Mon Sep 17 00:00:00 2001 From: Abhay Raizada <toabhayraizada@gmail.com> Date: Tue, 16 Jul 2024 23:03:02 +0530 Subject: [PATCH 167/587] Remove settings, fine tuning --- 118.md | 37 ++++++++++++++++++++----------------- 1 file changed, 20 insertions(+), 17 deletions(-) diff --git a/118.md b/118.md index 15bc730e..b22b0064 100644 --- a/118.md +++ b/118.md @@ -9,18 +9,23 @@ This NIP defines the event scheme that describe Polls on nostr. The NIP makes the following tradeoffs. 1. All votes are public. -2. All responses are editable (latest by timestamp considered last response) +2. All votes are editable (latest response by timestamp considered last vote) ## Events -### Poll Content +### Poll Event + +The poll event is defined as a `kind:1068` event. + +- **content** key holds the label for the poll. + +Major tags in the poll event are: -The poll event is defined as a `kind:1068` event. Major tags in the poll event are: -- **label**: The accompanying text of the poll. - **option**: The option tags contain an OptionId(any alphanumeric) field, followed by an option label field. -- **relays**: Set of relays that the poll is expecting respondents to respond on. -- **settings**: A JSON stringified object that may hold poll level configs and client specific configs. +- **relay**: One or multiple tags that the poll is expecting respondents to respond on. +- **polltype**: can be "singlechoice", "multiplechoice", or "rankedchoice". Polls that do not have a polltype should be considered a "singlechoice" poll. + Example Event @@ -36,15 +41,16 @@ Example Event ["label", "Pineapple on Pizza"], ["option", "qj518h583", "Yay"], ["option", "gga6cdnqj", "Nay"], - ["relays", "<relay1 url>", "<relay 2 url>"], - ["settings", "{\"PollType\": \"singlechoice\" }"] + ["relay","<relay url1>"], + ["relay", "<relay url2>"], + ["polltype", "singlechoice"] ] } ``` ### Responses -The response event is a `kind:1018` event. It contains an e tag referencing the poll event it is referencing, followed by one or more response tags. +The response event is a `kind:1018` event. It contains an e tag with the poll event it is referencing, followed by one or more response tags. - **response** : The tag contains "response" as it's first positional argument followed by the option Id selected. @@ -60,7 +66,8 @@ Example Response Event "sig": "30071a633c65db8f3a075c7a8de757fbd8ce65e3607f4ba287fe6d7fbf839a380f94ff4e826fbba593f6faaa13683b7ea9114ade140720ecf4927010ebf3e44f", "tags": [ ["e", "1fc80cf813f1af33d5a435862b7ef7fb96b47e68a48f1abcadf8081f5a545550"], - ["response", "gga6cdnqj"] + ["response", "gga6cdnqj"], + ["response", "m3agjsdq1"] ] } ``` @@ -70,20 +77,16 @@ Example Response Event Poll Types can be configured in the settings object of the poll, the setting dictates how multiple response tags are handled in the `kind:1018` event. - **PollType: singlechoice**: The first response tag is to be considered the actual response. -- **PollType: multiplechoice**: The first response tag pointing to each id is considered the actual response, without considering the order. +- **PollType: multiplechoice**: The first response tag pointing to each id is considered the actual response, without considering the order of the response tags. - **PollType: rankedchoice**: The first response tag pointing to each id is the considered the actual response, while also taking into account the order of the response tags. ### Counting Results Results can be queried by fetching `kind:1018` events from the relays specified in the poll. -The results displayed should only be 1 vote per pubkey. +The results displayed should only be 1 vote event per pubkey. In case of multiple events for a pubkey, the event with the largest timestamp should be considered. ### Curation The clients may configure fetching results by specific people. This can be achieved by creating `kind:30000` follow sets, and fetching results only from the follow set. -Clients can also employ other curation algorithms, like Proof Of Work and Web of Trust scores for result curations. - -### Private Polls - -This nip does not cover private polling, Clients may follow [forms nip](https://github.com/nostr-protocol/nips/pull/1190) for private polling. +Clients can also employ other curation algorithms, like Proof Of Work and Web of Trust scores for result curations. \ No newline at end of file From 9c54549f1842245b842d8a66f3bade744da24189 Mon Sep 17 00:00:00 2001 From: Alex Gleason <alex@alexgleason.me> Date: Thu, 18 Jul 2024 22:16:45 -0500 Subject: [PATCH 168/587] NIP-01: sort events by id after created_at --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index c7d7273f..1da6e837 100644 --- a/01.md +++ b/01.md @@ -143,7 +143,7 @@ All conditions of a filter that are specified must match for an event for it to A `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. -The `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. +The `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. ### From relay to client: sending events and notices From 2e85b89bcbc2b6dea07d988c3b4e4372614f254d Mon Sep 17 00:00:00 2001 From: Alexander Lopatin <alopatindev@codonaft.com> Date: Sun, 21 Jul 2024 02:05:46 +0800 Subject: [PATCH 169/587] Fix #1377: NIP-46: It's not obvious to the end-user that optional secrets are not temporary --- 46.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/46.md b/46.md index 15281162..fac06eee 100644 --- a/46.md +++ b/46.md @@ -28,7 +28,7 @@ The remote signer would provide a connection token in the form: bunker://<remote-user-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value> ``` -This 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). +This 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). Optional secret can be used for single successfully established connection only, remote signer SHOULD ignore new attempts to establish connection with old secret key. ### Direct connection initiated by the client From 8b5c9d8cf20899d6189f05d1d2f9f520677ce12b Mon Sep 17 00:00:00 2001 From: Alexander Lopatin <alopatindev@users.noreply.github.com> Date: Sat, 20 Jul 2024 21:19:05 +0300 Subject: [PATCH 170/587] Update 46.md Co-authored-by: Alex Gleason <alex@alexgleason.me> --- 46.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/46.md b/46.md index fac06eee..114c377d 100644 --- a/46.md +++ b/46.md @@ -28,7 +28,7 @@ The remote signer would provide a connection token in the form: bunker://<remote-user-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value> ``` -This 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). Optional secret can be used for single successfully established connection only, remote signer SHOULD ignore new attempts to establish connection with old secret key. +This 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). Optional secret can be used for single successfully established connection only, remote signer SHOULD ignore new attempts to establish connection with old optional secret. ### Direct connection initiated by the client From 96e3f767de285e780d5d84d6f6553070c519fd5e Mon Sep 17 00:00:00 2001 From: "@RandyMcMillan" <randy.lee.mcmillan@gmail.com> Date: Sat, 20 Jul 2024 15:39:38 -0400 Subject: [PATCH 171/587] 99.md:use relative links --- 99.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/99.md b/99.md index 93550d87..89482871 100644 --- a/99.md +++ b/99.md @@ -8,9 +8,9 @@ Classified Listings This 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. -The 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. +The 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. -The structure of these events is very similar to [NIP-23](https://github.com/nostr-protocol/nips/blob/master/23.md) long-form content events. +The structure of these events is very similar to [NIP-23](23.md) long-form content events. ### Draft / Inactive Listings @@ -26,8 +26,8 @@ The `.pubkey` field of these events are treated as the party creating the listin ### Metadata -- 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). -- 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. +- For "tags"/"hashtags" (i.e. categories or keywords of relevance for the listing) the `"t"` event tag should be used, as per [NIP-12](12.md). +- 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. The following tags, used for structured metadata, are standardized and SHOULD be included. Other tags may be added as necessary. From 3451f5a0c86f3ddcd3cbbbd3f534c606bbc60885 Mon Sep 17 00:00:00 2001 From: Yasuhiro Matsumoto <mattn.jp@gmail.com> Date: Mon, 22 Jul 2024 22:55:51 +0900 Subject: [PATCH 172/587] fix typos --- 34.md | 2 +- 96.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/34.md b/34.md index fcc2cece..52e23b50 100644 --- a/34.md +++ b/34.md @@ -53,7 +53,7 @@ The first patch revision in a patch revision SHOULD include a NIP-10 `e` `reply` ["p", "<repository-owner>"], ["p", "<other-user>"], // optionally send the patch to another user to bring it to their attention - ["t", "root"], // ommited for additional patches in a series + ["t", "root"], // omitted for additional patches in a series // for the first patch in a revision ["t", "root-revision"], diff --git a/96.md b/96.md index 2f253516..be709991 100644 --- a/96.md +++ b/96.md @@ -301,7 +301,7 @@ Example Response: // ...other metadata ] "content": "haha funny meme", // caption - "created_at": 1715691130 // upload timestmap + "created_at": 1715691130 // upload timestamp }, ... ] From d8339163704adfe2d277690cfe4c3863940fba35 Mon Sep 17 00:00:00 2001 From: Alexander Lopatin <alopatindev@codonaft.com> Date: Thu, 25 Jul 2024 02:57:48 +0800 Subject: [PATCH 173/587] NIP-32: Language example --- 32.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/32.md b/32.md index 79f59370..ee71ae95 100644 --- a/32.md +++ b/32.md @@ -129,6 +129,20 @@ is labeling their note as being related to Milan, Italy using ISO 3166-2. } ``` +Author is labelling their note language as English using ISO-639-1. + +```json +{ + "kind": 1, + "tags": [ + ["L", "ISO-639-1"], + ["l", "en", "ISO-639-1"] + ], + "content": "English text", + ... +} +``` + Other Notes ----------- From c7f4f68d03376c14a6813f9a04346ea1712503cc Mon Sep 17 00:00:00 2001 From: Alexander Lopatin <alopatindev@users.noreply.github.com> Date: Wed, 24 Jul 2024 22:14:06 +0300 Subject: [PATCH 174/587] Update 32.md Co-authored-by: Alex Gleason <alex@alexgleason.me> --- 32.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/32.md b/32.md index ee71ae95..ed46513f 100644 --- a/32.md +++ b/32.md @@ -129,7 +129,7 @@ is labeling their note as being related to Milan, Italy using ISO 3166-2. } ``` -Author is labelling their note language as English using ISO-639-1. +Author is labeling their note language as English using ISO-639-1. ```json { From 6021b07e26b990fd2bd7f715da839d380812a588 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Thu, 25 Jul 2024 09:00:10 +0900 Subject: [PATCH 175/587] BREAKING.md: add NIP-01 change --- BREAKING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/BREAKING.md b/BREAKING.md index c8255cdc..610764db 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -5,6 +5,7 @@ reverse chronological order. | Date | Commit | NIP | Change | | ----------- | --------- | -------- | ------ | +| 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 | | 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 | | 2024-06-06 | [a6dfc7b5](https://github.com/nostr-protocol/nips/commit/a6dfc7b5) | [NIP-55](55.md) | NIP number was changed | | 2024-05-25 | [5d1d1c17](https://github.com/nostr-protocol/nips/commit/5d1d1c17) | [NIP-71](71.md) | 'aes-256-gcm' tag was removed | From ecee40df17929abdf187bb49952cc40ed1a6702a Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Tue, 23 Jul 2024 20:59:50 -0300 Subject: [PATCH 176/587] nip19: deprecate `nrelay` --- 19.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/19.md b/19.md index ef808870..cce9e641 100644 --- a/19.md +++ b/19.md @@ -34,8 +34,8 @@ These are the possible bech32 prefixes with `TLV`: - `nprofile`: a nostr profile - `nevent`: a nostr event - - `nrelay`: a nostr relay - `naddr`: a nostr _replaceable event_ coordinate + - `nrelay`: a nostr relay (deprecated) These possible standardized `TLV` types are indicated here: @@ -43,7 +43,6 @@ These possible standardized `TLV` types are indicated here: - depends on the bech32 prefix: - for `nprofile` it will be the 32 bytes of the profile public key - for `nevent` it will be the 32 bytes of the event id - - for `nrelay`, this is the relay URL - for `naddr`, it is the identifier (the `"d"` tag) of the event being referenced. For non-parameterized replaceable events, use an empty string. - `1`: `relay` - for `nprofile`, `nevent` and `naddr`, _optionally_, a relay in which the entity (profile or event) is more likely to be found, encoded as ascii From 6826f5a52cac1215d9f0b8c4158500861cbbcfa8 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Fri, 26 Jul 2024 08:47:20 +0900 Subject: [PATCH 177/587] BREAKING.md: add NIP-19 change --- BREAKING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/BREAKING.md b/BREAKING.md index 610764db..dab94ed9 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -5,6 +5,7 @@ reverse chronological order. | Date | Commit | NIP | Change | | ----------- | --------- | -------- | ------ | +| 2024-07-26 | [ecee40df](https://github.com/nostr-protocol/nips/commit/ecee40df) | [NIP-19](19.md) | `nrelay` was deprecated | | 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 | | 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 | | 2024-06-06 | [a6dfc7b5](https://github.com/nostr-protocol/nips/commit/a6dfc7b5) | [NIP-55](55.md) | NIP number was changed | From a5228e59c91d14f7b6bbc30851882d7d394f66bd Mon Sep 17 00:00:00 2001 From: "@RandyMcMillan" <randy.lee.mcmillan@gmail.com> Date: Sun, 28 Jul 2024 14:18:32 -0400 Subject: [PATCH 178/587] 39.md: use relative link to 01.md --- 39.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/39.md b/39.md index f5ebe351..b7c3b9c6 100644 --- a/39.md +++ b/39.md @@ -12,7 +12,7 @@ Nostr protocol users may have other online identities such as usernames, profile ## `i` tag on a metadata event -A new optional `i` tag is introduced for `kind 0` metadata event defined in [NIP-01](https://github.com/nostr-protocol/nips/blob/master/01.md): +A new optional `i` tag is introduced for `kind 0` metadata event defined in [NIP-01](01.md): ```json { "id": <id>, From b8fe261ce4ff33142ce6ea71126969dfce0f7d7e Mon Sep 17 00:00:00 2001 From: randymcmillan <randymcmillan@protonmail.com> Date: Sun, 28 Jul 2024 15:08:13 -0400 Subject: [PATCH 179/587] 15.md:use relative links --- 15.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/15.md b/15.md index 55814fb5..6daa8019 100644 --- a/15.md +++ b/15.md @@ -6,7 +6,7 @@ Nostr Marketplace `draft` `optional` -Based on https://github.com/lnbits/Diagon-Alley. +Based on [Diagon-Alley](https://github.com/lnbits/Diagon-Alley). Implemented in [NostrMarket](https://github.com/lnbits/nostrmarket) and [Plebeian Market](https://github.com/PlebeianTech/plebeian-market). @@ -139,7 +139,7 @@ Fields that are not self-explanatory: ## Checkout events -All checkout events are sent as JSON strings using ([NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md)). +All checkout events are sent as JSON strings using [NIP-04](04.md). The `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: @@ -150,7 +150,7 @@ The `merchant` and the `customer` can exchange JSON messages that represent diff | 2 | Merchant | Order Status Update | ### Step 1: `customer` order (event) -The below JSON goes in content of [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md). +The below JSON goes in content of [NIP-04](04.md). ```json { @@ -182,7 +182,7 @@ _Open_: is `contact.nostr` required? Sent back from the merchant for payment. Any payment option is valid that the merchant can check. -The below JSON goes in `content` of [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md). +The below JSON goes in `content` of [NIP-04](04.md). `payment_options`/`type` include: @@ -217,7 +217,7 @@ The below JSON goes in `content` of [NIP-04](https://github.com/nostr-protocol/n Once payment has been received and processed. -The below JSON goes in `content` of [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md). +The below JSON goes in `content` of [NIP-04](04.md). ```json { @@ -231,7 +231,7 @@ The below JSON goes in `content` of [NIP-04](https://github.com/nostr-protocol/n ## Customize Marketplace -Create 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. +Create 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. ### Event `30019`: Create or update marketplace UI/UX @@ -331,7 +331,7 @@ Another thing that can happen is - if bids happen very close to the end date of ## Customer support events -Customer 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. +Customer support is handled over whatever communication method was specified. If communicating via nostr, [NIP-04](04.md) is used. ## Additional From 6c89e929ba445235e45ab2bb970c012827cf35b1 Mon Sep 17 00:00:00 2001 From: randymcmillan <randymcmillan@protonmail.com> Date: Sun, 28 Jul 2024 15:19:39 -0400 Subject: [PATCH 180/587] 46.mk:use relative links --- 46.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/46.md b/46.md index 114c377d..57fd2b01 100644 --- a/46.md +++ b/46.md @@ -101,7 +101,7 @@ nostrconnect://<local-keypair-pubkey>?relay=<wss://relay-to-connect-on>&metadata } ``` -The `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: +The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted and has the following structure: ```json { @@ -148,7 +148,7 @@ The `connect` method may be provided with `optional_requested_permissions` for u } ``` -The `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: +The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted and has the following structure: ```json { @@ -224,4 +224,4 @@ Coming soon... ## References -- [NIP-04 - Encryption](https://github.com/nostr-protocol/nips/blob/master/04.md) +- [NIP-04 - Encryption](04.md) From b47c50fa6e95300d537cc06df6755dc2691e3213 Mon Sep 17 00:00:00 2001 From: randymcmillan <randymcmillan@protonmail.com> Date: Sun, 28 Jul 2024 15:23:28 -0400 Subject: [PATCH 181/587] 47.md:use relative link --- 47.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/47.md b/47.md index 983d2c95..e4e432ca 100644 --- a/47.md +++ b/47.md @@ -38,7 +38,7 @@ a plaintext string with the supported commands, space-separated, eg. `pay_invoic Both 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. Optionally, 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. -The 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: +The content of requests and responses is encrypted with [NIP04](04.md), and is a JSON-RPCish object with a semi-fixed structure: Request: ```jsonc From 6d348b572e0f98b0a49ea6024da07e82917ace58 Mon Sep 17 00:00:00 2001 From: randymcmillan <randymcmillan@protonmail.com> Date: Sun, 28 Jul 2024 15:27:29 -0400 Subject: [PATCH 182/587] 70.md:use relative link --- 70.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/70.md b/70.md index 219e6a4f..043d5fbf 100644 --- a/70.md +++ b/70.md @@ -12,7 +12,7 @@ A protected event is an event that can only be published to relays by its author The default behavior of a relay MUST be to reject any event that contains `["-"]`. -Relays that want to accept such events MUST first require that the client perform the [NIP-42](https://github.com/nostr-protocol/nips/blob/master/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. +Relays 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. ## The tag From 0c1dfa966195d789dfa0c7f46544a2e653cc6ca3 Mon Sep 17 00:00:00 2001 From: randymcmillan <randymcmillan@protonmail.com> Date: Sun, 28 Jul 2024 15:36:31 -0400 Subject: [PATCH 183/587] 21.md:use relative link --- 21.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/21.md b/21.md index 6ed141a8..988485dd 100644 --- a/21.md +++ b/21.md @@ -10,7 +10,7 @@ This NIP standardizes the usage of a common URI scheme for maximum interoperabil The scheme is `nostr:`. -The 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`). +The identifiers that come after are expected to be the same as those defined in [NIP-19](19.md) (except `nsec`). ## Examples From 985fd30cd98451d1311d28bf4d596d70e0c7fd6d Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Mon, 29 Jul 2024 07:38:29 -0700 Subject: [PATCH 184/587] Add k tag to deletions --- 09.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/09.md b/09.md index 5e79ac23..b6aa72c7 100644 --- a/09.md +++ b/09.md @@ -6,9 +6,7 @@ Event Deletion `draft` `optional` -A 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. - -Each tag entry must contain an "e" event id and/or `a` tags intended for deletion. +A special event with kind `5`, meaning "deletion" 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 deleted. The event's `content` field MAY contain a text note describing the reason for the deletion. @@ -21,7 +19,9 @@ For example: "tags": [ ["e", "dcd59..464a2"], ["e", "968c5..ad7a4"], - ["a", "<kind>:<pubkey>:<d-identifier>"] + ["a", "<kind>:<pubkey>:<d-identifier>"], + ["k", "1"], + ["k", "30023"] ], "content": "these posts were published by accident", ...other fields From e73e77735d0ab08ca133077b389f980e5b2363b3 Mon Sep 17 00:00:00 2001 From: hodlbod <jstaab@protonmail.com> Date: Wed, 31 Jul 2024 08:53:17 -0700 Subject: [PATCH 185/587] Revert "Remove NIP 45 COUNT" --- 45.md | 2 -- README.md | 2 +- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/45.md b/45.md index 56d0f101..780dfb6b 100644 --- a/45.md +++ b/45.md @@ -1,5 +1,3 @@ -> __Warning__ `unrecommended`: deprecated - NIP-45 ====== diff --git a/README.md b/README.md index a12df706..dd2e812a 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-40: Expiration Timestamp](40.md) - [NIP-42: Authentication of clients to relays](42.md) - [NIP-44: Versioned Encryption](44.md) -- [NIP-45: Counting results](45.md) --- **unrecommended**: deprecated +- [NIP-45: Counting results](45.md) - [NIP-46: Nostr Connect](46.md) - [NIP-47: Wallet Connect](47.md) - [NIP-48: Proxy Tags](48.md) From c7b4b1b6da2284298f9cb813b515b897bf46368b Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Thu, 1 Aug 2024 07:33:30 +0900 Subject: [PATCH 186/587] BREAKING.md: add NIP-45 changes --- BREAKING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/BREAKING.md b/BREAKING.md index dab94ed9..cac35454 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -5,6 +5,8 @@ reverse chronological order. | Date | Commit | NIP | Change | | ----------- | --------- | -------- | ------ | +| 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 | +| 2024-07-30 | [444ad28d](https://github.com/nostr-protocol/nips/commit/444ad28d) | [NIP-45](45.md) | NIP-45 was deprecated | | 2024-07-26 | [ecee40df](https://github.com/nostr-protocol/nips/commit/ecee40df) | [NIP-19](19.md) | `nrelay` was deprecated | | 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 | | 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 | From 788ffb03a001eb1e26444472ee9211ff51d16baa Mon Sep 17 00:00:00 2001 From: DanConwayDev <DanConwayDev@protonmail.com> Date: Tue, 21 May 2024 15:29:22 +0100 Subject: [PATCH 187/587] nip34: add refs to repo event so that the event can be used as a source of truth for the state of refs such as branches and tags this could be useful as: 1. a way to reduce trust in git server(s) so they no longer act as a source of truth. a nip34 git remote-helper could proxy requests to git servers and only pull updates when they match the state listed in the repo event. 2. a form of authorisation for nip34 git server implementations such as song 3. a way of enabling experimentation with other protocols for hosting and accessing git data. eg a blossom git remote helper --- 34.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/34.md b/34.md index 52e23b50..4989803d 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 Except `d`, all tags are optional. +## Repository state announcements + +An optional source of truth for the state of branches and tags in a repository. + +```jsonc +{ + "kind": 30618, + "content": "", + "tags": [ + ["d", "<repo-id>"], // matches the identifier in the coresponding repository announcement + ["refs/<heads|tags>/<branch-or-tag-name>","<commit-id>"] + ["HEAD", "ref: refs/heads/<branch-name>"] + ] +} +``` + +The `refs` tag may appear multiple times, or none. + +If 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. + +The `refs` tag can be optionally extended to enable clients to identify how many commits ahead a ref is: + +```jsonc +{ + "tags": [ + ["refs/<heads|tags>/<branch-or-tag-name>", "<commit-id>", "<shorthand-parent-commit-id>", "<shorthand-grandparent>", ...], + ] +} +``` + ## Patches Patches 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. From 8e5083b28f9716939efbdde576ed21a99b2fed2a Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Sat, 3 Aug 2024 08:47:59 +0900 Subject: [PATCH 188/587] Update readme (#1408) * README: add kind 30618 repository state announcements * README: add NIP-72 link to `name` tag * README: use reference link for NUD: Custom Feeds * Format kinds table --- README.md | 216 +++++++++++++++++++++++++++--------------------------- 1 file changed, 109 insertions(+), 107 deletions(-) diff --git a/README.md b/README.md index dd2e812a..515f2a27 100644 --- a/README.md +++ b/README.md @@ -89,112 +89,114 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-99: Classified Listings](99.md) ## Event Kinds -| kind | description | NIP | -| ------------- | -------------------------- | ------------------------ | -| `0` | User Metadata | [01](01.md) | -| `1` | Short Text Note | [01](01.md) | -| `2` | Recommend Relay | 01 (deprecated) | -| `3` | Follows | [02](02.md) | -| `4` | Encrypted Direct Messages | [04](04.md) | -| `5` | Event Deletion | [09](09.md) | -| `6` | Repost | [18](18.md) | -| `7` | Reaction | [25](25.md) | -| `8` | Badge Award | [58](58.md) | -| `9` | Group Chat Message | [29](29.md) | -| `10` | Group Chat Threaded Reply | [29](29.md) | -| `11` | Group Thread | [29](29.md) | -| `12` | Group Thread Reply | [29](29.md) | -| `13` | Seal | [59](59.md) | -| `14` | Direct Message | [17](17.md) | -| `16` | Generic Repost | [18](18.md) | -| `40` | Channel Creation | [28](28.md) | -| `41` | Channel Metadata | [28](28.md) | -| `42` | Channel Message | [28](28.md) | -| `43` | Channel Hide Message | [28](28.md) | -| `44` | Channel Mute User | [28](28.md) | -| `818` | Merge Requests | [54](54.md) | -| `1021` | Bid | [15](15.md) | -| `1022` | Bid confirmation | [15](15.md) | -| `1040` | OpenTimestamps | [03](03.md) | -| `1059` | Gift Wrap | [59](59.md) | -| `1063` | File Metadata | [94](94.md) | -| `1311` | Live Chat Message | [53](53.md) | -| `1617` | Patches | [34](34.md) | -| `1621` | Issues | [34](34.md) | -| `1622` | Replies | [34](34.md) | -| `1630`-`1633` | Status | [34](34.md) | -| `1971` | Problem Tracker | [nostrocket][nostrocket] | -| `1984` | Reporting | [56](56.md) | -| `1985` | Label | [32](32.md) | -| `2003` | Torrent | [35](35.md) | -| `2004` | Torrent Comment | [35](35.md) | -| `2022` | Coinjoin Pool | [joinstr][joinstr] | -| `4550` | Community Post Approval | [72](72.md) | -| `5000`-`5999` | Job Request | [90](90.md) | -| `6000`-`6999` | Job Result | [90](90.md) | -| `7000` | Job Feedback | [90](90.md) | -| `9000`-`9030` | Group Control Events | [29](29.md) | -| `9041` | Zap Goal | [75](75.md) | -| `9734` | Zap Request | [57](57.md) | -| `9735` | Zap | [57](57.md) | -| `9802` | Highlights | [84](84.md) | -| `10000` | Mute list | [51](51.md) | -| `10001` | Pin list | [51](51.md) | -| `10002` | Relay List Metadata | [65](65.md) | -| `10003` | Bookmark list | [51](51.md) | -| `10004` | Communities list | [51](51.md) | -| `10005` | Public chats list | [51](51.md) | -| `10006` | Blocked relays list | [51](51.md) | -| `10007` | Search relays list | [51](51.md) | -| `10009` | User groups | [51](51.md), [29](29.md) | -| `10015` | Interests list | [51](51.md) | -| `10030` | User emoji list | [51](51.md) | -| `10050` | Relay list to receive DMs | [17](17.md) | -| `10096` | File storage server list | [96](96.md) | -| `13194` | Wallet Info | [47](47.md) | -| `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | -| `22242` | Client Authentication | [42](42.md) | -| `23194` | Wallet Request | [47](47.md) | -| `23195` | Wallet Response | [47](47.md) | -| `24133` | Nostr Connect | [46](46.md) | -| `27235` | HTTP Auth | [98](98.md) | -| `30000` | Follow sets | [51](51.md) | -| `30001` | Generic lists | [51](51.md) | -| `30002` | Relay sets | [51](51.md) | -| `30003` | Bookmark sets | [51](51.md) | -| `30004` | Curation sets | [51](51.md) | -| `30005` | Video sets | [51](51.md) | -| `30008` | Profile Badges | [58](58.md) | -| `30009` | Badge Definition | [58](58.md) | -| `30015` | Interest sets | [51](51.md) | -| `30017` | Create or update a stall | [15](15.md) | -| `30018` | Create or update a product | [15](15.md) | -| `30019` | Marketplace UI/UX | [15](15.md) | -| `30020` | Product sold as an auction | [15](15.md) | -| `30023` | Long-form Content | [23](23.md) | -| `30024` | Draft Long-form Content | [23](23.md) | -| `30030` | Emoji sets | [51](51.md) | -| `30063` | Release artifact sets | [51](51.md) | -| `30078` | Application-specific Data | [78](78.md) | -| `30311` | Live Event | [53](53.md) | -| `30315` | User Statuses | [38](38.md) | -| `30402` | Classified Listing | [99](99.md) | -| `30403` | Draft Classified Listing | [99](99.md) | -| `30617` | Repository announcements | [34](34.md) | -| `30818` | Wiki article | [54](54.md) | -| `30819` | Redirects | [54](54.md) | -| `31890` | Feed | [NUD: Custom Feeds](https://wikifreedia.xyz/cip-01/97c70a44366a6535c1) | -| `31922` | Date-Based Calendar Event | [52](52.md) | -| `31923` | Time-Based Calendar Event | [52](52.md) | -| `31924` | Calendar | [52](52.md) | -| `31925` | Calendar Event RSVP | [52](52.md) | -| `31989` | Handler recommendation | [89](89.md) | -| `31990` | Handler information | [89](89.md) | -| `34235` | Video Event | [71](71.md) | -| `34236` | Short-form Portrait Video Event | [71](71.md) | -| `34237` | Video View Event | [71](71.md) | -| `34550` | Community Definition | [72](72.md) | -| `39000-9` | Group metadata events | [29](29.md) | + +| kind | description | NIP | +| ------------- | ------------------------------- | -------------------------------------- | +| `0` | User Metadata | [01](01.md) | +| `1` | Short Text Note | [01](01.md) | +| `2` | Recommend Relay | 01 (deprecated) | +| `3` | Follows | [02](02.md) | +| `4` | Encrypted Direct Messages | [04](04.md) | +| `5` | Event Deletion | [09](09.md) | +| `6` | Repost | [18](18.md) | +| `7` | Reaction | [25](25.md) | +| `8` | Badge Award | [58](58.md) | +| `9` | Group Chat Message | [29](29.md) | +| `10` | Group Chat Threaded Reply | [29](29.md) | +| `11` | Group Thread | [29](29.md) | +| `12` | Group Thread Reply | [29](29.md) | +| `13` | Seal | [59](59.md) | +| `14` | Direct Message | [17](17.md) | +| `16` | Generic Repost | [18](18.md) | +| `40` | Channel Creation | [28](28.md) | +| `41` | Channel Metadata | [28](28.md) | +| `42` | Channel Message | [28](28.md) | +| `43` | Channel Hide Message | [28](28.md) | +| `44` | Channel Mute User | [28](28.md) | +| `818` | Merge Requests | [54](54.md) | +| `1021` | Bid | [15](15.md) | +| `1022` | Bid confirmation | [15](15.md) | +| `1040` | OpenTimestamps | [03](03.md) | +| `1059` | Gift Wrap | [59](59.md) | +| `1063` | File Metadata | [94](94.md) | +| `1311` | Live Chat Message | [53](53.md) | +| `1617` | Patches | [34](34.md) | +| `1621` | Issues | [34](34.md) | +| `1622` | Replies | [34](34.md) | +| `1630`-`1633` | Status | [34](34.md) | +| `1971` | Problem Tracker | [nostrocket][nostrocket] | +| `1984` | Reporting | [56](56.md) | +| `1985` | Label | [32](32.md) | +| `2003` | Torrent | [35](35.md) | +| `2004` | Torrent Comment | [35](35.md) | +| `2022` | Coinjoin Pool | [joinstr][joinstr] | +| `4550` | Community Post Approval | [72](72.md) | +| `5000`-`5999` | Job Request | [90](90.md) | +| `6000`-`6999` | Job Result | [90](90.md) | +| `7000` | Job Feedback | [90](90.md) | +| `9000`-`9030` | Group Control Events | [29](29.md) | +| `9041` | Zap Goal | [75](75.md) | +| `9734` | Zap Request | [57](57.md) | +| `9735` | Zap | [57](57.md) | +| `9802` | Highlights | [84](84.md) | +| `10000` | Mute list | [51](51.md) | +| `10001` | Pin list | [51](51.md) | +| `10002` | Relay List Metadata | [65](65.md) | +| `10003` | Bookmark list | [51](51.md) | +| `10004` | Communities list | [51](51.md) | +| `10005` | Public chats list | [51](51.md) | +| `10006` | Blocked relays list | [51](51.md) | +| `10007` | Search relays list | [51](51.md) | +| `10009` | User groups | [51](51.md), [29](29.md) | +| `10015` | Interests list | [51](51.md) | +| `10030` | User emoji list | [51](51.md) | +| `10050` | Relay list to receive DMs | [17](17.md) | +| `10096` | File storage server list | [96](96.md) | +| `13194` | Wallet Info | [47](47.md) | +| `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | +| `22242` | Client Authentication | [42](42.md) | +| `23194` | Wallet Request | [47](47.md) | +| `23195` | Wallet Response | [47](47.md) | +| `24133` | Nostr Connect | [46](46.md) | +| `27235` | HTTP Auth | [98](98.md) | +| `30000` | Follow sets | [51](51.md) | +| `30001` | Generic lists | [51](51.md) | +| `30002` | Relay sets | [51](51.md) | +| `30003` | Bookmark sets | [51](51.md) | +| `30004` | Curation sets | [51](51.md) | +| `30005` | Video sets | [51](51.md) | +| `30008` | Profile Badges | [58](58.md) | +| `30009` | Badge Definition | [58](58.md) | +| `30015` | Interest sets | [51](51.md) | +| `30017` | Create or update a stall | [15](15.md) | +| `30018` | Create or update a product | [15](15.md) | +| `30019` | Marketplace UI/UX | [15](15.md) | +| `30020` | Product sold as an auction | [15](15.md) | +| `30023` | Long-form Content | [23](23.md) | +| `30024` | Draft Long-form Content | [23](23.md) | +| `30030` | Emoji sets | [51](51.md) | +| `30063` | Release artifact sets | [51](51.md) | +| `30078` | Application-specific Data | [78](78.md) | +| `30311` | Live Event | [53](53.md) | +| `30315` | User Statuses | [38](38.md) | +| `30402` | Classified Listing | [99](99.md) | +| `30403` | Draft Classified Listing | [99](99.md) | +| `30617` | Repository announcements | [34](34.md) | +| `30618` | Repository state announcements | [34](34.md) | +| `30818` | Wiki article | [54](54.md) | +| `30819` | Redirects | [54](54.md) | +| `31890` | Feed | [NUD: Custom Feeds][NUD: Custom Feeds] | +| `31922` | Date-Based Calendar Event | [52](52.md) | +| `31923` | Time-Based Calendar Event | [52](52.md) | +| `31924` | Calendar | [52](52.md) | +| `31925` | Calendar Event RSVP | [52](52.md) | +| `31989` | Handler recommendation | [89](89.md) | +| `31990` | Handler information | [89](89.md) | +| `34235` | Video Event | [71](71.md) | +| `34236` | Short-form Portrait Video Event | [71](71.md) | +| `34237` | Video View Event | [71](71.md) | +| `34550` | Community Definition | [72](72.md) | +| `39000-9` | Group metadata events | [29](29.md) | [NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/97c70a44366a6535c1 [nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md @@ -262,7 +264,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `imeta` | inline metadata | -- | [92](92.md) | | `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | | `location` | location string | -- | [52](52.md), [99](99.md) | -| `name` | name | -- | [34](34.md), [58](58.md) | +| `name` | name | -- | [34](34.md), [58](58.md), [72](72.md) | | `nonce` | random | difficulty | [13](13.md) | | `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | | `price` | price | currency, frequency | [99](99.md) | From 428a4779d7c4f4c2ff53815e8958e7cf99d69d26 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Mon, 5 Aug 2024 10:43:24 -0300 Subject: [PATCH 189/587] nip51: add kind 10050 (from NIP-17). --- 51.md | 1 + README.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/51.md b/51.md index fb40b26e..65bc4848 100644 --- a/51.md +++ b/51.md @@ -32,6 +32,7 @@ For example, _mute list_ can contain the public keys of spammers and bad actors | Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group ids + mandatory relay URL) | | Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) | | Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | +| DM relays | 10050 | Where to receive [NIP-17](17.md) direct messages | `"relay"` (see [NIP-17](17.md)) | | Good wiki authors | 10101 | [NIP-54](54.md) user recommended wiki authors | `"p"` (pubkeys) | | Good wiki relays | 10102 | [NIP-54](54.md) relays deemed to only host useful articles | `"relay"` (relay URLs) | diff --git a/README.md b/README.md index 515f2a27..550888a8 100644 --- a/README.md +++ b/README.md @@ -150,7 +150,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10009` | User groups | [51](51.md), [29](29.md) | | `10015` | Interests list | [51](51.md) | | `10030` | User emoji list | [51](51.md) | -| `10050` | Relay list to receive DMs | [17](17.md) | +| `10050` | Relay list to receive DMs | [51](51.md), [17](17.md) | | `10096` | File storage server list | [96](96.md) | | `13194` | Wallet Info | [47](47.md) | | `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | From 14c3310039cf7ac8140e6e27f5a7c47ec8f47a30 Mon Sep 17 00:00:00 2001 From: Oscar Merry <oscardmerry@gmail.com> Date: Mon, 5 Aug 2024 23:16:49 +0100 Subject: [PATCH 190/587] Add Podcast Publisher GUID --- XX.md | 1 + 1 file changed, 1 insertion(+) diff --git a/XX.md b/XX.md index 636629d9..e7ee5f57 100644 --- a/XX.md +++ b/XX.md @@ -27,6 +27,7 @@ Book ISBNs MUST be referenced _**without hyphens**_ as many book search APIs ret - Podcast RSS Feed GUID: `["i", "podcast:guid:c90e609a-df1e-596a-bd5e-57bcc8aad6cc"]` - https://podcastindex.org/podcast/c90e609a-df1e-596a-bd5e-57bcc8aad6cc - Podcast RSS Item GUID: `["i", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f"]` +- Podcast RSS Publisher GUID: `["i", "podcast:publisher:guid:18bcbf10-6701-4ffb-b255-bc057390d738"]` ### Movies: From 4d9eb32dc9062868d0d61c15456935dad39364de Mon Sep 17 00:00:00 2001 From: Oscar Merry <oscardmerry@gmail.com> Date: Mon, 5 Aug 2024 23:51:04 +0100 Subject: [PATCH 191/587] Use NIP-73 --- 24.md | 2 +- XX.md => 73.md | 2 +- README.md | 3 ++- 3 files changed, 4 insertions(+), 3 deletions(-) rename XX.md => 73.md (99%) diff --git a/24.md b/24.md index 8710af69..ef4196bd 100644 --- a/24.md +++ b/24.md @@ -40,5 +40,5 @@ tags These 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: - `r`: a web URL the event is referring to in some way - - `i`: an external id the event is referring to in some way - see [NIP-XX](XX.md) + - `i`: an external id the event is referring to in some way - see [NIP-73](73.md) - `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/XX.md b/73.md similarity index 99% rename from XX.md rename to 73.md index e7ee5f57..12228d36 100644 --- a/XX.md +++ b/73.md @@ -1,4 +1,4 @@ -NIP-XX +NIP-73 ====== External Content IDs diff --git a/README.md b/README.md index 550888a8..6c83ba88 100644 --- a/README.md +++ b/README.md @@ -77,6 +77,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-70: Protected Events](70.md) - [NIP-71: Video Events](71.md) - [NIP-72: Moderated Communities](72.md) +- [NIP-73: External Content IDs](73.md) - [NIP-75: Zap Goals](75.md) - [NIP-78: Application-specific data](78.md) - [NIP-84: Highlights](84.md) @@ -238,7 +239,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `-` | -- | -- | [70](70.md) | | `g` | geohash | -- | [52](52.md) | | `h` | group id | -- | [29](29.md) | -| `i` | identity | proof | [39](39.md) | +| `i` | external identity | proof, url hint | [39](39.md), [73](73.md) | | `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) | | `l` | label, label namespace | -- | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | From 5277ee76bed157e2aecd6ac004995d7257773cd3 Mon Sep 17 00:00:00 2001 From: haorendashu <385321165@qq.com> Date: Tue, 6 Aug 2024 21:03:40 +0800 Subject: [PATCH 192/587] remove nip45 code block type remove nip45 code block type and then code will not highlight error. --- 45.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/45.md b/45.md index 780dfb6b..6b253960 100644 --- a/45.md +++ b/45.md @@ -16,14 +16,14 @@ Some queries a client may want to execute against connected relays are prohibiti This 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. -```json +``` ["COUNT", <subscription_id>, <filters JSON>...] ``` Counts are returned using a `COUNT` response in the form `{"count": <integer>}`. Relays may use probabilistic counts to reduce compute requirements. In case a relay uses probabilistic counts, it MAY indicate it in the response with `approximate` key i.e. `{"count": <integer>, "approximate": <true|false>}`. -```json +``` ["COUNT", <subscription_id>, {"count": <integer>}] ``` @@ -33,14 +33,14 @@ Whenever the relay decides to refuse to fulfill the `COUNT` request, it MUST ret ### Followers count -```json +``` ["COUNT", <subscription_id>, {"kinds": [3], "#p": [<pubkey>]}] ["COUNT", <subscription_id>, {"count": 238}] ``` ### Count posts and reactions -```json +``` ["COUNT", <subscription_id>, {"kinds": [1, 7], "authors": [<pubkey>]}] ["COUNT", <subscription_id>, {"count": 5}] ``` From dea4bebf4b1bf36feeb8a066bccf62b9b1aeb5c5 Mon Sep 17 00:00:00 2001 From: Terry Yiu <963907+tyiu@users.noreply.github.com> Date: Tue, 6 Aug 2024 23:55:47 -0400 Subject: [PATCH 193/587] Amend NIP-52 to include e and p tags to calendar event RSVPs --- 52.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/52.md b/52.md index f35d9040..077c8472 100644 --- a/52.md +++ b/52.md @@ -178,6 +178,12 @@ This NIP is intentionally not defining who is authorized to attend a calendar ev This NIP is also intentionally not defining what happens if a calendar event changes after an RSVP is submitted. +The RSVP MUST tag the calendar event it is in response to with an `e` tag on the calendar event's id. + +The RSVP MAY tag use an `a` tag to the calendar event's event coordinates to indicate that the RSVP response could hold trueregardless of any future revisions to the calendar event. If the `a` tag is omitted, the author of the RSVP is explicitly indicating that its response holds true for only that specific revision of the calendar event from the `e` tag. + +The 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. + ### Format The format uses a parameterized replaceable event kind `31925`. @@ -185,10 +191,12 @@ The format uses a parameterized replaceable event kind `31925`. The `.content` of these events is optional and should be a free-form note that adds more context to this calendar event response. The list of tags are as follows: -* `a` (required) reference tag to kind `31922` or `31923` calendar event being responded to. +* `e` (required) event tag to kind `31922` or `31923` calendar event being responded to. +* `a` (optional) reference tag to kind `31922` or `31923` calendar event being responded to. * `d` (required) universally unique identifier. Generated by the client creating the calendar event RSVP. * `status` (required) `accepted`, `declined`, or `tentative`. Determines attendance status to the referenced calendar event. * `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`. +* `p` (optional) author of the calendar event being responded to. ```json { @@ -198,10 +206,12 @@ The list of tags are as follows: "kind": 31925, "content": "<note>", "tags": [ - ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"], + ["e", "<kind 31922 or 31923 event id", "<optional recommended relay URL>"] + ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional recommended relay URL>"], ["d", "<UUID>"], ["status", "<accepted/declined/tentative>"], ["fb", "<free/busy>"], + ["p", "<hex pubkey of kind 31922 or 31923 event>", "<optional recommended relay URL>"] ] } ``` From 6de688f4594aa2c22b348669bdca6a503a6bf568 Mon Sep 17 00:00:00 2001 From: Vic <88121568+vicariousdrama@users.noreply.github.com> Date: Wed, 7 Aug 2024 08:45:21 +0000 Subject: [PATCH 194/587] Add used fields to Calendar Time Event in NIP-52 (#1137) * Add used fields to Calendar Time Event in NIP-52 Cornychat.com relies on a `t` tag of `audiospace` for filtering. Flockstr.com relies on optional and previously undocumented `audio` and `image` tags for rendering. * Update 52.md * Change tag for `about` to `summary` --- 52.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/52.md b/52.md index f35d9040..97873ef0 100644 --- a/52.md +++ b/52.md @@ -90,9 +90,12 @@ The list of tags are as follows: * `end` (optional) exclusive end Unix timestamp in seconds. If omitted, the calendar event ends instantaneously. * `start_tzid` (optional) time zone of the start timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica` * `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. +* `summary` (optional) brief description of the calendar event +* `image` (optional) url of an image to use for the event * `location` (optional, repeated) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call * `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location * `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting +* `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 * `t` (optional, repeated) hashtag to categorize calendar event * `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. @@ -110,6 +113,8 @@ The following tags are deprecated: ["d", "<UUID>"], ["title", "<title of calendar event>"], + ["summary", "<brief description of the calendar event>"], + ["image", "<string with image URI>"], // Timestamps ["start", "<Unix timestamp in seconds>"], @@ -126,6 +131,10 @@ The following tags are deprecated: ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"], ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"], + // Labels (example using com.cornychat namespace denoting the event as an audiospace) + ["L", "com.cornychat"], + ["l", "audiospace", "com.cornychat"], + // Hashtags ["t", "<tag>"], ["t", "<tag>"], From d36b24c82a07ad9769d5ff9aa2e01cfa65ca0614 Mon Sep 17 00:00:00 2001 From: Terry Yiu <963907+tyiu@users.noreply.github.com> Date: Thu, 8 Aug 2024 01:04:25 -0400 Subject: [PATCH 195/587] Revise NIP-52 amendments so that they are backwards compatible --- 52.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/52.md b/52.md index fb857374..2b2f6db6 100644 --- a/52.md +++ b/52.md @@ -187,9 +187,11 @@ This NIP is intentionally not defining who is authorized to attend a calendar ev This NIP is also intentionally not defining what happens if a calendar event changes after an RSVP is submitted. -The RSVP MUST tag the calendar event it is in response to with an `e` tag on the calendar event's id. +The RSVP MUST have at least one of an `a` tag of the event coordinates to the calendar event, or `e` tag of the id of the specific calendar event revision. -The RSVP MAY tag use an `a` tag to the calendar event's event coordinates to indicate that the RSVP response could hold trueregardless of any future revisions to the calendar event. If the `a` tag is omitted, the author of the RSVP is explicitly indicating that its response holds true for only that specific revision of the calendar event from the `e` tag. +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. + +If an `a` tag is present, clients SHOULD interpret it as an indication that the RSVP may hold true for all revisions of the calendar event. The 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. @@ -200,12 +202,12 @@ The format uses a parameterized replaceable event kind `31925`. The `.content` of these events is optional and should be a free-form note that adds more context to this calendar event response. The list of tags are as follows: -* `e` (required) event tag to kind `31922` or `31923` calendar event being responded to. -* `a` (optional) reference tag to kind `31922` or `31923` calendar event being responded to. +* `e` (optional) event id of a kind `31922` or `31923` calendar event being responded to. This tag is required if `a` is omitted. +* `a` (optional) coordinates to a kind `31922` or `31923` calendar event being responded to. This tag is required if `e` is omitted. * `d` (required) universally unique identifier. Generated by the client creating the calendar event RSVP. * `status` (required) `accepted`, `declined`, or `tentative`. Determines attendance status to the referenced calendar event. * `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`. -* `p` (optional) author of the calendar event being responded to. +* `p` (optional) pubkey of the author of the calendar event being responded to. ```json { From 744bce8fcae0aca07b936b6662db635c8b4253dd Mon Sep 17 00:00:00 2001 From: Don <496156+nikolat@users.noreply.github.com> Date: Fri, 9 Aug 2024 00:36:08 +0900 Subject: [PATCH 196/587] NIP-25: reactions to a website (#1381) * NIP-25: reactions to a website * add note about URL normalization --------- Co-authored-by: fiatjaf_ <fiatjaf@gmail.com> --- 25.md | 20 ++++++++++++++++++++ README.md | 3 ++- 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/25.md b/25.md index 17c203e1..f0386034 100644 --- a/25.md +++ b/25.md @@ -52,6 +52,26 @@ func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> Nost } ``` +Reactions to a website +--------------------- + +If 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. + +```json +{ + "kind": 17, + "content": "⭐", + "tags": [ + ["r", "https://example.com/"] + ], + ...other fields +} +``` + +URLs SHOULD be [normalized](https://datatracker.ietf.org/doc/html/rfc3986#section-6), so that reactions to the same website are not omitted from queries. +A fragment MAY be attached to the URL, to react to a section of the page. +It should be noted that a URL with a fragment is not considered to be the same URL as the original. + Custom Emoji Reaction --------------------- diff --git a/README.md b/README.md index 6c83ba88..d6840fcd 100644 --- a/README.md +++ b/README.md @@ -109,6 +109,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `13` | Seal | [59](59.md) | | `14` | Direct Message | [17](17.md) | | `16` | Generic Repost | [18](18.md) | +| `17` | Reaction to a website | [25](25.md) | | `40` | Channel Creation | [28](28.md) | | `41` | Channel Metadata | [28](28.md) | | `42` | Channel Message | [28](28.md) | @@ -245,7 +246,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `L` | label namespace | -- | [32](32.md) | | `m` | MIME type | -- | [94](94.md) | | `q` | event id (hex) | relay URL | [18](18.md) | -| `r` | a reference (URL, etc) | petname | [24](24.md) | +| `r` | a reference (URL, etc) | -- | [24](24.md), [25](25.md) | | `r` | relay url | marker | [65](65.md) | | `t` | hashtag | -- | | | `alt` | summary | -- | [31](31.md) | From ec1f0fcadaa7b62cc17633cc5a86686e85ebe7a6 Mon Sep 17 00:00:00 2001 From: Terry Yiu <963907+tyiu@users.noreply.github.com> Date: Sun, 11 Aug 2024 15:50:39 -0400 Subject: [PATCH 197/587] Update NIP-52 change to not be backwards incompatible by restoring required 'a' tag and clarify how clients should or may interpret the optional 'e' tag --- 52.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/52.md b/52.md index 2b2f6db6..bedf613c 100644 --- a/52.md +++ b/52.md @@ -187,11 +187,7 @@ This NIP is intentionally not defining who is authorized to attend a calendar ev This NIP is also intentionally not defining what happens if a calendar event changes after an RSVP is submitted. -The RSVP MUST have at least one of an `a` tag of the event coordinates to the calendar event, or `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. - -If an `a` tag is present, clients SHOULD interpret it as an indication that the RSVP may hold true for all revisions of the calendar event. +The 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. The 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. @@ -202,8 +198,8 @@ The format uses a parameterized replaceable event kind `31925`. The `.content` of these events is optional and should be a free-form note that adds more context to this calendar event response. The list of tags are as follows: -* `e` (optional) event id of a kind `31922` or `31923` calendar event being responded to. This tag is required if `a` is omitted. -* `a` (optional) coordinates to a kind `31922` or `31923` calendar event being responded to. This tag is required if `e` is omitted. +* `a` (required) coordinates to a kind `31922` or `31923` calendar event being responded to. +* `e` (optional) event id of a kind `31922` or `31923` calendar event being responded to. * `d` (required) universally unique identifier. Generated by the client creating the calendar event RSVP. * `status` (required) `accepted`, `declined`, or `tentative`. Determines attendance status to the referenced calendar event. * `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`. From e44491466836abfc567a9652392205d02b803ca7 Mon Sep 17 00:00:00 2001 From: theborakompanioni <theborakompanioni+github@gmail.com> Date: Thu, 28 Dec 2023 14:59:53 +0100 Subject: [PATCH 198/587] docs(NIP-64): Portable Game Notation --- 64.md | 125 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 125 insertions(+) create mode 100644 64.md diff --git a/64.md b/64.md new file mode 100644 index 00000000..b65fb569 --- /dev/null +++ b/64.md @@ -0,0 +1,125 @@ +NIP-64 +====== + +Portable Game Notation +----- + +`draft` `optional` + +This NIP defines `kind:30` notes representing Chess games in [PGN][pgn_specification] format, which can be read by humans and is also supported by most chess software. + +## Note + +### Content + +The `.content` of these notes is a string representing a [PGN-database][pgn_formal_syntax]. + +### Tags + +A note can contain `e` tags of each move or a subset of moves with the hashed piece placement data of a [FEN][fen_wikipedia] string, e.g. +```shell +sha256('rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR') := '63e2bcdcf5b275cd48b535ed210fb321197c4296b08d04329ca2d8f4391342a4' +sha256('8/8/4R1p1/2k3p1/1p4P1/1P1b1P2/3K1n2/8') := 'e8f876dfe8adac7ee02413f2160bae5808b7ea27a190cc7d4896d5e64f600c3d' +``` + +```json +[ "e", "63e2bcdcf5b275cd48b535ed210fb321197c4296b08d04329ca2d8f4391342a4"] +[ "e", "e8f876dfe8adac7ee02413f2160bae5808b7ea27a190cc7d4896d5e64f600c3d"] +``` + +## Example + +### Content + +```pgn +// A game where nothing is known. Game still in progress, game abandoned, or result otherwise unknown. +// Maybe players died before a move has been made. +* +``` + +```pgn +1. e4 * +``` + +```pgn +[White "Fischer, Robert J."] +[Black "Spassky, Boris V."] + +1. e4 e5 2. Nf3 Nc6 3. Bb5 {This opening is called the Ruy Lopez.} * +``` + +```pgn +[Event "F/S Return Match"] +[Site "Belgrade, Serbia JUG"] +[Date "1992.11.04"] +[Round "29"] +[White "Fischer, Robert J."] +[Black "Spassky, Boris V."] +[Result "1/2-1/2"] + +1. e4 e5 2. Nf3 Nc6 3. Bb5 {This opening is called the Ruy Lopez.} 3... a6 +4. Ba4 Nf6 5. O-O Be7 6. Re1 b5 7. Bb3 d6 8. c3 O-O 9. h3 Nb8 10. d4 Nbd7 +11. c4 c6 12. cxb5 axb5 13. Nc3 Bb7 14. Bg5 b4 15. Nb1 h6 16. Bh4 c5 17. dxe5 +Nxe4 18. Bxe7 Qxe7 19. exd6 Qf6 20. Nbd2 Nxd6 21. Nc4 Nxc4 22. Bxc4 Nb6 +23. Ne5 Rae8 24. Bxf7+ Rxf7 25. Nxf7 Rxe1+ 26. Qxe1 Kxf7 27. Qe3 Qg5 28. Qxg5 +hxg5 29. b3 Ke6 30. a3 Kd6 31. axb4 cxb4 32. Ra5 Nd5 33. f3 Bc8 34. Kf2 Bf5 +35. Ra7 g6 36. Ra6+ Kc5 37. Ke1 Nf4 38. g3 Nxh3 39. Kd2 Kb5 40. Rd6 Kc5 41. Ra6 +Nf2 42. g4 Bd3 43. Re6 1/2-1/2 +``` + +### Notes + +```json +{ + "kind": 30, + "content": "1. e4 *", + ... +} +``` + +```json +{ + "kind": 30, + "tags": [ + ["alt", "Fischer vs. Spassky in Belgrade on 1992-11-04 (F/S Return Match, Round 29)"], + [ "e", "63e2bcdcf5b275cd48b535ed210fb321197c4296b08d04329ca2d8f4391342a4"], + ... + [ "e", "e8f876dfe8adac7ee02413f2160bae5808b7ea27a190cc7d4896d5e64f600c3d"] + ], + "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" + ... +} +``` + +## Client Behavior + +Clients SHOULD check whether the formatting is valid and all moves comply with chess rules. + +Clients SHOULD display the content represented as chessboard. + +Clients 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). + +Clients SHOULD add `e` tags of each move or a subset of moves (hashed piece placement data of a [FEN][fen_wikipedia] string) in order to improve discoverability of certain board positions. + +Clients 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. + +## Relay Behavior + +Relays MAY validate PGN contents and reject invalid notes. + +## Resources +- [PGN Specification][pgn_specification]: PGN (Portable Game Notation) specification +- [PGN Specification Supplement](https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-spec-supplement.md): Addition for adding graphical elements, clock values, eval, ... +- [PGN Formal Syntax][pgn_formal_syntax] +- [PGN Seven Tag Roster][pgn_seven_tag_roster] +- [PGN Import Format][pgn_import_format] +- [PGN Export Format][pgn_export_format] +- [Forsyth–Edwards Notation (FEN)][fen_wikipedia] +- [lichess / pgn-viewer (GitHub)](https://github.com/lichess-org/pgn-viewer): PGN viewer widget, designed to be embedded in content pages + +[pgn_specification]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md +[pgn_formal_syntax]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md#18-formal-syntax +[pgn_seven_tag_roster]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md#811-seven-tag-roster +[pgn_import_format]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md#31-import-format-allows-for-manually-prepared-data +[pgn_export_format]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md#32-export-format-used-for-program-generated-output +[fen_wikipedia]: https://en.wikipedia.org/wiki/Forsyth%E2%80%93Edwards_Notation From d476dea62ff54a3efda98ff8af027e5e6a3cb6ff Mon Sep 17 00:00:00 2001 From: theborakompanioni <theborakompanioni+github@gmail.com> Date: Wed, 28 Feb 2024 16:16:34 +0100 Subject: [PATCH 199/587] docs(NIP-64): remove FEN tags --- 64.md | 19 ------------------- 1 file changed, 19 deletions(-) diff --git a/64.md b/64.md index b65fb569..8ea0ac65 100644 --- a/64.md +++ b/64.md @@ -14,19 +14,6 @@ This NIP defines `kind:30` notes representing Chess games in [PGN][pgn_specifica The `.content` of these notes is a string representing a [PGN-database][pgn_formal_syntax]. -### Tags - -A note can contain `e` tags of each move or a subset of moves with the hashed piece placement data of a [FEN][fen_wikipedia] string, e.g. -```shell -sha256('rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR') := '63e2bcdcf5b275cd48b535ed210fb321197c4296b08d04329ca2d8f4391342a4' -sha256('8/8/4R1p1/2k3p1/1p4P1/1P1b1P2/3K1n2/8') := 'e8f876dfe8adac7ee02413f2160bae5808b7ea27a190cc7d4896d5e64f600c3d' -``` - -```json -[ "e", "63e2bcdcf5b275cd48b535ed210fb321197c4296b08d04329ca2d8f4391342a4"] -[ "e", "e8f876dfe8adac7ee02413f2160bae5808b7ea27a190cc7d4896d5e64f600c3d"] -``` - ## Example ### Content @@ -82,9 +69,7 @@ Nf2 42. g4 Bd3 43. Re6 1/2-1/2 "kind": 30, "tags": [ ["alt", "Fischer vs. Spassky in Belgrade on 1992-11-04 (F/S Return Match, Round 29)"], - [ "e", "63e2bcdcf5b275cd48b535ed210fb321197c4296b08d04329ca2d8f4391342a4"], ... - [ "e", "e8f876dfe8adac7ee02413f2160bae5808b7ea27a190cc7d4896d5e64f600c3d"] ], "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" ... @@ -99,8 +84,6 @@ Clients SHOULD display the content represented as chessboard. Clients 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). -Clients SHOULD add `e` tags of each move or a subset of moves (hashed piece placement data of a [FEN][fen_wikipedia] string) in order to improve discoverability of certain board positions. - Clients 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. ## Relay Behavior @@ -114,7 +97,6 @@ Relays MAY validate PGN contents and reject invalid notes. - [PGN Seven Tag Roster][pgn_seven_tag_roster] - [PGN Import Format][pgn_import_format] - [PGN Export Format][pgn_export_format] -- [Forsyth–Edwards Notation (FEN)][fen_wikipedia] - [lichess / pgn-viewer (GitHub)](https://github.com/lichess-org/pgn-viewer): PGN viewer widget, designed to be embedded in content pages [pgn_specification]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md @@ -122,4 +104,3 @@ Relays MAY validate PGN contents and reject invalid notes. [pgn_seven_tag_roster]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md#811-seven-tag-roster [pgn_import_format]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md#31-import-format-allows-for-manually-prepared-data [pgn_export_format]: https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md#32-export-format-used-for-program-generated-output -[fen_wikipedia]: https://en.wikipedia.org/wiki/Forsyth%E2%80%93Edwards_Notation From 653642205e3e807c65b2e9b64f5325c7179c447c Mon Sep 17 00:00:00 2001 From: theborakompanioni <theborakompanioni+github@gmail.com> Date: Wed, 28 Feb 2024 16:35:30 +0100 Subject: [PATCH 200/587] docs(NIP-64): move examples section to bottom --- 64.md | 120 ++++++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 80 insertions(+), 40 deletions(-) diff --git a/64.md b/64.md index 8ea0ac65..bef63262 100644 --- a/64.md +++ b/64.md @@ -14,46 +14,6 @@ This NIP defines `kind:30` notes representing Chess games in [PGN][pgn_specifica The `.content` of these notes is a string representing a [PGN-database][pgn_formal_syntax]. -## Example - -### Content - -```pgn -// A game where nothing is known. Game still in progress, game abandoned, or result otherwise unknown. -// Maybe players died before a move has been made. -* -``` - -```pgn -1. e4 * -``` - -```pgn -[White "Fischer, Robert J."] -[Black "Spassky, Boris V."] - -1. e4 e5 2. Nf3 Nc6 3. Bb5 {This opening is called the Ruy Lopez.} * -``` - -```pgn -[Event "F/S Return Match"] -[Site "Belgrade, Serbia JUG"] -[Date "1992.11.04"] -[Round "29"] -[White "Fischer, Robert J."] -[Black "Spassky, Boris V."] -[Result "1/2-1/2"] - -1. e4 e5 2. Nf3 Nc6 3. Bb5 {This opening is called the Ruy Lopez.} 3... a6 -4. Ba4 Nf6 5. O-O Be7 6. Re1 b5 7. Bb3 d6 8. c3 O-O 9. h3 Nb8 10. d4 Nbd7 -11. c4 c6 12. cxb5 axb5 13. Nc3 Bb7 14. Bg5 b4 15. Nb1 h6 16. Bh4 c5 17. dxe5 -Nxe4 18. Bxe7 Qxe7 19. exd6 Qf6 20. Nbd2 Nxd6 21. Nc4 Nxc4 22. Bxc4 Nb6 -23. Ne5 Rae8 24. Bxf7+ Rxf7 25. Nxf7 Rxe1+ 26. Qxe1 Kxf7 27. Qe3 Qg5 28. Qxg5 -hxg5 29. b3 Ke6 30. a3 Kd6 31. axb4 cxb4 32. Ra5 Nd5 33. f3 Bc8 34. Kf2 Bf5 -35. Ra7 g6 36. Ra6+ Kc5 37. Ke1 Nf4 38. g3 Nxh3 39. Kd2 Kb5 40. Rd6 Kc5 41. Ra6 -Nf2 42. g4 Bd3 43. Re6 1/2-1/2 -``` - ### Notes ```json @@ -90,6 +50,86 @@ Clients MAY include additional tags (e.g. like [`"alt"`](https://github.com/nost Relays MAY validate PGN contents and reject invalid notes. + +## Examples + +```pgn +// A game where nothing is known. Game still in progress, game abandoned, or result otherwise unknown. +// Maybe players died before a move has been made. +* +``` + +```pgn +1. e4 * +``` + +```pgn +[White "Fischer, Robert J."] +[Black "Spassky, Boris V."] + +1. e4 e5 2. Nf3 Nc6 3. Bb5 {This opening is called the Ruy Lopez.} * +``` + +```pgn +[Event "F/S Return Match"] +[Site "Belgrade, Serbia JUG"] +[Date "1992.11.04"] +[Round "29"] +[White "Fischer, Robert J."] +[Black "Spassky, Boris V."] +[Result "1/2-1/2"] + +1. e4 e5 2. Nf3 Nc6 3. Bb5 {This opening is called the Ruy Lopez.} 3... a6 +4. Ba4 Nf6 5. O-O Be7 6. Re1 b5 7. Bb3 d6 8. c3 O-O 9. h3 Nb8 10. d4 Nbd7 +11. c4 c6 12. cxb5 axb5 13. Nc3 Bb7 14. Bg5 b4 15. Nb1 h6 16. Bh4 c5 17. dxe5 +Nxe4 18. Bxe7 Qxe7 19. exd6 Qf6 20. Nbd2 Nxd6 21. Nc4 Nxc4 22. Bxc4 Nb6 +23. Ne5 Rae8 24. Bxf7+ Rxf7 25. Nxf7 Rxe1+ 26. Qxe1 Kxf7 27. Qe3 Qg5 28. Qxg5 +hxg5 29. b3 Ke6 30. a3 Kd6 31. axb4 cxb4 32. Ra5 Nd5 33. f3 Bc8 34. Kf2 Bf5 +35. Ra7 g6 36. Ra6+ Kc5 37. Ke1 Nf4 38. g3 Nxh3 39. Kd2 Kb5 40. Rd6 Kc5 41. Ra6 +Nf2 42. g4 Bd3 43. Re6 1/2-1/2 +``` + +```pgn +[Event "Hourly HyperBullet Arena"] +[Site "https://lichess.org/wxx4GldJ"] +[Date "2017.04.01"] +[White "T_LUKE"] +[Black "decidement"] +[Result "1-0"] +[UTCDate "2017.04.01"] +[UTCTime "11:56:14"] +[WhiteElo "2047"] +[BlackElo "1984"] +[WhiteRatingDiff "+10"] +[BlackRatingDiff "-7"] +[Variant "Standard"] +[TimeControl "30+0"] +[ECO "B00"] +[Termination "Abandoned"] + +1. e4 1-0 + + +[Event "Hourly HyperBullet Arena"] +[Site "https://lichess.org/rospUdSk"] +[Date "2017.04.01"] +[White "Bastel"] +[Black "oslochess"] +[Result "1-0"] +[UTCDate "2017.04.01"] +[UTCTime "11:55:56"] +[WhiteElo "2212"] +[BlackElo "2000"] +[WhiteRatingDiff "+6"] +[BlackRatingDiff "-4"] +[Variant "Standard"] +[TimeControl "30+0"] +[ECO "A01"] +[Termination "Normal"] + +1. 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 +``` + ## Resources - [PGN Specification][pgn_specification]: PGN (Portable Game Notation) specification - [PGN Specification Supplement](https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-spec-supplement.md): Addition for adding graphical elements, clock values, eval, ... From e735ef9aeff1e5d18d0dfa7a163b1bdc63ee742e Mon Sep 17 00:00:00 2001 From: theborakompanioni <theborakompanioni+github@gmail.com> Date: Wed, 28 Feb 2024 16:41:40 +0100 Subject: [PATCH 201/587] docs(NIP-64): change kind from 30 to 64 --- 64.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/64.md b/64.md index bef63262..dd6ee849 100644 --- a/64.md +++ b/64.md @@ -6,7 +6,7 @@ Portable Game Notation `draft` `optional` -This NIP defines `kind:30` notes representing Chess games in [PGN][pgn_specification] format, which can be read by humans and is also supported by most chess software. +This NIP defines `kind:64` notes representing games in [PGN][pgn_specification] format, which can be read by humans and is also supported by most chess software. ## Note @@ -18,7 +18,7 @@ The `.content` of these notes is a string representing a [PGN-database][pgn_form ```json { - "kind": 30, + "kind": 64, "content": "1. e4 *", ... } @@ -26,7 +26,7 @@ The `.content` of these notes is a string representing a [PGN-database][pgn_form ```json { - "kind": 30, + "kind": 64, "tags": [ ["alt", "Fischer vs. Spassky in Belgrade on 1992-11-04 (F/S Return Match, Round 29)"], ... @@ -38,12 +38,12 @@ The `.content` of these notes is a string representing a [PGN-database][pgn_form ## Client Behavior -Clients SHOULD check whether the formatting is valid and all moves comply with chess rules. - Clients SHOULD display the content represented as chessboard. Clients 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). +Clients SHOULD check whether the formatting is valid and all moves comply with chess rules. + Clients 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. ## Relay Behavior From 5d37fea585f93fb98743f37f5f1318894b99a246 Mon Sep 17 00:00:00 2001 From: theborakompanioni <theborakompanioni+github@gmail.com> Date: Fri, 8 Mar 2024 13:26:47 +0100 Subject: [PATCH 202/587] docs(NIP-64): add chess to title make clear that the nip is about chess --- 64.md | 4 ++-- README.md | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/64.md b/64.md index dd6ee849..6d8d3736 100644 --- a/64.md +++ b/64.md @@ -1,12 +1,12 @@ NIP-64 ====== -Portable Game Notation +Chess (Portable Game Notation) ----- `draft` `optional` -This NIP defines `kind:64` notes representing games in [PGN][pgn_specification] format, which can be read by humans and is also supported by most chess software. +This 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. ## Note diff --git a/README.md b/README.md index d6840fcd..82778f85 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-57: Lightning Zaps](57.md) - [NIP-58: Badges](58.md) - [NIP-59: Gift Wrap](59.md) +- [NIP-64: Chess (PGN)](64.md) - [NIP-65: Relay List Metadata](65.md) - [NIP-70: Protected Events](70.md) - [NIP-71: Video Events](71.md) @@ -115,6 +116,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `42` | Channel Message | [28](28.md) | | `43` | Channel Hide Message | [28](28.md) | | `44` | Channel Mute User | [28](28.md) | +| `64` | Chess (PGN) | [64](64.md) | | `818` | Merge Requests | [54](54.md) | | `1021` | Bid | [15](15.md) | | `1022` | Bid confirmation | [15](15.md) | From 452fcc05a0b8e3ed1554aafc6ca1aea20bfc1835 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Wed, 14 Aug 2024 23:44:30 +0900 Subject: [PATCH 203/587] README: add NIP-52 link to `image` and `summary` tags --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 82778f85..e9a10a45 100644 --- a/README.md +++ b/README.md @@ -264,7 +264,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `encrypted` | -- | -- | [90](90.md) | | `expiration` | unix timestamp (string) | -- | [40](40.md) | | `goal` | event id (hex) | relay URL | [75](75.md) | -| `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | +| `image` | image URL | dimensions in pixels | [23](23.md), [52](52.md), [58](58.md) | | `imeta` | inline metadata | -- | [92](92.md) | | `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | | `location` | location string | -- | [52](52.md), [99](99.md) | @@ -278,7 +278,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `relays` | relay list | -- | [57](57.md) | | `server` | file storage server url | -- | [96](96.md) | | `subject` | subject | -- | [14](14.md), [17](17.md) | -| `summary` | article summary | -- | [23](23.md) | +| `summary` | summary | -- | [23](23.md), [52](52.md) | | `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | | `title` | article title | -- | [23](23.md) | | `web` | webpage URL | -- | [34](34.md) | From 95885afe2da245b0c4d80b91e9e44ee7f5ad447f Mon Sep 17 00:00:00 2001 From: Terry Yiu <963907+tyiu@users.noreply.github.com> Date: Wed, 14 Aug 2024 20:02:13 -0400 Subject: [PATCH 204/587] Update NIP-09 to rename deletion to retraction --- 09.md | 26 ++++++++++++++------------ 32.md | 2 +- 34.md | 2 +- 71.md | 2 +- 72.md | 2 +- 90.md | 2 +- README.md | 4 ++-- 7 files changed, 21 insertions(+), 19 deletions(-) diff --git a/09.md b/09.md index b6aa72c7..f153aba1 100644 --- a/09.md +++ b/09.md @@ -1,14 +1,14 @@ NIP-09 ====== -Event Deletion +Event Retraction -------------- `draft` `optional` -A special event with kind `5`, meaning "deletion" 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 deleted. +A special event with kind `5`, meaning "retraction" is defined as having a list of one or more `e` or `a` tags, each referencing an event the author is requesting to be retracted. Retraction requests SHOULD include a `k` tag for the kind of each event being retracted. -The event's `content` field MAY contain a text note describing the reason for the deletion. +The event's `content` field MAY contain a text note describing the reason for the retraction. For example: @@ -28,24 +28,26 @@ For example: } ``` -Relays 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. +Relays SHOULD delete or stop publishing any referenced events that have an identical `pubkey` as the retraction request. Clients SHOULD hide or otherwise indicate a retraction status for referenced events. -Relays 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. +Relays SHOULD continue to publish/share the retraction events indefinitely, as clients may already have the event that's intended to be retracted. Additionally, clients SHOULD broadcast retraction events to other relays which don't have it. -When an `a` tag is used, relays SHOULD delete all versions of the replaceable event up to the `created_at` timestamp of the deletion event. +When an `a` tag is used, relays SHOULD delete all versions of the replaceable event up to the `created_at` timestamp of the retraction event. ## Client Usage -Clients 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. +Clients MAY choose to fully hide any events that are referenced by valid retraction 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 retracted events' own content, although a user interface should clearly indicate that this is a retraction reason, not the original content. -A 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. +A client MUST validate that each event `pubkey` referenced in the `e` tag of the retraction request is identical to the retraction request `pubkey`, before hiding or deleting any event. Relays can not, in general, perform this validation and should not be treated as authoritative. -Clients display the deletion event itself in any way they choose, e.g., not at all, or with a prominent notice. +Clients display the retraction event itself in any way they choose, e.g., not at all, or with a prominent notice. + +Clients MAY choose to inform the user that their request for retraction does not guarantee deletion because it is impossible to delete events from all relays and clients. ## Relay Usage -Relays 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. +Relays MAY validate that a retraction event only references events that have the same `pubkey` as the retraction itself, however this is not required since relays may not have knowledge of all referenced events. -## Deleting a Deletion +## Retracting a Retraction -Publishing a deletion event against a deletion has no effect. Clients and relays are not obliged to support "undelete" functionality. +Publishing a retraction event against a retraction has no effect. Clients and relays are not obliged to support "unretract" functionality. diff --git a/32.md b/32.md index 0fb765a7..08966fcd 100644 --- a/32.md +++ b/32.md @@ -145,7 +145,7 @@ Author is labeling their note language as English using ISO-639-1. Other Notes ----------- -When using this NIP to bulk-label many targets at once, events may be deleted and a replacement +When using this NIP to bulk-label many targets at once, events may be retracted using [NIP-09](09.md) and a replacement may be published. We have opted not to use parameterizable/replaceable events for this due to the complexity in coming up with a standard `d` tag. In order to avoid ambiguity when querying, publishers SHOULD limit labeling events to a single namespace. diff --git a/34.md b/34.md index 4989803d..14c76058 100644 --- a/34.md +++ b/34.md @@ -53,7 +53,7 @@ An optional source of truth for the state of branches and tags in a repository. The `refs` tag may appear multiple times, or none. -If 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. +If 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) retraction. The `refs` tag can be optionally extended to enable clients to identify how many commits ahead a ref is: diff --git a/71.md b/71.md index a811434c..51ea4b91 100644 --- a/71.md +++ b/71.md @@ -6,7 +6,7 @@ Video Events `draft` `optional` -This 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). +This specification defines video events representing a dedicated post of externally hosted content. These video events are _parameterized replaceable_ and retractable per [NIP-09](09.md). Unlike 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. diff --git a/72.md b/72.md index d19b80b4..ffa921f6 100644 --- a/72.md +++ b/72.md @@ -62,7 +62,7 @@ An approval event MUST include one or more community `a` tags, an `e` or `a` tag The 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. -Moderators MAY delete their approval of a post at any time using NIP 09 event deletions. +Moderators MAY retract their approval of a post at any time using NIP 09 event retractions. ```jsonc { diff --git a/90.md b/90.md index 5a15ebb6..a5f85873 100644 --- a/90.md +++ b/90.md @@ -199,7 +199,7 @@ Some service providers might choose to submit a `payment-required` as the first It's not up to this NIP to define how individual vending machines should choose to run their business. # Cancellation -A job request might be canceled by publishing a `kind:5` delete request event tagging the job request event. +A job request might be canceled by publishing a `kind:5` retract request event tagging the job request event. # Appendix 1: Job chaining A 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/README.md b/README.md index e9a10a45..3cc5fe6b 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 - [NIP-06: Basic key derivation from mnemonic seed phrase](06.md) - [NIP-07: `window.nostr` capability for web browsers](07.md) - [NIP-08: Handling Mentions](08.md) --- **unrecommended**: deprecated in favor of [NIP-27](27.md) -- [NIP-09: Event Deletion](09.md) +- [NIP-09: Event Retraction](09.md) - [NIP-10: Conventions for clients' use of `e` and `p` tags in text events](10.md) - [NIP-11: Relay Information Document](11.md) - [NIP-13: Proof of Work](13.md) @@ -99,7 +99,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `2` | Recommend Relay | 01 (deprecated) | | `3` | Follows | [02](02.md) | | `4` | Encrypted Direct Messages | [04](04.md) | -| `5` | Event Deletion | [09](09.md) | +| `5` | Event Retraction | [09](09.md) | | `6` | Repost | [18](18.md) | | `7` | Reaction | [25](25.md) | | `8` | Badge Award | [58](58.md) | From 0ee877275a339d7a29915ddb6a4b37feb714c61d Mon Sep 17 00:00:00 2001 From: Terry Yiu <963907+tyiu@users.noreply.github.com> Date: Thu, 15 Aug 2024 01:19:07 -0400 Subject: [PATCH 205/587] Update NIP-09 to rename to deletion request --- 09.md | 26 +++++++++++++------------- 32.md | 2 +- 34.md | 2 +- 71.md | 2 +- 72.md | 2 +- 90.md | 2 +- README.md | 4 ++-- 7 files changed, 20 insertions(+), 20 deletions(-) diff --git a/09.md b/09.md index f153aba1..e1be5429 100644 --- a/09.md +++ b/09.md @@ -1,14 +1,14 @@ NIP-09 ====== -Event Retraction +Event Deletion Request -------------- `draft` `optional` -A special event with kind `5`, meaning "retraction" is defined as having a list of one or more `e` or `a` tags, each referencing an event the author is requesting to be retracted. Retraction requests SHOULD include a `k` tag for the kind of each event being retracted. +A 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. -The event's `content` field MAY contain a text note describing the reason for the retraction. +The event's `content` field MAY contain a text note describing the reason for the deletion request. For example: @@ -28,26 +28,26 @@ For example: } ``` -Relays SHOULD delete or stop publishing any referenced events that have an identical `pubkey` as the retraction request. Clients SHOULD hide or otherwise indicate a retraction status for referenced events. +Relays 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. -Relays SHOULD continue to publish/share the retraction events indefinitely, as clients may already have the event that's intended to be retracted. Additionally, clients SHOULD broadcast retraction events to other relays which don't have it. +Relays 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. -When an `a` tag is used, relays SHOULD delete all versions of the replaceable event up to the `created_at` timestamp of the retraction event. +When 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. ## Client Usage -Clients MAY choose to fully hide any events that are referenced by valid retraction 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 retracted events' own content, although a user interface should clearly indicate that this is a retraction reason, not the original content. +Clients 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. -A client MUST validate that each event `pubkey` referenced in the `e` tag of the retraction request is identical to the retraction request `pubkey`, before hiding or deleting any event. Relays can not, in general, perform this validation and should not be treated as authoritative. +A 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. -Clients display the retraction event itself in any way they choose, e.g., not at all, or with a prominent notice. +Clients display the deletion request event itself in any way they choose, e.g., not at all, or with a prominent notice. -Clients MAY choose to inform the user that their request for retraction does not guarantee deletion because it is impossible to delete events from all relays and clients. +Clients 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. ## Relay Usage -Relays MAY validate that a retraction event only references events that have the same `pubkey` as the retraction itself, however this is not required since relays may not have knowledge of all referenced events. +Relays 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. -## Retracting a Retraction +## Deletion Request of a Deletion Request -Publishing a retraction event against a retraction has no effect. Clients and relays are not obliged to support "unretract" functionality. +Publishing 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/32.md b/32.md index 08966fcd..92d18ebd 100644 --- a/32.md +++ b/32.md @@ -145,7 +145,7 @@ Author is labeling their note language as English using ISO-639-1. Other Notes ----------- -When using this NIP to bulk-label many targets at once, events may be retracted using [NIP-09](09.md) and a replacement +When using this NIP to bulk-label many targets at once, events may be requested for deletion using [NIP-09](09.md) and a replacement may be published. We have opted not to use parameterizable/replaceable events for this due to the complexity in coming up with a standard `d` tag. In order to avoid ambiguity when querying, publishers SHOULD limit labeling events to a single namespace. diff --git a/34.md b/34.md index 14c76058..69f460b7 100644 --- a/34.md +++ b/34.md @@ -53,7 +53,7 @@ An optional source of truth for the state of branches and tags in a repository. The `refs` tag may appear multiple times, or none. -If 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) retraction. +If 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. The `refs` tag can be optionally extended to enable clients to identify how many commits ahead a ref is: diff --git a/71.md b/71.md index 51ea4b91..2743b2b1 100644 --- a/71.md +++ b/71.md @@ -6,7 +6,7 @@ Video Events `draft` `optional` -This specification defines video events representing a dedicated post of externally hosted content. These video events are _parameterized replaceable_ and retractable per [NIP-09](09.md). +This specification defines video events representing a dedicated post of externally hosted content. These video events are _parameterized replaceable_ and delete requestable per [NIP-09](09.md). Unlike 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. diff --git a/72.md b/72.md index ffa921f6..b2f523b4 100644 --- a/72.md +++ b/72.md @@ -62,7 +62,7 @@ An approval event MUST include one or more community `a` tags, an `e` or `a` tag The 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. -Moderators MAY retract their approval of a post at any time using NIP 09 event retractions. +Moderators MAY request deletion of their approval of a post at any time using [NIP-09 event deletion requests](09.md). ```jsonc { diff --git a/90.md b/90.md index a5f85873..5a15ebb6 100644 --- a/90.md +++ b/90.md @@ -199,7 +199,7 @@ Some service providers might choose to submit a `payment-required` as the first It's not up to this NIP to define how individual vending machines should choose to run their business. # Cancellation -A job request might be canceled by publishing a `kind:5` retract request event tagging the job request event. +A job request might be canceled by publishing a `kind:5` delete request event tagging the job request event. # Appendix 1: Job chaining A 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/README.md b/README.md index 3cc5fe6b..8bf036b5 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 - [NIP-06: Basic key derivation from mnemonic seed phrase](06.md) - [NIP-07: `window.nostr` capability for web browsers](07.md) - [NIP-08: Handling Mentions](08.md) --- **unrecommended**: deprecated in favor of [NIP-27](27.md) -- [NIP-09: Event Retraction](09.md) +- [NIP-09: Event Deletion Request](09.md) - [NIP-10: Conventions for clients' use of `e` and `p` tags in text events](10.md) - [NIP-11: Relay Information Document](11.md) - [NIP-13: Proof of Work](13.md) @@ -99,7 +99,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `2` | Recommend Relay | 01 (deprecated) | | `3` | Follows | [02](02.md) | | `4` | Encrypted Direct Messages | [04](04.md) | -| `5` | Event Retraction | [09](09.md) | +| `5` | Event Deletion Request | [09](09.md) | | `6` | Repost | [18](18.md) | | `7` | Reaction | [25](25.md) | | `8` | Badge Award | [58](58.md) | From 1d3744784c0faf3e3c43b7a16e657499476e19c5 Mon Sep 17 00:00:00 2001 From: Alex Gleason <alex@alexgleason.me> Date: Thu, 15 Aug 2024 20:28:53 -0500 Subject: [PATCH 206/587] Define the `t` tag in NIP-24 --- 24.md | 7 ++++--- README.md | 2 +- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/24.md b/24.md index ef4196bd..e44a0399 100644 --- a/24.md +++ b/24.md @@ -39,6 +39,7 @@ tags These 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: - - `r`: a web URL the event is referring to in some way - - `i`: an external id the event is referring to in some way - see [NIP-73](73.md) - - `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 + - `r`: a web URL the event is referring to in some way. + - `i`: an external id the event is referring to in some way - see [NIP-73](73.md). + - `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. + - `t`: a hashtag. The value MUST be a lowercase string. For kind 1 and other text notes, the event's content SHOULD contain the value prefixed by a `#` within the text in any case. \ No newline at end of file diff --git a/README.md b/README.md index 8bf036b5..80b8dcf2 100644 --- a/README.md +++ b/README.md @@ -250,7 +250,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `q` | event id (hex) | relay URL | [18](18.md) | | `r` | a reference (URL, etc) | -- | [24](24.md), [25](25.md) | | `r` | relay url | marker | [65](65.md) | -| `t` | hashtag | -- | | +| `t` | hashtag | -- | [24](24.md) | | `alt` | summary | -- | [31](31.md) | | `amount` | millisatoshis, stringified | -- | [57](57.md) | | `bolt11` | `bolt11` invoice | -- | [57](57.md) | From 055101786bb4570f00a14f347c22545833922414 Mon Sep 17 00:00:00 2001 From: sepehr-safari <safari.sepehr@gmail.com> Date: Sun, 18 Aug 2024 14:54:21 +0330 Subject: [PATCH 207/587] add kind 9008 for deleting a group --- 29.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/29.md b/29.md index 74dfd666..7a599b56 100644 --- a/29.md +++ b/29.md @@ -120,6 +120,7 @@ Each moderation action uses a different kind and requires different arguments, w | 9005 | `delete-event` | `e` (id hex) | | 9006 | `edit-group-status` | `public` or `private`, `open` or `closed` | | 9007 | `create-group` | | +| 9008 | `delete-group` | | - *group metadata* (`kind:39000`) (optional) @@ -160,6 +161,7 @@ The list of capabilities, as defined by this NIP, for now, is the following: - `add-permission` - `remove-permission` - `edit-group-status` +- `delete-group` ```js { From 62ac522333d374f9c8bab95f08413f13cf648038 Mon Sep 17 00:00:00 2001 From: sepehr-safari <safari.sepehr@gmail.com> Date: Sun, 18 Aug 2024 14:57:50 +0330 Subject: [PATCH 208/587] add kind 9022 for leave request --- 29.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/29.md b/29.md index 7a599b56..c2b86f1f 100644 --- a/29.md +++ b/29.md @@ -93,6 +93,20 @@ Any user can send one of these events to the relay in order to be automatically } ``` +- *leave request* (`kind:9022`) + +Any 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. + +```js +{ + "kind": 9022, + "content": "optional reason", + "tags": [ + ["h", "<group-id>"] + ] +} +``` + - *moderation events* (`kinds:9000-9020`) (optional) 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. The relay may discard the event after taking action or keep it as a moderation log. From 3aff37bd4bfd2e28dda2d53367f6e7a322370498 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Sun, 9 Jun 2024 21:16:01 -0300 Subject: [PATCH 209/587] nip54: change to asciidoc, markdown is trash. --- 54.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/54.md b/54.md index fe469185..0c2dd1c4 100644 --- a/54.md +++ b/54.md @@ -28,13 +28,13 @@ Articles are identified by lowercase, normalized ascii `d` tags. ### Content rules -The content should be Markdown, following the same rules as of [NIP-23](23.md), although it takes some extra (optional) metadata tags: +The content should be Asciidoc, following the same rules as of [NIP-23](23.md), although it takes some extra (optional) metadata tags: - `title`: for when the display title should be different from the `d` tag. - `summary`: for display in lists. - `a` and `e`: for referencing the original event a wiki article was forked from. -One 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. +One extra functionality is added: **wikilinks**. Unlike normal Asciidoc 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. Wikilinks can take these two forms: @@ -86,12 +86,12 @@ This is a stronger signal of trust than a `+` reaction. This 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. -Why Markdown? +Why Asciidoc? ------------- -If 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. +Wikitext is [garbage](nostr:nevent1qqsqt0gcggry60n72uglhuhypdlmr2dm6swjj69jex5v530gcpazlzsprpmhxue69uhhyetvv9ujumn0wdmksetjv5hxxmmdqy28wumn8ghj7un9d3shjtnyv9kh2uewd9hsygpm7rrrljungc6q0tuh5hj7ue863q73qlheu4vywtzwhx42a7j9n5ueneex) and Markdown is not powerful enough (besides being too freeform and unspecified and prone to generate incompatibilities in the future). -On 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. +Asciidoc 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). # Appendix 1: Merge requests Users can request other users to get their entries merged into someone else's entry by creating a `kind:818` event. From e30eb40eefbcef319a74a5531473f412987fca6a Mon Sep 17 00:00:00 2001 From: Alex Gleason <alex@alexgleason.me> Date: Tue, 20 Aug 2024 09:42:59 -0500 Subject: [PATCH 210/587] NIP-24: t-tag only has to be a lowercase string --- 24.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/24.md b/24.md index e44a0399..1afa7c7a 100644 --- a/24.md +++ b/24.md @@ -42,4 +42,4 @@ These tags may be present in multiple event kinds. Whenever a different meaning - `r`: a web URL the event is referring to in some way. - `i`: an external id the event is referring to in some way - see [NIP-73](73.md). - `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. - - `t`: a hashtag. The value MUST be a lowercase string. For kind 1 and other text notes, the event's content SHOULD contain the value prefixed by a `#` within the text in any case. \ No newline at end of file + - `t`: a hashtag. The value MUST be a lowercase string. From ca3c52e3e74f0a4679f1c6c0d9ac6461ea748d2d Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Tue, 20 Aug 2024 12:56:05 -0300 Subject: [PATCH 211/587] rename "parameterized replaceable event" to "addressable event" (#1418) --- 01.md | 4 ++-- 15.md | 2 +- 19.md | 2 +- 23.md | 2 +- 29.md | 2 +- 33.md | 2 +- 38.md | 2 +- 51.md | 2 +- 52.md | 2 +- 53.md | 2 +- 54.md | 2 +- 57.md | 2 +- 58.md | 2 +- 71.md | 2 +- 75.md | 4 ++-- 78.md | 2 +- 99.md | 2 +- 17 files changed, 19 insertions(+), 19 deletions(-) diff --git a/01.md b/01.md index 1da6e837..73c7e8fe 100644 --- a/01.md +++ b/01.md @@ -78,8 +78,8 @@ This NIP defines 3 standard tags that can be used across all event kinds with th - The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, <recommended relay URL, optional>]` - The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, <recommended relay URL, optional>]` - The `a` tag, used to refer to a (maybe parameterized) replaceable event - - for a parameterized replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]` - - for a non-parameterized replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:, <recommended relay URL, optional>]` + - for an addressable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]` + - for a normal replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:, <recommended relay URL, optional>]` As 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. diff --git a/15.md b/15.md index 6daa8019..2a4e2c20 100644 --- a/15.md +++ b/15.md @@ -300,7 +300,7 @@ This event leverages naddr to enable comprehensive customization and sharing of Bids are simply events of kind `1021` with a `content` field specifying the amount, in the currency of the auction. Bids must reference an auction. > [!NOTE] -> 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! +> 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! ### Event `1022`: Bid confirmation diff --git a/19.md b/19.md index cce9e641..3ea8e112 100644 --- a/19.md +++ b/19.md @@ -43,7 +43,7 @@ These possible standardized `TLV` types are indicated here: - depends on the bech32 prefix: - for `nprofile` it will be the 32 bytes of the profile public key - for `nevent` it will be the 32 bytes of the event id - - for `naddr`, it is the identifier (the `"d"` tag) of the event being referenced. For non-parameterized replaceable events, use an empty string. + - for `naddr`, it is the identifier (the `"d"` tag) of the event being referenced. For normal replaceable events use an empty string. - `1`: `relay` - for `nprofile`, `nevent` and `naddr`, _optionally_, a relay in which the entity (profile or event) is more likely to be found, encoded as ascii - this may be included multiple times diff --git a/23.md b/23.md index 382df837..d8fb51a3 100644 --- a/23.md +++ b/23.md @@ -6,7 +6,7 @@ Long-form Content `draft` `optional` -This 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. +This 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. "Social" clients that deal primarily with `kind:1` notes should not be expected to implement this NIP. diff --git a/29.md b/29.md index c2b86f1f..f8672680 100644 --- a/29.md +++ b/29.md @@ -16,7 +16,7 @@ Normally a group will originally belong to one specific relay, but the community ## Relay-generated events -Relays 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. +Relays 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. ## Group identifier diff --git a/33.md b/33.md index 337a1f9b..9c00d42c 100644 --- a/33.md +++ b/33.md @@ -6,4 +6,4 @@ Parameterized Replaceable Events `final` `mandatory` -Moved to [NIP-01](01.md). +Renamed to "Addressable events" and moved to [NIP-01](01.md). diff --git a/38.md b/38.md index 4f2c06d2..d841d764 100644 --- a/38.md +++ b/38.md @@ -13,7 +13,7 @@ This NIP enables a way for users to share live statuses such as what music they ## Live Statuses -A special event with `kind:30315` "User Status" is defined as an *optionally expiring* _parameterized replaceable event_, where the `d` tag represents the status type: +A special event with `kind:30315` "User Status" is defined as an *optionally expiring* _addressable event_, where the `d` tag represents the status type: For example: diff --git a/51.md b/51.md index 7e43121e..f7a468e7 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 ## Standard lists -Standard 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. +Standard 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. For 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. diff --git a/52.md b/52.md index bedf613c..c6d6b968 100644 --- a/52.md +++ b/52.md @@ -6,7 +6,7 @@ Calendar Events `draft` `optional` -This 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). +This 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). Unlike 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. diff --git a/53.md b/53.md index 0b1cb813..15bdbc95 100644 --- a/53.md +++ b/53.md @@ -12,7 +12,7 @@ Service providers want to offer live activities to the Nostr network in such a w ### Live Event -A 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. +A 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. For example: diff --git a/54.md b/54.md index 0c2dd1c4..cf225448 100644 --- a/54.md +++ b/54.md @@ -6,7 +6,7 @@ Wiki `draft` `optional` -This 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. +This NIP defines `kind:30818` (an _addressable 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. Articles are identified by lowercase, normalized ascii `d` tags. diff --git a/57.md b/57.md index d04eeff1..1c0b3149 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 In addition, the event MAY include the following tags: - `e` is an optional hex-encoded event id. Clients MUST include this if zapping an event rather than a person. -- `a` is an optional event coordinate that allows tipping parameterized replaceable events such as NIP-23 long-form notes. +- `a` is an optional event coordinate that allows tipping addressable events such as NIP-23 long-form notes. Example: diff --git a/58.md b/58.md index 4a9ed4c4..438574be 100644 --- a/58.md +++ b/58.md @@ -9,7 +9,7 @@ Badges Three special events are used to define, award and display badges in user profiles: -1. 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. +1. 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. 2. 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. diff --git a/71.md b/71.md index 2743b2b1..be1587c9 100644 --- a/71.md +++ b/71.md @@ -6,7 +6,7 @@ Video Events `draft` `optional` -This specification defines video events representing a dedicated post of externally hosted content. These video events are _parameterized replaceable_ and delete requestable per [NIP-09](09.md). +This 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). Unlike 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. diff --git a/75.md b/75.md index c16436a8..a6f2bffe 100644 --- a/75.md +++ b/75.md @@ -53,11 +53,11 @@ The following tags are OPTIONAL. } ``` -The goal MAY include an `r` or `a` tag linking to a URL or parameterized replaceable event. +The goal MAY include an `r` or `a` tag linking to a URL or addressable event. The goal MAY include multiple beneficiary pubkeys by specifying [`zap` tags](57.md#appendix-g-zap-tag-on-other-events). -Parameterized replaceable events can link to a goal by using a `goal` tag specifying the event id and an optional relay hint. +Addressable events can link to a goal by using a `goal` tag specifying the event id and an optional relay hint. ```json { diff --git a/78.md b/78.md index 0f2fadac..abdd1b21 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 ## Nostr event -This 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. +This 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. ## Some use cases diff --git a/99.md b/99.md index 89482871..b1b7ce9b 100644 --- a/99.md +++ b/99.md @@ -6,7 +6,7 @@ Classified Listings `draft` `optional` -This 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. +This 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. The 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. From b3c1a562690ce34f2c9dd668a5b18da2255afcb1 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Tue, 20 Aug 2024 13:23:28 -0300 Subject: [PATCH 212/587] nip13: remove section about pow prefix querying. prefix searching was removed from the spec. --- 13.md | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/13.md b/13.md index 99289c2a..0900d2d7 100644 --- a/13.md +++ b/13.md @@ -103,16 +103,6 @@ function countLeadingZeroes(hex) { } ``` -Querying relays for PoW notes ------------------------------ - -If relays allow searching on prefixes, you can use this as a way to filter notes of a certain difficulty: - -``` -$ echo '["REQ", "subid", {"ids": ["000000000"]}]' | websocat wss://some-relay.com | jq -c '.[2]' -{"id":"000000000121637feeb68a06c8fa7abd25774bdedfa9b6ef648386fb3b70c387", ...} -``` - Delegated Proof of Work ----------------------- From c7a357285d7265ecd95df70bb684a0c14b675ae5 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Wed, 21 Aug 2024 23:27:27 +0900 Subject: [PATCH 213/587] BREAKING.md: add changes --- BREAKING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/BREAKING.md b/BREAKING.md index cac35454..83b104b6 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -5,6 +5,7 @@ reverse chronological order. | Date | Commit | NIP | Change | | ----------- | --------- | -------- | ------ | +| 2024-08-18 | [3aff37bd](https://github.com/nostr-protocol/nips/commit/3aff37bd) | [NIP-54](54.md) | content should be Asciidoc | | 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 | | 2024-07-30 | [444ad28d](https://github.com/nostr-protocol/nips/commit/444ad28d) | [NIP-45](45.md) | NIP-45 was deprecated | | 2024-07-26 | [ecee40df](https://github.com/nostr-protocol/nips/commit/ecee40df) | [NIP-19](19.md) | `nrelay` was deprecated | @@ -47,6 +48,7 @@ reverse chronological order. | 2023-06-18 | [83cbd3e1](https://github.com/nostr-protocol/nips/commit/83cbd3e1) | [NIP-11](11.md) | 'image' was renamed to 'icon' | | 2023-04-13 | [bf0a0da6](https://github.com/nostr-protocol/nips/commit/bf0a0da6) | [NIP-15](15.md) | different NIP was re-added as NIP-15 | | 2023-04-09 | [fb5b7c73](https://github.com/nostr-protocol/nips/commit/fb5b7c73) | [NIP-15](15.md) | NIP-15 was merged into NIP-01 | +| 2023-03-29 | [599e1313](https://github.com/nostr-protocol/nips/commit/599e1313) | [NIP-18](18.md) | NIP-18 was bring back | | 2023-03-15 | [e1004d3d](https://github.com/nostr-protocol/nips/commit/e1004d3d) | [NIP-19](19.md) | `1: relay` was changed to optionally | Breaking changes prior to 2023-03-01 are not yet documented. From 27c67f0c71397ca9e8ea85eee0264b8aa83e2999 Mon Sep 17 00:00:00 2001 From: Tomas Bezouska <bezysoftware@outlook.com> Date: Sun, 25 Aug 2024 22:55:25 +0200 Subject: [PATCH 214/587] Update 17.md --- 17.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/17.md b/17.md index 0f51367a..d22dbdef 100644 --- a/17.md +++ b/17.md @@ -102,7 +102,7 @@ Clients SHOULD publish kind `14` events to the `10050`-listed relays. If that is ## Relays -It's advisable that relays do not serve `kind:14` to clients other than the ones tagged in them. +It's advisable that relays do not serve `kind:1059` to clients other than the ones tagged in them. It's advisable that users choose relays that conform to these practices. From da34c57e99dbf6cadfb3b4176b7c4ff33ac5674c Mon Sep 17 00:00:00 2001 From: dtonon <github@dtonon.com> Date: Thu, 29 Aug 2024 16:25:15 +0200 Subject: [PATCH 215/587] NIP-05: add identification vs verification note --- 05.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/05.md b/05.md index a1d488df..eeca551a 100644 --- a/05.md +++ b/05.md @@ -58,6 +58,15 @@ A client may implement support for finding users' public keys from _internet ide ## Notes +### Identification, not verification + +The 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. +Exceptions 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. + +### User discovery implementation suggestion + +A 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. + ### Clients must always follow public keys, not NIP-05 addresses For 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`, Keys 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. -### User Discovery implementation suggestion - -A 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. - ### Showing just the domain as an identifier Clients 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. From 1002104ece1fe3de7a091084d97e031c7291c9c0 Mon Sep 17 00:00:00 2001 From: Paul Miller <paul@paulmillr.com> Date: Sun, 1 Sep 2024 00:44:30 +0200 Subject: [PATCH 216/587] nip44: clarify ecdh hashing --- 44.md | 1 + 1 file changed, 1 insertion(+) diff --git a/44.md b/44.md index f3071ea9..339d3002 100644 --- a/44.md +++ b/44.md @@ -142,6 +142,7 @@ validation rules, refer to BIP-340. The operation produces a shared point, and we encode the shared point's 32-byte x coordinate, using method `bytes(P)` from BIP340. Private and public keys must be validated as per BIP340: pubkey must be a valid, on-curve point, and private key must be a scalar in range `[1, secp256k1_order - 1]`. + Some libraries, like libsecp256k1, apply sha256 on the output. The hashing is unnecessary in NIP44. - Operators - `x[i:j]`, where `x` is a byte array and `i, j <= 0` returns a `(j - i)`-byte array with a copy of the `i`-th byte (inclusive) to the `j`-th byte (exclusive) of `x`. From be17e5dcd9943c1d4854eccd5714241d4fe246e1 Mon Sep 17 00:00:00 2001 From: Paul Miller <paul@paulmillr.com> Date: Sun, 1 Sep 2024 16:13:12 +0200 Subject: [PATCH 217/587] Clarify function name in libsecp256k1 --- 44.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/44.md b/44.md index 339d3002..ccd1f505 100644 --- a/44.md +++ b/44.md @@ -142,7 +142,8 @@ validation rules, refer to BIP-340. The operation produces a shared point, and we encode the shared point's 32-byte x coordinate, using method `bytes(P)` from BIP340. Private and public keys must be validated as per BIP340: pubkey must be a valid, on-curve point, and private key must be a scalar in range `[1, secp256k1_order - 1]`. - Some libraries, like libsecp256k1, apply sha256 on the output. The hashing is unnecessary in NIP44. + NIP44 doesn't do hashing of the output: keep this in mind, because some libraries hash it using sha256. + As an example, in libsecp256k1, unhashed version is available in `secp256k1_ec_pubkey_tweak_mul` - Operators - `x[i:j]`, where `x` is a byte array and `i, j <= 0` returns a `(j - i)`-byte array with a copy of the `i`-th byte (inclusive) to the `j`-th byte (exclusive) of `x`. From d9eb17ce86e1f11d0919f192ed61ab23045cfc03 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Tue, 3 Sep 2024 01:16:36 +0900 Subject: [PATCH 218/587] NIP-65: add links to outbox model articles --- 65.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/65.md b/65.md index f32c9653..c3efa1d3 100644 --- a/65.md +++ b/65.md @@ -62,3 +62,7 @@ This NIP allows Clients to connect directly with the most up-to-date relay set f 5. 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. 6. Clients SHOULD deduplicate connections by normalizing relay URIs according to [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986#section-6). + +## Related articles +- [Outbox model](https://mikedilger.com/gossip-model/) +- [What is the Outbox Model?](https://habla.news/u/hodlbod@coracle.social/8YjqXm4SKY-TauwjOfLXS) From 14ec14dac92d891715239bfb83ed1c9bdf2ac382 Mon Sep 17 00:00:00 2001 From: Silberengel <153727378+SilberWitch@users.noreply.github.com> Date: Mon, 2 Sep 2024 18:51:07 -0700 Subject: [PATCH 219/587] Missing events added to README, including NKBIP-01 and NKBIP-02 (#1464) * Missing events added to README, including NKBIP-01 and NKBIP-02 * Just format * kind conflict resolved, 2nd blossom kind added * Revert "kind conflict resolved, 2nd blossom kind added" This reverts commit 5a8ecc0c278336ee3134385d5640e8b8f3f136f2. * formatting changes merged, kind conflict resolved, 2nd blossom kind added * relay reviews --------- Co-authored-by: Asai Toshiya <to.asai.60@gmail.com> Co-authored-by: fiatjaf_ <fiatjaf@gmail.com> --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 80b8dcf2..0ebd9d22 100644 --- a/README.md +++ b/README.md @@ -131,6 +131,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `1971` | Problem Tracker | [nostrocket][nostrocket] | | `1984` | Reporting | [56](56.md) | | `1985` | Label | [32](32.md) | +| `1986` | Relay reviews | | +| `1987` | AI Embeddings / Vector lists | [NKBIP-02] | | `2003` | Torrent | [35](35.md) | | `2004` | Torrent Comment | [35](35.md) | | `2022` | Coinjoin Pool | [joinstr][joinstr] | @@ -141,6 +143,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `9000`-`9030` | Group Control Events | [29](29.md) | | `9041` | Zap Goal | [75](75.md) | | `9734` | Zap Request | [57](57.md) | +| `9467` | Tidal login | [Tidal-nostr] | | `9735` | Zap | [57](57.md) | | `9802` | Highlights | [84](84.md) | | `10000` | Mute list | [51](51.md) | @@ -155,6 +158,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10015` | Interests list | [51](51.md) | | `10030` | User emoji list | [51](51.md) | | `10050` | Relay list to receive DMs | [51](51.md), [17](17.md) | +| `10063` | User server list | [blossom] | | `10096` | File storage server list | [96](96.md) | | `13194` | Wallet Info | [47](47.md) | | `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | @@ -162,6 +166,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `23194` | Wallet Request | [47](47.md) | | `23195` | Wallet Response | [47](47.md) | | `24133` | Nostr Connect | [46](46.md) | +| `24242` | Blobs stored on mediaservers | [blossom] | | `27235` | HTTP Auth | [98](98.md) | | `30000` | Follow sets | [51](51.md) | | `30001` | Generic lists | [51](51.md) | @@ -179,6 +184,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30023` | Long-form Content | [23](23.md) | | `30024` | Draft Long-form Content | [23](23.md) | | `30030` | Emoji sets | [51](51.md) | +| `30040` | Modular Article Header | [NKBIP-01] | +| `30041` | Modular Article Content | [NKBIP-01] | | `30063` | Release artifact sets | [51](51.md) | | `30078` | Application-specific Data | [78](78.md) | | `30311` | Live Event | [53](53.md) | @@ -202,10 +209,14 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `34550` | Community Definition | [72](72.md) | | `39000-9` | Group metadata events | [29](29.md) | -[NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/97c70a44366a6535c1 +[NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/ [nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md [lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md [joinstr]: https://gitlab.com/1440000bytes/joinstr/-/blob/main/NIP.md +[NKBIP-01]: https://wikistr.com/nkbip-01 +[NKBIP-02]: https://wikistr.com/nkbip-02 +[Blossom]: https://wikistr.com/blossom +[Tidal-nostr]: https://wikistr.com/tidal-nostr ## Message types From b4a2561df7325b8624bc5ffad154ec946ade2f1e Mon Sep 17 00:00:00 2001 From: kehiy <kehiiiiya@gmail.com> Date: Mon, 2 Sep 2024 20:33:45 +0330 Subject: [PATCH 220/587] style: fix header styles in same format --- 09.md | 2 +- 10.md | 4 ++-- 11.md | 6 +++--- 26.md | 2 +- 32.md | 2 +- 35.md | 2 +- 38.md | 2 +- 44.md | 2 +- 45.md | 2 +- 46.md | 6 +++++- 55.md | 6 ++++-- 64.md | 2 +- 71.md | 2 +- 73.md | 2 +- 96.md | 6 ++++-- 15 files changed, 28 insertions(+), 20 deletions(-) diff --git a/09.md b/09.md index e1be5429..b1a28ac1 100644 --- a/09.md +++ b/09.md @@ -2,7 +2,7 @@ NIP-09 ====== Event Deletion Request --------------- +---------------------- `draft` `optional` diff --git a/10.md b/10.md index dfd4cb9e..67b01f27 100644 --- a/10.md +++ b/10.md @@ -2,8 +2,8 @@ NIP-10 ====== -On "e" and "p" tags in Text Events (kind 1). --------------------------------------------- +On "e" and "p" tags in Text Events (kind 1) +------------------------------------------- `draft` `optional` diff --git a/11.md b/11.md index a50038a0..21c61e45 100644 --- a/11.md +++ b/11.md @@ -2,7 +2,7 @@ NIP-11 ====== Relay Information Document ---------------------------- +-------------------------- `draft` `optional` @@ -172,7 +172,7 @@ There is no need to specify retention times for _ephemeral events_ since they ar ### Content Limitations Some relays may be governed by the arbitrary laws of a nation state. This -may limit what content can be stored in cleartext on those relays. All +may limit what content can be stored in clear-text on those relays. All clients are encouraged to use encryption to work around this limitation. It is not possible to describe the limitations of each country's laws @@ -183,7 +183,7 @@ countries' laws might end up being enforced on them, and then indirectly on their users' content. Users should be able to avoid relays in countries they don't like, -and/or select relays in more favourable zones. Exposing this +and/or select relays in more favorable zones. Exposing this flexibility is up to the client software. ```json diff --git a/26.md b/26.md index 86c46e1f..445dd54a 100644 --- a/26.md +++ b/26.md @@ -2,7 +2,7 @@ NIP-26 ======= Delegated Event Signing ------ +----------------------- `draft` `optional` diff --git a/32.md b/32.md index 92d18ebd..e06cad58 100644 --- a/32.md +++ b/32.md @@ -2,7 +2,7 @@ NIP-32 ====== Labeling ---------- +-------- `draft` `optional` diff --git a/35.md b/35.md index 04cfb46d..980bc856 100644 --- a/35.md +++ b/35.md @@ -2,7 +2,7 @@ NIP-35 ====== Torrents ------------ +-------- `draft` `optional` diff --git a/38.md b/38.md index d841d764..684843a3 100644 --- a/38.md +++ b/38.md @@ -3,7 +3,7 @@ NIP-38 ====== User Statuses --------------- +------------- `draft` `optional` diff --git a/44.md b/44.md index f3071ea9..78c2323a 100644 --- a/44.md +++ b/44.md @@ -1,5 +1,5 @@ NIP-44 -===== +====== Encrypted Payloads (Versioned) ------------------------------ diff --git a/45.md b/45.md index 6b253960..219368e4 100644 --- a/45.md +++ b/45.md @@ -2,7 +2,7 @@ NIP-45 ====== Event Counts --------------- +------------ `draft` `optional` diff --git a/46.md b/46.md index 57fd2b01..389a3e8c 100644 --- a/46.md +++ b/46.md @@ -1,4 +1,8 @@ -# NIP-46 - Nostr Remote Signing +NIP-46 +====== + +Nostr Remote Signing +-------------------- ## Rationale diff --git a/55.md b/55.md index 4565e8c3..c0ee9579 100644 --- a/55.md +++ b/55.md @@ -1,6 +1,8 @@ -# NIP-55 +NIP-55 +====== -## Android Signer Application +Android Signer Application +-------------------------- `draft` `optional` diff --git a/64.md b/64.md index 6d8d3736..7c2329a4 100644 --- a/64.md +++ b/64.md @@ -2,7 +2,7 @@ NIP-64 ====== Chess (Portable Game Notation) ------ +------------------------------ `draft` `optional` diff --git a/71.md b/71.md index be1587c9..302bbbf1 100644 --- a/71.md +++ b/71.md @@ -2,7 +2,7 @@ NIP-71 ====== Video Events ---------------- +------------ `draft` `optional` diff --git a/73.md b/73.md index 12228d36..d50ab22a 100644 --- a/73.md +++ b/73.md @@ -2,7 +2,7 @@ NIP-73 ====== External Content IDs -------------------------- +-------------------- `draft` `optional` diff --git a/96.md b/96.md index be709991..fab0c1a8 100644 --- a/96.md +++ b/96.md @@ -1,6 +1,8 @@ -# NIP-96 +NIP-96 +====== -## HTTP File Storage Integration +HTTP File Storage Integration +----------------------------- `draft` `optional` From 378dfaa5dbf44bd1f17fd70f8727b636b7c99239 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Tue, 3 Sep 2024 14:07:46 -0300 Subject: [PATCH 221/587] nip54: remove markdown leftovers. --- 54.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/54.md b/54.md index cf225448..39528cf9 100644 --- a/54.md +++ b/54.md @@ -6,7 +6,7 @@ Wiki `draft` `optional` -This NIP defines `kind:30818` (an _addressable 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. +This 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. Articles are identified by lowercase, normalized ascii `d` tags. @@ -26,21 +26,25 @@ Articles are identified by lowercase, normalized ascii `d` tags. - Any non-letter character MUST be converted to a `-`. - All letters MUST be converted to lowercase. -### Content rules +### Content -The content should be Asciidoc, following the same rules as of [NIP-23](23.md), although it takes some extra (optional) metadata tags: +The `content` should be Asciidoc with two extra functionalities: **wikilinks** and **nostr:...** links. - - `title`: for when the display title should be different from the `d` tag. - - `summary`: for display in lists. - - `a` and `e`: for referencing the original event a wiki article was forked from. - -One extra functionality is added: **wikilinks**. Unlike normal Asciidoc 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. +Unlike 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. Wikilinks can take these two forms: 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`; 2. `[[target page|see this]]` -- in this case it will link to the page `target-page`, but will be displayed as `see this`. +`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. + +### Optional extra tags + + - `title`: for when the display title should be different from the `d` tag. + - `summary`: for display in lists. + - `a` and `e`: for referencing the original event a wiki article was forked from. + ### Merge Requests Event `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. From e6552476aa2e5ca7256be572a9aa226ec8a022ee Mon Sep 17 00:00:00 2001 From: kehiy <kehiiiiya@gmail.com> Date: Tue, 3 Sep 2024 20:41:31 +0330 Subject: [PATCH 222/587] format(all): json formatting --- 02.md | 4 ++-- 05.md | 4 ++-- 09.md | 4 ++-- 11.md | 26 +++++++++++++++----------- 15.md | 19 ++++++++++--------- 17.md | 10 +++++----- 25.md | 8 ++++---- 28.md | 26 +++++++++++++------------- 29.md | 28 ++++++++++++++-------------- 32.md | 26 +++++++++++++------------- 34.md | 7 ++++--- 35.md | 2 +- 38.md | 4 +++- 39.md | 5 +++-- 42.md | 8 ++++---- 46.md | 2 +- 47.md | 10 ++++------ 50.md | 4 ++-- 51.md | 2 +- 53.md | 10 +++++----- 54.md | 8 ++++---- 56.md | 12 ++++++++---- 57.md | 2 +- 58.md | 12 ++++++------ 59.md | 4 ++-- 64.md | 12 ++++++------ 65.md | 4 ++-- 71.md | 2 +- 72.md | 6 +++--- 75.md | 20 ++++++++++---------- 84.md | 4 ++-- 89.md | 22 ++++++++++++---------- 90.md | 26 +++++++++++++------------- 94.md | 4 ++-- 96.md | 51 +++++++++++++++++++++++++-------------------------- 99.md | 2 +- 36 files changed, 206 insertions(+), 194 deletions(-) diff --git a/02.md b/02.md index 4029b222..8354bf0b 100644 --- a/02.md +++ b/02.md @@ -14,7 +14,7 @@ The `.content` is not used. For example: -```json +```jsonc { "kind": 3, "tags": [ @@ -23,7 +23,7 @@ For example: ["p", "612ae..e610f", "ws://carolrelay.com/ws", "carol"] ], "content": "", - ...other fields + // other fields... } ``` diff --git a/05.md b/05.md index eeca551a..ca6da7be 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 If a client sees an event like this: -```json +```jsonc { "pubkey": "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9", "kind": 0, "content": "{\"name\": \"bob\", \"nip05\": \"bob@example.com\"}" - ... + // other fields... } ``` diff --git a/09.md b/09.md index b1a28ac1..23ffeab1 100644 --- a/09.md +++ b/09.md @@ -12,7 +12,7 @@ The event's `content` field MAY contain a text note describing the reason for th For example: -``` +```jsonc { "kind": 5, "pubkey": <32-bytes hex-encoded public key of the event creator>, @@ -24,7 +24,7 @@ For example: ["k", "30023"] ], "content": "these posts were published by accident", - ...other fields + // other fields... } ``` diff --git a/11.md b/11.md index 21c61e45..0ca58708 100644 --- a/11.md +++ b/11.md @@ -66,7 +66,7 @@ These are limitations imposed by the relay on clients. Your client should expect that requests which exceed these *practical* limitations are rejected or fail immediately. -```json +```jsonc { "limitation": { "max_message_length": 16384, @@ -83,7 +83,7 @@ are rejected or fail immediately. "created_at_lower_limit": 31536000, "created_at_upper_limit": 3 }, - ... + // other fields... } ``` @@ -146,14 +146,15 @@ Retention times are given in seconds, with `null` indicating infinity. If zero is provided, this means the event will not be stored at all, and preferably an error will be provided when those are received. -```json +```jsonc { "retention": [ {"kinds": [0, 1, [5, 7], [40, 49]], "time": 3600}, {"kinds": [[40000, 49999]], "time": 100}, {"kinds": [[30000, 39999]], "count": 1000}, {"time": 3600, "count": 10000} - ] + ], + // other fields... } ``` @@ -186,10 +187,10 @@ Users should be able to avoid relays in countries they don't like, and/or select relays in more favorable zones. Exposing this flexibility is up to the client software. -```json +```jsonc { "relay_countries": [ "CA", "US" ], - ... + // other fields... } ``` @@ -208,12 +209,12 @@ local community. This would encourage users to follow the global feed on that relay, in addition to their usual individual follows. To support this goal, relays MAY specify some of the following values. -```json +```jsonc { "language_tags": ["en", "en-419"], "tags": ["sfw-only", "bitcoin-only", "anime"], "posting_policy": "https://example.com/posting-policy.html", - ... + // other fields... } ``` @@ -260,10 +261,10 @@ Relays that require payments may want to expose their fee schedules. A URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape. -```json +```jsonc { "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg", - ... + // other fields... } ``` @@ -271,9 +272,11 @@ A URL pointing to an image to be used as an icon for the relay. Recommended to b As of 2 May 2023 the following command provided these results: +```bash +$ curl -H "Accept: application/nostr+json" https://eden.nostr.land | jq ``` -~> curl -H "Accept: application/nostr+json" https://eden.nostr.land | jq +```json { "description": "nostr.land family of relays (us-or-01)", "name": "nostr.land", @@ -312,3 +315,4 @@ As of 2 May 2023 the following command provided these results: ] }, } +``` diff --git a/15.md b/15.md index 2a4e2c20..b55b4448 100644 --- a/15.md +++ b/15.md @@ -73,10 +73,10 @@ Fields that are not self-explanatory: **Event Tags** -```json +```jsonc { "tags": [["d", <string, id of stall]], - ... + // other fields... } ``` - 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: **Event Tags** -```json +```jsonc "tags": [ ["d", <string, id of product], ["t", <string (optional), product category], ["t", <string (optional), product category], - ... + // other fields... ], ... ``` @@ -158,7 +158,7 @@ The below JSON goes in content of [NIP-04](04.md). "type": 0, "name": <string (optional), ???>, "address": <string (optional), for physical goods an address should be provided>, - "message": "<string (optional), message for merchant>, + "message": <string (optional), message for merchant>, "contact": { "nostr": <32-bytes hex of a pubkey>, "phone": <string (optional), if the customer wants to be contacted by phone>, @@ -237,7 +237,7 @@ Create a customized user experience using the `naddr` from [NIP-19](19.md#sharea **Event Content** -```json +```jsonc { "name": <string (optional), market name>, "about": <string (optional), market description>, @@ -248,7 +248,7 @@ Create a customized user experience using the `naddr` from [NIP-19](19.md#sharea "darkMode": <bool, true/false> }, "merchants": [array of pubkeys (optional)], - ... + // other fields... } ``` @@ -290,10 +290,11 @@ This event leverages naddr to enable comprehensive customization and sharing of ### Event `1021`: Bid -```json +```jsonc { "content": <int, amount of sats>, "tags": [["e", <event ID of the auction to bid on>]], + // other fields... } ``` @@ -335,4 +336,4 @@ Customer support is handled over whatever communication method was specified. If ## Additional -Standard data models can be found <a href="https://raw.githubusercontent.com/lnbits/nostrmarket/main/models.py">here</a> +Standard data models can be found [here](https://raw.githubusercontent.com/lnbits/nostrmarket/main/models.py) diff --git a/17.md b/17.md index d22dbdef..4b96bce3 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 Kind `14` is a chat message. `p` tags identify one or more receivers of the message. -```js +```jsonc { "id": "<usual hash>",   "pubkey": "<sender-pubkey>", - "created_at": now(), + "created_at": "<current-time>",   "kind": 14,   "tags": [     ["p", "<receiver-1-pubkey>", "<relay-url>"],     ["p", "<receiver-2-pubkey>", "<relay-url>"],     ["e", "<kind-14-id>", "<relay-url>", "reply"] // if this is a reply ["subject", "<conversation-title>"], -    ... +    // rest of tags...   ],   "content": "<message-in-plain-text>", } @@ -86,7 +86,7 @@ Clients CAN offer disappearing messages by setting an `expiration` tag in the gi Kind `10050` indicates the user's preferred relays to receive DMs. The event MUST include a list of `relay` tags with relay URIs. -```js +```jsonc { "kind": 10050, "tags": [ @@ -94,7 +94,7 @@ Kind `10050` indicates the user's preferred relays to receive DMs. The event MUS ["relay", "wss://myrelay.nostr1.com"], ], "content": "", - //...other fields + // other fields... } ``` diff --git a/25.md b/25.md index f0386034..671c55fa 100644 --- a/25.md +++ b/25.md @@ -57,14 +57,14 @@ Reactions to a website If 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. -```json +```jsonc { "kind": 17, "content": "⭐", "tags": [ ["r", "https://example.com/"] ], - ...other fields + // other fields... } ``` @@ -79,14 +79,14 @@ The client may specify a custom emoji ([NIP-30](30.md)) `:shortcode:` in the reaction content. The client should refer to the emoji tag and render the content as an emoji if shortcode is specified. -```json +```jsonc { "kind": 7, "content": ":soapbox:", "tags": [ ["emoji", "soapbox", "https://gleasonator.com/emoji/Gleasonator/soapbox.png"] ], - ...other fields + // other fields... } ``` diff --git a/28.md b/28.md index 16320880..73c76b2b 100644 --- a/28.md +++ b/28.md @@ -25,10 +25,10 @@ Create a public chat channel. In the channel creation `content` field, Client SHOULD include basic channel metadata (`name`, `about`, `picture` and `relays` as specified in kind 41). -```json +```jsonc { "content": "{\"name\": \"Demo Channel\", \"about\": \"A test channel.\", \"picture\": \"https://placekitten.com/200/200\", \"relays\": [\"wss://nos.lol\", \"wss://nostr.mom\"]}", - ... + // other fields... } ``` @@ -52,11 +52,11 @@ Clients MAY add additional metadata fields. Clients SHOULD use [NIP-10](10.md) marked "e" tags to recommend a relay. -```json +```jsonc { "content": "{\"name\": \"Updated Demo Channel\", \"about\": \"Updating a test channel.\", \"picture\": \"https://placekitten.com/201/201\", \"relays\": [\"wss://nos.lol\", \"wss://nostr.mom\"]}", "tags": [["e", <channel_create_event_id>, <relay-url>]], - ... + // other fields... } ``` @@ -71,26 +71,26 @@ Clients SHOULD append [NIP-10](10.md) "p" tags to replies. Root message: -```json +```jsonc { "content": <string>, "tags": [["e", <kind_40_event_id>, <relay-url>, "root"]], - ... + // other fields... } ``` Reply to another message: -```json +```jsonc { "content": <string>, "tags": [ ["e", <kind_40_event_id>, <relay-url>, "root"], ["e", <kind_42_event_id>, <relay-url>, "reply"], ["p", <pubkey>, <relay-url>], - ... + // rest of tags... ], - ... + // other fields... } ``` @@ -107,11 +107,11 @@ Clients MAY hide event 42s for other users other than the user who sent the even (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.) -```json +```jsonc { "content": "{\"reason\": \"Dick pic\"}", "tags": [["e", <kind_42_event_id>]], - ... + // other fields... } ``` @@ -125,11 +125,11 @@ Clients SHOULD hide event 42s shown to a given user, if there is an event 44 fro Clients MAY hide event 42s for users other than the user who sent the event 44. -```json +```jsonc { "content": "{\"reason\": \"Posting dick pics\"}", "tags": [["p", <pubkey>]], - ... + // other fields... } ``` diff --git a/29.md b/29.md index f8672680..6232f8b6 100644 --- a/29.md +++ b/29.md @@ -42,14 +42,14 @@ Relays should prevent late publication (messages published now with a timestamp This is the basic unit of a "microblog" root text note sent to a group. -```js +```jsonc "kind": 11, "content": "hello my friends lovers of pizza", "tags": [ ["h", "<group-id>"], - ["previous", "<event-id-first-chars>", "<event-id-first-chars>", ...] + ["previous", "<event-id-first-chars>", "<event-id-first-chars>", /*...*/] ] - ... + // other fields... ``` - *threaded text reply* (`kind:12`) @@ -63,14 +63,14 @@ This is the basic unit of a "microblog" reply note sent to a group. It's the sam This is the basic unit of a _chat message_ sent to a group. -```js +```jsonc "kind": 9, "content": "hello my friends lovers of pizza", "tags": [ ["h", "<group-id>"], - ["previous", "<event-id-first-chars>", "<event-id-first-chars>", ...] + ["previous", "<event-id-first-chars>", "<event-id-first-chars>", /*...*/] ] - ... + // other fields... ``` - *chat message threaded reply* (`kind:10`) @@ -83,7 +83,7 @@ Similar to `kind:12`, this is the basic unit of a chat message sent to a group. Any 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. -```js +```json { "kind": 9021, "content": "optional reason", @@ -97,7 +97,7 @@ Any user can send one of these events to the relay in order to be automatically Any 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. -```js +```json { "kind": 9022, "content": "optional reason", @@ -111,13 +111,13 @@ Any user can send one of these events to the relay in order to be automatically 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. The relay may discard the event after taking action or keep it as a moderation log. -```js +```json { "kind": 90xx, "content": "optional reason", "tags": [ ["h", "<group-id>"], - ["previous", ...] + ["previous", /*...*/] ] } ``` @@ -142,7 +142,7 @@ This event defines the metadata for the group -- basically how clients should di If the group is forked and hosted in multiple relays, there will be multiple versions of this event in each different relay and so on. -```js +```jsonc { "kind": 39000, "content": "", @@ -154,7 +154,7 @@ If the group is forked and hosted in multiple relays, there will be multiple ver ["public"], // or ["private"] ["open"] // or ["closed"] ] - ... + // other fields... } ``` @@ -177,7 +177,7 @@ The list of capabilities, as defined by this NIP, for now, is the following: - `edit-group-status` - `delete-group` -```js +```json { "kind": 39001, "content": "list of admins for the pizza lovers group", @@ -186,7 +186,7 @@ The list of capabilities, as defined by this NIP, for now, is the following: ["p", "<pubkey1-as-hex>", "ceo", "add-user", "edit-metadata", "delete-event", "remove-user"], ["p", "<pubkey2-as-hex>", "secretary", "add-user", "delete-event"] ] - ... + // other fields... } ``` diff --git a/32.md b/32.md index e06cad58..66f02836 100644 --- a/32.md +++ b/32.md @@ -57,7 +57,7 @@ Example events A suggestion that multiple pubkeys be associated with the `permies` topic. -```json +```jsonc { "kind": 1985, "tags": [ @@ -66,13 +66,13 @@ A suggestion that multiple pubkeys be associated with the `permies` topic. ["p", <pubkey1>, <relay_url>], ["p", <pubkey2>, <relay_url>] ], - ... + // other fields... } ``` A report flagging violence toward a human being as defined by ontology.example.com. -```json +```jsonc { "kind": 1985, "tags": [ @@ -81,13 +81,13 @@ A report flagging violence toward a human being as defined by ontology.example.c ["p", <pubkey1>, <relay_url>], ["p", <pubkey2>, <relay_url>] ], - ... + // other fields... } ``` A moderation suggestion for a chat event. -```json +```jsonc { "kind": 1985, "tags": [ @@ -95,13 +95,13 @@ A moderation suggestion for a chat event. ["l", "approve", "nip28.moderation"], ["e", <kind40_event_id>, <relay_url>] ], - ... + // other fields... } ``` Assignment of a license to an event. -```json +```jsonc { "kind": 1985, "tags": [ @@ -109,14 +109,14 @@ Assignment of a license to an event. ["l", "MIT", "license"], ["e", <event_id>, <relay_url>] ], - ... + // other fields... } ``` Publishers can self-label by adding `l` tags to their own non-1985 events. In this case, the kind 1 event's author is labeling their note as being related to Milan, Italy using ISO 3166-2. -```json +```jsonc { "kind": 1, "tags": [ @@ -124,13 +124,13 @@ is labeling their note as being related to Milan, Italy using ISO 3166-2. ["l", "IT-MI", "ISO-3166-2"] ], "content": "It's beautiful here in Milan!", - ... + // other fields... } ``` Author is labeling their note language as English using ISO-639-1. -```json +```jsonc { "kind": 1, "tags": [ @@ -138,7 +138,7 @@ Author is labeling their note language as English using ISO-639-1. ["l", "en", "ISO-639-1"] ], "content": "English text", - ... + // other fields... } ``` @@ -169,7 +169,7 @@ be handled in some other way. Appendix: Known Ontologies -------------------------- +-------------------------- Below is a non-exhaustive list of ontologies currently in widespread use. diff --git a/34.md b/34.md index 69f460b7..9363aeb1 100644 --- a/34.md +++ b/34.md @@ -106,7 +106,7 @@ The first patch in a series MAY be a cover letter in the format produced by `git Issues 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. -```jsonc +```json { "kind": 1621, "content": "<markdown text>", @@ -132,8 +132,9 @@ Replies are also Markdown text. The difference is that they MUST be issued as re // other "e" and "p" tags should be applied here when necessary, following the threading rules of NIP-10 ["p", "<patch-author-pubkey-hex>", "", "mention"], ["e", "<previous-reply-id-hex>", "", "reply"], - // ... - ] + // rest of tags... + ], + // other fields... } ``` diff --git a/35.md b/35.md index 980bc856..3891f6f4 100644 --- a/35.md +++ b/35.md @@ -37,7 +37,7 @@ A second level prefix should be included where the database supports multiple me In 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. -```jsonc +```json { "kind": 2003, "content": "<long-description-pre-formatted>", diff --git a/38.md b/38.md index 684843a3..8b22b2a7 100644 --- a/38.md +++ b/38.md @@ -17,7 +17,7 @@ A special event with `kind:30315` "User Status" is defined as an *optionally exp For example: -```js +```json { "kind": 30315, "content": "Sign up for nostrasia!", @@ -26,7 +26,9 @@ For example: ["r", "https://nostr.world"] ], } +``` +```json { "kind": 30315, "content": "Intergalatic - Beastie Boys", diff --git a/39.md b/39.md index b7c3b9c6..3777ac55 100644 --- a/39.md +++ b/39.md @@ -13,7 +13,8 @@ Nostr protocol users may have other online identities such as usernames, profile ## `i` tag on a metadata event A new optional `i` tag is introduced for `kind 0` metadata event defined in [NIP-01](01.md): -```json + +```jsonc { "id": <id>, "pubkey": <pubkey>, @@ -23,7 +24,7 @@ A new optional `i` tag is introduced for `kind 0` metadata event defined in [NIP ["i", "mastodon:bitcoinhackers.org/@semisol", "109775066355589974"] ["i", "telegram:1087295469", "nostrdirectory/770"] ], - ... + // other fields... } ``` diff --git a/42.md b/42.md index 8c70de49..fdc5d104 100644 --- a/42.md +++ b/42.md @@ -22,13 +22,13 @@ A relay may want to require clients to authenticate to access restricted resourc This 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: -```json +``` ["AUTH", <challenge-string>] ``` And, when sent by clients, the following form: -```json +``` ["AUTH", <signed-event-json>] ``` @@ -38,14 +38,14 @@ And, when sent by clients, the following form: The 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: -```json +```jsonc { "kind": 22242, "tags": [ ["relay", "wss://relay.example.com/"], ["challenge", "challengestringhere"] ], - ... + // other fields... } ``` diff --git a/46.md b/46.md index 389a3e8c..e1675b0d 100644 --- a/46.md +++ b/46.md @@ -94,7 +94,7 @@ nostrconnect://<local-keypair-pubkey>?relay=<wss://relay-to-connect-on>&metadata ## Request Events `kind: 24133` -```json +```jsonc { "id": <id>, "kind": 24133, diff --git a/47.md b/47.md index e4e432ca..a19230fa 100644 --- a/47.md +++ b/47.md @@ -173,7 +173,7 @@ Request: "amount": 123, // invoice amount in msats, required "pubkey": "03...", // payee pubkey, required "preimage": "0123456789abcdef...", // preimage of the payment, optional - "tlv_records: [ // tlv records, optional + "tlv_records": [ // tlv records, optional { "type": 5482373484, // tlv type "value": "0123456789abcdef" // hex encoded tlv value @@ -208,7 +208,7 @@ Request: "method": "multi_pay_keysend", "params": { "keysends": [ - {"id": "4c5b24a351", pubkey": "03...", "amount": 123}, + {"id": "4c5b24a351", "pubkey": "03...", "amount": 123}, {"id": "3da52c32a1", "pubkey": "02...", "amount": 567, "preimage": "abc123..", "tlv_records": [{"type": 696969, "value": "77616c5f6872444873305242454d353736"}]}, ], } @@ -358,8 +358,7 @@ Request: ```jsonc { "method": "get_balance", - "params": { - } + "params": {} } ``` @@ -379,8 +378,7 @@ Request: ```jsonc { "method": "get_info", - "params": { - } + "params": {} } ``` diff --git a/50.md b/50.md index 2a31cb11..9eea1f85 100644 --- a/50.md +++ b/50.md @@ -15,9 +15,9 @@ extensible framework for performing such queries. ## `search` filter field A new `search` field is introduced for `REQ` messages from clients: -```json +```jsonc { - ... + // other fields on filter object... "search": <string> } ``` diff --git a/51.md b/51.md index f7a468e7..3792d7fe 100644 --- a/51.md +++ b/51.md @@ -111,7 +111,7 @@ Some clients have used these lists in the past, but they should work on transiti ### A _release artifact set_ of an Example App -```json +```jsonc { "id": "567b41fc9060c758c4216fe5f8d3df7c57daad7ae757fa4606f0c39d4dd220ef", "pubkey": "d6dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c", diff --git a/53.md b/53.md index 15bdbc95..ee12fef9 100644 --- a/53.md +++ b/53.md @@ -16,7 +16,7 @@ A special event with `kind:30311` "Live Event" is defined as an _addressable eve For example: -```json +```jsonc { "kind": 30311, "tags": [ @@ -35,10 +35,10 @@ For example: ["p", "91cf9..4e5ca", "wss://provider1.com/", "Host", "<proof>"], ["p", "14aeb..8dad4", "wss://provider2.com/nostr", "Speaker"], ["p", "612ae..e610f", "ws://provider3.com/ws", "Participant"], - ["relays", "wss://one.com", "wss://two.com", ...] + ["relays", "wss://one.com", "wss://two.com", /*...*/] ], "content": "", - ... + // other fields... } ``` @@ -64,14 +64,14 @@ This feature is important to avoid malicious event owners adding large account h Event `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. -```json +```jsonc { "kind": 1311, "tags": [ ["a", "30311:<Community event author pubkey>:<d-identifier of the community>", "<Optional relay url>", "root"], ], "content": "Zaps to live streams is beautiful.", - ... + // other fields... } ``` diff --git a/54.md b/54.md index cf225448..611ec7a1 100644 --- a/54.md +++ b/54.md @@ -11,7 +11,7 @@ This NIP defines `kind:30818` (an _addressable event_) for long-form text conten Articles are identified by lowercase, normalized ascii `d` tags. ### Articles -```jsonc +```json { "content": "A wiki is a hypertext publication collaboratively edited and managed by its own audience.", "tags": [ @@ -96,13 +96,13 @@ Asciidoc has a strict spec, multiple implementations in many languages, and supp # Appendix 1: Merge requests Users can request other users to get their entries merged into someone else's entry by creating a `kind:818` event. -```jsonc +```json { "content": "I added information about how to make hot ice-creams", "kind": 818, "tags": [ [ "a", "30818:<destination-pubkey>:hot-ice-creams", "<relay-url>" ], - [ "e", "<version-against-which-the-modification-was-made>", "<relay-url>' ], + [ "e", "<version-against-which-the-modification-was-made>", "<relay-url>" ], [ "p", "<destination-pubkey>" ], [ "e", "<version-to-be-merged>", "<relay-url>", "source" ] ] @@ -114,4 +114,4 @@ Users can request other users to get their entries merged into someone else's en `e` tag: optional version of the article in which this modifications is based `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. -The 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 `-` +The 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/56.md b/56.md index fc8d8985..f7b1b1a9 100644 --- a/56.md +++ b/56.md @@ -41,7 +41,7 @@ further qualification and querying. Example events -------------- -```json +```jsonc { "kind": 1984, "tags": [ @@ -50,9 +50,11 @@ Example events ["l", "NS-nud", "social.nos.ontology"] ], "content": "", - ... + // other fields... } +``` +```jsonc { "kind": 1984, "tags": [ @@ -60,16 +62,18 @@ Example events ["p", <pubkey>] ], "content": "He's insulting the king!", - ... + // other fields... } +``` +```jsonc { "kind": 1984, "tags": [ ["p", <impersonator pubkey>, "impersonation"] ], "content": "Profile is impersonating nostr:<victim bech32 pubkey>", - ... + // other fields... } ``` diff --git a/57.md b/57.md index 1c0b3149..b5338110 100644 --- a/57.md +++ b/57.md @@ -171,7 +171,7 @@ A client can retrieve `zap receipt`s on events and pubkeys using a NIP-01 filter When 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`). -```js +```jsonc { "tags": [ [ "zap", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2", "wss://nostr.oxtr.dev", "1" ], // 25% diff --git a/58.md b/58.md index 438574be..b6324f4e 100644 --- a/58.md +++ b/58.md @@ -74,7 +74,7 @@ Clients SHOULD attempt to render the most appropriate badge thumbnail according ### Example of a Badge Definition event -```json +```jsonc { "pubkey": "alice", "kind": 30009, @@ -85,13 +85,13 @@ Clients SHOULD attempt to render the most appropriate badge thumbnail according ["image", "https://nostr.academy/awards/bravery.png", "1024x1024"], ["thumb", "https://nostr.academy/awards/bravery_256x256.png", "256x256"] ], - ... + // other fields... } ``` ### Example of Badge Award event -```json +```jsonc { "id": "<badge award event id>", "kind": 8, @@ -101,14 +101,14 @@ Clients SHOULD attempt to render the most appropriate badge thumbnail according ["p", "bob", "wss://relay"], ["p", "charlie", "wss://relay"] ], - ... + // other fields... } ``` ### Example of a Profile Badges event Honorable Bob The Brave: -```json +```jsonc { "kind": 30008, "pubkey": "bob", @@ -119,6 +119,6 @@ Honorable Bob The Brave: ["a", "30009:alice:honor"], ["e", "<honor badge award event id>", "wss://nostr.academy"] ], - ... + // other fields... } ``` diff --git a/59.md b/59.md index 4dc857f6..a4fc99dc 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 to 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 without the receiver's or the sender's private key. The only public information in this event is who is signing it. -```js +```json { "id": "<id>", "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 A `gift wrap` event is a `kind:1059` event that wraps any other event. `tags` SHOULD include any information needed to route the event to its intended recipient, including the recipient's `p` tag or [NIP-13](13.md) proof of work. -```js +```json { "id": "<id>", "pubkey": "<random, one-time-use pubkey>", diff --git a/64.md b/64.md index 7c2329a4..616c5d6f 100644 --- a/64.md +++ b/64.md @@ -16,23 +16,23 @@ The `.content` of these notes is a string representing a [PGN-database][pgn_form ### Notes -```json +```jsonc { "kind": 64, "content": "1. e4 *", - ... + // other fields... } ``` -```json +```jsonc { "kind": 64, "tags": [ ["alt", "Fischer vs. Spassky in Belgrade on 1992-11-04 (F/S Return Match, Round 29)"], - ... + // rest of tags... ], - "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" - ... + "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", + // other fields... } ``` diff --git a/65.md b/65.md index f32c9653..71660d4d 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 The `.content` is not used. -```json +```jsonc { "kind": 10002, "tags": [ @@ -22,7 +22,7 @@ The `.content` is not used. ["r", "wss://nostr-relay.example.com", "read"] ], "content": "", - ...other fields + // other fields... } ``` diff --git a/71.md b/71.md index 302bbbf1..5cf3b369 100644 --- a/71.md +++ b/71.md @@ -42,7 +42,7 @@ The list of tags are as follows: * `p` (optional, repeated) 32-bytes hex pubkey of a participant in the video, optional recommended relay URL * `r` (optional, repeated) references / links to web pages -```json +```jsonc { "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, diff --git a/72.md b/72.md index b2f523b4..582410ad 100644 --- a/72.md +++ b/72.md @@ -35,7 +35,7 @@ The goal of this NIP is to enable public communities. It defines the replaceable ["relay", "<relay where to send and receive approvals>", "approvals"], ["relay", "<relay where to post requests to and fetch approvals from>"] ], - ... + // other fields... } ``` @@ -50,7 +50,7 @@ Any Nostr event can be posted to a community. Clients MUST add one or more commu ["a", "34550:<community event author pubkey>:<community-d-identifier>", "<optional-relay-url>"], ], "content": "hello world", - // ... + // other fields... } ``` @@ -75,7 +75,7 @@ Moderators MAY request deletion of their approval of a post at any time using [N ["k", "<post-request-kind>"] ], "content": "<the full approved event, JSON-encoded>", - // ... + // other fields... } ``` diff --git a/75.md b/75.md index a6f2bffe..885c3910 100644 --- a/75.md +++ b/75.md @@ -21,15 +21,16 @@ The following tags are defined as REQUIRED. Example event: -```json +```jsonc { "kind": 9041, "tags": [ - ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", ...], + ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", /*...*/], ["amount", "210000"], ], "content": "Nostrasia travel expenses", - ... + // other fields... +} ``` The following tags are OPTIONAL. @@ -38,18 +39,18 @@ The following tags are OPTIONAL. - `image` - an image for the goal - `summary` - a brief description -```json +```jsonc { "kind": 9041, "tags": [ - ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", ...], + ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", /*...*/], ["amount", "210000"], ["closed_at", "<unix timestamp in seconds>"], ["image", "<image URL>"], ["summary", "<description of the goal>"], ], "content": "Nostrasia travel expenses", - ... + // other fields... } ``` @@ -59,15 +60,14 @@ The goal MAY include multiple beneficiary pubkeys by specifying [`zap` tags](57. Addressable events can link to a goal by using a `goal` tag specifying the event id and an optional relay hint. -```json +```jsonc { - ... "kind": 3xxxx, "tags": [ - ... ["goal", "<event id>", "<Relay URL (optional)>"], + // rest of tags... ], - ... + // other fields... } ``` diff --git a/84.md b/84.md index d5f54d4c..e3063c2f 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 (e.g. prompting the user or reading a `<meta name="nostr:nprofile1..." />` tag on the document). A role MAY be included as the last value of the tag. -```json +```jsonc { "tags": [ ["p", "<pubkey-hex>", "<relay-url>", "author"], ["p", "<pubkey-hex>", "<relay-url>", "author"], ["p", "<pubkey-hex>", "<relay-url>", "editor"] ], - ... + // other fields... } ``` diff --git a/89.md b/89.md index 54aa30bc..24aa3c57 100644 --- a/89.md +++ b/89.md @@ -27,7 +27,7 @@ There are three actors to this workflow: ## Events ### Recommendation event -```json +```jsonc { "kind": 31989, "pubkey": <recommender-user-pubkey>, @@ -35,7 +35,8 @@ There are three actors to this workflow: ["d", <supported-event-kind>], ["a", "31990:app1-pubkey:<d-identifier>", "wss://relay1", "ios"], ["a", "31990:app2-pubkey:<d-identifier>", "wss://relay2", "web"] - ] + ], + // other fields... } ``` @@ -47,7 +48,7 @@ The second value of the tag SHOULD be a relay hint. The third value of the tag SHOULD be the platform where this recommendation might apply. ## Handler information -```json +```jsonc { "kind": 31990, "pubkey": "<application-pubkey>", @@ -59,7 +60,8 @@ The third value of the tag SHOULD be the platform where this recommendation migh ["web", "https://..../p/<bech32>", "nprofile"], ["web", "https://..../e/<bech32>"], ["ios", ".../<bech32>"] - ] + ], + // other fields... } ``` @@ -77,13 +79,13 @@ A tag without a second value in the array SHOULD be considered a generic handler # Client tag When 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. -```json +```jsonc { "kind": 1, "tags": [ ["client", "My Client", "31990:app1-pubkey:<d-identifier>", "wss://relay1"] ] - ... + // other fields... } ``` @@ -99,14 +101,14 @@ The client MIGHT query for the user's and the user's follows handler. ### User A recommends a `kind:31337`-handler User 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. -```json +```jsonc { "kind": 31989, "tags": [ ["d", "31337"], ["a", "31990:1743058db7078661b94aaf4286429d97ee5257d14a86d6bfa54cb0482b876fb0:abcd", <relay-url>, "web"] ], - ... + // other fields... } ``` @@ -115,7 +117,7 @@ User B might see in their timeline an event referring to a `kind:31337` event (e User 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`: -```json +``` ["REQ", <id>, { "kinds": [31989], "#d": ["31337"], "authors": [<user>, <users-contact-list>] }] ``` @@ -126,6 +128,6 @@ User B's client sees the application's `kind:31990` which includes the informati ### Alternative query bypassing `kind:31989` Alternatively, 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. -```json +``` ["REQ", <id>, { "kinds": [31990], "#k": [<desired-event-kind>], "authors": [...] }] ``` diff --git a/90.md b/90.md index 5a15ebb6..696ebd59 100644 --- a/90.md +++ b/90.md @@ -36,7 +36,7 @@ There are two actors in the workflow described in this NIP: ## Job request (`kind:5000-5999`) A 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. -```json +```jsonc { "kind": 5xxx, // kind in 5000-5999 range "content": "", @@ -46,7 +46,8 @@ A request to process data, published by a customer. This event signals that a cu [ "relays", "wss://..." ], [ "bid", "<msat-amount>" ], [ "t", "bitcoin" ] - ] + ], + // other fields... } ``` @@ -81,19 +82,18 @@ If the user wants to keep the input parameters a secret, they can encrypt the `i ["param", "top-p", "0.7"], ["param", "frequency_penalty", "1"] ] - ``` This param data will be encrypted and added to the `content` field and `p` tag should be present -```json +```jsonc { "content": "BE2Y4xvS6HIY7TozIgbEl3sAHkdZoXyLRRkZv4fLPh3R7LtviLKAJM5qpkC7D6VtMbgIt4iNcMpLtpo...", "tags": [ ["p", "04f74530a6ede6b24731b976b8e78fb449ea61f40ff10e3d869a3030c4edc91f"], ["encrypted"] ], - ... + // other fields... } ``` @@ -102,7 +102,7 @@ This param data will be encrypted and added to the `content` field and `p` tag s Service 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. -```json +```jsonc { "pubkey": "<service-provider pubkey>", "content": "<payload>", @@ -114,7 +114,7 @@ Service providers publish job results, providing the output of the job result. T ["p", "<customer's-pubkey>"], ["amount", "requested-payment-amount", "<optional-bolt11>"] ], - ... + // other fields... } ``` @@ -127,7 +127,7 @@ Service providers publish job results, providing the output of the job result. T If 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. Add a tag encrypted to mark the output content as `encrypted` -```json +```jsonc { "pubkey": "<service-provider pubkey>", "content": "<encrypted payload>", @@ -139,7 +139,7 @@ Add a tag encrypted to mark the output content as `encrypted` ["amount", "requested-payment-amount", "<optional-bolt11>"], ["encrypted"] ], - ... + // other fields... } ``` @@ -147,7 +147,7 @@ Add a tag encrypted to mark the output content as `encrypted` Service providers can give feedback about a job back to the customer. -```json +```jsonc { "kind": 7000, "content": "<empty-or-payload>", @@ -157,7 +157,7 @@ Service providers can give feedback about a job back to the customer. ["e", "<job-request-id>", "<relay-hint>"], ["p", "<customer's-pubkey>"], ], - ... + // other fields... } ``` @@ -211,7 +211,7 @@ This gives a higher level of flexibility to service providers (which sophisticat # Appendix 2: Service provider discoverability Service Providers MAY use NIP-89 announcements to advertise their support for job kinds: -```js +```jsonc { "kind": 31990, "pubkey": "<pubkey>", @@ -223,7 +223,7 @@ Service Providers MAY use NIP-89 announcements to advertise their support for jo ["k", "5005"], // e.g. translation ["t", "bitcoin"] // e.g. optionally advertises it specializes in bitcoin audio transcription that won't confuse "Drivechains" with "Ridechains" ], - ... + // other fields... } ``` diff --git a/94.md b/94.md index e35dfa1c..a057cb2d 100644 --- a/94.md +++ b/94.md @@ -27,7 +27,7 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr * `alt` (optional) description for accessibility * `fallback` (optional) zero or more fallback file sources in case `url` fails -```json +```jsonc { "kind": 1063, "tags": [ @@ -46,7 +46,7 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr ["alt", <description>] ], "content": "<caption>", - ... + // other fields... } ``` diff --git a/96.md b/96.md index fab0c1a8..75d7f1f9 100644 --- a/96.md +++ b/96.md @@ -19,7 +19,7 @@ will not have to learn anything about nostr relays. File 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`: -```js +```jsonc { // Required // File upload and deletion are served from this url @@ -59,7 +59,7 @@ File storage servers wishing to be accessible by nostr users should opt-in by ma "file_expiration": [14, 90], "media_transformations": { "image": [ - 'resizing' + "resizing" ] } } @@ -127,14 +127,14 @@ The `server` MUST link the user's `pubkey` string as the owner of the file so to The upload response is a json object as follows: -```js +```jsonc { // "success" if successful or "error" if not - status: "success", + "status": "success", // Free text success, failure or info message - message: "Upload successful.", + "message": "Upload successful.", // Optional. See "Delayed Processing" section - processing_url: "...", + "processing_url": "...", // This uses the NIP-94 event format but DO NOT need // to fill some fields like "id", "pubkey", "created_at" and "sig" // @@ -143,9 +143,9 @@ The upload response is a json object as follows: // and, optionally, all file metadata the server wants to make available // // nip94_event field is absent if unsuccessful upload - nip94_event: { + "nip94_event2":{ // Required tags: "url" and "ox" - tags: [ + "tags": [ // Can be same from /.well-known/nostr/nip96.json's "download_url" field // (or "api_url" field if "download_url" is absent or empty) with appended // original file hash. @@ -171,7 +171,7 @@ The upload response is a json object as follows: ["dim", "800x600"] // ... other optional NIP-94 tags ], - content: "" + "content": "" }, // ... other custom fields (please consider adding them to this NIP or to NIP-94 tags) } @@ -202,12 +202,12 @@ the file processing is done. If the processing isn't done, the server should reply at the `processing_url` url with **200 OK** and the following JSON: -``` +```jsonc { // It should be "processing". If "error" it would mean the processing failed. - status: "processing", - message: "Processing. Please check again later for updated status.", - percentage: 15 // Processing percentage. An integer between 0 and 100. + "status": "processing", + "message": "Processing. Please check again later for updated status.", + "percentage": 15 // Processing percentage. An integer between 0 and 100. } ``` @@ -270,10 +270,10 @@ in the same file hash). The successful response is a 200 OK one with just basic JSON fields: -``` +```json { - status: "success", - message: "File deleted." + "status": "success", + "message": "File deleted." } ``` @@ -287,7 +287,7 @@ Returns a list of files linked to the authenticated users pubkey. Example Response: -```js +```jsonc { "count": 1, // server page size, eg. max(1, min(server_max_page_size, arg_count)) "total": 1, // total number of files @@ -295,17 +295,16 @@ Example Response: "files": [ { "tags": [ - ["ox": "719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b"], - ["x": "5d2899290e0e69bcd809949ee516a4a1597205390878f780c098707a7f18e3df"], + ["ox", "719171db19525d9d08dd69cb716a18158a249b7b3b3ec4bbdec5698dca104b7b"], + ["x", "5d2899290e0e69bcd809949ee516a4a1597205390878f780c098707a7f18e3df"], ["size", "123456"], ["alt", "a meme that makes you laugh"], ["expiration", "1715691139"], // ...other metadata - ] + ], "content": "haha funny meme", // caption "created_at": 1715691130 // upload timestamp - }, - ... + } ] } ``` @@ -324,14 +323,14 @@ 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: -```js -{ - // ... +```json +{. "kind": 10096, "content": "", "tags": [ ["server", "https://file.server.one"], ["server", "https://file.server.two"] - ] + ], + // other fields... } ``` diff --git a/99.md b/99.md index b1b7ce9b..e2ffc3b8 100644 --- a/99.md +++ b/99.md @@ -54,7 +54,7 @@ Other standard tags that might be useful. ## Example Event -```json +```jsonc { "kind": 30402, "created_at": 1675642635, From c8dc1eadffe0ff894ec39e291c5b28bb18e6db9e Mon Sep 17 00:00:00 2001 From: K <kehiiiiya@gmail.com> Date: Tue, 3 Sep 2024 23:47:11 +0330 Subject: [PATCH 223/587] Update 96.md --- 96.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/96.md b/96.md index 75d7f1f9..4e9ce166 100644 --- a/96.md +++ b/96.md @@ -143,7 +143,7 @@ The upload response is a json object as follows: // and, optionally, all file metadata the server wants to make available // // nip94_event field is absent if unsuccessful upload - "nip94_event2":{ + "nip94_event2": { // Required tags: "url" and "ox" "tags": [ // Can be same from /.well-known/nostr/nip96.json's "download_url" field @@ -166,7 +166,7 @@ The upload response is a json object as follows: // The server can but does not need to store this value. ["x", "543244319525d9d08dd69cb716a18158a249b7b3b3ec4bbde5435543acb34443"], // Optional. Recommended for helping clients to easily know file type before downloading it. - ["m", "image/png"] + ["m", "image/png"], // Optional. Recommended for helping clients to reserve an adequate UI space to show the file before downloading it. ["dim", "800x600"] // ... other optional NIP-94 tags From 7edd3d23a953494bcce5def703a0d7a02a5ffa9c Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Tue, 10 Sep 2024 00:32:25 +0900 Subject: [PATCH 224/587] README: update kinds table --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0ebd9d22..b22f1a38 100644 --- a/README.md +++ b/README.md @@ -142,8 +142,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `7000` | Job Feedback | [90](90.md) | | `9000`-`9030` | Group Control Events | [29](29.md) | | `9041` | Zap Goal | [75](75.md) | -| `9734` | Zap Request | [57](57.md) | | `9467` | Tidal login | [Tidal-nostr] | +| `9734` | Zap Request | [57](57.md) | | `9735` | Zap | [57](57.md) | | `9802` | Highlights | [84](84.md) | | `10000` | Mute list | [51](51.md) | @@ -174,6 +174,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30003` | Bookmark sets | [51](51.md) | | `30004` | Curation sets | [51](51.md) | | `30005` | Video sets | [51](51.md) | +| `30007` | Kind mute sets | [51](51.md) | | `30008` | Profile Badges | [58](58.md) | | `30009` | Badge Definition | [58](58.md) | | `30015` | Interest sets | [51](51.md) | From e7eb776288b424e8cd43080b33b21506942f91e0 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Mon, 9 Sep 2024 12:38:51 -0700 Subject: [PATCH 225/587] Revert example code update --- 13.md | 45 +++++++++++++++++++-------------------------- 1 file changed, 19 insertions(+), 26 deletions(-) diff --git a/13.md b/13.md index 0900d2d7..cf5b1acd 100644 --- a/13.md +++ b/13.md @@ -48,37 +48,30 @@ Validating Here is some reference C code for calculating the difficulty (aka number of leading zero bits) in a nostr event id: ```c -#include <stdio.h> -#include <stdlib.h> -#include <string.h> +int zero_bits(unsigned char b) +{ + int n = 0; -int countLeadingZeroes(const char *hex) { - int count = 0; + if (b == 0) + return 8; - for (int i = 0; i < strlen(hex); i++) { - int nibble = (int)strtol((char[]){hex[i], '\0'}, NULL, 16); - if (nibble == 0) { - count += 4; - } else { - count += __builtin_clz(nibble) - 28; - break; - } - } + while (b >>= 1) + n++; - return count; + return 7-n; } -int main(int argc, char *argv[]) { - if (argc != 2) { - fprintf(stderr, "Usage: %s <hex_string>\n", argv[0]); - return 1; - } - - const char *hex_string = argv[1]; - int result = countLeadingZeroes(hex_string); - printf("Leading zeroes in hex string %s: %d\n", hex_string, result); - - return 0; +/* find the number of leading zero bits in a hash */ +int count_leading_zero_bits(unsigned char *hash) +{ + int bits, total, i; + for (i = 0, total = 0; i < 32; i++) { + bits = zero_bits(hash[i]); + total += bits; + if (bits != 8) + break; + } + return total; } ``` From c343175a32f492cd1a40749fdd7c523c083bdb19 Mon Sep 17 00:00:00 2001 From: Zig Blathazar <42387185+ZigBalthazar@users.noreply.github.com> Date: Tue, 10 Sep 2024 23:37:36 +0330 Subject: [PATCH 226/587] Update 10.md --- 10.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/10.md b/10.md index 67b01f27..94db4fae 100644 --- a/10.md +++ b/10.md @@ -43,7 +43,7 @@ They are citing from this event. `root-id` and `reply-id` are as above. Where: * `<event-id>` is the id of the event being referenced. - * `<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 `""`. + * `<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 `""`. * `<marker>` is optional and if present is one of `"reply"`, `"root"`, or `"mention"`. * `<pubkey>` is optional, SHOULD be the pubkey of the author of the referenced event From d8ab9849b36f741ced25e40e9639c72b8062a38e Mon Sep 17 00:00:00 2001 From: kehiy <kehiiiiya@gmail.com> Date: Wed, 11 Sep 2024 13:17:16 +0330 Subject: [PATCH 227/587] make *.md linguist detectable. --- .gitattributes | 1 + 1 file changed, 1 insertion(+) create mode 100644 .gitattributes diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000..a252d3d7 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +*.md linguist-detectable From 37a02e817b4b3e3ee7599fb1d28d97db133ef05c Mon Sep 17 00:00:00 2001 From: Zig Blathazar <42387185+ZigBalthazar@users.noreply.github.com> Date: Thu, 12 Sep 2024 16:45:47 +0330 Subject: [PATCH 228/587] custom emojis in reactions (#1492) --- 30.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/30.md b/30.md index c2f8bb07..54a8b375 100644 --- a/30.md +++ b/30.md @@ -54,3 +54,19 @@ In kind 1 events, the `content` should be emojified. "created_at": 1682630000 } ``` + +### Kind 7 events + +In kind 7 events, the `content` should be emojified. + +```json +{ + "kind": 7, + "content": ":dezh:", + "tags": [ + ["emoji", "dezh", "https://raw.githubusercontent.com/dezh-tech/brand-assets/main/dezh/logo/black-normal.svg"] + ], + "pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6", + "created_at": 1682630000 +} +``` From e61651ac06c662b43817f85581b50e4254efbd7b Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Fri, 13 Sep 2024 08:07:38 -0300 Subject: [PATCH 229/587] nip29: make @staab happier. --- 29.md | 90 +++++++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 75 insertions(+), 15 deletions(-) diff --git a/29.md b/29.md index 6232f8b6..f4a54364 100644 --- a/29.md +++ b/29.md @@ -22,6 +22,12 @@ Relays are supposed to generate the events that describe group metadata and grou A 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`. +Group identifiers must be strings restricted to the characters `a-z0-9-_`. + +When 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. + +Group 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. + ## The `h` tag Events 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,8 +42,22 @@ This is a hack to prevent messages from being broadcasted to external relays tha Relays 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. +## Unmanaged groups + +Unmanaged 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. + +In `unmanaged` groups, everybody is considered to be a member. + +Unmanaged 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. + ## Event definitions +These are the events expected to be found in NIP-29 groups. + +### Normal user-created events + +These 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. + - *text root note* (`kind:11`) This is the basic unit of a "microblog" root text note sent to a group. @@ -79,6 +99,14 @@ Similar to `kind:12`, this is the basic unit of a chat message sent to a group. `kind:10` SHOULD use NIP-10 markers, just like `kind:12`. +- other events: + +Groups 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. + +### User-related group management events + +These are events that can be sent my user to manage their situation in a group, they also require the `h` tag. + - *join request* (`kind:9021`) Any 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. @@ -88,11 +116,14 @@ Any user can send one of these events to the relay in order to be automatically "kind": 9021, "content": "optional reason", "tags": [ - ["h", "<group-id>"] + ["h", "<group-id>"], + ["claim", "<optional-invite-code>"] ] } ``` +The optional `claim` tag may be used by the relay to preauthorize acceptances in `closed` groups, together with the `kind:9009` `create-invite` moderation event. + - *leave request* (`kind:9022`) Any 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. @@ -107,6 +138,10 @@ Any user can send one of these events to the relay in order to be automatically } ``` +### Group state -- or moderation + +These 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. + - *moderation events* (`kinds:9000-9020`) (optional) 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. The relay may discard the event after taking action or keep it as a moderation log. @@ -124,17 +159,24 @@ Clients can send these events to a relay in order to accomplish a moderation act Each moderation action uses a different kind and requires different arguments, which are given as tags. These are defined in the following table: -| kind | name | tags | -| --- | --- | --- | -| 9000 | `add-user` | `p` (pubkey hex) | -| 9001 | `remove-user` | `p` (pubkey hex) | -| 9002 | `edit-metadata` | `name`, `about`, `picture` (string) | -| 9003 | `add-permission` | `p` (pubkey), `permission` (name) | -| 9004 | `remove-permission` | `p` (pubkey), `permission` (name) | -| 9005 | `delete-event` | `e` (id hex) | -| 9006 | `edit-group-status` | `public` or `private`, `open` or `closed` | -| 9007 | `create-group` | | -| 9008 | `delete-group` | | +| kind | name | tags | +| --- | --- | --- | +| 9000 | `add-user` | `p` (pubkey hex) | +| 9001 | `remove-user` | `p` (pubkey hex) | +| 9002 | `edit-metadata` | `name`, `about`, `picture` (string) | +| 9003 | `add-permission` | `p` (pubkey), `permission` (name) | +| 9004 | `remove-permission` | `p` (pubkey), `permission` (name) | +| 9005 | `delete-event` | `e` (id hex) | +| 9006 | `edit-group-status` | `public` or `private`, `open` or `closed` | +| 9007 | `create-group` | | +| 9008 | `delete-group` | | +| 9009 | `create-invite` | `code`, `uses` (how many times it can be used) | + +It'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. + +### Group metadata events + +These events contain the group id in a `d` tag instead of the `h` tag. They are expected to 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). - *group metadata* (`kind:39000`) (optional) @@ -142,6 +184,8 @@ This event defines the metadata for the group -- basically how clients should di If the group is forked and hosted in multiple relays, there will be multiple versions of this event in each different relay and so on. +When this event is not found, clients may still connect to the group, but treat it as having a different status, `unmanaged`, + ```jsonc { "kind": 39000, @@ -194,7 +238,9 @@ The list of capabilities, as defined by this NIP, for now, is the following: Similar to *group admins*, this event is supposed to be generated by relays that host the group. -It'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. +It's a 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. + +Clients should not assume this will always be present or that it will contain a full list of members, as relays may opt to not publish it or publish a shortened version. ```json { @@ -209,6 +255,20 @@ It's a NIP-51-like list of pubkeys that are members of the group. Relays might c } ``` -## Storing the list of groups a user belongs to +## Implementation quirks -A 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. +### Checking your own membership in a group + +The 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. + +### Adding yourself to a group + +When 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. + +### Storing your list of groups + +A 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. + +### Using `unmanaged` relays + +To 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. From efcc86950dd32721e00f868b480a74e9dbd9ca1b Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Fri, 13 Sep 2024 16:17:35 -0300 Subject: [PATCH 230/587] remove this annoying file. --- .gitattributes | 1 - 1 file changed, 1 deletion(-) delete mode 100644 .gitattributes diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index a252d3d7..00000000 --- a/.gitattributes +++ /dev/null @@ -1 +0,0 @@ -*.md linguist-detectable From d534bade7184966df7335a8867b97cd879ee58cd Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Tue, 17 Sep 2024 11:03:56 -0300 Subject: [PATCH 231/587] renumber polls NIP to 88. this one: https://github.com/nostr-protocol/nips/pull/1346 --- 118.md => 88.md | 8 ++++---- README.md | 3 +++ 2 files changed, 7 insertions(+), 4 deletions(-) rename 118.md => 88.md (95%) diff --git a/118.md b/88.md similarity index 95% rename from 118.md rename to 88.md index b22b0064..4318062b 100644 --- a/118.md +++ b/88.md @@ -1,4 +1,4 @@ -# NIP-118 +# NIP-88 ## Polls @@ -15,7 +15,7 @@ The NIP makes the following tradeoffs. ### Poll Event -The poll event is defined as a `kind:1068` event. +The poll event is defined as a `kind:1068` event. - **content** key holds the label for the poll. @@ -24,7 +24,7 @@ Major tags in the poll event are: - **option**: The option tags contain an OptionId(any alphanumeric) field, followed by an option label field. - **relay**: One or multiple tags that the poll is expecting respondents to respond on. -- **polltype**: can be "singlechoice", "multiplechoice", or "rankedchoice". Polls that do not have a polltype should be considered a "singlechoice" poll. +- **polltype**: can be "singlechoice", "multiplechoice", or "rankedchoice". Polls that do not have a polltype should be considered a "singlechoice" poll. Example Event @@ -89,4 +89,4 @@ In case of multiple events for a pubkey, the event with the largest timestamp sh ### Curation The clients may configure fetching results by specific people. This can be achieved by creating `kind:30000` follow sets, and fetching results only from the follow set. -Clients can also employ other curation algorithms, like Proof Of Work and Web of Trust scores for result curations. \ No newline at end of file +Clients can also employ other curation algorithms, like Proof Of Work and Web of Trust scores for result curations. diff --git a/README.md b/README.md index b22f1a38..5222e283 100644 --- a/README.md +++ b/README.md @@ -82,6 +82,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-75: Zap Goals](75.md) - [NIP-78: Application-specific data](78.md) - [NIP-84: Highlights](84.md) +- [NIP-88: Polls](88.md) - [NIP-89: Recommended Application Handlers](89.md) - [NIP-90: Data Vending Machines](90.md) - [NIP-92: Media Attachments](92.md) @@ -118,11 +119,13 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `44` | Channel Mute User | [28](28.md) | | `64` | Chess (PGN) | [64](64.md) | | `818` | Merge Requests | [54](54.md) | +| `1018` | Poll Response | [88](88.md) | | `1021` | Bid | [15](15.md) | | `1022` | Bid confirmation | [15](15.md) | | `1040` | OpenTimestamps | [03](03.md) | | `1059` | Gift Wrap | [59](59.md) | | `1063` | File Metadata | [94](94.md) | +| `1068` | Poll | [88](88.md) | | `1311` | Live Chat Message | [53](53.md) | | `1617` | Patches | [34](34.md) | | `1621` | Issues | [34](34.md) | From 3d8bf682b6f6f961a4c3609f9447907abaad9d0e Mon Sep 17 00:00:00 2001 From: Alex Gleason <alex@alexgleason.me> Date: Tue, 17 Sep 2024 09:22:40 -0500 Subject: [PATCH 232/587] NIP-88: make poll response a parameterized replaceable event --- 88.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/88.md b/88.md index 4318062b..1e71ffa2 100644 --- a/88.md +++ b/88.md @@ -50,7 +50,7 @@ Example Event ### Responses -The response event is a `kind:1018` event. It contains an e tag with the poll event it is referencing, followed by one or more response tags. +The response event is a `kind:30068` event. It contains a d tag with the poll event it is referencing, followed by one or more response tags. - **response** : The tag contains "response" as it's first positional argument followed by the option Id selected. @@ -61,11 +61,11 @@ Example Response Event "content": "", "created_at": 1720097117, "id": "60a005e32e9596c3f544a841a9bc4e46d3020ca3650d6a739c95c1568e33f6d8", - "kind": 1018, + "kind": 30068, "pubkey": "1bc70a0148b3f316da33fe7e89f23e3e71ac4ff998027ec712b905cd24f6a411", "sig": "30071a633c65db8f3a075c7a8de757fbd8ce65e3607f4ba287fe6d7fbf839a380f94ff4e826fbba593f6faaa13683b7ea9114ade140720ecf4927010ebf3e44f", "tags": [ - ["e", "1fc80cf813f1af33d5a435862b7ef7fb96b47e68a48f1abcadf8081f5a545550"], + ["d", "1fc80cf813f1af33d5a435862b7ef7fb96b47e68a48f1abcadf8081f5a545550"], ["response", "gga6cdnqj"], ["response", "m3agjsdq1"] ] @@ -74,7 +74,7 @@ Example Response Event ### Poll Types -Poll Types can be configured in the settings object of the poll, the setting dictates how multiple response tags are handled in the `kind:1018` event. +Poll Types can be configured in the settings object of the poll, the setting dictates how multiple response tags are handled in the `kind:30068` event. - **PollType: singlechoice**: The first response tag is to be considered the actual response. - **PollType: multiplechoice**: The first response tag pointing to each id is considered the actual response, without considering the order of the response tags. @@ -82,7 +82,7 @@ Poll Types can be configured in the settings object of the poll, the setting dic ### Counting Results -Results can be queried by fetching `kind:1018` events from the relays specified in the poll. +Results can be queried by fetching `kind:30068` events from the relays specified in the poll. The results displayed should only be 1 vote event per pubkey. In case of multiple events for a pubkey, the event with the largest timestamp should be considered. From 6cd598d02cceec76f6c4df6e061c4135ca3e3fd3 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Tue, 17 Sep 2024 18:56:50 -0300 Subject: [PATCH 233/587] remove NIP-88 polls temporarily. due to some crazy fight happening at https://github.com/nostr-protocol/nips/pull/1501 I'm removing this until people can become more reasonable. --- 88.md | 92 ------------------------------------------------------- README.md | 3 -- 2 files changed, 95 deletions(-) delete mode 100644 88.md diff --git a/88.md b/88.md deleted file mode 100644 index 1e71ffa2..00000000 --- a/88.md +++ /dev/null @@ -1,92 +0,0 @@ -# NIP-88 - -## Polls - -`draft` `optional` - -This NIP defines the event scheme that describe Polls on nostr. - -The NIP makes the following tradeoffs. - -1. All votes are public. -2. All votes are editable (latest response by timestamp considered last vote) - -## Events - -### Poll Event - -The poll event is defined as a `kind:1068` event. - -- **content** key holds the label for the poll. - -Major tags in the poll event are: - - -- **option**: The option tags contain an OptionId(any alphanumeric) field, followed by an option label field. -- **relay**: One or multiple tags that the poll is expecting respondents to respond on. -- **polltype**: can be "singlechoice", "multiplechoice", or "rankedchoice". Polls that do not have a polltype should be considered a "singlechoice" poll. - - -Example Event - -```json -{ - "content": "", - "created_at": 1719888496, - "id": "9d1b6b9562e66f2ecf35eb0a3c2decc736c47fddb13d6fb8f87185a153ea3634", - "kind": 1068, - "pubkey": "dee45a23c4f1d93f3a2043650c5081e4ac14a778e0acbef03de3768e4f81ac7b", - "sig": "7fa93bf3c430eaef784b0dacc217d3cd5eff1c520e7ef5d961381bc0f014dde6286618048d924808e54d1be03f2f2c2f0f8b5c9c2082a4480caf45a565ca9797", - "tags": [ - ["label", "Pineapple on Pizza"], - ["option", "qj518h583", "Yay"], - ["option", "gga6cdnqj", "Nay"], - ["relay","<relay url1>"], - ["relay", "<relay url2>"], - ["polltype", "singlechoice"] - ] -} -``` - -### Responses - -The response event is a `kind:30068` event. It contains a d tag with the poll event it is referencing, followed by one or more response tags. - -- **response** : The tag contains "response" as it's first positional argument followed by the option Id selected. - -Example Response Event - -```json -{ - "content": "", - "created_at": 1720097117, - "id": "60a005e32e9596c3f544a841a9bc4e46d3020ca3650d6a739c95c1568e33f6d8", - "kind": 30068, - "pubkey": "1bc70a0148b3f316da33fe7e89f23e3e71ac4ff998027ec712b905cd24f6a411", - "sig": "30071a633c65db8f3a075c7a8de757fbd8ce65e3607f4ba287fe6d7fbf839a380f94ff4e826fbba593f6faaa13683b7ea9114ade140720ecf4927010ebf3e44f", - "tags": [ - ["d", "1fc80cf813f1af33d5a435862b7ef7fb96b47e68a48f1abcadf8081f5a545550"], - ["response", "gga6cdnqj"], - ["response", "m3agjsdq1"] - ] -} -``` - -### Poll Types - -Poll Types can be configured in the settings object of the poll, the setting dictates how multiple response tags are handled in the `kind:30068` event. - -- **PollType: singlechoice**: The first response tag is to be considered the actual response. -- **PollType: multiplechoice**: The first response tag pointing to each id is considered the actual response, without considering the order of the response tags. -- **PollType: rankedchoice**: The first response tag pointing to each id is the considered the actual response, while also taking into account the order of the response tags. - -### Counting Results - -Results can be queried by fetching `kind:30068` events from the relays specified in the poll. -The results displayed should only be 1 vote event per pubkey. -In case of multiple events for a pubkey, the event with the largest timestamp should be considered. - -### Curation - -The clients may configure fetching results by specific people. This can be achieved by creating `kind:30000` follow sets, and fetching results only from the follow set. -Clients can also employ other curation algorithms, like Proof Of Work and Web of Trust scores for result curations. diff --git a/README.md b/README.md index 5222e283..b22f1a38 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-75: Zap Goals](75.md) - [NIP-78: Application-specific data](78.md) - [NIP-84: Highlights](84.md) -- [NIP-88: Polls](88.md) - [NIP-89: Recommended Application Handlers](89.md) - [NIP-90: Data Vending Machines](90.md) - [NIP-92: Media Attachments](92.md) @@ -119,13 +118,11 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `44` | Channel Mute User | [28](28.md) | | `64` | Chess (PGN) | [64](64.md) | | `818` | Merge Requests | [54](54.md) | -| `1018` | Poll Response | [88](88.md) | | `1021` | Bid | [15](15.md) | | `1022` | Bid confirmation | [15](15.md) | | `1040` | OpenTimestamps | [03](03.md) | | `1059` | Gift Wrap | [59](59.md) | | `1063` | File Metadata | [94](94.md) | -| `1068` | Poll | [88](88.md) | | `1311` | Live Chat Message | [53](53.md) | | `1617` | Patches | [34](34.md) | | `1621` | Issues | [34](34.md) | From 765daceaa1a25a0324864668cf977cbdcb30bbd4 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Wed, 18 Sep 2024 22:27:03 -0300 Subject: [PATCH 234/587] remove invites, simplify group metadata edits, rework fine-grained "permissions" into unspecified "roles". --- 29.md | 77 +++++++++++++++++++++++++++++++++-------------------------- 1 file changed, 43 insertions(+), 34 deletions(-) diff --git a/29.md b/29.md index f4a54364..c0dbcef7 100644 --- a/29.md +++ b/29.md @@ -144,7 +144,7 @@ These are events expected to be sent by the relay master key or by group admins - *moderation events* (`kinds:9000-9020`) (optional) -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. The relay may discard the event after taking action or keep it as a moderation log. +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 { @@ -161,22 +161,21 @@ Each moderation action uses a different kind and requires different arguments, w | kind | name | tags | | --- | --- | --- | -| 9000 | `add-user` | `p` (pubkey hex) | -| 9001 | `remove-user` | `p` (pubkey hex) | -| 9002 | `edit-metadata` | `name`, `about`, `picture` (string) | -| 9003 | `add-permission` | `p` (pubkey), `permission` (name) | -| 9004 | `remove-permission` | `p` (pubkey), `permission` (name) | -| 9005 | `delete-event` | `e` (id hex) | -| 9006 | `edit-group-status` | `public` or `private`, `open` or `closed` | +| 9000 | `add-user` | `p` with pubkey hex | +| 9001 | `remove-user` | `p` with pubkey hex | +| 9002 | `edit-metadata` | fields from `kind:39000` to be modified | +| 9003 | | | +| 9004 | | | +| 9005 | `delete-event` | | +| 9006 | `set-role` | `p` with pubkey hex and roles | | 9007 | `create-group` | | | 9008 | `delete-group` | | -| 9009 | `create-invite` | `code`, `uses` (how many times it can be used) | It'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. ### Group metadata events -These events contain the group id in a `d` tag instead of the `h` tag. They are expected to 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). +These 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). - *group metadata* (`kind:39000`) (optional) @@ -206,43 +205,29 @@ When this event is not found, clients may still connect to the group, but treat - *group admins* (`kind:39001`) (optional) -Similar to the group metadata, this event is supposed to be generated by relays that host the group. +Each 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. -Each 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. - -The list of capabilities, as defined by this NIP, for now, is the following: - -- `add-user` -- `edit-metadata` -- `delete-event` -- `remove-user` -- `add-permission` -- `remove-permission` -- `edit-group-status` -- `delete-group` - -```json +```jsonc { "kind": 39001, "content": "list of admins for the pizza lovers group", "tags": [ ["d", "<group-id>"], - ["p", "<pubkey1-as-hex>", "ceo", "add-user", "edit-metadata", "delete-event", "remove-user"], - ["p", "<pubkey2-as-hex>", "secretary", "add-user", "delete-event"] - ] + ["p", "<pubkey1-as-hex>", "ceo"], + ["p", "<pubkey2-as-hex>", "secretary", "gardener"], + // other pubkeys... + ], // other fields... } ``` - *group members* (`kind:39002`) (optional) -Similar to *group admins*, this event is supposed to be generated by relays that host the group. +It'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. -It's a 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. +Clients should not assume this will always be present or that it will contain a full list of members. -Clients should not assume this will always be present or that it will contain a full list of members, as relays may opt to not publish it or publish a shortened version. - -```json +```jsonc { "kind": 39002, "content": "list of members for the pizza lovers group", @@ -251,7 +236,31 @@ Clients should not assume this will always be present or that it will contain a ["p", "<admin1>"], ["p", "<member-pubkey1>"], ["p", "<member-pubkey2>"], - ] + // other pubkeys... + ], + // other fields... +} +``` + +- *group roles* (`kind:39003`) (optional) + +This 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. + +For 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). + +The 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. + +```jsonc +{ + "kind": 39003, + "content": "list of roles supported by this group", + "tags": [ + ["d", "<group-id>"], + ["role", "<role-name>", "<optional-description>"], + ["role", "<role-name>", "<optional-description>"], + // other roles... + ], + // other fields... } ``` From 79786bb7bbb32162c233d99850cb33b379c2fc7a Mon Sep 17 00:00:00 2001 From: Oscar Merry <oscardmerry@gmail.com> Date: Fri, 20 Sep 2024 16:21:15 +0100 Subject: [PATCH 235/587] Expand External Content IDs --- 73.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/73.md b/73.md index d50ab22a..afed8d12 100644 --- a/73.md +++ b/73.md @@ -6,17 +6,29 @@ External Content IDs `draft` `optional` -There are certain established global content identifiers that would be useful to reference in nostr events so that clients can query all events assosiated with these ids. +There 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. -- Book [ISBNs](https://en.wikipedia.org/wiki/ISBN) -- Podcast [GUIDs](https://podcastnamespace.org/tag/guid) -- Movie [ISANs](https://en.wikipedia.org/wiki/International_Standard_Audiovisual_Number) - -Since the `i` tag is already used for similar references in kind-0 metadata events it makes sense to use it for these content ids as well. +`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. ## Supported IDs +| Type | `i` tag | `k` tag | +|- | - | - | +| URLs | "`<URL, normalized, no fragment>`" | "`<scheme-host, normalized>`" | +| Hashtags | "#`<topic, lowercase>`" | "#" | +| Geohashes| "geo:`<geohash, lowercase>`" | "geo" | +| Books | "isbn:`<id, without hyphens>`" | "isbn" | +| Podcast Feeds | "podcast:guid:`<guid>`" | "podcast:guid" | +| Podcast Episodes | "podcast:item:guid:`<guid>`" | "podcast:item:guid" | +| Podcast Publishers | "podcast:publisher:guid:`<guid>`" | "podcast:publisher:guid" | +| Movies | "isan:`<id, without version part>`" | "isan" | +| Papers | "doi:`<id, lowercase>`" | "doi" | + +--- + +## Examples + ### Books: - Book ISBN: `["i", "isbn:9780765382030"]` - https://isbnsearch.org/isbn/9780765382030 From ea36ec9ed7596e49bf7f217b05954c1fecacad88 Mon Sep 17 00:00:00 2001 From: dluvian <133484344+dluvian@users.noreply.github.com> Date: Fri, 20 Sep 2024 14:08:47 -0600 Subject: [PATCH 236/587] Add `subject` and `t` tags to git issues (#1446) * Add subject and and l tags to git issues * Replace `l` with `t` tags * Add nip34 to tag table * List nip34 under subject instead of summary --- 34.md | 7 ++++++- README.md | 4 ++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/34.md b/34.md index 9363aeb1..35bc1be0 100644 --- a/34.md +++ b/34.md @@ -104,7 +104,9 @@ The first patch in a series MAY be a cover letter in the format produced by `git ## Issues -Issues 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. +Issues 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. + +Issues 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. ```json { @@ -113,6 +115,9 @@ Issues are Markdown text that is just human-readable conversational threads rela "tags": [ ["a", "30617:<base-repo-owner-pubkey>:<base-repo-id>"], ["p", "<repository-owner>"] + ["subject", "<issue-subject>"] + ["t", "<issue-label>"] + ["t", "<another-issue-label>"] ] } ``` diff --git a/README.md b/README.md index b22f1a38..a9318ee8 100644 --- a/README.md +++ b/README.md @@ -262,7 +262,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `q` | event id (hex) | relay URL | [18](18.md) | | `r` | a reference (URL, etc) | -- | [24](24.md), [25](25.md) | | `r` | relay url | marker | [65](65.md) | -| `t` | hashtag | -- | [24](24.md) | +| `t` | hashtag | -- | [24](24.md), [34](34.md) | | `alt` | summary | -- | [31](31.md) | | `amount` | millisatoshis, stringified | -- | [57](57.md) | | `bolt11` | `bolt11` invoice | -- | [57](57.md) | @@ -289,7 +289,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `relay` | relay url | -- | [42](42.md), [17](17.md) | | `relays` | relay list | -- | [57](57.md) | | `server` | file storage server url | -- | [96](96.md) | -| `subject` | subject | -- | [14](14.md), [17](17.md) | +| `subject` | subject | -- | [14](14.md), [17](17.md), [34](34.md) | | `summary` | summary | -- | [23](23.md), [52](52.md) | | `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | | `title` | article title | -- | [23](23.md) | From d82f68aa2ea37324b7d185954cc530a17db45e93 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Sat, 21 Sep 2024 11:52:09 -0300 Subject: [PATCH 237/587] update link to blossom on README. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a9318ee8..758045d2 100644 --- a/README.md +++ b/README.md @@ -158,7 +158,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10015` | Interests list | [51](51.md) | | `10030` | User emoji list | [51](51.md) | | `10050` | Relay list to receive DMs | [51](51.md), [17](17.md) | -| `10063` | User server list | [blossom] | +| `10063` | User server list | [Blossom][blossom] | | `10096` | File storage server list | [96](96.md) | | `13194` | Wallet Info | [47](47.md) | | `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | @@ -166,7 +166,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `23194` | Wallet Request | [47](47.md) | | `23195` | Wallet Response | [47](47.md) | | `24133` | Nostr Connect | [46](46.md) | -| `24242` | Blobs stored on mediaservers | [blossom] | +| `24242` | Blobs stored on mediaservers | [Blossom][blossom] | | `27235` | HTTP Auth | [98](98.md) | | `30000` | Follow sets | [51](51.md) | | `30001` | Generic lists | [51](51.md) | @@ -216,7 +216,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos [joinstr]: https://gitlab.com/1440000bytes/joinstr/-/blob/main/NIP.md [NKBIP-01]: https://wikistr.com/nkbip-01 [NKBIP-02]: https://wikistr.com/nkbip-02 -[Blossom]: https://wikistr.com/blossom +[blossom]: https://github.com/hzrd149/blossom [Tidal-nostr]: https://wikistr.com/tidal-nostr ## Message types From 4e73e94d417f16fa3451e58ef921cb3b512c6f8e Mon Sep 17 00:00:00 2001 From: Lux <135403604+Spl0itable@users.noreply.github.com> Date: Sun, 22 Sep 2024 19:17:39 +0930 Subject: [PATCH 238/587] fix typo on nip96 (#1511) Fixing typo --- 96.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/96.md b/96.md index 4e9ce166..05c1b186 100644 --- a/96.md +++ b/96.md @@ -143,7 +143,7 @@ The upload response is a json object as follows: // and, optionally, all file metadata the server wants to make available // // nip94_event field is absent if unsuccessful upload - "nip94_event2": { + "nip94_event": { // Required tags: "url" and "ox" "tags": [ // Can be same from /.well-known/nostr/nip96.json's "download_url" field From a736e629be5c4c9125d98bdb4965851d8110c483 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Sat, 28 Sep 2024 12:26:48 -0300 Subject: [PATCH 239/587] complete renaming to "addressable" events. as noticed by @bezysoftware at https://github.com/nostr-protocol/nips/pull/1437#issuecomment-2380626514. I don't know how so many of these instances were left from the original PR at following ca3c52e3e74f0a4679f1c6c0d9ac6461ea748d2d. --- 01.md | 4 ++-- 23.md | 2 +- 32.md | 4 ++-- 38.md | 2 +- 52.md | 6 +++--- 58.md | 3 +-- 71.md | 6 +++--- 75.md | 2 +- 8 files changed, 14 insertions(+), 15 deletions(-) diff --git a/01.md b/01.md index 9e502044..c3c09912 100644 --- a/01.md +++ b/01.md @@ -77,7 +77,7 @@ This NIP defines 3 standard tags that can be used across all event kinds with th - The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, <recommended relay URL, optional>]` - The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, <recommended relay URL, optional>]` -- The `a` tag, used to refer to a (maybe parameterized) replaceable event +- The `a` tag, used to refer to an addressable or replaceable event - for an addressable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]` - for a normal replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:, <recommended relay URL, optional>]` @@ -95,7 +95,7 @@ And also a convention for kind ranges that allow for easier experimentation and - 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. - 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. - for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. -- 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. +- 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. In 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. diff --git a/23.md b/23.md index d8fb51a3..720f6d61 100644 --- a/23.md +++ b/23.md @@ -31,7 +31,7 @@ Other metadata fields can be added as tags to the event as necessary. Here we st ### Editability -These 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. +These 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. ### Linking diff --git a/32.md b/32.md index 66f02836..a99e52a3 100644 --- a/32.md +++ b/32.md @@ -8,7 +8,7 @@ Labeling This 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. -New Tags: +New Tags: - `L` denotes a label namespace - `l` denotes a label @@ -146,7 +146,7 @@ Other Notes ----------- When using this NIP to bulk-label many targets at once, events may be requested for deletion using [NIP-09](09.md) and a replacement -may be published. We have opted not to use parameterizable/replaceable events for this due to the +may be published. We have opted not to use addressable/replaceable events for this due to the complexity in coming up with a standard `d` tag. In order to avoid ambiguity when querying, publishers SHOULD limit labeling events to a single namespace. diff --git a/38.md b/38.md index 8b22b2a7..ece5e5f7 100644 --- a/38.md +++ b/38.md @@ -46,7 +46,7 @@ Two common status types are defined: `general` and `music`. `general` represent Any other status types can be used but they are not defined by this NIP. -The status MAY include an `r`, `p`, `e` or `a` tag linking to a URL, profile, note, or parameterized replaceable event. +The status MAY include an `r`, `p`, `e` or `a` tag linking to a URL, profile, note, or addressable event. The `content` MAY include emoji(s), or [NIP-30](30.md) custom emoji(s). If the `content` is an empty string then the client should clear the status. diff --git a/52.md b/52.md index c6d6b968..cc2625af 100644 --- a/52.md +++ b/52.md @@ -20,7 +20,7 @@ This kind of calendar event starts on a date and ends before a different date in #### Format -The format uses a parameterized replaceable event kind `31922`. +The format uses an _addressable event_ of `kind:31922`. The `.content` of these events should be a detailed description of the calendar event. It is required but can be an empty string. @@ -79,7 +79,7 @@ This kind of calendar event spans between a start time and end time. #### Format -The format uses a parameterized replaceable event kind `31923`. +The format uses an _addressable event_ kind `31923`. The `.content` of these events should be a detailed description of the calendar event. It is required but can be an empty string. @@ -193,7 +193,7 @@ The RSVP MAY tag the author of the calendar event it is in response to using a ` ### Format -The format uses a parameterized replaceable event kind `31925`. +The format uses an _addressable event_ kind `31925`. The `.content` of these events is optional and should be a free-form note that adds more context to this calendar event response. diff --git a/58.md b/58.md index b6324f4e..23921bdd 100644 --- a/58.md +++ b/58.md @@ -13,8 +13,7 @@ user profiles: 2. 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. -3. A "Profile Badges" event is defined as a parameterized replaceable event -with kind `30008` with a `d` tag with the value `profile_badges`. +3. A "Profile Badges" event is defined as an _addressable event_ with kind `30008` with a `d` tag with the value `profile_badges`. Profile 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. ### Badge Definition event diff --git a/71.md b/71.md index 5cf3b369..dd813e93 100644 --- a/71.md +++ b/71.md @@ -16,7 +16,7 @@ There are two types of video events represented by different kinds: horizontal a #### Format -The format uses a parameterized replaceable event kind `34235` for horizontal videos and `34236` for vertical videos. +The format uses an _addressable event_ kind `34235` for horizontal videos and `34236` for vertical videos. The `.content` of these events is a summary or description on the video content. @@ -91,14 +91,14 @@ A video event view is a response to a video event to track a user's view or prog ### Format -The format uses a parameterized replaceable event kind `34237`. +The format uses an _addressable event_ kind `34237`. The `.content` of these events is optional and could be a free-form note that acts like a bookmark for the user. The list of tags are as follows: * `a` (required) reference tag to kind `34235` or `34236` video event being viewed * `d` (required) same as `a` reference tag value -* `viewed` (optional, repeated) timestamp of the user's start time in seconds, timestamp of the user's end time in seconds +* `viewed` (optional, repeated) timestamp of the user's start time in seconds, timestamp of the user's end time in seconds ```json diff --git a/75.md b/75.md index 885c3910..ad933d5f 100644 --- a/75.md +++ b/75.md @@ -77,7 +77,7 @@ Clients MAY display funding goals on user profiles. When zapping a goal event, clients MUST include the relays in the `relays` tag of the goal event in the zap request `relays` tag. -When zapping a parameterized replaceable event with a `goal` tag, clients SHOULD tag the goal event id in the `e` tag of the zap request. +When zapping an addressable event with a `goal` tag, clients SHOULD tag the goal event id in the `e` tag of the zap request. ## Use cases From ce2234e0baac9d64f7044ec1c4a5cc7210fd2fc2 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Mon, 30 Sep 2024 09:17:22 -0700 Subject: [PATCH 240/587] Clarify tag filters --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index c3c09912..d62f3177 100644 --- a/01.md +++ b/01.md @@ -81,7 +81,7 @@ This NIP defines 3 standard tags that can be used across all event kinds with th - for an addressable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]` - for a normal replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:, <recommended relay URL, optional>]` -As 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. +As 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. ### Kinds From 344b0b9a7271d5f6ac9cf2e6c875a7108d22a1dc Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Wed, 2 Oct 2024 23:15:20 +0900 Subject: [PATCH 241/587] README: add NIP-73 link to `k` tag --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 758045d2..789dcca2 100644 --- a/README.md +++ b/README.md @@ -255,7 +255,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `g` | geohash | -- | [52](52.md) | | `h` | group id | -- | [29](29.md) | | `i` | external identity | proof, url hint | [39](39.md), [73](73.md) | -| `k` | kind number (string) | -- | [18](18.md), [25](25.md), [72](72.md) | +| `k` | kind | -- | [18](18.md), [25](25.md), [72](72.md), [73](73.md) | | `l` | label, label namespace | -- | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | | `m` | MIME type | -- | [94](94.md) | From 7f67ce53fbc6f2994a53853fbd2f186cd5c5a94f Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Wed, 2 Oct 2024 23:19:35 +0900 Subject: [PATCH 242/587] Format tags table --- README.md | 100 +++++++++++++++++++++++++++--------------------------- 1 file changed, 50 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 789dcca2..e5e31c68 100644 --- a/README.md +++ b/README.md @@ -245,56 +245,56 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos ## Standardized Tags -| name | value | other parameters | NIP | -| ----------------- | ------------------------------------ | ------------------------------- | ------------------------------------- | -| `e` | event id (hex) | relay URL, marker, pubkey (hex) | [01](01.md), [10](10.md) | -| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | -| `a` | coordinates to an event | relay URL | [01](01.md) | -| `d` | identifier | -- | [01](01.md) | -| `-` | -- | -- | [70](70.md) | -| `g` | geohash | -- | [52](52.md) | -| `h` | group id | -- | [29](29.md) | -| `i` | external identity | proof, url hint | [39](39.md), [73](73.md) | -| `k` | kind | -- | [18](18.md), [25](25.md), [72](72.md), [73](73.md) | -| `l` | label, label namespace | -- | [32](32.md) | -| `L` | label namespace | -- | [32](32.md) | -| `m` | MIME type | -- | [94](94.md) | -| `q` | event id (hex) | relay URL | [18](18.md) | -| `r` | a reference (URL, etc) | -- | [24](24.md), [25](25.md) | -| `r` | relay url | marker | [65](65.md) | -| `t` | hashtag | -- | [24](24.md), [34](34.md) | -| `alt` | summary | -- | [31](31.md) | -| `amount` | millisatoshis, stringified | -- | [57](57.md) | -| `bolt11` | `bolt11` invoice | -- | [57](57.md) | -| `challenge` | challenge string | -- | [42](42.md) | -| `client` | name, address | relay URL | [89](89.md) | -| `clone` | git clone URL | -- | [34](34.md) | -| `content-warning` | reason | -- | [36](36.md) | -| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | -| `description` | description | -- | [34](34.md), [57](57.md), [58](58.md) | -| `emoji` | shortcode, image URL | -- | [30](30.md) | -| `encrypted` | -- | -- | [90](90.md) | -| `expiration` | unix timestamp (string) | -- | [40](40.md) | -| `goal` | event id (hex) | relay URL | [75](75.md) | -| `image` | image URL | dimensions in pixels | [23](23.md), [52](52.md), [58](58.md) | -| `imeta` | inline metadata | -- | [92](92.md) | -| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | -| `location` | location string | -- | [52](52.md), [99](99.md) | -| `name` | name | -- | [34](34.md), [58](58.md), [72](72.md) | -| `nonce` | random | difficulty | [13](13.md) | -| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | -| `price` | price | currency, frequency | [99](99.md) | -| `proxy` | external ID | protocol | [48](48.md) | -| `published_at` | unix timestamp (string) | -- | [23](23.md) | -| `relay` | relay url | -- | [42](42.md), [17](17.md) | -| `relays` | relay list | -- | [57](57.md) | -| `server` | file storage server url | -- | [96](96.md) | -| `subject` | subject | -- | [14](14.md), [17](17.md), [34](34.md) | -| `summary` | summary | -- | [23](23.md), [52](52.md) | -| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | -| `title` | article title | -- | [23](23.md) | -| `web` | webpage URL | -- | [34](34.md) | -| `zap` | pubkey (hex), relay URL | weight | [57](57.md) | +| name | value | other parameters | NIP | +| ----------------- | ------------------------------------ | ------------------------------- | -------------------------------------------------- | +| `e` | event id (hex) | relay URL, marker, pubkey (hex) | [01](01.md), [10](10.md) | +| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | +| `a` | coordinates to an event | relay URL | [01](01.md) | +| `d` | identifier | -- | [01](01.md) | +| `-` | -- | -- | [70](70.md) | +| `g` | geohash | -- | [52](52.md) | +| `h` | group id | -- | [29](29.md) | +| `i` | external identity | proof, url hint | [39](39.md), [73](73.md) | +| `k` | kind | -- | [18](18.md), [25](25.md), [72](72.md), [73](73.md) | +| `l` | label, label namespace | -- | [32](32.md) | +| `L` | label namespace | -- | [32](32.md) | +| `m` | MIME type | -- | [94](94.md) | +| `q` | event id (hex) | relay URL | [18](18.md) | +| `r` | a reference (URL, etc) | -- | [24](24.md), [25](25.md) | +| `r` | relay url | marker | [65](65.md) | +| `t` | hashtag | -- | [24](24.md), [34](34.md) | +| `alt` | summary | -- | [31](31.md) | +| `amount` | millisatoshis, stringified | -- | [57](57.md) | +| `bolt11` | `bolt11` invoice | -- | [57](57.md) | +| `challenge` | challenge string | -- | [42](42.md) | +| `client` | name, address | relay URL | [89](89.md) | +| `clone` | git clone URL | -- | [34](34.md) | +| `content-warning` | reason | -- | [36](36.md) | +| `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | +| `description` | description | -- | [34](34.md), [57](57.md), [58](58.md) | +| `emoji` | shortcode, image URL | -- | [30](30.md) | +| `encrypted` | -- | -- | [90](90.md) | +| `expiration` | unix timestamp (string) | -- | [40](40.md) | +| `goal` | event id (hex) | relay URL | [75](75.md) | +| `image` | image URL | dimensions in pixels | [23](23.md), [52](52.md), [58](58.md) | +| `imeta` | inline metadata | -- | [92](92.md) | +| `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | +| `location` | location string | -- | [52](52.md), [99](99.md) | +| `name` | name | -- | [34](34.md), [58](58.md), [72](72.md) | +| `nonce` | random | difficulty | [13](13.md) | +| `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | +| `price` | price | currency, frequency | [99](99.md) | +| `proxy` | external ID | protocol | [48](48.md) | +| `published_at` | unix timestamp (string) | -- | [23](23.md) | +| `relay` | relay url | -- | [42](42.md), [17](17.md) | +| `relays` | relay list | -- | [57](57.md) | +| `server` | file storage server url | -- | [96](96.md) | +| `subject` | subject | -- | [14](14.md), [17](17.md), [34](34.md) | +| `summary` | summary | -- | [23](23.md), [52](52.md) | +| `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | +| `title` | article title | -- | [23](23.md) | +| `web` | webpage URL | -- | [34](34.md) | +| `zap` | pubkey (hex), relay URL | weight | [57](57.md) | Please update these lists when proposing new NIPs. From 02e934acb725dc8a947e83e347a96c8f7ab9c219 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Wed, 2 Oct 2024 13:22:52 -0700 Subject: [PATCH 243/587] Clarify quote reposts --- 18.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/18.md b/18.md index 27c5915a..9d0ce1c6 100644 --- a/18.md +++ b/18.md @@ -18,13 +18,6 @@ to indicate where it can be fetched. The repost SHOULD include a `p` tag with the `pubkey` of the event being reposted. -## Quote Reposts - -Quote reposts are `kind 1` events with an embedded `q` tag of the note being -quote reposted. The `q` tag ensures quote reposts are not pulled and included -as replies in threads. It also allows you to easily pull and count all of the -quotes for a post. - ## Generic Reposts Since `kind 6` reposts are reserved for `kind 1` contents, we use `kind 16` @@ -33,3 +26,20 @@ as a "generic repost", that can include any kind of event inside other than `kind 16` reposts SHOULD contain a `k` tag with the stringified kind number of the reposted event as its value. + +## Quote Reposts + +Quote reposts are `kind 1` events with an embedded `q` tag of the note being +quote reposted. The `q` tag ensures quote reposts are not pulled and included +as replies in threads. It also allows you to easily pull and count all of the +quotes for a post. + +`q` tags should follow the same conventions as NIP 10 `e` tags, with the exception +of the `mark` argument. The first argument MAY be either an event id or an address. + +`["q", <event-id-or-address>, <relay-url>, <pubkey>]` + +Quote reposts MUST include the bech32-encoded `nevent`, `note`, or `naddr` of the +event in the content. The embedded entity should match the type of the tag (in +other words, if embedding a `naddr`, the `q` tag should contain an address, not +an event id). From 78b6615c211b83b4f09c3421ccd61c05e3d0264f Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Wed, 2 Oct 2024 14:50:10 -0700 Subject: [PATCH 244/587] recommend k tag for quotes --- 18.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/18.md b/18.md index 9d0ce1c6..c8bf224c 100644 --- a/18.md +++ b/18.md @@ -43,3 +43,6 @@ Quote reposts MUST include the bech32-encoded `nevent`, `note`, or `naddr` of th event in the content. The embedded entity should match the type of the tag (in other words, if embedding a `naddr`, the `q` tag should contain an address, not an event id). + +Quote reposts also SHOULD include a `k` tag matching the stringified `kind` of +the quoted note. From f5a6fb258fa235189303c8bf2c1132e9f81ac8c9 Mon Sep 17 00:00:00 2001 From: hodlbod <jstaab@protonmail.com> Date: Thu, 3 Oct 2024 09:31:17 -0700 Subject: [PATCH 245/587] Update 18.md Co-authored-by: Asai Toshiya <to.asai.60@gmail.com> --- 18.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/18.md b/18.md index c8bf224c..784946ab 100644 --- a/18.md +++ b/18.md @@ -39,7 +39,7 @@ of the `mark` argument. The first argument MAY be either an event id or an addre `["q", <event-id-or-address>, <relay-url>, <pubkey>]` -Quote reposts MUST include the bech32-encoded `nevent`, `note`, or `naddr` of the +Quote reposts MUST include the [NIP-19](19.md) `nevent`, `note`, or `naddr` of the event in the content. The embedded entity should match the type of the tag (in other words, if embedding a `naddr`, the `q` tag should contain an address, not an event id). From 2053aee0c27e43c395706dee2706f2417c0ad268 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Thu, 3 Oct 2024 09:35:09 -0700 Subject: [PATCH 246/587] Remove addresses and tags from quote reposts --- 18.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/18.md b/18.md index 784946ab..f1e3f8c7 100644 --- a/18.md +++ b/18.md @@ -35,14 +35,9 @@ as replies in threads. It also allows you to easily pull and count all of the quotes for a post. `q` tags should follow the same conventions as NIP 10 `e` tags, with the exception -of the `mark` argument. The first argument MAY be either an event id or an address. +of the `mark` argument. -`["q", <event-id-or-address>, <relay-url>, <pubkey>]` +`["q", <event-id>, <relay-url>, <pubkey>]` Quote reposts MUST include the [NIP-19](19.md) `nevent`, `note`, or `naddr` of the -event in the content. The embedded entity should match the type of the tag (in -other words, if embedding a `naddr`, the `q` tag should contain an address, not -an event id). - -Quote reposts also SHOULD include a `k` tag matching the stringified `kind` of -the quoted note. +event in the content. From 7df7deebf579fcf0c095fd6e974a4d54970cbec6 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Thu, 3 Oct 2024 09:39:03 -0700 Subject: [PATCH 247/587] Move generic reposts back to bottom for a simpler diff --- 18.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/18.md b/18.md index f1e3f8c7..4bf39ef7 100644 --- a/18.md +++ b/18.md @@ -18,15 +18,6 @@ to indicate where it can be fetched. The repost SHOULD include a `p` tag with the `pubkey` of the event being reposted. -## Generic Reposts - -Since `kind 6` reposts are reserved for `kind 1` contents, we use `kind 16` -as a "generic repost", that can include any kind of event inside other than -`kind 1`. - -`kind 16` reposts SHOULD contain a `k` tag with the stringified kind number -of the reposted event as its value. - ## Quote Reposts Quote reposts are `kind 1` events with an embedded `q` tag of the note being @@ -41,3 +32,12 @@ of the `mark` argument. Quote reposts MUST include the [NIP-19](19.md) `nevent`, `note`, or `naddr` of the event in the content. + +## Generic Reposts + +Since `kind 6` reposts are reserved for `kind 1` contents, we use `kind 16` +as a "generic repost", that can include any kind of event inside other than +`kind 1`. + +`kind 16` reposts SHOULD contain a `k` tag with the stringified kind number +of the reposted event as its value. From 7bb8997be5f8cbe1004e7c75724feaa56ccd08de Mon Sep 17 00:00:00 2001 From: DASHU <385321165@qq.com> Date: Tue, 2 Jul 2024 16:02:31 +0800 Subject: [PATCH 248/587] fix some info of nip55 to be same as other nips --- 55.md | 124 +++++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 89 insertions(+), 35 deletions(-) diff --git a/55.md b/55.md index c0ee9579..d78bc8ca 100644 --- a/55.md +++ b/55.md @@ -101,10 +101,10 @@ launcher.launch(intent) context.startActivity(intent) ``` - result: - - If the user approved intent it will return the **npub** in the signature field + - If the user approved intent it will return the **pubkey** in the signature field ```kotlin - val npub = intent.data?.getStringExtra("signature") + val pubkey = intent.data?.getStringExtra("signature") // The package name of the signer application val packageName = intent.data?.getStringExtra("package") ``` @@ -118,8 +118,8 @@ launcher.launch(intent) intent.putExtra("type", "sign_event") // To handle results when not waiting between intents intent.putExtra("id", event.id) - // Send the current logged in user npub - intent.putExtra("current_user", npub) + // Send the current logged in user pubkey + intent.putExtra("current_user", pubkey) context.startActivity(intent) ``` @@ -142,10 +142,10 @@ launcher.launch(intent) intent.putExtra("type", "nip04_encrypt") // to control the result in your application in case you are not waiting the result before sending another intent intent.putExtra("id", "some_id") - // Send the current logged in user npub - intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) - // Send the hex pubKey that will be used for encrypting the data - intent.putExtra("pubKey", pubKey) + // Send the current logged in user pubkey + intent.putExtra("current_user", account.keyPair.pubkey) + // Send the hex pubkey that will be used for encrypting the data + intent.putExtra("pubkey", pubkey) context.startActivity(intent) ``` @@ -167,10 +167,10 @@ launcher.launch(intent) intent.putExtra("type", "nip44_encrypt") // to control the result in your application in case you are not waiting the result before sending another intent intent.putExtra("id", "some_id") - // Send the current logged in user npub - intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) - // Send the hex pubKey that will be used for encrypting the data - intent.putExtra("pubKey", pubKey) + // Send the current logged in user pubkey + intent.putExtra("current_user", account.keyPair.pubkey) + // Send the hex pubkey that will be used for encrypting the data + intent.putExtra("pubkey", pubkey) context.startActivity(intent) ``` @@ -192,10 +192,10 @@ launcher.launch(intent) intent.putExtra("type", "nip04_decrypt") // to control the result in your application in case you are not waiting the result before sending another intent intent.putExtra("id", "some_id") - // Send the current logged in user npub - intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) - // Send the hex pubKey that will be used for decrypting the data - intent.putExtra("pubKey", pubKey) + // Send the current logged in user pubkey + intent.putExtra("current_user", account.keyPair.pubkey) + // Send the hex pubkey that will be used for decrypting the data + intent.putExtra("pubkey", pubkey) context.startActivity(intent) ``` @@ -217,10 +217,10 @@ launcher.launch(intent) intent.putExtra("type", "nip04_decrypt") // to control the result in your application in case you are not waiting the result before sending another intent intent.putExtra("id", "some_id") - // Send the current logged in user npub - intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) - // Send the hex pubKey that will be used for decrypting the data - intent.putExtra("pubKey", pubKey) + // Send the current logged in user pubkey + intent.putExtra("current_user", account.keyPair.pubkey) + // Send the hex pubkey that will be used for decrypting the data + intent.putExtra("pubkey", pubkey) context.startActivity(intent) ``` @@ -233,6 +233,29 @@ launcher.launch(intent) val id = intent.data?.getStringExtra("id") ``` +- **get_relays** + - params: + + ```kotlin + val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:")) + intent.`package` = "com.example.signer" + intent.putExtra("type", "get_relays") + // to control the result in your application in case you are not waiting the result before sending another intent + intent.putExtra("id", "some_id") + // Send the current logged in user pubkey + intent.putExtra("current_user", account.keyPair.pubkey) + + context.startActivity(intent) + ``` + - result: + - If the user approved intent it will return the **signature** and **id** fields + + ```kotlin + val relayJsonText = intent.data?.getStringExtra("signature") + // the id you sent + val id = intent.data?.getStringExtra("id") + ``` + - **decrypt_zap_event** - params: @@ -242,8 +265,8 @@ launcher.launch(intent) intent.putExtra("type", "decrypt_zap_event") // to control the result in your application in case you are not waiting the result before sending another intent intent.putExtra("id", "some_id") - // Send the current logged in user npub - intent.putExtra("current_user", account.keyPair.pubKey.toNpub()) + // Send the current logged in user pubkey + intent.putExtra("current_user", account.keyPair.pubkey) context.startActivity(intent) ``` - result: @@ -259,7 +282,7 @@ launcher.launch(intent) To 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. -If 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 +If 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 For the SIGN_EVENT type Signer Application returns two columns "signature" and "event". The column event is the signed event json @@ -282,7 +305,7 @@ If the user chose to always reject the event, signer application will return the ) ``` - result: - - Will return the **npub** in the signature column + - Will return the **pubkey** in the signature column ```kotlin if (result == null) return @@ -290,7 +313,7 @@ If the user chose to always reject the event, signer application will return the if (result.moveToFirst()) { val index = it.getColumnIndex("signature") if (index < 0) return - val npub = it.getString(index) + val pubkey = it.getString(index) } ``` @@ -300,7 +323,7 @@ If the user chose to always reject the event, signer application will return the ```kotlin val result = context.contentResolver.query( Uri.parse("content://com.example.signer.SIGN_EVENT"), - listOf("$eventJson", "", "${logged_in_user_npub}"), + listOf("$eventJson", "", "${logged_in_user_pubkey}"), null, null, null @@ -326,7 +349,7 @@ If the user chose to always reject the event, signer application will return the ```kotlin val result = context.contentResolver.query( Uri.parse("content://com.example.signer.NIP04_ENCRYPT"), - listOf("$plainText", "${hex_pub_key}", "${logged_in_user_npub}"), + listOf("$plainText", "${hex_pub_key}", "${logged_in_user_pubkey}"), null, null, null @@ -350,7 +373,7 @@ If the user chose to always reject the event, signer application will return the ```kotlin val result = context.contentResolver.query( Uri.parse("content://com.example.signer.NIP44_ENCRYPT"), - listOf("$plainText", "${hex_pub_key}", "${logged_in_user_npub}"), + listOf("$plainText", "${hex_pub_key}", "${logged_in_user_pubkey}"), null, null, null @@ -374,7 +397,7 @@ If the user chose to always reject the event, signer application will return the ```kotlin val result = context.contentResolver.query( Uri.parse("content://com.example.signer.NIP04_DECRYPT"), - listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_npub}"), + listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_pubkey}"), null, null, null @@ -398,7 +421,7 @@ If the user chose to always reject the event, signer application will return the ```kotlin val result = context.contentResolver.query( Uri.parse("content://com.example.signer.NIP44_DECRYPT"), - listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_npub}"), + listOf("$encryptedText", "${hex_pub_key}", "${logged_in_user_pubkey}"), null, null, null @@ -416,13 +439,37 @@ If the user chose to always reject the event, signer application will return the } ``` +- **get_relays** + - params: + + ```kotlin + val result = context.contentResolver.query( + Uri.parse("content://com.example.signer.GET_RELAYS"), + listOf("${logged_in_user_pubkey}"), + null, + null, + null + ) + ``` + - result: + - Will return the **signature** column + + ```kotlin + if (result == null) return + + if (result.moveToFirst()) { + val index = it.getColumnIndex("signature") + val relayJsonText = it.getString(index) + } + ``` + - **decrypt_zap_event** - params: ```kotlin val result = context.contentResolver.query( Uri.parse("content://com.example.signer.DECRYPT_ZAP_EVENT"), - listOf("$eventJson", "", "${logged_in_user_npub}"), + listOf("$eventJson", "", "${logged_in_user_pubkey}"), null, null, null @@ -472,28 +519,35 @@ Android intents and browser urls have limitations, so if you are using the `retu - params: ```js - window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_encrypt&callbackUrl=https://example.com/?event=`; + window.href = `nostrsigner:${plainText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_encrypt&callbackUrl=https://example.com/?event=`; ``` - **nip44_encrypt** - params: ```js - window.href = `nostrsigner:${plainText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_encrypt&callbackUrl=https://example.com/?event=`; + window.href = `nostrsigner:${plainText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_encrypt&callbackUrl=https://example.com/?event=`; ``` - **nip04_decrypt** - params: ```js - window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_decrypt&callbackUrl=https://example.com/?event=`; + window.href = `nostrsigner:${encryptedText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip04_decrypt&callbackUrl=https://example.com/?event=`; ``` - **nip44_decrypt** - params: ```js - window.href = `nostrsigner:${encryptedText}?pubKey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_decrypt&callbackUrl=https://example.com/?event=`; + window.href = `nostrsigner:${encryptedText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_decrypt&callbackUrl=https://example.com/?event=`; + ``` + +- **get_relays** + - params: + + ```js + window.href = `nostrsigner:?compressionType=none&returnType=signature&type=get_relays&callbackUrl=https://example.com/?event=`; ``` - **decrypt_zap_event** From db13d12eb6412d56e94e041d22cadf8ea757a91b Mon Sep 17 00:00:00 2001 From: Vic <88121568+vicariousdrama@users.noreply.github.com> Date: Mon, 7 Oct 2024 07:03:20 -0400 Subject: [PATCH 249/587] Add Corny Chat Slide Set and Link Set kinds (#1152) --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 758045d2..df1cc938 100644 --- a/README.md +++ b/README.md @@ -191,12 +191,14 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30078` | Application-specific Data | [78](78.md) | | `30311` | Live Event | [53](53.md) | | `30315` | User Statuses | [38](38.md) | +| `30388` | Slide Set | [Corny Chat][cornychat-slideset] | | `30402` | Classified Listing | [99](99.md) | | `30403` | Draft Classified Listing | [99](99.md) | | `30617` | Repository announcements | [34](34.md) | | `30618` | Repository state announcements | [34](34.md) | | `30818` | Wiki article | [54](54.md) | | `30819` | Redirects | [54](54.md) | +| `31388` | Link Set | [Corny Chat][cornychat-linkset] | | `31890` | Feed | [NUD: Custom Feeds][NUD: Custom Feeds] | | `31922` | Date-Based Calendar Event | [52](52.md) | | `31923` | Time-Based Calendar Event | [52](52.md) | @@ -213,6 +215,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos [NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/ [nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md [lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md +[cornychat-slideset]: https://cornychat.com/datatypes#kind30388slideset +[cornychat-linkset]: https://cornychat.com/datatypes#kind31388linkset [joinstr]: https://gitlab.com/1440000bytes/joinstr/-/blob/main/NIP.md [NKBIP-01]: https://wikistr.com/nkbip-01 [NKBIP-02]: https://wikistr.com/nkbip-02 From 4769b1658a226444e1c6d8d84b0bc6e00bca15a3 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Mon, 7 Oct 2024 08:56:52 -0700 Subject: [PATCH 250/587] Refer to nip 21 instead of 19 --- 18.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/18.md b/18.md index 4bf39ef7..41c94424 100644 --- a/18.md +++ b/18.md @@ -30,7 +30,7 @@ of the `mark` argument. `["q", <event-id>, <relay-url>, <pubkey>]` -Quote reposts MUST include the [NIP-19](19.md) `nevent`, `note`, or `naddr` of the +Quote reposts MUST include the [NIP-21](21.md) `nevent`, `note`, or `naddr` of the event in the content. ## Generic Reposts From 10c112defe6d2c57ded96eb22e0b078ff962c92a Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Tue, 8 Oct 2024 01:40:41 +0900 Subject: [PATCH 251/587] NIP-23, NIP-99: remove NIP-12 mention --- 23.md | 2 +- 99.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/23.md b/23.md index 720f6d61..e5e85ff9 100644 --- a/23.md +++ b/23.md @@ -20,7 +20,7 @@ The `.content` of these events should be a string text in Markdown syntax. To ma ### Metadata -For 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. +For 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. Other 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: diff --git a/99.md b/99.md index e2ffc3b8..724ce5f5 100644 --- a/99.md +++ b/99.md @@ -26,7 +26,7 @@ The `.pubkey` field of these events are treated as the party creating the listin ### Metadata -- For "tags"/"hashtags" (i.e. categories or keywords of relevance for the listing) the `"t"` event tag should be used, as per [NIP-12](12.md). +- For "tags"/"hashtags" (i.e. categories or keywords of relevance for the listing) the `"t"` event tag should be used. - 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. The following tags, used for structured metadata, are standardized and SHOULD be included. Other tags may be added as necessary. From 22c11cb243e797c3f6c4b119bd13082eea505cc5 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Tue, 8 Oct 2024 21:01:53 +0900 Subject: [PATCH 252/587] update `q` tag params. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index df1cc938..e03cb3b2 100644 --- a/README.md +++ b/README.md @@ -263,7 +263,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `l` | label, label namespace | -- | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | | `m` | MIME type | -- | [94](94.md) | -| `q` | event id (hex) | relay URL | [18](18.md) | +| `q` | event id (hex) | relay URL, pubkey (hex) | [18](18.md) | | `r` | a reference (URL, etc) | -- | [24](24.md), [25](25.md) | | `r` | relay url | marker | [65](65.md) | | `t` | hashtag | -- | [24](24.md), [34](34.md) | From 79cc2ef215cc1fe1edb804f0bee010644bc14445 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Thu, 10 Oct 2024 00:28:12 +0900 Subject: [PATCH 253/587] add NIP-55 change. --- BREAKING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/BREAKING.md b/BREAKING.md index 83b104b6..aba5b835 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -5,6 +5,7 @@ reverse chronological order. | Date | Commit | NIP | Change | | ----------- | --------- | -------- | ------ | +| 2024-10-07 | [7bb8997b](https://github.com/nostr-protocol/nips/commit/7bb8997b) | [NIP-55](55.md) | some fields and passing data were changed | | 2024-08-18 | [3aff37bd](https://github.com/nostr-protocol/nips/commit/3aff37bd) | [NIP-54](54.md) | content should be Asciidoc | | 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 | | 2024-07-30 | [444ad28d](https://github.com/nostr-protocol/nips/commit/444ad28d) | [NIP-45](45.md) | NIP-45 was deprecated | From 30f39d35d18f49adc86c483c34b232560772d75c Mon Sep 17 00:00:00 2001 From: greenart7c3 <greenart7c3@proton.me> Date: Fri, 11 Oct 2024 07:29:54 -0300 Subject: [PATCH 254/587] Change return field from signature to result --- 55.md | 68 +++++++++++++++++++++++++++++------------------------------ 1 file changed, 34 insertions(+), 34 deletions(-) diff --git a/55.md b/55.md index d78bc8ca..54dc44af 100644 --- a/55.md +++ b/55.md @@ -53,8 +53,8 @@ val launcher = rememberLauncherForActivityResult( Toast.LENGTH_SHORT ).show() } else { - val signature = activityResult.data?.getStringExtra("signature") - // Do something with signature ... + val result = activityResult.data?.getStringExtra("result") + // Do something with result ... } } ) @@ -101,10 +101,10 @@ launcher.launch(intent) context.startActivity(intent) ``` - result: - - If the user approved intent it will return the **pubkey** in the signature field + - If the user approved intent it will return the **pubkey** in the result field ```kotlin - val pubkey = intent.data?.getStringExtra("signature") + val pubkey = intent.data?.getStringExtra("result") // The package name of the signer application val packageName = intent.data?.getStringExtra("package") ``` @@ -124,10 +124,10 @@ launcher.launch(intent) context.startActivity(intent) ``` - result: - - If the user approved intent it will return the **signature**, **id** and **event** fields + - If the user approved intent it will return the **result**, **id** and **event** fields ```kotlin - val signature = intent.data?.getStringExtra("signature") + val signature = intent.data?.getStringExtra("result") // The id you sent val id = intent.data?.getStringExtra("id") val signedEventJson = intent.data?.getStringExtra("event") @@ -150,10 +150,10 @@ launcher.launch(intent) context.startActivity(intent) ``` - result: - - If the user approved intent it will return the **signature** and **id** fields + - If the user approved intent it will return the **result** and **id** fields ```kotlin - val encryptedText = intent.data?.getStringExtra("signature") + val encryptedText = intent.data?.getStringExtra("result") // the id you sent val id = intent.data?.getStringExtra("id") ``` @@ -200,10 +200,10 @@ launcher.launch(intent) context.startActivity(intent) ``` - result: - - If the user approved intent it will return the **signature** and **id** fields + - If the user approved intent it will return the **result** and **id** fields ```kotlin - val plainText = intent.data?.getStringExtra("signature") + val plainText = intent.data?.getStringExtra("result") // the id you sent val id = intent.data?.getStringExtra("id") ``` @@ -225,10 +225,10 @@ launcher.launch(intent) context.startActivity(intent) ``` - result: - - If the user approved intent it will return the **signature** and **id** fields + - If the user approved intent it will return the **result** and **id** fields ```kotlin - val plainText = intent.data?.getStringExtra("signature") + val plainText = intent.data?.getStringExtra("result") // the id you sent val id = intent.data?.getStringExtra("id") ``` @@ -248,10 +248,10 @@ launcher.launch(intent) context.startActivity(intent) ``` - result: - - If the user approved intent it will return the **signature** and **id** fields + - If the user approved intent it will return the **result** and **id** fields ```kotlin - val relayJsonText = intent.data?.getStringExtra("signature") + val relayJsonText = intent.data?.getStringExtra("result") // the id you sent val id = intent.data?.getStringExtra("id") ``` @@ -270,10 +270,10 @@ launcher.launch(intent) context.startActivity(intent) ``` - result: - - If the user approved intent it will return the **signature** and **id** fields + - If the user approved intent it will return the **result** and **id** fields ```kotlin - val eventJson = intent.data?.getStringExtra("signature") + val eventJson = intent.data?.getStringExtra("result") // the id you sent val id = intent.data?.getStringExtra("id") ``` @@ -284,9 +284,9 @@ To get the result back from Signer Application you should use contentResolver.qu If 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 -For the SIGN_EVENT type Signer Application returns two columns "signature" and "event". The column event is the signed event json +For the SIGN_EVENT type Signer Application returns two columns "result" and "event". The column event is the signed event json -For the other types Signer Application returns the column "signature" +For the other types Signer Application returns the column "result" If the user chose to always reject the event, signer application will return the column "rejected" and you should not open signer application @@ -305,13 +305,13 @@ If the user chose to always reject the event, signer application will return the ) ``` - result: - - Will return the **pubkey** in the signature column + - Will return the **pubkey** in the result column ```kotlin if (result == null) return if (result.moveToFirst()) { - val index = it.getColumnIndex("signature") + val index = it.getColumnIndex("result") if (index < 0) return val pubkey = it.getString(index) } @@ -330,13 +330,13 @@ If the user chose to always reject the event, signer application will return the ) ``` - result: - - Will return the **signature** and the **event** columns + - Will return the **result** and the **event** columns ```kotlin if (result == null) return if (result.moveToFirst()) { - val index = it.getColumnIndex("signature") + val index = it.getColumnIndex("result") val indexJson = it.getColumnIndex("event") val signature = it.getString(index) val eventJson = it.getString(indexJson) @@ -356,13 +356,13 @@ If the user chose to always reject the event, signer application will return the ) ``` - result: - - Will return the **signature** column + - Will return the **result** column ```kotlin if (result == null) return if (result.moveToFirst()) { - val index = it.getColumnIndex("signature") + val index = it.getColumnIndex("result") val encryptedText = it.getString(index) } ``` @@ -380,13 +380,13 @@ If the user chose to always reject the event, signer application will return the ) ``` - result: - - Will return the **signature** column + - Will return the **result** column ```kotlin if (result == null) return if (result.moveToFirst()) { - val index = it.getColumnIndex("signature") + val index = it.getColumnIndex("result") val encryptedText = it.getString(index) } ``` @@ -404,13 +404,13 @@ If the user chose to always reject the event, signer application will return the ) ``` - result: - - Will return the **signature** column + - Will return the **result** column ```kotlin if (result == null) return if (result.moveToFirst()) { - val index = it.getColumnIndex("signature") + val index = it.getColumnIndex("result") val encryptedText = it.getString(index) } ``` @@ -428,13 +428,13 @@ If the user chose to always reject the event, signer application will return the ) ``` - result: - - Will return the **signature** column + - Will return the **result** column ```kotlin if (result == null) return if (result.moveToFirst()) { - val index = it.getColumnIndex("signature") + val index = it.getColumnIndex("result") val encryptedText = it.getString(index) } ``` @@ -452,13 +452,13 @@ If the user chose to always reject the event, signer application will return the ) ``` - result: - - Will return the **signature** column + - Will return the **result** column ```kotlin if (result == null) return if (result.moveToFirst()) { - val index = it.getColumnIndex("signature") + val index = it.getColumnIndex("result") val relayJsonText = it.getString(index) } ``` @@ -476,13 +476,13 @@ If the user chose to always reject the event, signer application will return the ) ``` - result: - - Will return the **signature** column + - Will return the **result** column ```kotlin if (result == null) return if (result.moveToFirst()) { - val index = it.getColumnIndex("signature") + val index = it.getColumnIndex("result") val eventJson = it.getString(index) } ``` From e3cf02840d382360a604a7506e1b9608c63c4002 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Mon, 21 Oct 2024 13:45:51 -0300 Subject: [PATCH 255/587] rename "claim"=>"code", get rid of kind 9006 (just use 9000), add a paragraph explaining moderation. --- 29.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/29.md b/29.md index c0dbcef7..c4ee4952 100644 --- a/29.md +++ b/29.md @@ -42,6 +42,14 @@ This is a hack to prevent messages from being broadcasted to external relays tha Relays 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. +## Group management + +Groups 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). + +The 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. + +Users 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. + ## Unmanaged groups Unmanaged 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. @@ -117,12 +125,12 @@ Any user can send one of these events to the relay in order to be automatically "content": "optional reason", "tags": [ ["h", "<group-id>"], - ["claim", "<optional-invite-code>"] + ["code", "<optional-invite-code>"] ] } ``` -The optional `claim` tag may be used by the relay to preauthorize acceptances in `closed` groups, together with the `kind:9009` `create-invite` moderation event. +The optional `code` tag may be used by the relay to preauthorize acceptances in `closed` groups, together with the `kind:9009` `create-invite` moderation event. - *leave request* (`kind:9022`) @@ -161,13 +169,10 @@ Each moderation action uses a different kind and requires different arguments, w | kind | name | tags | | --- | --- | --- | -| 9000 | `add-user` | `p` with pubkey hex | +| 9000 | `add-user` | `p` with pubkey hex and optional roles | | 9001 | `remove-user` | `p` with pubkey hex | | 9002 | `edit-metadata` | fields from `kind:39000` to be modified | -| 9003 | | | -| 9004 | | | | 9005 | `delete-event` | | -| 9006 | `set-role` | `p` with pubkey hex and roles | | 9007 | `create-group` | | | 9008 | `delete-group` | | From d4d040ee715a1f742a19e2c3a9e8697387725e46 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Tue, 22 Oct 2024 09:55:42 -0300 Subject: [PATCH 256/587] fix typo. --- 29.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/29.md b/29.md index c4ee4952..80e0f96c 100644 --- a/29.md +++ b/29.md @@ -113,7 +113,7 @@ Groups may also accept other events, like long-form articles, calendar, livestre ### User-related group management events -These are events that can be sent my user to manage their situation in a group, they also require the `h` tag. +These are events that can be sent by users to manage their situation in a group, they also require the `h` tag. - *join request* (`kind:9021`) From e3afd7ac5b72c20fe209edf3ea84cd986d0bd4ef Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Wed, 23 Oct 2024 23:56:13 +0900 Subject: [PATCH 257/587] update related to NIP-71. --- BREAKING.md | 2 ++ README.md | 1 - 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/BREAKING.md b/BREAKING.md index aba5b835..b4bd53d7 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -5,6 +5,8 @@ reverse chronological order. | Date | Commit | NIP | Change | | ----------- | --------- | -------- | ------ | +| 2024-10-15 | [1cda2dcc](https://github.com/nostr-protocol/nips/commit/1cda2dcc) | [NIP-71](71.md) | some tags were replaced with `imeta` tag | +| 2024-10-15 | [1cda2dcc](https://github.com/nostr-protocol/nips/commit/1cda2dcc) | [NIP-71](71.md) | `kind: 34237` was dropped | | 2024-10-07 | [7bb8997b](https://github.com/nostr-protocol/nips/commit/7bb8997b) | [NIP-55](55.md) | some fields and passing data were changed | | 2024-08-18 | [3aff37bd](https://github.com/nostr-protocol/nips/commit/3aff37bd) | [NIP-54](54.md) | content should be Asciidoc | | 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 | diff --git a/README.md b/README.md index 9566dff6..2ef56294 100644 --- a/README.md +++ b/README.md @@ -208,7 +208,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `31990` | Handler information | [89](89.md) | | `34235` | Video Event | [71](71.md) | | `34236` | Short-form Portrait Video Event | [71](71.md) | -| `34237` | Video View Event | [71](71.md) | | `34550` | Community Definition | [72](72.md) | | `39000-9` | Group metadata events | [29](29.md) | From ba46b23d95b186c9a8fedabf8324af2ae40e8ce4 Mon Sep 17 00:00:00 2001 From: Pablo Fernandez <p@f7z.io> Date: Fri, 25 Oct 2024 17:54:49 +0100 Subject: [PATCH 258/587] Cashu wallet + Nutzaps (#1369) --- 60.md | 205 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 61.md | 132 +++++++++++++++++++++++++++++++++++ README.md | 9 +++ 3 files changed, 346 insertions(+) create mode 100644 60.md create mode 100644 61.md diff --git a/60.md b/60.md new file mode 100644 index 00000000..2f248410 --- /dev/null +++ b/60.md @@ -0,0 +1,205 @@ +# NIP-60 +## Cashu Wallet +`draft` `optional` + +This NIP defines the operations of a cashu-based wallet. + +A cashu wallet is a wallet which information is stored in relays to make it accessible across applications. + +The purpose of this NIP is: +* ease-of-use: new users immediately are able to receive funds without creating accounts with other services. +* interoperability: users' wallets follows them across applications. + +This NIP doesn't deal with users' *receiving* money from someone else, it's just to keep state of the user's wallet. + +# High-level flow +1. A user has a `kind:37375` event that represents a wallet. +2. A user has `kind:7375` events that represent the unspent proofs of the wallet. -- The proofs are encrypted with the user's private key. +3. 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. + +## Wallet Event +```jsonc +{ + "kind": 37375, + "content": nip44_encrypt([ + [ "balance", "100", "sat" ], + [ "privkey", "hexkey" ] // explained in NIP-61 + ]), + "tags": [ + [ "d", "my-wallet" ], + [ "mint", "https://mint1" ], + [ "mint", "https://mint2" ], + [ "mint", "https://mint3" ], + [ "name", "my shitposting wallet" ], + [ "unit", "sat" ], + [ "description", "a wallet for my day-to-day shitposting" ], + [ "relay", "wss://relay1" ], + [ "relay", "wss://relay2" ], + ] +} +``` + +The wallet event is a parameterized replaceable event `kind:37375`. + +Tags: +* `d` - wallet ID. +* `mint` - Mint(s) this wallet uses -- there MUST be one or more mint tags. +* `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]]. +* `unit` - Base unit of the wallet (e.g. "sat", "usd", etc). +* `name` - Optional human-readable name for the wallet. +* `description` - Optional human-readable description of the wallet. +* `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. +* `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. + +Any tag, other than the `d` tag, can be [[NIP-44]] encrypted into the `.content` field. + +### Deleting a wallet event +Due 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. + +## Token Event +Token events are used to record the unspent proofs that come from the mint. + +There can be multiple `kind:7375` events for the same mint, and multiple proofs inside each `kind:7375` event. + +```jsonc +{ + "kind": 7375, + "content": nip44_encrypt({ + "mint": "https://stablenut.umint.cash", + "proofs": [ + { + "id": "005c2502034d4f12", + "amount": 1, + "secret": "z+zyxAVLRqN9lEjxuNPSyRJzEstbl69Jc1vtimvtkPg=", + "C": "0241d98a8197ef238a192d47edf191a9de78b657308937b4f7dd0aa53beae72c46" + } + ] + }), + "tags": [ + [ "a", "37375:<pubkey>:my-wallet" ] + ] +} +``` + +`.content` is a [[NIP-44]] encrypted payload storing the mint and the unencoded proofs. +* `a` an optional tag linking the token to a specific wallet. + +### Spending proofs +When 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. + +## Spending History Event +Clients SHOULD publish `kind:7376` events to create a transaction history when their balance changes. + +```jsonc +{ + "kind": 7376, + "content": nip44_encrypt([ + [ "direction", "in" ], // in = received, out = sent + [ "amount", "1", "sat" ], + [ "e", "<event-id-of-spent-token>", "<relay-hint>", "created" ], + ]), + "tags": [ + [ "a", "37375:<pubkey>:my-wallet" ], + ] +} +``` + +* `direction` - The direction of the transaction; `in` for received funds, `out` for sent funds. +* `a` - The wallet the transaction is related to. + +Clients MUST add `e` tags to create references of destroyed and created token events along with the marker of the meaning of the tag: +* `created` - A new token event was created. +* `destroyed` - A token event was destroyed. +* `redeemed` - A [[NIP-61]] nutzap was redeemed. + +All tags can be [[NIP-44]] encrypted. Clients SHOULD leave `e` tags with a `redeemed` marker unencrypted. + +Multiple `e` tags can be added to a `kind:7376` event. + +# Flow +A 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. + +## Fetch wallet and token list +From those relays, the client should fetch wallet and token events. + +`"kinds": [37375, 7375], "authors": ["<my-pubkey>"]` + +## Fetch proofs +While 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. + +## Spending token +If Alice spends 4 sats from this token event +```jsonconc +{ + "kind": 7375, + "id": "event-id-1", + "content": nip44_encrypt({ + "mint": "https://stablenut.umint.cash", + "proofs": [ + { "id": "1", "amount": 1 }, + { "id": "2", "amount": 2 }, + { "id": "3", "amount": 4 }, + { "id": "4", "amount": 8 }, + ] + }), + "tags": [ + [ "a", "37375:<pubkey>:my-wallet" ] + ] +} +``` + +Her client: +* MUST roll over the unspent proofs: +```jsonconc +{ + "kind": 7375, + "id": "event-id-2", + "content": nip44_encrypt({ + "mint": "https://stablenut.umint.cash", + "proofs": [ + { "id": "1", "amount": 1 }, + { "id": "2", "amount": 2 }, + { "id": "8", "amount": 8 }, + ] + }), + "tags": [ + [ "a", "37375:<pubkey>:my-wallet" ] + ] +} +``` +* MUST delete event `event-id-1` +* SHOULD create a `kind:7376` event to record the spend +```jsonconc +{ + "kind": 7376, + "content": nip44_encrypt([ + [ "direction", "out" ], + [ "amount", "4", "sats" ], + [ "e", "<event-id-1>", "<relay-hint>", "destroyed" ], + [ "e", "<event-id-2>", "<relay-hint>", "created" ], + ]), + "tags": [ + [ "a", "37375:<pubkey>:my-wallet" ], + ] +} +``` + +## Redeeming a quote (optional) +When 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. + +Application developers are encouraged to use local state when possible and only publish this event when it makes sense in the context of their application. + +```jsonc +{ + "kind": 7374, + "content": nip44_encrypt("quote-id"), + "tags": [ + [ "expiration", "<expiration-timestamp>" ], + [ "mint", "<mint-url>" ], + [ "a", "37375:<pubkey>:my-wallet" ] + ] +} +``` + +## Appendix 1: Validating proofs +Clients 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 00000000..33442a3b --- /dev/null +++ b/61.md @@ -0,0 +1,132 @@ +# NIP-61: +## Nut Zaps + +A Nut Zap is a P2PK cashu token where the payment itself is the receipt. + +# High-level flow +Alice wants to nutzap 1 sat to Bob because of an event `event-id-1` she liked. + +## Alice nutzaps Bob +1. Alice fetches event `kind:10019` from Bob to see the mints Bob trusts. +2. 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`. +3. She publishes a `kind:9321` event to the relays Bob indicated with the proofs she minted. + +## Bob receives the nutzap +1. At some point, Bob's client fetches `kind:9321` events p-tagging him from his relays. +2. Bob's client swaps the token into his wallet. + +# Nutzap informational event +```jsonc +{ + "kind": 10019, + "tags": [ + [ "relay", "wss://relay1" ], + [ "relay", "wss://relay2" ], + [ "mint", "https://mint1", "usd", "sat" ], + [ "mint", "https://mint2", "sat" ], + [ "pubkey", "<p2pk-pubkey>" ] + ] +} +``` + +`kind:10019` is an event that is useful for others to know how to send money to the user. + +* `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. +* `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. +* `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. + +## Nutzap event +Event `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. + +Clients MUST prefix the pubkey they p2pk-lock with `"02"` (for nostr<>cashu pubkey compatibility). + +```jsonc +{ + kind: 9321, + content: "Thanks for this great idea.", + pubkey: "sender-pubkey", + tags: [ + [ "amount", "1" ], + [ "unit", "sat" ], + [ "proof", "{\"amount\":1,\"C\":\"02277c66191736eb72fce9d975d08e3191f8f96afb73ab1eec37e4465683066d3f\",\"id\":\"000a93d6f8a1d2c4\",\"secret\":\"[\\\"P2PK\\\",{\\\"nonce\\\":\\\"b00bdd0467b0090a25bdf2d2f0d45ac4e355c482c1418350f273a04fedaaee83\\\",\\\"data\\\":\\\"02eaee8939e3565e48cc62967e2fde9d8e2a4b3ec0081f29eceff5c64ef10ac1ed\\\"}]\"}" ], + [ "u", "https://stablenut.umint.cash", ], + [ "e", "<zapped-event-id>", "<relay-hint>" ], + [ "p", "e9fbced3a42dcf551486650cc752ab354347dd413b307484e4fd1818ab53f991" ], // recipient of nut zap + ] +} +``` + +* `.content` is an optional comment for the nutzap +* `amount` is a shorthand for the combined amount of all outputs. -- Clients SHOULD validate that the sum of the amounts in the outputs matches. +* `unit` is the base unit of the amount. +* `proof` is one ore more proofs p2pk-locked to the pubkey the recipient specified in their `kind:10019` event. +* `u` is the mint the URL of the mint EXACTLY as specified by the recipient's `kind:10019`. +* `e` zero or one event that is being nutzapped. +* `p` exactly one pubkey, specifying the recipient of the nutzap. + +WIP: Clients SHOULD embed a DLEQ proof in the nutzap event to make it possible to verify nutzaps without talking to the mint. + +# Sending a nutzap + +* The sender fetches the recipient's `kind:10019`. +* The sender mints/swaps ecash on one of the recipient's listed mints. +* The sender p2pk locks to the recipient's specified pubkey in their + +# Receiving nutzaps + +Clients should REQ for nut zaps: +* Filtering with `#u` for mints they expect to receive ecash from. + * this is to prevent even interacting with mints the user hasn't explicitly signaled. +* Filtering with `since` of the most recent `kind:7376` event the same user has created. + * 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. + +Clients MIGHT choose to use some kind of filtering (e.g. WoT) to ignore spam. + +`{ "kinds": [9321], "#p": "my-pubkey", "#u": [ "<mint-1>", "<mint-2>"], "since": <latest-created_at-of-kind-7376> }`. + +Upon 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. + +## Updating nutzap-redemption history +When 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. + +Multiple `kind:9321` events can be tagged in the same `kind:7376` event. + +```jsonc +{ + "kind": 7376, + "content": nip44_encrypt([ + [ "direction", "in" ], // in = received, out = sent + [ "amount", "1", "sat" ], + [ "e", "<7375-event-id>", "relay-hint", "created" ] // new token event that was created + ]), + "tags": [ + [ "a", "37375:<pubkey>:my-wallet" ], // an optional wallet tag + [ "e", "<9321-event-id>", "relay-hint", "redeemed" ], // nutzap event that has been redeemed + [ "p", "sender-pubkey" ] // pubkey of the author of the 9321 event (nutzap sender) + ] +} +``` + +Events that redeem a nutzap SHOULD be published to the sender's [[NIP-65]] relays. + +## Verifying a Cashu Zap +* Clients SHOULD check that the receiving user has issued a `kind:10019` tagging the mint where the cashu has been minted. +* Clients SHOULD check that the token is locked to the pubkey the user has listed in their `kind:10019`. + +## Final Considerations + +1. 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 + +2. Clients SHOULD normalize and deduplicate mint URLs as described in NIP-65. + +3. 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. + +## Appendix 1: Alternative P2PK pubkey +Clients 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. + +For this scenarios clients can: + +* add a `pubkey` tag to the `kind:10019` (indicating which pubkey senders should P2PK to) +* store the private key in the `kind:37375` event in the nip44-encrypted `content` field. + +This is to avoid depending on NIP-07/46 adaptations to sign cashu payloads. \ No newline at end of file diff --git a/README.md b/README.md index 2ef56294..ed5d753c 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-57: Lightning Zaps](57.md) - [NIP-58: Badges](58.md) - [NIP-59: Gift Wrap](59.md) +- [NIP-60: Cashu Wallet](60.md) +- [NIP-61: Nutzaps](61.md) +- [NIP-64: Chess (PGN)](64.md) - [NIP-64: Chess (PGN)](64.md) - [NIP-65: Relay List Metadata](65.md) - [NIP-70: Protected Events](70.md) @@ -140,8 +143,12 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `5000`-`5999` | Job Request | [90](90.md) | | `6000`-`6999` | Job Result | [90](90.md) | | `7000` | Job Feedback | [90](90.md) | +| `7374` | Reserved Cashu Wallet Tokens | [60](60.md) | +| `7375` | Cashu Wallet Tokens | [60](60.md) | +| `7376` | Cashu Wallet History | [60](60.md) | | `9000`-`9030` | Group Control Events | [29](29.md) | | `9041` | Zap Goal | [75](75.md) | +| `9321` | Nutzap | [61](61.md) | | `9467` | Tidal login | [Tidal-nostr] | | `9734` | Zap Request | [57](57.md) | | `9735` | Zap | [57](57.md) | @@ -156,6 +163,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10007` | Search relays list | [51](51.md) | | `10009` | User groups | [51](51.md), [29](29.md) | | `10015` | Interests list | [51](51.md) | +| `10019` | Nutzap Mint Recommendation | [61](61.md) | | `10030` | User emoji list | [51](51.md) | | `10050` | Relay list to receive DMs | [51](51.md), [17](17.md) | | `10063` | User server list | [Blossom][blossom] | @@ -209,6 +217,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `34235` | Video Event | [71](71.md) | | `34236` | Short-form Portrait Video Event | [71](71.md) | | `34550` | Community Definition | [72](72.md) | +| `37375` | Cashu Wallet Event | [60](60.md) | | `39000-9` | Group metadata events | [29](29.md) | [NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/ From dde8c81a87f01131ed2eec0dd653cd5b79900b82 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Sat, 26 Oct 2024 23:34:37 +0900 Subject: [PATCH 259/587] remove duplicate NIP-64 from list. --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index ed5d753c..400f1ec2 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-60: Cashu Wallet](60.md) - [NIP-61: Nutzaps](61.md) - [NIP-64: Chess (PGN)](64.md) -- [NIP-64: Chess (PGN)](64.md) - [NIP-65: Relay List Metadata](65.md) - [NIP-70: Protected Events](70.md) - [NIP-71: Video Events](71.md) From f21aa981d4960dae858ce1da87b553598c5010e0 Mon Sep 17 00:00:00 2001 From: ilcompratoreconsapevole <ilcompratoreconsapevole@gmail.com> Date: Sun, 27 Oct 2024 22:56:40 +0100 Subject: [PATCH 260/587] Changed 'id value' at row 162 --- 60.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/60.md b/60.md index 2f248410..64cd282a 100644 --- a/60.md +++ b/60.md @@ -159,7 +159,7 @@ Her client: "proofs": [ { "id": "1", "amount": 1 }, { "id": "2", "amount": 2 }, - { "id": "8", "amount": 8 }, + { "id": "4", "amount": 8 }, ] }), "tags": [ From 66c5cc637f118add2d2cade2210d21da7e25917b Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Sun, 27 Oct 2024 19:43:43 -0400 Subject: [PATCH 261/587] Instagram feeds --- 68.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 68.md diff --git a/68.md b/68.md new file mode 100644 index 00000000..22509e06 --- /dev/null +++ b/68.md @@ -0,0 +1,70 @@ +NIP-68 +====== + +Picture-first feeds +------------------- + +`draft` `optional` + +This NIP defines event kind `20` for picture-first clients. Images must be self-contained. They are hosted externally and referenced using `imeta` tags + +Unlike a `kind 1` event with a pircture attached, Picture events are meant to contain all additional metadata concerning the subject media and to be surfaced in picture-specific clients rather than general micro-blogging clients. The thought is for events of this kind to be referenced in a Instagram/Flickr/Snapshat/9gag like nostr client where the picture itself is at the center of the experience. + +## Picture Events + +Picture events contain a `title` tag and description in the `.content`. + +They may contain multiple images to be displayed as a single post. + +```jsonc +{ + "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": <Unix timestamp in seconds>, + "kind": 20, + "content": "<description of post>", + "tags": [ + ["title", "<short title of post>"], + + // Picture Data + [ + "imeta", + "url https://nostr.build/i/my-image.jpg", + "m image/jpeg", + "blurhash eVF$^OI:${M{o#*0-nNFxakD-?xVM}WEWB%iNKxvR-oetmo#R-aen$", + "dim 3024x4032", + "alt A scenic photo overlooking the coast of Costa Rica", + "x <sha256 hash as specified in NIP 94>", + "fallback https://nostrcheck.me/alt1.jpg", + "fallback https://void.cat/alt1.jpg" + ], + [ + "imeta", + "url https://nostr.build/i/my-image2.jpg", + "m image/jpeg", + "blurhash eVF$^OI:${M{o#*0-nNFxakD-?xVM}WEWB%iNKxvR-oetmo#R-aen$", + "dim 3024x4032", + "alt Another scenic photo overlooking the coast of Costa Rica", + "x <sha256 hash as specified in NIP 94>", + "fallback https://nostrcheck.me/alt2.jpg", + "fallback https://void.cat/alt2.jpg", + + "annotate-user <32-bytes hex of a pubkey>:<posX>:<posY>" // Tag users in specific locations in the picture + ], + + ["content-warning", "<reason>"], // if NSFW + + // Tagged users + ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], + ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], + + // Hashtags + ["t", "<tag>"], + ["t", "<tag>"], + ] +} +``` + +The `imeta` tag `annotate-user` places a user link in the specific position in the image. + +Picture events might be used with [NIP-71](71.md)'s kind `34236` to display short vertical videos in the same feed. \ No newline at end of file From 9517ac6f5dfac58bd7237777680c557bd518dc84 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Sun, 27 Oct 2024 20:30:27 -0400 Subject: [PATCH 262/587] Enforces certain media types --- 68.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/68.md b/68.md index 22509e06..dcc56f13 100644 --- a/68.md +++ b/68.md @@ -58,6 +58,9 @@ They may contain multiple images to be displayed as a single post. ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], + // Specify the media type for filters to allow clients to filter by supported kinds + ["m", "image/jpeg"] + // Hashtags ["t", "<tag>"], ["t", "<tag>"], @@ -67,4 +70,12 @@ They may contain multiple images to be displayed as a single post. The `imeta` tag `annotate-user` places a user link in the specific position in the image. +Only the following media types are accepted: +- `image/apng`: Animated Portable Network Graphics (APNG) +- `image/avif`: AV1 Image File Format (AVIF) +- `image/gif`: Graphics Interchange Format (GIF) +- `image/jpeg`: Joint Photographic Expert Group image (JPEG) +- `image/png`: Portable Network Graphics (PNG) +- `image/webp`: Web Picture format (WEBP) + Picture events might be used with [NIP-71](71.md)'s kind `34236` to display short vertical videos in the same feed. \ No newline at end of file From 5c7aad212ea44605d64e360be89ea5a1d843a3f8 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Mon, 28 Oct 2024 15:51:54 -0400 Subject: [PATCH 263/587] Adds language tag for images that contain text. --- 68.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/68.md b/68.md index dcc56f13..0ba4459b 100644 --- a/68.md +++ b/68.md @@ -64,6 +64,10 @@ They may contain multiple images to be displayed as a single post. // Hashtags ["t", "<tag>"], ["t", "<tag>"], + + // When text is written in the image, add the tag to represent the language + ["L", "ISO-639-1"], + ["l", "en", "ISO-639-1"] ] } ``` From f1e8d2c4f764d66996c0c1fb2eeabfbc0c7b2528 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Thu, 24 Oct 2024 20:59:15 -0300 Subject: [PATCH 264/587] nip46: remove words, introduce distinction between bunker key and user key. --- 46.md | 85 +++++++++++++++++++++++++++-------------------------------- 1 file changed, 39 insertions(+), 46 deletions(-) diff --git a/46.md b/46.md index e1675b0d..c356a9cc 100644 --- a/46.md +++ b/46.md @@ -4,6 +4,10 @@ NIP-46 Nostr Remote Signing -------------------- +## Changes + +`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. + ## Rationale Private keys should be exposed to as few systems - apps, operating systems, devices - as possible as each system adds to the attack surface. @@ -12,51 +16,53 @@ This NIP describes a method for 2-way communication between a remote signer and ## Terminology -- **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. -- **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. -- **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. +- **user**: A person that is trying to use Nostr. +- **client**: A user-facing application that _user_ is looking at and clicking buttons in. This application will send requests to _remote-signer_. +- **remote-signer**: A daemon or server running somewhere that will answer requests from _client_, also known as "bunker". +- **client-keypair/pubkey**: The keys generated by _client_. Used to encrypt content and communicate with _remote-signer_. +- **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. +- **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. All pubkeys specified in this NIP are in hex format. ## Initiating a connection -To initiate a connection between a client and a remote signer there are a few different options. +There are two ways to initiate a connection: -### Direct connection initiated by remote signer +### Direct connection initiated by _remote-signer_ -This 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. - -The remote signer would provide a connection token in the form: +_remote-signer_ provides connection token in the form: ``` -bunker://<remote-user-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value> +bunker://<remote-signer-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value> ``` -This 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). Optional secret can be used for single successfully established connection only, remote signer SHOULD ignore new attempts to establish connection with old optional secret. +_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. ### Direct connection initiated by the client -In 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). +In 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. ``` -nostrconnect://<local-keypair-pubkey>?relay=<wss://relay-to-connect-on>&metadata=<json metadata in the form: {"name":"...", "url": "...", "description": "..."}> +nostrconnect://<client-pubkey>?relay=<wss://relay-to-connect-on>&metadata=<json metadata in the form: {"name":"...", "url": "...", "description": "..."}> ``` ## The flow -1. 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. -2. Client gets the remote user pubkey (either via a `bunker://` connection string or a NIP-05 login-flow; shown below) -3. Clients use the local keypair to send requests to the remote signer by `p`-tagging and encrypting to the remote user pubkey. -4. The remote signer responds to the client by `p`-tagging and encrypting to the local keypair pubkey. +1. _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; +2. _client_ gets `remote-signer-pubkey` (either via a `bunker://` connection string or a NIP-05 login-flow; shown below); +3. _client_ use `client-keypair` to send requests to _remote-signer_ by `p`-tagging and encrypting to `remote-signer-pubkey`; +4. _remote-signer_ responds to _client_ by `p`-tagging and encrypting to the `client-pubkey`. ### Example flow for signing an event -- Remote user pubkey (e.g. signing as) `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52` -- Local pubkey is `eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86` +- `remote-signer-pubkey` is `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52` +- `user-pubkey` is also `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52` +- `client-pubkey` is `eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86` #### Signature request -```json +```js { "kind": 24133, "pubkey": "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86", @@ -70,13 +76,13 @@ nostrconnect://<local-keypair-pubkey>?relay=<wss://relay-to-connect-on>&metadata created_at: 1714078911 }>)] }), - "tags": [["p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"]], // p-tags the remote user pubkey + "tags": [["p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"]], // p-tags the remote-signer-pubkey } ``` #### Response event -```json +```js { "kind": 24133, "pubkey": "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", @@ -84,7 +90,7 @@ nostrconnect://<local-keypair-pubkey>?relay=<wss://relay-to-connect-on>&metadata "id": <random_string>, "result": json_stringified(<signed-event>) }), - "tags": [["p", "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86"]], // p-tags the local keypair pubkey + "tags": [["p", "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86"]], // p-tags the client-pubkey } ``` @@ -94,20 +100,18 @@ nostrconnect://<local-keypair-pubkey>?relay=<wss://relay-to-connect-on>&metadata ## Request Events `kind: 24133` -```jsonc +```js { - "id": <id>, "kind": 24133, "pubkey": <local_keypair_pubkey>, "content": <nip04(<request>)>, - "tags": [["p", <remote_user_pubkey>]], // NB: in the `create_account` event, the remote signer pubkey should be `p` tagged. - "created_at": <unix timestamp in seconds> + "tags": [["p", <remote-signer-pubkey>]], } ``` The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted and has the following structure: -```json +```jsonc { "id": <random_string>, "method": <method_name>, @@ -125,15 +129,16 @@ Each of the following are methods that the client sends to the remote signer. | Command | Params | Result | | ------------------------ | ------------------------------------------------- | ---------------------------------------------------------------------- | -| `connect` | `[<remote_user_pubkey>, <optional_secret>, <optional_requested_permissions>]` | "ack" | +| `connect` | `[<user_pubkey>, <optional_secret>, <optional_requested_permissions>]` | "ack" | | `sign_event` | `[<{kind, content, tags, created_at}>]` | `json_stringified(<signed_event>)` | | `ping` | `[]` | "pong" | | `get_relays` | `[]` | `json_stringified({<relay_url>: {read: <boolean>, write: <boolean>}})` | -| `get_public_key` | `[]` | `<hex-pubkey>` | +| `get_public_key` | `[]` | `<user-pubkey>` | | `nip04_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip04_ciphertext>` | | `nip04_decrypt` | `[<third_party_pubkey>, <nip04_ciphertext_to_decrypt>]` | `<plaintext>` | | `nip44_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip44_ciphertext>` | | `nip44_decrypt` | `[<third_party_pubkey>, <nip44_ciphertext_to_decrypt>]` | `<plaintext>` | +| `create_account` | `[<username>, <domain>, <optional_email>, <optional_requested_permissions>]` | `<newly_created_user_pubkey>` | ### Requested permissions @@ -145,9 +150,9 @@ The `connect` method may be provided with `optional_requested_permissions` for u { "id": <id>, "kind": 24133, - "pubkey": <remote_signer_pubkey>, + "pubkey": <remote-signer-pubkey>, "content": <nip04(<response>)>, - "tags": [["p", <local_keypair_pubkey>]], + "tags": [["p", <client-pubkey>]], "created_at": <unix timestamp in seconds> } ``` @@ -184,18 +189,6 @@ Clients should display (in a popup or new tab) the URL from the `error` field an ![signing-example-with-auth-challenge](https://i.nostr.build/W3aj.png) -## Remote Signer Commands - -Remote 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. - -### Methods/Commands - -Each of the following are methods that the client sends to the remote signer. - -| Command | Params | Result | -| ---------------- | ------------------------------------------ | ------------------------------------ | -| `create_account` | `[<username>, <domain>, <optional_email>, <optional_requested_permissions>]` | `<newly_created_remote_user_pubkey>` | - ## Appendix ### NIP-05 Login Flow @@ -204,7 +197,7 @@ Clients might choose to present a more familiar login flow, so users can type a When the user types a NIP-05 the client: -- 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**) +- 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`) - 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. - Now the client has enough information to send commands to the remote signer on behalf of the user. @@ -216,9 +209,9 @@ In this last case, most often used to facilitate an OAuth-like signin flow, the First the client will query for `kind: 31990` events that have a `k` tag of `24133`. -These 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. +These 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. -In 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. +In 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. Clients 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. From 82291c6afda8498ac6f4ddb1d14289f9edb8f8ae Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Wed, 30 Oct 2024 11:50:21 -0400 Subject: [PATCH 265/587] adds location --- 68.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/68.md b/68.md index 0ba4459b..8a878484 100644 --- a/68.md +++ b/68.md @@ -65,6 +65,10 @@ They may contain multiple images to be displayed as a single post. ["t", "<tag>"], ["t", "<tag>"], + // location + ["location", "<location>"], // city name, state, country + ["g", "<geohash>"], + // When text is written in the image, add the tag to represent the language ["L", "ISO-639-1"], ["l", "en", "ISO-639-1"] From c0568fe8cc31961fbfc783805af8942060b455e2 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Thu, 31 Oct 2024 10:09:43 -0700 Subject: [PATCH 266/587] Add explicit support for address quotes --- 18.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/18.md b/18.md index 41c94424..448171fa 100644 --- a/18.md +++ b/18.md @@ -30,6 +30,11 @@ of the `mark` argument. `["q", <event-id>, <relay-url>, <pubkey>]` +When quoting an event by address, `q` tags should follow conventions for `a` tags, +as described in [NIP 01](./01.md). + +`["q", <event-address>, <relay-url>]` + Quote reposts MUST include the [NIP-21](21.md) `nevent`, `note`, or `naddr` of the event in the content. From 5bcb2d834a8533ae657606a42d91169661e06369 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Fri, 1 Nov 2024 08:22:50 +0900 Subject: [PATCH 267/587] Revert "Merge pull request #1558 from coracle-social/quote-a" This reverts commit 4aa46562eb6d2abc6127fa8c2c9f3da7a098e2f6, reversing changes made to 8e2523e331cbcc7f7247590497a0db607c45cf80. --- 18.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/18.md b/18.md index 448171fa..41c94424 100644 --- a/18.md +++ b/18.md @@ -30,11 +30,6 @@ of the `mark` argument. `["q", <event-id>, <relay-url>, <pubkey>]` -When quoting an event by address, `q` tags should follow conventions for `a` tags, -as described in [NIP 01](./01.md). - -`["q", <event-address>, <relay-url>]` - Quote reposts MUST include the [NIP-21](21.md) `nevent`, `note`, or `naddr` of the event in the content. From 061d2ac47d79819e0efa938f231f2511ac40b419 Mon Sep 17 00:00:00 2001 From: greenart7c3 <greenart7c3@proton.me> Date: Fri, 1 Nov 2024 08:03:10 -0300 Subject: [PATCH 268/587] Add intent flags --- 55.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/55.md b/55.md index 54dc44af..1f7972b9 100644 --- a/55.md +++ b/55.md @@ -72,6 +72,12 @@ Set the Signer package name: intent.`package` = "com.example.signer" ``` +If you are sending multiple intents without awaiting you can add some intent flags to sign all events without opening multiple times the signer + +```kotlin +intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP or Intent.FLAG_ACTIVITY_CLEAR_TOP) +``` + Send the Intent: ```kotlin From 93e6c3880beb3818b47d22c07fd11aa5f1356c41 Mon Sep 17 00:00:00 2001 From: greenart7c3 <greenart7c3@proton.me> Date: Fri, 1 Nov 2024 08:16:06 -0300 Subject: [PATCH 269/587] Add launchMode for signers --- 55.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/55.md b/55.md index 1f7972b9..005e4f96 100644 --- a/55.md +++ b/55.md @@ -78,6 +78,12 @@ If you are sending multiple intents without awaiting you can add some intent fla intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP or Intent.FLAG_ACTIVITY_CLEAR_TOP) ``` +If you are developing a signer application them you need to add this to your AndroidManifest.xml so clients can use the intent flags above + +```kotlin +android:launchMode="singleTop" +``` + Send the Intent: ```kotlin From 03a555beb58296bef326f6469bbcf2b73ea144f6 Mon Sep 17 00:00:00 2001 From: greenart7c3 <greenart7c3@proton.me> Date: Fri, 1 Nov 2024 08:24:52 -0300 Subject: [PATCH 270/587] Add result from multiple intents --- 55.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/55.md b/55.md index 005e4f96..afca0aab 100644 --- a/55.md +++ b/55.md @@ -84,6 +84,23 @@ If you are developing a signer application them you need to add this to your And android:launchMode="singleTop" ``` +Signer MUST answer multiple permissions with an array of results + +```kotlin + +val results = listOf( + Result( + package = signerPackageName, + result = eventSignture, + id = intentId + ) +) + +val json = results.toJson() + +intent.putExtra("results", json) +``` + Send the Intent: ```kotlin From 087437042be0dac04a5fce9ea243b6babd31fb63 Mon Sep 17 00:00:00 2001 From: Terry Yiu <963907+tyiu@users.noreply.github.com> Date: Sun, 3 Nov 2024 22:33:48 +0100 Subject: [PATCH 271/587] Remove extra backticks in code blocks and change unnecessary gender-specific pronouns to be gender neutral --- 05.md | 4 ++-- 53.md | 2 +- 57.md | 2 +- 59.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/05.md b/05.md index ca6da7be..b9143440 100644 --- a/05.md +++ b/05.md @@ -33,7 +33,7 @@ It will make a GET request to `https://example.com/.well-known/nostr.json?name=b "bob": "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9" } } -```` +``` or with the **recommended** `"relays"` attribute: @@ -46,7 +46,7 @@ or with the **recommended** `"relays"` attribute: "b0635d6a9851d3aed0cd6c495b282167acf761729078d975fc341b22650b07b9": [ "wss://relay.example.com", "wss://relay2.example.com" ] } } -```` +``` If 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. diff --git a/53.md b/53.md index ee12fef9..c3f15ea0 100644 --- a/53.md +++ b/53.md @@ -119,4 +119,4 @@ Common use cases include meeting rooms/workshops, watch-together activities, or "content": "Zaps to live streams is beautiful.", "sig": "997f62ddfc0827c121043074d50cfce7a528e978c575722748629a4137c45b75bdbc84170bedc723ef0a5a4c3daebf1fef2e93f5e2ddb98e5d685d022c30b622" } -```` +``` diff --git a/57.md b/57.md index b5338110..3f55e57b 100644 --- a/57.md +++ b/57.md @@ -66,7 +66,7 @@ A signed `zap request` event is not published, but is instead sent using a HTTP - `nostr` is the `9734` `zap request` event, JSON encoded then URI encoded - `lnurl` is the lnurl pay url of the recipient, encoded using bech32 with the prefix `lnurl` -This 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: +This 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: ```javascript const senderPubkey // The sender's pubkey diff --git a/59.md b/59.md index a4fc99dc..9bb5845b 100644 --- a/59.md +++ b/59.md @@ -245,7 +245,7 @@ const rumor = createRumor( const seal = createSeal(rumor, senderPrivateKey, recipientPublicKey) const wrap = createWrap(seal, recipientPublicKey) -// Recipient unwraps with his/her private key. +// Recipient unwraps with their private key. const unwrappedSeal = nip44Decrypt(wrap, recipientPrivateKey) const unsealedRumor = nip44Decrypt(unwrappedSeal, recipientPrivateKey) From f72a2f69ed93cf442e83bf9e7e16f6c06da40384 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20Calder=C3=B3n?= <fjcalderon@gmail.com> Date: Mon, 4 Nov 2024 11:27:17 -0300 Subject: [PATCH 272/587] Add NIP number and update README --- xx.md => 100.md | 71 +++++++++++++++++++++++-------------------------- README.md | 2 ++ 2 files changed, 36 insertions(+), 37 deletions(-) rename xx.md => 100.md (69%) diff --git a/xx.md b/100.md similarity index 69% rename from xx.md rename to 100.md index 0543e682..8a7aac52 100644 --- a/xx.md +++ b/100.md @@ -1,4 +1,4 @@ -# NIP-XX +# NIP-100 ## Peer-to-peer Order events @@ -12,44 +12,40 @@ This NIP defines a simple standard for peer-to-peer order events, which enables ## The event -Events are [Parameterized Replaceable Events](https://github.com/nostr-protocol/nips/blob/master/01.md#kinds) and use `38383` as event kind, a p2p event look like this: +Events are [addressable events](https://github.com/nostr-protocol/nips/blob/master/01.md#kinds) and use `38383` as event kind, a p2p event look like this: ```json -[ - "EVENT", - "RAND", - { - "id": "84fad0d29cb3529d789faeff2033e88fe157a48e071c6a5d1619928289420e31", - "pubkey": "dbe0b1be7aafd3cfba92d7463edbd4e33b2969f61bd554d37ac56f032e13355a", - "created_at": 1702548701, - "kind": 38383, - "tags": [ - ["d", "ede61c96-4c13-4519-bf3a-dcf7f1e9d842"], - ["k", "sell"], - ["f", "VES"], - ["s", "pending"], - ["amt", "0"], - ["fa", "100"], - ["pm", "face to face", "bank transfer"], - ["premium", "1"], - [ - "rating", - "{\"total_reviews\":1,\"total_rating\":3.0,\"last_rating\":3,\"max_rate\":5,\"min_rate\":1}" - ], - ["source", "https://t.me/p2plightning/xxxxxxx"], - ["network", "mainnet"], - ["layer", "lightning"], - ["name", "Nakamoto"], - ["g", "<geohash>"], - ["bond", "0"], - ["expiration", "1719391096"], - ["y", "lnp2pbot"], - ["z", "order"] +{ + "id": "84fad0d29cb3529d789faeff2033e88fe157a48e071c6a5d1619928289420e31", + "pubkey": "dbe0b1be7aafd3cfba92d7463edbd4e33b2969f61bd554d37ac56f032e13355a", + "created_at": 1702548701, + "kind": 38383, + "tags": [ + ["d", "ede61c96-4c13-4519-bf3a-dcf7f1e9d842"], + ["k", "sell"], + ["f", "VES"], + ["s", "pending"], + ["amt", "0"], + ["fa", "100"], + ["pm", "face to face", "bank transfer"], + ["premium", "1"], + [ + "rating", + "{\"total_reviews\":1,\"total_rating\":3.0,\"last_rating\":3,\"max_rate\":5,\"min_rate\":1}" ], - "content": "", - "sig": "7e8fe1eb644f33ff51d8805c02a0e1a6d034e6234eac50ef7a7e0dac68a0414f7910366204fa8217086f90eddaa37ded71e61f736d1838e37c0b73f6a16c4af2" - } -] + ["source", "https://t.me/p2plightning/xxxxxxx"], + ["network", "mainnet"], + ["layer", "lightning"], + ["name", "Nakamoto"], + ["g", "<geohash>"], + ["bond", "0"], + ["expiration", "1719391096"], + ["y", "lnp2pbot"], + ["z", "order"] + ], + "content": "", + "sig": "7e8fe1eb644f33ff51d8805c02a0e1a6d034e6234eac50ef7a7e0dac68a0414f7910366204fa8217086f90eddaa37ded71e61f736d1838e37c0b73f6a16c4af2" +} ``` ## Tags @@ -81,9 +77,10 @@ Currently implemented on the following platforms: - [Mostro](https://github.com/MostroP2P/mostro) - [@lnp2pBot](https://github.com/lnp2pBot/bot) +- [Robosats](https://github.com/RoboSats/robosats/pull/1362) ## References -- [Mostro messages specification](https://mostro.network/messages/) +- [Mostro protocol specification](https://mostro.network/protocol/) - [Messages specification for peer 2 peer NIP proposal](https://github.com/nostr-protocol/nips/blob/8250274a22f4882f621510df0054fd6167c10c9e/31001.md) - [n3xB](https://github.com/nobu-maeda/n3xb) diff --git a/README.md b/README.md index 02773a5d..2d7f71f0 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-96: HTTP File Storage Integration](96.md) - [NIP-98: HTTP Auth](98.md) - [NIP-99: Classified Listings](99.md) +- [NIP-100: Peer-to-peer Order events](100.md) ## Event Kinds | kind | description | NIP | @@ -193,6 +194,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `34236` | Short-form Portrait Video Event | [71](71.md) | | `34237` | Video View Event | [71](71.md) | | `34550` | Community Definition | [72](72.md) | +| `38383` | Peer-to-peer Order events | [100](100.md) | | `39000-9` | Group metadata events | [29](29.md) | [NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/97c70a44366a6535c1 From bff61dd310828758651389940dbcebb7fb9ef0ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20Calder=C3=B3n?= <fjcalderon@gmail.com> Date: Mon, 4 Nov 2024 16:38:09 -0300 Subject: [PATCH 273/587] Changes NIP number --- 100.md => 69.md | 2 +- README.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) rename 100.md => 69.md (99%) diff --git a/100.md b/69.md similarity index 99% rename from 100.md rename to 69.md index 8a7aac52..330d6e58 100644 --- a/100.md +++ b/69.md @@ -1,4 +1,4 @@ -# NIP-100 +# NIP-69 ## Peer-to-peer Order events diff --git a/README.md b/README.md index 7c19bd5a..32fbd786 100644 --- a/README.md +++ b/README.md @@ -77,6 +77,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-61: Nutzaps](61.md) - [NIP-64: Chess (PGN)](64.md) - [NIP-65: Relay List Metadata](65.md) +- [NIP-69: Peer-to-peer Order events](69.md) - [NIP-70: Protected Events](70.md) - [NIP-71: Video Events](71.md) - [NIP-72: Moderated Communities](72.md) @@ -91,7 +92,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-96: HTTP File Storage Integration](96.md) - [NIP-98: HTTP Auth](98.md) - [NIP-99: Classified Listings](99.md) -- [NIP-100: Peer-to-peer Order events](100.md) ## Event Kinds @@ -218,7 +218,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `34236` | Short-form Portrait Video Event | [71](71.md) | | `34550` | Community Definition | [72](72.md) | | `37375` | Cashu Wallet Event | [60](60.md) | -| `38383` | Peer-to-peer Order events | [100](100.md) | +| `38383` | Peer-to-peer Order events | [69](69.md) | | `39000-9` | Group metadata events | [29](29.md) | [NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/ From 4c0f9632925eb0ffe94453e45a7bed77c0ab1e6b Mon Sep 17 00:00:00 2001 From: alltheseas <64376233+alltheseas@users.noreply.github.com> Date: Mon, 4 Nov 2024 20:34:24 -0600 Subject: [PATCH 274/587] Update 11.md with banner, and icon fields (#1555) * Update 11.md with banner field Added banner relay metadata field. If nostr relay management is not to be relegated to PhD or protocol developers only, an effort should be made by relay owners to communicate with non-dev non-technical nostr end users. A banner is a visual representation of the relay. It should aim to visually communicate the brand of the relay. * Update 11.md with icon added icon field * Update 11.md updated banner language * Update 11.md updated icon link examples updated icon link examples * Update 11.md grammar * Update 11.md remove .ICO format removed .ICO format * Update 11.md - moved, and merged icon examples Moved up previous Icon section, and removed overlapping/duplication of icon example link content. --- 11.md | 28 +++++++++++++++++----------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/11.md b/11.md index 0ca58708..8efd0f01 100644 --- a/11.md +++ b/11.md @@ -14,6 +14,8 @@ When a relay receives an HTTP(s) request with an `Accept` header of `application { "name": <string identifying relay>, "description": <string with detailed information>, + "banner": <a link to an image (e.g. in .jpg, or .png format)>, + "icon": <a link to an icon (e.g. in .jpg, or .png format>, "pubkey": <administrative contact pubkey>, "contact": <administrative alternate contact>, "supported_nips": <a list of NIP numbers supported by the relay>, @@ -35,6 +37,21 @@ A relay may select a `name` for use in client software. This is a string, and S Detailed plain-text information about the relay may be contained in the `description` string. It is recommended that this contain no markup, formatting or line breaks for word wrapping, and simply use double newline characters to separate paragraphs. There are no limitations on length. +### Banner + +To make nostr relay management more user friendly, an effort should be made by relay owners to communicate with non-dev non-technical nostr end users. A banner is a visual representation of the relay. It should aim to visually communicate the brand of the relay, complementing the text `Description`. [Here is an example banner](https://image.nostr.build/232ddf6846e8aea5a61abcd70f9222ab521f711aa545b7ab02e430248fa3a249.png) mockup as visualized in Damus iOS relay view of the Damus relay. + +### Icon + +Icon is a compact visual representation of the relay for use in UI with limited real estate such as a nostr user's relay list view. Below is an example URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape. + +```jsonc +{ + "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg", + // other fields... +} +``` + ### Pubkey An 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. @@ -257,17 +274,6 @@ Relays that require payments may want to expose their fee schedules. } ``` -### Icon - -A URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape. - -```jsonc -{ - "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg", - // other fields... -} -``` - ### Examples As of 2 May 2023 the following command provided these results: 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: [PATCH 275/587] 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 diff --git a/22.md b/22.md new file mode 100644 index 00000000..3706aec0 --- /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 +} +``` From 690e1b065ca789b04edce220d23bf6e39f6891bd Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Wed, 6 Nov 2024 22:40:46 +0900 Subject: [PATCH 276/587] nip29: add kind 9009 to moderation events table. --- 29.md | 1 + 1 file changed, 1 insertion(+) diff --git a/29.md b/29.md index 80e0f96c..885dae45 100644 --- a/29.md +++ b/29.md @@ -175,6 +175,7 @@ Each moderation action uses a different kind and requires different arguments, w | 9005 | `delete-event` | | | 9007 | `create-group` | | | 9008 | `delete-group` | | +| 9009 | `create-invite` | | It'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. From b0840be3124ee04abadc68155d71dbd6abaa6bde Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Fri, 8 Nov 2024 09:45:19 +0900 Subject: [PATCH 277/587] add NIP-22 to index. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 32fbd786..fc53a0a1 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-18: Reposts](18.md) - [NIP-19: bech32-encoded entities](19.md) - [NIP-21: `nostr:` URI scheme](21.md) +- [NIP-22: Comment](22.md) - [NIP-23: Long-form Content](23.md) - [NIP-24: Extra metadata fields and tags](24.md) - [NIP-25: Reactions](25.md) From 29696eb364d8a0cd609efa85b450c174c5806eda Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Sat, 9 Nov 2024 08:53:01 -0300 Subject: [PATCH 278/587] rename kind:11 as "forum thread root". --- 29.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/29.md b/29.md index 885dae45..ed57e516 100644 --- a/29.md +++ b/29.md @@ -66,9 +66,9 @@ These are the events expected to be found in NIP-29 groups. These 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. -- *text root note* (`kind:11`) +- *thread root post* (`kind:11`) -This is the basic unit of a "microblog" root text note sent to a group. +This is the basic unit of a forum-like root thread post sent to a group. ```jsonc "kind": 11, From 39154346bb691191a1fc734e53d5eda08a1eec79 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Sat, 9 Nov 2024 08:56:29 -0300 Subject: [PATCH 279/587] remove kind:10 and note that kind:1111 could be used. --- 29.md | 41 ++++++++++++++--------------------------- 1 file changed, 14 insertions(+), 27 deletions(-) diff --git a/29.md b/29.md index ed57e516..b02cad24 100644 --- a/29.md +++ b/29.md @@ -66,28 +66,7 @@ These are the events expected to be found in NIP-29 groups. These 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. -- *thread root post* (`kind:11`) - -This is the basic unit of a forum-like root thread post sent to a group. - -```jsonc - "kind": 11, - "content": "hello my friends lovers of pizza", - "tags": [ - ["h", "<group-id>"], - ["previous", "<event-id-first-chars>", "<event-id-first-chars>", /*...*/] - ] - // other fields... -``` - -- *threaded text reply* (`kind:12`) - -This is the basic unit of a "microblog" reply note sent to a group. It's the same as `kind:11`, except for the fact that it must be used whenever it's in reply to some other note (either in reply to a `kind:11` or a `kind:12`). `kind:12` events SHOULD use NIP-10 markers, leaving an empty relay url: - -* `["e", "<kind-11-root-id>", "", "root"]` -* `["e", "<kind-12-event-id>", "", "reply"]` - -- *chat message* (`kind:9`) +- _chat message_ (`kind:9`) This is the basic unit of a _chat message_ sent to a group. @@ -101,15 +80,23 @@ This is the basic unit of a _chat message_ sent to a group. // other fields... ``` -- *chat message threaded reply* (`kind:10`) +- _thread root post_ (`kind:11`) -Similar to `kind:12`, this is the basic unit of a chat message sent to a group. This is intended for in-chat threads that may be hidden by default. Not all in-chat replies MUST use `kind:10`, only when the intention is to create a hidden thread that isn't part of the normal flow of the chat (although clients are free to display those by default too). +This is the basic unit of a forum-like root thread post sent to a group. -`kind:10` SHOULD use NIP-10 markers, just like `kind:12`. +```jsonc + "kind": 11, + "content": "hello my friends lovers of pizza", + "tags": [ + ["h", "<group-id>"], + ["previous", "<event-id-first-chars>", "<event-id-first-chars>", /*...*/] + ] + // other fields... +``` -- other events: +- _other events_: -Groups 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. +Groups may also accept other events, like [NIP-22](22.md) comments as threaded replies to both chats messages and threads, long-form articles, calendar, livestreams, market announcements and so on. These should be as defined in their respective NIPs, with the addition of the `h` tag. ### User-related group management events From b58f02925e7ea05e9f104041cb6e42d146ab4c54 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Sat, 9 Nov 2024 08:56:43 -0300 Subject: [PATCH 280/587] rename kind:9000 to "put-user" instead of "add-user". --- 29.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/29.md b/29.md index b02cad24..5526b74b 100644 --- a/29.md +++ b/29.md @@ -156,7 +156,7 @@ Each moderation action uses a different kind and requires different arguments, w | kind | name | tags | | --- | --- | --- | -| 9000 | `add-user` | `p` with pubkey hex and optional roles | +| 9000 | `put-user` | `p` with pubkey hex and optional roles | | 9001 | `remove-user` | `p` with pubkey hex | | 9002 | `edit-metadata` | fields from `kind:39000` to be modified | | 9005 | `delete-event` | | From b79e46d33cdbe275080a0cb6c7db8e84c685bdb4 Mon Sep 17 00:00:00 2001 From: laanwj <126646+laanwj@users.noreply.github.com> Date: Sat, 9 Nov 2024 14:34:29 +0100 Subject: [PATCH 281/587] readme: Add standardized tags for NIP-35 (torrents) (#1575) --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fc53a0a1..73e3f182 100644 --- a/README.md +++ b/README.md @@ -268,7 +268,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `-` | -- | -- | [70](70.md) | | `g` | geohash | -- | [52](52.md) | | `h` | group id | -- | [29](29.md) | -| `i` | external identity | proof, url hint | [39](39.md), [73](73.md) | +| `i` | external identity | proof, url hint | [35](35.md), [39](39.md), [73](73.md) | | `k` | kind | -- | [18](18.md), [25](25.md), [72](72.md), [73](73.md) | | `l` | label, label namespace | -- | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | @@ -276,7 +276,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `q` | event id (hex) | relay URL, pubkey (hex) | [18](18.md) | | `r` | a reference (URL, etc) | -- | [24](24.md), [25](25.md) | | `r` | relay url | marker | [65](65.md) | -| `t` | hashtag | -- | [24](24.md), [34](34.md) | +| `t` | hashtag | -- | [24](24.md), [34](34.md), [35](35.md) | +| `x` | infohash | -- | [35](35.md) | | `alt` | summary | -- | [31](31.md) | | `amount` | millisatoshis, stringified | -- | [57](57.md) | | `bolt11` | `bolt11` invoice | -- | [57](57.md) | @@ -289,6 +290,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `emoji` | shortcode, image URL | -- | [30](30.md) | | `encrypted` | -- | -- | [90](90.md) | | `expiration` | unix timestamp (string) | -- | [40](40.md) | +| `file` | full path (string) | -- | [35](35.md) | | `goal` | event id (hex) | relay URL | [75](75.md) | | `image` | image URL | dimensions in pixels | [23](23.md), [52](52.md), [58](58.md) | | `imeta` | inline metadata | -- | [92](92.md) | @@ -307,6 +309,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `summary` | summary | -- | [23](23.md), [52](52.md) | | `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | | `title` | article title | -- | [23](23.md) | +| `tracker` | torrent tracker URL | -- | [35](35.md) | | `web` | webpage URL | -- | [34](34.md) | | `zap` | pubkey (hex), relay URL | weight | [57](57.md) | From 18bdc0ce8c80b68cd8e2c30c0dfd12c43e8b8bc0 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Sat, 9 Nov 2024 15:41:25 -0300 Subject: [PATCH 282/587] nip29: add missing "e" tag in kind:9005. --- 29.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/29.md b/29.md index 5526b74b..e4673dda 100644 --- a/29.md +++ b/29.md @@ -159,7 +159,7 @@ Each moderation action uses a different kind and requires different arguments, w | 9000 | `put-user` | `p` with pubkey hex and optional roles | | 9001 | `remove-user` | `p` with pubkey hex | | 9002 | `edit-metadata` | fields from `kind:39000` to be modified | -| 9005 | `delete-event` | | +| 9005 | `delete-event` | `e` with event id hex | | 9007 | `create-group` | | | 9008 | `delete-group` | | | 9009 | `create-invite` | | From b8a5447e264333f1fb009fce9ea631c3d1009db9 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Sat, 9 Nov 2024 15:37:10 -0500 Subject: [PATCH 283/587] adds missing single letter tags --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 73e3f182..9bc25995 100644 --- a/README.md +++ b/README.md @@ -261,23 +261,32 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | name | value | other parameters | NIP | | ----------------- | ------------------------------------ | ------------------------------- | -------------------------------------------------- | -| `e` | event id (hex) | relay URL, marker, pubkey (hex) | [01](01.md), [10](10.md) | -| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | | `a` | coordinates to an event | relay URL | [01](01.md) | +| `A` | root address | relay URL | [22](22.md) | | `d` | identifier | -- | [01](01.md) | -| `-` | -- | -- | [70](70.md) | +| `e` | event id (hex) | relay URL, marker, pubkey (hex) | [01](01.md), [10](10.md) | +| `E` | root event i | relay URL | [22](22.md) | +| `f` | currency code | -- | [69](69.md) | | `g` | geohash | -- | [52](52.md) | | `h` | group id | -- | [29](29.md) | | `i` | external identity | proof, url hint | [35](35.md), [39](39.md), [73](73.md) | +| `I` | root external identity | -- | [22](22.md) | | `k` | kind | -- | [18](18.md), [25](25.md), [72](72.md), [73](73.md) | +| `K` | root scope | -- | [22](22.md) | | `l` | label, label namespace | -- | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | | `m` | MIME type | -- | [94](94.md) | +| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | | `q` | event id (hex) | relay URL, pubkey (hex) | [18](18.md) | | `r` | a reference (URL, etc) | -- | [24](24.md), [25](25.md) | | `r` | relay url | marker | [65](65.md) | +| `s` | status | -- | [69](69.md) | | `t` | hashtag | -- | [24](24.md), [34](34.md), [35](35.md) | +| `u` | url | -- | [61](61.md), [98](98.md) | | `x` | infohash | -- | [35](35.md) | +| `y` | platform | -- | [69](69.md) | +| `z` | order number | -- | [69](69.md) | +| `-` | -- | -- | [70](70.md) | | `alt` | summary | -- | [31](31.md) | | `amount` | millisatoshis, stringified | -- | [57](57.md) | | `bolt11` | `bolt11` invoice | -- | [57](57.md) | From 926a51e72206dfa71b9950a0ce58b54a7422aad2 Mon Sep 17 00:00:00 2001 From: "Nostr.Band" <124499563+nostrband@users.noreply.github.com> Date: Tue, 12 Nov 2024 01:35:42 +0100 Subject: [PATCH 284/587] Nip46 upgrade part2: remove nip05 and create_account, clarify nostrconnect, cleanup, add nip05 signer metadata (#1553) --- 46.md | 173 ++++++++++++++++++++++++++++------------------------------ 1 file changed, 83 insertions(+), 90 deletions(-) diff --git a/46.md b/46.md index c356a9cc..60850aaf 100644 --- a/46.md +++ b/46.md @@ -6,7 +6,7 @@ Nostr Remote Signing ## Changes -`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. +`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, nip05 login is removed, create_account moved to another NIP. ## Rationale @@ -25,6 +25,14 @@ This NIP describes a method for 2-way communication between a remote signer and All pubkeys specified in this NIP are in hex format. +## Overview + +1. _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; +2. A connection is established (see below), _remote-signer_ learns `client-pubkey`, _client_ learns `remote-signer-pubkey`. +3. _client_ uses `client-keypair` to send requests to _remote-signer_ by `p`-tagging and encrypting to `remote-signer-pubkey`; +4. _remote-signer_ responds to _client_ by `p`-tagging and encrypting to the `client-pubkey`. +5. _client_ requests `get_public_key` to learn `user-pubkey`. + ## Initiating a connection There are two ways to initiate a connection: @@ -37,66 +45,16 @@ _remote-signer_ provides connection token in the form: bunker://<remote-signer-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value> ``` -_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. +_user_ passes this token to _client_, which then sends `connect` request 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 secret. -### Direct connection initiated by the client +### Direct connection initiated by the _client_ -In 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. +_client_ provides a connection token in the form: ``` -nostrconnect://<client-pubkey>?relay=<wss://relay-to-connect-on>&metadata=<json metadata in the form: {"name":"...", "url": "...", "description": "..."}> +nostrconnect://<client-pubkey>?relay=<wss://relay-to-connect-on>&metadata=<json metadata: {"name":"...", "url": "...", "description": "...", "perms": "..."}>&secret=<required-secret-value> ``` - -## The flow - -1. _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; -2. _client_ gets `remote-signer-pubkey` (either via a `bunker://` connection string or a NIP-05 login-flow; shown below); -3. _client_ use `client-keypair` to send requests to _remote-signer_ by `p`-tagging and encrypting to `remote-signer-pubkey`; -4. _remote-signer_ responds to _client_ by `p`-tagging and encrypting to the `client-pubkey`. - -### Example flow for signing an event - -- `remote-signer-pubkey` is `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52` -- `user-pubkey` is also `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52` -- `client-pubkey` is `eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86` - -#### Signature request - -```js -{ - "kind": 24133, - "pubkey": "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86", - "content": nip04({ - "id": <random_string>, - "method": "sign_event", - "params": [json_stringified(<{ - content: "Hello, I'm signing remotely", - kind: 1, - tags: [], - created_at: 1714078911 - }>)] - }), - "tags": [["p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"]], // p-tags the remote-signer-pubkey -} -``` - -#### Response event - -```js -{ - "kind": 24133, - "pubkey": "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", - "content": nip04({ - "id": <random_string>, - "result": json_stringified(<signed-event>) - }), - "tags": [["p", "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86"]], // p-tags the client-pubkey -} -``` - -#### Diagram - -![signing-example](https://i.nostr.build/P3gW.png) +_user_ passes this token to _remote-signer_, which then sends `connect` *response* event to the `client-pubkey` via the specified relays. Client discovers `remote-signer-pubkey` from connect response author. `secret` value MUST be provided to avoid connection spoofing, _client_ MUST validate the `secret` returned by `connect` response. ## Request Events `kind: 24133` @@ -125,11 +83,11 @@ The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted ### Methods/Commands -Each of the following are methods that the client sends to the remote signer. +Each of the following are methods that the _client_ sends to the _remote-signer_. | Command | Params | Result | | ------------------------ | ------------------------------------------------- | ---------------------------------------------------------------------- | -| `connect` | `[<user_pubkey>, <optional_secret>, <optional_requested_permissions>]` | "ack" | +| `connect` | `[<remote-signer-pubkey>, <optional_secret>, <optional_requested_permissions>]` | "ack" OR `<required-secret-value>` | | `sign_event` | `[<{kind, content, tags, created_at}>]` | `json_stringified(<signed_event>)` | | `ping` | `[]` | "pong" | | `get_relays` | `[]` | `json_stringified({<relay_url>: {read: <boolean>, write: <boolean>}})` | @@ -138,11 +96,10 @@ Each of the following are methods that the client sends to the remote signer. | `nip04_decrypt` | `[<third_party_pubkey>, <nip04_ciphertext_to_decrypt>]` | `<plaintext>` | | `nip44_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip44_ciphertext>` | | `nip44_decrypt` | `[<third_party_pubkey>, <nip44_ciphertext_to_decrypt>]` | `<plaintext>` | -| `create_account` | `[<username>, <domain>, <optional_email>, <optional_requested_permissions>]` | `<newly_created_user_pubkey>` | ### Requested permissions -The `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. +The `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. Same permission format may be used for `perms` field of `metadata` in `nostrconnect://` string. ## Response Events `kind:24133` @@ -171,9 +128,54 @@ The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted - `results` is a string of the result of the call (this can be either a string or a JSON stringified object) - `error`, _optionally_, it is an error in string form, if any. Its presence indicates an error with the request. -### Auth Challenges +## Example flow for signing an event -An Auth Challenge is a response that a remote signer can send back when it needs the user to authenticate via other means. This is currently used in the OAuth-like flow enabled by signers like [Nsecbunker](https://github.com/kind-0/nsecbunkerd/). The response `content` object will take the following form: +- `remote-signer-pubkey` is `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52` +- `user-pubkey` is also `fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52` +- `client-pubkey` is `eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86` + +### Signature request + +```js +{ + "kind": 24133, + "pubkey": "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86", + "content": nip04({ + "id": <random_string>, + "method": "sign_event", + "params": [json_stringified(<{ + content: "Hello, I'm signing remotely", + kind: 1, + tags: [], + created_at: 1714078911 + }>)] + }), + "tags": [["p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"]], // p-tags the remote-signer-pubkey +} +``` + +### Response event + +```js +{ + "kind": 24133, + "pubkey": "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", + "content": nip04({ + "id": <random_string>, + "result": json_stringified(<signed-event>) + }), + "tags": [["p", "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86"]], // p-tags the client-pubkey +} +``` + +### Diagram + +![signing-example](https://i.nostr.build/P3gW.png) + + +## Auth Challenges + +An Auth Challenge is a response that a _remote-signer_ can send back when it needs the _user_ to authenticate via other means. The response `content` object will take the following form: ```json { @@ -183,42 +185,33 @@ An Auth Challenge is a response that a remote signer can send back when it needs } ``` -Clients should display (in a popup or new tab) the URL from the `error` field and then subscribe/listen for another response from the remote signer (reusing the same request ID). This event will be sent once the user authenticates in the other window (or will never arrive if the user doesn't authenticate). It's also possible to add a `redirect_uri` url parameter to the auth_url, which is helpful in situations when a client cannot open a new window or tab to display the auth challenge. +_client_ should display (in a popup or new tab) the URL from the `error` field and then subscribe/listen for another response from the _remote-signer_ (reusing the same request ID). This event will be sent once the user authenticates in the other window (or will never arrive if the user doesn't authenticate). -#### Example event signing request with auth challenge +### Example event signing request with auth challenge ![signing-example-with-auth-challenge](https://i.nostr.build/W3aj.png) ## Appendix -### NIP-05 Login Flow +### Announcing _remote-signer_ metadata -Clients might choose to present a more familiar login flow, so users can type a NIP-05 address instead of a `bunker://` string. +_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: +``` +{ + "names":{ + "_": <remote-signer-app-pubkey>, + }, + "nip46": { + "relays": ["wss://relay1","wss://relay2"...], + "nostrconnect_url": "https://remote-signer-domain.com/<nostrconnect>" + } +} +``` -When the user types a NIP-05 the client: +The `<remote-signer-app-pubkey>` MAY be used to verify the domain from _remote-signer_'s NIP-89 event (see below). `relays` SHOULD be used to construct a more precise `nostrconnect://` string for the specific `remote-signer`. `nostrconnect_url` template MAY be used to redirect users to _remote-signer_'s connection flow by replacing `<nostrconnect>` placeholder with an actual `nostrconnect://` string. -- 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`) -- 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. -- Now the client has enough information to send commands to the remote signer on behalf of the user. +### Remote signer discovery via NIP-89 -### OAuth-like Flow +_remote-signer_ MAY publish a NIP-89 `kind: 31990` event with `k` tag of `24133`, which MAY also include one or more `relay` tags and MAY include `nostrconnect_url` tag. The semantics of `relay` and `nostrconnect_url` tags are the same as in the section above. -#### Remote signer discovery via NIP-89 - -In 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. - -First the client will query for `kind: 31990` events that have a `k` tag of `24133`. - -These 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. - -In 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. - -Clients 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. - -#### Example Oauth-like flow to create a new user account with Nsecbunker - -Coming soon... - -## References - -- [NIP-04 - Encryption](04.md) +_client_ MAY improve UX by discovering _remote-signers_ using their `kind: 31990` events. _client_ MAY then pre-generate `nostrconnect://` strings for the _remote-signers_, and SHOULD in that case verify that `kind: 31990` event's author is mentioned in signer's `nostr.json?name=_` file as `<remote-signer-app-pubkey>`. From 3e540a38e2da3e4ce93f50b2fb6f9009721db10d Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Thu, 14 Nov 2024 22:43:44 +0900 Subject: [PATCH 285/587] update kinds table. --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9bc25995..ffda69cd 100644 --- a/README.md +++ b/README.md @@ -108,9 +108,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `7` | Reaction | [25](25.md) | | `8` | Badge Award | [58](58.md) | | `9` | Group Chat Message | [29](29.md) | -| `10` | Group Chat Threaded Reply | [29](29.md) | +| `10` | Group Chat Threaded Reply | 29 (deprecated) | | `11` | Group Thread | [29](29.md) | -| `12` | Group Thread Reply | [29](29.md) | +| `12` | Group Thread Reply | 29 (deprecated) | | `13` | Seal | [59](59.md) | | `14` | Direct Message | [17](17.md) | | `16` | Generic Repost | [18](18.md) | @@ -127,6 +127,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `1040` | OpenTimestamps | [03](03.md) | | `1059` | Gift Wrap | [59](59.md) | | `1063` | File Metadata | [94](94.md) | +| `1111` | Comment | [22](22.md) | | `1311` | Live Chat Message | [53](53.md) | | `1617` | Patches | [34](34.md) | | `1621` | Issues | [34](34.md) | From 8f112857a256f2a6af943a28d45f30b363d1627a Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Fri, 15 Nov 2024 08:34:58 +0900 Subject: [PATCH 286/587] fix typo. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ffda69cd..cbd45cfb 100644 --- a/README.md +++ b/README.md @@ -266,7 +266,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `A` | root address | relay URL | [22](22.md) | | `d` | identifier | -- | [01](01.md) | | `e` | event id (hex) | relay URL, marker, pubkey (hex) | [01](01.md), [10](10.md) | -| `E` | root event i | relay URL | [22](22.md) | +| `E` | root event id | relay URL | [22](22.md) | | `f` | currency code | -- | [69](69.md) | | `g` | geohash | -- | [52](52.md) | | `h` | group id | -- | [29](29.md) | From eca0a83d097e274bc1c4b416315b5f2e924f7e02 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Thu, 14 Nov 2024 16:53:33 -0500 Subject: [PATCH 287/587] Moves deprecated stuff to the bottom --- 10.md | 57 ++++++++++++++++++++++++++++++--------------------------- 1 file changed, 30 insertions(+), 27 deletions(-) diff --git a/10.md b/10.md index 94db4fae..c1d50687 100644 --- a/10.md +++ b/10.md @@ -10,33 +10,6 @@ On "e" and "p" tags in Text Events (kind 1) ## Abstract This NIP describes how to use "e" and "p" tags in text events, especially those that are replies to other text events. It helps clients thread the replies into a tree rooted at the original event. -## Positional "e" tags (DEPRECATED) ->This scheme is in common use; but should be considered deprecated. - -`["e", <event-id>, <relay-url>]` as per NIP-01. - -Where: - - * `<event-id>` is the id of the event being referenced. - * `<relay-url>` is the URL of a recommended relay associated with the reference. Many clients treat this field as optional. - -**The positions of the "e" tags within the event denote specific meanings as follows**: - - * No "e" tag: <br> - This event is not a reply to, nor does it refer to, any other event. - - * One "e" tag: <br> - `["e", <id>]`: The id of the event to which this event is a reply. - - * Two "e" tags: `["e", <root-id>]`, `["e", <reply-id>]` <br> - `<root-id>` is the id of the event at the root of the reply chain. `<reply-id>` is the id of the article to which this event is a reply. - - * Many "e" tags: `["e", <root-id>]` `["e", <mention-id>]`, ..., `["e", <reply-id>]`<br> -There may be any number of `<mention-ids>`. These are the ids of events which may, or may not be in the reply chain. -They are citing from this event. `root-id` and `reply-id` are as above. - ->This scheme is deprecated because it creates ambiguities that are difficult, or impossible to resolve when an event references another but is not a reply. - ## Marked "e" tags (PREFERRED) `["e", <event-id>, <relay-url>, <marker>, <pubkey>]` @@ -62,3 +35,33 @@ When replying to a text event E the reply event's "p" tags should contain all of Example: Given a text event authored by `a1` with "p" tags [`p1`, `p2`, `p3`] then the "p" tags of the reply should be [`a1`, `p1`, `p2`, `p3`] in no particular order. + +## Deprecated Positional "e" tags + +This scheme is not in common use anymore and is here just to keep backward compatibility with older events on the network. + +Positional `e` tags are deprecated because they create ambiguities that are difficult, or impossible to resolve when an event references another but is not a reply. + +They use simple `e` tags without any marker. + +`["e", <event-id>, <relay-url>]` as per NIP-01. + +Where: + + * `<event-id>` is the id of the event being referenced. + * `<relay-url>` is the URL of a recommended relay associated with the reference. Many clients treat this field as optional. + +**The positions of the "e" tags within the event denote specific meanings as follows**: + + * No "e" tag: <br> + This event is not a reply to, nor does it refer to, any other event. + + * One "e" tag: <br> + `["e", <id>]`: The id of the event to which this event is a reply. + + * Two "e" tags: `["e", <root-id>]`, `["e", <reply-id>]` <br> + `<root-id>` is the id of the event at the root of the reply chain. `<reply-id>` is the id of the article to which this event is a reply. + + * Many "e" tags: `["e", <root-id>]` `["e", <mention-id>]`, ..., `["e", <reply-id>]`<br> +There may be any number of `<mention-ids>`. These are the ids of events which may, or may not be in the reply chain. +They are citing from this event. `root-id` and `reply-id` are as above. \ No newline at end of file From a8dfdff753a30f0845d6b9729cdbae3ad37a3f8e Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Fri, 15 Nov 2024 08:15:30 -0500 Subject: [PATCH 288/587] Adds x tag to index by sha256 Co-authored-by: Pablo Fernandez <pfer@me.com> --- 68.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/68.md b/68.md index 8a878484..29507126 100644 --- a/68.md +++ b/68.md @@ -59,7 +59,8 @@ They may contain multiple images to be displayed as a single post. ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], // Specify the media type for filters to allow clients to filter by supported kinds - ["m", "image/jpeg"] + ["m", "image/jpeg"], + ["x", "<sha256>"] // Hashtags ["t", "<tag>"], From dfd2c2b8ca86821485f9bbcd3b1397e211c294e5 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Fri, 15 Nov 2024 08:28:54 -0500 Subject: [PATCH 289/587] Minor changes to simplify the text --- 68.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/68.md b/68.md index 29507126..6c1e7d2d 100644 --- a/68.md +++ b/68.md @@ -6,9 +6,9 @@ Picture-first feeds `draft` `optional` -This NIP defines event kind `20` for picture-first clients. Images must be self-contained. They are hosted externally and referenced using `imeta` tags +This NIP defines event kind `20` for picture-first clients. Images must be self-contained. They are hosted externally and referenced using `imeta` tags. -Unlike a `kind 1` event with a pircture attached, Picture events are meant to contain all additional metadata concerning the subject media and to be surfaced in picture-specific clients rather than general micro-blogging clients. The thought is for events of this kind to be referenced in a Instagram/Flickr/Snapshat/9gag like nostr client where the picture itself is at the center of the experience. +The idea is for this type of event to cater to Nostr clients resembling platforms like Instagram, Flickr, Snapchat, or 9GAG, where the picture itself takes center stage in the user experience. ## Picture Events @@ -60,6 +60,8 @@ They may contain multiple images to be displayed as a single post. // Specify the media type for filters to allow clients to filter by supported kinds ["m", "image/jpeg"], + + // Hashes of each image to make them queryable ["x", "<sha256>"] // Hashtags @@ -87,4 +89,4 @@ Only the following media types are accepted: - `image/png`: Portable Network Graphics (PNG) - `image/webp`: Web Picture format (WEBP) -Picture events might be used with [NIP-71](71.md)'s kind `34236` to display short vertical videos in the same feed. \ No newline at end of file +Picture events might be used with [NIP-71](71.md)'s kind `34236` to display short vertical videos in the same feed. From 8794be6775a6264a82ed8044b14f3c5e4eb01122 Mon Sep 17 00:00:00 2001 From: Josh Brown <josh@roadfiresoftware.com> Date: Fri, 15 Nov 2024 11:14:19 -0500 Subject: [PATCH 290/587] Fix typo in NIP-29 --- 29.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/29.md b/29.md index e4673dda..f0ba8ab5 100644 --- a/29.md +++ b/29.md @@ -26,7 +26,7 @@ Group identifiers must be strings restricted to the characters `a-z0-9-_`. When 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. -Group 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. +Group identifiers in most cases should be random or pseudo-random, as that mitigates message replay confusion 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. ## The `h` tag From 108b6314299f71540190a7abf37074787fa6d698 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=B0=8F=E5=8E=9F=E6=99=B4=E5=A4=AA?= <haruta@s3-odara.net> Date: Sun, 17 Nov 2024 15:22:47 +0000 Subject: [PATCH 291/587] "user matadata" --- 05.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/05.md b/05.md index b9143440..7e823fba 100644 --- a/05.md +++ b/05.md @@ -10,7 +10,7 @@ On events of kind `0` (`user metadata`) one can specify the key `"nip05"` with a Upon seeing that, the client splits the identifier into `<local-part>` and `<domain>` and use these values to make a GET request to `https://<domain>/.well-known/nostr.json?name=<local-part>`. -The result should be a JSON document object with a key `"names"` that should then be a mapping of names to hex formatted public keys. If the public key for the given `<name>` matches the `pubkey` from the `user's metadata` event, the client then concludes that the given pubkey can indeed be referenced by its identifier. +The result should be a JSON document object with a key `"names"` that should then be a mapping of names to hex formatted public keys. If the public key for the given `<name>` matches the `pubkey` from the `user metadata` event, the client then concludes that the given pubkey can indeed be referenced by its identifier. ### Example 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: [PATCH 292/587] 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(-) diff --git a/11.md b/11.md index 8efd0f01..8af4f313 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 4b96bce3..72f40c47 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 3706aec0..f11925fa 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 f0ba8ab5..a1164332 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 60850aaf..ce6764da 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 05c1b186..3828e76c 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": [ From bbcea0c86175fd344132964345944d3479c3d4d0 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Tue, 19 Nov 2024 21:20:20 -0500 Subject: [PATCH 293/587] adds pronouns --- 24.md | 1 + 1 file changed, 1 insertion(+) diff --git a/24.md b/24.md index 1afa7c7a..d65d9ced 100644 --- a/24.md +++ b/24.md @@ -17,6 +17,7 @@ These are extra fields not specified in NIP-01 that may be present in the string - `website`: a web URL related in any way to the event author. - `banner`: an URL to a wide (~1024x768) picture to be optionally displayed in the background of a profile screen. - `bot`: a boolean to clarify that the content is entirely or partially the result of automation, such as with chatbots or newsfeeds. + - `pronouns`: a string representing the preferred way to refer to this person. ### Deprecated fields From 1e47fd75572704b84cf484ce52394fc7ea7d4067 Mon Sep 17 00:00:00 2001 From: hodlbod <jstaab@protonmail.com> Date: Thu, 21 Nov 2024 06:55:23 -0800 Subject: [PATCH 294/587] Break out chat and threads from nip 29 (#1591) --- 29.md | 34 +--------------------------------- 7D.md | 34 ++++++++++++++++++++++++++++++++++ C7.md | 29 +++++++++++++++++++++++++++++ 3 files changed, 64 insertions(+), 33 deletions(-) create mode 100644 7D.md create mode 100644 C7.md diff --git a/29.md b/29.md index a1164332..a2c8ef26 100644 --- a/29.md +++ b/29.md @@ -64,39 +64,7 @@ These are the events expected to be found in NIP-29 groups. ### Normal user-created events -These 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. - -- _chat message_ (`kind:9`) - -This is the basic unit of a _chat message_ sent to a group. - -```jsonc - "kind": 9, - "content": "hello my friends lovers of pizza", - "tags": [ - ["h", "<group-id>"], - ["previous", "<event-id-first-chars>", "<event-id-first-chars>", /*...*/] - ] - // other fields... -``` - -- _thread root post_ (`kind:11`) - -This is the basic unit of a forum-like root thread post sent to a group. - -```jsonc - "kind": 11, - "content": "hello my friends lovers of pizza", - "tags": [ - ["h", "<group-id>"], - ["previous", "<event-id-first-chars>", "<event-id-first-chars>", /*...*/] - ] - // other fields... -``` - -- _other events_: - -Groups may also accept other events, like [NIP-22](22.md) comments as threaded replies to both chats messages and threads, long-form articles, calendar, livestreams, market announcements and so on. These should be as defined in their respective NIPs, with the addition of the `h` tag. +Groups may accept any event kind, including chats, threads, long-form articles, calendar, livestreams, market announcements and so on. These should be as defined in their respective NIPs, with the addition of the `h` tag. ### User-related group management events diff --git a/7D.md b/7D.md new file mode 100644 index 00000000..d8509a6c --- /dev/null +++ b/7D.md @@ -0,0 +1,34 @@ +NIP-7D +====== + +Threads +------- + +`draft` `optional` + +A thread is a `kind 11` event. Threads SHOULD include a `subject` with a summary +of the thread's topic. + +```json +{ + "kind": 11, + "content": "Good morning", + "tags": [ + ["subject", "GM"] + ] +} +``` + +Replies to `kind 11` MUST use [NIP-22](./22.md) `kind 1111` comments. Replies should +always be to the root `kind 11` to avoid arbitrarily nested reply hierarchies. + +```json +{ + "kind": 1111, + "content": "Cool beans", + "tags": [ + ["K", "11"], + ["E", <event-id>, <relay-url>, <pubkey>] + ] +} +``` diff --git a/C7.md b/C7.md new file mode 100644 index 00000000..0d94f18b --- /dev/null +++ b/C7.md @@ -0,0 +1,29 @@ +NIP-C7 +====== + +Chats +----- + +`draft` `optional` + +A chat message is a `kind 9` event. + +```json +{ + "kind": 9, + "content": "GM", + "tags": [] +} +``` + +A reply to a `kind 9` is an additional `kind 9` which quotes the parent using a `q` tag. + +```json +{ + "kind": 9, + "content": "nostr:nevent1...\nyes", + "tags": [ + ["q", <event-id>, <relay-url>, <pubkey>] + ] +} +``` From 03c64a6e959ae91b727bcaea8198d08ee4860359 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Thu, 21 Nov 2024 12:11:13 -0300 Subject: [PATCH 295/587] nip24: revert improperly merged joke. this reverts https://github.com/nostr-protocol/nips/pull/1590 --- 24.md | 1 - 1 file changed, 1 deletion(-) diff --git a/24.md b/24.md index d65d9ced..1afa7c7a 100644 --- a/24.md +++ b/24.md @@ -17,7 +17,6 @@ These are extra fields not specified in NIP-01 that may be present in the string - `website`: a web URL related in any way to the event author. - `banner`: an URL to a wide (~1024x768) picture to be optionally displayed in the background of a profile screen. - `bot`: a boolean to clarify that the content is entirely or partially the result of automation, such as with chatbots or newsfeeds. - - `pronouns`: a string representing the preferred way to refer to this person. ### Deprecated fields From ef1746dd2cea9ec5d62d00f16f0fd5695d895d0b Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Thu, 21 Nov 2024 12:11:32 -0300 Subject: [PATCH 296/587] nip24: clarify nip purpose. --- 24.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/24.md b/24.md index 1afa7c7a..df3a9323 100644 --- a/24.md +++ b/24.md @@ -6,7 +6,7 @@ Extra metadata fields and tags `draft` `optional` -This NIP defines extra optional fields added to events. +This NIP keeps track of extra optional fields that can added to events which are not defined anywhere else but have become _de facto_ standards and other minor implementation possibilities that do not deserve their own NIP and do not have a place in other NIPs. kind 0 ====== From 7976f8ab777a2bb6359ed64171309b4a0663bdf4 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Thu, 21 Nov 2024 08:48:32 -0800 Subject: [PATCH 297/587] Clarify nostrconnect metadata --- 46.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/46.md b/46.md index ce6764da..824059c1 100644 --- a/46.md +++ b/46.md @@ -45,15 +45,25 @@ _remote-signer_ provides connection token in the form: bunker://<remote-signer-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value> ``` -_user_ passes this token to _client_, which then sends `connect` request 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 secret. +_user_ passes this token to _client_, which then sends `connect` request 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 secret. ### Direct connection initiated by the _client_ -_client_ provides a connection token in the form: +_client_ provides a connection token using `nostrconnect://` as the protocol, and `client-pubkey` as the origin. Additional information should be passed as query parameters: + +- `relay` (required) - one or more relay urls on which the _client_ is listening for responses from the _remote-signer_. +- `secret` (required) - a short random string that the _remote-signer_ should return as the `result` field of its response. +- `perms` (optional) - a comma-separated list of permissions the _client_ is requesting be approved by the _remote-signer_ +- `name` (optional) - the name of the _client_ application +- `url` (optional) - the canonical url of the _client_ application +- `image` (optional) - a small image representing the _client_ application + +Here's an example: ``` -nostrconnect://<client-pubkey>?relay=<wss://relay-to-connect-on>&metadata=<json metadata: {"name":"...", "url": "...", "description": "...", "perms": "..."}>&secret=<required-secret-value> +nostrconnect://83f3b2ae6aa368e8275397b9c26cf550101d63ebaab900d19dd4a4429f5ad8f5?relay=wss%3A%2F%2Frelay1.example.com&perms=nip44_encrypt%2Cnip44_decrypt%2Csign_event%3A13%2Csign_event%3A14%2Csign_event%3A1059&name=My+Client&secret=0s8j2djs&relay=wss%3A%2F%2Frelay2.example2.com ``` + _user_ passes this token to _remote-signer_, which then sends `connect` *response* event to the `client-pubkey` via the specified relays. Client discovers `remote-signer-pubkey` from connect response author. `secret` value MUST be provided to avoid connection spoofing, _client_ MUST validate the `secret` returned by `connect` response. ## Request Events `kind: 24133` From d09b51246d7d5757b5e78ef1cc18e8925561d42f Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Fri, 22 Nov 2024 14:09:12 -0800 Subject: [PATCH 298/587] Tweak group join requests to include user feedback --- 29.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/29.md b/29.md index a2c8ef26..93dc3d29 100644 --- a/29.md +++ b/29.md @@ -72,7 +72,7 @@ These are events that can be sent by users to manage their situation in a group, - *join request* (`kind:9021`) -Any 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. +Any user can send a kind `9021` event to the relay in order to request admission to the group. Relays MUST reject the request if the user has not been added to the group. The accompanying error message SHOULD explain whether the rejection is final, if the request is pending review, or if some other special handling is relevant (e.g. if payment is required). If a user is already a member, the event MUST be accepted. ```json { From 4d47b38dbc0c2e09d235972f59a4338a7bb37cc0 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Sat, 23 Nov 2024 07:09:25 -0800 Subject: [PATCH 299/587] Switch to rejecting duplicate joins --- 29.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/29.md b/29.md index 93dc3d29..7705c6db 100644 --- a/29.md +++ b/29.md @@ -72,7 +72,7 @@ These are events that can be sent by users to manage their situation in a group, - *join request* (`kind:9021`) -Any user can send a kind `9021` event to the relay in order to request admission to the group. Relays MUST reject the request if the user has not been added to the group. The accompanying error message SHOULD explain whether the rejection is final, if the request is pending review, or if some other special handling is relevant (e.g. if payment is required). If a user is already a member, the event MUST be accepted. +Any user can send a kind `9021` event to the relay in order to request admission to the group. Relays MUST reject the request if the user has not been added to the group. The accompanying error message SHOULD explain whether the rejection is final, if the request is pending review, or if some other special handling is relevant (e.g. if payment is required). If a user is already a member, the event MUST be rejected with `duplicate: ` as the error message prefix. ```json { From 43767e1e531de51874889b4eab905409192c404e Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Fri, 22 Nov 2024 13:55:23 -0800 Subject: [PATCH 300/587] Add support for naming unmanaged groups --- 29.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/29.md b/29.md index a2c8ef26..331047f7 100644 --- a/29.md +++ b/29.md @@ -22,15 +22,15 @@ Relays are supposed to generate the events that describe group metadata and grou A 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`. -Group identifiers must be strings restricted to the characters `a-z0-9-_`. +Group identifiers must be strings restricted to the characters `a-z0-9-_`, and SHOULD be random in order to avoid name collisions. -When 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. - -Group identifiers in most cases should be random or pseudo-random, as that mitigates message replay confusion 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. +When encountering just the `<host>` without the `'<group-id>`, clients MAY infer `_` as the group id, which is a special top-level group dedicated to relay-local discussions. ## The `h` tag -Events 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_. +Events 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_. + +`h` tags MAY include the group's name as the second argument. This allows `unmanaged` groups to be assigned human-readable names without relay support. ## Timeline references @@ -241,4 +241,4 @@ A definition for `kind:10009` was included in [NIP-51](51.md) that allows client ### Using `unmanaged` relays -To 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. +To prevent event leakage, 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. From 0e44178961b36909338d3dca37ed3cba4a41e7f6 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Tue, 26 Nov 2024 00:34:00 +0900 Subject: [PATCH 301/587] update related to NIP-29. --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cbd45cfb..5d1a47dc 100644 --- a/README.md +++ b/README.md @@ -93,6 +93,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-96: HTTP File Storage Integration](96.md) - [NIP-98: HTTP Auth](98.md) - [NIP-99: Classified Listings](99.md) +- [NIP-7D: Threads](7D.md) +- [NIP-C7: Chats](C7.md) ## Event Kinds @@ -107,9 +109,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `6` | Repost | [18](18.md) | | `7` | Reaction | [25](25.md) | | `8` | Badge Award | [58](58.md) | -| `9` | Group Chat Message | [29](29.md) | +| `9` | Chat Message | [C7](C7.md) | | `10` | Group Chat Threaded Reply | 29 (deprecated) | -| `11` | Group Thread | [29](29.md) | +| `11` | Thread | [7D](7D.md) | | `12` | Group Thread Reply | 29 (deprecated) | | `13` | Seal | [59](59.md) | | `14` | Direct Message | [17](17.md) | From 73f65133fcdcbf9f4d27cc7097963797c6250cd7 Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Mon, 25 Nov 2024 13:21:47 -0300 Subject: [PATCH 302/587] add NIP-86: Relay Management API (#1325) Co-authored-by: Alex Gleason <alex@alexgleason.me> --- 86.md | 90 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 1 + 2 files changed, 91 insertions(+) create mode 100644 86.md diff --git a/86.md b/86.md new file mode 100644 index 00000000..6f64eee7 --- /dev/null +++ b/86.md @@ -0,0 +1,90 @@ +NIP-86 +====== + +Relay Management API +-------------------- + +`draft` `optional` + +Relays may provide an API for performing management tasks. This is made available as a JSON-RPC-like request-response protocol over HTTP, on the same URI as the relay's websocket. + +When a relay receives an HTTP(s) request with a `Content-Type` header of `application/nostr+json+rpc` to a URI supporting WebSocket upgrades, it should parse the request as a JSON document with the following fields: + +```json +{ + "method": "<method-name>", + "params": ["<array>", "<of>", "<parameters>"] +} +``` + +Then it should return a response in the format + +```json +{ + "result": {"<arbitrary>": "<value>"}, + "error": "<optional error message, if the call has errored>" +} +``` + +This is the list of **methods** that may be supported: + +* `supportedmethods`: + - params: `[]` + - result: `["<method-name>", "<method-name>", ...]` (an array with the names of all the other supported methods) +* `banpubkey`: + - params: `["<32-byte-hex-public-key>", "<optional-reason>"]` + - result: `true` (a boolean always set to `true`) +* `listbannedpubkeys`: + - params: `[]` + - result: `[{"pubkey": "<32-byte-hex>", "reason": "<optional-reason>"}, ...]`, an array of objects +* `allowpubkey`: + - params: `["<32-byte-hex-public-key>", "<optional-reason>"]` + - result: `true` (a boolean always set to `true`) +* `listallowedpubkeys`: + - params: `[]` + - result: `[{"pubkey": "<32-byte-hex>", "reason": "<optional-reason>"}, ...]`, an array of objects +* `listeventsneedingmoderation`: + - params: `[]` + - result: `[{"id": "<32-byte-hex>", "reason": "<optional-reason>"}]`, an array of objects +* `allowevent`: + - params: `["<32-byte-hex-event-id>", "<optional-reason>"]` + - result: `true` (a boolean always set to `true`) +* `banevent`: + - params: `["<32-byte-hex-event-id>", "<optional-reason>"]` + - result: `true` (a boolean always set to `true`) +* `listbannedevents`: + - params: `[]` + - result: `[{"id": "<32-byte hex>", "reason": "<optional-reason>"}, ...]`, an array of objects +* `changerelayname`: + - params: `["<new-name>"]` + - result: `true` (a boolean always set to `true`) +* `changerelaydescription`: + - params: `["<new-description>"]` + - result: `true` (a boolean always set to `true`) +* `changerelayicon`: + - params: `["<new-icon-url>"]` + - result: `true` (a boolean always set to `true`) +* `allowkind`: + - params: `[<kind-number>]` + - result: `true` (a boolean always set to `true`) +* `disallowkind`: + - params: `[<kind-number>]` + - result: `true` (a boolean always set to `true`) +* `listallowedkinds`: + - params: `[]` + - result: `[<kind-number>, ...]`, an array of numbers +* `blockip`: + - params: `["<ip-address>", "<optional-reason>"]` + - result: `true` (a boolean always set to `true`) +* `unblockip`: + - params: `["<ip-address>"]` + - result: `true` (a boolean always set to `true`) +* `listblockedips`: + - params: `[]` + - result: `[{"ip": "<ip-address>", "reason": "<optional-reason>"}, ...]`, an array of objects + +### Authorization + +The request must contain an `Authorization` header with a valid [NIP-98](./98.md) event, except the `payload` tag is required. The `u` tag is the relay URL. + +If `Authorization` is not provided or is invalid, the endpoint should return a 401 response. diff --git a/README.md b/README.md index 5d1a47dc..9ef9fec3 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-75: Zap Goals](75.md) - [NIP-78: Application-specific data](78.md) - [NIP-84: Highlights](84.md) +- [NIP-86: Relay Management API](86.md) - [NIP-89: Recommended Application Handlers](89.md) - [NIP-90: Data Vending Machines](90.md) - [NIP-92: Media Attachments](92.md) From 64624a62eac4b2ee3e6b9da34c1aa77a33e20852 Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Fri, 22 Nov 2024 13:58:49 -0800 Subject: [PATCH 303/587] Add r to kind 10009 --- 51.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/51.md b/51.md index 3792d7fe..4c0b1f47 100644 --- a/51.md +++ b/51.md @@ -29,7 +29,7 @@ For example, _mute list_ can contain the public keys of spammers and bad actors | Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) | | Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) | | Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) | -| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group ids + mandatory relay URL) | +| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group id + relay URL), `"r"` for each relay in use | | Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) | | Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | | DM relays | 10050 | Where to receive [NIP-17](17.md) direct messages | `"relay"` (see [NIP-17](17.md)) | From 821614aee1f0d7e6f618c5df6e626ea5981a906b Mon Sep 17 00:00:00 2001 From: Jesus Christ <120573631+Gudnessuche@users.noreply.github.com> Date: Wed, 27 Nov 2024 14:43:00 +0000 Subject: [PATCH 304/587] multi_pay_invoice method Response error (grammatical) The response section that explained how the multi_pay_invoice method worked had a grammatical error of explaining the differentiation between requests. changed ".....contains an d tag" to "...contains a d tag" --- 47.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/47.md b/47.md index 71cd0763..d1030a47 100644 --- a/47.md +++ b/47.md @@ -175,7 +175,7 @@ Request: Response: For every invoice in the request, a separate response event is sent. To differentiate between the responses, each -response event contains an `d` tag with the id of the invoice it is responding to, if no id was given, then the +response event contains a `d` tag with the id of the invoice it is responding to, if no id was given, then the payment hash of the invoice should be used. ```jsonc From 6acf1c780a3fb348c6e5684f9eef3e98ffb3d156 Mon Sep 17 00:00:00 2001 From: stl1988 <35177539+stl1988@users.noreply.github.com> Date: Wed, 27 Nov 2024 23:28:50 +0100 Subject: [PATCH 305/587] Update README.md Add NIP-68 to the list --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 9ef9fec3..d362e6a1 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-61: Nutzaps](61.md) - [NIP-64: Chess (PGN)](64.md) - [NIP-65: Relay List Metadata](65.md) +- [NIP-68: Picture-first feeds](68.md) - [NIP-69: Peer-to-peer Order events](69.md) - [NIP-70: Protected Events](70.md) - [NIP-71: Video Events](71.md) From aa2342bd9da9dcef382fbaf4c73060767b3eeab1 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Thu, 28 Nov 2024 20:24:01 +0900 Subject: [PATCH 306/587] Update BREAKING.md (#1615) --- BREAKING.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/BREAKING.md b/BREAKING.md index b4bd53d7..c7ae2dfe 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -5,6 +5,11 @@ reverse chronological order. | Date | Commit | NIP | Change | | ----------- | --------- | -------- | ------ | +| 2024-11-12 | [2838e3bd](https://github.com/nostr-protocol/nips/commit/2838e3bd) | [NIP-29](29.md) | `kind: 12` and `kind: 10` were removed (use `kind: 1111` instead) | +| 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [NIP-46](46.md) | NIP-05 login was removed | +| 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [NIP-46](46.md) | `create_account` method was removed | +| 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [NIP-46](46.md) | `connect` params and result were changed | +| 2024-10-29 | [f1e8d2c4](https://github.com/nostr-protocol/nips/commit/f1e8d2c4) | [NIP-46](46.md) | bunker URL should use `remote-signer-key` | | 2024-10-15 | [1cda2dcc](https://github.com/nostr-protocol/nips/commit/1cda2dcc) | [NIP-71](71.md) | some tags were replaced with `imeta` tag | | 2024-10-15 | [1cda2dcc](https://github.com/nostr-protocol/nips/commit/1cda2dcc) | [NIP-71](71.md) | `kind: 34237` was dropped | | 2024-10-07 | [7bb8997b](https://github.com/nostr-protocol/nips/commit/7bb8997b) | [NIP-55](55.md) | some fields and passing data were changed | @@ -60,4 +65,3 @@ Breaking changes prior to 2023-03-01 are not yet documented. - If it isn't clear that a change is breaking or not, we list it. - The date is the date it was merged, not necessarily the date of the commit. - From 0352f8487db8046542bbc04ba02e6153d34968be Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Thu, 28 Nov 2024 23:45:47 +0900 Subject: [PATCH 307/587] remove "NIP-" prefixes. --- BREAKING.md | 106 ++++++++++++++++++++++++++-------------------------- 1 file changed, 53 insertions(+), 53 deletions(-) diff --git a/BREAKING.md b/BREAKING.md index c7ae2dfe..40391e05 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -5,59 +5,59 @@ reverse chronological order. | Date | Commit | NIP | Change | | ----------- | --------- | -------- | ------ | -| 2024-11-12 | [2838e3bd](https://github.com/nostr-protocol/nips/commit/2838e3bd) | [NIP-29](29.md) | `kind: 12` and `kind: 10` were removed (use `kind: 1111` instead) | -| 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [NIP-46](46.md) | NIP-05 login was removed | -| 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [NIP-46](46.md) | `create_account` method was removed | -| 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [NIP-46](46.md) | `connect` params and result were changed | -| 2024-10-29 | [f1e8d2c4](https://github.com/nostr-protocol/nips/commit/f1e8d2c4) | [NIP-46](46.md) | bunker URL should use `remote-signer-key` | -| 2024-10-15 | [1cda2dcc](https://github.com/nostr-protocol/nips/commit/1cda2dcc) | [NIP-71](71.md) | some tags were replaced with `imeta` tag | -| 2024-10-15 | [1cda2dcc](https://github.com/nostr-protocol/nips/commit/1cda2dcc) | [NIP-71](71.md) | `kind: 34237` was dropped | -| 2024-10-07 | [7bb8997b](https://github.com/nostr-protocol/nips/commit/7bb8997b) | [NIP-55](55.md) | some fields and passing data were changed | -| 2024-08-18 | [3aff37bd](https://github.com/nostr-protocol/nips/commit/3aff37bd) | [NIP-54](54.md) | content should be Asciidoc | -| 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 | -| 2024-07-30 | [444ad28d](https://github.com/nostr-protocol/nips/commit/444ad28d) | [NIP-45](45.md) | NIP-45 was deprecated | -| 2024-07-26 | [ecee40df](https://github.com/nostr-protocol/nips/commit/ecee40df) | [NIP-19](19.md) | `nrelay` was deprecated | -| 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 | -| 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 | -| 2024-06-06 | [a6dfc7b5](https://github.com/nostr-protocol/nips/commit/a6dfc7b5) | [NIP-55](55.md) | NIP number was changed | -| 2024-05-25 | [5d1d1c17](https://github.com/nostr-protocol/nips/commit/5d1d1c17) | [NIP-71](71.md) | 'aes-256-gcm' tag was removed | -| 2024-05-07 | [8073c848](https://github.com/nostr-protocol/nips/commit/8073c848) | [NIP-25](25.md) | e-tags were changed to not include entire thread | -| 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) | -| 2024-02-25 | [4a171cb0](https://github.com/nostr-protocol/nips/commit/4a171cb0) | [NIP-18](18.md) | quote repost should use `q` tag | -| 2024-02-21 | [c6cd655c](https://github.com/nostr-protocol/nips/commit/c6cd655c) | [NIP-46](46.md) | Params were stringified | -| 2024-02-16 | [cbec02ab](https://github.com/nostr-protocol/nips/commit/cbec02ab) | [NIP-49](49.md) | Password first normalized to NFKC | -| 2024-02-15 | [afbb8dd0](https://github.com/nostr-protocol/nips/commit/afbb8dd0) | [NIP-39](39.md) | PGP identity was removed | -| 2024-02-07 | [d3dad114](https://github.com/nostr-protocol/nips/commit/d3dad114) | [NIP-46](46.md) | Connection token format was changed | -| 2024-01-30 | [1a2b21b6](https://github.com/nostr-protocol/nips/commit/1a2b21b6) | [NIP-59](59.md) | 'p' tag became optional | -| 2023-01-27 | [c2f34817](https://github.com/nostr-protocol/nips/commit/c2f34817) | [NIP-47](47.md) | optional expiration tag should be honored | -| 2024-01-10 | [3d8652ea](https://github.com/nostr-protocol/nips/commit/3d8652ea) | [NIP-02](02.md) | list entries should be chronological | -| 2024-01-10 | [3d8652ea](https://github.com/nostr-protocol/nips/commit/3d8652ea) | [NIP-51](51.md) | list entries should be chronological | -| 2023-12-30 | [29869821](https://github.com/nostr-protocol/nips/commit/29869821) | [NIP-52](52.md) | 'name' tag was removed (use 'title' tag instead) | -| 2023-12-27 | [17c67ef5](https://github.com/nostr-protocol/nips/commit/17c67ef5) | [NIP-94](94.md) | 'aes-256-gcm' tag was removed | -| 2023-12-03 | [0ba45895](https://github.com/nostr-protocol/nips/commit/0ba45895) | [NIP-01](01.md) | WebSocket status code `4000` was replaced by 'CLOSED' message | -| 2023-11-28 | [6de35f9e](https://github.com/nostr-protocol/nips/commit/6de35f9e) | [NIP-89](89.md) | 'client' tag value was changed | -| 2023-11-20 | [7822a8b1](https://github.com/nostr-protocol/nips/commit/7822a8b1) | [NIP-51](51.md) | `kind: 30000` and `kind: 30001` were deprecated | -| 2023-11-11 | [cbdca1e9](https://github.com/nostr-protocol/nips/commit/cbdca1e9) | [NIP-84](84.md) | 'range' tag was removed | -| 2023-11-10 | [c945d8bd](https://github.com/nostr-protocol/nips/commit/c945d8bd) | [NIP-32](32.md) | 'l' tag annotations was removed | -| 2023-11-07 | [108b7f16](https://github.com/nostr-protocol/nips/commit/108b7f16) | [NIP-01](01.md) | 'OK' message must have 4 items | -| 2023-10-17 | [cf672b76](https://github.com/nostr-protocol/nips/commit/cf672b76) | [NIP-03](03.md) | 'block' tag was removed | -| 2023-09-29 | [7dc6385f](https://github.com/nostr-protocol/nips/commit/7dc6385f) | [NIP-57](57.md) | optional 'a' tag was included in `zap receipt` | -| 2023-08-21 | [89915e02](https://github.com/nostr-protocol/nips/commit/89915e02) | [NIP-11](11.md) | 'min_prefix' was removed | -| 2023-08-20 | [37c4375e](https://github.com/nostr-protocol/nips/commit/37c4375e) | [NIP-01](01.md) | replaceable events with same timestamp should be retained event with lowest id | -| 2023-08-15 | [88ee873c](https://github.com/nostr-protocol/nips/commit/88ee873c) | [NIP-15](15.md) | 'countries' tag was renamed to 'regions' | -| 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [NIP-12](12.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | -| 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [NIP-16](16.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | -| 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [NIP-20](20.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | -| 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [NIP-33](33.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | -| 2023-08-11 | [d87f8617](https://github.com/nostr-protocol/nips/commit/d87f8617) | [NIP-25](25.md) | empty `content` should be considered as "+" | -| 2023-08-01 | [5d63b157](https://github.com/nostr-protocol/nips/commit/5d63b157) | [NIP-57](57.md) | 'zap' tag was changed | -| 2023-07-15 | [d1814405](https://github.com/nostr-protocol/nips/commit/d1814405) | [NIP-01](01.md) | `since` and `until` filters should be `since <= created_at <= until` | -| 2023-07-12 | [a1cd2bd8](https://github.com/nostr-protocol/nips/commit/a1cd2bd8) | [NIP-25](25.md) | custom emoji was supported | -| 2023-06-18 | [83cbd3e1](https://github.com/nostr-protocol/nips/commit/83cbd3e1) | [NIP-11](11.md) | 'image' was renamed to 'icon' | -| 2023-04-13 | [bf0a0da6](https://github.com/nostr-protocol/nips/commit/bf0a0da6) | [NIP-15](15.md) | different NIP was re-added as NIP-15 | -| 2023-04-09 | [fb5b7c73](https://github.com/nostr-protocol/nips/commit/fb5b7c73) | [NIP-15](15.md) | NIP-15 was merged into NIP-01 | -| 2023-03-29 | [599e1313](https://github.com/nostr-protocol/nips/commit/599e1313) | [NIP-18](18.md) | NIP-18 was bring back | -| 2023-03-15 | [e1004d3d](https://github.com/nostr-protocol/nips/commit/e1004d3d) | [NIP-19](19.md) | `1: relay` was changed to optionally | +| 2024-11-12 | [2838e3bd](https://github.com/nostr-protocol/nips/commit/2838e3bd) | [29](29.md) | `kind: 12` and `kind: 10` were removed (use `kind: 1111` instead) | +| 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [46](46.md) | NIP-05 login was removed | +| 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [46](46.md) | `create_account` method was removed | +| 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [46](46.md) | `connect` params and result were changed | +| 2024-10-29 | [f1e8d2c4](https://github.com/nostr-protocol/nips/commit/f1e8d2c4) | [46](46.md) | bunker URL should use `remote-signer-key` | +| 2024-10-15 | [1cda2dcc](https://github.com/nostr-protocol/nips/commit/1cda2dcc) | [71](71.md) | some tags were replaced with `imeta` tag | +| 2024-10-15 | [1cda2dcc](https://github.com/nostr-protocol/nips/commit/1cda2dcc) | [71](71.md) | `kind: 34237` was dropped | +| 2024-10-07 | [7bb8997b](https://github.com/nostr-protocol/nips/commit/7bb8997b) | [55](55.md) | some fields and passing data were changed | +| 2024-08-18 | [3aff37bd](https://github.com/nostr-protocol/nips/commit/3aff37bd) | [54](54.md) | content should be Asciidoc | +| 2024-07-31 | [3ea2f1a4](https://github.com/nostr-protocol/nips/commit/3ea2f1a4) | [45](45.md) | [444ad28d](https://github.com/nostr-protocol/nips/commit/444ad28d) was reverted | +| 2024-07-30 | [444ad28d](https://github.com/nostr-protocol/nips/commit/444ad28d) | [45](45.md) | NIP-45 was deprecated | +| 2024-07-26 | [ecee40df](https://github.com/nostr-protocol/nips/commit/ecee40df) | [19](19.md) | `nrelay` was deprecated | +| 2024-07-23 | [0227a2cd](https://github.com/nostr-protocol/nips/commit/0227a2cd) | [01](01.md) | events should be sorted by id after created_at | +| 2024-06-06 | [58e94b20](https://github.com/nostr-protocol/nips/commit/58e94b20) | [25](25.md) | [8073c848](https://github.com/nostr-protocol/nips/commit/8073c848) was reverted | +| 2024-06-06 | [a6dfc7b5](https://github.com/nostr-protocol/nips/commit/a6dfc7b5) | [55](55.md) | NIP number was changed | +| 2024-05-25 | [5d1d1c17](https://github.com/nostr-protocol/nips/commit/5d1d1c17) | [71](71.md) | 'aes-256-gcm' tag was removed | +| 2024-05-07 | [8073c848](https://github.com/nostr-protocol/nips/commit/8073c848) | [25](25.md) | e-tags were changed to not include entire thread | +| 2024-04-30 | [bad88262](https://github.com/nostr-protocol/nips/commit/bad88262) | [34](34.md) | 'earliest-unique-commit' tag was removed (use 'r' tag instead) | +| 2024-02-25 | [4a171cb0](https://github.com/nostr-protocol/nips/commit/4a171cb0) | [18](18.md) | quote repost should use `q` tag | +| 2024-02-21 | [c6cd655c](https://github.com/nostr-protocol/nips/commit/c6cd655c) | [46](46.md) | Params were stringified | +| 2024-02-16 | [cbec02ab](https://github.com/nostr-protocol/nips/commit/cbec02ab) | [49](49.md) | Password first normalized to NFKC | +| 2024-02-15 | [afbb8dd0](https://github.com/nostr-protocol/nips/commit/afbb8dd0) | [39](39.md) | PGP identity was removed | +| 2024-02-07 | [d3dad114](https://github.com/nostr-protocol/nips/commit/d3dad114) | [46](46.md) | Connection token format was changed | +| 2024-01-30 | [1a2b21b6](https://github.com/nostr-protocol/nips/commit/1a2b21b6) | [59](59.md) | 'p' tag became optional | +| 2023-01-27 | [c2f34817](https://github.com/nostr-protocol/nips/commit/c2f34817) | [47](47.md) | optional expiration tag should be honored | +| 2024-01-10 | [3d8652ea](https://github.com/nostr-protocol/nips/commit/3d8652ea) | [02](02.md) | list entries should be chronological | +| 2024-01-10 | [3d8652ea](https://github.com/nostr-protocol/nips/commit/3d8652ea) | [51](51.md) | list entries should be chronological | +| 2023-12-30 | [29869821](https://github.com/nostr-protocol/nips/commit/29869821) | [52](52.md) | 'name' tag was removed (use 'title' tag instead) | +| 2023-12-27 | [17c67ef5](https://github.com/nostr-protocol/nips/commit/17c67ef5) | [94](94.md) | 'aes-256-gcm' tag was removed | +| 2023-12-03 | [0ba45895](https://github.com/nostr-protocol/nips/commit/0ba45895) | [01](01.md) | WebSocket status code `4000` was replaced by 'CLOSED' message | +| 2023-11-28 | [6de35f9e](https://github.com/nostr-protocol/nips/commit/6de35f9e) | [89](89.md) | 'client' tag value was changed | +| 2023-11-20 | [7822a8b1](https://github.com/nostr-protocol/nips/commit/7822a8b1) | [51](51.md) | `kind: 30000` and `kind: 30001` were deprecated | +| 2023-11-11 | [cbdca1e9](https://github.com/nostr-protocol/nips/commit/cbdca1e9) | [84](84.md) | 'range' tag was removed | +| 2023-11-10 | [c945d8bd](https://github.com/nostr-protocol/nips/commit/c945d8bd) | [32](32.md) | 'l' tag annotations was removed | +| 2023-11-07 | [108b7f16](https://github.com/nostr-protocol/nips/commit/108b7f16) | [01](01.md) | 'OK' message must have 4 items | +| 2023-10-17 | [cf672b76](https://github.com/nostr-protocol/nips/commit/cf672b76) | [03](03.md) | 'block' tag was removed | +| 2023-09-29 | [7dc6385f](https://github.com/nostr-protocol/nips/commit/7dc6385f) | [57](57.md) | optional 'a' tag was included in `zap receipt` | +| 2023-08-21 | [89915e02](https://github.com/nostr-protocol/nips/commit/89915e02) | [11](11.md) | 'min_prefix' was removed | +| 2023-08-20 | [37c4375e](https://github.com/nostr-protocol/nips/commit/37c4375e) | [01](01.md) | replaceable events with same timestamp should be retained event with lowest id | +| 2023-08-15 | [88ee873c](https://github.com/nostr-protocol/nips/commit/88ee873c) | [15](15.md) | 'countries' tag was renamed to 'regions' | +| 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [12](12.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | +| 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [16](16.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | +| 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [20](20.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | +| 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [33](33.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | +| 2023-08-11 | [d87f8617](https://github.com/nostr-protocol/nips/commit/d87f8617) | [25](25.md) | empty `content` should be considered as "+" | +| 2023-08-01 | [5d63b157](https://github.com/nostr-protocol/nips/commit/5d63b157) | [57](57.md) | 'zap' tag was changed | +| 2023-07-15 | [d1814405](https://github.com/nostr-protocol/nips/commit/d1814405) | [01](01.md) | `since` and `until` filters should be `since <= created_at <= until` | +| 2023-07-12 | [a1cd2bd8](https://github.com/nostr-protocol/nips/commit/a1cd2bd8) | [25](25.md) | custom emoji was supported | +| 2023-06-18 | [83cbd3e1](https://github.com/nostr-protocol/nips/commit/83cbd3e1) | [11](11.md) | 'image' was renamed to 'icon' | +| 2023-04-13 | [bf0a0da6](https://github.com/nostr-protocol/nips/commit/bf0a0da6) | [15](15.md) | different NIP was re-added as NIP-15 | +| 2023-04-09 | [fb5b7c73](https://github.com/nostr-protocol/nips/commit/fb5b7c73) | [15](15.md) | NIP-15 was merged into NIP-01 | +| 2023-03-29 | [599e1313](https://github.com/nostr-protocol/nips/commit/599e1313) | [18](18.md) | NIP-18 was bring back | +| 2023-03-15 | [e1004d3d](https://github.com/nostr-protocol/nips/commit/e1004d3d) | [19](19.md) | `1: relay` was changed to optionally | Breaking changes prior to 2023-03-01 are not yet documented. From 2ffd8ec36360512c5f5087519b667434b4dc7832 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=B0=8F=E5=8E=9F=E6=99=B4=E5=A4=AA?= <haruta@s3-odara.net> Date: Fri, 29 Nov 2024 14:40:11 +0000 Subject: [PATCH 308/587] use example domain --- 46.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/46.md b/46.md index 824059c1..7f8859f6 100644 --- a/46.md +++ b/46.md @@ -213,7 +213,7 @@ _remote-signer_ MAY publish it's metadata by using [NIP-05](05.md) and [NIP-89]( }, "nip46": { "relays": ["wss://relay1","wss://relay2"...], - "nostrconnect_url": "https://remote-signer-domain.com/<nostrconnect>" + "nostrconnect_url": "https://remote-signer-domain.example/<nostrconnect>" } } ``` From fe1fe75caecfaaf0dcd675fb706a91347c9b3c80 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Sat, 30 Nov 2024 15:57:50 +0900 Subject: [PATCH 309/587] mark kind 30001 as deprecated. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d362e6a1..61fdbe8e 100644 --- a/README.md +++ b/README.md @@ -183,7 +183,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `24242` | Blobs stored on mediaservers | [Blossom][blossom] | | `27235` | HTTP Auth | [98](98.md) | | `30000` | Follow sets | [51](51.md) | -| `30001` | Generic lists | [51](51.md) | +| `30001` | Generic lists | 51 (deprecated) | | `30002` | Relay sets | [51](51.md) | | `30003` | Bookmark sets | [51](51.md) | | `30004` | Curation sets | [51](51.md) | From 54c0c1352d73595b99b568248b87fe4542d30141 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Sun, 1 Dec 2024 00:15:39 +0900 Subject: [PATCH 310/587] BREAKING.md: fix change of 7822a8b1 --- BREAKING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/BREAKING.md b/BREAKING.md index 40391e05..39be5a0f 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -36,7 +36,8 @@ reverse chronological order. | 2023-12-27 | [17c67ef5](https://github.com/nostr-protocol/nips/commit/17c67ef5) | [94](94.md) | 'aes-256-gcm' tag was removed | | 2023-12-03 | [0ba45895](https://github.com/nostr-protocol/nips/commit/0ba45895) | [01](01.md) | WebSocket status code `4000` was replaced by 'CLOSED' message | | 2023-11-28 | [6de35f9e](https://github.com/nostr-protocol/nips/commit/6de35f9e) | [89](89.md) | 'client' tag value was changed | -| 2023-11-20 | [7822a8b1](https://github.com/nostr-protocol/nips/commit/7822a8b1) | [51](51.md) | `kind: 30000` and `kind: 30001` were deprecated | +| 2023-11-20 | [7822a8b1](https://github.com/nostr-protocol/nips/commit/7822a8b1) | [51](51.md) | `kind: 30001` was deprecated | +| 2023-11-20 | [7822a8b1](https://github.com/nostr-protocol/nips/commit/7822a8b1) | [51](51.md) | the meaning of `kind: 30000` was changed | | 2023-11-11 | [cbdca1e9](https://github.com/nostr-protocol/nips/commit/cbdca1e9) | [84](84.md) | 'range' tag was removed | | 2023-11-10 | [c945d8bd](https://github.com/nostr-protocol/nips/commit/c945d8bd) | [32](32.md) | 'l' tag annotations was removed | | 2023-11-07 | [108b7f16](https://github.com/nostr-protocol/nips/commit/108b7f16) | [01](01.md) | 'OK' message must have 4 items | From 33efff81a6909da9a85e81d296a711810f1848a1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=B0=8F=E5=8E=9F=E6=99=B4=E5=A4=AA?= <haruta@s3-odara.net> Date: Wed, 4 Dec 2024 14:30:42 +0000 Subject: [PATCH 311/587] NIP-44: Proper base64 explanation "Encoding algorithm" instead of "compression algorithm" --- 44.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/44.md b/44.md index 8f781b85..b70acb2b 100644 --- a/44.md +++ b/44.md @@ -63,7 +63,7 @@ NIP-44 version 2 has the following design characteristics: - SHA256 is used instead of SHA3 or BLAKE because it is already used in nostr. Also BLAKE's speed advantage is smaller in non-parallel environments. - A custom padding scheme is used instead of padmé because it provides better leakage reduction for small messages. -- Base64 encoding is used instead of another compression algorithm because it is widely available, and is already used in nostr. +- Base64 encoding is used instead of another encoding algorithm because it is widely available, and is already used in nostr. ### Encryption From 2776a2aa143e88295421bfc960e12adfcae5f8f8 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Fri, 6 Dec 2024 00:58:50 +0900 Subject: [PATCH 312/587] add `P` tag to README. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 61fdbe8e..9107bd79 100644 --- a/README.md +++ b/README.md @@ -282,6 +282,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `L` | label namespace | -- | [32](32.md) | | `m` | MIME type | -- | [94](94.md) | | `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | +| `P` | pubkey (hex) | -- | [57](57.md) | | `q` | event id (hex) | relay URL, pubkey (hex) | [18](18.md) | | `r` | a reference (URL, etc) | -- | [24](24.md), [25](25.md) | | `r` | relay url | marker | [65](65.md) | From 6d16019e9e98807b23b7ae1faf5edeead7ddee7a Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Thu, 5 Dec 2024 16:59:18 -0300 Subject: [PATCH 313/587] nip46: abandon nip04 entirely and just use nip44. --- 46.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/46.md b/46.md index 7f8859f6..d1706285 100644 --- a/46.md +++ b/46.md @@ -72,12 +72,12 @@ _user_ passes this token to _remote-signer_, which then sends `connect` *respons { "kind": 24133, "pubkey": <local_keypair_pubkey>, - "content": <nip04(<request>)>, + "content": <nip44(<request>)>, "tags": [["p", <remote-signer-pubkey>]], } ``` -The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted and has the following structure: +The `content` field is a JSON-RPC-like message that is [NIP-44](44.md) encrypted and has the following structure: ```jsonc { @@ -109,7 +109,7 @@ Each of the following are methods that the _client_ sends to the _remote-signer_ ### Requested permissions -The `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. Same permission format may be used for `perms` field of `metadata` in `nostrconnect://` string. +The `connect` method may be provided with `optional_requested_permissions` for user convenience. The permissions are a comma-separated list of `method[:params]`, i.e. `nip44_encrypt,sign_event:4` meaning permissions to call `nip44_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. Same permission format may be used for `perms` field of `metadata` in `nostrconnect://` string. ## Response Events `kind:24133` @@ -118,13 +118,13 @@ The `connect` method may be provided with `optional_requested_permissions` for u "id": <id>, "kind": 24133, "pubkey": <remote-signer-pubkey>, - "content": <nip04(<response>)>, + "content": <nip44(<response>)>, "tags": [["p", <client-pubkey>]], "created_at": <unix timestamp in seconds> } ``` -The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted and has the following structure: +The `content` field is a JSON-RPC-like message that is [NIP-44](44.md) encrypted and has the following structure: ```json { @@ -150,7 +150,7 @@ The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted { "kind": 24133, "pubkey": "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86", - "content": nip04({ + "content": nip44({ "id": <random_string>, "method": "sign_event", "params": [json_stringified(<{ @@ -170,7 +170,7 @@ The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted { "kind": 24133, "pubkey": "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", - "content": nip04({ + "content": nip44({ "id": <random_string>, "result": json_stringified(<signed-event>) }), @@ -224,4 +224,4 @@ The `<remote-signer-app-pubkey>` MAY be used to verify the domain from _remote-s _remote-signer_ MAY publish a NIP-89 `kind: 31990` event with `k` tag of `24133`, which MAY also include one or more `relay` tags and MAY include `nostrconnect_url` tag. The semantics of `relay` and `nostrconnect_url` tags are the same as in the section above. -_client_ MAY improve UX by discovering _remote-signers_ using their `kind: 31990` events. _client_ MAY then pre-generate `nostrconnect://` strings for the _remote-signers_, and SHOULD in that case verify that `kind: 31990` event's author is mentioned in signer's `nostr.json?name=_` file as `<remote-signer-app-pubkey>`. +_client_ MAY improve UX by discovering _remote-signers_ using their `kind: 31990` events. _client_ MAY then pre-generate `nostrconnect://` strings for the _remote-signers_, and SHOULD in that case verify that `kind: 31990` event's author is mentioned in signer's `nostr.json?name=_` file as `<remote-signer-app-pubkey>`. From a92d2e2edd3251067ab8787ecf10ee2dffe2b85f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=B0=8F=E5=8E=9F=E6=99=B4=E5=A4=AA?= <haruta@s3-odara.net> Date: Fri, 6 Dec 2024 11:26:23 +0000 Subject: [PATCH 314/587] Clarify the units --- 44.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/44.md b/44.md index b70acb2b..8f27fede 100644 --- a/44.md +++ b/44.md @@ -86,7 +86,7 @@ NIP-44 version 2 has the following design characteristics: - Content must be encoded from UTF-8 into byte array - Validate plaintext length. Minimum is 1 byte, maximum is 65535 bytes - Padding format is: `[plaintext_length: u16][plaintext][zero_bytes]` - - Padding algorithm is related to powers-of-two, with min padded msg size of 32 + - Padding algorithm is related to powers-of-two, with min padded msg size of 32bytes - Plaintext length is encoded in big-endian as first 2 bytes of the padded blob 5. Encrypt padded content - Use ChaCha20, with key and nonce from step 3 @@ -148,8 +148,8 @@ validation rules, refer to BIP-340. - `x[i:j]`, where `x` is a byte array and `i, j <= 0` returns a `(j - i)`-byte array with a copy of the `i`-th byte (inclusive) to the `j`-th byte (exclusive) of `x`. - Constants `c`: - - `min_plaintext_size` is 1. 1b msg is padded to 32b. - - `max_plaintext_size` is 65535 (64kb - 1). It is padded to 65536. + - `min_plaintext_size` is 1. 1bytes msg is padded to 32bytes. + - `max_plaintext_size` is 65535 (64kB - 1). It is padded to 65536bytes. - Functions - `base64_encode(string)` and `base64_decode(bytes)` are Base64 ([RFC 4648](https://datatracker.ietf.org/doc/html/rfc4648), with padding) - `concat` refers to byte array concatenation From 936616b3c00c83679496ca610910901968917859 Mon Sep 17 00:00:00 2001 From: mono <102149418+TsukemonoGit@users.noreply.github.com> Date: Sat, 7 Dec 2024 07:43:52 +0900 Subject: [PATCH 315/587] Update README.md add Event Kinds kind:20 Picture-first feeds --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 9107bd79..34dfc1b2 100644 --- a/README.md +++ b/README.md @@ -119,6 +119,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `14` | Direct Message | [17](17.md) | | `16` | Generic Repost | [18](18.md) | | `17` | Reaction to a website | [25](25.md) | +| `20` | Picture-first feeds | [68](68.md) | | `40` | Channel Creation | [28](28.md) | | `41` | Channel Metadata | [28](28.md) | | `42` | Channel Message | [28](28.md) | From a2be191ecd0b882ed388a564b5e57b1ca25cbdb4 Mon Sep 17 00:00:00 2001 From: mono <102149418+TsukemonoGit@users.noreply.github.com> Date: Sat, 7 Dec 2024 07:45:25 +0900 Subject: [PATCH 316/587] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 34dfc1b2..eb6fd94a 100644 --- a/README.md +++ b/README.md @@ -119,7 +119,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `14` | Direct Message | [17](17.md) | | `16` | Generic Repost | [18](18.md) | | `17` | Reaction to a website | [25](25.md) | -| `20` | Picture-first feeds | [68](68.md) | +| `20` | Picture | [68](68.md) | | `40` | Channel Creation | [28](28.md) | | `41` | Channel Metadata | [28](28.md) | | `42` | Channel Message | [28](28.md) | From b04922586ead1a0009716b86cc97d4790a5657d0 Mon Sep 17 00:00:00 2001 From: Jesus Christ <120573631+Gudnessuche@users.noreply.github.com> Date: Sun, 8 Dec 2024 12:34:34 +0000 Subject: [PATCH 317/587] Update 90.md Added a period to show the end of "Protocol Flow" explanation --- 90.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/90.md b/90.md index 696ebd59..1d69b0ff 100644 --- a/90.md +++ b/90.md @@ -185,7 +185,7 @@ Any job feedback event MIGHT include results in the `.content` field, as describ * Customer publishes a job request (e.g. `kind:5000` speech-to-text). * Service Providers MAY submit `kind:7000` job-feedback events (e.g. `payment-required`, `processing`, `error`, etc.). * Upon completion, the service provider publishes the result of the job with a `kind:6000` job-result event. -* At any point, if there is an `amount` pending to be paid as instructed by the service provider, the user can pay the included `bolt11` or zap the job result event the service provider has sent to the user +* At any point, if there is an `amount` pending to be paid as instructed by the service provider, the user can pay the included `bolt11` or zap the job result event the service provider has sent to the user. Job feedback (`kind:7000`) and Job Results (`kind:6000-6999`) events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers MUST use the `payment-required` feedback event to signal that a payment is required and no further actions will be performed until the payment is sent. From d71887a8e29821212f765b3cdf69c25df1415271 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Mon, 9 Dec 2024 13:19:16 +0900 Subject: [PATCH 318/587] BREAKING.md: merge duplicate lines --- BREAKING.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/BREAKING.md b/BREAKING.md index 39be5a0f..f083ca0e 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -30,8 +30,7 @@ reverse chronological order. | 2024-02-07 | [d3dad114](https://github.com/nostr-protocol/nips/commit/d3dad114) | [46](46.md) | Connection token format was changed | | 2024-01-30 | [1a2b21b6](https://github.com/nostr-protocol/nips/commit/1a2b21b6) | [59](59.md) | 'p' tag became optional | | 2023-01-27 | [c2f34817](https://github.com/nostr-protocol/nips/commit/c2f34817) | [47](47.md) | optional expiration tag should be honored | -| 2024-01-10 | [3d8652ea](https://github.com/nostr-protocol/nips/commit/3d8652ea) | [02](02.md) | list entries should be chronological | -| 2024-01-10 | [3d8652ea](https://github.com/nostr-protocol/nips/commit/3d8652ea) | [51](51.md) | list entries should be chronological | +| 2024-01-10 | [3d8652ea](https://github.com/nostr-protocol/nips/commit/3d8652ea) | [02](02.md), [51](51.md) | list entries should be chronological | | 2023-12-30 | [29869821](https://github.com/nostr-protocol/nips/commit/29869821) | [52](52.md) | 'name' tag was removed (use 'title' tag instead) | | 2023-12-27 | [17c67ef5](https://github.com/nostr-protocol/nips/commit/17c67ef5) | [94](94.md) | 'aes-256-gcm' tag was removed | | 2023-12-03 | [0ba45895](https://github.com/nostr-protocol/nips/commit/0ba45895) | [01](01.md) | WebSocket status code `4000` was replaced by 'CLOSED' message | @@ -46,10 +45,7 @@ reverse chronological order. | 2023-08-21 | [89915e02](https://github.com/nostr-protocol/nips/commit/89915e02) | [11](11.md) | 'min_prefix' was removed | | 2023-08-20 | [37c4375e](https://github.com/nostr-protocol/nips/commit/37c4375e) | [01](01.md) | replaceable events with same timestamp should be retained event with lowest id | | 2023-08-15 | [88ee873c](https://github.com/nostr-protocol/nips/commit/88ee873c) | [15](15.md) | 'countries' tag was renamed to 'regions' | -| 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [12](12.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | -| 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [16](16.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | -| 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [20](20.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | -| 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [33](33.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | +| 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [12](12.md), [16](16.md), [20](20.md), [33](33.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | | 2023-08-11 | [d87f8617](https://github.com/nostr-protocol/nips/commit/d87f8617) | [25](25.md) | empty `content` should be considered as "+" | | 2023-08-01 | [5d63b157](https://github.com/nostr-protocol/nips/commit/5d63b157) | [57](57.md) | 'zap' tag was changed | | 2023-07-15 | [d1814405](https://github.com/nostr-protocol/nips/commit/d1814405) | [01](01.md) | `since` and `until` filters should be `since <= created_at <= until` | From b94ad00ac7da6f4d54f1920c824487410fa904b7 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Mon, 9 Dec 2024 13:29:10 +0900 Subject: [PATCH 319/587] BREAKING.md: add NIP-46 change --- BREAKING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/BREAKING.md b/BREAKING.md index f083ca0e..77900d33 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -5,6 +5,7 @@ reverse chronological order. | Date | Commit | NIP | Change | | ----------- | --------- | -------- | ------ | +| 2024-12-05 | [6d16019e](https://github.com/nostr-protocol/nips/commit/6d16019e) | [46](46.md) | message encryption was changed to NIP-44 | | 2024-11-12 | [2838e3bd](https://github.com/nostr-protocol/nips/commit/2838e3bd) | [29](29.md) | `kind: 12` and `kind: 10` were removed (use `kind: 1111` instead) | | 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [46](46.md) | NIP-05 login was removed | | 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [46](46.md) | `create_account` method was removed | From 624b989f9f3b0c07d338ec42765351c24f2123cf Mon Sep 17 00:00:00 2001 From: Josh Brown <josh@nos.social> Date: Mon, 9 Dec 2024 10:00:04 -0500 Subject: [PATCH 320/587] clarify that Standard lists and Sets are both types of lists with heading level --- 51.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/51.md b/51.md index 4c0b1f47..90b56ce5 100644 --- a/51.md +++ b/51.md @@ -14,7 +14,7 @@ When new items are added to an existing list, clients SHOULD append them to the ## Types of lists -## Standard lists +### Standard lists Standard 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. @@ -36,7 +36,7 @@ For example, _mute list_ can contain the public keys of spammers and bad actors | Good wiki authors | 10101 | [NIP-54](54.md) user recommended wiki authors | `"p"` (pubkeys) | | Good wiki relays | 10102 | [NIP-54](54.md) relays deemed to only host useful articles | `"relay"` (relay URLs) | -## Sets +### Sets Sets are lists with well-defined meaning that can enhance the functionality and the UI of clients that rely on them. Unlike standard lists, users are expected to have more than one set of each kind, therefore each of them must be assigned a different `"d"` identifier. @@ -56,7 +56,7 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti | Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | | 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"` | -## Deprecated standard lists +### Deprecated standard lists Some clients have used these lists in the past, but they should work on transitioning to the [standard formats](#standard-lists) above. From e942427f8fcf316f4ade52838005910a650270af Mon Sep 17 00:00:00 2001 From: Jesus Christ <120573631+Gudnessuche@users.noreply.github.com> Date: Mon, 9 Dec 2024 15:13:59 +0000 Subject: [PATCH 321/587] nip17: specify order (#1637) Order specificity is implied better. --- 17.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/17.md b/17.md index 72f40c47..f091a969 100644 --- a/17.md +++ b/17.md @@ -133,7 +133,7 @@ When sending a message to anyone, clients must then connect to the relays in the This example sends the message `Hola, que tal?` from `nsec1w8udu59ydjvedgs3yv5qccshcj8k05fh3l60k9x57asjrqdpa00qkmr89m` to `nsec12ywtkplvyq5t6twdqwwygavp5lm4fhuang89c943nf2z92eez43szvn4dt`. -The two final GiftWraps, one to the receiver and the other to the sender, are: +The two final GiftWraps, one to the receiver and the other to the sender, respectively, are: ```json { From ed128aef46306dc390b9dfb8efc2e7ea9815d344 Mon Sep 17 00:00:00 2001 From: franzap <_@franzap.com> Date: Tue, 10 Dec 2024 15:02:54 -0300 Subject: [PATCH 322/587] App curation sets, minor fixes to release artifact sets --- 51.md | 32 +++++++++++++++++++++++++------- 1 file changed, 25 insertions(+), 7 deletions(-) diff --git a/51.md b/51.md index 90b56ce5..d762499e 100644 --- a/51.md +++ b/51.md @@ -54,7 +54,8 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti | Kind mute sets | 30007 | mute pubkeys by kinds<br>`"d"` tag MUST be the kind string | `"p"` (pubkeys) | | Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) | | Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | -| 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"` | +| Release artifact sets | 30063 | group of artifacts of a software release | `"e"` (kind:1063 [file metadata](94.md) events), `"a"` (software application event) | +| App curation sets | 30267 | references to multiple software applications | `"a"` (software application event) | ### Deprecated standard lists @@ -117,22 +118,39 @@ Some clients have used these lists in the past, but they should work on transiti "pubkey": "d6dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c", "created_at": 1695327657, "kind": 30063, + "content": "Release notes in markdown", "tags": [ - ["d", "ak8dy3v7"], - ["i", "com.example.app"], - ["version", "0.0.1"], - ["title", "Example App"], - ["image", "http://cdn.site/p/com.example.app/icon.png"], + ["d", "com.example.app@0.0.1"], ["e", "d78ba0d5dce22bfff9db0a9e996c9ef27e2c91051de0c4e1da340e0326b4941e"], // Windows exe ["e", "f27e2c91051de0c4e1da0d5dce22bfff9db0a9340e0326b4941ed78bae996c9e"], // MacOS dmg ["e", "9d24ddfab95ba3ff7c03fbd07ad011fff245abea431fb4d3787c2d04aad02332"], // Linux AppImage - ["e", "340e0326b340e0326b4941ed78ba340e0326b4941ed78ba340e0326b49ed78ba"] // PWA + ["e", "340e0326b340e0326b4941ed78ba340e0326b4941ed78ba340e0326b49ed78ba"], // PWA + ["a", "32267:d6dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:com.example.app"] // Reference to parent software application ], "content": "Example App is a decentralized marketplace for apps", "sig": "a9a4e2192eede77e6c9d24ddfab95ba3ff7c03fbd07ad011fff245abea431fb4d3787c2d04aad001cb039cb8de91d83ce30e9a94f82ac3c5a2372aa1294a96bd" } ``` +### An _app curation set_ + +```jsonc +{ + "id": "d8037fa866eb5acd2159960b3ada7284172f7d687b5289cc72a96ca2b431b611", + "pubkey": "78ce6faa72264387284e647ba6938995735ec8c7d5c5a65737e55130f026307d", + "sig": "c1ce0a04521c020ae7485307cd86285530c1f778766a3fd594d662a73e7c28f307d7cd9a9ab642ae749fce62abbabb3a32facfe8d19a21fba551b60fae863d95", + "kind": 30267, + "created_at": 1729302793, + "content": "My nostr app selection", + "tags": [ + ["d", "nostr"], + ["a", "32267:7579076d9aff0a4cfdefa7e2045f2486c7e5d8bc63bfc6b45397233e1bbfcb19:com.example.app1"], + ["a", "32267:045f2486c7e5d8bc63bfc6b45397233e1bbfcb197579076d9aff0a4cfdefa7e2:net.example.app2"], + ["a", "32267:264387284e647ba6938995735ec8c7d5c5a6f026307d78ce6faa725737e55130:pl.code.app3"] + ] +} +``` + ## Encryption process pseudocode ```scala From a1ca7a194b6d8f249b7437c0082682c2a7c074ab Mon Sep 17 00:00:00 2001 From: Jon Staab <shtaab@gmail.com> Date: Tue, 10 Dec 2024 14:11:43 -0800 Subject: [PATCH 323/587] Change strategy for naming groups --- 29.md | 4 ++-- 51.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/29.md b/29.md index 331047f7..8711cc94 100644 --- a/29.md +++ b/29.md @@ -30,8 +30,6 @@ When encountering just the `<host>` without the `'<group-id>`, clients MAY infer Events 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_. -`h` tags MAY include the group's name as the second argument. This allows `unmanaged` groups to be assigned human-readable names without relay support. - ## Timeline references In order to not be used out of context, events sent to these groups may contain references to previous events seen from the same relay in the `previous` tag. The choice of which previous events to pick belongs to the clients. The references are to be made using the first 8 characters (4 bytes) of any event in the last 50 events seen by the user in the relay, excluding events by themselves. There can be any number of references (including zero), but it's recommended that clients include at least 3 and that relays enforce this. @@ -242,3 +240,5 @@ A definition for `kind:10009` was included in [NIP-51](51.md) that allows client ### Using `unmanaged` relays To prevent event leakage, 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. + +Groups MAY be named without relay support by adding a `name` to the corresponding tag in a user's `kind 10009` group list. diff --git a/51.md b/51.md index 90b56ce5..23d5b999 100644 --- a/51.md +++ b/51.md @@ -29,7 +29,7 @@ For example, _mute list_ can contain the public keys of spammers and bad actors | Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) | | Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) | | Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) | -| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group id + relay URL), `"r"` for each relay in use | +| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group id + relay URL + optional group name), `"r"` for each relay in use | | Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) | | Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | | DM relays | 10050 | Where to receive [NIP-17](17.md) direct messages | `"relay"` (see [NIP-17](17.md)) | From 306be43fabf7a95b3eef9d5363e1c3411055337f Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Thu, 19 Dec 2024 10:16:57 -0500 Subject: [PATCH 324/587] removes new line --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index f203edd5..55de8422 100644 --- a/README.md +++ b/README.md @@ -231,7 +231,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `39000-9` | Group metadata events | [29](29.md) | [NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/ - [nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md [lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md [cornychat-slideset]: https://cornychat.com/datatypes#kind30388slideset From 97bf5266d7760094ec55a66fe18d549de385768b Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Fri, 20 Dec 2024 09:11:37 +0900 Subject: [PATCH 325/587] add kind 10013 to list. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 55de8422..e71a13e7 100644 --- a/README.md +++ b/README.md @@ -170,6 +170,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10006` | Blocked relays list | [51](51.md) | | `10007` | Search relays list | [51](51.md) | | `10009` | User groups | [51](51.md), [29](29.md) | +| `10013` | Draft relays | [37](37.md) | | `10015` | Interests list | [51](51.md) | | `10019` | Nutzap Mint Recommendation | [61](61.md) | | `10030` | User emoji list | [51](51.md) | From 7e150faed4ccadfdcdc81265a406c4b6cdd39047 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Sat, 21 Dec 2024 01:34:43 +0900 Subject: [PATCH 326/587] nip44: update some nits. --- 44.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/44.md b/44.md index 8f27fede..a7c13f12 100644 --- a/44.md +++ b/44.md @@ -8,11 +8,11 @@ Encrypted Payloads (Versioned) The NIP introduces a new data format for keypair-based encryption. This NIP is versioned to allow multiple algorithm choices to exist simultaneously. This format may be used for -many things, but MUST be used in the context of a signed event as described in NIP 01. +many things, but MUST be used in the context of a signed event as described in NIP-01. *Note*: this format DOES NOT define any `kind`s related to a new direct messaging standard, only the encryption required to define one. It SHOULD NOT be used as a drop-in replacement -for NIP 04 payloads. +for NIP-04 payloads. ## Versions @@ -41,7 +41,7 @@ On its own, messages sent using this scheme have a number of important shortcomi - No post-compromise security: when a key is compromised, it is possible to decrypt all future conversations - No post-quantum security: a powerful quantum computer would be able to decrypt the messages - IP address leak: user IP may be seen by relays and all intermediaries between user and relay -- Date leak: `created_at` is public, since it is a part of NIP 01 event +- Date leak: `created_at` is public, since it is a part of NIP-01 event - Limited message size leak: padding only partially obscures true message length - No attachments: they are not supported @@ -86,7 +86,7 @@ NIP-44 version 2 has the following design characteristics: - Content must be encoded from UTF-8 into byte array - Validate plaintext length. Minimum is 1 byte, maximum is 65535 bytes - Padding format is: `[plaintext_length: u16][plaintext][zero_bytes]` - - Padding algorithm is related to powers-of-two, with min padded msg size of 32bytes + - Padding algorithm is related to powers-of-two, with min padded msg size of 32 bytes - Plaintext length is encoded in big-endian as first 2 bytes of the padded blob 5. Encrypt padded content - Use ChaCha20, with key and nonce from step 3 @@ -148,8 +148,8 @@ validation rules, refer to BIP-340. - `x[i:j]`, where `x` is a byte array and `i, j <= 0` returns a `(j - i)`-byte array with a copy of the `i`-th byte (inclusive) to the `j`-th byte (exclusive) of `x`. - Constants `c`: - - `min_plaintext_size` is 1. 1bytes msg is padded to 32bytes. - - `max_plaintext_size` is 65535 (64kB - 1). It is padded to 65536bytes. + - `min_plaintext_size` is 1. 1 byte msg is padded to 32 bytes. + - `max_plaintext_size` is 65535 (64kB - 1). It is padded to 65536 bytes. - Functions - `base64_encode(string)` and `base64_decode(bytes)` are Base64 ([RFC 4648](https://datatracker.ietf.org/doc/html/rfc4648), with padding) - `concat` refers to byte array concatenation From 9d4f2b42b4491035472c8b5bc3d185f45c41bb45 Mon Sep 17 00:00:00 2001 From: Taha <TahaAttari@users.noreply.github.com> Date: Sun, 22 Dec 2024 21:11:24 -0500 Subject: [PATCH 327/587] add some missing words to readme (#1656) --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e71a13e7..11d9386a 100644 --- a/README.md +++ b/README.md @@ -344,9 +344,9 @@ Please update these lists when proposing new NIPs. ## Is this repository a centralizing factor? -To promote interoperability, we standards that everybody can follow, and we need them to define a **single way of doing each thing** without ever hurting **backwards-compatibility**, and for that purpose there is no way around getting everybody to agree on the same thing and keep a centralized index of these standards. However the fact that such index exists doesn't hurt the decentralization of Nostr. _At any point the central index can be challenged if it is failing to fulfill the needs of the protocol_ and it can migrate to other places and be maintained by other people. +To promote interoperability, we need standards that everybody can follow, and we need them to define a **single way of doing each thing** without ever hurting **backwards-compatibility**, and for that purpose there is no way around getting everybody to agree on the same thing and keep a centralized index of these standards. However the fact that such an index exists doesn't hurt the decentralization of Nostr. _At any point the central index can be challenged if it is failing to fulfill the needs of the protocol_ and it can migrate to other places and be maintained by other people. -It can even fork into multiple and then some clients would go one way, others would go another way, and some clients would adhere to both competing standards. This would hurt the simplicity, openness and interoperability of Nostr a little, but everything would still work in the short term. +It can even fork into multiple versions, and then some clients would go one way, others would go another way, and some clients would adhere to both competing standards. This would hurt the simplicity, openness and interoperability of Nostr a little, but everything would still work in the short term. There is a list of notable Nostr software developers who have commit access to this repository, but that exists mostly for practical reasons, as by the nature of the thing we're dealing with the repository owner can revoke membership and rewrite history as they want -- and if these actions are unjustified or perceived as bad or evil the community must react. From 71ca3f27f3833c4e240921bf105c4268919158e5 Mon Sep 17 00:00:00 2001 From: Kay <kehiiiiya@gmail.com> Date: Thu, 26 Dec 2024 13:14:28 +0000 Subject: [PATCH 328/587] fix broken link. --- 32.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/32.md b/32.md index a99e52a3..202200af 100644 --- a/32.md +++ b/32.md @@ -157,7 +157,7 @@ considered open for public use, and not proprietary. In other words, if there is namespace that fits your use case, use it even if it points to someone else's domain name. Vocabularies MAY choose to fully qualify all labels within a namespace (for example, -`["l", "com.example.vocabulary:my-label"]`. This may be preferred when defining more +`["l", "com.example.vocabulary:my-label"]`). This may be preferred when defining more formal vocabularies that should not be confused with another namespace when querying without an `L` tag. For these vocabularies, all labels SHOULD include the namespace (rather than mixing qualified and unqualified labels). @@ -173,4 +173,4 @@ Appendix: Known Ontologies Below is a non-exhaustive list of ontologies currently in widespread use. -- [social.ontolo.categories](https://ontolo.social/) +- [social ontology categories](https://github.com/CLARIAH/awesome-humanities-ontologies) From 9acad1c62c21c53b727e7025e0627c3c2d31e0fa Mon Sep 17 00:00:00 2001 From: Kay <kehiiiiya@gmail.com> Date: Thu, 26 Dec 2024 14:08:13 +0000 Subject: [PATCH 329/587] fix nip-46 and nip-47 names are changed. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 11d9386a..c9f43a2b 100644 --- a/README.md +++ b/README.md @@ -61,8 +61,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-42: Authentication of clients to relays](42.md) - [NIP-44: Versioned Encryption](44.md) - [NIP-45: Counting results](45.md) -- [NIP-46: Nostr Connect](46.md) -- [NIP-47: Wallet Connect](47.md) +- [NIP-46: Nostr Remote Signing](46.md) +- [NIP-47: Nostr Wallet Connect](47.md) - [NIP-48: Proxy Tags](48.md) - [NIP-49: Private Key Encryption](49.md) - [NIP-50: Search Capability](50.md) From e3911cc9e6078b90db52d61685f0742eda5a3cef Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Fri, 27 Dec 2024 06:52:15 +0900 Subject: [PATCH 330/587] rename NIP-44 in readme. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c9f43a2b..f6225580 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-39: External Identities in Profiles](39.md) - [NIP-40: Expiration Timestamp](40.md) - [NIP-42: Authentication of clients to relays](42.md) -- [NIP-44: Versioned Encryption](44.md) +- [NIP-44: Encrypted Payloads (Versioned)](44.md) - [NIP-45: Counting results](45.md) - [NIP-46: Nostr Remote Signing](46.md) - [NIP-47: Nostr Wallet Connect](47.md) From b88f716eef4feaf1d123562bf61bdb2aa47e6ac1 Mon Sep 17 00:00:00 2001 From: Kay <kehiiiiya@gmail.com> Date: Thu, 26 Dec 2024 22:13:22 +0000 Subject: [PATCH 331/587] fix typo in nip-94. --- 94.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/94.md b/94.md index 021cc4c3..4cd7c826 100644 --- a/94.md +++ b/94.md @@ -10,7 +10,7 @@ The purpose of this NIP is to allow an organization and classification of shared ## Event format -This NIP specifies the use of the `1063` event type, having in `content` a description of the file content, and a list of tags described below: +This NIP specifies the use of the `1063` event kind, having in `content` a description of the file content, and a list of tags described below: * `url` the url to download the file * `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. From 7622cdc9c07d9a99e4bd3e8bb6cf8c15cb7f56c5 Mon Sep 17 00:00:00 2001 From: pablof7z <pfer@me.com> Date: Sat, 28 Dec 2024 10:50:31 +0000 Subject: [PATCH 332/587] adds P and p tags --- 22.md | 33 ++++++++++++++++++++++++--------- 1 file changed, 24 insertions(+), 9 deletions(-) diff --git a/22.md b/22.md index f11925fa..905e0b43 100644 --- a/22.md +++ b/22.md @@ -13,6 +13,9 @@ 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`). +Comments MUST point to the authors when one is available (i.e. tagging a nostr event). `P` for the root scope +and `p` for the author of the parent item. + ```jsonc { kind: 1111, @@ -23,10 +26,16 @@ and MUST point to the parent item with lowercase ones (e.g. `k`, `e`, `a` or `i` // the root item kind ["K", "<root kind>"], + // pubkey of the author of the root scope event + ["P", "<root-pubkey>", "relay-url-hint"], + // 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>"] + ["k", "<parent comment kind>"], + + // parent item pubkey + ["p", "<parent-pubkey>", "relay-url-hint"] ] // other fields } @@ -46,11 +55,6 @@ Their uppercase versions use the same type of values but relate to the root item ``` `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 @@ -65,13 +69,17 @@ A comment on a blog post looks like this: ["A", "30023:3c9849383bdea883b0bd16fece1ed36d37e37cdde3ce43b17ea4e9192ec11289:f9347ca7", "wss://example.relay"], // the root kind ["K", "30023"], + // author of root event + ["P", "3c9849383bdea883b0bd16fece1ed36d37e37cdde3ce43b17ea4e9192ec11289", "wss://example.relay"] // 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"] + ["k", "30023"], + // author of the parent event + ["p", "3c9849383bdea883b0bd16fece1ed36d37e37cdde3ce43b17ea4e9192ec11289", "wss://example.relay"] ] // other fields } @@ -88,11 +96,14 @@ A comment on a [NIP-94](94.md) file looks like this: ["E", "768ac8720cdeb59227cf95e98b66560ef03d8bc9a90d721779e76e68fb42f5e6", "wss://example.relay", "3721e07b079525289877c366ccab47112bdff3d1b44758ca333feb2dbbbbe5bb"], // the root kind ["K", "1063"], + // author of the root event + ["P", "3721e07b079525289877c366ccab47112bdff3d1b44758ca333feb2dbbbbe5bb"], // the parent event id (same as root for top-level comments) ["e", "768ac8720cdeb59227cf95e98b66560ef03d8bc9a90d721779e76e68fb42f5e6", "wss://example.relay", "3721e07b079525289877c366ccab47112bdff3d1b44758ca333feb2dbbbbe5bb"], // the parent kind - ["k", "1063"] + ["k", "1063"], + ["p", "3721e07b079525289877c366ccab47112bdff3d1b44758ca333feb2dbbbbe5bb"] ] // other fields } @@ -109,11 +120,13 @@ A reply to a comment looks like this: ["E", "768ac8720cdeb59227cf95e98b66560ef03d8bc9a90d721779e76e68fb42f5e6", "wss://example.relay", "fd913cd6fa9edb8405750cd02a8bbe16e158b8676c0e69fdc27436cc4a54cc9a"], // the root kind ["K", "1063"], + ["P", "fd913cd6fa9edb8405750cd02a8bbe16e158b8676c0e69fdc27436cc4a54cc9a"], // the parent event ["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://example.relay", "93ef2ebaaf9554661f33e79949007900bbc535d239a4c801c33a4d67d3e7f546"], // the parent kind - ["k", "1111"] + ["k", "1111"], + ["p", "93ef2ebaaf9554661f33e79949007900bbc535d239a4c801c33a4d67d3e7f546"] ] // other fields } @@ -178,7 +191,9 @@ A reply to a podcast comment: ["e", "80c48d992a38f9c445b943a9c9f1010b396676013443765750431a9004bdac05", "wss://example.relay", "252f10c83610ebca1a059c0bae8255eba2f95be4d1d7bcfa89d7248a82d9f111"], // the parent comment kind ["k", "1111"] + ["p", "252f10c83610ebca1a059c0bae8255eba2f95be4d1d7bcfa89d7248a82d9f111"] ] // other fields } ``` + From cd09e6c9d8f5eadd33486aee7f7b4fb56791e4b6 Mon Sep 17 00:00:00 2001 From: jdabs <6774432+jdabs@users.noreply.github.com> Date: Wed, 1 Jan 2025 11:09:21 -0500 Subject: [PATCH 333/587] Grammar updates to 47.md Minor grammatical edits for clarity. - "It's" to "its" to show the possessive case intended instead of the contraction - Correct article from "an" to "a" for the following d letter (consonant sound) - Minor edit to fix comma splices with a semicolon ( ; ) to clarify two independent thoughts. Somewhat optional, but it clarifies the two long sentences. Period can instead be used instead as a new sentence. --- 47.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/47.md b/47.md index d1030a47..932c2632 100644 --- a/47.md +++ b/47.md @@ -107,7 +107,7 @@ The content of notifications is encrypted with [NIP04](https://github.com/nostr- ## Nostr Wallet Connect URI **client** discovers **wallet service** by scanning a QR code, handling a deeplink or pasting in a URI. -The **wallet service** generates this connection URI with protocol `nostr+walletconnect://` and base path it's hex-encoded `pubkey` with the following query string parameters: +The **wallet service** generates this connection URI with protocol `nostr+walletconnect://` and base path its hex-encoded `pubkey` with the following query string parameters: - `relay` Required. URL of the relay where the **wallet service** is connected and will be listening for events. May be more than one. - `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**. @@ -175,7 +175,7 @@ Request: Response: For every invoice in the request, a separate response event is sent. To differentiate between the responses, each -response event contains a `d` tag with the id of the invoice it is responding to, if no id was given, then the +response event contains a `d` tag with the id of the invoice it is responding to; if no id was given, then the payment hash of the invoice should be used. ```jsonc @@ -247,7 +247,7 @@ Request: Response: For every keysend in the request, a separate response event is sent. To differentiate between the responses, each -response event contains an `d` tag with the id of the keysend it is responding to, if no id was given, then the +response event contains a `d` tag with the id of the keysend it is responding to; if no id was given, then the pubkey should be used. ```jsonc From 936befbf9bcc1ec710497673339a2877192c67a2 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Thu, 2 Jan 2025 23:53:33 +0900 Subject: [PATCH 334/587] add NIP-22 link to `P` and `p` tags. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f6225580..251340da 100644 --- a/README.md +++ b/README.md @@ -285,8 +285,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `l` | label, label namespace | -- | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | | `m` | MIME type | -- | [94](94.md) | -| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | -| `P` | pubkey (hex) | -- | [57](57.md) | +| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md), [22](22.md) | +| `P` | pubkey (hex) | -- | [22](22.md), [57](57.md) | | `q` | event id (hex) | relay URL, pubkey (hex) | [18](18.md) | | `r` | a reference (URL, etc) | -- | [24](24.md), [25](25.md) | | `r` | relay url | marker | [65](65.md) | From 2561566af79e6cd6dd82c4980a711847f27dba3f Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Wed, 8 Jan 2025 20:28:46 +0900 Subject: [PATCH 335/587] nip51: format tables. --- 51.md | 54 +++++++++++++++++++++++++++--------------------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/51.md b/51.md index de06f01a..d1c62708 100644 --- a/51.md +++ b/51.md @@ -20,21 +20,21 @@ Standard lists use normal replaceable events, meaning users may only have a sing For 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. -| name | kind | description | expected tag items | -| --- | --- | --- | --- | -| Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags), `"word"` (lowercase string), `"e"` (threads) | -| Pinned notes | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | -| Bookmarks | 10003 | uncategorized, "global" list of things a user wants to save | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) | -| Communities | 10004 | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) | -| Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) | -| Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) | -| Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) | -| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group id + relay URL + optional group name), `"r"` for each relay in use | -| Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) | -| Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | -| DM relays | 10050 | Where to receive [NIP-17](17.md) direct messages | `"relay"` (see [NIP-17](17.md)) | -| Good wiki authors | 10101 | [NIP-54](54.md) user recommended wiki authors | `"p"` (pubkeys) | -| Good wiki relays | 10102 | [NIP-54](54.md) relays deemed to only host useful articles | `"relay"` (relay URLs) | +| name | kind | description | expected tag items | +| --- | --- | --- | --- | +| Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags), `"word"` (lowercase string), `"e"` (threads) | +| Pinned notes | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | +| Bookmarks | 10003 | uncategorized, "global" list of things a user wants to save | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) | +| Communities | 10004 | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) | +| Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) | +| Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) | +| Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) | +| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group id + relay URL + optional group name), `"r"` for each relay in use | +| Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) | +| Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | +| DM relays | 10050 | Where to receive [NIP-17](17.md) direct messages | `"relay"` (see [NIP-17](17.md)) | +| Good wiki authors | 10101 | [NIP-54](54.md) user recommended wiki authors | `"p"` (pubkeys) | +| Good wiki relays | 10102 | [NIP-54](54.md) relays deemed to only host useful articles | `"relay"` (relay URLs) | ### Sets @@ -44,18 +44,18 @@ For example, _relay sets_ can be displayed in a dropdown UI to give users the op Aside from their main identifier, the `"d"` tag, sets can optionally have a `"title"`, an `"image"` and a `"description"` tags that can be used to enhance their UI. -| name | kind | description | expected tag items | -| --- | --- | --- | --- | -| Follow sets | 30000 | categorized groups of users a client may choose to check out in different circumstances | `"p"` (pubkeys) | -| Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during various operations | `"relay"` (relay URLs) | -| 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) | -| 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) | -| Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"a"` (kind:34235 videos) | -| Kind mute sets | 30007 | mute pubkeys by kinds<br>`"d"` tag MUST be the kind string | `"p"` (pubkeys) | -| Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) | -| Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | -| Release artifact sets | 30063 | group of artifacts of a software release | `"e"` (kind:1063 [file metadata](94.md) events), `"a"` (software application event) | -| App curation sets | 30267 | references to multiple software applications | `"a"` (software application event) | +| name | kind | description | expected tag items | +| --- | --- | --- | --- | +| Follow sets | 30000 | categorized groups of users a client may choose to check out in different circumstances | `"p"` (pubkeys) | +| Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during various operations | `"relay"` (relay URLs) | +| 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) | +| 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) | +| Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"a"` (kind:34235 videos) | +| Kind mute sets | 30007 | mute pubkeys by kinds<br>`"d"` tag MUST be the kind string | `"p"` (pubkeys) | +| Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) | +| Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | +| Release artifact sets | 30063 | group of artifacts of a software release | `"e"` (kind:1063 [file metadata](94.md) events), `"a"` (software application event) | +| App curation sets | 30267 | references to multiple software applications | `"a"` (software application event) | ### Deprecated standard lists From 1f8bbbfb50150644c0bb56229394aca95310f7a8 Mon Sep 17 00:00:00 2001 From: pablof7z <pfer@me.com> Date: Fri, 10 Jan 2025 08:27:14 -0600 Subject: [PATCH 336/587] specify magic-wanded protected events should not be stringified in a repost --- 18.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/18.md b/18.md index 41c94424..7a8f810a 100644 --- a/18.md +++ b/18.md @@ -10,6 +10,7 @@ A repost is a `kind 6` event that is used to signal to followers that a `kind 1` text note is worth reading. The `content` of a repost event is _the stringified JSON of the reposted note_. It MAY also be empty, but that is not recommended. +[NIP-70](70.md)-protected events SHOULD always have an empty `content`. The repost event MUST include an `e` tag with the `id` of the note that is being reposted. That tag MUST include a relay URL as its third entry @@ -41,3 +42,4 @@ as a "generic repost", that can include any kind of event inside other than `kind 16` reposts SHOULD contain a `k` tag with the stringified kind number of the reposted event as its value. + From 76fd221ff1da383546f624615a38b6f961033b37 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Fri, 10 Jan 2025 23:39:08 +0900 Subject: [PATCH 337/587] add kind 30267 to list. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 251340da..3b36f0bb 100644 --- a/README.md +++ b/README.md @@ -206,6 +206,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30041` | Modular Article Content | [NKBIP-01] | | `30063` | Release artifact sets | [51](51.md) | | `30078` | Application-specific Data | [78](78.md) | +| `30267` | App curation sets | [51](51.md) | | `30311` | Live Event | [53](53.md) | | `30315` | User Statuses | [38](38.md) | | `30388` | Slide Set | [Corny Chat][cornychat-slideset] | From d96f6f852a080fd84251af6b6d6fb82313b199a8 Mon Sep 17 00:00:00 2001 From: Pablo Fernandez <pfer@me.com> Date: Mon, 13 Jan 2025 14:35:10 +0000 Subject: [PATCH 338/587] Update 18.md Co-authored-by: hodlbod <jstaab@protonmail.com> --- 18.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/18.md b/18.md index 7a8f810a..5d55f84c 100644 --- a/18.md +++ b/18.md @@ -10,7 +10,7 @@ A repost is a `kind 6` event that is used to signal to followers that a `kind 1` text note is worth reading. The `content` of a repost event is _the stringified JSON of the reposted note_. It MAY also be empty, but that is not recommended. -[NIP-70](70.md)-protected events SHOULD always have an empty `content`. +Reposts of [NIP-70](70.md)-protected events SHOULD always have an empty `content`. The repost event MUST include an `e` tag with the `id` of the note that is being reposted. That tag MUST include a relay URL as its third entry From 5b6ca881e24d5a6e089d3c577c6c7cab98bbb19d Mon Sep 17 00:00:00 2001 From: "T.Shinohara" <takuma1201@gmail.com> Date: Mon, 13 Jan 2025 23:37:53 +0900 Subject: [PATCH 339/587] add t-tags in kind 41 (#1673) --- 28.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/28.md b/28.md index 73c76b2b..6b240ef3 100644 --- a/28.md +++ b/28.md @@ -52,10 +52,17 @@ Clients MAY add additional metadata fields. Clients SHOULD use [NIP-10](10.md) marked "e" tags to recommend a relay. +It is also possible to set the category name using the "t" tag. This category name can be searched and filtered. + ```jsonc { "content": "{\"name\": \"Updated Demo Channel\", \"about\": \"Updating a test channel.\", \"picture\": \"https://placekitten.com/201/201\", \"relays\": [\"wss://nos.lol\", \"wss://nostr.mom\"]}", - "tags": [["e", <channel_create_event_id>, <relay-url>]], + "tags": [ + ["e", <channel_create_event_id>, <relay-url>, "root"], + ["t", <category_name-1>], + ["t", <category_name-2>], + ["t", <category_name-3>], + ], // other fields... } ``` From 0e3d1cd5d82754d0eb69ddb847f6532b4dade3be Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Mon, 13 Jan 2025 12:04:46 -0500 Subject: [PATCH 340/587] Moves Kind:1 definition to NIP-10 (#1076) Co-authored-by: Michael J <37635304+buttercat1791@users.noreply.github.com> --- 01.md | 5 +++-- 10.md | 16 ++++++++++++---- README.md | 2 +- 3 files changed, 16 insertions(+), 7 deletions(-) diff --git a/01.md b/01.md index d62f3177..e515d811 100644 --- a/01.md +++ b/01.md @@ -85,10 +85,11 @@ As a convention, all single-letter (only english alphabet letters: a-z, A-Z) key ### Kinds -Kinds specify how clients should interpret the meaning of each event and the other fields of each event (e.g. an `"r"` tag may have a meaning in an event of kind 1 and an entirely different meaning in an event of kind 10002). Each NIP may define the meaning of a set of kinds that weren't defined elsewhere. This NIP defines two basic kinds: +Kinds specify how clients should interpret the meaning of each event and the other fields of each event (e.g. an `"r"` tag may have a meaning in an event of kind 1 and an entirely different meaning in an event of kind 10002). Each NIP may define the meaning of a set of kinds that weren't defined elsewhere. [NIP-10](10.md), for instance, especifies the `kind:1` text note for social media applications. + +This NIP defines one basic kind: - `0`: **user metadata**: the `content` is set to a stringified JSON object `{name: <username>, about: <string>, picture: <url, string>}` describing the user who created the event. [Extra metadata fields](24.md#kind-0) may be set. A relay may delete older events once it gets a new one for the same pubkey. -- `1`: **text note**: the `content` is set to the **plaintext** content of a note (anything the user wants to say). Content that must be parsed, such as Markdown and HTML, should not be used. Clients should also not parse content as those. And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: diff --git a/10.md b/10.md index c1d50687..064e56a0 100644 --- a/10.md +++ b/10.md @@ -1,14 +1,22 @@ NIP-10 ====== - -On "e" and "p" tags in Text Events (kind 1) -------------------------------------------- +Text Notes and Threads +---------------------- `draft` `optional` +This NIP defines `kind:1` as a simple plaintext note. + ## Abstract -This NIP describes how to use "e" and "p" tags in text events, especially those that are replies to other text events. It helps clients thread the replies into a tree rooted at the original event. + +This NIP describes how to use "e" and "p" tags in text events, especially those that are replies to other text events. It helps clients thread the replies into a tree rooted at the original event. + +The `.content` property contains some human-readable text. + +`e` and `p` tags can be used to define note threads, replies and mentions. + +Markup languages such as markdown and HTML SHOULD NOT be used. ## Marked "e" tags (PREFERRED) `["e", <event-id>, <relay-url>, <marker>, <pubkey>]` diff --git a/README.md b/README.md index 3b36f0bb..ed8336cb 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-07: `window.nostr` capability for web browsers](07.md) - [NIP-08: Handling Mentions](08.md) --- **unrecommended**: deprecated in favor of [NIP-27](27.md) - [NIP-09: Event Deletion Request](09.md) -- [NIP-10: Conventions for clients' use of `e` and `p` tags in text events](10.md) +- [NIP-10: Text Notes and Threads](10.md) - [NIP-11: Relay Information Document](11.md) - [NIP-13: Proof of Work](13.md) - [NIP-14: Subject tag in text events](14.md) From 6c62751e573337cbe6276613a268fd4984751c74 Mon Sep 17 00:00:00 2001 From: hodlbod <jstaab@protonmail.com> Date: Mon, 13 Jan 2025 11:24:04 -0800 Subject: [PATCH 341/587] Warn against using 1111 to reply to kind 1 (#1680) Co-authored-by: Jon Staab <shtaab@gmail.com> --- 22.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/22.md b/22.md index 905e0b43..2ad1fd81 100644 --- a/22.md +++ b/22.md @@ -56,6 +56,8 @@ Their uppercase versions use the same type of values but relate to the root item `p` tags SHOULD be used when mentioning pubkeys in the `.content` with [NIP-21](21.md). +Comments MUST NOT be used to reply to kind 1 notes. [NIP-10](10.md) should instead be followed. + ## Examples A comment on a blog post looks like this: From 512caf7fcd4145b99ff2f5fea023c625bc38332e Mon Sep 17 00:00:00 2001 From: "P. Reis" <patrickpereirareal1@gmail.com> Date: Mon, 13 Jan 2025 20:42:58 -0300 Subject: [PATCH 342/587] NIP-61: fix unfinished sentence (#1683) --- 61.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/61.md b/61.md index 33442a3b..8246203e 100644 --- a/61.md +++ b/61.md @@ -70,7 +70,7 @@ WIP: Clients SHOULD embed a DLEQ proof in the nutzap event to make it possible t * The sender fetches the recipient's `kind:10019`. * The sender mints/swaps ecash on one of the recipient's listed mints. -* The sender p2pk locks to the recipient's specified pubkey in their +* The sender p2pk locks to the recipient's specified pubkey in their `kind:10019` # Receiving nutzaps @@ -129,4 +129,4 @@ For this scenarios clients can: * add a `pubkey` tag to the `kind:10019` (indicating which pubkey senders should P2PK to) * store the private key in the `kind:37375` event in the nip44-encrypted `content` field. -This is to avoid depending on NIP-07/46 adaptations to sign cashu payloads. \ No newline at end of file +This is to avoid depending on NIP-07/46 adaptations to sign cashu payloads. From 0782ebe0bcd31b6f7ad860fb85788a62b4c83c20 Mon Sep 17 00:00:00 2001 From: abhay-raizada <toabhayraizada@gmail.com> Date: Tue, 14 Jan 2025 05:55:30 +0530 Subject: [PATCH 343/587] Reinstate NIP-88: Polls on Nostr (#1507) --- 88.md | 130 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 3 ++ 2 files changed, 133 insertions(+) create mode 100644 88.md diff --git a/88.md b/88.md new file mode 100644 index 00000000..08f5c41d --- /dev/null +++ b/88.md @@ -0,0 +1,130 @@ +# NIP-88 + +## Polls + +`draft` `optional` + +This NIP defines the event scheme that describe Polls on nostr. + +## Events + +### Poll Event + +The poll event is defined as a `kind:1068` event. + +- **content** key holds the label for the poll. + +Major tags in the poll event are: + +- **option**: The option tags contain an OptionId(any alphanumeric) field, followed by an option label field. +- **relay**: One or multiple tags that the poll is expecting respondents to respond on. +- **polltype**: can be "singlechoice" or "multiplechoice". Polls that do not have a polltype should be considered a "singlechoice" poll. +- **endsAt**: signifying at which unix timestamp the poll is meant to end. + +Example Event + +```json +{ + "content": "Pineapple on pizza", + "created_at": 1719888496, + "id": "9d1b6b9562e66f2ecf35eb0a3c2decc736c47fddb13d6fb8f87185a153ea3634", + "kind": 1068, + "pubkey": "dee45a23c4f1d93f3a2043650c5081e4ac14a778e0acbef03de3768e4f81ac7b", + "sig": "7fa93bf3c430eaef784b0dacc217d3cd5eff1c520e7ef5d961381bc0f014dde6286618048d924808e54d1be03f2f2c2f0f8b5c9c2082a4480caf45a565ca9797", + "tags": [ + ["option", "qj518h583", "Yay"], + ["option", "gga6cdnqj", "Nay"], + ["relay", "<relay url1>"], + ["relay", "<relay url2>"], + ["polltype", "singlechoice"], + ["endsAt", "<unix timestamp in seconds>"] + ] +} +``` + +### Responses + +The response event is a `kind:1018` event. It contains an e tag with the poll event it is referencing, followed by one or more response tags. + +- **response** : The tag contains "response" as it's first positional argument followed by the option Id selected. + +The responses are meant to be published to the relays specified in the poll event. + +Example Response Event + +```json +{ + "content": "", + "created_at": 1720097117, + "id": "60a005e32e9596c3f544a841a9bc4e46d3020ca3650d6a739c95c1568e33f6d8", + "kind": 1018, + "pubkey": "1bc70a0148b3f316da33fe7e89f23e3e71ac4ff998027ec712b905cd24f6a411", + "sig": "30071a633c65db8f3a075c7a8de757fbd8ce65e3607f4ba287fe6d7fbf839a380f94ff4e826fbba593f6faaa13683b7ea9114ade140720ecf4927010ebf3e44f", + "tags": [ + ["e", "1fc80cf813f1af33d5a435862b7ef7fb96b47e68a48f1abcadf8081f5a545550"], + ["response", "gga6cdnqj"], + ["response", "m3agjsdq1"] + ] +} +``` + +### Poll Types + +The polltype setting dictates how multiple response tags are handled in the `kind:1018` event. + +- **polltype: singlechoice**: The first response tag is to be considered the actual response. +- **polltype: multiplechoice**: The first response tag pointing to each id is considered the actual response, without considering the order of the response tags. + +### Counting Results + +Results can be queried by fetching `kind:1018` events from the relays specified in the poll. +The results displayed should only be 1 vote event per pubkey. +In case of multiple events for a pubkey, the event with the largest timestamp within the poll limits should be considered. + +Example for querying polls. + +```ts +const fetchVoteEvents = (filterPubkeys: string[]) => { + let resultFilter: Filter = { + "#e": [pollEvent.id], + kinds: [1018], + }; + if (filterPubkeys?.length) { + resultFilter.authors = filterPubkeys; + } + if (pollExpiration) { + resultFilter.until = Number(pollExpiration); + } + pool.subscribeMany(relays, [resultFilter], { + onevent: handleResultEvent, + }); +}; +``` + +Example for maintaining OneVotePerPubkey + +```ts +const oneVotePerPubkey = (events: Event[]) => { + const eventMap = new Map<string, Event>(); + + events.forEach((event) => { + if ( + !eventMap.has(event.pubkey) || + event.created_at > eventMap.get(event.pubkey)!.created_at + ) { + eventMap.set(event.pubkey, event); + } + }); + + return Array.from(eventMap.values()); +}; +``` + +### Relays + +It is advisable for poll authors to use relays that do not allow backdated events and do not honor kind:5 (delete) requests for vote events in order to maintain the integrity of poll results after the poll has ended. + +### Curation + +The clients may configure fetching results by specific people. This can be achieved by creating `kind:30000` follow sets, and fetching results only from the follow set. +Clients can also employ other curation algorithms, like Proof Of Work and Web of Trust scores for result curations. diff --git a/README.md b/README.md index ed8336cb..91d3c67f 100644 --- a/README.md +++ b/README.md @@ -89,6 +89,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-78: Application-specific data](78.md) - [NIP-84: Highlights](84.md) - [NIP-86: Relay Management API](86.md) +- [NIP-88: Polls](88.md) - [NIP-89: Recommended Application Handlers](89.md) - [NIP-90: Data Vending Machines](90.md) - [NIP-92: Media Attachments](92.md) @@ -128,11 +129,13 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `44` | Channel Mute User | [28](28.md) | | `64` | Chess (PGN) | [64](64.md) | | `818` | Merge Requests | [54](54.md) | +| `1018` | Poll Response | [88](88.md) | | `1021` | Bid | [15](15.md) | | `1022` | Bid confirmation | [15](15.md) | | `1040` | OpenTimestamps | [03](03.md) | | `1059` | Gift Wrap | [59](59.md) | | `1063` | File Metadata | [94](94.md) | +| `1068` | Poll | [88](88.md) | | `1111` | Comment | [22](22.md) | | `1311` | Live Chat Message | [53](53.md) | | `1617` | Patches | [34](34.md) | From 190122fd8d36e35c0242dedcc89f622ad8c99e67 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Tue, 14 Jan 2025 23:13:39 +0900 Subject: [PATCH 344/587] update kind 1 link. (#1686) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 91d3c67f..56fa597d 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | kind | description | NIP | | ------------- | ------------------------------- | -------------------------------------- | | `0` | User Metadata | [01](01.md) | -| `1` | Short Text Note | [01](01.md) | +| `1` | Short Text Note | [10](10.md) | | `2` | Recommend Relay | 01 (deprecated) | | `3` | Follows | [02](02.md) | | `4` | Encrypted Direct Messages | [04](04.md) | From 3f11c00fb93f118f207130344032710e34de4710 Mon Sep 17 00:00:00 2001 From: Dan Gershony <dan.gershony@gmail.com> Date: Tue, 14 Jan 2025 19:56:13 +0200 Subject: [PATCH 345/587] Update nip 59 typo (#1687) --- 59.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/59.md b/59.md index 9bb5845b..ddeb83cb 100644 --- a/59.md +++ b/59.md @@ -53,7 +53,7 @@ without the receiver's or the sender's private key. The only public information } ``` -Tags MUST must always be empty in a `kind:13`. The inner event MUST always be unsigned. +Tags MUST always be empty in a `kind:13`. The inner event MUST always be unsigned. ## 3. Gift Wrap Event Kind From cc3fbab1533d72b9a6f3fbaaac6f33bf8c0d5901 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Sat, 18 Jan 2025 09:27:06 +0900 Subject: [PATCH 346/587] fix "PRE" to "addressable event". (#1697) --- 60.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/60.md b/60.md index 64cd282a..b2b0dd45 100644 --- a/60.md +++ b/60.md @@ -54,7 +54,7 @@ Tags: Any tag, other than the `d` tag, can be [[NIP-44]] encrypted into the `.content` field. ### Deleting a wallet event -Due 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. +Due to addressable event 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. ## Token Event Token events are used to record the unspent proofs that come from the mint. From 1b521d019ae19373f8c663f99fc95407cac35714 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Thu, 23 Jan 2025 21:39:23 +0900 Subject: [PATCH 347/587] BREAKING.md: single quote -> back quote. --- BREAKING.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/BREAKING.md b/BREAKING.md index 77900d33..66f1a9f6 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -21,37 +21,37 @@ reverse chronological order. | 2024-07-23 | [0227a2cd](https://github.com/nostr-protocol/nips/commit/0227a2cd) | [01](01.md) | events should be sorted by id after created_at | | 2024-06-06 | [58e94b20](https://github.com/nostr-protocol/nips/commit/58e94b20) | [25](25.md) | [8073c848](https://github.com/nostr-protocol/nips/commit/8073c848) was reverted | | 2024-06-06 | [a6dfc7b5](https://github.com/nostr-protocol/nips/commit/a6dfc7b5) | [55](55.md) | NIP number was changed | -| 2024-05-25 | [5d1d1c17](https://github.com/nostr-protocol/nips/commit/5d1d1c17) | [71](71.md) | 'aes-256-gcm' tag was removed | +| 2024-05-25 | [5d1d1c17](https://github.com/nostr-protocol/nips/commit/5d1d1c17) | [71](71.md) | `aes-256-gcm` tag was removed | | 2024-05-07 | [8073c848](https://github.com/nostr-protocol/nips/commit/8073c848) | [25](25.md) | e-tags were changed to not include entire thread | -| 2024-04-30 | [bad88262](https://github.com/nostr-protocol/nips/commit/bad88262) | [34](34.md) | 'earliest-unique-commit' tag was removed (use 'r' tag instead) | +| 2024-04-30 | [bad88262](https://github.com/nostr-protocol/nips/commit/bad88262) | [34](34.md) | `earliest-unique-commit` tag was removed (use `r` tag instead) | | 2024-02-25 | [4a171cb0](https://github.com/nostr-protocol/nips/commit/4a171cb0) | [18](18.md) | quote repost should use `q` tag | | 2024-02-21 | [c6cd655c](https://github.com/nostr-protocol/nips/commit/c6cd655c) | [46](46.md) | Params were stringified | | 2024-02-16 | [cbec02ab](https://github.com/nostr-protocol/nips/commit/cbec02ab) | [49](49.md) | Password first normalized to NFKC | | 2024-02-15 | [afbb8dd0](https://github.com/nostr-protocol/nips/commit/afbb8dd0) | [39](39.md) | PGP identity was removed | | 2024-02-07 | [d3dad114](https://github.com/nostr-protocol/nips/commit/d3dad114) | [46](46.md) | Connection token format was changed | -| 2024-01-30 | [1a2b21b6](https://github.com/nostr-protocol/nips/commit/1a2b21b6) | [59](59.md) | 'p' tag became optional | +| 2024-01-30 | [1a2b21b6](https://github.com/nostr-protocol/nips/commit/1a2b21b6) | [59](59.md) | `p` tag became optional | | 2023-01-27 | [c2f34817](https://github.com/nostr-protocol/nips/commit/c2f34817) | [47](47.md) | optional expiration tag should be honored | | 2024-01-10 | [3d8652ea](https://github.com/nostr-protocol/nips/commit/3d8652ea) | [02](02.md), [51](51.md) | list entries should be chronological | -| 2023-12-30 | [29869821](https://github.com/nostr-protocol/nips/commit/29869821) | [52](52.md) | 'name' tag was removed (use 'title' tag instead) | -| 2023-12-27 | [17c67ef5](https://github.com/nostr-protocol/nips/commit/17c67ef5) | [94](94.md) | 'aes-256-gcm' tag was removed | -| 2023-12-03 | [0ba45895](https://github.com/nostr-protocol/nips/commit/0ba45895) | [01](01.md) | WebSocket status code `4000` was replaced by 'CLOSED' message | -| 2023-11-28 | [6de35f9e](https://github.com/nostr-protocol/nips/commit/6de35f9e) | [89](89.md) | 'client' tag value was changed | +| 2023-12-30 | [29869821](https://github.com/nostr-protocol/nips/commit/29869821) | [52](52.md) | `name` tag was removed (use `title` tag instead) | +| 2023-12-27 | [17c67ef5](https://github.com/nostr-protocol/nips/commit/17c67ef5) | [94](94.md) | `aes-256-gcm` tag was removed | +| 2023-12-03 | [0ba45895](https://github.com/nostr-protocol/nips/commit/0ba45895) | [01](01.md) | WebSocket status code `4000` was replaced by `CLOSED` message | +| 2023-11-28 | [6de35f9e](https://github.com/nostr-protocol/nips/commit/6de35f9e) | [89](89.md) | `client` tag value was changed | | 2023-11-20 | [7822a8b1](https://github.com/nostr-protocol/nips/commit/7822a8b1) | [51](51.md) | `kind: 30001` was deprecated | | 2023-11-20 | [7822a8b1](https://github.com/nostr-protocol/nips/commit/7822a8b1) | [51](51.md) | the meaning of `kind: 30000` was changed | -| 2023-11-11 | [cbdca1e9](https://github.com/nostr-protocol/nips/commit/cbdca1e9) | [84](84.md) | 'range' tag was removed | -| 2023-11-10 | [c945d8bd](https://github.com/nostr-protocol/nips/commit/c945d8bd) | [32](32.md) | 'l' tag annotations was removed | -| 2023-11-07 | [108b7f16](https://github.com/nostr-protocol/nips/commit/108b7f16) | [01](01.md) | 'OK' message must have 4 items | -| 2023-10-17 | [cf672b76](https://github.com/nostr-protocol/nips/commit/cf672b76) | [03](03.md) | 'block' tag was removed | -| 2023-09-29 | [7dc6385f](https://github.com/nostr-protocol/nips/commit/7dc6385f) | [57](57.md) | optional 'a' tag was included in `zap receipt` | -| 2023-08-21 | [89915e02](https://github.com/nostr-protocol/nips/commit/89915e02) | [11](11.md) | 'min_prefix' was removed | +| 2023-11-11 | [cbdca1e9](https://github.com/nostr-protocol/nips/commit/cbdca1e9) | [84](84.md) | `range` tag was removed | +| 2023-11-10 | [c945d8bd](https://github.com/nostr-protocol/nips/commit/c945d8bd) | [32](32.md) | `l` tag annotations was removed | +| 2023-11-07 | [108b7f16](https://github.com/nostr-protocol/nips/commit/108b7f16) | [01](01.md) | `OK` message must have 4 items | +| 2023-10-17 | [cf672b76](https://github.com/nostr-protocol/nips/commit/cf672b76) | [03](03.md) | `block` tag was removed | +| 2023-09-29 | [7dc6385f](https://github.com/nostr-protocol/nips/commit/7dc6385f) | [57](57.md) | optional `a` tag was included in `zap receipt` | +| 2023-08-21 | [89915e02](https://github.com/nostr-protocol/nips/commit/89915e02) | [11](11.md) | `min_prefix` was removed | | 2023-08-20 | [37c4375e](https://github.com/nostr-protocol/nips/commit/37c4375e) | [01](01.md) | replaceable events with same timestamp should be retained event with lowest id | -| 2023-08-15 | [88ee873c](https://github.com/nostr-protocol/nips/commit/88ee873c) | [15](15.md) | 'countries' tag was renamed to 'regions' | +| 2023-08-15 | [88ee873c](https://github.com/nostr-protocol/nips/commit/88ee873c) | [15](15.md) | `countries` tag was renamed to `regions` | | 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [12](12.md), [16](16.md), [20](20.md), [33](33.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | | 2023-08-11 | [d87f8617](https://github.com/nostr-protocol/nips/commit/d87f8617) | [25](25.md) | empty `content` should be considered as "+" | -| 2023-08-01 | [5d63b157](https://github.com/nostr-protocol/nips/commit/5d63b157) | [57](57.md) | 'zap' tag was changed | +| 2023-08-01 | [5d63b157](https://github.com/nostr-protocol/nips/commit/5d63b157) | [57](57.md) | `zap` tag was changed | | 2023-07-15 | [d1814405](https://github.com/nostr-protocol/nips/commit/d1814405) | [01](01.md) | `since` and `until` filters should be `since <= created_at <= until` | | 2023-07-12 | [a1cd2bd8](https://github.com/nostr-protocol/nips/commit/a1cd2bd8) | [25](25.md) | custom emoji was supported | -| 2023-06-18 | [83cbd3e1](https://github.com/nostr-protocol/nips/commit/83cbd3e1) | [11](11.md) | 'image' was renamed to 'icon' | +| 2023-06-18 | [83cbd3e1](https://github.com/nostr-protocol/nips/commit/83cbd3e1) | [11](11.md) | `image` was renamed to `icon` | | 2023-04-13 | [bf0a0da6](https://github.com/nostr-protocol/nips/commit/bf0a0da6) | [15](15.md) | different NIP was re-added as NIP-15 | | 2023-04-09 | [fb5b7c73](https://github.com/nostr-protocol/nips/commit/fb5b7c73) | [15](15.md) | NIP-15 was merged into NIP-01 | | 2023-03-29 | [599e1313](https://github.com/nostr-protocol/nips/commit/599e1313) | [18](18.md) | NIP-18 was bring back | From a7f30b1eb232786263c5ff4ea7b9589c1ec3868f Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Tue, 28 Jan 2025 12:33:53 +0900 Subject: [PATCH 348/587] add kind 32267 to list. (#1698) --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 56fa597d..3f416a2c 100644 --- a/README.md +++ b/README.md @@ -228,6 +228,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `31925` | Calendar Event RSVP | [52](52.md) | | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | +| `32267` | Software Application | | | `34235` | Video Event | [71](71.md) | | `34236` | Short-form Portrait Video Event | [71](71.md) | | `34550` | Community Definition | [72](72.md) | From 70db801bb7fb258c10f4b2ec58056ef74df25549 Mon Sep 17 00:00:00 2001 From: Kieran <kieran@harkin.me> Date: Tue, 28 Jan 2025 14:37:54 +0000 Subject: [PATCH 349/587] Update 92.md (#1721) --- 92.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/92.md b/92.md index b332d211..d6e9932c 100644 --- a/92.md +++ b/92.md @@ -6,10 +6,10 @@ Media Attachments Media attachments (images, videos, and other files) may be added to events by including a URL in the event content, along with a matching `imeta` tag. -`imeta` ("inline metadata") tags add information about media URLs in the event's content. Each `imeta` tag SHOULD match a URL in the event content. Clients may replace imeta URLs with rich previews. +`imeta` ("inline metadata") tags MAY add information about media URLs in the event's content. Each `imeta` tag SHOULD match a URL in the event content. Clients MAY replace imeta URLs with rich previews. The `imeta` tag is variadic, and each entry is a space-delimited key/value pair. -Each `imeta` tag MUST have a `url`, and at least one other field. `imeta` may include +Each `imeta` tag MUST have a `url`, and at least one other field. `imeta` MAY include any field specified by [NIP 94](./94.md). There SHOULD be only one `imeta` tag per URL. ## Example From 36c48ca128c963b78469855d0e48fa6c1097269b Mon Sep 17 00:00:00 2001 From: Pablo Fernandez <pfer@me.com> Date: Tue, 28 Jan 2025 20:26:21 +0100 Subject: [PATCH 350/587] NIP-60: more consistent state transition (#1720) --- 60.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/60.md b/60.md index b2b0dd45..491bc479 100644 --- a/60.md +++ b/60.md @@ -57,7 +57,7 @@ Any tag, other than the `d` tag, can be [[NIP-44]] encrypted into the `.content` Due to addressable event 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. ## Token Event -Token events are used to record the unspent proofs that come from the mint. +Token events are used to record unspent proofs. There can be multiple `kind:7375` events for the same mint, and multiple proofs inside each `kind:7375` event. @@ -73,7 +73,9 @@ There can be multiple `kind:7375` events for the same mint, and multiple proofs "secret": "z+zyxAVLRqN9lEjxuNPSyRJzEstbl69Jc1vtimvtkPg=", "C": "0241d98a8197ef238a192d47edf191a9de78b657308937b4f7dd0aa53beae72c46" } - ] + ], + // tokens that were destroyed in the creation of this token + "del": [ "token-id-1" ] }), "tags": [ [ "a", "37375:<pubkey>:my-wallet" ] @@ -81,8 +83,11 @@ There can be multiple `kind:7375` events for the same mint, and multiple proofs } ``` -`.content` is a [[NIP-44]] encrypted payload storing the mint and the unencoded proofs. -* `a` an optional tag linking the token to a specific wallet. + * `a` an optional tag linking the token to a specific wallet. + * `.content` is a [[NIP-44]] encrypted payload: + * `mint`: The mint the proofs belong to. + * `proofs`: unecoded proofs + * `del`: token-ids that were destroyed by the creation of this token. This assists with state transitions. ### Spending proofs When 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. @@ -96,7 +101,7 @@ Clients SHOULD publish `kind:7376` events to create a transaction history when t "content": nip44_encrypt([ [ "direction", "in" ], // in = received, out = sent [ "amount", "1", "sat" ], - [ "e", "<event-id-of-spent-token>", "<relay-hint>", "created" ], + [ "e", "<event-id-of-created-token>", "<relay-hint>", "created" ], ]), "tags": [ [ "a", "37375:<pubkey>:my-wallet" ], @@ -160,7 +165,8 @@ Her client: { "id": "1", "amount": 1 }, { "id": "2", "amount": 2 }, { "id": "4", "amount": 8 }, - ] + ], + "del": [ "event-id-1" ] }), "tags": [ [ "a", "37375:<pubkey>:my-wallet" ] @@ -168,6 +174,7 @@ Her client: } ``` * MUST delete event `event-id-1` +* SHOULD add the `event-id-1` to the `del` array of deleted token-ids. * SHOULD create a `kind:7376` event to record the spend ```jsonconc { From 993c8a025eda25b1c87ece3605e5a5eae6d6a1e0 Mon Sep 17 00:00:00 2001 From: "P. Reis" <patrickpereirareal1@gmail.com> Date: Tue, 28 Jan 2025 21:26:41 -0300 Subject: [PATCH 351/587] parameterized replaceable -> addressable (#1722) --- 60.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/60.md b/60.md index 491bc479..6f3929c5 100644 --- a/60.md +++ b/60.md @@ -39,7 +39,7 @@ This NIP doesn't deal with users' *receiving* money from someone else, it's just } ``` -The wallet event is a parameterized replaceable event `kind:37375`. +The wallet event is an addressable event `kind:37375`. Tags: * `d` - wallet ID. From 54b431e701c3e3b0eaa5bdd2093a3bb7830543dc Mon Sep 17 00:00:00 2001 From: "k." <me@kehiy.net> Date: Wed, 29 Jan 2025 13:45:18 +0330 Subject: [PATCH 352/587] Add x tag to NIP-56 (#1669) --- 56.md | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/56.md b/56.md index f7b1b1a9..dc6f0983 100644 --- a/56.md +++ b/56.md @@ -22,7 +22,7 @@ are reporting. If reporting a note, an `e` tag MUST also be included referencing the note id. -A `report type` string MUST be included as the 3rd entry to the `e` or `p` tag +A `report type` string MUST be included as the 3rd entry to the `e`, `p` or `x` tag being reported, which consists of the following report types: - `nudity` - depictions of nudity, porn, etc. @@ -33,7 +33,9 @@ being reported, which consists of the following report types: - `impersonation` - someone pretending to be someone else - `other` - for reports that don't fit in the above categories -Some report tags only make sense for profile reports, such as `impersonation` +Some report tags only make sense for profile reports, such as `impersonation`. + +- `x` tags SHOULD be info hash of a blob which is intended to be report. when the `x` tag is represented client MUST include an `e` tag which is the id of the event that contains the mentioned blob. also, additionally these events can contain a `server` tag to point to media servers which may contain the mentioned media. `l` and `L` tags MAY be also be used as defined in [NIP-32](32.md) to support further qualification and querying. @@ -45,7 +47,7 @@ Example events { "kind": 1984, "tags": [ - ["p", <pubkey>, "nudity"], + ["p", "<pubkey>", "nudity"], ["L", "social.nos.ontology"], ["l", "NS-nud", "social.nos.ontology"] ], @@ -58,8 +60,8 @@ Example events { "kind": 1984, "tags": [ - ["e", <eventId>, "illegal"], - ["p", <pubkey>] + ["e", "<eventId>", "illegal"], + ["p", "<pubkey>"] ], "content": "He's insulting the king!", // other fields... @@ -70,13 +72,26 @@ Example events { "kind": 1984, "tags": [ - ["p", <impersonator pubkey>, "impersonation"] + ["p", "<impersonator pubkey>", "impersonation"] ], "content": "Profile is impersonating nostr:<victim bech32 pubkey>", // other fields... } ``` +```jsonc +{ + "kind": 1984, + "tags": [ + ["x", "<blob hash>", "malware"], + ["e", "<event id which contains the blob on x tag>", "malware"], + ["server", "https://you-may-find-the-blob-here.com/path-to-url.ext"] + ], + "content": "This file contains malware software in it.", + // other fields... +} +``` + Client behavior --------------- From 7370729472b5d8b54693e67d0f26b2dd1da84c07 Mon Sep 17 00:00:00 2001 From: "P. Reis" <patrickpereirareal1@gmail.com> Date: Thu, 30 Jan 2025 10:45:35 -0300 Subject: [PATCH 353/587] NIP-60: jsonconc -> jsonc (#1727) --- 60.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/60.md b/60.md index 6f3929c5..81174124 100644 --- a/60.md +++ b/60.md @@ -134,7 +134,7 @@ While the client is fetching (and perhaps validating) proofs it can use the opti ## Spending token If Alice spends 4 sats from this token event -```jsonconc +```jsonc { "kind": 7375, "id": "event-id-1", @@ -155,7 +155,7 @@ If Alice spends 4 sats from this token event Her client: * MUST roll over the unspent proofs: -```jsonconc +```jsonc { "kind": 7375, "id": "event-id-2", @@ -176,7 +176,7 @@ Her client: * MUST delete event `event-id-1` * SHOULD add the `event-id-1` to the `del` array of deleted token-ids. * SHOULD create a `kind:7376` event to record the spend -```jsonconc +```jsonc { "kind": 7376, "content": nip44_encrypt([ From f440eac3dccefa5c0ec9d3964e1d08357fd31e09 Mon Sep 17 00:00:00 2001 From: daniele <github@dtonon.com> Date: Thu, 30 Jan 2025 22:49:06 +0100 Subject: [PATCH 354/587] Remove reference to 'username' and update descriptions in metadata (#1726) --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index e515d811..9e25ca9b 100644 --- a/01.md +++ b/01.md @@ -89,7 +89,7 @@ Kinds specify how clients should interpret the meaning of each event and the oth This NIP defines one basic kind: -- `0`: **user metadata**: the `content` is set to a stringified JSON object `{name: <username>, about: <string>, picture: <url, string>}` describing the user who created the event. [Extra metadata fields](24.md#kind-0) may be set. A relay may delete older events once it gets a new one for the same pubkey. +- `0`: **user metadata**: the `content` is set to a stringified JSON object `{name: <nickname or full name>, about: <short bio>, picture: <url of the image>}` describing the user who created the event. [Extra metadata fields](24.md#kind-0) may be set. A relay may delete older events once it gets a new one for the same pubkey. And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: From 6a4b125ad771ac9da4a1347a1ed41185e30ad0cf Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Thu, 30 Jan 2025 23:21:37 -0300 Subject: [PATCH 355/587] nip71: make video events regular (#1704) --- 51.md | 2 +- 68.md | 6 +++--- 71.md | 32 ++++++++++++++++---------------- README.md | 8 ++++---- 4 files changed, 24 insertions(+), 24 deletions(-) diff --git a/51.md b/51.md index d1c62708..87744c72 100644 --- a/51.md +++ b/51.md @@ -50,7 +50,7 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti | Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during various operations | `"relay"` (relay URLs) | | 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) | | 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) | -| Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"a"` (kind:34235 videos) | +| Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"a"` (kind:21 videos) | | Kind mute sets | 30007 | mute pubkeys by kinds<br>`"d"` tag MUST be the kind string | `"p"` (pubkeys) | | Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) | | Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | diff --git a/68.md b/68.md index 6c1e7d2d..918378a9 100644 --- a/68.md +++ b/68.md @@ -12,7 +12,7 @@ The idea is for this type of event to cater to Nostr clients resembling platform ## Picture Events -Picture events contain a `title` tag and description in the `.content`. +Picture events contain a `title` tag and description in the `.content`. They may contain multiple images to be displayed as a single post. @@ -81,7 +81,7 @@ They may contain multiple images to be displayed as a single post. The `imeta` tag `annotate-user` places a user link in the specific position in the image. -Only the following media types are accepted: +Only the following media types are accepted: - `image/apng`: Animated Portable Network Graphics (APNG) - `image/avif`: AV1 Image File Format (AVIF) - `image/gif`: Graphics Interchange Format (GIF) @@ -89,4 +89,4 @@ Only the following media types are accepted: - `image/png`: Portable Network Graphics (PNG) - `image/webp`: Web Picture format (WEBP) -Picture events might be used with [NIP-71](71.md)'s kind `34236` to display short vertical videos in the same feed. +Picture events might be used with [NIP-71](71.md)'s kind `22` to display short vertical videos in the same feed. diff --git a/71.md b/71.md index 5edd7c60..d3b09253 100644 --- a/71.md +++ b/71.md @@ -6,17 +6,19 @@ Video Events `draft` `optional` -This 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). +This specification defines _video_ events representing a dedicated post of externally hosted content. -Unlike 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. +Unlike 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. ## Video Events -There are two types of video events represented by different kinds: horizontal and vertical video events. This is meant to allow clients to cater to each as the viewing experience for horizontal (landscape) videos is often different than that of vertical (portrait) videos (Stories, Reels, Shorts, etc). +There are two types of video events represented by different kinds: _normal_ and _short_ video events. This is meant to allow clients to cater to each as the viewing experience for longer, mostly horizontal (landscape) videos is often different than that of short-form, mostly vertical (portrait), videos ("stories", "reels", "shorts" etc). + +Nothing except cavaliership and common sense prevents a _short_ video from being long, or a _normal_ video from being vertical, and that may or may not be justified, it's mostly a stylistic qualitative difference, not a question of actual raw size. #### Format -The format uses an _addressable event_ kind `34235` for horizontal videos and `34236` for vertical videos. +The format uses a _regular event_ kind `21` for _normal_ videos and `22` for _short_ videos. The `.content` of these events is a summary or description on the video content. @@ -27,7 +29,7 @@ Each `imeta` tag can be used to specify a variant of the video by the `dim` & `m Example: ```json [ - ["imeta", + ["imeta", "dim 1920x1080", "url https://myvideo.com/1080/12345.mp4", "x 3093509d1e0bc604ff60cb9286f4cd7c781553bc8991937befaacfdc28ec5cdc", @@ -38,7 +40,7 @@ Example: "fallback https://andanotherserver.com/1080/12345.mp4", "service nip96", ], - ["imeta", + ["imeta", "dim 1280x720", "url https://myvideo.com/720/12345.mp4", "x e1d4f808dae475ed32fb23ce52ef8ac82e3cc760702fca10d62d382d2da3697d", @@ -49,7 +51,7 @@ Example: "fallback https://andanotherserver.com/720/12345.mp4", "service nip96", ], - ["imeta", + ["imeta", "dim 1280x720", "url https://myvideo.com/720/12345.m3u8", "x 704e720af2697f5d6a198ad377789d462054b6e8d790f8a3903afbc1e044014f", @@ -86,17 +88,15 @@ Additionally `service nip96` may be included to allow clients to search the auth "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, "created_at": <Unix timestamp in seconds>, - "kind": 34235 | 34236, + "kind": 21 | 22, "content": "<summary / description of video>", "tags": [ - ["d", "<UUID>"], - ["title", "<title of video>"], ["published_at", "<unix timestamp>"], ["alt", <description>], - // Video Data - ["imeta", + // video Data + ["imeta", "dim 1920x1080", "url https://myvideo.com/1080/12345.mp4", "x 3093509d1e0bc604ff60cb9286f4cd7c781553bc8991937befaacfdc28ec5cdc", @@ -113,17 +113,17 @@ Additionally `service nip96` may be included to allow clients to search the auth ["content-warning", "<reason>"], ["segment", <start>, <end>, "<title>", "<thumbnail URL>"], - // Participants + // participants ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], - // Hashtags + // hashtags ["t", "<tag>"], ["t", "<tag>"], - // Reference links + // reference links ["r", "<url>"], ["r", "<url>"] ] } -``` \ No newline at end of file +``` diff --git a/README.md b/README.md index 3f416a2c..5c1d4ec8 100644 --- a/README.md +++ b/README.md @@ -122,6 +122,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `16` | Generic Repost | [18](18.md) | | `17` | Reaction to a website | [25](25.md) | | `20` | Picture | [68](68.md) | +| `21` | Video Event | [71](71.md) | +| `22` | Short-form Portrait Video Event | [71](71.md) | | `40` | Channel Creation | [28](28.md) | | `41` | Channel Metadata | [28](28.md) | | `42` | Channel Message | [28](28.md) | @@ -227,10 +229,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `31924` | Calendar | [52](52.md) | | `31925` | Calendar Event RSVP | [52](52.md) | | `31989` | Handler recommendation | [89](89.md) | -| `31990` | Handler information | [89](89.md) | -| `32267` | Software Application | | -| `34235` | Video Event | [71](71.md) | -| `34236` | Short-form Portrait Video Event | [71](71.md) | +| `31990` | Handler information | [89](89.md) | | +| `32267` | Software Application | | | | `34550` | Community Definition | [72](72.md) | | `37375` | Cashu Wallet Event | [60](60.md) | | `38383` | Peer-to-peer Order events | [69](69.md) | From e09f6dad27fc2ed12deda09256dff5bcf22a65b0 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Sat, 1 Feb 2025 00:59:52 +0900 Subject: [PATCH 356/587] add NIP-71 change. --- BREAKING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/BREAKING.md b/BREAKING.md index 66f1a9f6..ca79a0e5 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -5,6 +5,7 @@ reverse chronological order. | Date | Commit | NIP | Change | | ----------- | --------- | -------- | ------ | +| 2025-01-31 | [6a4b125a](https://github.com/nostr-protocol/nips/commit/6a4b125a) | [71](71.md) | video events were changed to regular | | 2024-12-05 | [6d16019e](https://github.com/nostr-protocol/nips/commit/6d16019e) | [46](46.md) | message encryption was changed to NIP-44 | | 2024-11-12 | [2838e3bd](https://github.com/nostr-protocol/nips/commit/2838e3bd) | [29](29.md) | `kind: 12` and `kind: 10` were removed (use `kind: 1111` instead) | | 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [46](46.md) | NIP-05 login was removed | From c88d9256135e53136ea2ce4f99b7e9cfcb21d143 Mon Sep 17 00:00:00 2001 From: Terry Yiu <963907+tyiu@users.noreply.github.com> Date: Sun, 2 Feb 2025 22:38:15 -0500 Subject: [PATCH 357/587] Update kind 10013 description in README (#1736) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5c1d4ec8..d1100e10 100644 --- a/README.md +++ b/README.md @@ -175,7 +175,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10006` | Blocked relays list | [51](51.md) | | `10007` | Search relays list | [51](51.md) | | `10009` | User groups | [51](51.md), [29](29.md) | -| `10013` | Draft relays | [37](37.md) | +| `10013` | Private event relay list | [37](37.md) | | `10015` | Interests list | [51](51.md) | | `10019` | Nutzap Mint Recommendation | [61](61.md) | | `10030` | User emoji list | [51](51.md) | From 8577545faad887396d413707bc9020d024407818 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Mon, 3 Feb 2025 23:00:33 +0900 Subject: [PATCH 358/587] nip60: fix links. --- 60.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/60.md b/60.md index 81174124..2f97f87c 100644 --- a/60.md +++ b/60.md @@ -44,14 +44,14 @@ The wallet event is an addressable event `kind:37375`. Tags: * `d` - wallet ID. * `mint` - Mint(s) this wallet uses -- there MUST be one or more mint tags. -* `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]]. +* `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](65.md). * `unit` - Base unit of the wallet (e.g. "sat", "usd", etc). * `name` - Optional human-readable name for the wallet. * `description` - Optional human-readable description of the wallet. * `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. * `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. -Any tag, other than the `d` tag, can be [[NIP-44]] encrypted into the `.content` field. +Any tag, other than the `d` tag, can be [NIP-44](44.md) encrypted into the `.content` field. ### Deleting a wallet event Due to addressable event 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. @@ -90,7 +90,7 @@ There can be multiple `kind:7375` events for the same mint, and multiple proofs * `del`: token-ids that were destroyed by the creation of this token. This assists with state transitions. ### Spending proofs -When 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. +When one or more proofs of a token are spent, the token event should be [NIP-09](09.md)-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. ## Spending History Event Clients SHOULD publish `kind:7376` events to create a transaction history when their balance changes. @@ -115,14 +115,14 @@ Clients SHOULD publish `kind:7376` events to create a transaction history when t Clients MUST add `e` tags to create references of destroyed and created token events along with the marker of the meaning of the tag: * `created` - A new token event was created. * `destroyed` - A token event was destroyed. -* `redeemed` - A [[NIP-61]] nutzap was redeemed. +* `redeemed` - A [NIP-61](61.md) nutzap was redeemed. -All tags can be [[NIP-44]] encrypted. Clients SHOULD leave `e` tags with a `redeemed` marker unencrypted. +All tags can be [NIP-44](44.md) encrypted. Clients SHOULD leave `e` tags with a `redeemed` marker unencrypted. Multiple `e` tags can be added to a `kind:7376` event. # Flow -A 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. +A 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](65.md) relays. ## Fetch wallet and token list From those relays, the client should fetch wallet and token events. @@ -192,7 +192,7 @@ Her client: ``` ## Redeeming a quote (optional) -When 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. +When 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](40.md) matching the expiration of the bolt11 received from the mint; this signals to relays when they can safely discard these events. Application developers are encouraged to use local state when possible and only publish this event when it makes sense in the context of their application. From 93568e39717cd61ff855dc24e4f0ee30a6051f6c Mon Sep 17 00:00:00 2001 From: Ethan Tuttle <133234413+EthnTuttle@users.noreply.github.com> Date: Mon, 3 Feb 2025 18:27:25 -0500 Subject: [PATCH 359/587] Update 60.md (#1738) --- 60.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/60.md b/60.md index 2f97f87c..69db44f8 100644 --- a/60.md +++ b/60.md @@ -44,7 +44,7 @@ The wallet event is an addressable event `kind:37375`. Tags: * `d` - wallet ID. * `mint` - Mint(s) this wallet uses -- there MUST be one or more mint tags. -* `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](65.md). +* `relay` - Relays where the wallet and related events can be found. -- one or more relays SHOULD be specified. If missing, clients should follow [NIP-65](65.md). * `unit` - Base unit of the wallet (e.g. "sat", "usd", etc). * `name` - Optional human-readable name for the wallet. * `description` - Optional human-readable description of the wallet. From 5a857e8bf8b88e14a98b1fcff4932034091c9b5c Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Mon, 3 Feb 2025 22:36:27 -0300 Subject: [PATCH 360/587] nip60/61 updates and simplifications (#1730) Co-authored-by: Tiago Balas <eskema23@gmail.com> --- 60.md | 98 ++++++++++++++++++++++------------------------------------- 61.md | 90 ++++++++++++++++++++++++------------------------------ 2 files changed, 76 insertions(+), 112 deletions(-) diff --git a/60.md b/60.md index 69db44f8..87449d20 100644 --- a/60.md +++ b/60.md @@ -1,5 +1,9 @@ -# NIP-60 -## Cashu Wallet +NIP-60 +====== + +Cashu Wallets +------------- + `draft` `optional` This NIP defines the operations of a cashu-based wallet. @@ -13,48 +17,28 @@ The purpose of this NIP is: This NIP doesn't deal with users' *receiving* money from someone else, it's just to keep state of the user's wallet. # High-level flow -1. A user has a `kind:37375` event that represents a wallet. +1. A user has a `kind:17375` event that represents a wallet. 2. A user has `kind:7375` events that represent the unspent proofs of the wallet. -- The proofs are encrypted with the user's private key. 3. 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. ## Wallet Event ```jsonc { - "kind": 37375, + "kind": 17375, "content": nip44_encrypt([ - [ "balance", "100", "sat" ], - [ "privkey", "hexkey" ] // explained in NIP-61 - ]), - "tags": [ - [ "d", "my-wallet" ], + [ "privkey", "hexkey" ], [ "mint", "https://mint1" ], - [ "mint", "https://mint2" ], - [ "mint", "https://mint3" ], - [ "name", "my shitposting wallet" ], - [ "unit", "sat" ], - [ "description", "a wallet for my day-to-day shitposting" ], - [ "relay", "wss://relay1" ], - [ "relay", "wss://relay2" ], - ] + [ "mint", "https://mint2" ] + ]), + "tags": [] } ``` -The wallet event is an addressable event `kind:37375`. +The wallet event is an replaceable event `kind:17375`. Tags: -* `d` - wallet ID. * `mint` - Mint(s) this wallet uses -- there MUST be one or more mint tags. -* `relay` - Relays where the wallet and related events can be found. -- one or more relays SHOULD be specified. If missing, clients should follow [NIP-65](65.md). -* `unit` - Base unit of the wallet (e.g. "sat", "usd", etc). -* `name` - Optional human-readable name for the wallet. -* `description` - Optional human-readable description of the wallet. -* `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. -* `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. - -Any tag, other than the `d` tag, can be [NIP-44](44.md) encrypted into the `.content` field. - -### Deleting a wallet event -Due to addressable event 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. +* `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 for receiving [NIP-61](61.md) nutzaps. ## Token Event Token events are used to record unspent proofs. @@ -67,6 +51,7 @@ There can be multiple `kind:7375` events for the same mint, and multiple proofs "content": nip44_encrypt({ "mint": "https://stablenut.umint.cash", "proofs": [ + // one or more proofs in the default cashu format { "id": "005c2502034d4f12", "amount": 1, @@ -74,23 +59,21 @@ There can be multiple `kind:7375` events for the same mint, and multiple proofs "C": "0241d98a8197ef238a192d47edf191a9de78b657308937b4f7dd0aa53beae72c46" } ], - // tokens that were destroyed in the creation of this token - "del": [ "token-id-1" ] + // tokens that were destroyed in the creation of this token (helps on wallet state transitions) + "del": [ "token-event-id-1", "token-event-id-2" ] }), - "tags": [ - [ "a", "37375:<pubkey>:my-wallet" ] - ] + "tags": [] } ``` - * `a` an optional tag linking the token to a specific wallet. - * `.content` is a [[NIP-44]] encrypted payload: + * `.content` is a [NIP-44](44.md) encrypted payload: * `mint`: The mint the proofs belong to. * `proofs`: unecoded proofs * `del`: token-ids that were destroyed by the creation of this token. This assists with state transitions. -### Spending proofs -When one or more proofs of a token are spent, the token event should be [NIP-09](09.md)-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. +When one or more proofs of a token are spent, the token event should be [NIP-09](09.md)-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 (the change output should include a `del` field). + +The `kind:5` _delete event_ created in the [NIP-09](09.md) process MUST have a tag `["k", "7375"]` to allow easy filtering by clients interested in state transitions. ## Spending History Event Clients SHOULD publish `kind:7376` events to create a transaction history when their balance changes. @@ -100,17 +83,16 @@ Clients SHOULD publish `kind:7376` events to create a transaction history when t "kind": 7376, "content": nip44_encrypt([ [ "direction", "in" ], // in = received, out = sent - [ "amount", "1", "sat" ], - [ "e", "<event-id-of-created-token>", "<relay-hint>", "created" ], + [ "amount", "1" ], + [ "e", "<event-id-of-created-token>", "", "created" ] ]), "tags": [ - [ "a", "37375:<pubkey>:my-wallet" ], + [ "e", "<event-id-of-created-token>", "", "redeemed" ] ] } ``` * `direction` - The direction of the transaction; `in` for received funds, `out` for sent funds. -* `a` - The wallet the transaction is related to. Clients MUST add `e` tags to create references of destroyed and created token events along with the marker of the meaning of the tag: * `created` - A new token event was created. @@ -119,7 +101,7 @@ Clients MUST add `e` tags to create references of destroyed and created token ev All tags can be [NIP-44](44.md) encrypted. Clients SHOULD leave `e` tags with a `redeemed` marker unencrypted. -Multiple `e` tags can be added to a `kind:7376` event. +Multiple `e` tags can be added, and should be encrypted, except for tags with the `redeemed` marker. # Flow A 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](65.md) relays. @@ -127,10 +109,9 @@ A client that wants to check for user's wallets information starts by fetching ` ## Fetch wallet and token list From those relays, the client should fetch wallet and token events. -`"kinds": [37375, 7375], "authors": ["<my-pubkey>"]` +`"kinds": [17375, 7375], "authors": ["<my-pubkey>"]` ## Fetch proofs -While 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. ## Spending token If Alice spends 4 sats from this token event @@ -147,9 +128,7 @@ If Alice spends 4 sats from this token event { "id": "4", "amount": 8 }, ] }), - "tags": [ - [ "a", "37375:<pubkey>:my-wallet" ] - ] + "tags": [] } ``` @@ -168,9 +147,7 @@ Her client: ], "del": [ "event-id-1" ] }), - "tags": [ - [ "a", "37375:<pubkey>:my-wallet" ] - ] + "tags": [] } ``` * MUST delete event `event-id-1` @@ -181,20 +158,18 @@ Her client: "kind": 7376, "content": nip44_encrypt([ [ "direction", "out" ], - [ "amount", "4", "sats" ], - [ "e", "<event-id-1>", "<relay-hint>", "destroyed" ], - [ "e", "<event-id-2>", "<relay-hint>", "created" ], + [ "amount", "4" ], + [ "e", "<event-id-1>", "", "destroyed" ], + [ "e", "<event-id-2>", "", "created" ], ]), - "tags": [ - [ "a", "37375:<pubkey>:my-wallet" ], - ] + "tags": [] } ``` ## Redeeming a quote (optional) -When 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](40.md) matching the expiration of the bolt11 received from the mint; this signals to relays when they can safely discard these events. +When 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](40.md) of 2 weeks (which is around the maximum amount of time a Lightning payment may be in-flight). -Application developers are encouraged to use local state when possible and only publish this event when it makes sense in the context of their application. +However, application developers SHOULD use local state when possible and only publish this event when it makes sense in the context of their application. ```jsonc { @@ -202,8 +177,7 @@ Application developers are encouraged to use local state when possible and only "content": nip44_encrypt("quote-id"), "tags": [ [ "expiration", "<expiration-timestamp>" ], - [ "mint", "<mint-url>" ], - [ "a", "37375:<pubkey>:my-wallet" ] + [ "mint", "<mint-url>" ] ] } ``` diff --git a/61.md b/61.md index 8246203e..fdcc2b64 100644 --- a/61.md +++ b/61.md @@ -1,14 +1,19 @@ -# NIP-61: -## Nut Zaps +NIP-61 +====== -A Nut Zap is a P2PK cashu token where the payment itself is the receipt. +Nutzaps +------- + +`draft` `optional` + +A Nutzap is a P2PK Cashu token in which the payment itself is the receipt. # High-level flow Alice wants to nutzap 1 sat to Bob because of an event `event-id-1` she liked. ## Alice nutzaps Bob 1. Alice fetches event `kind:10019` from Bob to see the mints Bob trusts. -2. 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`. +2. 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`. 3. She publishes a `kind:9321` event to the relays Bob indicated with the proofs she minted. ## Bob receives the nutzap @@ -29,16 +34,15 @@ Alice wants to nutzap 1 sat to Bob because of an event `event-id-1` she liked. } ``` -`kind:10019` is an event that is useful for others to know how to send money to the user. - -* `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. -* `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. -* `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. +* `kind:10019` is an event that is useful for others to know how to send money to the user. +* `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. +* `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. +* `pubkey`: Public key that MUST be used to P2PK-lock receiving nutzaps -- implementations MUST NOT use the target user's main Nostr public key. This public key corresponds to the `privkey` field encrypted in a user's [nip-60](60.md) _wallet event_. ## Nutzap event -Event `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. +Event `kind:9321` is a nutzap event published by the sender, p-tagging the recipient. The outputs are P2PK-locked to the public key the recipient indicated in their `kind:10019` event. -Clients MUST prefix the pubkey they p2pk-lock with `"02"` (for nostr<>cashu pubkey compatibility). +Clients MUST prefix the public key they P2PK-lock with `"02"` (for nostr<>cashu compatibility). ```jsonc { @@ -46,48 +50,41 @@ Clients MUST prefix the pubkey they p2pk-lock with `"02"` (for nostr<>cashu pubk content: "Thanks for this great idea.", pubkey: "sender-pubkey", tags: [ - [ "amount", "1" ], - [ "unit", "sat" ], [ "proof", "{\"amount\":1,\"C\":\"02277c66191736eb72fce9d975d08e3191f8f96afb73ab1eec37e4465683066d3f\",\"id\":\"000a93d6f8a1d2c4\",\"secret\":\"[\\\"P2PK\\\",{\\\"nonce\\\":\\\"b00bdd0467b0090a25bdf2d2f0d45ac4e355c482c1418350f273a04fedaaee83\\\",\\\"data\\\":\\\"02eaee8939e3565e48cc62967e2fde9d8e2a4b3ec0081f29eceff5c64ef10ac1ed\\\"}]\"}" ], - [ "u", "https://stablenut.umint.cash", ], + [ "u", "https://stablenut.umint.cash" ], [ "e", "<zapped-event-id>", "<relay-hint>" ], - [ "p", "e9fbced3a42dcf551486650cc752ab354347dd413b307484e4fd1818ab53f991" ], // recipient of nut zap + [ "p", "e9fbced3a42dcf551486650cc752ab354347dd413b307484e4fd1818ab53f991" ], // recipient of nutzap ] } ``` * `.content` is an optional comment for the nutzap -* `amount` is a shorthand for the combined amount of all outputs. -- Clients SHOULD validate that the sum of the amounts in the outputs matches. -* `unit` is the base unit of the amount. -* `proof` is one ore more proofs p2pk-locked to the pubkey the recipient specified in their `kind:10019` event. -* `u` is the mint the URL of the mint EXACTLY as specified by the recipient's `kind:10019`. -* `e` zero or one event that is being nutzapped. -* `p` exactly one pubkey, specifying the recipient of the nutzap. - -WIP: Clients SHOULD embed a DLEQ proof in the nutzap event to make it possible to verify nutzaps without talking to the mint. +* `.tags`: + * `proof` is one ore more proofs P2PK-locked to the public key the recipient specified in their `kind:10019` event and including a DLEQ proof. + * `u` is the mint the URL of the mint EXACTLY as specified by the recipient's `kind:10019`. + * `p` is the Nostr identity public key of nutzap recipient. + * `e` is the event that is being nutzapped, if any. # Sending a nutzap * The sender fetches the recipient's `kind:10019`. * The sender mints/swaps ecash on one of the recipient's listed mints. -* The sender p2pk locks to the recipient's specified pubkey in their `kind:10019` +* The sender P2PK-locks to the recipient's specified public key in their `kind:10019` # Receiving nutzaps -Clients should REQ for nut zaps: +Clients should REQ for nutzaps: * Filtering with `#u` for mints they expect to receive ecash from. * this is to prevent even interacting with mints the user hasn't explicitly signaled. * Filtering with `since` of the most recent `kind:7376` event the same user has created. - * 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. + * this can be used as a marker of the nutzaps 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. -Clients MIGHT choose to use some kind of filtering (e.g. WoT) to ignore spam. +`{ "kinds": [9321], "#p": ["my-pubkey"], "#u": ["<mint-1>", "<mint-2>"], "since": <latest-created_at-of-kind-7376> }`. -`{ "kinds": [9321], "#p": "my-pubkey", "#u": [ "<mint-1>", "<mint-2>"], "since": <latest-created_at-of-kind-7376> }`. - -Upon 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. +Upon receiving a new nutzap, the client should swap the tokens into a wallet the user controls, either a [NIP-60](60.md) wallet, their own LN wallet or anything else. ## Updating nutzap-redemption history -When 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. +When claiming a token the client SHOULD create a `kind:7376` event and `e` tag the original nutzap 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. Multiple `kind:9321` events can be tagged in the same `kind:7376` event. @@ -96,7 +93,7 @@ Multiple `kind:9321` events can be tagged in the same `kind:7376` event. "kind": 7376, "content": nip44_encrypt([ [ "direction", "in" ], // in = received, out = sent - [ "amount", "1", "sat" ], + [ "amount", "1" ], [ "e", "<7375-event-id>", "relay-hint", "created" ] // new token event that was created ]), "tags": [ @@ -107,26 +104,19 @@ Multiple `kind:9321` events can be tagged in the same `kind:7376` event. } ``` -Events that redeem a nutzap SHOULD be published to the sender's [[NIP-65]] relays. +Events that redeem a nutzap SHOULD be published to the sender's [NIP-65](65.md) "read" relays. ## Verifying a Cashu Zap -* Clients SHOULD check that the receiving user has issued a `kind:10019` tagging the mint where the cashu has been minted. -* Clients SHOULD check that the token is locked to the pubkey the user has listed in their `kind:10019`. +When listing or counting zaps received by any given event, observer clients SHOULD: + +* check that the receiving user has issued a `kind:10019` tagging the mint where the cashu has been minted. +* check that the token is locked to the pubkey the user has listed in their `kind:10019`. +* look at the `u` tag and check that the token is issued in one of the mints listed in the `kind:10019`. +* locally verify the DLEQ proof of the tokens being sent. + +All these checks can be done offline (as long as the observer has the receiver mints' keyset and their `kind:10019` event), so the process should be reasonably fast. ## Final Considerations - -1. 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 - +1. Clients SHOULD guide their users to use NUT-11 (P2PK) and NUT-12 (DLEQ proofs) compatible-mints in their `kind:10019` event to avoid receiving nutzaps anyone can spend. 2. Clients SHOULD normalize and deduplicate mint URLs as described in NIP-65. - -3. 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. - -## Appendix 1: Alternative P2PK pubkey -Clients 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. - -For this scenarios clients can: - -* add a `pubkey` tag to the `kind:10019` (indicating which pubkey senders should P2PK to) -* store the private key in the `kind:37375` event in the nip44-encrypted `content` field. - -This is to avoid depending on NIP-07/46 adaptations to sign cashu payloads. +3. A nutzap event MUST include proofs in one of the mints the recipient has listed in their `kind:10019` and published 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. From 2bc53c12a2af71845bb15a9386ed28867b9f925e Mon Sep 17 00:00:00 2001 From: Ethan Tuttle <133234413+EthnTuttle@users.noreply.github.com> Date: Tue, 4 Feb 2025 05:53:04 -0500 Subject: [PATCH 361/587] Update 61.md (#1739) --- 61.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/61.md b/61.md index fdcc2b64..ac4dd150 100644 --- a/61.md +++ b/61.md @@ -60,7 +60,7 @@ Clients MUST prefix the public key they P2PK-lock with `"02"` (for nostr<>cashu * `.content` is an optional comment for the nutzap * `.tags`: - * `proof` is one ore more proofs P2PK-locked to the public key the recipient specified in their `kind:10019` event and including a DLEQ proof. + * `proof` is one or more proofs P2PK-locked to the public key the recipient specified in their `kind:10019` event and including a DLEQ proof. * `u` is the mint the URL of the mint EXACTLY as specified by the recipient's `kind:10019`. * `p` is the Nostr identity public key of nutzap recipient. * `e` is the event that is being nutzapped, if any. From a70e49e21cf286889568ce034011a29ba994faa0 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Tue, 4 Feb 2025 20:55:41 +0900 Subject: [PATCH 362/587] update Cashu Wallet Event kind. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d1100e10..dd3c0f74 100644 --- a/README.md +++ b/README.md @@ -183,6 +183,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10063` | User server list | [Blossom][blossom] | | `10096` | File storage server list | [96](96.md) | | `13194` | Wallet Info | [47](47.md) | +| `17375` | Cashu Wallet Event | [60](60.md) | | `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | | `22242` | Client Authentication | [42](42.md) | | `23194` | Wallet Request | [47](47.md) | @@ -232,7 +233,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `31990` | Handler information | [89](89.md) | | | `32267` | Software Application | | | | `34550` | Community Definition | [72](72.md) | -| `37375` | Cashu Wallet Event | [60](60.md) | | `38383` | Peer-to-peer Order events | [69](69.md) | | `39000-9` | Group metadata events | [29](29.md) | From 4e564ba4d99f247a6c2c1734d01a12c9bda8c1db Mon Sep 17 00:00:00 2001 From: Mohammed Alotaibi <a@4rs.nl> Date: Tue, 4 Feb 2025 15:50:20 +0300 Subject: [PATCH 363/587] Fix NIPs refs (#1740) --- 31.md | 2 +- 47.md | 2 +- 64.md | 2 +- 69.md | 4 ++-- 90.md | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/31.md b/31.md index ee920528..37e41306 100644 --- a/31.md +++ b/31.md @@ -12,4 +12,4 @@ The intent is that social clients, used to display only `kind:1` notes, can stil These clients that only know `kind:1` are not expected to ask relays for events of different kinds, but users could still reference these weird events on their notes, and without proper context these could be nonsensical notes. Having the fallback text makes that situation much better -- even if only for making the user aware that they should try to view that custom event elsewhere. -`kind:1`-centric clients can make interacting with these event kinds more functional by supporting [NIP-89](https://github.com/nostr-protocol/nips/blob/master/89.md). +`kind:1`-centric clients can make interacting with these event kinds more functional by supporting [NIP-89](89.md). diff --git a/47.md b/47.md index 932c2632..f15dc014 100644 --- a/47.md +++ b/47.md @@ -82,7 +82,7 @@ If the command was successful, the `error` field must be null. The notification event SHOULD contain one `p` tag, the public key of the **user**. -The content of notifications 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: +The content of notifications is encrypted with [NIP04](04.md), and is a JSON-RPCish object with a semi-fixed structure: ```jsonc { diff --git a/64.md b/64.md index 616c5d6f..318ea87c 100644 --- a/64.md +++ b/64.md @@ -44,7 +44,7 @@ Clients SHOULD publish PGN notes in ["export format"][pgn_export_format] ("stric Clients SHOULD check whether the formatting is valid and all moves comply with chess rules. -Clients 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. +Clients MAY include additional tags (e.g. like [`"alt"`](31.md)) in order to represent the note to users of non-supporting clients. ## Relay Behavior diff --git a/69.md b/69.md index 330d6e58..0cfceeac 100644 --- a/69.md +++ b/69.md @@ -12,7 +12,7 @@ This NIP defines a simple standard for peer-to-peer order events, which enables ## The event -Events are [addressable events](https://github.com/nostr-protocol/nips/blob/master/01.md#kinds) and use `38383` as event kind, a p2p event look like this: +Events are [addressable events](01.md#kinds) and use `38383` as event kind, a p2p event look like this: ```json { @@ -65,7 +65,7 @@ Events are [addressable events](https://github.com/nostr-protocol/nips/blob/mast - `name` [Name]: The name of the maker. - `g` [Geohash]: The geohash of the operation, it can be useful in a face to face trade. - `bond` [Bond]: The bond amount, the bond is a security deposit that both parties must pay. -- `expiration` < Expiration\>: The expiration date of the order ([NIP-40](https://github.com/nostr-protocol/nips/blob/master/40.md)). +- `expiration` < Expiration\>: The expiration date of the order ([NIP-40](40.md)). - `y` < Platform >: The platform that created the order. - `z` < Document >: `order`. diff --git a/90.md b/90.md index 1d69b0ff..785b539c 100644 --- a/90.md +++ b/90.md @@ -70,7 +70,7 @@ All tags are optional. ## Encrypted Params -If the user wants to keep the input parameters a secret, they can encrypt the `i` and `param` tags with the service provider's 'p' tag and add it to the content field. Add a tag `encrypted` as tags. Encryption for private tags will use [NIP-04 - Encrypted Direct Message encryption](https://github.com/nostr-protocol/nips/blob/master/04.md), using the user's private and service provider's public key for the shared secret +If the user wants to keep the input parameters a secret, they can encrypt the `i` and `param` tags with the service provider's 'p' tag and add it to the content field. Add a tag `encrypted` as tags. Encryption for private tags will use [NIP-04 - Encrypted Direct Message encryption](04.md), using the user's private and service provider's public key for the shared secret ```json [ From a0cd05f013d7a6c4d0581b2bebb885dc844791f4 Mon Sep 17 00:00:00 2001 From: "P. Reis" <patrickpereirareal1@gmail.com> Date: Tue, 4 Feb 2025 22:35:15 -0300 Subject: [PATCH 364/587] NIP-61: get rid of 'a' tag (#1742) --- 61.md | 1 - 1 file changed, 1 deletion(-) diff --git a/61.md b/61.md index ac4dd150..a340ae4a 100644 --- a/61.md +++ b/61.md @@ -97,7 +97,6 @@ Multiple `kind:9321` events can be tagged in the same `kind:7376` event. [ "e", "<7375-event-id>", "relay-hint", "created" ] // new token event that was created ]), "tags": [ - [ "a", "37375:<pubkey>:my-wallet" ], // an optional wallet tag [ "e", "<9321-event-id>", "relay-hint", "redeemed" ], // nutzap event that has been redeemed [ "p", "sender-pubkey" ] // pubkey of the author of the 9321 event (nutzap sender) ] From 3bbfbb26aa4abe00f612c6c540803de58391e618 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Wed, 5 Feb 2025 11:10:48 -0500 Subject: [PATCH 365/587] NIP-01: Adds the author information to `e` tags (#1749) --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 9e25ca9b..5873eb63 100644 --- a/01.md +++ b/01.md @@ -75,7 +75,7 @@ The first element of the tag array is referred to as the tag _name_ or _key_ and This NIP defines 3 standard tags that can be used across all event kinds with the same meaning. They are as follows: -- The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, <recommended relay URL, optional>]` +- The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, <recommended relay URL, optional>, <32-bytes lowercase hex of the author's pubkey, optional>]` - The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, <recommended relay URL, optional>]` - The `a` tag, used to refer to an addressable or replaceable event - for an addressable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]` From f2e89b130d8053636e0dbdf0e67d83193ccbcc3e Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Wed, 5 Feb 2025 13:25:01 -0300 Subject: [PATCH 366/587] Revert "NIP-01: Adds the author information to `e` tags (#1749)" This reverts commit 3bbfbb26aa4abe00f612c6c540803de58391e618. --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 5873eb63..9e25ca9b 100644 --- a/01.md +++ b/01.md @@ -75,7 +75,7 @@ The first element of the tag array is referred to as the tag _name_ or _key_ and This NIP defines 3 standard tags that can be used across all event kinds with the same meaning. They are as follows: -- The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, <recommended relay URL, optional>, <32-bytes lowercase hex of the author's pubkey, optional>]` +- The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, <recommended relay URL, optional>]` - The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, <recommended relay URL, optional>]` - The `a` tag, used to refer to an addressable or replaceable event - for an addressable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]` From 63d1e89f5380ae88b3c9e7903fdea6129beae0d0 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Wed, 5 Feb 2025 13:29:07 -0300 Subject: [PATCH 367/587] Revert "Revert "NIP-01: Adds the author information to `e` tags (#1749)"" This reverts commit f2e89b130d8053636e0dbdf0e67d83193ccbcc3e. --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 9e25ca9b..5873eb63 100644 --- a/01.md +++ b/01.md @@ -75,7 +75,7 @@ The first element of the tag array is referred to as the tag _name_ or _key_ and This NIP defines 3 standard tags that can be used across all event kinds with the same meaning. They are as follows: -- The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, <recommended relay URL, optional>]` +- The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, <recommended relay URL, optional>, <32-bytes lowercase hex of the author's pubkey, optional>]` - The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, <recommended relay URL, optional>]` - The `a` tag, used to refer to an addressable or replaceable event - for an addressable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]` From e286001789b0dbd0b1ef9f3cbf91f16f6e9e5c9e Mon Sep 17 00:00:00 2001 From: "P. Reis" <patrickpereirareal1@gmail.com> Date: Thu, 6 Feb 2025 12:28:23 -0300 Subject: [PATCH 368/587] NIP-61: nitpicks (#1754) --- 61.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/61.md b/61.md index a340ae4a..ffe7c523 100644 --- a/61.md +++ b/61.md @@ -94,11 +94,11 @@ Multiple `kind:9321` events can be tagged in the same `kind:7376` event. "content": nip44_encrypt([ [ "direction", "in" ], // in = received, out = sent [ "amount", "1" ], - [ "e", "<7375-event-id>", "relay-hint", "created" ] // new token event that was created + [ "e", "<7375-event-id>", "<relay-hint>", "created" ] // new token event that was created ]), "tags": [ - [ "e", "<9321-event-id>", "relay-hint", "redeemed" ], // nutzap event that has been redeemed - [ "p", "sender-pubkey" ] // pubkey of the author of the 9321 event (nutzap sender) + [ "e", "<9321-event-id>", "<relay-hint>", "redeemed" ], // nutzap event that has been redeemed + [ "p", "<sender-pubkey>" ] // pubkey of the author of the 9321 event (nutzap sender) ] } ``` From f1dee4a050ef850ff280fee60d98a39d500b4e1f Mon Sep 17 00:00:00 2001 From: "Nostr.Band" <124499563+nostrband@users.noreply.github.com> Date: Fri, 7 Feb 2025 12:53:30 +0100 Subject: [PATCH 369/587] Make description_hash verification optional (#1705) --- 57.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/57.md b/57.md index 3f55e57b..c37126e8 100644 --- a/57.md +++ b/57.md @@ -132,7 +132,7 @@ The following should be true of the `zap receipt` event: - `tags` MUST include the `p` tag (zap recipient) AND optional `e` tag from the `zap request` AND optional `a` tag from the `zap request` AND optional `P` tag from the pubkey of the zap request (zap sender). - The `zap receipt` MUST have a `bolt11` tag containing the description hash bolt11 invoice. - The `zap receipt` MUST contain a `description` tag which is the JSON-encoded zap request. -- `SHA256(description)` MUST match the description hash in the bolt11 invoice. +- `SHA256(description)` SHOULD match the description hash in the bolt11 invoice. - The `zap receipt` MAY contain a `preimage` tag to match against the payment hash of the bolt11 invoice. This isn't really a payment proof, there is no real way to prove that the invoice is real or has been paid. You are trusting the author of the `zap receipt` for the legitimacy of the payment. The `zap receipt` is not a proof of payment, all it proves is that some nostr user fetched an invoice. The existence of the `zap receipt` implies the invoice as paid, but it could be a lie given a rogue implementation. From c79ffe0a1c9d0ca86a7e7e1a1c746ad4edf8352a Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Fri, 7 Feb 2025 10:55:24 -0500 Subject: [PATCH 370/587] Clearly informs that kind 1 replies can only be used with kind 1 events. (#1690) --- 10.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/10.md b/10.md index 064e56a0..1aefb227 100644 --- a/10.md +++ b/10.md @@ -10,8 +10,6 @@ This NIP defines `kind:1` as a simple plaintext note. ## Abstract -This NIP describes how to use "e" and "p" tags in text events, especially those that are replies to other text events. It helps clients thread the replies into a tree rooted at the original event. - The `.content` property contains some human-readable text. `e` and `p` tags can be used to define note threads, replies and mentions. @@ -19,6 +17,9 @@ The `.content` property contains some human-readable text. Markup languages such as markdown and HTML SHOULD NOT be used. ## Marked "e" tags (PREFERRED) + +Kind 1 events with `e` tags are replies to other kind 1 events. Kind 1 replies MUST NOT be used to reply to other kinds, use [NIP-22](22.md) instead. + `["e", <event-id>, <relay-url>, <marker>, <pubkey>]` Where: From 546b897fd763ef54bafdb453f005b6f81f1fbab8 Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Fri, 7 Feb 2025 12:56:49 -0300 Subject: [PATCH 371/587] NIP-22: what is an I-tag? (#1757) --- 22.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/22.md b/22.md index 2ad1fd81..8eff09a9 100644 --- a/22.md +++ b/22.md @@ -6,7 +6,7 @@ Comment `draft` `optional` -A comment is a threading note always scoped to a root event or an `I`-tag. +A comment is a threading note always scoped to a root event or an [`I`-tag](73.md). It uses `kind:1111` with plaintext `.content` (no HTML, Markdown, or other formatting). @@ -198,4 +198,3 @@ A reply to a podcast comment: // other fields } ``` - From 57c84cc87a75e8598004530556fc5988dfc26c49 Mon Sep 17 00:00:00 2001 From: greenart7c3 <115044884+greenart7c3@users.noreply.github.com> Date: Fri, 7 Feb 2025 16:21:19 -0300 Subject: [PATCH 372/587] [NIP-55] - Add the rejected permission check in the code samples (#1755) --- 55.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/55.md b/55.md index afca0aab..a897bd65 100644 --- a/55.md +++ b/55.md @@ -339,6 +339,8 @@ If the user chose to always reject the event, signer application will return the ```kotlin if (result == null) return + if (it.getColumnIndex("rejected") > -1) return + if (result.moveToFirst()) { val index = it.getColumnIndex("result") if (index < 0) return @@ -364,6 +366,8 @@ If the user chose to always reject the event, signer application will return the ```kotlin if (result == null) return + if (it.getColumnIndex("rejected") > -1) return + if (result.moveToFirst()) { val index = it.getColumnIndex("result") val indexJson = it.getColumnIndex("event") @@ -390,6 +394,8 @@ If the user chose to always reject the event, signer application will return the ```kotlin if (result == null) return + if (it.getColumnIndex("rejected") > -1) return + if (result.moveToFirst()) { val index = it.getColumnIndex("result") val encryptedText = it.getString(index) @@ -414,6 +420,8 @@ If the user chose to always reject the event, signer application will return the ```kotlin if (result == null) return + if (it.getColumnIndex("rejected") > -1) return + if (result.moveToFirst()) { val index = it.getColumnIndex("result") val encryptedText = it.getString(index) @@ -438,6 +446,8 @@ If the user chose to always reject the event, signer application will return the ```kotlin if (result == null) return + if (it.getColumnIndex("rejected") > -1) return + if (result.moveToFirst()) { val index = it.getColumnIndex("result") val encryptedText = it.getString(index) @@ -462,6 +472,8 @@ If the user chose to always reject the event, signer application will return the ```kotlin if (result == null) return + if (it.getColumnIndex("rejected") > -1) return + if (result.moveToFirst()) { val index = it.getColumnIndex("result") val encryptedText = it.getString(index) @@ -486,6 +498,8 @@ If the user chose to always reject the event, signer application will return the ```kotlin if (result == null) return + if (it.getColumnIndex("rejected") > -1) return + if (result.moveToFirst()) { val index = it.getColumnIndex("result") val relayJsonText = it.getString(index) @@ -510,6 +524,8 @@ If the user chose to always reject the event, signer application will return the ```kotlin if (result == null) return + if (it.getColumnIndex("rejected") > -1) return + if (result.moveToFirst()) { val index = it.getColumnIndex("result") val eventJson = it.getString(index) From 0023ca818c759f46cd357a812dca98abfd9824b8 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Fri, 7 Feb 2025 14:59:59 -0500 Subject: [PATCH 373/587] Removes mention marker from NIP-10 in support of `q` tags (#1750) --- 10.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/10.md b/10.md index 1aefb227..9fd4415e 100644 --- a/10.md +++ b/10.md @@ -12,7 +12,15 @@ This NIP defines `kind:1` as a simple plaintext note. The `.content` property contains some human-readable text. -`e` and `p` tags can be used to define note threads, replies and mentions. +`e` tags can be used to define note thread roots and replies. They SHOULD be sorted by the reply stack from root to the direct parent. + +`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>"] +``` + +Authors of the `e` and `q` tags SHOULD be added as `p` tags to notify of a new reply or quote. Markup languages such as markdown and HTML SHOULD NOT be used. @@ -26,10 +34,10 @@ Where: * `<event-id>` is the id of the event being referenced. * `<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 `""`. - * `<marker>` is optional and if present is one of `"reply"`, `"root"`, or `"mention"`. + * `<marker>` is optional and if present is one of `"reply"`, `"root"`. * `<pubkey>` is optional, SHOULD be the pubkey of the author of the referenced event -Those marked with `"reply"` denote the id of the reply event being responded to. Those marked with `"root"` denote the root id of the reply thread being responded to. For top level replies (those replying directly to the root event), only the `"root"` marker should be used. Those marked with `"mention"` denote a quoted or reposted event id. +Those marked with `"reply"` denote the id of the reply event being responded to. Those marked with `"root"` denote the root id of the reply thread being responded to. For top level replies (those replying directly to the root event), only the `"root"` marker should be used. A direct reply to the root of a thread should have a single marked "e" tag of type "root". From 75f246ed987c23c99d77bfa6aeeb1afb669e23f7 Mon Sep 17 00:00:00 2001 From: Roland <33993199+rolznz@users.noreply.github.com> Date: Sat, 8 Feb 2025 03:25:31 +0700 Subject: [PATCH 374/587] docs: clarify NIP-47 key usage (#1756) --- 47.md | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/47.md b/47.md index f15dc014..84f710e2 100644 --- a/47.md +++ b/47.md @@ -1,7 +1,7 @@ NIP-47 ====== -Nostr Wallet Connect +Nostr Wallet Connect (NWC) -------------------- `draft` `optional` @@ -17,6 +17,9 @@ This NIP describes a way for clients to access a remote lightning wallet through * **wallet service**: Nostr app that typically runs on an always-on computer (eg. in the cloud or on a Raspberry Pi). This app has access to the APIs of the wallets it serves. ## Theory of Operation + +Fundamentally NWC is communication between a **client** and **wallet service** by the means of E2E-encrypted direct messages over a nostr relay. The relay knows the kinds and tags of notes, but not the content of the encrypted payloads. The **user**'s identity key is not used to avoid linking payment activity to the user. Ideally unique keys are used for each individual connection. + 1. **Users** who wish to use this NIP to allow **client(s)** to interact with their wallet must first acquire a special "connection" URI from their NIP-47 compliant wallet application. The wallet application may provide this URI using a QR screen, or a pasteable string, or some other means. 2. The **user** should then copy this URI into their **client(s)** by pasting, or scanning the QR, etc. The **client(s)** should save this URI and use it later whenever the **user** (or the **client** on the user's behalf) wants to interact with the wallet. The **client** should then request an `info` (13194) event from the relay(s) specified in the URI. The **wallet service** will have sent that event to those relays earlier, and the relays will hold it as a replaceable event. @@ -45,7 +48,7 @@ If the **wallet service** supports notifications, the info event SHOULD contain ### Request and Response Events -Both 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. +Both 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 **client** if this is a response. The response event SHOULD contain an `e` tag with the id of the request event it is responding to. Optionally, 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. The content of requests and responses is encrypted with [NIP04](04.md), and is a JSON-RPCish object with a semi-fixed structure: @@ -80,7 +83,7 @@ If the command was successful, the `error` field must be null. ### Notification Events -The notification event SHOULD contain one `p` tag, the public key of the **user**. +The notification event SHOULD contain one `p` tag, the public key of the **client**. The content of notifications is encrypted with [NIP04](04.md), and is a JSON-RPCish object with a semi-fixed structure: @@ -105,19 +108,27 @@ The content of notifications is encrypted with [NIP04](04.md), and is a JSON-RPC - `OTHER`: Other error. ## Nostr Wallet Connect URI -**client** discovers **wallet service** by scanning a QR code, handling a deeplink or pasting in a URI. -The **wallet service** generates this connection URI with protocol `nostr+walletconnect://` and base path its hex-encoded `pubkey` with the following query string parameters: +Communication between the **client** and **wallet service** requires two keys in order to encrypt and decrypt messages. The connection URI includes the secret key of the **client** and only the public key of the **wallet service**. + +The **client** discovers **wallet service** by scanning a QR code, handling a deeplink or pasting in a URI. + +The **wallet service** generates this connection URI with protocol `nostr+walletconnect://` and base path its 32-byte hex-encoded `pubkey`, which SHOULD be unique per client connection. + +The connection URI contains the following query string parameters: - `relay` Required. URL of the relay where the **wallet service** is connected and will be listening for events. May be more than one. -- `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**. +- `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**. The **wallet service** MUST use the corresponding public key of this secret to communicate with the **client**. - Authorization does not require passing keys back and forth. - The user can have different keys for different applications. Keys can be revoked and created at will and have arbitrary constraints (eg. budgets). - The key is harder to leak since it is not shown to the user and backed up. - It improves privacy because the user's main key would not be linked to their payments. - `lud16` Recommended. A lightning address that clients can use to automatically setup the `lud16` field on the user's profile if they have none configured. -The **client** should then store this connection and use it when the user wants to perform actions like paying an invoice. Due to this NIP using ephemeral events, it is recommended to pick relays that do not close connections on inactivity to not drop events. +The **client** should then store this connection and use it when the user wants to perform actions like paying an invoice. Due to this NIP using ephemeral events, it is recommended to pick relays that do not close connections on inactivity to not drop events, and ideally retain the events until they are either consumed or become stale. + +- When the **client** sends or receives a message it will use the `secret` from the connection URI and **wallet service**'s `pubkey` to encrypt or decrypt. +- When the **wallet service** sends or receives a message it will use its own secret and the corresponding pubkey of the **client's** `secret` to encrypt or decrypt. The **wallet service** SHOULD NOT store the secret it generates for the client and MUST NOT rely on the knowing the **client** secret for general operation. ### Example connection string ```sh From ab861e98c146a28e289e724d6a7453d10395257d Mon Sep 17 00:00:00 2001 From: "P. Reis" <patrickpereirareal1@gmail.com> Date: Sat, 8 Feb 2025 09:49:00 -0300 Subject: [PATCH 375/587] NIP-61: nitpick (#1765) --- 61.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/61.md b/61.md index ffe7c523..7b7b2ce4 100644 --- a/61.md +++ b/61.md @@ -48,7 +48,7 @@ Clients MUST prefix the public key they P2PK-lock with `"02"` (for nostr<>cashu { kind: 9321, content: "Thanks for this great idea.", - pubkey: "sender-pubkey", + pubkey: "<sender-pubkey>", tags: [ [ "proof", "{\"amount\":1,\"C\":\"02277c66191736eb72fce9d975d08e3191f8f96afb73ab1eec37e4465683066d3f\",\"id\":\"000a93d6f8a1d2c4\",\"secret\":\"[\\\"P2PK\\\",{\\\"nonce\\\":\\\"b00bdd0467b0090a25bdf2d2f0d45ac4e355c482c1418350f273a04fedaaee83\\\",\\\"data\\\":\\\"02eaee8939e3565e48cc62967e2fde9d8e2a4b3ec0081f29eceff5c64ef10ac1ed\\\"}]\"}" ], [ "u", "https://stablenut.umint.cash" ], From 5991afb9cf7ec06866d9f9afd7ec2359109a3b2a Mon Sep 17 00:00:00 2001 From: Zig Blathazar <42387185+ZigBalthazar@users.noreply.github.com> Date: Sat, 8 Feb 2025 16:27:38 +0330 Subject: [PATCH 376/587] add restricted to standardized machine-readable prefixes (#1685) --- 01.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/01.md b/01.md index 5873eb63..e2b4ad44 100644 --- a/01.md +++ b/01.md @@ -168,9 +168,10 @@ This NIP defines no rules for how `NOTICE` messages should be sent or treated. * `["OK", "b1a649ebe8...", false, "rate-limited: slow down there chief"]` * `["OK", "b1a649ebe8...", false, "invalid: event creation date is too far off from the current time"]` * `["OK", "b1a649ebe8...", false, "pow: difficulty 26 is less than 30"]` + * `["OK", "b1a649ebe8...", false, "restricted: not allowed to write."]` * `["OK", "b1a649ebe8...", false, "error: could not connect to the database"]` - `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: * `["CLOSED", "sub1", "unsupported: filter contains unknown elements"]` * `["CLOSED", "sub1", "error: could not connect to the database"]` * `["CLOSED", "sub1", "error: shutting down idle subscription"]` -- The standardized machine-readable prefixes for `OK` and `CLOSED` are: `duplicate`, `pow`, `blocked`, `rate-limited`, `invalid`, and `error` for when none of that fits. +- The standardized machine-readable prefixes for `OK` and `CLOSED` are: `duplicate`, `pow`, `blocked`, `rate-limited`, `invalid`, `restricted`, and `error` for when none of that fits. From e41185867f60061bb12ae092c6f7162571c06891 Mon Sep 17 00:00:00 2001 From: Oscar Merry <MerryOscar@users.noreply.github.com> Date: Sun, 9 Feb 2025 23:51:52 +0000 Subject: [PATCH 377/587] NIP-53 Live Events - Optional Pinned Chat Messages (#1577) --- 53.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/53.md b/53.md index c3f15ea0..cd84e4fe 100644 --- a/53.md +++ b/53.md @@ -35,7 +35,8 @@ For example: ["p", "91cf9..4e5ca", "wss://provider1.com/", "Host", "<proof>"], ["p", "14aeb..8dad4", "wss://provider2.com/nostr", "Speaker"], ["p", "612ae..e610f", "ws://provider3.com/ws", "Participant"], - ["relays", "wss://one.com", "wss://two.com", /*...*/] + ["relays", "wss://one.com", "wss://two.com", /*...*/], + ["pinned", "<event id of pinned live chat message>"], ], "content": "", // other fields... @@ -75,6 +76,8 @@ Event `kind:1311` is live chat's channel message. Clients MUST include the `a` t } ``` +Hosts may choose to pin one or more live chat messages by updating the `pinned` tags in the live event kind `30311`. + ## Use Cases Common use cases include meeting rooms/workshops, watch-together activities, or event spaces, such as [zap.stream](https://zap.stream). From 60c6404bd1a7ab7d78fca905928c83987846ca13 Mon Sep 17 00:00:00 2001 From: "P. Reis" <patrickpereirareal1@gmail.com> Date: Mon, 10 Feb 2025 09:25:21 -0300 Subject: [PATCH 378/587] 61: nitpick (#1769) --- 61.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/61.md b/61.md index 7b7b2ce4..6e378066 100644 --- a/61.md +++ b/61.md @@ -52,7 +52,7 @@ Clients MUST prefix the public key they P2PK-lock with `"02"` (for nostr<>cashu tags: [ [ "proof", "{\"amount\":1,\"C\":\"02277c66191736eb72fce9d975d08e3191f8f96afb73ab1eec37e4465683066d3f\",\"id\":\"000a93d6f8a1d2c4\",\"secret\":\"[\\\"P2PK\\\",{\\\"nonce\\\":\\\"b00bdd0467b0090a25bdf2d2f0d45ac4e355c482c1418350f273a04fedaaee83\\\",\\\"data\\\":\\\"02eaee8939e3565e48cc62967e2fde9d8e2a4b3ec0081f29eceff5c64ef10ac1ed\\\"}]\"}" ], [ "u", "https://stablenut.umint.cash" ], - [ "e", "<zapped-event-id>", "<relay-hint>" ], + [ "e", "<nutzapped-event-id>", "<relay-hint>" ], [ "p", "e9fbced3a42dcf551486650cc752ab354347dd413b307484e4fd1818ab53f991" ], // recipient of nutzap ] } From 6e7a618e7f873bb91e743caacc3b09edab7796a0 Mon Sep 17 00:00:00 2001 From: water <130329555+water783@users.noreply.github.com> Date: Wed, 12 Feb 2025 01:28:17 +0800 Subject: [PATCH 379/587] Add Kind 15 for Encrypted File message (#1537) --- 17.md | 42 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 41 insertions(+), 1 deletion(-) diff --git a/17.md b/17.md index f091a969..1bc258d8 100644 --- a/17.md +++ b/17.md @@ -35,6 +35,46 @@ Tags that mention, quote and assemble threading structures MUST follow [NIP-10]( Kind `14`s MUST never be signed. If it is signed, the message might leak to relays and become **fully public**. +## File Message Kind + +```jsonc +{ + "id": "<usual hash>", + "pubkey": "<sender-pubkey>", + "created_at": "<current-time>", + "kind": 15, + "tags": [ + ["p", "<receiver-1-pubkey>", "<relay-url>"], + ["p", "<receiver-2-pubkey>", "<relay-url>"], + ["e", "<kind-14-id>", "<relay-url>", "reply"], // if this is a reply + ["subject", "<conversation-title>"], + ["file-type", "<file-mime-type>"], + ["encryption-algorithm", "<encryption-algorithm>"], + ["decryption-key", "<decryption-key>"], + ["decryptiion-nonce", "<decryption-nonce>"], + ["x", "<the SHA-256 hexencoded string of the file>"], + // rest of tags... + ], + "content": "<file-url>" +} +``` + +Kind 15 is used for sending encrypted file event messages: + +- `file-type`: Specifies the MIME type of the attached file (e.g., `image/jpeg`, `audio/mpeg`, etc.). +- `encryption-algorithm`: Indicates the encryption algorithm used for encrypting the file. Supported algorithms may include `aes-gcm`, `chacha20-poly1305`,`aes-cbc` etc. +- `decryption-key`: The decryption key that will be used by the recipient to decrypt the file. +- `decryption-nonce`: The decryption nonce that will be used by the recipient to decrypt the file. +- `content`: The URL of the file (`<file-url>`). +- `x` containing the SHA-256 hexencoded string of the file. +- `size` (optional) size of file in bytes +- `dim` (optional) size of file in pixels in the form `<width>x<height>` +- `blurhash`(optional) the [blurhash](https://github.com/woltapp/blurhash) to show while the file is being loaded by the client +- `thumb` (optional) url of thumbnail with same aspect ratio +- `fallback` (optional) zero or more fallback file sources in case `url` fails + +Just like kind 14, kind `15`s MUST never be signed. + ## Chat Rooms The 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. @@ -45,7 +85,7 @@ An optional `subject` tag defines the current name/topic of the conversation. An ## Encrypting -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. +Following [NIP-59](59.md), the **unsigned** `kind:14` & `kind:15` chat message must be sealed (`kind:13`) and then gift-wrapped (`kind:1059`) to each receiver and the sender individually. ```jsonc { From 81908b6e3fbc852181de9ed21cf244f525ff60af Mon Sep 17 00:00:00 2001 From: greenart7c3 <115044884+greenart7c3@users.noreply.github.com> Date: Thu, 13 Feb 2025 23:46:56 -0300 Subject: [PATCH 380/587] remove get_relays from signers (#1779) --- 07.md | 1 - 46.md | 1 - 55.md | 56 -------------------------------------------------------- 3 files changed, 58 deletions(-) diff --git a/07.md b/07.md index 9f836d87..294acd38 100644 --- a/07.md +++ b/07.md @@ -17,7 +17,6 @@ async window.nostr.signEvent(event: { created_at: number, kind: number, tags: st Aside from these two basic above, the following functions can also be implemented optionally: ``` -async window.nostr.getRelays(): { [url: string]: {read: boolean, write: boolean} } // returns a basic map of relay urls to relay policies async window.nostr.nip04.encrypt(pubkey, plaintext): string // returns ciphertext and iv as specified in nip-04 (deprecated) async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext and iv as specified in nip-04 (deprecated) async window.nostr.nip44.encrypt(pubkey, plaintext): string // returns ciphertext as specified in nip-44 diff --git a/46.md b/46.md index d1706285..17019649 100644 --- a/46.md +++ b/46.md @@ -100,7 +100,6 @@ Each of the following are methods that the _client_ sends to the _remote-signer_ | `connect` | `[<remote-signer-pubkey>, <optional_secret>, <optional_requested_permissions>]` | "ack" OR `<required-secret-value>` | | `sign_event` | `[<{kind, content, tags, created_at}>]` | `json_stringified(<signed_event>)` | | `ping` | `[]` | "pong" | -| `get_relays` | `[]` | `json_stringified({<relay_url>: {read: <boolean>, write: <boolean>}})` | | `get_public_key` | `[]` | `<user-pubkey>` | | `nip04_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip04_ciphertext>` | | `nip04_decrypt` | `[<third_party_pubkey>, <nip04_ciphertext_to_decrypt>]` | `<plaintext>` | diff --git a/55.md b/55.md index a897bd65..2b79f798 100644 --- a/55.md +++ b/55.md @@ -262,29 +262,6 @@ launcher.launch(intent) val id = intent.data?.getStringExtra("id") ``` -- **get_relays** - - params: - - ```kotlin - val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:")) - intent.`package` = "com.example.signer" - intent.putExtra("type", "get_relays") - // to control the result in your application in case you are not waiting the result before sending another intent - intent.putExtra("id", "some_id") - // Send the current logged in user pubkey - intent.putExtra("current_user", account.keyPair.pubkey) - - context.startActivity(intent) - ``` - - result: - - If the user approved intent it will return the **result** and **id** fields - - ```kotlin - val relayJsonText = intent.data?.getStringExtra("result") - // the id you sent - val id = intent.data?.getStringExtra("id") - ``` - - **decrypt_zap_event** - params: @@ -480,32 +457,6 @@ If the user chose to always reject the event, signer application will return the } ``` -- **get_relays** - - params: - - ```kotlin - val result = context.contentResolver.query( - Uri.parse("content://com.example.signer.GET_RELAYS"), - listOf("${logged_in_user_pubkey}"), - null, - null, - null - ) - ``` - - result: - - Will return the **result** column - - ```kotlin - if (result == null) return - - if (it.getColumnIndex("rejected") > -1) return - - if (result.moveToFirst()) { - val index = it.getColumnIndex("result") - val relayJsonText = it.getString(index) - } - ``` - - **decrypt_zap_event** - params: @@ -588,13 +539,6 @@ Android intents and browser urls have limitations, so if you are using the `retu window.href = `nostrsigner:${encryptedText}?pubkey=${hex_pub_key}&compressionType=none&returnType=signature&type=nip44_decrypt&callbackUrl=https://example.com/?event=`; ``` -- **get_relays** - - params: - - ```js - window.href = `nostrsigner:?compressionType=none&returnType=signature&type=get_relays&callbackUrl=https://example.com/?event=`; - ``` - - **decrypt_zap_event** - params: From f9f8b5042d406d523d4b09cafced77ae4902d244 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Fri, 14 Feb 2025 12:38:18 +0900 Subject: [PATCH 381/587] add kind 15 to list. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index dd3c0f74..fb05d9a7 100644 --- a/README.md +++ b/README.md @@ -119,6 +119,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `12` | Group Thread Reply | 29 (deprecated) | | `13` | Seal | [59](59.md) | | `14` | Direct Message | [17](17.md) | +| `15` | File Message | [17](17.md) | | `16` | Generic Repost | [18](18.md) | | `17` | Reaction to a website | [25](25.md) | | `20` | Picture | [68](68.md) | From 8e6f2c06c3ec88a6c478a783825ff1b07e1972fa Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Fri, 14 Feb 2025 11:14:43 -0300 Subject: [PATCH 382/587] add kind:10002 to nip51 (#1785) --- 51.md | 1 + README.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/51.md b/51.md index 87744c72..55834352 100644 --- a/51.md +++ b/51.md @@ -24,6 +24,7 @@ For example, _mute list_ can contain the public keys of spammers and bad actors | --- | --- | --- | --- | | Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags), `"word"` (lowercase string), `"e"` (threads) | | Pinned notes | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | +| Read/write relays | 10002 | where a user publishes to and where they expect mentions | see [NIP-65](65.md) | | Bookmarks | 10003 | uncategorized, "global" list of things a user wants to save | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) | | Communities | 10004 | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) | | Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) | diff --git a/README.md b/README.md index fb05d9a7..6ec75afb 100644 --- a/README.md +++ b/README.md @@ -169,7 +169,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `9802` | Highlights | [84](84.md) | | `10000` | Mute list | [51](51.md) | | `10001` | Pin list | [51](51.md) | -| `10002` | Relay List Metadata | [65](65.md) | +| `10002` | Relay List Metadata | [65](65.md), [51](51.md) | | `10003` | Bookmark list | [51](51.md) | | `10004` | Communities list | [51](51.md) | | `10005` | Public chats list | [51](51.md) | From 330de34c7cc8fc6f34e3dec076f20ceb1af94927 Mon Sep 17 00:00:00 2001 From: greenart7c3 <115044884+greenart7c3@users.noreply.github.com> Date: Mon, 17 Feb 2025 15:09:37 -0300 Subject: [PATCH 383/587] [NIP-55] Make it clear how to use the package name and what is the purpose of the intents and content resolvers (#1791) --- 55.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/55.md b/55.md index 2b79f798..4adc6b74 100644 --- a/55.md +++ b/55.md @@ -10,7 +10,7 @@ This NIP describes a method for 2-way communication between an Android signer an # Usage for Android applications -The Android signer uses Intents and Content Resolvers to communicate between applications. +The Android signer uses Intents (to accept/reject permissions manually) and Content Resolvers (to accept/reject permissions automatically in background if the user allowed it) to communicate between applications. To be able to use the Android signer in your application you should add this to your AndroidManifest.xml: @@ -66,7 +66,7 @@ Create the Intent using the **nostrsigner** scheme: val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$content")) ``` -Set the Signer package name: +Set the Signer package name after you receive the response from **get_public_key** method: ```kotlin intent.`package` = "com.example.signer" @@ -114,7 +114,6 @@ launcher.launch(intent) ```kotlin val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:")) - intent.`package` = "com.example.signer" intent.putExtra("type", "get_public_key") // You can send some default permissions for the user to authorize for ever val permissions = listOf( @@ -130,7 +129,7 @@ launcher.launch(intent) context.startActivity(intent) ``` - result: - - If the user approved intent it will return the **pubkey** in the result field + - If the user approved the intent it will return the **pubkey** in the result field and the signer packageName in the **package** field ```kotlin val pubkey = intent.data?.getStringExtra("result") From 619e3bea57860d4c3b1d3f97587727a94b12a82e Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Tue, 18 Feb 2025 22:08:36 -0500 Subject: [PATCH 384/587] Right to Vanish (#1256) Co-authored-by: fiatjaf_ <fiatjaf@gmail.com> Co-authored-by: K <kehiiiiya@gmail.com> --- 62.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 63 insertions(+) create mode 100644 62.md diff --git a/62.md b/62.md new file mode 100644 index 00000000..a00ddfc0 --- /dev/null +++ b/62.md @@ -0,0 +1,61 @@ +NIP-62 +====== + +Request to Vanish +----------------- + +`draft` `optional` + +This NIP offers a Nostr-native way to request a complete reset of a key's fingerprint on the web. This procedure is legally binding in some jurisdictions, and thus, supporters of this NIP should truly delete events from their database. + +## Request to Vanish from Relay + +Kind `62` requests a specific relay to delete everything, including [NIP-09](09.md) Deletion Events, from the `.pubkey` until its `.created_at`. + +```jsonc +{ + "kind": 62, + "pubkey": <32-byte hex-encoded public key of the event creator>, + "tags": [ + ["relay", "<relay url>"] + ], + "content": "<reason or note>", + //...other fields +} +``` + +The tag list MUST include at least one `relay` value. + +Content MAY include a reason or a legal notice to the relay operator. + +Relays MUST fully delete any events from the `.pubkey` if their service URL is tagged in the event. + +Relays SHOULD delete all [NIP-59](59.md) Gift Wraps that p-tagged the `.pubkey` if their service URL is tagged in the event, deleting all DMs to the pubkey. + +Relays MUST ensure the deleted events cannot be re-broadcasted into the relay. + +Relays MAY store the signed request to vanish for bookkeeping. + +Paid relays or relays that restrict who can post MUST also follow the request to vanish regardless of the user's status. + +Publishing a deletion request event (Kind `5`) against a request to vanish has no effect. Clients and relays are not obliged to support "unrequest vanish" functionality. + +Clients SHOULD send this event to the target relays only. + +## Global Request to Vanish + +To request ALL relays to delete everything, the event MUST include a `relay` tag with the value `ALL_RELAYS` in uppercase. + +```jsonc +{ + "kind": 62, + "pubkey": <32-byte hex-encoded public key of the event creator>, + "tags": [ + ["relay", "ALL_RELAYS"] + ], + "content": "<reason>", + //...other fields +} +``` + +Clients SHOULD broadcast this event to as many relays as possible. diff --git a/README.md b/README.md index 6ec75afb..7cb749dc 100644 --- a/README.md +++ b/README.md @@ -77,6 +77,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-59: Gift Wrap](59.md) - [NIP-60: Cashu Wallet](60.md) - [NIP-61: Nutzaps](61.md) +- [NIP-62: Request to Vanish](62.md) - [NIP-64: Chess (PGN)](64.md) - [NIP-65: Relay List Metadata](65.md) - [NIP-68: Picture-first feeds](68.md) @@ -130,6 +131,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `42` | Channel Message | [28](28.md) | | `43` | Channel Hide Message | [28](28.md) | | `44` | Channel Mute User | [28](28.md) | +| `62` | Request to Vanish | [62](62.md) | | `64` | Chess (PGN) | [64](64.md) | | `818` | Merge Requests | [54](54.md) | | `1018` | Poll Response | [88](88.md) | From 0f12cf111f0037eff402d9634a0a96f5cc1cd9d4 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Wed, 19 Feb 2025 10:36:45 -0500 Subject: [PATCH 385/587] Updates NIP-53 live chat to remove markers and add `q` tags (#1747) --- 53.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/53.md b/53.md index cd84e4fe..69d1c9f0 100644 --- a/53.md +++ b/53.md @@ -63,7 +63,7 @@ This feature is important to avoid malicious event owners adding large account h ### Live Chat Message -Event `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. +Event `kind:1311` is live chat's channel message. Clients MUST include the `a` tag of the activity. An `e` tag denotes the direct parent message this post is replying to. ```jsonc { @@ -76,6 +76,12 @@ Event `kind:1311` is live chat's channel message. Clients MUST include the `a` t } ``` +`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>"] +``` + Hosts may choose to pin one or more live chat messages by updating the `pinned` tags in the live event kind `30311`. ## Use Cases From 58287cd641e31999be154c9155dff39f6be138e6 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Wed, 19 Feb 2025 10:52:30 -0500 Subject: [PATCH 386/587] Updates NIP-27 to use `q` tags instead of "mention" markers (#1751) --- 27.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/27.md b/27.md index 133f8ef0..d75672ac 100644 --- a/27.md +++ b/27.md @@ -10,7 +10,7 @@ This document standardizes the treatment given by clients of inline references o When creating an event, clients should include mentions to other profiles and to other events in the middle of the `.content` using [NIP-21](21.md) codes, such as `nostr:nprofile1qqsw3dy8cpu...6x2argwghx6egsqstvg`. -Including [NIP-10](10.md)-style tags (`["e", <hex-id>, <relay-url>, <marker>]`) for each reference is optional, clients should do it whenever they want the profile being mentioned to be notified of the mention, or when they want the referenced event to recognize their mention as a reply. +Including [NIP-18](18.md)'s quote tags (`["q", "<event-id> or <event-address>", "<relay-url>", "<pubkey-if-a-regular-event>"]`) for each reference is optional, clients should do it whenever they want the profile being mentioned to be notified of the mention, or when they want the referenced event to recognize their mention as a reply. A reader client that receives an event with such `nostr:...` mentions in its `.content` can do any desired context augmentation (for example, linking to the profile or showing a preview of the mentioned event contents) it wants in the process. If turning such mentions into links, they could become internal links, [NIP-21](21.md) links or direct links to web clients that will handle these references. From 0b6b69bcc7d76b6fa9a6d1c549df64a87b87e4a4 Mon Sep 17 00:00:00 2001 From: AsaiToshiya <to.asai.60@gmail.com> Date: Thu, 20 Feb 2025 00:58:25 +0900 Subject: [PATCH 387/587] add NIP-56 link to `x` tag. (#1724) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7cb749dc..79b75829 100644 --- a/README.md +++ b/README.md @@ -301,7 +301,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `s` | status | -- | [69](69.md) | | `t` | hashtag | -- | [24](24.md), [34](34.md), [35](35.md) | | `u` | url | -- | [61](61.md), [98](98.md) | -| `x` | infohash | -- | [35](35.md) | +| `x` | hash | -- | [35](35.md), [56](56.md) | | `y` | platform | -- | [69](69.md) | | `z` | order number | -- | [69](69.md) | | `-` | -- | -- | [70](70.md) | From 93d9a12f1693582b1a6231f8fe3e3832ba4fa8b3 Mon Sep 17 00:00:00 2001 From: AsaiToshiya <to.asai.60@gmail.com> Date: Thu, 20 Feb 2025 21:11:22 +0900 Subject: [PATCH 388/587] Update BREAKING.md --- BREAKING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/BREAKING.md b/BREAKING.md index ca79a0e5..c620a3f3 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -5,6 +5,8 @@ reverse chronological order. | Date | Commit | NIP | Change | | ----------- | --------- | -------- | ------ | +| 2025-02-14 | [81908b6e](https://github.com/nostr-protocol/nips/commit/81908b6e) | [07](07.md), [46](46.md), [55](55.md) | `getRelays` and `get_relays` were removed | +| 2025-02-07 | [0023ca81](https://github.com/nostr-protocol/nips/commit/0023ca81) | [10](10.md) | `"mention"` marker was removed | | 2025-01-31 | [6a4b125a](https://github.com/nostr-protocol/nips/commit/6a4b125a) | [71](71.md) | video events were changed to regular | | 2024-12-05 | [6d16019e](https://github.com/nostr-protocol/nips/commit/6d16019e) | [46](46.md) | message encryption was changed to NIP-44 | | 2024-11-12 | [2838e3bd](https://github.com/nostr-protocol/nips/commit/2838e3bd) | [29](29.md) | `kind: 12` and `kind: 10` were removed (use `kind: 1111` instead) | From 7cc120ecb01963e37f9adcd3b57b8efc1dd9e828 Mon Sep 17 00:00:00 2001 From: cypherhoodlum <82510823+cypherhoodlum@users.noreply.github.com> Date: Fri, 21 Feb 2025 13:57:03 +0000 Subject: [PATCH 389/587] Optional t tag to git repository announcements (#1798) --- 34.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/34.md b/34.md index 35bc1be0..f34badb4 100644 --- a/34.md +++ b/34.md @@ -22,9 +22,10 @@ Git repositories are hosted in Git-enabled servers, but their existence can be a ["description", "brief human-readable project description>"], ["web", "<url for browsing>", ...], // a webpage url, if the git server being used provides such a thing ["clone", "<url for git-cloning>", ...], // a url to be given to `git clone` so anyone can clone it - ["relays", "<relay-url>", ...] // relays that this repository will monitor for patches and issues - ["r", "<earliest-unique-commit-id>", "euc"] - ["maintainers", "<other-recognized-maintainer>", ...] + ["relays", "<relay-url>", ...], // relays that this repository will monitor for patches and issues + ["r", "<earliest-unique-commit-id>", "euc"], + ["maintainers", "<other-recognized-maintainer>", ...], + ["t", "<arbitrary string>"], // hashtags labelling the repository ] } ``` From 1e8b1bb16b4e449dadda0b3d82b031b182780cbb Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Wed, 26 Feb 2025 17:06:35 -0300 Subject: [PATCH 390/587] nip25: recommend that reactions do not include a million tags (#1811) --- 25.md | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/25.md b/25.md index 671c55fa..72109c0f 100644 --- a/25.md +++ b/25.md @@ -25,26 +25,21 @@ consider it a "+". Tags ---- -The reaction event SHOULD include `e` and `p` tags from the note the user is reacting to (and optionally `a` tags if the target is a replaceable event). This allows users to be notified of reactions to posts they were mentioned in. Including the `e` tags enables clients to pull all the reactions associated with individual posts or all the posts in a thread. `a` tags enables clients to seek reactions for all versions of a replaceable event. +There MUST be always an `e` tag set to the `id` of the event that is being reacted to. The `e` tag SHOULD include a relay hint pointing to a relay where the event being reacted to can be found. If a client decides to include other `e`, which not recommended, the target event `id` should be last of the `e` tags. -The last `e` tag MUST be the `id` of the note that is being reacted to. +The SHOULD be a `p` tag set to the `pubkey` of the event being reacted to. If a client decides to include other `p` tags, which not recommended, the target event `pubkey` should be last the `p` tags. -The last `p` tag MUST be the `pubkey` of the event being reacted to. +If the event being reacted to is an addressable event, an `a` SHOULD be included together with the `e` tag, it must be set to the coordinates (`kind:pubkey:d-tag`) of the event being reacted to. -The `a` tag MUST contain the coordinates (`kind:pubkey:d-tag`) of the replaceable being reacted to. +The reaction SHOULD include a `k` tag with the stringified kind number of the reacted event as its value. -The reaction event MAY include a `k` tag with the stringified kind number of the reacted event as its value. - -Example code +**Example code** ```swift func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> NostrEvent { - var tags: [[String]] = liked.tags.filter { - tag in tag.count >= 2 && (tag[0] == "e" || tag[0] == "p") - } - tags.append(["e", liked.id]) + tags.append(["e", liked.id, liked.source_relays.first ?? ""]) tags.append(["p", liked.pubkey]) - tags.append(["k", liked.kind]) + tags.append(["k", String(liked.kind)]) let ev = NostrEvent(content: "+", pubkey: pubkey, kind: 7, tags: tags) ev.calculate_id() ev.sign(privkey: privkey) From a3cd55fb332fcde424e8895b10e0ce02834efcb7 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Wed, 26 Feb 2025 20:14:45 -0500 Subject: [PATCH 391/587] NIP-17: Removes the need for markers and adds the use of `q` tags. (#1748) --- 17.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/17.md b/17.md index 1bc258d8..487d01ed 100644 --- a/17.md +++ b/17.md @@ -21,7 +21,7 @@ Kind `14` is a chat message. `p` tags identify one or more receivers of the mess   "tags": [     ["p", "<receiver-1-pubkey>", "<relay-url>"],     ["p", "<receiver-2-pubkey>", "<relay-url>"], -    ["e", "<kind-14-id>", "<relay-url>", "reply"] // if this is a reply +    ["e", "<kind-14-id>", "<relay-url>"] // if this is a reply ["subject", "<conversation-title>"],     // rest of tags...   ], @@ -31,7 +31,13 @@ Kind `14` is a chat message. `p` tags identify one or more receivers of the mess `.content` MUST be plain text. Fields `id` and `created_at` are required. -Tags that mention, quote and assemble threading structures MUST follow [NIP-10](10.md). +An `e` tag denotes the direct parent message this post is replying to. + +`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>"] +``` Kind `14`s MUST never be signed. If it is signed, the message might leak to relays and become **fully public**. From 84c3d14afa4dcea609452a0ae1e359dbdef6bc6d Mon Sep 17 00:00:00 2001 From: greenart7c3 <115044884+greenart7c3@users.noreply.github.com> Date: Fri, 28 Feb 2025 20:55:35 -0300 Subject: [PATCH 392/587] [NIP-55] Add a warning message when using web intents (#1457) Co-authored-by: dluvian <133484344+dluvian@users.noreply.github.com> --- 55.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/55.md b/55.md index 4adc6b74..6d2b92a5 100644 --- a/55.md +++ b/55.md @@ -484,6 +484,8 @@ If the user chose to always reject the event, signer application will return the # Usage for Web Applications +You should consider using [NIP-46: Nostr Connect](46.md) for a better experience for web applications. When using this approach, the web app can't call the signer in the background, so the user will see a popup for every event you try to sign. + Since web applications can't receive a result from the intent, you should add a modal to paste the signature or the event json or create a callback url. If you send the callback url parameter, Signer Application will send the result to the url. From 89fac599f68643cbd60b2ca14a53ef6582e4d475 Mon Sep 17 00:00:00 2001 From: Sandwich <299465+dskvr@users.noreply.github.com> Date: Mon, 3 Mar 2025 18:03:10 +0100 Subject: [PATCH 393/587] NIP-66 Relay Discovery and Liveness Monitoring (Draft 7) (#230) Co-authored-by: dskvr <dskvr@users.noreply.github.com> --- 66.md | 250 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 250 insertions(+) create mode 100644 66.md diff --git a/66.md b/66.md new file mode 100644 index 00000000..b242e856 --- /dev/null +++ b/66.md @@ -0,0 +1,250 @@ +# NIP-66: Relay Discovery and Liveness Monitoring + +`draft` `optional` + +You want to find relays. You may want to discover relays based on criteria that's up to date. You may even want to ensure that you have a complete dataset. You probably want to filter relays based on their reported liveness. + +In its purest form: + +```json +{ + "kind": 30166, + "created_at": 1722173222, + "content": "{}", + "tags": [ + [ "d", "wss://somerelay.abc/" ] + ], + "pubkey": "<pubkey>", + "sig": "<signature>", + "id": "<eventid>" +} +``` + +This event signals that the relay at `wss://somerelay.abc/` was reported "online" by `<pubkey>` at timestamp `1722173222`. This event **MAY** be extended upon to include more information. + +## Kinds +`NIP-66` defines two (2) event kinds, `30166` and `10166` + +| kind | name | description | +|-------|----------------------------|-----------------------------------------------------------------------------------------| +| [30166](#k30166) | Relay Discovery | A PRE that is published by a monitor when a relay is online | +| [10166](#k10166) | Relay Monitor Announcement | An RE that stores data that signals the intent of a pubkey to monitor relays and publish `30166` events at a regular _frequency_ | + +## Ontology +- `Relay Operator`: someone who operates a relay +- `Monitor`: A pubkey that monitors relays and publishes `30166` events at the frequency specified in their `10166` event. +- `Ad-hoc Monitor`: A pubkey that monitors relays and publishes `30166` events at an irregular frequency. +- `Monitor Service`: A group or individual that monitors relays using one or more `Monitors`. +- `Check`: a specific data point that is tested or aggregated by a monitor. + +## `30166`: "Relay Discovery" <a id="k30166"></a> + +### Summary +`30166` is a `NIP-33` Parameterized-Replaceable Event [PRE], referred to as a "Relay Discovery" event. These events are optimized with a small footprint for protocol-level relay Discovery. + +### Purpose +Discovery of relays over nostr. + +### Schema + +#### Content +`30166` content fields **SHOULD** include the stringified JSON of the relay's NIP-11 informational document. This data **MAY** be provided for informational purposes only. + +#### `created_at` +The `created_at` field in a NIP-66 event should reflect the time when the relay liveness (and potentially other data points) was checked. + +#### `tags` + +##### Meta Tags (unindexed) +- `rtt-open` The relay's open **round-trip time** in milliseconds. +- `rtt-read` The relay's read **round-trip time** in milliseconds. +- `rtt-write` The relay's write **round-trip time** in milliseconds. + +_Other `rtt` values **MAY** be present. This NIP should be updated if there is value found in more `rtt` values._ + +##### Single Letter Tags (indexed) +- `d` The relay URL/URI. The `#d` tag **must** be included in the `event.tags[]` array. Index position `1` **must** be the relay websocket URL/URI. If a URL it **SHOULD** be [normalized](https://datatracker.ietf.org/doc/html/rfc3986#section-6). For relays not accessible via conventional means but rather by an npub/pubkey, an npub/pubkey **MAY** be used in place of a URL. + ```json + [ "d", "wss://somerelay.abc/"] + ``` + +- `n`: Network + ```json + [ "n", "clearnet" ] + ``` + +- `T`: Relay Type. Enumerated [relay type](https://github.com/nostr-protocol/nips/issues/1282) formatted as `PascalCase` + ```json + ["T", "PrivateInbox" ] + ``` + +- `N`: Supported Nips _From NIP-11 "Informational Document" `nip11.supported_nips[]`_ + ```json + [ "N", "42" ] + ``` + +- `R`: Requirements _NIP-11 "Informational Document" `nip11.limitations.payment_required`, `nip11.limitations.auth_required` and/or any other boolean value within `nip11.limitations[]` that is added in the future_ + ```json + [ "R", "payment" ], + [ "R", "auth" ], + ``` + Since the nostr protocol does not currently support filtering on whether an indexed tag **is** or **is not** set, to make "public" and "no auth" relays discoverable requires a `!` flag + + ```json + [ "R", "!payment" ], //no payment required, is public + [ "R", "!auth" ], //no authentication required + ``` + +- `t`: "Topics" _From NIP-11 "Informational Document" `nip11.tags[]`_ + ```json + [ "t", "nsfw" ] + ``` + +- `k`: Accepted/Blocked Kinds [`NIP-22`] + ```json + [ "k", "0" ], + [ "k", "3" ], + [ "k", "10002" ] + ``` + + or for blocked kinds + + ```json + [ "k", "!0" ] + [ "k", "!3" ], + [ "k", "!10002" ] + ``` + +- `g`: `NIP-52` `g` tags (geohash) + ```json + [ "g", "9r1652whz" ] + ``` + +- `30166` **MAY** be extended with global tags defined by other NIPs that do no collide with locally defined indices, including but not limited to: `p`, `t`, `e`, `a`, `i` and `l/L`. + +#### Robust Example of a `30166` Event +_Relay was online, and you can filter on a number of different tags_ +```json +{ + "id": "<eventid>", + "pubkey": "<monitor's pubkey>", + "created_at": "<created_at [some recent date ...]>", + "signature": "<signature>", + "content": "{}", + "kind": 30166, + "tags": [ + ["d","wss://some.relay/"], + ["n", "clearnet"], + ["N", "40"], + ["N", "33"], + ["R", "!payment"], + ["R", "auth"], + ["g", "ww8p1r4t8"], + ["p", "somehexkey..."], + ["l", "en", "ISO-639-1"], + ["t", "nsfw" ], + ["rtt-open", 234 ] + ] +} +``` + +## `10166`: "Relay Monitor Announcement" Events <a id="k10166"></a> + +### Summary +`10166` is a replacable event herein referred to as "Relay Monitor Announcement" events. These events contain information about a publisher's intent to monitor and publish data as `30166` events. This event is optional and is intended for monitors who intend to provide monitoring services at a regular and predictable frequency. + +### Purpose +To provide a directory of monitors, their intent to publish, their criteria and parameters of monitoring activities. Absence of this event implies the monitor is ad-hoc and does not publish events at a predictable frequency, and relies on mechanisms to infer data integrity, such as web-of-trust. + +### Schema + +#### Standard Tags + +- `frequency` The frequency **in seconds** at which the monitor publishes events. A string-integer at index `1` represents the expected frequency the monitor will publish `30166` events. There should only be `1` frequency per monitor. + + ```json + [ "frequency", "3600" ] + ``` + +- `timeout` (optional) The timeout values for various checks conducted by a monitor. Index `1` is the monitor's timeout in milliseconds. Index `2` describes what test the timeout is used for. If no index `2` is provided, it is inferred that the timeout provided applies to all tests. These values can assist relay operators in understanding data signaled by the monitor in _Relay Discovery Events_. + ```json + [ "timeout", "2000", "open" ], + [ "timeout", "2000", "read" ], + [ "timeout", "3000", "write" ], + [ "timeout", "2000", "nip11" ], + [ "timeout", "4000", "ssl" ] + ``` + +#### Indexed Tags +- `c` "Checks" **SHOULD** be a lowercase string describing the check(s) conducted by a monitor. Due to the rapidly evolving nature of relays, enumeration is organic and not strictly defined. But examples of some checks could be websocket `open/read/write/auth`, `nip11` checks, `dns` and `geo` checks, and and any other checks the monitor may deem useful.. Other checks **MAY** be included. New types of checks **SHOULD** be added to this NIP as they are needed. + ```json + [ "c", "ws" ], + [ "c", "nip11" ], + [ "c", "dns" ], + [ "c", "geo" ], + [ "c", "ssl" ], + ``` + +- `g`: `NIP-52` `g` tags (geohash) + ```json + [ "g", "9r1652whz" ] + ``` + +- Any other globally defined indexable tags **MAY** be included as found necessary. + +### Other Requirements +Monitors **SHOULD** have the following +- A published `0` (NIP-1) event +- A published `10002` (NIP-65) event that defines the relays the monitor publishes to. + +### Robust Example of a `10166` Event +```json +{ + "id": "<eventid>", + "pubkey": "<monitor's pubkey>", + "created_at": "<created_at [some recent date ...]>", + "signature": "<signature>", + "content": "", + "tags": [ + + [ "timeout", "open", "5000" ], + [ "timeout", "read", "3000" ], + [ "timeout", "write", "3000" ], + [ "timeout", "nip11", "3000" ], + + [ "frequency", "3600" ], + + [ "c", "ws" ], + [ "c", "nip11" ], + [ "c", "ssl" ], + [ "c", "dns" ], + [ "c", "geo" ] + + [ "g", "ww8p1r4t8" ] + ] +} +``` + +## Methodology + +### Monitors +1. A _Relay Monitor_ checks the liveness and potentially other attributes of a relay. + +2. _Relay Monitor_ publishes a kind `30166` note when a relay it is monitoring is online. If the monitor has a `10166` event, events should be published at the frequency defined in their `10166` note. + +_Any pubkey that publishes `30166` events **SHOULD** at a minimum be checking that the relay is available by websocket and behaves like a relay_ + +### Clients +1. In most cases, a client **SHOULD** filter on `30166` events using either a statically or dynamically defined monitor's `pubkey` and a `created_at` value respective of the monitor's published `frequency`. If the monitor has no stated frequency, other mechanisms should be employed to determine data integrity. + +2. _Relay Liveness_ is subjectively determined by the client, starting with the `frequency` value of a monitor. + +3. The liveness of a _Relay Monitor_ can be subjectively determined by detecting whether the _Relay Monitor_ has published events with respect to `frequency` value of any particular monitor. + +4. The reliability and trustworthiness of a _Relay Monitor_ could be established via web-of-trust, reviews or similar mechanisms. + +## Risk Mitigation + +- When a client implements `NIP-66` events, the client should have a fallback if `NIP-66` events cannot be located. + +- A `Monitor` or `Ad-hoc Monitor` may publish erroneous `30166` events, intentionally or otherwise. Therefor, it's important to program defensively to limit the impact of such events. This can be achieved with web-of-trust, reviews, fallbacks and/or data-aggregation for example. From 64d4e3ea3e0affa49efbcbe088837947e51a7154 Mon Sep 17 00:00:00 2001 From: AsaiToshiya <to.asai.60@gmail.com> Date: Tue, 4 Mar 2025 12:35:37 +0900 Subject: [PATCH 394/587] add NIP-66 to README. --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 79b75829..61558365 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-62: Request to Vanish](62.md) - [NIP-64: Chess (PGN)](64.md) - [NIP-65: Relay List Metadata](65.md) +- [NIP-66: Relay Discovery and Liveness Monitoring](66.md) - [NIP-68: Picture-first feeds](68.md) - [NIP-69: Peer-to-peer Order events](69.md) - [NIP-70: Protected Events](70.md) @@ -185,6 +186,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10050` | Relay list to receive DMs | [51](51.md), [17](17.md) | | `10063` | User server list | [Blossom][blossom] | | `10096` | File storage server list | [96](96.md) | +| `10166` | Relay Monitor Announcement | [66](66.md) | | `13194` | Wallet Info | [47](47.md) | | `17375` | Cashu Wallet Event | [60](60.md) | | `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | @@ -215,6 +217,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30041` | Modular Article Content | [NKBIP-01] | | `30063` | Release artifact sets | [51](51.md) | | `30078` | Application-specific Data | [78](78.md) | +| `30166` | Relay Discovery | [66](66.md) | | `30267` | App curation sets | [51](51.md) | | `30311` | Live Event | [53](53.md) | | `30315` | User Statuses | [38](38.md) | From d662d97c66da015b96eabf1cff691d6278297582 Mon Sep 17 00:00:00 2001 From: AsaiToshiya <to.asai.60@gmail.com> Date: Tue, 4 Mar 2025 19:00:26 +0900 Subject: [PATCH 395/587] NIP-66: fix "PRE" to "addressable event". (#1820) --- 66.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/66.md b/66.md index b242e856..30c11fb6 100644 --- a/66.md +++ b/66.md @@ -27,7 +27,7 @@ This event signals that the relay at `wss://somerelay.abc/` was reported "online | kind | name | description | |-------|----------------------------|-----------------------------------------------------------------------------------------| -| [30166](#k30166) | Relay Discovery | A PRE that is published by a monitor when a relay is online | +| [30166](#k30166) | Relay Discovery | An addressable event that is published by a monitor when a relay is online | | [10166](#k10166) | Relay Monitor Announcement | An RE that stores data that signals the intent of a pubkey to monitor relays and publish `30166` events at a regular _frequency_ | ## Ontology @@ -40,7 +40,7 @@ This event signals that the relay at `wss://somerelay.abc/` was reported "online ## `30166`: "Relay Discovery" <a id="k30166"></a> ### Summary -`30166` is a `NIP-33` Parameterized-Replaceable Event [PRE], referred to as a "Relay Discovery" event. These events are optimized with a small footprint for protocol-level relay Discovery. +`30166` is a `NIP-33` addressable event, referred to as a "Relay Discovery" event. These events are optimized with a small footprint for protocol-level relay Discovery. ### Purpose Discovery of relays over nostr. From 0ed88ee0bdf97f7bce9924472ec08f9b63c56dcb Mon Sep 17 00:00:00 2001 From: Alex Gleason <alex@alexgleason.me> Date: Tue, 4 Mar 2025 19:26:54 -0600 Subject: [PATCH 396/587] NIP-01 `a` tag clarification (#1825) --- 01.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/01.md b/01.md index e2b4ad44..f7f592c3 100644 --- a/01.md +++ b/01.md @@ -78,8 +78,8 @@ This NIP defines 3 standard tags that can be used across all event kinds with th - The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, <recommended relay URL, optional>, <32-bytes lowercase hex of the author's pubkey, optional>]` - The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, <recommended relay URL, optional>]` - The `a` tag, used to refer to an addressable or replaceable event - - for an addressable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]` - - for a normal replaceable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:, <recommended relay URL, optional>]` + - for an addressable event: `["a", "<kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>", <recommended relay URL, optional>]` + - for a normal replaceable event: `["a", "<kind integer>:<32-bytes lowercase hex of a pubkey>:", <recommended relay URL, optional>]` (note: include the trailing colon) As 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. From 078ffd873e13997d47c3fb45788e18b670e8a990 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Thu, 6 Mar 2025 15:06:05 -0500 Subject: [PATCH 397/587] Long form with NIP-22 comments (#1830) --- 23.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/23.md b/23.md index e5e85ff9..2586ac0c 100644 --- a/23.md +++ b/23.md @@ -60,3 +60,7 @@ References to other Nostr notes, articles or profiles must be made according to "id": "..." } ``` + +### Replies & Comments + +Replies to `kind 30023` MUST use [NIP-22](./22.md) `kind 1111` comments. \ No newline at end of file From 7a9e2ec87d31a0ef455f0b0d5ee6713e0fd1ca65 Mon Sep 17 00:00:00 2001 From: Silberengel <153727378+SilberWitch@users.noreply.github.com> Date: Sat, 8 Mar 2025 13:58:59 -0800 Subject: [PATCH 398/587] NKBIPs added and updated (#1775) --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 61558365..6f3ff02c 100644 --- a/README.md +++ b/README.md @@ -127,6 +127,10 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `20` | Picture | [68](68.md) | | `21` | Video Event | [71](71.md) | | `22` | Short-form Portrait Video Event | [71](71.md) | +| `30` | internal reference | [NKBIP-03] | +| `31` | external web reference | [NKBIP-03] | +| `32` | hardcopy reference | [NKBIP-03] | +| `33` | prompt reference | [NKBIP-03] | | `40` | Channel Creation | [28](28.md) | | `41` | Channel Metadata | [28](28.md) | | `42` | Channel Message | [28](28.md) | @@ -213,8 +217,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30023` | Long-form Content | [23](23.md) | | `30024` | Draft Long-form Content | [23](23.md) | | `30030` | Emoji sets | [51](51.md) | -| `30040` | Modular Article Header | [NKBIP-01] | -| `30041` | Modular Article Content | [NKBIP-01] | +| `30040` | Curated Publication Index | [NKBIP-01] | +| `30041` | Curated Publication Content | [NKBIP-01] | | `30063` | Release artifact sets | [51](51.md) | | `30078` | Application-specific Data | [78](78.md) | | `30166` | Relay Discovery | [66](66.md) | @@ -248,8 +252,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos [cornychat-slideset]: https://cornychat.com/datatypes#kind30388slideset [cornychat-linkset]: https://cornychat.com/datatypes#kind31388linkset [joinstr]: https://gitlab.com/1440000bytes/joinstr/-/blob/main/NIP.md -[NKBIP-01]: https://wikistr.com/nkbip-01 -[NKBIP-02]: https://wikistr.com/nkbip-02 +[NKBIP-01]: https://wikistr.com/nkbip-01*fd208ee8c8f283780a9552896e4823cc9dc6bfd442063889577106940fd927c1 +[NKBIP-02]: https://wikistr.com/nkbip-02*fd208ee8c8f283780a9552896e4823cc9dc6bfd442063889577106940fd927c1 +[NKBIP-03]: https://wikistr.com/nkbip-03*fd208ee8c8f283780a9552896e4823cc9dc6bfd442063889577106940fd927c1 [blossom]: https://github.com/hzrd149/blossom [Tidal-nostr]: https://wikistr.com/tidal-nostr @@ -379,4 +384,4 @@ All NIPs are public domain. <a align="center" href="https://github.com/nostr-protocol/nips/graphs/contributors"> <img src="https://contrib.rocks/image?repo=nostr-protocol/nips" /> -</a> +</a> \ No newline at end of file From bf699c9bc15e16d78a2bd805626e8813446e5d31 Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Mon, 10 Mar 2025 11:05:51 -0300 Subject: [PATCH 399/587] nip73: change "k" tags standard for webpage comments to a hardcoded `web` (#1836) --- 73.md | 37 +++++++++++++++++++++++-------------- 1 file changed, 23 insertions(+), 14 deletions(-) diff --git a/73.md b/73.md index afed8d12..d15c5b23 100644 --- a/73.md +++ b/73.md @@ -9,26 +9,37 @@ External Content IDs There 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. -`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. +`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. ## Supported IDs -| Type | `i` tag | `k` tag | -|- | - | - | -| URLs | "`<URL, normalized, no fragment>`" | "`<scheme-host, normalized>`" | -| Hashtags | "#`<topic, lowercase>`" | "#" | -| Geohashes| "geo:`<geohash, lowercase>`" | "geo" | -| Books | "isbn:`<id, without hyphens>`" | "isbn" | -| Podcast Feeds | "podcast:guid:`<guid>`" | "podcast:guid" | -| Podcast Episodes | "podcast:item:guid:`<guid>`" | "podcast:item:guid" | -| Podcast Publishers | "podcast:publisher:guid:`<guid>`" | "podcast:publisher:guid" | -| Movies | "isan:`<id, without version part>`" | "isan" | -| Papers | "doi:`<id, lowercase>`" | "doi" | +| Type | `i` tag | `k` tag | +| --- | --- | --- | +| URLs | "`<URL, normalized, no fragment>`" | "web" | +| Hashtags | "#`<topic, lowercase>`" | "#" | +| Geohashes | "geo:`<geohash, lowercase>`" | "geo" | +| Books | "isbn:`<id, without hyphens>`" | "isbn" | +| Podcast Feeds | "podcast:guid:`<guid>`" | "podcast:guid" | +| Podcast Episodes | "podcast:item:guid:`<guid>`" | "podcast:item:guid" | +| Podcast Publishers | "podcast:publisher:guid:`<guid>`" | "podcast:publisher:guid" | +| Movies | "isan:`<id, without version part>`" | "isan" | +| Papers | "doi:`<id, lowercase>`" | "doi" | --- ## Examples +### Webpages + +For the webpage "https://myblog.example.com/post/2012-03-27/hello-world" the "i" and "k" tags are: + +```jsonc +[ + ["i","https://myblog.example.com/post/2012-03-27/hello-world"], + ["k", "web"] +] +``` + ### Books: - Book ISBN: `["i", "isbn:9780765382030"]` - https://isbnsearch.org/isbn/9780765382030 @@ -56,5 +67,3 @@ Each `i` tag MAY have a url hint as the second argument to redirect people to a `["i", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f", https://fountain.fm/episode/z1y9TMQRuqXl2awyrQxg]` `["i", "isan:0000-0000-401A-0000-7", https://www.imdb.com/title/tt0120737]` - - From 0619f370bca3485bb9c5870bc2defa03c7c3d10e Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Thu, 13 Mar 2025 09:23:35 -0400 Subject: [PATCH 400/587] NIP-17 Typos and grammar improvements (#1840) --- 17.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/17.md b/17.md index 487d01ed..4383308c 100644 --- a/17.md +++ b/17.md @@ -57,7 +57,7 @@ Kind `14`s MUST never be signed. If it is signed, the message might leak to rela ["file-type", "<file-mime-type>"], ["encryption-algorithm", "<encryption-algorithm>"], ["decryption-key", "<decryption-key>"], - ["decryptiion-nonce", "<decryption-nonce>"], + ["decryption-nonce", "<decryption-nonce>"], ["x", "<the SHA-256 hexencoded string of the file>"], // rest of tags... ], @@ -74,16 +74,16 @@ Kind 15 is used for sending encrypted file event messages: - `content`: The URL of the file (`<file-url>`). - `x` containing the SHA-256 hexencoded string of the file. - `size` (optional) size of file in bytes -- `dim` (optional) size of file in pixels in the form `<width>x<height>` -- `blurhash`(optional) the [blurhash](https://github.com/woltapp/blurhash) to show while the file is being loaded by the client -- `thumb` (optional) url of thumbnail with same aspect ratio +- `dim` (optional) size of the file in pixels in the form `<width>x<height>` +- `blurhash`(optional) the [blurhash](https://github.com/woltapp/blurhash) to show while the client is loading the file +- `thumb` (optional) URL of thumbnail with same aspect ratio (encrypted with the same key, nonce) - `fallback` (optional) zero or more fallback file sources in case `url` fails Just like kind 14, kind `15`s MUST never be signed. ## Chat Rooms -The 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. +The 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 a clean message history. Clients SHOULD render messages of the same room in a continuous thread. @@ -91,7 +91,7 @@ An optional `subject` tag defines the current name/topic of the conversation. An ## Encrypting -Following [NIP-59](59.md), the **unsigned** `kind:14` & `kind:15` chat message must be sealed (`kind:13`) and then gift-wrapped (`kind:1059`) to each receiver and the sender individually. +Following [NIP-59](59.md), the **unsigned** `kind:14` & `kind:15` chat messages must be sealed (`kind:13`) and then gift-wrapped (`kind:1059`) to each receiver and the sender individually. ```jsonc { @@ -173,7 +173,7 @@ The main limitation of this approach is having to send a separate encrypted even Clients 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. -When 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. +When 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. ## Examples From 86fc82ce4affe1f10fa5cab787a710105217b26c Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Wed, 26 Mar 2025 08:38:47 -0400 Subject: [PATCH 401/587] Deprecates git replies in favor of NIP-22 (#1744) --- 34.md | 19 +------------------ README.md | 2 +- 2 files changed, 2 insertions(+), 19 deletions(-) diff --git a/34.md b/34.md index f34badb4..56ede853 100644 --- a/34.md +++ b/34.md @@ -125,24 +125,7 @@ Issues may have a `subject` tag, which clients can utilize to display a header. ## Replies -Replies are also Markdown text. The difference is that they MUST be issued as replies to either a `kind:1621` _issue_ or a `kind:1617` _patch_ event. The threading of replies and patches should follow NIP-10 rules. - -```jsonc -{ - "kind": 1622, - "content": "<markdown text>", - "tags": [ - ["a", "30617:<base-repo-owner-pubkey>:<base-repo-id>", "<relay-url>"], - ["e", "<issue-or-patch-id-hex>", "", "root"], - - // other "e" and "p" tags should be applied here when necessary, following the threading rules of NIP-10 - ["p", "<patch-author-pubkey-hex>", "", "mention"], - ["e", "<previous-reply-id-hex>", "", "reply"], - // rest of tags... - ], - // other fields... -} -``` +Replies to either a `kind:1621` _issue_ or a `kind:1617` _patch_ event should follow [NIP-22 comment](22.md). ## Status diff --git a/README.md b/README.md index 6f3ff02c..cc985dda 100644 --- a/README.md +++ b/README.md @@ -150,7 +150,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `1311` | Live Chat Message | [53](53.md) | | `1617` | Patches | [34](34.md) | | `1621` | Issues | [34](34.md) | -| `1622` | Replies | [34](34.md) | +| `1622` | Git Replies (deprecated) | [34](34.md) | | `1630`-`1633` | Status | [34](34.md) | | `1971` | Problem Tracker | [nostrocket][nostrocket] | | `1984` | Reporting | [56](56.md) | From 7dad42c1cffc0a32fa4eeb43631e12f6bc0091a4 Mon Sep 17 00:00:00 2001 From: Christian Chiarulli <chris.machine@pm.me> Date: Sat, 29 Mar 2025 15:29:33 -0400 Subject: [PATCH 402/587] NIP-C0: Code snippets (#1852) --- 95.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 95.md diff --git a/95.md b/95.md new file mode 100644 index 00000000..3dd7f26a --- /dev/null +++ b/95.md @@ -0,0 +1,65 @@ +# NIP-95: Code Snippets + +`draft` `optional` + +## Abstract + +This NIP defines a new event kind for sharing and storing code snippets. Unlike regular text notes (`kind:1`), code snippets have specialized metadata like language, extension, and other code-specific attributes that enhance discoverability, syntax highlighting, and improved user experience. + +## Event Kind + +This NIP defines `kind:1337` as a code snippet event. + +The `.content` field contains the actual code snippet text. + +## Optional Tags + +- `l` - Programming language name (lowercase). Examples: "javascript", "python", "rust" +- `name` - Name of the code snippet, commonly a filename. Examples: "hello-world.js", "quick-sort.py" +- `extension` - File extension (without the dot). Examples: "js", "py", "rs" +- `description` - Brief description of what the code does +- `runtime` - Runtime or environment specification (e.g., "node v18.15.0", "python 3.11") +- `license` - License under which the code is shared (e.g., "MIT", "GPL-3.0", "Apache-2.0") +- `dep` - Dependency required for the code to run (can be repeated) +- `repo` - Reference to a repository where this code originates + +## Format + +```json +{ + "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", + "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", + "created_at": <Unix timestamp in seconds>, + "kind": 1337, + "content": "function helloWorld() {\n console.log('Hello, Nostr!');\n}\n\nhelloWorld();", + "tags": [ + ["l", "javascript"], + ["extension", "js"], + ["name", "hello-world.js"], + ["description", "A basic JavaScript function that prints 'Hello, Nostr!' to the console"], + ["runtime", "node v18.15.0"], + ["license", "MIT"], + ["repo", "https://github.com/nostr-protocol/nostr"] + ], + "sig": "<64-bytes signature of the id>" +} +``` + +## Client Behavior + +Clients that support this NIP SHOULD: + +1. Display code snippets with proper syntax highlighting based on the language. +2. Allow copying the full code snippet with a single action. +3. Render the code with appropriate formatting, preserving whitespace and indentation. +4. Display the language and extension prominently. +5. Provide "run" functionality for supported languages when possible. +6. Display the description (if available) as part of the snippet presentation. + +Clients MAY provide additional functionality such as: + +1. Code editing capabilities +2. Forking/modifying snippets +3. Creating executable environments based on the runtime/dependencies +4. Downloading the snippet as a file using the provided extension +5. Sharing the snippet with attribution From f90101406592134e5f9c27c5e81fad3ee670e9c1 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Sat, 29 Mar 2025 16:29:58 -0300 Subject: [PATCH 403/587] rename 95 to C0. --- 95.md => C0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename 95.md => C0.md (99%) diff --git a/95.md b/C0.md similarity index 99% rename from 95.md rename to C0.md index 3dd7f26a..02cd6c97 100644 --- a/95.md +++ b/C0.md @@ -1,4 +1,4 @@ -# NIP-95: Code Snippets +# NIP-C0: Code Snippets `draft` `optional` From ca9904f0424a2200fa326117ae8188491fd869ac Mon Sep 17 00:00:00 2001 From: mono <102149418+TsukemonoGit@users.noreply.github.com> Date: Sun, 30 Mar 2025 09:31:03 +0900 Subject: [PATCH 404/587] Add birth field to NIP-24 for birth date representation (#1793) --- 24.md | 1 + 1 file changed, 1 insertion(+) diff --git a/24.md b/24.md index df3a9323..5904efb7 100644 --- a/24.md +++ b/24.md @@ -17,6 +17,7 @@ These are extra fields not specified in NIP-01 that may be present in the string - `website`: a web URL related in any way to the event author. - `banner`: an URL to a wide (~1024x768) picture to be optionally displayed in the background of a profile screen. - `bot`: a boolean to clarify that the content is entirely or partially the result of automation, such as with chatbots or newsfeeds. + - `birthday`: an object representing the author's birth date. The format is { "year": number, "month": number, "day": number }. Each field MAY be omitted. ### Deprecated fields From 9821b0e999be6d8093691fdadc34f94fd1a12a9a Mon Sep 17 00:00:00 2001 From: AsaiToshiya <to.asai.60@gmail.com> Date: Sun, 30 Mar 2025 10:03:27 +0900 Subject: [PATCH 405/587] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cc985dda..c57564d1 100644 --- a/README.md +++ b/README.md @@ -100,6 +100,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-98: HTTP Auth](98.md) - [NIP-99: Classified Listings](99.md) - [NIP-7D: Threads](7D.md) +- [NIP-C0: Code Snippets](C0.md) - [NIP-C7: Chats](C7.md) ## Event Kinds @@ -148,6 +149,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `1068` | Poll | [88](88.md) | | `1111` | Comment | [22](22.md) | | `1311` | Live Chat Message | [53](53.md) | +| `1337` | Code Snippet | [C0](C0.md) | | `1617` | Patches | [34](34.md) | | `1621` | Issues | [34](34.md) | | `1622` | Git Replies (deprecated) | [34](34.md) | @@ -384,4 +386,4 @@ All NIPs are public domain. <a align="center" href="https://github.com/nostr-protocol/nips/graphs/contributors"> <img src="https://contrib.rocks/image?repo=nostr-protocol/nips" /> -</a> \ No newline at end of file +</a> From 67145a72b25c7db33592705c744d70ae8685e5a3 Mon Sep 17 00:00:00 2001 From: Xavier Damman <xdamman@gmail.com> Date: Wed, 2 Apr 2025 15:09:54 +0200 Subject: [PATCH 406/587] added blockchain transactions and addresses to NIP-73 (#1846) --- 73.md | 82 ++++++++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 70 insertions(+), 12 deletions(-) diff --git a/73.md b/73.md index d15c5b23..db3b14c6 100644 --- a/73.md +++ b/73.md @@ -13,29 +13,87 @@ There are certain established global content identifiers such as [Book ISBNs](ht ## Supported IDs -| Type | `i` tag | `k` tag | -| --- | --- | --- | -| URLs | "`<URL, normalized, no fragment>`" | "web" | -| Hashtags | "#`<topic, lowercase>`" | "#" | -| Geohashes | "geo:`<geohash, lowercase>`" | "geo" | -| Books | "isbn:`<id, without hyphens>`" | "isbn" | -| Podcast Feeds | "podcast:guid:`<guid>`" | "podcast:guid" | -| Podcast Episodes | "podcast:item:guid:`<guid>`" | "podcast:item:guid" | -| Podcast Publishers | "podcast:publisher:guid:`<guid>`" | "podcast:publisher:guid" | -| Movies | "isan:`<id, without version part>`" | "isan" | -| Papers | "doi:`<id, lowercase>`" | "doi" | +| Type | `i` tag | `k` tag | +| --- | --- | --- | +| Blockchain Transaction | "`<blockchain>`:[`<chainId>`:]tx:`<txid, hex, lowercase>`" | "`<blockchain>`:tx" | +| Blockchain Address | "`<blockchain>`:[`<chainId>`:]address:`<address>`" | "`<blockchain>`:address" | +| Books | "isbn:`<id, without hyphens>`" | "isbn" | +| Geohashes | "geo:`<geohash, lowercase>`" | "geo" | +| Hashtags | "#`<topic, lowercase>`" | "#" | +| Movies | "isan:`<id, without version part>`" | "isan" | +| Papers | "doi:`<id, lowercase>`" | "doi" | +| Podcast Feeds | "podcast:guid:`<guid>`" | "podcast:guid" | +| Podcast Episodes | "podcast:item:guid:`<guid>`" | "podcast:item:guid" | +| Podcast Publishers | "podcast:publisher:guid:`<guid>`" | "podcast:publisher:guid" | +| URLs | "`<URL, normalized, no fragment>`" | "web" | --- ## Examples +### Blockchain + +`<blockchain>` can be any layer 1 chain (`bitcoin`, `ethereum`, `solana`, ...). If necessary (e.g. for ethereum), you can specify a `<chainId>`. + +#### Bitcoin + +``` +bitcoin:address:<bech32, lowercase | base58, case sensitive> +bitcoin:tx:<txid, hex, lowercase> +``` + +E.g. https://blockstream.info/tx/a1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d + +```jsonc +[ + ["i", "bitcoin:tx:a1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"], + ["k", "bitcoin:tx"] +] +``` + +E.g. https://blockstream.info/address/1HQ3Go3ggs8pFnXuHVHRytPCq5fGG8Hbhx + +```jsonc +[ + ["i", "bitcoin:address:1HQ3Go3ggs8pFnXuHVHRytPCq5fGG8Hbhx"], + ["k", "bitcoin:address"] +] +``` + +#### Ethereum (and other EVM chains) + +``` +ethereum:<chainId, integer>:tx:<txHash, hex, lowercase> +ethereum:<chainId, integer>:address:<hex, lowercase> +``` + +E.g. https://etherscan.io/address/0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045 + +```jsonc +[ + ["i", "ethereum:1:address:0xd8da6bf26964af9d7eed9e03e53415d37aa96045"], + ["k", "ethereum:address"] +] +``` + +E.g. https://gnosisscan.io/tx/0x98f7812be496f97f80e2e98d66358d1fc733cf34176a8356d171ea7fbbe97ccd + +```jsonc +[ + ["i", "ethereum:100:tx:0x98f7812be496f97f80e2e98d66358d1fc733cf34176a8356d171ea7fbbe97ccd"], + ["k", "ethereum:tx"] +] +``` + + + ### Webpages For the webpage "https://myblog.example.com/post/2012-03-27/hello-world" the "i" and "k" tags are: ```jsonc [ - ["i","https://myblog.example.com/post/2012-03-27/hello-world"], + ["i", "https://myblog.example.com/post/2012-03-27/hello-world"], ["k", "web"] ] ``` From 8f676dc0a55e75564b54d96bcadf787b61654219 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Wed, 2 Apr 2025 10:11:54 -0300 Subject: [PATCH 407/587] nip73: bring back previous ordering. --- 73.md | 67 ++++++++++++++++++++++++++++++----------------------------- 1 file changed, 34 insertions(+), 33 deletions(-) diff --git a/73.md b/73.md index db3b14c6..d883e791 100644 --- a/73.md +++ b/73.md @@ -15,22 +15,52 @@ There are certain established global content identifiers such as [Book ISBNs](ht | Type | `i` tag | `k` tag | | --- | --- | --- | -| Blockchain Transaction | "`<blockchain>`:[`<chainId>`:]tx:`<txid, hex, lowercase>`" | "`<blockchain>`:tx" | -| Blockchain Address | "`<blockchain>`:[`<chainId>`:]address:`<address>`" | "`<blockchain>`:address" | +| URLs | "`<URL, normalized, no fragment>`" | "web" | | Books | "isbn:`<id, without hyphens>`" | "isbn" | | Geohashes | "geo:`<geohash, lowercase>`" | "geo" | -| Hashtags | "#`<topic, lowercase>`" | "#" | | Movies | "isan:`<id, without version part>`" | "isan" | | Papers | "doi:`<id, lowercase>`" | "doi" | +| Hashtags | "#`<topic, lowercase>`" | "#" | | Podcast Feeds | "podcast:guid:`<guid>`" | "podcast:guid" | | Podcast Episodes | "podcast:item:guid:`<guid>`" | "podcast:item:guid" | | Podcast Publishers | "podcast:publisher:guid:`<guid>`" | "podcast:publisher:guid" | -| URLs | "`<URL, normalized, no fragment>`" | "web" | +| Blockchain Transaction | "`<blockchain>`:[`<chainId>`:]tx:`<txid, hex, lowercase>`" | "`<blockchain>`:tx" | +| Blockchain Address | "`<blockchain>`:[`<chainId>`:]address:`<address>`" | "`<blockchain>`:address" | --- ## Examples + +### Webpages + +For the webpage "https://myblog.example.com/post/2012-03-27/hello-world" the "i" and "k" tags are: + +```jsonc +[ + ["i", "https://myblog.example.com/post/2012-03-27/hello-world"], + ["k", "web"] +] +``` + +### Books: + +- Book ISBN: `["i", "isbn:9780765382030"]` - https://isbnsearch.org/isbn/9780765382030 + +Book 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. + +### Podcasts: + +- Podcast RSS Feed GUID: `["i", "podcast:guid:c90e609a-df1e-596a-bd5e-57bcc8aad6cc"]` - https://podcastindex.org/podcast/c90e609a-df1e-596a-bd5e-57bcc8aad6cc +- Podcast RSS Item GUID: `["i", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f"]` +- Podcast RSS Publisher GUID: `["i", "podcast:publisher:guid:18bcbf10-6701-4ffb-b255-bc057390d738"]` + +### Movies: + +- Movie ISAN: `["i", "isan:0000-0000-401A-0000-7"]` - https://web.isan.org/public/en/isan/0000-0000-401A-0000-7 + +Movie 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 + ### Blockchain `<blockchain>` can be any layer 1 chain (`bitcoin`, `ethereum`, `solana`, ...). If necessary (e.g. for ethereum), you can specify a `<chainId>`. @@ -87,35 +117,6 @@ E.g. https://gnosisscan.io/tx/0x98f7812be496f97f80e2e98d66358d1fc733cf34176a8356 -### Webpages - -For the webpage "https://myblog.example.com/post/2012-03-27/hello-world" the "i" and "k" tags are: - -```jsonc -[ - ["i", "https://myblog.example.com/post/2012-03-27/hello-world"], - ["k", "web"] -] -``` - -### Books: - -- Book ISBN: `["i", "isbn:9780765382030"]` - https://isbnsearch.org/isbn/9780765382030 - -Book 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. - -### Podcasts: - -- Podcast RSS Feed GUID: `["i", "podcast:guid:c90e609a-df1e-596a-bd5e-57bcc8aad6cc"]` - https://podcastindex.org/podcast/c90e609a-df1e-596a-bd5e-57bcc8aad6cc -- Podcast RSS Item GUID: `["i", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f"]` -- Podcast RSS Publisher GUID: `["i", "podcast:publisher:guid:18bcbf10-6701-4ffb-b255-bc057390d738"]` - -### Movies: - -- Movie ISAN: `["i", "isan:0000-0000-401A-0000-7"]` - https://web.isan.org/public/en/isan/0000-0000-401A-0000-7 - -Movie 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 - --- ### Optional URL Hints From 3e8c33ee79e3d2eb46ca498eddadcc6ef1ef7329 Mon Sep 17 00:00:00 2001 From: Awiteb <a@4rs.nl> Date: Thu, 3 Apr 2025 14:07:46 +0300 Subject: [PATCH 408/587] NIP-C0: Add `NIP-C0` tags to standardized tags table (#1865) Co-authored-by: AsaiToshiya <to.asai.60@gmail.com> --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c57564d1..0a21119f 100644 --- a/README.md +++ b/README.md @@ -300,7 +300,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `I` | root external identity | -- | [22](22.md) | | `k` | kind | -- | [18](18.md), [25](25.md), [72](72.md), [73](73.md) | | `K` | root scope | -- | [22](22.md) | -| `l` | label, label namespace | -- | [32](32.md) | +| `l` | label, label namespace, language name| -- | [32](32.md), [C0](C0.md) | | `L` | label namespace | -- | [32](32.md) | | `m` | MIME type | -- | [94](94.md) | | `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md), [22](22.md) | @@ -323,17 +323,20 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `clone` | git clone URL | -- | [34](34.md) | | `content-warning` | reason | -- | [36](36.md) | | `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | -| `description` | description | -- | [34](34.md), [57](57.md), [58](58.md) | +| `dep` | Required dependency | -- | [C0][C0.md] | +| `description` | description | -- | [34](34.md), [57](57.md), [58](58.md), [C0][C0.md] | | `emoji` | shortcode, image URL | -- | [30](30.md) | | `encrypted` | -- | -- | [90](90.md) | +| `extension` | File extension | -- | [C0][C0.md] | | `expiration` | unix timestamp (string) | -- | [40](40.md) | | `file` | full path (string) | -- | [35](35.md) | | `goal` | event id (hex) | relay URL | [75](75.md) | | `image` | image URL | dimensions in pixels | [23](23.md), [52](52.md), [58](58.md) | | `imeta` | inline metadata | -- | [92](92.md) | +| `license` | License of the shared content | -- | [C0][C0.md] | | `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | | `location` | location string | -- | [52](52.md), [99](99.md) | -| `name` | name | -- | [34](34.md), [58](58.md), [72](72.md) | +| `name` | name | -- | [34](34.md), [58](58.md), [72](72.md), [C0][C0.md] | | `nonce` | random | difficulty | [13](13.md) | | `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | | `price` | price | currency, frequency | [99](99.md) | @@ -341,6 +344,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `published_at` | unix timestamp (string) | -- | [23](23.md) | | `relay` | relay url | -- | [42](42.md), [17](17.md) | | `relays` | relay list | -- | [57](57.md) | +| `repo` | Reference to the origin repository | -- | [C0](C0.md) | +| `runtime` | Runtime or environment specification | -- | [C0][C0.md] | | `server` | file storage server url | -- | [96](96.md) | | `subject` | subject | -- | [14](14.md), [17](17.md), [34](34.md) | | `summary` | summary | -- | [23](23.md), [52](52.md) | From d5907d094b4eace1d2269935202f8d4fbcc4c524 Mon Sep 17 00:00:00 2001 From: hodlbod <jstaab@protonmail.com> Date: Mon, 7 Apr 2025 09:43:01 -0700 Subject: [PATCH 409/587] Add note about re-publishing kind 10002 (#1801) Co-authored-by: Jon Staab <shtaab@gmail.com> --- 65.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/65.md b/65.md index df06de06..a4d34a53 100644 --- a/65.md +++ b/65.md @@ -63,6 +63,8 @@ This NIP allows Clients to connect directly with the most up-to-date relay set f 6. Clients SHOULD deduplicate connections by normalizing relay URIs according to [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986#section-6). +7. When publishing to a relay, clients SHOULD ensure the user's `kind 10002` is also available on that relay. Relays SHOULD accept and serve `kind 10002` notes for any pubkey whose notes they store. Relays MAY scrape the network for missing `kind 10002` events. The goal here is that for any note served from a relay the user can also request the author's relay selections as a way of bootstrapping further context discovery. + ## Related articles - [Outbox model](https://mikedilger.com/gossip-model/) - [What is the Outbox Model?](https://habla.news/u/hodlbod@coracle.social/8YjqXm4SKY-TauwjOfLXS) From 55f96bbeefdf0a9734a4edb24a69f034288e7a31 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Tue, 8 Apr 2025 10:56:38 -0400 Subject: [PATCH 410/587] Fixes C0 links (#1870) --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0a21119f..77430626 100644 --- a/README.md +++ b/README.md @@ -323,20 +323,20 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `clone` | git clone URL | -- | [34](34.md) | | `content-warning` | reason | -- | [36](36.md) | | `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | -| `dep` | Required dependency | -- | [C0][C0.md] | -| `description` | description | -- | [34](34.md), [57](57.md), [58](58.md), [C0][C0.md] | +| `dep` | Required dependency | -- | [C0](C0.md) | +| `description` | description | -- | [34](34.md), [57](57.md), [58](58.md), [C0](C0.md) | | `emoji` | shortcode, image URL | -- | [30](30.md) | | `encrypted` | -- | -- | [90](90.md) | -| `extension` | File extension | -- | [C0][C0.md] | +| `extension` | File extension | -- | [C0](C0.md) | | `expiration` | unix timestamp (string) | -- | [40](40.md) | | `file` | full path (string) | -- | [35](35.md) | | `goal` | event id (hex) | relay URL | [75](75.md) | | `image` | image URL | dimensions in pixels | [23](23.md), [52](52.md), [58](58.md) | | `imeta` | inline metadata | -- | [92](92.md) | -| `license` | License of the shared content | -- | [C0][C0.md] | +| `license` | License of the shared content | -- | [C0](C0.md) | | `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | | `location` | location string | -- | [52](52.md), [99](99.md) | -| `name` | name | -- | [34](34.md), [58](58.md), [72](72.md), [C0][C0.md] | +| `name` | name | -- | [34](34.md), [58](58.md), [72](72.md), [C0](C0.md) | | `nonce` | random | difficulty | [13](13.md) | | `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | | `price` | price | currency, frequency | [99](99.md) | @@ -345,7 +345,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `relay` | relay url | -- | [42](42.md), [17](17.md) | | `relays` | relay list | -- | [57](57.md) | | `repo` | Reference to the origin repository | -- | [C0](C0.md) | -| `runtime` | Runtime or environment specification | -- | [C0][C0.md] | +| `runtime` | Runtime or environment specification | -- | [C0](C0.md) | | `server` | file storage server url | -- | [96](96.md) | | `subject` | subject | -- | [14](14.md), [17](17.md), [34](34.md) | | `summary` | summary | -- | [23](23.md), [52](52.md) | From 611b6351863e128f470576586f0e2b9a75f19039 Mon Sep 17 00:00:00 2001 From: "k." <kehiiiiya@gmail.com> Date: Sun, 13 Apr 2025 20:45:24 +0330 Subject: [PATCH 411/587] nip-11: remove max filters, add max/default query limit, update example. (#1821) --- 11.md | 115 +++++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 73 insertions(+), 42 deletions(-) diff --git a/11.md b/11.md index 8af4f313..8a15a265 100644 --- a/11.md +++ b/11.md @@ -80,15 +80,14 @@ Extra Fields ### Server Limitations These are limitations imposed by the relay on clients. Your client -should expect that requests which exceed these *practical* limitations +should expect that requests exceed these *practical* limitations are rejected or fail immediately. ```jsonc { "limitation": { "max_message_length": 16384, - "max_subscriptions": 20, - "max_filters": 100, + "max_subscriptions": 300, "max_limit": 5000, "max_subid_length": 100, "max_event_tags": 100, @@ -98,33 +97,30 @@ are rejected or fail immediately. "payment_required": true, "restricted_writes": true, "created_at_lower_limit": 31536000, - "created_at_upper_limit": 3 + "created_at_upper_limit": 3, + "default_limit": 500 }, // other fields... } ``` -- `max_message_length`: this is the maximum number of bytes for incoming JSON that the relay +- `max_message_length`: the maximum number of bytes for incoming JSON that the relay will attempt to decode and act upon. When you send large subscriptions, you will be limited by this value. It also effectively limits the maximum size of any event. Value is -calculated from `[` to `]` and is after UTF-8 serialization (so some unicode characters +calculated from `[` to `]` after UTF-8 serialization (so some unicode characters will cost 2-3 bytes). It is equal to the maximum size of the WebSocket message frame. - `max_subscriptions`: total number of subscriptions that may be -active on a single websocket connection to this relay. It's possible -that authenticated clients with a (paid) relationship to the relay +active on a single websocket connection to this relay. Authenticated clients with a (paid) relationship to the relay may have higher limits. -- `max_filters`: maximum number of filter values in each subscription. -Must be one or higher. - - `max_subid_length`: maximum length of subscription id as a string. - `max_limit`: the relay server will clamp each filter's `limit` value to this number. This means the client won't be able to get more than this number of events from a single subscription filter. This clamping is typically done silently by the relay, but with this number, you can know that there are additional results -if you narrowed your filter's time range or other parameters. +if you narrow your filter's time range or other parameters. - `max_event_tags`: in any event, this is the maximum number of elements in the `tags` list. @@ -142,7 +138,7 @@ Even if set to False, authentication may be required for specific actions. - `payment_required`: this relay requires payment before a new connection may perform any action. -- `restricted_writes`: this relay requires some kind of condition to be fulfilled in order to +- `restricted_writes`: this relay requires some kind of condition to be fulfilled to accept events (not necessarily, but including `payment_required` and `min_pow_difficulty`). This should only be set to `true` when users are expected to know the relay policy before trying to write to it -- like belonging to a special pubkey-based whitelist or writing only events of @@ -152,6 +148,8 @@ a specific niche kind or content. Normal anti-spam heuristics, for example, do n - `created_at_upper_limit`: 'created_at' upper limit +- `default_limit`: The maximum returned events if you send a filter with the limit set to 0. + ### Event Retention There may be a cost associated with storing data forever, so relays @@ -212,7 +210,7 @@ flexibility is up to the client software. ``` - `relay_countries`: a list of two-level ISO country codes (ISO 3166-1 alpha-2) whose - laws and policies may affect this relay. `EU` may be used for European Union countries. + laws and policies may affect this relay. `EU` may be used for European Union countries. A `*` can be used for global relays. Remember that a relay may be hosted in a country which is not the country of the legal entities who own the relay, so it's very @@ -237,7 +235,7 @@ To support this goal, relays MAY specify some of the following values. - `language_tags` is an ordered list of [IETF language tags](https://en.wikipedia.org/wiki/IETF_language_tag) indicating - the major languages spoken on the relay. + the major languages spoken on the relay. A `*` can be used for global relays. - `tags` is a list of limitations on the topics to be discussed. For example `sfw-only` indicates that only "Safe For Work" content @@ -276,49 +274,82 @@ Relays that require payments may want to expose their fee schedules. ### Examples -As of 2 May 2023 the following command provided these results: +As of 25 March 2025 the following command provided these results: ```bash -$ curl -H "Accept: application/nostr+json" https://eden.nostr.land | jq +curl -H "Accept: application/nostr+json" https://jellyfish.land | jq ``` ```json { - "description": "nostr.land family of relays (us-or-01)", - "name": "nostr.land", - "pubkey": "52b4a076bcbbbdc3a1aefa3735816cf74993b1b8db202b01c883c58be7fad8bd", - "software": "custom", + "name": "JellyFish", + "description": "Stay Immortal!", + "banner": "https://image.nostr.build/7fdefea2dec1f1ec25b8ce69362566c13b2b7f13f1726c2e4584f05f64f62496.jpg", + "pubkey": "bf2bee5281149c7c350f5d12ae32f514c7864ff10805182f4178538c2c421007", + "contact": "hi@dezh.tech", + "software": "https://github.com/dezh-tech/immortal", "supported_nips": [ 1, - 2, - 4, 9, 11, - 12, - 16, - 20, - 22, - 28, - 33, - 40 + 13, + 17, + 40, + 42, + 59, + 62, + 70 ], - "version": "1.0.1", - "limitation": { - "payment_required": true, - "max_message_length": 65535, - "max_event_tags": 2000, - "max_subscriptions": 20, - "auth_required": false - }, - "payments_url": "https://eden.nostr.land", + "version": "immortal - 0.0.9", + "relay_countries": [ + "*" + ], + "language_tags": [ + "*" + ], + "tags": [], + "posting_policy": "https://jellyfish.land/tos.txt", + "payments_url": "https://jellyfish.land/relay", + "icon": "https://image.nostr.build/2547e9ec4b23589e09bc7071e0806c3d4293f76284c58ff331a64bce978aaee8.jpg", + "retention": [], "fees": { "subscription": [ { - "amount": 2500000, - "unit": "msats", - "period": 2592000 + "amount": 3000, + "period": 2628003, + "unit": "sats" + }, + { + "amount": 8000, + "period": 7884009, + "unit": "sats" + }, + { + "amount": 15000, + "period": 15768018, + "unit": "sats" + }, + { + "amount": 28000, + "period": 31536036, + "unit": "sats" } ] }, + "limitation": { + "auth_required": false, + "max_message_length": 70000, + "max_subid_length": 256, + "max_subscriptions": 350, + "min_pow_difficulty": 0, + "payment_required": true, + "restricted_writes": true, + "max_event_tags": 2000, + "max_content_length": 70000, + "created_at_lower_limit": 0, + "created_at_upper_limit": 2147483647, + "default_limit": 500, + "max_limit": 5000 + } } ``` From 45f6d598a19321a98592e1f4fdf0b40707871f26 Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Tue, 15 Apr 2025 18:07:49 -0300 Subject: [PATCH 412/587] Shrink NIP-65 so it is clearer (#1879) Co-authored-by: Vitor Pamplona <vitor@vitorpamplona.com> --- 65.md | 50 +++++++++++--------------------------------------- 1 file changed, 11 insertions(+), 39 deletions(-) diff --git a/65.md b/65.md index a4d34a53..2e7f6ef8 100644 --- a/65.md +++ b/65.md @@ -6,11 +6,9 @@ Relay List Metadata `draft` `optional` -Defines a replaceable event using `kind:10002` to advertise preferred relays for discovering a user's content and receiving fresh content from others. +Defines a replaceable event using `kind:10002` to advertise relays where the user generally **writes** to and relays where the user generally **reads** mentions. -The event MUST include a list of `r` tags with relay URIs and a `read` or `write` marker. Relays marked as `read` / `write` are called READ / WRITE relays, respectively. If the marker is omitted, the relay is used for both purposes. - -The `.content` is not used. +The event MUST include a list of `r` tags with relay URLs as value and an optional `read` or `write` marker. If the marker is omitted, the relay is both **read** and **write**. ```jsonc { @@ -26,45 +24,19 @@ The `.content` is not used. } ``` -This NIP doesn't fully replace relay lists that are designed to configure a client's usage of relays (such as `kind:3` style relay lists). Clients MAY use other relay lists in situations where a `kind:10002` relay list cannot be found. +When downloading events **from** a user, clients SHOULD use the **write** relays of that user. -## When to Use Read and Write Relays +When downloading events **about** a user, where the user was tagged (mentioned), clients SHOULD use the user's **read** relays. -When seeking events **from** a user, Clients SHOULD use the WRITE relays of the user's `kind:10002`. +When publishing an event, clients SHOULD: -When seeking events **about** a user, where the user was tagged, Clients SHOULD use the READ relays of the user's `kind:10002`. +- Send the event to the **write** relays of the author +- Send the event to all **read** relays of each tagged user -When broadcasting an event, Clients SHOULD: +### Size -- Broadcast the event to the WRITE relays of the author -- Broadcast the event to all READ relays of each tagged user +Clients SHOULD guide users to keep `kind:10002` lists small (2-4 relays of each category). -## Motivation +### Discoverability -The old model of using a fixed relay list per user centralizes in large relay operators: - - - Most users submit their posts to the same highly popular relays, aiming to achieve greater visibility among a broader audience - - Many users are pulling events from a large number of relays in order to get more data at the expense of duplication - - Events are being copied between relays, oftentimes to many different relays - -This NIP allows Clients to connect directly with the most up-to-date relay set from each individual user, eliminating the need of broadcasting events to popular relays. - -## Final Considerations - -1. Clients SHOULD guide users to keep `kind:10002` lists small (2-4 relays). - -2. Clients SHOULD spread an author's `kind:10002` event to as many relays as viable. - -3. `kind:10002` events should primarily be used to advertise the user's preferred relays to others. A user's own client may use other heuristics for selecting relays for fetching data. - -4. DMs SHOULD only be broadcasted to the author's WRITE relays and to the receiver's READ relays to keep maximum privacy. - -5. 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. - -6. Clients SHOULD deduplicate connections by normalizing relay URIs according to [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986#section-6). - -7. When publishing to a relay, clients SHOULD ensure the user's `kind 10002` is also available on that relay. Relays SHOULD accept and serve `kind 10002` notes for any pubkey whose notes they store. Relays MAY scrape the network for missing `kind 10002` events. The goal here is that for any note served from a relay the user can also request the author's relay selections as a way of bootstrapping further context discovery. - -## Related articles -- [Outbox model](https://mikedilger.com/gossip-model/) -- [What is the Outbox Model?](https://habla.news/u/hodlbod@coracle.social/8YjqXm4SKY-TauwjOfLXS) +Clients SHOULD spread an author's `kind:10002` event to as many relays as viable, paying attention to relays that, at any moment, serve naturally as well-known public indexers for these relay lists (where most other clients and users are connecting to in order to publish and fetch those). From c07643728293f53c06c7d6519f55fc37a7530271 Mon Sep 17 00:00:00 2001 From: William Casarin <jb55@jb55.com> Date: Thu, 17 Apr 2025 08:55:17 -0700 Subject: [PATCH 413/587] Quoted highlights (#1438) Signed-off-by: William Casarin <jb55@jb55.com> --- 84.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/84.md b/84.md index e3063c2f..ee416a59 100644 --- a/84.md +++ b/84.md @@ -40,3 +40,12 @@ last value of the tag. ### Context Clients MAY include a `context` tag, useful when the highlight is a subset of a paragraph and displaying the surrounding content might be beneficial to give context to the highlight. + +## Quote Highlights +A `comment` tag may be added to create a quote highlight. This MUST be rendered like a quote repost with the highlight as the quoted note. + +This is to prevent the creation and multiple notes (highlight + kind 1) for a single highlight action, which looks bad in micro-blogging clients where these notes may appear in succession. + +p-tag mentions MUST have a `mention` attribute to distinguish it from authors and editors. + +r-tag urls from the comment MUST have a `mention` attribute to distinguish from the highlighted source url. The source url MUST have the `source` attribute. From 951aaa8ba1af4962a75987b63be72da43c36e77e Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Thu, 17 Apr 2025 17:15:37 -0300 Subject: [PATCH 414/587] nip7D: `subject` -> `title` (#1874) --- 7D.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/7D.md b/7D.md index d8509a6c..fb1b7188 100644 --- a/7D.md +++ b/7D.md @@ -6,15 +6,14 @@ Threads `draft` `optional` -A thread is a `kind 11` event. Threads SHOULD include a `subject` with a summary -of the thread's topic. +A thread is a `kind 11` event. Threads SHOULD include a `title`. ```json { "kind": 11, "content": "Good morning", "tags": [ - ["subject", "GM"] + ["title", "GM"] ] } ``` From 4ba28112e6b80740ef15615f8a06ac914ebef37d Mon Sep 17 00:00:00 2001 From: alltheseas <64376233+alltheseas@users.noreply.github.com> Date: Mon, 21 Apr 2025 13:56:43 -0500 Subject: [PATCH 415/587] Update 11.md with privacy policy and terms of service (#1882) --- 11.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/11.md b/11.md index 8a15a265..8229bd4c 100644 --- a/11.md +++ b/11.md @@ -21,6 +21,10 @@ When a relay receives an HTTP(s) request with an `Accept` header of `application "supported_nips": <a list of NIP numbers supported by the relay>, "software": <string identifying relay software URL>, "version": <string version identifier> + "privacy_policy": <a link to a text file describing the relay's privacy policy>, + "terms_of_service": <a link to a text file describing the relay's term of service>, + + } ``` @@ -74,6 +78,16 @@ The relay server implementation MAY be provided in the `software` attribute. If The relay MAY choose to publish its software version as a string attribute. The string format is defined by the relay implementation. It is recommended this be a version number or commit identifier. +### Privacy Policy + +The relay owner/admin MAY choose to link to a privacy policy document, which describes how the relay utilizes user data. Data collection, data usage, data retention, monetization of data, and third party data sharing SHOULD be included. + +### Terms of Service + +The relay owner/admin MAY choose to link to a terms of service document. + + + Extra Fields ------------ From 8cdfe98e7497716b3b211641e7137437212d193b Mon Sep 17 00:00:00 2001 From: Awiteb <a@4rs.nl> Date: Wed, 23 Apr 2025 19:31:08 +0300 Subject: [PATCH 416/587] fix: Fix NIP-66 title and description format (#1886) --- 66.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/66.md b/66.md index 30c11fb6..7ab3786f 100644 --- a/66.md +++ b/66.md @@ -1,4 +1,8 @@ -# NIP-66: Relay Discovery and Liveness Monitoring +NIP-66 +====== + +Relay Discovery and Liveness Monitoring +------------------- `draft` `optional` From 4f09333ab538de527f693dd18f14726a879bc594 Mon Sep 17 00:00:00 2001 From: Awiteb <a@4rs.nl> Date: Wed, 23 Apr 2025 21:57:55 +0300 Subject: [PATCH 417/587] Fix nips titles and descriptions (#1888) Signed-off-by: Awiteb <a@4rs.nl> --- 69.md | 6 ++++-- 88.md | 6 ++++-- C0.md | 6 +++++- 3 files changed, 13 insertions(+), 5 deletions(-) diff --git a/69.md b/69.md index 0cfceeac..603016ec 100644 --- a/69.md +++ b/69.md @@ -1,6 +1,8 @@ -# NIP-69 +NIP-69 +====== -## Peer-to-peer Order events +Peer-to-peer Order events +------------------------- `draft` `optional` diff --git a/88.md b/88.md index 08f5c41d..331cd271 100644 --- a/88.md +++ b/88.md @@ -1,6 +1,8 @@ -# NIP-88 +NIP-88 +====== -## Polls +Polls +----- `draft` `optional` diff --git a/C0.md b/C0.md index 02cd6c97..c88e1455 100644 --- a/C0.md +++ b/C0.md @@ -1,4 +1,8 @@ -# NIP-C0: Code Snippets +NIP-C0 +====== + +Code Snippets +------------- `draft` `optional` From 5a371a5b92f497a59ce23eb320a2d5c1cca29eb4 Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Thu, 24 Apr 2025 13:47:04 -0300 Subject: [PATCH 418/587] add B7 NIP for Blossom interaction (#1822) --- README.md | 3 ++- b7.md | 41 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 43 insertions(+), 1 deletion(-) create mode 100644 b7.md diff --git a/README.md b/README.md index 77430626..09963142 100644 --- a/README.md +++ b/README.md @@ -89,6 +89,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-73: External Content IDs](73.md) - [NIP-75: Zap Goals](75.md) - [NIP-78: Application-specific data](78.md) +- [NIP-7D: Threads](7D.md) - [NIP-84: Highlights](84.md) - [NIP-86: Relay Management API](86.md) - [NIP-88: Polls](88.md) @@ -99,7 +100,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-96: HTTP File Storage Integration](96.md) - [NIP-98: HTTP Auth](98.md) - [NIP-99: Classified Listings](99.md) -- [NIP-7D: Threads](7D.md) +- [NIP-B7: Blossom](B7.md) - [NIP-C0: Code Snippets](C0.md) - [NIP-C7: Chats](C7.md) diff --git a/b7.md b/b7.md new file mode 100644 index 00000000..0e0fd347 --- /dev/null +++ b/b7.md @@ -0,0 +1,41 @@ +NIP-B7 +====== + +Blossom media +------------- + +`draft` `optional` + +This NIP specifies how Nostr clients can use [Blossom][] for handling media. + +Blossom is a set of standards (called BUDs) for dealing with servers that store files addressable by their SHA-256 sums. Nostr clients may make use of all the BUDs for allowing users to upload files, manage their own files and so on, but most importantly Nostr clients SHOULD make use of [BUD-03][] to fetch `kind:10063` lists of servers for each user: + +```json +{ + "id": "e4bee088334cb5d38cff1616e964369c37b6081be997962ab289d6c671975d71", + "pubkey": "781208004e09102d7da3b7345e64fd193cd1bc3fce8fdae6008d77f9cabcd036", + "content": "", + "kind": 10063, + "created_at": 1708774162, + "tags": [ + ["server", "https://blossom.self.hosted"], + ["server", "https://cdn.blossom.cloud"] + ], + "sig": "cc5efa74f59e80622c77cacf4dd62076bcb7581b45e9acff471e7963a1f4d8b3406adab5ee1ac9673487480e57d20e523428e60ffcc7e7a904ac882cfccfc653" +} +``` + +Whenever a Nostr client finds a URL in an event published by a given user and that URL ends a 64-character hex string (with or without an ending file extension) and that URL is not available anymore, that means that string is likely a representation of a sha256 and that the user may have a `kind:10063` list of Blossom servers published. + +Given that, the client SHOULD look into the `kind:10063` list for other Blossom servers and lookup for the same 64-character hex string in them, by just using the hex string as a path (optionally with the file extension at the end), producing a URL like `https://blossom.self.hosted/<hex-string>.png`. + +When downloading such files Nostr clients SHOULD verify that the sha256-hash of its contents matches the 64-character hex string. + +More information can be found at [BUD-03][]. + +### More complex interactions + +Clients may use other facilities exposed by Blossom servers (for example, for checking if a file exists in a Blossom server, instead of actually downloading it) which are better documented in the [BUDs][Blossom]. + +[Blossom]: https://github.com/hzrd149/blossom +[BUD-03]: https://github.com/hzrd149/blossom/blob/master/buds/03.md From 121258a611f43b24e62b00dffb1f2b9bcebfbb3f Mon Sep 17 00:00:00 2001 From: Sebastian Hagens <info@sebastix.nl> Date: Thu, 24 Apr 2025 18:52:29 +0200 Subject: [PATCH 419/587] adding more info / requirements for using kind 39701 for web bookmarks (NIP-B0) (#1849) Co-authored-by: fiatjaf <fiatjaf@gmail.com> --- b0.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 b0.md diff --git a/b0.md b/b0.md new file mode 100644 index 00000000..0dcefa7b --- /dev/null +++ b/b0.md @@ -0,0 +1,61 @@ +NIP-B0 +====== + +Web Bookmarking +--------------- + +`draft` `optional` + +This NIP defines `kind:39701` (an _addressable event_) for a URI as a web bookmark which uses the HTTP (Hypertext transfer protocol) scheme. +These web bookmark events are _addressable_ and deletable per [NIP-09](09.md). + +### Editability + +Web bookmarks are meant to be editable, so they should include a `d` tag with an identifier for the bookmark. 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 bookmark they may receive. + +### Format + +The format uses an _addressable event_ of `kind:39701`. + +The `.content` of these events should be a detailed description of the web bookmark. It is required but can be an empty string. + +The `d` tag is required. + +In this way web bookmarks events can be queried by the `d` tag by clients, which is just their URL without the scheme, which is always and everywhere assumed to be `https://` or `http://`. + +The querystring and the hash must be removed entirely, unless their requirement is explicitly stated either by the user or by some hardcoded list of URLs that rely on querystrings for basic routing provided by the client. + +### Metadata + +For 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. + +Other metadata fields can be added as tags to the event as necessary. + +* `"published_at"`, for the timestamp in unix seconds (stringified) of the first time the bookmark was published +* `"title"`, title about bookmark and can be used as a attribute for the HTML link element + +## Example event + +```jsonc +{ + "kind": 39701, + "id": "d7a92714f81d0f712e715556aee69ea6da6bfb287e6baf794a095d301d603ec7", + "pubkey": "2729620da105979b22acfdfe9585274a78c282869b493abfa4120d3af2061298", + "created_at": 1738869705, + "tags": [ + // Required tags + ["d", "alice.blog/post"], + // Optional tags + ["published_at", "1738863000"], + ["title", "Blog insights by Alice"], + ["t", "post"], + ["t", "insight"] + ], + "content": "A marvelous insight by Alice about the nature of blogs and posts.", + "sig": "36d34e6448fe0223e9999361c39c492a208bc423d2fcdfc2a3404e04df7c22dc65bbbd62dbe8a4373c62e4d29aac285b5aa4bb9b4b8053bd6207a8b45fbd0c98" +} +``` + +### Replies & Comments + +Replies to `kind 39701` MUST use `kind 1111` events as comments with [NIP-22](22.md). From 257e8700ea3d3dca4fa3337abd2c3ae49556c45f Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Thu, 24 Apr 2025 13:52:59 -0300 Subject: [PATCH 420/587] add B0 to index. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 09963142..230c78ec 100644 --- a/README.md +++ b/README.md @@ -100,6 +100,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-96: HTTP File Storage Integration](96.md) - [NIP-98: HTTP Auth](98.md) - [NIP-99: Classified Listings](99.md) +- [NIP-B0: Web Bookmarks](B0.md) - [NIP-B7: Blossom](B7.md) - [NIP-C0: Code Snippets](C0.md) - [NIP-C7: Chats](C7.md) From 473f651b3e714c92bfd236cf5972a7d594aec703 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Thu, 24 Apr 2025 13:53:56 -0300 Subject: [PATCH 421/587] uppercase B7 and B0. --- b0.md => B0.md | 0 b7.md => B7.md | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename b0.md => B0.md (100%) rename b7.md => B7.md (100%) diff --git a/b0.md b/B0.md similarity index 100% rename from b0.md rename to B0.md diff --git a/b7.md b/B7.md similarity index 100% rename from b7.md rename to B7.md From 507830c5c449e44515cee25af0443f2225577806 Mon Sep 17 00:00:00 2001 From: Sebastian Hagens <info@sebastix.nl> Date: Fri, 25 Apr 2025 17:32:49 +0200 Subject: [PATCH 422/587] Add kind 39701 web bookmarks to list of kinds in readme (#1891) --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 230c78ec..e2c26a37 100644 --- a/README.md +++ b/README.md @@ -249,6 +249,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `34550` | Community Definition | [72](72.md) | | `38383` | Peer-to-peer Order events | [69](69.md) | | `39000-9` | Group metadata events | [29](29.md) | +| `39701` | Web bookmarks | [B0](B0.md) | [NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/ [nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md From b96b72b4881c77fdd6397db6fb9e1b4c0ac937a8 Mon Sep 17 00:00:00 2001 From: Sepehr Safari <safari.sepehr@gmail.com> Date: Tue, 29 Apr 2025 14:21:27 +0200 Subject: [PATCH 423/587] Add NIP-B0 Standardized Tags to README.md (#1895) --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e2c26a37..2e1a8f01 100644 --- a/README.md +++ b/README.md @@ -344,7 +344,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | | `price` | price | currency, frequency | [99](99.md) | | `proxy` | external ID | protocol | [48](48.md) | -| `published_at` | unix timestamp (string) | -- | [23](23.md) | +| `published_at` | unix timestamp (string) | -- | [23](23.md), [B0](B0.md) | | `relay` | relay url | -- | [42](42.md), [17](17.md) | | `relays` | relay list | -- | [57](57.md) | | `repo` | Reference to the origin repository | -- | [C0](C0.md) | @@ -353,7 +353,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `subject` | subject | -- | [14](14.md), [17](17.md), [34](34.md) | | `summary` | summary | -- | [23](23.md), [52](52.md) | | `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | -| `title` | article title | -- | [23](23.md) | +| `title` | title | -- | [23](23.md), [B0](B0.md) | | `tracker` | torrent tracker URL | -- | [35](35.md) | | `web` | webpage URL | -- | [34](34.md) | | `zap` | pubkey (hex), relay URL | weight | [57](57.md) | From 77fdeeb6f168f960fe53816ae31d38a9b4d70cd1 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Tue, 29 Apr 2025 08:31:22 -0400 Subject: [PATCH 424/587] Deprecates NIP-26 (#1051) --- 26.md | 2 ++ README.md | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/26.md b/26.md index 445dd54a..050041b5 100644 --- a/26.md +++ b/26.md @@ -1,3 +1,5 @@ +> __Warning__ `unrecommended`: adds unecessary burden for little gain + NIP-26 ======= diff --git a/README.md b/README.md index 2e1a8f01..b665f702 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-23: Long-form Content](23.md) - [NIP-24: Extra metadata fields and tags](24.md) - [NIP-25: Reactions](25.md) -- [NIP-26: Delegated Event Signing](26.md) +- [NIP-26: Delegated Event Signing](26.md) --- **unrecommended**: adds unecessary burden for little gain - [NIP-27: Text Note References](27.md) - [NIP-28: Public Chat](28.md) - [NIP-29: Relay-based Groups](29.md) From 85f3282e46dab548cb1c69e0b19b65cb4140b562 Mon Sep 17 00:00:00 2001 From: Alexander Lopatin <alopatindev@users.noreply.github.com> Date: Tue, 29 Apr 2025 18:28:46 +0300 Subject: [PATCH 425/587] Fix JSON format (#1896) --- 22.md | 46 +++++++++++++++++++++++----------------------- 61.md | 8 ++++---- 2 files changed, 27 insertions(+), 27 deletions(-) diff --git a/22.md b/22.md index 8eff09a9..be07e532 100644 --- a/22.md +++ b/22.md @@ -18,9 +18,9 @@ and `p` for the author of the parent item. ```jsonc { - kind: 1111, - content: '<comment>', - tags: [ + "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 @@ -64,9 +64,9 @@ A comment on a blog post looks like this: ```jsonc { - kind: 1111, - content: 'Great blog post!', - tags: [ + "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 @@ -91,9 +91,9 @@ A comment on a [NIP-94](94.md) file looks like this: ```jsonc { - kind: 1111, - content: 'Great file!', - tags: [ + "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 @@ -115,9 +115,9 @@ A reply to a comment looks like this: ```jsonc { - kind: 1111, - content: 'This is a reply to "Great file!"', - tags: [ + "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 @@ -138,9 +138,9 @@ A comment on a website's url looks like this: ```jsonc { - kind: 1111, - content: 'Nice article!', - tags: [ + "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 @@ -159,11 +159,11 @@ A podcast comment example: ```jsonc { - id: "80c48d992a38f9c445b943a9c9f1010b396676013443765750431a9004bdac05", - pubkey: "252f10c83610ebca1a059c0bae8255eba2f95be4d1d7bcfa89d7248a82d9f111", - kind: 1111, - content: "This was a great episode!", - tags: [ + "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 @@ -181,9 +181,9 @@ A reply to a podcast comment: ```jsonc { - kind: 1111, - content: "I'm replying to the above comment.", - tags: [ + "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 diff --git a/61.md b/61.md index 6e378066..ebb8af3e 100644 --- a/61.md +++ b/61.md @@ -46,10 +46,10 @@ Clients MUST prefix the public key they P2PK-lock with `"02"` (for nostr<>cashu ```jsonc { - kind: 9321, - content: "Thanks for this great idea.", - pubkey: "<sender-pubkey>", - tags: [ + "kind": 9321, + "content": "Thanks for this great idea.", + "pubkey": "<sender-pubkey>", + "tags": [ [ "proof", "{\"amount\":1,\"C\":\"02277c66191736eb72fce9d975d08e3191f8f96afb73ab1eec37e4465683066d3f\",\"id\":\"000a93d6f8a1d2c4\",\"secret\":\"[\\\"P2PK\\\",{\\\"nonce\\\":\\\"b00bdd0467b0090a25bdf2d2f0d45ac4e355c482c1418350f273a04fedaaee83\\\",\\\"data\\\":\\\"02eaee8939e3565e48cc62967e2fde9d8e2a4b3ec0081f29eceff5c64ef10ac1ed\\\"}]\"}" ], [ "u", "https://stablenut.umint.cash" ], [ "e", "<nutzapped-event-id>", "<relay-hint>" ], From 2ade2e6229331b381a2c5570b2497717d25821b5 Mon Sep 17 00:00:00 2001 From: Awiteb <a@4rs.nl> Date: Wed, 30 Apr 2025 23:41:45 +0300 Subject: [PATCH 426/587] NIP-65: Add note about re-publishing kind 10002 (#1889) Signed-off-by: Awiteb <a@4rs.nl> Co-authored-by: hodlbod <jstaab@protonmail.com> --- 65.md | 1 + 1 file changed, 1 insertion(+) diff --git a/65.md b/65.md index 2e7f6ef8..36f0d122 100644 --- a/65.md +++ b/65.md @@ -32,6 +32,7 @@ When publishing an event, clients SHOULD: - Send the event to the **write** relays of the author - Send the event to all **read** relays of each tagged user +- Send the author's `kind:10002` event to all relays the event was published to ### Size From 5b7d3382009332f737bca8fdffce291e8d7935b9 Mon Sep 17 00:00:00 2001 From: Darrell <zh0521@gmail.com> Date: Thu, 1 May 2025 16:34:37 +0900 Subject: [PATCH 427/587] fix typo nip-60 (#1901) --- 60.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/60.md b/60.md index 87449d20..4d0c7096 100644 --- a/60.md +++ b/60.md @@ -68,7 +68,7 @@ There can be multiple `kind:7375` events for the same mint, and multiple proofs * `.content` is a [NIP-44](44.md) encrypted payload: * `mint`: The mint the proofs belong to. - * `proofs`: unecoded proofs + * `proofs`: unencoded proofs * `del`: token-ids that were destroyed by the creation of this token. This assists with state transitions. When one or more proofs of a token are spent, the token event should be [NIP-09](09.md)-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 (the change output should include a `del` field). From 86f0da716f15b1f1a5a19a9f900ace499c7bc4e2 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Mon, 5 May 2025 09:36:20 -0400 Subject: [PATCH 428/587] NIP-17 json formatting fix, text cleanup and more precise language (#1909) --- 17.md | 79 ++++++++++++++++++++++++++++++----------------------------- 1 file changed, 40 insertions(+), 39 deletions(-) diff --git a/17.md b/17.md index 4383308c..e9e97ba5 100644 --- a/17.md +++ b/17.md @@ -15,17 +15,17 @@ Kind `14` is a chat message. `p` tags identify one or more receivers of the mess ```jsonc { "id": "<usual hash>", -  "pubkey": "<sender-pubkey>", + "pubkey": "<sender-pubkey>", "created_at": "<current-time>", -  "kind": 14, -  "tags": [ -    ["p", "<receiver-1-pubkey>", "<relay-url>"], -    ["p", "<receiver-2-pubkey>", "<relay-url>"], -    ["e", "<kind-14-id>", "<relay-url>"] // if this is a reply + "kind": 14, + "tags": [ + ["p", "<receiver-1-pubkey>", "<relay-url>"], + ["p", "<receiver-2-pubkey>", "<relay-url>"], + ["e", "<kind-14-id>", "<relay-url>"] // if this is a reply ["subject", "<conversation-title>"], -    // rest of tags... -  ], -  "content": "<message-in-plain-text>", + // rest of tags... + ], + "content": "<message-in-plain-text>", } ``` @@ -65,21 +65,22 @@ Kind `14`s MUST never be signed. If it is signed, the message might leak to rela } ``` -Kind 15 is used for sending encrypted file event messages: +Kind `15` is used for sending encrypted file event messages: -- `file-type`: Specifies the MIME type of the attached file (e.g., `image/jpeg`, `audio/mpeg`, etc.). -- `encryption-algorithm`: Indicates the encryption algorithm used for encrypting the file. Supported algorithms may include `aes-gcm`, `chacha20-poly1305`,`aes-cbc` etc. +- `file-type`: Specifies the MIME type of the attached file (e.g., `image/jpeg`, `audio/mpeg`, etc.) before encryption. +- `encryption-algorithm`: Indicates the encryption algorithm used for encrypting the file. Supported algorithms: `aes-gcm`. - `decryption-key`: The decryption key that will be used by the recipient to decrypt the file. - `decryption-nonce`: The decryption nonce that will be used by the recipient to decrypt the file. - `content`: The URL of the file (`<file-url>`). -- `x` containing the SHA-256 hexencoded string of the file. -- `size` (optional) size of file in bytes -- `dim` (optional) size of the file in pixels in the form `<width>x<height>` +- `x` containing the SHA-256 hexencoded string of the encrypted file. +- `ox` containing the SHA-256 hexencoded string of the file before encryption. +- `size` (optional) size of the encrypted file in bytes +- `dim` (optional) size in pixels in the form `<width>x<height>` - `blurhash`(optional) the [blurhash](https://github.com/woltapp/blurhash) to show while the client is loading the file - `thumb` (optional) URL of thumbnail with same aspect ratio (encrypted with the same key, nonce) -- `fallback` (optional) zero or more fallback file sources in case `url` fails +- `fallback` (optional) zero or more fallback file sources in case `url` fails (encrypted with the same key, nonce) -Just like kind 14, kind `15`s MUST never be signed. +Just like kind `14`, kind `15`s MUST never be signed. ## Chat Rooms @@ -87,34 +88,34 @@ The set of `pubkey` + `p` tags defines a chat room. If a new `p` tag is added or Clients SHOULD render messages of the same room in a continuous thread. -An 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. +An 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 chat room is the subject of the conversation. ## Encrypting Following [NIP-59](59.md), the **unsigned** `kind:14` & `kind:15` chat messages must be sealed (`kind:13`) and then gift-wrapped (`kind:1059`) to each receiver and the sender individually. -```jsonc +```js { "id": "<usual hash>", -  "pubkey": randomPublicKey, -  "created_at": randomTimeUpTo2DaysInThePast(), + "pubkey": randomPublicKey, + "created_at": randomTimeUpTo2DaysInThePast(), "kind": 1059, // gift wrap -  "tags": [ -    ["p", receiverPublicKey, "<relay-url>"] // receiver -  ], -  "content": nip44Encrypt( -    { + "tags": [ + ["p", receiverPublicKey, "<relay-url>"] // receiver + ], + "content": nip44Encrypt( + { "id": "<usual hash>", -      "pubkey": senderPublicKey, -      "created_at": randomTimeUpTo2DaysInThePast(), -      "kind": 13, // seal -      "tags": [], // no tags -      "content": nip44Encrypt(unsignedKind14, senderPrivateKey, receiverPublicKey), -      "sig": "<signed by senderPrivateKey>" -    }, -    randomPrivateKey, receiverPublicKey -  ), -  "sig": "<signed by randomPrivateKey>" + "pubkey": senderPublicKey, + "created_at": randomTimeUpTo2DaysInThePast(), + "kind": 13, // seal + "tags": [], // no tags + "content": nip44Encrypt(unsignedKind14, senderPrivateKey, receiverPublicKey), + "sig": "<signed by senderPrivateKey>" + }, + randomPrivateKey, receiverPublicKey + ), + "sig": "<signed by randomPrivateKey>" } ``` @@ -124,7 +125,7 @@ Clients MUST verify if pubkey of the `kind:13` is the same pubkey on the `kind:1 Clients 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. -The 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. +The 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. Clients 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 @@ -188,7 +189,7 @@ The two final GiftWraps, one to the receiver and the other to the sender, respec "created_at":1703128320, "kind":1059, "tags":[ - [ "p", "918e2da906df4ccd12c8ac672d8335add131a4cf9d27ce42b3bb3625755f0788"] + ["p", "918e2da906df4ccd12c8ac672d8335add131a4cf9d27ce42b3bb3625755f0788"] ], "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", "sig":"a3c6ce632b145c0869423c1afaff4a6d764a9b64dedaf15f170b944ead67227518a72e455567ca1c2a0d187832cecbde7ed478395ec4c95dd3e71749ed66c480" @@ -202,7 +203,7 @@ The two final GiftWraps, one to the receiver and the other to the sender, respec "created_at":1702711587, "kind":1059, "tags":[ - [ "p", "44900586091b284416a0c001f677f9c49f7639a55c3f1e2ec130a8e1a7998e1b"] + ["p", "44900586091b284416a0c001f677f9c49f7639a55c3f1e2ec130a8e1a7998e1b"] ], "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", "sig":"c94e74533b482aa8eeeb54ae72a5303e0b21f62909ca43c8ef06b0357412d6f8a92f96e1a205102753777fd25321a58fba3fb384eee114bd53ce6c06a1c22bab" From ebfcd72a8d545d3f8386051a9ec53475447fbfb8 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Mon, 5 May 2025 20:11:52 -0400 Subject: [PATCH 429/587] Using yaml to fix NIP-01 JSON formatting (#1910) --- 01.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/01.md b/01.md index f7f592c3..a3d23f88 100644 --- a/01.md +++ b/01.md @@ -14,7 +14,7 @@ Each user has a keypair. Signatures, public key, and encodings are done accordin The only object type that exists is the `event`, which has the following format on the wire: -```jsonc +```yaml { "id": <32-bytes lowercase hex-encoded sha256 of the serialized event data>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, @@ -120,7 +120,7 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th `<filtersX>` is a JSON object that determines what events will be sent in that subscription, it can have the following attributes: -```json +```yaml { "ids": <a list of event ids>, "authors": <a list of lowercase pubkeys, the pubkey of an event must be one of these>, From ccd02f2612292825e7f7caf0edb41dfc5f33f91e Mon Sep 17 00:00:00 2001 From: Cody Tseng <codytseng@outlook.com> Date: Fri, 9 May 2025 09:50:12 +0800 Subject: [PATCH 430/587] NIP-51: favorite relays (#1848) --- 51.md | 1 + README.md | 1 + 2 files changed, 2 insertions(+) diff --git a/51.md b/51.md index 55834352..14eff6ba 100644 --- a/51.md +++ b/51.md @@ -31,6 +31,7 @@ For example, _mute list_ can contain the public keys of spammers and bad actors | Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) | | Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) | | Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group id + relay URL + optional group name), `"r"` for each relay in use | +| Favorite relays | 10012 | user favorite relays and pointers to relay sets | `"relay"` (relay URLs) and `"a"` (kind:30002 relay set) | | Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) | | Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | | DM relays | 10050 | Where to receive [NIP-17](17.md) direct messages | `"relay"` (see [NIP-17](17.md)) | diff --git a/README.md b/README.md index b665f702..5f46f0c5 100644 --- a/README.md +++ b/README.md @@ -187,6 +187,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10006` | Blocked relays list | [51](51.md) | | `10007` | Search relays list | [51](51.md) | | `10009` | User groups | [51](51.md), [29](29.md) | +| `10012` | Favorite relays list | [51](51.md) | | `10013` | Private event relay list | [37](37.md) | | `10015` | Interests list | [51](51.md) | | `10019` | Nutzap Mint Recommendation | [61](61.md) | From 564814ac7dccf7f7f9ad3af63fbc5a89fd7397eb Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Thu, 8 May 2025 22:51:09 -0300 Subject: [PATCH 431/587] add follow packs to nip51 (#1898) --- 51.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/51.md b/51.md index 14eff6ba..bac1a928 100644 --- a/51.md +++ b/51.md @@ -22,6 +22,7 @@ For example, _mute list_ can contain the public keys of spammers and bad actors | name | kind | description | expected tag items | | --- | --- | --- | --- | +| Follow list | 3 | microblogging basic follow list, see [NIP-02](02.md) | `"p"` (pubkeys -- with optional relay hint and petname) | | Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags), `"word"` (lowercase string), `"e"` (threads) | | Pinned notes | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | | Read/write relays | 10002 | where a user publishes to and where they expect mentions | see [NIP-65](65.md) | @@ -33,6 +34,7 @@ For example, _mute list_ can contain the public keys of spammers and bad actors | Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group id + relay URL + optional group name), `"r"` for each relay in use | | Favorite relays | 10012 | user favorite relays and pointers to relay sets | `"relay"` (relay URLs) and `"a"` (kind:30002 relay set) | | Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) | +| Media follows | 10020 | multimedia (photos, short video) follow list | `"p"` (pubkeys -- with optional relay hint and petname) | | Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | | DM relays | 10050 | Where to receive [NIP-17](17.md) direct messages | `"relay"` (see [NIP-17](17.md)) | | Good wiki authors | 10101 | [NIP-54](54.md) user recommended wiki authors | `"p"` (pubkeys) | @@ -58,6 +60,8 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti | Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | | Release artifact sets | 30063 | group of artifacts of a software release | `"e"` (kind:1063 [file metadata](94.md) events), `"a"` (software application event) | | App curation sets | 30267 | references to multiple software applications | `"a"` (software application event) | +| Starter packs | 39089 | a named set of profiles to be shared around with the goal of being followed together | `"p"` (pubkeys) | +| Media starter packs | 39092 | same as above, but specific to multimedia (photos, short video) clients | `"p"` (pubkeys) | ### Deprecated standard lists From 873afc5fb823f58c3b7f29c5090f9c56172623f2 Mon Sep 17 00:00:00 2001 From: AsaiToshiya <to.asai.60@gmail.com> Date: Fri, 9 May 2025 20:07:23 +0900 Subject: [PATCH 432/587] add follow packs to README. --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 5f46f0c5..d4d8419d 100644 --- a/README.md +++ b/README.md @@ -191,6 +191,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10013` | Private event relay list | [37](37.md) | | `10015` | Interests list | [51](51.md) | | `10019` | Nutzap Mint Recommendation | [61](61.md) | +| `10020` | Media follows | [51](51.md) | | `10030` | User emoji list | [51](51.md) | | `10050` | Relay list to receive DMs | [51](51.md), [17](17.md) | | `10063` | User server list | [Blossom][blossom] | @@ -250,6 +251,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `34550` | Community Definition | [72](72.md) | | `38383` | Peer-to-peer Order events | [69](69.md) | | `39000-9` | Group metadata events | [29](29.md) | +| `39089` | Starter packs | [51](51.md) | +| `39092` | Media starter packs | [51](51.md) | | `39701` | Web bookmarks | [B0](B0.md) | [NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/ From 7555a93f902277d18f3e0faf2535a15e0e3b9f50 Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Tue, 13 May 2025 08:01:06 -0300 Subject: [PATCH 433/587] remove mentions to uuids (#1920) --- 52.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/52.md b/52.md index cc2625af..f701ca6f 100644 --- a/52.md +++ b/52.md @@ -25,7 +25,7 @@ The format uses an _addressable event_ of `kind:31922`. The `.content` of these events should be a detailed description of the calendar event. It is required but can be an empty string. The list of tags are as follows: -* `d` (required) universally unique identifier (UUID). Generated by the client creating the calendar event. +* `d` (required) a short unique string identifier. Generated by the client creating the calendar event. * `title` (required) title of the calendar event * `start` (required) inclusive start date in ISO 8601 format (YYYY-MM-DD). Must be less than `end`, if it exists. * `end` (optional) exclusive end date in ISO 8601 format (YYYY-MM-DD). If omitted, the calendar event ends on the same date as `start`. @@ -46,7 +46,7 @@ The following tags are deprecated: "kind": 31922, "content": "<description of calendar event>", "tags": [ - ["d", "<UUID>"], + ["d", "<random-identifier>"], ["title", "<title of calendar event>"], @@ -84,7 +84,7 @@ The format uses an _addressable event_ kind `31923`. The `.content` of these events should be a detailed description of the calendar event. It is required but can be an empty string. The list of tags are as follows: -* `d` (required) universally unique identifier (UUID). Generated by the client creating the calendar event. +* `d` (required) a short unique string identifier. Generated by the client creating the calendar event. * `title` (required) title of the calendar event * `start` (required) inclusive start Unix timestamp in seconds. Must be less than `end`, if it exists. * `end` (optional) exclusive end Unix timestamp in seconds. If omitted, the calendar event ends instantaneously. @@ -110,7 +110,7 @@ The following tags are deprecated: "kind": 31923, "content": "<description of calendar event>", "tags": [ - ["d", "<UUID>"], + ["d", "<random-identifier>"], ["title", "<title of calendar event>"], ["summary", "<brief description of the calendar event>"], @@ -167,7 +167,7 @@ The format uses a custom replaceable list of kind `31924` with a list of tags as "kind": 31924, "content": "<description of calendar>", "tags": [ - ["d", "<UUID>"], + ["d", "<random-identifier>"], ["title", "<calendar title>"], ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"], ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional relay url>"] @@ -215,7 +215,7 @@ The list of tags are as follows: "tags": [ ["e", "<kind 31922 or 31923 event id", "<optional recommended relay URL>"] ["a", "<31922 or 31923>:<calendar event author pubkey>:<d-identifier of calendar event>", "<optional recommended relay URL>"], - ["d", "<UUID>"], + ["d", "<random-identifier>"], ["status", "<accepted/declined/tentative>"], ["fb", "<free/busy>"], ["p", "<hex pubkey of kind 31922 or 31923 event>", "<optional recommended relay URL>"] From 553c1c77c004329206a3ba851f3a68367d9edc9a Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Wed, 14 May 2025 09:27:59 -0300 Subject: [PATCH 434/587] simplify nip-52 (#1922) --- 51.md | 1 + 52.md | 119 ++++++++++++++++++++++------------------------------------ 2 files changed, 46 insertions(+), 74 deletions(-) diff --git a/51.md b/51.md index bac1a928..5313cea9 100644 --- a/51.md +++ b/51.md @@ -60,6 +60,7 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti | Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | | Release artifact sets | 30063 | group of artifacts of a software release | `"e"` (kind:1063 [file metadata](94.md) events), `"a"` (software application event) | | App curation sets | 30267 | references to multiple software applications | `"a"` (software application event) | +| Calendar | 31924 | a set of events categorized in any way | `"a"` (calendar event event) | | Starter packs | 39089 | a named set of profiles to be shared around with the goal of being followed together | `"p"` (pubkeys) | | Media starter packs | 39092 | same as above, but specific to multimedia (photos, short video) clients | `"p"` (pubkeys) | diff --git a/52.md b/52.md index f701ca6f..898e011e 100644 --- a/52.md +++ b/52.md @@ -12,23 +12,14 @@ Unlike the term `calendar event` specific to this NIP, the term `event` is used ## Calendar Events -There are two types of calendar events represented by different kinds: date-based and time-based calendar events. Calendar events are not required to be part of a [calendar](#calendar). +There are two types of calendar events represented by different kinds: _date-based_ and _time-based_ calendar events. -### Date-Based Calendar Event +These tags are common to both types of calendar events: -This kind of calendar event starts on a date and ends before a different date in the future. Its use is appropriate for all-day or multi-day events where time and time zone hold no significance. e.g., anniversary, public holidays, vacation days. - -#### Format - -The format uses an _addressable event_ of `kind:31922`. - -The `.content` of these events should be a detailed description of the calendar event. It is required but can be an empty string. - -The list of tags are as follows: * `d` (required) a short unique string identifier. Generated by the client creating the calendar event. * `title` (required) title of the calendar event -* `start` (required) inclusive start date in ISO 8601 format (YYYY-MM-DD). Must be less than `end`, if it exists. -* `end` (optional) exclusive end date in ISO 8601 format (YYYY-MM-DD). If omitted, the calendar event ends on the same date as `start`. +* `summary` (optional) brief description of the calendar event +* `image` (optional) url of an image to use for the event * `location` (optional, repeated) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call * `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location * `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting @@ -36,13 +27,31 @@ The list of tags are as follows: * `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. The following tags are deprecated: + * `name` name of the calendar event. Use only if `title` is not available. -```jsonc +Calendar events are _not_ required to be part of a [calendar](#calendar). + +### Date-Based Calendar Event + +This kind of calendar event starts on a date and ends before a different date in the future. Its use is appropriate for all-day or multi-day events where time and time zone hold no significance. e.g., anniversary, public holidays, vacation days. + +It's an _addressable event_ of `kind:31922`. + +The `.content` of these events SHOULD be a description of the calendar event. + +Aside from the common tags, this also takes the following tags: + +* `start` (required) inclusive start date in ISO 8601 format (YYYY-MM-DD). Must be less than `end`, if it exists. +* `end` (optional) exclusive end date in ISO 8601 format (YYYY-MM-DD). If omitted, the calendar event ends on the same date as `start`. + +Example: + +```yaml { "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, - "created_at": <Unix timestamp in seconds>, + "created_at": <unix timestamp in seconds>, "kind": 31922, "content": "<description of calendar event>", "tags": [ @@ -50,25 +59,17 @@ The following tags are deprecated: ["title", "<title of calendar event>"], - // Dates + // dates ["start", "<YYYY-MM-DD>"], ["end", "<YYYY-MM-DD>"], - // Location + // location ["location", "<location>"], ["g", "<geohash>"], - // Participants + // participants ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"], ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"], - - // Hashtags - ["t", "<tag>"], - ["t", "<tag>"], - - // Reference links - ["r", "<url>"], - ["r", "<url>"] ] } ``` @@ -77,36 +78,22 @@ The following tags are deprecated: This kind of calendar event spans between a start time and end time. -#### Format +It's an _addressable event_ of `kind:31923`. -The format uses an _addressable event_ kind `31923`. +The `.content` of these events should be a description of the calendar event. It is required but can be an empty string. -The `.content` of these events should be a detailed description of the calendar event. It is required but can be an empty string. +Aside from the common tags, this also takes the following tags: -The list of tags are as follows: -* `d` (required) a short unique string identifier. Generated by the client creating the calendar event. -* `title` (required) title of the calendar event * `start` (required) inclusive start Unix timestamp in seconds. Must be less than `end`, if it exists. * `end` (optional) exclusive end Unix timestamp in seconds. If omitted, the calendar event ends instantaneously. * `start_tzid` (optional) time zone of the start timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica` * `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. -* `summary` (optional) brief description of the calendar event -* `image` (optional) url of an image to use for the event -* `location` (optional, repeated) location of the calendar event. e.g. address, GPS coordinates, meeting room name, link to video call -* `g` (optional) [geohash](https://en.wikipedia.org/wiki/Geohash) to associate calendar event with a searchable physical location -* `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting -* `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 -* `t` (optional, repeated) hashtag to categorize calendar event -* `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. -The following tags are deprecated: -* `name` name of the calendar event. Use only if `title` is not available. - -```jsonc +```yaml { "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, - "created_at": <Unix timestamp in seconds>, + "created_at": <unix timestamp in seconds>, "kind": 31923, "content": "<description of calendar event>", "tags": [ @@ -116,54 +103,39 @@ The following tags are deprecated: ["summary", "<brief description of the calendar event>"], ["image", "<string with image URI>"], - // Timestamps - ["start", "<Unix timestamp in seconds>"], - ["end", "<Unix timestamp in seconds>"], + // timestamps + ["start", "<unix timestamp in seconds>"], + ["end", "<unix timestamp in seconds>"], ["start_tzid", "<IANA Time Zone Database identifier>"], ["end_tzid", "<IANA Time Zone Database identifier>"], - // Location + // location ["location", "<location>"], ["g", "<geohash>"], - // Participants + // participants ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"], ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>", "<role>"], - - // Labels (example using com.cornychat namespace denoting the event as an audiospace) - ["L", "com.cornychat"], - ["l", "audiospace", "com.cornychat"], - - // Hashtags - ["t", "<tag>"], - ["t", "<tag>"], - - // Reference links - ["r", "<url>"], - ["r", "<url>"] ] } ``` ## Calendar -A calendar is a collection of calendar events, represented as a custom replaceable list event using kind `31924`. A user can have multiple calendars. One may create a calendar to segment calendar events for specific purposes. e.g., personal, work, travel, meetups, and conferences. - -### Format +A calendar is a collection of calendar events, represented as a custom _addressable list_ event using kind `31924`. A user can have multiple calendars. One may create a calendar to segment calendar events for specific purposes. e.g., personal, work, travel, meetups, and conferences. The `.content` of these events should be a detailed description of the calendar. It is required but can be an empty string. -The format uses a custom replaceable list of kind `31924` with a list of tags as described below: * `d` (required) universally unique identifier. Generated by the client creating the calendar. * `title` (required) calendar title * `a` (repeated) reference tag to kind `31922` or `31923` calendar event being responded to -```json +```yaml { "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, - "created_at": <Unix timestamp in seconds>, + "created_at": <unix timestamp in seconds>, "kind": 31924, "content": "<description of calendar>", "tags": [ @@ -191,13 +163,12 @@ The RSVP MUST have an `a` tag of the event coordinates to the calendar event, an The 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. -### Format - -The format uses an _addressable event_ kind `31925`. +The RSVP is an _addressable event_ of `kind:31925`. The `.content` of these events is optional and should be a free-form note that adds more context to this calendar event response. -The list of tags are as follows: +The list of tags is as follows: + * `a` (required) coordinates to a kind `31922` or `31923` calendar event being responded to. * `e` (optional) event id of a kind `31922` or `31923` calendar event being responded to. * `d` (required) universally unique identifier. Generated by the client creating the calendar event RSVP. @@ -205,11 +176,11 @@ The list of tags are as follows: * `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`. * `p` (optional) pubkey of the author of the calendar event being responded to. -```json +```yaml { "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, - "created_at": <Unix timestamp in seconds>, + "created_at": <unix timestamp in seconds>, "kind": 31925, "content": "<note>", "tags": [ From 1c61ac29aafcb71ffd40e1ea32f664990231eb6e Mon Sep 17 00:00:00 2001 From: Paulo Cunha <paulomrcunha@gmail.com> Date: Sat, 17 May 2025 20:05:06 +0200 Subject: [PATCH 435/587] Eliminate discrepancy between NIP description and example (#1927) --- 51.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/51.md b/51.md index 5313cea9..10a2242d 100644 --- a/51.md +++ b/51.md @@ -104,9 +104,9 @@ Some clients have used these lists in the past, but they should work on transiti "kind": 30004, "tags": [ ["d", "jvdy9i4"], - ["name", "Yaks"], - ["picture", "https://cdn.britannica.com/40/188540-050-9AC748DE/Yak-Himalayas-Nepal.jpg"], - ["about", "The domestic yak, also known as the Tartary ox, grunting ox, or hairy cattle, is a species of long-haired domesticated cattle found throughout the Himalayan region of the Indian subcontinent, the Tibetan Plateau, Gilgit-Baltistan, Tajikistan and as far north as Mongolia and Siberia."], + ["title", "Yaks"], + ["image", "https://cdn.britannica.com/40/188540-050-9AC748DE/Yak-Himalayas-Nepal.jpg"], + ["description", "The domestic yak, also known as the Tartary ox, grunting ox, or hairy cattle, is a species of long-haired domesticated cattle found throughout the Himalayan region of the Indian subcontinent, the Tibetan Plateau, Gilgit-Baltistan, Tajikistan and as far north as Mongolia and Siberia."], ["a", "30023:26dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:95ODQzw3ajNoZ8SyMDOzQ"], ["a", "30023:54af95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:1-MYP8dAhramH9J5gJWKx"], ["a", "30023:f8fe95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:D2Tbd38bGrFvU0bIbvSMt"], From 0c993526f0c662af44fdf562dfc74f32521df9bb Mon Sep 17 00:00:00 2001 From: Vincenzo Imperati <61617279+VincenzoImp@users.noreply.github.com> Date: Tue, 20 May 2025 21:19:59 +0200 Subject: [PATCH 436/587] Fix typo and clarify `limit` filter behavior in event queries (#1931) --- 01.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/01.md b/01.md index a3d23f88..904f068b 100644 --- a/01.md +++ b/01.md @@ -85,7 +85,7 @@ As a convention, all single-letter (only english alphabet letters: a-z, A-Z) key ### Kinds -Kinds specify how clients should interpret the meaning of each event and the other fields of each event (e.g. an `"r"` tag may have a meaning in an event of kind 1 and an entirely different meaning in an event of kind 10002). Each NIP may define the meaning of a set of kinds that weren't defined elsewhere. [NIP-10](10.md), for instance, especifies the `kind:1` text note for social media applications. +Kinds specify how clients should interpret the meaning of each event and the other fields of each event (e.g. an `"r"` tag may have a meaning in an event of kind 1 and an entirely different meaning in an event of kind 10002). Each NIP may define the meaning of a set of kinds that weren't defined elsewhere. [NIP-10](10.md), for instance, specifies the `kind:1` text note for social media applications. This NIP defines one basic kind: @@ -144,7 +144,7 @@ All conditions of a filter that are specified must match for an event for it to A `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. -The `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. +The `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. Relays SHOULD use the `limit` value to guide how many events are returned in the initial response. Returning fewer events is acceptable, but returning (much) more should be avoided to prevent overwhelming clients. ### From relay to client: sending events and notices From 509613b9fa612f662d9339d66dc0918733321529 Mon Sep 17 00:00:00 2001 From: hodlbod <jstaab@protonmail.com> Date: Wed, 21 May 2025 16:06:08 -0700 Subject: [PATCH 437/587] Add hints to nip 25 (#1702) Co-authored-by: Jon Staab <shtaab@gmail.com> --- 25.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/25.md b/25.md index 72109c0f..9ec1551b 100644 --- a/25.md +++ b/25.md @@ -33,12 +33,17 @@ If the event being reacted to is an addressable event, an `a` SHOULD be included The reaction SHOULD include a `k` tag with the stringified kind number of the reacted event as its value. +The `e` and `a` tags SHOULD include relay and pubkey hints. The `p` tags SHOULD include relay hints. + +The reaction event MAY include a `k` tag with the stringified kind number of the reacted event as its value. + **Example code** ```swift -func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> NostrEvent { - tags.append(["e", liked.id, liked.source_relays.first ?? ""]) - tags.append(["p", liked.pubkey]) +func make_like_event(pubkey: String, privkey: String, liked: NostrEvent, hint: String) -> NostrEvent { + var tags: [[String]] = [] + tags.append(["e", liked.id, hint, liked.pubkey]) + tags.append(["p", liked.pubkey, hint]) tags.append(["k", String(liked.kind)]) let ev = NostrEvent(content: "+", pubkey: pubkey, kind: 7, tags: tags) ev.calculate_id() From a6a2020933c02cc31a9ae51e60610ebfdf3af9c6 Mon Sep 17 00:00:00 2001 From: hodlbod <jstaab@protonmail.com> Date: Wed, 21 May 2025 17:03:32 -0700 Subject: [PATCH 438/587] Remove recommendation to map emoji reactions to like/dislike (#1486) Co-authored-by: Jon Staab <shtaab@gmail.com> --- 25.md | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/25.md b/25.md index 9ec1551b..f5690783 100644 --- a/25.md +++ b/25.md @@ -7,20 +7,15 @@ Reactions `draft` `optional` -A reaction is a `kind 7` event that is used to react to other events. +A reaction is a `kind 7` event that is used to indicate user reactions to other events. A +reaction's `content` field MUST include user-generated-content indicating the value of the +reaction (conventionally `+`, `-`, or an emoji). -The generic reaction, represented by the `content` set to a `+` string, SHOULD -be interpreted as a "like" or "upvote". +A reaction with `content` set to `+` or an empty string MUST be interpreted as a "like" or "upvote". +A reaction with `content` set to `-` MUST be interpreted as a "dislike" or "downvote". -A reaction with `content` set to `-` SHOULD be interpreted as a "dislike" or -"downvote". It SHOULD NOT be counted as a "like", and MAY be displayed as a -downvote or dislike on a post. A client MAY also choose to tally likes against -dislikes in a reddit-like system of upvotes and downvotes, or display them as -separate tallies. - -The `content` MAY be an emoji, or [NIP-30](30.md) custom emoji in this case it MAY be interpreted as a "like" or "dislike", -or the client MAY display this emoji reaction on the post. If the `content` is an empty string then the client should -consider it a "+". +A reaction with `content` set to an emoji or [NIP-30](30.md) custom emoji SHOULD NOT be interpreted +as a "like" or "dislike". Clients MAY instead display this emoji reaction on the post. Tags ---- From 9eb4a330490d4f827a649aee7275ad8e112d78e1 Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Sat, 24 May 2025 10:42:34 -0300 Subject: [PATCH 439/587] Associating HTML documents to Nostr entities with `<link>` (#1897) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: hodlbod <jstaab@protonmail.com> Co-authored-by: Râu Cao <842+raucao@users.noreply.github.com> --- 21.md | 20 +++++++++++++++++++- 84.md | 2 +- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/21.md b/21.md index 988485dd..5f5e5b7e 100644 --- a/21.md +++ b/21.md @@ -12,9 +12,27 @@ The scheme is `nostr:`. The identifiers that come after are expected to be the same as those defined in [NIP-19](19.md) (except `nsec`). -## Examples +#### Examples - `nostr:npub1sn0wdenkukak0d9dfczzeacvhkrgz92ak56egt7vdgzn8pv2wfqqhrjdv9` - `nostr:nprofile1qqsrhuxx8l9ex335q7he0f09aej04zpazpl0ne2cgukyawd24mayt8gpp4mhxue69uhhytnc9e3k7mgpz4mhxue69uhkg6nzv9ejuumpv34kytnrdaksjlyr9p` - `nostr:note1fntxtkcy9pjwucqwa9mddn7v03wwwsu9j330jj350nvhpky2tuaspk6nqc` - `nostr:nevent1qqstna2yrezu5wghjvswqqculvvwxsrcvu7uc0f78gan4xqhvz49d9spr3mhxue69uhkummnw3ez6un9d3shjtn4de6x2argwghx6egpr4mhxue69uhkummnw3ez6ur4vgh8wetvd3hhyer9wghxuet5nxnepm` + +### Linking HTML pages to Nostr entities + +`<link>` tags with `rel="alternate"` can be used to associate webpages to Nostr events, in cases where the same content is served via the two mediums (for example, a web server that exposes Markdown articles both as HTML pages and as `kind:30023' events served under itself as a relay or through some other relay). For example: + +``` +<head> + <link rel="alternate" href="nostr:naddr1qqyrzwrxvc6ngvfkqyghwumn8ghj7enfv96x5ctx9e3k7mgzyqalp33lewf5vdq847t6te0wvnags0gs0mu72kz8938tn24wlfze6qcyqqq823cph95ag" /> +</head> +``` + +Likewise, `<link>` tags with `rel="me"` or `rel="author"` can be used to assign authorship of webpages to Nostr profiles. For example: + +``` +<head> + <link rel="me" href="nostr:nprofile1qyxhwumn8ghj7mn0wvhxcmmvqyd8wumn8ghj7un9d3shjtnhv4ehgetjde38gcewvdhk6qpq80cvv07tjdrrgpa0j7j7tmnyl2yr6yr7l8j4s3evf6u64th6gkwswpnfsn" /> +</head> +``` diff --git a/84.md b/84.md index ee416a59..1094f555 100644 --- a/84.md +++ b/84.md @@ -23,7 +23,7 @@ or obvious non-useful information from the query string. ### Attribution Clients MAY include one or more `p` tags, tagging the original authors of the material being highlighted; this is particularly useful when highlighting non-nostr content for which the client might be able to get a nostr pubkey somehow -(e.g. prompting the user or reading a `<meta name="nostr:nprofile1..." />` tag on the document). A role MAY be included as the +(e.g. prompting the user or reading a `<link rel="me" href="nostr:nprofile1..." />` tag on the document). A role MAY be included as the last value of the tag. ```jsonc From 569f55a90fb30a9bc3e1c0c130951ab6d738cc5e Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Mon, 26 May 2025 23:13:50 -0300 Subject: [PATCH 440/587] NIP-77: Negentropy syncing (#1494) Co-authored-by: Doug Hoyte <doug@hcsw.org> --- 77.md | 175 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 175 insertions(+) create mode 100644 77.md diff --git a/77.md b/77.md new file mode 100644 index 00000000..ffdb436a --- /dev/null +++ b/77.md @@ -0,0 +1,175 @@ +NIP-77 +====== + +Negentropy Syncing +------------------ + +`draft` `optional` + +This document describes a protocol extension for syncing events. It works for both client-relay and relay-relay scenarios. If both sides of the sync have events in common, then this protocol will use less bandwidth than transferring the full set of events (or even just their IDs). + +It is a Nostr-friendly wrapper around the [Negentropy](https://github.com/hoytech/negentropy) protocol, which uses a technique called [Range-Based Set Reconciliation](https://logperiodic.com/rbsr.html). + +Since Negentropy is a binary protocol, this wrapper hex-encodes its messages. The specification for Negentropy Protocol V1 is attached as an appendix to this NIP below. + +## High-Level Protocol Description + +We're going to call the two sides engaged in the sync the client and the relay (even though the initiator could be another relay instead of a client). + +* (1) Client (initiator) chooses a filter, and retrieves the set of events that it has locally that match this filter (or uses a cache), and constructs an initial message. +* (2) Client sends a `NEG-OPEN` message to the relay, which includes the filter and the initial message. +* (3) Relay selects the set of events that it has locally that match the filter (or uses a cache). +* (4) Relay constructs a response and returns it to the client in a `NEG-MSG` message. +* (5) Client parses the message to learn about IDs it has (and relay needs) and IDs it needs (and relay has). + * If client wishes to continue, then it constructs a new message and sends it to the relay in a `NEG-MSG` message. Goto step 4. + * If client wishes to stop, then it sends a `NEG-CLOSE` message or disconnects the websocket. + +The above protocol only results in the client learning about IDs it has/needs, and does not actually transfer events. Given these IDs, the client can upload events it has with `EVENT`, and/or download events it needs with `REQ`. This can be performed over the same websocket connection in parallel with subsequent `NEG-MSG` messages. If a client is only interested in determining the number of unique events (ie, reaction counts), it may choose to not download/upload at all. + +## Nostr Messages + +### Initial message (client to relay): + +```jsonc +[ + "NEG-OPEN", + <subscription ID string>, + <filter>, + <initialMessage, hex-encoded> +] +``` + +* The subscription ID is used by each side to identify which query a message refers to. It only needs to be long enough to distinguish it from any other concurrent subscriptions on this websocket connection (an integer that increments once per `NEG-OPEN` is fine). Subscription IDs are in a separate namespace from `REQ` subscription IDs. If a `NEG-OPEN` is issued for a currently open subscription ID, the existing subscription is first closed. +* The filter is as described in [NIP-01](01.md). +* `initialMessage` is the initial Negentropy binary message, hex-encoded. See appendix. + +### Error message (relay to client): + +If a request cannot be serviced by the relay, an error is returned to the client: + +```jsonc +[ + "NEG-ERR", + <subscription ID string>, + <reason code string> +] +``` + +Error reasons are the same format as in NIP-01. They should begin with a machine-readable single-word prefix, followed by a `:` and then a human-readable message with more information. + +The current suggested error reasons are + +* `blocked` + * Relays can optionally reject queries that would require them to process too many records, or records that are too old + * The maximum number of records that can be processed can optionally be returned as the 4th element in the response + * Example: `blocked: this query is too big` +* `closed` + * Because the `NEG-OPEN` queries may be stateful, relays may choose to time-out inactive queries to recover memory resources + * Example: `closed: you took too long to respond!` + +After a `NEG-ERR` is issued, the subscription is considered to be closed. + +### Subsequent messages (bidirectional): + +Relay and client alternate sending each other `NEG-MSG`s: + +```jsonc +[ + "NEG-MSG", + <subscription ID string>, + <message, hex-encoded> +] +``` + +* `message` is a Negentropy binary message, hex-encoded. Both message directions use the same format. See appendix. + +### Close message (client to relay): + +When finished, the client should tell the relay it can release its resources with a `NEG-CLOSE`: + +```jsonc +[ + "NEG-CLOSE", + <subscription ID string> +] +``` + + +## Appendix: Negentropy Protocol V1 + +### Preparation + +There are two protocol participants: Client and server. The client creates an initial message and transmits it to the server, which replies with its own message in response. The client continues querying the server until it is satisifed, and then terminates the protocol. Messages in either direction have the same format. + +Each participant has a collection of records. A records consists of a 64-bit numeric timestamp and a 256-bit ID. Each participant starts by sorting their items according to timestamp, ascending. If two timestamps are equal then items are sorted lexically by ID, ascending by first differing byte. Items may not use the max uint64 value (`2**64 - 1`) as a timestamp since this is reserved as a special "infinity" value. + +The goal of the protocol is for the client to learn the set of IDs that it has and the server does not, and the set of items that the server has and it does not. + +### `Varint` + +Varints (variable-sized unsigned integers) are represented as base-128 digits, most significant digit first, with as few digits as possible. Bit eight (the high bit) is set on each byte except the last. + + Varint := <Digit+128>* <Digit> + +### `Id` + +IDs are represented as byte-strings of length `32`: + + Id := Byte{32} + +### `Message` + +A reconciliation message is a protocol version byte followed by an ordered list of ranges: + + Message := <protocolVersion (Byte)> <Range>* + +The current protocol version is 1, represented by the byte `0x61`. Protocol version 2 will be `0x62`, and so forth. If a server receives a message with a protocol version that it cannot handle, it should reply with a single byte containing the highest protocol version it supports, allowing the client to downgrade and retry its message. + +Each Range corresponds to a contiguous section of the timestamp/ID space. The first Range starts at timestamp 0 and an ID of 0 bytes. Ranges are always adjacent (no gaps). If the last Range doesn't end at the special infinity value, an implicit `Skip` to infinity Range is appended. This means that the list of Ranges always covers the full timestamp/ID space. + +### `Range` + +A Range consists of an upper bound, a mode, and a payload: + + Range := <upperBound (Bound)> <mode (Varint)> <payload (Skip | Fingerprint | IdList)> + +The contents of the payload is determined by mode: + +* If `mode = 0`, then payload is `Skip`, meaning the sender does not wish to process this Range further. This payload is empty: + + Skip := + +* If `mode = 1`, then payload is a `Fingerprint`, which is a [digest](#fingerprint-algorithm) of all the IDs the sender has within the Range: + + Fingerprint := Byte{16} + +* If `mode = 2`, the payload is `IdList`, a variable-length list of all IDs the sender has within the Range: + + IdList := <length (Varint)> <ids (Id)>* + + +### `Bound` + +Each Range is specified by an *inclusive* lower bound and an *exclusive* upper bound. As defined above, each Range only includes an upper bound: the lower bound of a Range is the upper bound of the previous Range, or 0 timestamp/0 ID for the first Range. + +A Bound consists of an encoded timestamp and a variable-length disambiguating prefix of an ID (in case multiple items have the same timestamp): + + Bound := <encodedTimestamp (Varint)> <length (Varint)> <idPrefix (Byte)>* + +* The timestamp is encoded specially. The infinity timestamp is encoded as `0`. All other values are encoded as `1 + offset`, where offset is the difference between this timestamp and the previously encoded timestamp. The initial offset starts at `0` and resets at the beginning of each message. + + Offsets are always non-negative since the upper bound's timestamp is greater than or equal to the lower bound's timestamp, ranges in a message are always encoded in ascending order, and ranges never overlap. + +* The size of `idPrefix` is encoded in `length`, and can be between `0` and `32` bytes, inclusive. This allows implementations to use the shortest possible prefix to separate the first record of this Range from the last record of the previous Range. If these records' timestamps differ, then the length should be 0, otherwise it should be the byte-length of their common ID-prefix plus 1. + + If the `idPrefix` length is less than `32` then the omitted trailing bytes are implicitly 0 bytes. + + +### Fingerprint Algorithm + +The fingerprint of a Range is computed with the following algorithm: + +* Compute the addition mod 2<sup>256</sup> of the element IDs (interpreted as 32-byte little-endian unsigned integers) +* Concatenate with the number of elements in the Range, encoded as a [Varint](#varint) +* Hash with SHA-256 +* Take the first 16 bytes From cddab6d244c4536e8197b77fbc4c8681284f56be Mon Sep 17 00:00:00 2001 From: Michael Dilger <mike@mikedilger.com> Date: Tue, 27 May 2025 22:48:23 +1200 Subject: [PATCH 441/587] Add NIP-77 to the README (#1939) --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index d4d8419d..397eceb5 100644 --- a/README.md +++ b/README.md @@ -88,6 +88,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-72: Moderated Communities](72.md) - [NIP-73: External Content IDs](73.md) - [NIP-75: Zap Goals](75.md) +- [NIP-77: Negentropy Syncing](77.md) - [NIP-78: Application-specific data](78.md) - [NIP-7D: Threads](7D.md) - [NIP-84: Highlights](84.md) From 37bc37c95a00e746f083f53c9eaae8ca7193b365 Mon Sep 17 00:00:00 2001 From: cavini <60157060+cavini@users.noreply.github.com> Date: Thu, 29 May 2025 19:45:03 -0300 Subject: [PATCH 442/587] chore: fix typo (#1944) --- 25.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/25.md b/25.md index f5690783..6492822a 100644 --- a/25.md +++ b/25.md @@ -22,7 +22,7 @@ Tags There MUST be always an `e` tag set to the `id` of the event that is being reacted to. The `e` tag SHOULD include a relay hint pointing to a relay where the event being reacted to can be found. If a client decides to include other `e`, which not recommended, the target event `id` should be last of the `e` tags. -The SHOULD be a `p` tag set to the `pubkey` of the event being reacted to. If a client decides to include other `p` tags, which not recommended, the target event `pubkey` should be last the `p` tags. +There SHOULD be a `p` tag set to the `pubkey` of the event being reacted to. If a client decides to include other `p` tags, which not recommended, the target event `pubkey` should be last the `p` tags. If the event being reacted to is an addressable event, an `a` SHOULD be included together with the `e` tag, it must be set to the coordinates (`kind:pubkey:d-tag`) of the event being reacted to. From 3430b8bf3df77baacbaae2bdef381997f12884c9 Mon Sep 17 00:00:00 2001 From: "P. Reis" <patrickpereirareal1@gmail.com> Date: Tue, 3 Jun 2025 15:37:00 -0300 Subject: [PATCH 443/587] replaceable -> addressable (#1948) --- 19.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/19.md b/19.md index 3ea8e112..4787ecd5 100644 --- a/19.md +++ b/19.md @@ -34,7 +34,7 @@ These are the possible bech32 prefixes with `TLV`: - `nprofile`: a nostr profile - `nevent`: a nostr event - - `naddr`: a nostr _replaceable event_ coordinate + - `naddr`: a nostr _addressable event_ coordinate - `nrelay`: a nostr relay (deprecated) These possible standardized `TLV` types are indicated here: From 223bbdc15274eab69063dab1250d8630d64e96fc Mon Sep 17 00:00:00 2001 From: Bitkarrot <73979971+bitkarrot@users.noreply.github.com> Date: Wed, 11 Jun 2025 08:22:18 -0700 Subject: [PATCH 444/587] [NIP 53 Addendum] - Add Interactive Rooms, Meetings, and Live Presence. (#1789) --- 53.md | 143 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 143 insertions(+) diff --git a/53.md b/53.md index 69d1c9f0..d64f3ef3 100644 --- a/53.md +++ b/53.md @@ -129,3 +129,146 @@ Common use cases include meeting rooms/workshops, watch-together activities, or "sig": "997f62ddfc0827c121043074d50cfce7a528e978c575722748629a4137c45b75bdbc84170bedc723ef0a5a4c3daebf1fef2e93f5e2ddb98e5d685d022c30b622" } ``` + +## Interactive Rooms and Meetings +----- + +`draft` `optional` + +Service providers want to offer Interactive Rooms to the Nostr network in such a way that participants can easily log and query by clients. This NIP describes a general framework to advertise rooms and their associated events. + +## Concepts + +### Interactive Room (kind:30312) + +A special event with `kind:30312` "Interactive Room" defines the configuration and properties of a virtual interactive space. Each room has a unique identifier and can host multiple events/meetings. + +```jsonc +{ + "kind": 30312, + "tags": [ + ["d", "<unique identifier>"], // Required: Room identifier + ["room", "<name of the room>"], // Required: Display name + ["summary", "<description>"], // Optional: Room description + ["image", "<preview image url>"], // Optional: Room image + ["status", "<open, private, closed>"], // Required: Room accessibility + ["service", "<url>"], // Required: URL to access the room + ["endpoint", "<url>"], // Optional: API endpoint for status/info + ["t", "<hashtag>"], // Optional: Multiple hashtags allowed + ["p", "<pubkey>", "<url>", "<role>", "<proof>"], // Required: At least one provider + ["relays", "<url>", "<url>", /*...*/] // Optional: Preferred relays + ], + "content": "" // Usually empty, may contain additional metadata +} +``` + +Room properties: +* MUST be either open, private or closed. Closed means the room is not in operation. +* MAY specify access control policy for private rooms (e.g. invite-only, payment required) +* MAY persist when not in use +* MUST have at least one provider with "Host" role +* MAY have multiple providers with different roles +Provider roles (p tags): +* Host: Full room management capabilities +* Moderator: Room moderation capabilities +* Speaker: Allowed to present/speak +* Optional proof field for role verification + +### Room Meeting (kind:30313) + +A special event with kind:30313 represents a scheduled or ongoing meeting within a room. It MUST reference its parent room using the d tag. + +```jsonc +{ + "kind": 30313, + "tags": [ + ["d", "<event-unique-identifier>"], // Required: Event identifier + ["a", "30312:<pubkey>:<room-id>", "wss://nostr.example.com"], // Required: Reference to parent room, 'd' from 30312 + ["title", "<meeting-title>"], // Required: Meeting title + ["summary", "<description>"], // Optional: Meeting description + ["image", "<preview image url>"], // Optional: Meeting image + ["starts", "<unix timestamp>"], // Required: Start time + ["ends", "<unix timestamp>"], // Optional: End time + ["status", "<planned, live, ended>"], // Required: Meeting status + ["total_participants", "<number>"], // Optional: Total registered + ["current_participants", "<number>"], // Optional: Currently active + ["p", "<pubkey>", "<url>", "<role>"], // Optional: Participant with role + ], + "content": "" // Usually empty, may contain additional metadata +} +``` + +Event properties: +* MUST reference parent room via d tag +* MUST have a status (planned/live/ended) +* MUST have a start time +* MAY track participant counts +* MAY include participant roles specific to the event +Event management: +* Clients SHOULD update event status regularly when live +* Events without updates for 1 hour MAY be considered ended +* starts and ends timestamps SHOULD be updated when status changes + +Examples + +Interactive Room (kind:30312) + +```jsonc +{ + "kind": 30312, + "tags": [ + ["d", "main-conference-room"], + ["room", "Main Conference Hall"], + ["summary", "Our primary conference space"], + ["image", "https://example.com/room.jpg"], + ["status", "open"], + ["service", "https://meet.example.com/room"], + ["endpoint", "https://api.example.com/room"], + ["t", "conference"], + ["p", "f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca", "wss://nostr.example.com/", "Owner"], + ["p", "14aeb..8dad4", "wss://provider2.com/", "Moderator"], + ["relays", "wss://relay1.com", "wss://relay2.com"] + ], + "content": "" +} +``` + +Conference Event (kind:30313) + +```jsonc +{ + "kind": 30313, + "tags": [ + ["d", "annual-meeting-2025"], + ["a", "30312:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:main-conference-room", "wss://nostr.example.com"] + ["title", "Annual Company Meeting 2025"], + ["summary", "Yearly company-wide meeting"], + ["image", "https://example.com/meeting.jpg"], + ["starts", "1676262123"], + ["ends", "1676269323"], + ["status", "live"], + ["total_participants", "180"], + ["current_participants", "175"], + ["p", "91cf9..4e5ca", "wss://provider1.com/", "Speaker"], + ], + "content": "" +} +``` +## Room Presence + +New `kind: 10312` provides an event which signals presence of a listener. + +The presence event SHOULD be updated at regular intervals and clients SHOULD filter presence events older than +a given time window. + +**This kind `10312` is a regular replaceable event, as such presence can only be indicated in one room at a time.** + +```json +{ + "kind": 10312, + "tags": [ + ["a" , "<room-a-tag>", "<relay-hint>", "root"], + ["hand", "1"] // hand raised flag + ] +} +``` From 6f3926c5b2d414c61cef36e4062ca8b7918cfc15 Mon Sep 17 00:00:00 2001 From: Awiteb <a@4rs.nl> Date: Wed, 18 Jun 2025 18:53:58 +0300 Subject: [PATCH 445/587] nip-34: Improve readability (#1954) Signed-off-by: Awiteb <a@4rs.nl> --- 34.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/34.md b/34.md index 56ede853..fc25bdeb 100644 --- a/34.md +++ b/34.md @@ -70,9 +70,9 @@ The `refs` tag can be optionally extended to enable clients to identify how many Patches 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. -Patches in a patch set SHOULD include a NIP-10 `e` `reply` tag pointing to the previous patch. +Patches in a patch set SHOULD include a [NIP-10](10.md) `e` `reply` tag pointing to the previous patch. -The first patch revision in a patch revision SHOULD include a NIP-10 `e` `reply` to the original root patch. +The first patch revision in a patch revision SHOULD include a [NIP-10](10.md) `e` `reply` to the original root patch. ```jsonc { @@ -125,7 +125,7 @@ Issues may have a `subject` tag, which clients can utilize to display a header. ## Replies -Replies to either a `kind:1621` _issue_ or a `kind:1617` _patch_ event should follow [NIP-22 comment](22.md). +Replies to either a `kind:1621` (_issue_) or a `kind:1617` (_patch_) event should follow [NIP-22 comment](22.md). ## Status @@ -161,9 +161,9 @@ Root Patches and Issues have a Status that defaults to 'Open' and can be set by } ``` -The Status event with the largest created_at date is valid. +The most recent Status event (by `created_at` date) from either the issue/patch author or a maintainer is considered valid. -The 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. +The Status of a patch-revision defaults to either that of the root-patch, or `1632` (_Closed_) if the root-patch's Status is `1631` (_Applied/Merged_) and the patch-revision isn't tagged in the `1631` (_Applied/Merged_) event. ## Possible things to be added later From db3e3bddbe2996151c992fe76899ad66bae9627a Mon Sep 17 00:00:00 2001 From: Awiteb <a@4rs.nl> Date: Wed, 2 Jul 2025 14:15:12 +0300 Subject: [PATCH 446/587] nip34: change 'defaults' to 'is' in patch revision status description (#1964) --- 34.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/34.md b/34.md index fc25bdeb..605065fd 100644 --- a/34.md +++ b/34.md @@ -163,7 +163,7 @@ Root Patches and Issues have a Status that defaults to 'Open' and can be set by The most recent Status event (by `created_at` date) from either the issue/patch author or a maintainer is considered valid. -The Status of a patch-revision defaults to either that of the root-patch, or `1632` (_Closed_) if the root-patch's Status is `1631` (_Applied/Merged_) and the patch-revision isn't tagged in the `1631` (_Applied/Merged_) event. +The Status of a patch-revision is to either that of the root-patch, or `1632` (_Closed_) if the root-patch's Status is `1631` (_Applied/Merged_) and the patch-revision isn't tagged in the `1631` (_Applied/Merged_) event. ## Possible things to be added later From 4eed6e836834d64dac8a3e3eefaa1975cc589bbe Mon Sep 17 00:00:00 2001 From: Gamma Markets <gammamarkets@tuta.io> Date: Thu, 3 Jul 2025 01:47:46 +0800 Subject: [PATCH 447/587] nip99 e-commerce use case extension (#1784) --- 99.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/99.md b/99.md index 724ce5f5..d137641d 100644 --- a/99.md +++ b/99.md @@ -8,7 +8,7 @@ Classified Listings This 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. -The 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. +The specification supports a broad range of use cases physical goods, services, work opportunities, rentals, free giveaways, personals, etc. To promote interoperability between clients implementing NIP-99 for e-commerce, you can find the extension proposal [here](https://github.com/GammaMarkets/market-spec/blob/main/spec.md) which standardizes the e-commerce use case while maintaining the specification's lightweight and flexible nature. While [NIP-15](15.md) provides a strictly structured marketplace specification, NIP-99 has emerged as a simpler and more flexible alternative. The structure of these events is very similar to [NIP-23](23.md) long-form content events. From 9afca6c4dcd3a95f1e05b8452eb3000e50de5e7b Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Thu, 3 Jul 2025 19:45:38 -0300 Subject: [PATCH 448/587] nip51: clarify kind:10012 description. --- 51.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/51.md b/51.md index 10a2242d..061cff82 100644 --- a/51.md +++ b/51.md @@ -32,7 +32,7 @@ For example, _mute list_ can contain the public keys of spammers and bad actors | Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) | | Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) | | Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group id + relay URL + optional group name), `"r"` for each relay in use | -| Favorite relays | 10012 | user favorite relays and pointers to relay sets | `"relay"` (relay URLs) and `"a"` (kind:30002 relay set) | +| Relay feeds | 10012 | user favorite browsable relays (and relay sets) | `"relay"` (relay URLs) and `"a"` (kind:30002 relay set) | | Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) | | Media follows | 10020 | multimedia (photos, short video) follow list | `"p"` (pubkeys -- with optional relay hint and petname) | | Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | From 477e3dfd4d672a830d157f32c41795b7a143b9d7 Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Mon, 7 Jul 2025 10:50:54 -0300 Subject: [PATCH 449/587] add "mute" OK=false status for no-op ephemeral events (#1965) --- 01.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/01.md b/01.md index 904f068b..1f564274 100644 --- a/01.md +++ b/01.md @@ -85,7 +85,7 @@ As a convention, all single-letter (only english alphabet letters: a-z, A-Z) key ### Kinds -Kinds specify how clients should interpret the meaning of each event and the other fields of each event (e.g. an `"r"` tag may have a meaning in an event of kind 1 and an entirely different meaning in an event of kind 10002). Each NIP may define the meaning of a set of kinds that weren't defined elsewhere. [NIP-10](10.md), for instance, specifies the `kind:1` text note for social media applications. +Kinds specify how clients should interpret the meaning of each event and the other fields of each event (e.g. an `"r"` tag may have a meaning in an event of kind 1 and an entirely different meaning in an event of kind 10002). Each NIP may define the meaning of a set of kinds that weren't defined elsewhere. [NIP-10](10.md), for instance, specifies the `kind:1` text note for social media applications. This NIP defines one basic kind: @@ -170,8 +170,9 @@ This NIP defines no rules for how `NOTICE` messages should be sent or treated. * `["OK", "b1a649ebe8...", false, "pow: difficulty 26 is less than 30"]` * `["OK", "b1a649ebe8...", false, "restricted: not allowed to write."]` * `["OK", "b1a649ebe8...", false, "error: could not connect to the database"]` + * `["OK", "b1a649ebe8...", false, "mute: no one was listening to your ephemeral event and it wasn't handled in any way, it was ignored"]` - `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: * `["CLOSED", "sub1", "unsupported: filter contains unknown elements"]` * `["CLOSED", "sub1", "error: could not connect to the database"]` * `["CLOSED", "sub1", "error: shutting down idle subscription"]` -- The standardized machine-readable prefixes for `OK` and `CLOSED` are: `duplicate`, `pow`, `blocked`, `rate-limited`, `invalid`, `restricted`, and `error` for when none of that fits. +- The standardized machine-readable prefixes for `OK` and `CLOSED` are: `duplicate`, `pow`, `blocked`, `rate-limited`, `invalid`, `restricted`, `mute` and `error` for when none of that fits. From 82fffa05807f75c49ce322170e73ec538b998959 Mon Sep 17 00:00:00 2001 From: Alex Gleason <alex@alexgleason.me> Date: Fri, 11 Jul 2025 00:58:51 -0400 Subject: [PATCH 450/587] NIP-72: use kind 1111 events for text notes (#1953) --- 72.md | 44 ++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 40 insertions(+), 4 deletions(-) diff --git a/72.md b/72.md index 582410ad..11172904 100644 --- a/72.md +++ b/72.md @@ -41,19 +41,55 @@ The goal of this NIP is to enable public communities. It defines the replaceable # Posting to a community -Any Nostr event can be posted to a community. Clients MUST add one or more community `a` tags, each with a recommended relay. +[NIP-22](NIP-22) kind 1111 events SHOULD be used for text notes posted to a community, with the `A` tag always scoped to the community definition. + +## Top-level posts + +For top-level posts, the uppercase and lowercase NIP-22 tags should both refer to the community definition itself. ```jsonc { - "kind": 1, + "kind": 1111, "tags": [ - ["a", "34550:<community event author pubkey>:<community-d-identifier>", "<optional-relay-url>"], + ["A", "34550:<community-author-pubkey>:<community-d-identifier>", "<optional-relay-url>"], + ["a", "34550:<community-author-pubkey>:<community-d-identifier>", "<optional-relay-url>"], + ["P", "<community-author-pubkey>", "<optional-relay-url>"], + ["p", "<community-author-pubkey>", "<optional-relay-url>"], + ["K", "34550"], + ["k", "34550"], ], - "content": "hello world", + "content": "Hi everyone. It's great to be here!", // other fields... } ``` +## Nested replies + +For nested replies, the uppercase tags should still refer to the community definition, while the lowercase tags should refer to the parent post or reply. + +```jsonc +{ + "kind": 1111, + "tags": [ + // community definition itself + ["A", "34550:<community-author-pubkey>:<community-d-identifier>", "<optional-relay-url>"], + ["P", "<community-author-pubkey>", "<optional-relay-url>"], + ["K", "34550"], + + // parent post or reply + ["e", "<parent-event-id>", "<optional-relay-url>"], + ["p", "<parent-event-author-pubkey>", "<optional-relay-url>"], + ["k", "<parent-event-kind>"] // most likely "1111" + ], + "content": "Agreed! Welcome everyone!", + // other fields... +} +``` + +## Backwards compatibility note + +Previously kind 1 events were used for posts in communities, with an "a" tag pointing to the community. For backwards compatibility, clients MAY still query for kind 1 events, but SHOULD NOT use them for new posts. Instead, clients SHOULD use kind 1111 events with the `A` and `a` tags as described above. + # Moderation Anyone 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. From d306f6b3f81fe3bcffa0effe80aebd5c1572b1e7 Mon Sep 17 00:00:00 2001 From: Giovanni <giovanni.learntheropes@protonmail.ch> Date: Sat, 12 Jul 2025 14:04:35 -0300 Subject: [PATCH 451/587] add peach bitcoin nip-69 implementation (#1961) --- 69.md | 1 + 1 file changed, 1 insertion(+) diff --git a/69.md b/69.md index 603016ec..8a28331f 100644 --- a/69.md +++ b/69.md @@ -80,6 +80,7 @@ Currently implemented on the following platforms: - [Mostro](https://github.com/MostroP2P/mostro) - [@lnp2pBot](https://github.com/lnp2pBot/bot) - [Robosats](https://github.com/RoboSats/robosats/pull/1362) +- [Peach Bitcoin](https://github.com/Peach2Peach/peach-nostr-announcer-bot) ## References From 1afb6da049e57dd628ef46a3b0f90300653a66ee Mon Sep 17 00:00:00 2001 From: benthecarman <15256660+benthecarman@users.noreply.github.com> Date: Wed, 16 Jul 2025 06:13:09 -0500 Subject: [PATCH 452/587] NIP-87: Ecash Mint Discoverability (#1110) Co-authored-by: Pablo Fernandez <pfer@me.com> --- 87.md | 142 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 9 ++-- 2 files changed, 148 insertions(+), 3 deletions(-) create mode 100644 87.md diff --git a/87.md b/87.md new file mode 100644 index 00000000..c6701d5a --- /dev/null +++ b/87.md @@ -0,0 +1,142 @@ +NIP-87 +====== + +Ecash Mint Discoverability +-------------------------------- + +`draft` `optional` + +This NIP describes `kind:38173`, `kind:38172` and `kind:38000`: a way to discover ecash mints, their capabilities, and people who recommend them. + +## Rationale + +Nostr's discoverability and transparent event interaction is one of its most interesting/novel mechanics. +This NIP provides a simple way for users to discover ecash mints recommended by other users and to interact with them. + +### Parties involved + +There are three actors to this workflow: + +* An ecash mint operator, announces their mint and its capabilities. + * Publishes `kind:38173` or `kind:38172`, detailing how to connect to it and its capabilities. +* user A, who recommends an ecash mint + * Publishes `kind:38000` +* user B, who seeks a recommendation for an ecash mint + * Queries for `kind:38000` and, based on results, queries for `kind:38173`/`kind:38172` + +## Events + +### Recommendation event +```json +{ + "kind": 38000, + "pubkey": <recommender-user-pubkey>, + "tags": [ + ["k", "38173"], + ["d", "<d-identifier>"], + ["u", <recommended-fedimint-invite-code>], + ["a", "38173:fedimint-pubkey:<d-identifier>", "wss://relay1"] + ], + "content": "I trust this mint with my life" +} +``` + +The recommendation event is a parameterized-replacable event so that a user can change edit their recommendation without creating a new event. + +The `d` tag in `kind:38000` is the `kind:38173`/`kind:38172` event identifier this event is recommending, if no event exists, the `d` tag can still be calculated from the mint's pubkey/id. +The `k` tag is the kind number that corresponds to the event kind that the user is recommending, in this case `kind:38173` for fedimints and `kind:38172` for cashu mints. + +Optional `u` tags can be added to give a recommend way to connect to the mint. +The value of the tag is the URL or invite code of the ecash mint. +Multiple `u` tags can appear on the same `kind:38000`. + +`a` tags are used to point to the `kind:38173`/`kind:38172` event of the ecash mint. +The first value of the tag is the `kind:38173`/`kind:38172` event identifier, the second value of the tag is a relay hint. +This is used to correctly point to the mint's `kind:38173`/`kind:38172` event in case there are duplicates claiming to be the same mint. + +The content can be used to give a review. + +## Ecash Mint Information + +Cashu mints SHOULD publish `kind:38172` events to announce their capabilities and how to connect to them. + +For cashu mints, the `u` tag SHOULD be the URL to the cashu mint and it should list the nuts that the cashu mint supports. + +The `d` tag SHOULD be the mint's pubkey (found when querying `/v1/info`), this way users can query by pubkey and find the mint announcement. + +An `n` tag SHOULD be added to signify the network the cashu mint is on (either `mainnet`, `testnet`, `signet`, or `regtest`) + +```json +{ + "kind": 38172, + "pubkey": "<application-pubkey>", + "content": "<optional-kind:0-style-metadata>", + "tags": [ + ["d", <cashu mint pubkey>], + ["u", "https://cashu.example.com"], + ["nuts", "1,2,3,4,5,6,7"], + ["n", "mainnet"] + ] +} +``` + +Fedimints SHOULD publish `kind:38173` events to announce their capabilities and how to connect to them. + +For fedimints, it should list all known fedimint invite codes in `u` tags and it should list the modules it supports. + +The `d` tag SHOULD be the federation id, this way users can query by federation id and find the fedimint announcement. + +An `n` tag SHOULD be added to signify the network the fedimint is on (either `mainnet`, `testnet`, `signet`, or `regtest`) + +```json +{ + "kind": 38173, + "pubkey": "<application-pubkey>", + "content": "<optional-kind:0-style-metadata>", + "tags": [ + ["d", <federation-id>], + ["u", "fed11abc.."], + ["u", "fed11xyz.."], + ["modules", "lightning,wallet,mint"], + ["n", "signet"] + ] +} +``` + +* `content` is an optional `metadata`-like stringified JSON object, as described in NIP-01. This content is useful when the pubkey creating the `kind:38173` is not a normal user. If `content` is empty, the `kind:0` of the pubkey should be used to display mint information (e.g. name, picture, web, LUD16, etc.) + +## Example + +### User A recommends some mints +User A might be a user of a cashu mint. Using a client, user A publishes an event recommending the cashu mint they use. + +```json +{ + "kind": 38000, + "tags": [ + ["u", "fed11abc..", "fedimint"], + ["u", "https://cashu.example.com", "cashu"], + ["a", "38173:fedimint-pubkey:<d-identifier>", "wss://relay1", "fedimint"], + ["a", "38172:cashu-mint-pubkey:<d-identifier>", "wss://relay2", "cashu"] + ], + ... +} +``` + +### User B finds a mint +User B wants to use an ecash wallet, they need to find a mint. + +User B's wallet client queries for `kind:38000` events, looking for recommendations for ecash mints. + +```json +["REQ", <id>, [{ "kinds": [38000], "authors": [<user>, <users-contact-list>], "#k": ["38173"] }]] +``` + +User B, who follows User A, sees that `kind:38000` event and tries to connect to the corresponding mints. + +### Alternative query bypassing `kind:38000` +Alternatively, users might choose to query directly for `kind:38173` 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. + +```json +["REQ", <id>, [{ "kinds": [38173], "authors": [...] }]] +``` diff --git a/README.md b/README.md index 397eceb5..ff7e9bb7 100644 --- a/README.md +++ b/README.md @@ -93,6 +93,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-7D: Threads](7D.md) - [NIP-84: Highlights](84.md) - [NIP-86: Relay Management API](86.md) +- [NIP-87: Ecash Mint Discoverability](87.md) - [NIP-88: Polls](88.md) - [NIP-89: Recommended Application Handlers](89.md) - [NIP-90: Data Vending Machines](90.md) @@ -107,7 +108,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-C7: Chats](C7.md) ## Event Kinds - | kind | description | NIP | | ------------- | ------------------------------- | -------------------------------------- | | `0` | User Metadata | [01](01.md) | @@ -200,6 +200,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10166` | Relay Monitor Announcement | [66](66.md) | | `13194` | Wallet Info | [47](47.md) | | `17375` | Cashu Wallet Event | [60](60.md) | +| `17375` | Ecash Mint Recommendation | [87](87.md) | | `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | | `22242` | Client Authentication | [42](42.md) | | `23194` | Wallet Request | [47](47.md) | @@ -247,9 +248,11 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `31924` | Calendar | [52](52.md) | | `31925` | Calendar Event RSVP | [52](52.md) | | `31989` | Handler recommendation | [89](89.md) | -| `31990` | Handler information | [89](89.md) | | -| `32267` | Software Application | | | +| `31990` | Handler information | [89](89.md) | +| `32267` | Software Application | | | `34550` | Community Definition | [72](72.md) | +| `38172` | Cashu Mint Announcement | [87](87.md) | +| `38173` | Fedimint Announcement | [87](87.md) | | `38383` | Peer-to-peer Order events | [69](69.md) | | `39000-9` | Group metadata events | [29](29.md) | | `39089` | Starter packs | [51](51.md) | From 074b8eeb0194804ea7fa9d6e695c3d9e9c62e153 Mon Sep 17 00:00:00 2001 From: AsaiToshiya <to.asai.60@gmail.com> Date: Sat, 19 Jul 2025 01:17:44 +0900 Subject: [PATCH 453/587] add kinds 10312, 30312 and 30313 (from nip53) --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index ff7e9bb7..1292056a 100644 --- a/README.md +++ b/README.md @@ -198,6 +198,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10063` | User server list | [Blossom][blossom] | | `10096` | File storage server list | [96](96.md) | | `10166` | Relay Monitor Announcement | [66](66.md) | +| `10312` | Room Presence | [53](53.md) | | `13194` | Wallet Info | [47](47.md) | | `17375` | Cashu Wallet Event | [60](60.md) | | `17375` | Ecash Mint Recommendation | [87](87.md) | @@ -232,6 +233,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30166` | Relay Discovery | [66](66.md) | | `30267` | App curation sets | [51](51.md) | | `30311` | Live Event | [53](53.md) | +| `30312` | Interactive Room | [53](53.md) | +| `30313` | Conference Event | [53](53.md) | | `30315` | User Statuses | [38](38.md) | | `30388` | Slide Set | [Corny Chat][cornychat-slideset] | | `30402` | Classified Listing | [99](99.md) | From e50f37a527ace39cc3057827d52295c6b6de1112 Mon Sep 17 00:00:00 2001 From: Fabian <fabianfabian@gmail.com> Date: Wed, 23 Jul 2025 22:31:55 +0200 Subject: [PATCH 454/587] NIP-A0: Voice Messages (#1984) --- A0.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 3 +++ 2 files changed, 63 insertions(+) create mode 100644 A0.md diff --git a/A0.md b/A0.md new file mode 100644 index 00000000..f5d711b9 --- /dev/null +++ b/A0.md @@ -0,0 +1,60 @@ +NIP-A0 +====== + +Voice Messages +----------- + +**Status:** Draft + +This NIP defines new events `kind: 1222` for root messages and `kind: 1244` for reply messages to be used for short voice messages, typically up to 60 seconds in length. + +## Specification + +### Event Kind `1222` and Kind `1244` + +The `kind: 1222` event is defined as follows: + +- `content`: MUST be a URL pointing directly to an audio file. + - The audio file SHOULD be in `audio/webm` format. Clients MAY support other common audio formats like `audio/ogg`, `audio/mp4` (m4a), or `audio/mpeg` (mp3), but `audio/webm` is recommended for broad compatibility and efficiency. + - The audio duration SHOULD be no longer than 60 seconds. Clients publishing `kind: 1222` events SHOULD enforce this limit or provide a clear warning to the user if exceeded. +- `tags`: + - Tags MAY be included as per other NIPs (e.g., `t` for hashtags, `g` for geohash, etc.). + + The `kind: 1244` event is defined as follows: + +- To be used for replies, `kind: 1244` events MUST follow the structure of `NIP-22`. +- `content`: MUST be a URL pointing directly to an audio file. + - The audio file SHOULD be in `audio/webm` format. Clients MAY support other common audio formats like `audio/ogg`, `audio/mp4` (m4a), or `audio/mpeg` (mp3), but `audio/webm` is recommended for broad compatibility and efficiency. + - The audio duration SHOULD be no longer than 60 seconds. Clients publishing `kind: 1222` events SHOULD enforce this limit or provide a clear warning to the user if exceeded. +- `tags`: + - Tags MAY be included as per other NIPs (e.g., `t` for hashtags, `g` for geohash, etc.). + + +## Visual representation with `imeta` (NIP-92) tag (optional) + +The following imeta (NIP-92) tags MAY be included so clients can render a visual preview without having to download the audio file first: + +- `waveform`: amplitude values over time, space separated, less than 100 values should be enough to render a nice visual +- `duration`: audio length in seconds + +## Examples + +### Root Voice Message Example + +```json +{ + "content": "https://blossom.primal.net/5fe7df0e46ee6b14b5a8b8b92939e84e3ca5e3950eb630299742325d5ed9891b.mp4", + "created_at": 1752501052, + "id": "...", + "kind": 1222, + "pubkey": "...", + "sig": "...", + "tags": [ + [ + "imeta", + "url https://blossom.primal.net/5fe7df0e46ee6b14b5a8b8b92939e84e3ca5e3950eb630299742325d5ed9891b.mp4", + "waveform 0 0.05 0.27 0.08 0.01 0.01 0.01 0.03 0.38 1.5 0.49 0.02 0.28 0.04 0.01 0 0 0.39 0.22 0.16 0.05 0.06 0.55 0.01 0.06 0.01 0 0 0.02 0.61 0.02 0.07 0.01 0.21 0.09 0.12 0.63 0.01 0.02 0.02 0.42 0.02 0.68 0.05 0.02 0.05 0.02 0 0 0 0", + "duration 8" + ] + ] +} \ No newline at end of file diff --git a/README.md b/README.md index 1292056a..ad8c2c9e 100644 --- a/README.md +++ b/README.md @@ -102,6 +102,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-96: HTTP File Storage Integration](96.md) - [NIP-98: HTTP Auth](98.md) - [NIP-99: Classified Listings](99.md) +- [NIP-A1: Voice Messages](A0.md) - [NIP-B0: Web Bookmarks](B0.md) - [NIP-B7: Blossom](B7.md) - [NIP-C0: Code Snippets](C0.md) @@ -151,6 +152,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `1063` | File Metadata | [94](94.md) | | `1068` | Poll | [88](88.md) | | `1111` | Comment | [22](22.md) | +| `1222` | Voice Message | [A0](A0.md) | +| `1244` | Voice Message Comment | [A0](A0.md) | | `1311` | Live Chat Message | [53](53.md) | | `1337` | Code Snippet | [C0](C0.md) | | `1617` | Patches | [34](34.md) | From 9be455bf57117dcf5779feb79fd16ef808316b5c Mon Sep 17 00:00:00 2001 From: AsaiToshiya <to.asai.60@gmail.com> Date: Thu, 24 Jul 2025 23:04:12 +0900 Subject: [PATCH 455/587] fix A0 nip number --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ad8c2c9e..e82f754d 100644 --- a/README.md +++ b/README.md @@ -102,7 +102,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-96: HTTP File Storage Integration](96.md) - [NIP-98: HTTP Auth](98.md) - [NIP-99: Classified Listings](99.md) -- [NIP-A1: Voice Messages](A0.md) +- [NIP-A0: Voice Messages](A0.md) - [NIP-B0: Web Bookmarks](B0.md) - [NIP-B7: Blossom](B7.md) - [NIP-C0: Code Snippets](C0.md) From 4984b057c20397eae919ee5e463bc8a5d3fb2dc0 Mon Sep 17 00:00:00 2001 From: Fabian <fabian@nostur.com> Date: Sun, 27 Jul 2025 21:23:50 +0200 Subject: [PATCH 456/587] Update audio format and waveform recommendation for NIP-A0: Voice Messages (#1990) --- A0.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/A0.md b/A0.md index f5d711b9..884bf2aa 100644 --- a/A0.md +++ b/A0.md @@ -15,7 +15,7 @@ This NIP defines new events `kind: 1222` for root messages and `kind: 1244` for The `kind: 1222` event is defined as follows: - `content`: MUST be a URL pointing directly to an audio file. - - The audio file SHOULD be in `audio/webm` format. Clients MAY support other common audio formats like `audio/ogg`, `audio/mp4` (m4a), or `audio/mpeg` (mp3), but `audio/webm` is recommended for broad compatibility and efficiency. + - The audio file SHOULD be in `audio/mp4` (.m4a) format using AAC or Opus encoding. Clients MAY support other common audio formats like `audio/ogg`, `audio/webm`, or `audio/mpeg` (mp3), but `audio/mp4` is recommended for broad compatibility and efficiency. - The audio duration SHOULD be no longer than 60 seconds. Clients publishing `kind: 1222` events SHOULD enforce this limit or provide a clear warning to the user if exceeded. - `tags`: - Tags MAY be included as per other NIPs (e.g., `t` for hashtags, `g` for geohash, etc.). @@ -24,7 +24,7 @@ The `kind: 1222` event is defined as follows: - To be used for replies, `kind: 1244` events MUST follow the structure of `NIP-22`. - `content`: MUST be a URL pointing directly to an audio file. - - The audio file SHOULD be in `audio/webm` format. Clients MAY support other common audio formats like `audio/ogg`, `audio/mp4` (m4a), or `audio/mpeg` (mp3), but `audio/webm` is recommended for broad compatibility and efficiency. + - The audio file SHOULD be in `audio/mp4` (.m4a) format using AAC or Opus encoding. Clients MAY support other common audio formats like `audio/ogg`, `audio/webm`, or `audio/mpeg` (mp3), but `audio/mp4` is recommended for broad compatibility and efficiency. - The audio duration SHOULD be no longer than 60 seconds. Clients publishing `kind: 1222` events SHOULD enforce this limit or provide a clear warning to the user if exceeded. - `tags`: - Tags MAY be included as per other NIPs (e.g., `t` for hashtags, `g` for geohash, etc.). @@ -34,7 +34,7 @@ The `kind: 1222` event is defined as follows: The following imeta (NIP-92) tags MAY be included so clients can render a visual preview without having to download the audio file first: -- `waveform`: amplitude values over time, space separated, less than 100 values should be enough to render a nice visual +- `waveform`: amplitude values over time, space separated full integers, less than 100 values should be enough to render a nice visual - `duration`: audio length in seconds ## Examples @@ -53,7 +53,7 @@ The following imeta (NIP-92) tags MAY be included so clients can render a visual [ "imeta", "url https://blossom.primal.net/5fe7df0e46ee6b14b5a8b8b92939e84e3ca5e3950eb630299742325d5ed9891b.mp4", - "waveform 0 0.05 0.27 0.08 0.01 0.01 0.01 0.03 0.38 1.5 0.49 0.02 0.28 0.04 0.01 0 0 0.39 0.22 0.16 0.05 0.06 0.55 0.01 0.06 0.01 0 0 0.02 0.61 0.02 0.07 0.01 0.21 0.09 0.12 0.63 0.01 0.02 0.02 0.42 0.02 0.68 0.05 0.02 0.05 0.02 0 0 0 0", + "waveform 0 7 35 8 100 100 49 8 4 16 8 10 7 2 20 10 100 100 100 100 100 100 15 100 100 100 25 60 5 4 3 1 0 100 100 15 100 29 88 0 33 11 39 100 100 19 4 100 42 35 5 0 1 5 0 0 11 38 100 94 17 11 44 58 5 100 100 100 55 14 72 100 100 57 6 1 14 2 16 100 100 40 16 100 100 6 32 14 13 41 36 16 14 6 3 0 1 2 1 6 0", "duration 8" ] ] From aefad1876b68124d16222de7f3e458dd78c37fca Mon Sep 17 00:00:00 2001 From: reis <1l0@users.noreply.github.com> Date: Tue, 29 Jul 2025 20:42:47 +0900 Subject: [PATCH 457/587] nip25: remove duplicate (#1993) --- 25.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/25.md b/25.md index 6492822a..e0db86a0 100644 --- a/25.md +++ b/25.md @@ -26,8 +26,6 @@ There SHOULD be a `p` tag set to the `pubkey` of the event being reacted to. If If the event being reacted to is an addressable event, an `a` SHOULD be included together with the `e` tag, it must be set to the coordinates (`kind:pubkey:d-tag`) of the event being reacted to. -The reaction SHOULD include a `k` tag with the stringified kind number of the reacted event as its value. - The `e` and `a` tags SHOULD include relay and pubkey hints. The `p` tags SHOULD include relay hints. The reaction event MAY include a `k` tag with the stringified kind number of the reacted event as its value. From e6de76f76b2ef46d7535ef3c9c77812c6d40b32c Mon Sep 17 00:00:00 2001 From: AsaiToshiya <to.asai.60@gmail.com> Date: Wed, 30 Jul 2025 03:28:29 +0900 Subject: [PATCH 458/587] remove duplicate kind (#1995) --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index e82f754d..d2dcbfea 100644 --- a/README.md +++ b/README.md @@ -204,7 +204,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10312` | Room Presence | [53](53.md) | | `13194` | Wallet Info | [47](47.md) | | `17375` | Cashu Wallet Event | [60](60.md) | -| `17375` | Ecash Mint Recommendation | [87](87.md) | | `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | | `22242` | Client Authentication | [42](42.md) | | `23194` | Wallet Request | [47](47.md) | From faba3f016df141781f6328a3f0ac398ee8a03a3c Mon Sep 17 00:00:00 2001 From: DanConwayDev <114834599+DanConwayDev@users.noreply.github.com> Date: Thu, 31 Jul 2025 13:43:14 +0100 Subject: [PATCH 459/587] NIP-34: `mention` marker ~> `q` tag NIP-10 update (#1998) --- 34.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/34.md b/34.md index 605065fd..65f3388f 100644 --- a/34.md +++ b/34.md @@ -150,7 +150,7 @@ Root Patches and Issues have a Status that defaults to 'Open' and can be set by ["r", "<earliest-unique-commit-id-of-repo>"] // optional for `1631` status - ["e", "<applied-or-merged-patch-event-id>", "", "mention"], // for each + ["q", "<applied-or-merged-patch-event-id>", "<relay-url>", "<pubkey>"], // for each // when merged ["merge-commit", "<merge-commit-id>"] ["r", "<merge-commit-id>"] From f30a43bd37e08516923b96dd0d860122c9ffe04e Mon Sep 17 00:00:00 2001 From: Jeremy Klein <jklein24@gmail.com> Date: Thu, 31 Jul 2025 06:21:18 -0700 Subject: [PATCH 460/587] [NWC] Add an encryption tag to negotiate upgrading to NIP44. (#1780) Co-authored-by: Roland <33993199+rolznz@users.noreply.github.com> --- 47.md | 148 +++++++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 127 insertions(+), 21 deletions(-) diff --git a/47.md b/47.md index 84f710e2..298b3992 100644 --- a/47.md +++ b/47.md @@ -28,15 +28,16 @@ Fundamentally NWC is communication between a **client** and **wallet service** b 4. Once the payment is complete the **wallet service** will send an encrypted `response` (kind 23195) to the **user** over the relay(s) in the URI. - 5. The **wallet service** may send encrypted notifications (kind 23196) of wallet events (such as a received payment) to the **client**. + 5. The **wallet service** may send encrypted notifications (kind 23197 or 23196) of wallet events (such as a received payment) to the **client**. ## Events There are four event kinds: + - `NIP-47 info event`: 13194 - `NIP-47 request`: 23194 - `NIP-47 response`: 23195 -- `NIP-47 notification event`: 23196 +- `NIP-47 notification event`: 23197 (23196 for backwards compatibility with NIP-04) ### Info Event @@ -46,34 +47,71 @@ The content should be a plaintext string with the supported capabilities space-s If the **wallet service** supports notifications, the info event SHOULD contain a `notifications` tag with the supported notification types space-separated, eg. `payment_received payment_sent`. +It should also contain supported encryption modes as described in the [Encryption](#encryption) section. For example: + +```jsonc +{ + "kind": 13194, + "tags": [ + ["encryption", "nip44_v2 nip04"], // List of supported encryption schemes as described in the Encryption section. + ["notifications", "payment_received payment_sent"] + // ... + ], + "content": "pay_invoice get_balance make_invoice lookup_invoice list_transactions get_info notifications", + // ... +} +``` + ### Request and Response Events Both 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 **client** if this is a response. The response event SHOULD contain an `e` tag with the id of the request event it is responding to. Optionally, 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. -The content of requests and responses is encrypted with [NIP04](04.md), and is a JSON-RPCish object with a semi-fixed structure: +The content of requests and responses is encrypted with [NIP44](44.md), and is a JSON-RPCish object with a semi-fixed structure. -Request: -```jsonc +**Important note for backwards-compatibility:** The initial version of the protocol used [NIP04](04.md). If a **wallet service** or client app does not include the `encryption` tag in the +`info` or request events, it should be assumed that the connection is using NIP04 for encryption. See the [Encryption](#encryption) section for more information. + +Example request: + +```js { - "method": "pay_invoice", // method, string - "params": { // params, object - "invoice": "lnbc50n1..." // command-related data - } + "kind" 23194, + "tags": [ + ["encryption", "nip44_v2"], + ["p", "03..." ] // public key of the wallet service. + // ... + ], + "content": nip44_encrypt({ // Encryption type corresponds to the `encryption` tag. + "method": "pay_invoice", // method, string + "params": { // params, object + "invoice": "lnbc50n1..." // command-related data + } + }), } ``` -Response: -```jsonc +Example response: + +```js { - "result_type": "pay_invoice", //indicates the structure of the result field - "error": { //object, non-null in case of error - "code": "UNAUTHORIZED", //string error code, see below - "message": "human readable error message" - }, - "result": { // result, object. null in case of error. - "preimage": "0123456789abcdef..." // command-related data - } + "kind" 23195, + "tags": [ + ["p", "03..." ] // public key of the requesting client app + ["e", "1234"] // id of the request event this is responding to + // ... + ], + "content": nip44_encrypt({ // Encrypted using the scheme requested by the client. + "result_type": "pay_invoice", //indicates the structure of the result field + "error": { //object, non-null in case of error + "code": "UNAUTHORIZED", //string error code, see below + "message": "human readable error message" + }, + "result": { // result, object. null in case of error. + "preimage": "0123456789abcdef..." // command-related data + } + }) + // ... } ``` @@ -83,9 +121,9 @@ If the command was successful, the `error` field must be null. ### Notification Events -The notification event SHOULD contain one `p` tag, the public key of the **client**. +The notification event is a kind 23197 event SHOULD contain one `p` tag, the public key of the **client**. -The content of notifications is encrypted with [NIP04](04.md), and is a JSON-RPCish object with a semi-fixed structure: +The content of notifications is encrypted with [NIP44](44.md) (or NIP-04 for legacy client apps), and is a JSON-RPCish object with a semi-fixed structure: ```jsonc { @@ -96,6 +134,7 @@ The content of notifications is encrypted with [NIP04](04.md), and is a JSON-RPC } ``` +_Note on backwards-compatibility:_ If a **wallet service** supports both nip44 and nip04 for legacy client apps, it should publish both notification events for each notification - kind 23196 encrypted with NIP-04, and kind 23197 encrypted with NIP-44. It is up to the **client** to decide which event to listen to based on its supported encryption and declared supported encryption schemes of the **wallet service** in the `info` event. ### Error codes - `RATE_LIMITED`: The client is sending commands too fast. It should retry in a few seconds. @@ -105,6 +144,7 @@ The content of notifications is encrypted with [NIP04](04.md), and is a JSON-RPC - `RESTRICTED`: This public key is not allowed to do this operation. - `UNAUTHORIZED`: This public key has no wallet connected. - `INTERNAL`: An internal error. +- `UNSUPPORTED_ENCRYPTION`: The encryption type of the request is not supported by the wallet service. - `OTHER`: Other error. ## Nostr Wallet Connect URI @@ -499,6 +539,71 @@ Notification: 2. **wallet service** verifies that the author's key is authorized to perform the payment, decrypts the payload and sends the payment. 3. **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. +## Encryption + +The initial version of NWC used [NIP-04](04.md) for encryption which has been deprecated and replaced by [NIP-44](44.md). NIP-44 should always be preferred for encryption, but there may be legacy cases +where the **wallet service** or **client** has not yet migrated to NIP-44. The **wallet service** and **client** should negotiate the encryption method to use based on the `encryption` tag in the `info` event. + +The encryption tag can contain either `nip44_v2` or `nip04`. The absence of this tag implies that the wallet only supports `nip04`. + +| Encryption code | Use | Notes | +|-----------------|----------------------|---------------------------------------------------------| +| `nip44_v2` | NIP-44 | Required | +| `nip04` | NIP-04 | Deprecated and only here for backward compatibility | +| `<not present>` | NIP-04 | Deprecated and only here for backward compatibility | + +The negotiation works as follows. + +1. The **wallet service** includes an `encryption` tag in the `info` event. This tag contains a space-separated list of encryption schemes that the **wallet service** supports (eg. `nip44_v2 nip04`) +2. The **client application** includes an `encryption` tag in each request event. This tag contains the encryption scheme which should be used for the request. The **client application** should always prefer nip44 if supported by the **wallet service**. + +### Info event + +First, the **wallet service** adds an `encryption` tag to its `info` event containing a space-separated list of encryption schemes it supports. For example, +if a wallet service supports nip44, but also allows backwards-compatibility to nip04 client applications, its `encryption` tag in the `info` event might look something like: + +```jsonc +{ + "kind": 13194, + "tags": [ + ["encryption", "nip44_v2 nip04"], + // ... + ], + "content": "pay_invoice get_balance make_invoice lookup_invoice list_transactions get_info", + // ... +} +``` + +When a **client application** establishes a connection, it should read the info event and look for the `encryption` tag. + +**Absence of this tag implies that the wallet only supports nip04.** + +If the `encryption` tag is present, the **client application** will choose optimal encryption supported by both itself, and the **wallet service**, which should always be nip44 if possible. + +### Request events + +When a **client application** sends a request event, it should include a `encryption` tag with the encryption scheme it is using. The scheme MUST be supported by the **wallet service** as indicated by the info event. +For example, if the client application supports nip44, the request event might look like: + +```jsonc +{ + "kind": 23194, + "tags": [ + ["encryption", "nip44_v2"], + // ... + ], + // ... +} +``` + +If the **wallet service** does not support the specified encryption scheme, it will return an `UNSUPPORTED_ENCRYPTION` error. Absence of the `encryption` tag indicates use of nip04 for encryption. + +### Notification events + +As described above in the [Notifications](#notifications) section, if a **wallet service** supports both nip04 and nip44, it should publish two notification events for each notification - kind 23196 encrypted with NIP-04, and kind 23197 encrypted with NIP-44. If the **wallet service** only supports nip44, it should only publish kind 23197 events. + +The **client** should check the `encryption` tag in the `info` event to determine which encryption schemes the **wallet service** supports, and listen to the appropriate notification event. + ## Using a dedicated relay This NIP does not specify any requirements on the type of relays used. However, if the user is using a custodial service it might make sense to use a relay that is hosted by the custodial service. The relay may then enforce authentication to prevent metadata leaks. Not depending on a 3rd party relay would also improve reliability in this case. @@ -513,6 +618,7 @@ This NIP does not specify any requirements on the type of relays used. However, "created_at": 1713883677, "kind": 13194, "tags": [ + [ "encryption", "nip44_v2 nip04" ], [ "notifications", "payment_received payment_sent" From 0595d438aaa163dd33ed00748026698a411a0861 Mon Sep 17 00:00:00 2001 From: Adithya Vardhan <imadithyavardhan@gmail.com> Date: Thu, 31 Jul 2025 18:56:27 +0530 Subject: [PATCH 461/587] NIP-47: add state to transactions (#1933) --- 47.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/47.md b/47.md index 298b3992..1bbbcb3a 100644 --- a/47.md +++ b/47.md @@ -335,6 +335,7 @@ Response: "result_type": "make_invoice", "result": { "type": "incoming", // "incoming" for invoices, "outgoing" for payments + "state": "pending", "invoice": "string", // encoded invoice, optional "description": "string", // invoice's description, optional "description_hash": "string", // invoice's description hash, optional @@ -368,6 +369,7 @@ Response: "result_type": "lookup_invoice", "result": { "type": "incoming", // "incoming" for invoices, "outgoing" for payments + "state": "pending", // can be "pending", "settled", "expired" (for invoices) or "failed" (for payments) "invoice": "string", // encoded invoice, optional "description": "string", // invoice's description, optional "description_hash": "string", // invoice's description hash, optional @@ -416,6 +418,7 @@ Response: "transactions": [ { "type": "incoming", // "incoming" for invoices, "outgoing" for payments + "state": "pending", // can be "pending", "settled", "expired" (for invoices) or "failed" (for payments) "invoice": "string", // encoded invoice, optional "description": "string", // invoice's description, optional "description_hash": "string", // invoice's description hash, optional @@ -492,6 +495,7 @@ Notification: "notification_type": "payment_received", "notification": { "type": "incoming", + "state": "settled", "invoice": "string", // encoded invoice "description": "string", // invoice's description, optional "description_hash": "string", // invoice's description hash, optional @@ -517,6 +521,7 @@ Notification: "notification_type": "payment_sent", "notification": { "type": "outgoing", + "state": "settled", "invoice": "string", // encoded invoice "description": "string", // invoice's description, optional "description_hash": "string", // invoice's description hash, optional From e33f5cd38ff485519425006ed5f68015ff9de4a9 Mon Sep 17 00:00:00 2001 From: hodlbod <jstaab@protonmail.com> Date: Fri, 1 Aug 2025 19:39:33 +0000 Subject: [PATCH 462/587] Add geocaching kinds (#1977) Co-authored-by: Jon Staab <shtaab@gmail.com> --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index d2dcbfea..fb78832e 100644 --- a/README.md +++ b/README.md @@ -175,6 +175,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `7374` | Reserved Cashu Wallet Tokens | [60](60.md) | | `7375` | Cashu Wallet Tokens | [60](60.md) | | `7376` | Cashu Wallet History | [60](60.md) | +| `7516` | Geocache log | [geocaching](geocaching) | +| `7517` | Geocache proof of find | [geocaching](geocaching) | | `9000`-`9030` | Group Control Events | [29](29.md) | | `9041` | Zap Goal | [75](75.md) | | `9321` | Nutzap | [61](61.md) | @@ -258,6 +260,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `34550` | Community Definition | [72](72.md) | | `38172` | Cashu Mint Announcement | [87](87.md) | | `38173` | Fedimint Announcement | [87](87.md) | +| `37516` | Geocache listing | [geocaching](geocaching) | | `38383` | Peer-to-peer Order events | [69](69.md) | | `39000-9` | Group metadata events | [29](29.md) | | `39089` | Starter packs | [51](51.md) | @@ -275,6 +278,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos [NKBIP-03]: https://wikistr.com/nkbip-03*fd208ee8c8f283780a9552896e4823cc9dc6bfd442063889577106940fd927c1 [blossom]: https://github.com/hzrd149/blossom [Tidal-nostr]: https://wikistr.com/tidal-nostr +[geocaching]: https://nostrhub.io/naddr1qvzqqqrcvypzppscgyy746fhmrt0nq955z6xmf80pkvrat0yq0hpknqtd00z8z68qqgkwet0vdskx6rfdenj6etkv4h8guc6gs5y5 ## Message types From 0b45265a9385b83b8b78ca4d4fc4e83513d56983 Mon Sep 17 00:00:00 2001 From: hodlbod <jstaab@protonmail.com> Date: Mon, 4 Aug 2025 15:47:20 +0000 Subject: [PATCH 463/587] Clean up nip 66 (#1986) Co-authored-by: Jon Staab <shtaab@gmail.com> --- 66.md | 225 +++++++++------------------------------------------------- 1 file changed, 35 insertions(+), 190 deletions(-) diff --git a/66.md b/66.md index 7ab3786f..191c8468 100644 --- a/66.md +++ b/66.md @@ -6,137 +6,46 @@ Relay Discovery and Liveness Monitoring `draft` `optional` -You want to find relays. You may want to discover relays based on criteria that's up to date. You may even want to ensure that you have a complete dataset. You probably want to filter relays based on their reported liveness. +This NIP defines events for relay discovery and the announcement of relay monitors. -In its purest form: +## Relay Discovery Events -```json -{ - "kind": 30166, - "created_at": 1722173222, - "content": "{}", - "tags": [ - [ "d", "wss://somerelay.abc/" ] - ], - "pubkey": "<pubkey>", - "sig": "<signature>", - "id": "<eventid>" -} -``` +`30166` relay discovery events document relay characteristics inferred either from a relay's [NIP 11](https://github.com/nostr-protocol/nips/blob/master/11.md) document, or via probing. -This event signals that the relay at `wss://somerelay.abc/` was reported "online" by `<pubkey>` at timestamp `1722173222`. This event **MAY** be extended upon to include more information. +Information corresponding to field in a relay's NIP 11 document MAY contradict actual values if monitors find that a different policy is implemented than is advertised. -## Kinds -`NIP-66` defines two (2) event kinds, `30166` and `10166` +`content` MAY include the stringified JSON of the relay's NIP-11 informational document. -| kind | name | description | -|-------|----------------------------|-----------------------------------------------------------------------------------------| -| [30166](#k30166) | Relay Discovery | An addressable event that is published by a monitor when a relay is online | -| [10166](#k10166) | Relay Monitor Announcement | An RE that stores data that signals the intent of a pubkey to monitor relays and publish `30166` events at a regular _frequency_ | +The only required tag is the `d` tag, which MUST be set to the relay's [normalized](https://datatracker.ietf.org/doc/html/rfc3986#section-6) URL. For relays not accessible via URL, a hex-encoded pubkey MAY be used instead. -## Ontology -- `Relay Operator`: someone who operates a relay -- `Monitor`: A pubkey that monitors relays and publishes `30166` events at the frequency specified in their `10166` event. -- `Ad-hoc Monitor`: A pubkey that monitors relays and publishes `30166` events at an irregular frequency. -- `Monitor Service`: A group or individual that monitors relays using one or more `Monitors`. -- `Check`: a specific data point that is tested or aggregated by a monitor. +Other tags include: -## `30166`: "Relay Discovery" <a id="k30166"></a> +- `rtt-open` - The relay's open round-trip time in milliseconds. +- `rtt-read` - The relay's read round-trip time in milliseconds. +- `rtt-write` - The relay's write round-trip time in milliseconds. +- `n` - The relay's network type. SHOULD be one of `clearnet`, `tor`, `i2p`, `loki` +- `T` - The relay type. Enumerated [relay type](https://github.com/nostr-protocol/nips/issues/1282) formatted as `PascalCase`, e.g. `PrivateInbox` +- `N` - NIPs supported by the relay +- `R` - Keys corresponding to requirements per [NIP 11](https://github.com/nostr-protocol/nips/blob/master/11.md)'s `limitations` array, including `auth`, `writes`, `pow`, and `payment`. False values should be specified using a `!` prefix, for example `!auth`. +- `t` - A topic associated with this relay +- `k` - An event kind accepted by the relay +- `!k` - An event kind not accepted by the relay +- `g` - A [NIP-52](https://github.com/nostr-protocol/nips/blob/master/52.md) geohash +- `l` - A language tag -### Summary -`30166` is a `NIP-33` addressable event, referred to as a "Relay Discovery" event. These events are optimized with a small footprint for protocol-level relay Discovery. +Tags with more than one value should be repeated, rather than putting all values in a single tag, for example `[["t", "cats"], ["t", "dogs"]]`, rather than `[["t", "cats", "dogs"]]`. -### Purpose -Discovery of relays over nostr. +Example: -### Schema - -#### Content -`30166` content fields **SHOULD** include the stringified JSON of the relay's NIP-11 informational document. This data **MAY** be provided for informational purposes only. - -#### `created_at` -The `created_at` field in a NIP-66 event should reflect the time when the relay liveness (and potentially other data points) was checked. - -#### `tags` - -##### Meta Tags (unindexed) -- `rtt-open` The relay's open **round-trip time** in milliseconds. -- `rtt-read` The relay's read **round-trip time** in milliseconds. -- `rtt-write` The relay's write **round-trip time** in milliseconds. - -_Other `rtt` values **MAY** be present. This NIP should be updated if there is value found in more `rtt` values._ - -##### Single Letter Tags (indexed) -- `d` The relay URL/URI. The `#d` tag **must** be included in the `event.tags[]` array. Index position `1` **must** be the relay websocket URL/URI. If a URL it **SHOULD** be [normalized](https://datatracker.ietf.org/doc/html/rfc3986#section-6). For relays not accessible via conventional means but rather by an npub/pubkey, an npub/pubkey **MAY** be used in place of a URL. - ```json - [ "d", "wss://somerelay.abc/"] - ``` - -- `n`: Network - ```json - [ "n", "clearnet" ] - ``` - -- `T`: Relay Type. Enumerated [relay type](https://github.com/nostr-protocol/nips/issues/1282) formatted as `PascalCase` - ```json - ["T", "PrivateInbox" ] - ``` - -- `N`: Supported Nips _From NIP-11 "Informational Document" `nip11.supported_nips[]`_ - ```json - [ "N", "42" ] - ``` - -- `R`: Requirements _NIP-11 "Informational Document" `nip11.limitations.payment_required`, `nip11.limitations.auth_required` and/or any other boolean value within `nip11.limitations[]` that is added in the future_ - ```json - [ "R", "payment" ], - [ "R", "auth" ], - ``` - Since the nostr protocol does not currently support filtering on whether an indexed tag **is** or **is not** set, to make "public" and "no auth" relays discoverable requires a `!` flag - - ```json - [ "R", "!payment" ], //no payment required, is public - [ "R", "!auth" ], //no authentication required - ``` - -- `t`: "Topics" _From NIP-11 "Informational Document" `nip11.tags[]`_ - ```json - [ "t", "nsfw" ] - ``` - -- `k`: Accepted/Blocked Kinds [`NIP-22`] - ```json - [ "k", "0" ], - [ "k", "3" ], - [ "k", "10002" ] - ``` - - or for blocked kinds - - ```json - [ "k", "!0" ] - [ "k", "!3" ], - [ "k", "!10002" ] - ``` - -- `g`: `NIP-52` `g` tags (geohash) - ```json - [ "g", "9r1652whz" ] - ``` - -- `30166` **MAY** be extended with global tags defined by other NIPs that do no collide with locally defined indices, including but not limited to: `p`, `t`, `e`, `a`, `i` and `l/L`. - -#### Robust Example of a `30166` Event -_Relay was online, and you can filter on a number of different tags_ ```json { "id": "<eventid>", "pubkey": "<monitor's pubkey>", "created_at": "<created_at [some recent date ...]>", "signature": "<signature>", - "content": "{}", + "content": "<optional nip 11 document>", "kind": 30166, - "tags": [ + "tags": [ ["d","wss://some.relay/"], ["n", "clearnet"], ["N", "40"], @@ -144,64 +53,28 @@ _Relay was online, and you can filter on a number of different tags_ ["R", "!payment"], ["R", "auth"], ["g", "ww8p1r4t8"], - ["p", "somehexkey..."], ["l", "en", "ISO-639-1"], ["t", "nsfw" ], ["rtt-open", 234 ] ] -} +} ``` -## `10166`: "Relay Monitor Announcement" Events <a id="k10166"></a> +## Relay Monitor Announcements -### Summary -`10166` is a replacable event herein referred to as "Relay Monitor Announcement" events. These events contain information about a publisher's intent to monitor and publish data as `30166` events. This event is optional and is intended for monitors who intend to provide monitoring services at a regular and predictable frequency. +Kind `10166` relay monitor announcements advertise the author's intent to publish `30166` events. This event is optional and is intended for monitors who intend to provide monitoring services at a regular and predictable frequency. -### Purpose -To provide a directory of monitors, their intent to publish, their criteria and parameters of monitoring activities. Absence of this event implies the monitor is ad-hoc and does not publish events at a predictable frequency, and relies on mechanisms to infer data integrity, such as web-of-trust. +Tags include: -### Schema +- `frequency` - The frequency in seconds at which the monitor publishes events. +- `timeout` (optional) - The timeout values for various checks conducted by a monitor. Index `1` is the monitor's timeout in milliseconds. Index `2` describes what test the timeout is used for. If no index `2` is provided, it is inferred that the timeout provided applies to all tests. +- `c` - a lowercase string describing the checks conducted by a monitor. Examples include `open`, `read`, `write`, `auth`, `nip11`, `dns`, and `geo`. +- `g` - [NIP-52](https://github.com/nostr-protocol/nips/blob/master/11.md) geohash tag -#### Standard Tags +Monitors SHOULD also publish a `kind 0` profile and a `kind 10002` relay selections event. -- `frequency` The frequency **in seconds** at which the monitor publishes events. A string-integer at index `1` represents the expected frequency the monitor will publish `30166` events. There should only be `1` frequency per monitor. +Example: - ```json - [ "frequency", "3600" ] - ``` - -- `timeout` (optional) The timeout values for various checks conducted by a monitor. Index `1` is the monitor's timeout in milliseconds. Index `2` describes what test the timeout is used for. If no index `2` is provided, it is inferred that the timeout provided applies to all tests. These values can assist relay operators in understanding data signaled by the monitor in _Relay Discovery Events_. - ```json - [ "timeout", "2000", "open" ], - [ "timeout", "2000", "read" ], - [ "timeout", "3000", "write" ], - [ "timeout", "2000", "nip11" ], - [ "timeout", "4000", "ssl" ] - ``` - -#### Indexed Tags -- `c` "Checks" **SHOULD** be a lowercase string describing the check(s) conducted by a monitor. Due to the rapidly evolving nature of relays, enumeration is organic and not strictly defined. But examples of some checks could be websocket `open/read/write/auth`, `nip11` checks, `dns` and `geo` checks, and and any other checks the monitor may deem useful.. Other checks **MAY** be included. New types of checks **SHOULD** be added to this NIP as they are needed. - ```json - [ "c", "ws" ], - [ "c", "nip11" ], - [ "c", "dns" ], - [ "c", "geo" ], - [ "c", "ssl" ], - ``` - -- `g`: `NIP-52` `g` tags (geohash) - ```json - [ "g", "9r1652whz" ] - ``` - -- Any other globally defined indexable tags **MAY** be included as found necessary. - -### Other Requirements -Monitors **SHOULD** have the following -- A published `0` (NIP-1) event -- A published `10002` (NIP-65) event that defines the relays the monitor publishes to. - -### Robust Example of a `10166` Event ```json { "id": "<eventid>", @@ -209,46 +82,18 @@ Monitors **SHOULD** have the following "created_at": "<created_at [some recent date ...]>", "signature": "<signature>", "content": "", - "tags": [ - + "tags": [ [ "timeout", "open", "5000" ], [ "timeout", "read", "3000" ], [ "timeout", "write", "3000" ], [ "timeout", "nip11", "3000" ], - [ "frequency", "3600" ], - [ "c", "ws" ], [ "c", "nip11" ], [ "c", "ssl" ], [ "c", "dns" ], [ "c", "geo" ] - [ "g", "ww8p1r4t8" ] ] -} +} ``` - -## Methodology - -### Monitors -1. A _Relay Monitor_ checks the liveness and potentially other attributes of a relay. - -2. _Relay Monitor_ publishes a kind `30166` note when a relay it is monitoring is online. If the monitor has a `10166` event, events should be published at the frequency defined in their `10166` note. - -_Any pubkey that publishes `30166` events **SHOULD** at a minimum be checking that the relay is available by websocket and behaves like a relay_ - -### Clients -1. In most cases, a client **SHOULD** filter on `30166` events using either a statically or dynamically defined monitor's `pubkey` and a `created_at` value respective of the monitor's published `frequency`. If the monitor has no stated frequency, other mechanisms should be employed to determine data integrity. - -2. _Relay Liveness_ is subjectively determined by the client, starting with the `frequency` value of a monitor. - -3. The liveness of a _Relay Monitor_ can be subjectively determined by detecting whether the _Relay Monitor_ has published events with respect to `frequency` value of any particular monitor. - -4. The reliability and trustworthiness of a _Relay Monitor_ could be established via web-of-trust, reviews or similar mechanisms. - -## Risk Mitigation - -- When a client implements `NIP-66` events, the client should have a fallback if `NIP-66` events cannot be located. - -- A `Monitor` or `Ad-hoc Monitor` may publish erroneous `30166` events, intentionally or otherwise. Therefor, it's important to program defensively to limit the impact of such events. This can be achieved with web-of-trust, reviews, fallbacks and/or data-aggregation for example. From ce130e504a4e61dd6d925ae417348a25425562c0 Mon Sep 17 00:00:00 2001 From: G!l <gil@lohner.net> Date: Mon, 4 Aug 2025 22:28:18 +0200 Subject: [PATCH 464/587] NIP-52: Add collaborative calendar event request (#1970) --- 52.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/52.md b/52.md index 898e011e..133e3b36 100644 --- a/52.md +++ b/52.md @@ -25,6 +25,7 @@ These tags are common to both types of calendar events: * `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting * `t` (optional, repeated) hashtag to categorize calendar event * `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. +* `a` (repeated) reference tag to kind `31924` calendar event requesting to be included in Calendar The following tags are deprecated: @@ -32,6 +33,12 @@ The following tags are deprecated: Calendar events are _not_ required to be part of a [calendar](#calendar). +## Collaborative Calendar Event Requests + +Calendar events can include an `a` tag referencing a calendar (kind 31924) to request addition to that calendar. When a calendar event includes such a reference, clients should interpret this as a request to add the event to the referenced calendar by referencing it with an `a` tag. + +This enables collaborative calendar management where multiple users can contribute events to calendars they do not own, subject to the calendar owner's approval. + ### Date-Based Calendar Event This kind of calendar event starts on a date and ends before a different date in the future. Its use is appropriate for all-day or multi-day events where time and time zone hold no significance. e.g., anniversary, public holidays, vacation days. @@ -125,6 +132,8 @@ Aside from the common tags, this also takes the following tags: A calendar is a collection of calendar events, represented as a custom _addressable list_ event using kind `31924`. A user can have multiple calendars. One may create a calendar to segment calendar events for specific purposes. e.g., personal, work, travel, meetups, and conferences. +Calendars can accept event requests from other users. When calendar events reference a calendar via an `a` tag, this represents a request for inclusion. + The `.content` of these events should be a detailed description of the calendar. It is required but can be an empty string. * `d` (required) universally unique identifier. Generated by the client creating the calendar. From b224b0ecb8782f381dd25c8ffd36f3b73d34069e Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Mon, 4 Aug 2025 17:31:37 -0300 Subject: [PATCH 465/587] include missing "k" tag in some reactions (#2001) --- 03.md | 4 ++-- 18.md | 3 +-- 57.md | 5 ++++- 61.md | 1 + 4 files changed, 8 insertions(+), 5 deletions(-) diff --git a/03.md b/03.md index 74e010cb..3cd40a07 100644 --- a/03.md +++ b/03.md @@ -12,8 +12,8 @@ This NIP defines an event with `kind:1040` that can contain an [OpenTimestamps]( { "kind": 1040 "tags": [ - ["e", <event-id>, <relay-url>], - ["alt", "opentimestamps attestation"] + ["e", <target-event-id>, <relay-url>], + ["k", "<target-event-kind>"] ], "content": <base64-encoded OTS file data> } diff --git a/18.md b/18.md index 5d55f84c..4bea80a0 100644 --- a/18.md +++ b/18.md @@ -40,6 +40,5 @@ Since `kind 6` reposts are reserved for `kind 1` contents, we use `kind 16` as a "generic repost", that can include any kind of event inside other than `kind 1`. -`kind 16` reposts SHOULD contain a `k` tag with the stringified kind number +`kind 16` reposts SHOULD contain a `"k"` tag with the stringified kind number of the reposted event as its value. - diff --git a/57.md b/57.md index c37126e8..474f0920 100644 --- a/57.md +++ b/57.md @@ -37,6 +37,7 @@ In addition, the event MAY include the following tags: - `e` is an optional hex-encoded event id. Clients MUST include this if zapping an event rather than a person. - `a` is an optional event coordinate that allows tipping addressable events such as NIP-23 long-form notes. +- `k` is the stringified kind of the target event. Example: @@ -49,7 +50,8 @@ Example: ["amount", "21000"], ["lnurl", "lnurl1dp68gurn8ghj7um5v93kketj9ehx2amn9uh8wetvdskkkmn0wahz7mrww4excup0dajx2mrv92x9xp"], ["p", "04c915daefee38317fa734444acee390a8269fe5810b2241e5e6dd343dfbecc9"], - ["e", "9ae37aa68f48645127299e9453eb5d908a0cbb6058ff340d528ed4d37c8994fb"] + ["e", "9ae37aa68f48645127299e9453eb5d908a0cbb6058ff340d528ed4d37c8994fb"], + ["k", "1"] ], "pubkey": "97c70a44366a6535c145b333f973ea86dfdc2d7a99da618c40c64705ad98e322", "created_at": 1679673265, @@ -151,6 +153,7 @@ Example `zap receipt`: ["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"], ["P", "97c70a44366a6535c145b333f973ea86dfdc2d7a99da618c40c64705ad98e322"], ["e", "3624762a1274dd9636e0c552b53086d70bc88c165bc4dc0f9e836a1eaf86c3b8"], + ["k", "1"], ["bolt11", "lnbc10u1p3unwfusp5t9r3yymhpfqculx78u027lxspgxcr2n2987mx2j55nnfs95nxnzqpp5jmrh92pfld78spqs78v9euf2385t83uvpwk9ldrlvf6ch7tpascqhp5zvkrmemgth3tufcvflmzjzfvjt023nazlhljz2n9hattj4f8jq8qxqyjw5qcqpjrzjqtc4fc44feggv7065fqe5m4ytjarg3repr5j9el35xhmtfexc42yczarjuqqfzqqqqqqqqlgqqqqqqgq9q9qxpqysgq079nkq507a5tw7xgttmj4u990j7wfggtrasah5gd4ywfr2pjcn29383tphp4t48gquelz9z78p4cq7ml3nrrphw5w6eckhjwmhezhnqpy6gyf0"], ["description", "{\"pubkey\":\"97c70a44366a6535c145b333f973ea86dfdc2d7a99da618c40c64705ad98e322\",\"content\":\"\",\"id\":\"d9cc14d50fcb8c27539aacf776882942c1a11ea4472f8cdec1dea82fab66279d\",\"created_at\":1674164539,\"sig\":\"77127f636577e9029276be060332ea565deaf89ff215a494ccff16ae3f757065e2bc59b2e8c113dd407917a010b3abd36c8d7ad84c0e3ab7dab3a0b0caa9835d\",\"kind\":9734,\"tags\":[[\"e\",\"3624762a1274dd9636e0c552b53086d70bc88c165bc4dc0f9e836a1eaf86c3b8\"],[\"p\",\"32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245\"],[\"relays\",\"wss://relay.damus.io\",\"wss://nostr-relay.wlvs.space\",\"wss://nostr.fmt.wiz.biz\",\"wss://relay.nostr.bg\",\"wss://nostr.oxtr.dev\",\"wss://nostr.v0l.io\",\"wss://brb.io\",\"wss://nostr.bitcoiner.social\",\"ws://monad.jb55.com:8080\",\"wss://relay.snort.social\"]]}"], ["preimage", "5d006d2cf1e73c7148e7519a4c68adc81642ce0e25a432b2434c99f97344c15f"] diff --git a/61.md b/61.md index ebb8af3e..fcfc59b2 100644 --- a/61.md +++ b/61.md @@ -53,6 +53,7 @@ Clients MUST prefix the public key they P2PK-lock with `"02"` (for nostr<>cashu [ "proof", "{\"amount\":1,\"C\":\"02277c66191736eb72fce9d975d08e3191f8f96afb73ab1eec37e4465683066d3f\",\"id\":\"000a93d6f8a1d2c4\",\"secret\":\"[\\\"P2PK\\\",{\\\"nonce\\\":\\\"b00bdd0467b0090a25bdf2d2f0d45ac4e355c482c1418350f273a04fedaaee83\\\",\\\"data\\\":\\\"02eaee8939e3565e48cc62967e2fde9d8e2a4b3ec0081f29eceff5c64ef10ac1ed\\\"}]\"}" ], [ "u", "https://stablenut.umint.cash" ], [ "e", "<nutzapped-event-id>", "<relay-hint>" ], + [ "k", "<nutzapped-kind>"], [ "p", "e9fbced3a42dcf551486650cc752ab354347dd413b307484e4fd1818ab53f991" ], // recipient of nutzap ] } From 88305252508a7bbbcc7bc1293d33dd4b814da230 Mon Sep 17 00:00:00 2001 From: Yoji Shidara <dara@shidara.net> Date: Mon, 11 Aug 2025 19:35:36 +0900 Subject: [PATCH 466/587] NIP-21: Fix markup issue by closing backtick (#2008) --- 21.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/21.md b/21.md index 5f5e5b7e..800e490d 100644 --- a/21.md +++ b/21.md @@ -21,7 +21,7 @@ The identifiers that come after are expected to be the same as those defined in ### Linking HTML pages to Nostr entities -`<link>` tags with `rel="alternate"` can be used to associate webpages to Nostr events, in cases where the same content is served via the two mediums (for example, a web server that exposes Markdown articles both as HTML pages and as `kind:30023' events served under itself as a relay or through some other relay). For example: +`<link>` tags with `rel="alternate"` can be used to associate webpages to Nostr events, in cases where the same content is served via the two mediums (for example, a web server that exposes Markdown articles both as HTML pages and as `kind:30023` events served under itself as a relay or through some other relay). For example: ``` <head> From 739f3c5263584770f098440855d9364a779e7f9d Mon Sep 17 00:00:00 2001 From: Yoji Shidara <dara@shidara.net> Date: Mon, 11 Aug 2025 19:37:53 +0900 Subject: [PATCH 467/587] NIP-24: Fix heading levels (#2009) --- 24.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/24.md b/24.md index 5904efb7..0094d58d 100644 --- a/24.md +++ b/24.md @@ -8,8 +8,7 @@ Extra metadata fields and tags This NIP keeps track of extra optional fields that can added to events which are not defined anywhere else but have become _de facto_ standards and other minor implementation possibilities that do not deserve their own NIP and do not have a place in other NIPs. -kind 0 -====== +### kind 0 These are extra fields not specified in NIP-01 that may be present in the stringified JSON of metadata events: @@ -19,24 +18,22 @@ These are extra fields not specified in NIP-01 that may be present in the string - `bot`: a boolean to clarify that the content is entirely or partially the result of automation, such as with chatbots or newsfeeds. - `birthday`: an object representing the author's birth date. The format is { "year": number, "month": number, "day": number }. Each field MAY be omitted. -### Deprecated fields +#### Deprecated fields These are fields that should be ignored or removed when found in the wild: - `displayName`: use `display_name` instead. - `username`: use `name` instead. -kind 3 -====== +### kind 3 These are extra fields not specified in NIP-02 that may be present in the stringified JSON of follow events: -### Deprecated fields +#### Deprecated fields - `{<relay-url>: {"read": <true|false>, "write": <true|false>}, ...}`: an object of relays used by a user to read/write. [NIP-65](65.md) should be used instead. -tags -==== +### tags These 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: From 7dec812f9925ade0dbbac32197f6967117c32d1a Mon Sep 17 00:00:00 2001 From: Awiteb <a@4rs.nl> Date: Tue, 12 Aug 2025 00:26:05 +0300 Subject: [PATCH 468/587] nip22: fix example type for external URL (#2011) --- 22.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/22.md b/22.md index be07e532..cf7654f0 100644 --- a/22.md +++ b/22.md @@ -143,13 +143,13 @@ A comment on a website's url looks like this: "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 root "kind": for an url + ["K", "web"], // 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"] + // the parent "kind": for an url + ["k", "web"] ] // other fields } From 01c6bc9ea7ba8e1627423dad76d27a1cd1ae61bd Mon Sep 17 00:00:00 2001 From: Yoji Shidara <dara@shidara.net> Date: Wed, 13 Aug 2025 18:06:32 +0900 Subject: [PATCH 469/587] NIP-22: Fix typo (#2012) --- 22.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/22.md b/22.md index cf7654f0..f356fa20 100644 --- a/22.md +++ b/22.md @@ -45,7 +45,7 @@ Tags `K` and `k` MUST be present to define the event kind of the root and the pa `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). +The possible values for `i` tags – and `k` tags, when related to an external 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). From 252f746010cebafb3f98720ec5e8fb2634f70b77 Mon Sep 17 00:00:00 2001 From: Yoji Shidara <dara@shidara.net> Date: Wed, 13 Aug 2025 18:07:45 +0900 Subject: [PATCH 470/587] NIP-26: Fix typos (#2013) --- 26.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/26.md b/26.md index 050041b5..645ec441 100644 --- a/26.md +++ b/26.md @@ -1,4 +1,4 @@ -> __Warning__ `unrecommended`: adds unecessary burden for little gain +> __Warning__ `unrecommended`: adds unnecessary burden for little gain NIP-26 ======= diff --git a/README.md b/README.md index fb78832e..0357b29f 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-23: Long-form Content](23.md) - [NIP-24: Extra metadata fields and tags](24.md) - [NIP-25: Reactions](25.md) -- [NIP-26: Delegated Event Signing](26.md) --- **unrecommended**: adds unecessary burden for little gain +- [NIP-26: Delegated Event Signing](26.md) --- **unrecommended**: adds unnecessary burden for little gain - [NIP-27: Text Note References](27.md) - [NIP-28: Public Chat](28.md) - [NIP-29: Relay-based Groups](29.md) From 0e911333207cb6865d43e76d746e30650c413f23 Mon Sep 17 00:00:00 2001 From: Yoji Shidara <dara@shidara.net> Date: Wed, 13 Aug 2025 21:26:30 +0900 Subject: [PATCH 471/587] Fix typos (#2014) --- 34.md | 2 +- 55.md | 2 +- 61.md | 2 +- 73.md | 4 ++-- 77.md | 2 +- 87.md | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/34.md b/34.md index 65f3388f..ab80a936 100644 --- a/34.md +++ b/34.md @@ -45,7 +45,7 @@ An optional source of truth for the state of branches and tags in a repository. "kind": 30618, "content": "", "tags": [ - ["d", "<repo-id>"], // matches the identifier in the coresponding repository announcement + ["d", "<repo-id>"], // matches the identifier in the corresponding repository announcement ["refs/<heads|tags>/<branch-or-tag-name>","<commit-id>"] ["HEAD", "ref: refs/heads/<branch-name>"] ] diff --git a/55.md b/55.md index 6d2b92a5..abc316eb 100644 --- a/55.md +++ b/55.md @@ -91,7 +91,7 @@ Signer MUST answer multiple permissions with an array of results val results = listOf( Result( package = signerPackageName, - result = eventSignture, + result = eventSignature, id = intentId ) ) diff --git a/61.md b/61.md index fcfc59b2..fd11d3e4 100644 --- a/61.md +++ b/61.md @@ -78,7 +78,7 @@ Clients should REQ for nutzaps: * Filtering with `#u` for mints they expect to receive ecash from. * this is to prevent even interacting with mints the user hasn't explicitly signaled. * Filtering with `since` of the most recent `kind:7376` event the same user has created. - * this can be used as a marker of the nutzaps 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. + * this can be used as a marker of the nutzaps that have already been swapped by the user -- clients might choose to use other kinds of markers, including internal state -- this is just a guidance of one possible approach. `{ "kinds": [9321], "#p": ["my-pubkey"], "#u": ["<mint-1>", "<mint-2>"], "since": <latest-created_at-of-kind-7376> }`. diff --git a/73.md b/73.md index d883e791..7fb9a3c3 100644 --- a/73.md +++ b/73.md @@ -6,7 +6,7 @@ External Content IDs `draft` `optional` -There 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. +There 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 associated with these ids. `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. @@ -47,7 +47,7 @@ For the webpage "https://myblog.example.com/post/2012-03-27/hello-world" the "i" - Book ISBN: `["i", "isbn:9780765382030"]` - https://isbnsearch.org/isbn/9780765382030 -Book 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. +Book ISBNs MUST be referenced _**without hyphens**_ as many book search APIs return the ISBNs without hyphens. Removing hyphens from ISBNs is trivial, whereas adding the hyphens back in is non-trivial requiring a library. ### Podcasts: diff --git a/77.md b/77.md index ffdb436a..dd5ef070 100644 --- a/77.md +++ b/77.md @@ -99,7 +99,7 @@ When finished, the client should tell the relay it can release its resources wit ### Preparation -There are two protocol participants: Client and server. The client creates an initial message and transmits it to the server, which replies with its own message in response. The client continues querying the server until it is satisifed, and then terminates the protocol. Messages in either direction have the same format. +There are two protocol participants: Client and server. The client creates an initial message and transmits it to the server, which replies with its own message in response. The client continues querying the server until it is satisfied, and then terminates the protocol. Messages in either direction have the same format. Each participant has a collection of records. A records consists of a 64-bit numeric timestamp and a 256-bit ID. Each participant starts by sorting their items according to timestamp, ascending. If two timestamps are equal then items are sorted lexically by ID, ascending by first differing byte. Items may not use the max uint64 value (`2**64 - 1`) as a timestamp since this is reserved as a special "infinity" value. diff --git a/87.md b/87.md index c6701d5a..00100386 100644 --- a/87.md +++ b/87.md @@ -41,7 +41,7 @@ There are three actors to this workflow: } ``` -The recommendation event is a parameterized-replacable event so that a user can change edit their recommendation without creating a new event. +The recommendation event is a parameterized-replaceable event so that a user can change edit their recommendation without creating a new event. The `d` tag in `kind:38000` is the `kind:38173`/`kind:38172` event identifier this event is recommending, if no event exists, the `d` tag can still be calculated from the mint's pubkey/id. The `k` tag is the kind number that corresponds to the event kind that the user is recommending, in this case `kind:38173` for fedimints and `kind:38172` for cashu mints. From 15a49873ea3618da3926232248d4b5b8e307e32d Mon Sep 17 00:00:00 2001 From: Yoji Shidara <dara@shidara.net> Date: Wed, 13 Aug 2025 22:52:51 +0900 Subject: [PATCH 472/587] NIP-38: Fix heading levels (#2015) --- 38.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/38.md b/38.md index ece5e5f7..27359f1b 100644 --- a/38.md +++ b/38.md @@ -50,11 +50,11 @@ The status MAY include an `r`, `p`, `e` or `a` tag linking to a URL, profile, no The `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. -# Client behavior +## Client behavior Clients MAY display this next to the username on posts or profiles to provide live user status information. -# Use Cases +## Use Cases * Calendar nostr apps that update your general status when you're in a meeting * Nostr Nests that update your general status with a link to the nest when you join From 645986da49e78c19d86f06bafe38f8330605235a Mon Sep 17 00:00:00 2001 From: Yoji Shidara <dara@shidara.net> Date: Tue, 19 Aug 2025 02:16:23 +0900 Subject: [PATCH 473/587] README: Fix brackets to use references correctly (#2026) --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0357b29f..d5951b17 100644 --- a/README.md +++ b/README.md @@ -175,8 +175,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `7374` | Reserved Cashu Wallet Tokens | [60](60.md) | | `7375` | Cashu Wallet Tokens | [60](60.md) | | `7376` | Cashu Wallet History | [60](60.md) | -| `7516` | Geocache log | [geocaching](geocaching) | -| `7517` | Geocache proof of find | [geocaching](geocaching) | +| `7516` | Geocache log | [geocaching][geocaching] | +| `7517` | Geocache proof of find | [geocaching][geocaching] | | `9000`-`9030` | Group Control Events | [29](29.md) | | `9041` | Zap Goal | [75](75.md) | | `9321` | Nutzap | [61](61.md) | From bc96d5f44720b25f4902c16858daced58fb04591 Mon Sep 17 00:00:00 2001 From: Yoji Shidara <dara@shidara.net> Date: Tue, 19 Aug 2025 02:16:42 +0900 Subject: [PATCH 474/587] NIP-59: Fix heading levels (#2023) --- 59.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/59.md b/59.md index ddeb83cb..9cb79f2f 100644 --- a/59.md +++ b/59.md @@ -13,7 +13,7 @@ This NIP *does not* define any messaging protocol. Applications of this NIP shou This NIP relies on [NIP-44](./44.md)'s versioned encryption algorithms. -# Overview +## Overview This protocol uses three main concepts to protect the transmission of a target event: `rumor`s, `seal`s, and `gift wrap`s. @@ -29,13 +29,13 @@ This allows the isolation of concerns across layers: - A seal identifies the author without revealing the content or the recipient. - A gift wrap can add metadata (recipient, tags, a different author) without revealing the true author. -# Protocol Description +## Protocol Description -## 1. The Rumor Event Kind +### 1. The Rumor Event Kind A `rumor` is the same thing as an unsigned event. Any event kind can be made a `rumor` by removing the signature. -## 2. The Seal Event Kind +### 2. The Seal Event Kind A `seal` is a `kind:13` event that wraps a `rumor` with the sender's regular key. The `seal` is **always** encrypted to 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 @@ -55,7 +55,7 @@ without the receiver's or the sender's private key. The only public information Tags MUST always be empty in a `kind:13`. The inner event MUST always be unsigned. -## 3. Gift Wrap Event Kind +### 3. Gift Wrap Event Kind A `gift wrap` event is a `kind:1059` event that wraps any other event. `tags` SHOULD include any information needed to route the event to its intended recipient, including the recipient's `p` tag or [NIP-13](13.md) proof of work. @@ -72,12 +72,12 @@ needed to route the event to its intended recipient, including the recipient's ` } ``` -# Encrypting Payloads +## Encrypting Payloads Encryption is done following [NIP-44](44.md) on the JSON-encoded event. Place the encryption payload in the `.content` of the wrapper event (either a `seal` or a `gift wrap`). -# Other Considerations +## Other Considerations If a `rumor` is intended for more than one party, or if the author wants to retain an encrypted copy, a single `rumor` may be wrapped and addressed for each recipient individually. @@ -97,7 +97,7 @@ To protect recipient metadata, relays SHOULD only serve `kind 1059` events inten When possible, clients should only send wrapped events to `read` relays for the recipient that implement AUTH, and refuse to serve wrapped events to non-recipients. -# An Example +## An Example Let's send a wrapped `kind 1` message between two parties asking "Are you going to the party tonight?" @@ -108,7 +108,7 @@ Let's send a wrapped `kind 1` message between two parties asking "Are you going Note that this messaging protocol should not be used in practice, this is just an example. Refer to other NIPs for concrete messaging protocols that depend on gift wraps. -## 1. Create an event +### 1. Create an event Create a `kind 1` event with the message, the receivers, and any other tags you want, signed by the author. Do not sign the event. @@ -124,7 +124,7 @@ Do not sign the event. } ``` -## 2. Seal the rumor +### 2. Seal the rumor Encrypt the JSON-encoded `rumor` with a conversation key derived using the author's private key and the recipient's public key. Place the result in the `content` field of a `kind 13` `seal` event. Sign @@ -142,7 +142,7 @@ it with the author's key. } ``` -## 3. Wrap the seal +### 3. Wrap the seal Encrypt the JSON-encoded `kind 13` event with your ephemeral, single-use random key. Place the result in the `content` field of a `kind 1059`. Add a single `p` tag containing the recipient's public key. @@ -160,13 +160,13 @@ Sign the `gift wrap` using the random key generated in the previous step. } ``` -## 4. Broadcast Selectively +### 4. Broadcast Selectively Broadcast the `kind 1059` event to the recipient's relays only. Delete all the other events. -# Code Samples +## Code Samples -## JavaScript +### JavaScript ```javascript import {bytesToHex} from "@noble/hashes/utils" From b1720f4fdc2680db845fae1870981fc29b2a99b4 Mon Sep 17 00:00:00 2001 From: Yoji Shidara <dara@shidara.net> Date: Tue, 19 Aug 2025 02:17:27 +0900 Subject: [PATCH 475/587] NIP-55: Fix heading levels (#2022) --- 55.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/55.md b/55.md index abc316eb..c828768a 100644 --- a/55.md +++ b/55.md @@ -8,7 +8,7 @@ Android Signer Application This NIP describes a method for 2-way communication between an Android signer and any Nostr client on Android. The Android signer is an Android Application and the client can be a web client or an Android application. -# Usage for Android applications +## Usage for Android applications The Android signer uses Intents (to accept/reject permissions manually) and Content Resolvers (to accept/reject permissions automatically in background if the user allowed it) to communicate between applications. @@ -38,7 +38,7 @@ fun isExternalSignerInstalled(context: Context): Boolean { } ``` -## Using Intents +### Using Intents To get the result back from the Signer Application you should use `registerForActivityResult` or `rememberLauncherForActivityResult` in Kotlin. If you are using another framework check the documentation of your framework or a third party library to get the result. @@ -107,7 +107,7 @@ Send the Intent: launcher.launch(intent) ``` -### Methods +#### Methods - **get_public_key** - params: @@ -283,7 +283,7 @@ launcher.launch(intent) val id = intent.data?.getStringExtra("id") ``` -## Using Content Resolver +### Using Content Resolver To 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. @@ -295,7 +295,7 @@ For the other types Signer Application returns the column "result" If the user chose to always reject the event, signer application will return the column "rejected" and you should not open signer application -### Methods +#### Methods - **get_public_key** - params: @@ -482,7 +482,7 @@ If the user chose to always reject the event, signer application will return the } ``` -# Usage for Web Applications +## Usage for Web Applications You should consider using [NIP-46: Nostr Connect](46.md) for a better experience for web applications. When using this approach, the web app can't call the signer in the background, so the user will see a popup for every event you try to sign. @@ -496,7 +496,7 @@ You can configure the `returnType` to be **signature** or **event**. Android intents and browser urls have limitations, so if you are using the `returnType` of **event** consider using the parameter **compressionType=gzip** that will return "Signer1" + Base64 gzip encoded event json -## Methods +### Methods - **get_public_key** - params: @@ -547,7 +547,7 @@ Android intents and browser urls have limitations, so if you are using the `retu window.href = `nostrsigner:${eventJson}?compressionType=none&returnType=signature&type=decrypt_zap_event&callbackUrl=https://example.com/?event=`; ``` -## Example +### Example ```js <!DOCTYPE html> From b3334342233f216cfb2ea1396803388daeb8f258 Mon Sep 17 00:00:00 2001 From: Yoji Shidara <dara@shidara.net> Date: Tue, 19 Aug 2025 02:18:08 +0900 Subject: [PATCH 476/587] NIP-54: Fix heading levels (#2021) --- 54.md | 26 +++++++++++--------------- 1 file changed, 11 insertions(+), 15 deletions(-) diff --git a/54.md b/54.md index 3a021501..b23e8bd9 100644 --- a/54.md +++ b/54.md @@ -10,7 +10,7 @@ This NIP defines `kind:30818` (an _addressable event_) for descriptions (or ency Articles are identified by lowercase, normalized ascii `d` tags. -### Articles +## Articles ```json { "content": "A wiki is a hypertext publication collaboratively edited and managed by its own audience.", @@ -21,12 +21,12 @@ Articles are identified by lowercase, normalized ascii `d` tags. } ``` -### `d` tag normalization rules +## `d` tag normalization rules - Any non-letter character MUST be converted to a `-`. - All letters MUST be converted to lowercase. -### Content +## Content The `content` should be Asciidoc with two extra functionalities: **wikilinks** and **nostr:...** links. @@ -39,26 +39,25 @@ Wikilinks can take these two forms: `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. -### Optional extra tags +## Optional extra tags - `title`: for when the display title should be different from the `d` tag. - `summary`: for display in lists. - `a` and `e`: for referencing the original event a wiki article was forked from. -### Merge Requests +## Merge Requests Event `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. [INSERT EVENT EXAMPLE] -### Redirects +## Redirects Event `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)). [INSERT EVENT EXAMPLE] -How to decide what article to display -------------------------------------- +## How to decide what article to display As 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: @@ -78,26 +77,23 @@ As there could be many articles for each given name, some kind of prioritization [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. -Forks ---------- +## Forks Wiki-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. -Deference ---------- +## Deference Wiki-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. This is a stronger signal of trust than a `+` reaction. This 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. -Why Asciidoc? -------------- +## Why Asciidoc? Wikitext is [garbage](nostr:nevent1qqsqt0gcggry60n72uglhuhypdlmr2dm6swjj69jex5v530gcpazlzsprpmhxue69uhhyetvv9ujumn0wdmksetjv5hxxmmdqy28wumn8ghj7un9d3shjtnyv9kh2uewd9hsygpm7rrrljungc6q0tuh5hj7ue863q73qlheu4vywtzwhx42a7j9n5ueneex) and Markdown is not powerful enough (besides being too freeform and unspecified and prone to generate incompatibilities in the future). Asciidoc 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). -# Appendix 1: Merge requests +## Appendix 1: Merge requests Users can request other users to get their entries merged into someone else's entry by creating a `kind:818` event. ```json From 212f52a90a40ec03b948d0ab905ddb19f07443f4 Mon Sep 17 00:00:00 2001 From: hodlbod <jstaab@protonmail.com> Date: Mon, 18 Aug 2025 10:32:18 -0700 Subject: [PATCH 477/587] Add kinds used by nostr epoxy (#1976) Co-authored-by: Jon Staab <shtaab@gmail.com> --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index d5951b17..a91d7575 100644 --- a/README.md +++ b/README.md @@ -204,6 +204,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10096` | File storage server list | [96](96.md) | | `10166` | Relay Monitor Announcement | [66](66.md) | | `10312` | Room Presence | [53](53.md) | +| `10377` | Proxy Announcement | [Nostr Epoxy][nostr-epoxy] | +| `11111` | Transport Method Announcement | [Nostr Epoxy][nostr-epoxy] | | `13194` | Wallet Info | [47](47.md) | | `17375` | Cashu Wallet Event | [60](60.md) | | `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | @@ -279,6 +281,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos [blossom]: https://github.com/hzrd149/blossom [Tidal-nostr]: https://wikistr.com/tidal-nostr [geocaching]: https://nostrhub.io/naddr1qvzqqqrcvypzppscgyy746fhmrt0nq955z6xmf80pkvrat0yq0hpknqtd00z8z68qqgkwet0vdskx6rfdenj6etkv4h8guc6gs5y5 +[nostr-epoxy]: https://github.com/Origami74/nostr-epoxy-reverse-proxy ## Message types From 4b14bf831f4aa018b33b19614ab4b7f96633d16c Mon Sep 17 00:00:00 2001 From: Awiteb <a@4rs.nl> Date: Mon, 18 Aug 2025 21:11:50 +0300 Subject: [PATCH 478/587] nip34: Add `HEAD` tag to the README (#2017) --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index a91d7575..2b305a95 100644 --- a/README.md +++ b/README.md @@ -354,6 +354,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `expiration` | unix timestamp (string) | -- | [40](40.md) | | `file` | full path (string) | -- | [35](35.md) | | `goal` | event id (hex) | relay URL | [75](75.md) | +| `HEAD` | `ref: refs/heads/<branch-name>` | | [34](34.md) | | `image` | image URL | dimensions in pixels | [23](23.md), [52](52.md), [58](58.md) | | `imeta` | inline metadata | -- | [92](92.md) | | `license` | License of the shared content | -- | [C0](C0.md) | From 68e5d0ada427a5d4783b8727cd2334a6b3a5e89f Mon Sep 17 00:00:00 2001 From: Yoji Shidara <dara@shidara.net> Date: Wed, 20 Aug 2025 01:11:14 +0900 Subject: [PATCH 479/587] NIP-90: Fix heading levels (#2033) --- 90.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/90.md b/90.md index 785b539c..e39ce904 100644 --- a/90.md +++ b/90.md @@ -68,7 +68,7 @@ All tags are optional. * `relays`: List of relays where Service Providers SHOULD publish responses to * `p`: Service Providers the customer is interested in. Other SPs MIGHT still choose to process the job -## Encrypted Params +### Encrypted Params If the user wants to keep the input parameters a secret, they can encrypt the `i` and `param` tags with the service provider's 'p' tag and add it to the content field. Add a tag `encrypted` as tags. Encryption for private tags will use [NIP-04 - Encrypted Direct Message encryption](04.md), using the user's private and service provider's public key for the shared secret @@ -122,7 +122,7 @@ Service providers publish job results, providing the output of the job result. T * `amount`: millisats that the Service Provider is requesting to be paid. An optional third value can be a bolt11 invoice. * `i`: The original input(s) specified in the request. -## Encrypted Output +### Encrypted Output If 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. Add a tag encrypted to mark the output content as `encrypted` @@ -180,7 +180,7 @@ Service providers can give feedback about a job back to the customer. Any 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. -# Protocol Flow +## Protocol Flow * Customer publishes a job request (e.g. `kind:5000` speech-to-text). * Service Providers MAY submit `kind:7000` job-feedback events (e.g. `payment-required`, `processing`, `error`, etc.). @@ -191,24 +191,24 @@ Job feedback (`kind:7000`) and Job Results (`kind:6000-6999`) events MAY include Customers can always either pay the included `bolt11` invoice or zap the event requesting the payment and service providers should monitor for both if they choose to include a bolt11 invoice. -## Notes about the protocol flow +### Notes about the protocol flow The flow is deliberately ambiguous, allowing vast flexibility for the interaction between customers and service providers so that service providers can model their behavior based on their own decisions/perceptions of risk. Some service providers might choose to submit a `payment-required` as the first reaction before sending a `processing` or before delivering results, some might choose to serve partial results for the job (e.g. a sample), send a `payment-required` to deliver the rest of the results, and some service providers might choose to assess likelihood of payment based on an npub's past behavior and thus serve the job results before requesting payment for the best possible UX. It's not up to this NIP to define how individual vending machines should choose to run their business. -# Cancellation +## Cancellation A job request might be canceled by publishing a `kind:5` delete request event tagging the job request event. -# Appendix 1: Job chaining +## Appendix 1: Job chaining A 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. Service Providers MAY begin processing a subsequent job the moment they see the prior job's result, but they will likely wait for a zap to be published first. This introduces a risk that Service Provider of job #1 might delay publishing the zap event in order to have an advantage. This risk is up to Service Providers to mitigate or to decide whether the service provider of job #1 tends to have good-enough results so as to not wait for an explicit zap to assume the job was accepted. This gives a higher level of flexibility to service providers (which sophisticated service providers would take anyway). -# Appendix 2: Service provider discoverability +## Appendix 2: Service provider discoverability Service Providers MAY use NIP-89 announcements to advertise their support for job kinds: ```jsonc From c222f711020db8b18a5fab8e7891ea05049956cc Mon Sep 17 00:00:00 2001 From: Yoji Shidara <dara@shidara.net> Date: Wed, 20 Aug 2025 01:11:40 +0900 Subject: [PATCH 480/587] NIP-60: Fix heading levels (#2029) --- 60.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/60.md b/60.md index 4d0c7096..786ce977 100644 --- a/60.md +++ b/60.md @@ -16,12 +16,12 @@ The purpose of this NIP is: This NIP doesn't deal with users' *receiving* money from someone else, it's just to keep state of the user's wallet. -# High-level flow +## High-level flow 1. A user has a `kind:17375` event that represents a wallet. 2. A user has `kind:7375` events that represent the unspent proofs of the wallet. -- The proofs are encrypted with the user's private key. 3. 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. -## Wallet Event +### Wallet Event ```jsonc { "kind": 17375, @@ -40,7 +40,7 @@ Tags: * `mint` - Mint(s) this wallet uses -- there MUST be one or more mint tags. * `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 for receiving [NIP-61](61.md) nutzaps. -## Token Event +### Token Event Token events are used to record unspent proofs. There can be multiple `kind:7375` events for the same mint, and multiple proofs inside each `kind:7375` event. @@ -75,7 +75,7 @@ When one or more proofs of a token are spent, the token event should be [NIP-09] The `kind:5` _delete event_ created in the [NIP-09](09.md) process MUST have a tag `["k", "7375"]` to allow easy filtering by clients interested in state transitions. -## Spending History Event +### Spending History Event Clients SHOULD publish `kind:7376` events to create a transaction history when their balance changes. ```jsonc @@ -103,17 +103,17 @@ All tags can be [NIP-44](44.md) encrypted. Clients SHOULD leave `e` tags with a Multiple `e` tags can be added, and should be encrypted, except for tags with the `redeemed` marker. -# Flow +## Flow A 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](65.md) relays. -## Fetch wallet and token list +### Fetch wallet and token list From those relays, the client should fetch wallet and token events. `"kinds": [17375, 7375], "authors": ["<my-pubkey>"]` -## Fetch proofs +### Fetch proofs -## Spending token +### Spending token If Alice spends 4 sats from this token event ```jsonc { @@ -166,7 +166,7 @@ Her client: } ``` -## Redeeming a quote (optional) +### Redeeming a quote (optional) When 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](40.md) of 2 weeks (which is around the maximum amount of time a Lightning payment may be in-flight). However, application developers SHOULD use local state when possible and only publish this event when it makes sense in the context of their application. From 38bc891e671fab9603e5129b01158bda844271df Mon Sep 17 00:00:00 2001 From: Yoji Shidara <dara@shidara.net> Date: Wed, 20 Aug 2025 01:11:47 +0900 Subject: [PATCH 481/587] NIP-89: Fix heading levels (#2032) --- 89.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/89.md b/89.md index 24aa3c57..dff4ea1d 100644 --- a/89.md +++ b/89.md @@ -47,7 +47,7 @@ Multiple `a` tags can appear on the same `kind:31989`. The second value of the tag SHOULD be a relay hint. The third value of the tag SHOULD be the platform where this recommendation might apply. -## Handler information +### Handler information ```jsonc { "kind": 31990, @@ -76,7 +76,7 @@ Multiple tags might be registered by the app, following NIP-19 nomenclature as t A tag without a second value in the array SHOULD be considered a generic handler for any NIP-19 entity that is not handled by a different tag. -# Client tag +## Client tag When 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. ```jsonc From d5bfb6e8480b9c67dca4e3de1103cfdcfdf069cd Mon Sep 17 00:00:00 2001 From: Yoji Shidara <dara@shidara.net> Date: Wed, 20 Aug 2025 01:11:55 +0900 Subject: [PATCH 482/587] NIP-72: Fix heading levels (#2031) --- 72.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/72.md b/72.md index 11172904..9471cdb0 100644 --- a/72.md +++ b/72.md @@ -8,7 +8,7 @@ Moderated Communities (Reddit Style) The 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`. -# Community Definition +## Community Definition `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. @@ -39,11 +39,11 @@ The goal of this NIP is to enable public communities. It defines the replaceable } ``` -# Posting to a community +## Posting to a community [NIP-22](NIP-22) kind 1111 events SHOULD be used for text notes posted to a community, with the `A` tag always scoped to the community definition. -## Top-level posts +### Top-level posts For top-level posts, the uppercase and lowercase NIP-22 tags should both refer to the community definition itself. @@ -63,7 +63,7 @@ For top-level posts, the uppercase and lowercase NIP-22 tags should both refer t } ``` -## Nested replies +### Nested replies For nested replies, the uppercase tags should still refer to the community definition, while the lowercase tags should refer to the parent post or reply. @@ -86,11 +86,11 @@ For nested replies, the uppercase tags should still refer to the community defin } ``` -## Backwards compatibility note +### Backwards compatibility note Previously kind 1 events were used for posts in communities, with an "a" tag pointing to the community. For backwards compatibility, clients MAY still query for kind 1 events, but SHOULD NOT use them for new posts. Instead, clients SHOULD use kind 1111 events with the `A` and `a` tags as described above. -# Moderation +## Moderation Anyone 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. @@ -127,6 +127,6 @@ Since relays are instructed to delete old versions of a replaceable event, the ` Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be approved for all `34550:*` `a` tags. -# Cross-posting +## Cross-posting Clients 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. From 0d7c5ef0f8569ee3da542f2392424b1c9f14a7d9 Mon Sep 17 00:00:00 2001 From: Yoji Shidara <dara@shidara.net> Date: Wed, 20 Aug 2025 01:12:04 +0900 Subject: [PATCH 483/587] NIP-61: Fix heading levels (#2030) --- 61.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/61.md b/61.md index fd11d3e4..5ef7f680 100644 --- a/61.md +++ b/61.md @@ -8,19 +8,19 @@ Nutzaps A Nutzap is a P2PK Cashu token in which the payment itself is the receipt. -# High-level flow +## High-level flow Alice wants to nutzap 1 sat to Bob because of an event `event-id-1` she liked. -## Alice nutzaps Bob +### Alice nutzaps Bob 1. Alice fetches event `kind:10019` from Bob to see the mints Bob trusts. 2. 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`. 3. She publishes a `kind:9321` event to the relays Bob indicated with the proofs she minted. -## Bob receives the nutzap +### Bob receives the nutzap 1. At some point, Bob's client fetches `kind:9321` events p-tagging him from his relays. 2. Bob's client swaps the token into his wallet. -# Nutzap informational event +## Nutzap informational event ```jsonc { "kind": 10019, @@ -39,7 +39,7 @@ Alice wants to nutzap 1 sat to Bob because of an event `event-id-1` she liked. * `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. * `pubkey`: Public key that MUST be used to P2PK-lock receiving nutzaps -- implementations MUST NOT use the target user's main Nostr public key. This public key corresponds to the `privkey` field encrypted in a user's [nip-60](60.md) _wallet event_. -## Nutzap event +### Nutzap event Event `kind:9321` is a nutzap event published by the sender, p-tagging the recipient. The outputs are P2PK-locked to the public key the recipient indicated in their `kind:10019` event. Clients MUST prefix the public key they P2PK-lock with `"02"` (for nostr<>cashu compatibility). @@ -66,13 +66,13 @@ Clients MUST prefix the public key they P2PK-lock with `"02"` (for nostr<>cashu * `p` is the Nostr identity public key of nutzap recipient. * `e` is the event that is being nutzapped, if any. -# Sending a nutzap +## Sending a nutzap * The sender fetches the recipient's `kind:10019`. * The sender mints/swaps ecash on one of the recipient's listed mints. * The sender P2PK-locks to the recipient's specified public key in their `kind:10019` -# Receiving nutzaps +## Receiving nutzaps Clients should REQ for nutzaps: * Filtering with `#u` for mints they expect to receive ecash from. @@ -84,7 +84,7 @@ Clients should REQ for nutzaps: Upon receiving a new nutzap, the client should swap the tokens into a wallet the user controls, either a [NIP-60](60.md) wallet, their own LN wallet or anything else. -## Updating nutzap-redemption history +### Updating nutzap-redemption history When claiming a token the client SHOULD create a `kind:7376` event and `e` tag the original nutzap 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. Multiple `kind:9321` events can be tagged in the same `kind:7376` event. @@ -106,7 +106,7 @@ Multiple `kind:9321` events can be tagged in the same `kind:7376` event. Events that redeem a nutzap SHOULD be published to the sender's [NIP-65](65.md) "read" relays. -## Verifying a Cashu Zap +### Verifying a Cashu Zap When listing or counting zaps received by any given event, observer clients SHOULD: * check that the receiving user has issued a `kind:10019` tagging the mint where the cashu has been minted. @@ -116,7 +116,7 @@ When listing or counting zaps received by any given event, observer clients SHOU All these checks can be done offline (as long as the observer has the receiver mints' keyset and their `kind:10019` event), so the process should be reasonably fast. -## Final Considerations +### Final Considerations 1. Clients SHOULD guide their users to use NUT-11 (P2PK) and NUT-12 (DLEQ proofs) compatible-mints in their `kind:10019` event to avoid receiving nutzaps anyone can spend. 2. Clients SHOULD normalize and deduplicate mint URLs as described in NIP-65. 3. A nutzap event MUST include proofs in one of the mints the recipient has listed in their `kind:10019` and published 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. From 84e0b44f93c472af022bd4dcd2d72cb8ab2ea74c Mon Sep 17 00:00:00 2001 From: Oscar Merry <MerryOscar@users.noreply.github.com> Date: Fri, 22 Aug 2025 17:44:53 +0100 Subject: [PATCH 484/587] NIP-25: Add External Content Reactions (#2020) --- 25.md | 28 +++++++++++++++++++++------- 1 file changed, 21 insertions(+), 7 deletions(-) diff --git a/25.md b/25.md index e0db86a0..7ac4fb18 100644 --- a/25.md +++ b/25.md @@ -45,25 +45,39 @@ func make_like_event(pubkey: String, privkey: String, liked: NostrEvent, hint: S } ``` -Reactions to a website +External Content Reactions --------------------- -If 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. +If the target of a reaction is not a native nostr event, the reaction MUST be a `kind 17` event and MUST include [NIP-73](73.md) external content `k` + `i` tags to properly reference the content. +_Reacting to a website:_ ```jsonc { "kind": 17, "content": "⭐", "tags": [ - ["r", "https://example.com/"] + ["k", "web"], + ["i", "https://example.com"] ], - // other fields... } ``` -URLs SHOULD be [normalized](https://datatracker.ietf.org/doc/html/rfc3986#section-6), so that reactions to the same website are not omitted from queries. -A fragment MAY be attached to the URL, to react to a section of the page. -It should be noted that a URL with a fragment is not considered to be the same URL as the original. +_Reacting to a podcast episode:_ +```jsonc +{ + "kind": 17, + "content": "+", + "tags": [ + ["k", "podcast:guid"], + ["i", "podcast:guid:917393e3-1b1e-5cef-ace4-edaa54e1f810", "https://fountain.fm/show/QRT0l2EfrKXNGDlRrmjL"], + ["k", "podcast:item:guid"], + ["i", "podcast:item:guid:PC20-229", "https://fountain.fm/episode/DQqBg5sD3qFGMCZoSuLF"] + ], +} +``` + + + Custom Emoji Reaction --------------------- From 3f4c696f24dd5cab400235813f77a098f41938e3 Mon Sep 17 00:00:00 2001 From: AsaiToshiya <to.asai.60@gmail.com> Date: Sat, 23 Aug 2025 08:20:13 +0900 Subject: [PATCH 485/587] clean up B0. (#2039) --- B0.md | 22 +++++++--------------- 1 file changed, 7 insertions(+), 15 deletions(-) diff --git a/B0.md b/B0.md index 0dcefa7b..22ed9105 100644 --- a/B0.md +++ b/B0.md @@ -6,31 +6,23 @@ Web Bookmarking `draft` `optional` -This NIP defines `kind:39701` (an _addressable event_) for a URI as a web bookmark which uses the HTTP (Hypertext transfer protocol) scheme. -These web bookmark events are _addressable_ and deletable per [NIP-09](09.md). - -### Editability - -Web bookmarks are meant to be editable, so they should include a `d` tag with an identifier for the bookmark. 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 bookmark they may receive. +This NIP defines `kind:39701` for a URI as editable web bookmark which uses the HTTP scheme. ### Format -The format uses an _addressable event_ of `kind:39701`. +The format uses `kind:39701`. -The `.content` of these events should be a detailed description of the web bookmark. It is required but can be an empty string. +The `.content` should be a detailed description of the web bookmark. It can be an empty string. -The `d` tag is required. +The `d` tag is just their URL without the scheme, which is always and everywhere assumed to be `https://` or `http://`. -In this way web bookmarks events can be queried by the `d` tag by clients, which is just their URL without the scheme, which is always and everywhere assumed to be `https://` or `http://`. - -The querystring and the hash must be removed entirely, unless their requirement is explicitly stated either by the user or by some hardcoded list of URLs that rely on querystrings for basic routing provided by the client. +In this way web bookmarks events can be queried by the `d` tag by clients. ### Metadata -For 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. - -Other metadata fields can be added as tags to the event as necessary. +Metadata fields can be added as tags to the event as necessary. +* `"t"`, for "tags"/"hashtags" (i.e. topics about which the event might be of relevance) * `"published_at"`, for the timestamp in unix seconds (stringified) of the first time the bookmark was published * `"title"`, title about bookmark and can be used as a attribute for the HTML link element From 1f4d6d1c46dd9886e939fb511788870d80b7420e Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Mon, 25 Aug 2025 12:09:44 -0400 Subject: [PATCH 486/587] NIP-51: Updates lists to NIP-44, deprecates NIP-04 (#2034) --- 51.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/51.md b/51.md index 061cff82..42ea1f4d 100644 --- a/51.md +++ b/51.md @@ -8,7 +8,7 @@ Lists This NIP defines lists of things that users can create. Lists can contain references to anything, and these references can be **public** or **private**. -Public items in a list are specified in the event `tags` array, while private items are specified in a JSON array that mimics the structure of the event `tags` array, but stringified and encrypted using the same scheme from [NIP-04](04.md) (the shared key is computed using the author's public and private key) and stored in the `.content`. +Public items in a list are specified in the event `tags` array, while private items are specified in a JSON array that mimics the structure of the event `tags` array, but stringified and encrypted using the same scheme from [NIP-44](44.md) (the shared key is computed using the author's public and private key) and stored in the `.content`. An earlier version of this specification used [NIP-04](04.md) for encryptions. Those are now deprecated. For backward compatibility, Clients can automatically discover if the encryption is NIP-04 or NIP-44 by searching for "iv" in the ciphertext and decrypting accordingly. When new items are added to an existing list, clients SHOULD append them to the end of the list, so they are stored in chronological order. @@ -165,6 +165,6 @@ val private_items = [ ["p", "07caba282f76441955b695551c3c5c742e5b9202a3784780f8086fdcdc1da3a9"], ["a", "a55c15f5e41d5aebd236eca5e0142789c5385703f1a7485aa4b38d94fd18dcc4"], ] -val base64blob = nip04.encrypt(json.encode_to_string(private_items)) +val base64blob = nip44.encrypt(json.encode_to_string(private_items)) event.content = base64blob ``` From 581452e8459e84caef8fa080eb8d7940468754fb Mon Sep 17 00:00:00 2001 From: Jeff Gardner <202880+erskingardner@users.noreply.github.com> Date: Wed, 27 Aug 2025 18:03:06 +0200 Subject: [PATCH 487/587] Add NIP-EE: E2EE messaging using MLS (#1427) --- EE.md | 288 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 1 + 2 files changed, 289 insertions(+) create mode 100644 EE.md diff --git a/EE.md b/EE.md new file mode 100644 index 00000000..976df98a --- /dev/null +++ b/EE.md @@ -0,0 +1,288 @@ +# NIP-EE + +## E2EE Messaging using the Messaging Layer Security (MLS) Protocol + +`draft` `optional` + +This NIP standardizes how to use the [MLS Protocol](https://www.rfc-editor.org/rfc/rfc9420.html) with Nostr for efficient and E2EE (end-to-end encrypted) direct and group messaging. + +## Context + +Originally, one-to-one direct messages (DMs) in Nostr happened via the scheme defined in [NIP-04](04.md). This NIP is not recommended because, while it encrypts the content of the message (provides decent confidentiality), it leaks significant amounts of metadata about the parties involved in the conversation (completely lacks privacy). + +With the addition of [NIP-44](44.md), we have an updated encryption scheme that improves confidentiality guarantees but stops short of defining a new scheme for doing direct messages using this encryption scheme. Hence, makes little to no difference to privacy. + +Most recently, [NIP-17](17.md) combines [NIP-44](44.md) encryption with [NIP-59](59.md) gift-wrapping to hide the encrypted direct message inside another set of events to ensure that it's impossible to see who is talking to who and when messages passed between the users. This largely solves the metadata leakage problem; while it's still possible to see that a user is receiving gift-wrapped events, you can't tell from whom and what kind of events are within the gift-wrap outer event. This gives some degree of deniability/repudiation but doesn't solve forward secrecy or post compromise security. That is to say, if a user's private key (or the calculated conversation key shared between two users used to encrypt messages) is compromised, the attacker will have full access to all past and future DMs sent between those users. + +In addition, neither [NIP-04](04.md) or [NIP-17](17.md) attempt to solve the problem of group messages. + +### Why is this important? + +Without proper E2EE, Nostr cannot be used as the protocol for secure messaging clients. While clients like Signal do a fantastic job with E2EE, they still rely on centralized servers and as a result can be shut down by a powerful (i.e. state-level) actor. The goal of Nostr is not only to protect against centralized entities censoring you and your communications, but also protect against the ability of a state-level actor to stop these sorts of services from existing in the first place. By replacing centralized servers with decentralized relays, we make it nearly impossible for a centralized actor to completely stop communications between individual users. + +### Goals of this NIP + +1. Private _and_ Confidential DMs and Group messages + 1. **Private** means that an observer cannot tell that Alice and Bob are talking to one another, or that Alice is part of a specific group. This necessarily requires protecting metadata. + 2. **Confidential** means that the contents of conversations can only be viewed by the intended recipients. +2. Forward secrecy and Post-compromise security + 1. **Forward secrecy** means that encrypted content in the past remains encrypted even if a key material is leaked. + 2. **Post compromise security** means that leaking key material doesn't allow an attacker to continue to read messages indefinitely into the future. +3. Scales efficiently for large groups +4. Allows for the use of multiple device/clients in a single conversation/group. + +### Why MLS? + +This scheme adapts the Message Layer Security (MLS) protocol for use with Nostr. You can think of MLS as an evolution of the Signal Protocol. However, it significantly improves the scalability of encryption operations for large group messaging significantly (linear -> log), is built to accommodate federated environments, and also allows for graceful updating of ciphersuites and versions over time. In addition, it's very flexible and agnostic about the message content that is sent. + +It's beyond the scope of this NIP to explain the MLS protocol but you can read more about it in it's [Architectural Overview](https://www.ietf.org/archive/id/draft-ietf-mls-architecture-13.html) or the [RFC](https://www.rfc-editor.org/rfc/rfc9420). MLS is on track to become an internet standard under the IETF so the protocol itself is extremely well vetted and researched. This also means there is the potential for cross network messaging interoperability in the future as MLS gains more adoption. + +## Core MLS Concepts + +From the [MLS Architectural Overview](https://www.ietf.org/archive/id/draft-ietf-mls-architecture-13.html): + +> MLS provides a way for clients to form groups within which they can communicate securely. For example, a set of users might use clients on their phones or laptops to join a group and communicate with each other. A group may be as small as two clients (e.g., for simple person to person messaging) or as large as hundreds of thousands. A client that is part of a group is a member of that group. As groups change membership and group or member properties, they advance from one epoch to another and the cryptographic state of the group evolves. +> +> The group is represented as a tree, which represents the members as the leaves of a tree. It is used to efficiently encrypt to subsets of the members. Each member has a state called a LeafNode object holding the client's identity, credentials, and capabilities. + +The MLS protocol's job is to manage and evolve the cryptographic state of a group. This includes managing the membership of a group, the cryptographic state of a group (ratchet tree, keys, and encryption/decryption/authentication of messages), and managing the evolution of the group over time. + +### Groups + +Groups are created by their first member, who then invites one or more other members. Groups evolve over time in blocks called `Epochs`. New epochs are proposed via one ore more `Proposal` messages and then committed to via a `Commit` message. + +### Clients + +The device/client pair (e.g. Primal on iOS or Coracle on web) with which a user joins the group is represented as a `LeafNode` in the tree. The terms `Client` and `Member` are interchangeable in this regard. It is not possible to share group state across multiple `Clients`. If a user joins a group from 2 separate devices, their state is separate and they will be tracked as 2 separate members of the group. + +### Messages + +There are several different types of messages sent within a group. Some of these are control messages that are used to update the group state over time. These include `Welcome`, `Proposal`, and `Commit` messages. Others are the actual messages that are sent between members in a group. These include `Application` messages. + +Messages in MLS are "framed". Meaning that they are wrapped in a data structure that includes information about the sender, the epoch, the message index within the epoch and the message content. This framing makes it possible to authenticate and decrypt messages correctly, even if they arrive out of order. + +MLS is agnostic to the "content" of the messages that are sent. This is a key feature of MLS that allows for the use of MLS for a wide variety of applications. + +MLS is also agnostic to the transport protocol that is used to send messages. Obviously for us, we'll be using websockets, Nostr events and relays. + +## The focus of this NIP + +This NIP focuses on how to use Nostr to perform the Authentication Service and Delivery Service functions required by the MLS protocol. Most clients will choose to use an MLS implementation to handle keys, ratcheting, group state management, and other aspects of the MLS protocol itself. [OpenMLS](https://github.com/openmls/openmls) is the most actively developed library that implements MLS. + +This NIP specifies the following: + +1. A standardized way that Nostr clients should [create MLS groups](#creating-groups). +2. The required format of the MLS [`Credential`](#mls-credentials) that Nostr clients should use to represent a Nostr user in a group. +3. The structure of [KeyPackage Events](#keypackage-event-and-signing-keys) published to relays that allow Nostr users to be added to a group asynchronously. +4. The structure of [Group Events](#group-events) published to relays that represent the evolution of a group's state and the contents of the messages sent in the group. + +## Security Considerations + +This is a concise overview of the security trade-offs and considerations of this NIP in various scenarios. The NIP strives to fully maintain MLS security guarantees. + +### Forward Secrecy and Post-compromise Security + +- As per the MLS spec, keys are deleted as soon as they are used to encrypt or decrypt a message. This is usually handled by the MLS implementation library itself but attention needs to be paid by clients to ensure they're not storing secrets (expecially the [exporter secret](#group-events)) for longer than absolutely necessary. +- This NIP maintains MLS forward secrecy and post-compromise security guarantees. You can read more about those in the MLS Architectural Overview section on [Forward Secrecy and Post-compromise Security](https://www.ietf.org/archive/id/draft-ietf-mls-architecture-15.html#name-forward-and-post-compromise). + +### Leakage of various keys + +- This NIP does not depend on a user's Nostr identity key for any aspect of the MLS messaging protocol. Compromise of a user's Nostr identity key does not give access to past or future messages in any MLS-based group. +- For a complete discussion of MLS key leakage, please see the Endpoint Compromise section of the [MLS Architectural Overview](https://www.ietf.org/archive/id/draft-ietf-mls-architecture-15.html#name-endpoint-compromise). + +### Metadata + +- The only group specific metadata published to relays is the Nostr group ID value. This value is used to identify the group in the `h` tag of the Group Message Event (`kind: 445`). These events are published ephemerally and this Nostr group ID value can be updated over the lifetime of the group by group admins. This is a tradeoff to ensure that group participants and group size are obfuscated but still makes it possible to efficiently fan out group messages to all participants. The content field of this event is a value encrypted in two separate ways (using NIP-44 and MLS) with MLS group state/keys. Only group members with up-to-date group state can decrypt and read these messages. +- A user's key package events can be used one or more times to be added to groups. There is a tradeoff inherent here: Reusing key packages (initial signing keys) carries some degree of risk but this risk is mitigated as long as a user rotates their signing key immediately upon joining a group. This step also improves the forward secrecy of the entire group. + +### Device Compromise + +Clients implementing this NIP should take every precaution to ensure that data is stored in a secure way on the device and is protected against unwanted access in the case that a device is compromised (e.g. encryption at rest, biometric authentication, etc.). That said, full device compromise should be viewed as a catastrophic event and any group the compromised device was a part of should be considered compromised until they can remove that member and update their group's state. Some suggestions: + +- Clients should support and encourage self-destructing messages (ensuring that full transcript history isn't available on a device forever). +- Clients should regularly suggest to group admins that inactive users be removed. +- Clients should regularly suggest (or automatically) rotate a user's signing key in each of their groups. +- Clients should encrypt group state and keys on the device using a secret value that isn't part of the group state or the user's Nostr identity key. +- Clients should use secure enclave storage where possible. + +For a full discussion of the security considerations of MLS, please see the Security Considerations section of the [MLS RFC](https://www.rfc-editor.org/rfc/rfc9420.html#name-security-considerations). + +## Creating groups + +MLS Groups are created with a random 32-byte ID value that is effectively permanent. This ID should be treated as private to the group and MUST not be published to relays in any form. + +Clients must also ensure that the ciphersuite, capabilities, and extensions they use when creating the group are compatible with those advertised by the users they'd like to invite to the group. They can check this info via the user's published KeyPackage Events. + +When creating a new group, the following MLS extensions MUST be used. + +- [`required_capabilities`](https://docs.rs/openmls/latest/openmls/extensions/struct.RequiredCapabilitiesExtension.html) +- [`ratchet_tree`](https://docs.rs/openmls/latest/openmls/extensions/struct.RatchetTreeExtension.html) +- [`nostr_group_data`](https://github.com/erskingardner/nostr-openmls/blob/master/src/nostr_group_data_extension.rs) + +And the following MLS extension is highly recommended (more [here](#keypackage-event-and-signing-keys)): +- [`last_resort`](https://docs.rs/openmls/latest/openmls/extensions/struct.LastResortExtension.html) + +Changes to an MLS group are affected by first creating one or more `Proposal` events and then committing to a set of proposals in a `Commit` event. These are MLS events, not Nostr events. However, for the group state to properly evolve the Commit events (which represent a specific set of proposals - like adding a new user to the group) must be published to relays for the other group members to see. See [Group Messages](#group-events) for more information. + +## MLS Credentials + +A `Credential` in MLS is an assertion of who the user is coupled with a signing key. When constructing `Credentials` for MLS, clients MUST use the `BasicCredential` type and set the `identity` value as the 32-byte hex-encoded public key of the user's Nostr identity key. Clients MUST not allow users to change the identity field and MUST validate that all `Proposal` messages do not attempt to change the identity field on any credential in the group. + +A `Credential` also has an associated signing key. The initial signing key for a user is included in the KeyPackage event. The signing key MUST be different from the user's Nostr identity key. This signing key SHOULD be rotated over time to provide improved post-compromise security. + +## Nostr Group Data Extension + +As mentioned above, the `nostr_group_data` extension is a required MLS extension used to associate Nostr-specific data with an MLS group in a cryptographically secure and proveable way. This extension MUST be included as a required capability when creating a new group. + +The extension stores the following data about the group: + +- `nostr_group_id`: A 32-byte ID for the group. This is a different value from the group ID used by MLS and CAN be changed over time. This value is the group ID value used in the `h` tags when sending group message events. +- `name`: The name of the group. +- `description`: A short description of the group. +- `admin_pubkeys`: An array of the hex-encoded public keys of the group admins. The MLS protocol itself does not have a concept of group admins. Clients MUST check the list of `admin_pubkeys` before making any change to the group data (anything in this extension), or before changing group membership (add/remove members), or updating any other aspect of the group itself (e.g. ciphersuite, etc.). Note, all members of the group can send `Proposal` and `Commits` messages for changes to their own credentials (e.g. updating their signing key). +- `relays`: An array of the Nostr relay URLs that the group uses to publish and receive messages. + +All of these values can be updated over time using MLS `Proposal` and `Commit` events (by group admins). + +## KeyPackage Event and Signing Keys + +Each user that wishes to be reachable via MLS-based messaging MUST first publish at least one KeyPackage event. The KeyPackage Event is used to authenticate users and create the necessary `Credential` to add members to groups in an asynchronous way. Users can publish multiple KeyPackage Events with different parameters (supporting different ciphersuites or MLS extensions, for example). KeyPackages include a signing key that is used for signing MLS messages within a group. This signing key MUST not be the same as the user's Nostr identity key. + +KeyPackage reuse SHOULD be minimized. However, in normal MLS use, KeyPackages are consumed when joining a group. In order to reduce race conditions between invites for multiple groups using the same Key Package, Nostr clients SHOULD use "Last resort" KeyPackages. This requires the inclusion of the `last_resort` extension on the KeyPackage's capabilities (same as with the Group). + +It's important that clients immediately rotate a user's signing key after joining a group via a last resort key package to improve post-compromise security. The signing key (the public key included in the KeyPackage Event) is used for signing within the group. Therefore, clients implementing this NIP MUST ensure that they retain access to the private key material of the signing key for each group they are a member of. + +In most cases, it's assumed that clients implementing this NIP will manage the creation and rotation of KeyPackage Events. + +### Example KeyPackage Event + +```json + { + "id": <id>, + "kind": 443, + "created_at": <unix timestamp in seconds>, + "pubkey": <main identity pubkey>, + "content": "", + "tags": [ + ["mls_protocol_version", "1.0"], + ["ciphersuite", <MLS CipherSuite ID value e.g. "0x0001">], + ["extensions", <An array of MLS Extension ID values e.g. "0x0001, 0x0002">], + ["client", <client name>, <handler event id>, <optional relay url>], + ["relays", <array of relay urls>], + ["-"] + ], + "sig": <signed with main identity key> +} +``` + +- The `content` hex encoded serialized `KeyPackageBundle` from MLS. +- The `mls_protocol_version` tag is required and MUST be the version number of the MLS protocol version being used. For now, this is `1.0`. +- The `ciphersuite` tag is the value of the MLS ciphersuite that this KeyPackage Event supports. [Read more about ciphersuites in MLS](https://www.rfc-editor.org/rfc/rfc9420.html#name-mls-cipher-suites). +- The `extensions` tag is an array of MLS extension IDs that this KeyPackage Event supports. [Read more about MLS extensions](https://www.rfc-editor.org/rfc/rfc9420.html#name-extensions). +- (optional) The `client` tag helps other clients manage the user experience when they receive group invites but don't have access to the signing key. +- The `relays` tag identifies each of the relays that the client will attempt to publish this KeyPackage event. This allows for deletion of KeyPackage Events at a later date. +- (optional) The `-` tag can be used to ensure that KeyPackage Events are only published by their authenticated author. Read more in [NIP-70](70.md) + +### Deleting KeyPackage Events + +Clients SHOULD delete the KeyPackage Event on all the listed relays any time they successfully process a group request event for a given KeyPackage Event. Clients MAY also create a new KeyPackage Event at the same time. + +If clients cannot process a Welcome message (e.g. because the signing key was generated on another client), clients MUST not delete the KeyPackage Event and SHOULD show a human-understandable error to the user. + +### Rotating Signing Keys + +Clients MUST regularly rotate the user's signing key in each group that they are a part of. The more often the signing key is rotated the stronger the post-compromise security. This rotation is done via `Proposal` and `Commit` events and broadcast to the group via a Group Event. [Read more about forward secrecy and post-compromise security inherent in MLS](https://www.rfc-editor.org/rfc/rfc9420.html#name-forward-secrecy-and-post-co). + +### KeyPackage Relays List Event + +A `kind: 10051` event indicates the relays that a user will publish their KeyPackage Events to. The event MUST include a list of relay tags with relay URIs. These relays SHOULD be readable by anyone the user wants to be able to contact them. + +```json +{ + "kind": 10051, + "tags": [ + ["relay", "wss://inbox.nostr.wine"], + ["relay", "wss://myrelay.nostr1.com"], + ], + "content": "", + //...other fields +} +``` + +### Welcome Event + +When a new user is added to a group via an MLS `Commit` message. The member who sends the `Commit` message to the group is responsible for sending the user being added to the group a Welcome Event. This Welcome Event is sent to the user as a [NIP-59](59.md) gift-wrapped event. The Welcome Event gives the new member the context they need to join the group and start sending messages. + +Clients creating the Welcome Event SHOULD wait until they have received acknowledgement from relays that their Group Event with the `Commit` has been received before publishing the Welcome Event. + +```json +{ + "id": <id>, + "kind": 444, + "created_at": <unix timestamp in seconds>, + "pubkey": <nostr identity pubkey of sender>, + "content": <serialized Welcome object>, + "tags": [ + ["e", <ID of the KeyPackage Event used to add the user to the group>], + ["relays", <array of relay urls>], + ], + "sig": <NOT SIGNED> +} +``` + +- The `content` field is required and is a serialized MLSMessage object containing the MLS `Welcome` object. +- The `e` tag is required and is the ID of the KeyPackage Event used to add the user to the group. +- The `relays` tag is required and is a list of relays clients should query for Group Events. + +Welcome Events are then sealed and gift-wrapped as detailed in [NIP-59](59.md) before being published. Like all events that are sealed and gift-wrapped, `kind: 444` events MUST never be signed. This ensures that if they were ever leaked they would not be publishable to relays. + +#### Large Groups + +For groups above ~150 participants, welcome messages will become larger than the maximum event size allowed by Nostr. There is currently work underway on the MLS protocol to support "light" client welcomes that don't require the full Ratchet Tree state to be sent to the new member. This section will be updated with recommendations for how to handle large groups. + +## Group Events + +Group Events are all the messages that are sent within a group. This includes all "control" events that update the shared group state over time (`Proposal`, `Commit`) and messages sent between members of the group (`Application` messages). + +Group Events are published using an ephemeral Nostr keypair to obfuscate the number and identity of group participants. Clients MUST use a new Nostr keypair for each Group Event they publish. + +```json +{ + "id": <id>, + "kind": 445, + "created_at": <unix timestamp in seconds>, + "pubkey": <ephemeral sender pubkey>, + "content": <NIP-44 encrypted serialized MLSMessage object>, + "tags": [ + ["h", <group id>] + ], + "sig": <signed with ephemeral sender key> +} +``` +- The `content` field is a [tls-style](https://www.rfc-editor.org/rfc/rfc9420.html#name-the-message-mls-media-type) serialized [`MLSMessage`](https://www.rfc-editor.org/rfc/rfc9420.html#section-6-4) object which is then encrypted according to [NIP-44](44.md). However, instead of using the sender and receivers keys the NIP-44 encryption is done using a Nostr keypair generated from the MLS [`exporter_secret`](https://www.rfc-editor.org/rfc/rfc9420.html#section-8.5) to calulate the `conversation key` value. Essentially, you use the hex-encoded `exporter_secret` value as the private key, calculate the public key, and then use those two keys to encrypt and decrypt messages. +- The `exporter_secret` value should be generated with a 32-byte length and labeled `nostr`. This `exporter_secret` value is rotated on each new epoch in the group. Clients should generate a new 32-byte value each time they process a valid `Commit` message. +- The `pubkey` is the hex-encoded public key of the ephemeral sender. +- The `h` tag is the nostr group ID value (from the Nostr Group Data Extension). + +### Application Messages + +Application messages are the messages that are sent within the group by members. These are contained within the `MLSMessage` object. The format of these messages should be unsigned Nostr events of the appropriate kind. For normal DM or group messages, clents SHOULD use `kind: 9` chat message events. If the user reacts to a message, it would be a `kind: 7` event, and so on. + +This means that once the application message has been decrypted and deserialized, clients can store those events and treat them as any other Nostr event, effectively creating a private Nostr feed of the group's activity and taking advantage of all the features of Nostr. + +These inner unsigned Nostr events MUST use the member's Nostr identity key for the `pubkey` field and clients MUST check that the identity of them member who sent the message matches the pubkey of the inner Nostr event. + +These Nostr events MUST remain **unsigned** to ensure that if they were to leak to relays they would not be published publicly. These Nostr events MUST not include any "h" tags or other tags that would identify the group that they belong to. + +### `Commit` Message race conditions + +The MLS protocol is resilient to almost all messages arriving out of order. However, the order of `Commit` messages is important for the group state to move forward from one epoch to the next correctly. Given Nostr's nature as a decentralized network, it is possible for a client to receive 2 or more `Commit` messages all attempting to update to a new epoch at the same time. + +Clients sending commit messages MUST wait until they receive acknowledgement from at least one relay that their Group Message Event with the `Commit` has been received before applying the commit to their own group state. + +If a client receives 2 or more `Commit` messages attempting to change same epoch, they MUST apply only one of the `Commit` messages they receive, determined by the following: + +1. Using the `created_at` timestamp on the kind `445` event. The `Commit` with the lowest value for `created_at` is the message to be applied. The other `Commit` message is discarded. +2. If the `created_at` timestamp is the same for two or more `Commit` messages, the `Commit` message with the lowest value for `id` field is the message to be applied. + +Clients SHOULD retain previous group state for a short period of time in order to recover from forked group state. diff --git a/README.md b/README.md index 2b305a95..bced6977 100644 --- a/README.md +++ b/README.md @@ -107,6 +107,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-B7: Blossom](B7.md) - [NIP-C0: Code Snippets](C0.md) - [NIP-C7: Chats](C7.md) +- [NIP-EE: E2EE Messaging using MLS Protocol](EE.md) ## Event Kinds | kind | description | NIP | From fe114c64733d850007f181bb029d9cc2237efe0f Mon Sep 17 00:00:00 2001 From: Jeff Gardner <202880+erskingardner@users.noreply.github.com> Date: Wed, 27 Aug 2025 22:24:50 +0200 Subject: [PATCH 488/587] Fix link to nostr_data_extension and clarify how to use exporter_secret with NIP-44 (#2043) Co-authored-by: hodlbod <jstaab@protonmail.com> --- EE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/EE.md b/EE.md index 976df98a..6b24e0d9 100644 --- a/EE.md +++ b/EE.md @@ -117,7 +117,7 @@ When creating a new group, the following MLS extensions MUST be used. - [`required_capabilities`](https://docs.rs/openmls/latest/openmls/extensions/struct.RequiredCapabilitiesExtension.html) - [`ratchet_tree`](https://docs.rs/openmls/latest/openmls/extensions/struct.RatchetTreeExtension.html) -- [`nostr_group_data`](https://github.com/erskingardner/nostr-openmls/blob/master/src/nostr_group_data_extension.rs) +- [`nostr_group_data`](https://github.com/rust-nostr/nostr/blob/master/mls/nostr-mls/src/extension.rs) And the following MLS extension is highly recommended (more [here](#keypackage-event-and-signing-keys)): - [`last_resort`](https://docs.rs/openmls/latest/openmls/extensions/struct.LastResortExtension.html) @@ -259,7 +259,7 @@ Group Events are published using an ephemeral Nostr keypair to obfuscate the num "sig": <signed with ephemeral sender key> } ``` -- The `content` field is a [tls-style](https://www.rfc-editor.org/rfc/rfc9420.html#name-the-message-mls-media-type) serialized [`MLSMessage`](https://www.rfc-editor.org/rfc/rfc9420.html#section-6-4) object which is then encrypted according to [NIP-44](44.md). However, instead of using the sender and receivers keys the NIP-44 encryption is done using a Nostr keypair generated from the MLS [`exporter_secret`](https://www.rfc-editor.org/rfc/rfc9420.html#section-8.5) to calulate the `conversation key` value. Essentially, you use the hex-encoded `exporter_secret` value as the private key, calculate the public key, and then use those two keys to encrypt and decrypt messages. +- The `content` field is a [tls-style](https://www.rfc-editor.org/rfc/rfc9420.html#name-the-message-mls-media-type) serialized [`MLSMessage`](https://www.rfc-editor.org/rfc/rfc9420.html#section-6-4) object which is then encrypted according to [NIP-44](44.md). However, instead of using the sender and receivers keys to derive a `conversation_key`, the NIP-44 encryption is done using a Nostr keypair generated from the MLS [`exporter_secret`](https://www.rfc-editor.org/rfc/rfc9420.html#section-8.5) to calculate the `conversation_key` value. Essentially, you use the hex-encoded `exporter_secret` value as the private key (used as the sender key), calculate the public key for that private key (used as the receiver key), and then proceed with the standard NIP-44 scheme to encrypt and decrypt messages. - The `exporter_secret` value should be generated with a 32-byte length and labeled `nostr`. This `exporter_secret` value is rotated on each new epoch in the group. Clients should generate a new 32-byte value each time they process a valid `Commit` message. - The `pubkey` is the hex-encoded public key of the ephemeral sender. - The `h` tag is the nostr group ID value (from the Nostr Group Data Extension). From fd9c627b36aae2b56acfb8eae80429458daa7fef Mon Sep 17 00:00:00 2001 From: AsaiToshiya <to.asai.60@gmail.com> Date: Thu, 28 Aug 2025 23:15:52 +0900 Subject: [PATCH 489/587] add NIP-EE kinds (#2044) --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index bced6977..83b4197f 100644 --- a/README.md +++ b/README.md @@ -144,6 +144,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `44` | Channel Mute User | [28](28.md) | | `62` | Request to Vanish | [62](62.md) | | `64` | Chess (PGN) | [64](64.md) | +| `443` | KeyPackage | [EE](EE.md) | +| `444` | Welcome Message | [EE](EE.md) | +| `445` | Group Event | [EE](EE.md) | | `818` | Merge Requests | [54](54.md) | | `1018` | Poll Response | [88](88.md) | | `1021` | Bid | [15](15.md) | @@ -201,6 +204,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10020` | Media follows | [51](51.md) | | `10030` | User emoji list | [51](51.md) | | `10050` | Relay list to receive DMs | [51](51.md), [17](17.md) | +| `10051` | KeyPackage Relays List | [EE](EE.md) | | `10063` | User server list | [Blossom][blossom] | | `10096` | File storage server list | [96](96.md) | | `10166` | Relay Monitor Announcement | [66](66.md) | From 8c45ff5d964d6d9bf329c72713e43c89c060de09 Mon Sep 17 00:00:00 2001 From: Alex Gleason <alex@alexgleason.me> Date: Tue, 2 Sep 2025 20:39:19 -0500 Subject: [PATCH 490/587] NIP-11: fix default_limit (#2049) --- 11.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/11.md b/11.md index 8229bd4c..bb5c5346 100644 --- a/11.md +++ b/11.md @@ -162,7 +162,7 @@ a specific niche kind or content. Normal anti-spam heuristics, for example, do n - `created_at_upper_limit`: 'created_at' upper limit -- `default_limit`: The maximum returned events if you send a filter with the limit set to 0. +- `default_limit`: The maximum returned events if you send a filter without a `limit`. ### Event Retention From 3760a6e3085b9ad7422e99c5b2045c6f3602fb2d Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Thu, 4 Sep 2025 10:50:33 -0400 Subject: [PATCH 491/587] NIP-53 Text Refinements and formatting fixes (#2052) --- 53.md | 49 +++++++++++++++++++++---------------------------- 1 file changed, 21 insertions(+), 28 deletions(-) diff --git a/53.md b/53.md index d64f3ef3..523a998b 100644 --- a/53.md +++ b/53.md @@ -6,13 +6,13 @@ Live Activities `draft` `optional` -Service providers want to offer live activities to the Nostr network in such a way that participants can easily log and query by clients. This NIP describes a general framework to advertise the involvement of pubkeys in such live activities. +This NIP introduces event kinds to advertise live spaces and the participation of pubkeys in them. -## Concepts +## Live Streaming -### Live Event +A special event with `kind:30311` "Live Streaming Event" is defined as an _addressable event_ whose tags advertise the content and participats of a live stream. -A 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. +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. For example: @@ -69,7 +69,7 @@ Event `kind:1311` is live chat's channel message. Clients MUST include the `a` t { "kind": 1311, "tags": [ - ["a", "30311:<Community event author pubkey>:<d-identifier of the community>", "<Optional relay url>", "root"], + ["a", "30311:<Community event author pubkey>:<d-identifier of the community>", "<Optional relay url>"], ], "content": "Zaps to live streams is beautiful.", // other fields... @@ -84,13 +84,9 @@ Event `kind:1311` is live chat's channel message. Clients MUST include the `a` t Hosts may choose to pin one or more live chat messages by updating the `pinned` tags in the live event kind `30311`. -## Use Cases +### Examples -Common use cases include meeting rooms/workshops, watch-together activities, or event spaces, such as [zap.stream](https://zap.stream). - -## Example - -### Live Streaming +#### Live Streaming ```json { @@ -114,7 +110,7 @@ Common use cases include meeting rooms/workshops, watch-together activities, or } ``` -### Live Streaming chat message +#### Live Streaming chat message ```json { @@ -130,18 +126,13 @@ Common use cases include meeting rooms/workshops, watch-together activities, or } ``` -## Interactive Rooms and Meetings ------ +## Meeting Spaces -`draft` `optional` +Meeting spaces contain one or more video/audio rooms where users can join and participate in the streaming. -Service providers want to offer Interactive Rooms to the Nostr network in such a way that participants can easily log and query by clients. This NIP describes a general framework to advertise rooms and their associated events. +### Meeting Space Event (kind:30312) -## Concepts - -### Interactive Room (kind:30312) - -A special event with `kind:30312` "Interactive Room" defines the configuration and properties of a virtual interactive space. Each room has a unique identifier and can host multiple events/meetings. +A special event with `kind:30312` "Space Host" defines the configuration and properties of a virtual interactive space. Each space has a unique identifier and can host multiple events/meetings. ```jsonc { @@ -162,19 +153,20 @@ A special event with `kind:30312` "Interactive Room" defines the configuration a } ``` -Room properties: +Space properties: * MUST be either open, private or closed. Closed means the room is not in operation. * MAY specify access control policy for private rooms (e.g. invite-only, payment required) * MAY persist when not in use * MUST have at least one provider with "Host" role * MAY have multiple providers with different roles + Provider roles (p tags): * Host: Full room management capabilities * Moderator: Room moderation capabilities * Speaker: Allowed to present/speak * Optional proof field for role verification -### Room Meeting (kind:30313) +### Meeting Room Events (kind:30313) A special event with kind:30313 represents a scheduled or ongoing meeting within a room. It MUST reference its parent room using the d tag. @@ -183,7 +175,7 @@ A special event with kind:30313 represents a scheduled or ongoing meeting within "kind": 30313, "tags": [ ["d", "<event-unique-identifier>"], // Required: Event identifier - ["a", "30312:<pubkey>:<room-id>", "wss://nostr.example.com"], // Required: Reference to parent room, 'd' from 30312 + ["a", "30312:<pubkey>:<room-id>", "wss://nostr.example.com"], // Required: Reference to parent space, 'd' from 30312 ["title", "<meeting-title>"], // Required: Meeting title ["summary", "<description>"], // Optional: Meeting description ["image", "<preview image url>"], // Optional: Meeting image @@ -204,14 +196,15 @@ Event properties: * MUST have a start time * MAY track participant counts * MAY include participant roles specific to the event + Event management: * Clients SHOULD update event status regularly when live * Events without updates for 1 hour MAY be considered ended * starts and ends timestamps SHOULD be updated when status changes -Examples +### Examples -Interactive Room (kind:30312) +#### Meeting Space (kind:30312) ```jsonc { @@ -233,7 +226,7 @@ Interactive Room (kind:30312) } ``` -Conference Event (kind:30313) +#### Meeting room (kind:30313) ```jsonc { @@ -254,7 +247,7 @@ Conference Event (kind:30313) "content": "" } ``` -## Room Presence +### Room Presence New `kind: 10312` provides an event which signals presence of a listener. From 7c4a2cb82978551761dc698ccebb60f2b14ed807 Mon Sep 17 00:00:00 2001 From: Riccardo Balbo <os@rblb.it> Date: Thu, 4 Sep 2025 17:12:45 +0200 Subject: [PATCH 492/587] NIP-47: mark "state" field as optional in make_invoice response for backward compatibility (#2046) --- 47.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/47.md b/47.md index 1bbbcb3a..10649496 100644 --- a/47.md +++ b/47.md @@ -335,7 +335,7 @@ Response: "result_type": "make_invoice", "result": { "type": "incoming", // "incoming" for invoices, "outgoing" for payments - "state": "pending", + "state": "pending", // optional "invoice": "string", // encoded invoice, optional "description": "string", // invoice's description, optional "description_hash": "string", // invoice's description hash, optional @@ -369,7 +369,7 @@ Response: "result_type": "lookup_invoice", "result": { "type": "incoming", // "incoming" for invoices, "outgoing" for payments - "state": "pending", // can be "pending", "settled", "expired" (for invoices) or "failed" (for payments) + "state": "pending", // can be "pending", "settled", "expired" (for invoices) or "failed" (for payments), optional "invoice": "string", // encoded invoice, optional "description": "string", // invoice's description, optional "description_hash": "string", // invoice's description hash, optional @@ -418,7 +418,7 @@ Response: "transactions": [ { "type": "incoming", // "incoming" for invoices, "outgoing" for payments - "state": "pending", // can be "pending", "settled", "expired" (for invoices) or "failed" (for payments) + "state": "pending", // can be "pending", "settled", "expired" (for invoices) or "failed" (for payments), optional "invoice": "string", // encoded invoice, optional "description": "string", // invoice's description, optional "description_hash": "string", // invoice's description hash, optional @@ -495,7 +495,7 @@ Notification: "notification_type": "payment_received", "notification": { "type": "incoming", - "state": "settled", + "state": "settled", // optional "invoice": "string", // encoded invoice "description": "string", // invoice's description, optional "description_hash": "string", // invoice's description hash, optional @@ -521,7 +521,7 @@ Notification: "notification_type": "payment_sent", "notification": { "type": "outgoing", - "state": "settled", + "state": "settled", // optional "invoice": "string", // encoded invoice "description": "string", // invoice's description, optional "description_hash": "string", // invoice's description hash, optional From d6fe55a6ad4a3625a3c05f6e581890264d780fa7 Mon Sep 17 00:00:00 2001 From: SubatomicPlanets <133254461+SubatomicPlanets@users.noreply.github.com> Date: Sat, 6 Sep 2025 14:38:46 +0200 Subject: [PATCH 493/587] Fix weird list in NIP-99 (#2053) --- 99.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/99.md b/99.md index d137641d..7c214203 100644 --- a/99.md +++ b/99.md @@ -40,7 +40,7 @@ The following tags, used for structured metadata, are standardized and SHOULD be - `"<number>"` is the amount in numeric format (but included in the tag as a string) - `"<currency>"` is the currency unit in 3-character ISO 4217 format or ISO 4217-like currency code (e.g. `"btc"`, `"eth"`). - `"<frequency>"` is optional and can be used to describe recurring payments. SHOULD be in noun format (hour, day, week, month, year, etc.) -- - `"status"` (optional), the status of the listing. SHOULD be either "active" or "sold". +- `"status"` (optional), the status of the listing. SHOULD be either "active" or "sold". #### `price` examples From 4c5d5fff99993c5334c81475ab149895af884d04 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Sat, 6 Sep 2025 08:52:22 -0400 Subject: [PATCH 494/587] Allow multi-user AUTH (#1881) Co-authored-by: Leo Wandersleb <leo@leowandersleb.de> --- 42.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/42.md b/42.md index fdc5d104..24f7f5d9 100644 --- a/42.md +++ b/42.md @@ -32,6 +32,8 @@ And, when sent by clients, the following form: ["AUTH", <signed-event-json>] ``` +Clients MAY provide signed events from multiple pubkeys in a sequence of `AUTH` messages. Relays MUST treat all pubkeys as authenticated accordingly. + `AUTH` messages sent by clients MUST be answered with an `OK` message, like any `EVENT` message. ### Canonical authentication event @@ -69,7 +71,9 @@ relay: ["AUTH", "<challenge>"] client: ["REQ", "sub_1", {"kinds": [4]}] relay: ["CLOSED", "sub_1", "auth-required: we can't serve DMs to unauthenticated users"] client: ["AUTH", {"id": "abcdef...", ...}] +client: ["AUTH", {"id": "abcde2...", ...}] relay: ["OK", "abcdef...", true, ""] +relay: ["OK", "abcde2...", true, ""] client: ["REQ", "sub_1", {"kinds": [4]}] relay: ["EVENT", "sub_1", {...}] relay: ["EVENT", "sub_1", {...}] From 3a126a51a65bcf97a335a6897574254c92334cec Mon Sep 17 00:00:00 2001 From: Yoji Shidara <dara@shidara.net> Date: Sun, 7 Sep 2025 22:04:01 +0900 Subject: [PATCH 495/587] Typos (#2054) --- 53.md | 8 ++++---- EE.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/53.md b/53.md index 523a998b..a0270e51 100644 --- a/53.md +++ b/53.md @@ -10,7 +10,7 @@ This NIP introduces event kinds to advertise live spaces and the participation o ## Live Streaming -A special event with `kind:30311` "Live Streaming Event" is defined as an _addressable event_ whose tags advertise the content and participats of a live stream. +A special event with `kind:30311` "Live Streaming Event" is defined as an _addressable event_ whose tags advertise the content and participants of a live stream. 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. @@ -63,7 +63,7 @@ This feature is important to avoid malicious event owners adding large account h ### Live Chat Message -Event `kind:1311` is live chat's channel message. Clients MUST include the `a` tag of the activity. An `e` tag denotes the direct parent message this post is replying to. +Event `kind:1311` is live chat's channel message. Clients MUST include the `a` tag of the activity. An `e` tag denotes the direct parent message this post is replying to. ```jsonc { @@ -249,9 +249,9 @@ Event management: ``` ### Room Presence -New `kind: 10312` provides an event which signals presence of a listener. +New `kind: 10312` provides an event which signals presence of a listener. -The presence event SHOULD be updated at regular intervals and clients SHOULD filter presence events older than +The presence event SHOULD be updated at regular intervals and clients SHOULD filter presence events older than a given time window. **This kind `10312` is a regular replaceable event, as such presence can only be indicated in one room at a time.** diff --git a/EE.md b/EE.md index 6b24e0d9..090fa29f 100644 --- a/EE.md +++ b/EE.md @@ -82,7 +82,7 @@ This is a concise overview of the security trade-offs and considerations of this ### Forward Secrecy and Post-compromise Security -- As per the MLS spec, keys are deleted as soon as they are used to encrypt or decrypt a message. This is usually handled by the MLS implementation library itself but attention needs to be paid by clients to ensure they're not storing secrets (expecially the [exporter secret](#group-events)) for longer than absolutely necessary. +- As per the MLS spec, keys are deleted as soon as they are used to encrypt or decrypt a message. This is usually handled by the MLS implementation library itself but attention needs to be paid by clients to ensure they're not storing secrets (especially the [exporter secret](#group-events)) for longer than absolutely necessary. - This NIP maintains MLS forward secrecy and post-compromise security guarantees. You can read more about those in the MLS Architectural Overview section on [Forward Secrecy and Post-compromise Security](https://www.ietf.org/archive/id/draft-ietf-mls-architecture-15.html#name-forward-and-post-compromise). ### Leakage of various keys From 5d81c9100e6f4e47438fc0064d5518b532e018cd Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Mon, 8 Sep 2025 14:25:05 -0400 Subject: [PATCH 496/587] Removing the idea of "Standard" Tags (#2055) --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 83b4197f..55ff26a0 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [Message Types](#message-types) - [Client to Relay](#client-to-relay) - [Relay to Client](#relay-to-client) -- [Standardized Tags](#standardized-tags) +- [Common Tags](#common-tags) - [Criteria for acceptance of NIPs](#criteria-for-acceptance-of-nips) - [Is this repository a centralizing factor?](#is-this-repository-a-centralizing-factor) - [How this repository works](#how-this-repository-works) @@ -312,7 +312,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `AUTH` | used to send authentication challenges | [42](42.md) | | `COUNT` | used to send requested event counts to clients | [45](45.md) | -## Standardized Tags +## Common Tags | name | value | other parameters | NIP | | ----------------- | ------------------------------------ | ------------------------------- | -------------------------------------------------- | From 020609ed9f84b1e37a21bf167170b72a172dedc9 Mon Sep 17 00:00:00 2001 From: AsaiToshiya <to.asai.60@gmail.com> Date: Tue, 9 Sep 2025 19:01:01 +0900 Subject: [PATCH 497/587] standard -> common --- 99.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/99.md b/99.md index 7c214203..2b6a97af 100644 --- a/99.md +++ b/99.md @@ -48,7 +48,7 @@ The following tags, used for structured metadata, are standardized and SHOULD be - €15 per month `["price", "15", "EUR", "month"]` - £50,000 per year `["price", "50000", "GBP", "year"]` -Other standard tags that might be useful. +Other common tags that might be useful. - `"g"`, a geohash for more precise location From c3f92ca5775ab5046e826a681a41c9e2bac96655 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Tue, 9 Sep 2025 18:24:13 -0400 Subject: [PATCH 498/587] Deprecates NIP-96 (#2047) --- 96.md | 2 ++ README.md | 4 ++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/96.md b/96.md index 3828e76c..28bc8a89 100644 --- a/96.md +++ b/96.md @@ -1,3 +1,5 @@ +> __Warning__ `unrecommended`: deprecated in favor of [NIP-B7](B7.md) + NIP-96 ====== diff --git a/README.md b/README.md index 55ff26a0..3004ef83 100644 --- a/README.md +++ b/README.md @@ -99,7 +99,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-90: Data Vending Machines](90.md) - [NIP-92: Media Attachments](92.md) - [NIP-94: File Metadata](94.md) -- [NIP-96: HTTP File Storage Integration](96.md) +- [NIP-96: HTTP File Storage Integration](96.md) --- **unrecommended**: replaced by blossom APIs - [NIP-98: HTTP Auth](98.md) - [NIP-99: Classified Listings](99.md) - [NIP-A0: Voice Messages](A0.md) @@ -206,7 +206,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10050` | Relay list to receive DMs | [51](51.md), [17](17.md) | | `10051` | KeyPackage Relays List | [EE](EE.md) | | `10063` | User server list | [Blossom][blossom] | -| `10096` | File storage server list | [96](96.md) | +| `10096` | File storage server list | [96](96.md) (deprecated) | | `10166` | Relay Monitor Announcement | [66](66.md) | | `10312` | Room Presence | [53](53.md) | | `10377` | Proxy Announcement | [Nostr Epoxy][nostr-epoxy] | From 8b541fe8cd79d58d65e26b63cdb832ecbc29ae7d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=CE=9EDKAZ=E2=9A=A1?= <unesrouabeh@gmail.com> Date: Wed, 10 Sep 2025 18:32:39 +0800 Subject: [PATCH 499/587] Curation sets (kind-30005) should be regular event `e` tag and not `a`. (#2059) --- 51.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/51.md b/51.md index 42ea1f4d..a7a16288 100644 --- a/51.md +++ b/51.md @@ -54,7 +54,7 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti | Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during various operations | `"relay"` (relay URLs) | | 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) | | 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) | -| Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"a"` (kind:21 videos) | +| Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"e"` (kind:21 videos) | | Kind mute sets | 30007 | mute pubkeys by kinds<br>`"d"` tag MUST be the kind string | `"p"` (pubkeys) | | Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) | | Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | From e35a1bebbc7a5e10970d2dbc9d07a88ee876bfbf Mon Sep 17 00:00:00 2001 From: Rosano <1680612+rosano@users.noreply.github.com> Date: Wed, 10 Sep 2025 20:48:05 +0100 Subject: [PATCH 500/587] Quote values (#2057) Co-authored-by: Vitor Pamplona <vitor@vitorpamplona.com> --- 71.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/71.md b/71.md index d3b09253..4f07d488 100644 --- a/71.md +++ b/71.md @@ -85,15 +85,15 @@ Additionally `service nip96` may be included to allow clients to search the auth ```jsonc { - "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, - "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", + "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", "created_at": <Unix timestamp in seconds>, "kind": 21 | 22, "content": "<summary / description of video>", "tags": [ ["title", "<title of video>"], ["published_at", "<unix timestamp>"], - ["alt", <description>], + ["alt", "<description>"], // video Data ["imeta", @@ -108,7 +108,7 @@ Additionally `service nip96` may be included to allow clients to search the auth "service nip96", ], - ["duration", <duration of video in seconds>], + ["duration", "<duration of video in seconds>"], ["text-track", "<encoded `kind 6000` event>", "<recommended relay urls>"], ["content-warning", "<reason>"], ["segment", <start>, <end>, "<title>", "<thumbnail URL>"], From 400d975da36955a11c22f682cbcd3776ecb09867 Mon Sep 17 00:00:00 2001 From: Roland <33993199+rolznz@users.noreply.github.com> Date: Mon, 15 Sep 2025 23:42:07 +0700 Subject: [PATCH 501/587] feat: add metadata to NIP-47 make_invoice and payment commands (#2063) --- 47.md | 38 ++++++++++++++++++++++++++++++++++++-- 1 file changed, 36 insertions(+), 2 deletions(-) diff --git a/47.md b/47.md index 10649496..ac85019f 100644 --- a/47.md +++ b/47.md @@ -188,6 +188,7 @@ Request: "params": { "invoice": "lnbc50n1...", // bolt11 invoice "amount": 123, // invoice amount in msats, optional + "metadata": {} // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc, optional } } ``` @@ -217,7 +218,7 @@ Request: "params": { "invoices": [ {"id":"4da52c32a1", "invoice": "lnbc1...", "amount": 123}, // bolt11 invoice and amount in msats, amount is optional - {"id":"3da52c32a1", "invoice": "lnbc50n1..."}, + {"id":"3da52c32a1", "invoice": "lnbc50n1...", "metadata": {} }, // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc, optional ], } } @@ -324,7 +325,8 @@ Request: "amount": 123, // value in msats "description": "string", // invoice's description, optional "description_hash": "string", // invoice's description hash, optional - "expiry": 213 // expiry in seconds from time invoice is created, optional + "expiry": 213, // expiry in seconds from time invoice is created, optional + "metadata": {} // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc, optional } } ``` @@ -612,6 +614,38 @@ The **client** should check the `encryption` tag in the `info` event to determin ## Using a dedicated relay This NIP does not specify any requirements on the type of relays used. However, if the user is using a custodial service it might make sense to use a relay that is hosted by the custodial service. The relay may then enforce authentication to prevent metadata leaks. Not depending on a 3rd party relay would also improve reliability in this case. +## Metadata +Metadata MAY be stored by the **wallet service** alongside invoices and payments. The metadata MUST be no more than 4096 characters, otherwise MUST be dropped. This is to ensure transactions do not get too large to be relayed. + +NWC relays SHOULD allow at least a payload size of 64KB and **clients** SHOULD fetch small page sizes (maximum of 20 transactions per page) otherwise there is risk of `list_transactions` responses being rejected. + +Here are some properties that are recognized by some NWC clients: + +```jsonc +{ + "comment": "string", // LUD-12 comment + "payer_data": { + "email": "string", + "name": "string", + "pubkey": "string", + }, // LUD-18 payer data + "recipient_data": { + "identifier": "string" + }, // similar to LUD-18 payer data, but to record recipient data e.g. the lightning address of the recipient + "nostr": { + "pubkey": "string", + "tags": [], + // ... + }, // NIP-57 (Nostr Zaps) + "tlv_records": [ // tlv records, optional + { + "type": 5482373484, // tlv type + "value": "0123456789abcdef" // hex encoded tlv value + } + ] // keysend TLV records (e.g. for podcasting 2.0 boostagrams) +} & Record<string, unknown>; +``` + ## Appendix ### Example NIP-47 info event From 7dfb3b35d813fe9741706ad86d9a454f959b1ac8 Mon Sep 17 00:00:00 2001 From: Roland <33993199+rolznz@users.noreply.github.com> Date: Wed, 17 Sep 2025 19:07:11 +0700 Subject: [PATCH 502/587] docs: clarify NIP-47 zap request metadata (#2064) --- 47.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/47.md b/47.md index ac85019f..e1df915c 100644 --- a/47.md +++ b/47.md @@ -635,9 +635,9 @@ Here are some properties that are recognized by some NWC clients: "nostr": { "pubkey": "string", "tags": [], - // ... - }, // NIP-57 (Nostr Zaps) - "tlv_records": [ // tlv records, optional + // ... rest of zap request event + }, // NIP-57 Zap Request event (kind 9734) + "tlv_records": [ { "type": 5482373484, // tlv type "value": "0123456789abcdef" // hex encoded tlv value From 4b19bf2e40dd9b644279e45d5bdfc3ee2e079e34 Mon Sep 17 00:00:00 2001 From: AsaiToshiya <to.asai.60@gmail.com> Date: Thu, 18 Sep 2025 12:30:58 +0900 Subject: [PATCH 503/587] delete BREAKING.md (#2058) --- BREAKING.md | 68 ----------------------------------------------------- README.md | 5 ---- 2 files changed, 73 deletions(-) delete mode 100644 BREAKING.md diff --git a/BREAKING.md b/BREAKING.md deleted file mode 100644 index c620a3f3..00000000 --- a/BREAKING.md +++ /dev/null @@ -1,68 +0,0 @@ -# Breaking Changes - -This is a history of NIP changes that potentially break pre-existing implementations, in -reverse chronological order. - -| Date | Commit | NIP | Change | -| ----------- | --------- | -------- | ------ | -| 2025-02-14 | [81908b6e](https://github.com/nostr-protocol/nips/commit/81908b6e) | [07](07.md), [46](46.md), [55](55.md) | `getRelays` and `get_relays` were removed | -| 2025-02-07 | [0023ca81](https://github.com/nostr-protocol/nips/commit/0023ca81) | [10](10.md) | `"mention"` marker was removed | -| 2025-01-31 | [6a4b125a](https://github.com/nostr-protocol/nips/commit/6a4b125a) | [71](71.md) | video events were changed to regular | -| 2024-12-05 | [6d16019e](https://github.com/nostr-protocol/nips/commit/6d16019e) | [46](46.md) | message encryption was changed to NIP-44 | -| 2024-11-12 | [2838e3bd](https://github.com/nostr-protocol/nips/commit/2838e3bd) | [29](29.md) | `kind: 12` and `kind: 10` were removed (use `kind: 1111` instead) | -| 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [46](46.md) | NIP-05 login was removed | -| 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [46](46.md) | `create_account` method was removed | -| 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [46](46.md) | `connect` params and result were changed | -| 2024-10-29 | [f1e8d2c4](https://github.com/nostr-protocol/nips/commit/f1e8d2c4) | [46](46.md) | bunker URL should use `remote-signer-key` | -| 2024-10-15 | [1cda2dcc](https://github.com/nostr-protocol/nips/commit/1cda2dcc) | [71](71.md) | some tags were replaced with `imeta` tag | -| 2024-10-15 | [1cda2dcc](https://github.com/nostr-protocol/nips/commit/1cda2dcc) | [71](71.md) | `kind: 34237` was dropped | -| 2024-10-07 | [7bb8997b](https://github.com/nostr-protocol/nips/commit/7bb8997b) | [55](55.md) | some fields and passing data were changed | -| 2024-08-18 | [3aff37bd](https://github.com/nostr-protocol/nips/commit/3aff37bd) | [54](54.md) | content should be Asciidoc | -| 2024-07-31 | [3ea2f1a4](https://github.com/nostr-protocol/nips/commit/3ea2f1a4) | [45](45.md) | [444ad28d](https://github.com/nostr-protocol/nips/commit/444ad28d) was reverted | -| 2024-07-30 | [444ad28d](https://github.com/nostr-protocol/nips/commit/444ad28d) | [45](45.md) | NIP-45 was deprecated | -| 2024-07-26 | [ecee40df](https://github.com/nostr-protocol/nips/commit/ecee40df) | [19](19.md) | `nrelay` was deprecated | -| 2024-07-23 | [0227a2cd](https://github.com/nostr-protocol/nips/commit/0227a2cd) | [01](01.md) | events should be sorted by id after created_at | -| 2024-06-06 | [58e94b20](https://github.com/nostr-protocol/nips/commit/58e94b20) | [25](25.md) | [8073c848](https://github.com/nostr-protocol/nips/commit/8073c848) was reverted | -| 2024-06-06 | [a6dfc7b5](https://github.com/nostr-protocol/nips/commit/a6dfc7b5) | [55](55.md) | NIP number was changed | -| 2024-05-25 | [5d1d1c17](https://github.com/nostr-protocol/nips/commit/5d1d1c17) | [71](71.md) | `aes-256-gcm` tag was removed | -| 2024-05-07 | [8073c848](https://github.com/nostr-protocol/nips/commit/8073c848) | [25](25.md) | e-tags were changed to not include entire thread | -| 2024-04-30 | [bad88262](https://github.com/nostr-protocol/nips/commit/bad88262) | [34](34.md) | `earliest-unique-commit` tag was removed (use `r` tag instead) | -| 2024-02-25 | [4a171cb0](https://github.com/nostr-protocol/nips/commit/4a171cb0) | [18](18.md) | quote repost should use `q` tag | -| 2024-02-21 | [c6cd655c](https://github.com/nostr-protocol/nips/commit/c6cd655c) | [46](46.md) | Params were stringified | -| 2024-02-16 | [cbec02ab](https://github.com/nostr-protocol/nips/commit/cbec02ab) | [49](49.md) | Password first normalized to NFKC | -| 2024-02-15 | [afbb8dd0](https://github.com/nostr-protocol/nips/commit/afbb8dd0) | [39](39.md) | PGP identity was removed | -| 2024-02-07 | [d3dad114](https://github.com/nostr-protocol/nips/commit/d3dad114) | [46](46.md) | Connection token format was changed | -| 2024-01-30 | [1a2b21b6](https://github.com/nostr-protocol/nips/commit/1a2b21b6) | [59](59.md) | `p` tag became optional | -| 2023-01-27 | [c2f34817](https://github.com/nostr-protocol/nips/commit/c2f34817) | [47](47.md) | optional expiration tag should be honored | -| 2024-01-10 | [3d8652ea](https://github.com/nostr-protocol/nips/commit/3d8652ea) | [02](02.md), [51](51.md) | list entries should be chronological | -| 2023-12-30 | [29869821](https://github.com/nostr-protocol/nips/commit/29869821) | [52](52.md) | `name` tag was removed (use `title` tag instead) | -| 2023-12-27 | [17c67ef5](https://github.com/nostr-protocol/nips/commit/17c67ef5) | [94](94.md) | `aes-256-gcm` tag was removed | -| 2023-12-03 | [0ba45895](https://github.com/nostr-protocol/nips/commit/0ba45895) | [01](01.md) | WebSocket status code `4000` was replaced by `CLOSED` message | -| 2023-11-28 | [6de35f9e](https://github.com/nostr-protocol/nips/commit/6de35f9e) | [89](89.md) | `client` tag value was changed | -| 2023-11-20 | [7822a8b1](https://github.com/nostr-protocol/nips/commit/7822a8b1) | [51](51.md) | `kind: 30001` was deprecated | -| 2023-11-20 | [7822a8b1](https://github.com/nostr-protocol/nips/commit/7822a8b1) | [51](51.md) | the meaning of `kind: 30000` was changed | -| 2023-11-11 | [cbdca1e9](https://github.com/nostr-protocol/nips/commit/cbdca1e9) | [84](84.md) | `range` tag was removed | -| 2023-11-10 | [c945d8bd](https://github.com/nostr-protocol/nips/commit/c945d8bd) | [32](32.md) | `l` tag annotations was removed | -| 2023-11-07 | [108b7f16](https://github.com/nostr-protocol/nips/commit/108b7f16) | [01](01.md) | `OK` message must have 4 items | -| 2023-10-17 | [cf672b76](https://github.com/nostr-protocol/nips/commit/cf672b76) | [03](03.md) | `block` tag was removed | -| 2023-09-29 | [7dc6385f](https://github.com/nostr-protocol/nips/commit/7dc6385f) | [57](57.md) | optional `a` tag was included in `zap receipt` | -| 2023-08-21 | [89915e02](https://github.com/nostr-protocol/nips/commit/89915e02) | [11](11.md) | `min_prefix` was removed | -| 2023-08-20 | [37c4375e](https://github.com/nostr-protocol/nips/commit/37c4375e) | [01](01.md) | replaceable events with same timestamp should be retained event with lowest id | -| 2023-08-15 | [88ee873c](https://github.com/nostr-protocol/nips/commit/88ee873c) | [15](15.md) | `countries` tag was renamed to `regions` | -| 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [12](12.md), [16](16.md), [20](20.md), [33](33.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | -| 2023-08-11 | [d87f8617](https://github.com/nostr-protocol/nips/commit/d87f8617) | [25](25.md) | empty `content` should be considered as "+" | -| 2023-08-01 | [5d63b157](https://github.com/nostr-protocol/nips/commit/5d63b157) | [57](57.md) | `zap` tag was changed | -| 2023-07-15 | [d1814405](https://github.com/nostr-protocol/nips/commit/d1814405) | [01](01.md) | `since` and `until` filters should be `since <= created_at <= until` | -| 2023-07-12 | [a1cd2bd8](https://github.com/nostr-protocol/nips/commit/a1cd2bd8) | [25](25.md) | custom emoji was supported | -| 2023-06-18 | [83cbd3e1](https://github.com/nostr-protocol/nips/commit/83cbd3e1) | [11](11.md) | `image` was renamed to `icon` | -| 2023-04-13 | [bf0a0da6](https://github.com/nostr-protocol/nips/commit/bf0a0da6) | [15](15.md) | different NIP was re-added as NIP-15 | -| 2023-04-09 | [fb5b7c73](https://github.com/nostr-protocol/nips/commit/fb5b7c73) | [15](15.md) | NIP-15 was merged into NIP-01 | -| 2023-03-29 | [599e1313](https://github.com/nostr-protocol/nips/commit/599e1313) | [18](18.md) | NIP-18 was bring back | -| 2023-03-15 | [e1004d3d](https://github.com/nostr-protocol/nips/commit/e1004d3d) | [19](19.md) | `1: relay` was changed to optionally | - -Breaking changes prior to 2023-03-01 are not yet documented. - -## NOTES - -- If it isn't clear that a change is breaking or not, we list it. -- The date is the date it was merged, not necessarily the date of the commit. diff --git a/README.md b/README.md index 3004ef83..f5194ded 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [Criteria for acceptance of NIPs](#criteria-for-acceptance-of-nips) - [Is this repository a centralizing factor?](#is-this-repository-a-centralizing-factor) - [How this repository works](#how-this-repository-works) -- [Breaking Changes](#breaking-changes) - [License](#license) --- @@ -408,10 +407,6 @@ Standards may emerge in two ways: the first way is that someone starts doing som These two ways of standardizing things are supported by this repository. Although the second is preferred, an effort will be made to codify standards emerged outside this repository into NIPs that can be later referenced and easily understood and implemented by others -- but obviously as in any human system discretion may be applied when standards are considered harmful. -## Breaking Changes - -[Breaking Changes](BREAKING.md) - ## License All NIPs are public domain. From abe6fb959c4517c30ac1476e113d8f64eab0a8ff Mon Sep 17 00:00:00 2001 From: hodlbod <jstaab@protonmail.com> Date: Thu, 18 Sep 2025 17:09:53 -0700 Subject: [PATCH 504/587] Remove lud06 field (#2065) Co-authored-by: Jon Staab <shtaab@gmail.com> --- 57.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/57.md b/57.md index 474f0920..91eac306 100644 --- a/57.md +++ b/57.md @@ -12,7 +12,7 @@ Having lightning receipts on nostr allows clients to display lightning payments ## Protocol flow -1. Client calculates a recipient's lnurl pay request url from the `zap` tag on the event being zapped (see Appendix G), or by decoding their lud06 or lud16 field on their profile according to the [lnurl specifications](https://github.com/lnurl/luds). The client MUST send a GET request to this url and parse the response. If `allowsNostr` exists and it is `true`, and if `nostrPubkey` exists and is a valid BIP 340 public key in hex, the client should associate this information with the user, along with the response's `callback`, `minSendable`, and `maxSendable` values. +1. Client calculates a recipient's lnurl pay request url from the `zap` tag on the event being zapped (see Appendix G), or by decoding their lud16 field on their profile according to the [lnurl specifications](https://github.com/lnurl/luds). The client MUST send a GET request to this url and parse the response. If `allowsNostr` exists and it is `true`, and if `nostrPubkey` exists and is a valid BIP 340 public key in hex, the client should associate this information with the user, along with the response's `callback`, `minSendable`, and `maxSendable` values. 2. Clients may choose to display a lightning zap button on each post or on a user's profile. If the user's lnurl pay request endpoint supports nostr, the client SHOULD use this NIP to request a `zap receipt` rather than a normal lnurl invoice. 3. When a user (the "sender") indicates they want to send a zap to another user (the "recipient"), the client should create a `zap request` event as described in Appendix A of this NIP and sign it. 4. Instead of publishing the `zap request`, the `9734` event should instead be sent to the `callback` url received from the lnurl pay endpoint for the recipient using a GET request. See Appendix B for details and an example. From 90fcf4a44e659af0f79a6bfec5b5f018fe0bd4ff Mon Sep 17 00:00:00 2001 From: Yoji Shidara <dara@shidara.net> Date: Fri, 19 Sep 2025 20:55:42 +0900 Subject: [PATCH 505/587] NIP-11: add comma and remove empty lines (#2066) --- 11.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/11.md b/11.md index bb5c5346..5c3b9dab 100644 --- a/11.md +++ b/11.md @@ -20,11 +20,9 @@ When a relay receives an HTTP(s) request with an `Accept` header of `application "contact": <administrative alternate contact>, "supported_nips": <a list of NIP numbers supported by the relay>, "software": <string identifying relay software URL>, - "version": <string version identifier> + "version": <string version identifier>, "privacy_policy": <a link to a text file describing the relay's privacy policy>, "terms_of_service": <a link to a text file describing the relay's term of service>, - - } ``` From b516adbf423a120045e07adf5358ae69f190f3c8 Mon Sep 17 00:00:00 2001 From: Sandwich <299465+dskvr@users.noreply.github.com> Date: Sat, 20 Sep 2025 12:39:40 +0200 Subject: [PATCH 506/587] Fix fundamentally incorrect assertions in NIP-66 (#2067) --- 66.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/66.md b/66.md index 191c8468..2e19916e 100644 --- a/66.md +++ b/66.md @@ -28,10 +28,8 @@ Other tags include: - `N` - NIPs supported by the relay - `R` - Keys corresponding to requirements per [NIP 11](https://github.com/nostr-protocol/nips/blob/master/11.md)'s `limitations` array, including `auth`, `writes`, `pow`, and `payment`. False values should be specified using a `!` prefix, for example `!auth`. - `t` - A topic associated with this relay -- `k` - An event kind accepted by the relay -- `!k` - An event kind not accepted by the relay +- `k` - Accepted and unaccepted kinds (false values prepended by `!`) - `g` - A [NIP-52](https://github.com/nostr-protocol/nips/blob/master/52.md) geohash -- `l` - A language tag Tags with more than one value should be repeated, rather than putting all values in a single tag, for example `[["t", "cats"], ["t", "dogs"]]`, rather than `[["t", "cats", "dogs"]]`. From 2ace01cf1ad0a68dae6217111c9286e3de759923 Mon Sep 17 00:00:00 2001 From: Pablo Fernandez <pfer@me.com> Date: Wed, 8 Oct 2025 14:34:47 +0300 Subject: [PATCH 507/587] NWC Deep Links (#1777) --- 47.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/47.md b/47.md index e1df915c..13037cb5 100644 --- a/47.md +++ b/47.md @@ -667,3 +667,21 @@ Here are some properties that are recognized by some NWC clients: "sig": "31f57b369459b5306a5353aa9e03be7fbde169bc881c3233625605dd12f53548179def16b9fe1137e6465d7e4d5bb27ce81fd6e75908c46b06269f4233c845d8" } ``` + +### Deep-links + +Wallet applications can register deeplinks in mobile systems to make it possible to create a linking UX that doesn't require the user scanning a QR code or pasting some code. + +`nostrnwc://connect` and `nostrnwc+{app_name}://connect` can be registered by wallet apps and queried by apps that want to receive an NWC pairing code. + +All URI parameters, MUST be URI-encoded. + +URI parameters: + * `appicon` -- URL to an icon of the client that wants to create a connection. + * `appname` -- Name of the client that wants to create a connection. + * `callback` -- URI schema the wallet should open with the connection string + +Once a connection has been created by the wallet, it should be returned to the client by opening the callback with the following parameters + * `value` -- NWC pairing code (e.g. `nostr+walletconnect://...`) + + From 74681c3c1448b4d2d685512f61026987bd175876 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Wed, 8 Oct 2025 18:43:37 -0400 Subject: [PATCH 508/587] NIP-45 is not a subscription. Changing to query id to reduce confusion. (#2083) --- 45.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/45.md b/45.md index 219368e4..8758c873 100644 --- a/45.md +++ b/45.md @@ -14,17 +14,17 @@ Some queries a client may want to execute against connected relays are prohibiti ## Filters and return values -This 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. +This NIP defines the verb `COUNT`, which accepts a query 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. ``` -["COUNT", <subscription_id>, <filters JSON>...] +["COUNT", <query_id>, <filters JSON>...] ``` Counts are returned using a `COUNT` response in the form `{"count": <integer>}`. Relays may use probabilistic counts to reduce compute requirements. In case a relay uses probabilistic counts, it MAY indicate it in the response with `approximate` key i.e. `{"count": <integer>, "approximate": <true|false>}`. ``` -["COUNT", <subscription_id>, {"count": <integer>}] +["COUNT", <query_id>, {"count": <integer>}] ``` Whenever the relay decides to refuse to fulfill the `COUNT` request, it MUST return a `CLOSED` message. @@ -34,27 +34,27 @@ Whenever the relay decides to refuse to fulfill the `COUNT` request, it MUST ret ### Followers count ``` -["COUNT", <subscription_id>, {"kinds": [3], "#p": [<pubkey>]}] -["COUNT", <subscription_id>, {"count": 238}] +["COUNT", <query_id>, {"kinds": [3], "#p": [<pubkey>]}] +["COUNT", <query_id>, {"count": 238}] ``` ### Count posts and reactions ``` -["COUNT", <subscription_id>, {"kinds": [1, 7], "authors": [<pubkey>]}] -["COUNT", <subscription_id>, {"count": 5}] +["COUNT", <query_id>, {"kinds": [1, 7], "authors": [<pubkey>]}] +["COUNT", <query_id>, {"count": 5}] ``` ### Count posts approximately ``` -["COUNT", <subscription_id>, {"kinds": [1]}] -["COUNT", <subscription_id>, {"count": 93412452, "approximate": true}] +["COUNT", <query_id>, {"kinds": [1]}] +["COUNT", <query_id>, {"count": 93412452, "approximate": true}] ``` ### Relay refuses to count ``` -["COUNT", <subscription_id>, {"kinds": [4], "authors": [<pubkey>], "#p": [<pubkey>]}] -["CLOSED", <subscription_id>, "auth-required: cannot count other people's DMs"] +["COUNT", <query_id>, {"kinds": [1059], "#p": [<pubkey>]}] +["CLOSED", <query_id>, "auth-required: cannot count other people's DMs"] ``` From 179e42101150616c07884a321a70c6d889285202 Mon Sep 17 00:00:00 2001 From: Sandwich <299465+dskvr@users.noreply.github.com> Date: Mon, 13 Oct 2025 14:26:14 +0200 Subject: [PATCH 509/587] nip66: tags shouldn't have integers (#2085) --- 66.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/66.md b/66.md index 2e19916e..59ac1a2e 100644 --- a/66.md +++ b/66.md @@ -53,7 +53,7 @@ Example: ["g", "ww8p1r4t8"], ["l", "en", "ISO-639-1"], ["t", "nsfw" ], - ["rtt-open", 234 ] + ["rtt-open", "234" ] ] } ``` From d54c4267091987f035819ff4714910e388f5d701 Mon Sep 17 00:00:00 2001 From: greenart7c3 <115044884+greenart7c3@users.noreply.github.com> Date: Mon, 13 Oct 2025 15:21:07 -0300 Subject: [PATCH 510/587] [NIP 55] - Instructions on how to use the get_public_key method with content resolver (#2086) --- 55.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/55.md b/55.md index c828768a..19d5ea98 100644 --- a/55.md +++ b/55.md @@ -295,6 +295,8 @@ For the other types Signer Application returns the column "result" If the user chose to always reject the event, signer application will return the column "rejected" and you should not open signer application +Clients SHOULD save the user pubkey locally and avoid calling the `get_public_key` after the user is logged in to the Client + #### Methods - **get_public_key** @@ -303,7 +305,7 @@ If the user chose to always reject the event, signer application will return the ```kotlin val result = context.contentResolver.query( Uri.parse("content://com.example.signer.GET_PUBLIC_KEY"), - listOf("login"), + listOf(hex_pub_key), null, null, null From 7b24bf803f99e6bfe7a34b22f74f8a0942fca158 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Wed, 15 Oct 2025 16:09:36 -0400 Subject: [PATCH 511/587] NIP-37: Improving Draft events (#2016) --- 37.md | 39 +++++++++++++++++++++++---------------- 1 file changed, 23 insertions(+), 16 deletions(-) diff --git a/37.md b/37.md index 1ade59d8..ca0fdfb8 100644 --- a/37.md +++ b/37.md @@ -1,50 +1,57 @@ NIP-37 ====== -Draft Events ------------- +Draft Wraps +----------- `draft` `optional` -This NIP defines kind `31234` as a private wrap for drafts of any other event kind. +This NIP defines kind `31234` as an encrypted storage for unsigned draft events of any other kind. -The draft event is JSON-stringified, [NIP44-encrypted](44.md) to the signer's public key and placed inside the `.content` of the event. +The draft is JSON-stringified, [NIP44-encrypted](44.md) to the signer's public key and placed inside the `.content`. -An additional `k` tag identifies the kind of the draft event. +`k` tags identify the kind of the draft. ```js { "kind": 31234, "tags": [ ["d", "<identifier>"], - ["k", "<kind of the draft event>"], - ["e", "<anchor event event id>", "<relay-url>"], - ["a", "<anchor event address>", "<relay-url>"], + ["k", "<kind of the draft event>"], // required + ["expiration", "now + 90 days"] // recommended ], "content": nip44Encrypt(JSON.stringify(draft_event)), // other fields } ``` -A blanked `.content` means this draft has been deleted by a client but relays still have the event. +A blanked `.content` field signals that the draft has been deleted. -Tags `e` and `a` identify one or more anchor events, such as parent events on replies. +[NIP-40](40.md) `expiration` tags are recommended. + +Clients SHOULD publish kind `31234` events to relays listed on kind `10013` below. ## Relay List for Private Content -Kind `10013` indicates the user's preferred relays to store private events like Drafts. The event MUST include a list of `relay` URLs in private tags. Private tags are JSON Stringified, NIP-44-encrypted to the signer's keys and placed inside the .content of the event. +Kind `10013` indicates the user's preferred relays to store private events like Draft Wraps. + +The event MUST include a list of `relay` URLs in private tags. Private tags are JSON Stringified, [NIP44-encrypted](44.md) to the signer's keys and placed inside the .content of the event. ```js { "kind": 10013, "tags": [], - "content": nip44Encrypt(JSON.stringify([ - ["relay", "wss://myrelay.mydomain.com"] - ])) + "content": nip44Encrypt( + JSON.stringify( + [ + ["relay", "wss://myrelay.mydomain.com"] + ] + ) + ) //...other fields } ``` -Relays listed in this event SHOULD be authed and only allow downloads to events signed by the authed user. +It's recommended that Private Storage relays SHOULD be [NIP-42](42.md)-authed and only allow downloads of events signed by the authed user. -Clients SHOULD publish kind `10013` events to the author's [NIP-65](65.md) `write` relays. +Clients MUST publish kind `10013` events to the author's [NIP-65](65.md) `write` relays. From a3c5554e34f2b292af705d94f49e68f280c7e451 Mon Sep 17 00:00:00 2001 From: Kieran <kieran@harkin.me> Date: Wed, 15 Oct 2025 21:15:27 +0100 Subject: [PATCH 512/587] Add `duration` & `bitrate` to NIP-71 (#1723) Co-authored-by: Vitor Pamplona <vitor@vitorpamplona.com> --- 71.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/71.md b/71.md index 4f07d488..303ec5a3 100644 --- a/71.md +++ b/71.md @@ -26,6 +26,11 @@ The primary source of video information is the `imeta` tags which is defined in Each `imeta` tag can be used to specify a variant of the video by the `dim` & `m` properties. +This NIP defines the following additional `imeta` properties aside form those listen in [NIP-92](92.md) & [NIP-94](94.md): + +* `duration` (recommended) the duration of the video/audio in seconds (floating point number) +* `bitrate` (recommended) the average bitrate of the video/audio in bits/sec + Example: ```json [ @@ -39,6 +44,8 @@ Example: "fallback https://myotherserver.com/1080/12345.mp4", "fallback https://andanotherserver.com/1080/12345.mp4", "service nip96", + "bitrate 3000000", + "duration 29.223" ], ["imeta", "dim 1280x720", @@ -50,6 +57,8 @@ Example: "fallback https://myotherserver.com/720/12345.mp4", "fallback https://andanotherserver.com/720/12345.mp4", "service nip96", + "bitrate 2000000", + "duration 29.24" ], ["imeta", "dim 1280x720", @@ -61,6 +70,7 @@ Example: "fallback https://myotherserver.com/720/12345.m3u8", "fallback https://andanotherserver.com/720/12345.m3u8", "service nip96", + "duration 29.21" ], ] ``` @@ -74,7 +84,6 @@ Additionally `service nip96` may be included to allow clients to search the auth ### Other tags: * `title` (required) title of the video * `published_at`, for the timestamp in unix seconds (stringified) of the first time the video was published -* `duration` (optional) video duration in seconds * `text-track` (optional, repeated) link to WebVTT file for video, type of supplementary information (captions/subtitles/chapters/metadata), optional language code * `content-warning` (optional) warning about content of NSFW video * `alt` (optional) description for accessibility @@ -108,7 +117,6 @@ Additionally `service nip96` may be included to allow clients to search the auth "service nip96", ], - ["duration", "<duration of video in seconds>"], ["text-track", "<encoded `kind 6000` event>", "<recommended relay urls>"], ["content-warning", "<reason>"], ["segment", <start>, <end>, "<title>", "<thumbnail URL>"], From 3f79b7fde21bce53c7a07683a6fbec547095bcb6 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Thu, 16 Oct 2025 07:44:37 -0400 Subject: [PATCH 513/587] NIP-18: Normalize its `q` tags with the definition on NIP-22 (#1746) --- 18.md | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/18.md b/18.md index 4bea80a0..7967a59c 100644 --- a/18.md +++ b/18.md @@ -21,18 +21,12 @@ reposted. ## Quote Reposts -Quote reposts are `kind 1` events with an embedded `q` tag of the note being -quote reposted. The `q` tag ensures quote reposts are not pulled and included -as replies in threads. It also allows you to easily pull and count all of the -quotes for a post. +Mentions to [NIP-21](21.md) entities like `nevent`, `note` and `naddr` on any +event must be converted into `q` tags. The `q` tag ensures quote reposts are +not pulled and included as replies in threads. It also allows you to easily +pull and count all of the quotes for a post. The syntax follows -`q` tags should follow the same conventions as NIP 10 `e` tags, with the exception -of the `mark` argument. - -`["q", <event-id>, <relay-url>, <pubkey>]` - -Quote reposts MUST include the [NIP-21](21.md) `nevent`, `note`, or `naddr` of the -event in the content. +`["q", "<event-id> or <event-address>", "<relay-url>", "<pubkey-if-a-regular-event>"]` ## Generic Reposts From 6e6b9877b32b44e84c0f3c3d412d688cf86761b0 Mon Sep 17 00:00:00 2001 From: DanConwayDev <114834599+DanConwayDev@users.noreply.github.com> Date: Thu, 16 Oct 2025 18:08:48 +0100 Subject: [PATCH 514/587] NIP-34: add PR and PR update events (#1966) --- 34.md | 92 ++++++++++++++++++++++++++++++++++++++++++++++++++----- README.md | 5 +++ 2 files changed, 89 insertions(+), 8 deletions(-) diff --git a/34.md b/34.md index ab80a936..d35c0eb2 100644 --- a/34.md +++ b/34.md @@ -10,7 +10,7 @@ This NIP defines all the ways code collaboration using and adjacent to [`git`](h ## Repository announcements -Git repositories are hosted in Git-enabled servers, but their existence can be announced using Nostr events, as well as their willingness to receive patches, bug reports and comments in general. +Git repositories are hosted in Git-enabled servers, but their existence can be announced using Nostr events. By doing so the author asserts themselves as a maintainer and expresses a willingness to receive patches, bug reports and comments in general, unless `t` tag `personal-fork` is included. ```jsonc { @@ -25,6 +25,7 @@ Git repositories are hosted in Git-enabled servers, but their existence can be a ["relays", "<relay-url>", ...], // relays that this repository will monitor for patches and issues ["r", "<earliest-unique-commit-id>", "euc"], ["maintainers", "<other-recognized-maintainer>", ...], + ["t","personal-fork"], // optionally indicate author isn't a maintainer ["t", "<arbitrary string>"], // hashtags labelling the repository ] } @@ -66,9 +67,13 @@ The `refs` tag can be optionally extended to enable clients to identify how many } ``` -## Patches +## Patches and Pull Requests (PRs) -Patches 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. +Patches and PRs can be sent by anyone to any repository. Patches and PRs to a specific repository SHOULD be sent to the relays specified in that repository's announcement event's `"relays"` tag. Patch and PR events SHOULD include an `a` tag pointing to that repository's announcement address. + +Patches SHOULD be used if each event is under 60kb, otherwise PRs SHOULD be used. + +### Patches Patches in a patch set SHOULD include a [NIP-10](10.md) `e` `reply` tag pointing to the previous patch. @@ -103,9 +108,66 @@ The first patch revision in a patch revision SHOULD include a [NIP-10](10.md) `e The first patch in a series MAY be a cover letter in the format produced by `git format-patch`. +### Pull Requests + +The PR or PR update tip SHOULD be successfully pushed to `refs/nostr/<[PR|PR-Update]-event-id>` in all repositories listed in its `clone` tag before the event is signed. + +An attempt SHOULD be made to push this ref to all repositories listed in the repository's announcement event's `"clone"` tag, for which their is reason to believe the user might have write access. This includes each [grasp server](https://njump.me/naddr1qvzqqqrhnypzpgqgmmc409hm4xsdd74sf68a2uyf9pwel4g9mfdg8l5244t6x4jdqy28wumn8ghj7un9d3shjtnwva5hgtnyv4mqqpt8wfshxuqlnvh8x) which can be identified using this method: `clone` tag includes `[http|https]://<grasp-path>/<valid-npub>/<string>.git` and `relays` tag includes `[ws/wss]://<grasp-path>`. + +Clients MAY fallback to creating a 'personal-fork' `repository announcement` listing other grasp servers, e.g. from the `User grasp list`, for the purpose of serving the specified commit(s). + +```jsonc +{ + "kind": 1618, + "content": "<markdown text>", + "tags": [ + ["a", "30617:<base-repo-owner-pubkey>:<base-repo-id>"], + ["r", "<earliest-unique-commit-id-of-repo>"] // so clients can subscribe to all PRs sent to a local git repo + ["p", "<repository-owner>"], + ["p", "<other-user>"], // optionally send the PR to another user to bring it to their attention + + ["subject", "<PR-subject>"], + ["t", "<PR-label>"], // optional + ["t", "<another-PR-label>"], // optional + + ["c", "<current-commit-id>"], // tip of the PR branch + ["clone", "<clone-url>", ...], // at least one git clone url where commit can be downloaded + ["branch-name", "<branch-name>"], // optional recommended branch name + + ["e", "<root-patch-event-id>"], // optionally indicate PR is a revision of an existing patch, which should be closed + ["merge-base", "<commit-id>"], // optional: the most recent common ancestor with the target branch + ] +} +``` + +### Pull Request Updates + +A PR Update changes the tip of a referenced PR event. + +```jsonc +{ + "kind": 1619, + "content": "", + "tags": [ + ["a", "30617:<base-repo-owner-pubkey>:<base-repo-id>"], + ["r", "<earliest-unique-commit-id-of-repo>"] // so clients can subscribe to all PRs sent to a local git repo + ["p", "<repository-owner>"], + ["p", "<other-user>"], // optionally send the PR to another user to bring it to their attention + + // NIP-22 tags + ["E", "<pull-request-event-id>"], + ["P", "<pull-request-author>"], + + ["c", "<current-commit-id>"], // updated tip of PR + ["clone", "<clone-url>", ...], // at least one git clone url where commit can be downloaded + ["merge-base", "<commit-id>"], // optional: the most recent common ancestor with the target branch + ] +} +``` + ## Issues -Issues 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. +Issues 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. Issues 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. @@ -125,11 +187,11 @@ Issues may have a `subject` tag, which clients can utilize to display a header. ## Replies -Replies to either a `kind:1621` (_issue_) or a `kind:1617` (_patch_) event should follow [NIP-22 comment](22.md). +Replies to either a `kind:1621` (_issue_), `kind:1617` (_patch_) or `kind:1618` (_pull request_) event should follow [NIP-22 comment](22.md). ## Status -Root Patches and Issues have a Status that defaults to 'Open' and can be set by issuing Status events. +Root Patches, PRs and Issues have a Status that defaults to 'Open' and can be set by issuing Status events. ```jsonc { @@ -139,7 +201,7 @@ Root Patches and Issues have a Status that defaults to 'Open' and can be set by "kind": 1633, // Draft "content": "<markdown text>", "tags": [ - ["e", "<issue-or-original-root-patch-id-hex>", "", "root"], + ["e", "<issue-or-PR-or-original-root-patch-id-hex>", "", "root"], ["e", "<accepted-revision-root-id-hex>", "", "reply"], // for when revisions applied ["p", "<repository-owner>"], ["p", "<root-event-author>"], @@ -165,8 +227,22 @@ The most recent Status event (by `created_at` date) from either the issue/patch The Status of a patch-revision is to either that of the root-patch, or `1632` (_Closed_) if the root-patch's Status is `1631` (_Applied/Merged_) and the patch-revision isn't tagged in the `1631` (_Applied/Merged_) event. +## User grasp list + +List of [grasp servers](https://njump.me/naddr1qvzqqqrhnypzpgqgmmc409hm4xsdd74sf68a2uyf9pwel4g9mfdg8l5244t6x4jdqy28wumn8ghj7un9d3shjtnwva5hgtnyv4mqqpt8wfshxuqlnvh8x) the user generally wishes to use for NIP-34 related activity. It is similar in function to the NIP-65 relay list and NIP-B7 blossom list. + +The event SHOULD include a list of `g` tags with grasp service websocket URLs in order of preference. + +```jsonc +{ + "kind": 10317, + "content": "", + "tags": [ + ["g", "<grasp-service-websocket-url>"], // zero or more grasp sever urls + ] +} +``` ## Possible things to be added later -- "branch merge" kind (specifying a URL from where to fetch the branch to be merged) - inline file comments kind (we probably need one for patches and a different one for merged files) diff --git a/README.md b/README.md index f5194ded..445876e1 100644 --- a/README.md +++ b/README.md @@ -160,6 +160,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `1311` | Live Chat Message | [53](53.md) | | `1337` | Code Snippet | [C0](C0.md) | | `1617` | Patches | [34](34.md) | +| `1618` | Pull Requests | [34](34.md) | +| `1619` | Pull Request Updates | [34](34.md) | | `1621` | Issues | [34](34.md) | | `1622` | Git Replies (deprecated) | [34](34.md) | | `1630`-`1633` | Status | [34](34.md) | @@ -317,6 +319,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | ----------------- | ------------------------------------ | ------------------------------- | -------------------------------------------------- | | `a` | coordinates to an event | relay URL | [01](01.md) | | `A` | root address | relay URL | [22](22.md) | +| `c` | commit id | | [34](34.md) | | `d` | identifier | -- | [01](01.md) | | `e` | event id (hex) | relay URL, marker, pubkey (hex) | [01](01.md), [10](10.md) | | `E` | root event id | relay URL | [22](22.md) | @@ -345,6 +348,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `alt` | summary | -- | [31](31.md) | | `amount` | millisatoshis, stringified | -- | [57](57.md) | | `bolt11` | `bolt11` invoice | -- | [57](57.md) | +| `branch-name` | branch name suggestion | -- | [34](34.md) | | `challenge` | challenge string | -- | [42](42.md) | | `client` | name, address | relay URL | [89](89.md) | | `clone` | git clone URL | -- | [34](34.md) | @@ -358,6 +362,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `expiration` | unix timestamp (string) | -- | [40](40.md) | | `file` | full path (string) | -- | [35](35.md) | | `goal` | event id (hex) | relay URL | [75](75.md) | +| `merge-base` | commit id | | [34](34.md) | | `HEAD` | `ref: refs/heads/<branch-name>` | | [34](34.md) | | `image` | image URL | dimensions in pixels | [23](23.md), [52](52.md), [58](58.md) | | `imeta` | inline metadata | -- | [92](92.md) | From bcaad2957d0e9cec20e4265298d2788be87d3190 Mon Sep 17 00:00:00 2001 From: alltheseas <64376233+alltheseas@users.noreply.github.com> Date: Mon, 27 Oct 2025 12:56:47 -0500 Subject: [PATCH 515/587] Enhance metadata/timestamp protection guidance in NIP-59 (#2095) --- 59.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/59.md b/59.md index 9cb79f2f..6abf1cd4 100644 --- a/59.md +++ b/59.md @@ -97,6 +97,9 @@ To protect recipient metadata, relays SHOULD only serve `kind 1059` events inten When possible, clients should only send wrapped events to `read` relays for the recipient that implement AUTH, and refuse to serve wrapped events to non-recipients. +When adding expiration tags to both `seal` and `gift wrap` layers, implementations SHOULD use independent random timestamps for each layer. Using different `created_at` values increases timing variance and helps protect against metadata correlation attacks. + + ## An Example Let's send a wrapped `kind 1` message between two parties asking "Are you going to the party tonight?" From 520b9016291b087497323e37364d1b8853817852 Mon Sep 17 00:00:00 2001 From: alltheseas <64376233+alltheseas@users.noreply.github.com> Date: Tue, 28 Oct 2025 09:49:19 -0500 Subject: [PATCH 516/587] NIP-17: Clarify client event publishing instructions (#2097) --- 17.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/17.md b/17.md index e9e97ba5..2e0aabbf 100644 --- a/17.md +++ b/17.md @@ -145,7 +145,7 @@ Kind `10050` indicates the user's preferred relays to receive DMs. The event MUS } ``` -Clients 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. +Clients SHOULD publish the gift-wrapped kind 1059 events that contain the sealed kind 14 (text) or kind 15 (file) rumors to the relays listed in the recipient’s kind 10050 event. If that is not found that indicates the user is not ready to receive messages under this NIP and clients shouldn't try. ## Relays From 8054526b874a90a83aca2dc6c9c5cd17682f8703 Mon Sep 17 00:00:00 2001 From: hodlbod <jstaab@protonmail.com> Date: Thu, 30 Oct 2025 03:44:48 -0700 Subject: [PATCH 517/587] Add relay access requests (#1079) Co-authored-by: Jonathan Staab <shtaab@gmail.com> --- 43.md | 146 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 146 insertions(+) create mode 100644 43.md diff --git a/43.md b/43.md new file mode 100644 index 00000000..6455c08f --- /dev/null +++ b/43.md @@ -0,0 +1,146 @@ +NIP-43 +====== + +Relay Access Metadata and Requests +---------------------------------- + +`draft` `optional` + +This NIP defines a way for relays to advertise membership lists, and for clients to request admission to relays on behalf of users. + +## Membership Lists + +Relays MAY publish a `kind 13534` event which indicates pubkeys that have access to a given relay. This event MUST be signed by the pubkey specified in the `self` field of the relay's [NIP 11](./11.md) document. + +The following tags are required: + +- A [NIP 70](./70.md) `-` tag +- A `member` tag containing a hex pubkey should be included for each member + +This list should not be considered exhaustive or authoritative. To determine membership, both a `kind 13534` event by the relay, and a `kind 10010` event by the member should be consulted. + +Example: + +```jsonc +{ + "kind": 13534, + "pubkey": "<nip11.self>", + "tags": [ + ["-"], + ["member", "c308e1f882c1f1dff2a43d4294239ddeec04e575f2d1aad1fa21ea7684e61fb5"], + ["member", "ee1d336e13779e4d4c527b988429d96de16088f958cbf6c074676ac9cfd9c958"] + ], + // ...other fields +} +``` + +## Add User + +Relays MAY publish a `kind 8000` event when a member is added to the relay. This event MUST be signed by the pubkey specified in the `self` field of the relay's [NIP 11](./11.md) document. + +The following tags are required: + +- A [NIP 70](./70.md) `-` tag +- A `p` tag indicating the member's hex pubkey + +Example: + +```jsonc +{ + "kind": 8000, + "pubkey": "<nip11.self>", + "tags": [ + ["-"], + ["p", "c308e1f882c1f1dff2a43d4294239ddeec04e575f2d1aad1fa21ea7684e61fb5"] + ], + // ...other fields +} +``` + +## Remove User + +Relays MAY publish a `kind 8001` event when a member is removed from the relay. This event MUST be signed by the pubkey specified in the `self` field of the relay's [NIP 11](./11.md) document. + +The following tags are required: + +- A [NIP 70](./70.md) `-` tag +- A `p` tag indicating the member's hex pubkey + +Example: + +```jsonc +{ + "kind": 8001, + "pubkey": "<nip11.self>", + "tags": [ + ["-"], + ["p", "c308e1f882c1f1dff2a43d4294239ddeec04e575f2d1aad1fa21ea7684e61fb5"] + ], + // ...other fields +} +``` + +## Join Request + +A user MAY send a `kind 28934` to a relay in order to request admission. It MUST have a `claim` tag containing an invite code. The event's `created_at` MUST be now, plus or minus a few minutes. + +```jsonc +{ + "kind": 28934, + "pubkey": "<user pubkey>", + "tags": [ + ["-"], + ["claim", "<invite code>"] + ], + // ...other fields +} +``` + +Upon receiving a claim, a relay MUST notify the client as to what the status of the claim is using an `OK` message. Failed claims SHOULD use the same standard `"restricted: "` prefix specified by NIP 42. + +Relays SHOULD update their `kind 13534` member list and MAY publish a `kind 8000` "add member" event. + +Some examples: + +``` +["OK", <event-id>, false, "restricted: that invite code is expired."] +["OK", <event-id>, false, "restricted: that is an invalid invite code."] +["OK", <event-id>, true, "duplicate: you are already a member of this relay."] +["OK", <event-id>, true, "info: welcome to wss://relay.bunk.skunk!"] +``` + +## Invite Request + +Users may request a claim string from a relay by making a request for `kind 28935` events. This event MUST be signed by the pubkey specified in the `self` field of the relay's [NIP 11](./11.md) document. + +```jsonc +{ + "kind": 28935, + "pubkey": "<nip11.self>", + "tags": [ + ["-"], + ["claim", "<invite code>"], + ], + // ...other fields +} +``` + +Note that these events are in the `ephemeral` range, which means relays must explicitly opt-in to this behavior by generating claims on the fly when requested. This allows relays to improve security by issuing a different claim for each request, only issuing claims to certain users, or expiring claims. + +## Leave Request + +A user MAY send a `kind 28936` to a relay in order to request that their access be revoked. The event's `created_at` MUST be now, plus or minus a few minutes. This event MUST include a [NIP 70](./70.md) `-` tag. + +```jsonc +{ + "kind": 28936, + "tags": [["-"]], + // ...other fields +} +``` + +Relays SHOULD update their `kind 13534` member list and MAY publish a `kind 8001` "remove member" event. + +## Implementation + +Clients MUST only request `kind 28935` events from and send `kind 28934` events to relays which include this NIP in the `supported_nips` section of its [NIP 11](./11.md) relay information document. From cc77619af8f38f858a488a962358498a9dbc6250 Mon Sep 17 00:00:00 2001 From: Leo Wandersleb <leo@leowandersleb.de> Date: Thu, 30 Oct 2025 13:30:15 +0100 Subject: [PATCH 518/587] replace jsonc syntax highlighting for javascript (#2100) --- 60.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/60.md b/60.md index 786ce977..4b744189 100644 --- a/60.md +++ b/60.md @@ -22,7 +22,7 @@ This NIP doesn't deal with users' *receiving* money from someone else, it's just 3. 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. ### Wallet Event -```jsonc +```javascript { "kind": 17375, "content": nip44_encrypt([ @@ -45,7 +45,7 @@ Token events are used to record unspent proofs. There can be multiple `kind:7375` events for the same mint, and multiple proofs inside each `kind:7375` event. -```jsonc +```javascript { "kind": 7375, "content": nip44_encrypt({ @@ -78,7 +78,7 @@ The `kind:5` _delete event_ created in the [NIP-09](09.md) process MUST have a t ### Spending History Event Clients SHOULD publish `kind:7376` events to create a transaction history when their balance changes. -```jsonc +```javascript { "kind": 7376, "content": nip44_encrypt([ @@ -115,7 +115,7 @@ From those relays, the client should fetch wallet and token events. ### Spending token If Alice spends 4 sats from this token event -```jsonc +```javascript { "kind": 7375, "id": "event-id-1", @@ -134,7 +134,7 @@ If Alice spends 4 sats from this token event Her client: * MUST roll over the unspent proofs: -```jsonc +```javascript { "kind": 7375, "id": "event-id-2", @@ -153,7 +153,7 @@ Her client: * MUST delete event `event-id-1` * SHOULD add the `event-id-1` to the `del` array of deleted token-ids. * SHOULD create a `kind:7376` event to record the spend -```jsonc +```javascript { "kind": 7376, "content": nip44_encrypt([ @@ -171,7 +171,7 @@ When creating a quote at a mint, an event can be used to keep the state of the q However, application developers SHOULD use local state when possible and only publish this event when it makes sense in the context of their application. -```jsonc +```javascript { "kind": 7374, "content": nip44_encrypt("quote-id"), From 3ec830cd2331ba0ed3113fc05a44c87deb9785be Mon Sep 17 00:00:00 2001 From: hodlbod <jstaab@protonmail.com> Date: Thu, 30 Oct 2025 12:53:24 -0700 Subject: [PATCH 519/587] refine wording of nip 17, include kind 7 reactions (#2098) Co-authored-by: Jon Staab <shtaab@gmail.com> --- 17.md | 36 +++++++++++++++--------------------- 1 file changed, 15 insertions(+), 21 deletions(-) diff --git a/17.md b/17.md index 2e0aabbf..900b6dd7 100644 --- a/17.md +++ b/17.md @@ -6,9 +6,15 @@ Private Direct Messages `draft` `optional` -This NIP defines an encrypted direct messaging scheme using [NIP-44](44.md) encryption and [NIP-59](59.md) seals and gift wraps. +This NIP defines an encrypted chat scheme which uses [NIP-44](44.md) encryption and [NIP-59](59.md) seals and gift wraps. -## Direct Message Kind +Any event sent to an encrypted chat MUST NOT be signed, and MUST be encrypted as described in [NIP-59](./59.md) and illustrated below. Omitting signatures makes messages deniable in case they are accidentally or maliciously leaked, while still allowing the recipient to authenticate them. + +By convention, `kind 14` direct messages, `kind 15` file messages, and [`kind 7` reactions](./25.md) may be sent to an encrypted chat. + +## Kind Definitions + +### Chat Message Kind `14` is a chat message. `p` tags identify one or more receivers of the message. @@ -31,7 +37,7 @@ Kind `14` is a chat message. `p` tags identify one or more receivers of the mess `.content` MUST be plain text. Fields `id` and `created_at` are required. -An `e` tag denotes the direct parent message this post is replying to. +An `e` tag denotes the direct parent message this post is replying to. `q` tags MAY be used when citing events in the `.content` with [NIP-21](21.md). @@ -39,9 +45,7 @@ An `e` tag denotes the direct parent message this post is replying to. ["q", "<event-id> or <event-address>", "<relay-url>", "<pubkey-if-a-regular-event>"] ``` -Kind `14`s MUST never be signed. If it is signed, the message might leak to relays and become **fully public**. - -## File Message Kind +## File Message ```jsonc { @@ -80,8 +84,6 @@ Kind `15` is used for sending encrypted file event messages: - `thumb` (optional) URL of thumbnail with same aspect ratio (encrypted with the same key, nonce) - `fallback` (optional) zero or more fallback file sources in case `url` fails (encrypted with the same key, nonce) -Just like kind `14`, kind `15`s MUST never be signed. - ## Chat Rooms The 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 a clean message history. @@ -92,7 +94,7 @@ An optional `subject` tag defines the current name/topic of the conversation. An ## Encrypting -Following [NIP-59](59.md), the **unsigned** `kind:14` & `kind:15` chat messages must be sealed (`kind:13`) and then gift-wrapped (`kind:1059`) to each receiver and the sender individually. +Following [NIP-59](59.md), the **unsigned** chat messages must be sealed (`kind:13`) and then gift-wrapped (`kind:1059`) to each receiver and the sender individually. ```js { @@ -127,7 +129,7 @@ Clients SHOULD randomize `created_at` in up to two days in the past in both the The 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. -Clients 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 +Clients MAY 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. This tag SHOULD be included on the `kind 13` seal as well, in case it leaks. ## Publishing @@ -145,15 +147,13 @@ Kind `10050` indicates the user's preferred relays to receive DMs. The event MUS } ``` -Clients SHOULD publish the gift-wrapped kind 1059 events that contain the sealed kind 14 (text) or kind 15 (file) rumors to the relays listed in the recipient’s kind 10050 event. If that is not found that indicates the user is not ready to receive messages under this NIP and clients shouldn't try. +Clients SHOULD publish the gift-wrapped `kind 1059` events that contain the sealed rumors to the relays listed in the recipient’s kind 10050 event. If that is not found that indicates the user is not ready to receive messages under this NIP and clients shouldn't try. ## Relays -It's advisable that relays do not serve `kind:1059` to clients other than the ones tagged in them. +Relays MAY protect message metadata by only serving `kind:1059` events to users p-tagged on the event (enforced using [NIP 42 AUTH](./42.md)). -It's advisable that users choose relays that conform to these practices. - -Clients SHOULD guide users to keep `kind:10050` lists small (1-3 relays) and SHOULD spread it to as many relays as viable. +Clients SHOULD guide users to keep `kind:10050` lists small (1-3 relays) and SHOULD spread them to as many relays as viable. ## Benefits & Limitations @@ -170,12 +170,6 @@ This NIP offers the following privacy and security features: The 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. -## Implementation - -Clients 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. - -When 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. - ## Examples This example sends the message `Hola, que tal?` from `nsec1w8udu59ydjvedgs3yv5qccshcj8k05fh3l60k9x57asjrqdpa00qkmr89m` to `nsec12ywtkplvyq5t6twdqwwygavp5lm4fhuang89c943nf2z92eez43szvn4dt`. From 62f0b14ae81fd062bb84791bca698b29f6b573a3 Mon Sep 17 00:00:00 2001 From: Rob Woodgate <robwoodgate@users.noreply.github.com> Date: Fri, 31 Oct 2025 13:59:35 +0000 Subject: [PATCH 520/587] Added base "unit" tag to NutZap kind:9321 event (#1915) --- 60.md | 7 +++++++ 61.md | 3 +++ 2 files changed, 10 insertions(+) diff --git a/60.md b/60.md index 4b744189..8c836ac0 100644 --- a/60.md +++ b/60.md @@ -50,6 +50,7 @@ There can be multiple `kind:7375` events for the same mint, and multiple proofs "kind": 7375, "content": nip44_encrypt({ "mint": "https://stablenut.umint.cash", + "unit": "sat", "proofs": [ // one or more proofs in the default cashu format { @@ -69,6 +70,7 @@ There can be multiple `kind:7375` events for the same mint, and multiple proofs * `.content` is a [NIP-44](44.md) encrypted payload: * `mint`: The mint the proofs belong to. * `proofs`: unencoded proofs + * `unit` the base unit the proofs are denominated in (eg: `sat`, `usd`, `eur`). Default: `sat` if omitted. * `del`: token-ids that were destroyed by the creation of this token. This assists with state transitions. When one or more proofs of a token are spent, the token event should be [NIP-09](09.md)-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 (the change output should include a `del` field). @@ -84,6 +86,7 @@ Clients SHOULD publish `kind:7376` events to create a transaction history when t "content": nip44_encrypt([ [ "direction", "in" ], // in = received, out = sent [ "amount", "1" ], + [ "unit", "sat" ], [ "e", "<event-id-of-created-token>", "", "created" ] ]), "tags": [ @@ -93,6 +96,7 @@ Clients SHOULD publish `kind:7376` events to create a transaction history when t ``` * `direction` - The direction of the transaction; `in` for received funds, `out` for sent funds. +* `unit` the base unit of the amount (eg: `sat`, `usd`, `eur`). Default: `sat` if omitted. Clients MUST add `e` tags to create references of destroyed and created token events along with the marker of the meaning of the tag: * `created` - A new token event was created. @@ -121,6 +125,7 @@ If Alice spends 4 sats from this token event "id": "event-id-1", "content": nip44_encrypt({ "mint": "https://stablenut.umint.cash", + "unit": "sat", "proofs": [ { "id": "1", "amount": 1 }, { "id": "2", "amount": 2 }, @@ -140,6 +145,7 @@ Her client: "id": "event-id-2", "content": nip44_encrypt({ "mint": "https://stablenut.umint.cash", + "unit": "sat", "proofs": [ { "id": "1", "amount": 1 }, { "id": "2", "amount": 2 }, @@ -159,6 +165,7 @@ Her client: "content": nip44_encrypt([ [ "direction", "out" ], [ "amount", "4" ], + [ "unit", "sat" ], [ "e", "<event-id-1>", "", "destroyed" ], [ "e", "<event-id-2>", "", "created" ], ]), diff --git a/61.md b/61.md index 5ef7f680..5842d6b3 100644 --- a/61.md +++ b/61.md @@ -51,6 +51,7 @@ Clients MUST prefix the public key they P2PK-lock with `"02"` (for nostr<>cashu "pubkey": "<sender-pubkey>", "tags": [ [ "proof", "{\"amount\":1,\"C\":\"02277c66191736eb72fce9d975d08e3191f8f96afb73ab1eec37e4465683066d3f\",\"id\":\"000a93d6f8a1d2c4\",\"secret\":\"[\\\"P2PK\\\",{\\\"nonce\\\":\\\"b00bdd0467b0090a25bdf2d2f0d45ac4e355c482c1418350f273a04fedaaee83\\\",\\\"data\\\":\\\"02eaee8939e3565e48cc62967e2fde9d8e2a4b3ec0081f29eceff5c64ef10ac1ed\\\"}]\"}" ], + [ "unit", "sat" ], [ "u", "https://stablenut.umint.cash" ], [ "e", "<nutzapped-event-id>", "<relay-hint>" ], [ "k", "<nutzapped-kind>"], @@ -62,6 +63,7 @@ Clients MUST prefix the public key they P2PK-lock with `"02"` (for nostr<>cashu * `.content` is an optional comment for the nutzap * `.tags`: * `proof` is one or more proofs P2PK-locked to the public key the recipient specified in their `kind:10019` event and including a DLEQ proof. + * `unit` the base unit the proofs are denominated in (eg: `sat`, `usd`, `eur`). Default: `sat` if omitted. * `u` is the mint the URL of the mint EXACTLY as specified by the recipient's `kind:10019`. * `p` is the Nostr identity public key of nutzap recipient. * `e` is the event that is being nutzapped, if any. @@ -95,6 +97,7 @@ Multiple `kind:9321` events can be tagged in the same `kind:7376` event. "content": nip44_encrypt([ [ "direction", "in" ], // in = received, out = sent [ "amount", "1" ], + [ "unit", "sat" ], [ "e", "<7375-event-id>", "<relay-hint>", "created" ] // new token event that was created ]), "tags": [ From 45668383e372fc6ec7c9aa4023efbfad637e6bfe Mon Sep 17 00:00:00 2001 From: AsaiToshiya <to.asai.60@gmail.com> Date: Tue, 4 Nov 2025 22:46:47 +0900 Subject: [PATCH 521/587] add NIP-43 and its kinds to README. (#2110) --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 445876e1..ccae3aa0 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-39: External Identities in Profiles](39.md) - [NIP-40: Expiration Timestamp](40.md) - [NIP-42: Authentication of clients to relays](42.md) +- [NIP-43: Relay Access Metadata and Requests](43.md) - [NIP-44: Encrypted Payloads (Versioned)](44.md) - [NIP-45: Counting results](45.md) - [NIP-46: Nostr Remote Signing](46.md) @@ -182,6 +183,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `7376` | Cashu Wallet History | [60](60.md) | | `7516` | Geocache log | [geocaching][geocaching] | | `7517` | Geocache proof of find | [geocaching][geocaching] | +| `8000` | Add User | [43](43.md) | +| `8001` | Remove User | [43](43.md) | | `9000`-`9030` | Group Control Events | [29](29.md) | | `9041` | Zap Goal | [75](75.md) | | `9321` | Nutzap | [61](61.md) | @@ -213,6 +216,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10377` | Proxy Announcement | [Nostr Epoxy][nostr-epoxy] | | `11111` | Transport Method Announcement | [Nostr Epoxy][nostr-epoxy] | | `13194` | Wallet Info | [47](47.md) | +| `13534` | Membership Lists | [43](43.md) | | `17375` | Cashu Wallet Event | [60](60.md) | | `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | | `22242` | Client Authentication | [42](42.md) | @@ -221,6 +225,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `24133` | Nostr Connect | [46](46.md) | | `24242` | Blobs stored on mediaservers | [Blossom][blossom] | | `27235` | HTTP Auth | [98](98.md) | +| `28934` | Join Request | [43](43.md) | +| `28935` | Invite Request | [43](43.md) | +| `28936` | Leave Request | [43](43.md) | | `30000` | Follow sets | [51](51.md) | | `30001` | Generic lists | 51 (deprecated) | | `30002` | Relay sets | [51](51.md) | From a47c460415bf46635d6ae83aac40e6c4db8a9ca1 Mon Sep 17 00:00:00 2001 From: KoalaSat <koalasat@satstralia.com> Date: Tue, 11 Nov 2025 14:05:09 +0000 Subject: [PATCH 522/587] NIP-BE: Add BLE messaging and device synchronization (#1979) --- BE.md | 137 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 137 insertions(+) create mode 100644 BE.md diff --git a/BE.md b/BE.md new file mode 100644 index 00000000..50062d9e --- /dev/null +++ b/BE.md @@ -0,0 +1,137 @@ +NIP-BE +====== + +Nostr BLE Communications Protocol +--------------------------------- + +`draft` `optional` + +This NIP specifies how Nostr apps can use BLE to communicate and synchronize with each other. The BLE protocol follows a client-server pattern, so this NIP emulates the WS structure in a similar way, but with some adaptations to its limitations. + +## Device advertisement +A device advertises itself with: +- Service UUID: `0000180f-0000-1000-8000-00805f9b34fb` +- Data: Device UUID in ByteArray format + +## GATT service +The device exposes a Nordic UART Service with the following characteristics: + +1. Write Characteristic + - UUID: `87654321-0000-1000-8000-00805f9b34fb` + - Properties: Write + +2. Read Characteristic + - UUID: `12345678-0000-1000-8000-00805f9b34fb` + - Properties: Notify, Read + +## Role assignment + +When one device initially finds another advertising the service, it will read the service's data to get the device UUID and compare it with its own advertised device UUID. For this communication, the device with the highest ID will take the role of GATT Server (Relay), the other will be considered the GATT Client (Client) and will proceed to establish the connection. + +For devices whose purpose will require a single role, its device UUID will always be: + +- GATT Server: `FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF` +- GATT Client: `00000000-0000-0000-0000-000000000000` + +## Messages + +All messages will follow [NIP-01](/01.md) message structure. For a given message, a compression stream (DEFLATE) is applied to the message to generate a byte array. Depending on the BLE version, the byte array can be too large for a single message (20-23 bytes in BLE 4.2, 256 bytes in BLE > 4.2). In that case, this byte array is split into any number of batches following the structure: + +``` +[batch index (first 2 bytes)][batch n][is last batch (last byte)] +``` +After reception of all batches, the other device can then join them and decompress. To ensure reliability, only 1 message will be read/written at a time. MTU can be negotiated in advance. The maximum size for a message is 64KB; bigger messages will be rejected. + +## Examples + +This example implements a function to split and compress a byte array into chunks, as well as another function to join and decompress them in order to obtain the initial result: + +```kotlin +fun splitInChunks(message: ByteArray): Array<ByteArray> { + val chunkSize = 500 // define the chunk size + var byteArray = compressByteArray(message) + val numChunks = (byteArray.size + chunkSize - 1) / chunkSize // calculate the number of chunks + var chunkIndex = 0 + val chunks = Array(numChunks) { ByteArray(0) } + + for (i in 0 until numChunks) { + val start = i * chunkSize + val end = minOf((i + 1) * chunkSize, byteArray.size) + val chunk = byteArray.copyOfRange(start, end) + + // add chunk index to the first 2 bytes and last chunk flag to the last byte + val chunkWithIndex = ByteArray(chunk.size + 2) + chunkWithIndex[0] = chunkIndex.toByte() // chunk index + chunk.copyInto(chunkWithIndex, 1) + chunkWithIndex[chunkWithIndex.size - 1] = numChunks.toByte() + + // store the chunk in the array + chunks[i] = chunkWithIndex + + chunkIndex++ + } + + return chunks +} + +fun joinChunks(chunks: Array<ByteArray>): ByteArray { + val sortedChunks = chunks.sortedBy { it[0] } + var reassembledByteArray = ByteArray(0) + for (chunk in sortedChunks) { + val chunkData = chunk.copyOfRange(1, chunk.size - 1) + reassembledByteArray = reassembledByteArray.copyOf(reassembledByteArray.size + chunkData.size) + chunkData.copyInto(reassembledByteArray, reassembledByteArray.size - chunkData.size) + } + + return decompressByteArray(reassembledByteArray) +} + +``` + +## Workflows + +### Client to relay + +- Any message the client wants to send to a relay will be a write message. +- Any message the client receives from a relay will be a read message. + +### Relay to client + +The relay should notify the client about any new event matching subscription's filters by using the Notify action of the Read Characteristic. After that, the client can proceed to read messages from the relay. + +### Device synchronization + +Given the nature of BLE, it is expected that the direct connection between two devices might be extremely intermittent, with gaps of hours or even days. That's why it's crucial to define a synchronization process by following [NIP-77](./77.md) but with an adaptation to the limitations of the technology. + +After two devices have successfully connected and established the Client-Server roles, the devices will use half-duplex communication to intermittently send and receive messages. + +#### Half-duplex synchronization + +Right after the 2 devices connect, the Client starts the workflow by sending the first message. + +1. Client - Writes ["NEG-OPEN"](/77.md#initial-message-client-to-relay) message. +2. Server - Sends `write-success`. +3. Client - Sends `read-message`. +4. Server - Responds with ["NEG-MSG"](./77.md#subsequent-messages-bidirectional) message. +5. Client - + 1. If the Client has messages missing on the Server, it writes one `EVENT`. + 2. If the Client doesn't have any messages missing on the Server, it writes `EOSE`. In this case, subsequent messages to the Server will be empty while the Server claims to have more notes for the Client. +6. Server - Sends `write-success`. +7. Client - Sends `read-message`. +8. Server - + 1. If the Server has messages missing on the Client, it responds with one `EVENT`. + 2. If the Client doesn't have any messages missing on the Server, it responds with `EOSE`. In this case, subsequent responses to the Client will be empty. +9. If the Client detects that the devices are not synchronized yet, jump to step 5. +10. After the two devices detect that there are no more missing events on both ends, the workflow will pause at this point. + +#### Half-duplex event spread + +While two devices are connected and synchronized, it might happen that one of them receives a new message from another connected peer. Devices MUST keep track of which notes have been sent to its peers while they are connected. If the newly received event is detected as missing in one of the connected and synchronized peers: + +1. If the peer is a Server: + 1. Client - It writes the `EVENT`. + 2. Server - Sends `write-success`. +2. If the peer is a Client: + 1. Server - It will send an empty notification to the Client. + 2. Client - Sends `read-message`. + 3. Server - Responds with the `EVENT`. From f63c00213fbe494983f2753018d829ea64724d83 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20Calder=C3=B3n?= <fjcalderon@gmail.com> Date: Thu, 13 Nov 2025 15:41:04 -0300 Subject: [PATCH 523/587] Add order expiration support to NIP-69 (#2118) --- 69.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/69.md b/69.md index 8a28331f..997cac67 100644 --- a/69.md +++ b/69.md @@ -41,7 +41,8 @@ Events are [addressable events](01.md#kinds) and use `38383` as event kind, a p2 ["name", "Nakamoto"], ["g", "<geohash>"], ["bond", "0"], - ["expiration", "1719391096"], + ["expires_at", "1719391096"], + ["expiration", "1719995896"], ["y", "lnp2pbot"], ["z", "order"] ], @@ -55,7 +56,7 @@ Events are [addressable events](01.md#kinds) and use `38383` as event kind, a p2 - `d` < Order ID >: A unique identifier for the order. - `k` < Order type >: `sell` or `buy`. - `f` < Currency >: The asset being traded, using the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) standard. -- `s` < Status >: `pending`, `canceled`, `in-progress`, `success`. +- `s` < Status >: `pending`, `canceled`, `in-progress`, `success`, `expired`. - `amt` < Amount >: The amount of Bitcoin to be traded, the amount is defined in satoshis, if `0` means that the amount of satoshis will be obtained from a public API after the taker accepts the order. - `fa` < Fiat amount >: The fiat amount being traded, for range orders two values are expected, the minimum and maximum amount. - `pm` < Payment method >: The payment method used for the trade, if the order has multiple payment methods, they should be separated by a comma. @@ -67,7 +68,8 @@ Events are [addressable events](01.md#kinds) and use `38383` as event kind, a p2 - `name` [Name]: The name of the maker. - `g` [Geohash]: The geohash of the operation, it can be useful in a face to face trade. - `bond` [Bond]: The bond amount, the bond is a security deposit that both parties must pay. -- `expiration` < Expiration\>: The expiration date of the order ([NIP-40](40.md)). +- `expires_at` < Expires At\>: The expiration date of the event being published in `pending` status, after this time the event status SHOULD be changed to `expired`. +- `expiration` < Expiration\>: The expiration date of the event, after this time the relay SHOULD delete it ([NIP-40](40.md)). - `y` < Platform >: The platform that created the order. - `z` < Document >: `order`. From d8e57865d7869a35567fbb332f19d0c13a36aaa9 Mon Sep 17 00:00:00 2001 From: AsaiToshiya <to.asai.60@gmail.com> Date: Sat, 15 Nov 2025 05:27:17 +0900 Subject: [PATCH 524/587] add NIP-BE to README. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index ccae3aa0..fd498ce5 100644 --- a/README.md +++ b/README.md @@ -105,6 +105,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-A0: Voice Messages](A0.md) - [NIP-B0: Web Bookmarks](B0.md) - [NIP-B7: Blossom](B7.md) +- [NIP-BE: Nostr BLE Communications Protocol](BE.md) - [NIP-C0: Code Snippets](C0.md) - [NIP-C7: Chats](C7.md) - [NIP-EE: E2EE Messaging using MLS Protocol](EE.md) From c45f504537326121a2cf8d6fd7d6558185c4e98d Mon Sep 17 00:00:00 2001 From: hodlbod <jstaab@protonmail.com> Date: Mon, 17 Nov 2025 10:50:04 -0800 Subject: [PATCH 525/587] Add self to NIP 11 (#1764) Co-authored-by: Jon Staab <shtaab@gmail.com> --- 11.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/11.md b/11.md index 5c3b9dab..04978838 100644 --- a/11.md +++ b/11.md @@ -17,6 +17,7 @@ When a relay receives an HTTP(s) request with an `Accept` header of `application "banner": <a link to an image (e.g. in .jpg, or .png format)>, "icon": <a link to an icon (e.g. in .jpg, or .png format>, "pubkey": <administrative contact pubkey>, + "self": <relay's own pubkey>, "contact": <administrative alternate contact>, "supported_nips": <a list of NIP numbers supported by the relay>, "software": <string identifying relay software URL>, @@ -60,6 +61,10 @@ An administrative contact may be listed with a `pubkey`, in the same format as N Relay operators have no obligation to respond to direct messages. +### Self + +A relay MAY maintain an identity independent from its administrator using the `self` field, which MUST be a 32-byte hex public key. This allows relays to respond to requests with events published either in advance or on demand by their own key. + ### Contact An alternative contact may be listed under the `contact` field as well, with the same purpose as `pubkey`. Use of a Nostr public key and direct message SHOULD be preferred over this. Contents of this field SHOULD be a URI, using schemes such as `mailto` or `https` to provide users with a means of contact. From e0a2980d7a5709c0d6de242f0dfa6ae15bb87332 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Fri, 21 Nov 2025 05:11:35 -0500 Subject: [PATCH 526/587] NIP-59: Adds GiftWrap deletion requests (#2131) --- 59.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/59.md b/59.md index 6abf1cd4..680250b4 100644 --- a/59.md +++ b/59.md @@ -99,6 +99,8 @@ AUTH, and refuse to serve wrapped events to non-recipients. When adding expiration tags to both `seal` and `gift wrap` layers, implementations SHOULD use independent random timestamps for each layer. Using different `created_at` values increases timing variance and helps protect against metadata correlation attacks. +Since signing keys are random, relays SHOULD delete `kind 1059` events whose p-tag matches the signer of +[NIP-09](09.md) deletions or [NIP-62](62.md) vanish requests. ## An Example From 844c6fe15c07362d56233192dc3a49b66a709166 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Fri, 21 Nov 2025 18:04:54 -0500 Subject: [PATCH 527/587] NIP-51: Removes hashtags and `r` tags from bookmarks (#2133) --- 51.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/51.md b/51.md index a7a16288..b1e0960d 100644 --- a/51.md +++ b/51.md @@ -52,7 +52,7 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti | --- | --- | --- | --- | | Follow sets | 30000 | categorized groups of users a client may choose to check out in different circumstances | `"p"` (pubkeys) | | Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during various operations | `"relay"` (relay URLs) | -| 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) | +| Bookmark sets | 30003 | user-defined bookmarks categories , for when bookmarks must be in labeled separate groups | `"e"` (kind:1 notes), `"a"` (kind:30023 articles) | | 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) | | Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"e"` (kind:21 videos) | | Kind mute sets | 30007 | mute pubkeys by kinds<br>`"d"` tag MUST be the kind string | `"p"` (pubkeys) | From 2a33cceff6cbea14006791a4b2342391fd1db0be Mon Sep 17 00:00:00 2001 From: Valentino Giudice <valentino.giudice96@gmail.com> Date: Wed, 26 Nov 2025 13:05:45 +0100 Subject: [PATCH 528/587] Improve NIP-C0 (#2138) --- C0.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/C0.md b/C0.md index c88e1455..dcb72c6b 100644 --- a/C0.md +++ b/C0.md @@ -23,9 +23,9 @@ The `.content` field contains the actual code snippet text. - `extension` - File extension (without the dot). Examples: "js", "py", "rs" - `description` - Brief description of what the code does - `runtime` - Runtime or environment specification (e.g., "node v18.15.0", "python 3.11") -- `license` - License under which the code is shared (e.g., "MIT", "GPL-3.0", "Apache-2.0") +- `license` - License under which the code (along with any related data contained within the event, when available, such as the description) is shared. This MUST be a standard [SPDX](https://spdx.org/licenses/) short identifier (e.g., "MIT", "GPL-3.0-or-later", "Apache-2.0") when available. An additional parameter containing a reference to the actual text of the license MAY be provided. This tag can be repeated, to indicate multi-licensing, allowing recipients to use the code under any license of choosing among the referenced ones - `dep` - Dependency required for the code to run (can be repeated) -- `repo` - Reference to a repository where this code originates +- `repo` - Reference to a repository where this code originates. This MUST be a either standard URL or, alternatively, the address of a [NIP-34](34.md) Git repository annoucement event in the form `"30617:<32-bytes hex a pubkey>:<d tag value>"`. If a repository announcement is referenced, a recommended relay URL where to find the event should be provided as an additional parameter ## Format From a4dadca077645dcb3ceddc11dbe4982ce52196bc Mon Sep 17 00:00:00 2001 From: Cody Tseng <codytseng98@gmail.com> Date: Tue, 2 Dec 2025 09:07:37 +0800 Subject: [PATCH 529/587] Improve generic reposts for replaceable events (#2132) --- 18.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/18.md b/18.md index 7967a59c..0dead37e 100644 --- a/18.md +++ b/18.md @@ -1,8 +1,6 @@ -NIP-18 -====== +# NIP-18 -Reposts -------- +## Reposts `draft` `optional` @@ -21,9 +19,9 @@ reposted. ## Quote Reposts -Mentions to [NIP-21](21.md) entities like `nevent`, `note` and `naddr` on any -event must be converted into `q` tags. The `q` tag ensures quote reposts are -not pulled and included as replies in threads. It also allows you to easily +Mentions to [NIP-21](21.md) entities like `nevent`, `note` and `naddr` on any +event must be converted into `q` tags. The `q` tag ensures quote reposts are +not pulled and included as replies in threads. It also allows you to easily pull and count all of the quotes for a post. The syntax follows `["q", "<event-id> or <event-address>", "<relay-url>", "<pubkey-if-a-regular-event>"]` @@ -36,3 +34,10 @@ as a "generic repost", that can include any kind of event inside other than `kind 16` reposts SHOULD contain a `"k"` tag with the stringified kind number of the reposted event as its value. + +When reposting a replaceable event, the repost SHOULD include an `"a"` tag with +the event coordinate (`kind:pubkey:d-tag`) of the reposted event. + +If the `"a"` tag is not present, it indicates that a specific version of a replaceable +event is being reposted, in which case the `content` field must contain the full +JSON string of the reposted event. From f310614122866297d1e9438b37e327f0189410e8 Mon Sep 17 00:00:00 2001 From: KotlinGeekDev <29070932+KotlinGeekDev@users.noreply.github.com> Date: Tue, 2 Dec 2025 01:12:23 +0000 Subject: [PATCH 530/587] Complete removal of hashtag and url tags from bookmarks. (#2141) --- 51.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/51.md b/51.md index b1e0960d..dd2bb3f1 100644 --- a/51.md +++ b/51.md @@ -26,7 +26,7 @@ For example, _mute list_ can contain the public keys of spammers and bad actors | Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags), `"word"` (lowercase string), `"e"` (threads) | | Pinned notes | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | | Read/write relays | 10002 | where a user publishes to and where they expect mentions | see [NIP-65](65.md) | -| Bookmarks | 10003 | uncategorized, "global" list of things a user wants to save | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) | +| Bookmarks | 10003 | uncategorized, "global" list of things a user wants to save | `"e"` (kind:1 notes), `"a"` (kind:30023 articles) | | Communities | 10004 | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) | | Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) | | Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) | From 97d3531c44bf2e0869855fc95f6421da75016372 Mon Sep 17 00:00:00 2001 From: Awiteb <a@4rs.nl> Date: Wed, 3 Dec 2025 18:59:58 +0300 Subject: [PATCH 531/587] update NIP-18 headings (#2144) --- 18.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/18.md b/18.md index 0dead37e..3b94df86 100644 --- a/18.md +++ b/18.md @@ -1,6 +1,8 @@ -# NIP-18 +NIP-18 +====== -## Reposts +Reposts +------- `draft` `optional` From a6db7917f250a9727a6a0380f80d74cd26e92eaa Mon Sep 17 00:00:00 2001 From: Awiteb <a@4rs.nl> Date: Wed, 3 Dec 2025 19:35:23 +0300 Subject: [PATCH 532/587] Update NIP-EE header formatting (#2145) --- EE.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/EE.md b/EE.md index 090fa29f..f84f47de 100644 --- a/EE.md +++ b/EE.md @@ -1,6 +1,8 @@ -# NIP-EE +NIP-EE +====== -## E2EE Messaging using the Messaging Layer Security (MLS) Protocol +E2EE Messaging using the Messaging Layer Security (MLS) Protocol +---------------------------------------------------------------- `draft` `optional` From 5d64d57fc54b4765eaeb131010135e39461bfe09 Mon Sep 17 00:00:00 2001 From: mattn <mattn.jp@gmail.com> Date: Mon, 8 Dec 2025 19:59:59 +0900 Subject: [PATCH 533/587] fix typos (#2152) --- 58.md | 2 +- C0.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/58.md b/58.md index 23921bdd..00119977 100644 --- a/58.md +++ b/58.md @@ -11,7 +11,7 @@ user profiles: 1. 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. -2. 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. +2. 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-transferable. 3. A "Profile Badges" event is defined as an _addressable event_ with kind `30008` with a `d` tag with the value `profile_badges`. Profile 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. diff --git a/C0.md b/C0.md index dcb72c6b..65381871 100644 --- a/C0.md +++ b/C0.md @@ -25,7 +25,7 @@ The `.content` field contains the actual code snippet text. - `runtime` - Runtime or environment specification (e.g., "node v18.15.0", "python 3.11") - `license` - License under which the code (along with any related data contained within the event, when available, such as the description) is shared. This MUST be a standard [SPDX](https://spdx.org/licenses/) short identifier (e.g., "MIT", "GPL-3.0-or-later", "Apache-2.0") when available. An additional parameter containing a reference to the actual text of the license MAY be provided. This tag can be repeated, to indicate multi-licensing, allowing recipients to use the code under any license of choosing among the referenced ones - `dep` - Dependency required for the code to run (can be repeated) -- `repo` - Reference to a repository where this code originates. This MUST be a either standard URL or, alternatively, the address of a [NIP-34](34.md) Git repository annoucement event in the form `"30617:<32-bytes hex a pubkey>:<d tag value>"`. If a repository announcement is referenced, a recommended relay URL where to find the event should be provided as an additional parameter +- `repo` - Reference to a repository where this code originates. This MUST be a either standard URL or, alternatively, the address of a [NIP-34](34.md) Git repository announcement event in the form `"30617:<32-bytes hex a pubkey>:<d tag value>"`. If a repository announcement is referenced, a recommended relay URL where to find the event should be provided as an additional parameter ## Format From 247205a155e5fd5e8ca39f4b3e7b76796ea6a8a6 Mon Sep 17 00:00:00 2001 From: JeffG <202880+erskingardner@users.noreply.github.com> Date: Thu, 11 Dec 2025 15:54:19 +0100 Subject: [PATCH 534/587] Replace NIP-EE with Marmot (#2154) --- EE.md | 4 +++- README.md | 18 ++++++++++-------- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/EE.md b/EE.md index f84f47de..dacb152b 100644 --- a/EE.md +++ b/EE.md @@ -1,10 +1,12 @@ +> __Warning__ `unrecommended`: superseded by the [Marmot Protocol](https://github.com/marmot-protocol/marmot) + NIP-EE ====== E2EE Messaging using the Messaging Layer Security (MLS) Protocol ---------------------------------------------------------------- -`draft` `optional` +`final` `unrecommended` `optional` This NIP standardizes how to use the [MLS Protocol](https://www.rfc-editor.org/rfc/rfc9420.html) with Nostr for efficient and E2EE (end-to-end encrypted) direct and group messaging. diff --git a/README.md b/README.md index fd498ce5..fb5a5e4c 100644 --- a/README.md +++ b/README.md @@ -108,7 +108,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-BE: Nostr BLE Communications Protocol](BE.md) - [NIP-C0: Code Snippets](C0.md) - [NIP-C7: Chats](C7.md) -- [NIP-EE: E2EE Messaging using MLS Protocol](EE.md) +- [NIP-EE: E2EE Messaging using MLS Protocol](EE.md) --- **unrecommended**: superseded by the [Marmot Protocol](https://github.com/marmot-protocol/marmot) ## Event Kinds | kind | description | NIP | @@ -135,9 +135,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `21` | Video Event | [71](71.md) | | `22` | Short-form Portrait Video Event | [71](71.md) | | `30` | internal reference | [NKBIP-03] | -| `31` | external web reference | [NKBIP-03] | -| `32` | hardcopy reference | [NKBIP-03] | -| `33` | prompt reference | [NKBIP-03] | +| `31` | external web reference | [NKBIP-03] | +| `32` | hardcopy reference | [NKBIP-03] | +| `33` | prompt reference | [NKBIP-03] | | `40` | Channel Creation | [28](28.md) | | `41` | Channel Metadata | [28](28.md) | | `42` | Channel Message | [28](28.md) | @@ -145,9 +145,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `44` | Channel Mute User | [28](28.md) | | `62` | Request to Vanish | [62](62.md) | | `64` | Chess (PGN) | [64](64.md) | -| `443` | KeyPackage | [EE](EE.md) | -| `444` | Welcome Message | [EE](EE.md) | -| `445` | Group Event | [EE](EE.md) | +| `443` | KeyPackage | [Marmot](marmot) | +| `444` | Welcome Message | [Marmot](marmot) | +| `445` | Group Event | [Marmot](marmot) | | `818` | Merge Requests | [54](54.md) | | `1018` | Poll Response | [88](88.md) | | `1021` | Bid | [15](15.md) | @@ -209,7 +209,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10020` | Media follows | [51](51.md) | | `10030` | User emoji list | [51](51.md) | | `10050` | Relay list to receive DMs | [51](51.md), [17](17.md) | -| `10051` | KeyPackage Relays List | [EE](EE.md) | +| `10051` | KeyPackage Relays List | [Marmot](marmot) | | `10063` | User server list | [Blossom][blossom] | | `10096` | File storage server list | [96](96.md) (deprecated) | | `10166` | Relay Monitor Announcement | [66](66.md) | @@ -296,6 +296,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos [Tidal-nostr]: https://wikistr.com/tidal-nostr [geocaching]: https://nostrhub.io/naddr1qvzqqqrcvypzppscgyy746fhmrt0nq955z6xmf80pkvrat0yq0hpknqtd00z8z68qqgkwet0vdskx6rfdenj6etkv4h8guc6gs5y5 [nostr-epoxy]: https://github.com/Origami74/nostr-epoxy-reverse-proxy +[marmot]: https://github.com/marmot-protocol/marmot + ## Message types From 19f7d6652601ca32a9960d30e1954f9e3b0476b1 Mon Sep 17 00:00:00 2001 From: Henrique Albuquerque <18596542+henrialb@users.noreply.github.com> Date: Sat, 13 Dec 2025 13:49:19 +0100 Subject: [PATCH 535/587] Fix typo (#2158) --- 52.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/52.md b/52.md index 133e3b36..0b69007c 100644 --- a/52.md +++ b/52.md @@ -56,7 +56,7 @@ Example: ```yaml { - "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, + "id": <32-bytes lowercase hex-encoded SHA-256 of the serialized event data>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, "created_at": <unix timestamp in seconds>, "kind": 31922, From 862c7c0fe971c3754115fcac92a5dcc99845f67a Mon Sep 17 00:00:00 2001 From: Vic <88121568+vicariousdrama@users.noreply.github.com> Date: Tue, 16 Dec 2025 16:47:05 +0000 Subject: [PATCH 536/587] Update README.md (#2162) --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index fb5a5e4c..09ff7242 100644 --- a/README.md +++ b/README.md @@ -218,6 +218,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `11111` | Transport Method Announcement | [Nostr Epoxy][nostr-epoxy] | | `13194` | Wallet Info | [47](47.md) | | `13534` | Membership Lists | [43](43.md) | +| `14388` | User Sound Effect Lists | [Corny Chat][cornychat-usersoundlist] | | `17375` | Cashu Wallet Event | [60](60.md) | | `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | | `22242` | Client Authentication | [42](42.md) | @@ -273,6 +274,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | | `32267` | Software Application | | +| `32388` | User Room Favorites | [Corny Chat][cornychat-roomfavorites] | +| `33388` | High Scores | [Corny Chat][cornychat-highscores] | +| `34388` | Sound Effects | [Corny Chat][cornychat-soundeffects] | | `34550` | Community Definition | [72](72.md) | | `38172` | Cashu Mint Announcement | [87](87.md) | | `38173` | Fedimint Announcement | [87](87.md) | @@ -286,8 +290,12 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos [NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/ [nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md [lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md +[cornychat-usersoundlist]: https://cornychat.com/datatypes#kind14388usersoundeffectslist [cornychat-slideset]: https://cornychat.com/datatypes#kind30388slideset [cornychat-linkset]: https://cornychat.com/datatypes#kind31388linkset +[cornychat-roomfavorites]: https://cornychat.com/datatypes#kind32388roomfavorites +[cornychat-highscores]: https://cornychat.com/datatypes#kind33388highscores +[cornychat-soundeffects]: https://cornychat.com/datatypes#kind34388soundeffectsets [joinstr]: https://gitlab.com/1440000bytes/joinstr/-/blob/main/NIP.md [NKBIP-01]: https://wikistr.com/nkbip-01*fd208ee8c8f283780a9552896e4823cc9dc6bfd442063889577106940fd927c1 [NKBIP-02]: https://wikistr.com/nkbip-02*fd208ee8c8f283780a9552896e4823cc9dc6bfd442063889577106940fd927c1 @@ -390,6 +398,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `repo` | Reference to the origin repository | -- | [C0](C0.md) | | `runtime` | Runtime or environment specification | -- | [C0](C0.md) | | `server` | file storage server url | -- | [96](96.md) | +| `sound` | shortcode, sound url, image url | -- | [51](51.md) | | `subject` | subject | -- | [14](14.md), [17](17.md), [34](34.md) | | `summary` | summary | -- | [23](23.md), [52](52.md) | | `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | From 7cafdbb0cf115db81c6edd5a4846921085108ff7 Mon Sep 17 00:00:00 2001 From: greenart7c3 <115044884+greenart7c3@users.noreply.github.com> Date: Thu, 18 Dec 2025 10:18:54 -0300 Subject: [PATCH 537/587] NIP-55: Try to explain how to correctly initiate a connection (#2166) --- 55.md | 34 +++++++--------------------------- 1 file changed, 7 insertions(+), 27 deletions(-) diff --git a/55.md b/55.md index 19d5ea98..218af354 100644 --- a/55.md +++ b/55.md @@ -107,6 +107,13 @@ Send the Intent: launcher.launch(intent) ``` +### Initiating a connection + +- Client send a get_public_key `Intent` +- Signer responds with the user `pubkey` and it's `packageName` +- Client saves the `pubkey` and `packageName` somewhere and NEVER calls `get_public_key` again +- Client now can send `content resolvers` and `Intents` for the other methods + #### Methods - **get_public_key** @@ -299,33 +306,6 @@ Clients SHOULD save the user pubkey locally and avoid calling the `get_public_ke #### Methods -- **get_public_key** - - params: - - ```kotlin - val result = context.contentResolver.query( - Uri.parse("content://com.example.signer.GET_PUBLIC_KEY"), - listOf(hex_pub_key), - null, - null, - null - ) - ``` - - result: - - Will return the **pubkey** in the result column - - ```kotlin - if (result == null) return - - if (it.getColumnIndex("rejected") > -1) return - - if (result.moveToFirst()) { - val index = it.getColumnIndex("result") - if (index < 0) return - val pubkey = it.getString(index) - } - ``` - - **sign_event** - params: From 65a827dab317181760f6d1812b0cc17020b8c97b Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Thu, 18 Dec 2025 21:30:04 -0500 Subject: [PATCH 538/587] Public Messages (#1988) --- A4.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 A4.md diff --git a/A4.md b/A4.md new file mode 100644 index 00000000..36751c14 --- /dev/null +++ b/A4.md @@ -0,0 +1,56 @@ +NIP-A4 +====== + +Public Messages +--------------- + +`draft` `optional` + +This NIP defines kind `24` as a simple plaintext message to one or more Nostr users. + +The `.content` contains the message. `p` tags identify one or more receivers. + +```jsonc +{ + "pubkey": "<sender-pubkey>", + "kind": 24, + "tags": [ + ["p", "<receiver>", "<relay-url>"], + ], + "content": "<message-in-plain-text>", +} +``` + +Messages MUST be sent to the [NIP-65](65.md) inbox relays of each receiver and the outbox relay of the sender. + +Kind `24` is designed to be shown and replied to from notification screens. The goal is to allow clients to +support this feature without having to worry about chat history. There are no message chains. The concept of a +"thread", a "thread root", or a "chatroom" does not exist in this system, as messages can start and continue +without any syntactic connection to each other. `e` tags must not be used. + +This kind is not designed to be displayed on feeds, but anyone can see and reply to messages that may not be for them. + +## Advanced Support + +[NIP-40](40.md) `expiration` tags are recommended. Since there is no concept of a chatroom, it is unlikely that these messages will +make sense as time goes on. + +[NIP-18](18.md) quote repost `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>"] +``` + +[NIP-25](25.md) reactions MUST add a `k` tag to `24`. + +[NIP-57](57.md) zaps MUST include the `k` tag to `24` + +[NIP-21](21.md) links that use [NIP-19](19.md)'s `nevent1` MUST include a `kind` of `24`. Links that are not `kind:24` are not expected to be rendered natively by the client. + +[NIP-92](92.md) `imeta` tags SHOULD be added for image and video links. + +## Warnings + +There MUST be no expectation of privacy in this kind. It is just a public reply, but without a root note. + +Avoid confusing this kind with Kind `14` rumors in [NIP-17](17.md) DMs. This kind is signed and designed for public consumption. From fb18d4c74f5d1054c673fa9aa1e0778f3f70c8cc Mon Sep 17 00:00:00 2001 From: hodlbod <jstaab@protonmail.com> Date: Fri, 19 Dec 2025 05:50:19 -0800 Subject: [PATCH 539/587] Clarify closed/private, add hidden to nip 29 (#2106) Co-authored-by: Jon Staab <shtaab@gmail.com> --- 29.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/29.md b/29.md index 601d63ad..9099e4da 100644 --- a/29.md +++ b/29.md @@ -83,7 +83,7 @@ Any user can send a kind `9021` event to the relay in order to request admission } ``` -The optional `code` tag may be used by the relay to preauthorize acceptances in `closed` groups, together with the `kind:9009` `create-invite` moderation event. +The optional `code` tag may be used by the relay to preauthorize acceptance, together with the `kind:9009` `create-invite` moderation event. - *leave request* (`kind:9022`) @@ -153,14 +153,18 @@ When this event is not found, clients may still connect to the group, but treat ["name", "Pizza Lovers"], ["picture", "https://pizza.com/pizza.png"], ["about", "a group for people who love pizza"], - ["public"], // or ["private"] - ["open"] // or ["closed"] + ["private"], + ["closed"] ] // other fields... } ``` -`name`, `picture` and `about` are basic metadata for the group for display purposes. `public` signals the group can be _read_ by anyone, while `private` signals that only AUTHed users can read. `open` signals that anyone can request to join and the request will be automatically granted, while `closed` signals that members must be pre-approved or that requests to join will be manually handled. +- `name`, `picture` and `about` are basic metadata for the group for display purposes. +- `private` indicates that only members can _read_ group messages. Omitting this tag indicates that anyone can read group messages. +- `restricted` indicates that only members can _write_ messages to the group. Omitting this tag indicates that anyone can send messages to the group. +- `hidden` indicates that relays should hide group metadata from non-members. Omitting this tag indicates that anyone can request group metadata events. +- `closed` indicates that join requests are ignored. Omitting this tag indicates that users can expect join requests to be honored. - *group admins* (`kind:39001`) (optional) @@ -231,7 +235,7 @@ The latest of either `kind:9000` or `kind:9001` events present in a group should ### Adding yourself to a group -When 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. +Anyone can send a `kind:9021` join request to a group. The relay may then generate a `kind:9000` event immediately, or defer that decision to an administator. If a group is `closed`, join requests are not honored unless they include an invite code. ### Storing your list of groups From 3afdad183e25ab1559f05802eaab253dbbd5ec28 Mon Sep 17 00:00:00 2001 From: SondreB <sondre@outlook.com> Date: Sun, 21 Dec 2025 16:49:43 +0100 Subject: [PATCH 540/587] Add support for picture sets in NIP-51, using kind 30006. (#2170) --- 51.md | 1 + README.md | 1 + 2 files changed, 2 insertions(+) diff --git a/51.md b/51.md index dd2bb3f1..a7df4302 100644 --- a/51.md +++ b/51.md @@ -55,6 +55,7 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti | Bookmark sets | 30003 | user-defined bookmarks categories , for when bookmarks must be in labeled separate groups | `"e"` (kind:1 notes), `"a"` (kind:30023 articles) | | 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) | | Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"e"` (kind:21 videos) | +| Curation sets | 30006 | groups of pictures picked by users as interesting and/or belonging to the same category | `"e"` (kind:20 pictures) | | Kind mute sets | 30007 | mute pubkeys by kinds<br>`"d"` tag MUST be the kind string | `"p"` (pubkeys) | | Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) | | Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | diff --git a/README.md b/README.md index 09ff7242..fa006605 100644 --- a/README.md +++ b/README.md @@ -236,6 +236,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30003` | Bookmark sets | [51](51.md) | | `30004` | Curation sets | [51](51.md) | | `30005` | Video sets | [51](51.md) | +| `30006` | Picture sets | [51](51.md) | | `30007` | Kind mute sets | [51](51.md) | | `30008` | Profile Badges | [58](58.md) | | `30009` | Badge Definition | [58](58.md) | From c1ff79f1c6c6f90f032a631d141e6ce8d39be7f2 Mon Sep 17 00:00:00 2001 From: AsaiToshiya <to.asai.60@gmail.com> Date: Mon, 22 Dec 2025 21:52:03 +0900 Subject: [PATCH 541/587] add NIP-A4 to README. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index fa006605..0f70482d 100644 --- a/README.md +++ b/README.md @@ -103,6 +103,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-98: HTTP Auth](98.md) - [NIP-99: Classified Listings](99.md) - [NIP-A0: Voice Messages](A0.md) +- [NIP-A4: Public Messages](A4.md) - [NIP-B0: Web Bookmarks](B0.md) - [NIP-B7: Blossom](B7.md) - [NIP-BE: Nostr BLE Communications Protocol](BE.md) @@ -134,6 +135,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `20` | Picture | [68](68.md) | | `21` | Video Event | [71](71.md) | | `22` | Short-form Portrait Video Event | [71](71.md) | +| `24` | Public Message | [A4](A4.md) | | `30` | internal reference | [NKBIP-03] | | `31` | external web reference | [NKBIP-03] | | `32` | hardcopy reference | [NKBIP-03] | From f5a15ea27e06ce8f5635117931f06318f532a713 Mon Sep 17 00:00:00 2001 From: mattn <mattn.jp@gmail.com> Date: Wed, 24 Dec 2025 02:53:38 +0900 Subject: [PATCH 542/587] add relay tag (#2173) --- 01.md | 2 +- 04.md | 2 +- 09.md | 2 +- 11.md | 2 +- 13.md | 2 +- 17.md | 2 +- 26.md | 2 +- 29.md | 2 +- 40.md | 2 +- 42.md | 2 +- 43.md | 2 +- 45.md | 2 +- 46.md | 2 +- 50.md | 2 +- 59.md | 2 +- 62.md | 2 +- 66.md | 2 +- 70.md | 2 +- 77.md | 2 +- 19 files changed, 19 insertions(+), 19 deletions(-) diff --git a/01.md b/01.md index 1f564274..eb9f60c1 100644 --- a/01.md +++ b/01.md @@ -4,7 +4,7 @@ NIP-01 Basic protocol flow description ------------------------------- -`draft` `mandatory` +`draft` `mandatory` `relay` This NIP defines the basic protocol that should be implemented by everybody. New NIPs may add new optional (or mandatory) fields and messages and features to the structures and flows described here. diff --git a/04.md b/04.md index a561a2f8..107d872b 100644 --- a/04.md +++ b/04.md @@ -6,7 +6,7 @@ NIP-04 Encrypted Direct Message ------------------------ -`final` `unrecommended` `optional` +`final` `unrecommended` `optional` `relay` A special event with kind `4`, meaning "encrypted direct message". It is supposed to have the following attributes: diff --git a/09.md b/09.md index 23ffeab1..f061464c 100644 --- a/09.md +++ b/09.md @@ -4,7 +4,7 @@ NIP-09 Event Deletion Request ---------------------- -`draft` `optional` +`draft` `optional` `relay` A 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. diff --git a/11.md b/11.md index 04978838..26b5c263 100644 --- a/11.md +++ b/11.md @@ -4,7 +4,7 @@ NIP-11 Relay Information Document -------------------------- -`draft` `optional` +`draft` `optional` `relay` Relays may provide server metadata to clients to inform them of capabilities, administrative contacts, and various server attributes. This is made available as a JSON document over HTTP, on the same URI as the relay's websocket. diff --git a/13.md b/13.md index cf5b1acd..d7e7725e 100644 --- a/13.md +++ b/13.md @@ -4,7 +4,7 @@ NIP-13 Proof of Work ------------- -`draft` `optional` +`draft` `optional` `relay` This NIP defines a way to generate and interpret Proof of Work for nostr notes. Proof of Work (PoW) is a way to add a proof of computational work to a note. This is a bearer proof that all relays and clients can universally validate with a small amount of code. This proof can be used as a means of spam deterrence. diff --git a/17.md b/17.md index 900b6dd7..3ccdc772 100644 --- a/17.md +++ b/17.md @@ -4,7 +4,7 @@ NIP-17 Private Direct Messages ----------------------- -`draft` `optional` +`draft` `optional` `relay` This NIP defines an encrypted chat scheme which uses [NIP-44](44.md) encryption and [NIP-59](59.md) seals and gift wraps. diff --git a/26.md b/26.md index 645ec441..6cd32f4c 100644 --- a/26.md +++ b/26.md @@ -6,7 +6,7 @@ NIP-26 Delegated Event Signing ----------------------- -`draft` `optional` +`draft` `optional` `relay` This NIP defines how events can be delegated so that they can be signed by other keypairs. diff --git a/29.md b/29.md index 9099e4da..a1f035e0 100644 --- a/29.md +++ b/29.md @@ -4,7 +4,7 @@ NIP-29 Relay-based Groups ------------------ -`draft` `optional` +`draft` `optional` `relay` This NIP defines a standard for groups that are only writable by a closed set of users. They can be public for reading by external users or not. diff --git a/40.md b/40.md index 909747f5..9450b3c4 100644 --- a/40.md +++ b/40.md @@ -4,7 +4,7 @@ NIP-40 Expiration Timestamp -------------------- -`draft` `optional` +`draft` `optional` `relay` The `expiration` tag enables users to specify a unix timestamp at which the message SHOULD be considered expired (by relays and clients) and SHOULD be deleted by relays. diff --git a/42.md b/42.md index 24f7f5d9..c2b6ded0 100644 --- a/42.md +++ b/42.md @@ -4,7 +4,7 @@ NIP-42 Authentication of clients to relays ----------------------------------- -`draft` `optional` +`draft` `optional` `relay` This NIP defines a way for clients to authenticate to relays by signing an ephemeral event. diff --git a/43.md b/43.md index 6455c08f..d0742b47 100644 --- a/43.md +++ b/43.md @@ -4,7 +4,7 @@ NIP-43 Relay Access Metadata and Requests ---------------------------------- -`draft` `optional` +`draft` `optional` `relay` This NIP defines a way for relays to advertise membership lists, and for clients to request admission to relays on behalf of users. diff --git a/45.md b/45.md index 8758c873..14d656ec 100644 --- a/45.md +++ b/45.md @@ -4,7 +4,7 @@ NIP-45 Event Counts ------------ -`draft` `optional` +`draft` `optional` `relay` Relays may support the verb `COUNT`, which provides a mechanism for obtaining event counts. diff --git a/46.md b/46.md index 17019649..e951b5b8 100644 --- a/46.md +++ b/46.md @@ -41,7 +41,7 @@ There are two ways to initiate a connection: _remote-signer_ provides connection token in the form: -``` + `relay` bunker://<remote-signer-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value> ``` diff --git a/50.md b/50.md index 9eea1f85..08ce4fd2 100644 --- a/50.md +++ b/50.md @@ -4,7 +4,7 @@ NIP-50 Search Capability ----------------- -`draft` `optional` +`draft` `optional` `relay` ## Abstract diff --git a/59.md b/59.md index 680250b4..e5701510 100644 --- a/59.md +++ b/59.md @@ -4,7 +4,7 @@ NIP-59 Gift Wrap --------- -`optional` +`optional` `relay` This NIP defines a protocol for encapsulating any nostr event. This makes it possible to obscure most metadata for a given event, perform collaborative signing, and more. diff --git a/62.md b/62.md index a00ddfc0..e0398d8c 100644 --- a/62.md +++ b/62.md @@ -4,7 +4,7 @@ NIP-62 Request to Vanish ----------------- -`draft` `optional` +`draft` `optional` `relay` This NIP offers a Nostr-native way to request a complete reset of a key's fingerprint on the web. This procedure is legally binding in some jurisdictions, and thus, supporters of this NIP should truly delete events from their database. diff --git a/66.md b/66.md index 59ac1a2e..89f5a5fa 100644 --- a/66.md +++ b/66.md @@ -4,7 +4,7 @@ NIP-66 Relay Discovery and Liveness Monitoring ------------------- -`draft` `optional` +`draft` `optional` `relay` This NIP defines events for relay discovery and the announcement of relay monitors. diff --git a/70.md b/70.md index 043d5fbf..32853d37 100644 --- a/70.md +++ b/70.md @@ -4,7 +4,7 @@ NIP-70 Protected Events ---------------- -`draft` `optional` +`draft` `optional` `relay` When the `"-"` tag is present, that means the event is "protected". diff --git a/77.md b/77.md index dd5ef070..ff4eba73 100644 --- a/77.md +++ b/77.md @@ -4,7 +4,7 @@ NIP-77 Negentropy Syncing ------------------ -`draft` `optional` +`draft` `optional` `relay` This document describes a protocol extension for syncing events. It works for both client-relay and relay-relay scenarios. If both sides of the sync have events in common, then this protocol will use less bandwidth than transferring the full set of events (or even just their IDs). From fa9281af8b7c964542dd1145ba61a9fd851af713 Mon Sep 17 00:00:00 2001 From: Vincenzo Imperati <61617279+VincenzoImp@users.noreply.github.com> Date: Sat, 27 Dec 2025 18:04:08 +0100 Subject: [PATCH 543/587] NIP-54: Fix d-tag normalization for non-Latin scripts (#2177) --- 54.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/54.md b/54.md index b23e8bd9..59c49b30 100644 --- a/54.md +++ b/54.md @@ -8,7 +8,7 @@ Wiki This 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. -Articles are identified by lowercase, normalized ascii `d` tags. +Articles are identified by lowercase, normalized `d` tags. ## Articles ```json @@ -16,15 +16,30 @@ Articles are identified by lowercase, normalized ascii `d` tags. "content": "A wiki is a hypertext publication collaboratively edited and managed by its own audience.", "tags": [ ["d", "wiki"], - ["title", "Wiki"], + ["title", "Wiki"] ] } ``` ## `d` tag normalization rules -- Any non-letter character MUST be converted to a `-`. -- All letters MUST be converted to lowercase. +- All letters with uppercase/lowercase variants MUST be converted to lowercase. +- Whitespace MUST be converted to `-`. +- Punctuation and symbols SHOULD be removed. +- Multiple consecutive `-` SHOULD be collapsed to a single `-`. +- Leading and trailing `-` SHOULD be removed. +- Non-ASCII letters (e.g., Japanese, Chinese, Arabic, Cyrillic) MUST be preserved as UTF-8. +- Numbers MUST be preserved. + +For example: +- `"Wiki Article"` → `"wiki-article"` +- `"What's Up?"` → `"whats-up"` +- `" Hello World "` → `"hello-world"` +- `"Article 1"` → `"article-1"` +- `"ウィキペディア"` → `"ウィキペディア"` (Japanese, no case change) +- `"Ñoño"` → `"ñoño"` (Spanish, lowercased) +- `"Москва"` → `"москва"` (Russian, lowercased) +- `"日本語 Article"` → `"日本語-article"` (mixed scripts) ## Content @@ -32,10 +47,11 @@ The `content` should be Asciidoc with two extra functionalities: **wikilinks** a Unlike 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. -Wikilinks can take these two forms: +Wikilinks can take these forms: - 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`; - 2. `[[target page|see this]]` -- in this case it will link to the page `target-page`, but will be displayed as `see this`. + 1. `[[Target Page]]` -- links to `target-page` and displays as `Target Page`; + 2. `[[target page|see this]]` -- links to `target-page` but displays as `see this`; + 3. `[[日本語 Topic|Japanese Topic]]` -- links to `日本語-topic` and displays as `Japanese Topic`. `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. From aa30111d2f73f2f6f503b720b2bbf05299dcf141 Mon Sep 17 00:00:00 2001 From: mattn <mattn.jp@gmail.com> Date: Mon, 29 Dec 2025 21:53:31 +0900 Subject: [PATCH 544/587] fix last wrong commit (#2181) --- 46.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/46.md b/46.md index e951b5b8..17019649 100644 --- a/46.md +++ b/46.md @@ -41,7 +41,7 @@ There are two ways to initiate a connection: _remote-signer_ provides connection token in the form: - `relay` +``` bunker://<remote-signer-pubkey>?relay=<wss://relay-to-connect-on>&relay=<wss://another-relay-to-connect-on>&secret=<optional-secret-value> ``` From 2f71cf74ae3e9bc78d4b599d8ba350cb8df95921 Mon Sep 17 00:00:00 2001 From: Vincenzo Imperati <61617279+VincenzoImp@users.noreply.github.com> Date: Tue, 30 Dec 2025 19:04:37 +0100 Subject: [PATCH 545/587] Fix typos and broken links across multiple NIPs (#2178) --- 46.md | 2 +- 66.md | 2 +- 71.md | 2 +- 72.md | 2 +- 88.md | 2 +- 90.md | 2 +- C0.md | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/46.md b/46.md index 17019649..af34b19d 100644 --- a/46.md +++ b/46.md @@ -204,7 +204,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: +_remote-signer_ MAY publish its 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":{ diff --git a/66.md b/66.md index 89f5a5fa..9b467912 100644 --- a/66.md +++ b/66.md @@ -67,7 +67,7 @@ Tags include: - `frequency` - The frequency in seconds at which the monitor publishes events. - `timeout` (optional) - The timeout values for various checks conducted by a monitor. Index `1` is the monitor's timeout in milliseconds. Index `2` describes what test the timeout is used for. If no index `2` is provided, it is inferred that the timeout provided applies to all tests. - `c` - a lowercase string describing the checks conducted by a monitor. Examples include `open`, `read`, `write`, `auth`, `nip11`, `dns`, and `geo`. -- `g` - [NIP-52](https://github.com/nostr-protocol/nips/blob/master/11.md) geohash tag +- `g` - [NIP-52](https://github.com/nostr-protocol/nips/blob/master/52.md) geohash tag Monitors SHOULD also publish a `kind 0` profile and a `kind 10002` relay selections event. diff --git a/71.md b/71.md index 303ec5a3..3068e7ad 100644 --- a/71.md +++ b/71.md @@ -26,7 +26,7 @@ The primary source of video information is the `imeta` tags which is defined in Each `imeta` tag can be used to specify a variant of the video by the `dim` & `m` properties. -This NIP defines the following additional `imeta` properties aside form those listen in [NIP-92](92.md) & [NIP-94](94.md): +This NIP defines the following additional `imeta` properties aside from those listed in [NIP-92](92.md) & [NIP-94](94.md): * `duration` (recommended) the duration of the video/audio in seconds (floating point number) * `bitrate` (recommended) the average bitrate of the video/audio in bits/sec diff --git a/72.md b/72.md index 9471cdb0..210376ec 100644 --- a/72.md +++ b/72.md @@ -41,7 +41,7 @@ The goal of this NIP is to enable public communities. It defines the replaceable ## Posting to a community -[NIP-22](NIP-22) kind 1111 events SHOULD be used for text notes posted to a community, with the `A` tag always scoped to the community definition. +[NIP-22](22.md) kind 1111 events SHOULD be used for text notes posted to a community, with the `A` tag always scoped to the community definition. ### Top-level posts diff --git a/88.md b/88.md index 331cd271..9971623f 100644 --- a/88.md +++ b/88.md @@ -48,7 +48,7 @@ Example Event The response event is a `kind:1018` event. It contains an e tag with the poll event it is referencing, followed by one or more response tags. -- **response** : The tag contains "response" as it's first positional argument followed by the option Id selected. +- **response** : The tag contains "response" as its first positional argument followed by the option Id selected. The responses are meant to be published to the relays specified in the poll event. diff --git a/90.md b/90.md index e39ce904..a33d90ab 100644 --- a/90.md +++ b/90.md @@ -58,7 +58,7 @@ All tags are optional. * `<input-type>`: The way this argument should be interpreted. MUST be one of: * `url`: A URL to be fetched of the data that should be processed. * `event`: A Nostr event ID. - * `job`: The output of a previous job with the specified event ID. The dermination of which output to build upon is up to the service provider to decide (e.g. waiting for a signaling from the customer, waiting for a payment, etc.) + * `job`: The output of a previous job with the specified event ID. The determination of which output to build upon is up to the service provider to decide (e.g. waiting for a signaling from the customer, waiting for a payment, etc.) * `text`: `<data>` is the value of the input, no resolution is needed * `<relay>`: If `event` or `job` input-type, the relay where the event/job was published, otherwise optional or empty string * `<marker>`: An optional field indicating how this input should be used within the context of the job diff --git a/C0.md b/C0.md index 65381871..de78fe87 100644 --- a/C0.md +++ b/C0.md @@ -25,7 +25,7 @@ The `.content` field contains the actual code snippet text. - `runtime` - Runtime or environment specification (e.g., "node v18.15.0", "python 3.11") - `license` - License under which the code (along with any related data contained within the event, when available, such as the description) is shared. This MUST be a standard [SPDX](https://spdx.org/licenses/) short identifier (e.g., "MIT", "GPL-3.0-or-later", "Apache-2.0") when available. An additional parameter containing a reference to the actual text of the license MAY be provided. This tag can be repeated, to indicate multi-licensing, allowing recipients to use the code under any license of choosing among the referenced ones - `dep` - Dependency required for the code to run (can be repeated) -- `repo` - Reference to a repository where this code originates. This MUST be a either standard URL or, alternatively, the address of a [NIP-34](34.md) Git repository announcement event in the form `"30617:<32-bytes hex a pubkey>:<d tag value>"`. If a repository announcement is referenced, a recommended relay URL where to find the event should be provided as an additional parameter +- `repo` - Reference to a repository where this code originates. This MUST be either a standard URL or, alternatively, the address of a [NIP-34](34.md) Git repository announcement event in the form `"30617:<32-bytes hex a pubkey>:<d tag value>"`. If a repository announcement is referenced, a recommended relay URL where to find the event should be provided as an additional parameter ## Format From d7db75fc691a5b182d133d72fb3692b57cf2aeca Mon Sep 17 00:00:00 2001 From: greenart7c3 <115044884+greenart7c3@users.noreply.github.com> Date: Mon, 5 Jan 2026 10:57:34 -0300 Subject: [PATCH 546/587] NIP-55: Fix return field from nip44_encrypt (#2184) --- 55.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/55.md b/55.md index 218af354..b4a3aec8 100644 --- a/55.md +++ b/55.md @@ -210,10 +210,10 @@ launcher.launch(intent) context.startActivity(intent) ``` - result: - - If the user approved intent it will return the **signature** and **id** fields + - If the user approved intent it will return the **result** and **id** fields ```kotlin - val encryptedText = intent.data?.getStringExtra("signature") + val encryptedText = intent.data?.getStringExtra("result") // the id you sent val id = intent.data?.getStringExtra("id") ``` From f34e98c73f47fed6778e2fc62b256f925bead065 Mon Sep 17 00:00:00 2001 From: rabble <evan@protest.net> Date: Thu, 8 Jan 2026 05:48:48 +1300 Subject: [PATCH 547/587] NIP-71: Add addressable video events (kinds 34235, 34236) (#2072) Co-authored-by: hodlbod <jstaab@protonmail.com> --- 71.md | 73 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 75 insertions(+) diff --git a/71.md b/71.md index 3068e7ad..0124edd2 100644 --- a/71.md +++ b/71.md @@ -20,6 +20,20 @@ Nothing except cavaliership and common sense prevents a _short_ video from being The format uses a _regular event_ kind `21` for _normal_ videos and `22` for _short_ videos. +## Addressable Video Events + +For content that may need updates after publication (such as correcting metadata, descriptions, or handling URL migrations), addressable versions are available: + +- Kind `34235` for _addressable normal videos_ +- Kind `34236` for _addressable short videos_ + +These addressable events follow the same format as their regular counterparts but include a `d` tag as a unique identifier and can be updated while maintaining the same addressable reference. This is particularly useful for: + +- Metadata corrections (descriptions, titles, tags) without republishing +- Preservation of imported content IDs from legacy platforms +- URL migration when hosting changes +- Platform migration tracking + The `.content` of these events is a summary or description on the video content. The primary source of video information is the `imeta` tags which is defined in [NIP-92](92.md) @@ -81,6 +95,9 @@ The `image` tag contains a preview image (at the same resolution). Multiple `ima Additionally `service nip96` may be included to allow clients to search the authors NIP-96 server list to find the file using the hash. +### Required tags for addressable events: +* `d` - Unique identifier for this video (user-chosen string, required for kinds 34235, 34236) + ### Other tags: * `title` (required) title of the video * `published_at`, for the timestamp in unix seconds (stringified) of the first time the video was published @@ -92,6 +109,9 @@ Additionally `service nip96` may be included to allow clients to search the auth * `p` (optional, repeated) 32-bytes hex pubkey of a participant in the video, optional recommended relay URL * `r` (optional, repeated) references / links to web pages +### Optional tags for imported content: +* `origin` - Track original platform and ID: `["origin", "<platform>", "<external-id>", "<original-url>", "<optional-metadata>"]` + ```jsonc { "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", @@ -135,3 +155,56 @@ Additionally `service nip96` may be included to allow clients to search the auth ] } ``` + +## Addressable Event Example + +```jsonc +{ + "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": <Unix timestamp in seconds>, + "kind": 34235 | 34236, + "content": "<summary / description of video>", + "tags": [ + ["d", "<unique-identifier>"], + ["title", "<title of video>"], + ["published_at", "<unix timestamp>"], + ["alt", "<description for accessibility>"], + + // video data + ["imeta", + "url https://example.com/media.mp4", + "m video/mp4", + "dim 480x480", + "blurhash eVF$^OI:${M{%LRjWBoLoLaeR*", + "image https://example.com/thumb.jpg", + "x 3093509d1e0bc604ff60cb9286f4cd7c781553bc8991937befaacfdc28ec5cdc" + ], + + ["duration", <duration in seconds>], + ["content-warning", "<reason>"], + + // origin tracking for imported content + ["origin", "<platform>", "<external-id>", "<original-url>", "<optional-metadata>"], + + // participants + ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], + + // hashtags + ["t", "<tag>"], + ["t", "<tag>"], + + // reference links + ["r", "<url>"] + ] +} +``` + +## Referencing Addressable Events + +To reference an addressable video: + +``` +["a", "34235:<pubkey>:<d-tag-value>", "<relay-url>"] // for normal videos +["a", "34236:<pubkey>:<d-tag-value>", "<relay-url>"] // for short videos +``` diff --git a/README.md b/README.md index 0f70482d..7d3e4f41 100644 --- a/README.md +++ b/README.md @@ -279,6 +279,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `32267` | Software Application | | | `32388` | User Room Favorites | [Corny Chat][cornychat-roomfavorites] | | `33388` | High Scores | [Corny Chat][cornychat-highscores] | +| `34235` | Addressable Video Event | [71](71.md) | +| `34236` | Addressable Short Video Event | [71](71.md) | | `34388` | Sound Effects | [Corny Chat][cornychat-soundeffects] | | `34550` | Community Definition | [72](72.md) | | `38172` | Cashu Mint Announcement | [87](87.md) | From eb252ccfc479bf1f99c273b52c678aa97084e203 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Mon, 19 Jan 2026 09:39:55 -0300 Subject: [PATCH 548/587] fix missing stuff from nip-29. --- 29.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/29.md b/29.md index a1f035e0..d612bc78 100644 --- a/29.md +++ b/29.md @@ -120,15 +120,15 @@ Clients can send these events to a relay in order to accomplish a moderation act Each moderation action uses a different kind and requires different arguments, which are given as tags. These are defined in the following table: -| kind | name | tags | -| --- | --- | --- | -| 9000 | `put-user` | `p` with pubkey hex and optional roles | -| 9001 | `remove-user` | `p` with pubkey hex | -| 9002 | `edit-metadata` | fields from `kind:39000` to be modified | -| 9005 | `delete-event` | `e` with event id hex | -| 9007 | `create-group` | | -| 9008 | `delete-group` | | -| 9009 | `create-invite` | | +| kind | name | tags | +| --- | --- | --- | +| 9000 | `put-user` | `p` with pubkey hex and optional roles | +| 9001 | `remove-user` | `p` with pubkey hex | +| 9002 | `edit-metadata` | fields to be modified, and optionally `unrestricted`, `open`, `visible` `public` | +| 9005 | `delete-event` | `e` with event id hex | +| 9007 | `create-group` | | +| 9008 | `delete-group` | | +| 9009 | `create-invite` | arbitrary `code` | It'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. From f461065c29f469b34ebd9d111d6ea9123e5292e7 Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Mon, 19 Jan 2026 09:40:17 -0300 Subject: [PATCH 549/587] nip29: clarify what the relay key means (#2190) --- 29.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/29.md b/29.md index d612bc78..85f47ca7 100644 --- a/29.md +++ b/29.md @@ -134,7 +134,7 @@ It's expected that the group state (of who is an allowed member or not, who is a ### Group metadata events -These 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). +These events contain the group id in a `d` tag instead of the `h` tag. They MUST be created by the relay master key only (as stated by the [NIP-11](11.md) `"self"` pubkey) 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). - *group metadata* (`kind:39000`) (optional) From b58a6048b12e6cbbb64250664a9e78ee85579ff0 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Thu, 22 Jan 2026 11:47:55 -0500 Subject: [PATCH 550/587] Trusted Assertions (#1534) Co-authored-by: arthurfranca <arthur.a.franca@gmail.com> --- 85.md | 132 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 132 insertions(+) create mode 100644 85.md diff --git a/85.md b/85.md new file mode 100644 index 00000000..c11ce5a4 --- /dev/null +++ b/85.md @@ -0,0 +1,132 @@ +NIP-85 +====== + +Trusted Assertions +------------------ + +`draft` `optional` + +Certain Webs of Trust calculations require access to a large volume of events and/or computing power, making it virtually impossible to perform them directly on clients. This NIP allows users to offload such calculations to declared trusted service providers, and for these providers to publish signed "Trusted Assertion" events for the user client's consumption. + +## Assertion Events + +Trusted Assertions are always addressable (replaceable) events with the `d` tag pointing to the "subject" of the assertion. This NIP currently recognizes three distinct target "subjects" on which such calculations can be performed: *pubkeys*, *regular events*, and *addressable events*. Each subject type is mapped to an event kind: + +| Subject | Event Kind | `d` tag value | +| ------------------ | -------------- | ----------------- | +| User | 30382 | `<pubkey>` | +| Event | 30383 | `<event_id>` | +| Addressable Event | 30384 | `<event_address>` | +| NIP-73 Identifier | 30385 | `<i-tag>` | + +Calculation results are saved in pre-defined tags whose syntax and semantics are agreed upon by providers and clients. + +Example of ranking a pubkey with a web of trust score of `89`: + +```jsonc +{ + "kind": 30382, + "tags": [ + ["d", "e88a691e98d9987c964521dff60025f60700378a4879180dcbbb4a5027850411"], // target user's public key + ["rank", "89"], + ], + "content": "", + //... +} +``` + +## Kind 30382: Users as Subject: + +The following result types have been declared: + +| Result type | Tag name | Tag value format | +| ----------------------- | ---------------------- | ----------------- | +| Follower Count | `followers` | int | +| User Rank | `rank` | int, norm 0-100) | +| First Post Time | `first_created_at` | unix timestamp | +| Post Count | `post_cnt` | int, | +| Reply Count | `reply_cnt` | int | +| Reactions Count | `reactions_cnt` | int | +| Zap Amount Received | `zap_amt_recd` | int, sats | +| Zap Amount Sent | `zap_amt_sent` | int, sats | +| Zap Number Received | `zap_cnt_recd` | int | +| Zap Number Sent | `zap_cnt_sent` | int | +| Avg Zap Amount/day recd | `zap_avg_amt_day_recd` | int, sats | +| Avg Zap Amount/day sent | `zap_avg_amt_day_sent` | int, sats | +| Reports Received | `reports_cnt_recd` | int | +| Reports Sent | `reports_cnt_sent` | int | +| Common Topics | `t` | string | +| Generally active start | `active_hours_start` | int, 0-24, UTC | +| Generally active end | `active_hours_end` | int, 0-24, UTC | + +Each provider can offer their own ways to calculate such values. For instance, the Follower Count of one trust provider might remove the user's muted public keys while another provider keeps them. Users can then choose how they want to see this information in their preferred client by picking a provider that aligns with their view. + +## Kind 30383: Events as Subject + +Providers can rate individual events with the following tags: + +| Result type | Tag name | Tag value format | +| ----------------------- | ---------------------- | ----------------- | +| Event Rank | `rank` | int, norm 0-100 | +| Event Comment Count | `comment_cnt` | int | +| Event Quote Count | `quote_cnt` | int | +| Event Repost Count | `repost_cnt` | int | +| Event Reaction Count | `reaction_cnt` | int | +| Event Zap Count | `zap_cnt` | int | +| Event Zap Amount | `zap_amount` | int, sats | + +## Kind 30384: Addressables as Subject + +Providers can rate all versions of addressable events using the following tags: + +| Result type | Tag name | Tag value format | +| ------------------------- | ---------------------- | ----------------- | +| Address Rank | `rank` | int, norm 0-100 | +| Address Comment Count | `comment_cnt` | int | +| Address Quote Count | `quote_cnt` | int | +| Address Repost Count | `repost_cnt` | int | +| Address Reaction Count | `reaction_cnt` | int | +| Address Zap Count | `zap_cnt` | int | +| Address Zap Amount | `zap_amount` | int, sats | + +## Kind 30385: External identifier as Subject + +Providers can rate books, locations, movies, websites, and hashtags using [NIP-73](73.md) identifiers. + +| Result type | Tag name | Tag value format | +| ----------------- | ---------------------- | ----------------- | +| Rank | `rank` | int, norm 0-100 | +| Comment Count | `comment_cnt` | int | +| Reaction Count | `reaction_cnt` | int | + +NIP-73 `k` tags should be added to the event as well. + +## Declaring Trusted Service Providers + +Kind `10040` lists the user's authorized providers for each result. Each `kind:tag` is followed by the `pubkey` of the service and the relay where the results are published. Users can specify these publicly or privately by JSON-stringifying and encrypting the tag list in the `.content` using NIP-44. + +```js +{ + "kind": 10040, + "tags": [ + ["30382:rank", "4fd5e210530e4f6b2cb083795834bfe5108324f1ed9f00ab73b9e8fcfe5f12fe", "wss://nip85.nostr.band"], + ["30382:rank", "3d842afecd5e293f28b6627933704a3fb8ce153aa91d790ab11f6a752d44a42d", "wss://nostr.wine"], + ["30382:zap_amt_sent", "4fd5e210530e4f6b2cb083795834bfe5108324f1ed9f00ab73b9e8fcfe5f12fe", "wss://nip85.nostr.band"], + ], + "content": nip44Encrypt(JSON.stringify([ + ["30383:rank", "4fd5e210530e4f6b2cb083795834bfe5108324f1ed9f00ab73b9e8fcfe5f12fe", "wss://nip85.nostr.band"], + ["30384:rank", "4fd5e210530e4f6b2cb083795834bfe5108324f1ed9f00ab73b9e8fcfe5f12fe", "wss://nip85.nostr.band"], + ]), + //... +} +``` + +If the provider offers several algorithms or multiple points of view of an algorithm, the key listed in each tag SHOULD point to the key created for each algorithm or point of view. + +## Final Considerations + +Service providers SHOULD update Trusted Assertions as fast as new information arrives, but only if the contents of each event actually change to avoid re-downloading the same information. + +Service providers MAY limit access to the results by using paid relays. + +In TAs, `p`, `e`, and `a` tags with the same value as the `d` tag MAY be used to add a relay hint to the home relay of that user or event. From d33bcbac7c05bdd529afa6aa86f703bd87f52859 Mon Sep 17 00:00:00 2001 From: AsaiToshiya <to.asai.60@gmail.com> Date: Mon, 26 Jan 2026 22:25:04 +0900 Subject: [PATCH 551/587] fix typos. --- 85.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/85.md b/85.md index c11ce5a4..5463ed16 100644 --- a/85.md +++ b/85.md @@ -42,9 +42,9 @@ The following result types have been declared: | Result type | Tag name | Tag value format | | ----------------------- | ---------------------- | ----------------- | | Follower Count | `followers` | int | -| User Rank | `rank` | int, norm 0-100) | +| User Rank | `rank` | int, norm 0-100 | | First Post Time | `first_created_at` | unix timestamp | -| Post Count | `post_cnt` | int, | +| Post Count | `post_cnt` | int | | Reply Count | `reply_cnt` | int | | Reactions Count | `reactions_cnt` | int | | Zap Amount Received | `zap_amt_recd` | int, sats | From acf74f8c2988b0f27f80d84b2c7b3b238e29c699 Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Mon, 26 Jan 2026 23:48:18 -0300 Subject: [PATCH 552/587] nip46: `switch_relays` (#2193) --- 46.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/46.md b/46.md index af34b19d..cdc1118d 100644 --- a/46.md +++ b/46.md @@ -97,18 +97,25 @@ Each of the following are methods that the _client_ sends to the _remote-signer_ | Command | Params | Result | | ------------------------ | ------------------------------------------------- | ---------------------------------------------------------------------- | -| `connect` | `[<remote-signer-pubkey>, <optional_secret>, <optional_requested_permissions>]` | "ack" OR `<required-secret-value>` | +| `connect` | `[<remote-signer-pubkey>, <optional_secret>, <optional_requested_perms>]` | `"ack"` OR `<required-secret-value>` | | `sign_event` | `[<{kind, content, tags, created_at}>]` | `json_stringified(<signed_event>)` | -| `ping` | `[]` | "pong" | -| `get_public_key` | `[]` | `<user-pubkey>` | +| `ping` | `[]` | `"pong"` | +| `get_public_key` | `[]` | `<user-pubkey>` | | `nip04_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip04_ciphertext>` | | `nip04_decrypt` | `[<third_party_pubkey>, <nip04_ciphertext_to_decrypt>]` | `<plaintext>` | | `nip44_encrypt` | `[<third_party_pubkey>, <plaintext_to_encrypt>]` | `<nip44_ciphertext>` | | `nip44_decrypt` | `[<third_party_pubkey>, <nip44_ciphertext_to_decrypt>]` | `<plaintext>` | +| `switch_relays` | `[]` | `["<relay-url>", "<relay-url>", ...]` OR `null` | ### Requested permissions -The `connect` method may be provided with `optional_requested_permissions` for user convenience. The permissions are a comma-separated list of `method[:params]`, i.e. `nip44_encrypt,sign_event:4` meaning permissions to call `nip44_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. Same permission format may be used for `perms` field of `metadata` in `nostrconnect://` string. +The `connect` method may be provided with `optional_requested_perms` for user convenience. The permissions are a comma-separated list of `method[:params]`, i.e. `nip44_encrypt,sign_event:4` meaning permissions to call `nip44_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. Same permission format may be used for `perms` field of `metadata` in `nostrconnect://` string. + +### Switching relays + +At all times, the _remote-signer_ should be in control of what relays are being used for the connection between it and the _client_. Therefore it should be possible for it to evolve its set of relays over time as old relays go out of operation and new ones appear. Even more importantly, in the case of the connection initiated by the _client_ the client may pick relays completely foreign to the _remote-signer_'s preferences, so it must be possible for it to switch those immediately. + +Therefore, compliant clients should send a `switch_relays` request immediately upon establishing a connection (always, or at reasonable intervals). Upon receiving such requests, the _remote-signer_ should reply with its updated list of relays, or `null` if there is nothing to be changed. Immediately upon receiving an updated relay list, the _client_ should update its local state and send further requests on the new relays. The `remote-signer` should then be free to disconnect from the previous relays if that is desired. ## Response Events `kind:24133` From d071018d5a38e1a8a338bd81684fc3029705f5b9 Mon Sep 17 00:00:00 2001 From: Alex Gleason <alex@alexgleason.me> Date: Wed, 28 Jan 2026 15:47:17 -0600 Subject: [PATCH 553/587] Add NIP-85 to the README (#2203) --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 7d3e4f41..2e119065 100644 --- a/README.md +++ b/README.md @@ -92,6 +92,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-78: Application-specific data](78.md) - [NIP-7D: Threads](7D.md) - [NIP-84: Highlights](84.md) +- [NIP-85: Trusted Assertions](85.md) - [NIP-86: Relay Management API](86.md) - [NIP-87: Ecash Mint Discoverability](87.md) - [NIP-88: Polls](88.md) @@ -260,6 +261,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30312` | Interactive Room | [53](53.md) | | `30313` | Conference Event | [53](53.md) | | `30315` | User Statuses | [38](38.md) | +| `30382` | User Trusted Assertion | [85](85.md) | +| `30383` | Event Trusted Assertion | [85](85.md) | +| `30384` | Addressable Trusted Assertion | [85](85.md) | | `30388` | Slide Set | [Corny Chat][cornychat-slideset] | | `30402` | Classified Listing | [99](99.md) | | `30403` | Draft Classified Listing | [99](99.md) | From 06593632a83563a2a4172901209ae10beb5decfa Mon Sep 17 00:00:00 2001 From: Alex Gleason <alex@alexgleason.me> Date: Fri, 30 Jan 2026 11:25:30 -0600 Subject: [PATCH 554/587] Add ISO 3166 countries to NIP-73 (#2205) --- 73.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/73.md b/73.md index 7fb9a3c3..3e975aed 100644 --- a/73.md +++ b/73.md @@ -18,6 +18,7 @@ There are certain established global content identifiers such as [Book ISBNs](ht | URLs | "`<URL, normalized, no fragment>`" | "web" | | Books | "isbn:`<id, without hyphens>`" | "isbn" | | Geohashes | "geo:`<geohash, lowercase>`" | "geo" | +| Countries | "iso3166:`<code, uppercase>`" | "iso3166" | | Movies | "isan:`<id, without version part>`" | "isan" | | Papers | "doi:`<id, lowercase>`" | "doi" | | Hashtags | "#`<topic, lowercase>`" | "#" | @@ -43,6 +44,21 @@ For the webpage "https://myblog.example.com/post/2012-03-27/hello-world" the "i" ] ``` +### Geohashes: + +- Geohash: `["i", "geo:ezs42e44yx96"]` - https://www.movable-type.co.uk/scripts/geohash.html + +Geohashes are a geocoding system that encodes geographic locations into short strings of letters and digits. They MUST be lowercase. + +### Countries: + +ISO 3166 codes can reference countries (ISO 3166-1 alpha-2) or subdivisions like states/provinces (ISO 3166-2). + +- Country (Venezuela): `["i", "iso3166:VE"]` +- Subdivision (California, USA): `["i", "iso3166:US-CA"]` + +ISO 3166 codes MUST be uppercase. More info: https://en.wikipedia.org/wiki/ISO_3166 + ### Books: - Book ISBN: `["i", "isbn:9780765382030"]` - https://isbnsearch.org/isbn/9780765382030 From 18b948abda8e5a2c414419f824e09f7d379b40e8 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Tue, 3 Feb 2026 07:57:31 -0500 Subject: [PATCH 555/587] NIP-05: Explicitly requires lowercase for hex keys and names (#2208) --- 05.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/05.md b/05.md index 7e823fba..57a39365 100644 --- a/05.md +++ b/05.md @@ -6,11 +6,11 @@ Mapping Nostr keys to DNS-based internet identifiers `final` `optional` -On events of kind `0` (`user metadata`) one can specify the key `"nip05"` with an [internet identifier](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) (an email-like address) as the value. Although there is a link to a very liberal "internet identifier" specification above, NIP-05 assumes the `<local-part>` part will be restricted to the characters `a-z0-9-_.`, case-insensitive. +On events of kind `0` (`user metadata`) one can specify the key `"nip05"` with an [internet identifier](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) (an email-like address) as the value. Although there is a link to a very liberal "internet identifier" specification above, the `<local-part>` part MUST only use characters `a-z0-9-_.`. Upon seeing that, the client splits the identifier into `<local-part>` and `<domain>` and use these values to make a GET request to `https://<domain>/.well-known/nostr.json?name=<local-part>`. -The result should be a JSON document object with a key `"names"` that should then be a mapping of names to hex formatted public keys. If the public key for the given `<name>` matches the `pubkey` from the `user metadata` event, the client then concludes that the given pubkey can indeed be referenced by its identifier. +The result should be a JSON document object with a key `"names"` that should then be a mapping of names to hex formatted public keys, in lowercase. If the public key for the given `<name>` matches the `pubkey` from the `user metadata` event, the client then concludes that the given pubkey can indeed be referenced by its identifier. ### Example @@ -73,7 +73,7 @@ For example, if after finding that `bob@bob.com` has the public key `abc...def`, ### Public keys must be in hex format -Keys 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. +Keys must be returned in hex format, in lowercase. Keys in NIP-19 `npub` format are only meant to be used for display in client UIs, not in this NIP. ### Showing just the domain as an identifier From 90a60bd210670787afb1f14caab8fd8d70028ea6 Mon Sep 17 00:00:00 2001 From: mattn <mattn.jp@gmail.com> Date: Tue, 3 Feb 2026 22:22:08 +0900 Subject: [PATCH 556/587] chore: small fixes (#2209) --- 22.md | 2 +- 51.md | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/22.md b/22.md index f356fa20..daad6eac 100644 --- a/22.md +++ b/22.md @@ -192,7 +192,7 @@ A reply to a podcast comment: // this is a reference to the above comment ["e", "80c48d992a38f9c445b943a9c9f1010b396676013443765750431a9004bdac05", "wss://example.relay", "252f10c83610ebca1a059c0bae8255eba2f95be4d1d7bcfa89d7248a82d9f111"], // the parent comment kind - ["k", "1111"] + ["k", "1111"], ["p", "252f10c83610ebca1a059c0bae8255eba2f95be4d1d7bcfa89d7248a82d9f111"] ] // other fields diff --git a/51.md b/51.md index a7df4302..f9d6e56f 100644 --- a/51.md +++ b/51.md @@ -135,7 +135,6 @@ Some clients have used these lists in the past, but they should work on transiti ["e", "340e0326b340e0326b4941ed78ba340e0326b4941ed78ba340e0326b49ed78ba"], // PWA ["a", "32267:d6dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:com.example.app"] // Reference to parent software application ], - "content": "Example App is a decentralized marketplace for apps", "sig": "a9a4e2192eede77e6c9d24ddfab95ba3ff7c03fbd07ad011fff245abea431fb4d3787c2d04aad001cb039cb8de91d83ce30e9a94f82ac3c5a2372aa1294a96bd" } ``` From 01838f302ddf639b2cfc1bfbe6232401e82eac58 Mon Sep 17 00:00:00 2001 From: frnandu <frnandu@atomicmail.io> Date: Tue, 3 Feb 2026 19:41:08 +0100 Subject: [PATCH 557/587] NIP-47 Add Hold Invoice Support (#1913) Co-authored-by: Fmar <frnandu@gmail.com> Co-authored-by: Roland <33993199+rolznz@users.noreply.github.com> --- 47.md | 121 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 119 insertions(+), 2 deletions(-) diff --git a/47.md b/47.md index 13037cb5..76c8f502 100644 --- a/47.md +++ b/47.md @@ -371,7 +371,7 @@ Response: "result_type": "lookup_invoice", "result": { "type": "incoming", // "incoming" for invoices, "outgoing" for payments - "state": "pending", // can be "pending", "settled", "expired" (for invoices) or "failed" (for payments), optional + "state": "pending", // can be "pending", "settled", "accepted" (for hold invoices), "expired" (for invoices) or "failed" (for payments), optional "invoice": "string", // encoded invoice, optional "description": "string", // invoice's description, optional "description_hash": "string", // invoice's description hash, optional @@ -420,7 +420,7 @@ Response: "transactions": [ { "type": "incoming", // "incoming" for invoices, "outgoing" for payments - "state": "pending", // can be "pending", "settled", "expired" (for invoices) or "failed" (for payments), optional + "state": "pending", // can be "pending", "settled", "accepted" (for hold invoices), "expired" (for invoices) or "failed" (for payments), optional "invoice": "string", // encoded invoice, optional "description": "string", // invoice's description, optional "description_hash": "string", // invoice's description hash, optional @@ -485,6 +485,89 @@ Response: } ``` +### `make_hold_invoice` + +Creates a hold invoice using a pre-generated preimage. + +Request: +```jsonc +{ + "method": "make_hold_invoice", + "params": { + "amount": 123, // value in msats + "description": "string", // invoice's description, optional + "description_hash": "string", // invoice's description hash, optional + "expiry": 213 // expiry in seconds from time invoice is created for a payment to be initiated, optional. This does not determine how long a payment can be held (see `settle_deadline`) + "payment_hash": "string" // Payment hash for the payment generated from the preimage + "min_cltv_expiry_delta": 144 // The minimum CLTV delta to use for the final hop, optional + } +} +``` + +Response: +```jsonc +{ + "result_type": "make_hold_invoice", + "result": { + "type": "incoming", // "incoming" for invoices, "outgoing" for payments + "invoice": "string", // encoded invoice, optional + "description": "string", // invoice's description, optional + "description_hash": "string", // invoice's description hash, optional + "payment_hash": "string", // Payment hash for the payment + "amount": 123, // value in msats + "created_at": unixtimestamp, // invoice/payment creation time + "expires_at": unixtimestamp, // invoice expiration time, optional if not applicable + "metadata": {} // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc. + } +} +``` + +### `cancel_hold_invoice` + +Cancels a hold invoice using the payment hash + +Request: +```jsonc +{ + "method": "cancel_hold_invoice", + "params": { + "payment_hash": "string" // Payment hash for the payment generated from the preimage + } +} +``` + +Response: +```jsonc +{ + "result_type": "cancel_hold_invoice", + "result": {} +} +``` + +### `settle_hold_invoice` + +Settles a hold invoice using the preimage + + +Request: +```jsonc +{ + "method": "settle_hold_invoice", + "params": { + "preimage": "string" // preimage for the payment + } +} +``` + +Response: +```jsonc +{ + "result_type": "settle_hold_invoice", + "result": {} +} +``` + + ## Notifications ### `payment_received` @@ -539,6 +622,30 @@ Notification: } ``` +### `hold_invoice_accepted` + +Description: Sent when a payer accepts (locks in) a hold invoice. To avoid locking up funds in channels the hold invoice SHOULD be settled or canceled within a few minutes of receiving this event. + +Notification: +```jsonc +{ + "notification_type": "hold_invoice_accepted", + "notification": { + "type": "incoming", + "state": "accepted", // optional + "invoice": "string", // encoded invoice + "description": "string", // invoice's description, optional + "description_hash": "string", // invoice's description hash, optional + "payment_hash": "string", // Payment hash for the payment + "amount": 123, // value in msats + "created_at": unixtimestamp, // invoice/payment creation time + "expires_at": unixtimestamp, // invoice expiration time + "settle_deadline": blocknumber, // invoice can only be safely settled or canceled before this block number. + "metadata": {} // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc. + } +} +``` + ## Example pay invoice flow 0. 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. @@ -668,6 +775,16 @@ Here are some properties that are recognized by some NWC clients: } ``` +### Example Hold Invoice Support Flow + +1. Client generates a 32-byte hex-encoded preimage. +2. Computes SHA-256 to derive payment hash. +3. Sends `make_hold_invoice` with payment hash and desired parameters. +4. Waits for `hold_invoice_accepted` notification. +5. Upon receiving notification, either: + + * Calls `settle_hold_invoice` with the original preimage to release funds, or + * Calls `cancel_hold_invoice` with payment hash to abort. ### Deep-links Wallet applications can register deeplinks in mobile systems to make it possible to create a linking UX that doesn't require the user scanning a QR code or pasting some code. From 3d71a4a78c376a5a71bf44708cd6b02c1773ae0b Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Fri, 6 Feb 2026 17:26:02 -0300 Subject: [PATCH 558/587] nip45: add hyperloglog relay response (#1561) --- 45.md | 108 +++++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 99 insertions(+), 9 deletions(-) diff --git a/45.md b/45.md index 14d656ec..794dbe81 100644 --- a/45.md +++ b/45.md @@ -29,29 +29,119 @@ In case a relay uses probabilistic counts, it MAY indicate it in the response wi Whenever the relay decides to refuse to fulfill the `COUNT` request, it MUST return a `CLOSED` message. +## HyperLogLog + +Relays may return an HyperLogLog value together with the count, hex-encoded. + +``` +["COUNT", <subscription_id>, {"count": <integer>, "hll": "<hex>"}] +``` + +This is so it enables merging results from multiple relays and yielding a reasonable estimate of reaction counts, comment counts and follower counts, while saving many millions of bytes of bandwidth for everybody. + +### Algorithm + +This section describes the steps a relay should take in order to return HLL values to clients. + +1. Upon receiving a filter, if it is eligible (see below) for HyperLogLog, compute the deterministic `offset` for that filter (see below); +2. Initialize 256 registers to `0` for the HLL value; +3. For all the events that are to be counted according to the filter, do this: + 1. Read the byte at position `offset` of the event `pubkey`, its value will be the register index `ri`; + 2. Count the number of leading zero bits starting at position `offset+1` of the event `pubkey` and add `1`; + 3. Compare that with the value stored at register `ri`, if the new number is bigger, store it. + +That is all that has to be done on the relay side, and therefore the only part needed for interoperability. + +On the client side, these HLL values received from different relays can be merged (by simply going through all the registers in HLL values from each relay and picking the highest value for each register, regardless of the relay). + +And finally the absolute count can be estimated by running some methods I don't dare to describe here in English, it's better to check some implementation source code (also, there can be different ways of performing the estimation, with different quirks applied on top of the raw registers). + +### `offset` computation + +The `offset` (used in the HLL computation above) is derived deterministically from the filter sent by the client to the relay. The formula for obtaining the `offset` value is as follows: + + 1. Take the first tag attribute in the filter (with the `#` prefix); + 2. From that, take its first item (it will be a string); + 3. Obtain a 32-byte hex string from it: + - if the string is an event id or pubkey hex, use it as it is; + - if the string is an address (`<kind>:<pubkey>:<d-tag>`), use the `<pubkey>` part; + - if the string is anything else, hash it with a `sha256()` and take the result as a hex string; + 4. From the 64-character hex string obtained before, take the character at position `32`; + 5. Read that character as a base-16 number; + 6. Add 8 to it: the result is the `offset`. + +For cases not covered above (filters without a tag attribute, for example), behavior isn't yet defined. This NIP may be modified later to specify those, but for now there isn't a use case that justifies using HLL in those circumstances. + +### Rationale + +The value of `offset` must be deterministic because that's the only way to allow relays to cache the HLL values so they don't have to count thousands of events from the database on every query. It also allows relays to precompute HLL values for any given target `<id>` or `<pubkey>` without having to store the events themselves directly, which can be handy in case of reactions, for example. + +### Common filters + +Some relays may decide to cache or precompute HLL values for some common canonical queries, and also to refrain from counting events that do not match these specs. These are such queries (this NIP can be modified later if more common useful queries are discovered and start being used): + +- **reaction count**: `{"#e": ["<id>"], "kinds": [7]}` +- **repost count**: `{"#e": ["<id>"], "kinds": [6]}` +- **quote count**: `{"#q": ["<id>"], "kinds": [1, 1111]}` +- **reply count**: `{"#e": ["<id>"], "kinds": [1]}` +- **comment count**: `{"#E": ["<id>"], "kinds": [1111]}` +- **follower count**: `{"#p": ["<pubkey>"], "kinds": [3]}` + +Notice that these queries only include 1 tag attribute with always a single item in it, which means that implementors don't have to check the order in which these attributes show up in the filter. + +### Attack vectors + +One could mine a pubkey with a certain number of zero bits in the exact place where the HLL algorithm described above would look for them in order to artificially make its reaction or follow "count more" than others. For this to work a different pubkey would have to be created for each different target (event id, followed profile etc). This approach is not very different than creating tons of new pubkeys and using them all to send likes or follow someone in order to inflate their number of followers. The solution is the same in both cases: clients should not fetch these reaction counts from open relays that accept everything, they should base their counts on relays that perform some form of filtering that makes it more likely that only real humans are able to publish there and not bots or artificially-generated pubkeys. + +### `hll` encoding + +The value `hll` value must be the concatenation of the 256 registers, each being a uint8 value (i.e. a byte). Therefore `hll` will be a 512-character hex string. + +### Client-side usage + +This algorithm also allows clients to combine HLL responses received from relays with HLL counts computed locally from raw events. It's recommended that clients keep track of HLL values locally and add to these on each message received from relays. For example: + + - a client wants to keep track of the number of reactions an event Z has received over time; + - the client has decided it will read reactions from relays A, B and C (the NIP-65 "read" relays of Z's author); + - of these, only B and C support HLL responses, so the client fetches both and merges them locally; + - then the client fetches all reaction events from A then manually applies each event to the HLL from the previous step, using the same algorithm described above; + - finally, the client reads the estimate count from the HLL and displays that to the user; + - optionally the client may store that HLL value (together with some "last-read-date" for relay A) and repeat the process again later: + - this time it only needs to fetch the new reactions from A and add those to the HLL + - and redownload the HLL values from B and C and just reapply them to the local value. + +This procedure allows the client to download much less data. + ## Examples -### Followers count - -``` -["COUNT", <query_id>, {"kinds": [3], "#p": [<pubkey>]}] -["COUNT", <query_id>, {"count": 238}] -``` - -### Count posts and reactions +### Count notes and reactions ``` ["COUNT", <query_id>, {"kinds": [1, 7], "authors": [<pubkey>]}] ["COUNT", <query_id>, {"count": 5}] ``` -### Count posts approximately +### Count notes approximately ``` ["COUNT", <query_id>, {"kinds": [1]}] ["COUNT", <query_id>, {"count": 93412452, "approximate": true}] ``` +### Followers count with HyperLogLog + +``` +["COUNT", <subscription_id>, {"kinds": [3], "#p": [<pubkey>]}] +["COUNT", <subscription_id>, {"count": 16578, "hll": "0607070505060806050508060707070706090d080b0605090607070b07090606060b0705070709050807080805080407060906080707080507070805060509040a0b06060704060405070706080607050907070b08060808080b080607090a06060805060604070908050607060805050d05060906090809080807050e0705070507060907060606070708080b0807070708080706060609080705060604060409070a0808050a0506050b0810060a0908070709080b0a07050806060508060607080606080707050806080c0a0707070a080808050608080f070506070706070a0908090c080708080806090508060606090906060d07050708080405070708"}] +``` + +### Reaction counts with HyperLogLog + +``` +["COUNT", <subscription_id>, {"kinds": [7], "#e": [<id>]}] +["COUNT", <subscription_id>, {"count": 2044, "hll": "01ef070505060806050508060707070706090d080b0605090607070b07090606060b0705070709050807080805080407060906080707080507070805060509040a0b06060704060405070706080607050907070b08060808080b080607090a06060805060604070908050607060805050d05060906090809080807050e0705070507060907060606070708080b0807070708080706060609080705060604060409070a0808050a0506050b0810060a0908070709080b0a07050806060508060607080606080707050806080c0a0707070a080808050608080f070506070706070a0908090c080708080806090508060606090906060d07050708080405070708"}] +``` + ### Relay refuses to count ``` From 567ad57a4b930d5dd946e835f65b57bf6f7277fb Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Tue, 10 Feb 2026 10:06:08 -0500 Subject: [PATCH 559/587] NIP-39: moves i tags out of kind 0 (#2216) --- 39.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/39.md b/39.md index 3777ac55..8a3247f7 100644 --- a/39.md +++ b/39.md @@ -8,16 +8,11 @@ External Identities in Profiles ## Abstract -Nostr protocol users may have other online identities such as usernames, profile pages, keypairs etc. they control and they may want to include this data in their profile metadata so clients can parse, validate and display this information. - -## `i` tag on a metadata event - -A new optional `i` tag is introduced for `kind 0` metadata event defined in [NIP-01](01.md): +Users can declare their control over one or more online identities such as usernames, profile pages, keypairs in kind `10011` using `i` tags. ```jsonc { - "id": <id>, - "pubkey": <pubkey>, + "kind": 10011, "tags": [ ["i", "github:semisol", "9721ce4ee4fceb91c9711ca2a6c9a5ab"], ["i", "twitter:semisol_public", "1619358434134196225"], @@ -28,7 +23,7 @@ A new optional `i` tag is introduced for `kind 0` metadata event defined in [NIP } ``` -An `i` tag will have two parameters, which are defined as the following: +An `i` tag MUST have two parameters, which are defined as the following: 1. `platform:identity`: This is the platform name (for example `github`) and the identity on that platform (for example `semisol`) joined together with `:`. 2. `proof`: String or object that points to the proof of owning this identity. From e83326e6d45050f323de128e2e0b75ea9e0acde2 Mon Sep 17 00:00:00 2001 From: Roland <33993199+rolznz@users.noreply.github.com> Date: Wed, 11 Feb 2026 20:45:14 +0700 Subject: [PATCH 560/587] chore: simplify nip-47 (#2210) --- 47.md | 100 ++-------------------------------------------------------- 1 file changed, 3 insertions(+), 97 deletions(-) diff --git a/47.md b/47.md index 76c8f502..6830820a 100644 --- a/47.md +++ b/47.md @@ -28,7 +28,7 @@ Fundamentally NWC is communication between a **client** and **wallet service** b 4. Once the payment is complete the **wallet service** will send an encrypted `response` (kind 23195) to the **user** over the relay(s) in the URI. - 5. The **wallet service** may send encrypted notifications (kind 23197 or 23196) of wallet events (such as a received payment) to the **client**. + 5. The **wallet service** may send encrypted notifications (kind 23197) of wallet events (such as a received payment) to the **client**. ## Events @@ -134,8 +134,6 @@ The content of notifications is encrypted with [NIP44](44.md) (or NIP-04 for leg } ``` -_Note on backwards-compatibility:_ If a **wallet service** supports both nip44 and nip04 for legacy client apps, it should publish both notification events for each notification - kind 23196 encrypted with NIP-04, and kind 23197 encrypted with NIP-44. It is up to the **client** to decide which event to listen to based on its supported encryption and declared supported encryption schemes of the **wallet service** in the `info` event. - ### Error codes - `RATE_LIMITED`: The client is sending commands too fast. It should retry in a few seconds. - `NOT_IMPLEMENTED`: The command is not known or is intentionally not implemented. @@ -207,42 +205,6 @@ Response: Errors: - `PAYMENT_FAILED`: The payment failed. This may be due to a timeout, exhausting all routes, insufficient capacity or similar. -### `multi_pay_invoice` - -Description: Requests payment of multiple invoices. - -Request: -```jsonc -{ - "method": "multi_pay_invoice", - "params": { - "invoices": [ - {"id":"4da52c32a1", "invoice": "lnbc1...", "amount": 123}, // bolt11 invoice and amount in msats, amount is optional - {"id":"3da52c32a1", "invoice": "lnbc50n1...", "metadata": {} }, // generic metadata that can be used to add things like zap/boostagram details for a payer name/comment/etc, optional - ], - } -} -``` - -Response: - -For every invoice in the request, a separate response event is sent. To differentiate between the responses, each -response event contains a `d` tag with the id of the invoice it is responding to; if no id was given, then the -payment hash of the invoice should be used. - -```jsonc -{ - "result_type": "multi_pay_invoice", - "result": { - "preimage": "0123456789abcdef...", // preimage of the payment - "fees_paid": 123, // value in msats, optional - } -} -``` - -Errors: -- `PAYMENT_FAILED`: The payment failed. This may be due to a timeout, exhausting all routes, insufficient capacity or similar. - ### `pay_keysend` Request: @@ -277,44 +239,6 @@ Response: Errors: - `PAYMENT_FAILED`: The payment failed. This may be due to a timeout, exhausting all routes, insufficient capacity or similar. -### `multi_pay_keysend` - -Description: Requests multiple keysend payments. - -Has an array of keysends, these follow the same semantics as `pay_keysend`, just done in a batch - -Request: -```jsonc -{ - "method": "multi_pay_keysend", - "params": { - "keysends": [ - {"id": "4c5b24a351", "pubkey": "03...", "amount": 123}, - {"id": "3da52c32a1", "pubkey": "02...", "amount": 567, "preimage": "abc123..", "tlv_records": [{"type": 696969, "value": "77616c5f6872444873305242454d353736"}]}, - ], - } -} -``` - -Response: - -For every keysend in the request, a separate response event is sent. To differentiate between the responses, each -response event contains a `d` tag with the id of the keysend it is responding to; if no id was given, then the -pubkey should be used. - -```jsonc -{ - "result_type": "multi_pay_keysend", - "result": { - "preimage": "0123456789abcdef...", // preimage of the payment - "fees_paid": 123, // value in msats, optional - } -} -``` - -Errors: -- `PAYMENT_FAILED`: The payment failed. This may be due to a timeout, exhausting all routes, insufficient capacity or similar. - ### `make_invoice` Request: @@ -671,23 +595,6 @@ The negotiation works as follows. 1. The **wallet service** includes an `encryption` tag in the `info` event. This tag contains a space-separated list of encryption schemes that the **wallet service** supports (eg. `nip44_v2 nip04`) 2. The **client application** includes an `encryption` tag in each request event. This tag contains the encryption scheme which should be used for the request. The **client application** should always prefer nip44 if supported by the **wallet service**. -### Info event - -First, the **wallet service** adds an `encryption` tag to its `info` event containing a space-separated list of encryption schemes it supports. For example, -if a wallet service supports nip44, but also allows backwards-compatibility to nip04 client applications, its `encryption` tag in the `info` event might look something like: - -```jsonc -{ - "kind": 13194, - "tags": [ - ["encryption", "nip44_v2 nip04"], - // ... - ], - "content": "pay_invoice get_balance make_invoice lookup_invoice list_transactions get_info", - // ... -} -``` - When a **client application** establishes a connection, it should read the info event and look for the `encryption` tag. **Absence of this tag implies that the wallet only supports nip04.** @@ -714,7 +621,7 @@ If the **wallet service** does not support the specified encryption scheme, it w ### Notification events -As described above in the [Notifications](#notifications) section, if a **wallet service** supports both nip04 and nip44, it should publish two notification events for each notification - kind 23196 encrypted with NIP-04, and kind 23197 encrypted with NIP-44. If the **wallet service** only supports nip44, it should only publish kind 23197 events. +If a **wallet service** supports both nip04 and nip44, it should publish two notification events for each notification - kind 23196 encrypted with NIP-04, and kind 23197 encrypted with NIP-44. If the **wallet service** only supports nip44, it should only publish kind 23197 events. The **client** should check the `encryption` tag in the `info` event to determine which encryption schemes the **wallet service** supports, and listen to the appropriate notification event. @@ -785,6 +692,7 @@ Here are some properties that are recognized by some NWC clients: * Calls `settle_hold_invoice` with the original preimage to release funds, or * Calls `cancel_hold_invoice` with payment hash to abort. + ### Deep-links Wallet applications can register deeplinks in mobile systems to make it possible to create a linking UX that doesn't require the user scanning a QR code or pasting some code. @@ -800,5 +708,3 @@ URI parameters: Once a connection has been created by the wallet, it should be returned to the client by opening the callback with the following parameters * `value` -- NWC pairing code (e.g. `nostr+walletconnect://...`) - - From 5d232e65254100d543ebd1936d966085e9820dae Mon Sep 17 00:00:00 2001 From: Danny M <25923265+dannym-arx@users.noreply.github.com> Date: Fri, 13 Feb 2026 13:56:59 +0100 Subject: [PATCH 561/587] fix typo in nip-55 (#2222) --- 55.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/55.md b/55.md index b4a3aec8..72a844ac 100644 --- a/55.md +++ b/55.md @@ -249,7 +249,7 @@ launcher.launch(intent) ```kotlin val intent = Intent(Intent.ACTION_VIEW, Uri.parse("nostrsigner:$encryptedText")) intent.`package` = "com.example.signer" - intent.putExtra("type", "nip04_decrypt") + intent.putExtra("type", "nip44_decrypt") // to control the result in your application in case you are not waiting the result before sending another intent intent.putExtra("id", "some_id") // Send the current logged in user pubkey From 5a4734f8b77519b07568bf693e6dbb0d47aef0b6 Mon Sep 17 00:00:00 2001 From: hodlbod <jstaab@protonmail.com> Date: Fri, 13 Feb 2026 08:45:38 -0800 Subject: [PATCH 562/587] Add timehashes to nip 52 (#1752) Co-authored-by: Jon Staab <shtaab@gmail.com> --- 52.md | 6 ++---- README.md | 1 + 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/52.md b/52.md index 0b69007c..060b38f2 100644 --- a/52.md +++ b/52.md @@ -95,6 +95,7 @@ Aside from the common tags, this also takes the following tags: * `end` (optional) exclusive end Unix timestamp in seconds. If omitted, the calendar event ends instantaneously. * `start_tzid` (optional) time zone of the start timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica` * `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. +* `D` (required) the day-granularity unix timestamp on which the event takes place, calculated as `floor(unix_seconds() / seconds_in_one_day)`. Multiple tags SHOULD be included to cover the event's timeframe. ```yaml { @@ -113,6 +114,7 @@ Aside from the common tags, this also takes the following tags: // timestamps ["start", "<unix timestamp in seconds>"], ["end", "<unix timestamp in seconds>"], + ["D", "82549"], ["start_tzid", "<IANA Time Zone Database identifier>"], ["end_tzid", "<IANA Time Zone Database identifier>"], @@ -203,10 +205,6 @@ The list of tags is as follows: } ``` -## Unsolved Limitations - -* No private events - ## Intentionally Unsupported Scenarios ### Recurring Calendar Events diff --git a/README.md b/README.md index 2e119065..c094d477 100644 --- a/README.md +++ b/README.md @@ -348,6 +348,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `A` | root address | relay URL | [22](22.md) | | `c` | commit id | | [34](34.md) | | `d` | identifier | -- | [01](01.md) | +| `D` | day | -- | [52](52.md) | | `e` | event id (hex) | relay URL, marker, pubkey (hex) | [01](01.md), [10](10.md) | | `E` | root event id | relay URL | [22](22.md) | | `f` | currency code | -- | [69](69.md) | From b914aeffd8d0e1593a1e1cc27e3c70da19a27f13 Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Sat, 14 Feb 2026 22:15:29 -0300 Subject: [PATCH 563/587] partially remove bloat that no one cares about from nip11 (#1946) --- 11.md | 251 +++++++++++++++------------------------------------------- 1 file changed, 62 insertions(+), 189 deletions(-) diff --git a/11.md b/11.md index 26b5c263..b49fa441 100644 --- a/11.md +++ b/11.md @@ -6,7 +6,7 @@ Relay Information Document `draft` `optional` `relay` -Relays may provide server metadata to clients to inform them of capabilities, administrative contacts, and various server attributes. This is made available as a JSON document over HTTP, on the same URI as the relay's websocket. +Relays may provide server metadata to clients to inform them of capabilities, administrative contacts, and various server attributes. This is made available as a JSON document over HTTP, on the same URI as the relay's websocket. When a relay receives an HTTP(s) request with an `Accept` header of `application/nostr+json` to a URI supporting WebSocket upgrades, they SHOULD return a document with the following structure. @@ -22,8 +22,7 @@ When a relay receives an HTTP(s) request with an `Accept` header of `application "supported_nips": <a list of NIP numbers supported by the relay>, "software": <string identifying relay software URL>, "version": <string version identifier>, - "privacy_policy": <a link to a text file describing the relay's privacy policy>, - "terms_of_service": <a link to a text file describing the relay's term of service>, + "terms_of_service": <a link to a text file describing the relay's term of service> } ``` @@ -34,11 +33,11 @@ Field Descriptions ### Name -A relay may select a `name` for use in client software. This is a string, and SHOULD be less than 30 characters to avoid client truncation. +A relay may select a `name` for use in client software. This is a string, and SHOULD be less than 30 characters to avoid client truncation. ### Description -Detailed plain-text information about the relay may be contained in the `description` string. It is recommended that this contain no markup, formatting or line breaks for word wrapping, and simply use double newline characters to separate paragraphs. There are no limitations on length. +Detailed plain-text information about the relay may be contained in the `description` string. It is recommended that this contain no markup, formatting or line breaks for word wrapping, and simply use double newline characters to separate paragraphs. There are no limitations on length. ### Banner @@ -57,7 +56,7 @@ Icon is a compact visual representation of the relay for use in UI with limited ### Pubkey -An 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. +An 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. Relay operators have no obligation to respond to direct messages. @@ -67,29 +66,23 @@ A relay MAY maintain an identity independent from its administrator using the `s ### Contact -An alternative contact may be listed under the `contact` field as well, with the same purpose as `pubkey`. Use of a Nostr public key and direct message SHOULD be preferred over this. Contents of this field SHOULD be a URI, using schemes such as `mailto` or `https` to provide users with a means of contact. +An alternative contact may be listed under the `contact` field as well, with the same purpose as `pubkey`. Use of a Nostr public key and direct message SHOULD be preferred over this. Contents of this field SHOULD be a URI, using schemes such as `mailto` or `https` to provide users with a means of contact. ### Supported NIPs -As the Nostr protocol evolves, some functionality may only be available by relays that implement a specific `NIP`. This field is an array of the integer identifiers of `NIP`s that are implemented in the relay. Examples would include `1`, for `"NIP-01"` and `9`, for `"NIP-09"`. Client-side `NIPs` SHOULD NOT be advertised, and can be ignored by clients. +As the Nostr protocol evolves, some functionality may only be available by relays that implement a specific `NIP`. This field is an array of the integer identifiers of `NIP`s that are implemented in the relay. Examples would include `1`, for `"NIP-01"` and `9`, for `"NIP-09"`. Client-side `NIPs` SHOULD NOT be advertised, and can be ignored by clients. ### Software -The relay server implementation MAY be provided in the `software` attribute. If present, this MUST be a URL to the project's homepage. +The relay server implementation MAY be provided in the `software` attribute. If present, this MUST be a URL to the project's homepage. ### Version -The relay MAY choose to publish its software version as a string attribute. The string format is defined by the relay implementation. It is recommended this be a version number or commit identifier. - -### Privacy Policy - -The relay owner/admin MAY choose to link to a privacy policy document, which describes how the relay utilizes user data. Data collection, data usage, data retention, monetization of data, and third party data sharing SHOULD be included. +The relay MAY choose to publish its software version as a string attribute. The string format is defined by the relay implementation. It is recommended this be a version number or commit identifier. ### Terms of Service -The relay owner/admin MAY choose to link to a terms of service document. - - +The relay MAY choose to publish its software version as a string attribute. The string format is defined by the relay implementation. It is recommended this be a version number or commit identifier. Extra Fields ------------ @@ -167,112 +160,6 @@ a specific niche kind or content. Normal anti-spam heuristics, for example, do n - `default_limit`: The maximum returned events if you send a filter without a `limit`. -### Event Retention - -There may be a cost associated with storing data forever, so relays -may wish to state retention times. The values stated here are defaults -for unauthenticated users and visitors. Paid users would likely have -other policies. - -Retention times are given in seconds, with `null` indicating infinity. -If zero is provided, this means the event will not be stored at -all, and preferably an error will be provided when those are received. - -```jsonc -{ - "retention": [ - {"kinds": [0, 1, [5, 7], [40, 49]], "time": 3600}, - {"kinds": [[40000, 49999]], "time": 100}, - {"kinds": [[30000, 39999]], "count": 1000}, - {"time": 3600, "count": 10000} - ], - // other fields... -} -``` - -`retention` is a list of specifications: each will apply to either all kinds, or -a subset of kinds. Ranges may be specified for the kind field as a tuple of inclusive -start and end values. Events of indicated kind (or all) are then limited to a `count` -and/or time period. - -It is possible to effectively blacklist Nostr-based protocols that rely on -a specific `kind` number, by giving a retention time of zero for those `kind` values. -While that is unfortunate, it does allow clients to discover servers that will -support their protocol quickly via a single HTTP fetch. - -There is no need to specify retention times for _ephemeral events_ since they are not retained. - -### Content Limitations - -Some relays may be governed by the arbitrary laws of a nation state. This -may limit what content can be stored in clear-text on those relays. All -clients are encouraged to use encryption to work around this limitation. - -It is not possible to describe the limitations of each country's laws -and policies which themselves are typically vague and constantly shifting. - -Therefore, this field allows the relay operator to indicate which -countries' laws might end up being enforced on them, and then -indirectly on their users' content. - -Users should be able to avoid relays in countries they don't like, -and/or select relays in more favorable zones. Exposing this -flexibility is up to the client software. - -```jsonc -{ - "relay_countries": [ "CA", "US" ], - // other fields... -} -``` - -- `relay_countries`: a list of two-level ISO country codes (ISO 3166-1 alpha-2) whose - laws and policies may affect this relay. `EU` may be used for European Union countries. A `*` can be used for global relays. - -Remember that a relay may be hosted in a country which is not the -country of the legal entities who own the relay, so it's very -likely a number of countries are involved. - - -### Community Preferences - -For public text notes at least, a relay may try to foster a -local community. This would encourage users to follow the global -feed on that relay, in addition to their usual individual follows. -To support this goal, relays MAY specify some of the following values. - -```jsonc -{ - "language_tags": ["en", "en-419"], - "tags": ["sfw-only", "bitcoin-only", "anime"], - "posting_policy": "https://example.com/posting-policy.html", - // other fields... -} -``` - -- `language_tags` is an ordered list - of [IETF language tags](https://en.wikipedia.org/wiki/IETF_language_tag) indicating - the major languages spoken on the relay. A `*` can be used for global relays. - -- `tags` is a list of limitations on the topics to be discussed. - For example `sfw-only` indicates that only "Safe For Work" content - is encouraged on this relay. This relies on assumptions of what the - "work" "community" feels "safe" talking about. In time, a common - set of tags may emerge that allow users to find relays that suit - their needs, and client software will be able to parse these tags easily. - The `bitcoin-only` tag indicates that any *altcoin*, *"crypto"* or *blockchain* - comments will be ridiculed without mercy. - -- `posting_policy` is a link to a human-readable page which specifies the - community policies for the relay. In cases where `sfw-only` is True, it's - important to link to a page which gets into the specifics of your posting policy. - -The `description` field should be used to describe your community -goals and values, in brief. The `posting_policy` is for additional -detail and legal terms. Use the `tags` field to signify limitations -on content, or topics to be discussed, which could be machine -processed by appropriate client software. - ### Pay-to-Relay Relays that require payments may want to expose their fee schedules. @@ -291,82 +178,68 @@ Relays that require payments may want to expose their fee schedules. ### Examples -As of 25 March 2025 the following command provided these results: - -```bash -curl -H "Accept: application/nostr+json" https://jellyfish.land | jq -``` - -```json +```yaml +~> curl -H "Accept: application/nostr+json" https://nostr.wine | jq { - "name": "JellyFish", - "description": "Stay Immortal!", - "banner": "https://image.nostr.build/7fdefea2dec1f1ec25b8ce69362566c13b2b7f13f1726c2e4584f05f64f62496.jpg", - "pubkey": "bf2bee5281149c7c350f5d12ae32f514c7864ff10805182f4178538c2c421007", - "contact": "hi@dezh.tech", - "software": "https://github.com/dezh-tech/immortal", - "supported_nips": [ - 1, - 9, - 11, - 13, - 17, - 40, - 42, - 59, - 62, - 70 - ], - "version": "immortal - 0.0.9", - "relay_countries": [ - "*" - ], - "language_tags": [ - "*" - ], - "tags": [], - "posting_policy": "https://jellyfish.land/tos.txt", - "payments_url": "https://jellyfish.land/relay", - "icon": "https://image.nostr.build/2547e9ec4b23589e09bc7071e0806c3d4293f76284c58ff331a64bce978aaee8.jpg", - "retention": [], + "contact": "wino@nostr.wine", + "description": "A paid nostr relay for wine enthusiasts and everyone else.", "fees": { - "subscription": [ + "admission": [ { - "amount": 3000, - "period": 2628003, - "unit": "sats" - }, - { - "amount": 8000, - "period": 7884009, - "unit": "sats" - }, - { - "amount": 15000, - "period": 15768018, - "unit": "sats" - }, - { - "amount": 28000, - "period": 31536036, - "unit": "sats" + "amount": 18888000, + "unit": "msats" } ] }, + "icon": "https://image.nostr.build/30acdce4a81926f386622a07343228ae99fa68d012d54c538c0b2129dffe400c.png", "limitation": { "auth_required": false, - "max_message_length": 70000, - "max_subid_length": 256, - "max_subscriptions": 350, + "created_at_lower_limit": 94608000, + "created_at_upper_limit": 300, + "max_event_tags": 4000, + "max_limit": 1000, + "max_message_length": 524288, + "max_subid_length": 71, + "max_subscriptions": 50, "min_pow_difficulty": 0, "payment_required": true, - "restricted_writes": true, + "restricted_writes": true + }, + "name": "nostr.wine", + "payments_url": "https://nostr.wine/invoices", + "pubkey": "4918eb332a41b71ba9a74b1dc64276cfff592e55107b93baae38af3520e55975", + "software": "https://nostr.wine", + "supported_nips": [ 1, 2, 4, 9, 11, 40, 42, 50, 70, 77 ], + "terms_of_service": "https://nostr.wine/terms", + "version": "0.3.3" +} + +~> curl -H "Accept: application/nostr+json" https://nostr.land | jq +{ + "description": "[✨ NFDB] nostr.land family of relays (fi-01 [tiger])", + "name": "[✨ NFDB] nostr.land", + "pubkey": "52b4a076bcbbbdc3a1aefa3735816cf74993b1b8db202b01c883c58be7fad8bd", + "software": "NFDB", + "icon": "https://i.nostr.build/b3thno790aodH8lE.jpg", + "supported_nips": [ 1, 2, 4, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19, 21, 22, 23, 24, 25, 27, 28, 30, 31, 32, 34, 35, 36, 37, 38, 39, 40, 42, 44, 46, 47, 48, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 64, 65, 68, 69, 71, 72, 73, 75, 78, 84, 88, 89, 90, 92, 99 ], + "version": "1.0.0", + "limitation": { + "payment_required": true, + "max_message_length": 65535, "max_event_tags": 2000, - "max_content_length": 70000, - "created_at_lower_limit": 0, - "created_at_upper_limit": 2147483647, - "default_limit": 500, - "max_limit": 5000 - } + "max_subscriptions": 200, + "auth_required": false + }, + "payments_url": "https://nostr.land", + "fees": { + "subscription": [ + { + "amount": 4000000, + "unit": "msats", + "period": 2592000 + } + ] + }, + "terms_of_service": "https://nostr.land/terms" } ``` From 6df3a218c9e374bd869b926cb71c7c9e46195a39 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Tue, 17 Feb 2026 05:41:06 -0500 Subject: [PATCH 564/587] NIP-85: Adds service provider discoverability guidance (#2223) Co-authored-by: Alex Gleason <alex@alexgleason.me> --- 85.md | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/85.md b/85.md index 5463ed16..587095d5 100644 --- a/85.md +++ b/85.md @@ -10,7 +10,7 @@ Certain Webs of Trust calculations require access to a large volume of events an ## Assertion Events -Trusted Assertions are always addressable (replaceable) events with the `d` tag pointing to the "subject" of the assertion. This NIP currently recognizes three distinct target "subjects" on which such calculations can be performed: *pubkeys*, *regular events*, and *addressable events*. Each subject type is mapped to an event kind: +Trusted Assertions are always addressable (replaceable) events with the `d` tag pointing to the "subject" of the assertion. This NIP currently recognizes four distinct target "subjects" on which such calculations can be performed: *pubkeys*, *regular events*, *addressable events*, and *nip73 identifiers*. Each subject type is mapped to an event kind: | Subject | Event Kind | `d` tag value | | ------------------ | -------------- | ----------------- | @@ -26,6 +26,7 @@ Example of ranking a pubkey with a web of trust score of `89`: ```jsonc { "kind": 30382, + "pubkey": "<service pubkey>", "tags": [ ["d", "e88a691e98d9987c964521dff60025f60700378a4879180dcbbb4a5027850411"], // target user's public key ["rank", "89"], @@ -35,6 +36,8 @@ Example of ranking a pubkey with a web of trust score of `89`: } ``` +Service providers MUST use different service keys for distinct algorithms, including a key per user when the algorithm is personalized to that user's point of view or settings. + ## Kind 30382: Users as Subject: The following result types have been declared: @@ -109,11 +112,17 @@ Kind `10040` lists the user's authorized providers for each result. Each `kind:t { "kind": 10040, "tags": [ + ["<kind:tag>", "<service key>", "<relay hint>"], + + // examples ["30382:rank", "4fd5e210530e4f6b2cb083795834bfe5108324f1ed9f00ab73b9e8fcfe5f12fe", "wss://nip85.nostr.band"], ["30382:rank", "3d842afecd5e293f28b6627933704a3fb8ce153aa91d790ab11f6a752d44a42d", "wss://nostr.wine"], ["30382:zap_amt_sent", "4fd5e210530e4f6b2cb083795834bfe5108324f1ed9f00ab73b9e8fcfe5f12fe", "wss://nip85.nostr.band"], ], "content": nip44Encrypt(JSON.stringify([ + ["<kind:tag>", "<service key>", "<relay hint>"], + + // examples ["30383:rank", "4fd5e210530e4f6b2cb083795834bfe5108324f1ed9f00ab73b9e8fcfe5f12fe", "wss://nip85.nostr.band"], ["30384:rank", "4fd5e210530e4f6b2cb083795834bfe5108324f1ed9f00ab73b9e8fcfe5f12fe", "wss://nip85.nostr.band"], ]), @@ -130,3 +139,28 @@ Service providers SHOULD update Trusted Assertions as fast as new information ar Service providers MAY limit access to the results by using paid relays. In TAs, `p`, `e`, and `a` tags with the same value as the `d` tag MAY be used to add a relay hint to the home relay of that user or event. + +## Appendix 1: Service provider discoverability + +Service Providers SHOULD sign a kind `0` of each service key that explains who controls the key and what the current version of the algorithm is about. + +```jsonc +{ + "kind": 0, + "pubkey": "<service pubkey>", + "tags": [], + "content": "{ + \"name\" = \"Vitor's Brainstormer\", + \"about\" = \"A Web of Trust algorithm from Vitor's point of view that considers Follows and Mutes, but no reports, and gives extra score points for anyone around Boston\", + \"picture\" = \"https://brainstorm.com/logo.png\", + \"website\" = \"https://brainstorm.com\" + }", + // other fields... +} +``` + +Clients wishing to offer a list of Service Providers to their users SHOULD: +1. Download kind `10040` events of the user's follow list +2. Connect to each of the listed relays and download the kind `0` of the respective service keys +3. Parse the kind `0` and collect the `website` property +4. Load the OpenGraph tags of that website and display them as clickable items From d3cbc8cb5d3626683eefdf3d740410406c02a294 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Tue, 24 Feb 2026 17:54:19 -0300 Subject: [PATCH 565/587] nip29: delete "unmanaged" groups. --- 29.md | 18 +----------------- 1 file changed, 1 insertion(+), 17 deletions(-) diff --git a/29.md b/29.md index 85f47ca7..f39d4d81 100644 --- a/29.md +++ b/29.md @@ -48,14 +48,6 @@ The roles supported by the group as to having some special privilege assigned to Users 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. -## Unmanaged groups - -Unmanaged 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. - -In `unmanaged` groups, everybody is considered to be a member. - -Unmanaged 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. - ## Event definitions These are the events expected to be found in NIP-29 groups. @@ -142,8 +134,6 @@ This event defines the metadata for the group -- basically how clients should di If the group is forked and hosted in multiple relays, there will be multiple versions of this event in each different relay and so on. -When this event is not found, clients may still connect to the group, but treat it as having a different status, `unmanaged`, - ```jsonc { "kind": 39000, @@ -231,7 +221,7 @@ The process through which the relay decides what roles to support and how to han ### Checking your own membership in a group -The 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. +The 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. ### Adding yourself to a group @@ -240,9 +230,3 @@ Anyone can send a `kind:9021` join request to a group. The relay may then genera ### Storing your list of groups A 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. - -### Using `unmanaged` relays - -To prevent event leakage, 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. - -Groups MAY be named without relay support by adding a `name` to the corresponding tag in a user's `kind 10009` group list. From d2f7c9f2ab113d42a92978ebf692490965b0f3f9 Mon Sep 17 00:00:00 2001 From: hodlbod <jstaab@protonmail.com> Date: Thu, 26 Feb 2026 16:52:35 -0800 Subject: [PATCH 566/587] Add unallowpubkey and unbanpubkey (#2111) Co-authored-by: Jon Staab <shtaab@gmail.com> --- 86.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/86.md b/86.md index 6f64eee7..b9a8cc24 100644 --- a/86.md +++ b/86.md @@ -34,12 +34,18 @@ This is the list of **methods** that may be supported: * `banpubkey`: - params: `["<32-byte-hex-public-key>", "<optional-reason>"]` - result: `true` (a boolean always set to `true`) +* `unbanpubkey`: + - params: `["<32-byte-hex-public-key>", "<optional-reason>"]` + - result: `true` (a boolean always set to `true`) * `listbannedpubkeys`: - params: `[]` - result: `[{"pubkey": "<32-byte-hex>", "reason": "<optional-reason>"}, ...]`, an array of objects * `allowpubkey`: - params: `["<32-byte-hex-public-key>", "<optional-reason>"]` - result: `true` (a boolean always set to `true`) +* `unallowpubkey`: + - params: `["<32-byte-hex-public-key>", "<optional-reason>"]` + - result: `true` (a boolean always set to `true`) * `listallowedpubkeys`: - params: `[]` - result: `[{"pubkey": "<32-byte-hex>", "reason": "<optional-reason>"}, ...]`, an array of objects From 1a4e0988eb6c7b726be9faf8456492a144ff4df8 Mon Sep 17 00:00:00 2001 From: Awiteb <a@4rs.nl> Date: Mon, 2 Mar 2026 01:14:48 +0300 Subject: [PATCH 567/587] fix terms of use paragraph (#2249) --- 11.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/11.md b/11.md index b49fa441..d1acab7b 100644 --- a/11.md +++ b/11.md @@ -82,7 +82,7 @@ The relay MAY choose to publish its software version as a string attribute. The ### Terms of Service -The relay MAY choose to publish its software version as a string attribute. The string format is defined by the relay implementation. It is recommended this be a version number or commit identifier. +The relay owner/admin MAY choose to link to a terms of service document. Extra Fields ------------ From eeb532b5ff936a48caaef8b7540342e0b6795166 Mon Sep 17 00:00:00 2001 From: Alejandro <alejandrogomez@bitrefill.com> Date: Mon, 2 Mar 2026 16:01:13 +0100 Subject: [PATCH 568/587] feat: add optional emoji set address to emoji tags (#2247) --- 30.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/30.md b/30.md index 54a8b375..c9b9ebe0 100644 --- a/30.md +++ b/30.md @@ -9,13 +9,14 @@ Custom Emoji Custom emoji may be added to **kind 0**, **kind 1**, **kind 7** ([NIP-25](25.md)) and **kind 30315** ([NIP-38](38.md)) events by including one or more `"emoji"` tags, in the form: ``` -["emoji", <shortcode>, <image-url>] +["emoji", <shortcode>, <image-url>, <emoji-set-address>] ``` Where: - `<shortcode>` is a name given for the emoji, which MUST be comprised of only alphanumeric characters and underscores. - `<image-url>` is a URL to the corresponding image file of the emoji. +- `<emoji-set-address>` is an optional address pointer (`kind:pubkey:d-tag`) to the kind 30030 emoji set ([NIP-51](51.md)) the emoji belongs to. For each emoji tag, clients should parse emoji shortcodes (aka "emojify") like `:shortcode:` in the event to display custom emoji. @@ -46,7 +47,7 @@ In kind 1 events, the `content` should be emojified. "kind": 1, "content": "Hello :gleasonator: 😂 :ablobcatrainbow: :disputed: yolo", "tags": [ - ["emoji", "ablobcatrainbow", "https://gleasonator.com/emoji/blobcat/ablobcatrainbow.png"], + ["emoji", "ablobcatrainbow", "https://gleasonator.com/emoji/blobcat/ablobcatrainbow.png", "30030:79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6:blobcats"], ["emoji", "disputed", "https://gleasonator.com/emoji/Fun/disputed.png"], ["emoji", "gleasonator", "https://gleasonator.com/emoji/Gleasonator/gleasonator.png"] ], From f9f985dff56dec92600a99c59840f4b4640edebf Mon Sep 17 00:00:00 2001 From: AsaiToshiya <to.asai.60@gmail.com> Date: Fri, 6 Mar 2026 22:15:47 +0900 Subject: [PATCH 569/587] add kind 10011 (from nip39) (#2256) --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index c094d477..e533ff4a 100644 --- a/README.md +++ b/README.md @@ -205,6 +205,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10006` | Blocked relays list | [51](51.md) | | `10007` | Search relays list | [51](51.md) | | `10009` | User groups | [51](51.md), [29](29.md) | +| `10011` | External Identities | [39](39.md) | | `10012` | Favorite relays list | [51](51.md) | | `10013` | Private event relay list | [37](37.md) | | `10015` | Interests list | [51](51.md) | From 1f9988ff9bd905505a81140d1b0144e3cc144057 Mon Sep 17 00:00:00 2001 From: alltheseas <64376233+alltheseas@users.noreply.github.com> Date: Sat, 7 Mar 2026 08:44:06 -0600 Subject: [PATCH 570/587] Update 66.md with defensive measures (#2240) --- 66.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/66.md b/66.md index 9b467912..9f06ff5f 100644 --- a/66.md +++ b/66.md @@ -95,3 +95,9 @@ Example: ] } ``` + + ## Risk Mitigation + + - Clients MUST NOT require `30166` events to function. Absence of monitoring data MUST NOT prevent relay connections. + - A monitor may publish erroneous `30166` events, either by misconfiguration or malicious intent. + - Clients SHOULD NOT trust a single source. Defenses include: web-of-trust filtering, querying multiple monitors, and discarding filter results if they would remove an unreasonable proportion of relays. From 7d9908018eabb260e794174349e834199030bfd1 Mon Sep 17 00:00:00 2001 From: hodlbod <jstaab@protonmail.com> Date: Thu, 12 Mar 2026 09:34:49 -0700 Subject: [PATCH 571/587] Add limit to nip 19 (#2264) Co-authored-by: Jon Staab <shtaab@gmail.com> --- 19.md | 1 + 1 file changed, 1 insertion(+) diff --git a/19.md b/19.md index 4787ecd5..eb350a53 100644 --- a/19.md +++ b/19.md @@ -67,3 +67,4 @@ These possible standardized `TLV` types are indicated here: - `npub` keys MUST NOT be used in NIP-01 events or in NIP-05 JSON responses, only the hex format is supported there. - When decoding a bech32-formatted string, TLVs that are not recognized or supported should be ignored, rather than causing an error. +- Bech32-formatted strings SHOULD be limited in size to 5000 characters. From 3492eb1affa5e93e658224a81bb832d2b6090ecd Mon Sep 17 00:00:00 2001 From: Vincenzo Imperati <61617279+VincenzoImp@users.noreply.github.com> Date: Tue, 17 Mar 2026 13:32:56 +0100 Subject: [PATCH 572/587] NIP-54: Switch from Asciidoc to Djot (#2242) --- 54.md | 100 ++++++++++++++++++++++++++++++++++++---------------------- 1 file changed, 63 insertions(+), 37 deletions(-) diff --git a/54.md b/54.md index 59c49b30..ead362d2 100644 --- a/54.md +++ b/54.md @@ -43,17 +43,33 @@ For example: ## Content -The `content` should be Asciidoc with two extra functionalities: **wikilinks** and **nostr:...** links. +The `content` should be [Djot](https://djot.net/) with two special functionalities: -Unlike 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. +1. Links can have target URIs in [NIP-21](21.md) format, like `[Bob](nostr:npub1...)`. +2. When a reference can't be found for a reference-style link, it should link to the wiki article with that name instead (wikilink behavior). The target is normalized following the `d` tag normalization rules above. -Wikilinks can take these forms: +For example: - 1. `[[Target Page]]` -- links to `target-page` and displays as `Target Page`; - 2. `[[target page|see this]]` -- links to `target-page` but displays as `see this`; - 3. `[[日本語 Topic|Japanese Topic]]` -- links to `日本語-topic` and displays as `Japanese Topic`. +```djot +Bitcoin is a [cryptocurrency][] invented by [Satoshi Nakamoto][]. -`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. +See also: [proof of work][] and [lightning network][Lightning Network]. + +[Satoshi Nakamoto]: nostr:npub1satoshi... +``` + +In the article above: +- `[cryptocurrency][]` links to the wiki article with `d` tag `"cryptocurrency"` (no reference defined, so it becomes a wikilink) +- `[Satoshi Nakamoto][]` links to the npub (reference is defined) +- `[proof of work][]` links to the article with `d` tag `"proof-of-work"` +- `[lightning network][Lightning Network]` links to `"lightning-network"`, displays as "lightning network" + +Wikilinks also work with non-Latin scripts following the same normalization rules: +- `[ビットコイン][]` → links to article with `d` tag `"ビットコイン"` +- `[Japanese Article][日本語 記事]` → links to `"日本語-記事"`, displays as "Japanese Article" +- `[Биткойн][]` → links to article with `d` tag `"биткойн"` (Cyrillic, lowercased) + +[NIP-21](21.md) `nostr:` links can also be used to link to profiles or arbitrary Nostr events. It is not recommended to link to specific versions of articles — the wikilink syntax should be preferred instead, since it should be left to the reader and their client to decide what version of any given article they want to read. ## Optional extra tags @@ -65,13 +81,40 @@ Wikilinks can take these forms: Event `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. -[INSERT EVENT EXAMPLE] +```json +{ + "content": "I added information about the block size limit", + "kind": 818, + "tags": [ + ["a", "30818:<destination-pubkey>:bitcoin", "<relay-url>"], + ["e", "<version-against-which-the-modification-was-made>", "<relay-url>"], + ["p", "<destination-pubkey>"], + ["e", "<version-to-be-merged>", "<relay-url>", "source"] + ] +} +``` + +- `.content`: an optional explanation detailing why this merge is being requested. +- `a` tag: tag of the article which should be modified (i.e. the target of this merge request). +- `e` tag: optional version of the article on which this modification is based. +- `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. + +The destination pubkey can create [NIP-25](25.md) reactions that tag the `kind:818` event with `+` or `-` to accept or reject the merge request. ## Redirects -Event `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)). +Event `kind:30819` is also defined to stand for "wiki redirects", i.e. if one thinks "BTC" should redirect to "Bitcoin" 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)). -[INSERT EVENT EXAMPLE] +```json +{ + "kind": 30819, + "tags": [ + ["d", "btc"], + ["a", "30818:<pubkey>:bitcoin", "<relay-url>"] + ], + "content": "" +} +``` ## How to decide what article to display @@ -94,40 +137,23 @@ As there could be many articles for each given name, some kind of prioritization [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. ## Forks + Wiki-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. ## Deference + Wiki-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. This is a stronger signal of trust than a `+` reaction. -This 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. +This 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 `defer` tag could effectively be considered a "deletion" of the editor's version and putting that pubkey's WoT weight behind the original author's version. -## Why Asciidoc? +## Why Djot? -Wikitext is [garbage](nostr:nevent1qqsqt0gcggry60n72uglhuhypdlmr2dm6swjj69jex5v530gcpazlzsprpmhxue69uhhyetvv9ujumn0wdmksetjv5hxxmmdqy28wumn8ghj7un9d3shjtnyv9kh2uewd9hsygpm7rrrljungc6q0tuh5hj7ue863q73qlheu4vywtzwhx42a7j9n5ueneex) and Markdown is not powerful enough (besides being too freeform and unspecified and prone to generate incompatibilities in the future). +[Djot](https://djot.net/) is a markup language created by John MacFarlane (author of Pandoc and co-author of CommonMark). It was chosen for the following reasons: -Asciidoc 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). - -## Appendix 1: Merge requests -Users can request other users to get their entries merged into someone else's entry by creating a `kind:818` event. - -```json -{ - "content": "I added information about how to make hot ice-creams", - "kind": 818, - "tags": [ - [ "a", "30818:<destination-pubkey>:hot-ice-creams", "<relay-url>" ], - [ "e", "<version-against-which-the-modification-was-made>", "<relay-url>" ], - [ "p", "<destination-pubkey>" ], - [ "e", "<version-to-be-merged>", "<relay-url>", "source" ] - ] -} -``` - -`.content`: an optional explanation detailing why this merge is being requested. -`a` tag: tag of the article which should be modified (i.e. the target of this merge request). -`e` tag: optional version of the article in which this modifications is based -`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. - -The 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 `-` +- **Well-defined spec**: Unlike Markdown (many incompatible dialects) or Asciidoc (spec tied to Ruby implementation), Djot has a clear, standalone specification. +- **Native implementations**: Available in JavaScript, Lua, Rust, Go, and other languages without transpilation. +- **Rich features**: Supports superscript, subscript, footnotes, tables, definition lists, and math — features useful for encyclopedic content. +- **Familiar syntax**: Similar to basic Markdown, making it easy to learn. +- **Fast parsing**: Designed for efficient linear-time parsing. From 699e7a28f4d6e2df10660184c4f8c159adf1582d Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Fri, 20 Mar 2026 22:33:31 -0300 Subject: [PATCH 573/587] remove mentions to note1 codes. --- 21.md | 1 - 27.md | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/21.md b/21.md index 800e490d..93526907 100644 --- a/21.md +++ b/21.md @@ -16,7 +16,6 @@ The identifiers that come after are expected to be the same as those defined in - `nostr:npub1sn0wdenkukak0d9dfczzeacvhkrgz92ak56egt7vdgzn8pv2wfqqhrjdv9` - `nostr:nprofile1qqsrhuxx8l9ex335q7he0f09aej04zpazpl0ne2cgukyawd24mayt8gpp4mhxue69uhhytnc9e3k7mgpz4mhxue69uhkg6nzv9ejuumpv34kytnrdaksjlyr9p` -- `nostr:note1fntxtkcy9pjwucqwa9mddn7v03wwwsu9j330jj350nvhpky2tuaspk6nqc` - `nostr:nevent1qqstna2yrezu5wghjvswqqculvvwxsrcvu7uc0f78gan4xqhvz49d9spr3mhxue69uhkummnw3ez6un9d3shjtn4de6x2argwghx6egpr4mhxue69uhkummnw3ez6ur4vgh8wetvd3hhyer9wghxuet5nxnepm` ### Linking HTML pages to Nostr entities diff --git a/27.md b/27.md index d75672ac..1a2fd8f6 100644 --- a/27.md +++ b/27.md @@ -48,7 +48,7 @@ After Bob publishes this event and Carol sees it, her client will initially disp ## Verbose and probably unnecessary considerations - The example above was very concrete, but it doesn't mean all clients have to implement the same flow. There could be clients that do not support autocomplete at all, so they just allow users to paste raw [NIP-19](19.md) codes into the body of text, then prefix these with `nostr:` before publishing the event. -- The flow for referencing other events is similar: a user could paste a `note1...` or `nevent1...` code and the client will turn that into a `nostr:note1...` or `nostr:nevent1...` URL. Then upon reading such references the client may show the referenced note in a preview box or something like that -- or nothing at all. +- The flow for referencing other events is similar: a user could paste a `nevent1...` code and the client will turn that into a `nostr:nevent1...` URL. Then upon reading such references the client may show the referenced note in a preview box or something like that -- or nothing at all. - Other display procedures can be employed: for example, if a client that is designed for dealing with only `kind:1` text notes sees, for example, a [`kind:30023`](23.md) `nostr:naddr1...` URL reference in the `.content`, it can, for example, decide to turn that into a link to some hardcoded webapp capable of displaying such events. - Clients may give the user the option to include or not include tags for mentioned events or profiles. If someone wants to mention `mattn` without notifying them, but still have a nice augmentable/clickable link to their profile inside their note, they can instruct their client to _not_ create a `["p", ...]` tag for that specific mention. - In the same way, if someone wants to reference another note but their reference is not meant to show up along other replies to that same note, their client can choose to not include a corresponding `["e", ...]` tag for any given `nostr:nevent1...` URL inside `.content`. Clients may decide to expose these advanced functionalities to users or be more opinionated about things. From f9c48b38c0e58119fb9b1cdc38a9179586826414 Mon Sep 17 00:00:00 2001 From: hzrd149 <8001706+hzrd149@users.noreply.github.com> Date: Wed, 25 Mar 2026 11:07:23 -0500 Subject: [PATCH 574/587] NIP-5A: Static Websites (#1538) --- 5A.md | 163 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 163 insertions(+) create mode 100644 5A.md diff --git a/5A.md b/5A.md new file mode 100644 index 00000000..7fe24b9e --- /dev/null +++ b/5A.md @@ -0,0 +1,163 @@ +NIP-5A +====== + +Pubkey Static Websites +---------------------- + +`draft` `optional` + +This nip describes a method by which static websites can be hosted under public keys using specialized host servers + +### Site Manifest Definition + +A site manifest event MUST be a replaceable or an addressable event as defined in [NIP-01](01.md). There are two types of site manifest event kinds: + +- **Root site**: Uses kind `15128` and MUST NOT include a `d` tag. This is a single replaceable event per pubkey and serves as the root site for the pubkey. +- **Named sites**: Uses kind `35128` and MUST have a `d` tag containing the site identifier. These can be smaller websites under a pubkey and can be throught of as sub-domains. + +The event MUST include one or more `path` tags that map absolute paths to sha256 hashes. Each `path` tag MUST have the format `["path", "/absolute/path", "sha256hash"]` where: +- The first element is the literal string `"path"` +- The second element is an absolute path ending with a filename and extension +- The third element is the sha256 hash of the file that will be served under this path + +The event MAY include `server` tags that hint at which blossom servers can be used to find the blobs associated with the hashes. + +The event MAY include `title` and `description` tags that provide simple site information. + +The event MAY include a `source` tag that links to the site's source code repository or source archive. The `source` tag MUST have the format `["source", "<url>"]`, where `<url>` is an absolute `http` or `https` URL. + +The site icon SHOULD be provided by setting the `/favicon.ico` path in the manifest. + +For example, a root site manifest: + +```jsonc +{ + "content": "", + "created_at": 1727373475, + "id": "5324d695ed7abf7cdd2a48deb881c93b7f4e43de702989bbfb55a1b97b35a3de", + "kind": 15128, + "pubkey": "266815e0c9210dfa324c6cba3573b14bee49da4209a9456f9484e5106cd408a5", + "sig": "f4e4a9e785f70e9fcaa855d769438fea10781e84cd889e3fcb823774f83d094cf2c05d5a3ac4aebc1227a4ebc3d56867286c15a6df92d55045658bb428fd5fb5", + "tags": [ + // path mappings: absolute path -> sha256 hash + ["path", "/index.html", "186ea5fd14e88fd1ac49351759e7ab906fa94892002b60bf7f5a428f28ca1c99"], + ["path", "/about.html", "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456"], + ["path", "/favicon.ico", "fedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321"], + // optional: blossom server hints + ["server", "https://blossom.example.com"], + // optional: site metadata + ["title", "My Nostr Site"], + ["description", "A static website hosted on Nostr"], + // optional: source code location + ["source", "https://github.com/example/my-nostr-site"] + ] +} +``` + +And a named site manifest: + +```jsonc +{ + "content": "", + "created_at": 1727373475, + "id": "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456", + "kind": 35128, + "pubkey": "266815e0c9210dfa324c6cba3573b14bee49da4209a9456f9484e5106cd408a5", + "sig": "f4e4a9e785f70e9fcaa855d769438fea10781e84cd889e3fcb823774f83d094cf2c05d5a3ac4aebc1227a4ebc3d56867286c15a6df92d55045658bb428fd5fb5", + "tags": [ + // site identifier + ["d", "blog"], + // path mappings: absolute path -> sha256 hash + ["path", "/index.html", "186ea5fd14e88fd1ac49351759e7ab906fa94892002b60bf7f5a428f28ca1c99"], + ["path", "/post.html", "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456"], + // optional: blossom server hints + ["server", "https://blossom.example.com"], + // optional: site metadata + ["title", "My Blog"], + ["description", "A blog hosted on Nostr"], + // optional: source code location + ["source", "https://github.com/example/my-nostr-blog"] + ] +} +``` + +### Host server implementation + +A host server is a HTTP server that is responsible for serving pubkey static websites + +#### Resolving Pubkeys + +For interoperability, host servers SHOULD use the following canonical URL formats: + +- Root site: `<npub>.nsite-host.com` +- Named site: `<pubkeyB36><dTag>.nsite-host.com` + +`pubkeyB36` is the author's raw 32-byte pubkey encoded with base36 (lowercase, digits `0-9` then letters `a-z`, no padding) and is always exactly 50 characters. + +`dTag` is the site identifier (`d` tag value) as plain text. It is appended directly after `pubkeyB36` with no separator. + +For canonical named-site URLs, `dTag` MUST match `^[a-z0-9-]{1,13}$` and MUST NOT end with `-`. + +Because DNS labels are limited to 63 characters and `pubkeyB36` uses 50 of them, `dTag` MUST be 1-13 characters. + +This single-label format avoids wildcard certificate limitations with multi-level subdomains. + +If the host server is using subdomain routing it MAY serve anything at its own root domain `nsite-host.com` (a landing page for example). + +Example subdomains: +- Root site: `npub10phxfsms72rhafrklqdyhempujs9h67nye0p67qe424dyvcx0dkqgvap0e.nsite-host.com` +- Named site: `<50-char-pubkeyB36><dTag>.nsite-host.com` + +#### Resolving Paths + +When the host server receives a request and is able to determine the pubkey and identifier, it should fetch the users `10002` [NIP-65](https://github.com/nostr-protocol/nips/blob/master/65.md) relay list and lookup the site manifest event for the pubkey and identifier. + +For canonical subdomain formats, the host server MUST parse the left-most DNS label as follows: + +1. If the label is a valid `npub`, decode it and query for the root site manifest. +2. Otherwise, if the label matches `^[0-9a-z]{50}[a-z0-9-]{1,13}$` and does not end with `-`, treat it as a named-site label where: + - `pubkeyB36` is the first 50 characters + - `dTag` is the remaining 1-13 characters + - decode `pubkeyB36` to a 32-byte pubkey + - use `dTag` as the identifier (`d` tag value) + +If parsing fails, the host server MUST treat the site as not found. + +The host server should query for the site manifest event: + +```jsonc +// For root site (kind 15128, no d tag) +{ "kinds": [15128], "authors": [<pubkey>] } + +// For named site (kind 35128, with d tag) +{ "kinds": [35128], "authors": [<pubkey>], "#d": [<identifier>] } +``` + +Once the site manifest event is found, the host server MUST extract the path-to-hash mappings from the `path` tags in the manifest. The host server should look for a `path` tag where the second element matches the requested path. + +If the request path does not end with a filename the host server MUST fallback to using the `index.html` filename + +For example: `/` -> `/index.html` or `/blog/` -> `/blog/index.html` + +#### Resolving Files + +Once the host server has found the site manifest event and located the matching `path` tag for the requested path, it should use the sha256 hash defined in the third element of the `path` tag to retrieve the file. + +The host server SHOULD prioritize using `server` tags from the site manifest event as hints for which blossom servers to query. If the manifest includes `server` tags, the host server SHOULD attempt to retrieve the file from those servers first. + +If the pubkey has a `10063` [BUD-03 user servers](https://github.com/hzrd149/blossom/blob/master/buds/03.md) event the server MUST attempt to retrieve the file from the listed servers using the path defined in [BUD-01](https://github.com/hzrd149/blossom/blob/master/buds/01.md#get-sha256---get-blob) +If a pubkey does not have a `10063` event and no `server` tags are found in the manifest, the host server MUST respond with a status code 404 + +The host server MUST forward the `Content-Type`, and `Content-Length` headers from the Blossom server. If none are defined the host server MAY set `Content-Type` from the file extension in the requested path + +#### Handling Not Found + +If a host server is unable to find a site manifest event or a matching `path` tag for the requested path, it MUST use `/404.html` as a fallback path + +### Legacy Support + +Kind `34128` is marked as legacy/deprecated. This kind was used for individual static file events where each file was represented by a separate event with a `d` tag for the path and an `x` tag for the sha256 hash. + +Host servers MAY still support kind `34128` for backward compatibility with existing sites, but new sites SHOULD use kind `15128` (root site manifest) or kind `35128` (named site manifest) instead. + +Read the [legacy version](https://github.com/hzrd149/nips/blob/41e77b45a1e8a8d170097e363f7d7254797cc5c5/nsite.md) for more details. From 2a77e2fdda188779f5420954ad6ff396b4578ce5 Mon Sep 17 00:00:00 2001 From: Alex Gleason <alex@alexgleason.me> Date: Wed, 25 Mar 2026 11:38:22 -0500 Subject: [PATCH 575/587] Add NIP-5A and nsite kinds to README (#2286) --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index e533ff4a..d9f84b4a 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-57: Lightning Zaps](57.md) - [NIP-58: Badges](58.md) - [NIP-59: Gift Wrap](59.md) +- [NIP-5A: Pubkey Static Websites](5A.md) - [NIP-60: Cashu Wallet](60.md) - [NIP-61: Nutzaps](61.md) - [NIP-62: Request to Vanish](62.md) @@ -223,6 +224,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `13194` | Wallet Info | [47](47.md) | | `13534` | Membership Lists | [43](43.md) | | `14388` | User Sound Effect Lists | [Corny Chat][cornychat-usersoundlist] | +| `15128` | Root nsite manifest | [5A](5A.md) | | `17375` | Cashu Wallet Event | [60](60.md) | | `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | | `22242` | Client Authentication | [42](42.md) | @@ -288,6 +290,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `34236` | Addressable Short Video Event | [71](71.md) | | `34388` | Sound Effects | [Corny Chat][cornychat-soundeffects] | | `34550` | Community Definition | [72](72.md) | +| `34128` | Legacy nsite manifest | [5A](5A.md) (deprecated) | +| `35128` | Named nsite manifest | [5A](5A.md) | | `38172` | Cashu Mint Announcement | [87](87.md) | | `38173` | Fedimint Announcement | [87](87.md) | | `37516` | Geocache listing | [geocaching](geocaching) | From d004b4cb4874ca40119aa219b0438d835f712d8d Mon Sep 17 00:00:00 2001 From: Alex Gleason <alex@alexgleason.me> Date: Mon, 30 Mar 2026 11:58:53 -0500 Subject: [PATCH 576/587] NIP-30: Update shortcode description to include hyphens (#2297) --- 30.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/30.md b/30.md index c9b9ebe0..40db0b5e 100644 --- a/30.md +++ b/30.md @@ -14,7 +14,7 @@ Custom emoji may be added to **kind 0**, **kind 1**, **kind 7** ([NIP-25](25.md) Where: -- `<shortcode>` is a name given for the emoji, which MUST be comprised of only alphanumeric characters and underscores. +- `<shortcode>` is a name given for the emoji, which MUST be comprised of only alphanumeric characters, hyphens, and underscores. - `<image-url>` is a URL to the corresponding image file of the emoji. - `<emoji-set-address>` is an optional address pointer (`kind:pubkey:d-tag`) to the kind 30030 emoji set ([NIP-51](51.md)) the emoji belongs to. From ad8f29090795c03ad68c0b29e8e1af906c0e614d Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Tue, 31 Mar 2026 10:24:51 -0300 Subject: [PATCH 577/587] add nip34-related follow lists (#2130) --- 51.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/51.md b/51.md index f9d6e56f..eec64e38 100644 --- a/51.md +++ b/51.md @@ -39,6 +39,8 @@ For example, _mute list_ can contain the public keys of spammers and bad actors | DM relays | 10050 | Where to receive [NIP-17](17.md) direct messages | `"relay"` (see [NIP-17](17.md)) | | Good wiki authors | 10101 | [NIP-54](54.md) user recommended wiki authors | `"p"` (pubkeys) | | Good wiki relays | 10102 | [NIP-54](54.md) relays deemed to only host useful articles | `"relay"` (relay URLs) | +| Git authors | 10017 | code (people who produce NIP-34 events) follow list | `"p"` (pubkeys -- with optional relay hint and petname) | +| Git repositories | 10018 | [NIP-34](34.md) followed repositories | `"a"` (kind:30617 repository announcement event) | ### Sets From 420f0b181434c348e487c6ffaa8fea6111c10210 Mon Sep 17 00:00:00 2001 From: Alex Gleason <alex@alexgleason.me> Date: Wed, 1 Apr 2026 14:17:44 -0500 Subject: [PATCH 578/587] NIP-58: change Profile Badges to kind 10008, add kind 30008 Badge sets (#2276) --- 51.md | 2 ++ 58.md | 20 +++++++++++--------- README.md | 3 ++- 3 files changed, 15 insertions(+), 10 deletions(-) diff --git a/51.md b/51.md index eec64e38..aca3ea5f 100644 --- a/51.md +++ b/51.md @@ -31,6 +31,7 @@ For example, _mute list_ can contain the public keys of spammers and bad actors | Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) | | Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) | | Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) | +| Profile badges | 10008 | [NIP-58](58.md) badges a user has accepted and chosen to display | `"a"` (kind:30009 badge definitions) and `"e"` (kind:8 badge awards), and `"a"` (kind:30008 badge set) | | Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group id + relay URL + optional group name), `"r"` for each relay in use | | Relay feeds | 10012 | user favorite browsable relays (and relay sets) | `"relay"` (relay URLs) and `"a"` (kind:30002 relay set) | | Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) | @@ -59,6 +60,7 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti | Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"e"` (kind:21 videos) | | Curation sets | 30006 | groups of pictures picked by users as interesting and/or belonging to the same category | `"e"` (kind:20 pictures) | | Kind mute sets | 30007 | mute pubkeys by kinds<br>`"d"` tag MUST be the kind string | `"p"` (pubkeys) | +| Badge sets | 30008 | [NIP-58](58.md) categorized groups of badges | `"a"` (kind:30009 badge definitions) and `"e"` (kind:8 badge awards) | | Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) | | Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | | Release artifact sets | 30063 | group of artifacts of a software release | `"e"` (kind:1063 [file metadata](94.md) events), `"a"` (software application event) | diff --git a/58.md b/58.md index 00119977..69bb110d 100644 --- a/58.md +++ b/58.md @@ -6,15 +6,18 @@ Badges `draft` `optional` -Three special events are used to define, award and display badges in +Four special events are used to define, award, display and categorize badges in user profiles: 1. 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. 2. 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-transferable. -3. A "Profile Badges" event is defined as an _addressable event_ with kind `30008` with a `d` tag with the value `profile_badges`. -Profile 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. +3. A "Profile Badges" event is defined as a _replaceable event_ with kind `10008` as a [NIP-51](51.md) standard list. +Profile 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. It may also contain `a` tags referencing "Badge Set" events. + +4. A "Badge Set" event is defined as an _addressable event_ with kind `30008` as a [NIP-51](51.md) set. +Badge sets allow users to categorize accepted badges into labeled groups. They contain ordered pairs of `a` and `e` tags referencing a `Badge Definition` and a `Badge Award` for each badge in the set. ### Badge Definition event @@ -43,10 +46,6 @@ The number of badges a pubkey can be awarded is unbounded. The Profile Badge event allows individual users to accept or reject awarded badges, as well as choose the display order of badges on their profiles. -The following tags MUST be present: - -- A `d` tag with the unique identifier `profile_badges` - The following tags MAY be present: - Zero or more ordered consecutive pairs of `a` and `e` tags referencing a kind `30009` Badge Definition and kind `8` Badge Award, respectively. Clients SHOULD @@ -109,10 +108,9 @@ Clients SHOULD attempt to render the most appropriate badge thumbnail according Honorable Bob The Brave: ```jsonc { - "kind": 30008, + "kind": 10008, "pubkey": "bob", "tags": [ - ["d", "profile_badges"], ["a", "30009:alice:bravery"], ["e", "<bravery badge award event id>", "wss://nostr.academy"], ["a", "30009:alice:honor"], @@ -121,3 +119,7 @@ Honorable Bob The Brave: // other fields... } ``` + +### Deprecated Profile Badges event + +An earlier version of this NIP used a kind `30008` addressable event with a `d` tag value of `profile_badges` for the Profile Badges event. Clients should treat these events as equivalent to kind `10008` and migrate to the new format. diff --git a/README.md b/README.md index d9f84b4a..07cd6cb5 100644 --- a/README.md +++ b/README.md @@ -205,6 +205,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10005` | Public chats list | [51](51.md) | | `10006` | Blocked relays list | [51](51.md) | | `10007` | Search relays list | [51](51.md) | +| `10008` | Profile Badges | [51](51.md), [58](58.md) | | `10009` | User groups | [51](51.md), [29](29.md) | | `10011` | External Identities | [39](39.md) | | `10012` | Favorite relays list | [51](51.md) | @@ -244,7 +245,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30005` | Video sets | [51](51.md) | | `30006` | Picture sets | [51](51.md) | | `30007` | Kind mute sets | [51](51.md) | -| `30008` | Profile Badges | [58](58.md) | +| `30008` | Badge sets | [51](51.md), [58](58.md) | | `30009` | Badge Definition | [58](58.md) | | `30015` | Interest sets | [51](51.md) | | `30017` | Create or update a stall | [15](15.md) | From 0a25dd524389d642ec153d9009a16fb183eb23ce Mon Sep 17 00:00:00 2001 From: DanConwayDev <114834599+DanConwayDev@users.noreply.github.com> Date: Fri, 10 Apr 2026 22:21:56 +0100 Subject: [PATCH 579/587] NIP-34 add `nostr://` clone urls spec (#2312) --- 34.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/34.md b/34.md index d35c0eb2..be7d4455 100644 --- a/34.md +++ b/34.md @@ -37,6 +37,27 @@ The `r` tag annotated with the `"euc"` marker should be the commit ID of the ear Except `d`, all tags are optional. +### Nostr Clone URL format + +A `nostr://` URL can be used to reference a repository announcement in a way that is compatible with `git clone` when a [git-remote-nostr](https://git-scm.com/docs/gitremote-helpers) helper is installed: + +``` +nostr://<naddr> +nostr://<npub|nip05>/<identifier> +nostr://<npub|nip05>/<relay-hint>/<identifier> +``` + +Both `<relay-hint>` and `<identifier>` MUST be percent-encoded per [RFC 3986 §2.1](https://datatracker.ietf.org/doc/html/rfc3986#section-2.1). `<relay-hint>` is a relay URL whose `wss://` scheme may be omitted for brevity. `<identifier>` is the `d` tag value of the kind `30617` event. + +Examples: + +``` +nostr://npub15qydau2hjma6ngxkl2cyar74wzyjshvl65za5k5rl69264ar2exs5cyejr/relay.ngit.dev/ngit +nostr://npub15qydau2hjma6ngxkl2cyar74wzyjshvl65za5k5rl69264ar2exs5cyejr/my%20%F0%9F%9A%80%20repo +nostr://danconwaydev.com/ws%3A%2F%2Flocalhost%3A7334/my-local-only-repo +nostr://danconwaydev.com/relay.ngit.dev/ngit +``` + ## Repository state announcements An optional source of truth for the state of branches and tags in a repository. @@ -239,7 +260,7 @@ The event SHOULD include a list of `g` tags with grasp service websocket URLs in "content": "", "tags": [ ["g", "<grasp-service-websocket-url>"], // zero or more grasp sever urls - ] + ], } ``` From 6735a229bcf0a75bf32f3e4f429ecd7675929356 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Mon, 30 Mar 2026 08:58:57 -0300 Subject: [PATCH 580/587] nip29: match flotilla style "edit-metadata" (PUT, not PATCH). because hodlbod controls nostr --- 29.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/29.md b/29.md index f39d4d81..9d20ef2e 100644 --- a/29.md +++ b/29.md @@ -112,15 +112,15 @@ Clients can send these events to a relay in order to accomplish a moderation act Each moderation action uses a different kind and requires different arguments, which are given as tags. These are defined in the following table: -| kind | name | tags | -| --- | --- | --- | -| 9000 | `put-user` | `p` with pubkey hex and optional roles | -| 9001 | `remove-user` | `p` with pubkey hex | -| 9002 | `edit-metadata` | fields to be modified, and optionally `unrestricted`, `open`, `visible` `public` | -| 9005 | `delete-event` | `e` with event id hex | -| 9007 | `create-group` | | -| 9008 | `delete-group` | | -| 9009 | `create-invite` | arbitrary `code` | +| kind | name | tags | +| --- | --- | --- | +| 9000 | `put-user` | `p` with pubkey hex and optional roles | +| 9001 | `remove-user` | `p` with pubkey hex | +| 9002 | `edit-metadata` | all the fields of *group-metadata* | +| 9005 | `delete-event` | `e` with event id hex | +| 9007 | `create-group` | | +| 9008 | `delete-group` | | +| 9009 | `create-invite` | arbitrary `code` | It'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. From 59c046fd42aabe7574304c687dae80f50edda662 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Wed, 22 Apr 2026 12:01:43 -0300 Subject: [PATCH 581/587] add blossom server list to nip-51. --- 51.md | 1 + 1 file changed, 1 insertion(+) diff --git a/51.md b/51.md index aca3ea5f..c5359517 100644 --- a/51.md +++ b/51.md @@ -38,6 +38,7 @@ For example, _mute list_ can contain the public keys of spammers and bad actors | Media follows | 10020 | multimedia (photos, short video) follow list | `"p"` (pubkeys -- with optional relay hint and petname) | | Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | | DM relays | 10050 | Where to receive [NIP-17](17.md) direct messages | `"relay"` (see [NIP-17](17.md)) | +| Blossom servers | 10063 | Servers where to upload and look for images and other blobs | `"server"` (see [NIP-B7](B7.md)) | | Good wiki authors | 10101 | [NIP-54](54.md) user recommended wiki authors | `"p"` (pubkeys) | | Good wiki relays | 10102 | [NIP-54](54.md) relays deemed to only host useful articles | `"relay"` (relay URLs) | | Git authors | 10017 | code (people who produce NIP-34 events) follow list | `"p"` (pubkeys -- with optional relay hint and petname) | From f7cbaebcea5ebcae74f5e30b7a29da488019a8f1 Mon Sep 17 00:00:00 2001 From: DanConwayDev <114834599+DanConwayDev@users.noreply.github.com> Date: Sat, 25 Apr 2026 17:41:38 +0100 Subject: [PATCH 582/587] NIP-34: remove incorrect claim about NIP-09 and state reset (#2326) --- 34.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/34.md b/34.md index be7d4455..fa4c87cc 100644 --- a/34.md +++ b/34.md @@ -76,8 +76,6 @@ An optional source of truth for the state of branches and tags in a repository. The `refs` tag may appear multiple times, or none. -If 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. - The `refs` tag can be optionally extended to enable clients to identify how many commits ahead a ref is: ```jsonc From 7092ea99b27bd00c26663c200553654bd2f87169 Mon Sep 17 00:00:00 2001 From: DanConwayDev <114834599+DanConwayDev@users.noreply.github.com> Date: Sat, 25 Apr 2026 17:42:57 +0100 Subject: [PATCH 583/587] NIP-34: remove unused refs tag extension (#2325) Co-authored-by: fiatjaf <fiatjaf@gmail.com> --- 34.md | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/34.md b/34.md index fa4c87cc..f3d41e42 100644 --- a/34.md +++ b/34.md @@ -76,16 +76,6 @@ An optional source of truth for the state of branches and tags in a repository. The `refs` tag may appear multiple times, or none. -The `refs` tag can be optionally extended to enable clients to identify how many commits ahead a ref is: - -```jsonc -{ - "tags": [ - ["refs/<heads|tags>/<branch-or-tag-name>", "<commit-id>", "<shorthand-parent-commit-id>", "<shorthand-grandparent>", ...], - ] -} -``` - ## Patches and Pull Requests (PRs) Patches and PRs can be sent by anyone to any repository. Patches and PRs to a specific repository SHOULD be sent to the relays specified in that repository's announcement event's `"relays"` tag. Patch and PR events SHOULD include an `a` tag pointing to that repository's announcement address. From 22244f9d2620ae4f064fc0f212dcb07675ced3ed Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Sat, 25 Apr 2026 23:17:45 -0300 Subject: [PATCH 584/587] rename 5A for clarity. --- 5A.md | 6 +++--- README.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/5A.md b/5A.md index 7fe24b9e..061e89f6 100644 --- a/5A.md +++ b/5A.md @@ -1,12 +1,12 @@ NIP-5A ====== -Pubkey Static Websites ----------------------- +Static Websites (nsites) +------------------------ `draft` `optional` -This nip describes a method by which static websites can be hosted under public keys using specialized host servers +This NIP describes a method by which static websites can be hosted from Blossom assets. ### Site Manifest Definition diff --git a/README.md b/README.md index 07cd6cb5..4ea2f76d 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-57: Lightning Zaps](57.md) - [NIP-58: Badges](58.md) - [NIP-59: Gift Wrap](59.md) -- [NIP-5A: Pubkey Static Websites](5A.md) +- [NIP-5A: Static Websites (nsites)](5A.md) - [NIP-60: Cashu Wallet](60.md) - [NIP-61: Nutzaps](61.md) - [NIP-62: Request to Vanish](62.md) From 05d3f198c61c2732ccf15ba8005299365dabb8e0 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Tue, 28 Apr 2026 21:23:12 -0300 Subject: [PATCH 585/587] mention optional thumbhash alongside blurhash on nip17 and nip68. --- 17.md | 1 + 68.md | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/17.md b/17.md index 3ccdc772..6e44b0d8 100644 --- a/17.md +++ b/17.md @@ -80,6 +80,7 @@ Kind `15` is used for sending encrypted file event messages: - `ox` containing the SHA-256 hexencoded string of the file before encryption. - `size` (optional) size of the encrypted file in bytes - `dim` (optional) size in pixels in the form `<width>x<height>` +- `thumbhash`(optional) the [thumbhash](https://evanw.github.io/thumbhash/) to show while the client is loading the file - `blurhash`(optional) the [blurhash](https://github.com/woltapp/blurhash) to show while the client is loading the file - `thumb` (optional) URL of thumbnail with same aspect ratio (encrypted with the same key, nonce) - `fallback` (optional) zero or more fallback file sources in case `url` fails (encrypted with the same key, nonce) diff --git a/68.md b/68.md index 918378a9..89b95894 100644 --- a/68.md +++ b/68.md @@ -31,6 +31,7 @@ They may contain multiple images to be displayed as a single post. "imeta", "url https://nostr.build/i/my-image.jpg", "m image/jpeg", + "thumbhash zOcFFIIKmXdCinaXaHcmcHUFSA==", "blurhash eVF$^OI:${M{o#*0-nNFxakD-?xVM}WEWB%iNKxvR-oetmo#R-aen$", "dim 3024x4032", "alt A scenic photo overlooking the coast of Costa Rica", @@ -42,7 +43,7 @@ They may contain multiple images to be displayed as a single post. "imeta", "url https://nostr.build/i/my-image2.jpg", "m image/jpeg", - "blurhash eVF$^OI:${M{o#*0-nNFxakD-?xVM}WEWB%iNKxvR-oetmo#R-aen$", + "thumbhash zOcFFIIKmXgzmWaXWIcmcFQEGA", "dim 3024x4032", "alt Another scenic photo overlooking the coast of Costa Rica", "x <sha256 hash as specified in NIP 94>", From c0fa8bf2c7fa4ac5ec089e764042f8fc070bc2b5 Mon Sep 17 00:00:00 2001 From: juanfradb <94815906+juanfradb@users.noreply.github.com> Date: Mon, 11 May 2026 20:27:14 -0300 Subject: [PATCH 586/587] Fix README reference links (#2338) --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4ea2f76d..9bdc4c18 100644 --- a/README.md +++ b/README.md @@ -149,9 +149,9 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `44` | Channel Mute User | [28](28.md) | | `62` | Request to Vanish | [62](62.md) | | `64` | Chess (PGN) | [64](64.md) | -| `443` | KeyPackage | [Marmot](marmot) | -| `444` | Welcome Message | [Marmot](marmot) | -| `445` | Group Event | [Marmot](marmot) | +| `443` | KeyPackage | [Marmot][marmot] | +| `444` | Welcome Message | [Marmot][marmot] | +| `445` | Group Event | [Marmot][marmot] | | `818` | Merge Requests | [54](54.md) | | `1018` | Poll Response | [88](88.md) | | `1021` | Bid | [15](15.md) | @@ -215,7 +215,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10020` | Media follows | [51](51.md) | | `10030` | User emoji list | [51](51.md) | | `10050` | Relay list to receive DMs | [51](51.md), [17](17.md) | -| `10051` | KeyPackage Relays List | [Marmot](marmot) | +| `10051` | KeyPackage Relays List | [Marmot][marmot] | | `10063` | User server list | [Blossom][blossom] | | `10096` | File storage server list | [96](96.md) (deprecated) | | `10166` | Relay Monitor Announcement | [66](66.md) | @@ -295,7 +295,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `35128` | Named nsite manifest | [5A](5A.md) | | `38172` | Cashu Mint Announcement | [87](87.md) | | `38173` | Fedimint Announcement | [87](87.md) | -| `37516` | Geocache listing | [geocaching](geocaching) | +| `37516` | Geocache listing | [geocaching][geocaching] | | `38383` | Peer-to-peer Order events | [69](69.md) | | `39000-9` | Group metadata events | [29](29.md) | | `39089` | Starter packs | [51](51.md) | From d37b566b2eee73723577bf5ff2bd87306d6b7d6c Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Wed, 13 May 2026 09:14:41 -0300 Subject: [PATCH 587/587] nip70: reposts that embed protected events must be rejected (#2251) --- 70.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/70.md b/70.md index 32853d37..0b4857e4 100644 --- a/70.md +++ b/70.md @@ -14,6 +14,8 @@ The default behavior of a relay MUST be to reject any event that contains `["-"] Relays 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. +Reposts of protected events MUST NOT embed the reposted event. If a repost of a protected event embeds the event anyway, relays SHOULD summarily reject it. + ## The tag The tag is a simple tag with a single item: `["-"]`. It may be added to any event.