Document multiple queries in a COUNT request

This commit is contained in:
Leo Wandersleb 2023-05-06 12:29:09 -04:00 committed by GitHub
parent bc9d469c20
commit 535cfcc7e5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

8
45.md
View File

@ -14,13 +14,13 @@ Some queries a client may want to execute against connected relays are prohibiti
## Filters and return values ## Filters and return values
This NIP defines a verb called `COUNT`, which accepts a subscription id and filters as specified in [NIP 01](01.md). This NIP defines the verb `COUNT`, which accepts a subscription id and filters as specified in [NIP 01](01.md).
``` ```
["COUNT", <subscription_id>, <filters JSON>...] ["COUNT", <subscription_id>, <filters 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 with positional "count" objects in the form `{"count": <integer>}`. Relays may use probabilistic counts to reduce compute requirements.
``` ```
["COUNT", <subscription_id>, {"count": <integer>}] ["COUNT", <subscription_id>, {"count": <integer>}]
@ -36,4 +36,8 @@ Examples:
# Count posts and reactions # Count posts and reactions
["COUNT", <subscription_id>, {"kinds": [1, 7], "authors": [<pubkey>]}] ["COUNT", <subscription_id>, {"kinds": [1, 7], "authors": [<pubkey>]}]
["COUNT", <subscription_id>, {"count": 5}] ["COUNT", <subscription_id>, {"count": 5}]
# Both of the above in one `COUNT`
["COUNT", <subscription_id>, {"kinds": [3], "#p": [<pubkey>]}, {"kinds": [1, 7], "authors": [<pubkey>]}]
["COUNT", <subscription_id>, {"count": 238}, {"count": 5}]
``` ```