vacp2p/rfc
1
0
Fork 0
mirror of https://github.com/vacp2p/rfc.git synced 2025-01-11 15:24:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README linking to Waku spec overview page (#204)

Browse Source 
Partially addresses https://github.com/vacp2p/specs/issues/197
This commit is contained in:
Oskar Thorén 2020-10-05 19:20:10 +08:00 committed by GitHub
parent 61824575fc
commit df30e4ce15
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -10,23 +10,18 @@ The entire vac protocol is under active development, each specification has its
These protocols define various components of the [vac](https://vac.dev) stack.
## Waku
Waku is a protocol that substitutes [EIP-627](https://eips.ethereum.org/EIPS/eip-627). Waku v2 is in development. Here you can read more about the [plan for it](https://vac.dev/waku-v2-plan) and an [update](https://vac.dev/waku-v2-update).
Waku is made up of several protocols and specifications. To see them go to the [Waku spec home](https://specs.vac.dev/specs/waku/).
### Data sync
- [mvds](./specs/mvds.md) - Data Synchronization protocol for unreliable transports.
- [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.
### Waku
Waku is a protocol that substitutes [EIP-627](https://eips.ethereum.org/EIPS/eip-627).
- [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.
- [rpc api](./specs/waku/waku-rpc-api.md) - The RPC API for interacting with a Waku node.
Waku v2 is in development. Here you can read more about the [plan for it](https://vac.dev/waku-v2-plan) and an [update](https://vac.dev/waku-v2-update). Here's the current main spec:
- [waku v2](https://specs.vac.dev/specs/waku/v2/waku-v2.html)
## 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.