diff options
| -rw-r--r-- | 10.md | 43 |
1 files changed, 43 insertions, 0 deletions
| @@ -0,0 +1,43 @@ | |||
| 1 | NIP-10 | ||
| 2 | ====== | ||
| 3 | |||
| 4 | |||
| 5 | On `e` and `p` tags in Text Events (kind 1). | ||
| 6 | -------------------------------------------- | ||
| 7 | |||
| 8 | `draft` ~`mandatory`~ `author:unclebobmartin` | ||
| 9 | |||
| 10 | ### A Conventional use of `e` and `p` tags within clients. | ||
| 11 | |||
| 12 | The following seems to be the conventions that are used by `Branle`, `Damus`, and `more-speech` for referencing | ||
| 13 | events and authors when building a reply. These conventions help clients build event threads, and alert authors of | ||
| 14 | replies. | ||
| 15 | |||
| 16 | ### Definitions: | ||
| 17 | * A reply chain is the list of events from the root event to a specific reply. | ||
| 18 | * A reply thread is the tree of events consisting of all replies beginning at the root. | ||
| 19 | * An event id is a 32 byte number in lower-case hexidecimal. | ||
| 20 | |||
| 21 | ### The `e` tag | ||
| 22 | Used in a text event contains a single event id. ["e", "`hex-number`"] | ||
| 23 | |||
| 24 | * No `e` tag: | ||
| 25 | This event is not a reply to, nor does it refer to, any other event. | ||
| 26 | |||
| 27 | * One `e` tag: ["e",`id`]: | ||
| 28 | The id of the event to which this event is a reply. | ||
| 29 | |||
| 30 | * Two `e` tags: ["e",`root-id`], ["e",`reply-id`] | ||
| 31 | 'root-id' is the `id` of the event at the root of the reply chain. `reply-id` is the id of the article to which this event is a reply. | ||
| 32 | |||
| 33 | * Many `e` tags: ["e",`root-id`] ["e",`mention-id`], ..., ["e",`reply-id`] | ||
| 34 | There may be any number of `mention-ids`. These are the ids of events which may, or may not be in the reply chain. | ||
| 35 | They are citings from this event. `root-id` and `reply-id` are as above. | ||
| 36 | |||
| 37 | ### The `p` tag | ||
| 38 | Used in a text event contains a list of pubkeys used to record who is involved in a reply thread. | ||
| 39 | |||
| 40 | When replying to a text event E with `p` tags P, the replying event's `p` tags should contain P as well as the pubkey of the of the event being replied to. | ||
| 41 | |||
| 42 | Example: Given a text event authored by a1 with `p` tags [`p1`, `p2`, `p3`] then the `p` tags of the reply should be [`a1`, `p1`, `p2`, `p3`] | ||
| 43 | in no particular order. | ||