diff options
Diffstat (limited to '51.md')
| -rw-r--r-- | 51.md | 58 |
1 files changed, 36 insertions, 22 deletions
| @@ -1,8 +1,6 @@ | |||
| 1 | NIP-51 | 1 | # NIP-51 |
| 2 | ====== | ||
| 3 | 2 | ||
| 4 | Lists | 3 | ## Lists |
| 5 | ----- | ||
| 6 | 4 | ||
| 7 | `draft` `optional` | 5 | `draft` `optional` |
| 8 | 6 | ||
| @@ -21,7 +19,7 @@ Standard lists use normal replaceable events, meaning users may only have a sing | |||
| 21 | For example, _mute list_ can contain the public keys of spammers and bad actors users don't want to see in their feeds or receive annoying notifications from. | 19 | For example, _mute list_ can contain the public keys of spammers and bad actors users don't want to see in their feeds or receive annoying notifications from. |
| 22 | 20 | ||
| 23 | | name | kind | description | expected tag items | | 21 | | name | kind | description | expected tag items | |
| 24 | | --- | --- | --- | --- | | 22 | | ----------------- | ----- | ----------------------------------------------------------- | --------------------------------------------------------------------------------- | |
| 25 | | Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags), `"word"` (lowercase string), `"e"` (threads) | | 23 | | Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags), `"word"` (lowercase string), `"e"` (threads) | |
| 26 | | Pinned notes | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | | 24 | | Pinned notes | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | |
| 27 | | Bookmarks | 10003 | uncategorized, "global" list of things a user wants to save | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) | | 25 | | Bookmarks | 10003 | uncategorized, "global" list of things a user wants to save | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) | |
| @@ -44,24 +42,25 @@ For example, _relay sets_ can be displayed in a dropdown UI to give users the op | |||
| 44 | 42 | ||
| 45 | 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. | 43 | 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. |
| 46 | 44 | ||
| 47 | | name | kind | description | expected tag items | | 45 | | name | kind | description | expected tag items | |
| 48 | | --- | --- | --- | --- | | 46 | | --------------------- | ----- | -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | |
| 49 | | Follow sets | 30000 | categorized groups of users a client may choose to check out in different circumstances | `"p"` (pubkeys) | | 47 | | Follow sets | 30000 | categorized groups of users a client may choose to check out in different circumstances | `"p"` (pubkeys) | |
| 50 | | Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during various operations | `"relay"` (relay URLs) | | 48 | | Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during various operations | `"relay"` (relay URLs) | |
| 51 | | Bookmark sets | 30003 | user-defined bookmarks categories , for when bookmarks must be in labeled separate groups | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) | | 49 | | Bookmark sets | 30003 | user-defined bookmarks categories , for when bookmarks must be in labeled separate groups | `"e"` (kind:1 notes), `"a"` (kind:30023 articles), `"t"` (hashtags), `"r"` (URLs) | |
| 52 | | Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) | | 50 | | Curation sets | 30004 | groups of articles picked by users as interesting and/or belonging to the same category | `"a"` (kind:30023 articles), `"e"` (kind:1 notes) | |
| 53 | | Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"a"` (kind:34235 videos) | | 51 | | Curation sets | 30005 | groups of videos picked by users as interesting and/or belonging to the same category | `"a"` (kind:34235 videos) | |
| 54 | | Kind mute sets | 30007 | mute pubkeys by kinds<br>`"d"` tag MUST be the kind string | `"p"` (pubkeys) | | 52 | | Kind Curation sets | 30006 | groups of any kind of events picked by users as interesting and/or belonging to the same category<br>`"d"` tag MUST be the kind string | `"e"` or `"a"` | |
| 55 | | Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) | | 53 | | Kind mute sets | 30007 | mute pubkeys by kinds<br>`"d"` tag MUST be the kind string | `"p"` (pubkeys) | |
| 56 | | Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | | 54 | | Interest sets | 30015 | interest topics represented by a bunch of "hashtags" | `"t"` (hashtags) | |
| 57 | | Release artifact sets | 30063 | groups of files of a software release | `"e"` (kind:1063 [file metadata](94.md) events), `"i"` (application identifier, typically reverse domain notation), `"version"` | | 55 | | Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | |
| 56 | | Release artifact sets | 30063 | groups of files of a software release | `"e"` (kind:1063 [file metadata](94.md) events), `"i"` (application identifier, typically reverse domain notation), `"version"` | | ||
| 58 | 57 | ||
| 59 | ## Deprecated standard lists | 58 | ## Deprecated standard lists |
| 60 | 59 | ||
| 61 | Some clients have used these lists in the past, but they should work on transitioning to the [standard formats](#standard-lists) above. | 60 | Some clients have used these lists in the past, but they should work on transitioning to the [standard formats](#standard-lists) above. |
| 62 | 61 | ||
| 63 | | kind | "d" tag | use instead | | 62 | | kind | "d" tag | use instead | |
| 64 | | --- | --- | --- | | 63 | | ----- | --------------- | ----------------------------- | |
| 65 | | 30000 | `"mute"` | kind 10000 _mute list_ | | 64 | | 30000 | `"mute"` | kind 10000 _mute list_ | |
| 66 | | 30001 | `"pin"` | kind 10001 _pin list_ | | 65 | | 30001 | `"pin"` | kind 10001 _pin list_ | |
| 67 | | 30001 | `"bookmark"` | kind 10003 _bookmarks list_ | | 66 | | 30001 | `"bookmark"` | kind 10003 _bookmarks list_ | |
| @@ -97,11 +96,26 @@ Some clients have used these lists in the past, but they should work on transiti | |||
| 97 | "tags": [ | 96 | "tags": [ |
| 98 | ["d", "jvdy9i4"], | 97 | ["d", "jvdy9i4"], |
| 99 | ["name", "Yaks"], | 98 | ["name", "Yaks"], |
| 100 | ["picture", "https://cdn.britannica.com/40/188540-050-9AC748DE/Yak-Himalayas-Nepal.jpg"], | 99 | [ |
| 101 | ["about", "The domestic yak, also known as the Tartary ox, grunting ox, or hairy cattle, is a species of long-haired domesticated cattle found throughout the Himalayan region of the Indian subcontinent, the Tibetan Plateau, Gilgit-Baltistan, Tajikistan and as far north as Mongolia and Siberia."], | 100 | "picture", |
| 102 | ["a", "30023:26dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:95ODQzw3ajNoZ8SyMDOzQ"], | 101 | "https://cdn.britannica.com/40/188540-050-9AC748DE/Yak-Himalayas-Nepal.jpg" |
| 103 | ["a", "30023:54af95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:1-MYP8dAhramH9J5gJWKx"], | 102 | ], |
| 104 | ["a", "30023:f8fe95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:D2Tbd38bGrFvU0bIbvSMt"], | 103 | [ |
| 104 | "about", | ||
| 105 | "The domestic yak, also known as the Tartary ox, grunting ox, or hairy cattle, is a species of long-haired domesticated cattle found throughout the Himalayan region of the Indian subcontinent, the Tibetan Plateau, Gilgit-Baltistan, Tajikistan and as far north as Mongolia and Siberia." | ||
| 106 | ], | ||
| 107 | [ | ||
| 108 | "a", | ||
| 109 | "30023:26dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:95ODQzw3ajNoZ8SyMDOzQ" | ||
| 110 | ], | ||
| 111 | [ | ||
| 112 | "a", | ||
| 113 | "30023:54af95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:1-MYP8dAhramH9J5gJWKx" | ||
| 114 | ], | ||
| 115 | [ | ||
| 116 | "a", | ||
| 117 | "30023:f8fe95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:D2Tbd38bGrFvU0bIbvSMt" | ||
| 118 | ], | ||
| 105 | ["e", "d78ba0d5dce22bfff9db0a9e996c9ef27e2c91051de0c4e1da340e0326b4941e"] | 119 | ["e", "d78ba0d5dce22bfff9db0a9e996c9ef27e2c91051de0c4e1da340e0326b4941e"] |
| 106 | ], | 120 | ], |
| 107 | "content": "", | 121 | "content": "", |