From e4937befd6fc29482387ab18a7fab98338dba55d Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Tue, 23 May 2023 13:44:58 -0400 Subject: [PATCH 01/61] Zap splits --- 57.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/57.md b/57.md index cb1f126..987b5a2 100644 --- a/57.md +++ b/57.md @@ -168,16 +168,20 @@ A client can retrieve `zap receipt`s on events and pubkeys using a NIP-01 filter ### Appendix G: `zap` tag on zapped event -When an event includes a `zap` tag, clients SHOULD calculate the lnurl pay request based on it's value instead of the profile's field. An optional third argument on the tag specifies the type of value, either `lud06` or `lud16`. +When an event includes one or more `zap` tags, clients SHOULD calculate the lnurl pay request based on their value instead of the profile's field. The tag's second argument is a `lud06` address, `lud16` identifier or `hex` string of the receiver's pub key. An optional third argument specifies the type of the previous value: `lud06`, `lud16` or `pubkey`. 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 member. If weights are not present, CLIENTS should equally divide the zap amount to all zap receivers. If weights are only partially present, receivers without a weight should not be zapped (`weight = 0`). ```json { "tags": [ - [ "zap", "pablo@f7z.io", "lud16" ] + [ "zap", "LNURL..", "lud06", 10 ], // 10% + [ "zap", "pablo@f7z.io", "lud16", 65 ], // 65% + [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", 25 ] // 25% ] } ``` +When the hex code is used, clients MAY inform the user the zap split configuration in the note. + ## Future Work Zaps can be extended to be more private by encrypting `zap request` notes to the target user, but for simplicity it has been left out of this initial draft. From a56d650333c03a51b1f2d7852670216489ff35d6 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Tue, 23 May 2023 13:46:05 -0400 Subject: [PATCH 02/61] fixing json formatting --- 57.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/57.md b/57.md index 987b5a2..e67ec8b 100644 --- a/57.md +++ b/57.md @@ -173,9 +173,9 @@ When an event includes one or more `zap` tags, clients SHOULD calculate the lnur ```json { "tags": [ - [ "zap", "LNURL..", "lud06", 10 ], // 10% + [ "zap", "LNURL..", "lud06", 10 ], // 10% [ "zap", "pablo@f7z.io", "lud16", 65 ], // 65% - [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", 25 ] // 25% + [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", 25 ] // 25% ] } ``` From dd5c9c54ae33c0480b2f12b604353b738c827115 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Tue, 23 May 2023 13:50:55 -0400 Subject: [PATCH 03/61] Changes the client guidance --- 57.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/57.md b/57.md index e67ec8b..7471685 100644 --- a/57.md +++ b/57.md @@ -180,7 +180,7 @@ When an event includes one or more `zap` tags, clients SHOULD calculate the lnur } ``` -When the hex code is used, clients MAY inform the user the zap split configuration in the note. +Clients MAY display the zap split configuration in the note. ## Future Work From 7c3e5902471b2eccf8032c06ab4e07940dd56ae7 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Wed, 24 May 2023 09:46:36 -0400 Subject: [PATCH 04/61] Moves weights to be a string as tags can only contain strings --- 57.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/57.md b/57.md index 7471685..4d02611 100644 --- a/57.md +++ b/57.md @@ -173,9 +173,9 @@ When an event includes one or more `zap` tags, clients SHOULD calculate the lnur ```json { "tags": [ - [ "zap", "LNURL..", "lud06", 10 ], // 10% - [ "zap", "pablo@f7z.io", "lud16", 65 ], // 65% - [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", 25 ] // 25% + [ "zap", "LNURL..", "lud06", "10" ], // 10% + [ "zap", "pablo@f7z.io", "lud16", "65" ], // 65% + [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", "25" ] // 25% ] } ``` From 9c97736066a131442a5e43420f0600904959d1cf Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Wed, 24 May 2023 10:10:18 -0400 Subject: [PATCH 05/61] minor text/grammar adjustments --- 57.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/57.md b/57.md index 4d02611..a221481 100644 --- a/57.md +++ b/57.md @@ -168,7 +168,7 @@ A client can retrieve `zap receipt`s on events and pubkeys using a NIP-01 filter ### Appendix G: `zap` tag on zapped event -When an event includes one or more `zap` tags, clients SHOULD calculate the lnurl pay request based on their value instead of the profile's field. The tag's second argument is a `lud06` address, `lud16` identifier or `hex` string of the receiver's pub key. An optional third argument specifies the type of the previous value: `lud06`, `lud16` or `pubkey`. 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 member. If weights are not present, CLIENTS should equally divide the zap amount to all zap receivers. If weights are only partially present, receivers without a weight should not be zapped (`weight = 0`). +When an event includes one or more `zap` tags, clients SHOULD calculate the lnurl pay request based on their value instead of the profile's field. The tag's second argument is a `lud06` address, a `lud16` identifier or a `hex` string of the receiver's pub key. An optional third argument specifies the type of the previous value: `lud06`, `lud16` or `pubkey`. 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`). ```json { From 2f8be7c32b7b624ed65b3238d3ada9f2f8859777 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Wed, 24 May 2023 10:41:14 -0400 Subject: [PATCH 06/61] better example of weights. --- 57.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/57.md b/57.md index a221481..cb6a290 100644 --- a/57.md +++ b/57.md @@ -170,12 +170,12 @@ 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 SHOULD calculate the lnurl pay request based on their value instead of the profile's field. The tag's second argument is a `lud06` address, a `lud16` identifier or a `hex` string of the receiver's pub key. An optional third argument specifies the type of the previous value: `lud06`, `lud16` or `pubkey`. 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`). -```json +```js { "tags": [ - [ "zap", "LNURL..", "lud06", "10" ], // 10% - [ "zap", "pablo@f7z.io", "lud16", "65" ], // 65% - [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", "25" ] // 25% + [ "zap", "LNURL..", "lud06", "1" ], // 25% + [ "zap", "pablo@f7z.io", "lud16", "1" ], // 25% + [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", "2" ] // 50% ] } ``` From 5834c054398b39404868746db973ea7f373d1392 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Wed, 24 May 2023 12:20:53 -0400 Subject: [PATCH 07/61] Dropping lud06 and lud16 from the zap tag --- 57.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/57.md b/57.md index cb6a290..27b85a4 100644 --- a/57.md +++ b/57.md @@ -166,16 +166,16 @@ A client can retrieve `zap receipt`s on events and pubkeys using a NIP-01 filter - The `invoiceAmount` contained in the `bolt11` tag of the `zap receipt` MUST equal the `amount` tag of the `zap request` (if present). - The `lnurl` tag of the `zap request` (if present) SHOULD equal the recipient's `lnurl`. -### Appendix G: `zap` tag on zapped event +### Appendix G: `zap` tag on other events -When an event includes one or more `zap` tags, clients SHOULD calculate the lnurl pay request based on their value instead of the profile's field. The tag's second argument is a `lud06` address, a `lud16` identifier or a `hex` string of the receiver's pub key. An optional third argument specifies the type of the previous value: `lud06`, `lud16` or `pubkey`. 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`). +When an event includes one or more `zap` tags, clients wishing to zap it SHOULD calculate the lnurl pay request based on their 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 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 { "tags": [ - [ "zap", "LNURL..", "lud06", "1" ], // 25% - [ "zap", "pablo@f7z.io", "lud16", "1" ], // 25% - [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "pubkey", "2" ] // 50% + [ "zap", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2", "wss://nostr.oxtr.dev", "1" ], // 25% + [ "zap", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", "wss://nostr.wine/", "1" ], // 25% + [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "wss://nos.lol/", "2" ] // 50% ] } ``` From 91bdf63b130cadb89c3908cab09305526e9f2092 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Wed, 24 May 2023 12:22:16 -0400 Subject: [PATCH 08/61] grammar --- 57.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/57.md b/57.md index 27b85a4..39fa562 100644 --- a/57.md +++ b/57.md @@ -168,7 +168,7 @@ A client can retrieve `zap receipt`s on events and pubkeys using a NIP-01 filter ### Appendix G: `zap` tag on other events -When an event includes one or more `zap` tags, clients wishing to zap it SHOULD calculate the lnurl pay request based on their 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 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`). +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 { From 141197c564d97073f0293e3b2f367f0b6b3619c2 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Sat, 8 Jul 2023 08:11:22 -0400 Subject: [PATCH 09/61] NIP-53 Live Activities (#498) --- 53.md | 125 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 125 insertions(+) create mode 100644 53.md diff --git a/53.md b/53.md new file mode 100644 index 0000000..9a86d9e --- /dev/null +++ b/53.md @@ -0,0 +1,125 @@ +NIP-53 +====== + +Live Activities +--------------- + +`draft` `optional` `author:vitorpamplona` `author:v0l` + +## Abstract + +Service providers want to offer live activities to the Nostr network in such a way that participants can easily logged and queried by clients. This NIP describes a general framework to advertise the involvement of pubkeys in such live activities. + +# Live Event + +A special event with `kind:30311` "Live Event" is defined as a [NIP-33: Parameterized Replaceable Events](33.md) 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: + +```js +{ + "kind": 30311, + "tags": [ + ["d", ""], + ["title", ""], + ["summary", ""], + ["image", ""], + ["t", "hashtag"] + ["streaming", ""], + ["recording", ""], // used to place the edited video once the activity is over + ["starts", ""], + ["ends", ""], + ["status", ""], + ["current_participants", ""], + ["total_participants", ""], + ["p", "91cf9..4e5ca", "wss://provider1.com/", "Host", ""], + ["p", "14aeb..8dad4", "wss://provider2.com/nostr", "Speaker"], + ["p", "612ae..e610f", "ws://provider3.com/ws", "Participant"], + ["relays", "wss://one.com", "wss://two.com", ...] + ], + "content": "", + ...other fields +} +``` + +A distinct `d` tag should be used for each activity. All other tags are optional. + +Providers SHOULD keep the participant list small (e.g. under 1000 users) and, when limits are reached, Providers SHOULD select which participants get named in the event. Clients should not expect a comprehensive list. Once the activity ends, the event can be deleted or updated to summarize the activity and provide async content (e.g. recording of the event). + +Clients are expected to subscribe to `kind:30311` events in general or for given follow lists and statuses. Clients MAY display participants' roles in activities as well as access points to join the activity. + +Live Activity management clients are expected to constantly update `kind:30311` during the event. Clients MAY choose to consider `status=live` events after 1hr without any update as `ended`. The `starts` and `ends` timestamp SHOULD be updated when the status changes to and from `live` + +The activity MUST be linked to using the NIP-19 naddr code along with the "a" tag (see [NIP-33](33.md) and [NIP-19](19.md)). + +## Proof of Agreement to Participate + +Event owners can add proof as the 5th term in each `p` tag to clarify the participant's agreement in joining the event. The proof is a signed SHA256 of the complete `a` Tag of the event (`kind:pubkey:dTag`) by each `p`'s private key, encoded in hex. + +Clients MAY only display participants if the proof is available or MAY display participants as "invited" if the proof is not available. + +This feature is important to avoid malicious event owners adding large account holders to the event, without their knowledge, to lure their followers into the malicious owner's trap. + +# Live Chat Message + +Event `kind:1311` is live chat's channel message. Clients MUST include the `a` tag of the activity with a `root` marker. Other Kind-1 tags such as `reply` and `mention` can also be used. + +```js +{ + "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", + "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", + "created_at": "", + "kind": 1311, + "tags": [ + ["a", "34550::", "", "root"], + ], + "content": "Zaps to live streams is beautiful." +} +``` + +# Use Cases + +Common use cases include meeting rooms/workshops, watch-together activities, or event spaces, such as [live.snort.social](https://live.snort.social) and [nostrnests.com](https://nostrnests.com). + +# Example + +Live Streaming + +```json +{ + "id": "57f28dbc264990e2c61e80a883862f7c114019804208b14da0bff81371e484d2", + "pubkey": "1597246ac22f7d1375041054f2a4986bd971d8d196d7997e48973263ac9879ec", + "created_at": 1687182672, + "kind": 30311, + "tags": [ + ["d", "demo-cf-stream"], + ["title", "Adult Swim Metalocalypse"], + ["summary", "Live stream from IPTV-ORG collection"], + ["streaming", "https://adultswim-vodlive.cdn.turner.com/live/metalocalypse/stream.m3u8"], + ["starts", "1687182672"] + ["status", "live"], + ["t", "animation"], + ["t", "iptv"], + ["image", "https://i.imgur.com/CaKq6Mt.png"] + ], + "content": "", + "sig": "5bc7a60f5688effa5287244a24768cbe0dcd854436090abc3bef172f7f5db1410af4277508dbafc4f70a754a891c90ce3b966a7bc47e7c1eb71ff57640f3d389" +} +``` + +Live Streaming chat message + +```json +{ + "id": "97aa81798ee6c5637f7b21a411f89e10244e195aa91cb341bf49f718e36c8188", + "pubkey": "3f770d65d3a764a9c5cb503ae123e62ec7598ad035d836e2a810f3877a745b24", + "created_at": 1687286726, + "kind": 1311, + "tags": [ + ["a", "30311:1597246ac22f7d1375041054f2a4986bd971d8d196d7997e48973263ac9879ec:demo-cf-stream", "", "root"] + ], + "content": "Zaps to live streams is beautiful.", + "sig": "997f62ddfc0827c121043074d50cfce7a528e978c575722748629a4137c45b75bdbc84170bedc723ef0a5a4c3daebf1fef2e93f5e2ddb98e5d685d022c30b622" +} +```` + From 3a32c0fd781bb1b6e2d23eb83da9f0b56e4a233e Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Sun, 9 Jul 2023 12:32:26 +0900 Subject: [PATCH 10/61] clarify case-sensitiveness of tag names --- 01.md | 2 +- 12.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/01.md b/01.md index 2ff81eb..686b2ee 100644 --- a/01.md +++ b/01.md @@ -107,7 +107,7 @@ A relay may choose to treat different message kinds differently, and it may or m ## Other Notes: - Clients should not open more than one websocket to each relay. One channel can support an unlimited number of subscriptions, so clients should do that. -- The `tags` array can store a tag identifier as the first element of each subarray, plus arbitrary information afterward (always as strings). This NIP defines `"p"` — meaning "pubkey", which points to a pubkey of someone that is referred to in the event —, and `"e"` — meaning "event", which points to the id of an event this event is quoting, replying to or referring to somehow. See [NIP-10](10.md) for a detailed description of "e" and "p" tags. +- The `tags` array can store a case-sensitive tag identifier as the first element of each subarray, plus arbitrary information afterward (always as strings). This NIP defines `"p"` — meaning "pubkey", which points to a pubkey of someone that is referred to in the event —, and `"e"` — meaning "event", which points to the id of an event this event is quoting, replying to or referring to somehow. See [NIP-10](10.md) for a detailed description of "e" and "p" tags. - The `` item present on the `"e"` and `"p"` tags is an optional (could be set to `""`) URL of a relay the client could attempt to connect to fetch the tagged event or other events from a tagged profile. It MAY be ignored, but it exists to increase censorship resistance and make the spread of relay addresses more seamless across clients. - Clients should use the created_at field to judge the age of a metadata event and completely replace older metadata events with newer metadata events regardless of the order in which they arrive. Clients should not merge any filled fields within older metadata events into empty fields of newer metadata events. - When a websocket is closed by the relay with a status code 4000 that means the client shouldn't try to connect again. diff --git a/12.md b/12.md index 74c9d81..7d1f46e 100644 --- a/12.md +++ b/12.md @@ -8,7 +8,7 @@ Generic Tag Queries Relays may support subscriptions over arbitrary tags. `NIP-01` requires relays to respond to queries for `e` and `p` tags. This NIP allows any single-letter tag present in an event to be queried. -The `` object described in `NIP-01` is expanded to contain arbitrary keys with a `#` prefix. Any single-letter key in a filter beginning with `#` is a tag query, and MUST have a value of an array of strings. The filter condition matches if the event has a tag with the same name, and there is at least one tag value in common with the filter and event. The tag name is the letter without the `#`, and the tag value is the second element. Subsequent elements are ignored for the purposes of tag queries. +The `` object described in `NIP-01` is expanded to contain arbitrary keys with a `#` prefix. Any single-letter key in a filter beginning with `#` is a tag query, and MUST have a value of an array of strings. The filter condition matches if the event has a tag with the same name, and there is at least one tag value in common with the filter and event. The tag name is the letter without the `#`, and the tag value is the second element. Subsequent elements are ignored for the purposes of tag queries. Note that tag names are case-sensitive. Example Subscription Filter --------------------------- From 52edccbbe380eeadb7622fc9eb255928dcff6178 Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Sun, 9 Jul 2023 12:45:16 +0900 Subject: [PATCH 11/61] standardize the terminology --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 686b2ee..4c2ccd9 100644 --- a/01.md +++ b/01.md @@ -107,7 +107,7 @@ A relay may choose to treat different message kinds differently, and it may or m ## Other Notes: - Clients should not open more than one websocket to each relay. One channel can support an unlimited number of subscriptions, so clients should do that. -- The `tags` array can store a case-sensitive tag identifier as the first element of each subarray, plus arbitrary information afterward (always as strings). This NIP defines `"p"` — meaning "pubkey", which points to a pubkey of someone that is referred to in the event —, and `"e"` — meaning "event", which points to the id of an event this event is quoting, replying to or referring to somehow. See [NIP-10](10.md) for a detailed description of "e" and "p" tags. +- The `tags` array can store a case-sensitive tag name as the first element of each subarray, plus arbitrary information afterward (always as strings). This NIP defines `"p"` — meaning "pubkey", which points to a pubkey of someone that is referred to in the event —, and `"e"` — meaning "event", which points to the id of an event this event is quoting, replying to or referring to somehow. See [NIP-10](10.md) for a detailed description of "e" and "p" tags. - The `` item present on the `"e"` and `"p"` tags is an optional (could be set to `""`) URL of a relay the client could attempt to connect to fetch the tagged event or other events from a tagged profile. It MAY be ignored, but it exists to increase censorship resistance and make the spread of relay addresses more seamless across clients. - Clients should use the created_at field to judge the age of a metadata event and completely replace older metadata events with newer metadata events regardless of the order in which they arrive. Clients should not merge any filled fields within older metadata events into empty fields of newer metadata events. - When a websocket is closed by the relay with a status code 4000 that means the client shouldn't try to connect again. From 20b22e7079282fd5403b6f11ea4ddc3f1beb8bfe Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Sun, 9 Jul 2023 11:27:58 +0900 Subject: [PATCH 12/61] add NIP-53 to the list --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 9893ffc..2a444c3 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-47: Wallet Connect](47.md) - [NIP-50: Keywords filter](50.md) - [NIP-51: Lists](51.md) +- [NIP-53: Live Activities](53.md) - [NIP-56: Reporting](56.md) - [NIP-57: Lightning Zaps](57.md) - [NIP-58: Badges](58.md) @@ -87,6 +88,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `43` | Channel Hide Message | [28](28.md) | | `44` | Channel Mute User | [28](28.md) | | `1063` | File Metadata | [94](94.md) | +| `1311` | Live Chat Message | [53](53.md) | | `1984` | Reporting | [56](56.md) | | `1985` | Label | [32](32.md) | | `9734` | Zap Request | [57](57.md) | @@ -108,6 +110,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30018` | Create or update a product | [15](15.md) | | `30023` | Long-form Content | [23](23.md) | | `30078` | Application-specific Data | [78](78.md) | +| `30311` | Live Event | [53](53.md) | | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | From 7cd861c4d3c7a28d6b0d4ee26ad2a36fdb2670a5 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Mon, 10 Jul 2023 12:38:50 +0900 Subject: [PATCH 13/61] Update tag list --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2a444c3..c448df6 100644 --- a/README.md +++ b/README.md @@ -172,7 +172,7 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | `delegation` | pubkey, conditions, delegation token | -- | [26](26.md) | | `description` | badge description | -- | [58](58.md) | | `description` | invoice description | -- | [57](57.md) | -| `emoji` | shortcode | image URL | [30](30.md) | +| `emoji` | shortcode, image URL | -- | [30](30.md) | | `expiration` | unix timestamp (string) | -- | [40](40.md) | | `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | | `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | From a1cd2bd809c6e7476fe1e4dcab78f3a0df22f37d Mon Sep 17 00:00:00 2001 From: Yasuhiro Matsumoto Date: Thu, 6 Jul 2023 17:22:42 +0900 Subject: [PATCH 14/61] NIP-25 content might be NIP-30 custom emoji --- 25.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/25.md b/25.md index f74bcc0..855f331 100644 --- a/25.md +++ b/25.md @@ -18,7 +18,7 @@ downvote or dislike on a post. A client MAY also choose to tally likes against dislikes in a reddit-like system of upvotes and downvotes, or display them as separate tallies. -The `content` MAY be an emoji, in this case it MAY be interpreted as a "like" or "dislike", +The `content` MAY be an emoji, or [NIP-30](30.md) custom emoji in this case it MAY be interpreted as a "like" or "dislike", or the client MAY display this emoji reaction on the post. Tags From 00ec0c83ace1353b297b60af6bf519cb2ea04f0e Mon Sep 17 00:00:00 2001 From: Yasuhiro Matsumoto Date: Tue, 11 Jul 2023 00:15:34 +0900 Subject: [PATCH 15/61] Add new section Custom Emoji Reaction --- 25.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/25.md b/25.md index 855f331..7a612a1 100644 --- a/25.md +++ b/25.md @@ -47,3 +47,25 @@ func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> Nost ev.sign(privkey: privkey) return ev } +``` + +Custom Emoji Reaction +--------------------- + +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 +{ + "kind": 7, + "content": ":soapbox:", + "tags": [ + ["emoji", "soapbox", "https://gleasonator.com/emoji/Gleasonator/soapbox.png"] + ], + "pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6", + "created_at": 1682790000 +} +``` + +The content can be set only one `:shortcode:`. And emoji tag should be one. From ed32c93c9f17ddbfb855e94539a446ba37ec4db3 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Wed, 12 Jul 2023 12:38:43 +0900 Subject: [PATCH 16/61] Adjust NIP-14 title to other NIPs --- 14.md | 4 ++-- README.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/14.md b/14.md index 0b37e8a..7384394 100644 --- a/14.md +++ b/14.md @@ -1,8 +1,8 @@ NIP-14 ====== -Subject tag in Text events. ---------------------------- +Subject tag in Text events +-------------------------- `draft` `optional` `author:unclebobmartin` diff --git a/README.md b/README.md index c448df6..71d0868 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-11: Relay Information Document](11.md) - [NIP-12: Generic Tag Queries](12.md) - [NIP-13: Proof of Work](13.md) -- [NIP-14: Subject tag in text events.](14.md) +- [NIP-14: Subject tag in text events](14.md) - [NIP-15: Nostr Marketplace (for resilient marketplaces)](15.md) - [NIP-16: Event Treatment](16.md) - [NIP-18: Reposts](18.md) From f5a930c824bc0192e1161ebb1ae4e6c21ecb2f94 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Wed, 12 Jul 2023 18:37:51 +0900 Subject: [PATCH 17/61] Fix NIP-21 title --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 71d0868..274868a 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-18: Reposts](18.md) - [NIP-19: bech32-encoded entities](19.md) - [NIP-20: Command Results](20.md) -- [NIP-21: `nostr:` URL scheme](21.md) +- [NIP-21: `nostr:` URI scheme](21.md) - [NIP-22: Event `created_at` Limits](22.md) - [NIP-23: Long-form Content](23.md) - [NIP-25: Reactions](25.md) From 1889ac792b7119ba9dc41fd4e904445ad1d9c6b5 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Thu, 13 Jul 2023 12:34:04 +0900 Subject: [PATCH 18/61] Add k tag to list --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 274868a..6da74cd 100644 --- a/README.md +++ b/README.md @@ -160,6 +160,7 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | `e` | event id (hex) | relay URL, marker | [1](01.md), [10](10.md) | | `g` | geohash | -- | [12](12.md) | | `i` | identity | proof | [39](39.md) | +| `k` | kind number (string) | -- | [18](18.md) | | `l` | label, label namespace | annotations | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | | `p` | pubkey (hex) | relay URL | [1](01.md) | From 0b08cf545b50b4799000e90aa4c5ada2cb73ca62 Mon Sep 17 00:00:00 2001 From: Yoji Shidara Date: Thu, 13 Jul 2023 14:14:36 +0900 Subject: [PATCH 19/61] Explicitly state that the `subscription_id` is treated per connection --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 4c2ccd9..8b1471d 100644 --- a/01.md +++ b/01.md @@ -55,7 +55,7 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th * `["REQ", , ...]`, used to request events and subscribe to new updates. * `["CLOSE", ]`, used to stop previous subscriptions. -`` is an arbitrary, non-empty string of max length 64 chars, that should be used to represent a subscription. +`` is an arbitrary, non-empty string of max length 64 chars, that should be used to represent a subscription. Relays should manage ``s independently for each WebSocket connection; even if ``s are the same string, they should be treated as different subscriptions for different connections. `` is a JSON object that determines what events will be sent in that subscription, it can have the following attributes: From 451c06a3c572a13afe45c1d80616f8e6dd9bb1de Mon Sep 17 00:00:00 2001 From: Jeff Gardner <202880+erskingardner@users.noreply.github.com> Date: Thu, 13 Jul 2023 15:14:19 +0200 Subject: [PATCH 20/61] Add initial draft for classifieds NIP --- 402.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 402.md diff --git a/402.md b/402.md new file mode 100644 index 0000000..c0eee14 --- /dev/null +++ b/402.md @@ -0,0 +1,71 @@ +# NIP-402 + +## Classifieds + +`draft` `optional` `author:erskingardner` + +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 structure of these events is very similar to [NIP-23](https://github.com/nostr-protocol/nips/blob/master/23.md) long-form content events. + +### Draft / Inactive Listings + +`kind:30403` has the same structure as `kind:30402` and is used to save draft or inactive classified listings. + +### Content + +The `.content` field should be a description of what is being offered and by whom. These events should be a string in Markdown syntax. + +### Author + +The `.pubkey` field of these events are treated as the party creating the listing. + +### 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). + +The following tags, used for structured metadata, are standardized and SHOULD be included. Other tags may be added as necessary. + +- `"title"`, a title for the listing +- `"summary"`, for short tagline or summary for the listing +- `"published_at"`, for the timestamp (in unix seconds – converted to string) of the first time the listing was published. +- `"location"`, for the location. +- `"price"`, for the price of the thing being listed. This is a free-form string. e.g. `€2,000/week` or `$22 per hour` or `$500` + +Other standard tags that might be useful. + +- `"g"`, a geohash for more precise location + +## Example Event + +```json +{ + "kind": 30402, + "created_at": 1675642635, + // Markdown content + "content": "Lorem [ipsum][nostr:nevent1qqst8cujky046negxgwwm5ynqwn53t8aqjr6afd8g59nfqwxpdhylpcpzamhxue69uhhyetvv9ujuetcv9khqmr99e3k7mg8arnc9] dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\n\nRead more at nostr:naddr1qqzkjurnw4ksz9thwden5te0wfjkccte9ehx7um5wghx7un8qgs2d90kkcq3nk2jry62dyf50k0h36rhpdtd594my40w9pkal876jxgrqsqqqa28pccpzu.", + "tags": [ + ["d", "lorem-ipsum"], + ["title", "Lorem Ipsum"], + ["published_at", "1296962229"], + ["t", "electronics"], + ["summary", "More lorem ipsum that is a little more than the title"], + ["location", "NYC"], + ["price", "$100"], + [ + "e", + "b3e392b11f5d4f28321cedd09303a748acfd0487aea5a7450b3481c60b6e4f87", + "wss://relay.example.com" + ], + [ + "a", + "30023:a695f6b60119d9521934a691347d9f78e8770b56da16bb255ee286ddf9fda919:ipsum", + "wss://relay.nostr.org" + ] + ], + "pubkey": "...", + "id": "..." +} +``` From f065a40ee60d3b0f48f4f09e3daf12d6045cc0ae Mon Sep 17 00:00:00 2001 From: Jeff Gardner <202880+erskingardner@users.noreply.github.com> Date: Fri, 14 Jul 2023 00:05:02 +0200 Subject: [PATCH 21/61] Add image tags and change format of the price tag. --- 402.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/402.md b/402.md index c0eee14..5e725c7 100644 --- a/402.md +++ b/402.md @@ -25,6 +25,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](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. The following tags, used for structured metadata, are standardized and SHOULD be included. Other tags may be added as necessary. @@ -32,7 +33,17 @@ The following tags, used for structured metadata, are standardized and SHOULD be - `"summary"`, for short tagline or summary for the listing - `"published_at"`, for the timestamp (in unix seconds – converted to string) of the first time the listing was published. - `"location"`, for the location. -- `"price"`, for the price of the thing being listed. This is a free-form string. e.g. `€2,000/week` or `$22 per hour` or `$500` +- `"price"`, for the price of the thing being listed. This is an array in the format `[ "price", "", "", "" ]`. + - `"price"` is the name of the tag + - `""` is the amount in numeric format (but included in the tag as a string) + - `""` is the currency unit in 3-character ISO 4217 format. + - `""` is optional and can be used to describe recurring payments. + +#### `price` examples + +- $50 one-time payment `["price", "50", "USD", ""]` +- €15 per month `["price", "15", "EUR", "monthly"]` +- £50,000 per year `["price", "50000", "GBP", "yearly"]` Other standard tags that might be useful. @@ -51,9 +62,10 @@ Other standard tags that might be useful. ["title", "Lorem Ipsum"], ["published_at", "1296962229"], ["t", "electronics"], + ["image", "https://url.to.img", "256x256"], ["summary", "More lorem ipsum that is a little more than the title"], ["location", "NYC"], - ["price", "$100"], + ["price", "100", "USD"], [ "e", "b3e392b11f5d4f28321cedd09303a748acfd0487aea5a7450b3481c60b6e4f87", From dd4caf9c4c88728d65dc76dd2adb3bf2bbe6b30e Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Fri, 14 Jul 2023 09:08:03 +0900 Subject: [PATCH 22/61] Fix typo --- 25.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/25.md b/25.md index 7a612a1..86ce763 100644 --- a/25.md +++ b/25.md @@ -52,7 +52,7 @@ func make_like_event(pubkey: String, privkey: String, liked: NostrEvent) -> Nost Custom Emoji Reaction --------------------- -The client may specify a custom emoji ([NIP-30](30.md)) `:shortcode` in the +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. From d1814405beac7a936fa0dedc08359d70b5a9ab48 Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Sun, 9 Jul 2023 17:31:08 +0900 Subject: [PATCH 23/61] add detailed description of since/until --- 01.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/01.md b/01.md index 8b1471d..01cfcc1 100644 --- a/01.md +++ b/01.md @@ -78,6 +78,8 @@ Filter attributes containing lists (such as `ids`, `kinds`, or `#e`) are JSON ar The `ids` and `authors` lists contain lowercase hexadecimal strings, which may either be an exact 64-character match, or a prefix of the event value. A prefix match is when the filter string is an exact string prefix of the event value. The use of prefixes allows for more compact filters where a large number of values are queried, and can provide some privacy for clients that may not want to disclose the exact authors or events they are searching for. +The `since` and `until` properties can be used to specify the time range of events returned in the subscription. If a filter includes the `since` property, events with `created_at` greater than or equal to `since` are considered to match the filter. The `until` property is similar except that `created_at` must be less than or equal to `until`. In short, an event matches a filter if `since <= created_at <= until` holds. + All conditions of a filter that are specified must match for an event for it to pass the filter, i.e., multiple conditions are interpreted as `&&` conditions. 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. From 629c787d284c6bf27853f8b272888d86bd48d1dc Mon Sep 17 00:00:00 2001 From: Jeff Gardner <202880+erskingardner@users.noreply.github.com> Date: Mon, 17 Jul 2023 12:34:24 +0200 Subject: [PATCH 24/61] Update for feedback on format of price array --- 402.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/402.md b/402.md index 5e725c7..e63e97a 100644 --- a/402.md +++ b/402.md @@ -37,13 +37,13 @@ The following tags, used for structured metadata, are standardized and SHOULD be - `"price"` is the name of the tag - `""` is the amount in numeric format (but included in the tag as a string) - `""` is the currency unit in 3-character ISO 4217 format. - - `""` is optional and can be used to describe recurring payments. + - `""` is optional and can be used to describe recurring payments. SHOULD be in noun format (hour, day, week, month, year, etc.) #### `price` examples -- $50 one-time payment `["price", "50", "USD", ""]` -- €15 per month `["price", "15", "EUR", "monthly"]` -- £50,000 per year `["price", "50000", "GBP", "yearly"]` +- $50 one-time payment `["price", "50", "USD"]` +- €15 per month `["price", "15", "EUR", "month"]` +- £50,000 per year `["price", "50000", "GBP", "year"]` Other standard tags that might be useful. From 63718d6d89269819807b1e1c996d304f7aca64b0 Mon Sep 17 00:00:00 2001 From: Jeff Gardner <202880+erskingardner@users.noreply.github.com> Date: Tue, 18 Jul 2023 15:20:32 +0200 Subject: [PATCH 25/61] Update price detail --- 402.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/402.md b/402.md index e63e97a..d5df924 100644 --- a/402.md +++ b/402.md @@ -36,7 +36,7 @@ The following tags, used for structured metadata, are standardized and SHOULD be - `"price"`, for the price of the thing being listed. This is an array in the format `[ "price", "", "", "" ]`. - `"price"` is the name of the tag - `""` is the amount in numeric format (but included in the tag as a string) - - `""` is the currency unit in 3-character ISO 4217 format. + - `""` is the currency unit in 3-character ISO 4217 format or ISO 4217-like currency code (e.g. 'btc', 'eth'). - `""` is optional and can be used to describe recurring payments. SHOULD be in noun format (hour, day, week, month, year, etc.) #### `price` examples From b480624ac27e7083ed01c7f3d2157fddf7bd692a Mon Sep 17 00:00:00 2001 From: Jeff Gardner <202880+erskingardner@users.noreply.github.com> Date: Tue, 18 Jul 2023 15:22:56 +0200 Subject: [PATCH 26/61] Improve formatting --- 402.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/402.md b/402.md index d5df924..c316670 100644 --- a/402.md +++ b/402.md @@ -36,7 +36,7 @@ The following tags, used for structured metadata, are standardized and SHOULD be - `"price"`, for the price of the thing being listed. This is an array in the format `[ "price", "", "", "" ]`. - `"price"` is the name of the tag - `""` is the amount in numeric format (but included in the tag as a string) - - `""` is the currency unit in 3-character ISO 4217 format or ISO 4217-like currency code (e.g. 'btc', 'eth'). + - `""` is the currency unit in 3-character ISO 4217 format or ISO 4217-like currency code (e.g. `"btc"`, `"eth"`). - `""` is optional and can be used to describe recurring payments. SHOULD be in noun format (hour, day, week, month, year, etc.) #### `price` examples From b31d3077f6655f150cca9bb07f5fba895dc815ca Mon Sep 17 00:00:00 2001 From: Terry Yiu <963907+tyiu@users.noreply.github.com> Date: Mon, 3 Jul 2023 01:23:47 -0400 Subject: [PATCH 27/61] Fix content field in example in NIP-56 Reporting to replace deprecated NIP-08 indexed mentions with NIP-27 bech32 mentions --- 56.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/56.md b/56.md index 42174fb..43b7bad 100644 --- a/56.md +++ b/56.md @@ -63,10 +63,9 @@ Example events { "kind": 1984, "tags": [ - ["p", , "impersonation"], - ["p", ] + ["p", , "impersonation"] ], - "content": "Profile is imitating #[1]", + "content": "Profile is impersonating nostr:", ... } ``` @@ -75,7 +74,7 @@ Client behavior --------------- Clients can use reports from friends to make moderation decisions if they -choose to. For instance, if 3+ of your friends report a profile as explicit, +choose to. For instance, if 3+ of your friends report a profile for `nudity`, clients can have an option to automatically blur photos from said account. From afcbef2bb0ad854adfc8dac8d04ba16fe8107115 Mon Sep 17 00:00:00 2001 From: William Casarin Date: Tue, 18 Jul 2023 08:44:29 -0700 Subject: [PATCH 28/61] nip23: add some formatting guidelines to maximize compatibility Link: https://groups.google.com/g/nostr-protocol/c/tnrcWTIAzdU --- 23.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/23.md b/23.md index 4291228..7a06b0e 100644 --- a/23.md +++ b/23.md @@ -12,7 +12,11 @@ This NIP defines `kind:30023` (a parameterized replaceable event according to [N ### Format -The `.content` of these events should be a string text in Markdown syntax. +The `.content` of these events should be a string text in Markdown syntax. To maximize compatibility and readability between different clients and devices, any client that is creating long form notes: + +- MUST NOT hard line-break paragraphs of text, such as arbitrary line breaks at 80 column boundaries. + +- MUST NOT support adding HTML to Markdown. ### Metadata From 859bd471fe22ce18bcf208581040fbfa3b06dee4 Mon Sep 17 00:00:00 2001 From: Jeff Gardner <202880+erskingardner@users.noreply.github.com> Date: Tue, 18 Jul 2023 22:48:23 +0200 Subject: [PATCH 29/61] Update readme, change NIP number --- 402.md => 99.md | 2 +- README.md | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) rename 402.md => 99.md (99%) diff --git a/402.md b/99.md similarity index 99% rename from 402.md rename to 99.md index c316670..e974a5e 100644 --- a/402.md +++ b/99.md @@ -1,4 +1,4 @@ -# NIP-402 +# NIP-99 ## Classifieds diff --git a/README.md b/README.md index 6da74cd..9ffff27 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-89: Recommended Application Handlers](89.md) - [NIP-94: File Metadata](94.md) - [NIP-98: HTTP Auth](98.md) +- [NIP-99: Classified Listings](99.md) ## Event Kinds @@ -111,6 +112,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30023` | Long-form Content | [23](23.md) | | `30078` | Application-specific Data | [78](78.md) | | `30311` | Live Event | [53](53.md) | +| `30402` | Classified Listing | [99](99.md) | | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | @@ -177,9 +179,11 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | `expiration` | unix timestamp (string) | -- | [40](40.md) | | `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | | `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | +| `location` | location string | -- | [99](99.md) | | `name` | badge name | -- | [58](58.md) | | `nonce` | random | -- | [13](13.md) | | `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | +| `price` | price | currency, frequency | [99](99.md) | | `published_at` | unix timestamp (string) | -- | [23](23.md) | | `relay` | relay url | -- | [42](42.md) | | `relays` | relay list | -- | [57](57.md) | From 8efa0e76b471593396690941f234c570830449e4 Mon Sep 17 00:00:00 2001 From: Jeff Gardner <202880+erskingardner@users.noreply.github.com> Date: Tue, 18 Jul 2023 22:52:18 +0200 Subject: [PATCH 30/61] Update title --- 99.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/99.md b/99.md index e974a5e..274e5af 100644 --- a/99.md +++ b/99.md @@ -1,6 +1,6 @@ # NIP-99 -## Classifieds +## Classified Listings `draft` `optional` `author:erskingardner` From ad39e1f3ca5ff2e61b1fc718a680c304acd82fef Mon Sep 17 00:00:00 2001 From: William Casarin Date: Mon, 10 Jul 2023 08:40:58 -0700 Subject: [PATCH 31/61] readme: add mailing lists --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 9ffff27..a09be5e 100644 --- a/README.md +++ b/README.md @@ -201,6 +201,21 @@ When experimenting with kinds, keep in mind the classification introduced by [NI 4. There should be no more than one way of doing the same thing. 5. Other rules will be made up when necessary. +## Mailing Lists + +The nostr ecosystem is getting large with many different organizations, relays +and clients. Following the nips repo on github is becoming more difficult and +noisy. To coordinate on protocol development outside of github, there are +mailing lists where you can work on NIPs before submitting them here: + +* [w3c nostr community group][w3-nostr] - [public-nostr@w3.org][mailto-w3] - requires signup +* [nostr-protocol google group][nostr-google-group] - [nostr-protocol@googlegroups.com][mailto-google] - no signup required + +[w3-nostr]: https://www.w3.org/community/nostr/ +[mailto-w3]: mailto:public-nostr@w3.org +[nostr-google-group]: https://groups.google.com/g/nostr-protocol +[mailto-google]: mailto:nostr-protocol@googlegroups.com + ## License All NIPs are public domain. From d0cb9d0c24ec9815b0668bffff246a19352b9ca2 Mon Sep 17 00:00:00 2001 From: erechorse <935horse@gmail.com> Date: Fri, 21 Jul 2023 00:48:55 +0900 Subject: [PATCH 32/61] Fix typos about inline code --- 56.md | 2 +- 57.md | 2 +- 65.md | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/56.md b/56.md index 43b7bad..a129926 100644 --- a/56.md +++ b/56.md @@ -10,7 +10,7 @@ Reporting A report is a `kind 1984` note that is used to report other notes for spam, illegal and explicit content. -The content MAY contain additional information submitted by the entity +The `content` MAY contain additional information submitted by the entity reporting the content. Tags diff --git a/57.md b/57.md index 438a0f8..95dba3b 100644 --- a/57.md +++ b/57.md @@ -126,7 +126,7 @@ When receiving a payment, the following steps are executed: The following should be true of the `zap receipt` event: -- The content SHOULD be empty. +- The `content` SHOULD be empty. - The `created_at` date SHOULD be set to the invoice `paid_at` date for idempotency. - `tags` MUST include the `p` tag AND optional `e` tag from the `zap request`. - The `zap receipt` MUST have a `bolt11` tag containing the description hash bolt11 invoice. diff --git a/65.md b/65.md index 4c7a6a5..55f9ff0 100644 --- a/65.md +++ b/65.md @@ -10,7 +10,7 @@ A special replaceable event meaning "Relay List Metadata" is defined as an event The primary purpose of this relay list is to advertise to others, not for configuring one's client. -The content is not used and SHOULD be an empty string. +The `content` is not used and SHOULD be an empty string. The `r` tags can have a second parameter as either `read` or `write`. If it is omitted, it means the author uses the relay for both purposes. @@ -53,12 +53,12 @@ Authors may post events outside of the feed that they wish their followers to fo It is suggested that relays allow any user to write their own kind `10002` event (optionally with AUTH to verify it is their own) even if they are not otherwise subscribed to the relay because - finding where someone posts is rather important - - these events do not have content that needs management + - these events do not have `content` that needs management - relays only need to store one replaceable event per pubkey to offer this service ### Why not in kind `0` Metadata -Even though this is user related metadata, it is a separate event from kind `0` in order to keep it small (as it should be widely spread) and to not have content that may require moderation by relay operators so that it is more acceptable to relays. +Even though this is user related metadata, it is a separate event from kind `0` in order to keep it small (as it should be widely spread) and to not have `content` that may require moderation by relay operators so that it is more acceptable to relays. ### Example From 2af496e363f58b1d8bd026e8920f62e6a843d134 Mon Sep 17 00:00:00 2001 From: benthecarman <15256660+benthecarman@users.noreply.github.com> Date: Fri, 21 Jul 2023 03:12:02 -0500 Subject: [PATCH 33/61] Fix event kind in example in NIP 53 --- 53.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/53.md b/53.md index 9a86d9e..c5f2704 100644 --- a/53.md +++ b/53.md @@ -71,7 +71,7 @@ Event `kind:1311` is live chat's channel message. Clients MUST include the `a` t "created_at": "", "kind": 1311, "tags": [ - ["a", "34550::", "", "root"], + ["a", "30311::", "", "root"], ], "content": "Zaps to live streams is beautiful." } From b503f8a92b22be3037b8115fe3e644865a4fa155 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Wed, 19 Jul 2023 12:34:07 +0900 Subject: [PATCH 34/61] Clarify sort order when specified limit --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 01cfcc1..f607ca2 100644 --- a/01.md +++ b/01.md @@ -84,7 +84,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 can be ignored afterward. When `limit: n` is present it is assumed that the events returned in the initial query will be the latest `n` events. 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 can be ignored afterward. 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. ### From relay to client: sending events and notices From 4a386e645ce38e666ef277f9a21c665ae00ae0ee Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Sun, 23 Jul 2023 00:18:56 +0900 Subject: [PATCH 35/61] Add draft kinds to list --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index a09be5e..1360190 100644 --- a/README.md +++ b/README.md @@ -110,9 +110,11 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30017` | Create or update a stall | [15](15.md) | | `30018` | Create or update a product | [15](15.md) | | `30023` | Long-form Content | [23](23.md) | +| `30024` | Draft Long-form Content | [23](23.md) | | `30078` | Application-specific Data | [78](78.md) | | `30311` | Live Event | [53](53.md) | | `30402` | Classified Listing | [99](99.md) | +| `30403` | Draft Classified Listing | [99](99.md) | | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | From e58a40d2e7a1ea7a096b2d88919cd8cbf0daa219 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Tue, 25 Jul 2023 12:33:16 +0900 Subject: [PATCH 36/61] Minor JSON fix --- 56.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/56.md b/56.md index a129926..259118d 100644 --- a/56.md +++ b/56.md @@ -42,9 +42,9 @@ Example events { "kind": 1984, "tags": [ - ["p", , "nudity"] + ["p", , "nudity"], ["L", "social.nos.ontology"], - ["l", "NS-nud", "social.nos.ontology"], + ["l", "NS-nud", "social.nos.ontology"] ], "content": "", ... From 9e0be8467d9e803c5f0dd8da0d41a762502786df Mon Sep 17 00:00:00 2001 From: "Jesper L. Nielsen" Date: Wed, 26 Jul 2023 15:59:57 +0200 Subject: [PATCH 37/61] Update 01.md Spelling --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index f607ca2..50e9c9c 100644 --- a/01.md +++ b/01.md @@ -55,7 +55,7 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th * `["REQ", , ...]`, used to request events and subscribe to new updates. * `["CLOSE", ]`, used to stop previous subscriptions. -`` is an arbitrary, non-empty string of max length 64 chars, that should be used to represent a subscription. Relays should manage ``s independently for each WebSocket connection; even if ``s are the same string, they should be treated as different subscriptions for different connections. +`` is an arbitrary, non-empty string of max length 64 chars, that should be used to represent a subscription. Relays should manage ``s independently for each WebSocket connection; even if ``s are the same string, they should be treated as different subscriptions for different connections. `` is a JSON object that determines what events will be sent in that subscription, it can have the following attributes: From b4cdc1a73d415c79c35655fa02f5e55cd1f2a60c Mon Sep 17 00:00:00 2001 From: Terry Yiu <963907+tyiu@users.noreply.github.com> Date: Sat, 10 Jun 2023 20:57:57 -0400 Subject: [PATCH 38/61] NIP-52: Calendar Events --- 52.md | 209 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 9 ++- 2 files changed, 216 insertions(+), 2 deletions(-) create mode 100644 52.md diff --git a/52.md b/52.md new file mode 100644 index 0000000..c601412 --- /dev/null +++ b/52.md @@ -0,0 +1,209 @@ +NIP-52 +====== + +Calendar Events +--------------- + +`draft` `optional` `author:tyiu` + +This specification defines calendar events representing an occurrence at a specific moment or between moments. These calendar events are replaceable and referenceable per [NIP-33](33.md) 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. + +## Calendar Events + +There are two types of calendar events represented by different kinds: date-based and time-based calendar events. Calendar events are not required to be part of a [calendar](#calendar). + +### Date-Based Calendar Event + +This kind of calendar event starts on a date and ends before a different date in the future. Its use is appropriate for all-day or multi-day events where time and time zone hold no significance. e.g., anniversary, public holidays, vacation days. + +#### Format + +The format uses a parameterized replaceable event kind `31922`. + +The `.content` of these events is optional and should be a detailed description of the calendar event. + +The list of tags are as follows: +* `d` (required) universally unique identifier (UUID). Generated by the client creating the calendar event. +* `name` (required) name of the calendar event +* `start` (required) inclusive start date in ISO 8601 format (YYYY-MM-DD). Must be less than `end`, if it exists. +* `end` (optional) exclusive end date in ISO 8601 format (YYYY-MM-DD). If omitted, the calendar event ends on the same date as `start`. +* `location` (optional) 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 as suggested as an example by [NIP-12](12.md) +* `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting +* `t` (optional, repeated) hashtag to categorize calendar event +* `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. + +```json +{ + "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": , + "kind": "31922", + "content": "", + "tags": [ + ["d", ""], + + ["name", ""], + + // Dates + ["start", ""], + ["end", ""], + + // Location + ["location", ""], + ["g", ""], + + // Participants + ["p", "<32-bytes hex of a pubkey>", "", ""], + ["p", "<32-bytes hex of a pubkey>", "", ""], + + // Hashtags + ["t", ""], + ["t", ""], + + // Reference links + ["r", ""], + ["r", ""] + ] +} +``` + +### Time-Based Calendar Event + +This kind of calendar event spans between a start time and end time. + +#### Format + +The format uses a parameterized replaceable event kind `31923`. + +The `.content` of these events is optional and should be a detailed description of the calendar event. + +The list of tags are as follows: +* `d` (required) universally unique identifier (UUID). Generated by the client creating the calendar event. +* `name` (required) name of the calendar event +* `start` (required) inclusive start Unix timestamp in seconds. Must be less than `end`, if it exists. +* `end` (optional) exclusive end Unix timestamp in seconds. If omitted, the calendar event ends instantaneously. +* `start_tzid` (optional) time zone of the start timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica` +* `end_tzid` (optional) time zone of the end timestamp, as defined by the IANA Time Zone Database. e.g., `America/Costa_Rica`. If omitted and `start_tzid` is provided, the time zone of the end timestamp is the same as the start timestamp. +* `location` (optional) 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 as suggested as an example by [NIP-12](12.md) +* `p` (optional, repeated) 32-bytes hex pubkey of a participant, optional recommended relay URL, and participant's role in the meeting +* `t` (optional, repeated) hashtag to categorize calendar event +* `r` (optional, repeated) references / links to web pages, documents, video calls, recorded videos, etc. + +```json +{ + "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": , + "kind": "31923", + "content": "", + "tags": [ + ["d", ""], + + ["name", ""], + + // Timestamps + ["start", ""], + ["end", ""], + + ["start_tzid", ""], + ["end_tzid", ""], + + // Location + ["location", ""], + ["g", ""], + + // Participants + ["p", "<32-bytes hex of a pubkey>", "", ""], + ["p", "<32-bytes hex of a pubkey>", "", ""], + + // Hashtags + ["t", ""], + ["t", ""], + + // Reference links + ["r", ""], + ["r", ""] + ] +} +``` + +## Calendar + +A calendar is a collection of calendar events, represented as a custom replaceable list event using kind `31924`. A user can have multiple calendars. One may create a calendar to segment calendar events for specific purposes. e.g., personal, work, travel, meetups, and conferences. + +### Format + +The format uses a custom replaceable list of kind `31924` with a list of tags as described below: +* `d` (required) calendar name +* `a` (repeated) reference tag to kind `31922` or `31923` calendar event being responded to per [NIP-33](33.md) + +```json +{ + "kind": 31924, + "tags": [ + ["d", ""], + ["a", "<31922 or 31923>::", ""], + ["a", "<31922 or 31923>::", ""] + ] +} +``` + +## Calendar Event RSVP + +A calendar event RSVP is a response to a calendar event to indicate a user's attendance intention. + +If a calendar event tags a pubkey, that can be interpreted as the calendar event creator inviting that user to attend. Clients MAY choose to prompt the user to RSVP for the calendar event. + +Any user may RSVP, even if they were not tagged on the calendar event. Clients MAY choose to prompt the calendar event creator to invite the user who RSVP'd. Clients also MAY choose to ignore these RSVPs. + +This NIP is intentionally not defining who is authorized to attend a calendar event if the user who RSVP'd has not been tagged. It is up to the calendar event creator to determine the semantics. + +This NIP is also intentionally not defining what happens if a calendar event changes after an RSVP is submitted. + +### Format + +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 per [NIP-33](33.md) +* `d` (required) universally unique identifier. Generated by the client creating the calendar event RSVP. +* `L` (required) label namespace of `status` per [NIP-32](32.md) +* `l` (required) label of `accepted`, `declined`, or `tentative` under the label namespace of `status` per [NIP-32](32.md). Determines attendance status to the referenced calendar event. +* `L` (optional) label namespace of `freebusy` per [NIP-32](32.md). Exists if and only if corresponding `l` tag under the same label namespace exists. +* `l` (optional) label of `free` or `busy` under the label namespace of `freebusy` per [NIP-32](32.md). 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`. Exists if and only if corresponding `l` tag under the same label namespace exists. + +```json +{ + "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": , + "kind": "31925", + "content": "", + "tags": [ + ["a", "<31922 or 31923>::", ""], + ["d", ""], + ["L", "status"], + ["l", "", "status"], + ["L", "freebusy"], + ["l", "", "freebusy"] + ] +} +``` + +## Unsolved Limitations + +* No private events + +## Intentionally Unsupported Scenarios + +### Recurring Calendar Events + +Recurring calendar events come with a lot of complexity, making it difficult for software and humans to deal with. This complexity includes time zone differences between invitees, daylight savings, leap years, multiple calendar systems, one-off changes in schedule or other metadata, etc. + +This NIP intentionally omits support for recurring calendar events and pushes that complexity up to clients to manually implement if they desire. i.e., individual calendar events with duplicated metadata represent recurring calendar events. diff --git a/README.md b/README.md index 1360190..ff12800 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-47: Wallet Connect](47.md) - [NIP-50: Keywords filter](50.md) - [NIP-51: Lists](51.md) +- [NIP-52: Calendar Events](52.md) - [NIP-53: Live Activities](53.md) - [NIP-56: Reporting](56.md) - [NIP-57: Lightning Zaps](57.md) @@ -115,6 +116,10 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30311` | Live Event | [53](53.md) | | `30402` | Classified Listing | [99](99.md) | | `30403` | Draft Classified Listing | [99](99.md) | +| `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) | @@ -162,7 +167,7 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | `alt` | Alt tag | -- | [31](31.md) | | `d` | identifier | -- | [33](33.md) | | `e` | event id (hex) | relay URL, marker | [1](01.md), [10](10.md) | -| `g` | geohash | -- | [12](12.md) | +| `g` | geohash | -- | [12](12.md), [52](52.md) | | `i` | identity | proof | [39](39.md) | | `k` | kind number (string) | -- | [18](18.md) | | `l` | label, label namespace | annotations | [32](32.md) | @@ -181,7 +186,7 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | `expiration` | unix timestamp (string) | -- | [40](40.md) | | `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | | `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | -| `location` | location string | -- | [99](99.md) | +| `location` | location string | -- | [52](52.md), [99](99.md) | | `name` | badge name | -- | [58](58.md) | | `nonce` | random | -- | [13](13.md) | | `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | From 064a79f6142326fa09cda411c15ceca997d37a03 Mon Sep 17 00:00:00 2001 From: Alex Gleason Date: Thu, 3 Aug 2023 14:40:45 -0500 Subject: [PATCH 39/61] NIP-48: Proxy Tags --- 48.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 62 insertions(+) create mode 100644 48.md diff --git a/48.md b/48.md new file mode 100644 index 0000000..8f22781 --- /dev/null +++ b/48.md @@ -0,0 +1,60 @@ +NIP-48 +====== + +Proxy Tags +---------- + +`draft` `optional` `author:alexgleason` + +Nostr events bridged from other protocols such as ActivityPub can link back to the source object by including a `"proxy"` tag, in the form: + +``` +["proxy", , ] +``` + +Where: + +- `` is the ID of the source object. The ID format varies depending on the protocol. The ID must be universally unique, regardless of the protocol. +- `` is the name of the protocol, e.g. `"activitypub"`. + +Clients may use this information to reconcile duplicated content bridged from other protocols, or to display a link to the source object. + +Proxy tags may be added to any event kind, and doing so indicates that the event did not originate on the Nostr protocol, and instead originated elsewhere on the web. + +### Supported protocols + +This list may be extended in the future. + +| Protocol | ID format | Example | +| -------- | --------- | ------- | +| `activitypub` | URL | `https://gleasonator.com/objects/9f524868-c1a0-4ee7-ad51-aaa23d68b526` | +| `atproto` | AT URI | `at://did:plc:zhbjlbmir5dganqhueg7y4i3/app.bsky.feed.post/3jt5hlibeol2i` | +| `rss` | URL with guid fragment | `https://soapbox.pub/rss/feed.xml#https%3A%2F%2Fsoapbox.pub%2Fblog%2Fmostr-fediverse-nostr-bridge` | +| `web` | URL | `https://twitter.com/jack/status/20` | + +### Examples + +ActivityPub object: + +```json +{ + "kind": 1, + "content": "I'm vegan btw", + "tags": [ + [ + "proxy", + "https://gleasonator.com/objects/8f6fac53-4f66-4c6e-ac7d-92e5e78c3e79", + "activitypub" + ] + ], + "pubkey": "79c2cae114ea28a981e7559b4fe7854a473521a8d22a66bbab9fa248eb820ff6", + "created_at": 1691091365, + "id": "55920b758b9c7b17854b6e3d44e6a02a83d1cb49e1227e75a30426dea94d4cb2", + "sig": "a72f12c08f18e85d98fb92ae89e2fe63e48b8864c5e10fbdd5335f3c9f936397a6b0a7350efe251f8168b1601d7012d4a6d0ee6eec958067cf22a14f5a5ea579" +} +``` + +### See also + +- [FEP-fffd: Proxy Objects](https://codeberg.org/fediverse/fep/src/branch/main/fep/fffd/fep-fffd.md) +- [Mostr bridge](https://mostr.pub/) \ No newline at end of file diff --git a/README.md b/README.md index ff12800..cfee37d 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-45: Counting results](45.md) - [NIP-46: Nostr Connect](46.md) - [NIP-47: Wallet Connect](47.md) +- [NIP-48: Proxy Tags](48.md) - [NIP-50: Keywords filter](50.md) - [NIP-51: Lists](51.md) - [NIP-52: Calendar Events](52.md) @@ -191,6 +192,7 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | `nonce` | random | -- | [13](13.md) | | `preimage` | hash of `bolt11` invoice | -- | [57](57.md) | | `price` | price | currency, frequency | [99](99.md) | +| `proxy` | external ID | protocol | [48](48.md) | | `published_at` | unix timestamp (string) | -- | [23](23.md) | | `relay` | relay url | -- | [42](42.md) | | `relays` | relay list | -- | [57](57.md) | From 1912dacd33e69584e7f451e18a81bdc114ea9d76 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Mon, 12 Jun 2023 18:35:23 -0400 Subject: [PATCH 40/61] Simple moderated communities flow. --- 172.md | 85 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100644 172.md diff --git a/172.md b/172.md new file mode 100644 index 0000000..0cc8107 --- /dev/null +++ b/172.md @@ -0,0 +1,85 @@ +NIP-172 +======= + +Moderated Communities (Reddit Style) +------------------------------------ + +`draft` `optional` `author:vitorpamplona` + +The goal of this NIP is to create moderator-approved public communities arount a topic. It defines the replaceable event `34550` to define the community and the current list of moderators/administrators. Users that want to post into to the community, simply tag any Nostr event with an `a` tag. Moderators the issue an approval event `34551` that links the community with the new post. + +# Community definition + +Kind 34550 should include any field that helps define the community and the set of moderators. + +```js +{ + "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", + "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", + "created_at": "", + "kind": "34550", + "tags": [ + ["d", ""], + ["description", ""], + + // moderators + ["p", "<32-bytes hex of a pubkey>", "", "moderator"] + ["p", "<32-bytes hex of a pubkey>", "", "moderator"] + ["p", "<32-bytes hex of a pubkey>", "", "moderator"] + ] +} +``` + +# New Post Request + +Any Nostr event can be a post request. Clients should simply add the community's `a` tag to be presented for the moderator's approval. + +```js +{ + "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", + "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", + "created_at": "", + "kind": "1", + "tags": [ + ["a", "34550::", ""], + ], + "content": "" +} +``` + +Community management clients can filter all mentions to the kind-34550 event and request moderators to approve each submission. The same moderator can remove his/her approval of the post at anytime. + +# Post Approval by moderators + +The post approval includes a stringified `new post request` event inside the content's of the approval (NIP-18-style). + +```js +{ + "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", + "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", + "created_at": "", + "kind": "34551", + "tags": [ + ["a", "34550::", ""], + ["e", "", ""], + ["p", "", ""], + ], + "content": "{ }" +} +``` + +It's recommended that multiple moderators approve posts to avoid unapproving them when a given moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign post approvals for the past post or the community will restart. + +# Displaying + +Community clients can display posts that have been approved by at least 1 moderator or by the community owner. + +The following filter displays the approved posts. + +```js +{ + "authors": ["", "moderator1", "moderator2", "moderator3", ...], + "kinds": 34551, + "#a": ["34550::"], +} +``` \ No newline at end of file From 7f4970bb10923aca7400448a093b4debb4b49267 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Mon, 12 Jun 2023 18:38:20 -0400 Subject: [PATCH 41/61] Typos --- 172.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/172.md b/172.md index 0cc8107..542258a 100644 --- a/172.md +++ b/172.md @@ -6,11 +6,11 @@ Moderated Communities (Reddit Style) `draft` `optional` `author:vitorpamplona` -The goal of this NIP is to create moderator-approved public communities arount a topic. It defines the replaceable event `34550` to define the community and the current list of moderators/administrators. Users that want to post into to the community, simply tag any Nostr event with an `a` tag. Moderators the issue an approval event `34551` that links the community with the new post. +The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `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 an `a` tag. Moderators issue an approval event `34551` that links the community with the new post. # Community definition -Kind 34550 should include any field that helps define the community and the set of moderators. +Kind 34550 should include any field that helps define the community and the set of moderators. ```js { @@ -32,7 +32,7 @@ Kind 34550 should include any field that helps define the community and the set # New Post Request -Any Nostr event can be a post request. Clients should simply add the community's `a` tag to be presented for the moderator's approval. +Any Nostr event can be a post request. Clients should simply add the community's `a` tag to be presented for the moderator's approval. ```js { @@ -47,11 +47,11 @@ Any Nostr event can be a post request. Clients should simply add the community's } ``` -Community management clients can filter all mentions to the kind-34550 event and request moderators to approve each submission. The same moderator can remove his/her approval of the post at anytime. +Community management clients can filter all mentions of the kind-34550 event and request moderators to approve each submission. The same moderator can remove his/her approval of the post at any time. # Post Approval by moderators -The post approval includes a stringified `new post request` event inside the content's of the approval (NIP-18-style). +The post-approval event includes a stringified `new post request` event inside the content of the approval (NIP-18-style). ```js { @@ -68,13 +68,13 @@ The post approval includes a stringified `new post request` event inside the con } ``` -It's recommended that multiple moderators approve posts to avoid unapproving them when a given moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign post approvals for the past post or the community will restart. +It's recommended that multiple moderators approve posts to avoid unapproving them when a given moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign post-approvals for posts in the past or the community will restart. # Displaying -Community clients can display posts that have been approved by at least 1 moderator or by the community owner. +Community clients can display posts that have been approved by at least 1 moderator or by the community owner. -The following filter displays the approved posts. +The following filter displays the approved posts. ```js { From 6fbe488504729b4da4231f55097a144d9bbaa4a7 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Mon, 12 Jun 2023 18:40:19 -0400 Subject: [PATCH 42/61] Fixing indentation --- 172.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/172.md b/172.md index 542258a..9aa59e2 100644 --- a/172.md +++ b/172.md @@ -20,12 +20,12 @@ Kind 34550 should include any field that helps define the community and the set "kind": "34550", "tags": [ ["d", ""], - ["description", ""], + ["description", ""], // moderators ["p", "<32-bytes hex of a pubkey>", "", "moderator"] - ["p", "<32-bytes hex of a pubkey>", "", "moderator"] - ["p", "<32-bytes hex of a pubkey>", "", "moderator"] + ["p", "<32-bytes hex of a pubkey>", "", "moderator"] + ["p", "<32-bytes hex of a pubkey>", "", "moderator"] ] } ``` @@ -61,8 +61,8 @@ The post-approval event includes a stringified `new post request` event inside t "kind": "34551", "tags": [ ["a", "34550::", ""], - ["e", "", ""], - ["p", "", ""], + ["e", "", ""], + ["p", "", ""], ], "content": "{ }" } From bf84e733f3ad870ffd4516c6dfb60069997923be Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Tue, 13 Jun 2023 10:34:34 -0400 Subject: [PATCH 43/61] Adds preferred relay information to tags. --- 172.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/172.md b/172.md index 9aa59e2..1ca8b17 100644 --- a/172.md +++ b/172.md @@ -21,11 +21,19 @@ Kind 34550 should include any field that helps define the community and the set "tags": [ ["d", ""], ["description", ""], + ["image", "", "WidthxHeight"] + + //.. other tags relevant to defining the community // moderators - ["p", "<32-bytes hex of a pubkey>", "", "moderator"] - ["p", "<32-bytes hex of a pubkey>", "", "moderator"] - ["p", "<32-bytes hex of a pubkey>", "", "moderator"] + ["p", "<32-bytes hex of a pubkey>", "", "moderator"], + ["p", "<32-bytes hex of a pubkey>", "", "moderator"], + ["p", "<32-bytes hex of a pubkey>", "", "moderator"], + + // relays used by the community + ["relay", "", "author"], + ["relay", ""], + ["relay", ""] ] } ``` @@ -51,7 +59,7 @@ Community management clients can filter all mentions of the kind-34550 event and # Post Approval by moderators -The post-approval event includes a stringified `new post request` event inside the content of the approval (NIP-18-style). +The post-approval event includes a stringified `new post request` event inside the `.content` of the approval (NIP-18-style). ```js { From 4e61eb4e468a071c7d1efc8d0df6df06f65d5926 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Tue, 13 Jun 2023 15:52:41 -0400 Subject: [PATCH 44/61] Update 172.md Adds kind to the post approval. Co-authored-by: arthurfranca --- 172.md | 1 + 1 file changed, 1 insertion(+) diff --git a/172.md b/172.md index 1ca8b17..4689165 100644 --- a/172.md +++ b/172.md @@ -71,6 +71,7 @@ The post-approval event includes a stringified `new post request` event inside t ["a", "34550::", ""], ["e", "", ""], ["p", "", ""], + ["k", ""], ], "content": "{ }" } From 0c3df0ee30ca2a6eff842d7f851fd022e055a030 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 09:38:30 -0400 Subject: [PATCH 45/61] Removes quotes from kind Co-authored-by: arthurfranca --- 172.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/172.md b/172.md index 4689165..330fd1a 100644 --- a/172.md +++ b/172.md @@ -17,7 +17,7 @@ Kind 34550 should include any field that helps define the community and the set "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", "created_at": "", - "kind": "34550", + "kind": 34550, "tags": [ ["d", ""], ["description", ""], From 856ed84776b0b98b1e40d3776c8e65cc0c62957f Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 09:38:48 -0400 Subject: [PATCH 46/61] Fix typos in community image Co-authored-by: arthurfranca --- 172.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/172.md b/172.md index 330fd1a..92cd52c 100644 --- a/172.md +++ b/172.md @@ -21,9 +21,9 @@ Kind 34550 should include any field that helps define the community and the set "tags": [ ["d", ""], ["description", ""], - ["image", "", "WidthxHeight"] + ["image", "", "WidthxHeight"], - //.. other tags relevant to defining the community + //.. other tags relevant to defining the community // moderators ["p", "<32-bytes hex of a pubkey>", "", "moderator"], From 4c7b728be18c8cd934a879d888c04c85ac852687 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 09:38:56 -0400 Subject: [PATCH 47/61] Fix formatting Co-authored-by: arthurfranca --- 172.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/172.md b/172.md index 92cd52c..6a89a53 100644 --- a/172.md +++ b/172.md @@ -30,7 +30,7 @@ Kind 34550 should include any field that helps define the community and the set ["p", "<32-bytes hex of a pubkey>", "", "moderator"], ["p", "<32-bytes hex of a pubkey>", "", "moderator"], - // relays used by the community + // relays used by the community ["relay", "", "author"], ["relay", ""], ["relay", ""] From 3ff40201bdeae142be249c13a4c1983c18aabf84 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 09:39:32 -0400 Subject: [PATCH 48/61] Fixes double-quoted kind number Co-authored-by: arthurfranca --- 172.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/172.md b/172.md index 6a89a53..9f5fab5 100644 --- a/172.md +++ b/172.md @@ -47,7 +47,7 @@ Any Nostr event can be a post request. Clients should simply add the community's "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", "created_at": "", - "kind": "1", + "kind": 1, "tags": [ ["a", "34550::", ""], ], From c07b5fa9b03dc4ce4f68140e3a57ceafcf5b95b3 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 09:46:24 -0400 Subject: [PATCH 49/61] Moves post approval to a regular (non-replaceable event) --- 172.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/172.md b/172.md index 9f5fab5..4a9f5a9 100644 --- a/172.md +++ b/172.md @@ -6,7 +6,7 @@ Moderated Communities (Reddit Style) `draft` `optional` `author:vitorpamplona` -The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `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 an `a` tag. Moderators issue an approval event `34551` that links the community with the new post. +The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `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 an `a` tag. Moderators issue an approval event `4550` that links the community with the new post. # Community definition @@ -66,7 +66,7 @@ The post-approval event includes a stringified `new post request` event inside t "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", "created_at": "", - "kind": "34551", + "kind": "4550", "tags": [ ["a", "34550::", ""], ["e", "", ""], @@ -77,7 +77,7 @@ The post-approval event includes a stringified `new post request` event inside t } ``` -It's recommended that multiple moderators approve posts to avoid unapproving them when a given moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign post-approvals for posts in the past or the community will restart. +It's recommended that multiple moderators approve posts to avoid unapproving them when a given 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 copies of each moderator's approval events. # Displaying @@ -88,7 +88,7 @@ The following filter displays the approved posts. ```js { "authors": ["", "moderator1", "moderator2", "moderator3", ...], - "kinds": 34551, + "kinds": ["4550"], "#a": ["34550::"], } ``` \ No newline at end of file From 2b53049c1a69c413de1b3077a94a49810a2e0aff Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 09:50:06 -0400 Subject: [PATCH 50/61] Adds arthurfranca as author --- 172.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/172.md b/172.md index 4a9f5a9..ec6a60b 100644 --- a/172.md +++ b/172.md @@ -4,7 +4,7 @@ NIP-172 Moderated Communities (Reddit Style) ------------------------------------ -`draft` `optional` `author:vitorpamplona` +`draft` `optional` `author:vitorpamplona` `author:arthurfranca` The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `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 an `a` tag. Moderators issue an approval event `4550` that links the community with the new post. From 63441099be5898afc685bb2be28c2b30b2f27fc2 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 09:53:55 -0400 Subject: [PATCH 51/61] Fixes typos & clarifies the text. --- 172.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/172.md b/172.md index ec6a60b..df78081 100644 --- a/172.md +++ b/172.md @@ -77,7 +77,7 @@ The post-approval event includes a stringified `new post request` event inside t } ``` -It's recommended that multiple moderators approve posts to avoid unapproving them when a given 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 copies of each moderator's approval events. +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 dissapear with moderators. # Displaying @@ -88,7 +88,7 @@ The following filter displays the approved posts. ```js { "authors": ["", "moderator1", "moderator2", "moderator3", ...], - "kinds": ["4550"], + "kinds": [4550], "#a": ["34550::"], } ``` \ No newline at end of file From 3a01861adeaf527f160e73b892b383a2c81a5c66 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 10:03:07 -0400 Subject: [PATCH 52/61] Adds references to other NIPs with more information and standardizes citations to event kinds --- 172.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/172.md b/172.md index df78081..0c48ea3 100644 --- a/172.md +++ b/172.md @@ -6,11 +6,11 @@ Moderated Communities (Reddit Style) `draft` `optional` `author:vitorpamplona` `author:arthurfranca` -The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `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 an `a` tag. Moderators issue an approval event `4550` that links the community with the new post. +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 (See [NIP-33](33.md)). Moderators issue an approval event `kind:4550` that links the community with the new post. # Community definition -Kind 34550 should include any field that helps define the community and the set of moderators. +`Kind:34550` should include any field that helps define the community and the set of moderators. ```js { @@ -19,16 +19,16 @@ Kind 34550 should include any field that helps define the community and the set "created_at": "", "kind": 34550, "tags": [ - ["d", ""], - ["description", ""], - ["image", "", "WidthxHeight"], + ["d", ""], + ["description", ""], + ["image", "", "x"], //.. other tags relevant to defining the community // moderators - ["p", "<32-bytes hex of a pubkey>", "", "moderator"], - ["p", "<32-bytes hex of a pubkey>", "", "moderator"], - ["p", "<32-bytes hex of a pubkey>", "", "moderator"], + ["p", "<32-bytes hex of a pubkey1>", "", "moderator"], + ["p", "<32-bytes hex of a pubkey2>", "", "moderator"], + ["p", "<32-bytes hex of a pubkey3>", "", "moderator"], // relays used by the community ["relay", "", "author"], @@ -49,17 +49,17 @@ Any Nostr event can be a post request. Clients should simply add the community's "created_at": "", "kind": 1, "tags": [ - ["a", "34550::", ""], + ["a", "34550::", ""], ], - "content": "" + "content": "" } ``` -Community management clients can filter all mentions of the kind-34550 event and request moderators to approve each submission. The same moderator can remove his/her approval of the post at any time. +Community management clients can filter all mentions of the `kind:34550` event and request moderators to approve each submission. The same moderator can remove his/her approval of the post at any time. # Post Approval by moderators -The post-approval event includes a stringified `new post request` event inside the `.content` of the approval (NIP-18-style). +The post-approval event includes a stringified `new post request` event inside the `.content` of the approval ([NIP-18-style](18.md)). ```js { @@ -68,12 +68,12 @@ The post-approval event includes a stringified `new post request` event inside t "created_at": "", "kind": "4550", "tags": [ - ["a", "34550::", ""], - ["e", "", ""], - ["p", "", ""], + ["a", "34550::", ""], + ["e", "", ""], + ["p", "", ""], ["k", ""], ], - "content": "{ }" + "content": "" } ``` @@ -87,8 +87,8 @@ The following filter displays the approved posts. ```js { - "authors": ["", "moderator1", "moderator2", "moderator3", ...], + "authors": ["", "", "", "", ...], "kinds": [4550], - "#a": ["34550::"], + "#a": ["34550::"], } ``` \ No newline at end of file From d42fc18fa5800399690d82acfe34606e26419b8d Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 10:05:35 -0400 Subject: [PATCH 53/61] Addressing how to unapprove a post. --- 172.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/172.md b/172.md index 0c48ea3..87ae424 100644 --- a/172.md +++ b/172.md @@ -55,7 +55,7 @@ Any Nostr event can be a post request. Clients should simply add the community's } ``` -Community management clients can filter all mentions of the `kind:34550` event and request moderators to approve each submission. The same moderator can remove his/her approval of the post at any time. +Community management clients can filter all mentions to a given `kind:34550` event and request moderators to approve each submission. The same moderator can delete his/her approval of the post at any time using event deletions (See [NIP-09](09.md)). # Post Approval by moderators From 135a2f533890b77d3df1deca3fbe09ae47265723 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 10:13:09 -0400 Subject: [PATCH 54/61] Rewriting to use specification verbs SHOULD, MAY, etc --- 172.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/172.md b/172.md index 87ae424..123eaef 100644 --- a/172.md +++ b/172.md @@ -8,9 +8,9 @@ Moderated Communities (Reddit Style) 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 (See [NIP-33](33.md)). Moderators issue an approval event `kind:4550` that links the community with the new post. -# Community definition +# Community Definition -`Kind:34550` should include any field that helps define the community and the set of moderators. +`Kind:34550` SHOULD include any field that helps define the community and the set of moderators. ```js { @@ -19,9 +19,9 @@ The goal of this NIP is to create moderator-approved public communities around a "created_at": "", "kind": 34550, "tags": [ - ["d", ""], - ["description", ""], - ["image", "", "x"], + ["d", ""], + ["description", ""], + ["image", "", "x"], //.. other tags relevant to defining the community @@ -40,7 +40,7 @@ The goal of this NIP is to create moderator-approved public communities around a # New Post Request -Any Nostr event can be a post request. Clients should simply add the community's `a` tag to be presented for the moderator's approval. +Any Nostr event can be a post request. Clients MUST add the community's `a` tag to the new post event in order to be presented for the moderator's approval. ```js { @@ -55,11 +55,11 @@ Any Nostr event can be a post request. Clients should simply add the community's } ``` -Community management clients can filter all mentions to a given `kind:34550` event and request moderators to approve each submission. The same moderator can delete his/her approval of the post at any time using event deletions (See [NIP-09](09.md)). +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)). # Post Approval by moderators -The post-approval event includes a stringified `new post request` event inside the `.content` of the approval ([NIP-18-style](18.md)). +The post-approval event SHOULD include a stringified `new post request` event inside the `.content` of the approval ([NIP-18-style](18.md)). ```js { @@ -81,14 +81,16 @@ It's recommended that multiple moderators approve posts to avoid deleting them f # Displaying -Community clients can display posts that have been approved by at least 1 moderator or by the community owner. +Community clients SHOULD display posts that have been approved by at least 1 moderator or by the community owner. The following filter displays the approved posts. ```js { - "authors": ["", "", "", "", ...], + "authors": ["", "", "", "", ...], "kinds": [4550], "#a": ["34550::"], } -``` \ No newline at end of file +``` + +Clients MAY hide approvals by blocked moderators at the user's request. \ No newline at end of file From 73f2f24bbfb3a7b4fc16f9bbc96b58a7b0ab9410 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 10:20:11 -0400 Subject: [PATCH 55/61] Better describes the use of `a`, `e` and `p` tags in the post approval event. --- 172.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/172.md b/172.md index 123eaef..84a88c9 100644 --- a/172.md +++ b/172.md @@ -59,7 +59,7 @@ Community management clients MAY filter all mentions to a given `kind:34550` eve # Post Approval by moderators -The post-approval event SHOULD include a stringified `new post request` event inside the `.content` of the approval ([NIP-18-style](18.md)). +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 notificaitons). 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. ```js { From f8aa3f4e514dbe1688d269e71b1d5c6afad4c8c8 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 15 Jun 2023 10:24:48 -0400 Subject: [PATCH 56/61] Allows replaceable events to be part of communities as well. --- 172.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/172.md b/172.md index 84a88c9..d2b7a53 100644 --- a/172.md +++ b/172.md @@ -79,6 +79,10 @@ 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 dissapear with moderators. +Replaceable events can be submitted for approval in two ways: (i) by their `e` tag if moderators want to approve each individual change to the repleceable event or (ii) by the `a` tag if the moderator trusts the original post author to not modify the event beyond community rules. + +Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be included in all `34550:*` `a` tags. + # Displaying Community clients SHOULD display posts that have been approved by at least 1 moderator or by the community owner. From 7957880b48c7a56687364d9325e28c17e1ed9ca2 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Mon, 19 Jun 2023 15:07:40 -0400 Subject: [PATCH 57/61] Adds relay markers --- 172.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/172.md b/172.md index d2b7a53..28c3612 100644 --- a/172.md +++ b/172.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. +`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. ```js { @@ -30,9 +30,10 @@ The goal of this NIP is to create moderator-approved public communities around a ["p", "<32-bytes hex of a pubkey2>", "", "moderator"], ["p", "<32-bytes hex of a pubkey3>", "", "moderator"], - // relays used by the community + // relays used by the community (w/optional marker) ["relay", "", "author"], - ["relay", ""], + ["relay", "", "requests"], + ["relay", "", "approvals"], ["relay", ""] ] } From 507b0c20a52e4288d4ebaa9df0c4e12b89835172 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Fri, 7 Jul 2023 14:16:20 -0400 Subject: [PATCH 58/61] added a third option to approve replaceable events. --- 172.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/172.md b/172.md index 28c3612..3535039 100644 --- a/172.md +++ b/172.md @@ -80,7 +80,7 @@ The post-approval event MUST include `a` tags of the communities the moderator i It's recommended that multiple moderators approve posts to avoid deleting them from the community when a moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copy and re-sign of each moderator's approval events to make sure posts don't dissapear with moderators. -Replaceable events can be submitted for approval in two ways: (i) by their `e` tag if moderators want to approve each individual change to the repleceable event or (ii) by the `a` tag if the moderator trusts the original post author to not modify the event beyond community rules. +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. Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be included in all `34550:*` `a` tags. From 892fe9e4004dbb515d71729b92d0432665f8e823 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Tue, 8 Aug 2023 13:31:54 -0300 Subject: [PATCH 59/61] move 172 to 72 and update indexes. --- 172.md => 72.md | 36 ++++++++++++++++++------------------ README.md | 6 +++++- 2 files changed, 23 insertions(+), 19 deletions(-) rename 172.md => 72.md (93%) diff --git a/172.md b/72.md similarity index 93% rename from 172.md rename to 72.md index 3535039..750b076 100644 --- a/172.md +++ b/72.md @@ -1,5 +1,5 @@ -NIP-172 -======= +NIP-72 +====== Moderated Communities (Reddit Style) ------------------------------------ @@ -10,29 +10,29 @@ 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. -```js +```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": "", + "created_at": , "kind": 34550, "tags": [ ["d", ""], ["description", ""], ["image", "", "x"], - + //.. other tags relevant to defining the community // moderators ["p", "<32-bytes hex of a pubkey1>", "", "moderator"], ["p", "<32-bytes hex of a pubkey2>", "", "moderator"], ["p", "<32-bytes hex of a pubkey3>", "", "moderator"], - + // relays used by the community (w/optional marker) ["relay", "", "author"], - ["relay", "", "requests"], + ["relay", "", "requests"], ["relay", "", "approvals"], ["relay", ""] ] @@ -43,15 +43,15 @@ The goal of this NIP is to create moderator-approved public communities around a Any Nostr event can be a post request. Clients MUST add the community's `a` tag to the new post event in order to be presented for the moderator's approval. -```js +```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": "", + "created_at": , "kind": 1, "tags": [ ["a", "34550::", ""], - ], + ], "content": "" } ``` @@ -62,27 +62,27 @@ Community management clients MAY filter all mentions to a given `kind:34550` eve 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 notificaitons). 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. -```js +```json { "id": "<32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>", "pubkey": "<32-bytes lowercase hex-encoded public key of the event creator>", - "created_at": "", - "kind": "4550", + "created_at": , + "kind": 4550, "tags": [ ["a", "34550::", ""], ["e", "", ""], ["p", "", ""], ["k", ""], - ], + ], "content": "" } ``` -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 dissapear with moderators. +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 dissapear 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. -Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be included in all `34550:*` `a` tags. +Clients SHOULD evaluate any non-`34550:*` `a` tag as posts to be included in all `34550:*` `a` tags. # Displaying @@ -98,4 +98,4 @@ The following filter displays the approved posts. } ``` -Clients MAY hide approvals by blocked moderators at the user's request. \ No newline at end of file +Clients MAY hide approvals by blocked moderators at the user's request. diff --git a/README.md b/README.md index cfee37d..3c35ef3 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-57: Lightning Zaps](57.md) - [NIP-58: Badges](58.md) - [NIP-65: Relay List Metadata](65.md) +- [NIP-72: Moderated Communities](72.md) - [NIP-78: Application-specific data](78.md) - [NIP-89: Recommended Application Handlers](89.md) - [NIP-94: File Metadata](94.md) @@ -94,6 +95,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `1311` | Live Chat Message | [53](53.md) | | `1984` | Reporting | [56](56.md) | | `1985` | Label | [32](32.md) | +| `4550` | Community Post Approval | [72](72.md) | | `9734` | Zap Request | [57](57.md) | | `9735` | Zap | [57](57.md) | | `10000` | Mute List | [51](51.md) | @@ -123,6 +125,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `31925` | Calendar Event RSVP | [52](52.md) | | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | +| `34550` | Community Definition | [72](72.md) | + ### Event Kind Ranges @@ -170,7 +174,7 @@ When experimenting with kinds, keep in mind the classification introduced by [NI | `e` | event id (hex) | relay URL, marker | [1](01.md), [10](10.md) | | `g` | geohash | -- | [12](12.md), [52](52.md) | | `i` | identity | proof | [39](39.md) | -| `k` | kind number (string) | -- | [18](18.md) | +| `k` | kind number (string) | -- | [18](18.md), [72](72.md) | | `l` | label, label namespace | annotations | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | | `p` | pubkey (hex) | relay URL | [1](01.md) | From 77b626d74871fb195dfd7b211a75af97753333dd Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Wed, 9 Aug 2023 00:55:21 +0200 Subject: [PATCH 60/61] nips over nostr --- 17.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 17.md diff --git a/17.md b/17.md new file mode 100644 index 0000000..6b5f3fc --- /dev/null +++ b/17.md @@ -0,0 +1,26 @@ +# NIPs over Nostr + +`draft` `optional` `author:Semisol` + +This NIP defines a method to do NIPs over Nostr. + +## NIP event + +A NIP event is an event with kind 9777. The content is in Markdown and is the NIP text. + +A NIP event can be identified in multiple ways: +- `50001::`: Represents the NIP. +- `!50001::@:`: Represents a specific version of this NIP. The ID may be omitted. + +The following tags may be in a NIP event (bold ones are mandatory, and underlined ones may be used more than once): +- **`d`**: A distinguishing tag for this NIP. A NIP event is identified by the author's public key and this d tag. +- **`v`**: The version for this NIP, as a limited subset of SemVer in the format `major.minor.patch`. + - More than one event can exist for the same version of a NIP. This is intended for minor edits, and if this is encountered, the event with the higher created_at is used, + and this SHOULD be avoided when possible. +- **__`p`__**: An author or contributor of this NIP. The parameter after the public key can be specified the type of contribution (more may be added): + - `author`: An author of this NIP. + - `contrib`: Someone that contributed to this NIP. +- __`D`__: Depends on tag, in the format `["D", "50001::", "@"]`. The ID may not be omitted. +- __`E`__: Extends tag, in the same format as the `D` tag. +- __`K`__: A kind or kind range this NIP uses, such as `0` or `10000-19999`. +- __**`license`**__: A license for this NIP as an SPDX license identifier. Multiple tags mean any can be chosen by the user. From ce7e6b2100918648ec4341c5fe517d076e8d225c Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Wed, 9 Aug 2023 00:56:48 +0200 Subject: [PATCH 61/61] wrong branch --- 17.md | 26 -------------------------- 1 file changed, 26 deletions(-) delete mode 100644 17.md diff --git a/17.md b/17.md deleted file mode 100644 index 6b5f3fc..0000000 --- a/17.md +++ /dev/null @@ -1,26 +0,0 @@ -# NIPs over Nostr - -`draft` `optional` `author:Semisol` - -This NIP defines a method to do NIPs over Nostr. - -## NIP event - -A NIP event is an event with kind 9777. The content is in Markdown and is the NIP text. - -A NIP event can be identified in multiple ways: -- `50001::`: Represents the NIP. -- `!50001::@:`: Represents a specific version of this NIP. The ID may be omitted. - -The following tags may be in a NIP event (bold ones are mandatory, and underlined ones may be used more than once): -- **`d`**: A distinguishing tag for this NIP. A NIP event is identified by the author's public key and this d tag. -- **`v`**: The version for this NIP, as a limited subset of SemVer in the format `major.minor.patch`. - - More than one event can exist for the same version of a NIP. This is intended for minor edits, and if this is encountered, the event with the higher created_at is used, - and this SHOULD be avoided when possible. -- **__`p`__**: An author or contributor of this NIP. The parameter after the public key can be specified the type of contribution (more may be added): - - `author`: An author of this NIP. - - `contrib`: Someone that contributed to this NIP. -- __`D`__: Depends on tag, in the format `["D", "50001::", "@"]`. The ID may not be omitted. -- __`E`__: Extends tag, in the same format as the `D` tag. -- __`K`__: A kind or kind range this NIP uses, such as `0` or `10000-19999`. -- __**`license`**__: A license for this NIP as an SPDX license identifier. Multiple tags mean any can be chosen by the user.