status-im
/
go-waku
mirror of https://github.com/status-im/go-waku.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
Go implementation of Waku v2 protocol
221 Commits 34 Branches 19 Tags 78 MiB
Go 98.8%
Makefile 0.5%
Shell 0.3%
Nix 0.2%
Dockerfile 0.1%
Go to file
Anthony Laibe 3571f0bab9 feat: init swap protocol 
* Add proto files
* Add options
* Add credit/debit for soft mode
 		2021-11-24 13:58:35 +01:00
build Reorg file paths, and initialize peer store 2021-04-13 14:54:06 -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 fix: replace WIthTopic to ToTopic 2021-11-19 20:04:38 -04:00
hooks feat: add git hook 2021-10-18 14:43:48 +02:00
tests refactor: create separate functions for subscriptions and publishing 2021-11-19 20:04:38 -04:00
waku feat: init swap protocol 2021-11-24 13:58:35 +01: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 chore: exclude protobuffers from code coverage 2021-11-09 09:21:34 -04:00
README.md feat: init swap protocol 2021-11-24 13:58:35 +01:00
go.mod feat: Add first endpoint for rpc server 2021-11-02 15:16:23 +01:00
go.sum feat: Add first endpoint for rpc server 2021-11-02 15:16:23 +01:00
waku.go feat: Add log level options (#75) 2021-10-13 16:18:10 +02:00

README.md

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.