logos-messaging/specs
1
0
Fork 0
mirror of https://github.com/logos-messaging/specs.git synced 2026-01-02 14:13:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Jimmy Debe 2024-07-01 13:58:49 -04:00 committed by GitHub
parent a4e1ac6035
commit d0893fcedb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 45 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
README.md
View File

@ -4,50 +4,59 @@ Waku builds a family of privacy-preserving, censorship-resistant communication p
This repository contains specifications for the Waku suite of protocols. This repository contains specifications for the Waku suite of protocols.
## List of Specifications: ## List of Specifications:
- Informational: Waku design issues, general guidelines or background information that does not constitute a new feature.
- Standards - Standards
- Core: Standards and protocols for the core Waku p2p communications offering. - 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. - Application: Standards and protocols that describe various applications or encryption use cases built on top of a Waku network.
- Informational: Waku design issues, general guidelines or background information that does not constitute a new feature.
### Core standards
| Waku Specifications | Description | | Waku Specifications | Description |
| ---- | -------------- | | ---- | -------------- |
|[10/WAKU2](https://rfc.vac.dev/spec/10/)| Core | |[10/WAKU2](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/10/waku2.md)| Waku Overview |
|[11/WAKU2-RELAY](https://rfc.vac.dev/spec/11)| Core | |[11/WAKU2-RELAY](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/11/relay.md)| Waku Relay |
|[12/WAKU2-FILTER](https://rfc.vac.dev/spec/12)| Core| |[12/WAKU2-FILTER](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/12/filter.md)| Waku Filter |
|[13/WAKU2-STORE](https://rfc.vac.dev/spec/13/)| Core | |[13/WAKU2-STORE](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/13/store.md)| Waku Store |
|[14/WAKU2-MESSAGE](https://rfc.vac.dev/spec/14/)| Core | |[14/WAKU2-MESSAGE](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/14/message.md)| Waku Message |
|[15/WAKU2-BRIDGE](https://rfc.vac.dev/spec/15)| Core | |[17/WAKU2-RLN-RELAY](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/17/rln-relay.md)| Waku RLN Relay |
|[16/WAKU2-RPC](https://rfc.vac.dev/spec/16)| Core | |[19/WAKU2-LIGHTPUSH](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/19/lightpush.md)| Waku Lightpush |
|[17/WAKU2-RLN-RELAY](https://rfc.vac.dev/spec/17/)| Core | |[33/WAKU2-DISCV5](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/33/discv5.md)| Waku Discovery v5 Ambient Peer Discovery |
|[18/WAKU2-SWAP](https://rfc.vac.dev/spec/18/)| Application | |[36/WAKU2-BINDINGS-API](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/36/bindings-api.md)| Waku C Bindings API |
|[19/WAKU2-LIGHTPUSH](https://rfc.vac.dev/spec/19/)| Core | |[WAKU2-PEER-EXCHANGE](standards/core/peer-exchange.md)| Waku Peer Exchange |
|[20/TOY-ETH-PM](https://rfc.vac.dev/spec/20/)| Application | |[WAKU2-ENR](standards/core/enr.md)| Waku Usage of ENR |
|[21/WAKU2-FAULT-TOLERANT-STORE](https://rfc.vac.dev/spec/21/)| Application | |[WAKU2-INCENTIVIZATION](standards/core/incentivization.md)| Waku Incentivization |
|[22/TOY-CHAT](https://rfc.vac.dev/spec/22/)| Informational | |[66/WAKU2-METADATA](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/66/metadata.md)| Waku Metadata |
|[23/WAKU2-TOPICS](https://rfc.vac.dev/spec/23/)| Informational | |[64/WAKU2-NETWORK](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/64/network.md)| Waku Network |
|[26/WAKU2-PAYLOAD](https://rfc.vac.dev/spec/26/)| Application | |[RELAY-SHARDING](standards/core/relay-sharding.md)| Waku Relay Sharding |
|[27/WAKU2-PEERS](https://rfc.vac.dev/spec/27/)| Informational | |[WAKU2-STORE](standards/core/store.md) | Waku Store Query |
|[29/WAKU2-CONFIG](https://rfc.vac.dev/spec/29/)| Informational |
|[30/ADAPTIVE-NODES](https://rfc.vac.dev/spec/30/)| Informational |
|[33/WAKU2-DISCV5](https://rfc.vac.dev/spec/33/)| Core |
|[36/WAKU2-BINDINGS-API](https://rfc.vac.dev/spec/36/)| Core |
|[53/WAKU2-X3DH](https://rfc.vac.dev/spec/53/)| Application |
|[54/WAKU2-X3DH-SESSIONS](https://rfc.vac.dev/spec/54/)| Application |
|[ADVERSARIAL-MODELS](informational/adversarial-models.md)| Informational |
|[RELAY-STATIC-SHARD-ALLOC](informational/relay-static-shard-alloc.md)| Informational |
|[DANDELION](standards/application/dandelion.md)| Application |
|[WAKU2-DEVICE-PAIRING](standards/application/device-pairing.md)| Application |
|[WAKU2-PEER-EXCHANGE](standards/core/peer-exchange.md)| Core |
|[WAKU2-ENR](standards/core/enr.md)| Core |
|[WAKU2-NOISE](standards/application/noise.md)| Application |
|[TOR-PUSH](standards/application/tor-push.md)| Application |
|[WAKU2-INCENTIVIZATION](standards/core/incentivization.md)| Core |
|[WAKU2-METADATA](standards/core/metadata.md)| Core |
|[WAKU2-NETWORK](standards/core/network.md)| Core |
|[RELAY-SHARDING](standards/core/relay-sharding.md)| Core |
| WAKU2-STOREV3 | Coming Soon |
### Application standards
| Waku Specifications | Description |
| ---- | -------------- |
|[20/TOY-ETH-PM](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/application/20/toy-eth-pm.md)| Toy Ethereum Private Message |
|[21/WAKU2-FAULT-TOLERANT-STORE](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/application/21/fault-tolerant-store.md)| Waku Fault-Tolerant Store |
|[22/TOY-CHAT](https://github.com/vacp2p/rfc-index/blob/main/waku/informational/22/toy-chat.md)| Waku Toy Chat |
|[26/WAKU2-PAYLOAD](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/application/26/payload.md)| Waku Message Payload Encryption |
|[53/WAKU2-X3DH](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/application/53/x3dh.md)| X3DH Usage for Waku Payload Encryption |
|[54/WAKU2-X3DH-SESSIONS](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/application/54/x3dh-sessions.md)| Session Management for Waku X3DH |
|[DANDELION](standards/application/dandelion.md)| Waku Dandelion |
|[WAKU2-DEVICE-PAIRING](standards/application/device-pairing.md)| Device Pairing and Secure Transfers with Noise |
|[WAKU2-NOISE](standards/application/noise.md)| Noise Protocols for Waku Payload Encryption |
|[TOR-PUSH](standards/application/tor-push.md)| Waku Tor Push |
|[RLN-KEYSTORE](standards/application/rln-keystore.md)| Waku RLN Keystore JSON schema|
### Informational
| Waku Specifications | Description |
| ---- | -------------- |
|[23/WAKU2-TOPICS](https://github.com/vacp2p/rfc-index/blob/main/waku/informational/23/topics.md)| Waku Topic Usage Recommendations |
|[27/WAKU2-PEERS](https://github.com/vacp2p/rfc-index/blob/main/waku/informational/27/peers.md)| Waku Peer Management Recommendations |
|[29/WAKU2-CONFIG](https://github.com/vacp2p/rfc-index/blob/main/waku/informational/29/config.md)| Waku Parameter Configuration Recommendations |
|[30/ADAPTIVE-NODES](https://github.com/vacp2p/rfc-index/blob/main/waku/informational/30/adaptive-nodes.md)| Adaptive Nodes |
|[ADVERSARIAL-MODELS](informational/adversarial-models.md)| Waku Adversarial Models and Attack-based Threat List |
|[RELAY-STATIC-SHARD-ALLOC](informational/relay-static-shard-alloc.md)| Waku Relay Static Shard Allocation |
## Resources ## Resources
Relevant Waku resources related to the specifications located in this repository: Relevant Waku resources related to the specifications located in this repository: