mirror of
https://github.com/nostr-protocol/nips.git
synced 2024-11-09 22:09:06 -05:00
cut, simplify and update NIP-51 to reflect the real-world usage.
This commit is contained in:
fiatjaf
parent
f1433e0f0c
commit
5dc6071978
151
51.md
151
51.md
|
|
@ -6,148 +6,19 @@ 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`
|
||||||
|
|
||||||
A "list" event is defined as having a list of public and/or private tags. Public tags will be listed in the event `tags`. Private tags will be encrypted in the event `content`. Encryption for private tags will use [NIP-04 - Encrypted Direct Message](04.md) encryption, using the list author's private and public key for the shared secret. A distinct event kind should be used for each list type created.
|
This NIP defines lists of things that users can create. Lists can contain references to anything, and these references can be **public** or **private**.
|
||||||
|
|
||||||
If a list should only be defined once per user (like the "mute" list) the list is declared as a _replaceable event_. These lists may be referred to as "replaceable lists". Otherwise, the list is a _parameterized replaceable event_ and the list name will be used as the `d` tag. These lists may be referred to as "parameterized replaceable lists".
|
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`.
|
||||||
|
|
||||||
## Replaceable List Event Example
|
## Generic lists
|
||||||
|
|
||||||
Lets say a user wants to create a 'Mute' list and has keys:
|
The kinds `30000` and `30001` have been reserved for generic lists. These must be accompanied by a `d` tag identifying the list, but these are generally client-specific, except in the standard cases specified below.
|
||||||
```
|
|
||||||
priv: fb505c65d4df950f5d28c9e4d285ee12ffaf315deef1fc24e3c7cd1e7e35f2b1
|
|
||||||
pub: b1a5c93edcc8d586566fde53a20bdb50049a97b15483cb763854e57016e0fa3d
|
|
||||||
```
|
|
||||||
The user wants to publicly include these users:
|
|
||||||
|
|
||||||
```json
|
## Standard lists
|
||||||
["p", "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"],
|
|
||||||
["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"]
|
|
||||||
```
|
|
||||||
and privately include these users (below is the JSON that would be encrypted and placed in the event content):
|
|
||||||
|
|
||||||
```json
|
| name | kind | "d" tag | description | expected tag items |
|
||||||
[
|
| --- | --- | --- | --- | --- |
|
||||||
["p", "9ec7a778167afb1d30c4833de9322da0c08ba71a69e1911d5578d3144bb56437"],
|
| Muted list | 30000 | `"mute"` | things the user doesn't want to see in their feeds | `"p"` (pubkeys), `"t"` (hashtags) |
|
||||||
["p", "8c0da4862130283ff9e67d889df264177a508974e2feb96de139804ea66d6168"]
|
| Bookmarks list | 30001 | `"bookmark"` | things the user intends to save for the future | `"e"` (kind:1 notes), `"a"` (kind:30023 articles) |
|
||||||
]
|
| Pin list | 30001 | `"pin"` | events the user intends to showcase in their profile page | `"e"` (kind:1 notes) |
|
||||||
```
|
| Relay sets | 30002 | (user-defined) | user-defined relay groups the user can easily pick and choose from during variadic operations | `"relay"` (relay URLs) |
|
||||||
|
|
||||||
Then the user would create a 'Mute' list event like below:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"kind": 10000,
|
|
||||||
"tags": [
|
|
||||||
["p", "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"],
|
|
||||||
["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"],
|
|
||||||
],
|
|
||||||
"content": "VezuSvWak++ASjFMRqBPWS3mK5pZ0vRLL325iuIL4S+r8n9z+DuMau5vMElz1tGC/UqCDmbzE2kwplafaFo/FnIZMdEj4pdxgptyBV1ifZpH3TEF6OMjEtqbYRRqnxgIXsuOSXaerWgpi0pm+raHQPseoELQI/SZ1cvtFqEUCXdXpa5AYaSd+quEuthAEw7V1jP+5TDRCEC8jiLosBVhCtaPpLcrm8HydMYJ2XB6Ixs=?iv=/rtV49RFm0XyFEwG62Eo9A==",
|
|
||||||
...other fields
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Parameterized Replaceable List Event Example
|
|
||||||
|
|
||||||
Lets say a user wants to create a 'Categorized People' list of `nostr` people and has keys:
|
|
||||||
```
|
|
||||||
priv: fb505c65d4df950f5d28c9e4d285ee12ffaf315deef1fc24e3c7cd1e7e35f2b1
|
|
||||||
pub: b1a5c93edcc8d586566fde53a20bdb50049a97b15483cb763854e57016e0fa3d
|
|
||||||
```
|
|
||||||
The user wants to publicly include these users:
|
|
||||||
|
|
||||||
```json
|
|
||||||
["p", "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"],
|
|
||||||
["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"]
|
|
||||||
```
|
|
||||||
and privately include these users (below is the JSON that would be encrypted and placed in the event content):
|
|
||||||
|
|
||||||
```json
|
|
||||||
[
|
|
||||||
["p", "9ec7a778167afb1d30c4833de9322da0c08ba71a69e1911d5578d3144bb56437"],
|
|
||||||
["p", "8c0da4862130283ff9e67d889df264177a508974e2feb96de139804ea66d6168"]
|
|
||||||
]
|
|
||||||
```
|
|
||||||
|
|
||||||
Then the user would create a 'Categorized People' list event like below:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"kind": 30000,
|
|
||||||
"tags": [
|
|
||||||
["d", "nostr"],
|
|
||||||
["p", "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d"],
|
|
||||||
["p", "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"],
|
|
||||||
],
|
|
||||||
"content": "VezuSvWak++ASjFMRqBPWS3mK5pZ0vRLL325iuIL4S+r8n9z+DuMau5vMElz1tGC/UqCDmbzE2kwplafaFo/FnIZMdEj4pdxgptyBV1ifZpH3TEF6OMjEtqbYRRqnxgIXsuOSXaerWgpi0pm+raHQPseoELQI/SZ1cvtFqEUCXdXpa5AYaSd+quEuthAEw7V1jP+5TDRCEC8jiLosBVhCtaPpLcrm8HydMYJ2XB6Ixs=?iv=/rtV49RFm0XyFEwG62Eo9A==",
|
|
||||||
...other fields
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Lets say a user wants to create a 'Categorized Bookmarks' list of `bookmarks` and has keys:
|
|
||||||
```
|
|
||||||
priv: fb505c65d4df950f5d28c9e4d285ee12ffaf315deef1fc24e3c7cd1e7e35f2b1
|
|
||||||
pub: b1a5c93edcc8d586566fde53a20bdb50049a97b15483cb763854e57016e0fa3d
|
|
||||||
```
|
|
||||||
The user wants to publicly include these bookmarks:
|
|
||||||
|
|
||||||
```json
|
|
||||||
["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://nostr.example.com"],
|
|
||||||
["a", "30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"],
|
|
||||||
["r", "https://github.com/nostr-protocol/nostr", "Nostr repository"],
|
|
||||||
```
|
|
||||||
and privately include these bookmarks (below is the JSON that would be encrypted and placed in the event content):
|
|
||||||
|
|
||||||
```json
|
|
||||||
[
|
|
||||||
["r", "https://my-private.bookmark", "My private bookmark"],
|
|
||||||
["a", "30001:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"],
|
|
||||||
]
|
|
||||||
```
|
|
||||||
|
|
||||||
Then the user would create a 'Categorized Bookmarks' list event like below:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"kind": 30001,
|
|
||||||
"tags": [
|
|
||||||
["d", "bookmarks"],
|
|
||||||
["e", "5c83da77af1dec6d7289834998ad7aafbd9e2191396d75ec3cc27f5a77226f36", "wss://nostr.example.com"],
|
|
||||||
["a", "30023:f7234bd4c1394dda46d09f35bd384dd30cc552ad5541990f98844fb06676e9ca:abcd", "wss://nostr.example.com"],
|
|
||||||
["r", "https://github.com/nostr-protocol/nostr", "Nostr repository"],
|
|
||||||
],
|
|
||||||
"content": "y3AyaLJfnmYr9x9Od9o4aYrmL9+Ynmsim5y2ONrU0urOTq+V81CyAthQ2mUOWE9xwGgrizhY7ILdQwWhy6FK0sA33GHtC0egUJw1zIdknPe7BZjznD570yk/8RXYgGyDKdexME+RMYykrnYFxq1+y/h00kmJg4u+Gpn+ZjmVhNYxl9b+TiBOAXG9UxnK/H0AmUqDpcldn6+j1/AiStwYZhD1UZ3jzDIk2qcCDy7MlGnYhSP+kNmG+2b0T/D1L0Z7?iv=PGJJfPE84gacAh7T0e6duQ==",
|
|
||||||
...other fields
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## List Event Kinds
|
|
||||||
|
|
||||||
| kind | list type |
|
|
||||||
| ------ | ----------------------- |
|
|
||||||
| 10000 | Mute |
|
|
||||||
| 10001 | Pin |
|
|
||||||
| 30000 | Categorized People |
|
|
||||||
| 30001 | Categorized Bookmarks |
|
|
||||||
| 30002 | Categorized Relay Sets |
|
|
||||||
|
|
||||||
|
|
||||||
### Mute List
|
|
||||||
|
|
||||||
An event with kind `10000` is defined as a replaceable list event for listing content a user wants to mute. Any standardized tag can be included in a Mute List.
|
|
||||||
|
|
||||||
### Pin List
|
|
||||||
|
|
||||||
An event with kind `10001` is defined as a replaceable list event for listing content a user wants to pin. Any standardized tag can be included in a Pin List.
|
|
||||||
|
|
||||||
### Categorized People List
|
|
||||||
|
|
||||||
An event with kind `30000` is defined as a parameterized replaceable list event for categorizing people. The 'd' parameter for this event holds the category name of the list. The tags included in these lists MUST follow the format of kind 3 events as defined in [NIP-02 - Contact List and Petnames](02.md).
|
|
||||||
|
|
||||||
### Categorized Bookmarks List
|
|
||||||
|
|
||||||
An event of kind `30001` is defined as a parameterized replaceable list event for categorizing bookmarks. The 'd' parameter for this event holds the category name of the list. The bookmark lists may contain metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md). Any standardized tag can be included in a Categorized Bookmark List.
|
|
||||||
|
|
||||||
### Categorized Relay Set
|
|
||||||
|
|
||||||
An event of kind `30002` is defined as a parameterized replaceable list event for categorizing relays. The 'd' parameter for this event holds the category name of the list. The relays lists may contain metadata tags such as 'title', 'image', 'summary' as defined in [NIP-23 - Long-form Content](23.md). These sets can be used by clients in order to determine which relays to query in different scenarios.
|
|
||||||
|
|
|
||||||
117
README.md
117
README.md
|
|
@ -74,66 +74,65 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
|
||||||
- [NIP-99: Classified Listings](99.md)
|
- [NIP-99: Classified Listings](99.md)
|
||||||
|
|
||||||
## Event Kinds
|
## Event Kinds
|
||||||
| kind | description | NIP |
|
| kind | description | NIP |
|
||||||
| ------------- | -------------------------- | ----------- |
|
| ------------- | -------------------------- | ----------- |
|
||||||
| `0` | Metadata | [1](01.md) |
|
| `0` | Metadata | [1](01.md) |
|
||||||
| `1` | Short Text Note | [1](01.md) |
|
| `1` | Short Text Note | [1](01.md) |
|
||||||
| `2` | Recommend Relay | |
|
| `2` | Recommend Relay | |
|
||||||
| `3` | Contacts | [2](02.md) |
|
| `3` | Contacts | [2](02.md) |
|
||||||
| `4` | Encrypted Direct Messages | [4](04.md) |
|
| `4` | Encrypted Direct Messages | [4](04.md) |
|
||||||
| `5` | Event Deletion | [9](09.md) |
|
| `5` | Event Deletion | [9](09.md) |
|
||||||
| `6` | Repost | [18](18.md) |
|
| `6` | Repost | [18](18.md) |
|
||||||
| `7` | Reaction | [25](25.md) |
|
| `7` | Reaction | [25](25.md) |
|
||||||
| `8` | Badge Award | [58](58.md) |
|
| `8` | Badge Award | [58](58.md) |
|
||||||
| `16` | Generic Repost | [18](18.md) |
|
| `16` | Generic Repost | [18](18.md) |
|
||||||
| `40` | Channel Creation | [28](28.md) |
|
| `40` | Channel Creation | [28](28.md) |
|
||||||
| `41` | Channel Metadata | [28](28.md) |
|
| `41` | Channel Metadata | [28](28.md) |
|
||||||
| `42` | Channel Message | [28](28.md) |
|
| `42` | Channel Message | [28](28.md) |
|
||||||
| `43` | Channel Hide Message | [28](28.md) |
|
| `43` | Channel Hide Message | [28](28.md) |
|
||||||
| `44` | Channel Mute User | [28](28.md) |
|
| `44` | Channel Mute User | [28](28.md) |
|
||||||
| `1063` | File Metadata | [94](94.md) |
|
| `1063` | File Metadata | [94](94.md) |
|
||||||
| `1311` | Live Chat Message | [53](53.md) |
|
| `1311` | Live Chat Message | [53](53.md) |
|
||||||
| `1040` | OpenTimestamps | [03](03.md) |
|
| `1040` | OpenTimestamps | [03](03.md) |
|
||||||
| `1971` | Problem Tracker | [1971](https://github.com/nostrocket/NIPS/blob/main/Problems.md) |
|
| `1971` | Problem Tracker | [1971](https://github.com/nostrocket/NIPS/blob/main/Problems.md) |
|
||||||
| `1984` | Reporting | [56](56.md) |
|
| `1984` | Reporting | [56](56.md) |
|
||||||
| `1985` | Label | [32](32.md) |
|
| `1985` | Label | [32](32.md) |
|
||||||
| `4550` | Community Post Approval | [72](72.md) |
|
| `4550` | Community Post Approval | [72](72.md) |
|
||||||
| `5000`-`5999` | Job Request | [90](90.md) |
|
| `5000`-`5999` | Job Request | [90](90.md) |
|
||||||
| `6000`-`6999` | Job Result | [90](90.md) |
|
| `6000`-`6999` | Job Result | [90](90.md) |
|
||||||
| `7000` | Job Feedback | [90](90.md) |
|
| `7000` | Job Feedback | [90](90.md) |
|
||||||
| `9041` | Zap Goal | [75](75.md) |
|
| `9041` | Zap Goal | [75](75.md) |
|
||||||
| `9734` | Zap Request | [57](57.md) |
|
| `9734` | Zap Request | [57](57.md) |
|
||||||
| `9735` | Zap | [57](57.md) |
|
| `9735` | Zap | [57](57.md) |
|
||||||
| `9802` | Highlights | [84](84.md) |
|
| `9802` | Highlights | [84](84.md) |
|
||||||
| `10000` | Mute List | [51](51.md) |
|
| `10002` | Relay List Metadata | [65](65.md) |
|
||||||
| `10001` | Pin List | [51](51.md) |
|
| `13194` | Wallet Info | [47](47.md) |
|
||||||
| `10002` | Relay List Metadata | [65](65.md) |
|
| `22242` | Client Authentication | [42](42.md) |
|
||||||
| `13194` | Wallet Info | [47](47.md) |
|
| `23194` | Wallet Request | [47](47.md) |
|
||||||
| `22242` | Client Authentication | [42](42.md) |
|
| `23195` | Wallet Response | [47](47.md) |
|
||||||
| `23194` | Wallet Request | [47](47.md) |
|
| `24133` | Nostr Connect | [46](46.md) |
|
||||||
| `23195` | Wallet Response | [47](47.md) |
|
| `27235` | HTTP Auth | [98](98.md) |
|
||||||
| `24133` | Nostr Connect | [46](46.md) |
|
| `30000` | People List | [51](51.md) |
|
||||||
| `27235` | HTTP Auth | [98](98.md) |
|
| `30001` | Things List | [51](51.md) |
|
||||||
| `30000` | Categorized People List | [51](51.md) |
|
| `30002` | Relay Set | [51](51.md) |
|
||||||
| `30001` | Categorized Bookmark List | [51](51.md) |
|
| `30008` | Profile Badges | [58](58.md) |
|
||||||
| `30008` | Profile Badges | [58](58.md) |
|
| `30009` | Badge Definition | [58](58.md) |
|
||||||
| `30009` | Badge Definition | [58](58.md) |
|
| `30017` | Create or update a stall | [15](15.md) |
|
||||||
| `30017` | Create or update a stall | [15](15.md) |
|
| `30018` | Create or update a product | [15](15.md) |
|
||||||
| `30018` | Create or update a product | [15](15.md) |
|
| `30023` | Long-form Content | [23](23.md) |
|
||||||
| `30023` | Long-form Content | [23](23.md) |
|
| `30024` | Draft Long-form Content | [23](23.md) |
|
||||||
| `30024` | Draft Long-form Content | [23](23.md) |
|
| `30078` | Application-specific Data | [78](78.md) |
|
||||||
| `30078` | Application-specific Data | [78](78.md) |
|
| `30311` | Live Event | [53](53.md) |
|
||||||
| `30311` | Live Event | [53](53.md) |
|
| `30315` | User Statuses | [38](38.md) |
|
||||||
| `30315` | User Statuses | [38](38.md) |
|
| `30402` | Classified Listing | [99](99.md) |
|
||||||
| `30402` | Classified Listing | [99](99.md) |
|
| `30403` | Draft Classified Listing | [99](99.md) |
|
||||||
| `30403` | Draft Classified Listing | [99](99.md) |
|
| `31922` | Date-Based Calendar Event | [52](52.md) |
|
||||||
| `31922` | Date-Based Calendar Event | [52](52.md) |
|
| `31923` | Time-Based Calendar Event | [52](52.md) |
|
||||||
| `31923` | Time-Based Calendar Event | [52](52.md) |
|
| `31924` | Calendar | [52](52.md) |
|
||||||
| `31924` | Calendar | [52](52.md) |
|
| `31925` | Calendar Event RSVP | [52](52.md) |
|
||||||
| `31925` | Calendar Event RSVP | [52](52.md) |
|
| `31989` | Handler recommendation | [89](89.md) |
|
||||||
| `31989` | Handler recommendation | [89](89.md) |
|
| `31990` | Handler information | [89](89.md) |
|
||||||
| `31990` | Handler information | [89](89.md) |
|
| `34550` | Community Definition | [72](72.md) |
|
||||||
| `34550` | Community Definition | [72](72.md) |
|
|
||||||
|
|
||||||
## Message types
|
## Message types
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user