upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
path: root/58.md
diff options
context:
space:
mode:
Diffstat (limited to '58.md')
-rw-r--r--58.md12
1 files changed, 5 insertions, 7 deletions
diff --git a/58.md b/58.md
index ccabc7b..4a9ed4c 100644
--- a/58.md
+++ b/58.md
@@ -4,7 +4,7 @@ NIP-58
4Badges 4Badges
5------ 5------
6 6
7`draft` `optional` `author:cameri` 7`draft` `optional`
8 8
9Three special events are used to define, award and display badges in 9Three special events are used to define, award and display badges in
10user profiles: 10user profiles:
@@ -28,7 +28,7 @@ The following tags MAY be present:
28- A `name` tag with a short name for the badge. 28- A `name` tag with a short name for the badge.
29- `image` tag whose value is the URL of a high-resolution image representing the badge. The second value optionally specifies the dimensions of the image as `width`x`height` in pixels. Badge recommended dimensions is 1024x1024 pixels. 29- `image` tag whose value is the URL of a high-resolution image representing the badge. The second value optionally specifies the dimensions of the image as `width`x`height` in pixels. Badge recommended dimensions is 1024x1024 pixels.
30- A `description` tag whose value MAY contain a textual representation of the 30- A `description` tag whose value MAY contain a textual representation of the
31image, the meaning behind the badge, or the reason of it's issuance. 31image, the meaning behind the badge, or the reason of its issuance.
32- One or more `thumb` tags whose first value is an URL pointing to a thumbnail version of the image referenced in the `image` tag. The second value optionally specifies the dimensions of the thumbnail as `width`x`height` in pixels. 32- One or more `thumb` tags whose first value is an URL pointing to a thumbnail version of the image referenced in the `image` tag. The second value optionally specifies the dimensions of the thumbnail as `width`x`height` in pixels.
33 33
34### Badge Award event 34### Badge Award event
@@ -62,8 +62,6 @@ Users MAY choose to decorate their profiles with badges for fame, notoriety, rec
62 62
63### Recommendations 63### Recommendations
64 64
65Badge issuers MAY include some Proof of Work as per [NIP-13](13.md) when minting Badge Definitions or Badge Awards to embed them with a combined energy cost, arguably making them more special and valuable for users that wish to collect them.
66
67Clients MAY whitelist badge issuers (pubkeys) for the purpose of ensuring they retain a valuable/special factor for their users. 65Clients MAY whitelist badge issuers (pubkeys) for the purpose of ensuring they retain a valuable/special factor for their users.
68 66
69Badge image recommended aspect ratio is 1:1 with a high-res size of 1024x1024 pixels. 67Badge image recommended aspect ratio is 1:1 with a high-res size of 1024x1024 pixels.
@@ -85,7 +83,7 @@ Clients SHOULD attempt to render the most appropriate badge thumbnail according
85 ["name", "Medal of Bravery"], 83 ["name", "Medal of Bravery"],
86 ["description", "Awarded to users demonstrating bravery"], 84 ["description", "Awarded to users demonstrating bravery"],
87 ["image", "https://nostr.academy/awards/bravery.png", "1024x1024"], 85 ["image", "https://nostr.academy/awards/bravery.png", "1024x1024"],
88 ["thumb", "https://nostr.academy/awards/bravery_256x256.png", "256x256"], 86 ["thumb", "https://nostr.academy/awards/bravery_256x256.png", "256x256"]
89 ], 87 ],
90 ... 88 ...
91} 89}
@@ -101,7 +99,7 @@ Clients SHOULD attempt to render the most appropriate badge thumbnail according
101 "tags": [ 99 "tags": [
102 ["a", "30009:alice:bravery"], 100 ["a", "30009:alice:bravery"],
103 ["p", "bob", "wss://relay"], 101 ["p", "bob", "wss://relay"],
104 ["p", "charlie", "wss://relay"], 102 ["p", "charlie", "wss://relay"]
105 ], 103 ],
106 ... 104 ...
107} 105}
@@ -119,7 +117,7 @@ Honorable Bob The Brave:
119 ["a", "30009:alice:bravery"], 117 ["a", "30009:alice:bravery"],
120 ["e", "<bravery badge award event id>", "wss://nostr.academy"], 118 ["e", "<bravery badge award event id>", "wss://nostr.academy"],
121 ["a", "30009:alice:honor"], 119 ["a", "30009:alice:honor"],
122 ["e", "<honor badge award event id>", "wss://nostr.academy"], 120 ["e", "<honor badge award event id>", "wss://nostr.academy"]
123 ], 121 ],
124 ... 122 ...
125} 123}