aboutsummaryrefslogtreecommitdiff
path: root/include/nostr.hpp
diff options
context:
space:
mode:
authorLibravatar Michael Jurkoic <mjjurkoic@gmail.com>2024-03-17 14:09:42 -0500
committerLibravatar Michael Jurkoic <mjjurkoic@gmail.com>2024-03-17 14:09:42 -0500
commit20b0f9c073d52e95b02399d6a243010e36b6c4f1 (patch)
treecb669a6f9cb19469722a782c9fbbcd83a89dc3fb /include/nostr.hpp
parent137b8b1267e1202b5d6f673bbee49526ae64aaab (diff)
Serialize relay query filters into a JSON array
Diffstat (limited to 'include/nostr.hpp')
-rw-r--r--include/nostr.hpp5
1 files changed, 4 insertions, 1 deletions
diff --git a/include/nostr.hpp b/include/nostr.hpp
index fa407ef..8041efe 100644
--- a/include/nostr.hpp
+++ b/include/nostr.hpp
@@ -83,10 +83,13 @@ struct Filters
/**
* @brief Serializes the filters to a JSON object.
+ * @param subscriptionId A string up to 64 chars in length that is unique per relay connection.
* @returns A stringified JSON object representing the filters.
* @throws `std::invalid_argument` if the filter object is invalid.
+ * @remarks The Nostr client is responsible for managing subscription IDs. Responses from the
+ * relay will be organized by subscription ID.
*/
- std::string serialize();
+ std::string serialize(std::string subscriptionId);
private:
/**