From b8f2e14e6dc6b688605e55c86e68ac17b53338f0 Mon Sep 17 00:00:00 2001 From: Vivek Ganesan Date: Thu, 11 May 2023 20:39:40 +0530 Subject: [PATCH 001/129] 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/129] 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 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 003/129] 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 004/129] 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 005/129] 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 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 006/129] Commit suggestion Co-authored-by: hodlbod --- 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 f549b66f67dffea317efbe192631503dfdac2e9d Mon Sep 17 00:00:00 2001 From: Jon Staab Date: Thu, 26 Oct 2023 10:06:29 -0700 Subject: [PATCH 007/129] 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 e97df1410391dd04fdbf9695932275a9d763940c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=9B=AA=E7=8C=AB?= Date: Sat, 13 Apr 2024 12:39:24 +0900 Subject: [PATCH 008/129] 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
`"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 280eb498e0ac56b8f9356c1b7a88cc8b31579801 Mon Sep 17 00:00:00 2001 From: Oscar Merry Date: Fri, 19 Apr 2024 14:30:45 +0100 Subject: [PATCH 009/129] 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 b7bb46ac038bc5411f55bfa7646259da203c13c3 Mon Sep 17 00:00:00 2001 From: Oscar Merry Date: Thu, 9 May 2024 12:27:43 +0100 Subject: [PATCH 010/129] 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 d33b223c6afe2be3d197d2cdb4686961a6fb2b29 Mon Sep 17 00:00:00 2001 From: Oscar Merry Date: Thu, 16 May 2024 20:44:45 +0100 Subject: [PATCH 011/129] 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 53afaaece61f02e92b5ef9c3e9c32945c7ebf522 Mon Sep 17 00:00:00 2001 From: kieran Date: Mon, 27 May 2024 12:18:27 +0100 Subject: [PATCH 012/129] 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 `x` +* `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", ""], ["title", ""], - ["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 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 013/129] 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 014/129] 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 015/129] 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 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 016/129] 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 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 017/129] 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 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 018/129] 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 019/129] 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 020/129] 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 021/129] 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 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 022/129] 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 023/129] 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 024/129] 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 025/129] 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 026/129] 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 027/129] 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 028/129] 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 029/129] 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 030/129] 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 031/129] 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 032/129] 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 033/129] 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 034/129] 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 035/129] 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 036/129] 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 037/129] 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 038/129] 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 039/129] 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 040/129] 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 041/129] 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 042/129] 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 043/129] 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 044/129] 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 045/129] 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 046/129] 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 047/129] 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 048/129] 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 049/129] 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 050/129] 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 051/129] 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 052/129] 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 053/129] 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 054/129] 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 055/129] 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 056/129] 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 057/129] 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 058/129] 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 059/129] 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 060/129] 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 061/129] 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 062/129] 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 063/129] 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 064/129] 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 065/129] 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 066/129] 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 067/129] 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 068/129] 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 069/129] 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 070/129] 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 071/129] 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 072/129] 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 073/129] 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 074/129] 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 075/129] 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 076/129] 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 077/129] 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 078/129] 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 079/129] 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 080/129] 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 081/129] 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 082/129] 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 083/129] 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 084/129] 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 085/129] 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 086/129] 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 087/129] 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 088/129] 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 089/129] 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 090/129] 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 091/129] 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 092/129] 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 093/129] 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 094/129] 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 095/129] 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 096/129] 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 097/129] 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 098/129] 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 099/129] 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 100/129] 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 101/129] 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 102/129] 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 103/129] 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 104/129] 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 105/129] 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 106/129] 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 107/129] 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 108/129] 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 109/129] 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 110/129] 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 111/129] 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 112/129] 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 113/129] 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 114/129] 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 115/129] 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 116/129] 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 117/129] 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 118/129] 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 119/129] 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 120/129] 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 121/129] 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 122/129] 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 f1e8d2c4f764d66996c0c1fb2eeabfbc0c7b2528 Mon Sep 17 00:00:00 2001 From: fiatjaf <fiatjaf@gmail.com> Date: Thu, 24 Oct 2024 20:59:15 -0300 Subject: [PATCH 123/129] 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 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 124/129] 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 125/129] 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 126/129] 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 127/129] 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 128/129] 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 129/129] 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)