edc90625ff
adds some edits fixes minor typo WIP: integrates the pagination into store protocol updates wordlist.txt WIP: minor updates updates wordlist minor updates updates TOC updates the specs fixes a typo beta1 to beta2 deletes waku-store-pagination.md updates TOC with an autogenerated markdown-toc Update specs/waku/v2/waku-store.md Co-authored-by: Oskar Thorén <ot@oskarthoren.com> Update specs/waku/v2/waku-store.md Co-authored-by: Oskar Thorén <ot@oskarthoren.com> Update specs/waku/v2/waku-store.md Co-authored-by: Oskar Thorén <ot@oskarthoren.com> Update specs/waku/v2/waku-store.md Co-authored-by: Oskar Thorén <ot@oskarthoren.com> Update specs/waku/v2/waku-store.md Co-authored-by: Oskar Thorén <ot@oskarthoren.com> itemizes the message fields of HistoryRPC some updates Update specs/waku/v2/waku-store.md Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com> WIP: initial reorganization WIP: shortens the pagination spec removes some comments and adds more details to the wire spec minor updates beta1 to beta2 converts direction to enum edits the Index description Update specs/waku/v2/waku-store.md Co-authored-by: Oskar Thorén <ot@oskarthoren.com> shortens the abstract Update specs/waku/v2/waku-store.md Co-authored-by: Oskar Thorén <ot@oskarthoren.com> Update specs/waku/v2/waku-store.md Co-authored-by: Oskar Thorén <ot@oskarthoren.com> edits changelog Update specs/waku/v2/waku-store.md Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com> Update specs/waku/v2/waku-store.md Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com> Update specs/waku/v2/waku-store.md Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com> Update specs/waku/v2/waku-store.md Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com> minor minor reformats the change log Update specs/waku/v2/waku-store.md Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com> edits version numbers updates the release date removes Table of content from Table of content! Update specs/waku/v2/waku-store.md Co-authored-by: Kim De Mey <kim.demey@gmail.com> edits the wordlist explains the case where pageSize is zero Update waku-store.md Update waku-v2.md adds an overview of the sorting approach minor Update waku-store.md |
||
|---|---|---|
| .github | ||
| _includes | ||
| _layouts | ||
| assets | ||
| specs | ||
| .gitignore | ||
| .pyspelling.yml | ||
| .remarkrc | ||
| .textlintrc | ||
| 404.html | ||
| CNAME | ||
| CONTRIBUTING.md | ||
| Gemfile | ||
| Gemfile.lock | ||
| README.md | ||
| _config.yml | ||
| package-lock.json | ||
| package.json | ||
| wordlist.txt | ||
README.md
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.
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