diff options
Diffstat (limited to '24.md')
| -rw-r--r-- | 24.md | 41 |
1 files changed, 41 insertions, 0 deletions
| @@ -0,0 +1,41 @@ | |||
| 1 | NIP-24 | ||
| 2 | ====== | ||
| 3 | |||
| 4 | Extra metadata fields and tags | ||
| 5 | ------------------------------ | ||
| 6 | |||
| 7 | `draft` `optional` `author:fiatjaf` | ||
| 8 | |||
| 9 | This NIP defines extra optional fields added to events. | ||
| 10 | |||
| 11 | kind 0 | ||
| 12 | ====== | ||
| 13 | |||
| 14 | These are extra fields not specified in NIP-01 that may be present in the stringified JSON of metadata events: | ||
| 15 | |||
| 16 | - `display_name`: a bigger name with richer characters than `name`. Implementations should fallback to `name` when this is not available. | ||
| 17 | - `website`: a web URL related in any way to the event author. | ||
| 18 | - `banner`: an URL to a wide (~1024x768) picture to be optionally displayed in the background of a profile screen. | ||
| 19 | |||
| 20 | ### Deprecated fields | ||
| 21 | |||
| 22 | These are fields that should be ignored or removed when found in the wild: | ||
| 23 | |||
| 24 | - `displayName`: use `display_name` instead. | ||
| 25 | - `username`: use `name` instead. | ||
| 26 | |||
| 27 | kind 3 | ||
| 28 | ====== | ||
| 29 | |||
| 30 | These are extra fields not specified in NIP-02 that may be present in the stringified JSON of contacts events: | ||
| 31 | |||
| 32 | ### Deprecated fields | ||
| 33 | |||
| 34 | - `{<relay-url>: {"read": <true|false>, "write": <true|false>}, ...}`: an object of relays used by a user to read/write. [NIP-65](65.md) should be used instead. | ||
| 35 | |||
| 36 | tags | ||
| 37 | ==== | ||
| 38 | |||
| 39 | These tags may be present in multiple event kinds. Whenever a different meaning is not specified by some more specific NIP, they have the following meanings: | ||
| 40 | |||
| 41 | - `r`: a web URL the event is referring to in some way | ||