rfc/README.md

1.3 KiB

Specifications

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.

  • mvds - Ensure reliable messaging between peers across an unreliable peer-to-peer (P2P) network where they may be unreachable or unresponsive.

  • remote log - Ensures a node can read data from a node that iss offline by replicating a local log remotely.

Style guide

All specs follow RFC-2119.

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.