nostr/nips
1
0
Fork 0
mirror of https://github.com/nostr-protocol/nips.git synced 2024-12-23 00:45:53 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

101.md

Browse Source
This commit is contained in:
unostr 2023-11-17 16:32:22 +03:00 committed by GitHub
parent ba1078b6ce
commit 996e693597
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 40 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
101.md Normal file
View File

@ -0,0 +1,40 @@
NIP-101
=======
Descriptor Note
---------------
`draft` `optional`
A new event type "101" which is a note to describe "stuff" in a human readable way.
"Stuff" here, is represented by an identifier (descriptor if you will) which most likely would be the hash of a data object.
Each line of this note type will have a specific purpose.
The first line is dedicated for the point we want to describe (as mentioned above)
The second line is meant for making a human readable name for the identifier from the first line.
The third line is meant for a label, meaning a short, one-liner, description of the object behind the identifier.
The remaining of the note is for a multi-line description of the object we describe.
Example:
```
1234567890abcdef1234567890abcdef
order-number_12345
webshop order of a T-shirt
"This is awesome" T-shirt in size L.
Ordered from the webshop (order number 12345)
Remember to pack sticker freebies.
```
It is mandatory to fill out the point field; the three other fields are optional.
Making the describing fields optional on protocol level should make the descriptor note format useful for a broader set of applications.
On application level the user/developer can use and constraint the fields as it fits in that particular application.
All semantics regarding the descriptor note is in the note itself (by dedicating specific line numbers to specific fields).
Thereby we do not pollute the Nostr JSON document with extra meta data.
Hence we get more advanced functionality while keeping the Nostr note format itself clean and simple.
For more info the Descriptor Note has its own website over here:
https://descriptor-note.surge.sh