From a090de2b90f9fd83e49fa39ff4c7ef52750e904b Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Thu, 9 Mar 2023 14:01:19 +0000 Subject: [PATCH 01/23] create draft NIP 94 and 95 --- 94.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 95.md | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 78 insertions(+) create mode 100644 94.md create mode 100644 95.md diff --git a/94.md b/94.md new file mode 100644 index 00000000..06b03c8c --- /dev/null +++ b/94.md @@ -0,0 +1,43 @@ +NIP-94 - File Header +====== +`draft` `optional` `author:frbitten` + +The purpose of this NIP is to allow an organization and classification of shared files. So that relays can filter and organize in any way that is of interest. +Also the goal is to create a base on the protocol for this bountsr "Filesharing App" (https://bountsr.org/p2p-filesharing/) to be implemented. + +Nostr event +------------------ +This NIP specifies the use of the `30063` event type (parameterized replaceable event), having in `content` a description of the file content, and a list of tags described below: +* `d` containing the name of the shared file to allow it to be overwritten in the future. +* `url` the url to download the file +* `type` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) +* `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the information (the key) that allow the decryption of the file + +```json +{ + "id": <32-bytes lowercase hex-encoded sha256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": , + "kind": 30063, + "tags": [ + ["d", ], + ["url",], + ["decrypt",,], + ["p", <32-bytes hex of a pubkey>, ], + ], + "content": "A beautiful picture of a wild toucan", + "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> +} + +Client Behavior +--------------- +The client can use this event as they see fit. Either showing events in the same feed as kind 1 events or creating a specific feed for file listings +It allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, telegram, etc. Exemple: +To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image + +Suggested Use Cases +------------------- +* A relay for indexing shared files. For example to promote torrents +* A Pinterest-like relay and app where people can share their portfolio and inspire others. +* A simple way to distribute configurations and software updates. +* Specialized relays can provide collections of emojis, memes and animated gifs to be used in notes. diff --git a/95.md b/95.md new file mode 100644 index 00000000..680496c9 --- /dev/null +++ b/95.md @@ -0,0 +1,35 @@ +NIP-95 Base64 File +====== +`draft` `optional` `author:frbitten` + +This NIP allows users to send binary data to be stored in the relay. This data can be small pieces of information or even large files. + +Nostr event +------------------ +This NIP specifies the use of the `30064` event type (parameterized replaceable event), having in `content` the binary data that you want to be stored in Base64 format. +* `d` containing the name of the shared file to allow it to be overwritten in the future. +* `type` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) +* `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the information (the key) that allow the decryption of the file + +This event must not be returned in generic searches. It should only be returned if specifically requested by your ID. This avoids bandwidth consumption and unnecessary overload on the relay and client. + +The `NIP-94` can be used to broadcast the ID of that event, with the ` and ` tag referencing the event id, without having to send the full event which can be a lot of data. + +Relay Behavior +--------------- +Relays that use a relational database may have more difficulty implementing this NIP, but a possible solution is for this NIP not to be recorded in the database, but on disk, the file name being the event id. So it can be easily found and searched. And because it is not in the database, it does not interfere with the indexing of common events. + +Another solution is for Relays that want to implement this functionality and use a No-SQL database with mongodb that already supports large documents without harming performance. + +The relay can allow access to this data via URL, having its own URL pattern for these cases. And if you receive a `NIP-94` referring to a `NIP-95` you can include the URL in the proper `NIP-94` tag + +Client Behavior +--------------- +The client can use this event for any type of storage it wants. The functionality of uploading an image directly through the client's interface and including it in the note that is being created is a very useful facility for the end user. In this case, 3 events would be created. Kind 30064 with the file converted to base64, Kind 30063 which is the header of this file for dissemination and Kind 1 with the post and the image. + +Also, when used in conjunction with `NIP-94`, it allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, tegegran, etc.Exemple: . To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image + +Suggested Use Cases +------------------- +* Provide file storage service that is quickly integrable with nostr clients. +* Create an application similar to pinterest without the need for other protocols. From 342722963b5d6716410166c8e02d7d0b7cabb0f3 Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Thu, 9 Mar 2023 14:04:57 +0000 Subject: [PATCH 02/23] fixed json schema --- 94.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/94.md b/94.md index 06b03c8c..0798d743 100644 --- a/94.md +++ b/94.md @@ -25,7 +25,7 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable ["decrypt",,], ["p", <32-bytes hex of a pubkey>, ], ], - "content": "A beautiful picture of a wild toucan", + "content": , "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> } From 0ef5486e569f3e9888cab1030edea96785c360e1 Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Thu, 9 Mar 2023 14:05:07 +0000 Subject: [PATCH 03/23] add json schema --- 95.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/95.md b/95.md index 680496c9..ffb3906a 100644 --- a/95.md +++ b/95.md @@ -15,6 +15,21 @@ This event must not be returned in generic searches. It should only be returned The `NIP-94` can be used to broadcast the ID of that event, with the ` and ` tag referencing the event id, without having to send the full event which can be a lot of data. +```json +{ + "id": <32-bytes lowercase hex-encoded sha256 of the the serialized event data>, + "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, + "created_at": , + "kind": 30064, + "tags": [ + ["d", ], + ["decrypt",,], + ["p", <32-bytes hex of a pubkey>, ], + ], + "content": , + "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> +} + Relay Behavior --------------- Relays that use a relational database may have more difficulty implementing this NIP, but a possible solution is for this NIP not to be recorded in the database, but on disk, the file name being the event id. So it can be easily found and searched. And because it is not in the database, it does not interfere with the indexing of common events. From 8ea7c51f9b4fd81e4f5e390881bff43243455d16 Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Thu, 9 Mar 2023 14:08:52 +0000 Subject: [PATCH 04/23] add hash tag --- 94.md | 1 + 95.md | 1 + 2 files changed, 2 insertions(+) diff --git a/94.md b/94.md index 0798d743..7712171e 100644 --- a/94.md +++ b/94.md @@ -24,6 +24,7 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable ["url",], ["decrypt",,], ["p", <32-bytes hex of a pubkey>, ], + ["hash",< SHA256 hexencoded string of the file> ], "content": , "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> diff --git a/95.md b/95.md index ffb3906a..4c2dde8c 100644 --- a/95.md +++ b/95.md @@ -25,6 +25,7 @@ The `NIP-94` can be used to broadcast the ID of that event, with the ` and ` tag ["d", ], ["decrypt",,], ["p", <32-bytes hex of a pubkey>, ], + ["hash",< SHA256 hexencoded string of the raw data>] ], "content": , "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> From d212622ed113b9c19bab160c484c3c25fba6131f Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Fri, 10 Mar 2023 10:04:00 +0000 Subject: [PATCH 05/23] fix format text in md --- 94.md | 3 ++- 95.md | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index 7712171e..feead69e 100644 --- a/94.md +++ b/94.md @@ -29,11 +29,12 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable "content": , "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> } +``` Client Behavior --------------- The client can use this event as they see fit. Either showing events in the same feed as kind 1 events or creating a specific feed for file listings -It allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, telegram, etc. Exemple: +It allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, telegram, etc. Exemple: ![example](https://ibb.co/Fnj5TMg) To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image Suggested Use Cases diff --git a/95.md b/95.md index 4c2dde8c..755471f2 100644 --- a/95.md +++ b/95.md @@ -30,6 +30,7 @@ The `NIP-94` can be used to broadcast the ID of that event, with the ` and ` tag "content": , "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> } +``` Relay Behavior --------------- @@ -43,7 +44,7 @@ Client Behavior --------------- The client can use this event for any type of storage it wants. The functionality of uploading an image directly through the client's interface and including it in the note that is being created is a very useful facility for the end user. In this case, 3 events would be created. Kind 30064 with the file converted to base64, Kind 30063 which is the header of this file for dissemination and Kind 1 with the post and the image. -Also, when used in conjunction with `NIP-94`, it allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, tegegran, etc.Exemple: . To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image +Also, when used in conjunction with `NIP-94`, it allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, tegegran, etc.Exemple: ![example](https://ibb.co/Fnj5TMg). To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image Suggested Use Cases ------------------- From 64797e7910a7dd143c22c28d29e7d6108db806b3 Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Fri, 10 Mar 2023 10:07:49 +0000 Subject: [PATCH 06/23] fix example image --- 94.md | 2 +- 95.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index feead69e..5f5a14ae 100644 --- a/94.md +++ b/94.md @@ -34,7 +34,7 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable Client Behavior --------------- The client can use this event as they see fit. Either showing events in the same feed as kind 1 events or creating a specific feed for file listings -It allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, telegram, etc. Exemple: ![example](https://ibb.co/Fnj5TMg) +It allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, telegram, etc. Exemple: To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image Suggested Use Cases diff --git a/95.md b/95.md index 755471f2..3653f2ba 100644 --- a/95.md +++ b/95.md @@ -44,7 +44,7 @@ Client Behavior --------------- The client can use this event for any type of storage it wants. The functionality of uploading an image directly through the client's interface and including it in the note that is being created is a very useful facility for the end user. In this case, 3 events would be created. Kind 30064 with the file converted to base64, Kind 30063 which is the header of this file for dissemination and Kind 1 with the post and the image. -Also, when used in conjunction with `NIP-94`, it allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, tegegran, etc.Exemple: ![example](https://ibb.co/Fnj5TMg). To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image +Also, when used in conjunction with `NIP-94`, it allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, tegegran, etc.Exemple: . To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image Suggested Use Cases ------------------- From 475bcb6314beafb29e480f70a114947e7c301776 Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Fri, 10 Mar 2023 10:09:38 +0000 Subject: [PATCH 07/23] minor fix --- 94.md | 3 ++- 95.md | 4 +++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index 5f5a14ae..4963f857 100644 --- a/94.md +++ b/94.md @@ -34,7 +34,8 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable Client Behavior --------------- The client can use this event as they see fit. Either showing events in the same feed as kind 1 events or creating a specific feed for file listings -It allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, telegram, etc. Exemple: +It allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, telegram, etc. +Example: To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image Suggested Use Cases diff --git a/95.md b/95.md index 3653f2ba..16536abe 100644 --- a/95.md +++ b/95.md @@ -44,7 +44,9 @@ Client Behavior --------------- The client can use this event for any type of storage it wants. The functionality of uploading an image directly through the client's interface and including it in the note that is being created is a very useful facility for the end user. In this case, 3 events would be created. Kind 30064 with the file converted to base64, Kind 30063 which is the header of this file for dissemination and Kind 1 with the post and the image. -Also, when used in conjunction with `NIP-94`, it allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, tegegran, etc.Exemple: . To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image +Also, when used in conjunction with `NIP-94`, it allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, tegegran, etc. +Example: . +To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image Suggested Use Cases ------------------- From ac515573a0cf039174e850dd60ed79a60487cc2e Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Fri, 10 Mar 2023 10:11:55 +0000 Subject: [PATCH 08/23] ajusts formt text --- 94.md | 6 +++++- 95.md | 2 ++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/94.md b/94.md index 4963f857..1b5d8db1 100644 --- a/94.md +++ b/94.md @@ -33,11 +33,15 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable Client Behavior --------------- -The client can use this event as they see fit. Either showing events in the same feed as kind 1 events or creating a specific feed for file listings +The client can use this event as they see fit. Either showing events in the same feed as kind 1 events or creating a specific feed for file listings. + It allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, telegram, etc. + Example: + To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image + Suggested Use Cases ------------------- * A relay for indexing shared files. For example to promote torrents diff --git a/95.md b/95.md index 16536abe..6f7612fb 100644 --- a/95.md +++ b/95.md @@ -45,7 +45,9 @@ Client Behavior The client can use this event for any type of storage it wants. The functionality of uploading an image directly through the client's interface and including it in the note that is being created is a very useful facility for the end user. In this case, 3 events would be created. Kind 30064 with the file converted to base64, Kind 30063 which is the header of this file for dissemination and Kind 1 with the post and the image. Also, when used in conjunction with `NIP-94`, it allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, tegegran, etc. + Example: . + To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image Suggested Use Cases From 9d69bd05dcdaa1ee19078937a6150e2720bf9ba5 Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Fri, 10 Mar 2023 10:15:01 +0000 Subject: [PATCH 09/23] ajusts decrypt tag --- 94.md | 2 +- 95.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index 1b5d8db1..51ec1e25 100644 --- a/94.md +++ b/94.md @@ -22,7 +22,7 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable "tags": [ ["d", ], ["url",], - ["decrypt",,], + ["decrypt",,], ["p", <32-bytes hex of a pubkey>, ], ["hash",< SHA256 hexencoded string of the file> ], diff --git a/95.md b/95.md index 6f7612fb..292d04c8 100644 --- a/95.md +++ b/95.md @@ -23,7 +23,7 @@ The `NIP-94` can be used to broadcast the ID of that event, with the ` and ` tag "kind": 30064, "tags": [ ["d", ], - ["decrypt",,], + ["decrypt",,], ["p", <32-bytes hex of a pubkey>, ], ["hash",< SHA256 hexencoded string of the raw data>] ], From 747517f2c462ad603ee5b0b75c20693ef3913363 Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Fri, 10 Mar 2023 10:18:53 +0000 Subject: [PATCH 10/23] ajusts description of decrypt tag --- 94.md | 2 +- 95.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index 51ec1e25..7051ee6c 100644 --- a/94.md +++ b/94.md @@ -11,7 +11,7 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable * `d` containing the name of the shared file to allow it to be overwritten in the future. * `url` the url to download the file * `type` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) -* `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the information (the key) that allow the decryption of the file +* `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the parameters that allow the decryption of the file ```json { diff --git a/95.md b/95.md index 292d04c8..00132df1 100644 --- a/95.md +++ b/95.md @@ -9,7 +9,7 @@ Nostr event This NIP specifies the use of the `30064` event type (parameterized replaceable event), having in `content` the binary data that you want to be stored in Base64 format. * `d` containing the name of the shared file to allow it to be overwritten in the future. * `type` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) -* `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the information (the key) that allow the decryption of the file +* `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the parameters that allow the decryption of the file This event must not be returned in generic searches. It should only be returned if specifically requested by your ID. This avoids bandwidth consumption and unnecessary overload on the relay and client. From 564d06b8a213073e59195f56141b1e8f01903639 Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Fri, 10 Mar 2023 11:06:15 +0000 Subject: [PATCH 11/23] move nip-95 to other branch --- 95.md | 56 -------------------------------------------------------- 1 file changed, 56 deletions(-) delete mode 100644 95.md diff --git a/95.md b/95.md deleted file mode 100644 index 00132df1..00000000 --- a/95.md +++ /dev/null @@ -1,56 +0,0 @@ -NIP-95 Base64 File -====== -`draft` `optional` `author:frbitten` - -This NIP allows users to send binary data to be stored in the relay. This data can be small pieces of information or even large files. - -Nostr event ------------------- -This NIP specifies the use of the `30064` event type (parameterized replaceable event), having in `content` the binary data that you want to be stored in Base64 format. -* `d` containing the name of the shared file to allow it to be overwritten in the future. -* `type` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) -* `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the parameters that allow the decryption of the file - -This event must not be returned in generic searches. It should only be returned if specifically requested by your ID. This avoids bandwidth consumption and unnecessary overload on the relay and client. - -The `NIP-94` can be used to broadcast the ID of that event, with the ` and ` tag referencing the event id, without having to send the full event which can be a lot of data. - -```json -{ - "id": <32-bytes lowercase hex-encoded sha256 of the the serialized event data>, - "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, - "created_at": , - "kind": 30064, - "tags": [ - ["d", ], - ["decrypt",,], - ["p", <32-bytes hex of a pubkey>, ], - ["hash",< SHA256 hexencoded string of the raw data>] - ], - "content": , - "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> -} -``` - -Relay Behavior ---------------- -Relays that use a relational database may have more difficulty implementing this NIP, but a possible solution is for this NIP not to be recorded in the database, but on disk, the file name being the event id. So it can be easily found and searched. And because it is not in the database, it does not interfere with the indexing of common events. - -Another solution is for Relays that want to implement this functionality and use a No-SQL database with mongodb that already supports large documents without harming performance. - -The relay can allow access to this data via URL, having its own URL pattern for these cases. And if you receive a `NIP-94` referring to a `NIP-95` you can include the URL in the proper `NIP-94` tag - -Client Behavior ---------------- -The client can use this event for any type of storage it wants. The functionality of uploading an image directly through the client's interface and including it in the note that is being created is a very useful facility for the end user. In this case, 3 events would be created. Kind 30064 with the file converted to base64, Kind 30063 which is the header of this file for dissemination and Kind 1 with the post and the image. - -Also, when used in conjunction with `NIP-94`, it allows the app to create image galleries (memes, animations) that can be reused countless times in different notes. As it exists in whatsapp, tegegran, etc. - -Example: . - -To do this, just select the image from the gallery (events NIP-94) and include the URL of the selected image - -Suggested Use Cases -------------------- -* Provide file storage service that is quickly integrable with nostr clients. -* Create an application similar to pinterest without the need for other protocols. From 2b8f12caab99f465785d17e5ac3532e52ca9c93e Mon Sep 17 00:00:00 2001 From: Fernando Bittencourt Date: Fri, 17 Mar 2023 13:29:22 +0000 Subject: [PATCH 12/23] Update 94.md suggestion by arthurfranca Co-authored-by: arthurfranca --- 94.md | 1 - 1 file changed, 1 deletion(-) diff --git a/94.md b/94.md index 7051ee6c..21eefc95 100644 --- a/94.md +++ b/94.md @@ -8,7 +8,6 @@ Also the goal is to create a base on the protocol for this bountsr "Filesharing Nostr event ------------------ This NIP specifies the use of the `30063` event type (parameterized replaceable event), having in `content` a description of the file content, and a list of tags described below: -* `d` containing the name of the shared file to allow it to be overwritten in the future. * `url` the url to download the file * `type` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) * `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the parameters that allow the decryption of the file From fddce814a37e66ba9eaf1f1f1f089ce7761309ec Mon Sep 17 00:00:00 2001 From: Fernando Bittencourt Date: Fri, 17 Mar 2023 13:29:55 +0000 Subject: [PATCH 13/23] Update 94.md change tag hash with suggestion by arthurfranca Co-authored-by: arthurfranca --- 94.md | 1 + 1 file changed, 1 insertion(+) diff --git a/94.md b/94.md index 21eefc95..13cd2310 100644 --- a/94.md +++ b/94.md @@ -11,6 +11,7 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable * `url` the url to download the file * `type` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) * `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the parameters that allow the decryption of the file +* `hash` containing the SHA-256 hexencoded string of the file or the BlurHash string (for images). The third array value is the lowercase chosen algorithm name: "sha256" or "blurhash". ```json { From 6b9d93c2857dd4714675543f45e7f55a653d1ff5 Mon Sep 17 00:00:00 2001 From: Fernando Bittencourt Date: Fri, 17 Mar 2023 13:31:22 +0000 Subject: [PATCH 14/23] Update 94.md change hash tag with suggestion by arthutfranca Co-authored-by: arthurfranca --- 94.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/94.md b/94.md index 13cd2310..13315e0c 100644 --- a/94.md +++ b/94.md @@ -24,7 +24,7 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable ["url",], ["decrypt",,], ["p", <32-bytes hex of a pubkey>, ], - ["hash",< SHA256 hexencoded string of the file> + ["hash", "LKN]Rv%2Tw=w]~RBVZRi};RPxuwH", "blurhash"] ], "content": , "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> From 088c3bba1d730dcc80b376153288f918005ca3ce Mon Sep 17 00:00:00 2001 From: Fernando Bittencourt Date: Fri, 17 Mar 2023 13:34:04 +0000 Subject: [PATCH 15/23] Update 94.md fixed by arthurfranca Co-authored-by: arthurfranca --- 94.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/94.md b/94.md index 13315e0c..81e2bf27 100644 --- a/94.md +++ b/94.md @@ -23,7 +23,7 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable ["d", ], ["url",], ["decrypt",,], - ["p", <32-bytes hex of a pubkey>, ], + ["type", "image/webp"], ["hash", "LKN]Rv%2Tw=w]~RBVZRi};RPxuwH", "blurhash"] ], "content": , From 40fa44b0fc0f358995bf8c162087a11173d912cc Mon Sep 17 00:00:00 2001 From: Fernando Bittencourt Date: Fri, 17 Mar 2023 13:34:21 +0000 Subject: [PATCH 16/23] Update 94.md change to regular event Co-authored-by: arthurfranca --- 94.md | 1 - 1 file changed, 1 deletion(-) diff --git a/94.md b/94.md index 81e2bf27..dfc77d93 100644 --- a/94.md +++ b/94.md @@ -20,7 +20,6 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable "created_at": , "kind": 30063, "tags": [ - ["d", ], ["url",], ["decrypt",,], ["type", "image/webp"], From bd32adfc2aba90b3a3e486c7b856c93480301992 Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Fri, 17 Mar 2023 13:41:46 +0000 Subject: [PATCH 17/23] change to regular event --- 94.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/94.md b/94.md index dfc77d93..533b49cb 100644 --- a/94.md +++ b/94.md @@ -7,7 +7,7 @@ Also the goal is to create a base on the protocol for this bountsr "Filesharing Nostr event ------------------ -This NIP specifies the use of the `30063` event type (parameterized replaceable event), 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 type (parameterized replaceable event), having in `content` a description of the file content, and a list of tags described below: * `url` the url to download the file * `type` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) * `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the parameters that allow the decryption of the file @@ -18,12 +18,12 @@ This NIP specifies the use of the `30063` event type (parameterized replaceable "id": <32-bytes lowercase hex-encoded sha256 of the the serialized event data>, "pubkey": <32-bytes lowercase hex-encoded public key of the event creator>, "created_at": , - "kind": 30063, + "kind": 1063, "tags": [ ["url",], ["decrypt",,], - ["type", "image/webp"], - ["hash", "LKN]Rv%2Tw=w]~RBVZRi};RPxuwH", "blurhash"] + ["type", ], + ["hash", "LKN]Rv%2Tw=w]~RBVZRi};RPxuwH", <"blurhash" or "sha256">] ], "content": , "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> From f766a850cd6cc72f35681906b519031745cbc5a8 Mon Sep 17 00:00:00 2001 From: Fernando Bittencourt Date: Tue, 28 Mar 2023 09:57:56 +0100 Subject: [PATCH 18/23] Apply suggestions from code review add sugestion of arthurfranca and nryo-o Co-authored-by: arthurfranca Co-authored-by: Ryo_o <127748188+nryo-o@users.noreply.github.com> --- 94.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index 533b49cb..005ef267 100644 --- a/94.md +++ b/94.md @@ -8,7 +8,7 @@ Also the goal is to create a base on the protocol for this bountsr "Filesharing Nostr event ------------------ This NIP specifies the use of the `1063` event type (parameterized replaceable event), having in `content` a description of the file content, and a list of tags described below: -* `url` the url to download the file +* `r` the url to download the file, without trailing slash * `type` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) * `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the parameters that allow the decryption of the file * `hash` containing the SHA-256 hexencoded string of the file or the BlurHash string (for images). The third array value is the lowercase chosen algorithm name: "sha256" or "blurhash". @@ -20,7 +20,7 @@ This NIP specifies the use of the `1063` event type (parameterized replaceable e "created_at": , "kind": 1063, "tags": [ - ["url",], + ["r",], ["decrypt",,], ["type", ], ["hash", "LKN]Rv%2Tw=w]~RBVZRi};RPxuwH", <"blurhash" or "sha256">] From bfd2a0fc38f85371a85f47891565f410ed0af48f Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Wed, 5 Apr 2023 15:11:59 +0100 Subject: [PATCH 19/23] fixed text description --- 94.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/94.md b/94.md index 005ef267..78c7056c 100644 --- a/94.md +++ b/94.md @@ -7,8 +7,8 @@ Also the goal is to create a base on the protocol for this bountsr "Filesharing Nostr event ------------------ -This NIP specifies the use of the `1063` event type (parameterized replaceable event), having in `content` a description of the file content, and a list of tags described below: -* `r` the url to download the file, without trailing slash +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: +* `r` the url to download the file * `type` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) * `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the parameters that allow the decryption of the file * `hash` containing the SHA-256 hexencoded string of the file or the BlurHash string (for images). The third array value is the lowercase chosen algorithm name: "sha256" or "blurhash". From 34af61df41f7e6c7668cd2c6fbce17042503751e Mon Sep 17 00:00:00 2001 From: frbittencourt Date: Wed, 12 Apr 2023 14:03:52 +0100 Subject: [PATCH 20/23] nip update to reach consensus with other nips --- 94.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/94.md b/94.md index 78c7056c..5c125651 100644 --- a/94.md +++ b/94.md @@ -8,10 +8,14 @@ Also the goal is to create a base on the protocol for this bountsr "Filesharing Nostr event ------------------ 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: -* `r` the url to download the file -* `type` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) -* `decrypt` (optional) If the file is encrypted, you must indicate in the first value the algorithm used to encrypt the file and in the second value the parameters that allow the decryption of the file -* `hash` containing the SHA-256 hexencoded string of the file or the BlurHash string (for images). The third array value is the lowercase chosen algorithm name: "sha256" or "blurhash". +* `url` the url to download the file +* `m` a string indicating the data type of the file. The MIME types format must be used (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) +* `"aes-256-gcm"` (optional) key and nonce for AES-GCM encryption with tagSize always 128bits +* `x` containing the SHA-256 hexencoded string of the file. +* `size` (optional) size of file in bytes +* `magnet` (optional) URI to magnet file +* `i` (optional) torrent infohash +* `blurhash`(optional) for cosmetic purposes ```json { @@ -20,10 +24,14 @@ This NIP specifies the use of the `1063` event type, having in `content` a descr "created_at": , "kind": 1063, "tags": [ - ["r",], - ["decrypt",,], - ["type", ], - ["hash", "LKN]Rv%2Tw=w]~RBVZRi};RPxuwH", <"blurhash" or "sha256">] + ["url",], + ["aes-256-gcm",, ], + ["m", ], + ["x",], + ["size", ], + ["magnet", ], + ["i",], + ["blurhash", ] ], "content": , "sig": <64-bytes hex of the signature of the sha256 hash of the serialized event data, which is the same as the "id" field> From 92536d8b562d20a37aee92fc4e001937845f4ae7 Mon Sep 17 00:00:00 2001 From: Asai Toshiya Date: Fri, 21 Apr 2023 00:45:35 +0900 Subject: [PATCH 21/23] Add NIP-94 and kind 1063 to README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 836a5930..d47bf76a 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/fia - [NIP-58: Badges](58.md) - [NIP-65: Relay List Metadata](65.md) - [NIP-78: Application-specific data](78.md) +- [NIP-94: File Header](94.md) ## Event Kinds @@ -77,6 +78,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/fia | `42` | Channel Message | [28](28.md) | | `43` | Channel Hide Message | [28](28.md) | | `44` | Channel Mute User | [28](28.md) | +| `1063` | File Header | [94](94.md) | | `1984` | Reporting | [56](56.md) | | `9734` | Zap Request | [57](57.md) | | `9735` | Zap | [57](57.md) | From 4b9847802a9fb1a6d13b3967976bca78b5eacb0c Mon Sep 17 00:00:00 2001 From: jiftechnify Date: Fri, 21 Apr 2023 13:04:48 +0900 Subject: [PATCH 22/23] fix: re-add NIP-15 to the list --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index d47bf76a..fb0ddb78 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/fia - [NIP-12: Generic Tag Queries](12.md) - [NIP-13: Proof of Work](13.md) - [NIP-14: Subject tag in text events.](14.md) +- [NIP-15: Nostr Marketplace (for resilient marketplaces)](15.md) - [NIP-16: Event Treatment](16.md) - [NIP-18: Reposts](18.md) - [NIP-19: bech32-encoded entities](19.md) From c5f43a8f9047184258f0e59f3e1fcd759acca4e2 Mon Sep 17 00:00:00 2001 From: michaelhall923 Date: Fri, 21 Apr 2023 09:04:20 -0400 Subject: [PATCH 23/23] Update 01.md Info on "e" and "p" tags is kind of hard to find so I added a link to it in the place that I intuitively looked for it. --- 01.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/01.md b/01.md index ae138246..a07a0dff 100644 --- a/01.md +++ b/01.md @@ -107,5 +107,5 @@ A relay may choose to treat different message kinds differently, and it may or m ## Other Notes: - Clients should not open more than one websocket to each relay. One channel can support an unlimited number of subscriptions, so clients should do that. -- The `tags` array can store a tag identifier as the first element of each subarray, plus arbitrary information afterward (always as strings). This NIP defines `"p"` — meaning "pubkey", which points to a pubkey of someone that is referred to in the event —, and `"e"` — meaning "event", which points to the id of an event this event is quoting, replying to or referring to somehow. +- The `tags` array can store a tag identifier as the first element of each subarray, plus arbitrary information afterward (always as strings). This NIP defines `"p"` — meaning "pubkey", which points to a pubkey of someone that is referred to in the event —, and `"e"` — meaning "event", which points to the id of an event this event is quoting, replying to or referring to somehow. See [NIP-10](https://github.com/nostr-protocol/nips/blob/127d5518bfa9a4e4e7510490c0b8d95e342dfa4b/10.md) for a detailed description of "e" and "p" tags. - The `` item present on the `"e"` and `"p"` tags is an optional (could be set to `""`) URL of a relay the client could attempt to connect to fetch the tagged event or other events from a tagged profile. It MAY be ignored, but it exists to increase censorship resistance and make the spread of relay addresses more seamless across clients.