mirror of
https://github.com/nostr-protocol/nips.git
synced 2024-12-23 08:55:52 -05:00
remove style changes
This commit is contained in:
parent
4a52533674
commit
aa680d5a09
84
11.md
84
11.md
|
@ -37,7 +37,7 @@ Detailed plain-text information about the relay may be contained in the `descrip
|
||||||
|
|
||||||
### Pubkey
|
### Pubkey
|
||||||
|
|
||||||
An administrative contact may be listed with a `pubkey`, in the same format as the 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.
|
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.
|
||||||
|
|
||||||
Relay operators have no obligation to respond to direct messages.
|
Relay operators have no obligation to respond to direct messages.
|
||||||
|
|
||||||
|
@ -66,7 +66,7 @@ These are limitations imposed by the relay on clients. Your client
|
||||||
should expect that requests which exceed these *practical* limitations
|
should expect that requests which exceed these *practical* limitations
|
||||||
are rejected or fail immediately.
|
are rejected or fail immediately.
|
||||||
|
|
||||||
```jsonc
|
```json
|
||||||
{
|
{
|
||||||
"limitation": {
|
"limitation": {
|
||||||
"max_message_length": 16384,
|
"max_message_length": 16384,
|
||||||
|
@ -83,7 +83,7 @@ are rejected or fail immediately.
|
||||||
"created_at_lower_limit": 31536000,
|
"created_at_lower_limit": 31536000,
|
||||||
"created_at_upper_limit": 3
|
"created_at_upper_limit": 3
|
||||||
},
|
},
|
||||||
// ...
|
...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -146,48 +146,14 @@ Retention times are given in seconds, with `null` indicating infinity.
|
||||||
If zero is provided, this means the event will not be stored at
|
If zero is provided, this means the event will not be stored at
|
||||||
all, and preferably an error will be provided when those are received.
|
all, and preferably an error will be provided when those are received.
|
||||||
|
|
||||||
```jsonc
|
```json
|
||||||
{
|
{
|
||||||
"retention":[
|
"retention": [
|
||||||
{
|
{"kinds": [0, 1, [5, 7], [40, 49]], "time": 3600},
|
||||||
"kinds":[
|
{"kinds": [[40000, 49999]], "time": 100},
|
||||||
0,
|
{"kinds": [[30000, 39999]], "count": 1000},
|
||||||
1,
|
{"time": 3600, "count": 10000}
|
||||||
[
|
]
|
||||||
5,
|
|
||||||
7
|
|
||||||
],
|
|
||||||
[
|
|
||||||
40,
|
|
||||||
49
|
|
||||||
]
|
|
||||||
],
|
|
||||||
"time":3600
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"kinds":[
|
|
||||||
[
|
|
||||||
40000,
|
|
||||||
49999
|
|
||||||
]
|
|
||||||
],
|
|
||||||
"time":100
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"kinds":[
|
|
||||||
[
|
|
||||||
30000,
|
|
||||||
39999
|
|
||||||
]
|
|
||||||
],
|
|
||||||
"count":1000
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"time":3600,
|
|
||||||
"count":10000
|
|
||||||
}
|
|
||||||
],
|
|
||||||
// ...
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -220,10 +186,10 @@ Users should be able to avoid relays in countries they don't like,
|
||||||
and/or select relays in more favorable zones. Exposing this
|
and/or select relays in more favorable zones. Exposing this
|
||||||
flexibility is up to the client software.
|
flexibility is up to the client software.
|
||||||
|
|
||||||
```jsonc
|
```json
|
||||||
{
|
{
|
||||||
"relay_countries": [ "CA", "US" ],
|
"relay_countries": [ "CA", "US" ],
|
||||||
// ...
|
...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -242,12 +208,12 @@ local community. This would encourage users to follow the global
|
||||||
feed on that relay, in addition to their usual individual follows.
|
feed on that relay, in addition to their usual individual follows.
|
||||||
To support this goal, relays MAY specify some of the following values.
|
To support this goal, relays MAY specify some of the following values.
|
||||||
|
|
||||||
```jsonc
|
```json
|
||||||
{
|
{
|
||||||
"language_tags": ["en", "en-419"],
|
"language_tags": ["en", "en-419"],
|
||||||
"tags": ["sfw-only", "bitcoin-only", "anime"],
|
"tags": ["sfw-only", "bitcoin-only", "anime"],
|
||||||
"posting_policy": "https://example.com/posting-policy.html",
|
"posting_policy": "https://example.com/posting-policy.html",
|
||||||
// ...
|
...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -256,12 +222,12 @@ To support this goal, relays MAY specify some of the following values.
|
||||||
the major languages spoken on the relay. `"*"` wildcard can be used for global relays.
|
the major languages spoken on the relay. `"*"` wildcard can be used for global relays.
|
||||||
|
|
||||||
- `tags` is a list of limitations on the topics to be discussed.
|
- `tags` is a list of limitations on the topics to be discussed.
|
||||||
For example `sfw-only` indicates that only *"Safe For Work"* content
|
For example `sfw-only` indicates that only "Safe For Work" content
|
||||||
is encouraged on this relay. This relies on assumptions of what the
|
is encouraged on this relay. This relies on assumptions of what the
|
||||||
"work" "community" feels "safe" talking about. In time, a common
|
"work" "community" feels "safe" talking about. In time, a common
|
||||||
set of tags may emerge that allow users to find relays that suit
|
set of tags may emerge that allow users to find relays that suit
|
||||||
their needs, and client software will be able to parse these tags easily.
|
their needs, and client software will be able to parse these tags easily.
|
||||||
The `bitcoin-only` tag indicates that any *"altcoin"*, *"crypto"* or *"blockchain"*
|
The `bitcoin-only` tag indicates that any *altcoin*, *crypto* or *"blockchain"*
|
||||||
comments will be ridiculed without mercy.
|
comments will be ridiculed without mercy.
|
||||||
|
|
||||||
- `posting_policy` is a link to a human-readable page which specifies the
|
- `posting_policy` is a link to a human-readable page which specifies the
|
||||||
|
@ -339,24 +305,22 @@ Access means user can post anything on relay based on its limitation/policies do
|
||||||
|
|
||||||
A URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape.
|
A URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape.
|
||||||
|
|
||||||
```jsonc
|
```json
|
||||||
{
|
{
|
||||||
"icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg",
|
"icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg",
|
||||||
// ...
|
...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Examples
|
### Examples
|
||||||
|
|
||||||
As of 3 September 2024 the following command provided these results:
|
As of 2 May 2023 the following command provided these results:
|
||||||
|
|
||||||
```bash
|
|
||||||
$ curl -H "Accept: application/nostr+json" https://eden.nostr.land | jq
|
|
||||||
```
|
```
|
||||||
|
~> curl -H "Accept: application/nostr+json" https://eden.nostr.land | jq
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
{
|
||||||
"description": "nostr.land family of relays (fi-01 [tiger])",
|
"description": "nostr.land family of relays (us-or-01)",
|
||||||
"name": "nostr.land",
|
"name": "nostr.land",
|
||||||
"pubkey": "52b4a076bcbbbdc3a1aefa3735816cf74993b1b8db202b01c883c58be7fad8bd",
|
"pubkey": "52b4a076bcbbbdc3a1aefa3735816cf74993b1b8db202b01c883c58be7fad8bd",
|
||||||
"software": "custom",
|
"software": "custom",
|
||||||
|
@ -382,16 +346,14 @@ $ curl -H "Accept: application/nostr+json" https://eden.nostr.land | jq
|
||||||
"max_subscriptions": 20,
|
"max_subscriptions": 20,
|
||||||
"auth_required": false
|
"auth_required": false
|
||||||
},
|
},
|
||||||
"payments_url": "https://nostr.land",
|
"payments_url": "https://eden.nostr.land",
|
||||||
"fees": {
|
"fees": {
|
||||||
"subscription": [
|
"subscription": [
|
||||||
{
|
{
|
||||||
"amount": 4000000,
|
"amount": 2500000,
|
||||||
"unit": "msats",
|
"unit": "msats",
|
||||||
"period": 2592000
|
"period": 2592000
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"canonical_url": "wss://eden.nostr.land"
|
|
||||||
}
|
}
|
||||||
```
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user