NIP-91: remove has_more, add auth_recommended

This commit is contained in:
Semisol 2024-04-15 09:07:23 +03:00 committed by GitHub
parent 46f8133cd4
commit 053d07e0ef
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

11
91.md
View File

@ -30,7 +30,8 @@ This MAY be higher or lower than the lowest `created_at`, and the clients SHOULD
### `cursor` ### `cursor`
The value of this extension MUST be a string if present, and represents a cursor the client can use to paginate this query. The value of this extension MUST be a string or `null` if present, and represents a cursor the client can use to paginate this query.
If the value is `null`, then it indicates that no more events are available for the given set of filters.
To get more events, the client MUST send a `REQ` with the same filters (except limit, which can be changed), and the `cursor` string To get more events, the client MUST send a `REQ` with the same filters (except limit, which can be changed), and the `cursor` string
in the 1st filter with the key `cursor`. Example: in the 1st filter with the key `cursor`. Example:
```jsonc ```jsonc
@ -46,8 +47,8 @@ in the 1st filter with the key `cursor`. Example:
This cursor MUST be valid for the duration of the connection, and MAY be valid in a new connection. A relay may indicate a cursor is no longer valid This cursor MUST be valid for the duration of the connection, and MAY be valid in a new connection. A relay may indicate a cursor is no longer valid
by sending a CLOSED with the prefix `bad-cursor: `. by sending a CLOSED with the prefix `bad-cursor: `.
### `has_more` ### `auth_recommended`
`recommended`
The value of this extension MUST be a boolean if present, and should represent if the client should continue trying to get events. The value of this extension MUST be a boolean if present, and indicates if the client should `AUTH` to get more events that match this query.
This MAY be false if the relay has completed the query due to not having more events available, or may not be able to complete this query due to a permanent failure (scan limit exceeded is one). This is a less disruptive alternative to `CLOSED` with `auth-required:` for filters that don't explicitly ask for access controlled events,
but may match them.