vacp2p/rfc
1
0
Fork 0
mirror of https://github.com/vacp2p/rfc.git synced 2025-02-17 09:26:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix/v1-specs-stablized (#231)

Browse Source 
* stabalized

* commit

* versions
This commit is contained in:
Dean Eigenmann 2020-11-18 12:19:59 +01:00 committed by GitHub
parent 1af7dfc169
commit a3f449925c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 39 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
specs/mvds.md
View File

@ -1,7 +1,7 @@
---
title: Minimum Viable Data Synchronization
version: 0.6.0
status: Draft
version: 1.0.0
status: Stable
authors: Oskar Thorén <oskar@status.im>, Dean Eigenmann <dean@status.im>
redirect_from:
- /mvds.html
@ -153,12 +153,13 @@ MVDS has been formally specified using TLA+: <https://github.com/vacp2p/formalit
## Changelog
| Version | Comment |
| :-----: | ------- |
| [0.6.0](https://github.com/vacp2p/specs/commit/b6335947e09502ec399954002d983a709065a342#diff-a6dbd535bfcb545a64b1c95f6dc8f9f1) | Breaking change to update protocol buffer and field changes. |
| [0.5.2](https://github.com/vacp2p/specs/blob/0adddcdb8d7e71240c2df30d4ba40e49b4275011/mvds.md) | Breaking change to update protocol buffer and field changes. |
| [0.5.1](https://github.com/status-im/bigbrother-specs/blob/20e2659447dcb5123a105526eb26816307c3780c/data_sync/mvds.md) | Documentation updates: clarifications on spec, RFC-2119 and message identifiers. |
| [0.5.0](https://github.com/status-im/bigbrother-specs/blob/6d3d0771b46941791eabe9263f80cbaeaf3d1148/data_sync/mvds.md) | Initial Release |
| Version | Comment |
| :----------------------------------------------------------------------------------------------------------------------------: | -------------------------------------------------------------------------------- |
| [1.0.0](https://github.com/vacp2p/specs/commit/bc7e75ebb2e45d2cbf6ab27352c113e666df37c8) | marked stable as it is in use. |
| [0.6.0](https://github.com/vacp2p/specs/commit/b6335947e09502ec399954002d983a709065a342#diff-a6dbd535bfcb545a64b1c95f6dc8f9f1) | Breaking change to update protocol buffer and field changes. |
| [0.5.2](https://github.com/vacp2p/specs/blob/0adddcdb8d7e71240c2df30d4ba40e49b4275011/mvds.md) | Breaking change to update protocol buffer and field changes. |
| [0.5.1](https://github.com/status-im/bigbrother-specs/blob/20e2659447dcb5123a105526eb26816307c3780c/data_sync/mvds.md) | Documentation updates: clarifications on spec, RFC-2119 and message identifiers. |
| [0.5.0](https://github.com/status-im/bigbrother-specs/blob/6d3d0771b46941791eabe9263f80cbaeaf3d1148/data_sync/mvds.md) | Initial Release |
## Acknowledgments
- Preston van Loon

13
specs/waku/v1/envelope-data-format.md
View File

@ -1,7 +1,7 @@
---
title: Envelope data field
version: 0.1.0
status: Draft
version: 1.0.0
status: Stable
authors: Oskar Thorén <oskar@status.im>, Dean Eigenmann <dean@status.im>
redirect_from:
- /waku/envelope-data-format.html
@ -14,7 +14,8 @@ redirect_from:
1. [ABNF](#abnf)
2. [Signature](#signature)
3. [Padding](#padding)
3. [Copyright](#copyright)
3. [Changelog](#changelog)
4. [Copyright](#copyright)
## Abstract
@ -68,6 +69,12 @@ Those unable to decrypt the envelope data are also unable to access the signatur
The padding field is used to align data size, since data size alone might reveal important metainformation. Padding can be arbitrary size. However, it is recommended that the size of Data Field (excluding the Salt) before encryption (i.e. plain text) SHOULD be factor of 256 bytes.
## Changelog
| Version | Comment |
| :--------------------------------------------------------------------------------------:| ---------------- |
| [1.0.0](https://github.com/vacp2p/specs/commit/bc7e75ebb2e45d2cbf6ab27352c113e666df37c8)| Initial release. |
## Copyright
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

11
specs/waku/v1/mailserver.md
View File

@ -1,7 +1,7 @@
---
title: Waku Mailserver
version: 0.2.0
status: Draft
version: 1.0.0
status: Stable
authors: Adam Babik <adam@status.im>, Dean Eigenmann <dean@status.im>, Oskar Thorén <oskar@status.im>
redirect_from:
- /waku/mailserver.html
@ -110,9 +110,10 @@ A mailserver has a direct TCP connection, which means they are trusted to send t
## Changelog
| Version | Comment |
| :-----: | ------- |
| 0.2.0 (current) | Add topic interest to reduce bandwidth usage |
| Version | Comment |
| :--------------------------------------------------------------------------------------------: | ------- |
| [1.0.0](https://github.com/vacp2p/specs/commit/bc7e75ebb2e45d2cbf6ab27352c113e666df37c8) | marked stable as it is in use. |
| 0.2.0 | Add topic interest to reduce bandwidth usage |
| [0.1.0](https://github.com/vacp2p/specs/blob/06d4c736c920526472a507e5d842212843a112ed/wms.md) | Initial Release |
### Difference between wms 0.1 and wms 0.2

4
specs/waku/v1/waku-1.md
View File

@ -1,7 +1,7 @@
---
title: Waku
version: 1.0.0
status: Draft
status: Stable
authors: Adam Babik <adam@status.im>, Andrea Maria Piana <andreap@status.im>, Dean Eigenmann <dean@status.im>, Kim De Mey <kimdemey@status.im>, Oskar Thorén <oskar@status.im>
redirect_from:
- /waku/waku.html
@ -568,7 +568,7 @@ Known static nodes MAY also be used.
## Changelog
### Upcoming Version
### [Initial Release](https://github.com/vacp2p/specs/commit/bc7e75ebb2e45d2cbf6ab27352c113e666df37c8)
- Add section on P2P Request Complete packet and update packet code table.
- Correct the header hierarchy for the status-options fields.

17
specs/waku/v1/waku-rpc-api.md
View File

@ -1,7 +1,7 @@
---
title: Waku RPC API
version: 0.1.0
status: Draft
version: 1.0.0
status: Stable
authors: Dean Eigenmann <dean@status.im>
---
@ -10,9 +10,10 @@ authors: Dean Eigenmann <dean@status.im>
1. [Abstract](#abstract)
2. [Wire Protocol](#wire-protocol)
1. [Transport](#transport)
1. [Objects](#objects)
1. [Methods](#methods)
3. [Copyright](#copyright)
2. [Objects](#objects)
3. [Methods](#methods)
3. [Changelog](#changelog)
4. [Copyright](#copyright)
## Abstract
@ -405,6 +406,12 @@ The parameters is an `Object` containing the following fields:
- **bool** - `true` on success or an [error](https://www.jsonrpc.org/specification#error_object) on failure.
## Changelog
| Version | Comment |
| :--------------------------------------------------------------------------------------:| ---------------- |
| [1.0.0](https://github.com/vacp2p/specs/commit/bc7e75ebb2e45d2cbf6ab27352c113e666df37c8)| Initial release. |
## Copyright
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).