upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
path: root/11.md
diff options
context:
space:
mode:
authorPablo Fernandez <p@f7z.io>2023-10-15 21:30:42 +0300
committerGitHub <noreply@github.com>2023-10-15 21:30:42 +0300
commita482f47ae4c36d38062cd0fd3ee6235e57691673 (patch)
treea16f57208cd3c3ef74237dafcef277f16d70e688 /11.md
parentd9400e1e7b08225aedb6c78b522c5ad07b5198b4 (diff)
parent202e18f2b256646148805880ed58731c1c8b2b9b (diff)
Merge branch 'master' into vending-machine
Diffstat (limited to '11.md')
-rw-r--r--11.md24
1 files changed, 12 insertions, 12 deletions
diff --git a/11.md b/11.md
index ec46b36..deb6f19 100644
--- a/11.md
+++ b/11.md
@@ -75,12 +75,13 @@ are rejected or fail immediately.
75 "max_filters": 100, 75 "max_filters": 100,
76 "max_limit": 5000, 76 "max_limit": 5000,
77 "max_subid_length": 100, 77 "max_subid_length": 100,
78 "min_prefix": 4,
79 "max_event_tags": 100, 78 "max_event_tags": 100,
80 "max_content_length": 8196, 79 "max_content_length": 8196,
81 "min_pow_difficulty": 30, 80 "min_pow_difficulty": 30,
82 "auth_required": true, 81 "auth_required": true,
83 "payment_required": true, 82 "payment_required": true,
83 "created_at_lower_limit":31536000,
84 "created_at_upper_limit":3,
84 } 85 }
85... 86...
86} 87}
@@ -102,9 +103,6 @@ Must be one or higher.
102 103
103- `max_subid_length`: maximum length of subscription id as a string. 104- `max_subid_length`: maximum length of subscription id as a string.
104 105
105- `min_prefix`: for `authors` and `ids` filters which are to match against
106a hex prefix, you must provide at least this many hex digits in the prefix.
107
108- `max_limit`: the relay server will clamp each filter's `limit` value to this number. 106- `max_limit`: the relay server will clamp each filter's `limit` value to this number.
109This means the client won't be able to get more than this number 107This means the client won't be able to get more than this number
110of events from a single subscription filter. This clamping is typically done silently 108of events from a single subscription filter. This clamping is typically done silently
@@ -118,7 +116,7 @@ field of any event. This is a count of unicode characters. After
118serializing into JSON it may be larger (in bytes), and is still 116serializing into JSON it may be larger (in bytes), and is still
119subject to the `max_message_length`, if defined. 117subject to the `max_message_length`, if defined.
120 118
121- `min_pow_difficulty`: new events will require at least this difficulty of PoW, 119- `min_pow_difficulty`: new events will require at least this difficulty of PoW,
122based on [NIP-13](13.md), or they will be rejected by this server. 120based on [NIP-13](13.md), or they will be rejected by this server.
123 121
124- `auth_required`: this relay requires [NIP-42](42.md) authentication 122- `auth_required`: this relay requires [NIP-42](42.md) authentication
@@ -127,9 +125,13 @@ Even if set to False, authentication may be required for specific actions.
127 125
128- `payment_required`: this relay requires payment before a new connection may perform any action. 126- `payment_required`: this relay requires payment before a new connection may perform any action.
129 127
128- `created_at_lower_limit`: 'created_at' lower limit as defined in [NIP-22](22.md)
129
130- `created_at_upper_limit`: 'created_at' upper limit as defined in [NIP-22](22.md)
131
130### Event Retention ### 132### Event Retention ###
131 133
132There may be a cost associated with storing data forever, so relays 134There may be a cost associated with storing data forever, so relays
133may wish to state retention times. The values stated here are defaults 135may wish to state retention times. The values stated here are defaults
134for unauthenticated users and visitors. Paid users would likely have 136for unauthenticated users and visitors. Paid users would likely have
135other policies. 137other policies.
@@ -151,7 +153,7 @@ all, and preferably an error will be provided when those are received.
151} 153}
152``` 154```
153 155
154`retention` is a list of specifications: each will apply to either all kinds, or 156`retention` is a list of specifications: each will apply to either all kinds, or
155a subset of kinds. Ranges may be specified for the kind field as a tuple of inclusive 157a subset of kinds. Ranges may be specified for the kind field as a tuple of inclusive
156start and end values. Events of indicated kind (or all) are then limited to a `count` 158start and end values. Events of indicated kind (or all) are then limited to a `count`
157and/or time period. 159and/or time period.
@@ -161,8 +163,7 @@ a specific `kind` number, by giving a retention time of zero for those `kind` va
161While that is unfortunate, it does allow clients to discover servers that will 163While that is unfortunate, it does allow clients to discover servers that will
162support their protocol quickly via a single HTTP fetch. 164support their protocol quickly via a single HTTP fetch.
163 165
164There is no need to specify retention times for _ephemeral events_ as defined 166There is no need to specify retention times for _ephemeral events_ since they are not retained.
165in [NIP-16](16.md) since they are not retained.
166 167
167 168
168### Content Limitations ### 169### Content Limitations ###
@@ -271,7 +272,7 @@ A URL pointing to an image to be used as an icon for the relay. Recommended to b
271As of 2 May 2023 the following `curl` command provided these results. 272As of 2 May 2023 the following `curl` command provided these results.
272 273
273 >curl -H "Accept: application/nostr+json" https://eden.nostr.land 274 >curl -H "Accept: application/nostr+json" https://eden.nostr.land
274 275
275 {"name":"eden.nostr.land", 276 {"name":"eden.nostr.land",
276 "description":"Eden Nostr Land - Toronto 1-01", 277 "description":"Eden Nostr Land - Toronto 1-01",
277 "pubkey":"00000000827ffaa94bfea288c3dfce4422c794fbb96625b6b31e9049f729d700", 278 "pubkey":"00000000827ffaa94bfea288c3dfce4422c794fbb96625b6b31e9049f729d700",
@@ -285,7 +286,6 @@ As of 2 May 2023 the following `curl` command provided these results.
285 "max_filters":2500, 286 "max_filters":2500,
286 "max_limit":5000, 287 "max_limit":5000,
287 "max_subid_length":256, 288 "max_subid_length":256,
288 "min_prefix":4,
289 "max_event_tags":2500, 289 "max_event_tags":2500,
290 "max_content_length":65536, 290 "max_content_length":65536,
291 "min_pow_difficulty":0, 291 "min_pow_difficulty":0,
@@ -293,5 +293,5 @@ As of 2 May 2023 the following `curl` command provided these results.
293 "payment_required":true}, 293 "payment_required":true},
294 "payments_url":"https://eden.nostr.land/invoices", 294 "payments_url":"https://eden.nostr.land/invoices",
295 "fees":{"admission":[{"amount":5000000,"unit":"msats"}], 295 "fees":{"admission":[{"amount":5000000,"unit":"msats"}],
296 "publication":[]}}, 296 "publication":[]}},
297 "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg" 297 "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg"