From 4c0ff4a6427c688167a0b8d334f91edd3abb7a27 Mon Sep 17 00:00:00 2001 From: Dean Eigenmann Date: Tue, 14 Jan 2020 05:22:44 +0100 Subject: [PATCH] rename/specs-descriptive (#89) * started renaming * fix --- README.md | 6 +++--- mdf.md => mvds-metadata.md | 0 waku/{wedf.md => envelope-data-format.md} | 0 waku/{wms.md => mailserver.md} | 0 waku/waku.md | 4 ++-- 5 files changed, 5 insertions(+), 5 deletions(-) rename mdf.md => mvds-metadata.md (100%) rename waku/{wedf.md => envelope-data-format.md} (100%) rename waku/{wms.md => mailserver.md} (100%) diff --git a/README.md b/README.md index ccd9cd87..12a19af7 100644 --- a/README.md +++ b/README.md @@ -12,15 +12,15 @@ These protocols define various components of the [vac](https://vac.dev) stack. - [mvds](./mvds.md) - Data Synchronization protocol for unreliable transports. - [remote log](./remote-log.md) - Remote replication of local logs. - - [mdf](./mdf.md) - Metadata field for [MVDS](./mvds.md) messages. + - [mvds metadata](./mvds-metadata.md) - Metadata field for [MVDS](./mvds.md) messages. ### Waku Waku is a protocol that substitutes [EIP-627](https://eips.ethereum.org/EIPS/eip-627). - [waku](./waku/waku.md) - ÐΞVp2p wire protocol, substituting [EIP-627](https://eips.ethereum.org/EIPS/eip-627). - - [wedf](./waku/wedf.md) - [waku](./waku/waku.md) envelope data field specification. - - [wms](./waku/wms.md) - Mailserver specification for archiving and delivering historical [waku](./waku/waku.md) envelopes on demand. + - [envelope data format](./waku/envelope-data-format.md) - [waku](./waku/waku.md) envelope data field specification. + - [mailserver](./waku/mailserver.md) - Mailserver specification for archiving and delivering historical [waku](./waku/waku.md) envelopes on demand. ## Style guide diff --git a/mdf.md b/mvds-metadata.md similarity index 100% rename from mdf.md rename to mvds-metadata.md diff --git a/waku/wedf.md b/waku/envelope-data-format.md similarity index 100% rename from waku/wedf.md rename to waku/envelope-data-format.md diff --git a/waku/wms.md b/waku/mailserver.md similarity index 100% rename from waku/wms.md rename to waku/mailserver.md diff --git a/waku/waku.md b/waku/waku.md index 42f843f0..4ac21319 100644 --- a/waku/waku.md +++ b/waku/waku.md @@ -65,7 +65,7 @@ For nodes to communicate, they MUST implement devp2p and run RLPx. They MUST hav ### Gossip based routing -In Whisper, messages are gossiped between peers. Whisper is a form of rumor-mongering protocol that works by flooding to its connected peers based on some factors. Messages are elgible for retransmission until their TTL expires. A node SHOULD relay messages to all connected nodes if an envelope matches their PoW and bloom filter settings. If a node works in light mode, it MAY choose not to forward envelopes. A node MUST NOT send expired envelopes, unless the envelopes are sent as a [mailserver](./wms.md) response. A node SHOULD NOT send a message to a peer that it has already sent before. +In Whisper, messages are gossiped between peers. Whisper is a form of rumor-mongering protocol that works by flooding to its connected peers based on some factors. Messages are elgible for retransmission until their TTL expires. A node SHOULD relay messages to all connected nodes if an envelope matches their PoW and bloom filter settings. If a node works in light mode, it MAY choose not to forward envelopes. A node MUST NOT send expired envelopes, unless the envelopes are sent as a [mailserver](./mailserver.md) response. A node SHOULD NOT send a message to a peer that it has already sent before. ## Wire Specification @@ -337,7 +337,7 @@ Packet codes `0x7E` and `0x7F` may be used to implement Waku Mail Server and Cli Waku supports multiple capabilities. These include light node, rate limiting and bridging of traffic. Here we list these capabilities, how they are identified, what properties they have and what invariants they must maintain. -Additionally there is the capability of a mailserver which is documented in its on [specification](./wms). +Additionally there is the capability of a mailserver which is documented in its on [specification](./mailserver.md). ### Light node