highperfocused/nips
1
0
Fork 0
mirror of https://github.com/nostr-protocol/nips.git synced 2025-03-25 17:21:52 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge e37b4146b93f2312a3ea55d1c134851cf24c9720 into 0619f370bca3485bb9c5870bc2defa03c7c3d10e

Browse Source
This commit is contained in:
k. 2025-03-17 17:23:51 -03:00 committed by GitHub
commit b61120d59a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
45.md
View File

@ -10,21 +10,21 @@ Relays may support the verb `COUNT`, which provides a mechanism for obtaining ev
## Motivation
Some queries a client may want to execute against connected relays are prohibitively expensive, for example, in order to retrieve follower counts for a given pubkey, a client must query all kind-3 events referring to a given pubkey only to count them. The result may be cached, either by a client or by a separate indexing server as an alternative, but both options erode the decentralization of the network by creating a second-layer protocol on top of Nostr.
Some queries a client may want to execute against connected relays are prohibitively expensive, for example, in order to retrieve follower counts for a given pubkey, a client must query all kind-3 events referring to a given pubkey only to count them. The result may be cached, either by a client or by a separate indexing server as an alternative, but both options erode the decentralization of the network by creating a second-layer protocol on top of the Nostr.
## Filters and return values
## Filter and return values
This NIP defines the verb `COUNT`, which accepts a subscription id and filters as specified in [NIP 01](01.md) for the verb `REQ`. Multiple filters are OR'd together and aggregated into a single count result.
This NIP defines the verb `COUNT`, which accepts a subscription id and a filter as specified in [NIP 01](01.md) for the verb `REQ`.
```
["COUNT", <subscription_id>, <filters JSON>...]
```json
["COUNT", "<subscription_id>", <filter JSON>]
```
Counts are returned using a `COUNT` response in the form `{"count": <integer>}`. Relays may use probabilistic counts to reduce compute requirements.
Counts are returned using a `COUNT` response in the form `{"count": <integer>}`. Relays MAY use probabilistic counts to reduce compute requirements.
In case a relay uses probabilistic counts, it MAY indicate it in the response with `approximate` key i.e. `{"count": <integer>, "approximate": <true|false>}`.
```
["COUNT", <subscription_id>, {"count": <integer>}]
```json
["COUNT", "<subscription_id>", {"count": <integer>}]
```
Whenever the relay decides to refuse to fulfill the `COUNT` request, it MUST return a `CLOSED` message.
@ -33,28 +33,28 @@ Whenever the relay decides to refuse to fulfill the `COUNT` request, it MUST ret
### Followers count
```
["COUNT", <subscription_id>, {"kinds": [3], "#p": [<pubkey>]}]
["COUNT", <subscription_id>, {"count": 238}]
```json
["COUNT", "<subscription_id>", {"kinds": [3], "#p": ["<pubkey>"]}]
["COUNT", "<subscription_id>", {"count": 238}]
```
### Count posts and reactions
```
["COUNT", <subscription_id>, {"kinds": [1, 7], "authors": [<pubkey>]}]
["COUNT", <subscription_id>, {"count": 5}]
```json
["COUNT", "<subscription_id>", {"kinds": [1, 7], "authors": ["<pubkey>"]}]
["COUNT", "<subscription_id>", {"count": 5}]
```
### Count posts approximately
```
["COUNT", <subscription_id>, {"kinds": [1]}]
["COUNT", <subscription_id>, {"count": 93412452, "approximate": true}]
```json
["COUNT", "<subscription_id>", {"kinds": [1]}]
["COUNT", "<subscription_id>", {"count": 93412452, "approximate": true}]
```
### Relay refuses to count
```
["COUNT", <subscription_id>, {"kinds": [4], "authors": [<pubkey>], "#p": [<pubkey>]}]
["CLOSED", <subscription_id>, "auth-required: cannot count other people's DMs"]
```json
["COUNT", "<subscription_id>", {"kinds": [4], "authors": ["<pubkey>"], "#p": ["<pubkey>"]}]
["CLOSED", "<subscription_id>", "auth-required: cannot count other people's DMs"]
```