diff options
| -rw-r--r-- | 51.md | 46 | ||||
| -rw-r--r-- | README.md | 5 |
2 files changed, 23 insertions, 28 deletions
| @@ -16,9 +16,6 @@ stored in the `.content`. | |||
| 16 | 16 | ||
| 17 | ## Types of lists | 17 | ## Types of lists |
| 18 | 18 | ||
| 19 | ### Generic lists | ||
| 20 | |||
| 21 | |||
| 22 | ## Standard lists | 19 | ## Standard lists |
| 23 | 20 | ||
| 24 | Standard lists use non-parameterized replaceable events, meaning users may only have a single list | 21 | Standard lists use non-parameterized replaceable events, meaning users may only have a single list |
| @@ -28,12 +25,16 @@ browsing experience. | |||
| 28 | For example, _mute lists_ can contain the public keys of spammers and bad actors users don't want to see in | 25 | For example, _mute lists_ can contain the public keys of spammers and bad actors users don't want to see in |
| 29 | their feeds or receive annoying notifications from. | 26 | their feeds or receive annoying notifications from. |
| 30 | 27 | ||
| 31 | | name | kind | description | expected tag items | | 28 | | name | kind | description | expected tag items | |
| 32 | | --- | --- | --- | --- | | 29 | | --- | --- | --- | --- | |
| 33 | | Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags) | | 30 | | Mute list | 10000 | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags), `"word"` (lowercase string), `"e"` (threads) | |
| 34 | | Pin list | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | | 31 | | Pinned notes | 10001 | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) | |
| 35 | | Bookmarks list | 10003 | things the user intends to save for the future | `"e"` (kind:1 notes), `"a"` (kind:30023 articles) | | 32 | | Bookmarks | 10003 | things the user intends to save for the future | `"e"` (kind:1 notes), `"a"` (kind:30023 articles) | |
| 36 | | Communities list | 10004 | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) | | 33 | | Communities | 10004 | [NIP-72](72.md) communities the user belongs to | `"a"` (kind:34550 community definitions) | |
| 34 | | Public chats | 10005 | [NIP-28](28.md) chat channels the user is in | `"e"` (kind:40 community definitions) | | ||
| 35 | | Blocked relays | 10006 | relays clients should never connect to | `"relay"` (relay URLs) | | ||
| 36 | | Search relays | 10007 | relays clients should use when performing search queries | `"relay"` (relay URLs) | | ||
| 37 | | Emojis | 10030 | user preferred emojis and pointers to emoji sets | `"emoji"` (see [NIP-30](30.md)) and `"a"` (kind:30030 emoji set) | | ||
| 37 | 38 | ||
| 38 | ## Sets | 39 | ## Sets |
| 39 | 40 | ||
| @@ -45,18 +46,19 @@ For example, _relay sets_ can be displayed in a dropdown UI to give users the op | |||
| 45 | relays they will publish an event or from which relays they will read the replies to an event; _curation sets_ | 46 | relays they will publish an event or from which relays they will read the replies to an event; _curation sets_ |
| 46 | can be used by apps to showcase curations made by others tagged to different topics. | 47 | can be used by apps to showcase curations made by others tagged to different topics. |
| 47 | 48 | ||
| 48 | Aside from their main identifier, the `"d"` tag, sets can optionally have a `"title"`, an `"image"` and a | 49 | Aside from their main identifier, the `"d"` tag, sets can optionally have a `"name"`, a `"picture"` and an |
| 49 | `"description"` tag that can be used to enhance their UI. | 50 | `"about"` tag that can be used to enhance their UI. |
| 50 | 51 | ||
| 51 | | name | kind | description | expected tag items | | 52 | | name | kind | description | expected tag items | |
| 52 | | --- | --- | --- | --- | | 53 | | --- | --- | --- | --- | |
| 53 | | Follow sets | 30000 | categorized groups of users a client may choose to check out in different circumstances | `"p"` (pubkeys) | | 54 | | Follow sets | 30000 | categorized groups of users a client may choose to check out in different circumstances | `"p"` (pubkeys) | |
| 54 | | Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during variadic operations | `"relay"` (relay URLs) | | 55 | | Relay sets | 30002 | user-defined relay groups the user can easily pick and choose from during variadic operations | `"relay"` (relay URLs) | |
| 55 | | 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) | | 56 | | 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) | |
| 57 | | Emoji sets | 30030 | categorized emoji groups | `"emoji"` (see [NIP-30](30.md)) | | ||
| 56 | 58 | ||
| 57 | ## Deprecated standard lists | 59 | ## Deprecated standard lists |
| 58 | 60 | ||
| 59 | Some clients have used these lists in the past, but they should work on transitioning to the [standard formats](#standard-lists) above: | 61 | Some clients have used these lists in the past, but they should work on transitioning to the [standard formats](#standard-lists) above. |
| 60 | 62 | ||
| 61 | | kind | "d" tag | use instead | | 63 | | kind | "d" tag | use instead | |
| 62 | | --- | --- | --- | | 64 | | --- | --- | --- | |
| @@ -93,22 +95,10 @@ Some clients have used these lists in the past, but they should work on transiti | |||
| 93 | "created_at": 1695327657, | 95 | "created_at": 1695327657, |
| 94 | "kind": 30004, | 96 | "kind": 30004, |
| 95 | "tags": [ | 97 | "tags": [ |
| 96 | [ | 98 | ["d", "jvdy9i4"], |
| 97 | "d", | 99 | ["name", "Yaks"], |
| 98 | "jvdy9i4" | 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 | [ | ||
| 101 | "title", | ||
| 102 | "Yaks" | ||
| 103 | ], | ||
| 104 | [ | ||
| 105 | "summary", | ||
| 106 | "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." | ||
| 107 | ], | ||
| 108 | [ | ||
| 109 | "image", | ||
| 110 | "https://cdn.britannica.com/40/188540-050-9AC748DE/Yak-Himalayas-Nepal.jpg" | ||
| 111 | ], | ||
| 112 | ["a", "30023:26dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:95ODQzw3ajNoZ8SyMDOzQ"], | 102 | ["a", "30023:26dc95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:95ODQzw3ajNoZ8SyMDOzQ"], |
| 113 | ["a", "30023:54af95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:1-MYP8dAhramH9J5gJWKx"], | 103 | ["a", "30023:54af95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:1-MYP8dAhramH9J5gJWKx"], |
| 114 | ["a", "30023:f8fe95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:D2Tbd38bGrFvU0bIbvSMt"], | 104 | ["a", "30023:f8fe95542e18b8b7aec2f14610f55c335abebec76f3db9e58c254661d0593a0c:D2Tbd38bGrFvU0bIbvSMt"], |
| @@ -110,6 +110,10 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | |||
| 110 | | `10002` | Relay List Metadata | [65](65.md) | | 110 | | `10002` | Relay List Metadata | [65](65.md) | |
| 111 | | `10003` | Bookmark list | [51](51.md) | | 111 | | `10003` | Bookmark list | [51](51.md) | |
| 112 | | `10004` | Communities list | [51](51.md) | | 112 | | `10004` | Communities list | [51](51.md) | |
| 113 | | `10005` | Public chats list | [51](51.md) | | ||
| 114 | | `10006` | Blocked relays list | [51](51.md) | | ||
| 115 | | `10007` | Search relays list | [51](51.md) | | ||
| 116 | | `10030` | User emoji list | [51](51.md) | | ||
| 113 | | `13194` | Wallet Info | [47](47.md) | | 117 | | `13194` | Wallet Info | [47](47.md) | |
| 114 | | `22242` | Client Authentication | [42](42.md) | | 118 | | `22242` | Client Authentication | [42](42.md) | |
| 115 | | `23194` | Wallet Request | [47](47.md) | | 119 | | `23194` | Wallet Request | [47](47.md) | |
| @@ -122,6 +126,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos | |||
| 122 | | `30004` | Curation sets | [51](51.md) | | 126 | | `30004` | Curation sets | [51](51.md) | |
| 123 | | `30008` | Profile Badges | [58](58.md) | | 127 | | `30008` | Profile Badges | [58](58.md) | |
| 124 | | `30009` | Badge Definition | [58](58.md) | | 128 | | `30009` | Badge Definition | [58](58.md) | |
| 129 | | `30030` | Emoji sets | [51](51.md) | | ||
| 125 | | `30017` | Create or update a stall | [15](15.md) | | 130 | | `30017` | Create or update a stall | [15](15.md) | |
| 126 | | `30018` | Create or update a product | [15](15.md) | | 131 | | `30018` | Create or update a product | [15](15.md) | |
| 127 | | `30023` | Long-form Content | [23](23.md) | | 132 | | `30023` | Long-form Content | [23](23.md) | |