nips/64.md

56 lines
2.4 KiB
Markdown
Raw Permalink Normal View History

2024-03-23 09:31:34 -04:00
NIP-64
======
Inbox model
-----------
`draft` `optional`
Suppose **Sarah** wants to subscribe to the notes **Walter** writes.
She must let Walter know she is following him. The first step is to find Walter's _inbox list_:
```jsonc
{
"kind": 10064,
"pubkey": "<walter>",
"tags": [
["relay", "wss://walter.inbox"]
]
}
```
Now Sarah can publish a `kind:6401` _follow intent_ to `wss://walter.inbox` tagging Walter:
```jsonc
{
"kind": 6401,
"pubkey": "<sarah>"
"tags": [
["p", "<walter>"],
["relay", "wss://sarah.inbox"],
["relay", "wss://other.inbox"]
]
}
```
Sarah also publishes these to her own inbox relays (`wss://sarah.inbox` and `wss://other.inbox`) so they are aware.
From the Walter side, whenever he is about to publish a note, he downloads all the `kind:6401` events from his inbox relays and sends his note to all the relays he finds in these.
Whenever Sarah's inbox relay receive a note from Walter, they will know that Sarah is following him, so they index that note in a way that it is associated with Sarah. If the relays receive a note from someone else they can simply reject the note.
When Sarah turns on her client she will connect to her inbox relay, perform [NIP-42](42.md) `AUTH` and create a subscription that doesn't specify `"authors"` (for example, `["REQ", "_", {}]`). The relays, aware of who she is and who she is following, can deliver to her just Walter's notes.
If Sarah ever decides to stop following Walter, she just sends a `kind:5` _deletion_ to both Walter's relay and hers.
2024-03-23 09:31:34 -04:00
---
The approach described in this NIP doesn't replace any of the other models for following people that are already in use in Nostr, and doesn't claim to be strictly superior to the Outbox Model, but just provides an alternative way to do things.
In reality, clients should implement both approaches and can never assume others will implement this.
For example, if Sarah wanted to follow Wesley and he didn't have a `kind:10064` she would have to do the normal "outbox" approach of subscribing to his relays and fetching his notes from there.
In the same vein, if for any reason Sarah noticed that she had stopped receiving notes from Walter for a long time (~7 days) it would make sense for her to go to his relays (obtained from [NIP-65](65.md), [NIP-05](05.md), relay hints or other means) and check if he is publishing to these. In the affirmative case, she would turn Walter into an "outbox follow" instead of an "inbox follow".