ba418ab5ba
* DOS protection of non relay protocols - rate limit phase3: - Enhanced TokenBucket to be able to add compensation tokens based on previous usage percentage, - per peer rate limiter 'PeerRateLimier' applied on waku_filter_v2 with opinionated default of acceptable request rate - Add traffic metrics to filter message push - RequestRateLimiter added to combine simple token bucket limiting of request numbers but consider per peer usage over time and prevent some peers to over use the service (although currently rule violating peers will not be disconnected by this time only their requests will get not served) - TimedMap utility created (inspired and taken from libp2p TimedCache) which serves as forgiving feature for peers had been overusing the service. - Added more tests - Fix rebase issues - Applied new RequestRateLimiter for store and legacy_store and lightpush * Incorporate review comments, typos, file/class naming and placement changes. * Add issue link reference of the original issue with nim-chronos TokenBucket * Make TimedEntry of TimedMap private and not mixable with similar named in libp2p * Fix review comments, renamings, const instead of values and more comments.
Nwaku
Introduction
The nwaku repository implements Waku, and provides tools related to it.
- A Nim implementation of the Waku (v2) protocol.
- CLI application
wakunode2that allows you to run a Waku node. - Examples of Waku usage.
- Various tests of above.
For more details see the source code
How to Build & Run
These instructions are generic. For more detailed instructions, see the Waku source code above.
Prerequisites
The standard developer tools, including a C compiler, GNU Make, Bash, and Git. More information on these installations can be found here.
Wakunode
# The first `make` invocation will update all Git submodules.
# You'll run `make update` after each `git pull` in the future to keep those submodules updated.
make wakunode2
# Build with custom compilation flags. Do not use NIM_PARAMS unless you know what you are doing.
# Replace with your own flags
make wakunode2 NIMFLAGS="-d:chronicles_colors:none -d:disableMarchNative"
# Run with DNS bootstrapping
./build/wakunode2 --dns-discovery --dns-discovery-url=DNS_BOOTSTRAP_NODE_URL
# See available command line options
./build/wakunode2 --help
To join the network, you need to know the address of at least one bootstrap node. Please refer to the Waku README for more information.
For more on how to run wakunode2, refer to:
Issues
WSL
If you encounter difficulties building the project on WSL, consider placing the project within WSL's filesystem, avoiding the /mnt/ directory.
Developing
Nim Runtime
This repository is bundled with a Nim runtime that includes the necessary dependencies for the project.
Before you can utilise the runtime you'll need to build the project, as detailed in a previous section. This will generate a vendor directory containing various dependencies, including the nimbus-build-system which has the bundled nim runtime.
After successfully building the project, you may bring the bundled runtime into scope by running:
source env.sh
If everything went well, you should see your prompt suffixed with [Nimbus env]$. Now you can run nim commands as usual.
Waku Protocol Test Suite
# Run all the Waku tests
make test
Examples
Examples can be found in the examples folder. This includes a fully featured chat example.
Tools
Different tools and their corresponding how-to guides can be found in the tools folder.
Bugs, Questions & Features
For an inquiry, or if you would like to propose new features, feel free to open a general issue.
For bug reports, please tag your issue with the bug label.
If you believe the reported issue requires critical attention, please use the critical label to assist with triaging.
To get help, or participate in the conversation, join the Waku Discord server.