nostr/nips

Fork 0

mirror of https://github.com/nostr-protocol/nips.git synced 2025-08-24 11:20:47 -04:00

Files

01.md

02.md

03.md

04.md

05.md

06.md

07.md

08.md

09.md

10.md

11.md

12.md

13.md

14.md

15.md

16.md

17.md

18.md

19.md

20.md

21.md

22.md

23.md

24.md

25.md

26.md

27.md

28.md

29.md

30.md

31.md

32.md

33.md

34.md

35.md

36.md

37.md

38.md

39.md

40.md

42.md

44.md

45.md

46.md

47.md

48.md

49.md

50.md

51.md

52.md

53.md

54.md

55.md

56.md

57.md

58.md

59.md

60.md

61.md

62.md

64.md

65.md

66.md

68.md

69.md

70.md

71.md

72.md

73.md

75.md

78.md

7D.md

84.md

86.md

88.md

89.md

90.md

92.md

94.md

96.md

98.md

99.md

BREAKING.md

C0.md

C7.md

README.md

kehiy b4a2561df7 style: fix header styles in same format

2024-09-02 22:51:48 -03:00

2.0 KiB

Raw Blame History

NIP-45

Event Counts

draft optional

Relays may support the verb COUNT, which provides a mechanism for obtaining event counts.

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.

Filters and return values

This NIP defines the verb COUNT, which accepts a subscription id and filters as specified in NIP 01 for the verb REQ. Multiple filters are OR'd together and aggregated into a single count result.

["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. 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>}]

Whenever the relay decides to refuse to fulfill the COUNT request, it MUST return a CLOSED message.

Examples

Followers count

["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}]

Count posts approximately

["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"]

2.0 KiB Raw Blame History