Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update NIP 11 to support relay recommendations #259

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions 11.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ When a relay receives an HTTP(s) request with an `Accept` header of `application
pubkey: <administrative contact pubkey>,
contact: <administrative alternate contact>,
supported_nips: <a list of NIP numbers supported by the relay>,
extensions: <a list of nip number, url tuples>
software: <string identifying relay software URL>,
version: <string version identifier>
}
Expand Down Expand Up @@ -49,6 +50,10 @@ An alternative contact may be listed under the `contact` field as well, with the

As the Nostr protocol evolves, some functionality may only be available by relays that implement a specific `NIP`. This field is an array of the integer identifiers of `NIP`s that are implemented in the relay. Examples would include `1`, for `"NIP-01"` and `9`, for `"NIP-09"`. Client-side `NIPs` SHOULD NOT be advertised, and can be ignored by clients.

### Extensions ###

Some NIPs may be more burdensome than others for relays to implement. Relays may advertise support for these NIPs as `extensions` by advertising other relays that support those NIPs for some or all of the given relay's events. For example, if a relay that functioned as a read replica wanted to advertise support for NIP 42 on the master relay it follows, it would set its `extensions` key to `[["NIP-42", "wss://my-master.example.com"]]`.

### Software ###

The relay server implementation MAY be provided in the `software` attribute. If present, this MUST be a URL to the project's homepage.
Expand Down