vacp2p-rfc/README.md

# Specifications

This repository contains the specs for [vac](https://vac.dev), a modular peer-to-peer messaging stack, with a focus on secure messaging. A detailed explanation of the vac and its design goals can be found [here](https://vac.dev/vac-overview).

## Status

The entire vac protocol is under active development, each specification has its own `status` which is reflected through the version number at the top of every document. We use [semver](https://semver.org/) to version these specifications.

## Protocols

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. 
 - [waku](./waku.md) - ÐΞVp2p wire protocol, substituting [EIP-627](https://eips.ethereum.org/EIPS/eip-627).
 - [wedf](./wedf.md) - [Waku](./waku.md) envelope data field specification.
 - [wms](./wms.md) - Mailserver specification for archiving and delivering historical [waku](./waku.md) envelopes on demand.

## Style guide

Sequence diagrams are generated using [Mscgen](http://www.mcternan.me.uk/mscgen/) like this: `mscgen -T png -i input.msc -o output.png`. Both the source and generated image should be in source control. For ease of readability, the generated image is embedded inside the main spec document.

## Meta

The keywords “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).
Update README.md 2019-08-02 15:27:59 +00:00			`# Specifications`
Update README.md 2019-07-25 18:32:54 +00:00
vacp2p -> vac 2019-08-02 16:18:06 +00:00			`This repository contains the specs for [vac](https://vac.dev), a modular peer-to-peer messaging stack, with a focus on secure messaging. A detailed explanation of the vac and its design goals can be found [here](https://vac.dev/vac-overview).`
Update README.md 2019-07-25 18:32:54 +00:00
			`## Status`

vacp2p -> vac 2019-08-02 16:18:06 +00:00			The entire vac protocol is under active development, each specification has its own `status` which is reflected through the version number at the top of every document. We use [semver](https://semver.org/) to version these specifications.
adding some stuff to readme 2019-08-02 15:01:36 +00:00
Update README.md 2019-07-25 18:32:54 +00:00			`## Protocols`

vacp2p -> vac 2019-08-02 16:18:06 +00:00			`These protocols define various components of the [vac](https://vac.dev) stack.`
Update README.md 2019-07-25 18:32:54 +00:00
shorter-descriptions (#20) * Update README.md * Update README.md 2019-10-18 03:30:15 +00:00			`- [mvds](./mvds.md) - Data Synchronization protocol for unreliable transports.`
			`- [remote log](./remote-log.md) - Remote replication of local logs.`
spec/sync-modes (#4) * started * parents * minor * updated hash * added some desc * new v cause breaks message * fixed * ack flag * upadte * first changes * package * updated * extended * started adding soem fields * readded fields section * toc * using american spelling * some more text * fixed * changes * updated * started working on persistence. * eol * fixed * nicer path * removed ack flag * brought back the ack * done * update abstract * Update README.md * Update mdf.md * Update mdf.md * Update mdf.md * Update mdf.md * Update mdf.md * Update mdf.md * Update mdf.md * added previous message * unit32 * spellcheck * changed context to groupid * moved back * updated * removes sequence * removed * made parents -> parent & previous_message -> previous_messages * changed wording * linked list * changed note * updated * mode * ack -> ack_required * update header * space * changed phrasing * Update mdf.md * Update mdf.md * minor changes, added motivation and ref consistency * Update mdf.md * Update mdf.md * Update mdf.md * Update mdf.md * Update mdf.md * Update README.md * Update mdf.md * Update mdf.md * Update mdf.md * first changes from oskar * Update mdf.md * Update mdf.md * Update mdf.md * Update mdf.md * Update README.md * Update mdf.md * Update mdf.md * Update mdf.md * Update mdf.md 2019-10-21 14:49:03 +00:00			`- [mdf](./mdf.md) - Metadata field for [MVDS](./mvds.md) messages.`
Update README.md 2019-11-21 21:24:45 +00:00			`- [waku](./waku.md) - ÐΞVp2p wire protocol, substituting [EIP-627](https://eips.ethereum.org/EIPS/eip-627).`
spec/envelope (#76) * moved spec, still needs some rewriting * fix * added abstract * rewrote * add to readme * Update edf.md * Update edf.md * Update edf.md Co-Authored-By: kdeme <kim.demey@gmail.com> * rename 2019-12-16 05:05:11 +00:00			`- [wedf](./wedf.md) - [Waku](./waku.md) envelope data field specification.`
spec/mail-server (#77) * mail server specification * todo * Update waku.md * add adam * changes * remove todo * reference * fixes * updates 2019-12-13 10:06:54 +00:00			`- [wms](./wms.md) - Mailserver specification for archiving and delivering historical [waku](./waku.md) envelopes on demand.`
update readme remote log 2019-10-03 03:08:30 +00:00
Add style guide on sequence diagrams 2019-09-24 05:29:48 +00:00			`## Style guide`

			Sequence diagrams are generated using [Mscgen](http://www.mcternan.me.uk/mscgen/) like this: `mscgen -T png -i input.msc -o output.png`. Both the source and generated image should be in source control. For ease of readability, the generated image is embedded inside the main spec document.
Update README.md 2019-11-02 14:52:22 +00:00
			`## Meta`

			`The keywords “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).`