Documentation

go-waku

A Go implementation of the Waku v2 protocol.

Waku Protocol Support

  • : Supported
  • 🚧: Implementation in progress
  • : Support is not planned
Spec Implementation Status
7/WAKU-DATA
10/WAKU2 🚧
11/WAKU2-RELAY
12/WAKU2-FILTER
13/WAKU2-STORE 🚧
14/WAKU2-MESSAGE
15/WAKU2-BRIDGE
16/WAKU2-RPC
17/WAKU2-RLNRELAY
18/WAKU2-SWAP

Install

git clone https://github.com/status-im/go-waku
cd go-waku
make

Wakunode

See the available command line options with

./build/waku --help

Examples

Examples of usage of go-waku as a library can be found in the examples folder. There is a fully featured chat example.

Contribution

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:

License

Licensed and distributed under either of

or

at your option. These files may not be copied, modified, or distributed except according to those terms.