2021-03-18 23:21:45 +00:00
# go-waku
2021-04-13 18:52:02 +00:00
A Go implementation of the [Waku v2 protocol ](https://specs.vac.dev/specs/waku/v2/waku-v2 ).
2021-03-18 23:21:45 +00:00
2021-10-09 18:18:53 +00:00
< p align = "left" >
< a href = "https://goreportcard.com/report/github.com/status-im/go-waku" > < img src = "https://goreportcard.com/badge/github.com/status-im/go-waku" / > < / a >
< a href = "https://godoc.org/github.com/status-im/go-waku" > < img src = "http://img.shields.io/badge/godoc-reference-5272B4.svg?style=flat-square" / > < / a >
2021-10-11 15:46:35 +00:00
< a href = "" > < img src = "https://img.shields.io/badge/golang-%3E%3D1.15.0-orange.svg?style=flat-square" / > < / a >
2021-10-09 18:18:53 +00:00
< br >
< / p >
## Install
2021-10-11 15:46:35 +00:00
#### Building from source
2021-10-09 18:18:53 +00:00
```
git clone https://github.com/status-im/go-waku
cd go-waku
make
2021-10-11 15:46:35 +00:00
# See the available command line options with
./build/waku --help
2021-10-09 18:18:53 +00:00
```
2021-10-11 15:46:35 +00:00
#### Docker
2021-10-09 18:18:53 +00:00
```
2021-10-11 15:46:35 +00:00
docker build -t go-waku:latest .
docker run go-waku:latest --help
2021-10-09 18:18:53 +00:00
```
## 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.
2021-03-18 23:21:45 +00:00
2021-04-13 18:52:02 +00:00
## Waku Protocol Support
- ✔: Supported
- 🚧: Implementation in progress
- ⛔: Support is not planned
| Spec | Implementation Status |
| ---- | -------------- |
2021-08-25 20:16:14 +00:00
|[7/WAKU2](https://rfc.vac.dev/spec/7)|✔|
2021-04-13 18:52:02 +00:00
|[10/WAKU2](https://rfc.vac.dev/spec/10)|🚧|
|[11/WAKU2-RELAY](https://rfc.vac.dev/spec/11)|✔|
2021-08-25 20:16:14 +00:00
|[12/WAKU2-FILTER](https://rfc.vac.dev/spec/12)|✔|
|[13/WAKU2-STORE](https://rfc.vac.dev/spec/13)|✔|
2021-04-13 18:52:02 +00:00
|[14/WAKU2-MESSAGE](https://rfc.vac.dev/spec/14)|✔|
|[15/WAKU2-BRIDGE](https://rfc.vac.dev/spec/15)|⛔|
|[16/WAKU2-RPC](https://rfc.vac.dev/spec/16)||
|[17/WAKU2-RLNRELAY](https://rfc.vac.dev/spec/17)||
|[18/WAKU2-SWAP](https://rfc.vac.dev/spec/18)||
2021-08-25 20:16:14 +00:00
|[21/WAKU2-FTSTORE](https://rfc.vac.dev/spec/21)|✔|
|[22/TOY-CHAT](https://rfc.vac.dev/spec/22)|✔|
|[23/TOPICS](https://rfc.vac.dev/spec/22)|(implemented in status-go)|
|[25/LIBP2P-DNS-DISCOVERY](https://rfc.vac.dev/spec/25)|🚧|
|[26/WAKU2-PAYLOAD](https://rfc.vac.dev/spec/26)|✔|
|[27/WAKU2-PEERS](https://rfc.vac.dev/spec/27)|✔|
|[29/WAKU2-CONFIG](https://rfc.vac.dev/spec/29)|🚧|
2021-04-13 18:52:02 +00:00
## 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:
2021-10-11 15:46:35 +00:00
- [Go ](https://golang.org/ ) (version 1.15 or later)
2021-04-13 18:52:02 +00:00
- [protoc ](https://grpc.io/docs/protoc-installation/ )
- [Protocol Buffers for Go with Gadgets ](https://github.com/gogo/protobuf )
2021-10-09 18:18:53 +00:00
2021-04-13 18:52:02 +00:00
## License
Licensed and distributed under either of
* MIT license: [LICENSE-MIT ](LICENSE-MIT ) or http://opensource.org/licenses/MIT
or
* Apache License, Version 2.0, ([LICENSE-APACHEv2](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.
