* Added waku README.md, starting text and structure
Resolves GH-1944
* Added api, config and doc details
* Created Docs for waku.const, envelope and events
* Added notes on Filter
* Rewrote the filter section
* Restructured docs to match new versioning structure
* Moved package files out of the main ToC
* Added waku/common/README.md
* Added details to mailserver.go and notes to api.go
* Update to bloomfilter and const common
* Added common/ helpers.go, errors.go and message.go details
* Added common/metrics.go and protocol details
* Added rate_limiter and topic.go details
* fix rate limiter table
* Added Waku Versioning details
* Added Versioned sub-package file details
* Added better detail for Waku Filters
Addressing https://github.com/status-im/status-go/pull/1949#discussion_r419232235
* Added notes about light nodes not being actually new
* Added more detail for Waku node configs and defaults
* Added details to the version message.go section
* Added details to waku/common/rate_limiter
* Minor typo fix in docs
Why make the change?
As discussed previously, the way we will move across versions is to maintain completely separate
codebases and eventually remove those that are not supported anymore.
This has the drawback of some code duplication, but the advantage is that is more
explicit what each version requires, and changes in one version will not
impact the other, so we won't pile up backward compatible code.
This is the same strategy used by `whisper` in go ethereum and is influenced by
https://www.youtube.com/watch?v=oyLBGkS5ICk .
All the code that is used for the networking protocol is now under `v0/`.
Some of the common parts might still be refactored out.
The main namespace `waku` deals with `host`->`waku` interactions (through RPC),
while `v0` deals with `waku`->`remote-waku` interactions.
In order to support `v1`, the namespace `v0` will be copied over, and changed to
support `v1`. Once `v0` will be not used anymore, the whole namespace will be removed.
This PR does not actually implement `v1`, I'd rather get things looked over to
make sure the structure is what we would like before implementing the changes.
What has changed?
- Moved all code for the common parts under `waku/common/` namespace
- Moved code used for bloomfilters in `waku/common/bloomfilter.go`
- Removed all version specific code from `waku/common/const` (`ProtocolVersion`, status-codes etc)
- Added interfaces for `WakuHost` and `Peer` under `waku/common/protocol.go`
Things still to do
Some tests in `waku/` are still testing by stubbing components of a particular version (`v0`).
I started moving those tests to instead of stubbing using the actual component, which increases
the testing surface. Some other tests that can't be easily ported should be likely moved under
`v0` instead. Ideally no version specif code should be exported from a version namespace (for
example the various codes, as those might change across versions). But this will be a work-in-progress.
Some code that will be common in `v0`/`v1` could still be extract to avoid duplication, and duplicated only
when implementations diverge across versions.
Samuel Hawksby-Robinson
Andrea Maria Piana