upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
path: root/51.md
diff options
context:
space:
mode:
Diffstat (limited to '51.md')
-rw-r--r--51.md23
1 files changed, 6 insertions, 17 deletions
diff --git a/51.md b/51.md
index b42bc8b..f9f567a 100644
--- a/51.md
+++ b/51.md
@@ -6,24 +6,17 @@ Lists
6 6
7`draft` `optional` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema` `author:gzuuus` 7`draft` `optional` `author:fiatjaf` `author:arcbtc` `author:monlovesmango` `author:eskema` `author:gzuuus`
8 8
9This NIP defines lists of things that users can create. Lists can contain references to anything, and these 9This NIP defines lists of things that users can create. Lists can contain references to anything, and these references can be **public** or **private**.
10references can be **public** or **private**.
11 10
12Public items in a list are specified in the event `tags` array, while private items are specified in a JSON 11Public 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`.
13array that mimics the structure of the event `tags` array, but stringified and encrypted using the same
14scheme from [NIP-04](04.md) (the shared key is computed using the author's public and private key) and
15stored in the `.content`.
16 12
17## Types of lists 13## Types of lists
18 14
19## Standard lists 15## Standard lists
20 16
21Standard lists use non-parameterized replaceable events, meaning users may only have a single list 17Standard 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.
22of each kind. They have special meaning and clients may rely on them to augment a user's profile or
23browsing experience.
24 18
25For example, _mute lists_ can contain the public keys of spammers and bad actors users don't want to see in 19For 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.
26their feeds or receive annoying notifications from.
27 20
28| name | kind | description | expected tag items | 21| name | kind | description | expected tag items |
29| --- | --- | --- | --- | 22| --- | --- | --- | --- |
@@ -39,13 +32,9 @@ their feeds or receive annoying notifications from.
39 32
40## Sets 33## Sets
41 34
42Sets are lists with well-defined meaning that can enhance the functionality and the UI of clients that rely 35Sets 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.
43on them. Unlike standard lists, users are expected to have more than one set of each kind, therefore each of
44them must be assigned a different `"d"` identifier.
45 36
46For example, _relay sets_ can be displayed in a dropdown UI to give users the option to switch to which 37For 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.
47relays they will publish an event or from which relays they will read the replies to an event; _curation sets_
48can be used by apps to showcase curations made by others tagged to different topics.
49 38
50Aside 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. 39Aside 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.
51 40