NIP-10 ====== Text Notes and Threads ---------------------- `draft` `optional` This NIP defines `kind:1` as a simple plaintext note. ## Abstract This NIP describes how to use "e" and "p" tags in text events, especially those that are replies to other text events. It helps clients thread the replies into a tree rooted at the original event. The `.content` property contains some human-readable text. `e` and `p` tags can be used to define note threads, replies and mentions. Markup languages such as markdown and HTML SHOULD NOT be used. ## Marked "e" tags (PREFERRED) `["e", , , , ]` Where: * `` is the id of the event being referenced. * `` is the URL of a recommended relay associated with the reference. Clients SHOULD add a valid `` field, but may instead leave it as `""`. * `` is optional and if present is one of `"reply"`, `"root"`, or `"mention"`. * `` is optional, SHOULD be the pubkey of the author of the referenced event Those marked with `"reply"` denote the id of the reply event being responded to. Those marked with `"root"` denote the root id of the reply thread being responded to. For top level replies (those replying directly to the root event), only the `"root"` marker should be used. Those marked with `"mention"` denote a quoted or reposted event id. A direct reply to the root of a thread should have a single marked "e" tag of type "root". >This scheme is preferred because it allows events to mention others without confusing them with `` or ``. `` SHOULD be the pubkey of the author of the `e` tagged event, this is used in the outbox model to search for that event from the authors write relays where relay hints did not resolve the event. ## The "p" tag Used in a text event contains a list of pubkeys used to record who is involved in a reply thread. When replying to a text event E the reply event's "p" tags should contain all of E's "p" tags as well as the `"pubkey"` of the event being replied to. 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`] in no particular order. ## Deprecated Positional "e" tags This scheme is not in common use anymore and is here just to keep backward compatibility with older events on the network. Positional `e` tags are deprecated because they create ambiguities that are difficult, or impossible to resolve when an event references another but is not a reply. They use simple `e` tags without any marker. `["e", , ]` as per NIP-01. Where: * `` is the id of the event being referenced. * `` is the URL of a recommended relay associated with the reference. Many clients treat this field as optional. **The positions of the "e" tags within the event denote specific meanings as follows**: * No "e" tag:
This event is not a reply to, nor does it refer to, any other event. * One "e" tag:
`["e", ]`: The id of the event to which this event is a reply. * Two "e" tags: `["e", ]`, `["e", ]`
`` is the id of the event at the root of the reply chain. `` is the id of the article to which this event is a reply. * Many "e" tags: `["e", ]` `["e", ]`, ..., `["e", ]`
There may be any number of ``. These are the ids of events which may, or may not be in the reply chain. They are citing from this event. `root-id` and `reply-id` are as above.