From 3d3f323438c8999c2cdc6cbee47a3f37627c1f9f Mon Sep 17 00:00:00 2001 From: Oskar Thoren Date: Wed, 28 Oct 2020 13:04:13 +0800 Subject: [PATCH] Add default PubSub topic Indicate in next version, don't release it yet (pending store and filter protocol changes). --- specs/waku/v2/waku-v2.md | 48 +++++++++++++++++++++++++++++++++------- wordlist.txt | 2 ++ 2 files changed, 42 insertions(+), 8 deletions(-) diff --git a/specs/waku/v2/waku-v2.md b/specs/waku/v2/waku-v2.md index 9591bb56..5f0099b9 100644 --- a/specs/waku/v2/waku-v2.md +++ b/specs/waku/v2/waku-v2.md @@ -10,16 +10,25 @@ authors: Oskar Thorén - [Abstract](#abstract) - [Motivation and goals](#motivation-and-goals) - [Network interaction domains](#network-interaction-domains) - + [Protocol Identifiers](#protocol-identifiers) - * [Gossip domain](#gossip-domain) - * [Discovery domain](#discovery-domain) - * [Request/reply domain](#request-reply-domain) - + [Historical message support](#historical-message-support) - + [Content filtering](#content-filtering) + - [Protocols and identifiers](#protocols-and-identifiers) + - [Gossip domain](#gossip-domain) + - [Default pubsub topic](#default-pubsub-topic) + - [Discovery domain](#discovery-domain) + - [Request/reply domain](#requestreply-domain) + - [Historical message support](#historical-message-support) + - [Content filtering](#content-filtering) - [Upgradability and Compatibility](#upgradability-and-compatibility) - * [Compatibility with Waku v1](#compatibility-with-waku-v1) + - [Compatibility with Waku v1](#compatibility-with-waku-v1) + - [Changelog](#changelog) + - [Next version](#next-version) + - [2.0.0-beta1](#200-beta1) - [Copyright](#copyright) - [References](#references) +- [Underlying transports, etc](#underlying-transports-etc) + - [Peer Discovery](#peer-discovery) + - [PubSub interface](#pubsub-interface) + - [FloodSub](#floodsub) + - [Bridge mode](#bridge-mode) # Abstract @@ -68,7 +77,7 @@ interaction domains: (a) gossip domain (b) discovery domain (c) req/resp domain. The current [protocol identifiers](https://docs.libp2p.io/concepts/protocols/) are: -1. `/vac/waku/relay/2.0.0-beta1` +1. `/vac/waku/relay/2.0.0-beta2` 2. `/vac/waku/store/2.0.0-beta1` 3. `/vac/waku/filter/2.0.0-beta1` @@ -76,12 +85,30 @@ These protocols and their semantics are elaborated on in their own specs. For the actual content being passed around, see the [Waku Message](waku-message.md) spec. +The WakuMessage spec being used is: `2.0.0-beta1`. + ## Gossip domain **Protocol identifier***: `/vac/waku/relay/2.0.0-beta1` See [WakuRelay](waku-relay.md) spec for more details. +### Default pubsub topic + +The default PubSub topic being used for Waku is currently: `/waku/2/default-waku/proto` + +This indicates that it relates to Waku, is version 2, is the default topic, and +that the encoding of data field is protobuf. + +The default PubSub topic SHOULD be used for all protocols. This ensures a +connected network, as well some degree of metadata protection. It MAY be +different if or when: + +- Different applications have different message volume +- Topic sharding is introduced +- Encoding is changed +- Version is changed + ## Discovery domain Discovery domain is not yet implemented. Currently static nodes should be used. @@ -122,6 +149,11 @@ See [bridge spec](waku-bridge.md) for details on a bridge mode. ## Changelog +### Next version + +- Add recommended default PubSub topic +- Update relay and message spec version + ### 2.0.0-beta1 Initial draft version. Released [2020-09-17](https://github.com/vacp2p/specs/commit/a57dad2cc3d62f9128e21f68719704a0b358768b) diff --git a/wordlist.txt b/wordlist.txt index 9d77af0b..9489d754 100644 --- a/wordlist.txt +++ b/wordlist.txt @@ -119,6 +119,7 @@ protobuf PSS pseudonymity PubSub +pubsub pyspelling qNAN remoteHash @@ -141,6 +142,7 @@ SECP semver seqid seqno +sharding Sieka sNAN suboptimal