upleb.uk

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

summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhodlbod <jstaab@protonmail.com>2023-12-07 10:03:55 -0800
committerGitHub <noreply@github.com>2023-12-07 10:03:55 -0800
commit730324f4878e827df2524fdff0a40fa646b9cf08 (patch)
tree75c752efd5d9c84a55ab61cc8eadecff847c0f0c
parent2bd4bf784112aabff9d0fc2dd90fed9107aa5cde (diff)
parent0146892501d63042d13724bae7c887bfa985e251 (diff)
Merge pull request #921 from alexgleason/follows
NIP-02: Rename Contact List to Follow List
-rw-r--r--02.md20
-rw-r--r--README.md4
2 files changed, 12 insertions, 12 deletions
diff --git a/02.md b/02.md
index 0653d06..8c47a5f 100644
--- a/02.md
+++ b/02.md
@@ -1,12 +1,12 @@
1NIP-02 1NIP-02
2====== 2======
3 3
4Contact List and Petnames 4Follow List
5------------------------- 5-----------
6 6
7`final` `optional` 7`final` `optional`
8 8
9A special event with kind `3`, meaning "contact list" is defined as having a list of `p` tags, one for each of the followed/known profiles one is following. 9A special event with kind `3`, meaning "follow list" is defined as having a list of `p` tags, one for each of the followed/known profiles one is following.
10 10
11Each tag entry should contain the key for the profile, a relay URL where events from that key can be found (can be set to an empty string if not needed), and a local name (or "petname") for that profile (can also be set to an empty string or not provided), i.e., `["p", <32-bytes hex key>, <main relay URL>, <petname>]`. The `content` can be anything and should be ignored. 11Each tag entry should contain the key for the profile, a relay URL where events from that key can be found (can be set to an empty string if not needed), and a local name (or "petname") for that profile (can also be set to an empty string or not provided), i.e., `["p", <32-bytes hex key>, <main relay URL>, <petname>]`. The `content` can be anything and should be ignored.
12 12
@@ -25,27 +25,27 @@ For example:
25} 25}
26``` 26```
27 27
28Every new contact list that gets published overwrites the past ones, so it should contain all entries. Relays and clients SHOULD delete past contact lists as soon as they receive a new one. 28Every new following list that gets published overwrites the past ones, so it should contain all entries. Relays and clients SHOULD delete past following lists as soon as they receive a new one.
29 29
30## Uses 30## Uses
31 31
32### Contact list backup 32### Follow list backup
33 33
34If one believes a relay will store their events for sufficient time, they can use this kind-3 event to backup their following list and recover on a different device. 34If one believes a relay will store their events for sufficient time, they can use this kind-3 event to backup their following list and recover on a different device.
35 35
36### Profile discovery and context augmentation 36### Profile discovery and context augmentation
37 37
38A client may rely on the kind-3 event to display a list of followed people by profiles one is browsing; make lists of suggestions on who to follow based on the contact lists of other people one might be following or browsing; or show the data in other contexts. 38A client may rely on the kind-3 event to display a list of followed people by profiles one is browsing; make lists of suggestions on who to follow based on the follow lists of other people one might be following or browsing; or show the data in other contexts.
39 39
40### Relay sharing 40### Relay sharing
41 41
42A client may publish a full list of contacts with good relays for each of their contacts so other clients may use these to update their internal relay lists if needed, increasing censorship-resistance. 42A client may publish a follow list with good relays for each of their follows so other clients may use these to update their internal relay lists if needed, increasing censorship-resistance.
43 43
44### Petname scheme 44### Petname scheme
45 45
46The data from these contact lists can be used by clients to construct local ["petname"](http://www.skyhunter.com/marcs/petnames/IntroPetNames.html) tables derived from other people's contact lists. This alleviates the need for global human-readable names. For example: 46The data from these follow lists can be used by clients to construct local ["petname"](http://www.skyhunter.com/marcs/petnames/IntroPetNames.html) tables derived from other people's follow lists. This alleviates the need for global human-readable names. For example:
47 47
48A user has an internal contact list that says 48A user has an internal follow list that says
49 49
50```json 50```json
51[ 51[
@@ -53,7 +53,7 @@ A user has an internal contact list that says
53] 53]
54``` 54```
55 55
56And receives two contact lists, one from `21df6d143fb96c2ec9d63726bf9edc71` that says 56And receives two follow lists, one from `21df6d143fb96c2ec9d63726bf9edc71` that says
57 57
58```json 58```json
59[ 59[
diff --git a/README.md b/README.md
index 47b5986..6b83490 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
22## List 22## List
23 23
24- [NIP-01: Basic protocol flow description](01.md) 24- [NIP-01: Basic protocol flow description](01.md)
25- [NIP-02: Contact List and Petnames](02.md) 25- [NIP-02: Follow List](02.md)
26- [NIP-03: OpenTimestamps Attestations for Events](03.md) 26- [NIP-03: OpenTimestamps Attestations for Events](03.md)
27- [NIP-04: Encrypted Direct Message](04.md) 27- [NIP-04: Encrypted Direct Message](04.md)
28- [NIP-05: Mapping Nostr keys to DNS-based internet identifiers](05.md) 28- [NIP-05: Mapping Nostr keys to DNS-based internet identifiers](05.md)
@@ -80,7 +80,7 @@ They exist to document what may be implemented by [Nostr](https://github.com/nos
80| `0` | Metadata | [1](01.md) | 80| `0` | Metadata | [1](01.md) |
81| `1` | Short Text Note | [1](01.md) | 81| `1` | Short Text Note | [1](01.md) |
82| `2` | Recommend Relay | | 82| `2` | Recommend Relay | |
83| `3` | Contacts | [2](02.md) | 83| `3` | Follows | [2](02.md) |
84| `4` | Encrypted Direct Messages | [4](04.md) | 84| `4` | Encrypted Direct Messages | [4](04.md) |
85| `5` | Event Deletion | [9](09.md) | 85| `5` | Event Deletion | [9](09.md) |
86| `6` | Repost | [18](18.md) | 86| `6` | Repost | [18](18.md) |