Go to file
Jimmy Debe 7ace67f110
Update LICENSE
2024-02-20 12:35:06 -05:00
.github/workflows Update spelling.yml 2024-02-15 13:37:21 -05:00
images Rename assets/images/protocol.svg to images/protocol.svg 2024-02-15 14:54:46 -05:00
informational Update adversarial-models.md 2024-02-14 16:08:44 -05:00
standards Update noise-sessions.md 2024-02-15 14:57:09 -05:00
LICENSE Update LICENSE 2024-02-20 12:35:06 -05:00
README.md Update README.md 2024-02-15 16:15:03 -05:00
spellcheck.yaml Update spellcheck.yaml 2024-02-15 13:50:04 -05:00
template.md Create template.md 2024-02-15 16:06:13 -05:00

README.md

Waku Specifications

Waku builds a family of privacy-preserving, censorship-resistant communication protocols for web3 applications. This repository contains specifications for the Waku suite of protocols.

List of Specifications:

  • Informational: Waku design issues, general guidelines or background information that does not constitute a new feature.
  • Standards
    • Core: Standards and protocols for the core Waku p2p communications offering.
    • Application: Standards and protocols that describe various applications or encryption use cases built on top of a Waku network.
Waku Specifications Description
10/WAKU2 Core
11/WAKU2-RELAY Core
12/WAKU2-FILTER Core
13/WAKU2-STORE Core
14/WAKU2-MESSAGE Core
15/WAKU2-BRIDGE Core
16/WAKU2-RPC Core
17/WAKU2-RLN-RELAY Core
18/WAKU2-SWAP Application
19/WAKU2-LIGHTPUSH Core
20/TOY-ETH-PM Application
21/WAKU2-FAULT-TOLERANT-STORE Application
22/TOY-CHAT Informational
23/WAKU2-TOPICS Informational
26/WAKU2-PAYLOAD Application
27/WAKU2-PEERS Informational
29/WAKU2-CONFIG Informational
30/ADAPTIVE-NODES Informational
33/WAKU2-DISCV5 Core
36/WAKU2-BINDINGS-API Core
53/WAKU2-X3DH Application
54/WAKU2-X3DH-SESSIONS Application
ADVERSARIAL-MODELS Informational
RELAY-STATIC-SHARD-ALLOC Informational
DANDELION Application
WAKU2-DEVICE-PAIRING Application
WAKU2-PEER-EXCHANGE Core
WAKU2-ENR Core
WAKU2-NOISE Application
TOR-PUSH Application
WAKU2-INCENTIVIZATION Core
WAKU2-METADATA Core
WAKU2-NETWORK Core
RELAY-SHARDING Core
WAKU2-STOREV3 Coming Soon

Resources

Relevant Waku resources related to the specifications located in this repository:

Contributions

Contributions are welcome from any party. Contributors can create specifications relating to the Waku domain and create a pull request to begin discussion. The recommended template may be used for new proposed specifications.

New specifications are considered a proof of concept. Once a rough consensus is reached towards stabilization, the specification may be considered to receive the draft status and further discussion will continue on the Vac RFC-Index repository.

NOTE: Specifications located in this repository should be considered not production ready. Discussion should be conducted with the intention of maturing each specification.

Head over to the Vac RFC-Index repository where other Waku specifications live.