Go implementation of Waku v2 protocol

Go to file

Richard Ramos 4d0e4ca4da chore: upgrade deps (#225 )		2022-04-06 09:57:53 -04:00
build	feat: c-sharp example (#222 )	2022-04-02 20:22:42 -04:00
ci	feat: upload code coverage to code climate	2021-11-09 13:13:49 +01:00
coverage	chore: add codeclimate code coverage support (#126 )	2021-11-02 09:55:28 -04:00
examples	chore: upgrade deps (#225 )	2022-04-06 09:57:53 -04:00
hooks	feat: add git hook	2021-10-18 14:43:48 +02:00
library	feat: c-sharp example (#222 )	2022-04-02 20:22:42 -04:00
tests	feat: secure websockets (#201 )	2022-03-22 09:12:58 -04:00
waku	fix: port on discv5 (#224 )	2022-03-31 21:20:10 -04:00
.dockerignore	Dockerfile: add commit, log format, and make target (#83 )	2021-10-15 12:47:23 +02:00
.gitignore	chore: exclude protobuffers from code coverage	2021-11-09 09:21:34 -04:00
CHANGELOG.md	Initial commit	2021-03-11 16:27:12 -04:00
Dockerfile	Dockerfile: add commit, log format, and make target (#83 )	2021-10-15 12:47:23 +02:00
LICENSE-APACHEv2	Initial commit	2021-03-11 16:27:12 -04:00
LICENSE-MIT	Initial commit	2021-03-11 16:27:12 -04:00
Makefile	fix: readme (#221 )	2022-03-23 14:40:54 -04:00
README.md	fix: readme (#221 )	2022-03-23 14:40:54 -04:00
go.mod	chore: upgrade deps (#225 )	2022-04-06 09:57:53 -04:00
go.sum	chore: upgrade deps (#225 )	2022-04-06 09:57:53 -04:00
waku.go	feat: secure websockets (#201 )	2022-03-22 09:12:58 -04:00

README.md

go-waku

A Go implementation of the Waku v2 protocol.

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

Building on windows

Windows requires the following tools to be installed

git bash (which is installed as part of Git)
chocolatey
make
mingw
go

Library

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

C Bindings

make static-library
make dynamic-library

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

Bugs, Questions & Features

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.

License

Licensed and distributed under either of

MIT license: LICENSE-MIT or http://opensource.org/licenses/MIT

Apache License, Version 2.0, (LICENSE-APACHEv2 or http://www.apache.org/licenses/LICENSE-2.0)

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