History

kaiserd f767fd1b69 update: topic naming (#579 )		2023-03-13 10:36:57 +01:00
..
README.md	update: topic naming (#579 )	2023-03-13 10:36:57 +01:00

README.md

slug

title

name

status

Pubsub Topics

Pubsub topics are used for routing of messages (see 11/WAKU2-RELAY), and can be named implicitly by Waku sharding (see 51/WAKU2-RELAY-SHARDING). This document comprises recommendations for explicitly naming pubsub topics (e.g. when choosing named sharding as specified in 51/WAKU2-RELAY-SHARDING).

Pubsub Topic Format

Pubsub topics SHOULD follow the following structure:

/waku/2/{topic-name}

This namespaced structure makes compatibility, discoverability, and automatic handling of new topics easier.

The first two parts indicate

it relates to the Waku protocol domain, and
the version is 2.

If applicable, it is RECOMMENDED to structure {topic-name} in a hierarchical way as well.

Note: In previous versions of this document, the structure was /waku/2/{topic-name}/{encoding}. The now deprecated /{encoding} was always set to /proto, which indicated that the data field in pubsub is serialized/encoded as protobuf. The inspiration for this format was taken from Ethereum 2 P2P spec. However, because the payload of messages transmitted over 11/WAKU2-RELAY must be a 14/WAKU2-MESSAGE, which specifies the wire format as protobuf,/proto is the only valid encoding. This makes the /proto indication obsolete. The encoding of the payload field of a Waku Message is indicated by the /{encoding} part of the content topic name. Specifying an encoding is only significant for the actual payload/data field. Waku preserves this option by allowing to specify an encoding for the WakuMessage payload field as part of the content topic name.

Default PubSub Topic

The Waku v2 default pubsub topic is:

/waku/2/default-waku/proto

The {topic name} part is default-waku/proto, which indicates it is default topic for exchanging WakuMessages; /proto remains for backwards compatibility.

Application Specific Names

Larger apps can segregate their pubsub meshes using topics named like:

/waku/2/status/
/waku/2/walletconnect/

This indicates that these networks carry WakuMessages, but for different domains completely.

Named Topic Sharding Example

The following is an example of named sharding, as specified in 51/WAKU2-RELAY-SHARDING.

waku/2/waku-9_shard-0/
...
waku/2/waku-9_shard-9/

This indicates explicitly that the network traffic has been partitioned into 10 buckets.

Content Topics

The other type of topic that exists in Waku v2 is a content topic. This is used for content based filtering. See 14/WAKU2-MESSAGE spec for where this is specified. Note that this doesn't impact routing of messages between relaying nodes, but it does impact how request/reply protocols such as 12/WAKU2-FILTER and 13/WAKU2-STORE are used.

This is especially useful for nodes that have limited bandwidth, and only want to pull down messages that match this given content topic.

Since all messages are relayed using the relay protocol regardless of content topic, you MAY use any content topic you wish without impacting how messages are relayed.

Content Topic Format

The format for content topics is as follows:

/{application-name}/{version-of-the-application}/{content-topic-name}/{encoding}

The name of a content topic is application-specific. As an example, here's the content topic used for an upcoming testnet:

/toychat/2/huilong/proto

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. 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 to indicate different bandwidth and privacy guarantees. The encoding field indicates the serialization/encoding scheme for the WakuMessage payload field.

Differences with Waku v1

In 6/WAKU1 there is no actual routing. All messages are sent to all other nodes. This means that we are implicitly using the same pubsub topic that would be something like:

/waku/1/default-waku/rlp

Topics in Waku v1 correspond to Content Topics in Waku v2.

Bridging Waku v1 and Waku v2

To bridge Waku v1 and Waku v2 we have a 15/WAKU-BRIDGE. For mapping Waku v1 topics to Waku v2 content topics, the following structure for the content topic SHOULD be used:

/waku/1/<4bytes-waku-v1-topic>/rfc26

The <4bytes-waku-v1-topic> SHOULD be the lowercase hex representation of the 4-byte Waku v1 topic. A 0x prefix SHOULD be used. /rfc26 indicates that the bridged content is encoded according to RFC 26/WAKU-PAYLOAD. See 15/WAKU-BRIDGE for a description of the bridged fields.

This creates a direct mapping between the two protocols. For example:

/waku/1/0x007f80ff/rfc26