mirror of https://github.com/vacp2p/rfc.git
Add default PubSub topic
Indicate in next version, don't release it yet (pending store and filter protocol changes).
This commit is contained in:
parent
fff669230d
commit
3d3f323438
|
@ -10,16 +10,25 @@ authors: Oskar Thorén <oskar@status.im>
|
||||||
- [Abstract](#abstract)
|
- [Abstract](#abstract)
|
||||||
- [Motivation and goals](#motivation-and-goals)
|
- [Motivation and goals](#motivation-and-goals)
|
||||||
- [Network interaction domains](#network-interaction-domains)
|
- [Network interaction domains](#network-interaction-domains)
|
||||||
+ [Protocol Identifiers](#protocol-identifiers)
|
- [Protocols and identifiers](#protocols-and-identifiers)
|
||||||
* [Gossip domain](#gossip-domain)
|
- [Gossip domain](#gossip-domain)
|
||||||
* [Discovery domain](#discovery-domain)
|
- [Default pubsub topic](#default-pubsub-topic)
|
||||||
* [Request/reply domain](#request-reply-domain)
|
- [Discovery domain](#discovery-domain)
|
||||||
+ [Historical message support](#historical-message-support)
|
- [Request/reply domain](#requestreply-domain)
|
||||||
+ [Content filtering](#content-filtering)
|
- [Historical message support](#historical-message-support)
|
||||||
|
- [Content filtering](#content-filtering)
|
||||||
- [Upgradability and Compatibility](#upgradability-and-compatibility)
|
- [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)
|
- [Copyright](#copyright)
|
||||||
- [References](#references)
|
- [References](#references)
|
||||||
|
- [Underlying transports, etc](#underlying-transports-etc)
|
||||||
|
- [Peer Discovery](#peer-discovery)
|
||||||
|
- [PubSub interface](#pubsub-interface)
|
||||||
|
- [FloodSub](#floodsub)
|
||||||
|
- [Bridge mode](#bridge-mode)
|
||||||
|
|
||||||
# Abstract
|
# 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:
|
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`
|
2. `/vac/waku/store/2.0.0-beta1`
|
||||||
3. `/vac/waku/filter/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.
|
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
|
## Gossip domain
|
||||||
|
|
||||||
**Protocol identifier***: `/vac/waku/relay/2.0.0-beta1`
|
**Protocol identifier***: `/vac/waku/relay/2.0.0-beta1`
|
||||||
|
|
||||||
See [WakuRelay](waku-relay.md) spec for more details.
|
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
|
||||||
|
|
||||||
Discovery domain is not yet implemented. Currently static nodes should be used.
|
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
|
## Changelog
|
||||||
|
|
||||||
|
### Next version
|
||||||
|
|
||||||
|
- Add recommended default PubSub topic
|
||||||
|
- Update relay and message spec version
|
||||||
|
|
||||||
### 2.0.0-beta1
|
### 2.0.0-beta1
|
||||||
|
|
||||||
Initial draft version. Released [2020-09-17](https://github.com/vacp2p/specs/commit/a57dad2cc3d62f9128e21f68719704a0b358768b)
|
Initial draft version. Released [2020-09-17](https://github.com/vacp2p/specs/commit/a57dad2cc3d62f9128e21f68719704a0b358768b)
|
||||||
|
|
|
@ -119,6 +119,7 @@ protobuf
|
||||||
PSS
|
PSS
|
||||||
pseudonymity
|
pseudonymity
|
||||||
PubSub
|
PubSub
|
||||||
|
pubsub
|
||||||
pyspelling
|
pyspelling
|
||||||
qNAN
|
qNAN
|
||||||
remoteHash
|
remoteHash
|
||||||
|
@ -141,6 +142,7 @@ SECP
|
||||||
semver
|
semver
|
||||||
seqid
|
seqid
|
||||||
seqno
|
seqno
|
||||||
|
sharding
|
||||||
Sieka
|
Sieka
|
||||||
sNAN
|
sNAN
|
||||||
suboptimal
|
suboptimal
|
||||||
|
|
Loading…
Reference in New Issue