Mirror/nips
1
0
Fork 0
mirror of https://github.com/nostr-protocol/nips.git synced 2025-02-22 13:19:00 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Deprecate stringified JSON in favor of tags on user metadata kind 0 events

Browse Source
This commit is contained in:
Terry Yiu 2025-02-09 19:58:48 -05:00
parent e41185867f
commit 6e1f351ccd
No known key found for this signature in database
GPG Key ID: 108645AE8A19B71A
2 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
01.md
View File

@ -89,7 +89,11 @@ Kinds specify how clients should interpret the meaning of each event and the oth
This NIP defines one basic kind:
- `0`: **user metadata**: the `content` is set to a stringified JSON object `{name: <nickname or full name>, about: <short bio>, picture: <url of the image>}` describing the user who created the event. [Extra metadata fields](24.md#kind-0) may be set. A relay may delete older events once it gets a new one for the same pubkey.
- `0`: **user metadata**: a basic set of metadata `tags` describing the user who created the event. [Extra metadata fields](24.md#kind-0) may be set. A relay may delete older events once it gets a new one for the same pubkey. These tags include:
- `name`: `<nickname or full name>`
- `about`: `<short bio>`
- `picture`: `<url of the image>`
- **DEPRECATED**: the `content` field has been used to store the stringified JSON of metadata fields in the format of `{name: <nickname or full name>, about: <short bio>, picture: <url of the image>}`. Clients SHOULD write metadata as both tags and legacy stringified JSON until a reasonable number of SDKs and popular clients on each operating system platform have adopted using tags on the user metadata event to avoid introducing breaking changes.
And also a convention for kind ranges that allow for easier experimentation and flexibility of relay implementation:

4
24.md
View File

@ -11,7 +11,7 @@ This NIP keeps track of extra optional fields that can added to events which are
kind 0
======
These are extra fields not specified in NIP-01 that may be present in the stringified JSON of metadata events:
These are extra fields not specified in NIP-01 that may be present in the tags of metadata events:
- `display_name`: an alternative, bigger name with richer characters than `name`. `name` should always be set regardless of the presence of `display_name` in the metadata.
- `website`: a web URL related in any way to the event author.
@ -25,6 +25,8 @@ These are fields that should be ignored or removed when found in the wild:
- `displayName`: use `display_name` instead.
- `username`: use `name` instead.
The `content` field has been used to store the stringified JSON of metadata fields. It has been deprecated in favor of using tags. Clients SHOULD write metadata as both tags and legacy stringified JSON until a reasonable number of SDKs and popular clients on each platform have adopted using tags on the user metadata event to avoid introducing breaking changes.
kind 3
======