A Go implementation of the Waku v2 protocol.
git clone https://github.com/waku-org/go-waku
cd go-waku
make
# See the available command line options with
./build/waku --help
You can build Waku v2 node using Nix Flakes:
nix build github:waku-org/go-waku
Or build the library using:
nix build github:waku-org/go-waku#library
To start a shell with build dependencies use:
nix develop
docker run -i -t -p 60000:60000 -p 9000:9000/udp \
wakuorg/go-waku:latest \
--dns-discovery \
--dns-discovery-url enrtree://AIRVQ5DDA4FFWLRBCHJWUWOO6X6S4ZTZ5B667LQ6AJU6PEYDLRD5O@sandbox.waku.nodes.status.im \
--discv5-discovery
or use the image:tag of your choice.
or build and run the image with:
docker build -t wakuorg/go-waku:latest .
docker run wakuorg/go-waku:latest --help
Windows requires the following tools to be installed
go get github.com/waku-org/go-waku
make static-library
make dynamic-library
Requires gomobile
make mobile-android
make mobile-ios
Examples of usage of go-waku as a library can be found in the examples/
folder:
Thank you for considering to help out with the source code! We welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes!
If you'd like to contribute to go-waku, please fork, fix, commit and send a pull request. If you wish to submit more complex changes though, please check up with the core devs first to ensure those changes are in line with the general philosophy of the project and/or get some early feedback which can make both your efforts much lighter as well as our review and merge procedures quick and simple.
To build and test this repository, you need:
To enable the git hooks:
git config core.hooksPath hooks
If you encounter any bug or would like to propose new features, feel free to open an issue.
For more general discussion, help and latest news, join #go-waku on Vac Discord or Telegram.
Licensed and distributed under either of
or
at your option. These files may not be copied, modified, or distributed except according to those terms.