Go implementation of Waku v2 protocol

Go to file

Richard Ramos c8a83f04de feat: add dns-discovery flags to wakunode and chat2 example (#52 )		2021-09-30 19:03:19 -04:00
build	Reorg file paths, and initialize peer store	2021-04-13 14:54:06 -04:00
examples	feat: add dns-discovery flags to wakunode and chat2 example (#52 )	2021-09-30 19:03:19 -04:00
tests	Add tests and lint code	2021-08-13 13:56:09 +02:00
waku	feat: add dns-discovery flags to wakunode and chat2 example (#52 )	2021-09-30 19:03:19 -04:00
.gitignore	persist messages on sqlite db	2021-04-12 13:59:41 -04:00
CHANGELOG.md	Initial commit	2021-03-11 16:27:12 -04:00
Jenkinsfile	ci: add Jenkinsfile that runs lint and test targets	2021-08-16 12:52:13 +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	[Fixes: #39 ] Add DNS discovery (#48 )	2021-09-27 13:52:56 -04:00
README.md	Update README.md	2021-08-25 16:16:14 -04:00
go.mod	[Fixes: #39 ] Add DNS discovery (#48 )	2021-09-27 13:52:56 -04:00
go.sum	[Fixes: #39 ] Add DNS discovery (#48 )	2021-09-27 13:52:56 -04:00
waku.go	Reorg file paths, and initialize peer store	2021-04-13 14:54:06 -04:00

README.md

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/WAKU2	✔
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	(implemented in status-go)
25/LIBP2P-DNS-DISCOVERY	🚧
26/WAKU2-PAYLOAD	✔
27/WAKU2-PEERS	✔
29/WAKU2-CONFIG	🚧

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

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.