vacp2p
/
rfc
mirror of https://github.com/vacp2p/rfc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Modular p2p messaging stack, with a focus on secure messaging. https://rfc.vac.dev/
182 Commits 45 Branches 11 Tags 32 MiB
HTML 77.9%
Dockerfile 22.1%
Go to file
Samuel Hawksby-Robinson ddf37e52d3
Waku Confirmations Enabled and Light Node Field Descriptions (#128) 
* Reference fixes

Updated .gitignore to include ide files

Added simple reference to Envelope definition

Added discribtion for light node and confirm enabled fields

Resolves GH-124

Revert changes to .gitignore

Update specs/waku/waku-1.md

Co-authored-by: Kim De Mey <kim.demey@gmail.com>

Revert link fix changes

Addressed also in GH-131

Revert link error

Addressed spelling issues

Addressing feedback

Added Batch Ack to definitions

rephrase to reintroduce rfc2119 language

Added correct spelling of acknowledgement to wordlist

Update specs/waku/waku-1.md

Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com>

Update specs/waku/waku-1.md

Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com>

Update specs/waku/waku-1.md

Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com>

Change to Use the incorrect spelling of words

* Resolved rebase conflicts
 		2020-05-25 09:27:58 +01:00
.github github-actions-readme-spelling (#127) 2020-05-20 09:03:40 +02:00
_includes added 2020-02-20 10:48:25 -05:00
_layouts fix 2020-02-20 10:51:53 -05:00
assets Update remote log asset 2019-10-01 12:52:02 +08:00
specs Waku Confirmations Enabled and Light Node Field Descriptions (#128) 2020-05-25 09:27:58 +01:00
.gitignore travis 2020-01-31 17:33:54 +01:00
.remarkrc adds link checks (#131) 2020-05-21 12:20:44 +08:00
404.html Create 404.html 2019-09-22 20:39:34 +02:00
CNAME Create CNAME 2019-08-04 15:25:11 +02:00
Gemfile sitemap (#109) 2020-03-01 17:00:06 +01:00
Gemfile.lock update 2020-02-20 10:18:26 -05:00
README.md Update README.md (#129) 2020-05-20 17:15:08 +08:00
_config.yml fix/redirects (#110) 2020-03-11 12:37:08 +01:00
package-lock.json adds link checks (#131) 2020-05-21 12:20:44 +08:00
package.json adds link checks (#131) 2020-05-21 12:20:44 +08:00
spellcheck.yaml github-actions-readme-spelling (#127) 2020-05-20 09:03:40 +02:00
wordlist.txt Waku Confirmations Enabled and Light Node Field Descriptions (#128) 2020-05-25 09:27:58 +01:00

README.md

CI

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 - Data Synchronization protocol for unreliable transports.
  • remote log - Remote replication of local logs.
  • mvds metadata - Metadata field for MVDS messages.

Waku

Waku is a protocol that substitutes EIP-627.

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 spellcheck.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