acid-info
/
vacp2p-rfc
mirror of https://github.com/acid-info/vacp2p-rfc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
vacp2p-rfc/README.md

33 lines
2.1 KiB
Markdown
Raw Normal View History

Update README.md
2020-01-31 16:36:02 +00:00
[![Build Status](https://travis-ci.com/vacp2p/specs.svg?branch=master)](https://travis-ci.com/vacp2p/specs)
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
fix
2020-02-20 15:25:21 +00:00
- [mvds](./specs/mvds.md) - Data Synchronization protocol for unreliable transports.
update
2020-02-20 15:44:00 +00:00
- [remote log](./specs/remote-log.md) - Remote replication of local logs.
- [mvds metadata](./specs/mvds-metadata.md) - Metadata field for [MVDS](./specs/mvds.md) messages.
move/specs-waku (#82) * moves waku * Update README.md * Update README.md * Update README.md
2019-12-18 05:20:02 +00:00
### Waku
Waku is a protocol that substitutes [EIP-627](https://eips.ethereum.org/EIPS/eip-627).
update
2020-02-20 15:44:00 +00:00
- [waku](./specs/waku/waku.md) - ÐΞVp2p wire protocol, substituting [EIP-627](https://eips.ethereum.org/EIPS/eip-627).
- [envelope data format](./specs/waku/envelope-data-format.md) - [waku](./specs/waku/waku.md) envelope data field specification.
- [mailserver](./specs/waku/mailserver.md) - Mailserver specification for archiving and delivering historical [waku](./specs/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.
Upgrade waku specs to waku/1 This commit upgrades the spec to waku/1. Changes include: - RLP code are now 0,1,2,3,4,5 for status-options - Version is removed from handshake - Waku/1 is now advertised Co-Authored-By: Kim De Mey <kim.demey@gmail.com>
2020-04-21 06:07:05 +00:00
The lifecycle of the specs follows the [COSS Lifecycle](https://rfc.unprotocols.org/spec:2/COSS/)
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).