From 71cae195b4669d6faf4336940169ec9f75fba0c2 Mon Sep 17 00:00:00 2001 From: Jon Staab Date: Mon, 26 Feb 2024 07:52:03 -0800 Subject: [PATCH] Add annotations --- 37.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 37.md diff --git a/37.md b/37.md new file mode 100644 index 00000000..0dfc5051 --- /dev/null +++ b/37.md @@ -0,0 +1,32 @@ +NIP-37 +====== + +Annotations +----------- + +`draft` `optional` + +This NIP adds a new concept called "annotations" which allow authors to create privileged comments on their own notes. +These are simply `kind:1` replies with an additional `annotation` tag. + +These can be used to indicate updates, edits, corrections, or retractions, without obscuring the content of the original +note or forcing clients to handle multiple versions of the note. These MAY be applied to events of any kind. + +```js +{ + "kind": 1, + "pubkey": "", + "tags": [ + ["e", "", "", "reply"], + ["annotation"] + ], + "content": "EDIT: I forgot to say...", + // ...other fields +} +``` + +Clients MUST check if the pubkey of the annotation is the same as the referenced event. + +These events are designed so that clients that don't support annotations will still show these events as replies. + +Clients SHOULD have a strategy for displaying replies to annotations.