AtHeartEngineer/rfc-index
1
0
Fork 0
mirror of https://github.com/vacp2p/rfc-index.git synced 2026-01-07 23:04:09 -05:00
Code Issues Packages Projects Releases Wiki Activity

update waku/informational/29/config.md (#146)

Browse Source 
Improved config.md file in waku/informational/29 folder
This commit is contained in:
Cofson
2025-04-22 12:55:15 +02:00
committed by GitHub
parent 34aa3f3647
commit 7408956616
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
waku/informational/29/config.md
View File

@@ -5,6 +5,7 @@ name: Waku v2 Client Parameter Configuration Recommendations
status: draft status: draft
editor: Hanno Cornelius <hanno@status.im> editor: Hanno Cornelius <hanno@status.im>
contributors: contributors:
- Filip Dimitrijevic <filip@status.im>
--- ---
`29/WAKU2-CONFIG` describes the RECOMMENDED values `29/WAKU2-CONFIG` describes the RECOMMENDED values
@@ -12,7 +13,7 @@ to assign to configurable parameters for Waku v2 clients.
Since Waku v2 is built on [libp2p](https://github.com/libp2p/specs), Since Waku v2 is built on [libp2p](https://github.com/libp2p/specs),
most of the parameters and reasonable defaults are derived from there. most of the parameters and reasonable defaults are derived from there.
Waku v2 relay messaging is specified in [`11/WAKU2-RELAY`](../../standards/core/11/relay.md), Waku v2 relay messaging is specified in [`11/WAKU2-RELAY`](/waku/standards/core/11/relay.md),
a minor extension of the [libp2p GossipSub protocol](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/README.md). a minor extension of the [libp2p GossipSub protocol](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/README.md).
GossipSub behaviour is controlled by a series of adjustable parameters. GossipSub behaviour is controlled by a series of adjustable parameters.
Waku v2 clients SHOULD configure these parameters to the recommended values below. Waku v2 clients SHOULD configure these parameters to the recommended values below.
@@ -26,7 +27,7 @@ We repeat them here with RECOMMMENDED values for `11/WAKU2-RELAY` implementation
|----------------------|-------------------------------------------------------|-------------------| |----------------------|-------------------------------------------------------|-------------------|
| `D` | The desired outbound degree of the network | 6 | | `D` | The desired outbound degree of the network | 6 |
| `D_low` | Lower bound for outbound degree | 4 | | `D_low` | Lower bound for outbound degree | 4 |
| `D_high` | Upper bound for outbound degree | 8 | | `D_high` | Upper bound for outbound degree | 8 |
| `D_lazy` | (Optional) the outbound degree for gossip emission | `D` | | `D_lazy` | (Optional) the outbound degree for gossip emission | `D` |
| `heartbeat_interval` | Time between heartbeats | 1 second | | `heartbeat_interval` | Time between heartbeats | 1 second |
| `fanout_ttl` | Time-to-live for each topic's fanout state | 60 seconds | | `fanout_ttl` | Time-to-live for each topic's fanout state | 60 seconds |
@@ -36,9 +37,10 @@ We repeat them here with RECOMMMENDED values for `11/WAKU2-RELAY` implementation
## GossipSub v1.1 parameters ## GossipSub v1.1 parameters
GossipSub v1.1 extended GossipSub v1.0 and introduced [several new parameters](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md#overview-of-new-parameters). GossipSub v1.1 extended GossipSub v1.0 and
We repeat the global parameters here with RECOMMMENDED values introduced [several new parameters](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md#overview-of-new-parameters).
for `11/WAKU2-RELAY` implementations. We repeat the global parameters here
with RECOMMMENDED values for `11/WAKU2-RELAY` implementations.
| Parameter | Description | RECOMMENDED value | | Parameter | Description | RECOMMENDED value |
|----------------|------------------------------------------------------------------------|-------------------| |----------------|------------------------------------------------------------------------|-------------------|
@@ -73,7 +75,7 @@ Copyright and related rights waived via
## References ## References
- [libp2p](https://github.com/libp2p/specs) - [libp2p](https://github.com/libp2p/specs)
- [11/WAKU2-RELAY](../../standards/core/11/relay.md) - [11/WAKU2-RELAY](/waku/standards/core/11/relay.md)
- [libp2p GossipSub protocol](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/README.md) - [libp2p GossipSub protocol](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/README.md)
- [corresponding libp2p specification](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.0.md#parameters) - [corresponding libp2p specification](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.0.md#parameters)
- [several new parameters](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md#overview-of-new-parameters) - [several new parameters](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md#overview-of-new-parameters)