waku-org/specs
1
0
Fork 0
mirror of https://github.com/waku-org/specs.git synced 2025-02-21 01:08:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Jimmy Debe 2024-02-15 14:47:13 -05:00 committed by GitHub
parent 1aff7f2b86
commit 6ddda523df
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 55 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
README.md
View File

@ -1,26 +1,72 @@
# Waku Specifications # Waku Specifications
Waku builds a family of privacy-preserving, censorship-resistant communication protocols for web3 applications. Waku builds a family of privacy-preserving, censorship-resistant communication protocols for web3 applications.
This repository contain specification from contributors wanting to imporve Waku protocols. This repository contains specifications for the Waku suite of protocols.
## Index:
- Informational:
- Standards
- Core:
- Application:
| Waku Specifications | Description |
| ---- | -------------- |
|[10/WAKU2](https://rfc.vac.dev/spec/10/)| Core |
|[11/WAKU2-RELAY](https://rfc.vac.dev/spec/11)| Core |
|[12/WAKU2-FILTER](https://rfc.vac.dev/spec/12)| Core|
|[13/WAKU2-STORE](https://rfc.vac.dev/spec/13/)| Core |
|[14/WAKU2-MESSAGE](https://rfc.vac.dev/spec/14/)| Core |
|[15/WAKU2-BRIDGE](https://rfc.vac.dev/spec/15)| Core |
|[16/WAKU2-RPC](https://rfc.vac.dev/spec/16)| Core |
|[17/WAKU2-RLN-RELAY](https://rfc.vac.dev/spec/17/)| Core |
|[18/WAKU2-SWAP](https://rfc.vac.dev/spec/18/)| Application |
|[19/WAKU2-LIGHTPUSH](https://rfc.vac.dev/spec/19/)| Core |
|[20/TOY-ETH-PM](https://rfc.vac.dev/spec/20/)| Application |
|[21/WAKU2-FAULT-TOLERANT-STORE](https://rfc.vac.dev/spec/21/)| Application |
|[22/TOY-CHAT](https://rfc.vac.dev/spec/22/)| Informational |
|[23/WAKU2-TOPICS](https://rfc.vac.dev/spec/23/)| Informational |
|[26/WAKU2-PAYLOAD](https://rfc.vac.dev/spec/26/)| Application |
|[27/WAKU2-PEERS](https://rfc.vac.dev/spec/27/)| Informational |
|[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 |
## Resources ## Resources
Relvant Waku resouces related to the specifications located in this repository: Relevant Waku resources related to the specifications located in this repository:
- [Waku.org](https://waku.org/) - [Waku.org](https://waku.org/)
- [nWaku: Waku Node](https://github.com/waku-org/nwaku) - [nwaku: Waku Node](https://github.com/waku-org/nwaku)
## Contributions ## Contributions
Contributions are welcome from any party. Contributions are welcome from any party.
Contributors can create specifcations relating to the Waku domain and Contributors can create specifications relating to the Waku domain and
create a pull request to begin discussion. create a pull request to begin discussion.
There is no format/template for accepted specifications to the Waku RFC. The recommended template may be used for new proposed specifications.
New specifications are considered a proof of concept, New specifications are considered a proof of concept.
once a rough consensus is reached towards stabilzition, Once a rough consensus is reached towards stabilization,
the specification may be considered to receive the draft status and the specification may be considered to receive the draft status and
further discussion will continue on the [Vac RFC-Index](https://github.com/vacp2p/rfc-index) repository. further discussion will continue on the [Vac RFC-Index](https://github.com/vacp2p/rfc-index) repository.
**NOTE:** Specifications located in this repository should be considered not production ready. **NOTE:** Specifications located in this repository should be considered not production ready.
Discussion should be conducted with the intention of maturing each specifications. Discussion should be conducted with the intention of maturing each specification.
Head over to the [Vac RFC-Index](https://github.com/vacp2p/rfc-index) repository where other Waku specifcations live. Head over to the [Vac RFC-Index](https://github.com/vacp2p/rfc-index) repository where other Waku specifications live.