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

get rid of these arbitrary markdown linebreaks and put everything in the same line.

Browse Source
This commit is contained in:
fiatjaf 2023-11-18 11:36:20 -03:00
parent 2d678bcd5a
commit 5e6e7a2bc8
No known key found for this signature in database
GPG Key ID: BAD43C4BE5C1A3A1
1 changed files with 6 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
51.md
View File

@ -6,24 +6,17 @@ Lists
`draft` `optional` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema` `author:gzuuus` `draft` `optional` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema` `author:gzuuus`
This NIP defines lists of things that users can create. Lists can contain references to anything, and these This NIP defines lists of things that users can create. Lists can contain references to anything, and these references can be **public** or **private**.
references can be **public** or **private**.
Public items in a list are specified in the event `tags` array, while private items are specified in a JSON Public items in a list are specified in the event `tags` array, while private items are specified in a JSON array that mimics the structure of the event `tags` array, but stringified and encrypted using the same scheme from [NIP-04](04.md) (the shared key is computed using the author's public and private key) and stored in the `.content`.
array that mimics the structure of the event `tags` array, but stringified and encrypted using the same
scheme from [NIP-04](04.md) (the shared key is computed using the author's public and private key) and
stored in the `.content`.
## Types of lists ## Types of lists
## Standard lists ## Standard lists
Standard lists use non-parameterized replaceable events, meaning users may only have a single list Standard lists use non-parameterized 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.
of each kind. They have special meaning and clients may rely on them to augment a user's profile or
browsing experience.
For example, _mute lists_ can contain the public keys of spammers and bad actors users don't want to see in For example, _mute lists_ can contain the public keys of spammers and bad actors users don't want to see in their feeds or receive annoying notifications from.
their feeds or receive annoying notifications from.
| name | kind | description | expected tag items | | name | kind | description | expected tag items |
| --- | --- | --- | --- | | --- | --- | --- | --- |
@ -39,13 +32,9 @@ their feeds or receive annoying notifications from.
## Sets ## Sets
Sets are lists with well-defined meaning that can enhance the functionality and the UI of clients that rely 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.
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.
For example, _relay sets_ can be displayed in a dropdown UI to give users the option to switch to which For example, _relay sets_ can be displayed in a dropdown UI to give users the option to switch to which relays they will publish an event or from which relays they will read the replies to an event; _curation sets_ can be used by apps to showcase curations made by others tagged to different topics.
relays they will publish an event or from which relays they will read the replies to an event; _curation sets_
can be used by apps to showcase curations made by others tagged to different topics.
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. 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.