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

update language as per discussion

Browse Source
This commit is contained in:
dskvr 2023-03-01 17:51:26 +01:00
parent 7bed3f7223
commit 5c5f08c6ac
1 changed files with 16 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
59.md
View File

@ -5,38 +5,35 @@
This NIP defines `30303`, a parameterized replaceable event [NIP-33], referred to as Relay Statuses. Relay Statuses use tags extensively and **may** have `.content` populated with Stringified JSON. This NIP defines `30303`, a parameterized replaceable event [NIP-33], referred to as Relay Statuses. Relay Statuses use tags extensively and **may** have `.content` populated with Stringified JSON.
## Purpose ## Purpose
To store relay meta-data and the result of subjective checks as queryable [NIP-12] events on nostr. To store computationally expensive relay meta-data from active relays as events on nostr.
## Personas ## Personas
- **Publishers** generate and push `30303` events. Events **should** be published at a regular interval. Events **may** be stale. - **Publishers** generate and push `30303` events. Events **should** be published at a regular interval. Events **must** implement `NIP-40`.
- **Consumers** aggregate `30303` for insight on relays. Some example consumers are a social client or relay status client. - **Consumers** aggregate `30303` for insight on relays. Some example consumers are a social client or relay status client.
## schema ## schema
### `event.created_at`
`created_at` **should** be interpreted by consumers as `updated_at`
### `event.tags` ### `event.tags`
Relay status events have **one** (1) required tags and **nine** (9) optional tags. Relay status events have **two** (2) required tags and **eight** (8) optional tags. Relay status events introduce **one** (1) new indexable tag (NIP-12)
The tags should be used to represent the Relay's abilities and meta at a point in time. Below the `tags schema` is expressed using pseudo-types for reasons of communication and brevity, for example `tagDescriptor[]`. The tags should be used to represent the Relay's abilities and meta at a point in time. Below the `tags schema` is expressed using pseudo-types for reasons of communication and brevity, for example `tagDescriptor[]`.
1. `"d" == tagId[0]` The relay URL. The `#d` tag **must** be included in the `event.tags[]` array. `tagId[1]` **must** be the relay websocket URL. The URL **should** be normalized. 1. `"d" == tagId[0]` The relay URL. The `#d` tag **must** be included in the `event.tags[]` array. `tagId[1]` **must** be the relay websocket URL. The URL **should** be normalized.
```json ```json
["d", "wss://history.nostr.watch/"] //tagId[] ["d", "wss://history.nostr.watch/"] //tagId[]
``` ```
2. `"t" == tagTopic[0]` Topics relevant to the relay. `tagTopic[]` **may** be included in the `event.tags[]` array. `tagTopic[1]` **should** be string. There **should** be no more than **twenty (20)** `tagTopic[]` arrays. 2. `"expiration" == tagExpiration[0]` [NIP-40]. The `tagExpiration[]` tag **must** be included in the `event.tags[]` array. `tagExpiration[1]` **should** be set to a future timestamp that correlates with the publisher's intended update frequency.
```json
["expiration", "1600000000"] //tagExpiration[]
```
3. `"t" == tagTopic[0]` Topics relevant to the relay. `tagTopic[]` **may** be included in the `event.tags[]` array. `tagTopic[1]` **should** be string. There **should** be no more than **twenty (20)** `tagTopic[]` arrays.
```json ```json
["t", "bitcoin"] //tagTopic[] ["t", "bitcoin"] //tagTopic[]
``` ```
3. `"g" == tagGeo[0]` Relay Geo Data. `tagGeo[]` **may** be included in the `event.tags[]` array. `tagGeo[1]` **must** be string and **should** be a geohash. There **may** be strings defined in the key range `2+` (`tagGeo[2...]`) and they **must** be strings if set. `tagGeo[]` items **should** be descending by precision. There **should** be no more than **one (1)** `tagGeo[]` per event. 4. `"g" == tagGeo[0]` Relay Geo Data. `tagGeo[]` **may** be included in the `event.tags[]` array. `tagGeo[1]` **must** be string and **should** be a geohash. There **may** be strings defined in the key range `2+` (`tagGeo[2...]`) and they **must** be strings if set. `tagGeo[]` items **should** be descending by precision. There **should** be no more than **one (1)** `tagGeo[]` per event.
```json ```json
["g", "ww8p1r4t8", "Amsterdam", "NL", "EU", "Earth", "Sol", "Milky Way"] //tagGeo[] ["g", "ww8p1r4t8", "Amsterdam", "NL", "EU", "Earth", "Sol", "Milky Way"] //tagGeo[]
``` ```
4. `"online" == tagOnline[0]` Is the relay online. `tagOnline[]` **may** be included in the `event.tags[]` array. `tagOnline[1]` **must** be type string as exactly `true` or `false`
```json
["online", "true"] //tagOnline[]
```
5. `"read" == 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` 5. `"read" == 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
["read", "true"] //tagRead[] ["read", "true"] //tagRead[]
@ -54,17 +51,16 @@ The tags should be used to represent the Relay's abilities and meta at a point i
["ip", "1.1.1.1"], //tagIp[] ["ip", "1.1.1.1"], //tagIp[]
["ip", "2001:db8:3333:4444:5555:6666:7777:8888"] //tagIp[] ["ip", "2001:db8:3333:4444:5555:6666:7777:8888"] //tagIp[]
``` ```
9. `"events" == tagEvents[0]` Number of events on relay. `tagEvents[]` **may** be included in the `event.tags[]` array. `tagEvents[1]` **must** be string. There **should** only be **one (1)** `tagEvents[]` 9. `"events" == tagEvents[0]` Number of events on relay. `tagEvents[]` **may** be included in the `event.tags[]` array. `tagEvents[1]` **must** be string. There **should** only be **one (1)** `tagEvents[]`
```json ```json
["events", "502341"], //tagEvents[] ["events", "502341"], //tagEvents[]
``` ```
10. `"users" == tagUsers[0]` Relay IP. `tagUsers[]` **may** be included in the `event.tags[]` array. `tagUsers[1]` **must** be string. There **should** be no more than **one (1)** `tagUsers[]` 10. `"users" == tagUsers[0]` Relay IP. `tagUsers[]` **may** be included in the `event.tags[]` array. `tagUsers[1]` **must** be string. There **should** be no more than **one (1)** `tagUsers[]`
```json ```json
["users","37482"] //tagUsers[] ["users","37482"] //tagUsers[]
``` ```
Example with Minimum Requirements: Example with Minimum Requirements:
```json ```json
{ {
@ -74,7 +70,8 @@ Example with Minimum Requirements:
"signature": "<signature>", "signature": "<signature>",
"content": "", "content": "",
"tags": [ "tags": [
["d","wss://relay.snort.social/"] ["d","wss://relay.snort.social/"],
["expiration", "1600000000"]
] ]
} }
``` ```
@ -89,12 +86,12 @@ Example with all Tags:
"content": "{}", "content": "{}",
"tags": [ "tags": [
["d","wss://some.relay/"], ["d","wss://some.relay/"],
["expiration", "1600000000"],
["t","nostrica"], ["t","nostrica"],
["t","bitcoin"], ["t","bitcoin"],
["g","ww8p1r4t8", "Amsterdam", "NL", "EU", "Earth"], ["g","ww8p1r4t8","Amsterdam","NL","EU","Earth"],
["ip","1.1.1.1"], ["ip","1.1.1.1"],
["ip","2001:db8:3333:4444:5555:6666:7777:8888"], ["ip","2001:db8:3333:4444:5555:6666:7777:8888"],
["open","true"],
["read","true"], ["read","true"],
["write","false"], ["write","false"],
["ssl","true"], ["ssl","true"],
@ -111,7 +108,7 @@ 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 the `authors` filter array with the pubkeys of trusted **publishers** The data in `30303` **may** be erroneous, intentionally or otherwise. Where 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. - Aggregate relays quickly.
@ -119,6 +116,4 @@ The data in `30303` **may** be erroneous, intentionally or otherwise. When accur
- 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
- A status client shows relay statuses - A status client shows relay statuses
- Identify macro-patterns amongst relays.
- Relays self-report statuses and/or metadata in `.content` signed by their NIP-11 `pubkey`. - Relays self-report statuses and/or metadata in `.content` signed by their NIP-11 `pubkey`.
- Could be used to store user checks for a relay to express personalized policies. For example, a user's pubkey was blacklisted on a relay, so they were unable to write: `..., tags: { [ ["d","wss://relay.damus.io"], ["o","true"], ["w","false"] ] }, ...`.