From 04e1588360133a1bc7632b0389fd993ce111d402 Mon Sep 17 00:00:00 2001 From: Prem Chaitanya Prathi Date: Thu, 2 Jan 2025 16:45:08 +0530 Subject: [PATCH] address review comments --- waku/informational/23/topics.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/waku/informational/23/topics.md b/waku/informational/23/topics.md index 9dab1f91..59a1bab7 100644 --- a/waku/informational/23/topics.md +++ b/waku/informational/23/topics.md @@ -120,8 +120,8 @@ As an example, here's the content topic used for an upcoming testnet: ### Content Topic Naming Recommendations -Application names should be unique to avoid conflicting issues with other protocols. -Applications should specify their version (if applicable) in the version field. +Application names SHOULD be unique to avoid conflicting issues with other protocols. +Applications SHOULD specify their version (if applicable) in the version field. The `{content-topic-name}` portion of the content topic is up to the application, and depends on the problem domain. It can be hierarchical, for instance to separate content, or @@ -131,14 +131,14 @@ for the [WakuMessage payload](../../standards/core/14/message.md/#payloads) fiel ### Content Topic usage guidelines -Applications should be mindful while designing/using content topics so that a bloat of content-topics does not happen. -A content-topic bloat causes performance degradation in [13/WAKU2 -STORE](/waku/standards/core/13/store.md) and [12/WAKU2-FILTER](/waku/standards/core/13/filter.md) protocols while trying to retrieve messages. +Applications SHOULD be mindful while designing/using content topics so that a bloat of content-topics does not happen. +A content-topic bloat causes performance degradation in Store and Filter protocols while trying to retrieve messages. Store queries have been noticed to be considerably slow (e.g doubling of response-time when content-topic count is increased from 10 to 100) when a lot of content-topics are involved in a single query. Similarly number of filter subscriptions increase, which increases complexity on client side to maintain and manage these subscriptions. -Applications should analyze the query/filter criteria for fetching messages from the network and select/design content topics to match such filter criteria. -e.g: even though applications may want to segregate messages into different sets based on some application logic, if those sets of messages are always fetched/queried together from the network, then all those messages should use a single content-topic. +Applications SHOULD analyze the query/filter criteria for fetching messages from the network and select/design content topics to match such filter criteria. +e.g: even though applications may want to segregate messages into different sets based on some application logic, if those sets of messages are always fetched/queried together from the network, then all those messages SHOULD use a single content-topic. ## Differences with Waku v1