nips/66.md

250 lines
9.8 KiB
Markdown
Raw Normal View History

2024-06-25 05:37:08 -04:00
# NIP-66: Relay Discovery and Liveness Monitoring
2023-12-27 07:46:01 -05:00
`draft` `optional`
2024-06-25 05:37:08 -04:00
You want to find relays. You may want to discover relays based on criteria that's up to date. You may even want to ensure that you have a complete dataset. You probably want to filter relays based on their reported liveness.
2024-06-25 05:37:08 -04:00
In its purest form:
2024-06-25 05:37:08 -04:00
```json
{
"kind": 30166,
2024-08-30 12:19:28 -04:00
"created_at": 1722173222,
"content": "{}",
2024-06-25 05:37:08 -04:00
"tags": [
2024-08-30 12:19:28 -04:00
[ "d", "wss://somerelay.abc/" ]
],
"pubkey": "<pubkey>",
"sig": "<signature>",
"id": "<eventid>"
2024-06-25 05:37:08 -04:00
}
```
2023-12-27 07:46:01 -05:00
2024-08-30 12:19:28 -04:00
This event signals that the relay at `wss://somerelay.abc/` was reported "online" by `<pubkey>` at timestamp `1722173222`. This event **MAY** be extended upon to include more information.
2023-12-27 07:46:01 -05:00
2024-06-25 05:37:08 -04:00
## Kinds
2024-08-30 12:19:28 -04:00
`NIP-66` defines two (2) event kinds, `30166` and `10166`
2023-12-27 07:46:01 -05:00
2024-06-25 05:37:08 -04:00
| kind | name | description |
|-------|----------------------------|-----------------------------------------------------------------------------------------|
| [30166](#k30166) | Relay Discovery | A PRE that is published by a monitor when a relay is online |
2024-08-30 12:19:28 -04:00
| [10166](#k10166) | Relay Monitor Announcement | An RE that stores data that signals the intent of a pubkey to monitor relays and publish `30166` events at a regular _frequency_ |
2023-12-27 07:46:01 -05:00
2024-02-07 19:32:22 -05:00
## Ontology
- `Relay Operator`: someone who operates a relay
2024-08-30 12:19:28 -04:00
- `Monitor`: A pubkey that monitors relays and publishes `30166` events at the frequency specified in their `10166` event.
- `Ad-hoc Monitor`: A pubkey that monitors relays and publishes `30166` events at an irregular frequency.
- `Monitor Service`: A group or individual that monitors relays using one or more `Monitors`.
2024-02-07 19:32:22 -05:00
- `Check`: a specific data point that is tested or aggregated by a monitor.
2023-12-27 07:46:01 -05:00
2024-06-25 05:37:08 -04:00
## `30166`: "Relay Discovery" <a id="k30166"></a>
2024-02-07 19:32:22 -05:00
### Summary
2024-06-25 05:37:08 -04:00
`30166` is a `NIP-33` Parameterized-Replaceable Event [PRE], referred to as a "Relay Discovery" event. These events are optimized with a small footprint for protocol-level relay Discovery.
2024-02-07 19:32:22 -05:00
### Purpose
2024-08-30 12:19:28 -04:00
Discovery of relays over nostr.
2024-02-07 19:32:22 -05:00
### Schema
2024-06-25 05:37:08 -04:00
#### Content
`30166` content fields **MAY** include the stringified JSON of the relay's NIP-11 informational document. This data **MAY** be provided for informational purposes only.
#### `created_at`
The `created_at` field in a NIP-66 event should reflect the time when the relay liveness (and potentially other data points) was checked.
#### `tags`
##### Meta Tags (unindexed)
- `rtt-open` The relay's open **round-trip time** in milliseconds.
- `rtt-read` The relay's read **round-trip time** in milliseconds.
- `rtt-write` The relay's write **round-trip time** in milliseconds.
_Other `rtt` values **MAY** be present. This NIP should be updated if there is value found in more `rtt` values._
2024-02-07 19:32:22 -05:00
2024-06-25 05:37:08 -04:00
##### Single Letter Tags (indexed)
2024-08-30 12:19:28 -04:00
- `d` The relay URL/URI. The `#d` tag **must** be included in the `event.tags[]` array. Index position `1` **must** be the relay websocket URL/URI. If a URL it **SHOULD** be [normalized](https://datatracker.ietf.org/doc/html/rfc3986#section-6). For relays not accessible via conventional means but rather by an npub/pubkey, an npub/pubkey **MAY** be used in place of a URL.
2024-02-07 19:32:22 -05:00
```json
2024-06-25 05:37:08 -04:00
[ "d", "wss://somerelay.abc/"]
2023-12-27 07:46:01 -05:00
```
2024-02-07 19:32:22 -05:00
- `n`: Network
```json
[ "n", "clearnet" ]
2023-12-27 07:46:01 -05:00
```
2024-06-25 05:37:08 -04:00
- `T`: Relay Type. Enumerated [relay type](https://github.com/nostr-protocol/nips/issues/1282) formatted as `PascalCase`
```json
["T", "PrivateInbox" ]
```
2024-02-07 19:32:22 -05:00
- `N`: Supported Nips _From NIP-11 "Informational Document" `nip11.supported_nips[]`_
```json
[ "N", "42" ]
2023-12-27 07:46:01 -05:00
```
2024-02-07 19:32:22 -05:00
- `R`: Requirements _NIP-11 "Informational Document" `nip11.limitations.payment_required`, `nip11.limitations.auth_required` and/or any other boolean value within `nip11.limitations[]` that is added in the future_
```json
[ "R", "payment" ],
[ "R", "auth" ],
2023-12-27 07:46:01 -05:00
```
2024-06-25 05:37:08 -04:00
Since the nostr protocol does not currently support filtering on whether an indexed tag **is** or **is not** set, to make "public" and "no auth" relays discoverable requires a `!` flag
2023-12-27 07:46:01 -05:00
2024-02-07 19:32:22 -05:00
```json
[ "R", "!payment" ], //no payment required, is public
2024-06-25 05:37:08 -04:00
[ "R", "!auth" ], //no authentication required
2023-12-27 07:46:01 -05:00
```
2024-02-07 19:32:22 -05:00
2024-06-25 05:37:08 -04:00
- `t`: "Topics" _From NIP-11 "Informational Document" `nip11.tags[]`_
2024-02-07 19:32:22 -05:00
```json
[ "t", "nsfw" ]
2023-12-27 07:55:16 -05:00
```
2024-02-07 19:32:22 -05:00
- `k`: Accepted/Blocked Kinds [`NIP-22`]
2024-02-07 19:32:22 -05:00
```json
[ "k", "0" ],
[ "k", "3" ],
[ "k", "10002" ]
2023-12-27 07:55:16 -05:00
```
2023-12-27 07:46:01 -05:00
or for blocked kinds
```json
[ "k", "!0" ]
[ "k", "!3" ],
[ "k", "!10002" ]
```
2024-06-25 05:37:08 -04:00
- `g`: `NIP-52` `g` tags (geohash)
2024-02-07 19:32:22 -05:00
```json
2024-06-25 05:37:08 -04:00
[ "g", "9r1652whz" ]
2024-02-07 19:32:22 -05:00
```
2024-06-25 05:37:08 -04:00
- `30166` **MAY** be extended with global tags defined by other NIPs that do no collide with locally defined indices, including but not limited to: `p`, `t`, `e`, `a`, `i` and `l/L`.
#### Robust Example of a `30166` Event
_Relay was online, and you can filter on a number of different tags_
2024-02-07 19:32:22 -05:00
```json
{
"id": "<eventid>",
"pubkey": "<monitor's pubkey>",
"created_at": "<created_at [some recent date ...]>",
"signature": "<signature>",
"content": "{}",
"kind": 30166,
"tags": [
["d","wss://some.relay/"],
["n", "clearnet"],
2024-06-25 05:37:08 -04:00
["N", "40"],
2024-02-07 19:32:22 -05:00
["N", "33"],
["R", "!payment"],
2024-06-25 05:37:08 -04:00
["R", "auth"],
2024-02-07 19:32:22 -05:00
["g", "ww8p1r4t8"],
2024-06-25 05:37:08 -04:00
["p", "somehexkey..."],
["l", "en", "ISO-639-1"],
["t", "nsfw" ],
["rtt-open", 234 ]
2024-02-07 19:32:22 -05:00
]
}
```
2023-12-27 07:46:01 -05:00
2024-08-30 12:19:28 -04:00
## `10166`: "Relay Monitor Announcement" Events <a id="k10166"></a>
### Summary
`10166` is a replacable event herein referred to as "Relay Monitor Announcement" events. These events contain information about a publisher's intent to monitor and publish data as `30166` events. This event is optional and is intended for monitors who intend to provide monitoring services at a regular and predictable frequency.
### Purpose
To provide a directory of monitors, their intent to publish, their criteria and parameters of monitoring activities. Absence of this event implies the monitor is ad-hoc and does not publish events at a predictable frequency, and relies on mechanisms to infer data integrity, such as web-of-trust.
### Schema
#### Standard Tags
- `frequency` The frequency **in seconds** at which the monitor publishes events. A string-integer at index `1` represents the expected frequency the monitor will publish `30166` events. There should only be `1` frequency per monitor.
```json
[ "frequency", "3600" ]
```
- `timeout` (optional) The timeout values for various checks conducted by a monitor. Index `1` is the monitor's timeout in milliseconds. Index `2` describes what test the timeout is used for. If no index `2` is provided, it is inferred that the timeout provided applies to all tests. These values can assist relay operators in understanding data signaled by the monitor in _Relay Discovery Events_.
```json
[ "timeout", "2000", "open" ],
[ "timeout", "2000", "read" ],
[ "timeout", "3000", "write" ],
[ "timeout", "2000", "nip11" ],
[ "timeout", "4000", "ssl" ]
```
#### Indexed Tags
- `c` "Checks" **SHOULD** be a lowercase string describing the check(s) conducted by a monitor. Due to the rapidly evolving nature of relays, enumeration is organic and not strictly defined. But examples of some checks could be websocket `open/read/write/auth`, `nip11` checks, `dns` and `geo` checks, and and any other checks the monitor may deem useful.. Other checks **MAY** be included. New types of checks **SHOULD** be added to this NIP as they are needed.
```json
[ "c", "ws" ],
[ "c", "nip11" ],
[ "c", "dns" ],
[ "c", "geo" ],
[ "c", "ssl" ],
```
- `g`: `NIP-52` `g` tags (geohash)
```json
[ "g", "9r1652whz" ]
```
- Any other globally defined indexable tags **MAY** be included as found necessary.
### Other Requirements
Monitors **SHOULD** have the following
- A published `0` (NIP-1) event
- A published `10002` (NIP-65) event that defines the relays the monitor publishes to.
### Robust Example of a `10166` Event
```json
{
"id": "<eventid>",
"pubkey": "<monitor's pubkey>",
"created_at": "<created_at [some recent date ...]>",
"signature": "<signature>",
"content": "",
"tags": [
[ "timeout", "open", "5000" ],
[ "timeout", "read", "3000" ],
[ "timeout", "write", "3000" ],
[ "timeout", "nip11", "3000" ],
[ "frequency", "3600" ],
[ "c", "ws" ],
[ "c", "nip11" ],
[ "c", "ssl" ],
[ "c", "dns" ],
[ "c", "geo" ]
[ "g", "ww8p1r4t8" ]
]
}
```
## Methodology
2023-12-27 07:46:01 -05:00
2024-08-30 12:19:28 -04:00
### Monitors
1. A _Relay Monitor_ checks the liveness and potentially other attributes of a relay.
2023-12-27 07:46:01 -05:00
2024-08-30 12:19:28 -04:00
2. _Relay Monitor_ publishes a kind `30166` note when a relay it is monitoring is online. If the monitor has a `10166` event, events should be published at the frequency defined in their `10166` note.
2023-12-27 07:46:01 -05:00
2024-08-30 12:19:28 -04:00
_Any pubkey that publishes `30166` events **SHOULD** at a minimum be checking that the relay is available by websocket and behaves like a relay_
2023-02-07 09:12:03 -05:00
2024-08-30 12:19:28 -04:00
### Clients
1. In most cases, a client **SHOULD** filter on `30166` events using either a staticly or dynamically chosen monitor's `pubkey` and a `created_at` value respective of the monitor's published `frequency`. If the monitor has no stated frequency, other mechanisms should be employed to determine data integrity.
2024-06-25 05:37:08 -04:00
2. _Relay Liveness_ is subjectively determined by the client, starting with the `frequency` value of a monitor.
2023-12-27 07:46:01 -05:00
3. The liveness of a _Relay Monitor_ can be subjectively determined by detecting whether the _Relay Monitor_ has published events with respect to `frequency` value of any particular monitor.
2024-08-30 12:19:28 -04:00
4. The reliability and trustworthiness of a _Relay Monitor_ could be established via web-of-trust, reviews or similar mechanisms.
## Risk Mitigation
- When a client implements `NIP-66` events, the client should have a fallback if `NIP-66` events cannot be located.
- A `Monitor` or `Ad-hoc Monitor` may publish erroneous `30166` events, intentionally or otherwise. Therefor, it's important to program defensively to limit the impact of such events. This can be achieved with web-of-trust, reviews, fallbacks and/or data-aggregation for example.