snormore / go-waku

Go implementation of Waku v2 protocol

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

go-waku

A Go implementation of the Waku v2 protocol.

Total alerts

Install

Building from source

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

# See the available command line options with
./build/waku --help

Docker

docker build -t go-waku:latest .

docker run go-waku:latest --help

Library

go get github.com/status-im/go-waku

Examples

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

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 🚧
21/WAKU2-FTSTORE βœ”
22/TOY-CHAT βœ”
23/TOPICS βœ”
25/LIBP2P-DNS-DISCOVERY 🚧
26/WAKU2-PAYLOAD βœ”
27/WAKU2-PEERS βœ”
29/WAKU2-CONFIG 🚧

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:

To enable the git hooks:

git config core.hooksPath hooks

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.

About

Go implementation of Waku v2 protocol

License:Other


Languages

Language:Go 98.9%Language:Makefile 0.6%Language:Dockerfile 0.3%Language:Shell 0.3%