nips/37.md

64 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

2024-05-30 15:31:33 -04:00
NIP-37
2024-03-14 08:38:37 -04:00
======
Draft Events
------------
`draft` `optional`
2024-03-14 08:52:58 -04:00
This NIP defines kind `31234` as a private wrap for drafts of any other event kind.
2024-03-14 08:38:37 -04:00
2024-03-14 08:52:58 -04:00
The draft event is JSON-stringified, [NIP44-encrypted](44.md) to the signer's public key and placed inside the `.content` of the event.
2024-03-14 08:38:37 -04:00
An additional `k` tag identifies the kind of the draft event.
```js
{
"kind": 31234,
"tags": [
["d", "<identifier>"],
["k", "<kind of the draft event>"],
2024-03-14 14:07:23 -04:00
["e", "<anchor event event id>", "<relay-url>"],
["a", "<anchor event address>", "<relay-url>"],
2024-03-14 08:38:37 -04:00
],
"content": nip44Encrypt(JSON.stringify(draft_event)),
// other fields
}
2024-03-14 14:07:23 -04:00
```
A blanked `.content` means this draft has been deleted by a client but relays still have the event.
2024-03-14 14:07:23 -04:00
Tags `e` and `a` identify one or more anchor events, such as parent events on replies.
2024-05-30 15:27:59 -04:00
2024-12-19 10:22:39 -05:00
## Checkpoints
`kind:1234` defines checkpoints that belong to a parent `kind:31234` event. These can serve to provide a revision history of a parent event.
```js
{
"kind": 1234,
"tags": [
["a", "31234:<pubkey>:<identifier>"]
],
"content": nip44Encrypt(JSON.stringify(draft_event)),
}
```
2024-05-30 15:27:59 -04:00
## Relay List for Private Content
Kind `10013` indicates the user's preferred relays to store private events like Drafts. The event MUST include a list of `relay` URLs in private tags. Private tags are JSON Stringified, NIP-44-encrypted to the signer's keys and placed inside the .content of the event.
```js
{
"kind": 10013,
"tags": [],
"content": nip44Encrypt(JSON.stringify([
["relay", "wss://myrelay.mydomain.com"]
]))
//...other fields
}
```
Relays listed in this event SHOULD be authed and only allow downloads to events signed by the authed user.
Clients SHOULD publish kind `10013` events to the author's [NIP-65](65.md) `write` relays.