3.2 KiB
This repository contains the specs for vac, 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.
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 to version these specifications.
Protocols
These protocols define various components of the vac stack.
Waku
Waku is a protocol that substitutes EIP-627. Waku v2 is in development. Here you can read more about the plan for it and an update.
Waku is made up of several protocols and specifications. To see them go to the Waku spec home.
Data sync
- mvds - Data Synchronization protocol for unreliable transports.
- remote log - Remote replication of local logs.
- mvds metadata - Metadata field for MVDS messages.
Style guide
Sequence diagrams are generated using 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.
Alternatively, mscgenjs can be used to generate sequence diagrams (mscgenjs produces better quality figures especially concerning lines' spaces and figures' margins). Once installed, the following command can be used to generate the sequence diagrams mscgenjs -T png -i input.msc -o output.png. More details on the installation and compilation are given in mscgenjs repository. You may try the online playground https://mscgen.js.org/ as well to get a sense of the output figures.
The lifecycle of the specs follows the COSS Lifecycle
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.
Linting
Spellcheck
To run the spellchecker locally, you must install pyspelling.
It can then be run with the following command:
pyspelling -c .pyspelling.yml
Words that should be ignored or are unrecognized must be added to the wordlist.
Markdown Verification
We use remark to verify our markdown. You can easily run this tool simply by using our npm package:
npm install
npm run lint
Textlint
We use textlint for extra markdown verification. You can easily run this tool simply by using our npm package:
npm install
npm run textlint