From 2f2dead4cc08671b761f5e40f9a38cc32bcb26c5 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 14 Mar 2024 08:38:37 -0400 Subject: [PATCH 01/80] Adds draft event. --- 35.md | 25 +++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 27 insertions(+) create mode 100644 35.md diff --git a/35.md b/35.md new file mode 100644 index 00000000..ba2c7869 --- /dev/null +++ b/35.md @@ -0,0 +1,25 @@ +NIP-35 +====== + +Draft Events +------------ + +`draft` `optional` + +This NIP defines kind `31234` as a private draft event for any other event kind. + +The draft event is JSON-stringified, [NIP44-encrypted](44.md) to the owner's public key and placed inside the `.content` of the event. + +An additional `k` tag identifies the kind of the draft event. + +```js +{ + "kind": 31234, + "tags": [ + ["d", ""], + ["k", ""], + ], + "content": nip44Encrypt(JSON.stringify(draft_event)), + // other fields +} +``` \ No newline at end of file diff --git a/README.md b/README.md index 90a63949..dce4aaf2 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-31: Dealing with Unknown Events](31.md) - [NIP-32: Labeling](32.md) - [NIP-34: `git` stuff](34.md) +- [NIP-35: Draft Events](35.md) - [NIP-36: Sensitive Content](36.md) - [NIP-38: User Statuses](38.md) - [NIP-39: External Identities in Profiles](39.md) @@ -167,6 +168,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30402` | Classified Listing | [99](99.md) | | `30403` | Draft Classified Listing | [99](99.md) | | `30617` | Repository announcements | [34](34.md) | +| `31234` | Draft Event | [35](35.md) | | `31922` | Date-Based Calendar Event | [52](52.md) | | `31923` | Time-Based Calendar Event | [52](52.md) | | `31924` | Calendar | [52](52.md) | From f96ccc6e351be0b42d8b8395cc5b2de72f7f8e75 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 14 Mar 2024 08:52:58 -0400 Subject: [PATCH 02/80] Improved wording. --- 35.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/35.md b/35.md index ba2c7869..beff6754 100644 --- a/35.md +++ b/35.md @@ -6,9 +6,9 @@ Draft Events `draft` `optional` -This NIP defines kind `31234` as a private draft event for any other event kind. +This NIP defines kind `31234` as a private wrap for drafts of any other event kind. -The draft event is JSON-stringified, [NIP44-encrypted](44.md) to the owner's public key and placed inside the `.content` of the event. +The draft event is JSON-stringified, [NIP44-encrypted](44.md) to the signer's public key and placed inside the `.content` of the event. An additional `k` tag identifies the kind of the draft event. From f7f060303d25f081b1250761aff7522560270ddb Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 14 Mar 2024 14:07:23 -0400 Subject: [PATCH 03/80] Adds anchor events. --- 35.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/35.md b/35.md index beff6754..476ae36d 100644 --- a/35.md +++ b/35.md @@ -18,8 +18,12 @@ An additional `k` tag identifies the kind of the draft event. "tags": [ ["d", ""], ["k", ""], + ["e", "", ""], + ["a", "", ""], ], "content": nip44Encrypt(JSON.stringify(draft_event)), // other fields } -``` \ No newline at end of file +``` + +Tags `e` and `a` identify one or more anchor events, such as parent events on replies. From 0ed2f63f223f03a171d1aa5c31dbec6bd68ffb6b Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Fri, 29 Mar 2024 11:39:19 -0400 Subject: [PATCH 04/80] Getting drafts to be deleted even without relays supporting deletion events. --- 35.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/35.md b/35.md index 476ae36d..4bec44be 100644 --- a/35.md +++ b/35.md @@ -26,4 +26,6 @@ An additional `k` tag identifies the kind of the draft event. } ``` +A blanked `.content` means this draft has been deleted by a client but relays still have the event. + Tags `e` and `a` identify one or more anchor events, such as parent events on replies. From 00b2e0a5cb819f9b2e8135f08d29ee94607d83b6 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 30 May 2024 15:27:59 -0400 Subject: [PATCH 05/80] Adds private outbox relays. --- 35.md | 19 +++++++++++++++++++ README.md | 1 + 2 files changed, 20 insertions(+) diff --git a/35.md b/35.md index 4bec44be..45663dd8 100644 --- a/35.md +++ b/35.md @@ -29,3 +29,22 @@ An additional `k` tag identifies the kind of the draft event. A blanked `.content` means this draft has been deleted by a client but relays still have the event. Tags `e` and `a` identify one or more anchor events, such as parent events on replies. + +## Relay List for Private Content + +Kind `10013` indicates the user's preferred relays to store private events like Drafts. The event MUST include a list of `relay` URLs in private tags. Private tags are JSON Stringified, NIP-44-encrypted to the signer's keys and placed inside the .content of the event. + +```js +{ + "kind": 10013, + "tags": [], + "content": nip44Encrypt(JSON.stringify([ + ["relay", "wss://myrelay.mydomain.com"] + ])) + //...other fields +} +``` + +Relays listed in this event SHOULD be authed and only allow downloads to events signed by the authed user. + +Clients SHOULD publish kind `10013` events to the author's [NIP-65](65.md) `write` relays. diff --git a/README.md b/README.md index dce4aaf2..6cd47788 100644 --- a/README.md +++ b/README.md @@ -136,6 +136,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10006` | Blocked relays list | [51](51.md) | | `10007` | Search relays list | [51](51.md) | | `10009` | User groups | [51](51.md), [29](29.md) | +| `10013` | Private Relays | [35](35.md) | `10015` | Interests list | [51](51.md) | | `10030` | User emoji list | [51](51.md) | | `10096` | File storage server list | [96](96.md) | From 48674e563865b1cb7bb3c5c7869d20055446f408 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 30 May 2024 15:31:33 -0400 Subject: [PATCH 06/80] moves from NIP-35 to NIP-37 --- 35.md => 37.md | 2 +- README.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) rename 35.md => 37.md (99%) diff --git a/35.md b/37.md similarity index 99% rename from 35.md rename to 37.md index 45663dd8..1ade59d8 100644 --- a/35.md +++ b/37.md @@ -1,4 +1,4 @@ -NIP-35 +NIP-37 ====== Draft Events diff --git a/README.md b/README.md index 6cd47788..b4626aaf 100644 --- a/README.md +++ b/README.md @@ -50,8 +50,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-31: Dealing with Unknown Events](31.md) - [NIP-32: Labeling](32.md) - [NIP-34: `git` stuff](34.md) -- [NIP-35: Draft Events](35.md) - [NIP-36: Sensitive Content](36.md) +- [NIP-37: Draft Events](37.md) - [NIP-38: User Statuses](38.md) - [NIP-39: External Identities in Profiles](39.md) - [NIP-40: Expiration Timestamp](40.md) @@ -136,7 +136,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10006` | Blocked relays list | [51](51.md) | | `10007` | Search relays list | [51](51.md) | | `10009` | User groups | [51](51.md), [29](29.md) | -| `10013` | Private Relays | [35](35.md) +| `10013` | Private Relays | [35](37.md) | | `10015` | Interests list | [51](51.md) | | `10030` | User emoji list | [51](51.md) | | `10096` | File storage server list | [96](96.md) | @@ -169,7 +169,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30402` | Classified Listing | [99](99.md) | | `30403` | Draft Classified Listing | [99](99.md) | | `30617` | Repository announcements | [34](34.md) | -| `31234` | Draft Event | [35](35.md) | +| `31234` | Draft Event | [35](37.md) | | `31922` | Date-Based Calendar Event | [52](52.md) | | `31923` | Time-Based Calendar Event | [52](52.md) | | `31924` | Calendar | [52](52.md) | From d09b51246d7d5757b5e78ef1cc18e8925561d42f Mon Sep 17 00:00:00 2001 From: Jon Staab Date: Fri, 22 Nov 2024 14:09:12 -0800 Subject: [PATCH 07/80] Tweak group join requests to include user feedback --- 29.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/29.md b/29.md index a2c8ef26..93dc3d29 100644 --- a/29.md +++ b/29.md @@ -72,7 +72,7 @@ These are events that can be sent by users to manage their situation in a group, - *join request* (`kind:9021`) -Any user can send one of these events to the relay in order to be automatically or manually added to the group. If the group is `open` the relay will automatically issue a `kind:9000` in response adding this user. Otherwise group admins may choose to query for these requests and act upon them. +Any user can send a kind `9021` event to the relay in order to request admission to the group. Relays MUST reject the request if the user has not been added to the group. The accompanying error message SHOULD explain whether the rejection is final, if the request is pending review, or if some other special handling is relevant (e.g. if payment is required). If a user is already a member, the event MUST be accepted. ```json { From 4d47b38dbc0c2e09d235972f59a4338a7bb37cc0 Mon Sep 17 00:00:00 2001 From: Jon Staab Date: Sat, 23 Nov 2024 07:09:25 -0800 Subject: [PATCH 08/80] Switch to rejecting duplicate joins --- 29.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/29.md b/29.md index 93dc3d29..7705c6db 100644 --- a/29.md +++ b/29.md @@ -72,7 +72,7 @@ These are events that can be sent by users to manage their situation in a group, - *join request* (`kind:9021`) -Any user can send a kind `9021` event to the relay in order to request admission to the group. Relays MUST reject the request if the user has not been added to the group. The accompanying error message SHOULD explain whether the rejection is final, if the request is pending review, or if some other special handling is relevant (e.g. if payment is required). If a user is already a member, the event MUST be accepted. +Any user can send a kind `9021` event to the relay in order to request admission to the group. Relays MUST reject the request if the user has not been added to the group. The accompanying error message SHOULD explain whether the rejection is final, if the request is pending review, or if some other special handling is relevant (e.g. if payment is required). If a user is already a member, the event MUST be rejected with `duplicate: ` as the error message prefix. ```json { From 2ffd8ec36360512c5f5087519b667434b4dc7832 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=B0=8F=E5=8E=9F=E6=99=B4=E5=A4=AA?= Date: Fri, 29 Nov 2024 14:40:11 +0000 Subject: [PATCH 09/80] use example domain --- 46.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/46.md b/46.md index 824059c1..7f8859f6 100644 --- a/46.md +++ b/46.md @@ -213,7 +213,7 @@ _remote-signer_ MAY publish it's metadata by using [NIP-05](05.md) and [NIP-89]( }, "nip46": { "relays": ["wss://relay1","wss://relay2"...], - "nostrconnect_url": "https://remote-signer-domain.com/" + "nostrconnect_url": "https://remote-signer-domain.example/" } } ``` From fe1fe75caecfaaf0dcd675fb706a91347c9b3c80 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Sat, 30 Nov 2024 15:57:50 +0900 Subject: [PATCH 10/80] mark kind 30001 as deprecated. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d362e6a1..61fdbe8e 100644 --- a/README.md +++ b/README.md @@ -183,7 +183,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `24242` | Blobs stored on mediaservers | [Blossom][blossom] | | `27235` | HTTP Auth | [98](98.md) | | `30000` | Follow sets | [51](51.md) | -| `30001` | Generic lists | [51](51.md) | +| `30001` | Generic lists | 51 (deprecated) | | `30002` | Relay sets | [51](51.md) | | `30003` | Bookmark sets | [51](51.md) | | `30004` | Curation sets | [51](51.md) | From 54c0c1352d73595b99b568248b87fe4542d30141 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Sun, 1 Dec 2024 00:15:39 +0900 Subject: [PATCH 11/80] BREAKING.md: fix change of 7822a8b1 --- BREAKING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/BREAKING.md b/BREAKING.md index 40391e05..39be5a0f 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -36,7 +36,8 @@ reverse chronological order. | 2023-12-27 | [17c67ef5](https://github.com/nostr-protocol/nips/commit/17c67ef5) | [94](94.md) | 'aes-256-gcm' tag was removed | | 2023-12-03 | [0ba45895](https://github.com/nostr-protocol/nips/commit/0ba45895) | [01](01.md) | WebSocket status code `4000` was replaced by 'CLOSED' message | | 2023-11-28 | [6de35f9e](https://github.com/nostr-protocol/nips/commit/6de35f9e) | [89](89.md) | 'client' tag value was changed | -| 2023-11-20 | [7822a8b1](https://github.com/nostr-protocol/nips/commit/7822a8b1) | [51](51.md) | `kind: 30000` and `kind: 30001` were deprecated | +| 2023-11-20 | [7822a8b1](https://github.com/nostr-protocol/nips/commit/7822a8b1) | [51](51.md) | `kind: 30001` was deprecated | +| 2023-11-20 | [7822a8b1](https://github.com/nostr-protocol/nips/commit/7822a8b1) | [51](51.md) | the meaning of `kind: 30000` was changed | | 2023-11-11 | [cbdca1e9](https://github.com/nostr-protocol/nips/commit/cbdca1e9) | [84](84.md) | 'range' tag was removed | | 2023-11-10 | [c945d8bd](https://github.com/nostr-protocol/nips/commit/c945d8bd) | [32](32.md) | 'l' tag annotations was removed | | 2023-11-07 | [108b7f16](https://github.com/nostr-protocol/nips/commit/108b7f16) | [01](01.md) | 'OK' message must have 4 items | From 33efff81a6909da9a85e81d296a711810f1848a1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=B0=8F=E5=8E=9F=E6=99=B4=E5=A4=AA?= Date: Wed, 4 Dec 2024 14:30:42 +0000 Subject: [PATCH 12/80] NIP-44: Proper base64 explanation "Encoding algorithm" instead of "compression algorithm" --- 44.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/44.md b/44.md index 8f781b85..b70acb2b 100644 --- a/44.md +++ b/44.md @@ -63,7 +63,7 @@ NIP-44 version 2 has the following design characteristics: - SHA256 is used instead of SHA3 or BLAKE because it is already used in nostr. Also BLAKE's speed advantage is smaller in non-parallel environments. - A custom padding scheme is used instead of padmé because it provides better leakage reduction for small messages. -- Base64 encoding is used instead of another compression algorithm because it is widely available, and is already used in nostr. +- Base64 encoding is used instead of another encoding algorithm because it is widely available, and is already used in nostr. ### Encryption From 2776a2aa143e88295421bfc960e12adfcae5f8f8 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Fri, 6 Dec 2024 00:58:50 +0900 Subject: [PATCH 13/80] add `P` tag to README. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 61fdbe8e..9107bd79 100644 --- a/README.md +++ b/README.md @@ -282,6 +282,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `L` | label namespace | -- | [32](32.md) | | `m` | MIME type | -- | [94](94.md) | | `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | +| `P` | pubkey (hex) | -- | [57](57.md) | | `q` | event id (hex) | relay URL, pubkey (hex) | [18](18.md) | | `r` | a reference (URL, etc) | -- | [24](24.md), [25](25.md) | | `r` | relay url | marker | [65](65.md) | From 6d16019e9e98807b23b7ae1faf5edeead7ddee7a Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Thu, 5 Dec 2024 16:59:18 -0300 Subject: [PATCH 14/80] nip46: abandon nip04 entirely and just use nip44. --- 46.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/46.md b/46.md index 7f8859f6..d1706285 100644 --- a/46.md +++ b/46.md @@ -72,12 +72,12 @@ _user_ passes this token to _remote-signer_, which then sends `connect` *respons { "kind": 24133, "pubkey": , - "content": )>, + "content": )>, "tags": [["p", ]], } ``` -The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted and has the following structure: +The `content` field is a JSON-RPC-like message that is [NIP-44](44.md) encrypted and has the following structure: ```jsonc { @@ -109,7 +109,7 @@ Each of the following are methods that the _client_ sends to the _remote-signer_ ### Requested permissions -The `connect` method may be provided with `optional_requested_permissions` for user convenience. The permissions are a comma-separated list of `method[:params]`, i.e. `nip04_encrypt,sign_event:4` meaning permissions to call `nip04_encrypt` and to call `sign_event` with `kind:4`. Optional parameter for `sign_event` is the kind number, parameters for other methods are to be defined later. Same permission format may be used for `perms` field of `metadata` in `nostrconnect://` string. +The `connect` method may be provided with `optional_requested_permissions` for user convenience. The permissions are a comma-separated list of `method[:params]`, i.e. `nip44_encrypt,sign_event:4` meaning permissions to call `nip44_encrypt` and to call `sign_event` with `kind:4`. Optional parameter for `sign_event` is the kind number, parameters for other methods are to be defined later. Same permission format may be used for `perms` field of `metadata` in `nostrconnect://` string. ## Response Events `kind:24133` @@ -118,13 +118,13 @@ The `connect` method may be provided with `optional_requested_permissions` for u "id": , "kind": 24133, "pubkey": , - "content": )>, + "content": )>, "tags": [["p", ]], "created_at": } ``` -The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted and has the following structure: +The `content` field is a JSON-RPC-like message that is [NIP-44](44.md) encrypted and has the following structure: ```json { @@ -150,7 +150,7 @@ The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted { "kind": 24133, "pubkey": "eff37350d839ce3707332348af4549a96051bd695d3223af4aabce4993531d86", - "content": nip04({ + "content": nip44({ "id": , "method": "sign_event", "params": [json_stringified(<{ @@ -170,7 +170,7 @@ The `content` field is a JSON-RPC-like message that is [NIP-04](04.md) encrypted { "kind": 24133, "pubkey": "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", - "content": nip04({ + "content": nip44({ "id": , "result": json_stringified() }), @@ -224,4 +224,4 @@ The `` MAY be used to verify the domain from _remote-s _remote-signer_ MAY publish a NIP-89 `kind: 31990` event with `k` tag of `24133`, which MAY also include one or more `relay` tags and MAY include `nostrconnect_url` tag. The semantics of `relay` and `nostrconnect_url` tags are the same as in the section above. -_client_ MAY improve UX by discovering _remote-signers_ using their `kind: 31990` events. _client_ MAY then pre-generate `nostrconnect://` strings for the _remote-signers_, and SHOULD in that case verify that `kind: 31990` event's author is mentioned in signer's `nostr.json?name=_` file as ``. +_client_ MAY improve UX by discovering _remote-signers_ using their `kind: 31990` events. _client_ MAY then pre-generate `nostrconnect://` strings for the _remote-signers_, and SHOULD in that case verify that `kind: 31990` event's author is mentioned in signer's `nostr.json?name=_` file as ``. From a92d2e2edd3251067ab8787ecf10ee2dffe2b85f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=B0=8F=E5=8E=9F=E6=99=B4=E5=A4=AA?= Date: Fri, 6 Dec 2024 11:26:23 +0000 Subject: [PATCH 15/80] Clarify the units --- 44.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/44.md b/44.md index b70acb2b..8f27fede 100644 --- a/44.md +++ b/44.md @@ -86,7 +86,7 @@ NIP-44 version 2 has the following design characteristics: - Content must be encoded from UTF-8 into byte array - Validate plaintext length. Minimum is 1 byte, maximum is 65535 bytes - Padding format is: `[plaintext_length: u16][plaintext][zero_bytes]` - - Padding algorithm is related to powers-of-two, with min padded msg size of 32 + - Padding algorithm is related to powers-of-two, with min padded msg size of 32bytes - Plaintext length is encoded in big-endian as first 2 bytes of the padded blob 5. Encrypt padded content - Use ChaCha20, with key and nonce from step 3 @@ -148,8 +148,8 @@ validation rules, refer to BIP-340. - `x[i:j]`, where `x` is a byte array and `i, j <= 0` returns a `(j - i)`-byte array with a copy of the `i`-th byte (inclusive) to the `j`-th byte (exclusive) of `x`. - Constants `c`: - - `min_plaintext_size` is 1. 1b msg is padded to 32b. - - `max_plaintext_size` is 65535 (64kb - 1). It is padded to 65536. + - `min_plaintext_size` is 1. 1bytes msg is padded to 32bytes. + - `max_plaintext_size` is 65535 (64kB - 1). It is padded to 65536bytes. - Functions - `base64_encode(string)` and `base64_decode(bytes)` are Base64 ([RFC 4648](https://datatracker.ietf.org/doc/html/rfc4648), with padding) - `concat` refers to byte array concatenation From 936616b3c00c83679496ca610910901968917859 Mon Sep 17 00:00:00 2001 From: mono <102149418+TsukemonoGit@users.noreply.github.com> Date: Sat, 7 Dec 2024 07:43:52 +0900 Subject: [PATCH 16/80] Update README.md add Event Kinds kind:20 Picture-first feeds --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 9107bd79..34dfc1b2 100644 --- a/README.md +++ b/README.md @@ -119,6 +119,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `14` | Direct Message | [17](17.md) | | `16` | Generic Repost | [18](18.md) | | `17` | Reaction to a website | [25](25.md) | +| `20` | Picture-first feeds | [68](68.md) | | `40` | Channel Creation | [28](28.md) | | `41` | Channel Metadata | [28](28.md) | | `42` | Channel Message | [28](28.md) | From a2be191ecd0b882ed388a564b5e57b1ca25cbdb4 Mon Sep 17 00:00:00 2001 From: mono <102149418+TsukemonoGit@users.noreply.github.com> Date: Sat, 7 Dec 2024 07:45:25 +0900 Subject: [PATCH 17/80] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 34dfc1b2..eb6fd94a 100644 --- a/README.md +++ b/README.md @@ -119,7 +119,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `14` | Direct Message | [17](17.md) | | `16` | Generic Repost | [18](18.md) | | `17` | Reaction to a website | [25](25.md) | -| `20` | Picture-first feeds | [68](68.md) | +| `20` | Picture | [68](68.md) | | `40` | Channel Creation | [28](28.md) | | `41` | Channel Metadata | [28](28.md) | | `42` | Channel Message | [28](28.md) | From b04922586ead1a0009716b86cc97d4790a5657d0 Mon Sep 17 00:00:00 2001 From: Jesus Christ <120573631+Gudnessuche@users.noreply.github.com> Date: Sun, 8 Dec 2024 12:34:34 +0000 Subject: [PATCH 18/80] Update 90.md Added a period to show the end of "Protocol Flow" explanation --- 90.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/90.md b/90.md index 696ebd59..1d69b0ff 100644 --- a/90.md +++ b/90.md @@ -185,7 +185,7 @@ Any job feedback event MIGHT include results in the `.content` field, as describ * Customer publishes a job request (e.g. `kind:5000` speech-to-text). * Service Providers MAY submit `kind:7000` job-feedback events (e.g. `payment-required`, `processing`, `error`, etc.). * Upon completion, the service provider publishes the result of the job with a `kind:6000` job-result event. -* At any point, if there is an `amount` pending to be paid as instructed by the service provider, the user can pay the included `bolt11` or zap the job result event the service provider has sent to the user +* At any point, if there is an `amount` pending to be paid as instructed by the service provider, the user can pay the included `bolt11` or zap the job result event the service provider has sent to the user. Job feedback (`kind:7000`) and Job Results (`kind:6000-6999`) events MAY include an `amount` tag, this can be interpreted as a suggestion to pay. Service Providers MUST use the `payment-required` feedback event to signal that a payment is required and no further actions will be performed until the payment is sent. From d71887a8e29821212f765b3cdf69c25df1415271 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Mon, 9 Dec 2024 13:19:16 +0900 Subject: [PATCH 19/80] BREAKING.md: merge duplicate lines --- BREAKING.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/BREAKING.md b/BREAKING.md index 39be5a0f..f083ca0e 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -30,8 +30,7 @@ reverse chronological order. | 2024-02-07 | [d3dad114](https://github.com/nostr-protocol/nips/commit/d3dad114) | [46](46.md) | Connection token format was changed | | 2024-01-30 | [1a2b21b6](https://github.com/nostr-protocol/nips/commit/1a2b21b6) | [59](59.md) | 'p' tag became optional | | 2023-01-27 | [c2f34817](https://github.com/nostr-protocol/nips/commit/c2f34817) | [47](47.md) | optional expiration tag should be honored | -| 2024-01-10 | [3d8652ea](https://github.com/nostr-protocol/nips/commit/3d8652ea) | [02](02.md) | list entries should be chronological | -| 2024-01-10 | [3d8652ea](https://github.com/nostr-protocol/nips/commit/3d8652ea) | [51](51.md) | list entries should be chronological | +| 2024-01-10 | [3d8652ea](https://github.com/nostr-protocol/nips/commit/3d8652ea) | [02](02.md), [51](51.md) | list entries should be chronological | | 2023-12-30 | [29869821](https://github.com/nostr-protocol/nips/commit/29869821) | [52](52.md) | 'name' tag was removed (use 'title' tag instead) | | 2023-12-27 | [17c67ef5](https://github.com/nostr-protocol/nips/commit/17c67ef5) | [94](94.md) | 'aes-256-gcm' tag was removed | | 2023-12-03 | [0ba45895](https://github.com/nostr-protocol/nips/commit/0ba45895) | [01](01.md) | WebSocket status code `4000` was replaced by 'CLOSED' message | @@ -46,10 +45,7 @@ reverse chronological order. | 2023-08-21 | [89915e02](https://github.com/nostr-protocol/nips/commit/89915e02) | [11](11.md) | 'min_prefix' was removed | | 2023-08-20 | [37c4375e](https://github.com/nostr-protocol/nips/commit/37c4375e) | [01](01.md) | replaceable events with same timestamp should be retained event with lowest id | | 2023-08-15 | [88ee873c](https://github.com/nostr-protocol/nips/commit/88ee873c) | [15](15.md) | 'countries' tag was renamed to 'regions' | -| 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [12](12.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | -| 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [16](16.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | -| 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [20](20.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | -| 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [33](33.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | +| 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [12](12.md), [16](16.md), [20](20.md), [33](33.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | | 2023-08-11 | [d87f8617](https://github.com/nostr-protocol/nips/commit/d87f8617) | [25](25.md) | empty `content` should be considered as "+" | | 2023-08-01 | [5d63b157](https://github.com/nostr-protocol/nips/commit/5d63b157) | [57](57.md) | 'zap' tag was changed | | 2023-07-15 | [d1814405](https://github.com/nostr-protocol/nips/commit/d1814405) | [01](01.md) | `since` and `until` filters should be `since <= created_at <= until` | From b94ad00ac7da6f4d54f1920c824487410fa904b7 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Mon, 9 Dec 2024 13:29:10 +0900 Subject: [PATCH 20/80] BREAKING.md: add NIP-46 change --- BREAKING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/BREAKING.md b/BREAKING.md index f083ca0e..77900d33 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -5,6 +5,7 @@ reverse chronological order. | Date | Commit | NIP | Change | | ----------- | --------- | -------- | ------ | +| 2024-12-05 | [6d16019e](https://github.com/nostr-protocol/nips/commit/6d16019e) | [46](46.md) | message encryption was changed to NIP-44 | | 2024-11-12 | [2838e3bd](https://github.com/nostr-protocol/nips/commit/2838e3bd) | [29](29.md) | `kind: 12` and `kind: 10` were removed (use `kind: 1111` instead) | | 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [46](46.md) | NIP-05 login was removed | | 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [46](46.md) | `create_account` method was removed | From 624b989f9f3b0c07d338ec42765351c24f2123cf Mon Sep 17 00:00:00 2001 From: Josh Brown Date: Mon, 9 Dec 2024 10:00:04 -0500 Subject: [PATCH 21/80] clarify that Standard lists and Sets are both types of lists with heading level --- 51.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/51.md b/51.md index 4c0b1f47..90b56ce5 100644 --- a/51.md +++ b/51.md @@ -14,7 +14,7 @@ When new items are added to an existing list, clients SHOULD append them to the ## Types of lists -## Standard lists +### Standard lists Standard lists use normal replaceable events, meaning users may only have a single list of each kind. They have special meaning and clients may rely on them to augment a user's profile or browsing experience. @@ -36,7 +36,7 @@ For example, _mute list_ can contain the public keys of spammers and bad actors | Good wiki authors | 10101 | [NIP-54](54.md) user recommended wiki authors | `"p"` (pubkeys) | | Good wiki relays | 10102 | [NIP-54](54.md) relays deemed to only host useful articles | `"relay"` (relay URLs) | -## Sets +### Sets Sets are lists with well-defined meaning that can enhance the functionality and the UI of clients that rely on them. Unlike standard lists, users are expected to have more than one set of each kind, therefore each of them must be assigned a different `"d"` identifier. @@ -56,7 +56,7 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti | Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | | Release artifact sets | 30063 | groups of files of a software release | `"e"` (kind:1063 [file metadata](94.md) events), `"i"` (application identifier, typically reverse domain notation), `"version"` | -## Deprecated standard lists +### Deprecated standard lists Some clients have used these lists in the past, but they should work on transitioning to the [standard formats](#standard-lists) above. From e942427f8fcf316f4ade52838005910a650270af Mon Sep 17 00:00:00 2001 From: Jesus Christ <120573631+Gudnessuche@users.noreply.github.com> Date: Mon, 9 Dec 2024 15:13:59 +0000 Subject: [PATCH 22/80] nip17: specify order (#1637) Order specificity is implied better. --- 17.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/17.md b/17.md index 72f40c47..f091a969 100644 --- a/17.md +++ b/17.md @@ -133,7 +133,7 @@ When sending a message to anyone, clients must then connect to the relays in the This example sends the message `Hola, que tal?` from `nsec1w8udu59ydjvedgs3yv5qccshcj8k05fh3l60k9x57asjrqdpa00qkmr89m` to `nsec12ywtkplvyq5t6twdqwwygavp5lm4fhuang89c943nf2z92eez43szvn4dt`. -The two final GiftWraps, one to the receiver and the other to the sender, are: +The two final GiftWraps, one to the receiver and the other to the sender, respectively, are: ```json { From ed128aef46306dc390b9dfb8efc2e7ea9815d344 Mon Sep 17 00:00:00 2001 From: franzap <_@franzap.com> Date: Tue, 10 Dec 2024 15:02:54 -0300 Subject: [PATCH 23/80] App curation sets, minor fixes to release artifact sets --- 51.md | 32 +++++++++++++++++++++++++------- 1 file changed, 25 insertions(+), 7 deletions(-) diff --git a/51.md b/51.md index 90b56ce5..d762499e 100644 --- a/51.md +++ b/51.md @@ -54,7 +54,8 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti | Kind mute sets | 30007 | mute pubkeys by kinds
`"d"` tag MUST be the kind string | `"p"` (pubkeys) | | Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) | | Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | -| Release artifact sets | 30063 | groups of files of a software release | `"e"` (kind:1063 [file metadata](94.md) events), `"i"` (application identifier, typically reverse domain notation), `"version"` | +| Release artifact sets | 30063 | group of artifacts of a software release | `"e"` (kind:1063 [file metadata](94.md) events), `"a"` (software application event) | +| App curation sets | 30267 | references to multiple software applications | `"a"` (software application event) | ### Deprecated standard lists @@ -117,22 +118,39 @@ Some clients have used these lists in the past, but they should work on transiti "pubkey": "d6dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c", "created_at": 1695327657, "kind": 30063, + "content": "Release notes in markdown", "tags": [ - ["d", "ak8dy3v7"], - ["i", "com.example.app"], - ["version", "0.0.1"], - ["title", "Example App"], - ["image", "http://cdn.site/p/com.example.app/icon.png"], + ["d", "com.example.app@0.0.1"], ["e", "d78ba0d5dce22bfff9db0a9e996c9ef27e2c91051de0c4e1da340e0326b4941e"], // Windows exe ["e", "f27e2c91051de0c4e1da0d5dce22bfff9db0a9340e0326b4941ed78bae996c9e"], // MacOS dmg ["e", "9d24ddfab95ba3ff7c03fbd07ad011fff245abea431fb4d3787c2d04aad02332"], // Linux AppImage - ["e", "340e0326b340e0326b4941ed78ba340e0326b4941ed78ba340e0326b49ed78ba"] // PWA + ["e", "340e0326b340e0326b4941ed78ba340e0326b4941ed78ba340e0326b49ed78ba"], // PWA + ["a", "32267:d6dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:com.example.app"] // Reference to parent software application ], "content": "Example App is a decentralized marketplace for apps", "sig": "a9a4e2192eede77e6c9d24ddfab95ba3ff7c03fbd07ad011fff245abea431fb4d3787c2d04aad001cb039cb8de91d83ce30e9a94f82ac3c5a2372aa1294a96bd" } ``` +### An _app curation set_ + +```jsonc +{ + "id": "d8037fa866eb5acd2159960b3ada7284172f7d687b5289cc72a96ca2b431b611", + "pubkey": "78ce6faa72264387284e647ba6938995735ec8c7d5c5a65737e55130f026307d", + "sig": "c1ce0a04521c020ae7485307cd86285530c1f778766a3fd594d662a73e7c28f307d7cd9a9ab642ae749fce62abbabb3a32facfe8d19a21fba551b60fae863d95", + "kind": 30267, + "created_at": 1729302793, + "content": "My nostr app selection", + "tags": [ + ["d", "nostr"], + ["a", "32267:7579076d9aff0a4cfdefa7e2045f2486c7e5d8bc63bfc6b45397233e1bbfcb19:com.example.app1"], + ["a", "32267:045f2486c7e5d8bc63bfc6b45397233e1bbfcb197579076d9aff0a4cfdefa7e2:net.example.app2"], + ["a", "32267:264387284e647ba6938995735ec8c7d5c5a6f026307d78ce6faa725737e55130:pl.code.app3"] + ] +} +``` + ## Encryption process pseudocode ```scala From a1ca7a194b6d8f249b7437c0082682c2a7c074ab Mon Sep 17 00:00:00 2001 From: Jon Staab Date: Tue, 10 Dec 2024 14:11:43 -0800 Subject: [PATCH 24/80] Change strategy for naming groups --- 29.md | 4 ++-- 51.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/29.md b/29.md index 331047f7..8711cc94 100644 --- a/29.md +++ b/29.md @@ -30,8 +30,6 @@ When encountering just the `` without the `'`, clients MAY infer Events sent by users to groups (chat messages, text notes, moderation events etc) MUST have an `h` tag with the value set to the group _id_. -`h` tags MAY include the group's name as the second argument. This allows `unmanaged` groups to be assigned human-readable names without relay support. - ## Timeline references In order to not be used out of context, events sent to these groups may contain references to previous events seen from the same relay in the `previous` tag. The choice of which previous events to pick belongs to the clients. The references are to be made using the first 8 characters (4 bytes) of any event in the last 50 events seen by the user in the relay, excluding events by themselves. There can be any number of references (including zero), but it's recommended that clients include at least 3 and that relays enforce this. @@ -242,3 +240,5 @@ A definition for `kind:10009` was included in [NIP-51](51.md) that allows client ### Using `unmanaged` relays To prevent event leakage, when using `unmanaged` relays, clients should include the [NIP-70](70.md) `-` tag, as just the `previous` tag won't be checked by other `unmanaged` relays. + +Groups MAY be named without relay support by adding a `name` to the corresponding tag in a user's `kind 10009` group list. diff --git a/51.md b/51.md index 90b56ce5..23d5b999 100644 --- a/51.md +++ b/51.md @@ -29,7 +29,7 @@ For example, _mute list_ can contain the public keys of spammers and bad actors | Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) | | Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) | | Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) | -| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group id + relay URL), `"r"` for each relay in use | +| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group id + relay URL + optional group name), `"r"` for each relay in use | | Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) | | Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | | DM relays | 10050 | Where to receive [NIP-17](17.md) direct messages | `"relay"` (see [NIP-17](17.md)) | From 306be43fabf7a95b3eef9d5363e1c3411055337f Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Thu, 19 Dec 2024 10:16:57 -0500 Subject: [PATCH 25/80] removes new line --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index f203edd5..55de8422 100644 --- a/README.md +++ b/README.md @@ -231,7 +231,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `39000-9` | Group metadata events | [29](29.md) | [NUD: Custom Feeds]: https://wikifreedia.xyz/cip-01/ - [nostrocket]: https://github.com/nostrocket/NIPS/blob/main/Problems.md [lnpub]: https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md [cornychat-slideset]: https://cornychat.com/datatypes#kind30388slideset From 97bf5266d7760094ec55a66fe18d549de385768b Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Fri, 20 Dec 2024 09:11:37 +0900 Subject: [PATCH 26/80] add kind 10013 to list. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 55de8422..e71a13e7 100644 --- a/README.md +++ b/README.md @@ -170,6 +170,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10006` | Blocked relays list | [51](51.md) | | `10007` | Search relays list | [51](51.md) | | `10009` | User groups | [51](51.md), [29](29.md) | +| `10013` | Draft relays | [37](37.md) | | `10015` | Interests list | [51](51.md) | | `10019` | Nutzap Mint Recommendation | [61](61.md) | | `10030` | User emoji list | [51](51.md) | From 7e150faed4ccadfdcdc81265a406c4b6cdd39047 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Sat, 21 Dec 2024 01:34:43 +0900 Subject: [PATCH 27/80] nip44: update some nits. --- 44.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/44.md b/44.md index 8f27fede..a7c13f12 100644 --- a/44.md +++ b/44.md @@ -8,11 +8,11 @@ Encrypted Payloads (Versioned) The NIP introduces a new data format for keypair-based encryption. This NIP is versioned to allow multiple algorithm choices to exist simultaneously. This format may be used for -many things, but MUST be used in the context of a signed event as described in NIP 01. +many things, but MUST be used in the context of a signed event as described in NIP-01. *Note*: this format DOES NOT define any `kind`s related to a new direct messaging standard, only the encryption required to define one. It SHOULD NOT be used as a drop-in replacement -for NIP 04 payloads. +for NIP-04 payloads. ## Versions @@ -41,7 +41,7 @@ On its own, messages sent using this scheme have a number of important shortcomi - No post-compromise security: when a key is compromised, it is possible to decrypt all future conversations - No post-quantum security: a powerful quantum computer would be able to decrypt the messages - IP address leak: user IP may be seen by relays and all intermediaries between user and relay -- Date leak: `created_at` is public, since it is a part of NIP 01 event +- Date leak: `created_at` is public, since it is a part of NIP-01 event - Limited message size leak: padding only partially obscures true message length - No attachments: they are not supported @@ -86,7 +86,7 @@ NIP-44 version 2 has the following design characteristics: - Content must be encoded from UTF-8 into byte array - Validate plaintext length. Minimum is 1 byte, maximum is 65535 bytes - Padding format is: `[plaintext_length: u16][plaintext][zero_bytes]` - - Padding algorithm is related to powers-of-two, with min padded msg size of 32bytes + - Padding algorithm is related to powers-of-two, with min padded msg size of 32 bytes - Plaintext length is encoded in big-endian as first 2 bytes of the padded blob 5. Encrypt padded content - Use ChaCha20, with key and nonce from step 3 @@ -148,8 +148,8 @@ validation rules, refer to BIP-340. - `x[i:j]`, where `x` is a byte array and `i, j <= 0` returns a `(j - i)`-byte array with a copy of the `i`-th byte (inclusive) to the `j`-th byte (exclusive) of `x`. - Constants `c`: - - `min_plaintext_size` is 1. 1bytes msg is padded to 32bytes. - - `max_plaintext_size` is 65535 (64kB - 1). It is padded to 65536bytes. + - `min_plaintext_size` is 1. 1 byte msg is padded to 32 bytes. + - `max_plaintext_size` is 65535 (64kB - 1). It is padded to 65536 bytes. - Functions - `base64_encode(string)` and `base64_decode(bytes)` are Base64 ([RFC 4648](https://datatracker.ietf.org/doc/html/rfc4648), with padding) - `concat` refers to byte array concatenation From 9d4f2b42b4491035472c8b5bc3d185f45c41bb45 Mon Sep 17 00:00:00 2001 From: Taha Date: Sun, 22 Dec 2024 21:11:24 -0500 Subject: [PATCH 28/80] add some missing words to readme (#1656) --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e71a13e7..11d9386a 100644 --- a/README.md +++ b/README.md @@ -344,9 +344,9 @@ Please update these lists when proposing new NIPs. ## Is this repository a centralizing factor? -To promote interoperability, we standards that everybody can follow, and we need them to define a **single way of doing each thing** without ever hurting **backwards-compatibility**, and for that purpose there is no way around getting everybody to agree on the same thing and keep a centralized index of these standards. However the fact that such index exists doesn't hurt the decentralization of Nostr. _At any point the central index can be challenged if it is failing to fulfill the needs of the protocol_ and it can migrate to other places and be maintained by other people. +To promote interoperability, we need standards that everybody can follow, and we need them to define a **single way of doing each thing** without ever hurting **backwards-compatibility**, and for that purpose there is no way around getting everybody to agree on the same thing and keep a centralized index of these standards. However the fact that such an index exists doesn't hurt the decentralization of Nostr. _At any point the central index can be challenged if it is failing to fulfill the needs of the protocol_ and it can migrate to other places and be maintained by other people. -It can even fork into multiple and then some clients would go one way, others would go another way, and some clients would adhere to both competing standards. This would hurt the simplicity, openness and interoperability of Nostr a little, but everything would still work in the short term. +It can even fork into multiple versions, and then some clients would go one way, others would go another way, and some clients would adhere to both competing standards. This would hurt the simplicity, openness and interoperability of Nostr a little, but everything would still work in the short term. There is a list of notable Nostr software developers who have commit access to this repository, but that exists mostly for practical reasons, as by the nature of the thing we're dealing with the repository owner can revoke membership and rewrite history as they want -- and if these actions are unjustified or perceived as bad or evil the community must react. From 71ca3f27f3833c4e240921bf105c4268919158e5 Mon Sep 17 00:00:00 2001 From: Kay Date: Thu, 26 Dec 2024 13:14:28 +0000 Subject: [PATCH 29/80] fix broken link. --- 32.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/32.md b/32.md index a99e52a3..202200af 100644 --- a/32.md +++ b/32.md @@ -157,7 +157,7 @@ considered open for public use, and not proprietary. In other words, if there is namespace that fits your use case, use it even if it points to someone else's domain name. Vocabularies MAY choose to fully qualify all labels within a namespace (for example, -`["l", "com.example.vocabulary:my-label"]`. This may be preferred when defining more +`["l", "com.example.vocabulary:my-label"]`). This may be preferred when defining more formal vocabularies that should not be confused with another namespace when querying without an `L` tag. For these vocabularies, all labels SHOULD include the namespace (rather than mixing qualified and unqualified labels). @@ -173,4 +173,4 @@ Appendix: Known Ontologies Below is a non-exhaustive list of ontologies currently in widespread use. -- [social.ontolo.categories](https://ontolo.social/) +- [social ontology categories](https://github.com/CLARIAH/awesome-humanities-ontologies) From 9acad1c62c21c53b727e7025e0627c3c2d31e0fa Mon Sep 17 00:00:00 2001 From: Kay Date: Thu, 26 Dec 2024 14:08:13 +0000 Subject: [PATCH 30/80] fix nip-46 and nip-47 names are changed. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 11d9386a..c9f43a2b 100644 --- a/README.md +++ b/README.md @@ -61,8 +61,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-42: Authentication of clients to relays](42.md) - [NIP-44: Versioned Encryption](44.md) - [NIP-45: Counting results](45.md) -- [NIP-46: Nostr Connect](46.md) -- [NIP-47: Wallet Connect](47.md) +- [NIP-46: Nostr Remote Signing](46.md) +- [NIP-47: Nostr Wallet Connect](47.md) - [NIP-48: Proxy Tags](48.md) - [NIP-49: Private Key Encryption](49.md) - [NIP-50: Search Capability](50.md) From e3911cc9e6078b90db52d61685f0742eda5a3cef Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Fri, 27 Dec 2024 06:52:15 +0900 Subject: [PATCH 31/80] rename NIP-44 in readme. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c9f43a2b..f6225580 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-39: External Identities in Profiles](39.md) - [NIP-40: Expiration Timestamp](40.md) - [NIP-42: Authentication of clients to relays](42.md) -- [NIP-44: Versioned Encryption](44.md) +- [NIP-44: Encrypted Payloads (Versioned)](44.md) - [NIP-45: Counting results](45.md) - [NIP-46: Nostr Remote Signing](46.md) - [NIP-47: Nostr Wallet Connect](47.md) From b88f716eef4feaf1d123562bf61bdb2aa47e6ac1 Mon Sep 17 00:00:00 2001 From: Kay Date: Thu, 26 Dec 2024 22:13:22 +0000 Subject: [PATCH 32/80] fix typo in nip-94. --- 94.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/94.md b/94.md index 021cc4c3..4cd7c826 100644 --- a/94.md +++ b/94.md @@ -10,7 +10,7 @@ The purpose of this NIP is to allow an organization and classification of shared ## Event format -This NIP specifies the use of the `1063` event type, having in `content` a description of the file content, and a list of tags described below: +This NIP specifies the use of the `1063` event kind, having in `content` a description of the file content, and a list of tags described below: * `url` the url to download the file * `m` a string indicating the data type of the file. The [MIME types](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) format must be used, and they should be lowercase. From 7622cdc9c07d9a99e4bd3e8bb6cf8c15cb7f56c5 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Sat, 28 Dec 2024 10:50:31 +0000 Subject: [PATCH 33/80] adds P and p tags --- 22.md | 33 ++++++++++++++++++++++++--------- 1 file changed, 24 insertions(+), 9 deletions(-) diff --git a/22.md b/22.md index f11925fa..905e0b43 100644 --- a/22.md +++ b/22.md @@ -13,6 +13,9 @@ It uses `kind:1111` with plaintext `.content` (no HTML, Markdown, or other forma Comments MUST point to the root scope using uppercase tag names (e.g. `K`, `E`, `A` or `I`) and MUST point to the parent item with lowercase ones (e.g. `k`, `e`, `a` or `i`). +Comments MUST point to the authors when one is available (i.e. tagging a nostr event). `P` for the root scope +and `p` for the author of the parent item. + ```jsonc { kind: 1111, @@ -23,10 +26,16 @@ and MUST point to the parent item with lowercase ones (e.g. `k`, `e`, `a` or `i` // the root item kind ["K", ""], + // pubkey of the author of the root scope event + ["P", "", "relay-url-hint"], + // parent item: event addresses, event ids, or i-tags. ["", "", "", ""], // parent item kind - ["k", ""] + ["k", ""], + + // parent item pubkey + ["p", "", "relay-url-hint"] ] // other fields } @@ -46,11 +55,6 @@ Their uppercase versions use the same type of values but relate to the root item ``` `p` tags SHOULD be used when mentioning pubkeys in the `.content` with [NIP-21](21.md). -If the parent item is an event, a `p` tag set to the parent event's author SHOULD be added. - -```json -["p", "", ""] -``` ## Examples @@ -65,13 +69,17 @@ A comment on a blog post looks like this: ["A", "30023:3c9849383bdea883b0bd16fece1ed36d37e37cdde3ce43b17ea4e9192ec11289:f9347ca7", "wss://example.relay"], // the root kind ["K", "30023"], + // author of root event + ["P", "3c9849383bdea883b0bd16fece1ed36d37e37cdde3ce43b17ea4e9192ec11289", "wss://example.relay"] // the parent event address (same as root for top-level comments) ["a", "30023:3c9849383bdea883b0bd16fece1ed36d37e37cdde3ce43b17ea4e9192ec11289:f9347ca7", "wss://example.relay"], // when the parent event is replaceable or addressable, also include an `e` tag referencing its id ["e", "5b4fc7fed15672fefe65d2426f67197b71ccc82aa0cc8a9e94f683eb78e07651", "wss://example.relay"], // the parent event kind - ["k", "30023"] + ["k", "30023"], + // author of the parent event + ["p", "3c9849383bdea883b0bd16fece1ed36d37e37cdde3ce43b17ea4e9192ec11289", "wss://example.relay"] ] // other fields } @@ -88,11 +96,14 @@ A comment on a [NIP-94](94.md) file looks like this: ["E", "768ac8720cdeb59227cf95e98b66560ef03d8bc9a90d721779e76e68fb42f5e6", "wss://example.relay", "3721e07b079525289877c366ccab47112bdff3d1b44758ca333feb2dbbbbe5bb"], // the root kind ["K", "1063"], + // author of the root event + ["P", "3721e07b079525289877c366ccab47112bdff3d1b44758ca333feb2dbbbbe5bb"], // the parent event id (same as root for top-level comments) ["e", "768ac8720cdeb59227cf95e98b66560ef03d8bc9a90d721779e76e68fb42f5e6", "wss://example.relay", "3721e07b079525289877c366ccab47112bdff3d1b44758ca333feb2dbbbbe5bb"], // the parent kind - ["k", "1063"] + ["k", "1063"], + ["p", "3721e07b079525289877c366ccab47112bdff3d1b44758ca333feb2dbbbbe5bb"] ] // other fields } @@ -109,11 +120,13 @@ A reply to a comment looks like this: ["E", "768ac8720cdeb59227cf95e98b66560ef03d8bc9a90d721779e76e68fb42f5e6", "wss://example.relay", "fd913cd6fa9edb8405750cd02a8bbe16e158b8676c0e69fdc27436cc4a54cc9a"], // the root kind ["K", "1063"], + ["P", "fd913cd6fa9edb8405750cd02a8bbe16e158b8676c0e69fdc27436cc4a54cc9a"], // the parent event ["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://example.relay", "93ef2ebaaf9554661f33e79949007900bbc535d239a4c801c33a4d67d3e7f546"], // the parent kind - ["k", "1111"] + ["k", "1111"], + ["p", "93ef2ebaaf9554661f33e79949007900bbc535d239a4c801c33a4d67d3e7f546"] ] // other fields } @@ -178,7 +191,9 @@ A reply to a podcast comment: ["e", "80c48d992a38f9c445b943a9c9f1010b396676013443765750431a9004bdac05", "wss://example.relay", "252f10c83610ebca1a059c0bae8255eba2f95be4d1d7bcfa89d7248a82d9f111"], // the parent comment kind ["k", "1111"] + ["p", "252f10c83610ebca1a059c0bae8255eba2f95be4d1d7bcfa89d7248a82d9f111"] ] // other fields } ``` + From cd09e6c9d8f5eadd33486aee7f7b4fb56791e4b6 Mon Sep 17 00:00:00 2001 From: jdabs <6774432+jdabs@users.noreply.github.com> Date: Wed, 1 Jan 2025 11:09:21 -0500 Subject: [PATCH 34/80] Grammar updates to 47.md Minor grammatical edits for clarity. - "It's" to "its" to show the possessive case intended instead of the contraction - Correct article from "an" to "a" for the following d letter (consonant sound) - Minor edit to fix comma splices with a semicolon ( ; ) to clarify two independent thoughts. Somewhat optional, but it clarifies the two long sentences. Period can instead be used instead as a new sentence. --- 47.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/47.md b/47.md index d1030a47..932c2632 100644 --- a/47.md +++ b/47.md @@ -107,7 +107,7 @@ The content of notifications is encrypted with [NIP04](https://github.com/nostr- ## Nostr Wallet Connect URI **client** discovers **wallet service** by scanning a QR code, handling a deeplink or pasting in a URI. -The **wallet service** generates this connection URI with protocol `nostr+walletconnect://` and base path it's hex-encoded `pubkey` with the following query string parameters: +The **wallet service** generates this connection URI with protocol `nostr+walletconnect://` and base path its hex-encoded `pubkey` with the following query string parameters: - `relay` Required. URL of the relay where the **wallet service** is connected and will be listening for events. May be more than one. - `secret` Required. 32-byte randomly generated hex encoded string. The **client** MUST use this to sign events and encrypt payloads when communicating with the **wallet service**. @@ -175,7 +175,7 @@ Request: Response: For every invoice in the request, a separate response event is sent. To differentiate between the responses, each -response event contains a `d` tag with the id of the invoice it is responding to, if no id was given, then the +response event contains a `d` tag with the id of the invoice it is responding to; if no id was given, then the payment hash of the invoice should be used. ```jsonc @@ -247,7 +247,7 @@ Request: Response: For every keysend in the request, a separate response event is sent. To differentiate between the responses, each -response event contains an `d` tag with the id of the keysend it is responding to, if no id was given, then the +response event contains a `d` tag with the id of the keysend it is responding to; if no id was given, then the pubkey should be used. ```jsonc From 936befbf9bcc1ec710497673339a2877192c67a2 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Thu, 2 Jan 2025 23:53:33 +0900 Subject: [PATCH 35/80] add NIP-22 link to `P` and `p` tags. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f6225580..251340da 100644 --- a/README.md +++ b/README.md @@ -285,8 +285,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `l` | label, label namespace | -- | [32](32.md) | | `L` | label namespace | -- | [32](32.md) | | `m` | MIME type | -- | [94](94.md) | -| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md) | -| `P` | pubkey (hex) | -- | [57](57.md) | +| `p` | pubkey (hex) | relay URL, petname | [01](01.md), [02](02.md), [22](22.md) | +| `P` | pubkey (hex) | -- | [22](22.md), [57](57.md) | | `q` | event id (hex) | relay URL, pubkey (hex) | [18](18.md) | | `r` | a reference (URL, etc) | -- | [24](24.md), [25](25.md) | | `r` | relay url | marker | [65](65.md) | From 2561566af79e6cd6dd82c4980a711847f27dba3f Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Wed, 8 Jan 2025 20:28:46 +0900 Subject: [PATCH 36/80] nip51: format tables. --- 51.md | 54 +++++++++++++++++++++++++++--------------------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/51.md b/51.md index de06f01a..d1c62708 100644 --- a/51.md +++ b/51.md @@ -20,21 +20,21 @@ Standard lists use normal replaceable events, meaning users may only have a sing For example, _mute list_ can contain the public keys of spammers and bad actors users don't want to see in their feeds or receive annoying notifications from. -| name | kind | description | expected tag items | -| --- | --- | --- | --- | -| Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags), `"word"` (lowercase string), `"e"` (threads) | -| Pinned notes | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | -| Bookmarks | 10003 | uncategorized, "global" list of things a user wants to save | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) | -| Communities | 10004 | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) | -| Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) | -| Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) | -| Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) | -| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group id + relay URL + optional group name), `"r"` for each relay in use | -| Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) | -| Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | -| DM relays | 10050 | Where to receive [NIP-17](17.md) direct messages | `"relay"` (see [NIP-17](17.md)) | -| Good wiki authors | 10101 | [NIP-54](54.md) user recommended wiki authors | `"p"` (pubkeys) | -| Good wiki relays | 10102 | [NIP-54](54.md) relays deemed to only host useful articles | `"relay"` (relay URLs) | +| name | kind | description | expected tag items | +| --- | --- | --- | --- | +| Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags), `"word"` (lowercase string), `"e"` (threads) | +| Pinned notes | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | +| Bookmarks | 10003 | uncategorized, "global" list of things a user wants to save | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) | +| Communities | 10004 | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) | +| Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 channel definitions) | +| Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) | +| Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) | +| Simple groups | 10009 | [NIP-29](29.md) groups the user is in | `"group"` ([NIP-29](29.md) group id + relay URL + optional group name), `"r"` for each relay in use | +| Interests | 10015 | topics a user may be interested in and pointers | `"t"` (hashtags) and `"a"` (kind:30015 interest set) | +| Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | +| DM relays | 10050 | Where to receive [NIP-17](17.md) direct messages | `"relay"` (see [NIP-17](17.md)) | +| Good wiki authors | 10101 | [NIP-54](54.md) user recommended wiki authors | `"p"` (pubkeys) | +| Good wiki relays | 10102 | [NIP-54](54.md) relays deemed to only host useful articles | `"relay"` (relay URLs) | ### Sets @@ -44,18 +44,18 @@ For example, _relay sets_ can be displayed in a dropdown UI to give users the op Aside from their main identifier, the `"d"` tag, sets can optionally have a `"title"`, an `"image"` and a `"description"` tags that can be used to enhance their UI. -| name | kind | description | expected tag items | -| --- | --- | --- | --- | -| Follow sets | 30000 | categorized groups of users a client may choose to check out in different circumstances | `"p"` (pubkeys) | -| Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during various operations | `"relay"` (relay URLs) | -| Bookmark sets | 30003 | user-defined bookmarks categories , for when bookmarks must be in labeled separate groups | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) | -| Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) | -| Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"a"` (kind:34235 videos) | -| Kind mute sets | 30007 | mute pubkeys by kinds
`"d"` tag MUST be the kind string | `"p"` (pubkeys) | -| Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) | -| Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | -| Release artifact sets | 30063 | group of artifacts of a software release | `"e"` (kind:1063 [file metadata](94.md) events), `"a"` (software application event) | -| App curation sets | 30267 | references to multiple software applications | `"a"` (software application event) | +| name | kind | description | expected tag items | +| --- | --- | --- | --- | +| Follow sets | 30000 | categorized groups of users a client may choose to check out in different circumstances | `"p"` (pubkeys) | +| Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during various operations | `"relay"` (relay URLs) | +| Bookmark sets | 30003 | user-defined bookmarks categories , for when bookmarks must be in labeled separate groups | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) | +| Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) | +| Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"a"` (kind:34235 videos) | +| Kind mute sets | 30007 | mute pubkeys by kinds
`"d"` tag MUST be the kind string | `"p"` (pubkeys) | +| Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) | +| Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | +| Release artifact sets | 30063 | group of artifacts of a software release | `"e"` (kind:1063 [file metadata](94.md) events), `"a"` (software application event) | +| App curation sets | 30267 | references to multiple software applications | `"a"` (software application event) | ### Deprecated standard lists From 1f8bbbfb50150644c0bb56229394aca95310f7a8 Mon Sep 17 00:00:00 2001 From: pablof7z Date: Fri, 10 Jan 2025 08:27:14 -0600 Subject: [PATCH 37/80] specify magic-wanded protected events should not be stringified in a repost --- 18.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/18.md b/18.md index 41c94424..7a8f810a 100644 --- a/18.md +++ b/18.md @@ -10,6 +10,7 @@ A repost is a `kind 6` event that is used to signal to followers that a `kind 1` text note is worth reading. The `content` of a repost event is _the stringified JSON of the reposted note_. It MAY also be empty, but that is not recommended. +[NIP-70](70.md)-protected events SHOULD always have an empty `content`. The repost event MUST include an `e` tag with the `id` of the note that is being reposted. That tag MUST include a relay URL as its third entry @@ -41,3 +42,4 @@ as a "generic repost", that can include any kind of event inside other than `kind 16` reposts SHOULD contain a `k` tag with the stringified kind number of the reposted event as its value. + From 76fd221ff1da383546f624615a38b6f961033b37 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Fri, 10 Jan 2025 23:39:08 +0900 Subject: [PATCH 38/80] add kind 30267 to list. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 251340da..3b36f0bb 100644 --- a/README.md +++ b/README.md @@ -206,6 +206,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `30041` | Modular Article Content | [NKBIP-01] | | `30063` | Release artifact sets | [51](51.md) | | `30078` | Application-specific Data | [78](78.md) | +| `30267` | App curation sets | [51](51.md) | | `30311` | Live Event | [53](53.md) | | `30315` | User Statuses | [38](38.md) | | `30388` | Slide Set | [Corny Chat][cornychat-slideset] | From d96f6f852a080fd84251af6b6d6fb82313b199a8 Mon Sep 17 00:00:00 2001 From: Pablo Fernandez Date: Mon, 13 Jan 2025 14:35:10 +0000 Subject: [PATCH 39/80] Update 18.md Co-authored-by: hodlbod --- 18.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/18.md b/18.md index 7a8f810a..5d55f84c 100644 --- a/18.md +++ b/18.md @@ -10,7 +10,7 @@ A repost is a `kind 6` event that is used to signal to followers that a `kind 1` text note is worth reading. The `content` of a repost event is _the stringified JSON of the reposted note_. It MAY also be empty, but that is not recommended. -[NIP-70](70.md)-protected events SHOULD always have an empty `content`. +Reposts of [NIP-70](70.md)-protected events SHOULD always have an empty `content`. The repost event MUST include an `e` tag with the `id` of the note that is being reposted. That tag MUST include a relay URL as its third entry From 5b6ca881e24d5a6e089d3c577c6c7cab98bbb19d Mon Sep 17 00:00:00 2001 From: "T.Shinohara" Date: Mon, 13 Jan 2025 23:37:53 +0900 Subject: [PATCH 40/80] add t-tags in kind 41 (#1673) --- 28.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/28.md b/28.md index 73c76b2b..6b240ef3 100644 --- a/28.md +++ b/28.md @@ -52,10 +52,17 @@ Clients MAY add additional metadata fields. Clients SHOULD use [NIP-10](10.md) marked "e" tags to recommend a relay. +It is also possible to set the category name using the "t" tag. This category name can be searched and filtered. + ```jsonc { "content": "{\"name\": \"Updated Demo Channel\", \"about\": \"Updating a test channel.\", \"picture\": \"https://placekitten.com/201/201\", \"relays\": [\"wss://nos.lol\", \"wss://nostr.mom\"]}", - "tags": [["e", , ]], + "tags": [ + ["e", , , "root"], + ["t", ], + ["t", ], + ["t", ], + ], // other fields... } ``` From 0e3d1cd5d82754d0eb69ddb847f6532b4dade3be Mon Sep 17 00:00:00 2001 From: Vitor Pamplona Date: Mon, 13 Jan 2025 12:04:46 -0500 Subject: [PATCH 41/80] Moves Kind:1 definition to NIP-10 (#1076) Co-authored-by: Michael J <37635304+buttercat1791@users.noreply.github.com> --- 01.md | 5 +++-- 10.md | 16 ++++++++++++---- README.md | 2 +- 3 files changed, 16 insertions(+), 7 deletions(-) diff --git a/01.md b/01.md index d62f3177..e515d811 100644 --- a/01.md +++ b/01.md @@ -85,10 +85,11 @@ As a convention, all single-letter (only english alphabet letters: a-z, A-Z) key ### Kinds -Kinds specify how clients should interpret the meaning of each event and the other fields of each event (e.g. an `"r"` tag may have a meaning in an event of kind 1 and an entirely different meaning in an event of kind 10002). Each NIP may define the meaning of a set of kinds that weren't defined elsewhere. This NIP defines two basic kinds: +Kinds specify how clients should interpret the meaning of each event and the other fields of each event (e.g. an `"r"` tag may have a meaning in an event of kind 1 and an entirely different meaning in an event of kind 10002). Each NIP may define the meaning of a set of kinds that weren't defined elsewhere. [NIP-10](10.md), for instance, especifies the `kind:1` text note for social media applications. + +This NIP defines one basic kind: - `0`: **user metadata**: the `content` is set to a stringified JSON object `{name: , about: , picture: }` describing the user who created the event. [Extra metadata fields](24.md#kind-0) may be set. A relay may delete older events once it gets a new one for the same pubkey. -- `1`: **text note**: the `content` is set to the **plaintext** content of a note (anything the user wants to say). Content that must be parsed, such as Markdown and HTML, should not be used. Clients should also not parse content as those. And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: diff --git a/10.md b/10.md index c1d50687..064e56a0 100644 --- a/10.md +++ b/10.md @@ -1,14 +1,22 @@ NIP-10 ====== - -On "e" and "p" tags in Text Events (kind 1) -------------------------------------------- +Text Notes and Threads +---------------------- `draft` `optional` +This NIP defines `kind:1` as a simple plaintext note. + ## Abstract -This NIP describes how to use "e" and "p" tags in text events, especially those that are replies to other text events. It helps clients thread the replies into a tree rooted at the original event. + +This NIP describes how to use "e" and "p" tags in text events, especially those that are replies to other text events. It helps clients thread the replies into a tree rooted at the original event. + +The `.content` property contains some human-readable text. + +`e` and `p` tags can be used to define note threads, replies and mentions. + +Markup languages such as markdown and HTML SHOULD NOT be used. ## Marked "e" tags (PREFERRED) `["e", , , , ]` diff --git a/README.md b/README.md index 3b36f0bb..ed8336cb 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-07: `window.nostr` capability for web browsers](07.md) - [NIP-08: Handling Mentions](08.md) --- **unrecommended**: deprecated in favor of [NIP-27](27.md) - [NIP-09: Event Deletion Request](09.md) -- [NIP-10: Conventions for clients' use of `e` and `p` tags in text events](10.md) +- [NIP-10: Text Notes and Threads](10.md) - [NIP-11: Relay Information Document](11.md) - [NIP-13: Proof of Work](13.md) - [NIP-14: Subject tag in text events](14.md) From 6c62751e573337cbe6276613a268fd4984751c74 Mon Sep 17 00:00:00 2001 From: hodlbod Date: Mon, 13 Jan 2025 11:24:04 -0800 Subject: [PATCH 42/80] Warn against using 1111 to reply to kind 1 (#1680) Co-authored-by: Jon Staab --- 22.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/22.md b/22.md index 905e0b43..2ad1fd81 100644 --- a/22.md +++ b/22.md @@ -56,6 +56,8 @@ Their uppercase versions use the same type of values but relate to the root item `p` tags SHOULD be used when mentioning pubkeys in the `.content` with [NIP-21](21.md). +Comments MUST NOT be used to reply to kind 1 notes. [NIP-10](10.md) should instead be followed. + ## Examples A comment on a blog post looks like this: From 512caf7fcd4145b99ff2f5fea023c625bc38332e Mon Sep 17 00:00:00 2001 From: "P. Reis" Date: Mon, 13 Jan 2025 20:42:58 -0300 Subject: [PATCH 43/80] NIP-61: fix unfinished sentence (#1683) --- 61.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/61.md b/61.md index 33442a3b..8246203e 100644 --- a/61.md +++ b/61.md @@ -70,7 +70,7 @@ WIP: Clients SHOULD embed a DLEQ proof in the nutzap event to make it possible t * The sender fetches the recipient's `kind:10019`. * The sender mints/swaps ecash on one of the recipient's listed mints. -* The sender p2pk locks to the recipient's specified pubkey in their +* The sender p2pk locks to the recipient's specified pubkey in their `kind:10019` # Receiving nutzaps @@ -129,4 +129,4 @@ For this scenarios clients can: * add a `pubkey` tag to the `kind:10019` (indicating which pubkey senders should P2PK to) * store the private key in the `kind:37375` event in the nip44-encrypted `content` field. -This is to avoid depending on NIP-07/46 adaptations to sign cashu payloads. \ No newline at end of file +This is to avoid depending on NIP-07/46 adaptations to sign cashu payloads. From 0782ebe0bcd31b6f7ad860fb85788a62b4c83c20 Mon Sep 17 00:00:00 2001 From: abhay-raizada Date: Tue, 14 Jan 2025 05:55:30 +0530 Subject: [PATCH 44/80] Reinstate NIP-88: Polls on Nostr (#1507) --- 88.md | 130 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 3 ++ 2 files changed, 133 insertions(+) create mode 100644 88.md diff --git a/88.md b/88.md new file mode 100644 index 00000000..08f5c41d --- /dev/null +++ b/88.md @@ -0,0 +1,130 @@ +# NIP-88 + +## Polls + +`draft` `optional` + +This NIP defines the event scheme that describe Polls on nostr. + +## Events + +### Poll Event + +The poll event is defined as a `kind:1068` event. + +- **content** key holds the label for the poll. + +Major tags in the poll event are: + +- **option**: The option tags contain an OptionId(any alphanumeric) field, followed by an option label field. +- **relay**: One or multiple tags that the poll is expecting respondents to respond on. +- **polltype**: can be "singlechoice" or "multiplechoice". Polls that do not have a polltype should be considered a "singlechoice" poll. +- **endsAt**: signifying at which unix timestamp the poll is meant to end. + +Example Event + +```json +{ + "content": "Pineapple on pizza", + "created_at": 1719888496, + "id": "9d1b6b9562e66f2ecf35eb0a3c2decc736c47fddb13d6fb8f87185a153ea3634", + "kind": 1068, + "pubkey": "dee45a23c4f1d93f3a2043650c5081e4ac14a778e0acbef03de3768e4f81ac7b", + "sig": "7fa93bf3c430eaef784b0dacc217d3cd5eff1c520e7ef5d961381bc0f014dde6286618048d924808e54d1be03f2f2c2f0f8b5c9c2082a4480caf45a565ca9797", + "tags": [ + ["option", "qj518h583", "Yay"], + ["option", "gga6cdnqj", "Nay"], + ["relay", ""], + ["relay", ""], + ["polltype", "singlechoice"], + ["endsAt", ""] + ] +} +``` + +### Responses + +The response event is a `kind:1018` event. It contains an e tag with the poll event it is referencing, followed by one or more response tags. + +- **response** : The tag contains "response" as it's first positional argument followed by the option Id selected. + +The responses are meant to be published to the relays specified in the poll event. + +Example Response Event + +```json +{ + "content": "", + "created_at": 1720097117, + "id": "60a005e32e9596c3f544a841a9bc4e46d3020ca3650d6a739c95c1568e33f6d8", + "kind": 1018, + "pubkey": "1bc70a0148b3f316da33fe7e89f23e3e71ac4ff998027ec712b905cd24f6a411", + "sig": "30071a633c65db8f3a075c7a8de757fbd8ce65e3607f4ba287fe6d7fbf839a380f94ff4e826fbba593f6faaa13683b7ea9114ade140720ecf4927010ebf3e44f", + "tags": [ + ["e", "1fc80cf813f1af33d5a435862b7ef7fb96b47e68a48f1abcadf8081f5a545550"], + ["response", "gga6cdnqj"], + ["response", "m3agjsdq1"] + ] +} +``` + +### Poll Types + +The polltype setting dictates how multiple response tags are handled in the `kind:1018` event. + +- **polltype: singlechoice**: The first response tag is to be considered the actual response. +- **polltype: multiplechoice**: The first response tag pointing to each id is considered the actual response, without considering the order of the response tags. + +### Counting Results + +Results can be queried by fetching `kind:1018` events from the relays specified in the poll. +The results displayed should only be 1 vote event per pubkey. +In case of multiple events for a pubkey, the event with the largest timestamp within the poll limits should be considered. + +Example for querying polls. + +```ts +const fetchVoteEvents = (filterPubkeys: string[]) => { + let resultFilter: Filter = { + "#e": [pollEvent.id], + kinds: [1018], + }; + if (filterPubkeys?.length) { + resultFilter.authors = filterPubkeys; + } + if (pollExpiration) { + resultFilter.until = Number(pollExpiration); + } + pool.subscribeMany(relays, [resultFilter], { + onevent: handleResultEvent, + }); +}; +``` + +Example for maintaining OneVotePerPubkey + +```ts +const oneVotePerPubkey = (events: Event[]) => { + const eventMap = new Map(); + + events.forEach((event) => { + if ( + !eventMap.has(event.pubkey) || + event.created_at > eventMap.get(event.pubkey)!.created_at + ) { + eventMap.set(event.pubkey, event); + } + }); + + return Array.from(eventMap.values()); +}; +``` + +### Relays + +It is advisable for poll authors to use relays that do not allow backdated events and do not honor kind:5 (delete) requests for vote events in order to maintain the integrity of poll results after the poll has ended. + +### Curation + +The clients may configure fetching results by specific people. This can be achieved by creating `kind:30000` follow sets, and fetching results only from the follow set. +Clients can also employ other curation algorithms, like Proof Of Work and Web of Trust scores for result curations. diff --git a/README.md b/README.md index ed8336cb..91d3c67f 100644 --- a/README.md +++ b/README.md @@ -89,6 +89,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos - [NIP-78: Application-specific data](78.md) - [NIP-84: Highlights](84.md) - [NIP-86: Relay Management API](86.md) +- [NIP-88: Polls](88.md) - [NIP-89: Recommended Application Handlers](89.md) - [NIP-90: Data Vending Machines](90.md) - [NIP-92: Media Attachments](92.md) @@ -128,11 +129,13 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `44` | Channel Mute User | [28](28.md) | | `64` | Chess (PGN) | [64](64.md) | | `818` | Merge Requests | [54](54.md) | +| `1018` | Poll Response | [88](88.md) | | `1021` | Bid | [15](15.md) | | `1022` | Bid confirmation | [15](15.md) | | `1040` | OpenTimestamps | [03](03.md) | | `1059` | Gift Wrap | [59](59.md) | | `1063` | File Metadata | [94](94.md) | +| `1068` | Poll | [88](88.md) | | `1111` | Comment | [22](22.md) | | `1311` | Live Chat Message | [53](53.md) | | `1617` | Patches | [34](34.md) | From 190122fd8d36e35c0242dedcc89f622ad8c99e67 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Tue, 14 Jan 2025 23:13:39 +0900 Subject: [PATCH 45/80] update kind 1 link. (#1686) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 91d3c67f..56fa597d 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | kind | description | NIP | | ------------- | ------------------------------- | -------------------------------------- | | `0` | User Metadata | [01](01.md) | -| `1` | Short Text Note | [01](01.md) | +| `1` | Short Text Note | [10](10.md) | | `2` | Recommend Relay | 01 (deprecated) | | `3` | Follows | [02](02.md) | | `4` | Encrypted Direct Messages | [04](04.md) | From 3f11c00fb93f118f207130344032710e34de4710 Mon Sep 17 00:00:00 2001 From: Dan Gershony Date: Tue, 14 Jan 2025 19:56:13 +0200 Subject: [PATCH 46/80] Update nip 59 typo (#1687) --- 59.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/59.md b/59.md index 9bb5845b..ddeb83cb 100644 --- a/59.md +++ b/59.md @@ -53,7 +53,7 @@ without the receiver's or the sender's private key. The only public information } ``` -Tags MUST must always be empty in a `kind:13`. The inner event MUST always be unsigned. +Tags MUST always be empty in a `kind:13`. The inner event MUST always be unsigned. ## 3. Gift Wrap Event Kind From cc3fbab1533d72b9a6f3fbaaac6f33bf8c0d5901 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Sat, 18 Jan 2025 09:27:06 +0900 Subject: [PATCH 47/80] fix "PRE" to "addressable event". (#1697) --- 60.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/60.md b/60.md index 64cd282a..b2b0dd45 100644 --- a/60.md +++ b/60.md @@ -54,7 +54,7 @@ Tags: Any tag, other than the `d` tag, can be [[NIP-44]] encrypted into the `.content` field. ### Deleting a wallet event -Due to PRE being hard to delete, if a user wants to delete a wallet, they should empty the event and keep just the `d` identifier and add a `deleted` tag. +Due to addressable event being hard to delete, if a user wants to delete a wallet, they should empty the event and keep just the `d` identifier and add a `deleted` tag. ## Token Event Token events are used to record the unspent proofs that come from the mint. From 1b521d019ae19373f8c663f99fc95407cac35714 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Thu, 23 Jan 2025 21:39:23 +0900 Subject: [PATCH 48/80] BREAKING.md: single quote -> back quote. --- BREAKING.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/BREAKING.md b/BREAKING.md index 77900d33..66f1a9f6 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -21,37 +21,37 @@ reverse chronological order. | 2024-07-23 | [0227a2cd](https://github.com/nostr-protocol/nips/commit/0227a2cd) | [01](01.md) | events should be sorted by id after created_at | | 2024-06-06 | [58e94b20](https://github.com/nostr-protocol/nips/commit/58e94b20) | [25](25.md) | [8073c848](https://github.com/nostr-protocol/nips/commit/8073c848) was reverted | | 2024-06-06 | [a6dfc7b5](https://github.com/nostr-protocol/nips/commit/a6dfc7b5) | [55](55.md) | NIP number was changed | -| 2024-05-25 | [5d1d1c17](https://github.com/nostr-protocol/nips/commit/5d1d1c17) | [71](71.md) | 'aes-256-gcm' tag was removed | +| 2024-05-25 | [5d1d1c17](https://github.com/nostr-protocol/nips/commit/5d1d1c17) | [71](71.md) | `aes-256-gcm` tag was removed | | 2024-05-07 | [8073c848](https://github.com/nostr-protocol/nips/commit/8073c848) | [25](25.md) | e-tags were changed to not include entire thread | -| 2024-04-30 | [bad88262](https://github.com/nostr-protocol/nips/commit/bad88262) | [34](34.md) | 'earliest-unique-commit' tag was removed (use 'r' tag instead) | +| 2024-04-30 | [bad88262](https://github.com/nostr-protocol/nips/commit/bad88262) | [34](34.md) | `earliest-unique-commit` tag was removed (use `r` tag instead) | | 2024-02-25 | [4a171cb0](https://github.com/nostr-protocol/nips/commit/4a171cb0) | [18](18.md) | quote repost should use `q` tag | | 2024-02-21 | [c6cd655c](https://github.com/nostr-protocol/nips/commit/c6cd655c) | [46](46.md) | Params were stringified | | 2024-02-16 | [cbec02ab](https://github.com/nostr-protocol/nips/commit/cbec02ab) | [49](49.md) | Password first normalized to NFKC | | 2024-02-15 | [afbb8dd0](https://github.com/nostr-protocol/nips/commit/afbb8dd0) | [39](39.md) | PGP identity was removed | | 2024-02-07 | [d3dad114](https://github.com/nostr-protocol/nips/commit/d3dad114) | [46](46.md) | Connection token format was changed | -| 2024-01-30 | [1a2b21b6](https://github.com/nostr-protocol/nips/commit/1a2b21b6) | [59](59.md) | 'p' tag became optional | +| 2024-01-30 | [1a2b21b6](https://github.com/nostr-protocol/nips/commit/1a2b21b6) | [59](59.md) | `p` tag became optional | | 2023-01-27 | [c2f34817](https://github.com/nostr-protocol/nips/commit/c2f34817) | [47](47.md) | optional expiration tag should be honored | | 2024-01-10 | [3d8652ea](https://github.com/nostr-protocol/nips/commit/3d8652ea) | [02](02.md), [51](51.md) | list entries should be chronological | -| 2023-12-30 | [29869821](https://github.com/nostr-protocol/nips/commit/29869821) | [52](52.md) | 'name' tag was removed (use 'title' tag instead) | -| 2023-12-27 | [17c67ef5](https://github.com/nostr-protocol/nips/commit/17c67ef5) | [94](94.md) | 'aes-256-gcm' tag was removed | -| 2023-12-03 | [0ba45895](https://github.com/nostr-protocol/nips/commit/0ba45895) | [01](01.md) | WebSocket status code `4000` was replaced by 'CLOSED' message | -| 2023-11-28 | [6de35f9e](https://github.com/nostr-protocol/nips/commit/6de35f9e) | [89](89.md) | 'client' tag value was changed | +| 2023-12-30 | [29869821](https://github.com/nostr-protocol/nips/commit/29869821) | [52](52.md) | `name` tag was removed (use `title` tag instead) | +| 2023-12-27 | [17c67ef5](https://github.com/nostr-protocol/nips/commit/17c67ef5) | [94](94.md) | `aes-256-gcm` tag was removed | +| 2023-12-03 | [0ba45895](https://github.com/nostr-protocol/nips/commit/0ba45895) | [01](01.md) | WebSocket status code `4000` was replaced by `CLOSED` message | +| 2023-11-28 | [6de35f9e](https://github.com/nostr-protocol/nips/commit/6de35f9e) | [89](89.md) | `client` tag value was changed | | 2023-11-20 | [7822a8b1](https://github.com/nostr-protocol/nips/commit/7822a8b1) | [51](51.md) | `kind: 30001` was deprecated | | 2023-11-20 | [7822a8b1](https://github.com/nostr-protocol/nips/commit/7822a8b1) | [51](51.md) | the meaning of `kind: 30000` was changed | -| 2023-11-11 | [cbdca1e9](https://github.com/nostr-protocol/nips/commit/cbdca1e9) | [84](84.md) | 'range' tag was removed | -| 2023-11-10 | [c945d8bd](https://github.com/nostr-protocol/nips/commit/c945d8bd) | [32](32.md) | 'l' tag annotations was removed | -| 2023-11-07 | [108b7f16](https://github.com/nostr-protocol/nips/commit/108b7f16) | [01](01.md) | 'OK' message must have 4 items | -| 2023-10-17 | [cf672b76](https://github.com/nostr-protocol/nips/commit/cf672b76) | [03](03.md) | 'block' tag was removed | -| 2023-09-29 | [7dc6385f](https://github.com/nostr-protocol/nips/commit/7dc6385f) | [57](57.md) | optional 'a' tag was included in `zap receipt` | -| 2023-08-21 | [89915e02](https://github.com/nostr-protocol/nips/commit/89915e02) | [11](11.md) | 'min_prefix' was removed | +| 2023-11-11 | [cbdca1e9](https://github.com/nostr-protocol/nips/commit/cbdca1e9) | [84](84.md) | `range` tag was removed | +| 2023-11-10 | [c945d8bd](https://github.com/nostr-protocol/nips/commit/c945d8bd) | [32](32.md) | `l` tag annotations was removed | +| 2023-11-07 | [108b7f16](https://github.com/nostr-protocol/nips/commit/108b7f16) | [01](01.md) | `OK` message must have 4 items | +| 2023-10-17 | [cf672b76](https://github.com/nostr-protocol/nips/commit/cf672b76) | [03](03.md) | `block` tag was removed | +| 2023-09-29 | [7dc6385f](https://github.com/nostr-protocol/nips/commit/7dc6385f) | [57](57.md) | optional `a` tag was included in `zap receipt` | +| 2023-08-21 | [89915e02](https://github.com/nostr-protocol/nips/commit/89915e02) | [11](11.md) | `min_prefix` was removed | | 2023-08-20 | [37c4375e](https://github.com/nostr-protocol/nips/commit/37c4375e) | [01](01.md) | replaceable events with same timestamp should be retained event with lowest id | -| 2023-08-15 | [88ee873c](https://github.com/nostr-protocol/nips/commit/88ee873c) | [15](15.md) | 'countries' tag was renamed to 'regions' | +| 2023-08-15 | [88ee873c](https://github.com/nostr-protocol/nips/commit/88ee873c) | [15](15.md) | `countries` tag was renamed to `regions` | | 2023-08-14 | [72bb8a12](https://github.com/nostr-protocol/nips/commit/72bb8a12) | [12](12.md), [16](16.md), [20](20.md), [33](33.md) | NIP-12, 16, 20 and 33 were merged into NIP-01 | | 2023-08-11 | [d87f8617](https://github.com/nostr-protocol/nips/commit/d87f8617) | [25](25.md) | empty `content` should be considered as "+" | -| 2023-08-01 | [5d63b157](https://github.com/nostr-protocol/nips/commit/5d63b157) | [57](57.md) | 'zap' tag was changed | +| 2023-08-01 | [5d63b157](https://github.com/nostr-protocol/nips/commit/5d63b157) | [57](57.md) | `zap` tag was changed | | 2023-07-15 | [d1814405](https://github.com/nostr-protocol/nips/commit/d1814405) | [01](01.md) | `since` and `until` filters should be `since <= created_at <= until` | | 2023-07-12 | [a1cd2bd8](https://github.com/nostr-protocol/nips/commit/a1cd2bd8) | [25](25.md) | custom emoji was supported | -| 2023-06-18 | [83cbd3e1](https://github.com/nostr-protocol/nips/commit/83cbd3e1) | [11](11.md) | 'image' was renamed to 'icon' | +| 2023-06-18 | [83cbd3e1](https://github.com/nostr-protocol/nips/commit/83cbd3e1) | [11](11.md) | `image` was renamed to `icon` | | 2023-04-13 | [bf0a0da6](https://github.com/nostr-protocol/nips/commit/bf0a0da6) | [15](15.md) | different NIP was re-added as NIP-15 | | 2023-04-09 | [fb5b7c73](https://github.com/nostr-protocol/nips/commit/fb5b7c73) | [15](15.md) | NIP-15 was merged into NIP-01 | | 2023-03-29 | [599e1313](https://github.com/nostr-protocol/nips/commit/599e1313) | [18](18.md) | NIP-18 was bring back | From a7f30b1eb232786263c5ff4ea7b9589c1ec3868f Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Tue, 28 Jan 2025 12:33:53 +0900 Subject: [PATCH 49/80] add kind 32267 to list. (#1698) --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 56fa597d..3f416a2c 100644 --- a/README.md +++ b/README.md @@ -228,6 +228,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `31925` | Calendar Event RSVP | [52](52.md) | | `31989` | Handler recommendation | [89](89.md) | | `31990` | Handler information | [89](89.md) | +| `32267` | Software Application | | | `34235` | Video Event | [71](71.md) | | `34236` | Short-form Portrait Video Event | [71](71.md) | | `34550` | Community Definition | [72](72.md) | From 70db801bb7fb258c10f4b2ec58056ef74df25549 Mon Sep 17 00:00:00 2001 From: Kieran Date: Tue, 28 Jan 2025 14:37:54 +0000 Subject: [PATCH 50/80] Update 92.md (#1721) --- 92.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/92.md b/92.md index b332d211..d6e9932c 100644 --- a/92.md +++ b/92.md @@ -6,10 +6,10 @@ Media Attachments Media attachments (images, videos, and other files) may be added to events by including a URL in the event content, along with a matching `imeta` tag. -`imeta` ("inline metadata") tags add information about media URLs in the event's content. Each `imeta` tag SHOULD match a URL in the event content. Clients may replace imeta URLs with rich previews. +`imeta` ("inline metadata") tags MAY add information about media URLs in the event's content. Each `imeta` tag SHOULD match a URL in the event content. Clients MAY replace imeta URLs with rich previews. The `imeta` tag is variadic, and each entry is a space-delimited key/value pair. -Each `imeta` tag MUST have a `url`, and at least one other field. `imeta` may include +Each `imeta` tag MUST have a `url`, and at least one other field. `imeta` MAY include any field specified by [NIP 94](./94.md). There SHOULD be only one `imeta` tag per URL. ## Example From 36c48ca128c963b78469855d0e48fa6c1097269b Mon Sep 17 00:00:00 2001 From: Pablo Fernandez Date: Tue, 28 Jan 2025 20:26:21 +0100 Subject: [PATCH 51/80] NIP-60: more consistent state transition (#1720) --- 60.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/60.md b/60.md index b2b0dd45..491bc479 100644 --- a/60.md +++ b/60.md @@ -57,7 +57,7 @@ Any tag, other than the `d` tag, can be [[NIP-44]] encrypted into the `.content` Due to addressable event being hard to delete, if a user wants to delete a wallet, they should empty the event and keep just the `d` identifier and add a `deleted` tag. ## Token Event -Token events are used to record the unspent proofs that come from the mint. +Token events are used to record unspent proofs. There can be multiple `kind:7375` events for the same mint, and multiple proofs inside each `kind:7375` event. @@ -73,7 +73,9 @@ There can be multiple `kind:7375` events for the same mint, and multiple proofs "secret": "z+zyxAVLRqN9lEjxuNPSyRJzEstbl69Jc1vtimvtkPg=", "C": "0241d98a8197ef238a192d47edf191a9de78b657308937b4f7dd0aa53beae72c46" } - ] + ], + // tokens that were destroyed in the creation of this token + "del": [ "token-id-1" ] }), "tags": [ [ "a", "37375::my-wallet" ] @@ -81,8 +83,11 @@ There can be multiple `kind:7375` events for the same mint, and multiple proofs } ``` -`.content` is a [[NIP-44]] encrypted payload storing the mint and the unencoded proofs. -* `a` an optional tag linking the token to a specific wallet. + * `a` an optional tag linking the token to a specific wallet. + * `.content` is a [[NIP-44]] encrypted payload: + * `mint`: The mint the proofs belong to. + * `proofs`: unecoded proofs + * `del`: token-ids that were destroyed by the creation of this token. This assists with state transitions. ### Spending proofs When one or more proofs of a token are spent, the token event should be [[NIP-09]]-deleted and, if some proofs are unspent from the same token event, a new token event should be created rolling over the unspent proofs and adding any change outputs to the new token event. @@ -96,7 +101,7 @@ Clients SHOULD publish `kind:7376` events to create a transaction history when t "content": nip44_encrypt([ [ "direction", "in" ], // in = received, out = sent [ "amount", "1", "sat" ], - [ "e", "", "", "created" ], + [ "e", "", "", "created" ], ]), "tags": [ [ "a", "37375::my-wallet" ], @@ -160,7 +165,8 @@ Her client: { "id": "1", "amount": 1 }, { "id": "2", "amount": 2 }, { "id": "4", "amount": 8 }, - ] + ], + "del": [ "event-id-1" ] }), "tags": [ [ "a", "37375::my-wallet" ] @@ -168,6 +174,7 @@ Her client: } ``` * MUST delete event `event-id-1` +* SHOULD add the `event-id-1` to the `del` array of deleted token-ids. * SHOULD create a `kind:7376` event to record the spend ```jsonconc { From 993c8a025eda25b1c87ece3605e5a5eae6d6a1e0 Mon Sep 17 00:00:00 2001 From: "P. Reis" Date: Tue, 28 Jan 2025 21:26:41 -0300 Subject: [PATCH 52/80] parameterized replaceable -> addressable (#1722) --- 60.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/60.md b/60.md index 491bc479..6f3929c5 100644 --- a/60.md +++ b/60.md @@ -39,7 +39,7 @@ This NIP doesn't deal with users' *receiving* money from someone else, it's just } ``` -The wallet event is a parameterized replaceable event `kind:37375`. +The wallet event is an addressable event `kind:37375`. Tags: * `d` - wallet ID. From 54b431e701c3e3b0eaa5bdd2093a3bb7830543dc Mon Sep 17 00:00:00 2001 From: "k." Date: Wed, 29 Jan 2025 13:45:18 +0330 Subject: [PATCH 53/80] Add x tag to NIP-56 (#1669) --- 56.md | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/56.md b/56.md index f7b1b1a9..dc6f0983 100644 --- a/56.md +++ b/56.md @@ -22,7 +22,7 @@ are reporting. If reporting a note, an `e` tag MUST also be included referencing the note id. -A `report type` string MUST be included as the 3rd entry to the `e` or `p` tag +A `report type` string MUST be included as the 3rd entry to the `e`, `p` or `x` tag being reported, which consists of the following report types: - `nudity` - depictions of nudity, porn, etc. @@ -33,7 +33,9 @@ being reported, which consists of the following report types: - `impersonation` - someone pretending to be someone else - `other` - for reports that don't fit in the above categories -Some report tags only make sense for profile reports, such as `impersonation` +Some report tags only make sense for profile reports, such as `impersonation`. + +- `x` tags SHOULD be info hash of a blob which is intended to be report. when the `x` tag is represented client MUST include an `e` tag which is the id of the event that contains the mentioned blob. also, additionally these events can contain a `server` tag to point to media servers which may contain the mentioned media. `l` and `L` tags MAY be also be used as defined in [NIP-32](32.md) to support further qualification and querying. @@ -45,7 +47,7 @@ Example events { "kind": 1984, "tags": [ - ["p", , "nudity"], + ["p", "", "nudity"], ["L", "social.nos.ontology"], ["l", "NS-nud", "social.nos.ontology"] ], @@ -58,8 +60,8 @@ Example events { "kind": 1984, "tags": [ - ["e", , "illegal"], - ["p", ] + ["e", "", "illegal"], + ["p", ""] ], "content": "He's insulting the king!", // other fields... @@ -70,13 +72,26 @@ Example events { "kind": 1984, "tags": [ - ["p", , "impersonation"] + ["p", "", "impersonation"] ], "content": "Profile is impersonating nostr:", // other fields... } ``` +```jsonc +{ + "kind": 1984, + "tags": [ + ["x", "", "malware"], + ["e", "", "malware"], + ["server", "https://you-may-find-the-blob-here.com/path-to-url.ext"] + ], + "content": "This file contains malware software in it.", + // other fields... +} +``` + Client behavior --------------- From 7370729472b5d8b54693e67d0f26b2dd1da84c07 Mon Sep 17 00:00:00 2001 From: "P. Reis" Date: Thu, 30 Jan 2025 10:45:35 -0300 Subject: [PATCH 54/80] NIP-60: jsonconc -> jsonc (#1727) --- 60.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/60.md b/60.md index 6f3929c5..81174124 100644 --- a/60.md +++ b/60.md @@ -134,7 +134,7 @@ While the client is fetching (and perhaps validating) proofs it can use the opti ## Spending token If Alice spends 4 sats from this token event -```jsonconc +```jsonc { "kind": 7375, "id": "event-id-1", @@ -155,7 +155,7 @@ If Alice spends 4 sats from this token event Her client: * MUST roll over the unspent proofs: -```jsonconc +```jsonc { "kind": 7375, "id": "event-id-2", @@ -176,7 +176,7 @@ Her client: * MUST delete event `event-id-1` * SHOULD add the `event-id-1` to the `del` array of deleted token-ids. * SHOULD create a `kind:7376` event to record the spend -```jsonconc +```jsonc { "kind": 7376, "content": nip44_encrypt([ From f440eac3dccefa5c0ec9d3964e1d08357fd31e09 Mon Sep 17 00:00:00 2001 From: daniele Date: Thu, 30 Jan 2025 22:49:06 +0100 Subject: [PATCH 55/80] Remove reference to 'username' and update descriptions in metadata (#1726) --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index e515d811..9e25ca9b 100644 --- a/01.md +++ b/01.md @@ -89,7 +89,7 @@ Kinds specify how clients should interpret the meaning of each event and the oth This NIP defines one basic kind: -- `0`: **user metadata**: the `content` is set to a stringified JSON object `{name: , about: , picture: }` describing the user who created the event. [Extra metadata fields](24.md#kind-0) may be set. A relay may delete older events once it gets a new one for the same pubkey. +- `0`: **user metadata**: the `content` is set to a stringified JSON object `{name: , about: , picture: }` describing the user who created the event. [Extra metadata fields](24.md#kind-0) may be set. A relay may delete older events once it gets a new one for the same pubkey. And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation: From 6a4b125ad771ac9da4a1347a1ed41185e30ad0cf Mon Sep 17 00:00:00 2001 From: fiatjaf_ Date: Thu, 30 Jan 2025 23:21:37 -0300 Subject: [PATCH 56/80] nip71: make video events regular (#1704) --- 51.md | 2 +- 68.md | 6 +++--- 71.md | 32 ++++++++++++++++---------------- README.md | 8 ++++---- 4 files changed, 24 insertions(+), 24 deletions(-) diff --git a/51.md b/51.md index d1c62708..87744c72 100644 --- a/51.md +++ b/51.md @@ -50,7 +50,7 @@ Aside from their main identifier, the `"d"` tag, sets can optionally have a `"ti | Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during various operations | `"relay"` (relay URLs) | | Bookmark sets | 30003 | user-defined bookmarks categories , for when bookmarks must be in labeled separate groups | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) | | Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) | -| Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"a"` (kind:34235 videos) | +| Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"a"` (kind:21 videos) | | Kind mute sets | 30007 | mute pubkeys by kinds
`"d"` tag MUST be the kind string | `"p"` (pubkeys) | | Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) | | Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | diff --git a/68.md b/68.md index 6c1e7d2d..918378a9 100644 --- a/68.md +++ b/68.md @@ -12,7 +12,7 @@ The idea is for this type of event to cater to Nostr clients resembling platform ## Picture Events -Picture events contain a `title` tag and description in the `.content`. +Picture events contain a `title` tag and description in the `.content`. They may contain multiple images to be displayed as a single post. @@ -81,7 +81,7 @@ They may contain multiple images to be displayed as a single post. The `imeta` tag `annotate-user` places a user link in the specific position in the image. -Only the following media types are accepted: +Only the following media types are accepted: - `image/apng`: Animated Portable Network Graphics (APNG) - `image/avif`: AV1 Image File Format (AVIF) - `image/gif`: Graphics Interchange Format (GIF) @@ -89,4 +89,4 @@ Only the following media types are accepted: - `image/png`: Portable Network Graphics (PNG) - `image/webp`: Web Picture format (WEBP) -Picture events might be used with [NIP-71](71.md)'s kind `34236` to display short vertical videos in the same feed. +Picture events might be used with [NIP-71](71.md)'s kind `22` to display short vertical videos in the same feed. diff --git a/71.md b/71.md index 5edd7c60..d3b09253 100644 --- a/71.md +++ b/71.md @@ -6,17 +6,19 @@ Video Events `draft` `optional` -This specification defines video events representing a dedicated post of externally hosted content. These video events are _addressable_ and delete-requestable per [NIP-09](09.md). +This specification defines _video_ events representing a dedicated post of externally hosted content. -Unlike a `kind 1` event with a video attached, Video Events are meant to contain all additional metadata concerning the subject media and to be surfaced in video-specific clients rather than general micro-blogging clients. The thought is for events of this kind to be referenced in a Netflix, YouTube, or TikTok like nostr client where the video itself is at the center of the experience. +Unlike a `kind:1` event with a video attached, video events are meant to contain all additional metadata concerning the subject media and to be surfaced in video-specific clients rather than general micro-blogging clients. The thought is for events of this kind to be referenced in a Netflix, YouTube, or TikTok like nostr client where the video itself is at the center of the experience. ## Video Events -There are two types of video events represented by different kinds: horizontal and vertical video events. This is meant to allow clients to cater to each as the viewing experience for horizontal (landscape) videos is often different than that of vertical (portrait) videos (Stories, Reels, Shorts, etc). +There are two types of video events represented by different kinds: _normal_ and _short_ video events. This is meant to allow clients to cater to each as the viewing experience for longer, mostly horizontal (landscape) videos is often different than that of short-form, mostly vertical (portrait), videos ("stories", "reels", "shorts" etc). + +Nothing except cavaliership and common sense prevents a _short_ video from being long, or a _normal_ video from being vertical, and that may or may not be justified, it's mostly a stylistic qualitative difference, not a question of actual raw size. #### Format -The format uses an _addressable event_ kind `34235` for horizontal videos and `34236` for vertical videos. +The format uses a _regular event_ kind `21` for _normal_ videos and `22` for _short_ videos. The `.content` of these events is a summary or description on the video content. @@ -27,7 +29,7 @@ Each `imeta` tag can be used to specify a variant of the video by the `dim` & `m Example: ```json [ - ["imeta", + ["imeta", "dim 1920x1080", "url https://myvideo.com/1080/12345.mp4", "x 3093509d1e0bc604ff60cb9286f4cd7c781553bc8991937befaacfdc28ec5cdc", @@ -38,7 +40,7 @@ Example: "fallback https://andanotherserver.com/1080/12345.mp4", "service nip96", ], - ["imeta", + ["imeta", "dim 1280x720", "url https://myvideo.com/720/12345.mp4", "x e1d4f808dae475ed32fb23ce52ef8ac82e3cc760702fca10d62d382d2da3697d", @@ -49,7 +51,7 @@ Example: "fallback https://andanotherserver.com/720/12345.mp4", "service nip96", ], - ["imeta", + ["imeta", "dim 1280x720", "url https://myvideo.com/720/12345.m3u8", "x 704e720af2697f5d6a198ad377789d462054b6e8d790f8a3903afbc1e044014f", @@ -86,17 +88,15 @@ Additionally `service nip96` may be included to allow clients to search the auth "id": <32-bytes lowercase hex-encoded SHA-256 of the the serialized event data>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, "created_at": , - "kind": 34235 | 34236, + "kind": 21 | 22, "content": "", "tags": [ - ["d", ""], - ["title", ""], ["published_at", "<unix timestamp>"], ["alt", <description>], - // Video Data - ["imeta", + // video Data + ["imeta", "dim 1920x1080", "url https://myvideo.com/1080/12345.mp4", "x 3093509d1e0bc604ff60cb9286f4cd7c781553bc8991937befaacfdc28ec5cdc", @@ -113,17 +113,17 @@ Additionally `service nip96` may be included to allow clients to search the auth ["content-warning", "<reason>"], ["segment", <start>, <end>, "<title>", "<thumbnail URL>"], - // Participants + // participants ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], ["p", "<32-bytes hex of a pubkey>", "<optional recommended relay URL>"], - // Hashtags + // hashtags ["t", "<tag>"], ["t", "<tag>"], - // Reference links + // reference links ["r", "<url>"], ["r", "<url>"] ] } -``` \ No newline at end of file +``` diff --git a/README.md b/README.md index 3f416a2c..5c1d4ec8 100644 --- a/README.md +++ b/README.md @@ -122,6 +122,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `16` | Generic Repost | [18](18.md) | | `17` | Reaction to a website | [25](25.md) | | `20` | Picture | [68](68.md) | +| `21` | Video Event | [71](71.md) | +| `22` | Short-form Portrait Video Event | [71](71.md) | | `40` | Channel Creation | [28](28.md) | | `41` | Channel Metadata | [28](28.md) | | `42` | Channel Message | [28](28.md) | @@ -227,10 +229,8 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `31924` | Calendar | [52](52.md) | | `31925` | Calendar Event RSVP | [52](52.md) | | `31989` | Handler recommendation | [89](89.md) | -| `31990` | Handler information | [89](89.md) | -| `32267` | Software Application | | -| `34235` | Video Event | [71](71.md) | -| `34236` | Short-form Portrait Video Event | [71](71.md) | +| `31990` | Handler information | [89](89.md) | | +| `32267` | Software Application | | | | `34550` | Community Definition | [72](72.md) | | `37375` | Cashu Wallet Event | [60](60.md) | | `38383` | Peer-to-peer Order events | [69](69.md) | From e09f6dad27fc2ed12deda09256dff5bcf22a65b0 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Sat, 1 Feb 2025 00:59:52 +0900 Subject: [PATCH 57/80] add NIP-71 change. --- BREAKING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/BREAKING.md b/BREAKING.md index 66f1a9f6..ca79a0e5 100644 --- a/BREAKING.md +++ b/BREAKING.md @@ -5,6 +5,7 @@ reverse chronological order. | Date | Commit | NIP | Change | | ----------- | --------- | -------- | ------ | +| 2025-01-31 | [6a4b125a](https://github.com/nostr-protocol/nips/commit/6a4b125a) | [71](71.md) | video events were changed to regular | | 2024-12-05 | [6d16019e](https://github.com/nostr-protocol/nips/commit/6d16019e) | [46](46.md) | message encryption was changed to NIP-44 | | 2024-11-12 | [2838e3bd](https://github.com/nostr-protocol/nips/commit/2838e3bd) | [29](29.md) | `kind: 12` and `kind: 10` were removed (use `kind: 1111` instead) | | 2024-11-12 | [926a51e7](https://github.com/nostr-protocol/nips/commit/926a51e7) | [46](46.md) | NIP-05 login was removed | From c88d9256135e53136ea2ce4f99b7e9cfcb21d143 Mon Sep 17 00:00:00 2001 From: Terry Yiu <963907+tyiu@users.noreply.github.com> Date: Sun, 2 Feb 2025 22:38:15 -0500 Subject: [PATCH 58/80] Update kind 10013 description in README (#1736) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5c1d4ec8..d1100e10 100644 --- a/README.md +++ b/README.md @@ -175,7 +175,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10006` | Blocked relays list | [51](51.md) | | `10007` | Search relays list | [51](51.md) | | `10009` | User groups | [51](51.md), [29](29.md) | -| `10013` | Draft relays | [37](37.md) | +| `10013` | Private event relay list | [37](37.md) | | `10015` | Interests list | [51](51.md) | | `10019` | Nutzap Mint Recommendation | [61](61.md) | | `10030` | User emoji list | [51](51.md) | From 8577545faad887396d413707bc9020d024407818 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Mon, 3 Feb 2025 23:00:33 +0900 Subject: [PATCH 59/80] nip60: fix links. --- 60.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/60.md b/60.md index 81174124..2f97f87c 100644 --- a/60.md +++ b/60.md @@ -44,14 +44,14 @@ The wallet event is an addressable event `kind:37375`. Tags: * `d` - wallet ID. * `mint` - Mint(s) this wallet uses -- there MUST be one or more mint tags. -* `relay` - Relays where the wallet and related events can be found. -- one ore more relays SHOULD be specified. If missing, clients should follow [[NIP-65]]. +* `relay` - Relays where the wallet and related events can be found. -- one ore more relays SHOULD be specified. If missing, clients should follow [NIP-65](65.md). * `unit` - Base unit of the wallet (e.g. "sat", "usd", etc). * `name` - Optional human-readable name for the wallet. * `description` - Optional human-readable description of the wallet. * `balance` - Optional best-effort balance of the wallet that can serve as a placeholder while an accurate balance is computed from fetching all unspent proofs. * `privkey` - Private key used to unlock P2PK ecash. MUST be stored encrypted in the `.content` field. **This is a different private key exclusively used for the wallet, not associated in any way to the user's nostr private key** -- This is only used when receiving funds from others, described in NIP-61. -Any tag, other than the `d` tag, can be [[NIP-44]] encrypted into the `.content` field. +Any tag, other than the `d` tag, can be [NIP-44](44.md) encrypted into the `.content` field. ### Deleting a wallet event Due to addressable event being hard to delete, if a user wants to delete a wallet, they should empty the event and keep just the `d` identifier and add a `deleted` tag. @@ -90,7 +90,7 @@ There can be multiple `kind:7375` events for the same mint, and multiple proofs * `del`: token-ids that were destroyed by the creation of this token. This assists with state transitions. ### Spending proofs -When one or more proofs of a token are spent, the token event should be [[NIP-09]]-deleted and, if some proofs are unspent from the same token event, a new token event should be created rolling over the unspent proofs and adding any change outputs to the new token event. +When one or more proofs of a token are spent, the token event should be [NIP-09](09.md)-deleted and, if some proofs are unspent from the same token event, a new token event should be created rolling over the unspent proofs and adding any change outputs to the new token event. ## Spending History Event Clients SHOULD publish `kind:7376` events to create a transaction history when their balance changes. @@ -115,14 +115,14 @@ Clients SHOULD publish `kind:7376` events to create a transaction history when t Clients MUST add `e` tags to create references of destroyed and created token events along with the marker of the meaning of the tag: * `created` - A new token event was created. * `destroyed` - A token event was destroyed. -* `redeemed` - A [[NIP-61]] nutzap was redeemed. +* `redeemed` - A [NIP-61](61.md) nutzap was redeemed. -All tags can be [[NIP-44]] encrypted. Clients SHOULD leave `e` tags with a `redeemed` marker unencrypted. +All tags can be [NIP-44](44.md) encrypted. Clients SHOULD leave `e` tags with a `redeemed` marker unencrypted. Multiple `e` tags can be added to a `kind:7376` event. # Flow -A client that wants to check for user's wallets information starts by fetching `kind:10019` events from the user's relays, if no event is found, it should fall back to using the user's [[NIP-65]] relays. +A client that wants to check for user's wallets information starts by fetching `kind:10019` events from the user's relays, if no event is found, it should fall back to using the user's [NIP-65](65.md) relays. ## Fetch wallet and token list From those relays, the client should fetch wallet and token events. @@ -192,7 +192,7 @@ Her client: ``` ## Redeeming a quote (optional) -When creating a quote at a mint, an event can be used to keep the state of the quote ID, which will be used to check when the quote has been paid. These events should be created with an expiration tag [[NIP-40]] matching the expiration of the bolt11 received from the mint; this signals to relays when they can safely discard these events. +When creating a quote at a mint, an event can be used to keep the state of the quote ID, which will be used to check when the quote has been paid. These events should be created with an expiration tag [NIP-40](40.md) matching the expiration of the bolt11 received from the mint; this signals to relays when they can safely discard these events. Application developers are encouraged to use local state when possible and only publish this event when it makes sense in the context of their application. From 93568e39717cd61ff855dc24e4f0ee30a6051f6c Mon Sep 17 00:00:00 2001 From: Ethan Tuttle <133234413+EthnTuttle@users.noreply.github.com> Date: Mon, 3 Feb 2025 18:27:25 -0500 Subject: [PATCH 60/80] Update 60.md (#1738) --- 60.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/60.md b/60.md index 2f97f87c..69db44f8 100644 --- a/60.md +++ b/60.md @@ -44,7 +44,7 @@ The wallet event is an addressable event `kind:37375`. Tags: * `d` - wallet ID. * `mint` - Mint(s) this wallet uses -- there MUST be one or more mint tags. -* `relay` - Relays where the wallet and related events can be found. -- one ore more relays SHOULD be specified. If missing, clients should follow [NIP-65](65.md). +* `relay` - Relays where the wallet and related events can be found. -- one or more relays SHOULD be specified. If missing, clients should follow [NIP-65](65.md). * `unit` - Base unit of the wallet (e.g. "sat", "usd", etc). * `name` - Optional human-readable name for the wallet. * `description` - Optional human-readable description of the wallet. From 5a857e8bf8b88e14a98b1fcff4932034091c9b5c Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Mon, 3 Feb 2025 22:36:27 -0300 Subject: [PATCH 61/80] nip60/61 updates and simplifications (#1730) Co-authored-by: Tiago Balas <eskema23@gmail.com> --- 60.md | 98 ++++++++++++++++++++++------------------------------------- 61.md | 88 ++++++++++++++++++++++++----------------------------- 2 files changed, 75 insertions(+), 111 deletions(-) diff --git a/60.md b/60.md index 69db44f8..87449d20 100644 --- a/60.md +++ b/60.md @@ -1,5 +1,9 @@ -# NIP-60 -## Cashu Wallet +NIP-60 +====== + +Cashu Wallets +------------- + `draft` `optional` This NIP defines the operations of a cashu-based wallet. @@ -13,48 +17,28 @@ The purpose of this NIP is: This NIP doesn't deal with users' *receiving* money from someone else, it's just to keep state of the user's wallet. # High-level flow -1. A user has a `kind:37375` event that represents a wallet. +1. A user has a `kind:17375` event that represents a wallet. 2. A user has `kind:7375` events that represent the unspent proofs of the wallet. -- The proofs are encrypted with the user's private key. 3. A user has `kind:7376` events that represent the spending history of the wallet -- This history is for informational purposes only and is completely optional. ## Wallet Event ```jsonc { - "kind": 37375, + "kind": 17375, "content": nip44_encrypt([ - [ "balance", "100", "sat" ], - [ "privkey", "hexkey" ] // explained in NIP-61 - ]), - "tags": [ - [ "d", "my-wallet" ], + [ "privkey", "hexkey" ], [ "mint", "https://mint1" ], - [ "mint", "https://mint2" ], - [ "mint", "https://mint3" ], - [ "name", "my shitposting wallet" ], - [ "unit", "sat" ], - [ "description", "a wallet for my day-to-day shitposting" ], - [ "relay", "wss://relay1" ], - [ "relay", "wss://relay2" ], - ] + [ "mint", "https://mint2" ] + ]), + "tags": [] } ``` -The wallet event is an addressable event `kind:37375`. +The wallet event is an replaceable event `kind:17375`. Tags: -* `d` - wallet ID. * `mint` - Mint(s) this wallet uses -- there MUST be one or more mint tags. -* `relay` - Relays where the wallet and related events can be found. -- one or more relays SHOULD be specified. If missing, clients should follow [NIP-65](65.md). -* `unit` - Base unit of the wallet (e.g. "sat", "usd", etc). -* `name` - Optional human-readable name for the wallet. -* `description` - Optional human-readable description of the wallet. -* `balance` - Optional best-effort balance of the wallet that can serve as a placeholder while an accurate balance is computed from fetching all unspent proofs. -* `privkey` - Private key used to unlock P2PK ecash. MUST be stored encrypted in the `.content` field. **This is a different private key exclusively used for the wallet, not associated in any way to the user's nostr private key** -- This is only used when receiving funds from others, described in NIP-61. - -Any tag, other than the `d` tag, can be [NIP-44](44.md) encrypted into the `.content` field. - -### Deleting a wallet event -Due to addressable event being hard to delete, if a user wants to delete a wallet, they should empty the event and keep just the `d` identifier and add a `deleted` tag. +* `privkey` - Private key used to unlock P2PK ecash. MUST be stored encrypted in the `.content` field. **This is a different private key exclusively used for the wallet, not associated in any way to the user's Nostr private key** -- This is only used for receiving [NIP-61](61.md) nutzaps. ## Token Event Token events are used to record unspent proofs. @@ -67,6 +51,7 @@ There can be multiple `kind:7375` events for the same mint, and multiple proofs "content": nip44_encrypt({ "mint": "https://stablenut.umint.cash", "proofs": [ + // one or more proofs in the default cashu format { "id": "005c2502034d4f12", "amount": 1, @@ -74,23 +59,21 @@ There can be multiple `kind:7375` events for the same mint, and multiple proofs "C": "0241d98a8197ef238a192d47edf191a9de78b657308937b4f7dd0aa53beae72c46" } ], - // tokens that were destroyed in the creation of this token - "del": [ "token-id-1" ] + // tokens that were destroyed in the creation of this token (helps on wallet state transitions) + "del": [ "token-event-id-1", "token-event-id-2" ] }), - "tags": [ - [ "a", "37375:<pubkey>:my-wallet" ] - ] + "tags": [] } ``` - * `a` an optional tag linking the token to a specific wallet. - * `.content` is a [[NIP-44]] encrypted payload: + * `.content` is a [NIP-44](44.md) encrypted payload: * `mint`: The mint the proofs belong to. * `proofs`: unecoded proofs * `del`: token-ids that were destroyed by the creation of this token. This assists with state transitions. -### Spending proofs -When one or more proofs of a token are spent, the token event should be [NIP-09](09.md)-deleted and, if some proofs are unspent from the same token event, a new token event should be created rolling over the unspent proofs and adding any change outputs to the new token event. +When one or more proofs of a token are spent, the token event should be [NIP-09](09.md)-deleted and, if some proofs are unspent from the same token event, a new token event should be created rolling over the unspent proofs and adding any change outputs to the new token event (the change output should include a `del` field). + +The `kind:5` _delete event_ created in the [NIP-09](09.md) process MUST have a tag `["k", "7375"]` to allow easy filtering by clients interested in state transitions. ## Spending History Event Clients SHOULD publish `kind:7376` events to create a transaction history when their balance changes. @@ -100,17 +83,16 @@ Clients SHOULD publish `kind:7376` events to create a transaction history when t "kind": 7376, "content": nip44_encrypt([ [ "direction", "in" ], // in = received, out = sent - [ "amount", "1", "sat" ], - [ "e", "<event-id-of-created-token>", "<relay-hint>", "created" ], + [ "amount", "1" ], + [ "e", "<event-id-of-created-token>", "", "created" ] ]), "tags": [ - [ "a", "37375:<pubkey>:my-wallet" ], + [ "e", "<event-id-of-created-token>", "", "redeemed" ] ] } ``` * `direction` - The direction of the transaction; `in` for received funds, `out` for sent funds. -* `a` - The wallet the transaction is related to. Clients MUST add `e` tags to create references of destroyed and created token events along with the marker of the meaning of the tag: * `created` - A new token event was created. @@ -119,7 +101,7 @@ Clients MUST add `e` tags to create references of destroyed and created token ev All tags can be [NIP-44](44.md) encrypted. Clients SHOULD leave `e` tags with a `redeemed` marker unencrypted. -Multiple `e` tags can be added to a `kind:7376` event. +Multiple `e` tags can be added, and should be encrypted, except for tags with the `redeemed` marker. # Flow A client that wants to check for user's wallets information starts by fetching `kind:10019` events from the user's relays, if no event is found, it should fall back to using the user's [NIP-65](65.md) relays. @@ -127,10 +109,9 @@ A client that wants to check for user's wallets information starts by fetching ` ## Fetch wallet and token list From those relays, the client should fetch wallet and token events. -`"kinds": [37375, 7375], "authors": ["<my-pubkey>"]` +`"kinds": [17375, 7375], "authors": ["<my-pubkey>"]` ## Fetch proofs -While the client is fetching (and perhaps validating) proofs it can use the optional `balance` tag of the wallet event to display a estimate of the balance of the wallet. ## Spending token If Alice spends 4 sats from this token event @@ -147,9 +128,7 @@ If Alice spends 4 sats from this token event { "id": "4", "amount": 8 }, ] }), - "tags": [ - [ "a", "37375:<pubkey>:my-wallet" ] - ] + "tags": [] } ``` @@ -168,9 +147,7 @@ Her client: ], "del": [ "event-id-1" ] }), - "tags": [ - [ "a", "37375:<pubkey>:my-wallet" ] - ] + "tags": [] } ``` * MUST delete event `event-id-1` @@ -181,20 +158,18 @@ Her client: "kind": 7376, "content": nip44_encrypt([ [ "direction", "out" ], - [ "amount", "4", "sats" ], - [ "e", "<event-id-1>", "<relay-hint>", "destroyed" ], - [ "e", "<event-id-2>", "<relay-hint>", "created" ], + [ "amount", "4" ], + [ "e", "<event-id-1>", "", "destroyed" ], + [ "e", "<event-id-2>", "", "created" ], ]), - "tags": [ - [ "a", "37375:<pubkey>:my-wallet" ], - ] + "tags": [] } ``` ## Redeeming a quote (optional) -When creating a quote at a mint, an event can be used to keep the state of the quote ID, which will be used to check when the quote has been paid. These events should be created with an expiration tag [NIP-40](40.md) matching the expiration of the bolt11 received from the mint; this signals to relays when they can safely discard these events. +When creating a quote at a mint, an event can be used to keep the state of the quote ID, which will be used to check when the quote has been paid. These events should be created with an expiration tag [NIP-40](40.md) of 2 weeks (which is around the maximum amount of time a Lightning payment may be in-flight). -Application developers are encouraged to use local state when possible and only publish this event when it makes sense in the context of their application. +However, application developers SHOULD use local state when possible and only publish this event when it makes sense in the context of their application. ```jsonc { @@ -202,8 +177,7 @@ Application developers are encouraged to use local state when possible and only "content": nip44_encrypt("quote-id"), "tags": [ [ "expiration", "<expiration-timestamp>" ], - [ "mint", "<mint-url>" ], - [ "a", "37375:<pubkey>:my-wallet" ] + [ "mint", "<mint-url>" ] ] } ``` diff --git a/61.md b/61.md index 8246203e..fdcc2b64 100644 --- a/61.md +++ b/61.md @@ -1,14 +1,19 @@ -# NIP-61: -## Nut Zaps +NIP-61 +====== -A Nut Zap is a P2PK cashu token where the payment itself is the receipt. +Nutzaps +------- + +`draft` `optional` + +A Nutzap is a P2PK Cashu token in which the payment itself is the receipt. # High-level flow Alice wants to nutzap 1 sat to Bob because of an event `event-id-1` she liked. ## Alice nutzaps Bob 1. Alice fetches event `kind:10019` from Bob to see the mints Bob trusts. -2. She mints a token at that mint (or swaps some tokens she already had in that mint) p2pk-locked to the pubkey Bob has listed in his `kind:10019`. +2. She mints a token at that mint (or swaps some tokens she already had in that mint) P2PK-locked to the pubkey Bob has listed in his `kind:10019`. 3. She publishes a `kind:9321` event to the relays Bob indicated with the proofs she minted. ## Bob receives the nutzap @@ -29,16 +34,15 @@ Alice wants to nutzap 1 sat to Bob because of an event `event-id-1` she liked. } ``` -`kind:10019` is an event that is useful for others to know how to send money to the user. - -* `relay` - Relays where the user will be reading token events from. If a user wants to send money to the user, they should write to these relays. -* `mint` - Mints the user is explicitly agreeing to use to receive funds on. Clients SHOULD not send money on mints not listed here or risk burning their money. Additional markers can be used to list the supported base units of the mint. -* `pubkey` - Pubkey that SHOULD be used to P2PK-lock receiving nutzaps. If not present, clients SHOULD use the pubkey of the recipient. This is explained in Appendix 1. +* `kind:10019` is an event that is useful for others to know how to send money to the user. +* `relay`: relays where the user will be reading token events from. If a user wants to send money to the user, they should write to these relays. +* `mint`: mints the user is explicitly agreeing to use to receive funds on. Clients SHOULD not send money on mints not listed here or risk burning their money. Additional markers can be used to list the supported base units of the mint. +* `pubkey`: Public key that MUST be used to P2PK-lock receiving nutzaps -- implementations MUST NOT use the target user's main Nostr public key. This public key corresponds to the `privkey` field encrypted in a user's [nip-60](60.md) _wallet event_. ## Nutzap event -Event `kind:9321` is a nutzap event published by the sender, p-tagging the recipient. The outputs are P2PK-locked to the pubkey the recipient indicated in their `kind:10019` event or to the recipient pubkey if the `kind:10019` event doesn't have a explicit pubkey. +Event `kind:9321` is a nutzap event published by the sender, p-tagging the recipient. The outputs are P2PK-locked to the public key the recipient indicated in their `kind:10019` event. -Clients MUST prefix the pubkey they p2pk-lock with `"02"` (for nostr<>cashu pubkey compatibility). +Clients MUST prefix the public key they P2PK-lock with `"02"` (for nostr<>cashu compatibility). ```jsonc { @@ -46,48 +50,41 @@ Clients MUST prefix the pubkey they p2pk-lock with `"02"` (for nostr<>cashu pubk content: "Thanks for this great idea.", pubkey: "sender-pubkey", tags: [ - [ "amount", "1" ], - [ "unit", "sat" ], [ "proof", "{\"amount\":1,\"C\":\"02277c66191736eb72fce9d975d08e3191f8f96afb73ab1eec37e4465683066d3f\",\"id\":\"000a93d6f8a1d2c4\",\"secret\":\"[\\\"P2PK\\\",{\\\"nonce\\\":\\\"b00bdd0467b0090a25bdf2d2f0d45ac4e355c482c1418350f273a04fedaaee83\\\",\\\"data\\\":\\\"02eaee8939e3565e48cc62967e2fde9d8e2a4b3ec0081f29eceff5c64ef10ac1ed\\\"}]\"}" ], - [ "u", "https://stablenut.umint.cash", ], + [ "u", "https://stablenut.umint.cash" ], [ "e", "<zapped-event-id>", "<relay-hint>" ], - [ "p", "e9fbced3a42dcf551486650cc752ab354347dd413b307484e4fd1818ab53f991" ], // recipient of nut zap + [ "p", "e9fbced3a42dcf551486650cc752ab354347dd413b307484e4fd1818ab53f991" ], // recipient of nutzap ] } ``` * `.content` is an optional comment for the nutzap -* `amount` is a shorthand for the combined amount of all outputs. -- Clients SHOULD validate that the sum of the amounts in the outputs matches. -* `unit` is the base unit of the amount. -* `proof` is one ore more proofs p2pk-locked to the pubkey the recipient specified in their `kind:10019` event. -* `u` is the mint the URL of the mint EXACTLY as specified by the recipient's `kind:10019`. -* `e` zero or one event that is being nutzapped. -* `p` exactly one pubkey, specifying the recipient of the nutzap. - -WIP: Clients SHOULD embed a DLEQ proof in the nutzap event to make it possible to verify nutzaps without talking to the mint. +* `.tags`: + * `proof` is one ore more proofs P2PK-locked to the public key the recipient specified in their `kind:10019` event and including a DLEQ proof. + * `u` is the mint the URL of the mint EXACTLY as specified by the recipient's `kind:10019`. + * `p` is the Nostr identity public key of nutzap recipient. + * `e` is the event that is being nutzapped, if any. # Sending a nutzap * The sender fetches the recipient's `kind:10019`. * The sender mints/swaps ecash on one of the recipient's listed mints. -* The sender p2pk locks to the recipient's specified pubkey in their `kind:10019` +* The sender P2PK-locks to the recipient's specified public key in their `kind:10019` # Receiving nutzaps -Clients should REQ for nut zaps: +Clients should REQ for nutzaps: * Filtering with `#u` for mints they expect to receive ecash from. * this is to prevent even interacting with mints the user hasn't explicitly signaled. * Filtering with `since` of the most recent `kind:7376` event the same user has created. - * this can be used as a marker of the nut zaps that have already been swaped by the user -- clients might choose to use other kinds of markers, including internal state -- this is just a guidance of one possible approach. - -Clients MIGHT choose to use some kind of filtering (e.g. WoT) to ignore spam. + * this can be used as a marker of the nutzaps that have already been swaped by the user -- clients might choose to use other kinds of markers, including internal state -- this is just a guidance of one possible approach. -`{ "kinds": [9321], "#p": "my-pubkey", "#u": [ "<mint-1>", "<mint-2>"], "since": <latest-created_at-of-kind-7376> }`. +`{ "kinds": [9321], "#p": ["my-pubkey"], "#u": ["<mint-1>", "<mint-2>"], "since": <latest-created_at-of-kind-7376> }`. -Upon receiving a new nut zap, the client should swap the tokens into a wallet the user controls, either a [[NIP-60]] wallet, their own LN wallet or anything else. +Upon receiving a new nutzap, the client should swap the tokens into a wallet the user controls, either a [NIP-60](60.md) wallet, their own LN wallet or anything else. ## Updating nutzap-redemption history -When claiming a token the client SHOULD create a `kind:7376` event and `e` tag the original nut zap event. This is to record that this token has already been claimed (and shouldn't be attempted again) and as signaling to the recipient that the ecash has been redeemed. +When claiming a token the client SHOULD create a `kind:7376` event and `e` tag the original nutzap event. This is to record that this token has already been claimed (and shouldn't be attempted again) and as signaling to the recipient that the ecash has been redeemed. Multiple `kind:9321` events can be tagged in the same `kind:7376` event. @@ -96,7 +93,7 @@ Multiple `kind:9321` events can be tagged in the same `kind:7376` event. "kind": 7376, "content": nip44_encrypt([ [ "direction", "in" ], // in = received, out = sent - [ "amount", "1", "sat" ], + [ "amount", "1" ], [ "e", "<7375-event-id>", "relay-hint", "created" ] // new token event that was created ]), "tags": [ @@ -107,26 +104,19 @@ Multiple `kind:9321` events can be tagged in the same `kind:7376` event. } ``` -Events that redeem a nutzap SHOULD be published to the sender's [[NIP-65]] relays. +Events that redeem a nutzap SHOULD be published to the sender's [NIP-65](65.md) "read" relays. ## Verifying a Cashu Zap -* Clients SHOULD check that the receiving user has issued a `kind:10019` tagging the mint where the cashu has been minted. -* Clients SHOULD check that the token is locked to the pubkey the user has listed in their `kind:10019`. +When listing or counting zaps received by any given event, observer clients SHOULD: -## Final Considerations +* check that the receiving user has issued a `kind:10019` tagging the mint where the cashu has been minted. +* check that the token is locked to the pubkey the user has listed in their `kind:10019`. +* look at the `u` tag and check that the token is issued in one of the mints listed in the `kind:10019`. +* locally verify the DLEQ proof of the tokens being sent. -1. Clients SHOULD guide their users to use NUT-11 (P2PK) compatible-mints in their `kind:10019` event to avoid receiving nut zaps anyone can spend +All these checks can be done offline (as long as the observer has the receiver mints' keyset and their `kind:10019` event), so the process should be reasonably fast. +## Final Considerations +1. Clients SHOULD guide their users to use NUT-11 (P2PK) and NUT-12 (DLEQ proofs) compatible-mints in their `kind:10019` event to avoid receiving nutzaps anyone can spend. 2. Clients SHOULD normalize and deduplicate mint URLs as described in NIP-65. - -3. A nut zap MUST be sent to a mint the recipient has listed in their `kind:10019` event or to the NIP-65 relays of the recipient, failure to do so may result in the recipient donating the tokens to the mint since the recipient might never see the event. - -## Appendix 1: Alternative P2PK pubkey -Clients might not have access to the user's private key (i.e. NIP-07, NIP-46 signing) and, as such, the private key to sign cashu spends might not be available, which would make spending the P2PK incoming nutzaps impossible. - -For this scenarios clients can: - -* add a `pubkey` tag to the `kind:10019` (indicating which pubkey senders should P2PK to) -* store the private key in the `kind:37375` event in the nip44-encrypted `content` field. - -This is to avoid depending on NIP-07/46 adaptations to sign cashu payloads. +3. A nutzap event MUST include proofs in one of the mints the recipient has listed in their `kind:10019` and published to the NIP-65 relays of the recipient, failure to do so may result in the recipient donating the tokens to the mint since the recipient might never see the event. From 2bc53c12a2af71845bb15a9386ed28867b9f925e Mon Sep 17 00:00:00 2001 From: Ethan Tuttle <133234413+EthnTuttle@users.noreply.github.com> Date: Tue, 4 Feb 2025 05:53:04 -0500 Subject: [PATCH 62/80] Update 61.md (#1739) --- 61.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/61.md b/61.md index fdcc2b64..ac4dd150 100644 --- a/61.md +++ b/61.md @@ -60,7 +60,7 @@ Clients MUST prefix the public key they P2PK-lock with `"02"` (for nostr<>cashu * `.content` is an optional comment for the nutzap * `.tags`: - * `proof` is one ore more proofs P2PK-locked to the public key the recipient specified in their `kind:10019` event and including a DLEQ proof. + * `proof` is one or more proofs P2PK-locked to the public key the recipient specified in their `kind:10019` event and including a DLEQ proof. * `u` is the mint the URL of the mint EXACTLY as specified by the recipient's `kind:10019`. * `p` is the Nostr identity public key of nutzap recipient. * `e` is the event that is being nutzapped, if any. From a70e49e21cf286889568ce034011a29ba994faa0 Mon Sep 17 00:00:00 2001 From: Asai Toshiya <to.asai.60@gmail.com> Date: Tue, 4 Feb 2025 20:55:41 +0900 Subject: [PATCH 63/80] update Cashu Wallet Event kind. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d1100e10..dd3c0f74 100644 --- a/README.md +++ b/README.md @@ -183,6 +183,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `10063` | User server list | [Blossom][blossom] | | `10096` | File storage server list | [96](96.md) | | `13194` | Wallet Info | [47](47.md) | +| `17375` | Cashu Wallet Event | [60](60.md) | | `21000` | Lightning Pub RPC | [Lightning.Pub][lnpub] | | `22242` | Client Authentication | [42](42.md) | | `23194` | Wallet Request | [47](47.md) | @@ -232,7 +233,6 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | `31990` | Handler information | [89](89.md) | | | `32267` | Software Application | | | | `34550` | Community Definition | [72](72.md) | -| `37375` | Cashu Wallet Event | [60](60.md) | | `38383` | Peer-to-peer Order events | [69](69.md) | | `39000-9` | Group metadata events | [29](29.md) | From 4e564ba4d99f247a6c2c1734d01a12c9bda8c1db Mon Sep 17 00:00:00 2001 From: Mohammed Alotaibi <a@4rs.nl> Date: Tue, 4 Feb 2025 15:50:20 +0300 Subject: [PATCH 64/80] Fix NIPs refs (#1740) --- 31.md | 2 +- 47.md | 2 +- 64.md | 2 +- 69.md | 4 ++-- 90.md | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/31.md b/31.md index ee920528..37e41306 100644 --- a/31.md +++ b/31.md @@ -12,4 +12,4 @@ The intent is that social clients, used to display only `kind:1` notes, can stil These clients that only know `kind:1` are not expected to ask relays for events of different kinds, but users could still reference these weird events on their notes, and without proper context these could be nonsensical notes. Having the fallback text makes that situation much better -- even if only for making the user aware that they should try to view that custom event elsewhere. -`kind:1`-centric clients can make interacting with these event kinds more functional by supporting [NIP-89](https://github.com/nostr-protocol/nips/blob/master/89.md). +`kind:1`-centric clients can make interacting with these event kinds more functional by supporting [NIP-89](89.md). diff --git a/47.md b/47.md index 932c2632..f15dc014 100644 --- a/47.md +++ b/47.md @@ -82,7 +82,7 @@ If the command was successful, the `error` field must be null. The notification event SHOULD contain one `p` tag, the public key of the **user**. -The content of notifications is encrypted with [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md), and is a JSON-RPCish object with a semi-fixed structure: +The content of notifications is encrypted with [NIP04](04.md), and is a JSON-RPCish object with a semi-fixed structure: ```jsonc { diff --git a/64.md b/64.md index 616c5d6f..318ea87c 100644 --- a/64.md +++ b/64.md @@ -44,7 +44,7 @@ Clients SHOULD publish PGN notes in ["export format"][pgn_export_format] ("stric Clients SHOULD check whether the formatting is valid and all moves comply with chess rules. -Clients MAY include additional tags (e.g. like [`"alt"`](https://github.com/nostr-protocol/nips/blob/master/31.md)) in order to represent the note to users of non-supporting clients. +Clients MAY include additional tags (e.g. like [`"alt"`](31.md)) in order to represent the note to users of non-supporting clients. ## Relay Behavior diff --git a/69.md b/69.md index 330d6e58..0cfceeac 100644 --- a/69.md +++ b/69.md @@ -12,7 +12,7 @@ This NIP defines a simple standard for peer-to-peer order events, which enables ## The event -Events are [addressable events](https://github.com/nostr-protocol/nips/blob/master/01.md#kinds) and use `38383` as event kind, a p2p event look like this: +Events are [addressable events](01.md#kinds) and use `38383` as event kind, a p2p event look like this: ```json { @@ -65,7 +65,7 @@ Events are [addressable events](https://github.com/nostr-protocol/nips/blob/mast - `name` [Name]: The name of the maker. - `g` [Geohash]: The geohash of the operation, it can be useful in a face to face trade. - `bond` [Bond]: The bond amount, the bond is a security deposit that both parties must pay. -- `expiration` < Expiration\>: The expiration date of the order ([NIP-40](https://github.com/nostr-protocol/nips/blob/master/40.md)). +- `expiration` < Expiration\>: The expiration date of the order ([NIP-40](40.md)). - `y` < Platform >: The platform that created the order. - `z` < Document >: `order`. diff --git a/90.md b/90.md index 1d69b0ff..785b539c 100644 --- a/90.md +++ b/90.md @@ -70,7 +70,7 @@ All tags are optional. ## Encrypted Params -If the user wants to keep the input parameters a secret, they can encrypt the `i` and `param` tags with the service provider's 'p' tag and add it to the content field. Add a tag `encrypted` as tags. Encryption for private tags will use [NIP-04 - Encrypted Direct Message encryption](https://github.com/nostr-protocol/nips/blob/master/04.md), using the user's private and service provider's public key for the shared secret +If the user wants to keep the input parameters a secret, they can encrypt the `i` and `param` tags with the service provider's 'p' tag and add it to the content field. Add a tag `encrypted` as tags. Encryption for private tags will use [NIP-04 - Encrypted Direct Message encryption](04.md), using the user's private and service provider's public key for the shared secret ```json [ From a0cd05f013d7a6c4d0581b2bebb885dc844791f4 Mon Sep 17 00:00:00 2001 From: "P. Reis" <patrickpereirareal1@gmail.com> Date: Tue, 4 Feb 2025 22:35:15 -0300 Subject: [PATCH 65/80] NIP-61: get rid of 'a' tag (#1742) --- 61.md | 1 - 1 file changed, 1 deletion(-) diff --git a/61.md b/61.md index ac4dd150..a340ae4a 100644 --- a/61.md +++ b/61.md @@ -97,7 +97,6 @@ Multiple `kind:9321` events can be tagged in the same `kind:7376` event. [ "e", "<7375-event-id>", "relay-hint", "created" ] // new token event that was created ]), "tags": [ - [ "a", "37375:<pubkey>:my-wallet" ], // an optional wallet tag [ "e", "<9321-event-id>", "relay-hint", "redeemed" ], // nutzap event that has been redeemed [ "p", "sender-pubkey" ] // pubkey of the author of the 9321 event (nutzap sender) ] From 3bbfbb26aa4abe00f612c6c540803de58391e618 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Wed, 5 Feb 2025 11:10:48 -0500 Subject: [PATCH 66/80] NIP-01: Adds the author information to `e` tags (#1749) --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 9e25ca9b..5873eb63 100644 --- a/01.md +++ b/01.md @@ -75,7 +75,7 @@ The first element of the tag array is referred to as the tag _name_ or _key_ and This NIP defines 3 standard tags that can be used across all event kinds with the same meaning. They are as follows: -- The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, <recommended relay URL, optional>]` +- The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, <recommended relay URL, optional>, <32-bytes lowercase hex of the author's pubkey, optional>]` - The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, <recommended relay URL, optional>]` - The `a` tag, used to refer to an addressable or replaceable event - for an addressable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]` From f2e89b130d8053636e0dbdf0e67d83193ccbcc3e Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Wed, 5 Feb 2025 13:25:01 -0300 Subject: [PATCH 67/80] Revert "NIP-01: Adds the author information to `e` tags (#1749)" This reverts commit 3bbfbb26aa4abe00f612c6c540803de58391e618. --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 5873eb63..9e25ca9b 100644 --- a/01.md +++ b/01.md @@ -75,7 +75,7 @@ The first element of the tag array is referred to as the tag _name_ or _key_ and This NIP defines 3 standard tags that can be used across all event kinds with the same meaning. They are as follows: -- The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, <recommended relay URL, optional>, <32-bytes lowercase hex of the author's pubkey, optional>]` +- The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, <recommended relay URL, optional>]` - The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, <recommended relay URL, optional>]` - The `a` tag, used to refer to an addressable or replaceable event - for an addressable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]` From 63d1e89f5380ae88b3c9e7903fdea6129beae0d0 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Wed, 5 Feb 2025 13:29:07 -0300 Subject: [PATCH 68/80] Revert "Revert "NIP-01: Adds the author information to `e` tags (#1749)"" This reverts commit f2e89b130d8053636e0dbdf0e67d83193ccbcc3e. --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index 9e25ca9b..5873eb63 100644 --- a/01.md +++ b/01.md @@ -75,7 +75,7 @@ The first element of the tag array is referred to as the tag _name_ or _key_ and This NIP defines 3 standard tags that can be used across all event kinds with the same meaning. They are as follows: -- The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, <recommended relay URL, optional>]` +- The `e` tag, used to refer to an event: `["e", <32-bytes lowercase hex of the id of another event>, <recommended relay URL, optional>, <32-bytes lowercase hex of the author's pubkey, optional>]` - The `p` tag, used to refer to another user: `["p", <32-bytes lowercase hex of a pubkey>, <recommended relay URL, optional>]` - The `a` tag, used to refer to an addressable or replaceable event - for an addressable event: `["a", <kind integer>:<32-bytes lowercase hex of a pubkey>:<d tag value>, <recommended relay URL, optional>]` From e286001789b0dbd0b1ef9f3cbf91f16f6e9e5c9e Mon Sep 17 00:00:00 2001 From: "P. Reis" <patrickpereirareal1@gmail.com> Date: Thu, 6 Feb 2025 12:28:23 -0300 Subject: [PATCH 69/80] NIP-61: nitpicks (#1754) --- 61.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/61.md b/61.md index a340ae4a..ffe7c523 100644 --- a/61.md +++ b/61.md @@ -94,11 +94,11 @@ Multiple `kind:9321` events can be tagged in the same `kind:7376` event. "content": nip44_encrypt([ [ "direction", "in" ], // in = received, out = sent [ "amount", "1" ], - [ "e", "<7375-event-id>", "relay-hint", "created" ] // new token event that was created + [ "e", "<7375-event-id>", "<relay-hint>", "created" ] // new token event that was created ]), "tags": [ - [ "e", "<9321-event-id>", "relay-hint", "redeemed" ], // nutzap event that has been redeemed - [ "p", "sender-pubkey" ] // pubkey of the author of the 9321 event (nutzap sender) + [ "e", "<9321-event-id>", "<relay-hint>", "redeemed" ], // nutzap event that has been redeemed + [ "p", "<sender-pubkey>" ] // pubkey of the author of the 9321 event (nutzap sender) ] } ``` From f1dee4a050ef850ff280fee60d98a39d500b4e1f Mon Sep 17 00:00:00 2001 From: "Nostr.Band" <124499563+nostrband@users.noreply.github.com> Date: Fri, 7 Feb 2025 12:53:30 +0100 Subject: [PATCH 70/80] Make description_hash verification optional (#1705) --- 57.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/57.md b/57.md index 3f55e57b..c37126e8 100644 --- a/57.md +++ b/57.md @@ -132,7 +132,7 @@ The following should be true of the `zap receipt` event: - `tags` MUST include the `p` tag (zap recipient) AND optional `e` tag from the `zap request` AND optional `a` tag from the `zap request` AND optional `P` tag from the pubkey of the zap request (zap sender). - The `zap receipt` MUST have a `bolt11` tag containing the description hash bolt11 invoice. - The `zap receipt` MUST contain a `description` tag which is the JSON-encoded zap request. -- `SHA256(description)` MUST match the description hash in the bolt11 invoice. +- `SHA256(description)` SHOULD match the description hash in the bolt11 invoice. - The `zap receipt` MAY contain a `preimage` tag to match against the payment hash of the bolt11 invoice. This isn't really a payment proof, there is no real way to prove that the invoice is real or has been paid. You are trusting the author of the `zap receipt` for the legitimacy of the payment. The `zap receipt` is not a proof of payment, all it proves is that some nostr user fetched an invoice. The existence of the `zap receipt` implies the invoice as paid, but it could be a lie given a rogue implementation. From c79ffe0a1c9d0ca86a7e7e1a1c746ad4edf8352a Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Fri, 7 Feb 2025 10:55:24 -0500 Subject: [PATCH 71/80] Clearly informs that kind 1 replies can only be used with kind 1 events. (#1690) --- 10.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/10.md b/10.md index 064e56a0..1aefb227 100644 --- a/10.md +++ b/10.md @@ -10,8 +10,6 @@ This NIP defines `kind:1` as a simple plaintext note. ## Abstract -This NIP describes how to use "e" and "p" tags in text events, especially those that are replies to other text events. It helps clients thread the replies into a tree rooted at the original event. - The `.content` property contains some human-readable text. `e` and `p` tags can be used to define note threads, replies and mentions. @@ -19,6 +17,9 @@ The `.content` property contains some human-readable text. Markup languages such as markdown and HTML SHOULD NOT be used. ## Marked "e" tags (PREFERRED) + +Kind 1 events with `e` tags are replies to other kind 1 events. Kind 1 replies MUST NOT be used to reply to other kinds, use [NIP-22](22.md) instead. + `["e", <event-id>, <relay-url>, <marker>, <pubkey>]` Where: From 546b897fd763ef54bafdb453f005b6f81f1fbab8 Mon Sep 17 00:00:00 2001 From: fiatjaf_ <fiatjaf@gmail.com> Date: Fri, 7 Feb 2025 12:56:49 -0300 Subject: [PATCH 72/80] NIP-22: what is an I-tag? (#1757) --- 22.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/22.md b/22.md index 2ad1fd81..8eff09a9 100644 --- a/22.md +++ b/22.md @@ -6,7 +6,7 @@ Comment `draft` `optional` -A comment is a threading note always scoped to a root event or an `I`-tag. +A comment is a threading note always scoped to a root event or an [`I`-tag](73.md). It uses `kind:1111` with plaintext `.content` (no HTML, Markdown, or other formatting). @@ -198,4 +198,3 @@ A reply to a podcast comment: // other fields } ``` - From 57c84cc87a75e8598004530556fc5988dfc26c49 Mon Sep 17 00:00:00 2001 From: greenart7c3 <115044884+greenart7c3@users.noreply.github.com> Date: Fri, 7 Feb 2025 16:21:19 -0300 Subject: [PATCH 73/80] [NIP-55] - Add the rejected permission check in the code samples (#1755) --- 55.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/55.md b/55.md index afca0aab..a897bd65 100644 --- a/55.md +++ b/55.md @@ -339,6 +339,8 @@ If the user chose to always reject the event, signer application will return the ```kotlin if (result == null) return + if (it.getColumnIndex("rejected") > -1) return + if (result.moveToFirst()) { val index = it.getColumnIndex("result") if (index < 0) return @@ -364,6 +366,8 @@ If the user chose to always reject the event, signer application will return the ```kotlin if (result == null) return + if (it.getColumnIndex("rejected") > -1) return + if (result.moveToFirst()) { val index = it.getColumnIndex("result") val indexJson = it.getColumnIndex("event") @@ -390,6 +394,8 @@ If the user chose to always reject the event, signer application will return the ```kotlin if (result == null) return + if (it.getColumnIndex("rejected") > -1) return + if (result.moveToFirst()) { val index = it.getColumnIndex("result") val encryptedText = it.getString(index) @@ -414,6 +420,8 @@ If the user chose to always reject the event, signer application will return the ```kotlin if (result == null) return + if (it.getColumnIndex("rejected") > -1) return + if (result.moveToFirst()) { val index = it.getColumnIndex("result") val encryptedText = it.getString(index) @@ -438,6 +446,8 @@ If the user chose to always reject the event, signer application will return the ```kotlin if (result == null) return + if (it.getColumnIndex("rejected") > -1) return + if (result.moveToFirst()) { val index = it.getColumnIndex("result") val encryptedText = it.getString(index) @@ -462,6 +472,8 @@ If the user chose to always reject the event, signer application will return the ```kotlin if (result == null) return + if (it.getColumnIndex("rejected") > -1) return + if (result.moveToFirst()) { val index = it.getColumnIndex("result") val encryptedText = it.getString(index) @@ -486,6 +498,8 @@ If the user chose to always reject the event, signer application will return the ```kotlin if (result == null) return + if (it.getColumnIndex("rejected") > -1) return + if (result.moveToFirst()) { val index = it.getColumnIndex("result") val relayJsonText = it.getString(index) @@ -510,6 +524,8 @@ If the user chose to always reject the event, signer application will return the ```kotlin if (result == null) return + if (it.getColumnIndex("rejected") > -1) return + if (result.moveToFirst()) { val index = it.getColumnIndex("result") val eventJson = it.getString(index) From 0023ca818c759f46cd357a812dca98abfd9824b8 Mon Sep 17 00:00:00 2001 From: Vitor Pamplona <vitor@vitorpamplona.com> Date: Fri, 7 Feb 2025 14:59:59 -0500 Subject: [PATCH 74/80] Removes mention marker from NIP-10 in support of `q` tags (#1750) --- 10.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/10.md b/10.md index 1aefb227..9fd4415e 100644 --- a/10.md +++ b/10.md @@ -12,7 +12,15 @@ This NIP defines `kind:1` as a simple plaintext note. The `.content` property contains some human-readable text. -`e` and `p` tags can be used to define note threads, replies and mentions. +`e` tags can be used to define note thread roots and replies. They SHOULD be sorted by the reply stack from root to the direct parent. + +`q` tags MAY be used when citing events in the `.content` with [NIP-21](21.md). + +```json +["q", "<event-id> or <event-address>", "<relay-url>", "<pubkey-if-a-regular-event>"] +``` + +Authors of the `e` and `q` tags SHOULD be added as `p` tags to notify of a new reply or quote. Markup languages such as markdown and HTML SHOULD NOT be used. @@ -26,10 +34,10 @@ Where: * `<event-id>` is the id of the event being referenced. * `<relay-url>` is the URL of a recommended relay associated with the reference. Clients SHOULD add a valid `<relay-url>` field, but may instead leave it as `""`. - * `<marker>` is optional and if present is one of `"reply"`, `"root"`, or `"mention"`. + * `<marker>` is optional and if present is one of `"reply"`, `"root"`. * `<pubkey>` is optional, SHOULD be the pubkey of the author of the referenced event -Those marked with `"reply"` denote the id of the reply event being responded to. Those marked with `"root"` denote the root id of the reply thread being responded to. For top level replies (those replying directly to the root event), only the `"root"` marker should be used. Those marked with `"mention"` denote a quoted or reposted event id. +Those marked with `"reply"` denote the id of the reply event being responded to. Those marked with `"root"` denote the root id of the reply thread being responded to. For top level replies (those replying directly to the root event), only the `"root"` marker should be used. A direct reply to the root of a thread should have a single marked "e" tag of type "root". From 75f246ed987c23c99d77bfa6aeeb1afb669e23f7 Mon Sep 17 00:00:00 2001 From: Roland <33993199+rolznz@users.noreply.github.com> Date: Sat, 8 Feb 2025 03:25:31 +0700 Subject: [PATCH 75/80] docs: clarify NIP-47 key usage (#1756) --- 47.md | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/47.md b/47.md index f15dc014..84f710e2 100644 --- a/47.md +++ b/47.md @@ -1,7 +1,7 @@ NIP-47 ====== -Nostr Wallet Connect +Nostr Wallet Connect (NWC) -------------------- `draft` `optional` @@ -17,6 +17,9 @@ This NIP describes a way for clients to access a remote lightning wallet through * **wallet service**: Nostr app that typically runs on an always-on computer (eg. in the cloud or on a Raspberry Pi). This app has access to the APIs of the wallets it serves. ## Theory of Operation + +Fundamentally NWC is communication between a **client** and **wallet service** by the means of E2E-encrypted direct messages over a nostr relay. The relay knows the kinds and tags of notes, but not the content of the encrypted payloads. The **user**'s identity key is not used to avoid linking payment activity to the user. Ideally unique keys are used for each individual connection. + 1. **Users** who wish to use this NIP to allow **client(s)** to interact with their wallet must first acquire a special "connection" URI from their NIP-47 compliant wallet application. The wallet application may provide this URI using a QR screen, or a pasteable string, or some other means. 2. The **user** should then copy this URI into their **client(s)** by pasting, or scanning the QR, etc. The **client(s)** should save this URI and use it later whenever the **user** (or the **client** on the user's behalf) wants to interact with the wallet. The **client** should then request an `info` (13194) event from the relay(s) specified in the URI. The **wallet service** will have sent that event to those relays earlier, and the relays will hold it as a replaceable event. @@ -45,7 +48,7 @@ If the **wallet service** supports notifications, the info event SHOULD contain ### Request and Response Events -Both the request and response events SHOULD contain one `p` tag, containing the public key of the **wallet service** if this is a request, and the public key of the **user** if this is a response. The response event SHOULD contain an `e` tag with the id of the request event it is responding to. +Both the request and response events SHOULD contain one `p` tag, containing the public key of the **wallet service** if this is a request, and the public key of the **client** if this is a response. The response event SHOULD contain an `e` tag with the id of the request event it is responding to. Optionally, a request can have an `expiration` tag that has a unix timestamp in seconds. If the request is received after this timestamp, it should be ignored. The content of requests and responses is encrypted with [NIP04](04.md), and is a JSON-RPCish object with a semi-fixed structure: @@ -80,7 +83,7 @@ If the command was successful, the `error` field must be null. ### Notification Events -The notification event SHOULD contain one `p` tag, the public key of the **user**. +The notification event SHOULD contain one `p` tag, the public key of the **client**. The content of notifications is encrypted with [NIP04](04.md), and is a JSON-RPCish object with a semi-fixed structure: @@ -105,19 +108,27 @@ The content of notifications is encrypted with [NIP04](04.md), and is a JSON-RPC - `OTHER`: Other error. ## Nostr Wallet Connect URI -**client** discovers **wallet service** by scanning a QR code, handling a deeplink or pasting in a URI. -The **wallet service** generates this connection URI with protocol `nostr+walletconnect://` and base path its hex-encoded `pubkey` with the following query string parameters: +Communication between the **client** and **wallet service** requires two keys in order to encrypt and decrypt messages. The connection URI includes the secret key of the **client** and only the public key of the **wallet service**. + +The **client** discovers **wallet service** by scanning a QR code, handling a deeplink or pasting in a URI. + +The **wallet service** generates this connection URI with protocol `nostr+walletconnect://` and base path its 32-byte hex-encoded `pubkey`, which SHOULD be unique per client connection. + +The connection URI contains the following query string parameters: - `relay` Required. URL of the relay where the **wallet service** is connected and will be listening for events. May be more than one. -- `secret` Required. 32-byte randomly generated hex encoded string. The **client** MUST use this to sign events and encrypt payloads when communicating with the **wallet service**. +- `secret` Required. 32-byte randomly generated hex encoded string. The **client** MUST use this to sign events and encrypt payloads when communicating with the **wallet service**. The **wallet service** MUST use the corresponding public key of this secret to communicate with the **client**. - Authorization does not require passing keys back and forth. - The user can have different keys for different applications. Keys can be revoked and created at will and have arbitrary constraints (eg. budgets). - The key is harder to leak since it is not shown to the user and backed up. - It improves privacy because the user's main key would not be linked to their payments. - `lud16` Recommended. A lightning address that clients can use to automatically setup the `lud16` field on the user's profile if they have none configured. -The **client** should then store this connection and use it when the user wants to perform actions like paying an invoice. Due to this NIP using ephemeral events, it is recommended to pick relays that do not close connections on inactivity to not drop events. +The **client** should then store this connection and use it when the user wants to perform actions like paying an invoice. Due to this NIP using ephemeral events, it is recommended to pick relays that do not close connections on inactivity to not drop events, and ideally retain the events until they are either consumed or become stale. + +- When the **client** sends or receives a message it will use the `secret` from the connection URI and **wallet service**'s `pubkey` to encrypt or decrypt. +- When the **wallet service** sends or receives a message it will use its own secret and the corresponding pubkey of the **client's** `secret` to encrypt or decrypt. The **wallet service** SHOULD NOT store the secret it generates for the client and MUST NOT rely on the knowing the **client** secret for general operation. ### Example connection string ```sh From ab861e98c146a28e289e724d6a7453d10395257d Mon Sep 17 00:00:00 2001 From: "P. Reis" <patrickpereirareal1@gmail.com> Date: Sat, 8 Feb 2025 09:49:00 -0300 Subject: [PATCH 76/80] NIP-61: nitpick (#1765) --- 61.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/61.md b/61.md index ffe7c523..7b7b2ce4 100644 --- a/61.md +++ b/61.md @@ -48,7 +48,7 @@ Clients MUST prefix the public key they P2PK-lock with `"02"` (for nostr<>cashu { kind: 9321, content: "Thanks for this great idea.", - pubkey: "sender-pubkey", + pubkey: "<sender-pubkey>", tags: [ [ "proof", "{\"amount\":1,\"C\":\"02277c66191736eb72fce9d975d08e3191f8f96afb73ab1eec37e4465683066d3f\",\"id\":\"000a93d6f8a1d2c4\",\"secret\":\"[\\\"P2PK\\\",{\\\"nonce\\\":\\\"b00bdd0467b0090a25bdf2d2f0d45ac4e355c482c1418350f273a04fedaaee83\\\",\\\"data\\\":\\\"02eaee8939e3565e48cc62967e2fde9d8e2a4b3ec0081f29eceff5c64ef10ac1ed\\\"}]\"}" ], [ "u", "https://stablenut.umint.cash" ], From 5991afb9cf7ec06866d9f9afd7ec2359109a3b2a Mon Sep 17 00:00:00 2001 From: Zig Blathazar <42387185+ZigBalthazar@users.noreply.github.com> Date: Sat, 8 Feb 2025 16:27:38 +0330 Subject: [PATCH 77/80] add restricted to standardized machine-readable prefixes (#1685) --- 01.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/01.md b/01.md index 5873eb63..e2b4ad44 100644 --- a/01.md +++ b/01.md @@ -168,9 +168,10 @@ This NIP defines no rules for how `NOTICE` messages should be sent or treated. * `["OK", "b1a649ebe8...", false, "rate-limited: slow down there chief"]` * `["OK", "b1a649ebe8...", false, "invalid: event creation date is too far off from the current time"]` * `["OK", "b1a649ebe8...", false, "pow: difficulty 26 is less than 30"]` + * `["OK", "b1a649ebe8...", false, "restricted: not allowed to write."]` * `["OK", "b1a649ebe8...", false, "error: could not connect to the database"]` - `CLOSED` messages MUST be sent in response to a `REQ` when the relay refuses to fulfill it. It can also be sent when a relay decides to kill a subscription on its side before a client has disconnected or sent a `CLOSE`. This message uses the same pattern of `OK` messages with the machine-readable prefix and human-readable message. Some examples: * `["CLOSED", "sub1", "unsupported: filter contains unknown elements"]` * `["CLOSED", "sub1", "error: could not connect to the database"]` * `["CLOSED", "sub1", "error: shutting down idle subscription"]` -- The standardized machine-readable prefixes for `OK` and `CLOSED` are: `duplicate`, `pow`, `blocked`, `rate-limited`, `invalid`, and `error` for when none of that fits. +- The standardized machine-readable prefixes for `OK` and `CLOSED` are: `duplicate`, `pow`, `blocked`, `rate-limited`, `invalid`, `restricted`, and `error` for when none of that fits. From e41185867f60061bb12ae092c6f7162571c06891 Mon Sep 17 00:00:00 2001 From: Oscar Merry <MerryOscar@users.noreply.github.com> Date: Sun, 9 Feb 2025 23:51:52 +0000 Subject: [PATCH 78/80] NIP-53 Live Events - Optional Pinned Chat Messages (#1577) --- 53.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/53.md b/53.md index c3f15ea0..cd84e4fe 100644 --- a/53.md +++ b/53.md @@ -35,7 +35,8 @@ For example: ["p", "91cf9..4e5ca", "wss://provider1.com/", "Host", "<proof>"], ["p", "14aeb..8dad4", "wss://provider2.com/nostr", "Speaker"], ["p", "612ae..e610f", "ws://provider3.com/ws", "Participant"], - ["relays", "wss://one.com", "wss://two.com", /*...*/] + ["relays", "wss://one.com", "wss://two.com", /*...*/], + ["pinned", "<event id of pinned live chat message>"], ], "content": "", // other fields... @@ -75,6 +76,8 @@ Event `kind:1311` is live chat's channel message. Clients MUST include the `a` t } ``` +Hosts may choose to pin one or more live chat messages by updating the `pinned` tags in the live event kind `30311`. + ## Use Cases Common use cases include meeting rooms/workshops, watch-together activities, or event spaces, such as [zap.stream](https://zap.stream). From 60c6404bd1a7ab7d78fca905928c83987846ca13 Mon Sep 17 00:00:00 2001 From: "P. Reis" <patrickpereirareal1@gmail.com> Date: Mon, 10 Feb 2025 09:25:21 -0300 Subject: [PATCH 79/80] 61: nitpick (#1769) --- 61.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/61.md b/61.md index 7b7b2ce4..6e378066 100644 --- a/61.md +++ b/61.md @@ -52,7 +52,7 @@ Clients MUST prefix the public key they P2PK-lock with `"02"` (for nostr<>cashu tags: [ [ "proof", "{\"amount\":1,\"C\":\"02277c66191736eb72fce9d975d08e3191f8f96afb73ab1eec37e4465683066d3f\",\"id\":\"000a93d6f8a1d2c4\",\"secret\":\"[\\\"P2PK\\\",{\\\"nonce\\\":\\\"b00bdd0467b0090a25bdf2d2f0d45ac4e355c482c1418350f273a04fedaaee83\\\",\\\"data\\\":\\\"02eaee8939e3565e48cc62967e2fde9d8e2a4b3ec0081f29eceff5c64ef10ac1ed\\\"}]\"}" ], [ "u", "https://stablenut.umint.cash" ], - [ "e", "<zapped-event-id>", "<relay-hint>" ], + [ "e", "<nutzapped-event-id>", "<relay-hint>" ], [ "p", "e9fbced3a42dcf551486650cc752ab354347dd413b307484e4fd1818ab53f991" ], // recipient of nutzap ] } From 6e7a618e7f873bb91e743caacc3b09edab7796a0 Mon Sep 17 00:00:00 2001 From: water <130329555+water783@users.noreply.github.com> Date: Wed, 12 Feb 2025 01:28:17 +0800 Subject: [PATCH 80/80] Add Kind 15 for Encrypted File message (#1537) --- 17.md | 42 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 41 insertions(+), 1 deletion(-) diff --git a/17.md b/17.md index f091a969..1bc258d8 100644 --- a/17.md +++ b/17.md @@ -35,6 +35,46 @@ Tags that mention, quote and assemble threading structures MUST follow [NIP-10]( Kind `14`s MUST never be signed. If it is signed, the message might leak to relays and become **fully public**. +## File Message Kind + +```jsonc +{ + "id": "<usual hash>", + "pubkey": "<sender-pubkey>", + "created_at": "<current-time>", + "kind": 15, + "tags": [ + ["p", "<receiver-1-pubkey>", "<relay-url>"], + ["p", "<receiver-2-pubkey>", "<relay-url>"], + ["e", "<kind-14-id>", "<relay-url>", "reply"], // if this is a reply + ["subject", "<conversation-title>"], + ["file-type", "<file-mime-type>"], + ["encryption-algorithm", "<encryption-algorithm>"], + ["decryption-key", "<decryption-key>"], + ["decryptiion-nonce", "<decryption-nonce>"], + ["x", "<the SHA-256 hexencoded string of the file>"], + // rest of tags... + ], + "content": "<file-url>" +} +``` + +Kind 15 is used for sending encrypted file event messages: + +- `file-type`: Specifies the MIME type of the attached file (e.g., `image/jpeg`, `audio/mpeg`, etc.). +- `encryption-algorithm`: Indicates the encryption algorithm used for encrypting the file. Supported algorithms may include `aes-gcm`, `chacha20-poly1305`,`aes-cbc` etc. +- `decryption-key`: The decryption key that will be used by the recipient to decrypt the file. +- `decryption-nonce`: The decryption nonce that will be used by the recipient to decrypt the file. +- `content`: The URL of the file (`<file-url>`). +- `x` containing the SHA-256 hexencoded string of the file. +- `size` (optional) size of file in bytes +- `dim` (optional) size of file in pixels in the form `<width>x<height>` +- `blurhash`(optional) the [blurhash](https://github.com/woltapp/blurhash) to show while the file is being loaded by the client +- `thumb` (optional) url of thumbnail with same aspect ratio +- `fallback` (optional) zero or more fallback file sources in case `url` fails + +Just like kind 14, kind `15`s MUST never be signed. + ## Chat Rooms The set of `pubkey` + `p` tags defines a chat room. If a new `p` tag is added or a current one is removed, a new room is created with clean message history. @@ -45,7 +85,7 @@ An optional `subject` tag defines the current name/topic of the conversation. An ## Encrypting -Following [NIP-59](59.md), the **unsigned** `kind:14` chat message must be sealed (`kind:13`) and then gift-wrapped (`kind:1059`) to each receiver and the sender individually. +Following [NIP-59](59.md), the **unsigned** `kind:14` & `kind:15` chat message must be sealed (`kind:13`) and then gift-wrapped (`kind:1059`) to each receiver and the sender individually. ```jsonc {