Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add usage guidelines for waku content topics #117

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions waku/informational/23/topics.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,18 @@ to indicate different bandwidth and privacy guarantees.
The encoding field indicates the serialization/encoding scheme
for the [WakuMessage payload](../../standards/core/14/message.md/#payloads) field.

### 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 Store and Filter protocols while trying to retrieve messages.
chaitanyaprem marked this conversation as resolved.
Show resolved Hide resolved

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: eventhough 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.
chaitanyaprem marked this conversation as resolved.
Show resolved Hide resolved


## Differences with Waku v1

In [5/WAKU1](../../deprecated/5/waku0.md) there is no actual routing.
Expand Down
Loading