A Go implementation of the Waku v2 protocol.
Building from source
git clone https://github.com/waku-org/go-waku cd go-waku make # See the available command line options with ./build/waku --help
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:
docker run -i -t -p 60000:60000 -p 9000:9000/udp \ wakuorg/go-waku:latest \ --dns-discovery \ --dns-discovery-url enrtree://ANEDLO25QVUGJOUTQFRYKWX6P4Z4GKVESBMHML7DZ6YK4LGS5FC5O@prod.wakuv2.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
Building on windows
Windows requires the following tools to be installed
go get github.com/waku-org/go-waku
make static-library make dynamic-library
make mobile-android make mobile-ios
Tutorials and documentation
- Receive and send messages using Waku Relay
- Send messages using Waku Lightpush
- Encrypting and decrypting Waku Messages
- Retrieve message history using Waku Store
- C Bindings
- Waku Specs, has information of waku topics, wakuv1/wakuv2 message, rln relay etc.
- Enr, Enrtree
- devp2p tool for playing with enr/entree sync tree. Tutorial
Examples of usage of go-waku as a library can be found in the
- basic2 - demonstrates how to send and receive messages
- chat2 - simple chat client using waku relay / lightpush + filter / store protocol to send/receive messages and retrieve message history
- filter2 - demonstrates how to use filter protocol
- c-bindings - simple program to demonstrate how to consume the go-waku library via C FFI
- waku-csharp - C# console application that uses the go-waku library via FFI
- android-kotlin - android app that uses a .jar generated by gomobile using kotlin
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
Bugs, Questions & Features
If you encounter any bug or would like to propose new features, feel free to open an issue.
Licensed and distributed under either of
at your option. These files may not be copied, modified, or distributed except according to those terms.