diff options
Diffstat (limited to '11.md')
| -rw-r--r-- | 11.md | 30 |
1 files changed, 18 insertions, 12 deletions
| @@ -14,6 +14,8 @@ When a relay receives an HTTP(s) request with an `Accept` header of `application | |||
| 14 | { | 14 | { |
| 15 | "name": <string identifying relay>, | 15 | "name": <string identifying relay>, |
| 16 | "description": <string with detailed information>, | 16 | "description": <string with detailed information>, |
| 17 | "banner": <a link to an image (e.g. in .jpg, or .png format)>, | ||
| 18 | "icon": <a link to an icon (e.g. in .jpg, or .png format>, | ||
| 17 | "pubkey": <administrative contact pubkey>, | 19 | "pubkey": <administrative contact pubkey>, |
| 18 | "contact": <administrative alternate contact>, | 20 | "contact": <administrative alternate contact>, |
| 19 | "supported_nips": <a list of NIP numbers supported by the relay>, | 21 | "supported_nips": <a list of NIP numbers supported by the relay>, |
| @@ -35,6 +37,21 @@ A relay may select a `name` for use in client software. This is a string, and S | |||
| 35 | 37 | ||
| 36 | Detailed plain-text information about the relay may be contained in the `description` string. It is recommended that this contain no markup, formatting or line breaks for word wrapping, and simply use double newline characters to separate paragraphs. There are no limitations on length. | 38 | Detailed plain-text information about the relay may be contained in the `description` string. It is recommended that this contain no markup, formatting or line breaks for word wrapping, and simply use double newline characters to separate paragraphs. There are no limitations on length. |
| 37 | 39 | ||
| 40 | ### Banner | ||
| 41 | |||
| 42 | To make nostr relay management more user friendly, an effort should be made by relay owners to communicate with non-dev non-technical nostr end users. A banner is a visual representation of the relay. It should aim to visually communicate the brand of the relay, complementing the text `Description`. [Here is an example banner](https://image.nostr.build/232ddf6846e8aea5a61abcd70f9222ab521f711aa545b7ab02e430248fa3a249.png) mockup as visualized in Damus iOS relay view of the Damus relay. | ||
| 43 | |||
| 44 | ### Icon | ||
| 45 | |||
| 46 | Icon is a compact visual representation of the relay for use in UI with limited real estate such as a nostr user's relay list view. Below is an example URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape. | ||
| 47 | |||
| 48 | ```jsonc | ||
| 49 | { | ||
| 50 | "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg", | ||
| 51 | // other fields... | ||
| 52 | } | ||
| 53 | ``` | ||
| 54 | |||
| 38 | ### Pubkey | 55 | ### Pubkey |
| 39 | 56 | ||
| 40 | An administrative contact may be listed with a `pubkey`, in the same format as Nostr events (32-byte hex for a `secp256k1` public key). If a contact is listed, this provides clients with a recommended address to send encrypted direct messages (See [NIP-17](17.md)) to a system administrator. Expected uses of this address are to report abuse or illegal content, file bug reports, or request other technical assistance. | 57 | An administrative contact may be listed with a `pubkey`, in the same format as Nostr events (32-byte hex for a `secp256k1` public key). If a contact is listed, this provides clients with a recommended address to send encrypted direct messages (See [NIP-17](17.md)) to a system administrator. Expected uses of this address are to report abuse or illegal content, file bug reports, or request other technical assistance. |
| @@ -245,7 +262,7 @@ processed by appropriate client software. | |||
| 245 | 262 | ||
| 246 | Relays that require payments may want to expose their fee schedules. | 263 | Relays that require payments may want to expose their fee schedules. |
| 247 | 264 | ||
| 248 | ```json | 265 | ```jsonc |
| 249 | { | 266 | { |
| 250 | "payments_url": "https://my-relay/payments", | 267 | "payments_url": "https://my-relay/payments", |
| 251 | "fees": { | 268 | "fees": { |
| @@ -253,17 +270,6 @@ Relays that require payments may want to expose their fee schedules. | |||
| 253 | "subscription": [{ "amount": 5000000, "unit": "msats", "period": 2592000 }], | 270 | "subscription": [{ "amount": 5000000, "unit": "msats", "period": 2592000 }], |
| 254 | "publication": [{ "kinds": [4], "amount": 100, "unit": "msats" }], | 271 | "publication": [{ "kinds": [4], "amount": 100, "unit": "msats" }], |
| 255 | }, | 272 | }, |
| 256 | ... | ||
| 257 | } | ||
| 258 | ``` | ||
| 259 | |||
| 260 | ### Icon | ||
| 261 | |||
| 262 | A URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape. | ||
| 263 | |||
| 264 | ```jsonc | ||
| 265 | { | ||
| 266 | "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg", | ||
| 267 | // other fields... | 273 | // other fields... |
| 268 | } | 274 | } |
| 269 | ``` | 275 | ``` |