nostr/nips
1
0
Fork 0
mirror of https://github.com/nostr-protocol/nips.git synced 2024-12-23 08:55:52 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

A use case, fix text formatting

Browse Source
This commit is contained in:
dskvr 2023-02-07 15:12:03 +01:00
parent 4bec3aa1ef
commit de9e41077c
1 changed files with 22 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
59.md
View File

@ -25,21 +25,21 @@ The tags should be used to represent the Relay's abilities and meta at a point i
```json ```json
["d", "wss://history.nostr.watch/"] //tagId[] ["d", "wss://history.nostr.watch/"] //tagId[]
``` ```
2. `"o" == tagOnline[0]` Is the relay online (`#o`). `tagOnline[]` **may** be included in the `event.tags[]` array. `tagOnline[1]` **should** be type string as exactly `true` or `false` 2. `"o" == tagOnline[0]` Is the relay online (`#o`). `tagOnline[]` **may** be included in the `event.tags[]` array. `tagOnline[1]` **must** be type string as exactly `true` or `false`
```json ```json
["o", "true"] //tagOnline[] ["o", "true"] //tagOnline[]
``` ```
3. `"r" == tagRead[0]` Was able to read from the relay. `tagRead[]` **may** be included in the `event.tags[]` array. `tagRead[1]` **should** be type string as exactly `true` or `false` 3. `"r" == tagRead[0]` Was able to read from the relay. `tagRead[]` **may** be included in the `event.tags[]` array. `tagRead[1]` **must** be type string as exactly `true` or `false`
```json ```json
["r", "true"] //tagRead[] ["r", "true"] //tagRead[]
``` ```
4. `"w" == tagWrite[0]` Was able to write to the relay. `tagWrite[]` **may** be included in the `event.tags[]` array. `tagWrite[1]` **should** be type string as exactly `true` or `false` 4. `"w" == tagWrite[0]` Was able to write to the relay. `tagWrite[]` **may** be included in the `event.tags[]` array. `tagWrite[1]` **must** be type string as exactly `true` or `false`
```json ```json
["w", "false"] //tagWrite[] ["w", "false"] //tagWrite[]
``` ```
5. `"s" == tagSsl[0]` Is the relay's SSL valid (`#s`). `tagSsl[]` **may** be included in the `event.tags[]` array. `tagSsl[1]` **should** be type string as exactly `true` or `false` 5. `"s" == tagSsl[0]` Is the relay's SSL valid. `tagSsl[]` **may** be included in the `event.tags[]` array. `tagSsl[1]` **must** be type string as exactly `true` or `false`
```json ```json
["s", "true"] //tagSSL[] ["s", "true"] //tagSsl[]
``` ```
6. `"t" == tagTopic[0]` Topics relavant to the relay. `tagTopic[]` **may** be included in the `event.tags[]` array. `tagTopic[1]` **should** be string 6. `"t" == tagTopic[0]` Topics relavant to the relay. `tagTopic[]` **may** be included in the `event.tags[]` array. `tagTopic[1]` **should** be string
```json ```json
@ -58,11 +58,25 @@ The tags should be used to represent the Relay's abilities and meta at a point i
["y", "2001:db8:3333:4444:5555:6666:7777:8888"] //tagIPv6[] ["y", "2001:db8:3333:4444:5555:6666:7777:8888"] //tagIPv6[]
``` ```
Minimal Requirements:
```json
{
"id": "<eventid>",
"pubkey": "<pubkey>",
"created_at": "<created_at>",
"signature": "<signature>",
"content": "{}",
"tags": [
["d","wss://relay.snort.social/"]
]
}
```
Example Event: Example Event:
```json ```json
{ {
"id": "<eventid>", "id": "<eventid>",
"pubkey": "", "pubkey": "<pubkey>",
"created_at": "<created_at>", "created_at": "<created_at>",
"signature": "<signature>", "signature": "<signature>",
"content": "{}", "content": "{}",
@ -88,9 +102,10 @@ The `.content` of these events **may** be empty. `.content` **may** contain stri
The testing criteria to determine conditions defined in event's tags **may** be subjective and **may** vary between publishers. The testing criteria to determine conditions defined in event's tags **may** be subjective and **may** vary between publishers.
## Consumption ## Consumption
The data in `30303` **may** be erroneous, intentionally or otherwise. When accuracy is required, the data in `30303` events **should** be subscribed to by populating tthe `authors` filter array with the pubkeys of trusted **publishers** The data in `30303` **may** be erroneous, intentionally or otherwise. When accuracy is required, the data in `30303` events **should** be subscribed to by populating the `authors` filter array with the pubkeys of trusted **publishers**
## Use Cases ## Use Cases
- Aggregate relays quickly.
- A lite social client identifies relays that were recently reported to be online without client-side tests - A lite social client identifies relays that were recently reported to be online without client-side tests
- A social client may find relays where a particular topic is popular. - A social client may find relays where a particular topic is popular.
- A social client may find relays based on their geographic proximity - A social client may find relays based on their geographic proximity