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 cb1f126c..987b5a2f 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 987b5a2f..e67ec8b1 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 e67ec8b1..74716857 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 74716857..4d02611d 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 4d02611d..a2214817 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 a2214817..cb6a2904 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 cb6a2904..27b85a4c 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 27b85a4c..39fa5620 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 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 09/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 00000000..c601412e --- /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 1360190a..ff128008 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 10/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 00000000..8f227811 --- /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 ff128008..cfee37dc 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 11/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 00000000..0cc81078 --- /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 12/61] Typos --- 172.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/172.md b/172.md index 0cc81078..542258ac 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 13/61] Fixing indentation --- 172.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/172.md b/172.md index 542258ac..9aa59e21 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 14/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 9aa59e21..1ca8b17d 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 15/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 1ca8b17d..4689165e 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 16/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 4689165e..330fd1a8 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 17/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 330fd1a8..92cd52ca 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 18/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 92cd52ca..6a89a538 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 19/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 6a89a538..9f5fab50 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 20/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 9f5fab50..4a9f5a99 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 21/61] Adds arthurfranca as author --- 172.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/172.md b/172.md index 4a9f5a99..ec6a60bd 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 22/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 ec6a60bd..df78081f 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 23/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 df78081f..0c48ea38 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 24/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 0c48ea38..87ae424b 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 25/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 87ae424b..123eaefb 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 26/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 123eaefb..84a88c92 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 27/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 84a88c92..d2b7a533 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 28/61] Adds relay markers --- 172.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/172.md b/172.md index d2b7a533..28c36120 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 29/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 28c36120..35350398 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 30/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 35350398..750b076a 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 cfee37dc..3c35ef36 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 31/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 00000000..6b5f3fc3 --- /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 32/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 6b5f3fc3..00000000 --- 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. From f91cb5ce665fa404b3a5e00c9f49f555d7a3855b Mon Sep 17 00:00:00 2001 From: Yasuhiro Matsumoto Date: Thu, 10 Aug 2023 01:34:49 +0900 Subject: [PATCH 33/61] fix typos --- 72.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/72.md b/72.md index 750b076a..f4bebf4e 100644 --- a/72.md +++ b/72.md @@ -60,7 +60,7 @@ Community management clients MAY filter all mentions to a given `kind:34550` eve # Post Approval by moderators -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. +The post-approval event MUST include `a` tags of the communities the moderator is posting into (one or more), the `e` tag of the post and `p` tag of the author of the post (for approval notifications). The event SHOULD also include the stringified `post request` event inside the `.content` ([NIP-18-style](18.md)) and a `k` tag with the original post's event kind to allow filtering of approved posts by kind. ```json { @@ -78,7 +78,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. +It's recommended that multiple moderators approve posts to avoid deleting them from the community when a moderator is removed from the owner's list. In case the full list of moderators must be rotated, the new moderator set must sign new approvals for posts in the past or the community will restart. The owner can also periodically copy and re-sign of each moderator's approval events to make sure posts don't disappear with moderators. Post Approvals of replaceable events can be created in three ways: (i) by tagging the replaceable event as an `e` tag if moderators want to approve each individual change to the repleceable event; (ii) by tagging the replaceable event as an `a` tag if the moderator authorizes the replaceable event author to make changes without additional approvals and (iii) by tagging the replaceable event with both its `e` and `a` tag which empowers clients to display the original and updated versions of the event, with appropriate remarks in the UI. Since relays are instructed to delete old versions of a replaceable event, the `.content` of an `e`-approval MUST have the specific version of the event or Clients might not be able to find that version of the content anywhere. From e5a6c2c698bcfca4d9d135343fabf8846214314a Mon Sep 17 00:00:00 2001 From: ktecho Date: Thu, 10 Aug 2023 00:16:35 +0200 Subject: [PATCH 34/61] Adding (optional) shipping costs per product to nip-15 --- 15.md | 32 ++++++++++++++++++++++++-------- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/15.md b/15.md index f8df3284..bd0f0db8 100644 --- a/15.md +++ b/15.md @@ -8,7 +8,7 @@ Nostr Marketplace (for resilient marketplaces) > Based on https://github.com/lnbits/Diagon-Alley -> Implemented here https://github.com/lnbits/nostrmarket +> Implemented in [NostrMarket](https://github.com/lnbits/nostrmarket) and [Plebeian Market](https://github.com/PlebeianTech/plebeian-market) ## Terms @@ -54,7 +54,7 @@ A merchant can publish these events: { "id": , "name": , - "cost": , + "cost": , "countries": [], } ] @@ -63,9 +63,12 @@ A merchant can publish these events: Fields that are not self-explanatory: - `shipping`: - - an array with possible shipping zones for this stall. The customer MUST choose exactly one shipping zone. + - an array with possible shipping zones for this stall. + - the customer MUST choose exactly one of those shipping zones. - shipping to different zones can have different costs. For some goods (digital for example) the cost can be zero. - the `id` is an internal value used by the merchant. This value must be sent back as the customer selection. + - each shipping zone contains the base cost for orders made to that shipping zone, but a specific shipping cost per + product can also be specified if the shipping cost for that product is higher than what's specified by the base cost. **Event Tags**: ```json @@ -87,17 +90,30 @@ Fields that are not self-explanatory: "price": , "quantity": , "specs": [ - [ , ] - ] + [, ] + ], + "shipping": [ + { + "id": , + "cost": , + } + ] } ``` Fields that are not self-explanatory: - `specs`: - - an array of key pair values. It allows for the Customer UI to present present product specifications in a structure mode. It also allows comparison between products + - an optional array of key pair values. It allows for the Customer UI to present product specifications in a structure mode. It also allows comparison between products - eg: `[["operating_system", "Android 12.0"], ["screen_size", "6.4 inches"], ["connector_type", "USB Type C"]]` -_Open_: better to move `spec` in the `tags` section of the event? + _Open_: better to move `spec` in the `tags` section of the event? + +- `shipping`: + - an _optional_ array of costs to be used per shipping zone, only for products that require special shipping costs to be added to the base shipping cost defined in the stall + - the `id` should match the id of the shipping zone, as defined in the `shipping` field of the stall + - to calculate the total cost of shipping for an order, the user will choose a shipping option during checkout, and then the client must consider this costs: + - the `base cost from the stall` for the chosen shipping option + - the result of multiplying the product units by the `shipping costs specified in the product`, if any. **Event Tags**: ```json @@ -211,4 +227,4 @@ Customer support is handled over whatever communication method was specified. If ## Additional -Standard data models can be found here here +Standard data models can be found here From b7faf8a4fec78d3504989117944b77a893a56d32 Mon Sep 17 00:00:00 2001 From: ktecho Date: Thu, 10 Aug 2023 16:17:45 +0200 Subject: [PATCH 35/61] Fix copy/paste --- 15.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/15.md b/15.md index bd0f0db8..26015590 100644 --- a/15.md +++ b/15.md @@ -95,7 +95,7 @@ Fields that are not self-explanatory: "shipping": [ { "id": , - "cost": , + "cost": , } ] } @@ -109,7 +109,7 @@ Fields that are not self-explanatory: _Open_: better to move `spec` in the `tags` section of the event? - `shipping`: - - an _optional_ array of costs to be used per shipping zone, only for products that require special shipping costs to be added to the base shipping cost defined in the stall + - an _optional_ array of extra costs to be used per shipping zone, only for products that require special shipping costs to be added to the base shipping cost defined in the stall - the `id` should match the id of the shipping zone, as defined in the `shipping` field of the stall - to calculate the total cost of shipping for an order, the user will choose a shipping option during checkout, and then the client must consider this costs: - the `base cost from the stall` for the chosen shipping option From d87f86178b2178c2cb171af8a4e042bdffe4b1fe Mon Sep 17 00:00:00 2001 From: benthecarman Date: Thu, 10 Aug 2023 15:48:53 -0500 Subject: [PATCH 36/61] NIP-25: Handle empty string as + --- 25.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/25.md b/25.md index 86ce7635..63c07a73 100644 --- a/25.md +++ b/25.md @@ -19,7 +19,8 @@ dislikes in a reddit-like system of upvotes and downvotes, or display them as separate tallies. The `content` MAY be an emoji, or [NIP-30](30.md) custom emoji in this case it MAY be interpreted as a "like" or "dislike", -or the client MAY display this emoji reaction on the post. +or the client MAY display this emoji reaction on the post. If the `content` is an empty string then the client should +consider it a "+". Tags ---- From a5047326d4d7c28e66c5d1262c252b86a1c8fe67 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Fri, 11 Aug 2023 06:12:50 -0400 Subject: [PATCH 37/61] Simplifies NIP-65 (#700) Co-authored-by: fiatjaf_ Co-authored-by: Jon Staab --- 65.md | 93 +++++++++++++++++++++++++---------------------------------- 1 file changed, 39 insertions(+), 54 deletions(-) diff --git a/65.md b/65.md index 55f9ff0a..3c064385 100644 --- a/65.md +++ b/65.md @@ -4,63 +4,13 @@ NIP-65 Relay List Metadata ------------------- -`draft` `optional` `author:mikedilger` +`draft` `optional` `author:mikedilger` `author:vitorpamplona` -A special replaceable event meaning "Relay List Metadata" is defined as an event with kind `10002` having a list of `r` tags, one for each relay the author uses to either read or write to. +Defines a replaceable event using `kind:10002` to advertise preferred relays for discovering a user's content and receiving fresh content from others. -The primary purpose of this relay list is to advertise to others, not for configuring one's client. +The event MUST include a list of `r` tags with relay URIs and a `read` or `write` marker. If the marker is omitted, the relay is used for both purposes. -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. - -Clients SHOULD, as with all replaceable events, use only the most recent kind-10002 event they can find. - -### The meaning of read and write - -Write relays are for events that are intended for anybody (e.g. your followers). Read relays are for events that address a particular person. - -Clients SHOULD write feed-related events created by their user to their user's write relays. - -Clients SHOULD read feed-related events created by another from at least some of that other person's write relays. Explicitly, they SHOULD NOT expect them to be available at their user's read relays. It SHOULD NOT be presumed that the user's read relays coincide with the write relays of the people the user follows. - -Clients SHOULD read events that tag their user from their user's read relays. - -Clients SHOULD write events that tag a person to at least some of that person's read relays. Explicitly, they SHOULD NOT expect that person will pick them up from their user's write relays. It SHOULD NOT be presumed that the user's write relays coincide with the read relays of the person being tagged. - -Clients SHOULD presume that if their user has a pubkey in their ContactList (kind 3) that it is because they wish to see that author's feed-related events. But clients MAY presume otherwise. - -### Motivation - -There is a common nostr use case where users wish to follow the content produced by other users. This is evidenced by the implicit meaning of the Contact List in [NIP-02](02.md) - -Because users don't often share the same sets of relays, ad-hoc solutions have arisen to get that content, but these solutions negatively impact scalability and decentralization: - - - Most people are sending their posts to the same most popular relays in order to be more widely seen - - Many people are pulling from a large number of relays (including many duplicate events) in order to get more data - - Events are being copied between relays, oftentimes to many different relays - -### Purposes - -The purpose of this NIP is to help clients find the events of the people they follow, to help tagged events get to the people tagged, and to help nostr scale better. - -### Suggestions - -It is suggested that people spread their kind `10002` events to many relays, but write their normal feed-related events to a much smaller number of relays (between 2 to 6 relays). It is suggested that clients offer a way for users to spread their kind `10002` events to many more relays than they normally post to. - -Authors may post events outside of the feed that they wish their followers to follow by posting them to relays outside of those listed in their "Relay List Metadata". For example, an author may want to reply to someone without all of their followers watching. - -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 - - 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. - -### Example +The `.content` is not used. ```json { @@ -74,3 +24,38 @@ Even though this is user related metadata, it is a separate event from kind `0` "content": "", ...other fields ``` + +This NIP doesn't fully replace relay lists that are designed to configure a client's usage of relays (such as `kind:3` style relay lists). Clients MAY use other relay lists in situations where a `kind:10002` relay list cannot be found. + +## When to Use Read and Write + +When seeking events **from** a user, Clients SHOULD use the WRITE relays of the user's `kind:10002` + +When seeking events **about** a user, where the user was tagged, Clients SHOULD use the READ relays of the user's `kind:10002` + +When broadcasting an event, Clients SHOULD: + +- Broadcast the event to the WRITE relays of the author +- Broadcast the event all READ relays of each tagged user. + +## Motivation + +The old model of using a fixed relay list per user centralizes in large relay operators: + + - Most users submit their posts to the same highly popular relays, aiming to achieve greater visibility among a broader audience. + - Many users are pulling events from a large number of relays in order to get more data at the expense of duplication + - Events are being copied between relays, oftentimes to many different relays + +This NIP allows Clients to connect directly with the most up-to-date relay set from each individual user, eliminating the need of broadcasting events to popular relays. + +## Final Considerations + +1. Clients SHOULD guide users to keep `kind:10002` lists small (2-4 relays). + +2. Clients SHOULD spread an author's `kind:10002` events to as many relays as viable. + +3. `kind:10002` events should primarily be used to advertise the user's preferred relays to others. A user's own client may use other heuristics for selecting relays for fetching data. + +4. DMs SHOULD only be broadcasted to the author's WRITE relays and to the receiver's READ relays to keep maximum privacy. + +5. If a relay signals support for this NIP in their [NIP-11](11.md) document that means they're willing to accept kind 10002 events from a broad range of users, not only their paying customers or whitelisted group. From 72bb8a128b2d7d3c2c654644cd68d0d0fe58a3b1 Mon Sep 17 00:00:00 2001 From: fiatjaf_ Date: Sun, 13 Aug 2023 13:47:45 -0300 Subject: [PATCH 38/61] merge nips 12, 16, 20 and 33 into nip 01 (#703) Co-authored-by: Viktor Vsk --- 01.md | 102 ++++++++++++++++++++++++++++++++++++++---------------- 11.md | 13 ++++--- 12.md | 37 ++------------------ 13.md | 2 +- 15.md | 24 ++++++------- 16.md | 35 ++----------------- 19.md | 2 +- 20.md | 88 ++-------------------------------------------- 22.md | 6 ++-- 23.md | 8 ++--- 33.md | 50 ++------------------------ 51.md | 8 ++--- 52.md | 6 ++-- 53.md | 19 +++++----- 58.md | 10 ++---- 72.md | 2 +- README.md | 47 +++++++++---------------- 17 files changed, 141 insertions(+), 318 deletions(-) diff --git a/01.md b/01.md index 50e9c9ca..4b33975e 100644 --- a/01.md +++ b/01.md @@ -4,7 +4,7 @@ NIP-01 Basic protocol flow description ------------------------------- -`draft` `mandatory` `author:fiatjaf` `author:distbit` `author:scsibug` `author:kukks` `author:jb55` `author:semisol` +`draft` `mandatory` `author:fiatjaf` `author:distbit` `author:scsibug` `author:kukks` `author:jb55` `author:semisol` `author:cameri` `author:Giszmo` This NIP defines the basic protocol that should be implemented by everybody. New NIPs may add new optional (or mandatory) fields and messages and features to the structures and flows described here. @@ -19,11 +19,10 @@ The only object type that exists is the `event`, which has the following format "id": <32-bytes lowercase hex-encoded sha256 of the serialized event data>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, "created_at": , - "kind": , + "kind": , "tags": [ - ["e", <32-bytes hex of the id of another event>, ], - ["p", <32-bytes hex of a pubkey>, ], - ... // other kinds of tags may be included later + [...], + ... ], "content": , "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> @@ -43,9 +42,57 @@ To obtain the `event.id`, we `sha256` the serialized event. The serialization is ] ``` +### Tags + +Each tag is an array of strings of arbitrary size, with some conventions around them. Take a look at the example below: + +```json +{ + ..., + "tags": [ + ["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://nostr.example.com"], + ["p", "f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca"], + ["a", "30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"], + ["alt", "reply"], + ... + ], + ... +} +``` + +The first element of the tag array is referred to as the tag _name_ or _key_ and the second as the tag _value_. So we can safely say that the event above has an `e` tag set to `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"`, an `alt` tag set to `"reply"` and so on. All elements after the second do not have a conventional name. + +This NIP defines 3 standard tags that can be used accross all event kinds with the same meaning. They are as follows: + +- The `e` tag, used to refer to an event: `["e", <32-bytes hex of the id of another event>, ]` +- The `p` tag, used to refer to another user: `["p", <32-bytes hex of a pubkey>, ]` +- The `a` tag, used to refer to a parameterized replaceable event: `["a", :<32-bytes hex of a pubkey>:, ]` + +As a convention, all single-letter key tags are expected to be indexed by relays, such that it is possible, for example, to query or subscribe to events that reference the event `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"` by using the `{"#e": "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"}` filter. + +### Kinds + +Kinds specify how clients should interpret the meaning of each event and the other fields of each event (e.g. an `"r"` tag may have a meaning in an event of kind 1 and an entirely different meaning in an event of kind 10002). Each NIP may define the meaning of a set of kinds that weren't defined elsewhere. This NIP defines two basic kinds: + +- `0`: **metadata**: the `content` is set to a stringified JSON object `{name: , about: , picture: }` describing the user who created the event. A relay may delete older events once it gets a new one for the same pubkey. +- `1`: **text note**: the `content` is set to the **plaintext** content of a note (anything the user wants to say). Content that must be parsed, such as Markdown and HTML, should not be used. Clients should also not parse content as those. + +And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: + +- for kind `n` such that `1000 <= n < 10000`, events are **regular**, which means they're all expected to be stored by relays. +- for kind `n` such that `10000 <= n < 20000`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to be stored by relays, older versions are expected to be discarded. +- for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. +- for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag, only the latest event is expected to be stored by relays, older versions are expected to be discarded. + +These are just conventions and relay implementations may differ. + ## Communication between clients and relays -Relays expose a websocket endpoint to which clients can connect. +Relays expose a websocket endpoint to which clients can connect. Clients should open a single websocket connection to each relay and use it for all their subscriptions. + +### Meaning of WebSocket status codes + +- When a websocket is closed by the relay with a status code `4000` that means the client shouldn't try to connect again. ### From client to relay: sending events and creating subscriptions @@ -61,11 +108,10 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th ```json { - "ids": , - "authors": , + "ids": , + "authors": , "kinds": , - "#e": , - "#p": , + "#": , "since": , "until": , "limit": @@ -74,9 +120,9 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th Upon receiving a `REQ` message, the relay SHOULD query its internal database and return events that match the filter, then store that filter and send again all future events it receives to that same websocket until the websocket is closed. The `CLOSE` event is received with the same `` or a new `REQ` is sent using the same ``, in which case it should overwrite the previous subscription. -Filter attributes containing lists (such as `ids`, `kinds`, or `#e`) are JSON arrays with one or more values. At least one of the array's values must match the relevant field in an event for the condition itself to be considered a match. For scalar event attributes such as `kind`, the attribute from the event must be contained in the filter list. For tag attributes such as `#e`, where an event may have multiple values, the event and filter condition values must have at least one item in common. +Filter attributes containing lists (`ids`, `authors`, `kinds` and tag filters like `#e`) are JSON arrays with one or more values. At least one of the arrays' values must match the relevant field in an event for the condition to be considered a match. For scalar event attributes such as `authors` and `kind`, the attribute from the event must be contained in the filter list. In the case of tag attributes such as `#e`, for which an event may have multiple values, the event and filter condition values must have at least one item in common. -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 `ids`, `authors`, `#e` and `#p` filter lists MUST contain exact 64-character lowercase hex values. 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. @@ -84,32 +130,28 @@ 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 last `n` events ordered by the `created_at`. It is safe to return less events than `limit` specifies, but it is expected that relays do not return (much) more events than requested so clients don't get unnecessarily overwhelmed by data. +The `limit` property of a filter is only valid for the initial query and MUST be ignored afterwards. When `limit: n` is present it is assumed that the events returned in the initial query will be the last `n` events ordered by the `created_at`. 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 -Relays can send 3 types of messages, which must also be JSON arrays, according to the following patterns: +Relays can send 4 types of messages, which must also be JSON arrays, according to the following patterns: * `["EVENT", , ]`, used to send events requested by clients. + * `["OK", , , ]`, used to indicate acceptance or denial of an `EVENT` message. * `["EOSE", ]`, used to indicate the _end of stored events_ and the beginning of events newly received in real-time. * `["NOTICE", ]`, used to send human-readable error messages or other things to clients. This NIP defines no rules for how `NOTICE` messages should be sent or treated. -`EVENT` messages MUST be sent only with a subscription ID related to a subscription previously initiated by the client (using the `REQ` message above). +- `EVENT` messages MUST be sent only with a subscription ID related to a subscription previously initiated by the client (using the `REQ` message above). +- `OK` messages MUST be sent in response to `EVENT` messages received from clients, they must have the 3rd parameter set to `true` when an event has been accepted by the relay, `false` otherwise. The 4th parameter MAY be empty when the 3rd is `true`, otherwise it MUST be a string containing a machine-readable single-word prefix followed by a `:` and then a human-readable message. The standardized machine-readable prefixes are: `duplicate`, `pow`, `blocked`, `rate-limited`, `invalid`, and `error` for when none of that fits. Some examples: -## Basic Event Kinds - - - `0`: `set_metadata`: the `content` is set to a stringified JSON object `{name: , about: , picture: }` describing the user who created the event. A relay may delete past `set_metadata` events once it gets a new one for the same pubkey. - - `1`: `text_note`: the `content` is set to the **plaintext** content of a note (anything the user wants to say). Content that must be parsed, such as Markdown and HTML, should not be used. Clients should also not parse content as those. - - `2`: `recommend_server`: the `content` is set to the URL (e.g., `wss://somerelay.com`) of a relay the event creator wants to recommend to its followers. - -A relay may choose to treat different message kinds differently, and it may or may not choose to have a default way to handle kinds it doesn't know about. - -## 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 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. + * `["OK", "b1a649ebe8...", true, ""]` + * `["OK", "b1a649ebe8...", true, "pow: difficulty 25>=24"]` + * `["OK", "b1a649ebe8...", true, "duplicate: already have this event"]` + * `["OK", "b1a649ebe8...", false, "blocked: you are banned from posting here"]` + * `["OK", "b1a649ebe8...", false, "blocked: please register your pubkey at https://my-expensive-relay.example.com"]` + * `["OK", "b1a649ebe8...", false, "rate-limited: slow down there chief"]` + * `["OK", "b1a649ebe8...", false, "invalid: event creation date is too far off from the current time. Is your system clock in sync?"]` + * `["OK", "b1a649ebe8...", false, "pow: difficulty 26 is less than 30"]` + * `["OK", "b1a649ebe8...", false, "error: could not connect to the database"]` diff --git a/11.md b/11.md index ec46b367..c71f89e0 100644 --- a/11.md +++ b/11.md @@ -118,7 +118,7 @@ field of any event. This is a count of unicode characters. After serializing into JSON it may be larger (in bytes), and is still subject to the `max_message_length`, if defined. -- `min_pow_difficulty`: new events will require at least this difficulty of PoW, +- `min_pow_difficulty`: new events will require at least this difficulty of PoW, based on [NIP-13](13.md), or they will be rejected by this server. - `auth_required`: this relay requires [NIP-42](42.md) authentication @@ -129,7 +129,7 @@ Even if set to False, authentication may be required for specific actions. ### Event Retention ### -There may be a cost associated with storing data forever, so relays +There may be a cost associated with storing data forever, so relays may wish to state retention times. The values stated here are defaults for unauthenticated users and visitors. Paid users would likely have other policies. @@ -151,7 +151,7 @@ all, and preferably an error will be provided when those are received. } ``` -`retention` is a list of specifications: each will apply to either all kinds, or +`retention` is a list of specifications: each will apply to either all kinds, or a subset of kinds. Ranges may be specified for the kind field as a tuple of inclusive start and end values. Events of indicated kind (or all) are then limited to a `count` and/or time period. @@ -161,8 +161,7 @@ a specific `kind` number, by giving a retention time of zero for those `kind` va While that is unfortunate, it does allow clients to discover servers that will support their protocol quickly via a single HTTP fetch. -There is no need to specify retention times for _ephemeral events_ as defined -in [NIP-16](16.md) since they are not retained. +There is no need to specify retention times for _ephemeral events_ since they are not retained. ### Content Limitations ### @@ -271,7 +270,7 @@ A URL pointing to an image to be used as an icon for the relay. Recommended to b As of 2 May 2023 the following `curl` command provided these results. >curl -H "Accept: application/nostr+json" https://eden.nostr.land - + {"name":"eden.nostr.land", "description":"Eden Nostr Land - Toronto 1-01", "pubkey":"00000000827ffaa94bfea288c3dfce4422c794fbb96625b6b31e9049f729d700", @@ -293,5 +292,5 @@ As of 2 May 2023 the following `curl` command provided these results. "payment_required":true}, "payments_url":"https://eden.nostr.land/invoices", "fees":{"admission":[{"amount":5000000,"unit":"msats"}], - "publication":[]}}, + "publication":[]}}, "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg" diff --git a/12.md b/12.md index 7d1f46e7..93579779 100644 --- a/12.md +++ b/12.md @@ -4,39 +4,6 @@ NIP-12 Generic Tag Queries ------------------- -`draft` `optional` `author:scsibug` `author:fiatjaf` +`final` `mandatory` `author:scsibug` `author:fiatjaf` -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. Note that tag names are case-sensitive. - -Example Subscription Filter ---------------------------- - -The following provides an example of a filter that matches events of kind `1` with an `r` tag set to either `foo` or `bar`. - -``` -{ - "kinds": [1], - "#r": ["foo", "bar"] -} -``` - -Client Behavior ---------------- - -Clients SHOULD use the `supported_nips` field to learn if a relay supports generic tag queries. Clients MAY send generic tag queries to any relay, if they are prepared to filter out extraneous responses from relays that do not support this NIP. - -Rationale ---------- - -The decision to reserve only single-letter tags to be usable in queries allow applications to make use of tags for all sorts of metadata, as it is their main purpose, without worrying that they might be bloating relay indexes. That also makes relays more lightweight, of course. And if some application or user is abusing single-letter tags with the intention of bloating relays that becomes easier to detect as single-letter tags will hardly be confused with some actually meaningful metadata some application really wanted to attach to the event with no spammy intentions. - -Suggested Use Cases -------------------- - -Motivating examples for generic tag queries are provided below. This NIP does not promote or standardize the use of any specific tag for any purpose. - -* Decentralized Commenting System: clients can comment on arbitrary web pages, and easily search for other comments, by using a `r` ("reference", in this case an URL) tag and value. -* Location-specific Posts: clients can use a `g` ("geohash") tag to associate a post with a physical location. Clients can search for a set of geohashes of varying precisions near them to find local content. -* Hashtags: clients can use simple `t` ("hashtag") tags to associate an event with an easily searchable topic name. Since Nostr events themselves are not searchable through the protocol, this provides a mechanism for user-driven search. +Moved to [NIP-01](01.md). diff --git a/13.md b/13.md index 360bde6c..01787336 100644 --- a/13.md +++ b/13.md @@ -110,7 +110,7 @@ function countLeadingZeroes(hex) { Querying relays for PoW notes ----------------------------- -Since relays allow searching on prefixes, you can use this as a way to filter notes of a certain difficulty: +If relays allow searching on prefixes, you can use this as a way to filter notes of a certain difficulty: ``` $ echo '["REQ", "subid", {"ids": ["000000000"]}]' | websocat wss://some-relay.com | jq -c '.[2]' diff --git a/15.md b/15.md index f8df3284..f9e4b790 100644 --- a/15.md +++ b/15.md @@ -4,7 +4,7 @@ NIP-15 Nostr Marketplace (for resilient marketplaces) ----------------------------------- -`draft` `optional` `author:fiatjaf` `author:benarc` `author:motorina0` `author:talvasconcelos` +`draft` `optional` `author:fiatjaf` `author:benarc` `author:motorina0` `author:talvasconcelos` > Based on https://github.com/lnbits/Diagon-Alley @@ -33,13 +33,13 @@ The `merchant` admin software can be purely clientside, but for `convenience` an ## `Merchant` publishing/updating products (event) A merchant can publish these events: -| Kind | | Description | NIP | -|---------|------------------|---------------------------------------------------------------------------------------------------------------|-----------------------------------------| -| `0 ` | `set_meta` | The merchant description (similar with any `nostr` public key). | [NIP01 ](https://github.com/nostr-protocol/nips/blob/master/01.md) | -| `30017` | `set_stall` | Create or update a stall. | [NIP33](https://github.com/nostr-protocol/nips/blob/master/33.md) (Parameterized Replaceable Event) | -| `30018` | `set_product` | Create or update a product. | [NIP33](https://github.com/nostr-protocol/nips/blob/master/33.md) (Parameterized Replaceable Event) | -| `4 ` | `direct_message` | Communicate with the customer. The messages can be plain-text or JSON. | [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md) | -| `5 ` | `delete` | Delete a product or a stall. | [NIP09](https://github.com/nostr-protocol/nips/blob/master/09.md) | +| Kind | | Description | +| --------- | ------------------ | --------------------------------------------------------------------------------------------------------------- | +| `0 ` | `set_meta` | The merchant description (similar with any `nostr` public key). | +| `30017` | `set_stall` | Create or update a stall. | +| `30018` | `set_product` | Create or update a product. | +| `4 ` | `direct_message` | Communicate with the customer. The messages can be plain-text or JSON. | +| `5 ` | `delete` | Delete a product or a stall. | ### Event `30017`: Create or update a stall. @@ -71,7 +71,7 @@ Fields that are not self-explanatory: ```json "tags": [["d", , , ] - -Relays MUST return `true` when the event is a duplicate and has already been saved. The `message` SHOULD start with `duplicate:` in this case. - -Relays MUST return `false` when the event was rejected and not saved. - -The `message` SHOULD provide additional information as to why the command succeeded or failed. - -The `message` SHOULD start with `blocked:` if the pubkey or network address has been blocked, banned, or is not on a whitelist. - -The `message` SHOULD start with `invalid:` if the event is invalid or doesn't meet some specific criteria (created_at is too far off, id is wrong, signature is wrong, etc) - -The `message` SHOULD start with `pow:` if the event doesn't meet some proof-of-work difficulty. The client MAY consult the relay metadata at this point to retrieve the required posting difficulty. - -The `message` SHOULD start with `rate-limited:` if the event was rejected due to rate limiting techniques. - -The `message` SHOULD start with `error:` if the event failed to save due to a server issue. - -Ephemeral events are not acknowledged with OK responses, unless there is a failure. - -If the event or `EVENT` command is malformed and could not be parsed, a NOTICE message SHOULD be used instead of a command result. This NIP only applies to non-malformed EVENT commands. - - -Examples --------- - -Event successfully written to the database: - - ["OK", "b1a649ebe8b435ec71d3784793f3bbf4b93e64e17568a741aecd4c7ddeafce30", true, ""] - -Event successfully written to the database because of a reason: - - ["OK", "b1a649ebe8b435ec71d3784793f3bbf4b93e64e17568a741aecd4c7ddeafce30", true, "pow: difficulty 25>=24"] - -Event blocked due to ip filter - - ["OK", "b1a649ebe8...", false, "blocked: tor exit nodes not allowed"] - -Event blocked due to pubkey ban - - ["OK", "b1a649ebe8...", false, "blocked: you are banned from posting here"] - -Event blocked, pubkey not registered - - ["OK", "b1a649ebe8...", false, "blocked: please register your pubkey at https://my-expensive-relay.example.com"] - -Event rejected, rate limited - - ["OK", "b1a649ebe8...", false, "rate-limited: slow down there chief"] - -Event rejected, `created_at` too far off - - ["OK", "b1a649ebe8...", false, "invalid: event creation date is too far off from the current time. Is your system clock in sync?"] - -Event rejected, insufficient proof-of-work difficulty - - ["OK", "b1a649ebe8...", false, "pow: difficulty 26 is less than 30"] - -Event failed to save, - - ["OK", "b1a649ebe8...", false, "error: could not connect to the database"] - - - -Client Handling ---------------- - -`messages` are meant for humans, with `reason:` prefixes so that clients can be slightly more intelligent with what to do with them. For example, with a `rate-limited:` reason the client may not show anything and simply try again with a longer timeout. - -For the `pow:` prefix it may query relay metadata to get the updated difficulty requirement and try again in the background. - -For the `invalid:` and `blocked:` prefix the client may wish to show these as styled error popups. - -The prefixes include a colon so that the message can be cleanly separated from the prefix by taking everything after `:` and trimming it. - - -Future Extensions ------------------ - -This proposal SHOULD be extended to support further commands in the future, such as REQ and AUTH. They are left out of this initial version to keep things simpler. +Moved to [NIP-01](01.md). diff --git a/22.md b/22.md index 2172519e..f595ebf3 100644 --- a/22.md +++ b/22.md @@ -2,13 +2,13 @@ NIP-22 ====== Event `created_at` Limits ---------------------------- +------------------------- `draft` `optional` `author:jeffthibault` `author:Giszmo` Relays may define both upper and lower limits within which they will consider an event's `created_at` to be acceptable. Both the upper and lower limits MUST be unix timestamps in seconds as defined in [NIP-01](01.md). -If a relay supports this NIP, the relay SHOULD send the client a [NIP-20](20.md) command result saying the event was not stored for the `created_at` timestamp not being within the permitted limits. +If a relay supports this NIP, the relay SHOULD send the client an `OK` result saying the event was not stored for the `created_at` timestamp not being within the permitted limits. Client Behavior --------------- @@ -22,7 +22,7 @@ This NIP formalizes restrictions on event timestamps as accepted by a relay and The event `created_at` field is just a unix timestamp and can be set to a time in the past or future. Relays accept and share events dated to 20 years ago or 50,000 years in the future. This NIP aims to define a way for relays that do not want to store events with *any* timestamp to set their own restrictions. -[Replaceable events](16.md#replaceable-events) can behave rather unexpectedly if the user wrote them - or tried to write them - with a wrong system clock. Persisting an update with a backdated system now would result in the update not getting persisted without a notification and if they did the last update with a forward dated system, they will again fail to do another update with the now correct time. +_Replaceable events_ can behave rather unexpectedly if the user wrote them - or tried to write them - with a wrong system clock. Persisting an update with a backdated system now would result in the update not getting persisted without a notification and if they did the last update with a forward dated system, they will again fail to do another update with the now correct time. A wide adoption of this NIP could create a better user experience as it would decrease the amount of events that appear wildly out of order or even from impossible dates in the distant past or future. diff --git a/23.md b/23.md index 7a06b0ef..76c0a69b 100644 --- a/23.md +++ b/23.md @@ -6,7 +6,7 @@ Long-form Content `draft` `optional` `author:fiatjaf` -This NIP defines `kind:30023` (a parameterized replaceable event according to [NIP-33](33.md)) for long-form text content, generally referred to as "articles" or "blog posts". `kind:30024` has the same structure as `kind:30023` and is used to save long form drafts. +This NIP defines `kind:30023` (a _parameterized replaceable event_) for long-form text content, generally referred to as "articles" or "blog posts". `kind:30024` has the same structure as `kind:30023` and is used to save long form drafts. "Social" clients that deal primarily with `kind:1` notes should not be expected to implement this NIP. @@ -20,7 +20,7 @@ The `.content` of these events should be a string text in Markdown syntax. To ma ### Metadata -For the date of the last update the `.created_at` field should be used, for "tags"/"hashtags" (i.e. topics about which the event might be of relevance) the `"t"` event tag should be used, as per NIP-12. +For the date of the last update the `.created_at` field should be used, for "tags"/"hashtags" (i.e. topics about which the event might be of relevance) the `t` tag should be used, as per NIP-12. Other metadata fields can be added as tags to the event as necessary. Here we standardize 4 that may be useful, although they remain strictly optional: @@ -31,11 +31,11 @@ Other metadata fields can be added as tags to the event as necessary. Here we st ### Editability -These articles are meant to be editable, so they should make use of the replaceability feature of NIP-33 and include a `"d"` tag with an identifier for the article. Clients should take care to only publish and read these events from relays that implement that. If they don't do that they should also take care to hide old versions of the same article they may receive. +These articles are meant to be editable, so they should make use of the parameterized replaceability feature and include a `d` tag with an identifier for the article. Clients should take care to only publish and read these events from relays that implement that. If they don't do that they should also take care to hide old versions of the same article they may receive. ### Linking -The article may be linked to using the NIP-19 `naddr` code along with the `"a"` tag (see [NIP-33](33.md) and [NIP-19](19.md)). +The article may be linked to using the [NIP-19](19.md) `naddr` code along with the `a` tag. ### References diff --git a/33.md b/33.md index 5128bece..1e7a9fc9 100644 --- a/33.md +++ b/33.md @@ -4,52 +4,6 @@ NIP-33 Parameterized Replaceable Events -------------------------------- -`draft` `optional` `author:Semisol` `author:Kukks` `author:Cameri` `author:Giszmo` +`final` `mandatory` `author:Semisol` `author:Kukks` `author:Cameri` `author:Giszmo` -This NIP adds a new event range that allows for replacement of events that have the same `d` tag and kind unlike NIP-16 which only replaced by kind. - -Implementation --------------- -The value of a tag can be any string and is defined as the first parameter of a tag after the tag name. - -A *parameterized replaceable event* is defined as an event with a kind `30000 <= n < 40000`. -Upon a parameterized replaceable event with a newer timestamp than the currently known latest -replaceable event with the same kind, author and first `d` tag value being received, the old event -SHOULD be discarded, effectively replacing what gets returned when querying for -`author:kind:d-tag` tuples. - -If two events have the same timestamp, the event with the lowest id (first in lexical order) SHOULD be retained, and the other discarded. - -A missing or a `d` tag with no value should be interpreted equivalent to a `d` tag with the -value as an empty string. Events from the same author with any of the following `tags` -replace each other: - -* `"tags":[["d",""]]` -* `"tags":[]`: implicit `d` tag with empty value -* `"tags":[["d"]]`: implicit empty value `""` -* `"tags":[["d",""],["d","not empty"]]`: only first `d` tag is considered -* `"tags":[["d"],["d","some value"]]`: only first `d` tag is considered -* `"tags":[["e"]]`: same as no tags -* `"tags":[["d","","1"]]`: only the first value is considered (`""`) - -Clients SHOULD NOT use `d` tags with multiple values and SHOULD include the `d` tag even if it has no value to allow querying using the `#d` filter. - -Referencing and tagging ------------------------ - -Normally (as per NIP-01, NIP-12) the `"p"` tag is used for referencing public keys and the -`"e"` tag for referencing event ids and the `note`, `npub`, `nprofile` or `nevent` are their -equivalents for event tags (i.e. an `nprofile` is generally translated into a tag -`["p", "", ""]`). - -To support linking to parameterized replaceable events, the `naddr` code is introduced on -NIP-19. It includes the public key of the event author and the `d` tag (and relays) such that -the referenced combination of public key and `d` tag can be found. - -The equivalent in `tags` to the `naddr` code is the tag `"a"`, comprised of `["a", "::", ""]`. - -Client Behavior ---------------- - -Clients SHOULD use the `supported_nips` field to learn if a relay supports this NIP. -Clients MAY send parameterized replaceable events to relays that may not support this NIP, and clients querying SHOULD be prepared for the relay to send multiple events and should use the latest one and are recommended to send a `#d` tag filter. Clients should account for the fact that missing `d` tags or ones with no value are not returned in tag filters, and are recommended to always include a `d` tag with a value. +Moved to [NIP-01](01.md). diff --git a/51.md b/51.md index 80cc09ef..b7229aa8 100644 --- a/51.md +++ b/51.md @@ -2,15 +2,13 @@ NIP-51 ====== Lists -------------------------- +----- -`draft` `optional` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema` `depends:33` +`draft` `optional` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema` A "list" event is defined as having a list of public and/or private tags. Public tags will be listed in the event `tags`. Private tags will be encrypted in the event `content`. Encryption for private tags will use [NIP-04 - Encrypted Direct Message](04.md) encryption, using the list author's private and public key for the shared secret. A distinct event kind should be used for each list type created. -If a list type should only be defined once per user (like the 'Mute' list), the list type's events should follow the specification for [NIP-16 - Replaceable Events](16.md). These lists may be referred to as 'replaceable lists'. - -Otherwise, the list type's events should follow the specification for [NIP-33 - Parameterized Replaceable Events](33.md), where the list name will be used as the 'd' parameter. These lists may be referred to as 'parameterized replaceable lists'. +If a list should only be defined once per user (like the "mute" list) the list is declared as a _replaceable event_. These lists may be referred to as "replaceable lists". Otherwise, the list is a _parameterized replaceable event_ and the list name will be used as the `d` tag. These lists may be referred to as "parameterized replaceable lists". ## Replaceable List Event Example diff --git a/52.md b/52.md index c601412e..846fbf43 100644 --- a/52.md +++ b/52.md @@ -6,7 +6,7 @@ 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). +This specification defines calendar events representing an occurrence at a specific moment or between moments. These calendar events are _parameterized replaceable_ and deletable per [NIP-09](09.md). 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. @@ -139,7 +139,7 @@ A calendar is a collection of calendar events, represented as a custom replaceab 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) +* `a` (repeated) reference tag to kind `31922` or `31923` calendar event being responded to ```json { @@ -171,7 +171,7 @@ 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) +* `a` (required) reference tag to kind `31922` or `31923` calendar event being responded to. * `d` (required) universally unique identifier. Generated by the client creating the calendar event RSVP. * `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. diff --git a/53.md b/53.md index c5f2704e..b3d416b7 100644 --- a/53.md +++ b/53.md @@ -12,7 +12,7 @@ Service providers want to offer live activities to the Nostr network in such a w # Live Event -A special event with `kind:30311` "Live Event" is defined as a [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. +A special event with `kind:30311` "Live Event" is defined as a _parameterized replaceable event_ of public `p` tags. Each `p` tag SHOULD have a **displayable** marker name for the current role (e.g. `Host`, `Speaker`, `Participant`) of the user in the event and the relay information MAY be empty. This event will be constantly updated as participants join and leave the activity. For example: @@ -44,13 +44,13 @@ For example: 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). +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. +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)). +The activity MUST be linked to using the [NIP-19](19.md) `naddr` code along with the `a` tag. ## Proof of Agreement to Participate @@ -58,11 +58,11 @@ Event owners can add proof as the 5th term in each `p` tag to clarify the partic 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. +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. +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 { @@ -74,7 +74,7 @@ Event `kind:1311` is live chat's channel message. Clients MUST include the `a` t ["a", "30311::", "", "root"], ], "content": "Zaps to live streams is beautiful." -} +} ``` # Use Cases @@ -83,7 +83,7 @@ Common use cases include meeting rooms/workshops, watch-together activities, or # Example -Live Streaming +Live Streaming ```json { @@ -112,7 +112,7 @@ Live Streaming chat message ```json { "id": "97aa81798ee6c5637f7b21a411f89e10244e195aa91cb341bf49f718e36c8188", - "pubkey": "3f770d65d3a764a9c5cb503ae123e62ec7598ad035d836e2a810f3877a745b24", + "pubkey": "3f770d65d3a764a9c5cb503ae123e62ec7598ad035d836e2a810f3877a745b24", "created_at": 1687286726, "kind": 1311, "tags": [ @@ -122,4 +122,3 @@ Live Streaming chat message "sig": "997f62ddfc0827c121043074d50cfce7a528e978c575722748629a4137c45b75bdbc84170bedc723ef0a5a4c3daebf1fef2e93f5e2ddb98e5d685d022c30b622" } ```` - diff --git a/58.md b/58.md index 2fa44066..d6bb27d6 100644 --- a/58.md +++ b/58.md @@ -9,15 +9,9 @@ Badges Three special events are used to define, award and display badges in user profiles: -1. A "Badge Definition" event is defined as a parameterized replaceable event -with kind `30009` having a `d` tag with a value that uniquely identifies -the badge (e.g. `bravery`) published by the badge issuer. Badge definitions can -be updated. +1. A "Badge Definition" event is defined as a parameterized replaceable event with kind `30009` having a `d` tag with a value that uniquely identifies the badge (e.g. `bravery`) published by the badge issuer. Badge definitions can be updated. -2. A "Badge Award" event is a kind `8` event with a single `a` tag referencing -a "Define Badge" event and one or more `p` tags, one for each pubkey the -badge issuer wishes to award. The value for the `a` tag MUST follow the format -defined in [NIP-33](33.md). Awarded badges are immutable and non-transferrable. +2. A "Badge Award" event is a kind `8` event with a single `a` tag referencing a "Define Badge" event and one or more `p` tags, one for each pubkey the badge issuer wishes to award. Awarded badges are immutable and non-transferrable. 3. A "Profile Badges" event is defined as a parameterized replaceable event with kind `30008` with a `d` tag with the value `profile_badges`. diff --git a/72.md b/72.md index f4bebf4e..599a4c45 100644 --- a/72.md +++ b/72.md @@ -6,7 +6,7 @@ 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 `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. +The goal of this NIP is to create moderator-approved public communities around a topic. It defines the replaceable event `kind:34550` to define the community and the current list of moderators/administrators. Users that want to post into the community, simply tag any Nostr event with the community's `a` tag. Moderators issue an approval event `kind:4550` that links the community with the new post. # Community Definition diff --git a/README.md b/README.md index 3c35ef36..f2603cfa 100644 --- a/README.md +++ b/README.md @@ -30,14 +30,11 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-09: Event Deletion](09.md) - [NIP-10: Conventions for clients' use of `e` and `p` tags in text events](10.md) - [NIP-11: Relay Information Document](11.md) -- [NIP-12: Generic Tag Queries](12.md) - [NIP-13: Proof of Work](13.md) - [NIP-14: Subject tag in text events](14.md) - [NIP-15: Nostr Marketplace (for resilient marketplaces)](15.md) -- [NIP-16: Event Treatment](16.md) - [NIP-18: Reposts](18.md) - [NIP-19: bech32-encoded entities](19.md) -- [NIP-20: Command Results](20.md) - [NIP-21: `nostr:` URI scheme](21.md) - [NIP-22: Event `created_at` Limits](22.md) - [NIP-23: Long-form Content](23.md) @@ -48,7 +45,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-30: Custom Emoji](30.md) - [NIP-31: Dealing with Unknown Events](31.md) - [NIP-32: Labeling](32.md) -- [NIP-33: Parameterized Replaceable Events](33.md) - [NIP-36: Sensitive Content](36.md) - [NIP-39: External Identities in Profiles](39.md) - [NIP-40: Expiration Timestamp](40.md) @@ -78,7 +74,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | ------- | -------------------------- | ----------- | | `0` | Metadata | [1](01.md) | | `1` | Short Text Note | [1](01.md) | -| `2` | Recommend Relay | [1](01.md) | +| `2` | Recommend Relay | | | `3` | Contacts | [2](02.md) | | `4` | Encrypted Direct Messages | [4](04.md) | | `5` | Event Deletion | [9](09.md) | @@ -128,59 +124,48 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `34550` | Community Definition | [72](72.md) | -### Event Kind Ranges - -| range | description | NIP | -| ---------------- | -------------------------------- | ----------- | -| `1000`--`9999` | Regular Events | [16](16.md) | -| `10000`--`19999` | Replaceable Events | [16](16.md) | -| `20000`--`29999` | Ephemeral Events | [16](16.md) | -| `30000`--`39999` | Parameterized Replaceable Events | [33](33.md) | - ## Message types ### Client to Relay | type | description | NIP | | ------- | --------------------------------------------------- | ----------- | +| `EVENT` | used to publish events | [01](01.md) | +| `REQ` | used to request events and subscribe to new updates | [01](01.md) | +| `CLOSE` | used to stop previous subscriptions | [01](01.md) | | `AUTH` | used to send authentication events | [42](42.md) | -| `CLOSE` | used to stop previous subscriptions | [1](01.md) | | `COUNT` | used to request event counts | [45](45.md) | -| `EVENT` | used to publish events | [1](01.md) | -| `REQ` | used to request events and subscribe to new updates | [1](01.md) | ### Relay to Client | type | description | NIP | | -------- | ------------------------------------------------------- | ----------- | +| `EOSE` | used to notify clients all stored events have been sent | [01](01.md) | +| `EVENT` | used to send events requested to clients | [01](01.md) | +| `NOTICE` | used to send human-readable messages to clients | [01](01.md) | +| `OK` | used to notify clients if an EVENT was successful | [01](01.md) | | `AUTH` | used to send authentication challenges | [42](42.md) | | `COUNT` | used to send requested event counts to clients | [45](45.md) | -| `EOSE` | used to notify clients all stored events have been sent | [1](01.md) | -| `EVENT` | used to send events requested to clients | [1](01.md) | -| `NOTICE` | used to send human-readable messages to clients | [1](01.md) | -| `OK` | used to notify clients if an EVENT was successful | [20](20.md) | Please update these lists when proposing NIPs introducing new event kinds. -When experimenting with kinds, keep in mind the classification introduced by [NIP-16](16.md) and [NIP-33](33.md). - ## Standardized Tags | name | value | other parameters | NIP | | ----------------- | ------------------------------------ | -------------------- | ------------------------ | -| `a` | coordinates to an event | relay URL | [33](33.md), [23](23.md) | +| `e` | event id (hex) | relay URL, marker | [01](01.md), [10](10.md) | +| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | +| `a` | coordinates to an event | relay URL | [01](01.md) | +| `d` | identifier | -- | [01](01.md) | | `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), [52](52.md) | +| `g` | geohash | -- | [52](52.md) | | `i` | identity | proof | [39](39.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) | -| `r` | a reference (URL, etc) | -- | [12](12.md) | -| `t` | hashtag | -- | [12](12.md) | -| `amount` | millisats | -- | [57](57.md) | +| `r` | a reference (URL, etc) | -- | | +| `t` | hashtag | -- | | +| `amount` | millisatoshis, stringified | -- | [57](57.md) | | `bolt11` | `bolt11` invoice | -- | [57](57.md) | | `challenge` | challenge string | -- | [42](42.md) | | `content-warning` | reason | -- | [36](36.md) | From 04051ffcbc36964ecaf44f390e7d1f17e61edb15 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Tue, 15 Aug 2023 05:40:54 +0900 Subject: [PATCH 39/61] Update tag list (#692) --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f2603cfa..38a03173 100644 --- a/README.md +++ b/README.md @@ -164,6 +164,7 @@ Please update these lists when proposing NIPs introducing new event kinds. | `l` | label, label namespace | annotations | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | | `r` | a reference (URL, etc) | -- | | +| `r` | relay url | marker | [65](65.md) | | `t` | hashtag | -- | | | `amount` | millisatoshis, stringified | -- | [57](57.md) | | `bolt11` | `bolt11` invoice | -- | [57](57.md) | @@ -189,7 +190,7 @@ Please update these lists when proposing NIPs introducing new event kinds. | `summary` | article summary | -- | [23](23.md) | | `thumb` | badge thumbnail | dimensions in pixels | [58](58.md) | | `title` | article title | -- | [23](23.md) | -| `zap` | profile name | type of value | [57](57.md) | +| `zap` | pubkey (hex), relay URL | weight | [57](57.md) | ## Criteria for acceptance of NIPs From 88ee873c9e4824125d3f2e38d16c39ccf73ddf16 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ioan=20Biz=C4=83u?= Date: Tue, 15 Aug 2023 17:02:54 +0300 Subject: [PATCH 40/61] Rename countries to regions. (#465) --- 15.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/15.md b/15.md index 5e3164e7..01ef05bf 100644 --- a/15.md +++ b/15.md @@ -55,7 +55,7 @@ A merchant can publish these events: "id": , "name": , "cost": , - "countries": [], + "regions": [], } ] } From 2ba0eca44344a770b5ad24f20e749864cddf3518 Mon Sep 17 00:00:00 2001 From: gzuuus Date: Tue, 15 Aug 2023 18:32:30 +0200 Subject: [PATCH 41/61] Nip 51 extended --- 51.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/51.md b/51.md index b7229aa8..03bd9219 100644 --- a/51.md +++ b/51.md @@ -4,7 +4,7 @@ NIP-51 Lists ----- -`draft` `optional` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema` +`draft` `optional` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema` `author:gzuuus` A "list" event is defined as having a list of public and/or private tags. Public tags will be listed in the event `tags`. Private tags will be encrypted in the event `content`. Encryption for private tags will use [NIP-04 - Encrypted Direct Message](04.md) encryption, using the list author's private and public key for the shared secret. A distinct event kind should be used for each list type created. @@ -92,6 +92,7 @@ Then the user would create a 'Categorized People' list event like below: | 10001 | Pin | | 30000 | Categorized People | | 30001 | Categorized Bookmarks | +| 30303 | Categorized Reference List | ### Mute List @@ -108,3 +109,7 @@ An event with kind `30000` is defined as a parameterized replaceable list event ### Categorized Bookmarks List An event with kind `30001` is defined as a parameterized replaceable list event for categorizing bookmarks. The 'd' parameter for this event holds the category name of the list. Any standardized tag can be included in a Categorized Bookmarks List. + +### Categorized Reference List + +An event with kind `30303` is defined as a parameterized replaceable list event for categorizing user references. The 'd' parameter of this event holds the category name of the list. The reference lists may have metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md) . Items in these lists are `r` tags, and follow the schema of Kind 3 events as defined in [NIP-02 - Contact List and Petnames](02.md). Each `r` tag entry should contain the 'reference URL' and the 'description', `["r", , ]`. Any standard tag can be included in a reference list. \ No newline at end of file From 2f84cd97e38c0a824cc27ea2ac976545e9e3f09e Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Thu, 17 Aug 2023 08:17:24 -0300 Subject: [PATCH 42/61] remove harmful remark from nip-10. --- 10.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/10.md b/10.md index 64947967..9c79b4a2 100644 --- a/10.md +++ b/10.md @@ -19,7 +19,7 @@ Where: * `` is the id of the event being referenced. * `` is the URL of a recommended relay associated with the reference. Many clients treat this field as optional. - + **The positions of the "e" tags within the event denote specific meanings as follows**: * No "e" tag:
@@ -29,34 +29,34 @@ Where: `["e", ]`: The id of the event to which this event is a reply. * Two "e" tags: `["e", ]`, `["e", ]`
- `` is the id of the event at the root of the reply chain. `` is the id of the article to which this event is a reply. + `` is the id of the event at the root of the reply chain. `` is the id of the article to which this event is a reply. * Many "e" tags: `["e", ]` `["e", ]`, ..., `["e", ]`
-There may be any number of ``. These are the ids of events which may, or may not be in the reply chain. +There may be any number of ``. These are the ids of events which may, or may not be in the reply chain. They are citings from this event. `root-id` and `reply-id` are as above. >This scheme is deprecated because it creates ambiguities that are difficult, or impossible to resolve when an event references another but is not a reply. ## Marked "e" tags (PREFERRED) -`["e", , , ]` - +`["e", , , ]` + Where: * `` is the id of the event being referenced. * `` is the URL of a recommended relay associated with the reference. Clients SHOULD add a valid `` field, but may instead leave it as `""`. * `` is optional and if present is one of `"reply"`, `"root"`, or `"mention"`. -**The order of marked "e" tags is not relevant.** Those marked with `"reply"` denote the id of the reply event being responded to. Those marked with `"root"` denote the root id of the reply thread being responded to. For top level replies (those replying directly to the root event), only the `"root"` marker should be used. Those marked with `"mention"` denote a quoted or reposted event id. +Those marked with `"reply"` denote the id of the reply event being responded to. Those marked with `"root"` denote the root id of the reply thread being responded to. For top level replies (those replying directly to the root event), only the `"root"` marker should be used. Those marked with `"mention"` denote a quoted or reposted event id. A direct reply to the root of a thread should have a single marked "e" tag of type "root". ->This scheme is preferred because it allows events to mention others without confusing them with `` or ``. +>This scheme is preferred because it allows events to mention others without confusing them with `` or ``. ## The "p" tag Used in a text event contains a list of pubkeys used to record who is involved in a reply thread. -When replying to a text event E the reply event's "p" tags should contain all of E's "p" tags as well as the `"pubkey"` of the event being replied to. +When replying to a text event E the reply event's "p" tags should contain all of E's "p" tags as well as the `"pubkey"` of the event being replied to. -Example: Given a text event authored by `a1` with "p" tags [`p1`, `p2`, `p3`] then the "p" tags of the reply should be [`a1`, `p1`, `p2`, `p3`] +Example: Given a text event authored by `a1` with "p" tags [`p1`, `p2`, `p3`] then the "p" tags of the reply should be [`a1`, `p1`, `p2`, `p3`] in no particular order. From 50b63c26c83ffe892c8698e9ea2eed88a3e6b9a0 Mon Sep 17 00:00:00 2001 From: gzuuus Date: Thu, 17 Aug 2023 13:45:44 +0200 Subject: [PATCH 43/61] updated kind30001 --- 51.md | 45 +++++++++++++++++++++++++++++++++++++++------ 1 file changed, 39 insertions(+), 6 deletions(-) diff --git a/51.md b/51.md index 03bd9219..cd1a4ab3 100644 --- a/51.md +++ b/51.md @@ -84,6 +84,43 @@ Then the user would create a 'Categorized People' list event like below: } ``` +Lets say a user wants to create a 'Categorized Bookmarks' list of `bookmarks` and has keys: +``` +priv: fb505c65d4df950f5d28c9e4d285ee12ffaf315deef1fc24e3c7cd1e7e35f2b1 +pub: b1a5c93edcc8d586566fde53a20bdb50049a97b15483cb763854e57016e0fa3d +``` +The user wants to publicly include these bookmarks: + +```json +["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://nostr.example.com"], +["a", "30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"], +["r", "https://github.com/nostr-protocol/nostr", "Nostr repository"], +``` +and privately include these bookmarks (below is the JSON that would be encrypted and placed in the event content): + +```json +[ + ["r", "https://my-private.bookmark", "My private bookmark"], + ["a", "30001:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"], +] +``` + +Then the user would create a 'Categorized Bookmarks' list event like below: + +```json +{ + "kind": 30001, + "tags": [ + ["d", "bookmarks"], + ["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://nostr.example.com"], + ["a", "30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"], + ["r", "https://github.com/nostr-protocol/nostr", "Nostr repository"], + ], + "content": "y3AyaLJfnmYr9x9Od9o4aYrmL9+Ynmsim5y2ONrU0urOTq+V81CyAthQ2mUOWE9xwGgrizhY7ILdQwWhy6FK0sA33GHtC0egUJw1zIdknPe7BZjznD570yk/8RXYgGyDKdexME+RMYykrnYFxq1+y/h00kmJg4u+Gpn+ZjmVhNYxl9b+TiBOAXG9UxnK/H0AmUqDpcldn6+j1/AiStwYZhD1UZ3jzDIk2qcCDy7MlGnYhSP+kNmG+2b0T/D1L0Z7?iv=PGJJfPE84gacAh7T0e6duQ==", + ...other fields +} +``` + ## List Event Kinds | kind | list type | @@ -92,7 +129,7 @@ Then the user would create a 'Categorized People' list event like below: | 10001 | Pin | | 30000 | Categorized People | | 30001 | Categorized Bookmarks | -| 30303 | Categorized Reference List | + ### Mute List @@ -108,8 +145,4 @@ An event with kind `30000` is defined as a parameterized replaceable list event ### Categorized Bookmarks List -An event with kind `30001` is defined as a parameterized replaceable list event for categorizing bookmarks. The 'd' parameter for this event holds the category name of the list. Any standardized tag can be included in a Categorized Bookmarks List. - -### Categorized Reference List - -An event with kind `30303` is defined as a parameterized replaceable list event for categorizing user references. The 'd' parameter of this event holds the category name of the list. The reference lists may have metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md) . Items in these lists are `r` tags, and follow the schema of Kind 3 events as defined in [NIP-02 - Contact List and Petnames](02.md). Each `r` tag entry should contain the 'reference URL' and the 'description', `["r", , ]`. Any standard tag can be included in a reference list. \ No newline at end of file +An event of kind `30001` is defined as a parameterised replaceable list event for categorizing bookmarks. The `d' parameter for this event holds the category name of the list. The bookmark lists may contain metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md). The tags included in these lists MUST follow the schema of event tags as defined in [NIP-01 - Basic protocol flow description](01.md). Any standardized tag can be included in a Categorized Bookmark List. \ No newline at end of file From 867132ce9ac889258cdb46cf73531e8892f46ec4 Mon Sep 17 00:00:00 2001 From: gzuuus Date: Thu, 17 Aug 2023 16:21:21 +0200 Subject: [PATCH 44/61] fix typos --- 51.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/51.md b/51.md index cd1a4ab3..cbd6be11 100644 --- a/51.md +++ b/51.md @@ -145,4 +145,4 @@ An event with kind `30000` is defined as a parameterized replaceable list event ### Categorized Bookmarks List -An event of kind `30001` is defined as a parameterised replaceable list event for categorizing bookmarks. The `d' parameter for this event holds the category name of the list. The bookmark lists may contain metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md). The tags included in these lists MUST follow the schema of event tags as defined in [NIP-01 - Basic protocol flow description](01.md). Any standardized tag can be included in a Categorized Bookmark List. \ No newline at end of file +An event of kind `30001` is defined as a parameterized replaceable list event for categorizing bookmarks. The 'd' parameter for this event holds the category name of the list. The bookmark lists may contain metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md). Any standardized tag can be included in a Categorized Bookmark List. \ No newline at end of file From 7143bfccf7470e209c0048050f104a27901b9ebd Mon Sep 17 00:00:00 2001 From: gzuuus Date: Fri, 18 Aug 2023 10:23:45 +0200 Subject: [PATCH 45/61] added other parameter 'petname' to r tag --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 38a03173..555f006d 100644 --- a/README.md +++ b/README.md @@ -163,7 +163,7 @@ Please update these lists when proposing NIPs introducing new event kinds. | `k` | kind number (string) | -- | [18](18.md), [72](72.md) | | `l` | label, label namespace | annotations | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | -| `r` | a reference (URL, etc) | -- | | +| `r` | a reference (URL, etc) | petname | | | `r` | relay url | marker | [65](65.md) | | `t` | hashtag | -- | | | `amount` | millisatoshis, stringified | -- | [57](57.md) | From 37c4375e297166df8350c8a7d119d33c0757228b Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sat, 19 Aug 2023 23:03:19 -0300 Subject: [PATCH 46/61] bring back 9cac35db9b1d41c8eb7413269308a76687489b30 fixes https://github.com/nostr-protocol/nips/issues/732 --- 01.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/01.md b/01.md index 4b33975e..63697439 100644 --- a/01.md +++ b/01.md @@ -80,10 +80,12 @@ Kinds specify how clients should interpret the meaning of each event and the oth And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: - for kind `n` such that `1000 <= n < 10000`, events are **regular**, which means they're all expected to be stored by relays. -- for kind `n` such that `10000 <= n < 20000`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to be stored by relays, older versions are expected to be discarded. +- for kind `n` such that `10000 <= n < 20000 || k == 0 || k == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to be stored by relays, older versions are expected to be discarded. - for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. - for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag, only the latest event is expected to be stored by relays, older versions are expected to be discarded. +In case of replaceable events with the same timestamp, the event with the lowest id (first in lexical order) should be retained, and the other discarded. + These are just conventions and relay implementations may differ. ## Communication between clients and relays From c5a8b75abd9ad5c0b2a680f71ae2c91beda37d5a Mon Sep 17 00:00:00 2001 From: Viktor Vsk Date: Sun, 20 Aug 2023 04:04:55 +0200 Subject: [PATCH 47/61] Consistency and small refinements for NIP-01 (#731) --- 01.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/01.md b/01.md index 63697439..d6ccfbe2 100644 --- a/01.md +++ b/01.md @@ -25,7 +25,7 @@ The only object type that exists is the `event`, which has the following format ... ], "content": , - "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> + "sig": <64-bytes lowercase hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> } ``` @@ -34,7 +34,7 @@ To obtain the `event.id`, we `sha256` the serialized event. The serialization is ```json [ 0, - , + , , , , @@ -64,11 +64,11 @@ The first element of the tag array is referred to as the tag _name_ or _key_ and This NIP defines 3 standard tags that can be used accross all event kinds with the same meaning. They are as follows: -- The `e` tag, used to refer to an event: `["e", <32-bytes hex of the id of another event>, ]` -- The `p` tag, used to refer to another user: `["p", <32-bytes hex of a pubkey>, ]` -- The `a` tag, used to refer to a parameterized replaceable event: `["a", :<32-bytes hex of a pubkey>:, ]` +- The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, ]` +- The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, ]` +- The `a` tag, used to refer to a parameterized replaceable event: `["a", :<32-bytes lowercase hex of a pubkey>:, ]` -As a convention, all single-letter key tags are expected to be indexed by relays, such that it is possible, for example, to query or subscribe to events that reference the event `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"` by using the `{"#e": "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"}` filter. +As a convention, all single-letter (only english alphabet letters: a-z, A-Z) key tags are expected to be indexed by relays, such that it is possible, for example, to query or subscribe to events that reference the event `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"` by using the `{"#e": "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"}` filter. ### Kinds @@ -80,7 +80,7 @@ Kinds specify how clients should interpret the meaning of each event and the oth And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: - for kind `n` such that `1000 <= n < 10000`, events are **regular**, which means they're all expected to be stored by relays. -- for kind `n` such that `10000 <= n < 20000 || k == 0 || k == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to be stored by relays, older versions are expected to be discarded. +- for kind `n` such that `10000 <= n < 20000 || k == 0 || k == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to (SHOULD) be stored by relays, older versions are expected to be discarded. - for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. - for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag, only the latest event is expected to be stored by relays, older versions are expected to be discarded. @@ -90,7 +90,7 @@ These are just conventions and relay implementations may differ. ## Communication between clients and relays -Relays expose a websocket endpoint to which clients can connect. Clients should open a single websocket connection to each relay and use it for all their subscriptions. +Relays expose a websocket endpoint to which clients can connect. Clients SHOULD open a single websocket connection to each relay and use it for all their subscriptions. Relays MAY limit number of connections from specific IP/client/etc. ### Meaning of WebSocket status codes @@ -113,14 +113,14 @@ Clients can send 3 types of messages, which must be JSON arrays, according to th "ids": , "authors": , "kinds": , - "#": , + "#": , "since": , "until": , - "limit": + "limit": } ``` -Upon receiving a `REQ` message, the relay SHOULD query its internal database and return events that match the filter, then store that filter and send again all future events it receives to that same websocket until the websocket is closed. The `CLOSE` event is received with the same `` or a new `REQ` is sent using the same ``, in which case it should overwrite the previous subscription. +Upon receiving a `REQ` message, the relay SHOULD query its internal database and return events that match the filter, then store that filter and send again all future events it receives to that same websocket until the websocket is closed. The `CLOSE` event is received with the same `` or a new `REQ` is sent using the same ``, in which case relay MUST overwrite the previous subscription. Filter attributes containing lists (`ids`, `authors`, `kinds` and tag filters like `#e`) are JSON arrays with one or more values. At least one of the arrays' values must match the relevant field in an event for the condition to be considered a match. For scalar event attributes such as `authors` and `kind`, the attribute from the event must be contained in the filter list. In the case of tag attributes such as `#e`, for which an event may have multiple values, the event and filter condition values must have at least one item in common. From 89915e0251ec4e5ce3fc00e2f2dfd9106a359b79 Mon Sep 17 00:00:00 2001 From: Viktor Vsk Date: Sun, 20 Aug 2023 14:27:03 +0200 Subject: [PATCH 48/61] Remove min_prefix mentions from NIP-11 after prefix search was removed from NIP-01 --- 11.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/11.md b/11.md index c71f89e0..083ae8f3 100644 --- a/11.md +++ b/11.md @@ -75,7 +75,6 @@ are rejected or fail immediately. "max_filters": 100, "max_limit": 5000, "max_subid_length": 100, - "min_prefix": 4, "max_event_tags": 100, "max_content_length": 8196, "min_pow_difficulty": 30, @@ -102,9 +101,6 @@ Must be one or higher. - `max_subid_length`: maximum length of subscription id as a string. -- `min_prefix`: for `authors` and `ids` filters which are to match against -a hex prefix, you must provide at least this many hex digits in the prefix. - - `max_limit`: the relay server will clamp each filter's `limit` value to this number. This means the client won't be able to get more than this number of events from a single subscription filter. This clamping is typically done silently @@ -284,7 +280,6 @@ As of 2 May 2023 the following `curl` command provided these results. "max_filters":2500, "max_limit":5000, "max_subid_length":256, - "min_prefix":4, "max_event_tags":2500, "max_content_length":65536, "min_pow_difficulty":0, From 209dc5d7945ca95f4de4c44df085568b271f3de5 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Mon, 21 Aug 2023 18:49:21 +0900 Subject: [PATCH 49/61] Update NIP-50 title in list --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 38a03173..72eb2a4a 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-46: Nostr Connect](46.md) - [NIP-47: Wallet Connect](47.md) - [NIP-48: Proxy Tags](48.md) -- [NIP-50: Keywords filter](50.md) +- [NIP-50: Search Capability](50.md) - [NIP-51: Lists](51.md) - [NIP-52: Calendar Events](52.md) - [NIP-53: Live Activities](53.md) From c6b6eea96a85aa6c9b5ce579685214fea3de0282 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Wed, 23 Aug 2023 12:55:31 -0300 Subject: [PATCH 50/61] remove bracket from kind attribute in example. fixes https://github.com/nostr-protocol/nips/issues/735 --- 57.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/57.md b/57.md index ace4a03c..729d585e 100644 --- a/57.md +++ b/57.md @@ -78,7 +78,7 @@ const sats = 21 const amount = sats * 1000 const relays = ['wss://nostr-pub.wellorder.net'] const event = encodeURI(JSON.stringify(await signEvent({ - kind: [9734], + kind: 9734, content: "", pubkey: senderPubkey, created_at: Math.round(Date.now() / 1000), From 208dee210249f84496ddfa823542d023e23b3edb Mon Sep 17 00:00:00 2001 From: Jonathan Staab Date: Thu, 24 Aug 2023 15:18:50 -0700 Subject: [PATCH 51/61] Define how to encode a non-parameterized replaceable event as a naddr --- 19.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/19.md b/19.md index 6b087426..cd989e21 100644 --- a/19.md +++ b/19.md @@ -35,7 +35,7 @@ These are the possible bech32 prefixes with `TLV`: - `nprofile`: a nostr profile - `nevent`: a nostr event - `nrelay`: a nostr relay - - `naddr`: a nostr _parameterized replaceable event_ coordinate + - `naddr`: a nostr _replaceable event_ coordinate These possible standardized `TLV` types are indicated here: @@ -44,7 +44,7 @@ These possible standardized `TLV` types are indicated here: - for `nprofile` it will be the 32 bytes of the profile public key - for `nevent` it will be the 32 bytes of the event id - for `nrelay`, this is the relay URL - - for `naddr`, it is the identifier (the `"d"` tag) of the event being referenced + - for `naddr`, it is the identifier (the `"d"` tag) of the event being referenced. For non-parameterized replaceable events, use an empty string. - `1`: `relay` - for `nprofile`, `nevent` and `naddr`, _optionally_, a relay in which the entity (profile or event) is more likely to be found, encoded as ascii - this may be included multiple times From f7b7b865e629789cb4d64b45a836c116e2831cbe Mon Sep 17 00:00:00 2001 From: William Casarin Date: Wed, 23 Aug 2023 19:56:20 -0700 Subject: [PATCH 52/61] NIP-315: User Statuses This NIP enables a way for users to share live statuses such as what music they are listening to, as well as what they are currently doing: work, play, out of office, etc. --- 315.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 62 insertions(+) create mode 100644 315.md diff --git a/315.md b/315.md new file mode 100644 index 00000000..0f4f0a1d --- /dev/null +++ b/315.md @@ -0,0 +1,60 @@ + +NIP-315 +======= + +User Statuses +-------------- + +`draft` `optional` `author:jb55` + +## Abstract + +This NIP enables a way for users to share live statuses such as what music they are listening to, as well as what they are currently doing: work, play, out of office, etc. + +## Live Statuses + +A special event with `kind:30315` "User Status" is defined as an *optionally expiring* _parameterized replaceable event_, where the `d` tag represents the status type: + +For example: + +```js +{ + "kind": 30315, + "content": "Sign up for nostrasia!", + "tags": [ + ["d", "general"], + ["r", "https://nostr.world"] + ], +} + +{ + "kind": 30315, + "content": "Intergalatic - Beastie Boys", + "tags": [ + ["d", "music"], + ["r", "spotify:search:Intergalatic%20-%20Beastie%20Boys"], + ["expiration", "1692845589"] + ], +} +``` + +Two common status types are defined: `general` and `music`. `general` represent general statuses: "Working", "Hiking", etc. + +`music` status events are for live streaming what you are currently listening to. The expiry of the `music` status should be when the track will stop playing. + +Any other status types can be used but they are not defined by this NIP. + +The status MAY include an `r`, `p`, `e` or `a` tag linking to a URL, profile, note, or parameterized replaceable event. + +# Client behavior + +Clients MAY display this next to the username on posts or profiles to provide live user status information. + +# Use Cases + +* Calendar nostr apps that update your general status when you're in a meeting +* Nostr Nests that update your general status with a link to the nest when you join +* Nostr music streaming services that update your music status when you're listening +* Podcasting apps that update your music status when you're listening to a podcast, with a link for others to listen as well +* Clients can use the system media player to update playing music status + diff --git a/README.md b/README.md index f8b77dfb..f6b57f11 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-94: File Metadata](94.md) - [NIP-98: HTTP Auth](98.md) - [NIP-99: Classified Listings](99.md) +- [NIP-315: User Statuses](315.md) ## Event Kinds @@ -113,6 +114,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30024` | Draft Long-form Content | [23](23.md) | | `30078` | Application-specific Data | [78](78.md) | | `30311` | Live Event | [53](53.md) | +| `30315` | User Statuses | [315](315.md) | | `30402` | Classified Listing | [99](99.md) | | `30403` | Draft Classified Listing | [99](99.md) | | `31922` | Date-Based Calendar Event | [52](52.md) | From 7dc1f02fa70a5b9da7b3867e3faa37f48571d5e1 Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Fri, 25 Aug 2023 08:41:26 -0300 Subject: [PATCH 53/61] rename 315 to 38. --- 315.md => 38.md | 5 ++--- README.md | 4 ++-- 2 files changed, 4 insertions(+), 5 deletions(-) rename 315.md => 38.md (99%) diff --git a/315.md b/38.md similarity index 99% rename from 315.md rename to 38.md index 0f4f0a1d..378da1c5 100644 --- a/315.md +++ b/38.md @@ -1,6 +1,6 @@ -NIP-315 -======= +NIP-38 +====== User Statuses -------------- @@ -57,4 +57,3 @@ Clients MAY display this next to the username on posts or profiles to provide li * Nostr music streaming services that update your music status when you're listening * Podcasting apps that update your music status when you're listening to a podcast, with a link for others to listen as well * Clients can use the system media player to update playing music status - diff --git a/README.md b/README.md index f6b57f11..7951339f 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-31: Dealing with Unknown Events](31.md) - [NIP-32: Labeling](32.md) - [NIP-36: Sensitive Content](36.md) +- [NIP-38: User Statuses](38.md) - [NIP-39: External Identities in Profiles](39.md) - [NIP-40: Expiration Timestamp](40.md) - [NIP-42: Authentication of clients to relays](42.md) @@ -67,7 +68,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-94: File Metadata](94.md) - [NIP-98: HTTP Auth](98.md) - [NIP-99: Classified Listings](99.md) -- [NIP-315: User Statuses](315.md) ## Event Kinds @@ -114,7 +114,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30024` | Draft Long-form Content | [23](23.md) | | `30078` | Application-specific Data | [78](78.md) | | `30311` | Live Event | [53](53.md) | -| `30315` | User Statuses | [315](315.md) | +| `30315` | User Statuses | [38](38.md) | | `30402` | Classified Listing | [99](99.md) | | `30403` | Draft Classified Listing | [99](99.md) | | `31922` | Date-Based Calendar Event | [52](52.md) | From 50945f7150c8b100f92fdfdffba32894ba5a831f Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Fri, 25 Aug 2023 23:17:05 +0900 Subject: [PATCH 54/61] Reword set_metadata to metadata (#741) --- 05.md | 4 ++-- 89.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/05.md b/05.md index 56b9156b..00d69af6 100644 --- a/05.md +++ b/05.md @@ -6,11 +6,11 @@ Mapping Nostr keys to DNS-based internet identifiers `final` `optional` `author:fiatjaf` `author:mikedilger` -On events of kind `0` (`set_metadata`) one can specify the key `"nip05"` with an [internet identifier](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) (an email-like address) as the value. Although there is a link to a very liberal "internet identifier" specification above, NIP-05 assumes the `` part will be restricted to the characters `a-z0-9-_.`, case-insensitive. +On events of kind `0` (`metadata`) one can specify the key `"nip05"` with an [internet identifier](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) (an email-like address) as the value. Although there is a link to a very liberal "internet identifier" specification above, NIP-05 assumes the `` part will be restricted to the characters `a-z0-9-_.`, case-insensitive. Upon seeing that, the client splits the identifier into `` and `` and use these values to make a GET request to `https:///.well-known/nostr.json?name=`. -The result should be a JSON document object with a key `"names"` that should then be a mapping of names to hex formatted public keys. If the public key for the given `` matches the `pubkey` from the `set_metadata` event, the client then concludes that the given pubkey can indeed be referenced by its identifier. +The result should be a JSON document object with a key `"names"` that should then be a mapping of names to hex formatted public keys. If the public key for the given `` matches the `pubkey` from the `metadata` event, the client then concludes that the given pubkey can indeed be referenced by its identifier. ### Example diff --git a/89.md b/89.md index 5eee3b8e..4503ecfd 100644 --- a/89.md +++ b/89.md @@ -61,7 +61,7 @@ The third value of the tag SHOULD be the platform where this recommendation migh } ``` -* `content` is an optional `set_metadata`-like stringified JSON object, as described in NIP-01. This content is useful when the pubkey creating the `kind:31990` is not an application. If `content` is empty, the `kind:0` of the pubkey should be used to display application information (e.g. name, picture, web, LUD16, etc.) +* `content` is an optional `metadata`-like stringified JSON object, as described in NIP-01. This content is useful when the pubkey creating the `kind:31990` is not an application. If `content` is empty, the `kind:0` of the pubkey should be used to display application information (e.g. name, picture, web, LUD16, etc.) * `k` tags' value is the event kind that is supported by this `kind:31990`. Using a `k` tag(s) (instead of having the kind onf the NIP-33 `d` tag) provides: From 21f3ad5a42c0ae63f2fc0a6e9f18b05f44df68c5 Mon Sep 17 00:00:00 2001 From: Viktor Vsk Date: Sun, 27 Aug 2023 15:34:55 +0200 Subject: [PATCH 55/61] Allow relays indicate whether probabilistic count was used in NIP-45 --- 45.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/45.md b/45.md index a5253913..7b11950a 100644 --- a/45.md +++ b/45.md @@ -21,6 +21,7 @@ This NIP defines the verb `COUNT`, which accepts a subscription id and filters a ``` Counts are returned using a `COUNT` response in the form `{"count": }`. Relays may use probabilistic counts to reduce compute requirements. +In case a relay uses probabilistic counts, it MAY indicate it in the response with `approximate` key i.e. `{"count": , "approximate": }`. ``` ["COUNT", , {"count": }] @@ -36,4 +37,8 @@ Examples: # Count posts and reactions ["COUNT", , {"kinds": [1, 7], "authors": []}] ["COUNT", , {"count": 5}] + +# Count posts approximately +["COUNT", , {"kinds": [1]}] +["COUNT", , {"count": 93412452, "approximate": true}] ``` From d1d438bf1458fc0f59a191631d10c0bde35353be Mon Sep 17 00:00:00 2001 From: Yasuhiro Matsumoto Date: Tue, 29 Aug 2023 00:45:45 +0900 Subject: [PATCH 56/61] fix typo --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index d6ccfbe2..e4c0546c 100644 --- a/01.md +++ b/01.md @@ -62,7 +62,7 @@ Each tag is an array of strings of arbitrary size, with some conventions around The first element of the tag array is referred to as the tag _name_ or _key_ and the second as the tag _value_. So we can safely say that the event above has an `e` tag set to `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"`, an `alt` tag set to `"reply"` and so on. All elements after the second do not have a conventional name. -This NIP defines 3 standard tags that can be used accross all event kinds with the same meaning. They are as follows: +This NIP defines 3 standard tags that can be used across all event kinds with the same meaning. They are as follows: - The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, ]` - The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, ]` From e50bf508d9014cfb19bfa8a5c4ec88dc4788d490 Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Tue, 29 Aug 2023 23:49:59 +0900 Subject: [PATCH 57/61] add a-tag format for non-parameterized replaceable events --- 01.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/01.md b/01.md index e4c0546c..1831438e 100644 --- a/01.md +++ b/01.md @@ -66,7 +66,9 @@ This NIP defines 3 standard tags that can be used across all event kinds with th - The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, ]` - The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, ]` -- The `a` tag, used to refer to a parameterized replaceable event: `["a", :<32-bytes lowercase hex of a pubkey>:, ]` +- The `a` tag, used to refer to a (maybe parameterized) replaceable event + - for a parameterized replaceable event: `["a", :<32-bytes lowercase hex of a pubkey>:, ]` + - for a non-parameterized replaceable event: `["a", :<32-bytes lowercase hex of a pubkey>:, ]` As a convention, all single-letter (only english alphabet letters: a-z, A-Z) key tags are expected to be indexed by relays, such that it is possible, for example, to query or subscribe to events that reference the event `"5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"` by using the `{"#e": "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36"}` filter. From d784820309dba0447d6a0a351ad0230ba6c5c5fb Mon Sep 17 00:00:00 2001 From: SnazzyBytes Date: Wed, 30 Aug 2023 18:30:41 -0500 Subject: [PATCH 58/61] add NIP-22 created_at limits to Server-Limitations --- 11.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/11.md b/11.md index 083ae8f3..deb6f197 100644 --- a/11.md +++ b/11.md @@ -80,6 +80,8 @@ are rejected or fail immediately. "min_pow_difficulty": 30, "auth_required": true, "payment_required": true, + "created_at_lower_limit":31536000, + "created_at_upper_limit":3, } ... } @@ -123,6 +125,10 @@ Even if set to False, authentication may be required for specific actions. - `payment_required`: this relay requires payment before a new connection may perform any action. +- `created_at_lower_limit`: 'created_at' lower limit as defined in [NIP-22](22.md) + +- `created_at_upper_limit`: 'created_at' upper limit as defined in [NIP-22](22.md) + ### Event Retention ### There may be a cost associated with storing data forever, so relays From 08bd050598e078179eea71cb9de777d887a9e9f8 Mon Sep 17 00:00:00 2001 From: Alejandro Date: Fri, 1 Sep 2023 15:07:52 +0200 Subject: [PATCH 59/61] NIP-75: Zap Goals (#757) --- 75.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 3 +++ 2 files changed, 79 insertions(+) create mode 100644 75.md diff --git a/75.md b/75.md new file mode 100644 index 00000000..6c8cb7b1 --- /dev/null +++ b/75.md @@ -0,0 +1,76 @@ +# NIP-75 + +## Zap Goals + +`draft` `optional` `author:verbiricha` + +This NIP defines an event for creating fundraising goals. Users can contribute funds towards the goal by zapping the goal event. + +## Nostr Event + +A `kind:9041` event is used. + +The `.content` contains a human-readable description of the goal. + +The following tags are defined as REQUIRED. + +- `amount` - target amount in milisats. +- `relays` - a list of relays the zaps to this goal will be sent to and tallied from. + +Example event: + +```json +{ + "kind": 9041, + "tags": [ + ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", ...], + ["amount", "210000"], + ], + "content": "Nostrasia travel expenses", + ...other fields +``` + +The following tags are OPTIONAL. + +- `closed_at` - timestamp for determining which zaps are included in the tally. Zap receipts published after the `closed_at` timestamp SHOULD NOT count towards the goal progress. + +```json +{ + "kind": 9041, + "tags": [ + ["relays", "wss://alicerelay.example.com", "wss://bobrelay.example.com", ...], + ["amount", "210000"], + ["closed_at", ""], + ], + "content": "Nostrasia travel expenses", + ...other fields +``` + +The goal MAY include an `r` or `a` tag linking to a URL or parameterized replaceable event. + +The goal MAY include multiple beneficiary pubkeys by specifying [`zap` tags](57.md#appendix-g-zap-tag-on-other-events). + +Parameterized replaceable events can link to a goal by using a `goal` tag specifying the event id and an optional relay hint. + +```json +{ + "kind": 3XXXX, + "tags": [ + ... + ["goal", "", ""], + ], + ...other fields +``` + +## Client behavior + +Clients MAY display funding goals on user profiles. + +When zapping a goal event, clients MUST include the relays in the `relays` tag of the goal event in the zap request `relays` tag. + +When zapping a parameterized replaceable event with a `goal` tag, clients SHOULD tag the goal event id in the `e` tag of the zap request. + +## Use cases + +- Fundraising clients +- Adding funding goals to events such as long form posts, badges or live streams diff --git a/README.md b/README.md index 7951339f..5beff919 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-58: Badges](58.md) - [NIP-65: Relay List Metadata](65.md) - [NIP-72: Moderated Communities](72.md) +- [NIP-75: Zap Goals](75.md) - [NIP-78: Application-specific data](78.md) - [NIP-89: Recommended Application Handlers](89.md) - [NIP-94: File Metadata](94.md) @@ -93,6 +94,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `1984` | Reporting | [56](56.md) | | `1985` | Label | [32](32.md) | | `4550` | Community Post Approval | [72](72.md) | +| `9041` | Zap Goal | [75](75.md) | | `9734` | Zap Request | [57](57.md) | | `9735` | Zap | [57](57.md) | | `10000` | Mute List | [51](51.md) | @@ -177,6 +179,7 @@ Please update these lists when proposing NIPs introducing new event kinds. | `description` | invoice description | -- | [57](57.md) | | `emoji` | shortcode, image URL | -- | [30](30.md) | | `expiration` | unix timestamp (string) | -- | [40](40.md) | +| `goal` | event id (hex) | relay URL | [75](75.md) | | `image` | image URL | dimensions in pixels | [23](23.md), [58](58.md) | | `lnurl` | `bech32` encoded `lnurl` | -- | [57](57.md) | | `location` | location string | -- | [52](52.md), [99](99.md) | From c7191fc2f518aa85b6437c001c1fdcadaa0b38a3 Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Sat, 2 Sep 2023 14:34:39 +0300 Subject: [PATCH 60/61] fix inconsistency --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 1831438e..7a304e0d 100644 --- a/01.md +++ b/01.md @@ -82,7 +82,7 @@ Kinds specify how clients should interpret the meaning of each event and the oth And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: - for kind `n` such that `1000 <= n < 10000`, events are **regular**, which means they're all expected to be stored by relays. -- for kind `n` such that `10000 <= n < 20000 || k == 0 || k == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to (SHOULD) be stored by relays, older versions are expected to be discarded. +- for kind `n` such that `10000 <= n < 20000 || n == 0 || n == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to (SHOULD) be stored by relays, older versions are expected to be discarded. - for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. - for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag, only the latest event is expected to be stored by relays, older versions are expected to be discarded. From ea8fa91c8058c8d74aff8b011196d504a2683fe9 Mon Sep 17 00:00:00 2001 From: Semisol <45574030+Semisol@users.noreply.github.com> Date: Mon, 4 Sep 2023 14:25:04 +0300 Subject: [PATCH 61/61] clarify parameterized replaceable events --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 7a304e0d..d822bfbc 100644 --- a/01.md +++ b/01.md @@ -84,7 +84,7 @@ And also a convention for kind ranges that allow for easier experimentation and - for kind `n` such that `1000 <= n < 10000`, events are **regular**, which means they're all expected to be stored by relays. - for kind `n` such that `10000 <= n < 20000 || n == 0 || n == 3`, events are **replaceable**, which means that, for each combination of `pubkey` and `kind`, only the latest event is expected to (SHOULD) be stored by relays, older versions are expected to be discarded. - for kind `n` such that `20000 <= n < 30000`, events are **ephemeral**, which means they are not expected to be stored by relays. -- for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag, only the latest event is expected to be stored by relays, older versions are expected to be discarded. +- for kind `n` such that `30000 <= n < 40000`, events are **parameterized replaceable**, which means that, for each combination of `pubkey`, `kind` and the `d` tag's first value, only the latest event is expected to be stored by relays, older versions are expected to be discarded. In case of replaceable events with the same timestamp, the event with the lowest id (first in lexical order) should be retained, and the other discarded.