mirror of
https://github.com/nostr-protocol/nips.git
synced 2024-11-13 23:39:08 -05:00
44 lines
2.5 KiB
Markdown
44 lines
2.5 KiB
Markdown
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": <unix timestamp in seconds>,
|
|
"kind": 30063,
|
|
"tags": [
|
|
["d", <string with name of file>],
|
|
["url",<string with URL of file>],
|
|
["decrypt",<algorithm>,<key>],
|
|
["p", <32-bytes hex of a pubkey>, <recommended relay URL>],
|
|
],
|
|
"content": <description>,
|
|
"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: <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
|
|
-------------------
|
|
* 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.
|